Skip to content

Commit 4b61b36

Browse files
rvaggrvagg
committed
feat(miner): make precommit HAMT & AMT CIDs nullable
1 parent 5f30872 commit 4b61b36

File tree

4 files changed

+131
-52
lines changed

4 files changed

+131
-52
lines changed

‎builtin/v16/migration/top.go‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ package migration
33
import (
44
"context"
55

6+
"github.com/filecoin-project/go-state-types/builtin/v16/util/adt"
67
adt16 "github.com/filecoin-project/go-state-types/builtin/v16/util/adt"
78

89
system15 "github.com/filecoin-project/go-state-types/builtin/v13/system"
10+
miner16 "github.com/filecoin-project/go-state-types/builtin/v16/miner"
911

1012
"github.com/filecoin-project/go-state-types/abi"
1113
"github.com/filecoin-project/go-state-types/builtin"
@@ -67,14 +69,22 @@ func MigrateStateTree(ctx context.Context, store cbor.IpldStore, newManifestCID
6769
// Set of prior version code CIDs for actors to defer during iteration, for explicit migration afterwards.
6870
deferredCodeIDs := make(map[cid.Cid]struct{})
6971

72+
miner15Cid := cid.Undef
73+
7074
for _, oldEntry := range oldManifestData.Entries {
7175
newCodeCID, ok := newManifest.Get(oldEntry.Name)
7276
if !ok {
7377
return cid.Undef, xerrors.Errorf("code cid for %s actor not found in new manifest", oldEntry.Name)
7478
}
79+
if oldEntry.Name == manifest.MinerKey {
80+
miner15Cid = oldEntry.Code
81+
}
7582
migrations[oldEntry.Code] = migration.CachedMigration(cache, migration.CodeMigrator{OutCodeCID: newCodeCID})
7683
}
7784

85+
if miner15Cid == cid.Undef {
86+
return cid.Undef, xerrors.Errorf("could not find miner actor in old manifest")
87+
}
7888
// migrations that migrate both code and state, override entries in `migrations`
7989

8090
// The System Actor
@@ -90,6 +100,35 @@ func MigrateStateTree(ctx context.Context, store cbor.IpldStore, newManifestCID
90100
return cid.Undef, xerrors.Errorf("incomplete migration specification with %d code CIDs, need %d", len(migrations)+len(deferredCodeIDs), len(oldManifestData.Entries))
91101
}
92102

103+
var emptyPreCommittedSectorsHamtCid cid.Cid
104+
if hamt, err := adt.MakeEmptyMap(adtStore, builtin.DefaultHamtBitwidth); err != nil {
105+
return cid.Undef, xerrors.Errorf("failed to create empty precommit clean up amount array: %w", err)
106+
} else {
107+
if emptyPreCommittedSectorsHamtCid, err = hamt.Root(); err != nil {
108+
return cid.Undef, xerrors.Errorf("failed to get root of empty precommit clean up amount array: %w", err)
109+
}
110+
}
111+
var emptyPrecommitCleanUpAmtCid cid.Cid
112+
if amt, err := adt.MakeEmptyArray(adtStore, miner16.PrecommitCleanUpAmtBitwidth); err != nil {
113+
return cid.Undef, xerrors.Errorf("failed to create empty precommit clean up amount array: %w", err)
114+
} else {
115+
if emptyPrecommitCleanUpAmtCid, err = amt.Root(); err != nil {
116+
return cid.Undef, xerrors.Errorf("failed to get root of empty precommit clean up amount array: %w", err)
117+
}
118+
}
119+
120+
miner16Cid, ok := newManifest.Get(manifest.MinerKey)
121+
if !ok {
122+
return cid.Undef, xerrors.Errorf("code cid for miner actor not found in new manifest")
123+
}
124+
125+
minerMig, err := newMinerMigrator(ctx, store, miner16Cid, emptyPreCommittedSectorsHamtCid, emptyPrecommitCleanUpAmtCid)
126+
if err != nil {
127+
return cid.Undef, xerrors.Errorf("failed to create miner migrator: %w", err)
128+
}
129+
130+
migrations[miner15Cid] = migration.CachedMigration(cache, minerMig)
131+
93132
actorsOut, err := migration.RunMigration(ctx, cfg, cache, store, log, actorsIn, migrations)
94133
if err != nil {
95134
return cid.Undef, xerrors.Errorf("failed to run migration: %w", err)

‎builtin/v16/miner/cbor_gen.go‎

Lines changed: 42 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎builtin/v16/miner/invariants.go‎

Lines changed: 43 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -778,54 +778,58 @@ func CheckPreCommits(st *State, store adt.Store, allocatedSectorsMap map[uint64]
778778

779779
// invert pre-commit clean up queue into a lookup by sector number
780780
cleanUpEpochs := make(map[uint64]abi.ChainEpoch)
781-
if cleanUpQ, err := util.LoadBitfieldQueue(store, st.PreCommittedSectorsCleanUp, st.QuantSpecEveryDeadline(), PrecommitCleanUpAmtBitwidth); err != nil {
782-
acc.Addf("error loading pre-commit clean up queue: %v", err)
783-
} else {
784-
err = cleanUpQ.ForEach(func(epoch abi.ChainEpoch, bf bitfield.BitField) error {
785-
quantized := quant.QuantizeUp(epoch)
786-
acc.Require(quantized == epoch, "precommit expiration %d is not quantized", epoch)
787-
if err = bf.ForEach(func(secNum uint64) error {
788-
cleanUpEpochs[secNum] = epoch
781+
if st.PreCommittedSectorsCleanUp != nil {
782+
if cleanUpQ, err := util.LoadBitfieldQueue(store, *st.PreCommittedSectorsCleanUp, st.QuantSpecEveryDeadline(), PrecommitCleanUpAmtBitwidth); err != nil {
783+
acc.Addf("error loading pre-commit clean up queue: %v", err)
784+
} else {
785+
err = cleanUpQ.ForEach(func(epoch abi.ChainEpoch, bf bitfield.BitField) error {
786+
quantized := quant.QuantizeUp(epoch)
787+
acc.Require(quantized == epoch, "precommit expiration %d is not quantized", epoch)
788+
if err = bf.ForEach(func(secNum uint64) error {
789+
cleanUpEpochs[secNum] = epoch
790+
return nil
791+
}); err != nil {
792+
acc.Addf("error iteration pre-commit expiration bitfield: %v", err)
793+
}
789794
return nil
790-
}); err != nil {
791-
acc.Addf("error iteration pre-commit expiration bitfield: %v", err)
792-
}
793-
return nil
794-
})
795-
acc.RequireNoError(err, "error iterating pre-commit clean up queue")
795+
})
796+
acc.RequireNoError(err, "error iterating pre-commit clean up queue")
797+
}
796798
}
797799

798800
precommitTotal := big.Zero()
799-
if precommitted, err := adt.AsMap(store, st.PreCommittedSectors, builtin.DefaultHamtBitwidth); err != nil {
800-
acc.Addf("error loading precommitted sectors: %v", err)
801-
} else {
802-
var precommit SectorPreCommitOnChainInfo
803-
err = precommitted.ForEach(&precommit, func(key string) error {
804-
secNum, err := abi.ParseUIntKey(key)
805-
if err != nil {
806-
acc.Addf("error parsing pre-commit key as uint: %v", err)
807-
return nil
808-
}
809-
810-
allocated := false
811-
if allocatedSectorsMap != nil {
812-
allocated = allocatedSectorsMap[secNum]
813-
} else {
814-
allocated, err = allocatedSectorsBf.IsSet(secNum)
801+
if st.PreCommittedSectors != nil {
802+
if precommitted, err := adt.AsMap(store, *st.PreCommittedSectors, builtin.DefaultHamtBitwidth); err != nil {
803+
acc.Addf("error loading precommitted sectors: %v", err)
804+
} else {
805+
var precommit SectorPreCommitOnChainInfo
806+
err = precommitted.ForEach(&precommit, func(key string) error {
807+
secNum, err := abi.ParseUIntKey(key)
815808
if err != nil {
816-
acc.Addf("error checking allocated sectors: %v", err)
809+
acc.Addf("error parsing pre-commit key as uint: %v", err)
817810
return nil
818811
}
819-
}
820-
acc.Require(allocated, "pre-committed sector number has not been allocated %d", secNum)
821812

822-
_, found := cleanUpEpochs[secNum]
823-
acc.Require(found, "no clean up epoch for pre-commit at %d", precommit.PreCommitEpoch)
813+
allocated := false
814+
if allocatedSectorsMap != nil {
815+
allocated = allocatedSectorsMap[secNum]
816+
} else {
817+
allocated, err = allocatedSectorsBf.IsSet(secNum)
818+
if err != nil {
819+
acc.Addf("error checking allocated sectors: %v", err)
820+
return nil
821+
}
822+
}
823+
acc.Require(allocated, "pre-committed sector number has not been allocated %d", secNum)
824824

825-
precommitTotal = big.Add(precommitTotal, precommit.PreCommitDeposit)
826-
return nil
827-
})
828-
acc.RequireNoError(err, "error iterating pre-committed sectors")
825+
_, found := cleanUpEpochs[secNum]
826+
acc.Require(found, "no clean up epoch for pre-commit at %d", precommit.PreCommitEpoch)
827+
828+
precommitTotal = big.Add(precommitTotal, precommit.PreCommitDeposit)
829+
return nil
830+
})
831+
acc.RequireNoError(err, "error iterating pre-committed sectors")
832+
}
829833
}
830834

831835
acc.Require(st.PreCommitDeposits.Equals(precommitTotal),

‎builtin/v16/miner/miner_state.go‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ type State struct {
3535
InitialPledge abi.TokenAmount // Sum of initial pledge requirements of all active sectors
3636

3737
// Sectors that have been pre-committed but not yet proven.
38-
PreCommittedSectors cid.Cid // Map, HAMT[SectorNumber]SectorPreCommitOnChainInfo
38+
PreCommittedSectors *cid.Cid // Map, HAMT[SectorNumber]SectorPreCommitOnChainInfo
3939

4040
// PreCommittedSectorsCleanUp maintains the state required to cleanup expired PreCommittedSectors.
41-
PreCommittedSectorsCleanUp cid.Cid // BitFieldQueue (AMT[Epoch]*BitField)
41+
PreCommittedSectorsCleanUp *cid.Cid // BitFieldQueue (AMT[Epoch]*BitField)
4242

4343
// Allocated sector IDs. Sector IDs can never be reused once allocated.
4444
AllocatedSectors cid.Cid // BitField
@@ -217,7 +217,11 @@ func (st *State) QuantSpecForDeadline(dlIdx uint64) builtin.QuantSpec {
217217
}
218218

219219
func (st *State) GetPrecommittedSector(store adt.Store, sectorNo abi.SectorNumber) (*SectorPreCommitOnChainInfo, bool, error) {
220-
precommitted, err := adt.AsMap(store, st.PreCommittedSectors, builtin.DefaultHamtBitwidth)
220+
if st.PreCommittedSectors == nil {
221+
return nil, false, nil
222+
}
223+
224+
precommitted, err := adt.AsMap(store, *st.PreCommittedSectors, builtin.DefaultHamtBitwidth)
221225
if err != nil {
222226
return nil, false, err
223227
}

0 commit comments

Comments
 (0)