chore: sync with go1.23.2

Author: ldez

internal/cache/cache.go

@@ -162,22 +162,22 @@ var DebugTest = false
 // func init() { initEnv() }
 
 // var (
-// 	goCacheVerify = godebug.New("gocacheverify")
-// 	goDebugHash   = godebug.New("gocachehash")
-// 	goCacheTest   = godebug.New("gocachetest")
+// 	gocacheverify = godebug.New("gocacheverify")
+// 	gocachehash   = godebug.New("gocachehash")
+// 	gocachetest   = godebug.New("gocachetest")
 // )
 
 // func initEnv() {
-// 	if goCacheVerify.Value() == "1" {
-// 		goCacheVerify.IncNonDefault()
+// 	if gocacheverify.Value() == "1" {
+// 		gocacheverify.IncNonDefault()
 // 		verify = true
 // 	}
-// 	if goDebugHash.Value() == "1" {
-// 		goDebugHash.IncNonDefault()
+// 	if gocachehash.Value() == "1" {
+// 		gocachehash.IncNonDefault()
 // 		debugHash = true
 // 	}
-// 	if goCacheTest.Value() == "1" {
-// 		goCacheTest.IncNonDefault()
+// 	if gocachetest.Value() == "1" {
+// 		gocachetest.IncNonDefault()
 // 		DebugTest = true
 // 	}
 // }

internal/cache/default.go

@@ -13,14 +13,15 @@ import (
 )
 
 // Default returns the default cache to use.
