package splitstore import ( "context" "encoding/binary" "errors" "sync" "sync/atomic" "time" "golang.org/x/xerrors" blocks "github.com/ipfs/go-block-format" cid "github.com/ipfs/go-cid" dstore "github.com/ipfs/go-datastore" logging "github.com/ipfs/go-log/v2" "github.com/filecoin-project/go-state-types/abi" bstore "github.com/filecoin-project/lotus/blockstore" "github.com/filecoin-project/lotus/build" "github.com/filecoin-project/lotus/chain/types" ) var ( // CompactionThreshold is the number of epochs that need to have elapsed // from the previously compacted epoch to trigger a new compaction. // // |················· CompactionThreshold ··················| // | | // =======‖≡≡≡≡≡≡≡‖-------------------------------------------------» // | | chain --> ↑__ current epoch // |·······| // ↑________ CompactionCold. // // === :: cold (already archived) // ≡≡≡ :: to be archived in this compaction // --- :: hot CompactionThreshold = 5 * build.Finality // CompactionCold is the number of epochs that will be archived to the // cold store on compaction. See diagram on CompactionThreshold for a // better sense. CompactionCold = build.Finality ) var ( // baseEpochKey stores the base epoch (last compaction epoch) in the // metadata store. baseEpochKey = dstore.NewKey("/splitstore/baseEpoch") // warmupEpochKey stores whether a hot store warmup has been performed. // On first start, the splitstore will walk the state tree and will copy // all active blocks into the hotstore. warmupEpochKey = dstore.NewKey("/splitstore/warmupEpoch") log = logging.Logger("splitstore") ) const ( batchSize = 16384 defaultColdPurgeSize = 7_000_000 defaultDeadPurgeSize = 1_000_000 ) func init() { // TODO temporary for debugging purposes; to be removed for merge. _ = logging.SetLogLevel("splitstore", "DEBUG") } type Config struct { // TrackingStore is the type of tracking store to use. // // Supported values are: "bolt" (default if omitted). TrackingStoreType string // MarkSetType is the type of mark set to use. // // Supported values are: "bloom" (default if omitted), "bolt". MarkSetType string // perform full reachability analysis (expensive) for compaction // You should enable this option if you plan to use the splitstore without a backing coldstore EnableFullCompaction bool // EXPERIMENTAL enable pruning of unreachable objects. // This has not been sufficiently tested yet; only enable if you know what you are doing. // Only applies if you enable full compaction. EnableGC bool // full archival nodes should enable this if EnableFullCompaction is enabled // do NOT enable this if you synced from a snapshot. // Only applies if you enabled full compaction Archival bool } // ChainAccessor allows the Splitstore to access the chain. It will most likely // be a ChainStore at runtime. type ChainAccessor interface { GetTipsetByHeight(context.Context, abi.ChainEpoch, *types.TipSet, bool) (*types.TipSet, error) GetHeaviestTipSet() *types.TipSet SubscribeHeadChanges(change func(revert []*types.TipSet, apply []*types.TipSet) error) WalkSnapshot(context.Context, *types.TipSet, abi.ChainEpoch, bool, bool, func(cid.Cid) error) error } type SplitStore struct { compacting int32 fullCompaction bool enableGC bool skipOldMsgs bool skipMsgReceipts bool baseEpoch abi.ChainEpoch warmupEpoch abi.ChainEpoch coldPurgeSize int deadPurgeSize int mx sync.Mutex curTs *types.TipSet chain ChainAccessor ds dstore.Datastore hot bstore.Blockstore cold bstore.Blockstore tracker TrackingStore env MarkSetEnv markSetSize int64 } var _ bstore.Blockstore = (*SplitStore)(nil) // Open opens an existing splistore, or creates a new splitstore. The splitstore // is backed by the provided hot and cold stores. The returned SplitStore MUST be // attached to the ChainStore with Start in order to trigger compaction. func Open(path string, ds dstore.Datastore, hot, cold bstore.Blockstore, cfg *Config) (*SplitStore, error) { // the tracking store tracker, err := OpenTrackingStore(path, cfg.TrackingStoreType) if err != nil { return nil, err } // the markset env env, err := OpenMarkSetEnv(path, cfg.MarkSetType) if err != nil { _ = tracker.Close() return nil, err } // and now we can make a SplitStore ss := &SplitStore{ ds: ds, hot: hot, cold: cold, tracker: tracker, env: env, fullCompaction: cfg.EnableFullCompaction, enableGC: cfg.EnableGC, skipOldMsgs: !(cfg.EnableFullCompaction && cfg.Archival), skipMsgReceipts: !(cfg.EnableFullCompaction && cfg.Archival), coldPurgeSize: defaultColdPurgeSize, } if cfg.EnableGC { ss.deadPurgeSize = defaultDeadPurgeSize } return ss, nil } // Blockstore interface func (s *SplitStore) DeleteBlock(_ cid.Cid) error { // afaict we don't seem to be using this method, so it's not implemented return errors.New("DeleteBlock not implemented on SplitStore; don't do this Luke!") //nolint } func (s *SplitStore) DeleteMany(_ []cid.Cid) error { // afaict we don't seem to be using this method, so it's not implemented return errors.New("DeleteMany not implemented on SplitStore; don't do this Luke!") //nolint } func (s *SplitStore) Has(cid cid.Cid) (bool, error) { has, err := s.hot.Has(cid) if err != nil || has { return has, err } return s.cold.Has(cid) } func (s *SplitStore) Get(cid cid.Cid) (blocks.Block, error) { blk, err := s.hot.Get(cid) switch err { case nil: return blk, nil case bstore.ErrNotFound: return s.cold.Get(cid) default: return nil, err } } func (s *SplitStore) GetSize(cid cid.Cid) (int, error) { size, err := s.hot.GetSize(cid) switch err { case nil: return size, nil case bstore.ErrNotFound: return s.cold.GetSize(cid) default: return 0, err } } func (s *SplitStore) Put(blk blocks.Block) error { s.mx.Lock() if s.curTs == nil { s.mx.Unlock() return s.cold.Put(blk) } epoch := s.curTs.Height() s.mx.Unlock() err := s.tracker.Put(blk.Cid(), epoch) if err != nil { log.Errorf("error tracking CID in hotstore: %s; falling back to coldstore", err) return s.cold.Put(blk) } return s.hot.Put(blk) } func (s *SplitStore) PutMany(blks []blocks.Block) error { s.mx.Lock() if s.curTs == nil { s.mx.Unlock() return s.cold.PutMany(blks) } epoch := s.curTs.Height() s.mx.Unlock() batch := make([]cid.Cid, 0, len(blks)) for _, blk := range blks { batch = append(batch, blk.Cid()) } err := s.tracker.PutBatch(batch, epoch) if err != nil { log.Errorf("error tracking CIDs in hotstore: %s; falling back to coldstore", err) return s.cold.PutMany(blks) } return s.hot.PutMany(blks) } func (s *SplitStore) AllKeysChan(ctx context.Context) (<-chan cid.Cid, error) { ctx, cancel := context.WithCancel(ctx) chHot, err := s.hot.AllKeysChan(ctx) if err != nil { cancel() return nil, err } chCold, err := s.cold.AllKeysChan(ctx) if err != nil { cancel() return nil, err } ch := make(chan cid.Cid) go func() { defer cancel() defer close(ch) for _, in := range []<-chan cid.Cid{chHot, chCold} { for cid := range in { select { case ch <- cid: case <-ctx.Done(): return } } } }() return ch, nil } func (s *SplitStore) HashOnRead(enabled bool) { s.hot.HashOnRead(enabled) s.cold.HashOnRead(enabled) } func (s *SplitStore) View(cid cid.Cid, cb func([]byte) error) error { err := s.hot.View(cid, cb) switch err { case bstore.ErrNotFound: return s.cold.View(cid, cb) default: return err } } // State tracking func (s *SplitStore) Start(chain ChainAccessor) error { s.chain = chain s.curTs = chain.GetHeaviestTipSet() // load base epoch from metadata ds // if none, then use current epoch because it's a fresh start bs, err := s.ds.Get(baseEpochKey) switch err { case nil: s.baseEpoch = bytesToEpoch(bs) case dstore.ErrNotFound: if s.curTs == nil { // this can happen in some tests break } err = s.setBaseEpoch(s.curTs.Height()) if err != nil { return xerrors.Errorf("error saving base epoch: %w", err) } default: return xerrors.Errorf("error loading base epoch: %w", err) } // load warmup epoch from metadata ds // if none, then the splitstore will warm up the hotstore at first head change notif // by walking the current tipset bs, err = s.ds.Get(warmupEpochKey) switch err { case nil: s.warmupEpoch = bytesToEpoch(bs) case dstore.ErrNotFound: default: return xerrors.Errorf("error loading warmup epoch: %w", err) } log.Infof("starting splitstore at base epoch %d", s.baseEpoch) // watch the chain chain.SubscribeHeadChanges(s.HeadChange) return nil } func (s *SplitStore) Close() error { if atomic.LoadInt32(&s.compacting) == 1 { log.Warn("ongoing compaction; waiting for it to finish...") for atomic.LoadInt32(&s.compacting) == 1 { time.Sleep(time.Second) } } return s.env.Close() } func (s *SplitStore) HeadChange(_, apply []*types.TipSet) error { s.mx.Lock() curTs := apply[len(apply)-1] epoch := curTs.Height() s.curTs = curTs s.mx.Unlock() if !atomic.CompareAndSwapInt32(&s.compacting, 0, 1) { // we are currently compacting, do nothing and wait for the next head change return nil } if s.warmupEpoch == 0 { // splitstore needs to warm up go func() { defer atomic.StoreInt32(&s.compacting, 0) log.Info("warming up hotstore") start := time.Now() s.warmup(curTs) log.Infow("warm up done", "took", time.Since(start)) }() return nil } if epoch-s.baseEpoch > CompactionThreshold { // it's time to compact go func() { defer atomic.StoreInt32(&s.compacting, 0) log.Info("compacting splitstore") start := time.Now() s.compact(curTs) log.Infow("compaction done", "took", time.Since(start)) }() } else { // no compaction necessary atomic.StoreInt32(&s.compacting, 0) } return nil } func (s *SplitStore) warmup(curTs *types.TipSet) { epoch := curTs.Height() batchHot := make([]blocks.Block, 0, batchSize) batchSnoop := make([]cid.Cid, 0, batchSize) count := int64(0) err := s.chain.WalkSnapshot(context.Background(), curTs, 1, s.skipOldMsgs, s.skipMsgReceipts, func(cid cid.Cid) error { count++ has, err := s.hot.Has(cid) if err != nil { return err } if has { return nil } blk, err := s.cold.Get(cid) if err != nil { return err } batchHot = append(batchHot, blk) batchSnoop = append(batchSnoop, cid) if len(batchHot) == batchSize { err = s.tracker.PutBatch(batchSnoop, epoch) if err != nil { return err } batchSnoop = batchSnoop[:0] err = s.hot.PutMany(batchHot) if err != nil { return err } batchHot = batchHot[:0] } return nil }) if err != nil { log.Errorf("error warming up splitstore: %s", err) return } if len(batchHot) > 0 { err = s.tracker.PutBatch(batchSnoop, epoch) if err != nil { log.Errorf("error warming up splitstore: %s", err) return } err = s.hot.PutMany(batchHot) if err != nil { log.Errorf("error warming up splitstore: %s", err) return } } if count > s.markSetSize { s.markSetSize = count } // save the warmup epoch s.warmupEpoch = epoch err = s.ds.Put(warmupEpochKey, epochToBytes(epoch)) if err != nil { log.Errorf("error saving warmup epoch: %s", err) } } // Compaction/GC Algorithm func (s *SplitStore) compact(curTs *types.TipSet) { if s.markSetSize == 0 { start := time.Now() log.Info("estimating mark set size") s.estimateMarkSetSize(curTs) log.Infow("estimating mark set size done", "took", time.Since(start), "size", s.markSetSize) } else { log.Infow("current mark set size estimate", "size", s.markSetSize) } if s.fullCompaction { s.compactFull(curTs) } else { s.compactSimple(curTs) } } func (s *SplitStore) estimateMarkSetSize(curTs *types.TipSet) { s.markSetSize = 0 err := s.chain.WalkSnapshot(context.Background(), curTs, 1, s.skipOldMsgs, s.skipMsgReceipts, func(cid cid.Cid) error { s.markSetSize++ return nil }) if err != nil { // TODO do something better here panic(err) } } func (s *SplitStore) compactSimple(curTs *types.TipSet) { coldEpoch := s.baseEpoch + CompactionCold log.Infow("running simple compaction", "currentEpoch", curTs.Height(), "baseEpoch", s.baseEpoch, "coldEpoch", coldEpoch) coldSet, err := s.env.Create("cold", s.markSetSize) if err != nil { // TODO do something better here panic(err) } defer coldSet.Close() //nolint:errcheck // 1. mark reachable cold objects by looking at the objects reachable only from the cold epoch log.Infow("marking reachable cold objects", "cold_epoch", coldEpoch) startMark := time.Now() coldTs, err := s.chain.GetTipsetByHeight(context.Background(), coldEpoch, curTs, true) if err != nil { // TODO do something better here panic(err) } var count int64 err = s.chain.WalkSnapshot(context.Background(), coldTs, 1, s.skipOldMsgs, s.skipMsgReceipts, func(cid cid.Cid) error { count++ return coldSet.Mark(cid) }) if err != nil { // TODO do something better here panic(err) } if count > s.markSetSize { s.markSetSize = count } log.Infow("marking done", "took", time.Since(startMark)) // 2. move cold unreachable objects to the coldstore log.Info("collecting cold objects") startCollect := time.Now() cold := make([]cid.Cid, 0, s.coldPurgeSize) // some stats for logging var hotCnt, coldCnt int // 2.1 iterate through the tracking store and collect unreachable cold objects err = s.tracker.ForEach(func(cid cid.Cid, writeEpoch abi.ChainEpoch) error { // is the object still hot? if writeEpoch > coldEpoch { // yes, stay in the hotstore hotCnt++ return nil } // check whether it is reachable in the cold boundary mark, err := coldSet.Has(cid) if err != nil { return xerrors.Errorf("error checkiing cold set for %s: %w", cid, err) } if mark { hotCnt++ return nil } // it's cold, mark it for move cold = append(cold, cid) coldCnt++ return nil }) if err != nil { // TODO do something better here panic(err) } s.coldPurgeSize = coldCnt log.Infow("collection done", "took", time.Since(startCollect)) log.Infow("compaction stats", "hot", hotCnt, "cold", coldCnt) // 2.2 copy the cold objects to the coldstore log.Info("moving cold objects to the coldstore") startMove := time.Now() err = s.moveColdBlocks(cold) if err != nil { // TODO do something better here panic(err) } log.Infow("moving done", "took", time.Since(startMove)) // 2.3 delete cold objects from the hotstore log.Info("purging cold objects from the hotstore") startPurge := time.Now() err = s.purgeBlocks(cold) if err != nil { // TODO do something better here panic(err) } log.Infow("purging cold from hotstore done", "took", time.Since(startPurge)) // 2.4 remove the tracker tracking for cold objects startPurge = time.Now() log.Info("purging cold objects from tracker") err = s.purgeTracking(cold) if err != nil { // TODO do something better here panic(err) } log.Infow("purging cold from tracker done", "took", time.Since(startPurge)) // we are done; do some housekeeping err = s.tracker.Sync() if err != nil { // TODO do something better here panic(err) } err = s.setBaseEpoch(coldEpoch) if err != nil { // TODO do something better here panic(err) } } func (s *SplitStore) moveColdBlocks(cold []cid.Cid) error { batch := make([]blocks.Block, 0, batchSize) for _, cid := range cold { blk, err := s.hot.Get(cid) if err != nil { if err == dstore.ErrNotFound { // this can happen if the node is killed after we have deleted the block from the hotstore // but before we have deleted it from the tracker; just delete the tracker. err = s.tracker.Delete(cid) if err != nil { return xerrors.Errorf("error deleting unreachable cid %s from tracker: %w", cid, err) } } else { return xerrors.Errorf("error retrieving tracked block %s from hotstore: %w", cid, err) } continue } batch = append(batch, blk) if len(batch) == batchSize { err = s.cold.PutMany(batch) if err != nil { return xerrors.Errorf("error putting batch to coldstore: %w", err) } batch = batch[:0] } } if len(batch) > 0 { err := s.cold.PutMany(batch) if err != nil { return xerrors.Errorf("error putting cold to coldstore: %w", err) } } return nil } func (s *SplitStore) purgeBlocks(cids []cid.Cid) error { err := s.hot.DeleteMany(cids) if err != nil { return xerrors.Errorf("error deleting batch from hotstore: %e", err) } return nil } func (s *SplitStore) purgeTracking(cids []cid.Cid) error { err := s.tracker.DeleteBatch(cids) if err != nil { return xerrors.Errorf("error deleting batch from tracker: %w", err) } return nil } func (s *SplitStore) compactFull(curTs *types.TipSet) { epoch := curTs.Height() coldEpoch := s.baseEpoch + CompactionCold log.Infow("running full compaction", "currentEpoch", curTs.Height(), "baseEpoch", s.baseEpoch, "coldEpoch", coldEpoch) // create two mark sets, one for marking the cold finality region // and one for marking the hot region hotSet, err := s.env.Create("hot", s.markSetSize) if err != nil { // TODO do something better here panic(err) } defer hotSet.Close() //nolint:errcheck coldSet, err := s.env.Create("cold", s.markSetSize) if err != nil { // TODO do something better here panic(err) } defer coldSet.Close() //nolint:errcheck // Phase 1: marking log.Info("marking live objects") startMark := time.Now() // Phase 1a: mark all reachable CIDs in the hot range count := int64(0) err = s.chain.WalkSnapshot(context.Background(), curTs, epoch-coldEpoch, s.skipOldMsgs, s.skipMsgReceipts, func(cid cid.Cid) error { count++ return hotSet.Mark(cid) }) if err != nil { // TODO do something better here panic(err) } if count > s.markSetSize { s.markSetSize = count } // Phase 1b: mark all reachable CIDs in the cold range coldTs, err := s.chain.GetTipsetByHeight(context.Background(), coldEpoch, curTs, true) if err != nil { // TODO do something better here panic(err) } count = 0 err = s.chain.WalkSnapshot(context.Background(), coldTs, CompactionCold, s.skipOldMsgs, s.skipMsgReceipts, func(cid cid.Cid) error { count++ return coldSet.Mark(cid) }) if err != nil { // TODO do something better here panic(err) } if count > s.markSetSize { s.markSetSize = count } log.Infow("marking done", "took", time.Since(startMark)) // Phase 2: sweep cold objects: // - If a cold object is reachable in the hot range, it stays in the hotstore. // - If a cold object is reachable in the cold range, it is moved to the coldstore. // - If a cold object is unreachable, it is deleted if GC is enabled, otherwise moved to the coldstore. log.Info("collecting cold objects") startCollect := time.Now() // some stats for logging var hotCnt, coldCnt, deadCnt int cold := make([]cid.Cid, 0, s.coldPurgeSize) dead := make([]cid.Cid, 0, s.deadPurgeSize) // 2.1 iterate through the tracker and collect cold and dead objects err = s.tracker.ForEach(func(cid cid.Cid, wrEpoch abi.ChainEpoch) error { // is the object stil hot? if wrEpoch > coldEpoch { // yes, stay in the hotstore hotCnt++ return nil } // the object is cold -- check whether it is reachable in the hot range mark, err := hotSet.Has(cid) if err != nil { return xerrors.Errorf("error checking live mark for %s: %w", cid, err) } if mark { // the object is reachable in the hot range, stay in the hotstore hotCnt++ return nil } // check whether it is reachable in the cold range mark, err = coldSet.Has(cid) if err != nil { return xerrors.Errorf("error checkiing cold set for %s: %w", cid, err) } if s.enableGC { if mark { // the object is reachable in the cold range, move it to the cold store cold = append(cold, cid) coldCnt++ } else { // the object is dead and will be deleted dead = append(dead, cid) deadCnt++ } } else { // if GC is disabled, we move both cold and dead objects to the coldstore cold = append(cold, cid) if mark { coldCnt++ } else { deadCnt++ } } return nil }) if err != nil { // TODO do something better here panic(err) } s.coldPurgeSize = coldCnt + coldCnt>>2 // overestimate a bit s.deadPurgeSize = deadCnt + deadCnt>>2 // overestimate a bit log.Infow("collection done", "took", time.Since(startCollect)) log.Infow("compaction stats", "hot", hotCnt, "cold", coldCnt, "dead", deadCnt) // 2.2 copy the cold objects to the coldstore log.Info("moving cold objects to the coldstore") startMove := time.Now() err = s.moveColdBlocks(cold) if err != nil { // TODO do something better here panic(err) } log.Infow("moving done", "took", time.Since(startMove)) // 2.3 delete cold objects from the hotstore log.Info("purging cold objects from the hotstore") startPurge := time.Now() err = s.purgeBlocks(cold) if err != nil { // TODO do something better here panic(err) } log.Infow("purging cold from hotstore done", "took", time.Since(startPurge)) // 2.4 remove the tracker tracking for cold objects startPurge = time.Now() log.Info("purging cold objects from tracker") err = s.purgeTracking(cold) if err != nil { // TODO do something better here panic(err) } log.Infow("purging cold from tracker done", "took", time.Since(startPurge)) // 3. if we have dead objects, delete them from the hotstore and remove the tracking if len(dead) > 0 { log.Info("deleting dead objects") err = s.purgeBlocks(dead) if err != nil { // TODO do something better here panic(err) } // remove the tracker tracking startPurge := time.Now() log.Info("purging dead objects from tracker") err = s.purgeTracking(dead) if err != nil { // TODO do something better here panic(err) } log.Infow("purging dead from tracker done", "took", time.Since(startPurge)) } // we are done; do some housekeeping err = s.tracker.Sync() if err != nil { // TODO do something better here panic(err) } err = s.setBaseEpoch(coldEpoch) if err != nil { // TODO do something better here panic(err) } } func (s *SplitStore) setBaseEpoch(epoch abi.ChainEpoch) error { s.baseEpoch = epoch // write to datastore return s.ds.Put(baseEpochKey, epochToBytes(epoch)) } func epochToBytes(epoch abi.ChainEpoch) []byte { buf := make([]byte, 16) n := binary.PutUvarint(buf, uint64(epoch)) return buf[:n] } func bytesToEpoch(buf []byte) abi.ChainEpoch { epoch, n := binary.Uvarint(buf) if n < 0 { panic("bogus base epoch bytes") } return abi.ChainEpoch(epoch) }