Add cache builtin

Author: hinshun

builtin/lookup.go

@@ -17,6 +17,7 @@ var (
 			"git":                   Git{},
 			"local":                 Local{},
 			"frontend":              Frontend{},
+			"cache":                 Cache{},
 			"run":                   Run{},
 			"env":                   Env{},
 			"dir":                   Dir{},
@@ -108,7 +109,7 @@ var (
 			"readonly":   Readonly{},
 			"tmpfs":      Tmpfs{},
 			"sourcePath": SourcePath{},
-			"cache":      Cache{},
+			"cache":      MountCache{},
 		},
 		"option::mkdir": {
 			"createParents": CreateParents{},

codegen/builtin.go

@@ -328,6 +328,64 @@ func (f Frontend) Call(ctx context.Context, cln *client.Client, val Value, opts
 	return NewValue(ctx, fs)
 }
 
+type Cache struct{}
+
+func (c Cache) Call(ctx context.Context, cln *client.Client, val Value, opts Option, input Value, ref string) (Value, error) {
+	named, err := reference.ParseNormalizedNamed(ref)
+	if err != nil {
+		return nil, errdefs.WithInvalidImageRef(err, Arg(ctx, 1), ref)
+	}
+	ref = reference.TagNameOnly(named).String()
+
+	resolver := ImageResolver(ctx)
+	if resolver != nil {
+		platform := DefaultPlatform(ctx)
+		resolveOpt := llb.ResolveImageConfigOpt{
+			Platform: &platform,
+		}
+
+		dgst, config, err := resolver.ResolveImageConfig(ctx, ref, resolveOpt)
+		if err == nil {
+			var imageOpts []llb.ImageOption
+			imageOpts = append(imageOpts, llb.Platform(platform))
+			for _, opt := range SourceMap(ctx) {
+				imageOpts = append(imageOpts, opt)
+			}
+
+			canonical, err := reference.WithDigest(named, dgst)
+			if err != nil {
+				return nil, errdefs.WithInvalidImageRef(err, Arg(ctx, 1), ref)
+			}
+
+			cacheVal, err := NewValue(ctx, llb.Image(canonical.String()))
+			if err != nil {
+				return nil, Arg(ctx, 1).WithError(err)
+			}
+
+			fs, err := cacheVal.Filesystem()
+			if err != nil {
+				return nil, Arg(ctx, 1).WithError(err)
+			}
+
+			fs.State, err = fs.State.WithImageConfig(config)
+			if err != nil {
+				return nil, Arg(ctx, 1).WithError(err)
+			}
+
+			fs.Image = &solver.ImageSpec{}
+			err = json.Unmarshal(config, fs.Image)
+			if err != nil {
+				return nil, Arg(ctx, 1).WithError(err)
+			}
+			return NewValue(ctx, fs)
+		} else { // not found
+			return (DockerPush{}).Call(ctx, cln, input, opts, ref)
+		}
+	}
+
+	return NewValue(ctx, input)
+}
+
 type Env struct{}
 
 func (e Env) Call(ctx context.Context, cln *client.Client, val Value, opts Option, key, value string) (Value, error) {

codegen/builtin_fs.go

@@ -693,10 +693,10 @@ func (m Mount) Call(ctx context.Context, cln *client.Client, val Value, opts Opt
 		return nil, err
 	}
 
-	var cache *Cache
+	var cache *MountCache
 	for _, opt := range opts {
 		var ok bool
-		cache, ok = opt.(*Cache)
+		cache, ok = opt.(*MountCache)
 		if ok {
 			break
 		}
@@ -858,11 +858,11 @@ func (sp SourcePath) Call(ctx context.Context, cln *client.Client, val Value, op
 	return NewValue(ctx, append(retOpts, llbutil.WithSourcePath(path)))
 }
 
-type Cache struct {
+type MountCache struct {
 	ast.Node
 }
 
-func (c Cache) Call(ctx context.Context, cln *client.Client, val Value, opts Option, id, mode string) (Value, error) {
+func (mc MountCache) Call(ctx context.Context, cln *client.Client, val Value, opts Option, id, mode string) (Value, error) {
 	retOpts, err := val.Option()
 	if err != nil {
 		return nil, err
@@ -880,7 +880,7 @@ func (c Cache) Call(ctx context.Context, cln *client.Client, val Value, opts Opt
 		return nil, errdefs.WithInvalidSharingMode(Arg(ctx, 1), mode, []string{"shared", "private", "locked"})
 	}
 
-	retOpts = append(retOpts, &Cache{ProgramCounter(ctx)}, llbutil.WithPersistentCacheDir(id, sharing))
+	retOpts = append(retOpts, &MountCache{ProgramCounter(ctx)}, llbutil.WithPersistentCacheDir(id, sharing))
 	return NewValue(ctx, retOpts)
 }
 

codegen/builtin_option.go

@@ -1,4 +1,20 @@
 ## <span class='hlb-type'>fs</span> functions
+### <span class='hlb-type'>fs</span> <span class='hlb-name'>cache</span>(<span class='hlb-type'>fs</span> <span class='hlb-variable'>input</span>, <span class='hlb-type'>string</span> <span class='hlb-variable'>ref</span>)
+
+!!! info "<span class='hlb-type'>fs</span> <span class='hlb-variable'>input</span>"
+	
+!!! info "<span class='hlb-type'>string</span> <span class='hlb-variable'>ref</span>"
+	
+
+
+
+	#!hlb
+	fs default() {
+		cache scratch "ref"
+	}
+
+
+
 ### <span class='hlb-type'>fs</span> <span class='hlb-name'>cmd</span>(<span class='hlb-type'>string</span> <span class='hlb-variable'>args</span>)
 
 !!! info "<span class='hlb-type'>string</span> <span class='hlb-variable'>args</span>"

docs/reference.md

@@ -109,6 +109,14 @@ option::frontend input(string key, fs value)
 # @return an option to provide a key value pair to the external frontend.
 option::frontend opt(string key, string value)
 
+# Caches an input fs by its vertex digest.
+# If the image exists then use that image instead of executing input.
+#
+# @param input a filesystem to cache by vertex digest.
+# @param ref a docker registry reference. if not fully qualified, it will be
+# @return a filesystem of input from either building or image.
+fs cache(fs input, string ref)
+
 # Sets the current shell command to use when executing subsequent "run"
 # methods. By default, this is ["sh", "-c"].
 #