-func Default() (*DiskCache, error) {
+// It never returns nil.
+func Default() Cache {
 	defaultOnce.Do(initDefaultCache)
-	return defaultCache, defaultDirErr
+	return defaultCache
 }
 
 var (
 	defaultOnce  sync.Once
-	defaultCache *DiskCache
+	defaultCache Cache
 )
 
 // cacheREADME is a message stored in a README in the cache directory.
@@ -32,7 +33,13 @@ const cacheREADME = `This directory holds cached build artifacts from golangci-l
 // initDefaultCache does the work of finding the default cache
 // the first time Default is called.
 func initDefaultCache() {
-	dir := DefaultDir()
+	dir, _ := DefaultDir()
+	if dir == "off" {
+		if defaultDirErr != nil {
+			base.Fatalf("build cache is required, but could not be located: %v", defaultDirErr)
+		}
+		base.Fatalf("build cache is disabled by %s=off, but required", envGolangciLintCache)
+	}
 	if err := os.MkdirAll(dir, 0744); err != nil {
 		base.Fatalf("failed to initialize build cache at %s: %s\n", dir, err)
 	}
@@ -43,44 +50,56 @@ func initDefaultCache() {
 		}
 	}
 
-	c, err := Open(dir)
+	diskCache, err := Open(dir)
 	if err != nil {
 		base.Fatalf("failed to initialize build cache at %s: %s\n", dir, err)
 	}
-	defaultCache = c
+
+	if v := os.Getenv(envGolangciLintCacheProg); v != "" {
+		defaultCache = startCacheProg(v, diskCache)
+	} else {
+		defaultCache = diskCache
+	}
 }
 
 var (
-	defaultDirOnce sync.Once
-	defaultDir     string
-	defaultDirErr  error
+	defaultDirOnce    sync.Once
+	defaultDir        string
+	defaultDirChanged bool // effective value differs from $GOLANGCI_LINT_CACHE
+	defaultDirErr     error
 )
 
 // DefaultDir returns the effective GOLANGCI_LINT_CACHE setting.
-func DefaultDir() string {
+// It returns "off" if the cache is disabled,
+// and reports whether the effective value differs from GOLANGCI_LINT_CACHE.
+func DefaultDir() (string, bool) {
 	// Save the result of the first call to DefaultDir for later use in
 	// initDefaultCache. cmd/go/main.go explicitly sets GOCACHE so that
 	// subprocesses will inherit it, but that means initDefaultCache can't
 	// otherwise distinguish between an explicit "off" and a UserCacheDir error.
 
 	defaultDirOnce.Do(func() {
 		defaultDir = os.Getenv(envGolangciLintCache)
-		if filepath.IsAbs(defaultDir) {
-			return
-		}
 		if defaultDir != "" {
+			defaultDirChanged = true
+			if filepath.IsAbs(defaultDir) || defaultDir == "off" {
+				return
+			}
+			defaultDir = "off"
 			defaultDirErr = fmt.Errorf("%s is not an absolute path", envGolangciLintCache)
 			return
 		}
 
 		// Compute default location.
 		dir, err := os.UserCacheDir()
 		if err != nil {
+			defaultDir = "off"
+			defaultDirChanged = true
 			defaultDirErr = fmt.Errorf("%s is not defined and %w", envGolangciLintCache, err)
 			return
 		}
 		defaultDir = filepath.Join(dir, "golangci-lint")
 	})
 
-	return defaultDir
+	return defaultDir, defaultDirChanged
 }

internal/cache/default_gcil.go

@@ -1,3 +1,6 @@
 package cache
 
-const envGolangciLintCache = "GOLANGCI_LINT_CACHE"
+const (
+	envGolangciLintCache     = "GOLANGCI_LINT_CACHE"
+	envGolangciLintCacheProg = "GOLANGCI_LINT_CACHEPROG"
+)

internal/cache/prog.go

@@ -76,7 +76,7 @@ const (
 )
 
 // ProgRequest is the JSON-encoded message that's sent from cmd/go to
-// the GOCACHEPROG child process over stdin. Each JSON object is on its
+// the GOLANGCI_LINT_CACHEPROG child process over stdin. Each JSON object is on its
 // own line. A ProgRequest of Type "put" with BodySize > 0 will be followed
 // by a line containing a base64-encoded JSON string literal of the body.
 type ProgRequest struct {
@@ -152,7 +152,7 @@ func startCacheProg(progAndArgs string, fuzzDirCache Cache) Cache {
 	}
 	args, err := quoted.Split(progAndArgs)
 	if err != nil {
-		base.Fatalf("GOCACHEPROG args: %v", err)
+		base.Fatalf("%s args: %v", envGolangciLintCacheProg, err)
 	}
 	var prog string
 	if len(args) > 0 {
@@ -165,17 +165,17 @@ func startCacheProg(progAndArgs string, fuzzDirCache Cache) Cache {
 	cmd := exec.CommandContext(ctx, prog, args...)
 	out, err := cmd.StdoutPipe()
 	if err != nil {
-		base.Fatalf("StdoutPipe to GOCACHEPROG: %v", err)
+		base.Fatalf("StdoutPipe to %s: %v", envGolangciLintCacheProg, err)
 	}
 	in, err := cmd.StdinPipe()
 	if err != nil {
-		base.Fatalf("StdinPipe to GOCACHEPROG: %v", err)
+		base.Fatalf("StdinPipe to %s: %v", envGolangciLintCacheProg, err)
 	}
 	cmd.Stderr = os.Stderr
 	cmd.Cancel = in.Close
 
 	if err := cmd.Start(); err != nil {
-		base.Fatalf("error starting GOCACHEPROG program %q: %v", prog, err)
+		base.Fatalf("error starting %s program %q: %v", envGolangciLintCacheProg, prog, err)
 	}
 
 	pc := &ProgCache{
@@ -206,14 +206,14 @@ func startCacheProg(progAndArgs string, fuzzDirCache Cache) Cache {
 	for {
 		select {
 		case <-timer.C:
-			log.Printf("# still waiting for GOCACHEPROG %v ...", prog)
+			log.Printf("# still waiting for %s %v ...", envGolangciLintCacheProg, prog)
 		case capRes := <-capResc:
 			can := map[ProgCmd]bool{}
 			for _, cmd := range capRes.KnownCommands {
 				can[cmd] = true
 			}
 			if len(can) == 0 {
-				base.Fatalf("GOCACHEPROG %v declared no supported commands", prog)
+				base.Fatalf("%s %v declared no supported commands", envGolangciLintCacheProg, prog)
 			}
 			pc.can = can
 			return pc
@@ -234,9 +234,9 @@ func (c *ProgCache) readLoop(readLoopDone chan<- struct{}) {
 				c.mu.Lock()
 				inFlight := len(c.inFlight)
 				c.mu.Unlock()
-				base.Fatalf("GOCACHEPROG exited pre-Close with %v pending requests", inFlight)
+				base.Fatalf("%s exited pre-Close with %v pending requests", envGolangciLintCacheProg, inFlight)
 			}
-			base.Fatalf("error reading JSON from GOCACHEPROG: %v", err)
+			base.Fatalf("error reading JSON from %s: %v", envGolangciLintCacheProg, err)
 		}
 		c.mu.Lock()
 		ch, ok := c.inFlight[res.ID]
@@ -245,7 +245,7 @@ func (c *ProgCache) readLoop(readLoopDone chan<- struct{}) {
 		if ok {
 			ch <- res
 		} else {
-			base.Fatalf("GOCACHEPROG sent response for unknown request ID %v", res.ID)
+			base.Fatalf("%s sent response for unknown request ID %v", envGolangciLintCacheProg, res.ID)
 		}
 	}
 }
@@ -303,8 +303,8 @@ func (c *ProgCache) writeToChild(req *ProgRequest, resc chan<- *ProgResponse) (e
 			return nil
 		}
 		if wrote != req.BodySize {
-			return fmt.Errorf("short write writing body to GOCACHEPROG for action %x, object %x: wrote %v; expected %v",
-				req.ActionID, req.ObjectID, wrote, req.BodySize)
+			return fmt.Errorf("short write writing body to %s for action %x, object %x: wrote %v; expected %v",
+				envGolangciLintCacheProg, req.ActionID, req.ObjectID, wrote, req.BodySize)
 		}
 		if _, err := c.bw.WriteString("\"\n"); err != nil {
 			return err
@@ -346,7 +346,7 @@ func (c *ProgCache) Get(a ActionID) (Entry, error) {
 		e.Time = time.Now()
 	}
 	if res.DiskPath == "" {
-		return Entry{}, &entryNotFoundError{errors.New("GOCACHEPROG didn't populate DiskPath on get hit")}
+		return Entry{}, &entryNotFoundError{fmt.Errorf("%s didn't populate DiskPath on get hit", envGolangciLintCacheProg)}
 	}
 	if copy(e.OutputID[:], res.OutputID) != len(res.OutputID) {
 		return Entry{}, &entryNotFoundError{errors.New("incomplete ProgResponse OutputID")}
@@ -400,7 +400,7 @@ func (c *ProgCache) Put(a ActionID, file io.ReadSeeker) (_ OutputID, size int64,
 		return OutputID{}, 0, err
 	}
 	if res.DiskPath == "" {
-		return OutputID{}, 0, errors.New("GOCACHEPROG didn't return DiskPath in put response")
+		return OutputID{}, 0, fmt.Errorf("%s didn't return DiskPath in put response", envGolangciLintCacheProg)
 	}
 	c.noteOutputFile(out, res.DiskPath)
 	return out, size, err

internal/cache/readme.md

@@ -2,6 +2,7 @@
 
 Extracted from `go/src/cmd/go/internal/cache/`.
 
+- sync with go1.23.2
 - sync with go1.22.8
 - sync with go1.21.13
 - sync with go1.20.14

internal/mmap/readme.md

@@ -2,6 +2,7 @@
 
 Extracted from `go/src/cmd/go/internal/mmap/` (related to `cache`).
 
+- sync with go1.23.2
 - sync with go1.22.8
 - sync with go1.21.13
 - sync with go1.20.14

internal/pkgcache/pkgcache.go

@@ -28,20 +28,16 @@ const (
 // Cache is a per-package data cache. A cached data is invalidated when
 // package, or it's dependencies change.
 type Cache struct {
-	lowLevelCache *cache.DiskCache
+	lowLevelCache cache.Cache
 	pkgHashes     sync.Map
 	sw            *timeutils.Stopwatch
 	log           logutils.Log
 	ioSem         chan struct{} // semaphore limiting parallel IO
 }
 
 func NewCache(sw *timeutils.Stopwatch, log logutils.Log) (*Cache, error) {
-	c, err := cache.Default()
-	if err != nil {
-		return nil, err
-	}
 	return &Cache{
-		lowLevelCache: c,
+		lowLevelCache: cache.Default(),
 		sw:            sw,
 		log:           log,
 		ioSem:         make(chan struct{}, runtime.GOMAXPROCS(-1)),
@@ -50,7 +46,12 @@ func NewCache(sw *timeutils.Stopwatch, log logutils.Log) (*Cache, error) {
 
 func (c *Cache) Trim() {
 	c.sw.TrackStage("trim", func() {
-		err := c.lowLevelCache.Trim()
+		llc, ok := c.lowLevelCache.(*cache.DiskCache)
+		if !ok {
+			return
+		}
+
+		err := llc.Trim()
 		if err != nil {
 			c.log.Errorf("cache trim: %v", err)
 		}

internal/quoted/readme.md

@@ -2,5 +2,6 @@
 
 Extracted from `go/src/cmd/internal/quoted/` (related to `cache`).
 
+- sync go1.23.2
 - sync go1.22.8
 - sync go1.21.13

internal/testenv/readme.md

@@ -4,5 +4,6 @@ Extracted from `go/src/internal/testenv/`.
 
 Only the function `SyscallIsNotSupported` is extracted (related to `cache`).
 
+- sync with go1.23.2
 - sync with go1.22.8
 - sync with go1.21.13

pkg/commands/cache.go

@@ -51,7 +51,7 @@ func newCacheCommand() *cacheCommand {
 }
 
 func (*cacheCommand) executeClean(_ *cobra.Command, _ []string) error {
-	cacheDir := cache.DefaultDir()
+	cacheDir, _ := cache.DefaultDir()
 
 	if err := os.RemoveAll(cacheDir); err != nil {
 		return fmt.Errorf("failed to remove dir %s: %w", cacheDir, err)
@@ -61,7 +61,8 @@ func (*cacheCommand) executeClean(_ *cobra.Command, _ []string) error {
 }
 
 func (*cacheCommand) executeStatus(_ *cobra.Command, _ []string) {
-	cacheDir := cache.DefaultDir()
+	cacheDir, _ := cache.DefaultDir()
+
 	_, _ = fmt.Fprintf(logutils.StdOut, "Dir: %s\n", cacheDir)
 
 	cacheSizeBytes, err := dirSizeBytes(cacheDir)