native build directories hardlinking file fetcher de-duplicates in-flight download requests

Author: HongboDu-at

pkg/cas/hardlinking_file_fetcher.go

@@ -26,6 +26,14 @@ type hardlinkingFileFetcher struct {
 
 	evictionLock sync.Mutex
 	evictionSet  eviction.Set[string]
+
+	downloadsLock sync.Mutex
+	downloads     map[string]*download
+}
+
+type download struct {
+	wait chan struct{}
+	err  error
 }
 
 // NewHardlinkingFileFetcher is an adapter for FileFetcher that stores
@@ -43,6 +51,8 @@ func NewHardlinkingFileFetcher(base FileFetcher, cacheDirectory filesystem.Direc
 		filesSize: map[string]int64{},
 
 		evictionSet: evictionSet,
+
+		downloads: map[string]*download{},
 	}
 }
 
@@ -71,59 +81,111 @@ func (ff *hardlinkingFileFetcher) GetFile(ctx context.Context, blobDigest digest
 	}
 
 	// If the file is present in the cache, hardlink it to the destination.
-	wasMissing := false
-	ff.filesLock.RLock()
-	if _, ok := ff.filesSize[key]; ok {
-		ff.evictionLock.Lock()
-		ff.evictionSet.Touch(key)
-		ff.evictionLock.Unlock()
-
-		if err := ff.cacheDirectory.Link(path.MustNewComponent(key), directory, name); err == nil {
-			// Successfully hardlinked the file to its destination.
-			ff.filesLock.RUnlock()
-			return nil
-		} else if !os.IsNotExist(err) {
-			ff.filesLock.RUnlock()
-			return util.StatusWrapfWithCode(err, codes.Internal, "Failed to create hardlink to cached file %#v", key)
-		}
+	wasMissing, err := ff.tryLinkFromCache(key, directory, name)
+	if err == nil {
+		return nil
+	} else if !wasMissing {
+		return err
+	}
 
-		// The file was part of the cache, even though it did not
-		// exist on disk. Some other process may have tampered
-		// with the cache directory's contents.
-		wasMissing = true
+	// A download is required. Let's see if one is already in progress.
+	ff.downloadsLock.Lock()
+	d, ok := ff.downloads[key]
+	if ok {
+		// A download is already in progress. Wait for it to finish.
+		ff.downloadsLock.Unlock()
+		select {
+		case <-d.wait:
+			if d.err != nil {
+				return d.err
+			}
+			// The download should have placed the file in the cache.
+			// Try linking from the cache one more time.
+			wasMissingAfterWait, errAfterWait := ff.tryLinkFromCache(key, directory, name)
+			if errAfterWait == nil {
+				return nil
+			} else if wasMissingAfterWait {
+				return util.StatusWrapfWithCode(errAfterWait, codes.Internal, "Failed to link from cache for %#v after download", key)
+			}
+			return errAfterWait
+		case <-ctx.Done():
+			return util.StatusFromContext(ctx)
+		}
 	}
-	ff.filesLock.RUnlock()
 
-	// Download the file at the intended location.
-	if err := ff.base.GetFile(ctx, blobDigest, directory, name, isExecutable); err != nil {
-		return err
+	// Start a new download.
+	d = &download{wait: make(chan struct{})}
+	ff.downloads[key] = d
+	ff.downloadsLock.Unlock()
+
+	downloadErr := ff.base.GetFile(ctx, blobDigest, directory, name, isExecutable)
+	if downloadErr == nil {
+		// The file was downloaded successfully. Place it into the
+		// cache, so that successive calls may use it.
+		ff.filesLock.Lock()
+		if _, ok := ff.filesSize[key]; !ok {
+			ff.evictionLock.Lock()
+
+			// Remove old files from the cache if necessary.
+			sizeBytes := blobDigest.GetSizeBytes()
+			if err := ff.makeSpace(sizeBytes); err != nil {
+				downloadErr = err
+			} else {
+				// Hardlink the file into the cache.
+				if err := directory.Link(name, ff.cacheDirectory, path.MustNewComponent(key)); err != nil && !os.IsExist(err) {
+					downloadErr = util.StatusWrapfWithCode(err, codes.Internal, "Failed to add cached file %#v", key)
+				} else {
+					ff.evictionSet.Insert(key)
+					ff.filesSize[key] = sizeBytes
+					ff.filesTotalSize += sizeBytes
+				}
+			}
+			ff.evictionLock.Unlock()
+		} else if wasMissing {
+			// The file was already part of our bookkeeping,
+			// but was missing on disk. Repair this by adding
+			// a link to the newly downloaded file.
+			if err := directory.Link(name, ff.cacheDirectory, path.MustNewComponent(key)); err != nil && !os.IsExist(err) {
+				downloadErr = util.StatusWrapfWithCode(err, codes.Internal, "Failed to repair cached file %#v", key)
+			}
+		}
+		ff.filesLock.Unlock()
 	}
 
-	ff.filesLock.Lock()
-	defer ff.filesLock.Unlock()
-	if _, ok := ff.filesSize[key]; !ok {
-		ff.evictionLock.Lock()
-		defer ff.evictionLock.Unlock()
+	// Unblock waiters.
+	ff.downloadsLock.Lock()
+	d.err = downloadErr
+	delete(ff.downloads, key)
+	ff.downloadsLock.Unlock()
+	close(d.wait)
 
-		// Remove old files from the cache if necessary.
-		sizeBytes := blobDigest.GetSizeBytes()
-		if err := ff.makeSpace(sizeBytes); err != nil {
-			return err
-		}
+	return downloadErr
+}
 
-		// Hardlink the file into the cache.
-		if err := directory.Link(name, ff.cacheDirectory, path.MustNewComponent(key)); err != nil && !os.IsExist(err) {
-			return util.StatusWrapfWithCode(err, codes.Internal, "Failed to add cached file %#v", key)
-		}
-		ff.evictionSet.Insert(key)
-		ff.filesSize[key] = sizeBytes
-		ff.filesTotalSize += sizeBytes
-	} else if wasMissing {
-		// Even though the file is part of our bookkeeping, we
-		// observed it didn't exist. Repair this inconsistency.
-		if err := directory.Link(name, ff.cacheDirectory, path.MustNewComponent(key)); err != nil && !os.IsExist(err) {
-			return util.StatusWrapfWithCode(err, codes.Internal, "Failed to repair cached file %#v", key)
-		}
+// tryLinkFromCache attempts to create a hardlink from the cache to a
+// file in the build directory. The first return value is whether the
+// file was present in the cache's bookkeeping, but missing on disk.
+func (ff *hardlinkingFileFetcher) tryLinkFromCache(key string, directory filesystem.Directory, name path.Component) (bool, error) {
+	ff.filesLock.RLock()
+	_, ok := ff.filesSize[key]
+	ff.filesLock.RUnlock()
+	if !ok {
+		return true, os.ErrNotExist
 	}
-	return nil
+
+	ff.evictionLock.Lock()
+	ff.evictionSet.Touch(key)
+	ff.evictionLock.Unlock()
+
+	if err := ff.cacheDirectory.Link(path.MustNewComponent(key), directory, name); err == nil {
+		// Successfully hardlinked the file to its destination.
+		return false, nil
+	} else if !os.IsNotExist(err) {
+		return false, util.StatusWrapfWithCode(err, codes.Internal, "Failed to create hardlink to cached file %#v", key)
+	}
+
+	// The file was part of the cache, even though it did not
+	// exist on disk. Some other process may have tampered with
+	// the cache directory's contents.
+	return true, os.ErrNotExist
 }