Compute diff from the upper dir of overlayfs-based snapshotter

Signed-off-by: Kohei Tokunaga <[email protected]>

cache/blobs.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"io"
+	"os"
 
 	"github.com/containerd/containerd/content"
 	"github.com/containerd/containerd/diff"
@@ -17,6 +18,7 @@ import (
 	imagespecidentity "github.com/opencontainers/image-spec/identity"
 	ocispecs "github.com/opencontainers/image-spec/specs-go/v1"
 	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
 	"golang.org/x/sync/errgroup"
 )
 
@@ -106,13 +108,30 @@ func computeBlobChain(ctx context.Context, sr *immutableRef, createIfNeeded bool
 			if release != nil {
 				defer release()
 			}
-			desc, err := sr.cm.Differ.Compare(ctx, lower, upper,
-				diff.WithMediaType(mediaType),
-				diff.WithReference(sr.ID()),
-				diff.WithCompressor(compressorFunc),
-			)
-			if err != nil {
-				return nil, err
+			var desc ocispecs.Descriptor
+			if len(lower) > 0 && !isTypeWindows(sr) {
+				// Try optimized diff for overlayfs
+				computed, ok, err := sr.tryComputeOverlayBlob(ctx, lower, upper, mediaType, sr.ID(), compressorFunc)
+				if err != nil {
+					if debugMustOverlayDiff(sr.cm.ManagerOpt.Snapshotter.Name()) {
+						// fallback is disabled. used for testing/debugging.
+						return nil, errors.Wrapf(err, "failed to compute overlay blob")
+					}
+					logrus.Warnf("failed to compute blob (%s) from diff of overlay snapshotter: %+v", sr.ID(), err)
+				}
+				if ok {
+					desc = computed
+				}
+			}
+			if desc.Digest == "" {
+				desc, err = sr.cm.Differ.Compare(ctx, lower, upper,
+					diff.WithMediaType(mediaType),
+					diff.WithReference(sr.ID()),
+					diff.WithCompressor(compressorFunc),
+				)
+				if err != nil {
+					return nil, err
+				}
 			}
 
 			if desc.Annotations == nil {
@@ -308,3 +327,14 @@ func ensureCompression(ctx context.Context, ref *immutableRef, compressionType c
 	})
 	return err
 }
+
+func debugMustOverlayDiff(snapshotter string) bool {
+	if os.Getenv("BUILDKIT_DEBUG_FORCE_OVERLAY_DIFF") != "1" {
+		return false
+	}
+	switch snapshotter {
+	case "overlayfs", "fuse-overlayfs", "stargz":
+		return true
+	}
+	return false
+}