Source file src/cmd/go/internal/work/exec.go

     1  // Copyright 2011 The Go Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  // Action graph execution.
     6  
     7  package work
     8  
     9  import (
    10  	"bytes"
    11  	"cmd/internal/cov/covcmd"
    12  	"cmd/internal/pathcache"
    13  	"context"
    14  	"crypto/sha256"
    15  	"encoding/json"
    16  	"errors"
    17  	"fmt"
    18  	"go/token"
    19  	"internal/lazyregexp"
    20  	"io"
    21  	"io/fs"
    22  	"log"
    23  	"math/rand"
    24  	"os"
    25  	"os/exec"
    26  	"path/filepath"
    27  	"regexp"
    28  	"runtime"
    29  	"slices"
    30  	"sort"
    31  	"strconv"
    32  	"strings"
    33  	"sync"
    34  	"time"
    35  
    36  	"cmd/go/internal/base"
    37  	"cmd/go/internal/cache"
    38  	"cmd/go/internal/cfg"
    39  	"cmd/go/internal/fsys"
    40  	"cmd/go/internal/gover"
    41  	"cmd/go/internal/load"
    42  	"cmd/go/internal/modinfo"
    43  	"cmd/go/internal/modload"
    44  	"cmd/go/internal/str"
    45  	"cmd/go/internal/trace"
    46  	"cmd/internal/buildid"
    47  	"cmd/internal/quoted"
    48  	"cmd/internal/sys"
    49  
    50  	"golang.org/x/tools/go/analysis"
    51  )
    52  
    53  const DefaultCFlags = "-O2 -g"
    54  
    55  // actionList returns the list of actions in the dag rooted at root
    56  // as visited in a depth-first post-order traversal.
    57  func actionList(root *Action) []*Action {
    58  	seen := map[*Action]bool{}
    59  	all := []*Action{}
    60  	var walk func(*Action)
    61  	walk = func(a *Action) {
    62  		if seen[a] {
    63  			return
    64  		}
    65  		seen[a] = true
    66  		for _, a1 := range a.Deps {
    67  			walk(a1)
    68  		}
    69  		all = append(all, a)
    70  	}
    71  	walk(root)
    72  	return all
    73  }
    74  
    75  // Do runs the action graph rooted at root.
    76  func (b *Builder) Do(ctx context.Context, root *Action) {
    77  	ctx, span := trace.StartSpan(ctx, "exec.Builder.Do ("+root.Mode+" "+root.Target+")")
    78  	defer span.Done()
    79  
    80  	if !b.IsCmdList {
    81  		// If we're doing real work, take time at the end to trim the cache.
    82  		c := cache.Default()
    83  		defer func() {
    84  			if err := c.Close(); err != nil {
    85  				base.Fatalf("go: failed to trim cache: %v", err)
    86  			}
    87  		}()
    88  	}
    89  
    90  	// Build list of all actions, assigning depth-first post-order priority.
    91  	// The original implementation here was a true queue
    92  	// (using a channel) but it had the effect of getting
    93  	// distracted by low-level leaf actions to the detriment
    94  	// of completing higher-level actions. The order of
    95  	// work does not matter much to overall execution time,
    96  	// but when running "go test std" it is nice to see each test
    97  	// results as soon as possible. The priorities assigned
    98  	// ensure that, all else being equal, the execution prefers
    99  	// to do what it would have done first in a simple depth-first
   100  	// dependency order traversal.
   101  	all := actionList(root)
   102  	for i, a := range all {
   103  		a.priority = i
   104  	}
   105  
   106  	// Write action graph, without timing information, in case we fail and exit early.
   107  	writeActionGraph := func() {
   108  		if file := cfg.DebugActiongraph; file != "" {
   109  			if strings.HasSuffix(file, ".go") {
   110  				// Do not overwrite Go source code in:
   111  				//	go build -debug-actiongraph x.go
   112  				base.Fatalf("go: refusing to write action graph to %v\n", file)
   113  			}
   114  			js := actionGraphJSON(root)
   115  			if err := os.WriteFile(file, []byte(js), 0666); err != nil {
   116  				fmt.Fprintf(os.Stderr, "go: writing action graph: %v\n", err)
   117  				base.SetExitStatus(1)
   118  			}
   119  		}
   120  	}
   121  	writeActionGraph()
   122  
   123  	b.readySema = make(chan bool, len(all))
   124  
   125  	// Initialize per-action execution state.
   126  	for _, a := range all {
   127  		for _, a1 := range a.Deps {
   128  			a1.triggers = append(a1.triggers, a)
   129  		}
   130  		a.pending = len(a.Deps)
   131  		if a.pending == 0 {
   132  			b.ready.push(a)
   133  			b.readySema <- true
   134  		}
   135  	}
   136  
   137  	// Handle runs a single action and takes care of triggering
   138  	// any actions that are runnable as a result.
   139  	handle := func(ctx context.Context, a *Action) {
   140  		if a.json != nil {
   141  			a.json.TimeStart = time.Now()
   142  		}
   143  		var err error
   144  		if a.Actor != nil && (a.Failed == nil || a.IgnoreFail) {
   145  			// TODO(matloob): Better action descriptions
   146  			desc := "Executing action (" + a.Mode
   147  			if a.Package != nil {
   148  				desc += " " + a.Package.Desc()
   149  			}
   150  			desc += ")"
   151  			ctx, span := trace.StartSpan(ctx, desc)
   152  			a.traceSpan = span
   153  			for _, d := range a.Deps {
   154  				trace.Flow(ctx, d.traceSpan, a.traceSpan)
   155  			}
   156  			err = a.Actor.Act(b, ctx, a)
   157  			span.Done()
   158  		}
   159  		if a.json != nil {
   160  			a.json.TimeDone = time.Now()
   161  		}
   162  
   163  		// The actions run in parallel but all the updates to the
   164  		// shared work state are serialized through b.exec.
   165  		b.exec.Lock()
   166  		defer b.exec.Unlock()
   167  
   168  		if err != nil {
   169  			if b.AllowErrors && a.Package != nil {
   170  				if a.Package.Error == nil {
   171  					a.Package.Error = &load.PackageError{Err: err}
   172  					a.Package.Incomplete = true
   173  				}
   174  			} else {
   175  				if a.Package != nil {
   176  					if ipe, ok := errors.AsType[load.ImportPathError](err); !ok || ipe.ImportPath() != a.Package.ImportPath {
   177  						err = fmt.Errorf("%s: %v", a.Package.ImportPath, err)
   178  					}
   179  				}
   180  				sh := b.Shell(a)
   181  				sh.Errorf("%s", err)
   182  			}
   183  			if a.Failed == nil {
   184  				a.Failed = a
   185  			}
   186  		}
   187  
   188  		for _, a0 := range a.triggers {
   189  			if a.Failed != nil {
   190  				if a0.Mode == "test barrier" {
   191  					// If this action was triggered by a test, there
   192  					// will be a test barrier action in between the test
   193  					// and the true trigger. But there will be other
   194  					// triggers that are other barriers that are waiting
   195  					// for this one. Propagate the failure to the true
   196  					// trigger, but not to the other barriers.
   197  					for _, bt := range a0.triggers {
   198  						if bt.Mode != "test barrier" {
   199  							bt.Failed = a.Failed
   200  						}
   201  					}
   202  				} else {
   203  					a0.Failed = a.Failed
   204  				}
   205  			}
   206  			if a0.pending--; a0.pending == 0 {
   207  				b.ready.push(a0)
   208  				b.readySema <- true
   209  			}
   210  		}
   211  
   212  		if a == root {
   213  			close(b.readySema)
   214  		}
   215  	}
   216  
   217  	var wg sync.WaitGroup
   218  
   219  	// Kick off goroutines according to parallelism.
   220  	// If we are using the -n flag (just printing commands)
   221  	// drop the parallelism to 1, both to make the output
   222  	// deterministic and because there is no real work anyway.
   223  	par := cfg.BuildP
   224  	if cfg.BuildN {
   225  		par = 1
   226  	}
   227  	for i := 0; i < par; i++ {
   228  		wg.Add(1)
   229  		go func() {
   230  			ctx := trace.StartGoroutine(ctx)
   231  			defer wg.Done()
   232  			for {
   233  				select {
   234  				case _, ok := <-b.readySema:
   235  					if !ok {
   236  						return
   237  					}
   238  					// Receiving a value from b.readySema entitles
   239  					// us to take from the ready queue.
   240  					b.exec.Lock()
   241  					a := b.ready.pop()
   242  					b.exec.Unlock()
   243  					handle(ctx, a)
   244  				case <-base.Interrupted:
   245  					base.SetExitStatus(1)
   246  					return
   247  				}
   248  			}
   249  		}()
   250  	}
   251  
   252  	wg.Wait()
   253  
   254  	if tokens != totalTokens || concurrentProcesses != 0 {
   255  		base.Fatalf("internal error: tokens not restored at end of build: tokens: %d, totalTokens: %d, concurrentProcesses: %d",
   256  			tokens, totalTokens, concurrentProcesses)
   257  	}
   258  
   259  	// Write action graph again, this time with timing information.
   260  	writeActionGraph()
   261  }
   262  
   263  // buildActionID computes the action ID for a build action.
   264  func (b *Builder) buildActionID(a *Action) cache.ActionID {
   265  	p := a.Package
   266  	h := cache.NewHash("build " + p.ImportPath)
   267  
   268  	// Configuration independent of compiler toolchain.
   269  	// Note: buildmode has already been accounted for in buildGcflags
   270  	// and should not be inserted explicitly. Most buildmodes use the
   271  	// same compiler settings and can reuse each other's results.
   272  	// If not, the reason is already recorded in buildGcflags.
   273  	fmt.Fprintf(h, "compile\n")
   274  
   275  	// Include information about the origin of the package that
   276  	// may be embedded in the debug info for the object file.
   277  	if cfg.BuildTrimpath {
   278  		// When -trimpath is used with a package built from the module cache,
   279  		// its debug information refers to the module path and version
   280  		// instead of the directory.
   281  		if p.Module != nil {
   282  			fmt.Fprintf(h, "module %s@%s\n", p.Module.Path, p.Module.Version)
   283  		}
   284  	} else if p.Goroot {
   285  		// The Go compiler always hides the exact value of $GOROOT
   286  		// when building things in GOROOT.
   287  		//
   288  		// The C compiler does not, but for packages in GOROOT we rewrite the path
   289  		// as though -trimpath were set. This used to be so that we did not invalidate
   290  		// the build cache (and especially precompiled archive files) when changing
   291  		// GOROOT_FINAL, but we no longer ship precompiled archive files as of Go 1.20
   292  		// (https://go.dev/issue/47257) and no longer support GOROOT_FINAL
   293  		// (https://go.dev/issue/62047).
   294  		// TODO(bcmills): Figure out whether this behavior is still useful.
   295  		//
   296  		// b.WorkDir is always either trimmed or rewritten to
   297  		// the literal string "/tmp/go-build".
   298  	} else if !strings.HasPrefix(p.Dir, b.WorkDir) {
   299  		// -trimpath is not set and no other rewrite rules apply,
   300  		// so the object file may refer to the absolute directory
   301  		// containing the package.
   302  		fmt.Fprintf(h, "dir %s\n", p.Dir)
   303  	}
   304  
   305  	if p.Module != nil {
   306  		fmt.Fprintf(h, "go %s\n", p.Module.GoVersion)
   307  	}
   308  	fmt.Fprintf(h, "goos %s goarch %s\n", cfg.Goos, cfg.Goarch)
   309  	fmt.Fprintf(h, "import %q\n", p.ImportPath)
   310  	fmt.Fprintf(h, "omitdebug %v standard %v local %v prefix %q\n", p.Internal.OmitDebug, p.Standard, p.Internal.Local, p.Internal.LocalPrefix)
   311  	if cfg.BuildTrimpath {
   312  		fmt.Fprintln(h, "trimpath")
   313  	}
   314  	if p.Internal.ForceLibrary {
   315  		fmt.Fprintf(h, "forcelibrary\n")
   316  	}
   317  	if len(p.CgoFiles)+len(p.SwigFiles)+len(p.SwigCXXFiles) > 0 {
   318  		fmt.Fprintf(h, "cgo %q\n", b.toolID("cgo"))
   319  		cppflags, cflags, cxxflags, fflags, ldflags, _ := b.CFlags(p)
   320  
   321  		ccExe := b.ccExe()
   322  		fmt.Fprintf(h, "CC=%q %q %q %q\n", ccExe, cppflags, cflags, ldflags)
   323  		// Include the C compiler tool ID so that if the C
   324  		// compiler changes we rebuild the package.
   325  		if ccID, _, err := b.gccToolID(ccExe[0], "c"); err == nil {
   326  			fmt.Fprintf(h, "CC ID=%q\n", ccID)
   327  		} else {
   328  			fmt.Fprintf(h, "CC ID ERROR=%q\n", err)
   329  		}
   330  		if len(p.CXXFiles)+len(p.SwigCXXFiles) > 0 {
   331  			cxxExe := b.cxxExe()
   332  			fmt.Fprintf(h, "CXX=%q %q\n", cxxExe, cxxflags)
   333  			if cxxID, _, err := b.gccToolID(cxxExe[0], "c++"); err == nil {
   334  				fmt.Fprintf(h, "CXX ID=%q\n", cxxID)
   335  			} else {
   336  				fmt.Fprintf(h, "CXX ID ERROR=%q\n", err)
   337  			}
   338  		}
   339  		if len(p.FFiles) > 0 {
   340  			fcExe := b.fcExe()
   341  			fmt.Fprintf(h, "FC=%q %q\n", fcExe, fflags)
   342  			if fcID, _, err := b.gccToolID(fcExe[0], "f95"); err == nil {
   343  				fmt.Fprintf(h, "FC ID=%q\n", fcID)
   344  			} else {
   345  				fmt.Fprintf(h, "FC ID ERROR=%q\n", err)
   346  			}
   347  		}
   348  		// TODO(rsc): Should we include the SWIG version?
   349  	}
   350  	if p.Internal.Cover.Mode != "" {
   351  		fmt.Fprintf(h, "cover %q %q\n", p.Internal.Cover.Mode, b.toolID("cover"))
   352  	}
   353  	if p.Internal.FuzzInstrument {
   354  		if fuzzFlags := fuzzInstrumentFlags(); fuzzFlags != nil {
   355  			fmt.Fprintf(h, "fuzz %q\n", fuzzFlags)
   356  		}
   357  	}
   358  	if p.Internal.BuildInfo != nil {
   359  		fmt.Fprintf(h, "modinfo %q\n", p.Internal.BuildInfo.String())
   360  	}
   361  
   362  	// Configuration specific to compiler toolchain.
   363  	switch cfg.BuildToolchainName {
   364  	default:
   365  		base.Fatalf("buildActionID: unknown build toolchain %q", cfg.BuildToolchainName)
   366  	case "gc":
   367  		fmt.Fprintf(h, "compile %s %q %q\n", b.toolID("compile"), forcedGcflags, p.Internal.Gcflags)
   368  		if len(p.SFiles) > 0 {
   369  			fmt.Fprintf(h, "asm %q %q %q\n", b.toolID("asm"), forcedAsmflags, p.Internal.Asmflags)
   370  		}
   371  
   372  		// GOARM, GOMIPS, etc.
   373  		key, val, _ := cfg.GetArchEnv()
   374  		fmt.Fprintf(h, "%s=%s\n", key, val)
   375  
   376  		if cfg.CleanGOEXPERIMENT != "" {
   377  			fmt.Fprintf(h, "GOEXPERIMENT=%q\n", cfg.CleanGOEXPERIMENT)
   378  		}
   379  
   380  		// TODO(rsc): Convince compiler team not to add more magic environment variables,
   381  		// or perhaps restrict the environment variables passed to subprocesses.
   382  		// Because these are clumsy, undocumented special-case hacks
   383  		// for debugging the compiler, they are not settable using 'go env -w',
   384  		// and so here we use os.Getenv, not cfg.Getenv.
   385  		magic := []string{
   386  			"GOCLOBBERDEADHASH",
   387  			"GOSSAFUNC",
   388  			"GOSSADIR",
   389  			"GOCOMPILEDEBUG",
   390  		}
   391  		for _, env := range magic {
   392  			if x := os.Getenv(env); x != "" {
   393  				fmt.Fprintf(h, "magic %s=%s\n", env, x)
   394  			}
   395  		}
   396  
   397  	case "gccgo":
   398  		id, _, err := b.gccToolID(BuildToolchain.compiler(), "go")
   399  		if err != nil {
   400  			base.Fatalf("%v", err)
   401  		}
   402  		fmt.Fprintf(h, "compile %s %q %q\n", id, forcedGccgoflags, p.Internal.Gccgoflags)
   403  		fmt.Fprintf(h, "pkgpath %s\n", gccgoPkgpath(p))
   404  		fmt.Fprintf(h, "ar %q\n", BuildToolchain.(gccgoToolchain).ar())
   405  		if len(p.SFiles) > 0 {
   406  			id, _, _ = b.gccToolID(BuildToolchain.compiler(), "assembler-with-cpp")
   407  			// Ignore error; different assembler versions
   408  			// are unlikely to make any difference anyhow.
   409  			fmt.Fprintf(h, "asm %q\n", id)
   410  		}
   411  	}
   412  
   413  	// Input files.
   414  	inputFiles := str.StringList(
   415  		p.GoFiles,
   416  		p.CgoFiles,
   417  		p.CFiles,
   418  		p.CXXFiles,
   419  		p.FFiles,
   420  		p.MFiles,
   421  		p.HFiles,
   422  		p.SFiles,
   423  		p.SysoFiles,
   424  		p.SwigFiles,
   425  		p.SwigCXXFiles,
   426  		p.EmbedFiles,
   427  	)
   428  	for _, file := range inputFiles {
   429  		fmt.Fprintf(h, "file %s %s\n", file, b.fileHash(filepath.Join(p.Dir, file)))
   430  	}
   431  	for _, a1 := range a.Deps {
   432  		p1 := a1.Package
   433  		if p1 != nil {
   434  			fmt.Fprintf(h, "import %s %s\n", p1.ImportPath, contentID(a1.buildID))
   435  		}
   436  		if a1.Mode == "preprocess PGO profile" {
   437  			fmt.Fprintf(h, "pgofile %s\n", b.fileHash(a1.built))
   438  		}
   439  	}
   440  
   441  	return h.Sum()
   442  }
   443  
   444  // needCgoHdr reports whether the actions triggered by this one
   445  // expect to be able to access the cgo-generated header file.
   446  func (b *Builder) needCgoHdr(a *Action) bool {
   447  	// If this build triggers a header install, run cgo to get the header.
   448  	if !b.IsCmdList && (a.Package.UsesCgo() || a.Package.UsesSwig()) && (cfg.BuildBuildmode == "c-archive" || cfg.BuildBuildmode == "c-shared") {
   449  		for _, t1 := range a.triggers {
   450  			if t1.Mode == "install header" {
   451  				return true
   452  			}
   453  		}
   454  		for _, t1 := range a.triggers {
   455  			for _, t2 := range t1.triggers {
   456  				if t2.Mode == "install header" {
   457  					return true
   458  				}
   459  			}
   460  		}
   461  	}
   462  	return false
   463  }
   464  
   465  // allowedVersion reports whether the version v is an allowed version of go
   466  // (one that we can compile).
   467  // v is known to be of the form "1.23".
   468  func allowedVersion(v string) bool {
   469  	// Special case: no requirement.
   470  	if v == "" {
   471  		return true
   472  	}
   473  	return gover.Compare(gover.Local(), v) >= 0
   474  }
   475  
   476  func (b *Builder) computeNonGoOverlay(a *Action, p *load.Package, sh *Shell, objdir string, nonGoFileLists [][]string) error {
   477  OverlayLoop:
   478  	for _, fs := range nonGoFileLists {
   479  		for _, f := range fs {
   480  			if fsys.Replaced(mkAbs(p.Dir, f)) {
   481  				a.nonGoOverlay = make(map[string]string)
   482  				break OverlayLoop
   483  			}
   484  		}
   485  	}
   486  	if a.nonGoOverlay != nil {
   487  		for _, fs := range nonGoFileLists {
   488  			for i := range fs {
   489  				from := mkAbs(p.Dir, fs[i])
   490  				dst := objdir + filepath.Base(fs[i])
   491  				if err := sh.CopyFile(dst, fsys.Actual(from), 0666, false); err != nil {
   492  					return err
   493  				}
   494  				a.nonGoOverlay[from] = dst
   495  			}
   496  		}
   497  	}
   498  
   499  	return nil
   500  }
   501  
   502  // needsBuild reports whether the Action (which must be mode "build") needs
   503  // to produce the built output.
   504  func (b *Builder) needsBuild(a *Action) bool {
   505  	return !b.IsCmdList && a.needBuild || b.NeedExport
   506  }
   507  
   508  const (
   509  	needBuild uint32 = 1 << iota
   510  	needCgoHdr
   511  	needVet
   512  	needCompiledGoFiles
   513  	needCovMetaFile
   514  	needStale
   515  )
   516  
   517  // checkCacheForBuild checks the cache for the outputs of the buildAction to determine
   518  // what work needs to be done by it and the actions preceding it. a is the action
   519  // currently being run, which has an actor of type *checkCacheActor and is a dependency
   520  // of the buildAction.
   521  func (b *Builder) checkCacheForBuild(a, buildAction *Action, covMetaFileName string) (_ *checkCacheProvider, err error) {
   522  	p := buildAction.Package
   523  	sh := b.Shell(a)
   524  
   525  	bit := func(x uint32, b bool) uint32 {
   526  		if b {
   527  			return x
   528  		}
   529  		return 0
   530  	}
   531  
   532  	cachedBuild := false
   533  	needCovMeta := p.Internal.Cover.GenMeta
   534  	need := bit(needBuild, !b.IsCmdList && buildAction.needBuild || b.NeedExport) |
   535  		bit(needCgoHdr, b.needCgoHdr(buildAction)) |
   536  		bit(needVet, buildAction.needVet) |
   537  		bit(needCovMetaFile, needCovMeta) |
   538  		bit(needCompiledGoFiles, b.NeedCompiledGoFiles)
   539  
   540  	if !p.BinaryOnly {
   541  		// We pass 'a' (this checkCacheAction) to buildActionID so that we use its dependencies,
   542  		// which are the actual package dependencies, rather than the buildAction's dependencies
   543  		// which also includes this action and the cover action.
   544  		if b.useCache(buildAction, b.buildActionID(a), p.Target, need&needBuild != 0) {
   545  			// We found the main output in the cache.
   546  			// If we don't need any other outputs, we can stop.
   547  			// Otherwise, we need to write files to a.Objdir (needVet, needCgoHdr).
   548  			// Remember that we might have them in cache
   549  			// and check again after we create a.Objdir.
   550  			cachedBuild = true
   551  			buildAction.output = []byte{} // start saving output in case we miss any cache results
   552  			need &^= needBuild
   553  			if b.NeedExport {
   554  				p.Export = buildAction.built
   555  				p.BuildID = buildAction.buildID
   556  			}
   557  			if need&needCompiledGoFiles != 0 {
   558  				if err := b.loadCachedCompiledGoFiles(buildAction); err == nil {
   559  					need &^= needCompiledGoFiles
   560  				}
   561  			}
   562  		}
   563  
   564  		// Source files might be cached, even if the full action is not
   565  		// (e.g., go list -compiled -find).
   566  		if !cachedBuild && need&needCompiledGoFiles != 0 {
   567  			if err := b.loadCachedCompiledGoFiles(buildAction); err == nil {
   568  				need &^= needCompiledGoFiles
   569  			}
   570  		}
   571  
   572  		if need == 0 {
   573  			return &checkCacheProvider{need: need}, nil
   574  		}
   575  		defer b.flushOutput(a)
   576  	}
   577  
   578  	defer func() {
   579  		if err != nil && b.IsCmdList && b.NeedError && p.Error == nil {
   580  			p.Error = &load.PackageError{Err: err}
   581  		}
   582  	}()
   583  
   584  	if p.Error != nil {
   585  		// Don't try to build anything for packages with errors. There may be a
   586  		// problem with the inputs that makes the package unsafe to build.
   587  		return nil, p.Error
   588  	}
   589  
   590  	// TODO(matloob): return early for binary-only packages so that we don't need to indent
   591  	// the core of this function in the if !p.BinaryOnly block above.
   592  	if p.BinaryOnly {
   593  		p.Stale = true
   594  		p.StaleReason = "binary-only packages are no longer supported"
   595  		if b.IsCmdList {
   596  			return &checkCacheProvider{need: 0}, nil
   597  		}
   598  		return nil, errors.New("binary-only packages are no longer supported")
   599  	}
   600  
   601  	if p.Module != nil && !allowedVersion(p.Module.GoVersion) {
   602  		return nil, errors.New("module requires Go " + p.Module.GoVersion + " or later")
   603  	}
   604  
   605  	if err := b.checkDirectives(buildAction); err != nil {
   606  		return nil, err
   607  	}
   608  
   609  	if err := sh.Mkdir(buildAction.Objdir); err != nil {
   610  		return nil, err
   611  	}
   612  
   613  	// Load cached cgo header, but only if we're skipping the main build (cachedBuild==true).
   614  	if cachedBuild && need&needCgoHdr != 0 {
   615  		if err := b.loadCachedCgoHdr(buildAction); err == nil {
   616  			need &^= needCgoHdr
   617  		}
   618  	}
   619  
   620  	// Load cached coverage meta-data file fragment, but only if we're
   621  	// skipping the main build (cachedBuild==true).
   622  	if cachedBuild && need&needCovMetaFile != 0 {
   623  		if err := b.loadCachedObjdirFile(buildAction, cache.Default(), covMetaFileName); err == nil {
   624  			need &^= needCovMetaFile
   625  		}
   626  	}
   627  
   628  	// Load cached vet config, but only if that's all we have left
   629  	// (need == needVet, not testing just the one bit).
   630  	// If we are going to do a full build anyway,
   631  	// we're going to regenerate the files in the build action anyway.
   632  	if need == needVet {
   633  		if err := b.loadCachedVet(buildAction, a.Deps); err == nil {
   634  			need &^= needVet
   635  		}
   636  	}
   637  
   638  	return &checkCacheProvider{need: need}, nil
   639  }
   640  
   641  func (b *Builder) runCover(a, buildAction *Action, objdir string, gofiles, cgofiles []string) (*coverProvider, error) {
   642  	p := a.Package
   643  	sh := b.Shell(a)
   644  
   645  	var cacheProvider *checkCacheProvider
   646  	for _, dep := range a.Deps {
   647  		if pr, ok := dep.Provider.(*checkCacheProvider); ok {
   648  			cacheProvider = pr
   649  		}
   650  	}
   651  	if cacheProvider == nil {
   652  		base.Fatalf("internal error: could not find checkCacheProvider")
   653  	}
   654  	need := cacheProvider.need
   655  
   656  	if need == 0 {
   657  		return nil, nil
   658  	}
   659  
   660  	if err := sh.Mkdir(a.Objdir); err != nil {
   661  		return nil, err
   662  	}
   663  
   664  	gofiles = slices.Clone(gofiles)
   665  	cgofiles = slices.Clone(cgofiles)
   666  
   667  	outfiles := []string{}
   668  	infiles := []string{}
   669  	for i, file := range str.StringList(gofiles, cgofiles) {
   670  		if base.IsTestFile(file) {
   671  			continue // Not covering this file.
   672  		}
   673  
   674  		var sourceFile string
   675  		var coverFile string
   676  		if base, found := strings.CutSuffix(file, ".cgo1.go"); found {
   677  			// cgo files have absolute paths
   678  			base = filepath.Base(base)
   679  			sourceFile = file
   680  			coverFile = objdir + base + ".cgo1.go"
   681  		} else {
   682  			sourceFile = filepath.Join(p.Dir, file)
   683  			coverFile = objdir + file
   684  		}
   685  		coverFile = strings.TrimSuffix(coverFile, ".go") + ".cover.go"
   686  		infiles = append(infiles, sourceFile)
   687  		outfiles = append(outfiles, coverFile)
   688  		if i < len(gofiles) {
   689  			gofiles[i] = coverFile
   690  		} else {
   691  			cgofiles[i-len(gofiles)] = coverFile
   692  		}
   693  	}
   694  
   695  	if len(infiles) != 0 {
   696  		// Coverage instrumentation creates new top level
   697  		// variables in the target package for things like
   698  		// meta-data containers, counter vars, etc. To avoid
   699  		// collisions with user variables, suffix the var name
   700  		// with 12 hex digits from the SHA-256 hash of the
   701  		// import path. Choice of 12 digits is historical/arbitrary,
   702  		// we just need enough of the hash to avoid accidents,
   703  		// as opposed to precluding determined attempts by
   704  		// users to break things.
   705  		sum := sha256.Sum256([]byte(a.Package.ImportPath))
   706  		coverVar := fmt.Sprintf("goCover_%x_", sum[:6])
   707  		mode := a.Package.Internal.Cover.Mode
   708  		if mode == "" {
   709  			panic("covermode should be set at this point")
   710  		}
   711  		if newoutfiles, err := b.cover(a, infiles, outfiles, coverVar, mode); err != nil {
   712  			return nil, err
   713  		} else {
   714  			outfiles = newoutfiles
   715  			gofiles = append([]string{newoutfiles[0]}, gofiles...)
   716  		}
   717  		if ca, ok := a.Actor.(*coverActor); ok && ca.covMetaFileName != "" {
   718  			b.cacheObjdirFile(buildAction, cache.Default(), ca.covMetaFileName)
   719  		}
   720  	}
   721  	return &coverProvider{gofiles, cgofiles}, nil
   722  }
   723  
   724  // build is the action for building a single package.
   725  // Note that any new influence on this logic must be reported in b.buildActionID above as well.
   726  func (b *Builder) build(ctx context.Context, a *Action) (err error) {
   727  	p := a.Package
   728  	sh := b.Shell(a)
   729  
   730  	var cacheProvider *checkCacheProvider
   731  	var coverPr *coverProvider
   732  	var runCgoPr *runCgoProvider
   733  	for _, dep := range a.Deps {
   734  		switch pr := dep.Provider.(type) {
   735  		case *coverProvider:
   736  			coverPr = pr
   737  		case *checkCacheProvider:
   738  			cacheProvider = pr
   739  		case *runCgoProvider:
   740  			runCgoPr = pr
   741  		}
   742  	}
   743  	if cacheProvider == nil {
   744  		base.Fatalf("internal error: could not find checkCacheProvider")
   745  	}
   746  
   747  	need := cacheProvider.need
   748  	need &^= needCovMetaFile // handled by cover action
   749  	need &^= needCgoHdr      // handled by run cgo action // TODO: accumulate "negative" need bits from actions
   750  
   751  	if need == 0 {
   752  		return
   753  	}
   754  	defer b.flushOutput(a)
   755  
   756  	if cfg.BuildN {
   757  		// In -n mode, print a banner between packages.
   758  		// The banner is five lines so that when changes to
   759  		// different sections of the bootstrap script have to
   760  		// be merged, the banners give patch something
   761  		// to use to find its context.
   762  		sh.Printf("\n#\n# %s\n#\n\n", p.ImportPath)
   763  	}
   764  
   765  	if cfg.BuildV {
   766  		sh.Printf("%s\n", p.ImportPath)
   767  	}
   768  
   769  	objdir := a.Objdir
   770  
   771  	if err := AllowInstall(a); err != nil {
   772  		return err
   773  	}
   774  
   775  	// make target directory
   776  	dir, _ := filepath.Split(a.Target)
   777  	if dir != "" {
   778  		if err := sh.Mkdir(dir); err != nil {
   779  			return err
   780  		}
   781  	}
   782  
   783  	gofiles := str.StringList(p.GoFiles)
   784  	cfiles := str.StringList(p.CFiles)
   785  	sfiles := str.StringList(p.SFiles)
   786  	var objects, cgoObjects []string
   787  
   788  	// If we're doing coverage, preprocess the .go files and put them in the work directory
   789  	if p.Internal.Cover.Mode != "" {
   790  		gofiles = coverPr.goSources
   791  	}
   792  
   793  	if p.UsesCgo() || p.UsesSwig() {
   794  		if runCgoPr == nil {
   795  			base.Fatalf("internal error: could not find runCgoProvider")
   796  		}
   797  
   798  		// In a package using cgo, cgo compiles the C, C++ and assembly files with gcc.
   799  		// There is one exception: runtime/cgo's job is to bridge the
   800  		// cgo and non-cgo worlds, so it necessarily has files in both.
   801  		// In that case gcc only gets the gcc_* files.
   802  		cfiles = nil
   803  		if p.Standard && p.ImportPath == "runtime/cgo" {
   804  			// filter to the non-gcc files.
   805  			i := 0
   806  			for _, f := range sfiles {
   807  				if !strings.HasPrefix(f, "gcc_") {
   808  					sfiles[i] = f
   809  					i++
   810  				}
   811  			}
   812  			sfiles = sfiles[:i]
   813  		} else {
   814  			sfiles = nil
   815  		}
   816  
   817  		outGo, outObj, err := b.processCgoOutputs(a, runCgoPr, base.Tool("cgo"), objdir)
   818  
   819  		if err != nil {
   820  			return err
   821  		}
   822  		if cfg.BuildToolchainName == "gccgo" {
   823  			cgoObjects = append(cgoObjects, a.Objdir+"_cgo_flags")
   824  		}
   825  		cgoObjects = append(cgoObjects, outObj...)
   826  		gofiles = append(gofiles, outGo...)
   827  
   828  		switch cfg.BuildBuildmode {
   829  		case "c-archive", "c-shared":
   830  			b.cacheCgoHdr(a)
   831  		}
   832  	}
   833  
   834  	var srcfiles []string // .go and non-.go
   835  	srcfiles = append(srcfiles, gofiles...)
   836  	srcfiles = append(srcfiles, sfiles...)
   837  	srcfiles = append(srcfiles, cfiles...)
   838  	b.cacheSrcFiles(a, srcfiles)
   839  
   840  	// Sanity check only, since Package.load already checked as well.
   841  	if len(gofiles) == 0 {
   842  		return &load.NoGoError{Package: p}
   843  	}
   844  
   845  	// Prepare Go vet config if needed.
   846  	if need&needVet != 0 {
   847  		buildVetConfig(a, srcfiles, a.Deps)
   848  		need &^= needVet
   849  	}
   850  	if need&needCompiledGoFiles != 0 {
   851  		if err := b.loadCachedCompiledGoFiles(a); err != nil {
   852  			return fmt.Errorf("loading compiled Go files from cache: %w", err)
   853  		}
   854  		need &^= needCompiledGoFiles
   855  	}
   856  	if need == 0 {
   857  		// Nothing left to do.
   858  		return nil
   859  	}
   860  
   861  	// Collect symbol ABI requirements from assembly.
   862  	symabis, err := BuildToolchain.symabis(b, a, sfiles)
   863  	if err != nil {
   864  		return err
   865  	}
   866  
   867  	// Prepare Go import config.
   868  	// We start it off with a comment so it can't be empty, so icfg.Bytes() below is never nil.
   869  	// It should never be empty anyway, but there have been bugs in the past that resulted
   870  	// in empty configs, which then unfortunately turn into "no config passed to compiler",
   871  	// and the compiler falls back to looking in pkg itself, which mostly works,
   872  	// except when it doesn't.
   873  	var icfg bytes.Buffer
   874  	fmt.Fprintf(&icfg, "# import config\n")
   875  	for i, raw := range p.Internal.RawImports {
   876  		final := p.Imports[i]
   877  		if final != raw {
   878  			fmt.Fprintf(&icfg, "importmap %s=%s\n", raw, final)
   879  		}
   880  	}
   881  	for _, a1 := range a.Deps {
   882  		p1 := a1.Package
   883  		if p1 == nil || p1.ImportPath == "" || a1.built == "" {
   884  			continue
   885  		}
   886  		fmt.Fprintf(&icfg, "packagefile %s=%s\n", p1.ImportPath, a1.built)
   887  	}
   888  
   889  	// Prepare Go embed config if needed.
   890  	// Unlike the import config, it's okay for the embed config to be empty.
   891  	var embedcfg []byte
   892  	if len(p.Internal.Embed) > 0 {
   893  		var embed struct {
   894  			Patterns map[string][]string
   895  			Files    map[string]string
   896  		}
   897  		embed.Patterns = p.Internal.Embed
   898  		embed.Files = make(map[string]string)
   899  		for _, file := range p.EmbedFiles {
   900  			embed.Files[file] = fsys.Actual(filepath.Join(p.Dir, file))
   901  		}
   902  		js, err := json.MarshalIndent(&embed, "", "\t")
   903  		if err != nil {
   904  			return fmt.Errorf("marshal embedcfg: %v", err)
   905  		}
   906  		embedcfg = js
   907  	}
   908  
   909  	// Find PGO profile if needed.
   910  	var pgoProfile string
   911  	for _, a1 := range a.Deps {
   912  		if a1.Mode != "preprocess PGO profile" {
   913  			continue
   914  		}
   915  		if pgoProfile != "" {
   916  			return fmt.Errorf("action contains multiple PGO profile dependencies")
   917  		}
   918  		pgoProfile = a1.built
   919  	}
   920  
   921  	if p.Internal.BuildInfo != nil && cfg.ModulesEnabled {
   922  		prog := modload.ModInfoProg(p.Internal.BuildInfo.String(), cfg.BuildToolchainName == "gccgo")
   923  		if len(prog) > 0 {
   924  			if err := sh.writeFile(objdir+"_gomod_.go", prog); err != nil {
   925  				return err
   926  			}
   927  			gofiles = append(gofiles, objdir+"_gomod_.go")
   928  		}
   929  	}
   930  
   931  	// Compile Go.
   932  	objpkg := objdir + "_pkg_.a"
   933  	ofile, out, err := BuildToolchain.gc(b, a, objpkg, icfg.Bytes(), embedcfg, symabis, len(sfiles) > 0, pgoProfile, gofiles)
   934  	if len(out) > 0 && (p.UsesCgo() || p.UsesSwig()) && !cfg.BuildX {
   935  		// Fix up output referring to cgo-generated code to be more readable.
   936  		// Replace *[100]_Ctype_foo with *[100]C.foo.
   937  		// If we're using -x, assume we're debugging and want the full dump, so disable the rewrite.
   938  		out = cgoTypeSigRe.ReplaceAll(out, []byte("C."))
   939  	}
   940  	if err := sh.reportCmd("", "", out, err); err != nil {
   941  		return err
   942  	}
   943  	if ofile != objpkg {
   944  		objects = append(objects, ofile)
   945  	}
   946  
   947  	// Copy .h files named for goos or goarch or goos_goarch
   948  	// to names using GOOS and GOARCH.
   949  	// For example, defs_linux_amd64.h becomes defs_GOOS_GOARCH.h.
   950  	_goos_goarch := "_" + cfg.Goos + "_" + cfg.Goarch
   951  	_goos := "_" + cfg.Goos
   952  	_goarch := "_" + cfg.Goarch
   953  	for _, file := range p.HFiles {
   954  		name, ext := fileExtSplit(file)
   955  		switch {
   956  		case strings.HasSuffix(name, _goos_goarch):
   957  			targ := file[:len(name)-len(_goos_goarch)] + "_GOOS_GOARCH." + ext
   958  			if err := sh.CopyFile(objdir+targ, filepath.Join(p.Dir, file), 0666, true); err != nil {
   959  				return err
   960  			}
   961  		case strings.HasSuffix(name, _goarch):
   962  			targ := file[:len(name)-len(_goarch)] + "_GOARCH." + ext
   963  			if err := sh.CopyFile(objdir+targ, filepath.Join(p.Dir, file), 0666, true); err != nil {
   964  				return err
   965  			}
   966  		case strings.HasSuffix(name, _goos):
   967  			targ := file[:len(name)-len(_goos)] + "_GOOS." + ext
   968  			if err := sh.CopyFile(objdir+targ, filepath.Join(p.Dir, file), 0666, true); err != nil {
   969  				return err
   970  			}
   971  		}
   972  	}
   973  
   974  	if err := b.computeNonGoOverlay(a, p, sh, objdir, [][]string{cfiles}); err != nil {
   975  		return err
   976  	}
   977  
   978  	// Compile C files in a package being built with gccgo. We disallow
   979  	// C files when compiling with gc unless swig or cgo is used.
   980  	for _, file := range cfiles {
   981  		out := file[:len(file)-len(".c")] + ".o"
   982  		if err := BuildToolchain.cc(b, a, objdir+out, file); err != nil {
   983  			return err
   984  		}
   985  		objects = append(objects, out)
   986  	}
   987  
   988  	// Assemble .s files.
   989  	if len(sfiles) > 0 {
   990  		ofiles, err := BuildToolchain.asm(b, a, sfiles)
   991  		if err != nil {
   992  			return err
   993  		}
   994  		objects = append(objects, ofiles...)
   995  	}
   996  
   997  	// For gccgo on ELF systems, we write the build ID as an assembler file.
   998  	// This lets us set the SHF_EXCLUDE flag.
   999  	// This is read by readGccgoArchive in cmd/internal/buildid/buildid.go.
  1000  	if a.buildID != "" && cfg.BuildToolchainName == "gccgo" {
  1001  		switch cfg.Goos {
  1002  		case "aix", "android", "dragonfly", "freebsd", "illumos", "linux", "netbsd", "openbsd", "solaris":
  1003  			asmfile, err := b.gccgoBuildIDFile(a)
  1004  			if err != nil {
  1005  				return err
  1006  			}
  1007  			ofiles, err := BuildToolchain.asm(b, a, []string{asmfile})
  1008  			if err != nil {
  1009  				return err
  1010  			}
  1011  			objects = append(objects, ofiles...)
  1012  		}
  1013  	}
  1014  
  1015  	// NOTE(rsc): On Windows, it is critically important that the
  1016  	// gcc-compiled objects (cgoObjects) be listed after the ordinary
  1017  	// objects in the archive. I do not know why this is.
  1018  	// https://golang.org/issue/2601
  1019  	objects = append(objects, cgoObjects...)
  1020  
  1021  	// Add system object files.
  1022  	for _, syso := range p.SysoFiles {
  1023  		objects = append(objects, filepath.Join(p.Dir, syso))
  1024  	}
  1025  
  1026  	// Pack into archive in objdir directory.
  1027  	// If the Go compiler wrote an archive, we only need to add the
  1028  	// object files for non-Go sources to the archive.
  1029  	// If the Go compiler wrote an archive and the package is entirely
  1030  	// Go sources, there is no pack to execute at all.
  1031  	if len(objects) > 0 {
  1032  		if err := BuildToolchain.pack(b, a, objpkg, objects); err != nil {
  1033  			return err
  1034  		}
  1035  	}
  1036  
  1037  	if err := b.updateBuildID(a, objpkg); err != nil {
  1038  		return err
  1039  	}
  1040  
  1041  	a.built = objpkg
  1042  	return nil
  1043  }
  1044  
  1045  var cgoTypeSigRe = lazyregexp.New(`\b_C2?(type|func|var|macro)_\B`)
  1046  
  1047  func (b *Builder) checkDirectives(a *Action) error {
  1048  	var msg []byte
  1049  	p := a.Package
  1050  	var seen map[string]token.Position
  1051  	for _, d := range p.Internal.Build.Directives {
  1052  		if strings.HasPrefix(d.Text, "//go:debug") {
  1053  			key, _, err := load.ParseGoDebug(d.Text)
  1054  			if err != nil && err != load.ErrNotGoDebug {
  1055  				msg = fmt.Appendf(msg, "%s: invalid //go:debug: %v\n", d.Pos, err)
  1056  				continue
  1057  			}
  1058  			if pos, ok := seen[key]; ok {
  1059  				msg = fmt.Appendf(msg, "%s: repeated //go:debug for %v\n\t%s: previous //go:debug\n", d.Pos, key, pos)
  1060  				continue
  1061  			}
  1062  			if seen == nil {
  1063  				seen = make(map[string]token.Position)
  1064  			}
  1065  			seen[key] = d.Pos
  1066  		}
  1067  	}
  1068  	if len(msg) > 0 {
  1069  		// We pass a non-nil error to reportCmd to trigger the failure reporting
  1070  		// path, but the content of the error doesn't matter because msg is
  1071  		// non-empty.
  1072  		err := errors.New("invalid directive")
  1073  		return b.Shell(a).reportCmd("", "", msg, err)
  1074  	}
  1075  	return nil
  1076  }
  1077  
  1078  func (b *Builder) cacheObjdirFile(a *Action, c cache.Cache, name string) error {
  1079  	f, err := os.Open(a.Objdir + name)
  1080  	if err != nil {
  1081  		return err
  1082  	}
  1083  	defer f.Close()
  1084  	_, _, err = c.Put(cache.Subkey(a.actionID, name), f)
  1085  	return err
  1086  }
  1087  
  1088  func (b *Builder) findCachedObjdirFile(a *Action, c cache.Cache, name string) (string, error) {
  1089  	file, _, err := cache.GetFile(c, cache.Subkey(a.actionID, name))
  1090  	if err != nil {
  1091  		return "", fmt.Errorf("loading cached file %s: %w", name, err)
  1092  	}
  1093  	return file, nil
  1094  }
  1095  
  1096  func (b *Builder) loadCachedObjdirFile(a *Action, c cache.Cache, name string) error {
  1097  	cached, err := b.findCachedObjdirFile(a, c, name)
  1098  	if err != nil {
  1099  		return err
  1100  	}
  1101  	return b.Shell(a).CopyFile(a.Objdir+name, cached, 0666, true)
  1102  }
  1103  
  1104  func (b *Builder) cacheCgoHdr(a *Action) {
  1105  	c := cache.Default()
  1106  	b.cacheObjdirFile(a, c, "_cgo_install.h")
  1107  }
  1108  
  1109  func (b *Builder) loadCachedCgoHdr(a *Action) error {
  1110  	c := cache.Default()
  1111  	return b.loadCachedObjdirFile(a, c, "_cgo_install.h")
  1112  }
  1113  
  1114  func (b *Builder) cacheSrcFiles(a *Action, srcfiles []string) {
  1115  	c := cache.Default()
  1116  	var buf bytes.Buffer
  1117  	for _, file := range srcfiles {
  1118  		if !strings.HasPrefix(file, a.Objdir) {
  1119  			// not generated
  1120  			buf.WriteString("./")
  1121  			buf.WriteString(file)
  1122  			buf.WriteString("\n")
  1123  			continue
  1124  		}
  1125  		name := file[len(a.Objdir):]
  1126  		buf.WriteString(name)
  1127  		buf.WriteString("\n")
  1128  		if err := b.cacheObjdirFile(a, c, name); err != nil {
  1129  			return
  1130  		}
  1131  	}
  1132  	cache.PutBytes(c, cache.Subkey(a.actionID, "srcfiles"), buf.Bytes())
  1133  }
  1134  
  1135  func (b *Builder) loadCachedVet(a *Action, vetDeps []*Action) error {
  1136  	c := cache.Default()
  1137  	list, _, err := cache.GetBytes(c, cache.Subkey(a.actionID, "srcfiles"))
  1138  	if err != nil {
  1139  		return fmt.Errorf("reading srcfiles list: %w", err)
  1140  	}
  1141  	var srcfiles []string
  1142  	for name := range strings.SplitSeq(string(list), "\n") {
  1143  		if name == "" { // end of list
  1144  			continue
  1145  		}
  1146  		if strings.HasPrefix(name, "./") {
  1147  			srcfiles = append(srcfiles, name[2:])
  1148  			continue
  1149  		}
  1150  		if err := b.loadCachedObjdirFile(a, c, name); err != nil {
  1151  			return err
  1152  		}
  1153  		srcfiles = append(srcfiles, a.Objdir+name)
  1154  	}
  1155  	buildVetConfig(a, srcfiles, vetDeps)
  1156  	return nil
  1157  }
  1158  
  1159  func (b *Builder) loadCachedCompiledGoFiles(a *Action) error {
  1160  	c := cache.Default()
  1161  	list, _, err := cache.GetBytes(c, cache.Subkey(a.actionID, "srcfiles"))
  1162  	if err != nil {
  1163  		return fmt.Errorf("reading srcfiles list: %w", err)
  1164  	}
  1165  	var gofiles []string
  1166  	for name := range strings.SplitSeq(string(list), "\n") {
  1167  		if name == "" { // end of list
  1168  			continue
  1169  		} else if !strings.HasSuffix(name, ".go") {
  1170  			continue
  1171  		}
  1172  		if strings.HasPrefix(name, "./") {
  1173  			gofiles = append(gofiles, name[len("./"):])
  1174  			continue
  1175  		}
  1176  		file, err := b.findCachedObjdirFile(a, c, name)
  1177  		if err != nil {
  1178  			return fmt.Errorf("finding %s: %w", name, err)
  1179  		}
  1180  		gofiles = append(gofiles, file)
  1181  	}
  1182  	a.Package.CompiledGoFiles = gofiles
  1183  	return nil
  1184  }
  1185  
  1186  // vetConfig is the configuration passed to vet describing a single package.
  1187  type vetConfig struct {
  1188  	ID           string   // package ID (example: "fmt [fmt.test]")
  1189  	Compiler     string   // compiler name (gc, gccgo)
  1190  	Dir          string   // directory containing package
  1191  	ImportPath   string   // canonical import path ("package path")
  1192  	GoFiles      []string // absolute paths to package source files
  1193  	NonGoFiles   []string // absolute paths to package non-Go files
  1194  	IgnoredFiles []string // absolute paths to ignored source files
  1195  
  1196  	Module      *analysis.Module  // module information, if any
  1197  	ImportMap   map[string]string // map import path in source code to package path
  1198  	PackageFile map[string]string // map package path to .a file with export data
  1199  	Standard    map[string]bool   // map package path to whether it's in the standard library
  1200  	PackageVetx map[string]string // map package path to vetx data from earlier vet run
  1201  	VetxOnly    bool              // only compute vetx data; don't report detected problems
  1202  	VetxOutput  string            // write vetx data to this output file
  1203  	Stdout      string            // write stdout (JSON, unified diff) to this output file
  1204  	GoVersion   string            // Go version for package
  1205  	FixArchive  string            // write fixed files to this zip archive, if non-empty
  1206  
  1207  	SucceedOnTypecheckFailure bool // awful hack; see #18395 and below
  1208  }
  1209  
  1210  // analysisModuleFromModulePublic converts a modinfo.ModulePublic to a analysis.Module.
  1211  func analysisModuleFromModulePublic(m *modinfo.ModulePublic) *analysis.Module {
  1212  	if m == nil {
  1213  		return nil
  1214  	}
  1215  	vm := &analysis.Module{
  1216  		Path:      m.Path,
  1217  		Version:   m.Version,
  1218  		Replace:   analysisModuleFromModulePublic(m.Replace),
  1219  		Time:      m.Time,
  1220  		Main:      m.Main,
  1221  		Indirect:  m.Indirect,
  1222  		Dir:       m.Dir,
  1223  		GoMod:     m.GoMod,
  1224  		GoVersion: m.GoVersion,
  1225  	}
  1226  	if m.Error != nil {
  1227  		vm.Error = &analysis.ModuleError{Err: m.Error.Err}
  1228  	}
  1229  	return vm
  1230  }
  1231  
  1232  func buildVetConfig(a *Action, srcfiles []string, vetDeps []*Action) {
  1233  	// Classify files based on .go extension.
  1234  	// srcfiles does not include raw cgo files.
  1235  	var gofiles, nongofiles []string
  1236  	for _, name := range srcfiles {
  1237  		if strings.HasSuffix(name, ".go") {
  1238  			gofiles = append(gofiles, name)
  1239  		} else {
  1240  			nongofiles = append(nongofiles, name)
  1241  		}
  1242  	}
  1243  
  1244  	ignored := str.StringList(a.Package.IgnoredGoFiles, a.Package.IgnoredOtherFiles)
  1245  
  1246  	// Pass list of absolute paths to vet,
  1247  	// so that vet's error messages will use absolute paths,
  1248  	// so that we can reformat them relative to the directory
  1249  	// in which the go command is invoked.
  1250  	vcfg := &vetConfig{
  1251  		ID:           a.Package.ImportPath,
  1252  		Compiler:     cfg.BuildToolchainName,
  1253  		Dir:          a.Package.Dir,
  1254  		GoFiles:      actualFiles(mkAbsFiles(a.Package.Dir, gofiles)),
  1255  		NonGoFiles:   actualFiles(mkAbsFiles(a.Package.Dir, nongofiles)),
  1256  		IgnoredFiles: actualFiles(mkAbsFiles(a.Package.Dir, ignored)),
  1257  		ImportPath:   a.Package.ImportPath,
  1258  		ImportMap:    make(map[string]string),
  1259  		PackageFile:  make(map[string]string),
  1260  		Standard:     make(map[string]bool),
  1261  	}
  1262  	vcfg.GoVersion = "go" + gover.Local()
  1263  	if a.Package.Module != nil {
  1264  		v := a.Package.Module.GoVersion
  1265  		if v == "" {
  1266  			v = gover.DefaultGoModVersion
  1267  		}
  1268  		vcfg.GoVersion = "go" + v
  1269  		vcfg.Module = analysisModuleFromModulePublic(a.Package.Module)
  1270  	}
  1271  	a.vetCfg = vcfg
  1272  	for i, raw := range a.Package.Internal.RawImports {
  1273  		final := a.Package.Imports[i]
  1274  		vcfg.ImportMap[raw] = final
  1275  	}
  1276  
  1277  	// Compute the list of mapped imports in the vet config
  1278  	// so that we can add any missing mappings below.
  1279  	vcfgMapped := make(map[string]bool)
  1280  	for _, p := range vcfg.ImportMap {
  1281  		vcfgMapped[p] = true
  1282  	}
  1283  
  1284  	for _, a1 := range vetDeps {
  1285  		p1 := a1.Package
  1286  		if p1 == nil || p1.ImportPath == "" || p1 == a.Package {
  1287  			continue
  1288  		}
  1289  		// Add import mapping if needed
  1290  		// (for imports like "runtime/cgo" that appear only in generated code).
  1291  		if !vcfgMapped[p1.ImportPath] {
  1292  			vcfg.ImportMap[p1.ImportPath] = p1.ImportPath
  1293  		}
  1294  		if a1.built != "" {
  1295  			vcfg.PackageFile[p1.ImportPath] = a1.built
  1296  		}
  1297  		if p1.Standard {
  1298  			vcfg.Standard[p1.ImportPath] = true
  1299  		}
  1300  	}
  1301  }
  1302  
  1303  // VetTool is the path to the effective vet or fix tool binary.
  1304  // The user may specify a non-default value using -{vet,fix}tool.
  1305  // The caller is expected to set it (if needed) before executing any vet actions.
  1306  var VetTool string
  1307  
  1308  // VetFlags are the default flags to pass to vet.
  1309  // The caller is expected to set them before executing any vet actions.
  1310  var VetFlags []string
  1311  
  1312  // VetHandleStdout determines how the stdout output of each vet tool
  1313  // invocation should be handled. The default behavior is to copy it to
  1314  // the go command's stdout, atomically.
  1315  var VetHandleStdout = copyToStdout
  1316  
  1317  // VetExplicit records whether the vet flags (which may include
  1318  // -{vet,fix}tool) were set explicitly on the command line.
  1319  var VetExplicit bool
  1320  
  1321  func (b *Builder) vet(ctx context.Context, a *Action) error {
  1322  	// a.Deps[0] is the build of the package being vetted.
  1323  
  1324  	a.Failed = nil // vet of dependency may have failed but we can still succeed
  1325  
  1326  	if a.Deps[0].Failed != nil {
  1327  		// The build of the package has failed. Skip vet check.
  1328  		// Vet could return export data for non-typecheck errors,
  1329  		// but we ignore it because the package cannot be compiled.
  1330  		return nil
  1331  	}
  1332  
  1333  	vcfg := a.Deps[0].vetCfg
  1334  	if vcfg == nil {
  1335  		// Vet config should only be missing if the build failed.
  1336  		return fmt.Errorf("vet config not found")
  1337  	}
  1338  
  1339  	sh := b.Shell(a)
  1340  
  1341  	// We use "vet" terminology even when building action graphs for go fix.
  1342  	vcfg.VetxOnly = a.VetxOnly
  1343  	vcfg.VetxOutput = a.Objdir + "vet.out"
  1344  	vcfg.Stdout = a.Objdir + "vet.stdout"
  1345  	if a.needFix {
  1346  		vcfg.FixArchive = a.Objdir + "vet.fix.zip"
  1347  	}
  1348  	vcfg.PackageVetx = make(map[string]string)
  1349  
  1350  	h := cache.NewHash("vet " + a.Package.ImportPath)
  1351  	fmt.Fprintf(h, "vet %q\n", b.toolID("vet"))
  1352  
  1353  	vetFlags := VetFlags
  1354  
  1355  	// In GOROOT, we enable all the vet tests during 'go test',
  1356  	// not just the high-confidence subset. This gets us extra
  1357  	// checking for the standard library (at some compliance cost)
  1358  	// and helps us gain experience about how well the checks
  1359  	// work, to help decide which should be turned on by default.
  1360  	// The command-line still wins.
  1361  	//
  1362  	// Note that this flag change applies even when running vet as
  1363  	// a dependency of vetting a package outside std.
  1364  	// (Otherwise we'd have to introduce a whole separate
  1365  	// space of "vet fmt as a dependency of a std top-level vet"
  1366  	// versus "vet fmt as a dependency of a non-std top-level vet".)
  1367  	// This is OK as long as the packages that are farther down the
  1368  	// dependency tree turn on *more* analysis, as here.
  1369  	// (The unsafeptr check does not write any facts for use by
  1370  	// later vet runs, nor does unreachable.)
  1371  	if a.Package.Goroot && !VetExplicit && VetTool == base.Tool("vet") {
  1372  		// Turn off -unsafeptr checks.
  1373  		// There's too much unsafe.Pointer code
  1374  		// that vet doesn't like in low-level packages
  1375  		// like runtime, sync, and reflect.
  1376  		// Note that $GOROOT/src/buildall.bash
  1377  		// does the same
  1378  		// and should be updated if these flags are
  1379  		// changed here.
  1380  		vetFlags = []string{"-unsafeptr=false"}
  1381  
  1382  		// Also turn off -unreachable checks during go test.
  1383  		// During testing it is very common to make changes
  1384  		// like hard-coded forced returns or panics that make
  1385  		// code unreachable. It's unreasonable to insist on files
  1386  		// not having any unreachable code during "go test".
  1387  		// (buildall.bash still has -unreachable enabled
  1388  		// for the overall whole-tree scan.)
  1389  		if cfg.CmdName == "test" {
  1390  			vetFlags = append(vetFlags, "-unreachable=false")
  1391  		}
  1392  	}
  1393  
  1394  	// Note: We could decide that vet should compute export data for
  1395  	// all analyses, in which case we don't need to include the flags here.
  1396  	// But that would mean that if an analysis causes problems like
  1397  	// unexpected crashes there would be no way to turn it off.
  1398  	// It seems better to let the flags disable export analysis too.
  1399  	fmt.Fprintf(h, "vetflags %q\n", vetFlags)
  1400  
  1401  	fmt.Fprintf(h, "pkg %q\n", a.Deps[0].actionID)
  1402  	for _, a1 := range a.Deps {
  1403  		if a1.Mode == "vet" && a1.built != "" {
  1404  			fmt.Fprintf(h, "vetout %q %s\n", a1.Package.ImportPath, b.fileHash(a1.built))
  1405  			vcfg.PackageVetx[a1.Package.ImportPath] = a1.built
  1406  		}
  1407  	}
  1408  	var (
  1409  		id            = cache.ActionID(h.Sum())     // for .vetx file
  1410  		stdoutKey     = cache.Subkey(id, "stdout")  // for .stdout file
  1411  		fixArchiveKey = cache.Subkey(id, "fix.zip") // for .fix.zip file
  1412  	)
  1413  
  1414  	// Check the cache; -a forces a rebuild.
  1415  	if !cfg.BuildA {
  1416  		c := cache.Default()
  1417  
  1418  		// There may be multiple artifacts in the cache.
  1419  		// We need to retrieve them all, or none:
  1420  		// the effect must be transactional.
  1421  		var (
  1422  			vetxFile   string                           // name of cached .vetx file
  1423  			fixArchive string                           // name of cached .fix.zip file
  1424  			stdout     io.Reader = bytes.NewReader(nil) // cached stdout stream
  1425  		)
  1426  
  1427  		// Obtain location of cached .vetx file.
  1428  		vetxFile, _, err := cache.GetFile(c, id)
  1429  		if err != nil {
  1430  			goto cachemiss
  1431  		}
  1432  
  1433  		// Obtain location of cached .fix.zip file (if needed).
  1434  		if a.needFix {
  1435  			file, _, err := cache.GetFile(c, fixArchiveKey)
  1436  			if err != nil {
  1437  				goto cachemiss
  1438  			}
  1439  			fixArchive = file
  1440  		}
  1441  
  1442  		// Copy cached .stdout file to stdout.
  1443  		if file, _, err := cache.GetFile(c, stdoutKey); err == nil {
  1444  			f, err := os.Open(file)
  1445  			if err != nil {
  1446  				goto cachemiss
  1447  			}
  1448  			defer f.Close() // ignore error (can't fail)
  1449  			stdout = f
  1450  		}
  1451  
  1452  		// Cache hit: commit transaction.
  1453  		a.built = vetxFile
  1454  		a.FixArchive = fixArchive
  1455  		if err := VetHandleStdout(stdout); err != nil {
  1456  			return err // internal error (don't fall through to cachemiss)
  1457  		}
  1458  
  1459  		return nil
  1460  	}
  1461  cachemiss:
  1462  
  1463  	js, err := json.MarshalIndent(vcfg, "", "\t")
  1464  	if err != nil {
  1465  		return fmt.Errorf("internal error marshaling vet config: %v", err)
  1466  	}
  1467  	js = append(js, '\n')
  1468  	if err := sh.writeFile(a.Objdir+"vet.cfg", js); err != nil {
  1469  		return err
  1470  	}
  1471  
  1472  	// TODO(rsc): Why do we pass $GCCGO to go vet?
  1473  	env := b.cCompilerEnv()
  1474  	if cfg.BuildToolchainName == "gccgo" {
  1475  		env = append(env, "GCCGO="+BuildToolchain.compiler())
  1476  	}
  1477  
  1478  	p := a.Package
  1479  	tool := VetTool
  1480  	if tool == "" {
  1481  		panic("VetTool unset")
  1482  	}
  1483  
  1484  	if err := sh.run(p.Dir, p.ImportPath, env, cfg.BuildToolexec, tool, vetFlags, a.Objdir+"vet.cfg"); err != nil {
  1485  		return err
  1486  	}
  1487  
  1488  	// Vet tool succeeded, possibly with facts, fixes, or JSON stdout.
  1489  	// Save all in cache.
  1490  
  1491  	// Save facts.
  1492  	if f, err := os.Open(vcfg.VetxOutput); err == nil {
  1493  		defer f.Close() // ignore error
  1494  		a.built = vcfg.VetxOutput
  1495  		cache.Default().Put(id, f) // ignore error
  1496  	}
  1497  
  1498  	// Save fix archive (if any).
  1499  	if a.needFix {
  1500  		if f, err := os.Open(vcfg.FixArchive); err == nil {
  1501  			defer f.Close() // ignore error
  1502  			a.FixArchive = vcfg.FixArchive
  1503  			cache.Default().Put(fixArchiveKey, f) // ignore error
  1504  		}
  1505  	}
  1506  
  1507  	// Save stdout.
  1508  	if f, err := os.Open(vcfg.Stdout); err == nil {
  1509  		defer f.Close() // ignore error
  1510  		if err := VetHandleStdout(f); err != nil {
  1511  			return err
  1512  		}
  1513  		f.Seek(0, io.SeekStart)           // ignore error
  1514  		cache.Default().Put(stdoutKey, f) // ignore error
  1515  	}
  1516  
  1517  	return nil
  1518  }
  1519  
  1520  var stdoutMu sync.Mutex // serializes concurrent writes (of e.g. JSON values) to stdout
  1521  
  1522  // copyToStdout copies the stream to stdout while holding the lock.
  1523  func copyToStdout(r io.Reader) error {
  1524  	stdoutMu.Lock()
  1525  	defer stdoutMu.Unlock()
  1526  	if _, err := io.Copy(os.Stdout, r); err != nil {
  1527  		return fmt.Errorf("copying vet tool stdout: %w", err)
  1528  	}
  1529  	return nil
  1530  }
  1531  
  1532  // linkActionID computes the action ID for a link action.
  1533  func (b *Builder) linkActionID(a *Action) cache.ActionID {
  1534  	p := a.Package
  1535  	h := cache.NewHash("link " + p.ImportPath)
  1536  
  1537  	// Toolchain-independent configuration.
  1538  	fmt.Fprintf(h, "link\n")
  1539  	fmt.Fprintf(h, "buildmode %s goos %s goarch %s\n", cfg.BuildBuildmode, cfg.Goos, cfg.Goarch)
  1540  	fmt.Fprintf(h, "import %q\n", p.ImportPath)
  1541  	fmt.Fprintf(h, "omitdebug %v standard %v local %v prefix %q\n", p.Internal.OmitDebug, p.Standard, p.Internal.Local, p.Internal.LocalPrefix)
  1542  	fmt.Fprintf(h, "defaultgodebug %q\n", p.DefaultGODEBUG)
  1543  	if cfg.BuildTrimpath {
  1544  		fmt.Fprintln(h, "trimpath")
  1545  	}
  1546  
  1547  	// Toolchain-dependent configuration, shared with b.linkSharedActionID.
  1548  	b.printLinkerConfig(h, p)
  1549  
  1550  	// Input files.
  1551  	for _, a1 := range a.Deps {
  1552  		p1 := a1.Package
  1553  		if p1 != nil {
  1554  			if a1.built != "" || a1.buildID != "" {
  1555  				buildID := a1.buildID
  1556  				if buildID == "" {
  1557  					buildID = b.buildID(a1.built)
  1558  				}
  1559  				fmt.Fprintf(h, "packagefile %s=%s\n", p1.ImportPath, contentID(buildID))
  1560  			}
  1561  			// Because we put package main's full action ID into the binary's build ID,
  1562  			// we must also put the full action ID into the binary's action ID hash.
  1563  			if p1.Name == "main" {
  1564  				fmt.Fprintf(h, "packagemain %s\n", a1.buildID)
  1565  			}
  1566  			if p1.Shlib != "" {
  1567  				fmt.Fprintf(h, "packageshlib %s=%s\n", p1.ImportPath, contentID(b.buildID(p1.Shlib)))
  1568  			}
  1569  		}
  1570  	}
  1571  
  1572  	return h.Sum()
  1573  }
  1574  
  1575  // printLinkerConfig prints the linker config into the hash h,
  1576  // as part of the computation of a linker-related action ID.
  1577  func (b *Builder) printLinkerConfig(h io.Writer, p *load.Package) {
  1578  	switch cfg.BuildToolchainName {
  1579  	default:
  1580  		base.Fatalf("linkActionID: unknown toolchain %q", cfg.BuildToolchainName)
  1581  
  1582  	case "gc":
  1583  		fmt.Fprintf(h, "link %s %q %s\n", b.toolID("link"), forcedLdflags, ldBuildmode)
  1584  		if p != nil {
  1585  			fmt.Fprintf(h, "linkflags %q\n", p.Internal.Ldflags)
  1586  		}
  1587  
  1588  		// GOARM, GOMIPS, etc.
  1589  		key, val, _ := cfg.GetArchEnv()
  1590  		fmt.Fprintf(h, "%s=%s\n", key, val)
  1591  
  1592  		if cfg.CleanGOEXPERIMENT != "" {
  1593  			fmt.Fprintf(h, "GOEXPERIMENT=%q\n", cfg.CleanGOEXPERIMENT)
  1594  		}
  1595  
  1596  		// The linker writes source file paths that refer to GOROOT,
  1597  		// but only if -trimpath is not specified (see [gctoolchain.ld] in gc.go).
  1598  		gorootFinal := cfg.GOROOT
  1599  		if cfg.BuildTrimpath {
  1600  			gorootFinal = ""
  1601  		}
  1602  		fmt.Fprintf(h, "GOROOT=%s\n", gorootFinal)
  1603  
  1604  		// GO_EXTLINK_ENABLED controls whether the external linker is used.
  1605  		fmt.Fprintf(h, "GO_EXTLINK_ENABLED=%s\n", cfg.Getenv("GO_EXTLINK_ENABLED"))
  1606  
  1607  		// TODO(rsc): Do cgo settings and flags need to be included?
  1608  		// Or external linker settings and flags?
  1609  
  1610  	case "gccgo":
  1611  		id, _, err := b.gccToolID(BuildToolchain.linker(), "go")
  1612  		if err != nil {
  1613  			base.Fatalf("%v", err)
  1614  		}
  1615  		fmt.Fprintf(h, "link %s %s\n", id, ldBuildmode)
  1616  		// TODO(iant): Should probably include cgo flags here.
  1617  	}
  1618  }
  1619  
  1620  // link is the action for linking a single command.
  1621  // Note that any new influence on this logic must be reported in b.linkActionID above as well.
  1622  func (b *Builder) link(ctx context.Context, a *Action) (err error) {
  1623  	if b.useCache(a, b.linkActionID(a), a.Package.Target, !b.IsCmdList) || b.IsCmdList {
  1624  		return nil
  1625  	}
  1626  	defer b.flushOutput(a)
  1627  
  1628  	sh := b.Shell(a)
  1629  	if err := sh.Mkdir(a.Objdir); err != nil {
  1630  		return err
  1631  	}
  1632  
  1633  	importcfg := a.Objdir + "importcfg.link"
  1634  	if err := b.writeLinkImportcfg(a, importcfg); err != nil {
  1635  		return err
  1636  	}
  1637  
  1638  	if err := AllowInstall(a); err != nil {
  1639  		return err
  1640  	}
  1641  
  1642  	// make target directory
  1643  	dir, _ := filepath.Split(a.Target)
  1644  	if dir != "" {
  1645  		if err := sh.Mkdir(dir); err != nil {
  1646  			return err
  1647  		}
  1648  	}
  1649  
  1650  	if err := BuildToolchain.ld(b, a, a.Target, importcfg, a.Deps[0].built); err != nil {
  1651  		return err
  1652  	}
  1653  
  1654  	// Update the binary with the final build ID.
  1655  	if err := b.updateBuildID(a, a.Target); err != nil {
  1656  		return err
  1657  	}
  1658  
  1659  	a.built = a.Target
  1660  	return nil
  1661  }
  1662  
  1663  func (b *Builder) writeLinkImportcfg(a *Action, file string) error {
  1664  	// Prepare Go import cfg.
  1665  	var icfg bytes.Buffer
  1666  	for _, a1 := range a.Deps {
  1667  		p1 := a1.Package
  1668  		if p1 == nil {
  1669  			continue
  1670  		}
  1671  		fmt.Fprintf(&icfg, "packagefile %s=%s\n", p1.ImportPath, a1.built)
  1672  		if p1.Shlib != "" {
  1673  			fmt.Fprintf(&icfg, "packageshlib %s=%s\n", p1.ImportPath, p1.Shlib)
  1674  		}
  1675  	}
  1676  	info := ""
  1677  	if a.Package.Internal.BuildInfo != nil {
  1678  		info = a.Package.Internal.BuildInfo.String()
  1679  	}
  1680  	fmt.Fprintf(&icfg, "modinfo %q\n", modload.ModInfoData(info))
  1681  	return b.Shell(a).writeFile(file, icfg.Bytes())
  1682  }
  1683  
  1684  // PkgconfigCmd returns a pkg-config binary name
  1685  // defaultPkgConfig is defined in zdefaultcc.go, written by cmd/dist.
  1686  func (b *Builder) PkgconfigCmd() string {
  1687  	return envList("PKG_CONFIG", cfg.DefaultPkgConfig)[0]
  1688  }
  1689  
  1690  // splitPkgConfigOutput parses the pkg-config output into a slice of flags.
  1691  // This implements the shell quoting semantics described in
  1692  // https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02,
  1693  // except that it does not support parameter or arithmetic expansion or command
  1694  // substitution and hard-codes the <blank> delimiters instead of reading them
  1695  // from LC_LOCALE.
  1696  func splitPkgConfigOutput(out []byte) ([]string, error) {
  1697  	if len(out) == 0 {
  1698  		return nil, nil
  1699  	}
  1700  	var flags []string
  1701  	flag := make([]byte, 0, len(out))
  1702  	didQuote := false // was the current flag parsed from a quoted string?
  1703  	escaped := false  // did we just read `\` in a non-single-quoted context?
  1704  	quote := byte(0)  // what is the quote character around the current string?
  1705  
  1706  	for _, c := range out {
  1707  		if escaped {
  1708  			if quote == '"' {
  1709  				// “The <backslash> shall retain its special meaning as an escape
  1710  				// character … only when followed by one of the following characters
  1711  				// when considered special:”
  1712  				switch c {
  1713  				case '$', '`', '"', '\\', '\n':
  1714  					// Handle the escaped character normally.
  1715  				default:
  1716  					// Not an escape character after all.
  1717  					flag = append(flag, '\\', c)
  1718  					escaped = false
  1719  					continue
  1720  				}
  1721  			}
  1722  
  1723  			if c == '\n' {
  1724  				// “If a <newline> follows the <backslash>, the shell shall interpret
  1725  				// this as line continuation.”
  1726  			} else {
  1727  				flag = append(flag, c)
  1728  			}
  1729  			escaped = false
  1730  			continue
  1731  		}
  1732  
  1733  		if quote != 0 && c == quote {
  1734  			quote = 0
  1735  			continue
  1736  		}
  1737  		switch quote {
  1738  		case '\'':
  1739  			// “preserve the literal value of each character”
  1740  			flag = append(flag, c)
  1741  			continue
  1742  		case '"':
  1743  			// “preserve the literal value of all characters within the double-quotes,
  1744  			// with the exception of …”
  1745  			switch c {
  1746  			case '`', '$', '\\':
  1747  			default:
  1748  				flag = append(flag, c)
  1749  				continue
  1750  			}
  1751  		}
  1752  
  1753  		// “The application shall quote the following characters if they are to
  1754  		// represent themselves:”
  1755  		switch c {
  1756  		case '|', '&', ';', '<', '>', '(', ')', '$', '`':
  1757  			return nil, fmt.Errorf("unexpected shell character %q in pkgconf output", c)
  1758  
  1759  		case '\\':
  1760  			// “A <backslash> that is not quoted shall preserve the literal value of
  1761  			// the following character, with the exception of a <newline>.”
  1762  			escaped = true
  1763  			continue
  1764  
  1765  		case '"', '\'':
  1766  			quote = c
  1767  			didQuote = true
  1768  			continue
  1769  
  1770  		case ' ', '\t', '\n':
  1771  			if len(flag) > 0 || didQuote {
  1772  				flags = append(flags, string(flag))
  1773  			}
  1774  			flag, didQuote = flag[:0], false
  1775  			continue
  1776  		}
  1777  
  1778  		flag = append(flag, c)
  1779  	}
  1780  
  1781  	// Prefer to report a missing quote instead of a missing escape. If the string
  1782  	// is something like `"foo\`, it's ambiguous as to whether the trailing
  1783  	// backslash is really an escape at all.
  1784  	if quote != 0 {
  1785  		return nil, errors.New("unterminated quoted string in pkgconf output")
  1786  	}
  1787  	if escaped {
  1788  		return nil, errors.New("broken character escaping in pkgconf output")
  1789  	}
  1790  
  1791  	if len(flag) > 0 || didQuote {
  1792  		flags = append(flags, string(flag))
  1793  	}
  1794  	return flags, nil
  1795  }
  1796  
  1797  // Calls pkg-config if needed and returns the cflags/ldflags needed to build a's package.
  1798  func (b *Builder) getPkgConfigFlags(a *Action, p *load.Package) (cflags, ldflags []string, err error) {
  1799  	sh := b.Shell(a)
  1800  	if pcargs := p.CgoPkgConfig; len(pcargs) > 0 {
  1801  		// pkg-config permits arguments to appear anywhere in
  1802  		// the command line. Move them all to the front, before --.
  1803  		var pcflags []string
  1804  		var pkgs []string
  1805  		for _, pcarg := range pcargs {
  1806  			if pcarg == "--" {
  1807  				// We're going to add our own "--" argument.
  1808  			} else if strings.HasPrefix(pcarg, "--") {
  1809  				pcflags = append(pcflags, pcarg)
  1810  			} else {
  1811  				pkgs = append(pkgs, pcarg)
  1812  			}
  1813  		}
  1814  		for _, pkg := range pkgs {
  1815  			if !load.SafeArg(pkg) {
  1816  				return nil, nil, fmt.Errorf("invalid pkg-config package name: %s", pkg)
  1817  			}
  1818  		}
  1819  
  1820  		if err := checkPkgConfigFlags("", "pkg-config", pcflags); err != nil {
  1821  			return nil, nil, err
  1822  		}
  1823  
  1824  		var out []byte
  1825  		out, err = sh.runOut(p.Dir, nil, b.PkgconfigCmd(), "--cflags", pcflags, "--", pkgs)
  1826  		if err != nil {
  1827  			desc := b.PkgconfigCmd() + " --cflags " + strings.Join(pcflags, " ") + " -- " + strings.Join(pkgs, " ")
  1828  			return nil, nil, sh.reportCmd(desc, "", out, err)
  1829  		}
  1830  		if len(out) > 0 {
  1831  			cflags, err = splitPkgConfigOutput(bytes.TrimSpace(out))
  1832  			if err != nil {
  1833  				return nil, nil, err
  1834  			}
  1835  			if err := checkCompilerFlags("CFLAGS", "pkg-config --cflags", cflags); err != nil {
  1836  				return nil, nil, err
  1837  			}
  1838  		}
  1839  		out, err = sh.runOut(p.Dir, nil, b.PkgconfigCmd(), "--libs", pcflags, "--", pkgs)
  1840  		if err != nil {
  1841  			desc := b.PkgconfigCmd() + " --libs " + strings.Join(pcflags, " ") + " -- " + strings.Join(pkgs, " ")
  1842  			return nil, nil, sh.reportCmd(desc, "", out, err)
  1843  		}
  1844  		if len(out) > 0 {
  1845  			// We need to handle path with spaces so that C:/Program\ Files can pass
  1846  			// checkLinkerFlags. Use splitPkgConfigOutput here just like we treat cflags.
  1847  			ldflags, err = splitPkgConfigOutput(bytes.TrimSpace(out))
  1848  			if err != nil {
  1849  				return nil, nil, err
  1850  			}
  1851  			if err := checkLinkerFlags("LDFLAGS", "pkg-config --libs", ldflags); err != nil {
  1852  				return nil, nil, err
  1853  			}
  1854  		}
  1855  	}
  1856  
  1857  	return
  1858  }
  1859  
  1860  func (b *Builder) installShlibname(ctx context.Context, a *Action) error {
  1861  	if err := AllowInstall(a); err != nil {
  1862  		return err
  1863  	}
  1864  
  1865  	sh := b.Shell(a)
  1866  	a1 := a.Deps[0]
  1867  	if !cfg.BuildN {
  1868  		if err := sh.Mkdir(filepath.Dir(a.Target)); err != nil {
  1869  			return err
  1870  		}
  1871  	}
  1872  	return sh.writeFile(a.Target, []byte(filepath.Base(a1.Target)+"\n"))
  1873  }
  1874  
  1875  func (b *Builder) linkSharedActionID(a *Action) cache.ActionID {
  1876  	h := cache.NewHash("linkShared")
  1877  
  1878  	// Toolchain-independent configuration.
  1879  	fmt.Fprintf(h, "linkShared\n")
  1880  	fmt.Fprintf(h, "goos %s goarch %s\n", cfg.Goos, cfg.Goarch)
  1881  
  1882  	// Toolchain-dependent configuration, shared with b.linkActionID.
  1883  	b.printLinkerConfig(h, nil)
  1884  
  1885  	// Input files.
  1886  	for _, a1 := range a.Deps {
  1887  		p1 := a1.Package
  1888  		if a1.built == "" {
  1889  			continue
  1890  		}
  1891  		if p1 != nil {
  1892  			fmt.Fprintf(h, "packagefile %s=%s\n", p1.ImportPath, contentID(b.buildID(a1.built)))
  1893  			if p1.Shlib != "" {
  1894  				fmt.Fprintf(h, "packageshlib %s=%s\n", p1.ImportPath, contentID(b.buildID(p1.Shlib)))
  1895  			}
  1896  		}
  1897  	}
  1898  	// Files named on command line are special.
  1899  	for _, a1 := range a.Deps[0].Deps {
  1900  		p1 := a1.Package
  1901  		fmt.Fprintf(h, "top %s=%s\n", p1.ImportPath, contentID(b.buildID(a1.built)))
  1902  	}
  1903  
  1904  	return h.Sum()
  1905  }
  1906  
  1907  func (b *Builder) linkShared(ctx context.Context, a *Action) (err error) {
  1908  	if b.useCache(a, b.linkSharedActionID(a), a.Target, !b.IsCmdList) || b.IsCmdList {
  1909  		return nil
  1910  	}
  1911  	defer b.flushOutput(a)
  1912  
  1913  	if err := AllowInstall(a); err != nil {
  1914  		return err
  1915  	}
  1916  
  1917  	if err := b.Shell(a).Mkdir(a.Objdir); err != nil {
  1918  		return err
  1919  	}
  1920  
  1921  	importcfg := a.Objdir + "importcfg.link"
  1922  	if err := b.writeLinkImportcfg(a, importcfg); err != nil {
  1923  		return err
  1924  	}
  1925  
  1926  	// TODO(rsc): There is a missing updateBuildID here,
  1927  	// but we have to decide where to store the build ID in these files.
  1928  	a.built = a.Target
  1929  	return BuildToolchain.ldShared(b, a, a.Deps[0].Deps, a.Target, importcfg, a.Deps)
  1930  }
  1931  
  1932  // BuildInstallFunc is the action for installing a single package or executable.
  1933  func BuildInstallFunc(b *Builder, ctx context.Context, a *Action) (err error) {
  1934  	defer func() {
  1935  		if err != nil {
  1936  			// a.Package == nil is possible for the go install -buildmode=shared
  1937  			// action that installs libmangledname.so, which corresponds to
  1938  			// a list of packages, not just one.
  1939  			sep, path := "", ""
  1940  			if a.Package != nil {
  1941  				sep, path = " ", a.Package.ImportPath
  1942  			}
  1943  			err = fmt.Errorf("go %s%s%s: %v", cfg.CmdName, sep, path, err)
  1944  		}
  1945  	}()
  1946  	sh := b.Shell(a)
  1947  
  1948  	a1 := a.Deps[0]
  1949  	a.buildID = a1.buildID
  1950  	if a.json != nil {
  1951  		a.json.BuildID = a.buildID
  1952  	}
  1953  
  1954  	// If we are using the eventual install target as an up-to-date
  1955  	// cached copy of the thing we built, then there's no need to
  1956  	// copy it into itself (and that would probably fail anyway).
  1957  	// In this case a1.built == a.Target because a1.built == p.Target,
  1958  	// so the built target is not in the a1.Objdir tree that b.cleanup(a1) removes.
  1959  	if a1.built == a.Target {
  1960  		a.built = a.Target
  1961  		if !a.buggyInstall {
  1962  			b.cleanup(a1)
  1963  		}
  1964  		// Whether we're smart enough to avoid a complete rebuild
  1965  		// depends on exactly what the staleness and rebuild algorithms
  1966  		// are, as well as potentially the state of the Go build cache.
  1967  		// We don't really want users to be able to infer (or worse start depending on)
  1968  		// those details from whether the modification time changes during
  1969  		// "go install", so do a best-effort update of the file times to make it
  1970  		// look like we rewrote a.Target even if we did not. Updating the mtime
  1971  		// may also help other mtime-based systems that depend on our
  1972  		// previous mtime updates that happened more often.
  1973  		// This is still not perfect - we ignore the error result, and if the file was
  1974  		// unwritable for some reason then pretending to have written it is also
  1975  		// confusing - but it's probably better than not doing the mtime update.
  1976  		//
  1977  		// But don't do that for the special case where building an executable
  1978  		// with -linkshared implicitly installs all its dependent libraries.
  1979  		// We want to hide that awful detail as much as possible, so don't
  1980  		// advertise it by touching the mtimes (usually the libraries are up
  1981  		// to date).
  1982  		if !a.buggyInstall && !b.IsCmdList {
  1983  			if cfg.BuildN {
  1984  				sh.ShowCmd("", "touch %s", a.Target)
  1985  			} else if err := AllowInstall(a); err == nil {
  1986  				now := time.Now()
  1987  				os.Chtimes(a.Target, now, now)
  1988  			}
  1989  		}
  1990  		return nil
  1991  	}
  1992  
  1993  	// If we're building for go list -export,
  1994  	// never install anything; just keep the cache reference.
  1995  	if b.IsCmdList {
  1996  		a.built = a1.built
  1997  		return nil
  1998  	}
  1999  	if err := AllowInstall(a); err != nil {
  2000  		return err
  2001  	}
  2002  
  2003  	if err := sh.Mkdir(a.Objdir); err != nil {
  2004  		return err
  2005  	}
  2006  
  2007  	perm := fs.FileMode(0666)
  2008  	if a1.Mode == "link" {
  2009  		switch cfg.BuildBuildmode {
  2010  		case "c-archive", "c-shared", "plugin":
  2011  		default:
  2012  			perm = 0777
  2013  		}
  2014  	}
  2015  
  2016  	// make target directory
  2017  	dir, _ := filepath.Split(a.Target)
  2018  	if dir != "" {
  2019  		if err := sh.Mkdir(dir); err != nil {
  2020  			return err
  2021  		}
  2022  	}
  2023  
  2024  	if !a.buggyInstall {
  2025  		defer b.cleanup(a1)
  2026  	}
  2027  
  2028  	return sh.moveOrCopyFile(a.Target, a1.built, perm, false)
  2029  }
  2030  
  2031  // AllowInstall returns a non-nil error if this invocation of the go command is
  2032  // allowed to install a.Target.
  2033  //
  2034  // The build of cmd/go running under its own test is forbidden from installing
  2035  // to its original GOROOT. The var is exported so it can be set by TestMain.
  2036  var AllowInstall = func(*Action) error { return nil }
  2037  
  2038  // cleanup removes a's object dir to keep the amount of
  2039  // on-disk garbage down in a large build. On an operating system
  2040  // with aggressive buffering, cleaning incrementally like
  2041  // this keeps the intermediate objects from hitting the disk.
  2042  func (b *Builder) cleanup(a *Action) {
  2043  	if !cfg.BuildWork {
  2044  		b.Shell(a).RemoveAll(a.Objdir)
  2045  	}
  2046  }
  2047  
  2048  // Install the cgo export header file, if there is one.
  2049  func (b *Builder) installHeader(ctx context.Context, a *Action) error {
  2050  	sh := b.Shell(a)
  2051  
  2052  	src := a.Objdir + "_cgo_install.h"
  2053  	if _, err := os.Stat(src); os.IsNotExist(err) {
  2054  		// If the file does not exist, there are no exported
  2055  		// functions, and we do not install anything.
  2056  		// TODO(rsc): Once we know that caching is rebuilding
  2057  		// at the right times (not missing rebuilds), here we should
  2058  		// probably delete the installed header, if any.
  2059  		if cfg.BuildX {
  2060  			sh.ShowCmd("", "# %s not created", src)
  2061  		}
  2062  		return nil
  2063  	}
  2064  
  2065  	if err := AllowInstall(a); err != nil {
  2066  		return err
  2067  	}
  2068  
  2069  	dir, _ := filepath.Split(a.Target)
  2070  	if dir != "" {
  2071  		if err := sh.Mkdir(dir); err != nil {
  2072  			return err
  2073  		}
  2074  	}
  2075  
  2076  	return sh.moveOrCopyFile(a.Target, src, 0666, true)
  2077  }
  2078  
  2079  // cover runs, in effect,
  2080  //
  2081  //	go tool cover -pkgcfg=<config file> -mode=b.coverMode -var="varName" -o <outfiles> <infiles>
  2082  //
  2083  // Return value is an updated output files list; in addition to the
  2084  // regular outputs (instrumented source files) the cover tool also
  2085  // writes a separate file (appearing first in the list of outputs)
  2086  // that will contain coverage counters and meta-data.
  2087  func (b *Builder) cover(a *Action, infiles, outfiles []string, varName string, mode string) ([]string, error) {
  2088  	pkgcfg := a.Objdir + "pkgcfg.txt"
  2089  	covoutputs := a.Objdir + "coveroutfiles.txt"
  2090  	odir := filepath.Dir(outfiles[0])
  2091  	cv := filepath.Join(odir, "covervars.go")
  2092  	outfiles = append([]string{cv}, outfiles...)
  2093  	if err := b.writeCoverPkgInputs(a, pkgcfg, covoutputs, outfiles); err != nil {
  2094  		return nil, err
  2095  	}
  2096  	args := []string{base.Tool("cover"),
  2097  		"-pkgcfg", pkgcfg,
  2098  		"-mode", mode,
  2099  		"-var", varName,
  2100  		"-outfilelist", covoutputs,
  2101  	}
  2102  	args = append(args, infiles...)
  2103  	if err := b.Shell(a).run(a.Objdir, "", nil,
  2104  		cfg.BuildToolexec, args); err != nil {
  2105  		return nil, err
  2106  	}
  2107  	return outfiles, nil
  2108  }
  2109  
  2110  func (b *Builder) writeCoverPkgInputs(a *Action, pconfigfile string, covoutputsfile string, outfiles []string) error {
  2111  	sh := b.Shell(a)
  2112  	p := a.Package
  2113  	p.Internal.Cover.Cfg = a.Objdir + "coveragecfg"
  2114  	pcfg := covcmd.CoverPkgConfig{
  2115  		PkgPath: p.ImportPath,
  2116  		PkgName: p.Name,
  2117  		// Note: coverage granularity is currently hard-wired to
  2118  		// 'perblock'; there isn't a way using "go build -cover" or "go
  2119  		// test -cover" to select it. This may change in the future
  2120  		// depending on user demand.
  2121  		Granularity: "perblock",
  2122  		OutConfig:   p.Internal.Cover.Cfg,
  2123  		Local:       p.Internal.Local,
  2124  	}
  2125  	if ca, ok := a.Actor.(*coverActor); ok && ca.covMetaFileName != "" {
  2126  		pcfg.EmitMetaFile = a.Objdir + ca.covMetaFileName
  2127  	}
  2128  	if a.Package.Module != nil {
  2129  		pcfg.ModulePath = a.Package.Module.Path
  2130  	}
  2131  	data, err := json.Marshal(pcfg)
  2132  	if err != nil {
  2133  		return err
  2134  	}
  2135  	data = append(data, '\n')
  2136  	if err := sh.writeFile(pconfigfile, data); err != nil {
  2137  		return err
  2138  	}
  2139  	var sb strings.Builder
  2140  	for i := range outfiles {
  2141  		fmt.Fprintf(&sb, "%s\n", outfiles[i])
  2142  	}
  2143  	return sh.writeFile(covoutputsfile, []byte(sb.String()))
  2144  }
  2145  
  2146  var objectMagic = [][]byte{
  2147  	{'!', '<', 'a', 'r', 'c', 'h', '>', '\n'}, // Package archive
  2148  	{'<', 'b', 'i', 'g', 'a', 'f', '>', '\n'}, // Package AIX big archive
  2149  	{'\x7F', 'E', 'L', 'F'},                   // ELF
  2150  	{0xFE, 0xED, 0xFA, 0xCE},                  // Mach-O big-endian 32-bit
  2151  	{0xFE, 0xED, 0xFA, 0xCF},                  // Mach-O big-endian 64-bit
  2152  	{0xCE, 0xFA, 0xED, 0xFE},                  // Mach-O little-endian 32-bit
  2153  	{0xCF, 0xFA, 0xED, 0xFE},                  // Mach-O little-endian 64-bit
  2154  	{0x4d, 0x5a, 0x90, 0x00, 0x03, 0x00},      // PE (Windows) as generated by 6l/8l and gcc
  2155  	{0x4d, 0x5a, 0x78, 0x00, 0x01, 0x00},      // PE (Windows) as generated by llvm for dll
  2156  	{0x00, 0x00, 0x01, 0xEB},                  // Plan 9 i386
  2157  	{0x00, 0x00, 0x8a, 0x97},                  // Plan 9 amd64
  2158  	{0x00, 0x00, 0x06, 0x47},                  // Plan 9 arm
  2159  	{0x00, 0x61, 0x73, 0x6D},                  // WASM
  2160  	{0x01, 0xDF},                              // XCOFF 32bit
  2161  	{0x01, 0xF7},                              // XCOFF 64bit
  2162  }
  2163  
  2164  func isObject(s string) bool {
  2165  	f, err := os.Open(s)
  2166  	if err != nil {
  2167  		return false
  2168  	}
  2169  	defer f.Close()
  2170  	buf := make([]byte, 64)
  2171  	io.ReadFull(f, buf)
  2172  	for _, magic := range objectMagic {
  2173  		if bytes.HasPrefix(buf, magic) {
  2174  			return true
  2175  		}
  2176  	}
  2177  	return false
  2178  }
  2179  
  2180  // cCompilerEnv returns environment variables to set when running the
  2181  // C compiler. This is needed to disable escape codes in clang error
  2182  // messages that confuse tools like cgo.
  2183  func (b *Builder) cCompilerEnv() []string {
  2184  	return []string{"TERM=dumb"}
  2185  }
  2186  
  2187  // mkAbs returns an absolute path corresponding to
  2188  // evaluating f in the directory dir.
  2189  // We always pass absolute paths of source files so that
  2190  // the error messages will include the full path to a file
  2191  // in need of attention.
  2192  func mkAbs(dir, f string) string {
  2193  	// Leave absolute paths alone.
  2194  	// Also, during -n mode we use the pseudo-directory $WORK
  2195  	// instead of creating an actual work directory that won't be used.
  2196  	// Leave paths beginning with $WORK alone too.
  2197  	if filepath.IsAbs(f) || strings.HasPrefix(f, "$WORK") {
  2198  		return f
  2199  	}
  2200  	return filepath.Join(dir, f)
  2201  }
  2202  
  2203  type toolchain interface {
  2204  	// gc runs the compiler in a specific directory on a set of files
  2205  	// and returns the name of the generated output file.
  2206  	gc(b *Builder, a *Action, archive string, importcfg, embedcfg []byte, symabis string, asmhdr bool, pgoProfile string, gofiles []string) (ofile string, out []byte, err error)
  2207  	// cc runs the toolchain's C compiler in a directory on a C file
  2208  	// to produce an output file.
  2209  	cc(b *Builder, a *Action, ofile, cfile string) error
  2210  	// asm runs the assembler in a specific directory on specific files
  2211  	// and returns a list of named output files.
  2212  	asm(b *Builder, a *Action, sfiles []string) ([]string, error)
  2213  	// symabis scans the symbol ABIs from sfiles and returns the
  2214  	// path to the output symbol ABIs file, or "" if none.
  2215  	symabis(b *Builder, a *Action, sfiles []string) (string, error)
  2216  	// pack runs the archive packer in a specific directory to create
  2217  	// an archive from a set of object files.
  2218  	// typically it is run in the object directory.
  2219  	pack(b *Builder, a *Action, afile string, ofiles []string) error
  2220  	// ld runs the linker to create an executable starting at mainpkg.
  2221  	ld(b *Builder, root *Action, targetPath, importcfg, mainpkg string) error
  2222  	// ldShared runs the linker to create a shared library containing the pkgs built by toplevelactions
  2223  	ldShared(b *Builder, root *Action, toplevelactions []*Action, targetPath, importcfg string, allactions []*Action) error
  2224  
  2225  	compiler() string
  2226  	linker() string
  2227  }
  2228  
  2229  type noToolchain struct{}
  2230  
  2231  func noCompiler() error {
  2232  	log.Fatalf("unknown compiler %q", cfg.BuildContext.Compiler)
  2233  	return nil
  2234  }
  2235  
  2236  func (noToolchain) compiler() string {
  2237  	noCompiler()
  2238  	return ""
  2239  }
  2240  
  2241  func (noToolchain) linker() string {
  2242  	noCompiler()
  2243  	return ""
  2244  }
  2245  
  2246  func (noToolchain) gc(b *Builder, a *Action, archive string, importcfg, embedcfg []byte, symabis string, asmhdr bool, pgoProfile string, gofiles []string) (ofile string, out []byte, err error) {
  2247  	return "", nil, noCompiler()
  2248  }
  2249  
  2250  func (noToolchain) asm(b *Builder, a *Action, sfiles []string) ([]string, error) {
  2251  	return nil, noCompiler()
  2252  }
  2253  
  2254  func (noToolchain) symabis(b *Builder, a *Action, sfiles []string) (string, error) {
  2255  	return "", noCompiler()
  2256  }
  2257  
  2258  func (noToolchain) pack(b *Builder, a *Action, afile string, ofiles []string) error {
  2259  	return noCompiler()
  2260  }
  2261  
  2262  func (noToolchain) ld(b *Builder, root *Action, targetPath, importcfg, mainpkg string) error {
  2263  	return noCompiler()
  2264  }
  2265  
  2266  func (noToolchain) ldShared(b *Builder, root *Action, toplevelactions []*Action, targetPath, importcfg string, allactions []*Action) error {
  2267  	return noCompiler()
  2268  }
  2269  
  2270  func (noToolchain) cc(b *Builder, a *Action, ofile, cfile string) error {
  2271  	return noCompiler()
  2272  }
  2273  
  2274  // gcc runs the gcc C compiler to create an object from a single C file.
  2275  func (b *Builder) gcc(a *Action, workdir, out string, flags []string, cfile string) error {
  2276  	p := a.Package
  2277  	return b.ccompile(a, out, flags, cfile, b.GccCmd(p.Dir, workdir))
  2278  }
  2279  
  2280  // gas runs the gcc c compiler to create an object file from a single C assembly file.
  2281  func (b *Builder) gas(a *Action, workdir, out string, flags []string, sfile string) error {
  2282  	p := a.Package
  2283  	data, err := os.ReadFile(filepath.Join(p.Dir, sfile))
  2284  	if err == nil {
  2285  		if bytes.HasPrefix(data, []byte("TEXT")) || bytes.Contains(data, []byte("\nTEXT")) ||
  2286  			bytes.HasPrefix(data, []byte("DATA")) || bytes.Contains(data, []byte("\nDATA")) ||
  2287  			bytes.HasPrefix(data, []byte("GLOBL")) || bytes.Contains(data, []byte("\nGLOBL")) {
  2288  			return fmt.Errorf("package using cgo has Go assembly file %s", sfile)
  2289  		}
  2290  	}
  2291  	return b.ccompile(a, out, flags, sfile, b.GccCmd(p.Dir, workdir))
  2292  }
  2293  
  2294  // gxx runs the g++ C++ compiler to create an object from a single C++ file.
  2295  func (b *Builder) gxx(a *Action, workdir, out string, flags []string, cxxfile string) error {
  2296  	p := a.Package
  2297  	return b.ccompile(a, out, flags, cxxfile, b.GxxCmd(p.Dir, workdir))
  2298  }
  2299  
  2300  // gfortran runs the gfortran Fortran compiler to create an object from a single Fortran file.
  2301  func (b *Builder) gfortran(a *Action, workdir, out string, flags []string, ffile string) error {
  2302  	p := a.Package
  2303  	return b.ccompile(a, out, flags, ffile, b.gfortranCmd(p.Dir, workdir))
  2304  }
  2305  
  2306  // ccompile runs the given C or C++ compiler and creates an object from a single source file.
  2307  func (b *Builder) ccompile(a *Action, outfile string, flags []string, file string, compiler []string) error {
  2308  	p := a.Package
  2309  	sh := b.Shell(a)
  2310  	file = mkAbs(p.Dir, file)
  2311  	outfile = mkAbs(p.Dir, outfile)
  2312  
  2313  	flags = slices.Clip(flags) // If we append to flags, write to a new slice that we own.
  2314  
  2315  	// Elide source directory paths if -trimpath is set.
  2316  	// This is needed for source files (e.g., a .c file in a package directory).
  2317  	// TODO(golang.org/issue/36072): cgo also generates files with #line
  2318  	// directives pointing to the source directory. It should not generate those
  2319  	// when -trimpath is enabled.
  2320  	if b.gccSupportsFlag(compiler, "-fdebug-prefix-map=a=b") {
  2321  		if cfg.BuildTrimpath || p.Goroot {
  2322  			prefixMapFlag := "-fdebug-prefix-map"
  2323  			if b.gccSupportsFlag(compiler, "-ffile-prefix-map=a=b") {
  2324  				prefixMapFlag = "-ffile-prefix-map"
  2325  			}
  2326  			// Keep in sync with Action.trimpath.
  2327  			// The trimmed paths are a little different, but we need to trim in mostly the
  2328  			// same situations.
  2329  			var from, toPath string
  2330  			if m := p.Module; m == nil {
  2331  				if p.Root == "" { // command-line-arguments in GOPATH mode, maybe?
  2332  					from = p.Dir
  2333  					toPath = p.ImportPath
  2334  				} else if p.Goroot {
  2335  					from = p.Root
  2336  					toPath = "GOROOT"
  2337  				} else {
  2338  					from = p.Root
  2339  					toPath = "GOPATH"
  2340  				}
  2341  			} else if m.Dir == "" {
  2342  				// The module is in the vendor directory. Replace the entire vendor
  2343  				// directory path, because the module's Dir is not filled in.
  2344  				from = b.getVendorDir()
  2345  				toPath = "vendor"
  2346  			} else {
  2347  				from = m.Dir
  2348  				toPath = m.Path
  2349  				if m.Version != "" {
  2350  					toPath += "@" + m.Version
  2351  				}
  2352  			}
  2353  			// -fdebug-prefix-map (or -ffile-prefix-map) requires an absolute "to"
  2354  			// path (or it joins the path  with the working directory). Pick something
  2355  			// that makes sense for the target platform.
  2356  			var to string
  2357  			if cfg.BuildContext.GOOS == "windows" {
  2358  				to = filepath.Join(`\\_\_`, toPath)
  2359  			} else {
  2360  				to = filepath.Join("/_", toPath)
  2361  			}
  2362  			flags = append(slices.Clip(flags), prefixMapFlag+"="+from+"="+to)
  2363  		}
  2364  	}
  2365  
  2366  	// Tell gcc to not insert truly random numbers into the build process
  2367  	// this ensures LTO won't create random numbers for symbols.
  2368  	if b.gccSupportsFlag(compiler, "-frandom-seed=1") {
  2369  		flags = append(flags, "-frandom-seed="+buildid.HashToString(a.actionID))
  2370  	}
  2371  
  2372  	overlayPath := file
  2373  	if p, ok := a.nonGoOverlay[overlayPath]; ok {
  2374  		overlayPath = p
  2375  	}
  2376  	output, err := sh.runOut(filepath.Dir(overlayPath), b.cCompilerEnv(), compiler, flags, "-o", outfile, "-c", filepath.Base(overlayPath))
  2377  
  2378  	// On FreeBSD 11, when we pass -g to clang 3.8 it
  2379  	// invokes its internal assembler with -dwarf-version=2.
  2380  	// When it sees .section .note.GNU-stack, it warns
  2381  	// "DWARF2 only supports one section per compilation unit".
  2382  	// This warning makes no sense, since the section is empty,
  2383  	// but it confuses people.
  2384  	// We work around the problem by detecting the warning
  2385  	// and dropping -g and trying again.
  2386  	if bytes.Contains(output, []byte("DWARF2 only supports one section per compilation unit")) {
  2387  		newFlags := make([]string, 0, len(flags))
  2388  		for _, f := range flags {
  2389  			if !strings.HasPrefix(f, "-g") {
  2390  				newFlags = append(newFlags, f)
  2391  			}
  2392  		}
  2393  		if len(newFlags) < len(flags) {
  2394  			return b.ccompile(a, outfile, newFlags, file, compiler)
  2395  		}
  2396  	}
  2397  
  2398  	if len(output) > 0 && err == nil && os.Getenv("GO_BUILDER_NAME") != "" {
  2399  		output = append(output, "C compiler warning promoted to error on Go builders\n"...)
  2400  		err = errors.New("warning promoted to error")
  2401  	}
  2402  
  2403  	return sh.reportCmd("", "", output, err)
  2404  }
  2405  
  2406  // gccld runs the gcc linker to create an executable from a set of object files.
  2407  func (b *Builder) gccld(a *Action, objdir, outfile string, flags []string, objs []string) error {
  2408  	p := a.Package
  2409  	sh := b.Shell(a)
  2410  	var cmd []string
  2411  	if len(p.CXXFiles) > 0 || len(p.SwigCXXFiles) > 0 {
  2412  		cmd = b.GxxCmd(p.Dir, objdir)
  2413  	} else {
  2414  		cmd = b.GccCmd(p.Dir, objdir)
  2415  	}
  2416  
  2417  	cmdargs := []any{cmd, "-o", outfile, objs, flags}
  2418  	_, err := sh.runOut(base.Cwd(), b.cCompilerEnv(), cmdargs...)
  2419  
  2420  	// Note that failure is an expected outcome here, so we report output only
  2421  	// in debug mode and don't report the error.
  2422  	if cfg.BuildN || cfg.BuildX {
  2423  		saw := "succeeded"
  2424  		if err != nil {
  2425  			saw = "failed"
  2426  		}
  2427  		sh.ShowCmd("", "%s # test for internal linking errors (%s)", joinUnambiguously(str.StringList(cmdargs...)), saw)
  2428  	}
  2429  
  2430  	return err
  2431  }
  2432  
  2433  // GccCmd returns a gcc command line prefix
  2434  // defaultCC is defined in zdefaultcc.go, written by cmd/dist.
  2435  func (b *Builder) GccCmd(incdir, workdir string) []string {
  2436  	return b.compilerCmd(b.ccExe(), incdir, workdir)
  2437  }
  2438  
  2439  // GxxCmd returns a g++ command line prefix
  2440  // defaultCXX is defined in zdefaultcc.go, written by cmd/dist.
  2441  func (b *Builder) GxxCmd(incdir, workdir string) []string {
  2442  	return b.compilerCmd(b.cxxExe(), incdir, workdir)
  2443  }
  2444  
  2445  // gfortranCmd returns a gfortran command line prefix.
  2446  func (b *Builder) gfortranCmd(incdir, workdir string) []string {
  2447  	return b.compilerCmd(b.fcExe(), incdir, workdir)
  2448  }
  2449  
  2450  // ccExe returns the CC compiler setting without all the extra flags we add implicitly.
  2451  func (b *Builder) ccExe() []string {
  2452  	return envList("CC", cfg.DefaultCC(cfg.Goos, cfg.Goarch))
  2453  }
  2454  
  2455  // cxxExe returns the CXX compiler setting without all the extra flags we add implicitly.
  2456  func (b *Builder) cxxExe() []string {
  2457  	return envList("CXX", cfg.DefaultCXX(cfg.Goos, cfg.Goarch))
  2458  }
  2459  
  2460  // fcExe returns the FC compiler setting without all the extra flags we add implicitly.
  2461  func (b *Builder) fcExe() []string {
  2462  	return envList("FC", "gfortran")
  2463  }
  2464  
  2465  // compilerCmd returns a command line prefix for the given environment
  2466  // variable and using the default command when the variable is empty.
  2467  func (b *Builder) compilerCmd(compiler []string, incdir, workdir string) []string {
  2468  	a := append(compiler, "-I", incdir)
  2469  
  2470  	// Definitely want -fPIC but on Windows gcc complains
  2471  	// "-fPIC ignored for target (all code is position independent)"
  2472  	if cfg.Goos != "windows" {
  2473  		a = append(a, "-fPIC")
  2474  	}
  2475  	a = append(a, b.gccArchArgs()...)
  2476  	// gcc-4.5 and beyond require explicit "-pthread" flag
  2477  	// for multithreading with pthread library.
  2478  	if cfg.BuildContext.CgoEnabled {
  2479  		switch cfg.Goos {
  2480  		case "windows":
  2481  			a = append(a, "-mthreads")
  2482  		default:
  2483  			a = append(a, "-pthread")
  2484  		}
  2485  	}
  2486  
  2487  	if cfg.Goos == "aix" {
  2488  		// mcmodel=large must always be enabled to allow large TOC.
  2489  		a = append(a, "-mcmodel=large")
  2490  	}
  2491  
  2492  	// disable ASCII art in clang errors, if possible
  2493  	if b.gccSupportsFlag(compiler, "-fno-caret-diagnostics") {
  2494  		a = append(a, "-fno-caret-diagnostics")
  2495  	}
  2496  	// clang is too smart about command-line arguments
  2497  	if b.gccSupportsFlag(compiler, "-Qunused-arguments") {
  2498  		a = append(a, "-Qunused-arguments")
  2499  	}
  2500  
  2501  	// zig cc passes --gc-sections to the underlying linker, which then causes
  2502  	// undefined symbol errors when compiling with cgo but without C code.
  2503  	// https://github.com/golang/go/issues/52690
  2504  	if b.gccSupportsFlag(compiler, "-Wl,--no-gc-sections") {
  2505  		a = append(a, "-Wl,--no-gc-sections")
  2506  	}
  2507  
  2508  	// disable word wrapping in error messages
  2509  	a = append(a, "-fmessage-length=0")
  2510  
  2511  	// Tell gcc not to include the work directory in object files.
  2512  	if b.gccSupportsFlag(compiler, "-fdebug-prefix-map=a=b") {
  2513  		if workdir == "" {
  2514  			workdir = b.WorkDir
  2515  		}
  2516  		workdir = strings.TrimSuffix(workdir, string(filepath.Separator))
  2517  		if b.gccSupportsFlag(compiler, "-ffile-prefix-map=a=b") {
  2518  			a = append(a, "-ffile-prefix-map="+workdir+"=/tmp/go-build")
  2519  		} else {
  2520  			a = append(a, "-fdebug-prefix-map="+workdir+"=/tmp/go-build")
  2521  		}
  2522  	}
  2523  
  2524  	// Tell gcc not to include flags in object files, which defeats the
  2525  	// point of -fdebug-prefix-map above.
  2526  	if b.gccSupportsFlag(compiler, "-gno-record-gcc-switches") {
  2527  		a = append(a, "-gno-record-gcc-switches")
  2528  	}
  2529  
  2530  	// On OS X, some of the compilers behave as if -fno-common
  2531  	// is always set, and the Mach-O linker in 6l/8l assumes this.
  2532  	// See https://golang.org/issue/3253.
  2533  	if cfg.Goos == "darwin" || cfg.Goos == "ios" {
  2534  		a = append(a, "-fno-common")
  2535  	}
  2536  
  2537  	return a
  2538  }
  2539  
  2540  // gccNoPie returns the flag to use to request non-PIE. On systems
  2541  // with PIE (position independent executables) enabled by default,
  2542  // -no-pie must be passed when doing a partial link with -Wl,-r.
  2543  // But -no-pie is not supported by all compilers, and clang spells it -nopie.
  2544  func (b *Builder) gccNoPie(linker []string) string {
  2545  	if b.gccSupportsFlag(linker, "-no-pie") {
  2546  		return "-no-pie"
  2547  	}
  2548  	if b.gccSupportsFlag(linker, "-nopie") {
  2549  		return "-nopie"
  2550  	}
  2551  	return ""
  2552  }
  2553  
  2554  // gccSupportsFlag checks to see if the compiler supports a flag.
  2555  func (b *Builder) gccSupportsFlag(compiler []string, flag string) bool {
  2556  	// We use the background shell for operations here because, while this is
  2557  	// triggered by some Action, it's not really about that Action, and often we
  2558  	// just get the results from the global cache.
  2559  	sh := b.BackgroundShell()
  2560  
  2561  	key := [2]string{compiler[0], flag}
  2562  
  2563  	// We used to write an empty C file, but that gets complicated with go
  2564  	// build -n. We tried using a file that does not exist, but that fails on
  2565  	// systems with GCC version 4.2.1; that is the last GPLv2 version of GCC,
  2566  	// so some systems have frozen on it. Now we pass an empty file on stdin,
  2567  	// which should work at least for GCC and clang.
  2568  	//
  2569  	// If the argument is "-Wl,", then it is testing the linker. In that case,
  2570  	// skip "-c". If it's not "-Wl,", then we are testing the compiler and can
  2571  	// omit the linking step with "-c".
  2572  	//
  2573  	// Using the same CFLAGS/LDFLAGS here and for building the program.
  2574  
  2575  	// On the iOS builder the command
  2576  	//   $CC -Wl,--no-gc-sections -x c - -o /dev/null < /dev/null
  2577  	// is failing with:
  2578  	//   Unable to remove existing file: Invalid argument
  2579  	tmp := os.DevNull
  2580  	if runtime.GOOS == "windows" || runtime.GOOS == "ios" {
  2581  		f, err := os.CreateTemp(b.WorkDir, "")
  2582  		if err != nil {
  2583  			return false
  2584  		}
  2585  		f.Close()
  2586  		tmp = f.Name()
  2587  		defer os.Remove(tmp)
  2588  	}
  2589  
  2590  	cmdArgs := str.StringList(compiler, flag)
  2591  	if strings.HasPrefix(flag, "-Wl,") /* linker flag */ {
  2592  		ldflags, err := buildFlags("LDFLAGS", DefaultCFlags, nil, checkLinkerFlags)
  2593  		if err != nil {
  2594  			return false
  2595  		}
  2596  		cmdArgs = append(cmdArgs, ldflags...)
  2597  	} else { /* compiler flag, add "-c" */
  2598  		cflags, err := buildFlags("CFLAGS", DefaultCFlags, nil, checkCompilerFlags)
  2599  		if err != nil {
  2600  			return false
  2601  		}
  2602  		cmdArgs = append(cmdArgs, cflags...)
  2603  		cmdArgs = append(cmdArgs, "-c")
  2604  	}
  2605  
  2606  	cmdArgs = append(cmdArgs, "-x", "c", "-", "-o", tmp)
  2607  
  2608  	if cfg.BuildN {
  2609  		sh.ShowCmd(b.WorkDir, "%s || true", joinUnambiguously(cmdArgs))
  2610  		return false
  2611  	}
  2612  
  2613  	// gccCompilerID acquires b.exec, so do before acquiring lock.
  2614  	compilerID, cacheOK := b.gccCompilerID(compiler[0])
  2615  
  2616  	b.exec.Lock()
  2617  	defer b.exec.Unlock()
  2618  	if b, ok := b.flagCache[key]; ok {
  2619  		return b
  2620  	}
  2621  	if b.flagCache == nil {
  2622  		b.flagCache = make(map[[2]string]bool)
  2623  	}
  2624  
  2625  	// Look in build cache.
  2626  	var flagID cache.ActionID
  2627  	if cacheOK {
  2628  		flagID = cache.Subkey(compilerID, "gccSupportsFlag "+flag)
  2629  		if data, _, err := cache.GetBytes(cache.Default(), flagID); err == nil {
  2630  			supported := string(data) == "true"
  2631  			b.flagCache[key] = supported
  2632  			return supported
  2633  		}
  2634  	}
  2635  
  2636  	if cfg.BuildX {
  2637  		sh.ShowCmd(b.WorkDir, "%s || true", joinUnambiguously(cmdArgs))
  2638  	}
  2639  	cmd := exec.Command(cmdArgs[0], cmdArgs[1:]...)
  2640  	cmd.Dir = b.WorkDir
  2641  	cmd.Env = append(cmd.Environ(), "LC_ALL=C")
  2642  	out, _ := cmd.CombinedOutput()
  2643  	// GCC says "unrecognized command line option".
  2644  	// clang says "unknown argument".
  2645  	// tcc says "unsupported"
  2646  	// AIX says "not recognized"
  2647  	// Older versions of GCC say "unrecognised debug output level".
  2648  	// For -fsplit-stack GCC says "'-fsplit-stack' is not supported".
  2649  	supported := !bytes.Contains(out, []byte("unrecognized")) &&
  2650  		!bytes.Contains(out, []byte("unknown")) &&
  2651  		!bytes.Contains(out, []byte("unrecognised")) &&
  2652  		!bytes.Contains(out, []byte("is not supported")) &&
  2653  		!bytes.Contains(out, []byte("not recognized")) &&
  2654  		!bytes.Contains(out, []byte("unsupported"))
  2655  
  2656  	if cacheOK {
  2657  		s := "false"
  2658  		if supported {
  2659  			s = "true"
  2660  		}
  2661  		cache.PutBytes(cache.Default(), flagID, []byte(s))
  2662  	}
  2663  
  2664  	b.flagCache[key] = supported
  2665  	return supported
  2666  }
  2667  
  2668  // statString returns a string form of an os.FileInfo, for serializing and comparison.
  2669  func statString(info os.FileInfo) string {
  2670  	return fmt.Sprintf("stat %d %x %v %v\n", info.Size(), uint64(info.Mode()), info.ModTime(), info.IsDir())
  2671  }
  2672  
  2673  // gccCompilerID returns a build cache key for the current gcc,
  2674  // as identified by running 'compiler'.
  2675  // The caller can use subkeys of the key.
  2676  // Other parts of cmd/go can use the id as a hash
  2677  // of the installed compiler version.
  2678  func (b *Builder) gccCompilerID(compiler string) (id cache.ActionID, ok bool) {
  2679  	// We use the background shell for operations here because, while this is
  2680  	// triggered by some Action, it's not really about that Action, and often we
  2681  	// just get the results from the global cache.
  2682  	sh := b.BackgroundShell()
  2683  
  2684  	if cfg.BuildN {
  2685  		sh.ShowCmd(b.WorkDir, "%s || true", joinUnambiguously([]string{compiler, "--version"}))
  2686  		return cache.ActionID{}, false
  2687  	}
  2688  
  2689  	b.exec.Lock()
  2690  	defer b.exec.Unlock()
  2691  
  2692  	if id, ok := b.gccCompilerIDCache[compiler]; ok {
  2693  		return id, ok
  2694  	}
  2695  
  2696  	// We hash the compiler's full path to get a cache entry key.
  2697  	// That cache entry holds a validation description,
  2698  	// which is of the form:
  2699  	//
  2700  	//	filename \x00 statinfo \x00
  2701  	//	...
  2702  	//	compiler id
  2703  	//
  2704  	// If os.Stat of each filename matches statinfo,
  2705  	// then the entry is still valid, and we can use the
  2706  	// compiler id without any further expense.
  2707  	//
  2708  	// Otherwise, we compute a new validation description
  2709  	// and compiler id (below).
  2710  	exe, err := pathcache.LookPath(compiler)
  2711  	if err != nil {
  2712  		return cache.ActionID{}, false
  2713  	}
  2714  
  2715  	h := cache.NewHash("gccCompilerID")
  2716  	fmt.Fprintf(h, "gccCompilerID %q", exe)
  2717  	key := h.Sum()
  2718  	data, _, err := cache.GetBytes(cache.Default(), key)
  2719  	if err == nil && len(data) > len(id) {
  2720  		stats := strings.Split(string(data[:len(data)-len(id)]), "\x00")
  2721  		if len(stats)%2 != 0 {
  2722  			goto Miss
  2723  		}
  2724  		for i := 0; i+2 <= len(stats); i++ {
  2725  			info, err := os.Stat(stats[i])
  2726  			if err != nil || statString(info) != stats[i+1] {
  2727  				goto Miss
  2728  			}
  2729  		}
  2730  		copy(id[:], data[len(data)-len(id):])
  2731  		return id, true
  2732  	Miss:
  2733  	}
  2734  
  2735  	// Validation failed. Compute a new description (in buf) and compiler ID (in h).
  2736  	// For now, there are only at most two filenames in the stat information.
  2737  	// The first one is the compiler executable we invoke.
  2738  	// The second is the underlying compiler as reported by -v -###
  2739  	// (see b.gccToolID implementation in buildid.go).
  2740  	toolID, exe2, err := b.gccToolID(compiler, "c")
  2741  	if err != nil {
  2742  		return cache.ActionID{}, false
  2743  	}
  2744  
  2745  	exes := []string{exe, exe2}
  2746  	str.Uniq(&exes)
  2747  	fmt.Fprintf(h, "gccCompilerID %q %q\n", exes, toolID)
  2748  	id = h.Sum()
  2749  
  2750  	var buf bytes.Buffer
  2751  	for _, exe := range exes {
  2752  		if exe == "" {
  2753  			continue
  2754  		}
  2755  		info, err := os.Stat(exe)
  2756  		if err != nil {
  2757  			return cache.ActionID{}, false
  2758  		}
  2759  		buf.WriteString(exe)
  2760  		buf.WriteString("\x00")
  2761  		buf.WriteString(statString(info))
  2762  		buf.WriteString("\x00")
  2763  	}
  2764  	buf.Write(id[:])
  2765  
  2766  	cache.PutBytes(cache.Default(), key, buf.Bytes())
  2767  	if b.gccCompilerIDCache == nil {
  2768  		b.gccCompilerIDCache = make(map[string]cache.ActionID)
  2769  	}
  2770  	b.gccCompilerIDCache[compiler] = id
  2771  	return id, true
  2772  }
  2773  
  2774  // gccArchArgs returns arguments to pass to gcc based on the architecture.
  2775  func (b *Builder) gccArchArgs() []string {
  2776  	switch cfg.Goarch {
  2777  	case "386":
  2778  		return []string{"-m32"}
  2779  	case "amd64":
  2780  		if cfg.Goos == "darwin" {
  2781  			return []string{"-arch", "x86_64", "-m64"}
  2782  		}
  2783  		return []string{"-m64"}
  2784  	case "arm64":
  2785  		if cfg.Goos == "darwin" {
  2786  			return []string{"-arch", "arm64"}
  2787  		}
  2788  	case "arm":
  2789  		return []string{"-marm"} // not thumb
  2790  	case "s390x":
  2791  		// minimum supported s390x version on Go is z13
  2792  		return []string{"-m64", "-march=z13"}
  2793  	case "mips64", "mips64le":
  2794  		args := []string{"-mabi=64"}
  2795  		if cfg.GOMIPS64 == "hardfloat" {
  2796  			return append(args, "-mhard-float")
  2797  		} else if cfg.GOMIPS64 == "softfloat" {
  2798  			return append(args, "-msoft-float")
  2799  		}
  2800  	case "mips", "mipsle":
  2801  		args := []string{"-mabi=32", "-march=mips32"}
  2802  		if cfg.GOMIPS == "hardfloat" {
  2803  			return append(args, "-mhard-float", "-mfp32", "-mno-odd-spreg")
  2804  		} else if cfg.GOMIPS == "softfloat" {
  2805  			return append(args, "-msoft-float")
  2806  		}
  2807  	case "loong64":
  2808  		// On loong64, gcc and clang enable relaxation optimization by default, forcing
  2809  		// Go to handle corresponding relocations. Otherwise, it can lead to unreachable
  2810  		// jump instructions and an excessive number of temporary symbols in the findfunc
  2811  		// table. We added the -mno-relax option to disable relaxation optimization in the
  2812  		// cgo code to ensure that Go doesn't encounter errors without additional processing.
  2813  		return []string{"-mabi=lp64d", "-mno-relax"}
  2814  	case "ppc64":
  2815  		if cfg.Goos == "aix" {
  2816  			return []string{"-maix64"}
  2817  		}
  2818  	}
  2819  	return nil
  2820  }
  2821  
  2822  // envList returns the value of the given environment variable broken
  2823  // into fields, using the default value when the variable is empty.
  2824  //
  2825  // The environment variable must be quoted correctly for
  2826  // quoted.Split. This should be done before building
  2827  // anything, for example, in BuildInit.
  2828  func envList(key, def string) []string {
  2829  	v := cfg.Getenv(key)
  2830  	if v == "" {
  2831  		v = def
  2832  	}
  2833  	args, err := quoted.Split(v)
  2834  	if err != nil {
  2835  		panic(fmt.Sprintf("could not parse environment variable %s with value %q: %v", key, v, err))
  2836  	}
  2837  	return args
  2838  }
  2839  
  2840  // CFlags returns the flags to use when invoking the C, C++ or Fortran compilers, or cgo.
  2841  func (b *Builder) CFlags(p *load.Package) (cppflags, cflags, cxxflags, fflags, ldflags []string, err error) {
  2842  	if cppflags, err = buildFlags("CPPFLAGS", "", p.CgoCPPFLAGS, checkCompilerFlags); err != nil {
  2843  		return
  2844  	}
  2845  	if cflags, err = buildFlags("CFLAGS", DefaultCFlags, p.CgoCFLAGS, checkCompilerFlags); err != nil {
  2846  		return
  2847  	}
  2848  	if cxxflags, err = buildFlags("CXXFLAGS", DefaultCFlags, p.CgoCXXFLAGS, checkCompilerFlags); err != nil {
  2849  		return
  2850  	}
  2851  	if fflags, err = buildFlags("FFLAGS", DefaultCFlags, p.CgoFFLAGS, checkCompilerFlags); err != nil {
  2852  		return
  2853  	}
  2854  	if ldflags, err = buildFlags("LDFLAGS", DefaultCFlags, p.CgoLDFLAGS, checkLinkerFlags); err != nil {
  2855  		return
  2856  	}
  2857  
  2858  	return
  2859  }
  2860  
  2861  func buildFlags(name, defaults string, fromPackage []string, check func(string, string, []string) error) ([]string, error) {
  2862  	if err := check(name, "#cgo "+name, fromPackage); err != nil {
  2863  		return nil, err
  2864  	}
  2865  	return str.StringList(envList("CGO_"+name, defaults), fromPackage), nil
  2866  }
  2867  
  2868  var cgoRe = lazyregexp.New(`[/\\:]`)
  2869  
  2870  type runCgoProvider struct {
  2871  	CFLAGS, CXXFLAGS, FFLAGS, LDFLAGS []string
  2872  	notCompatibleForInternalLinking   bool
  2873  	nonGoOverlay                      map[string]string
  2874  	goFiles                           []string // processed cgo files for the compiler
  2875  }
  2876  
  2877  func (pr *runCgoProvider) cflags() []string {
  2878  	return pr.CFLAGS
  2879  }
  2880  
  2881  func (pr *runCgoProvider) cxxflags() []string {
  2882  	return pr.CXXFLAGS
  2883  }
  2884  
  2885  func (pr *runCgoProvider) fflags() []string {
  2886  	return pr.FFLAGS
  2887  }
  2888  
  2889  func (pr *runCgoProvider) ldflags() []string {
  2890  	return pr.LDFLAGS
  2891  }
  2892  
  2893  func mustGetCoverInfo(a *Action) *coverProvider {
  2894  	for _, dep := range a.Deps {
  2895  		if dep.Mode == "cover" {
  2896  			return dep.Provider.(*coverProvider)
  2897  		}
  2898  	}
  2899  	base.Fatalf("internal error: cover provider not found")
  2900  	panic("unreachable")
  2901  }
  2902  
  2903  func (b *Builder) runCgo(ctx context.Context, a *Action) error {
  2904  	p := a.Package
  2905  	sh := b.Shell(a)
  2906  	objdir := a.Objdir
  2907  
  2908  	if err := sh.Mkdir(objdir); err != nil {
  2909  		return err
  2910  	}
  2911  
  2912  	nonGoFileLists := [][]string{p.CFiles, p.SFiles, p.CXXFiles, p.HFiles, p.FFiles}
  2913  	if err := b.computeNonGoOverlay(a, p, sh, objdir, nonGoFileLists); err != nil {
  2914  		return err
  2915  	}
  2916  
  2917  	cgofiles := slices.Clip(p.CgoFiles)
  2918  	if a.Package.Internal.Cover.Mode != "" {
  2919  		cp := mustGetCoverInfo(a)
  2920  		cgofiles = cp.cgoSources
  2921  	}
  2922  
  2923  	pcCFLAGS, pcLDFLAGS, err := b.getPkgConfigFlags(a, p)
  2924  	if err != nil {
  2925  		return err
  2926  	}
  2927  
  2928  	// Run SWIG on each .swig and .swigcxx file.
  2929  	// Each run will generate two files, a .go file and a .c or .cxx file.
  2930  	// The .go file will use import "C" and is to be processed by cgo.
  2931  	// For -cover test or build runs, this needs to happen after the cover
  2932  	// tool is run; we don't want to instrument swig-generated Go files,
  2933  	// see issue #64661.
  2934  	if p.UsesSwig() {
  2935  		if err := b.swig(a, objdir, pcCFLAGS); err != nil {
  2936  			return err
  2937  		}
  2938  		outGo, _, _ := b.swigOutputs(p, objdir)
  2939  		cgofiles = append(cgofiles, outGo...)
  2940  	}
  2941  
  2942  	cgoExe := base.Tool("cgo")
  2943  	cgofiles = mkAbsFiles(p.Dir, cgofiles)
  2944  
  2945  	cgoCPPFLAGS, cgoCFLAGS, cgoCXXFLAGS, cgoFFLAGS, cgoLDFLAGS, err := b.CFlags(p)
  2946  	if err != nil {
  2947  		return err
  2948  	}
  2949  
  2950  	cgoCPPFLAGS = append(cgoCPPFLAGS, pcCFLAGS...)
  2951  	cgoLDFLAGS = append(cgoLDFLAGS, pcLDFLAGS...)
  2952  	// If we are compiling Objective-C code, then we need to link against libobjc
  2953  	if len(p.MFiles) > 0 {
  2954  		cgoLDFLAGS = append(cgoLDFLAGS, "-lobjc")
  2955  	}
  2956  
  2957  	// Likewise for Fortran, except there are many Fortran compilers.
  2958  	// Support gfortran out of the box and let others pass the correct link options
  2959  	// via CGO_LDFLAGS
  2960  	if len(p.FFiles) > 0 {
  2961  		fc := cfg.Getenv("FC")
  2962  		if fc == "" {
  2963  			fc = "gfortran"
  2964  		}
  2965  		if strings.Contains(fc, "gfortran") {
  2966  			cgoLDFLAGS = append(cgoLDFLAGS, "-lgfortran")
  2967  		}
  2968  	}
  2969  
  2970  	// Scrutinize CFLAGS and related for flags that might cause
  2971  	// problems if we are using internal linking (for example, use of
  2972  	// plugins, LTO, etc) by calling a helper routine that builds on
  2973  	// the existing CGO flags allow-lists. If we see anything
  2974  	// suspicious, emit a special token file "preferlinkext" (known to
  2975  	// the linker) in the object file to signal the that it should not
  2976  	// try to link internally and should revert to external linking.
  2977  	// The token we pass is a suggestion, not a mandate; if a user is
  2978  	// explicitly asking for a specific linkmode via the "-linkmode"
  2979  	// flag, the token will be ignored. NB: in theory we could ditch
  2980  	// the token approach and just pass a flag to the linker when we
  2981  	// eventually invoke it, and the linker flag could then be
  2982  	// documented (although coming up with a simple explanation of the
  2983  	// flag might be challenging). For more context see issues #58619,
  2984  	// #58620, and #58848.
  2985  	flagSources := []string{"CGO_CFLAGS", "CGO_CXXFLAGS", "CGO_FFLAGS"}
  2986  	flagLists := [][]string{cgoCFLAGS, cgoCXXFLAGS, cgoFFLAGS}
  2987  	notCompatibleWithInternalLinking := flagsNotCompatibleWithInternalLinking(flagSources, flagLists)
  2988  
  2989  	if cfg.BuildMSan {
  2990  		cgoCFLAGS = append([]string{"-fsanitize=memory"}, cgoCFLAGS...)
  2991  		cgoLDFLAGS = append([]string{"-fsanitize=memory"}, cgoLDFLAGS...)
  2992  	}
  2993  	if cfg.BuildASan {
  2994  		cgoCFLAGS = append([]string{"-fsanitize=address"}, cgoCFLAGS...)
  2995  		cgoLDFLAGS = append([]string{"-fsanitize=address"}, cgoLDFLAGS...)
  2996  	}
  2997  
  2998  	// Allows including _cgo_export.h, as well as the user's .h files,
  2999  	// from .[ch] files in the package.
  3000  	cgoCPPFLAGS = append(cgoCPPFLAGS, "-I", objdir)
  3001  
  3002  	// cgo
  3003  	// TODO: CGO_FLAGS?
  3004  	gofiles := []string{objdir + "_cgo_gotypes.go"}
  3005  	cfiles := []string{objdir + "_cgo_export.c"}
  3006  	for _, fn := range cgofiles {
  3007  		f := strings.TrimSuffix(filepath.Base(fn), ".go")
  3008  		gofiles = append(gofiles, objdir+f+".cgo1.go")
  3009  		cfiles = append(cfiles, objdir+f+".cgo2.c")
  3010  	}
  3011  
  3012  	// TODO: make cgo not depend on $GOARCH?
  3013  
  3014  	cgoflags := []string{}
  3015  	if p.Standard && p.ImportPath == "runtime/cgo" {
  3016  		cgoflags = append(cgoflags, "-import_runtime_cgo=false")
  3017  	}
  3018  	if p.Standard && (p.ImportPath == "runtime/race" || p.ImportPath == "runtime/msan" || p.ImportPath == "runtime/cgo" || p.ImportPath == "runtime/asan") {
  3019  		cgoflags = append(cgoflags, "-import_syscall=false")
  3020  	}
  3021  
  3022  	// cgoLDFLAGS, which includes p.CgoLDFLAGS, can be very long.
  3023  	// Pass it to cgo on the command line, so that we use a
  3024  	// response file if necessary.
  3025  	//
  3026  	// These flags are recorded in the generated _cgo_gotypes.go file
  3027  	// using //go:cgo_ldflag directives, the compiler records them in the
  3028  	// object file for the package, and then the Go linker passes them
  3029  	// along to the host linker. At this point in the code, cgoLDFLAGS
  3030  	// consists of the original $CGO_LDFLAGS (unchecked) and all the
  3031  	// flags put together from source code (checked).
  3032  	cgoenv := b.cCompilerEnv()
  3033  	cgoenv = append(cgoenv, cfgChangedEnv...)
  3034  	var ldflagsOption []string
  3035  	if len(cgoLDFLAGS) > 0 {
  3036  		flags := make([]string, len(cgoLDFLAGS))
  3037  		for i, f := range cgoLDFLAGS {
  3038  			flags[i] = strconv.Quote(f)
  3039  		}
  3040  		ldflagsOption = []string{"-ldflags=" + strings.Join(flags, " ")}
  3041  
  3042  		// Remove CGO_LDFLAGS from the environment.
  3043  		cgoenv = append(cgoenv, "CGO_LDFLAGS=")
  3044  	}
  3045  
  3046  	if cfg.BuildToolchainName == "gccgo" {
  3047  		if b.gccSupportsFlag([]string{BuildToolchain.compiler()}, "-fsplit-stack") {
  3048  			cgoCFLAGS = append(cgoCFLAGS, "-fsplit-stack")
  3049  		}
  3050  		cgoflags = append(cgoflags, "-gccgo")
  3051  		if pkgpath := gccgoPkgpath(p); pkgpath != "" {
  3052  			cgoflags = append(cgoflags, "-gccgopkgpath="+pkgpath)
  3053  		}
  3054  		if !BuildToolchain.(gccgoToolchain).supportsCgoIncomplete(b, a) {
  3055  			cgoflags = append(cgoflags, "-gccgo_define_cgoincomplete")
  3056  		}
  3057  	}
  3058  
  3059  	switch cfg.BuildBuildmode {
  3060  	case "c-archive", "c-shared":
  3061  		// Tell cgo that if there are any exported functions
  3062  		// it should generate a header file that C code can
  3063  		// #include.
  3064  		cgoflags = append(cgoflags, "-exportheader="+objdir+"_cgo_install.h")
  3065  	}
  3066  
  3067  	// Rewrite overlaid paths in cgo files.
  3068  	// cgo adds //line and #line pragmas in generated files with these paths.
  3069  	var trimpath []string
  3070  	for i := range cgofiles {
  3071  		path := mkAbs(p.Dir, cgofiles[i])
  3072  		if fsys.Replaced(path) {
  3073  			actual := fsys.Actual(path)
  3074  			cgofiles[i] = actual
  3075  			trimpath = append(trimpath, actual+"=>"+path)
  3076  		}
  3077  	}
  3078  	if len(trimpath) > 0 {
  3079  		cgoflags = append(cgoflags, "-trimpath", strings.Join(trimpath, ";"))
  3080  	}
  3081  
  3082  	if err := sh.run(p.Dir, p.ImportPath, cgoenv, cfg.BuildToolexec, cgoExe, "-objdir", objdir, "-importpath", p.ImportPath, cgoflags, ldflagsOption, "--", cgoCPPFLAGS, cgoCFLAGS, cgofiles); err != nil {
  3083  		return err
  3084  	}
  3085  
  3086  	a.Provider = &runCgoProvider{
  3087  		CFLAGS:                          str.StringList(cgoCPPFLAGS, cgoCFLAGS),
  3088  		CXXFLAGS:                        str.StringList(cgoCPPFLAGS, cgoCXXFLAGS),
  3089  		FFLAGS:                          str.StringList(cgoCPPFLAGS, cgoFFLAGS),
  3090  		LDFLAGS:                         cgoLDFLAGS,
  3091  		notCompatibleForInternalLinking: notCompatibleWithInternalLinking,
  3092  		nonGoOverlay:                    a.nonGoOverlay,
  3093  		goFiles:                         gofiles,
  3094  	}
  3095  
  3096  	return nil
  3097  }
  3098  
  3099  func (b *Builder) processCgoOutputs(a *Action, runCgoProvider *runCgoProvider, cgoExe, objdir string) (outGo, outObj []string, err error) {
  3100  	outGo = slices.Clip(runCgoProvider.goFiles)
  3101  
  3102  	// TODO(matloob): Pretty much the only thing this function is doing is
  3103  	// producing the dynimport go files. But we should be able to compile
  3104  	// those separately from the package itself: we just need to get the
  3105  	// compiled output to the linker. That means that we can remove the
  3106  	// dependency of this build action on the outputs of the cgo compile actions
  3107  	// (though we'd still need to depend on the runCgo action of course).
  3108  
  3109  	sh := b.Shell(a)
  3110  
  3111  	// Output the preferlinkext file if the run cgo action determined this package
  3112  	// was not compatible for internal linking based on CFLAGS, CXXFLAGS, or FFLAGS.
  3113  	if runCgoProvider.notCompatibleForInternalLinking {
  3114  		tokenFile := objdir + "preferlinkext"
  3115  		if err := sh.writeFile(tokenFile, nil); err != nil {
  3116  			return nil, nil, err
  3117  		}
  3118  		outObj = append(outObj, tokenFile)
  3119  	}
  3120  
  3121  	var collectAction *Action
  3122  	for _, dep := range a.Deps {
  3123  		if dep.Mode == "collect cgo" {
  3124  			collectAction = dep
  3125  		}
  3126  	}
  3127  	if collectAction == nil {
  3128  		base.Fatalf("internal error: no cgo collect action")
  3129  	}
  3130  	for _, dep := range collectAction.Deps {
  3131  		outObj = append(outObj, dep.Target)
  3132  	}
  3133  
  3134  	switch cfg.BuildToolchainName {
  3135  	case "gc":
  3136  		importGo := objdir + "_cgo_import.go"
  3137  		dynOutGo, dynOutObj, err := b.dynimport(a, objdir, importGo, cgoExe, runCgoProvider.CFLAGS, runCgoProvider.LDFLAGS, outObj)
  3138  		if err != nil {
  3139  			return nil, nil, err
  3140  		}
  3141  		if dynOutGo != "" {
  3142  			outGo = append(outGo, dynOutGo)
  3143  		}
  3144  		if dynOutObj != "" {
  3145  			outObj = append(outObj, dynOutObj)
  3146  		}
  3147  
  3148  	case "gccgo":
  3149  		defunC := objdir + "_cgo_defun.c"
  3150  		defunObj := objdir + "_cgo_defun.o"
  3151  		if err := BuildToolchain.cc(b, a, defunObj, defunC); err != nil {
  3152  			return nil, nil, err
  3153  		}
  3154  		outObj = append(outObj, defunObj)
  3155  
  3156  	default:
  3157  		noCompiler()
  3158  	}
  3159  
  3160  	// Double check the //go:cgo_ldflag comments in the generated files.
  3161  	// The compiler only permits such comments in files whose base name
  3162  	// starts with "_cgo_". Make sure that the comments in those files
  3163  	// are safe. This is a backstop against people somehow smuggling
  3164  	// such a comment into a file generated by cgo.
  3165  	if cfg.BuildToolchainName == "gc" && !cfg.BuildN {
  3166  		var flags []string
  3167  		for _, f := range outGo {
  3168  			if !strings.HasPrefix(filepath.Base(f), "_cgo_") {
  3169  				continue
  3170  			}
  3171  
  3172  			src, err := os.ReadFile(f)
  3173  			if err != nil {
  3174  				return nil, nil, err
  3175  			}
  3176  
  3177  			const cgoLdflag = "//go:cgo_ldflag"
  3178  			idx := bytes.Index(src, []byte(cgoLdflag))
  3179  			for idx >= 0 {
  3180  				// We are looking at //go:cgo_ldflag.
  3181  				// Find start of line.
  3182  				start := bytes.LastIndex(src[:idx], []byte("\n"))
  3183  				if start == -1 {
  3184  					start = 0
  3185  				}
  3186  
  3187  				// Find end of line.
  3188  				end := bytes.Index(src[idx:], []byte("\n"))
  3189  				if end == -1 {
  3190  					end = len(src)
  3191  				} else {
  3192  					end += idx
  3193  				}
  3194  
  3195  				// Check for first line comment in line.
  3196  				// We don't worry about /* */ comments,
  3197  				// which normally won't appear in files
  3198  				// generated by cgo.
  3199  				commentStart := bytes.Index(src[start:], []byte("//"))
  3200  				commentStart += start
  3201  				// If that line comment is //go:cgo_ldflag,
  3202  				// it's a match.
  3203  				if bytes.HasPrefix(src[commentStart:], []byte(cgoLdflag)) {
  3204  					// Pull out the flag, and unquote it.
  3205  					// This is what the compiler does.
  3206  					flag := string(src[idx+len(cgoLdflag) : end])
  3207  					flag = strings.TrimSpace(flag)
  3208  					flag = strings.Trim(flag, `"`)
  3209  					flags = append(flags, flag)
  3210  				}
  3211  				src = src[end:]
  3212  				idx = bytes.Index(src, []byte(cgoLdflag))
  3213  			}
  3214  		}
  3215  
  3216  		// We expect to find the contents of cgoLDFLAGS used when running the CGO action in flags.
  3217  		if len(runCgoProvider.LDFLAGS) > 0 {
  3218  		outer:
  3219  			for i := range flags {
  3220  				for j, f := range runCgoProvider.LDFLAGS {
  3221  					if f != flags[i+j] {
  3222  						continue outer
  3223  					}
  3224  				}
  3225  				flags = append(flags[:i], flags[i+len(runCgoProvider.LDFLAGS):]...)
  3226  				break
  3227  			}
  3228  		}
  3229  
  3230  		if err := checkLinkerFlags("LDFLAGS", "go:cgo_ldflag", flags); err != nil {
  3231  			return nil, nil, err
  3232  		}
  3233  	}
  3234  
  3235  	return outGo, outObj, nil
  3236  }
  3237  
  3238  // flagsNotCompatibleWithInternalLinking scans the list of cgo
  3239  // compiler flags (C/C++/Fortran) looking for flags that might cause
  3240  // problems if the build in question uses internal linking. The
  3241  // primary culprits are use of plugins or use of LTO, but we err on
  3242  // the side of caution, supporting only those flags that are on the
  3243  // allow-list for safe flags from security perspective. Return is TRUE
  3244  // if a sensitive flag is found, FALSE otherwise.
  3245  func flagsNotCompatibleWithInternalLinking(sourceList []string, flagListList [][]string) bool {
  3246  	for i := range sourceList {
  3247  		sn := sourceList[i]
  3248  		fll := flagListList[i]
  3249  		if err := checkCompilerFlagsForInternalLink(sn, sn, fll); err != nil {
  3250  			return true
  3251  		}
  3252  	}
  3253  	return false
  3254  }
  3255  
  3256  // dynimport creates a Go source file named importGo containing
  3257  // //go:cgo_import_dynamic directives for each symbol or library
  3258  // dynamically imported by the object files outObj.
  3259  // dynOutGo, if not empty, is a new Go file to build as part of the package.
  3260  // dynOutObj, if not empty, is a new file to add to the generated archive.
  3261  func (b *Builder) dynimport(a *Action, objdir, importGo, cgoExe string, cflags, cgoLDFLAGS, outObj []string) (dynOutGo, dynOutObj string, err error) {
  3262  	p := a.Package
  3263  	sh := b.Shell(a)
  3264  
  3265  	cfile := objdir + "_cgo_main.c"
  3266  	ofile := objdir + "_cgo_main.o"
  3267  	if err := b.gcc(a, objdir, ofile, cflags, cfile); err != nil {
  3268  		return "", "", err
  3269  	}
  3270  
  3271  	// Gather .syso files from this package and all (transitive) dependencies.
  3272  	var syso []string
  3273  	seen := make(map[*Action]bool)
  3274  	var gatherSyso func(*Action)
  3275  	gatherSyso = func(a1 *Action) {
  3276  		if seen[a1] {
  3277  			return
  3278  		}
  3279  		seen[a1] = true
  3280  		if p1 := a1.Package; p1 != nil {
  3281  			syso = append(syso, mkAbsFiles(p1.Dir, p1.SysoFiles)...)
  3282  		}
  3283  		for _, a2 := range a1.Deps {
  3284  			gatherSyso(a2)
  3285  		}
  3286  	}
  3287  	gatherSyso(a)
  3288  	sort.Strings(syso)
  3289  	str.Uniq(&syso)
  3290  	linkobj := str.StringList(ofile, outObj, syso)
  3291  	dynobj := objdir + "_cgo_.o"
  3292  
  3293  	ldflags := cgoLDFLAGS
  3294  	if (cfg.Goarch == "arm" && cfg.Goos == "linux") || cfg.Goos == "android" {
  3295  		if !slices.Contains(ldflags, "-no-pie") {
  3296  			// we need to use -pie for Linux/ARM to get accurate imported sym (added in https://golang.org/cl/5989058)
  3297  			// this seems to be outdated, but we don't want to break existing builds depending on this (Issue 45940)
  3298  			ldflags = append(ldflags, "-pie")
  3299  		}
  3300  		if slices.Contains(ldflags, "-pie") && slices.Contains(ldflags, "-static") {
  3301  			// -static -pie doesn't make sense, and causes link errors.
  3302  			// Issue 26197.
  3303  			n := make([]string, 0, len(ldflags)-1)
  3304  			for _, flag := range ldflags {
  3305  				if flag != "-static" {
  3306  					n = append(n, flag)
  3307  				}
  3308  			}
  3309  			ldflags = n
  3310  		}
  3311  	}
  3312  	if err := b.gccld(a, objdir, dynobj, ldflags, linkobj); err != nil {
  3313  		// We only need this information for internal linking.
  3314  		// If this link fails, mark the object as requiring
  3315  		// external linking. This link can fail for things like
  3316  		// syso files that have unexpected dependencies.
  3317  		// cmd/link explicitly looks for the name "dynimportfail".
  3318  		// See issue #52863.
  3319  		fail := objdir + "dynimportfail"
  3320  		if err := sh.writeFile(fail, nil); err != nil {
  3321  			return "", "", err
  3322  		}
  3323  		return "", fail, nil
  3324  	}
  3325  
  3326  	// cgo -dynimport
  3327  	var cgoflags []string
  3328  	if p.Standard && p.ImportPath == "runtime/cgo" {
  3329  		cgoflags = []string{"-dynlinker"} // record path to dynamic linker
  3330  	}
  3331  	err = sh.run(base.Cwd(), p.ImportPath, b.cCompilerEnv(), cfg.BuildToolexec, cgoExe, "-dynpackage", p.Name, "-dynimport", dynobj, "-dynout", importGo, cgoflags)
  3332  	if err != nil {
  3333  		return "", "", err
  3334  	}
  3335  	return importGo, "", nil
  3336  }
  3337  
  3338  // Run SWIG on all SWIG input files.
  3339  // TODO: Don't build a shared library, once SWIG emits the necessary
  3340  // pragmas for external linking.
  3341  func (b *Builder) swig(a *Action, objdir string, pcCFLAGS []string) error {
  3342  	p := a.Package
  3343  
  3344  	if err := b.swigVersionCheck(); err != nil {
  3345  		return err
  3346  	}
  3347  
  3348  	intgosize, err := b.swigIntSize(objdir)
  3349  	if err != nil {
  3350  		return err
  3351  	}
  3352  
  3353  	for _, f := range p.SwigFiles {
  3354  		if err := b.swigOne(a, f, objdir, pcCFLAGS, false, intgosize); err != nil {
  3355  			return err
  3356  		}
  3357  	}
  3358  	for _, f := range p.SwigCXXFiles {
  3359  		if err := b.swigOne(a, f, objdir, pcCFLAGS, true, intgosize); err != nil {
  3360  			return err
  3361  		}
  3362  	}
  3363  	return nil
  3364  }
  3365  
  3366  func (b *Builder) swigOutputs(p *load.Package, objdir string) (outGo, outC, outCXX []string) {
  3367  	for _, f := range p.SwigFiles {
  3368  		goFile, cFile := swigOneOutputs(f, objdir, false)
  3369  		outGo = append(outGo, goFile)
  3370  		outC = append(outC, cFile)
  3371  	}
  3372  	for _, f := range p.SwigCXXFiles {
  3373  		goFile, cxxFile := swigOneOutputs(f, objdir, true)
  3374  		outGo = append(outGo, goFile)
  3375  		outCXX = append(outCXX, cxxFile)
  3376  	}
  3377  	return outGo, outC, outCXX
  3378  }
  3379  
  3380  // Make sure SWIG is new enough.
  3381  var (
  3382  	swigCheckOnce sync.Once
  3383  	swigCheck     error
  3384  )
  3385  
  3386  func (b *Builder) swigDoVersionCheck() error {
  3387  	sh := b.BackgroundShell()
  3388  	out, err := sh.runOut(".", nil, "swig", "-version")
  3389  	if err != nil {
  3390  		return err
  3391  	}
  3392  	re := regexp.MustCompile(`[vV]ersion +(\d+)([.]\d+)?([.]\d+)?`)
  3393  	matches := re.FindSubmatch(out)
  3394  	if matches == nil {
  3395  		// Can't find version number; hope for the best.
  3396  		return nil
  3397  	}
  3398  
  3399  	major, err := strconv.Atoi(string(matches[1]))
  3400  	if err != nil {
  3401  		// Can't find version number; hope for the best.
  3402  		return nil
  3403  	}
  3404  	const errmsg = "must have SWIG version >= 3.0.6"
  3405  	if major < 3 {
  3406  		return errors.New(errmsg)
  3407  	}
  3408  	if major > 3 {
  3409  		// 4.0 or later
  3410  		return nil
  3411  	}
  3412  
  3413  	// We have SWIG version 3.x.
  3414  	if len(matches[2]) > 0 {
  3415  		minor, err := strconv.Atoi(string(matches[2][1:]))
  3416  		if err != nil {
  3417  			return nil
  3418  		}
  3419  		if minor > 0 {
  3420  			// 3.1 or later
  3421  			return nil
  3422  		}
  3423  	}
  3424  
  3425  	// We have SWIG version 3.0.x.
  3426  	if len(matches[3]) > 0 {
  3427  		patch, err := strconv.Atoi(string(matches[3][1:]))
  3428  		if err != nil {
  3429  			return nil
  3430  		}
  3431  		if patch < 6 {
  3432  			// Before 3.0.6.
  3433  			return errors.New(errmsg)
  3434  		}
  3435  	}
  3436  
  3437  	return nil
  3438  }
  3439  
  3440  func (b *Builder) swigVersionCheck() error {
  3441  	swigCheckOnce.Do(func() {
  3442  		swigCheck = b.swigDoVersionCheck()
  3443  	})
  3444  	return swigCheck
  3445  }
  3446  
  3447  // Find the value to pass for the -intgosize option to swig.
  3448  var (
  3449  	swigIntSizeOnce  sync.Once
  3450  	swigIntSize      string
  3451  	swigIntSizeError error
  3452  )
  3453  
  3454  // This code fails to build if sizeof(int) <= 32
  3455  const swigIntSizeCode = `
  3456  package main
  3457  const i int = 1 << 32
  3458  `
  3459  
  3460  // Determine the size of int on the target system for the -intgosize option
  3461  // of swig >= 2.0.9. Run only once.
  3462  func (b *Builder) swigDoIntSize(objdir string) (intsize string, err error) {
  3463  	if cfg.BuildN {
  3464  		return "$INTBITS", nil
  3465  	}
  3466  	src := filepath.Join(b.WorkDir, "swig_intsize.go")
  3467  	if err = os.WriteFile(src, []byte(swigIntSizeCode), 0666); err != nil {
  3468  		return
  3469  	}
  3470  	srcs := []string{src}
  3471  
  3472  	p := load.GoFilesPackage(modload.NewLoader(), context.TODO(), load.PackageOpts{}, srcs)
  3473  
  3474  	if _, _, e := BuildToolchain.gc(b, &Action{Mode: "swigDoIntSize", Package: p, Objdir: objdir}, "", nil, nil, "", false, "", srcs); e != nil {
  3475  		return "32", nil
  3476  	}
  3477  	return "64", nil
  3478  }
  3479  
  3480  // Determine the size of int on the target system for the -intgosize option
  3481  // of swig >= 2.0.9.
  3482  func (b *Builder) swigIntSize(objdir string) (intsize string, err error) {
  3483  	swigIntSizeOnce.Do(func() {
  3484  		swigIntSize, swigIntSizeError = b.swigDoIntSize(objdir)
  3485  	})
  3486  	return swigIntSize, swigIntSizeError
  3487  }
  3488  
  3489  // Run SWIG on one SWIG input file.
  3490  func (b *Builder) swigOne(a *Action, file, objdir string, pcCFLAGS []string, cxx bool, intgosize string) error {
  3491  	if strings.HasPrefix(file, "cgo") {
  3492  		return errors.New("SWIG file must not use prefix 'cgo'")
  3493  	}
  3494  
  3495  	p := a.Package
  3496  	sh := b.Shell(a)
  3497  
  3498  	cgoCPPFLAGS, cgoCFLAGS, cgoCXXFLAGS, _, _, err := b.CFlags(p)
  3499  	if err != nil {
  3500  		return err
  3501  	}
  3502  
  3503  	var cflags []string
  3504  	if cxx {
  3505  		cflags = str.StringList(cgoCPPFLAGS, pcCFLAGS, cgoCXXFLAGS)
  3506  	} else {
  3507  		cflags = str.StringList(cgoCPPFLAGS, pcCFLAGS, cgoCFLAGS)
  3508  	}
  3509  
  3510  	base := swigBase(file, cxx)
  3511  	newGoFile, outC := swigOneOutputs(file, objdir, cxx)
  3512  
  3513  	gccgo := cfg.BuildToolchainName == "gccgo"
  3514  
  3515  	// swig
  3516  	args := []string{
  3517  		"-go",
  3518  		"-cgo",
  3519  		"-intgosize", intgosize,
  3520  		"-module", base,
  3521  		"-o", outC,
  3522  		"-outdir", objdir,
  3523  	}
  3524  
  3525  	for _, f := range cflags {
  3526  		if len(f) > 3 && f[:2] == "-I" {
  3527  			args = append(args, f)
  3528  		}
  3529  	}
  3530  
  3531  	if gccgo {
  3532  		args = append(args, "-gccgo")
  3533  		if pkgpath := gccgoPkgpath(p); pkgpath != "" {
  3534  			args = append(args, "-go-pkgpath", pkgpath)
  3535  		}
  3536  	}
  3537  	if cxx {
  3538  		args = append(args, "-c++")
  3539  	}
  3540  
  3541  	out, err := sh.runOut(p.Dir, nil, "swig", args, file)
  3542  	if err != nil && (bytes.Contains(out, []byte("-intgosize")) || bytes.Contains(out, []byte("-cgo"))) {
  3543  		return errors.New("must have SWIG version >= 3.0.6")
  3544  	}
  3545  	if err := sh.reportCmd("", "", out, err); err != nil {
  3546  		return err
  3547  	}
  3548  
  3549  	// If the input was x.swig, the output is x.go in the objdir.
  3550  	// But there might be an x.go in the original dir too, and if it
  3551  	// uses cgo as well, cgo will be processing both and will
  3552  	// translate both into x.cgo1.go in the objdir, overwriting one.
  3553  	// Rename x.go to _x_swig.go (newGoFile) to avoid this problem.
  3554  	// We ignore files in the original dir that begin with underscore
  3555  	// so _x_swig.go cannot conflict with an original file we were
  3556  	// going to compile.
  3557  	goFile := objdir + base + ".go"
  3558  	if cfg.BuildX || cfg.BuildN {
  3559  		sh.ShowCmd("", "mv %s %s", goFile, newGoFile)
  3560  	}
  3561  	if !cfg.BuildN {
  3562  		if err := os.Rename(goFile, newGoFile); err != nil {
  3563  			return err
  3564  		}
  3565  	}
  3566  
  3567  	return nil
  3568  }
  3569  
  3570  func swigBase(file string, cxx bool) string {
  3571  	n := 5 // length of ".swig"
  3572  	if cxx {
  3573  		n = 8 // length of ".swigcxx"
  3574  	}
  3575  	return file[:len(file)-n]
  3576  }
  3577  
  3578  func swigOneOutputs(file, objdir string, cxx bool) (outGo, outC string) {
  3579  	base := swigBase(file, cxx)
  3580  	gccBase := base + "_wrap."
  3581  	gccExt := "c"
  3582  	if cxx {
  3583  		gccExt = "cxx"
  3584  	}
  3585  
  3586  	newGoFile := objdir + "_" + base + "_swig.go"
  3587  	cFile := objdir + gccBase + gccExt
  3588  	return newGoFile, cFile
  3589  }
  3590  
  3591  // disableBuildID adjusts a linker command line to avoid creating a
  3592  // build ID when creating an object file rather than an executable or
  3593  // shared library. Some systems, such as Ubuntu, always add
  3594  // --build-id to every link, but we don't want a build ID when we are
  3595  // producing an object file. On some of those system a plain -r (not
  3596  // -Wl,-r) will turn off --build-id, but clang 3.0 doesn't support a
  3597  // plain -r. I don't know how to turn off --build-id when using clang
  3598  // other than passing a trailing --build-id=none. So that is what we
  3599  // do, but only on systems likely to support it, which is to say,
  3600  // systems that normally use gold or the GNU linker.
  3601  func (b *Builder) disableBuildID(ldflags []string) []string {
  3602  	switch cfg.Goos {
  3603  	case "android", "dragonfly", "linux", "netbsd":
  3604  		ldflags = append(ldflags, "-Wl,--build-id=none")
  3605  	}
  3606  	return ldflags
  3607  }
  3608  
  3609  // mkAbsFiles converts files into a list of absolute files,
  3610  // assuming they were originally relative to dir,
  3611  // and returns that new list.
  3612  func mkAbsFiles(dir string, files []string) []string {
  3613  	abs := make([]string, len(files))
  3614  	for i, f := range files {
  3615  		if !filepath.IsAbs(f) {
  3616  			f = filepath.Join(dir, f)
  3617  		}
  3618  		abs[i] = f
  3619  	}
  3620  	return abs
  3621  }
  3622  
  3623  // actualFiles applies fsys.Actual to the list of files.
  3624  func actualFiles(files []string) []string {
  3625  	a := make([]string, len(files))
  3626  	for i, f := range files {
  3627  		a[i] = fsys.Actual(f)
  3628  	}
  3629  	return a
  3630  }
  3631  
  3632  // passLongArgsInResponseFiles modifies cmd such that, for
  3633  // certain programs, long arguments are passed in "response files", a
  3634  // file on disk with the arguments, with one arg per line. An actual
  3635  // argument starting with '@' means that the rest of the argument is
  3636  // a filename of arguments to expand.
  3637  //
  3638  // See issues 18468 (Windows) and 37768 (Darwin).
  3639  func passLongArgsInResponseFiles(cmd *exec.Cmd) (cleanup func()) {
  3640  	cleanup = func() {} // no cleanup by default
  3641  
  3642  	var argLen int
  3643  	for _, arg := range cmd.Args {
  3644  		argLen += len(arg)
  3645  	}
  3646  
  3647  	// If we're not approaching 32KB of args, just pass args normally.
  3648  	// (use 30KB instead to be conservative; not sure how accounting is done)
  3649  	if !useResponseFile(cmd.Path, argLen) {
  3650  		return
  3651  	}
  3652  
  3653  	tf, err := os.CreateTemp("", "args")
  3654  	if err != nil {
  3655  		log.Fatalf("error writing long arguments to response file: %v", err)
  3656  	}
  3657  	cleanup = func() { os.Remove(tf.Name()) }
  3658  	var buf bytes.Buffer
  3659  	for _, arg := range cmd.Args[1:] {
  3660  		fmt.Fprintf(&buf, "%s\n", encodeArg(arg))
  3661  	}
  3662  	if _, err := tf.Write(buf.Bytes()); err != nil {
  3663  		tf.Close()
  3664  		cleanup()
  3665  		log.Fatalf("error writing long arguments to response file: %v", err)
  3666  	}
  3667  	if err := tf.Close(); err != nil {
  3668  		cleanup()
  3669  		log.Fatalf("error writing long arguments to response file: %v", err)
  3670  	}
  3671  	cmd.Args = []string{cmd.Args[0], "@" + tf.Name()}
  3672  	return cleanup
  3673  }
  3674  
  3675  func useResponseFile(path string, argLen int) bool {
  3676  	// Unless the program uses objabi.Flagparse, which understands
  3677  	// response files, don't use response files.
  3678  	// TODO: Note that other toolchains like CC are missing here for now.
  3679  	prog := strings.TrimSuffix(filepath.Base(path), ".exe")
  3680  	switch prog {
  3681  	case "compile", "link", "cgo", "asm", "cover", "pack":
  3682  	default:
  3683  		return false
  3684  	}
  3685  
  3686  	if argLen > sys.ExecArgLengthLimit {
  3687  		return true
  3688  	}
  3689  
  3690  	// On the Go build system, use response files about 10% of the
  3691  	// time, just to exercise this codepath.
  3692  	isBuilder := os.Getenv("GO_BUILDER_NAME") != ""
  3693  	if isBuilder && rand.Intn(10) == 0 {
  3694  		return true
  3695  	}
  3696  
  3697  	return false
  3698  }
  3699  
  3700  // encodeArg encodes an argument for response file writing using GCC-compatible format.
  3701  // Arguments containing special characters are wrapped in double quotes with escapes.
  3702  func encodeArg(arg string) string {
  3703  	// Empty string must be quoted to preserve it.
  3704  	if arg == "" {
  3705  		return `""`
  3706  	}
  3707  	// If no special characters, return as-is.
  3708  	if !strings.ContainsAny(arg, " \t\n\r'\"\\$`") {
  3709  		return arg
  3710  	}
  3711  
  3712  	// Use double quotes and escape special chars.
  3713  	var b strings.Builder
  3714  	b.WriteByte('"')
  3715  	for _, r := range arg {
  3716  		switch r {
  3717  		case '\\':
  3718  			b.WriteString(`\\`)
  3719  		case '"':
  3720  			b.WriteString(`\"`)
  3721  		case '$':
  3722  			b.WriteString(`\$`)
  3723  		case '`':
  3724  			b.WriteString("\\`")
  3725  		default:
  3726  			b.WriteRune(r)
  3727  		}
  3728  	}
  3729  	b.WriteByte('"')
  3730  	return b.String()
  3731  }
  3732  

View as plain text