feat: add new command: prune (#1198)

* Add new command: prune

* Change ther permission for lily api

---------

Co-authored-by: Terry <[email protected]>

Author: Terryhung

commands/chain.go

@@ -52,6 +52,7 @@ var ChainCmd = &cli.Command{
 		ChainStateInspect,
 		ChainStateCompute,
 		ChainStateComputeRange,
+		ChainPruneCmd,
 	},
 }
 
@@ -813,6 +814,105 @@ var ChainSetHeadCmd = &cli.Command{
 	},
 }
 
+var chainPruneHotGCCmd = &cli.Command{
+	Name:  "hot",
+	Usage: "run online (badger vlog) garbage collection on hotstore",
+	Flags: []cli.Flag{
+		&cli.Float64Flag{Name: "threshold", Value: 0.01, Usage: "Threshold of vlog garbage for gc"},
+		&cli.BoolFlag{Name: "periodic", Value: false, Usage: "Run periodic gc over multiple vlogs. Otherwise run gc once"},
+	},
+	Action: func(cctx *cli.Context) error {
+		ctx := lotuscli.ReqContext(cctx)
+		lapi, closer, err := GetAPI(ctx)
+		if err != nil {
+			return err
+		}
+		defer closer()
+
+		opts := api.HotGCOpts{}
+		opts.Periodic = cctx.Bool("periodic")
+		opts.Threshold = cctx.Float64("threshold")
+
+		gcStart := time.Now()
+		err = lapi.ChainHotGC(ctx, opts)
+		gcTime := time.Since(gcStart)
+		fmt.Printf("Online GC took %v (periodic <%t> threshold <%f>)", gcTime, opts.Periodic, opts.Threshold)
+		return err
+	},
+}
+
+var chainPruneHotMovingGCCmd = &cli.Command{
+	Name:  "hot-moving",
+	Usage: "run moving gc on hotstore",
+	Action: func(cctx *cli.Context) error {
+		ctx := lotuscli.ReqContext(cctx)
+		lapi, closer, err := GetAPI(ctx)
+		if err != nil {
+			return err
+		}
+		defer closer()
+		opts := api.HotGCOpts{}
+		opts.Moving = true
+
+		gcStart := time.Now()
+		err = lapi.ChainHotGC(ctx, opts)
+		gcTime := time.Since(gcStart)
+		fmt.Printf("Moving GC took %v", gcTime)
+		return err
+	},
+}
+
+var chainPruneColdCmd = &cli.Command{
+	Name:  "compact-cold",
+	Usage: "force splitstore compaction on cold store state and run gc",
+	Flags: []cli.Flag{
+		&cli.BoolFlag{
+			Name:  "online-gc",
+			Value: false,
+			Usage: "use online gc for garbage collecting the coldstore",
+		},
+		&cli.BoolFlag{
+			Name:  "moving-gc",
+			Value: false,
+			Usage: "use moving gc for garbage collecting the coldstore",
+		},
+		&cli.IntFlag{
+			Name:  "retention",
+			Value: -1,
+			Usage: "specify state retention policy",
+		},
+	},
+	Action: func(cctx *cli.Context) error {
+		ctx := lotuscli.ReqContext(cctx)
+		lapi, closer, err := GetAPI(ctx)
+		if err != nil {
+			return err
+		}
+		defer closer()
+
+		opts := api.PruneOpts{}
+		if cctx.Bool("online-gc") {
+			opts.MovingGC = false
+		}
+		if cctx.Bool("moving-gc") {
+			opts.MovingGC = true
+		}
+		opts.RetainState = int64(cctx.Int("retention"))
+
+		return lapi.ChainPrune(ctx, opts)
+	},
+}
+
+var ChainPruneCmd = &cli.Command{
+	Name:  "prune",
+	Usage: "splitstore gc",
+	Subcommands: []*cli.Command{
+		chainPruneColdCmd,
+		chainPruneHotGCCmd,
+		chainPruneHotMovingGCCmd,
+	},
+}
+
 func printTipSet(format string, ts *types.TipSet) {
 	format = strings.ReplaceAll(format, "<height>", fmt.Sprint(ts.Height()))
 	format = strings.ReplaceAll(format, "<time>", time.Unix(int64(ts.MinTimestamp()), 0).Format(time.Stamp))

lens/lily/api.go

@@ -52,6 +52,8 @@ type LilyAPI interface {
 	ChainGetParentMessages(context.Context, cid.Cid) ([]api.Message, error)                            //perm:read
 	ChainSetHead(context.Context, types.TipSetKey) error                                               //perm:read
 	ChainGetGenesis(context.Context) (*types.TipSet, error)                                            //perm:read
+	ChainPrune(ctx context.Context, opts api.PruneOpts) error                                          //perm:read
+	ChainHotGC(ctx context.Context, opts api.HotGCOpts) error                                          //perm:read
 
 	// trigger graceful shutdown
 	Shutdown(context.Context) error

lens/lily/struct.go

@@ -61,6 +61,8 @@ type LilyAPIStruct struct {
 		ChainGetTipSetAfterHeight func(context.Context, abi.ChainEpoch, types.TipSetKey) (*types.TipSet, error) `perm:"read"`
 		ChainSetHead              func(context.Context, types.TipSetKey) error                                  `perm:"read"`
 		ChainGetGenesis           func(context.Context) (*types.TipSet, error)                                  `perm:"read"`
+		ChainPrune                func(ctx context.Context, opts api.PruneOpts) error                           `perm:"read"`
+		ChainHotGC                func(ctx context.Context, opts api.HotGCOpts) error                           `perm:"read"`
 
 		LogList          func(context.Context) ([]string, error)     `perm:"read"`
 		LogSetLevel      func(context.Context, string, string) error `perm:"read"`
@@ -139,6 +141,14 @@ func (s *LilyAPIStruct) ChainSetHead(ctx context.Context, key types.TipSetKey) e
 	return s.Internal.ChainSetHead(ctx, key)
 }
 
+func (s *LilyAPIStruct) ChainPrune(ctx context.Context, opts api.PruneOpts) error {
+	return s.Internal.ChainPrune(ctx, opts)
+}
+
+func (s *LilyAPIStruct) ChainHotGC(ctx context.Context, opts api.HotGCOpts) error {
+	return s.Internal.ChainHotGC(ctx, opts)
+}
+
 func (s *LilyAPIStruct) ChainGetGenesis(ctx context.Context) (*types.TipSet, error) {
 	return s.Internal.ChainGetGenesis(ctx)
 }