Merge pull request #159 from HileQAQ/main

liulanzheng · web-flow · commit 4b29fed05a2c · 2022-11-23T12:26:28.000+08:00
Add zstd compress options for image convert
diff --git a/cmd/ctr/overlaybd_conv.go b/cmd/ctr/overlaybd_conv.go
@@ -58,6 +58,16 @@ var convertCommand = cli.Command{
 			Usage: "data base config string used for layer deduplication",
 			Value: "",
 		},
+		cli.StringFlag{
+			Name:  "algorithm",
+			Usage: "compress algorithm uses in zfile, [lz4|zstd]",
+			Value: "",
+		},
+		cli.IntFlag{
+			Name:  "bs",
+			Usage: "The size of a compressed data block in KB. Must be a power of two between 4K~64K [4/8/16/32/64])",
+			Value: 0,
+		},
 	),
 	Action: func(context *cli.Context) error {
 		var (
@@ -97,6 +107,10 @@ var convertCommand = cli.Command{
 			obdOpts = append(obdOpts, obdconv.WithDbstr(dbstr))
 			fmt.Printf("database config string: %s\n", dbstr)
 		}
+		algorithm := context.String("algorithm")
+		obdOpts = append(obdOpts, obdconv.WithAlgorithm(algorithm))
+		blockSize := context.Int("bs")
+		obdOpts = append(obdOpts, obdconv.WithBlockSize(blockSize))
 
 		resolver, err := commands.GetResolver(ctx, context)
 		if err != nil {
diff --git a/pkg/convertor/convertor.go b/pkg/convertor/convertor.go
@@ -58,6 +58,7 @@ const (
 	labelOverlayBDBlobWritable = "containerd.io/snapshot/overlaybd.writable"
 	labelKeyAccelerationLayer  = "containerd.io/snapshot/overlaybd/acceleration-layer"
 	labelBuildLayerFrom        = "containerd.io/snapshot/overlaybd/build.layer-from"
+	labelKeyZFileConfig        = "containerd.io/snapshot/overlaybd/zfile-config"
 	labelDistributionSource    = "containerd.io/distribution.source"
 )
 
@@ -70,6 +71,11 @@ var (
 	convContentNameFormat  = convSnapshotNameFormat
 )
 
+type ZFileConfig struct {
+	Algorithm string `json:"algorithm"`
+	BlockSize int    `json:"blockSize"`
+}
+
 type ImageConvertor interface {
 	Convert(ctx context.Context, srcManifest ocispec.Manifest, fsType string) (ocispec.Descriptor, error)
 }
@@ -187,21 +193,23 @@ func (loader *contentLoader) Load(ctx context.Context, cs content.Store) (l laye
 
 type overlaybdConvertor struct {
 	ImageConvertor
-	cs      content.Store
-	sn      snapshots.Snapshotter
-	remote  bool
-	fetcher remotes.Fetcher
-	pusher  remotes.Pusher
-	db      *sql.DB
-	host    string
-	repo    string
+	cs       content.Store
+	sn       snapshots.Snapshotter
+	remote   bool
+	fetcher  remotes.Fetcher
+	pusher   remotes.Pusher
+	db       *sql.DB
+	host     string
+	repo     string
+	zfileCfg ZFileConfig
 }
 
-func NewOverlaybdConvertor(ctx context.Context, cs content.Store, sn snapshots.Snapshotter, resolver remotes.Resolver, ref string, dbstr string) (ImageConvertor, error) {
+func NewOverlaybdConvertor(ctx context.Context, cs content.Store, sn snapshots.Snapshotter, resolver remotes.Resolver, ref string, dbstr string, zfileCfg ZFileConfig) (ImageConvertor, error) {
 	c := &overlaybdConvertor{
-		cs:     cs,
-		sn:     sn,
-		remote: false,
+		cs:       cs,
+		sn:       sn,
+		remote:   false,
+		zfileCfg: zfileCfg,
 	}
 	var err error
 	if dbstr != "" {
@@ -505,6 +513,13 @@ func (c *overlaybdConvertor) convertLayers(ctx context.Context, srcDescs []ocisp
 				labelOverlayBDBlobFsType:   fsType,
 			}),
 		}
+		cfgStr, err := json.Marshal(c.zfileCfg)
+		if err != nil {
+			return nil, err
+		}
+		opts = append(opts, snapshots.WithLabels(map[string]string{
+			labelKeyZFileConfig: string(cfgStr),
+		}))
 		lastParentID, err = c.applyOCIV1LayerInZfile(ctx, lastParentID, desc, opts, nil)
 		if err != nil {
 			return nil, err
@@ -606,7 +621,7 @@ func (c *overlaybdConvertor) applyOCIV1LayerInZfile(
 	}
 
 	commitID := fmt.Sprintf(convSnapshotNameFormat, digester.Digest())
-	if err = c.sn.Commit(ctx, commitID, key); err != nil {
+	if err = c.sn.Commit(ctx, commitID, key, snOpts...); err != nil {
 		if !errdefs.IsAlreadyExists(err) {
 			return emptyString, err
 		}
@@ -638,11 +653,13 @@ func (wc *writeCountWrapper) Write(p []byte) (n int, err error) {
 
 // NOTE: based on https://github.com/containerd/containerd/blob/v1.6.8/images/converter/converter.go#L29-L71
 type options struct {
-	fsType   string
-	dbstr    string
-	imgRef   string
-	resolver remotes.Resolver
-	client   *containerd.Client
+	fsType    string
+	dbstr     string
+	imgRef    string
+	algorithm string
+	blockSize int
+	resolver  remotes.Resolver
+	client    *containerd.Client
 }
 
 type Option func(o *options) error
@@ -668,6 +685,20 @@ func WithImageRef(imgRef string) Option {
 	}
 }
 
+func WithAlgorithm(algorithm string) Option {
+	return func(o *options) error {
+		o.algorithm = algorithm
+		return nil
+	}
+}
+
+func WithBlockSize(blockSize int) Option {
+	return func(o *options) error {
+		o.blockSize = blockSize
+		return nil
+	}
+}
+
 func WithResolver(resolver remotes.Resolver) Option {
 	return func(o *options) error {
 		o.resolver = resolver
@@ -703,8 +734,11 @@ func IndexConvertFunc(opts ...Option) converter.ConvertFunc {
 		if err != nil {
 			return nil, errors.Wrapf(err, "failed to read manifest")
 		}
-
-		c, err := NewOverlaybdConvertor(ctx, cs, sn, copts.resolver, imgRef, copts.dbstr)
+		zfileCfg := ZFileConfig{
+			Algorithm: copts.algorithm,
+			BlockSize: copts.blockSize,
+		}
+		c, err := NewOverlaybdConvertor(ctx, cs, sn, copts.resolver, imgRef, copts.dbstr, zfileCfg)
 		if err != nil {
 			return nil, err
 		}
diff --git a/pkg/snapshot/overlay.go b/pkg/snapshot/overlay.go
@@ -18,6 +18,7 @@ package snapshot
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -107,6 +108,9 @@ const (
 	// labelKeyRecordTracePath is the the file path to record trace
 	labelKeyRecordTracePath = "containerd.io/snapshot/overlaybd/record-trace-path"
 
+	// labelKeyZFileConfig is the config of ZFile
+	labelKeyZFileConfig = "containerd.io/snapshot/overlaybd/zfile-config"
+
 	// labelKeyCriImageRef is thr image-ref from cri
 	labelKeyCriImageRef = "containerd.io/snapshot/cri.image-ref"
 
@@ -160,6 +164,11 @@ func DefaultBootConfig() *BootConfig {
 	}
 }
 
+type ZFileConfig struct {
+	Algorithm string `json:"algorithm"`
+	BlockSize int    `json:"blockSize"`
+}
+
 // SnapshotterConfig is used to configure the snapshotter instance
 type SnapshotterConfig struct {
 	// OverlayBDUtilBinDir contains overlaybd-create/overlaybd-commit tools
@@ -668,7 +677,14 @@ func (o *snapshotter) Commit(ctx context.Context, name, key string, opts ...snap
 				return errors.Wrapf(err, "failed to destroy target device for snapshot %s", key)
 			}
 
-			if err := o.commitWritableOverlaybd(ctx, id); err != nil {
+			var zfileCfg ZFileConfig
+			if cfgStr, ok := oinfo.Labels[labelKeyZFileConfig]; ok {
+				if err := json.Unmarshal([]byte(cfgStr), &zfileCfg); err != nil {
+					return err
+				}
+			}
+
+			if err := o.commitWritableOverlaybd(ctx, id, zfileCfg); err != nil {
 				return err
 			}
 
diff --git a/pkg/snapshot/storage.go b/pkg/snapshot/storage.go
@@ -649,13 +649,21 @@ func (o *snapshotter) prepareWritableOverlaybd(ctx context.Context, snID string)
 }
 
 // commitWritableOverlaybd
-func (o *snapshotter) commitWritableOverlaybd(ctx context.Context, snID string) (retErr error) {
+func (o *snapshotter) commitWritableOverlaybd(ctx context.Context, snID string, cfg ZFileConfig) (retErr error) {
 	binpath := filepath.Join(o.config.OverlayBDUtilBinDir, "overlaybd-commit")
-
-	out, err := exec.CommandContext(ctx, binpath, "-z",
+	opts := []string{
+		"-z",
 		o.overlaybdWritableDataPath(snID),
 		o.overlaybdWritableIndexPath(snID),
-		o.magicFilePath(snID)).CombinedOutput()
+		o.magicFilePath(snID),
+	}
+	if cfg.BlockSize != 0 {
+		opts = append(opts, "--bs", strconv.Itoa(cfg.BlockSize))
+	}
+	if cfg.Algorithm != "" {
+		opts = append(opts, "--algorithm", cfg.Algorithm)
+	}
+	out, err := exec.CommandContext(ctx, binpath, opts...).CombinedOutput()
 	if err != nil {
 		return errors.Wrapf(err, "failed to commit writable overlaybd: %s", out)
 	}
