Source file src/cmd/dist/test.go

     1  // Copyright 2015 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  package main
     6  
     7  import (
     8  	"bytes"
     9  	"encoding/json"
    10  	"flag"
    11  	"fmt"
    12  	"io"
    13  	"io/fs"
    14  	"log"
    15  	"os"
    16  	"os/exec"
    17  	"path/filepath"
    18  	"reflect"
    19  	"regexp"
    20  	"runtime"
    21  	"slices"
    22  	"strconv"
    23  	"strings"
    24  	"time"
    25  )
    26  
    27  func cmdtest() {
    28  	gogcflags = os.Getenv("GO_GCFLAGS")
    29  	setNoOpt()
    30  
    31  	var t tester
    32  
    33  	t.asmflags = os.Getenv("GO_TEST_ASMFLAGS")
    34  
    35  	var noRebuild bool
    36  	flag.BoolVar(&t.listMode, "list", false, "list available tests")
    37  	flag.BoolVar(&t.rebuild, "rebuild", false, "rebuild everything first")
    38  	flag.BoolVar(&noRebuild, "no-rebuild", false, "overrides -rebuild (historical dreg)")
    39  	flag.BoolVar(&t.keepGoing, "k", false, "keep going even when error occurred")
    40  	flag.BoolVar(&t.race, "race", false, "run in race builder mode (different set of tests)")
    41  	flag.BoolVar(&t.compileOnly, "compile-only", false, "compile tests, but don't run them")
    42  	flag.StringVar(&t.banner, "banner", "##### ", "banner prefix; blank means no section banners")
    43  	flag.StringVar(&t.runRxStr, "run", "",
    44  		"run only those tests matching the regular expression; empty means to run all. "+
    45  			"Special exception: if the string begins with '!', the match is inverted.")
    46  	flag.BoolVar(&t.msan, "msan", false, "run in memory sanitizer builder mode")
    47  	flag.BoolVar(&t.asan, "asan", false, "run in address sanitizer builder mode")
    48  	flag.BoolVar(&t.json, "json", false, "report test results in JSON")
    49  
    50  	xflagparse(-1) // any number of args
    51  	if noRebuild {
    52  		t.rebuild = false
    53  	}
    54  
    55  	t.run()
    56  }
    57  
    58  // tester executes cmdtest.
    59  type tester struct {
    60  	race        bool
    61  	msan        bool
    62  	asan        bool
    63  	listMode    bool
    64  	rebuild     bool
    65  	failed      bool
    66  	keepGoing   bool
    67  	compileOnly bool // just try to compile all tests, but no need to run
    68  	short       bool
    69  	cgoEnabled  bool
    70  	asmflags    string
    71  	json        bool
    72  	runRxStr    string
    73  	runRx       *regexp.Regexp
    74  	runRxWant   bool     // want runRx to match (true) or not match (false)
    75  	runNames    []string // tests to run, exclusive with runRx; empty means all
    76  	banner      string   // prefix, or "" for none
    77  	lastHeading string   // last dir heading printed
    78  
    79  	tests        []distTest // use addTest to extend
    80  	testNames    map[string]bool
    81  	timeoutScale int
    82  
    83  	worklist []*work
    84  }
    85  
    86  // work tracks command execution for a test.
    87  type work struct {
    88  	dt    *distTest     // unique test name, etc.
    89  	cmd   *exec.Cmd     // must write stdout/stderr to out
    90  	flush func()        // if non-nil, called after cmd.Run
    91  	start chan bool     // a true means to start, a false means to skip
    92  	out   bytes.Buffer  // combined stdout/stderr from cmd
    93  	err   error         // work result
    94  	end   chan struct{} // a value means cmd ended (or was skipped)
    95  }
    96  
    97  // printSkip prints a skip message for all of work.
    98  func (w *work) printSkip(t *tester, msg string) {
    99  	if t.json {
   100  		synthesizeSkipEvent(json.NewEncoder(&w.out), w.dt.name, msg)
   101  		return
   102  	}
   103  	fmt.Fprintln(&w.out, msg)
   104  }
   105  
   106  // A distTest is a test run by dist test.
   107  // Each test has a unique name and belongs to a group (heading)
   108  type distTest struct {
   109  	name    string // unique test name; may be filtered with -run flag
   110  	heading string // group section; this header is printed before the test is run.
   111  	fn      func(*distTest) error
   112  }
   113  
   114  func (t *tester) run() {
   115  	timelog("start", "dist test")
   116  
   117  	os.Setenv("PATH", fmt.Sprintf("%s%c%s", gorootBin, os.PathListSeparator, os.Getenv("PATH")))
   118  
   119  	t.short = true
   120  	if v := os.Getenv("GO_TEST_SHORT"); v != "" {
   121  		short, err := strconv.ParseBool(v)
   122  		if err != nil {
   123  			fatalf("invalid GO_TEST_SHORT %q: %v", v, err)
   124  		}
   125  		t.short = short
   126  	}
   127  
   128  	cmd := exec.Command(gorootBinGo, "env", "CGO_ENABLED")
   129  	cmd.Stderr = new(bytes.Buffer)
   130  	slurp, err := cmd.Output()
   131  	if err != nil {
   132  		fatalf("Error running %s: %v\n%s", cmd, err, cmd.Stderr)
   133  	}
   134  	parts := strings.Split(string(slurp), "\n")
   135  	if nlines := len(parts) - 1; nlines < 1 {
   136  		fatalf("Error running %s: output contains <1 lines\n%s", cmd, cmd.Stderr)
   137  	}
   138  	t.cgoEnabled, _ = strconv.ParseBool(parts[0])
   139  
   140  	if flag.NArg() > 0 && t.runRxStr != "" {
   141  		fatalf("the -run regular expression flag is mutually exclusive with test name arguments")
   142  	}
   143  
   144  	t.runNames = flag.Args()
   145  
   146  	// Set GOTRACEBACK to system if the user didn't set a level explicitly.
   147  	// Since we're running tests for Go, we want as much detail as possible
   148  	// if something goes wrong.
   149  	//
   150  	// Set it before running any commands just in case something goes wrong.
   151  	if ok := isEnvSet("GOTRACEBACK"); !ok {
   152  		if err := os.Setenv("GOTRACEBACK", "system"); err != nil {
   153  			if t.keepGoing {
   154  				log.Printf("Failed to set GOTRACEBACK: %v", err)
   155  			} else {
   156  				fatalf("Failed to set GOTRACEBACK: %v", err)
   157  			}
   158  		}
   159  	}
   160  
   161  	if t.rebuild {
   162  		t.out("Building packages and commands.")
   163  		// Force rebuild the whole toolchain.
   164  		goInstall(toolenv(), gorootBinGo, append([]string{"-a"}, toolchain...)...)
   165  	}
   166  
   167  	if !t.listMode {
   168  		if builder := os.Getenv("GO_BUILDER_NAME"); builder == "" {
   169  			// Ensure that installed commands are up to date, even with -no-rebuild,
   170  			// so that tests that run commands end up testing what's actually on disk.
   171  			// If everything is up-to-date, this is a no-op.
   172  			// We first build the toolchain twice to allow it to converge,
   173  			// as when we first bootstrap.
   174  			// See cmdbootstrap for a description of the overall process.
   175  			//
   176  			// On the builders, we skip this step: we assume that 'dist test' is
   177  			// already using the result of a clean build, and because of test sharding
   178  			// and virtualization we usually start with a clean GOCACHE, so we would
   179  			// end up rebuilding large parts of the standard library that aren't
   180  			// otherwise relevant to the actual set of packages under test.
   181  			goInstall(toolenv(), gorootBinGo, toolchain...)
   182  			goInstall(toolenv(), gorootBinGo, toolchain...)
   183  			goInstall(toolenv(), gorootBinGo, toolsToInstall...)
   184  		}
   185  	}
   186  
   187  	t.timeoutScale = 1
   188  	if s := os.Getenv("GO_TEST_TIMEOUT_SCALE"); s != "" {
   189  		t.timeoutScale, err = strconv.Atoi(s)
   190  		if err != nil {
   191  			fatalf("failed to parse $GO_TEST_TIMEOUT_SCALE = %q as integer: %v", s, err)
   192  		}
   193  	}
   194  
   195  	if t.runRxStr != "" {
   196  		if t.runRxStr[0] == '!' {
   197  			t.runRxWant = false
   198  			t.runRxStr = t.runRxStr[1:]
   199  		} else {
   200  			t.runRxWant = true
   201  		}
   202  		t.runRx = regexp.MustCompile(t.runRxStr)
   203  	}
   204  
   205  	t.registerTests()
   206  	if t.listMode {
   207  		for _, tt := range t.tests {
   208  			fmt.Println(tt.name)
   209  		}
   210  		return
   211  	}
   212  
   213  	for _, name := range t.runNames {
   214  		if !t.testNames[name] {
   215  			fatalf("unknown test %q", name)
   216  		}
   217  	}
   218  
   219  	// On a few builders, make GOROOT unwritable to catch tests writing to it.
   220  	if strings.HasPrefix(os.Getenv("GO_BUILDER_NAME"), "linux-") {
   221  		if os.Getuid() == 0 {
   222  			// Don't bother making GOROOT unwritable:
   223  			// we're running as root, so permissions would have no effect.
   224  		} else {
   225  			xatexit(t.makeGOROOTUnwritable())
   226  		}
   227  	}
   228  
   229  	if !t.json {
   230  		if err := t.maybeLogMetadata(); err != nil {
   231  			t.failed = true
   232  			if t.keepGoing {
   233  				log.Printf("Failed logging metadata: %v", err)
   234  			} else {
   235  				fatalf("Failed logging metadata: %v", err)
   236  			}
   237  		}
   238  	}
   239  
   240  	var anyIncluded, someExcluded bool
   241  	for _, dt := range t.tests {
   242  		if !t.shouldRunTest(dt.name) {
   243  			someExcluded = true
   244  			continue
   245  		}
   246  		anyIncluded = true
   247  		dt := dt // dt used in background after this iteration
   248  		if err := dt.fn(&dt); err != nil {
   249  			t.runPending(&dt) // in case that hasn't been done yet
   250  			t.failed = true
   251  			if t.keepGoing {
   252  				log.Printf("Failed: %v", err)
   253  			} else {
   254  				fatalf("Failed: %v", err)
   255  			}
   256  		}
   257  	}
   258  	t.runPending(nil)
   259  	timelog("end", "dist test")
   260  
   261  	if !t.json {
   262  		if t.failed {
   263  			fmt.Println("\nFAILED")
   264  		} else if !anyIncluded {
   265  			fmt.Println()
   266  			errprintf("go tool dist: warning: %q matched no tests; use the -list flag to list available tests\n", t.runRxStr)
   267  			fmt.Println("NO TESTS TO RUN")
   268  		} else if someExcluded {
   269  			fmt.Println("\nALL TESTS PASSED (some were excluded)")
   270  		} else {
   271  			fmt.Println("\nALL TESTS PASSED")
   272  		}
   273  	}
   274  	if t.failed {
   275  		xexit(1)
   276  	}
   277  }
   278  
   279  func (t *tester) shouldRunTest(name string) bool {
   280  	if t.runRx != nil {
   281  		return t.runRx.MatchString(name) == t.runRxWant
   282  	}
   283  	if len(t.runNames) == 0 {
   284  		return true
   285  	}
   286  	return slices.Contains(t.runNames, name)
   287  }
   288  
   289  func (t *tester) maybeLogMetadata() error {
   290  	if t.compileOnly {
   291  		// We need to run a subprocess to log metadata. Don't do that
   292  		// on compile-only runs.
   293  		return nil
   294  	}
   295  	t.out("Test execution environment.")
   296  	// Helper binary to print system metadata (CPU model, etc). This is a
   297  	// separate binary from dist so it need not build with the bootstrap
   298  	// toolchain.
   299  	//
   300  	// TODO(prattmic): If we split dist bootstrap and dist test then this
   301  	// could be simplified to directly use internal/sysinfo here.
   302  	return t.dirCmd(filepath.Join(goroot, "src/cmd/internal/metadata"), gorootBinGo, []string{"run", "main.go"}).Run()
   303  }
   304  
   305  // testName returns the dist test name for a given package and variant.
   306  func testName(pkg, variant string) string {
   307  	name := pkg
   308  	if variant != "" {
   309  		name += ":" + variant
   310  	}
   311  	return name
   312  }
   313  
   314  // goTest represents all options to a "go test" command. The final command will
   315  // combine configuration from goTest and tester flags.
   316  type goTest struct {
   317  	timeout  time.Duration // If non-zero, override timeout
   318  	short    bool          // If true, force -short
   319  	tags     []string      // Build tags
   320  	race     bool          // Force -race
   321  	bench    bool          // Run benchmarks (briefly), not tests.
   322  	runTests string        // Regexp of tests to run
   323  	cpu      string        // If non-empty, -cpu flag
   324  	skip     string        // If non-empty, -skip flag
   325  
   326  	gcflags   string // If non-empty, build with -gcflags=all=X
   327  	ldflags   string // If non-empty, build with -ldflags=X
   328  	buildmode string // If non-empty, -buildmode flag
   329  
   330  	env []string // Environment variables to add, as KEY=VAL. KEY= unsets a variable
   331  
   332  	runOnHost bool // When cross-compiling, run this test on the host instead of guest
   333  
   334  	// variant, if non-empty, is a name used to distinguish different
   335  	// configurations of the same test package(s). If set and omitVariant is false,
   336  	// the Package field in test2json output is rewritten to pkg:variant.
   337  	variant string
   338  	// omitVariant indicates that variant is used solely for the dist test name and
   339  	// that the set of test names run by each variant (including empty) of a package
   340  	// is non-overlapping.
   341  	//
   342  	// TODO(mknyszek): Consider removing omitVariant as it is no longer set to true
   343  	// by any test. It's too valuable to have timing information in ResultDB that
   344  	// corresponds directly with dist names for tests.
   345  	omitVariant bool
   346  
   347  	// We have both pkg and pkgs as a convenience. Both may be set, in which
   348  	// case they will be combined. At least one must be set.
   349  	pkgs []string // Multiple packages to test
   350  	pkg  string   // A single package to test
   351  
   352  	testFlags []string // Additional flags accepted by this test
   353  }
   354  
   355  // compileOnly reports whether this test is only for compiling,
   356  // indicated by runTests being set to '^$' and bench being false.
   357  func (opts *goTest) compileOnly() bool {
   358  	return opts.runTests == "^$" && !opts.bench
   359  }
   360  
   361  // bgCommand returns a go test Cmd and a post-Run flush function. The result
   362  // will write its output to stdout and stderr. If stdout==stderr, bgCommand
   363  // ensures Writes are serialized. The caller should call flush() after Cmd exits.
   364  func (opts *goTest) bgCommand(t *tester, stdout, stderr io.Writer) (cmd *exec.Cmd, flush func()) {
   365  	build, run, pkgs, testFlags, setupCmd := opts.buildArgs(t)
   366  
   367  	// Combine the flags.
   368  	args := append([]string{"test"}, build...)
   369  	if t.compileOnly || opts.compileOnly() {
   370  		args = append(args, "-c", "-o", os.DevNull)
   371  	} else {
   372  		args = append(args, run...)
   373  	}
   374  	args = append(args, pkgs...)
   375  	if !t.compileOnly && !opts.compileOnly() {
   376  		args = append(args, testFlags...)
   377  	}
   378  
   379  	cmd = exec.Command(gorootBinGo, args...)
   380  	setupCmd(cmd)
   381  	if t.json && opts.variant != "" && !opts.omitVariant {
   382  		// Rewrite Package in the JSON output to be pkg:variant. When omitVariant
   383  		// is true, pkg.TestName is already unambiguous, so we don't need to
   384  		// rewrite the Package field.
   385  		//
   386  		// We only want to process JSON on the child's stdout. Ideally if
   387  		// stdout==stderr, we would also use the same testJSONFilter for
   388  		// cmd.Stdout and cmd.Stderr in order to keep the underlying
   389  		// interleaving of writes, but then it would see even partial writes
   390  		// interleaved, which would corrupt the JSON. So, we only process
   391  		// cmd.Stdout. This has another consequence though: if stdout==stderr,
   392  		// we have to serialize Writes in case the Writer is not concurrent
   393  		// safe. If we were just passing stdout/stderr through to exec, it would
   394  		// do this for us, but since we're wrapping stdout, we have to do it
   395  		// ourselves.
   396  		if stdout == stderr {
   397  			stdout = &lockedWriter{w: stdout}
   398  			stderr = stdout
   399  		}
   400  		f := &testJSONFilter{w: stdout, variant: opts.variant}
   401  		cmd.Stdout = f
   402  		flush = f.Flush
   403  	} else {
   404  		cmd.Stdout = stdout
   405  		flush = func() {}
   406  	}
   407  	cmd.Stderr = stderr
   408  
   409  	return cmd, flush
   410  }
   411  
   412  // run runs a go test and returns an error if it does not succeed.
   413  func (opts *goTest) run(t *tester) error {
   414  	cmd, flush := opts.bgCommand(t, os.Stdout, os.Stderr)
   415  	err := cmd.Run()
   416  	flush()
   417  	return err
   418  }
   419  
   420  // buildArgs is in internal helper for goTest that constructs the elements of
   421  // the "go test" command line. build is the flags for building the test. run is
   422  // the flags for running the test. pkgs is the list of packages to build and
   423  // run. testFlags is the list of flags to pass to the test package.
   424  //
   425  // The caller must call setupCmd on the resulting exec.Cmd to set its directory
   426  // and environment.
   427  func (opts *goTest) buildArgs(t *tester) (build, run, pkgs, testFlags []string, setupCmd func(*exec.Cmd)) {
   428  	run = append(run, "-count=1") // Disallow caching
   429  	if opts.timeout != 0 {
   430  		d := opts.timeout * time.Duration(t.timeoutScale)
   431  		run = append(run, "-timeout="+d.String())
   432  	} else if t.timeoutScale != 1 {
   433  		const goTestDefaultTimeout = 10 * time.Minute // Default value of go test -timeout flag.
   434  		run = append(run, "-timeout="+(goTestDefaultTimeout*time.Duration(t.timeoutScale)).String())
   435  	}
   436  	if opts.short || t.short {
   437  		run = append(run, "-short")
   438  	}
   439  	var tags []string
   440  	if noOpt {
   441  		tags = append(tags, "noopt")
   442  	}
   443  	tags = append(tags, opts.tags...)
   444  	if len(tags) > 0 {
   445  		build = append(build, "-tags="+strings.Join(tags, ","))
   446  	}
   447  	if t.race || opts.race {
   448  		build = append(build, "-race")
   449  	}
   450  	if t.msan {
   451  		build = append(build, "-msan")
   452  	}
   453  	if t.asan {
   454  		build = append(build, "-asan")
   455  	}
   456  	if opts.bench {
   457  		// Run no tests.
   458  		run = append(run, "-run=^$")
   459  		// Run benchmarks briefly as a smoke test.
   460  		run = append(run, "-bench=.*", "-benchtime=.1s")
   461  	} else if opts.runTests != "" {
   462  		run = append(run, "-run="+opts.runTests)
   463  	}
   464  	if opts.cpu != "" {
   465  		run = append(run, "-cpu="+opts.cpu)
   466  	}
   467  	if opts.skip != "" {
   468  		run = append(run, "-skip="+opts.skip)
   469  	}
   470  	if t.json {
   471  		run = append(run, "-json")
   472  	}
   473  
   474  	if opts.gcflags != "" {
   475  		build = append(build, "-gcflags=all="+opts.gcflags)
   476  	}
   477  	if opts.ldflags != "" {
   478  		build = append(build, "-ldflags="+opts.ldflags)
   479  	}
   480  	if t.asmflags != "" {
   481  		build = append(build, "-asmflags="+t.asmflags)
   482  	}
   483  	if opts.buildmode != "" {
   484  		build = append(build, "-buildmode="+opts.buildmode)
   485  	}
   486  
   487  	pkgs = opts.packages()
   488  
   489  	runOnHost := opts.runOnHost && (goarch != gohostarch || goos != gohostos)
   490  	needTestFlags := len(opts.testFlags) > 0 || runOnHost
   491  	if needTestFlags {
   492  		testFlags = append([]string{"-args"}, opts.testFlags...)
   493  	}
   494  	if runOnHost {
   495  		// -target is a special flag understood by tests that can run on the host
   496  		testFlags = append(testFlags, "-target="+goos+"/"+goarch)
   497  	}
   498  
   499  	setupCmd = func(cmd *exec.Cmd) {
   500  		setDir(cmd, filepath.Join(goroot, "src"))
   501  		if len(opts.env) != 0 {
   502  			for _, kv := range opts.env {
   503  				if i := strings.Index(kv, "="); i < 0 {
   504  					unsetEnv(cmd, kv[:len(kv)-1])
   505  				} else {
   506  					setEnv(cmd, kv[:i], kv[i+1:])
   507  				}
   508  			}
   509  		}
   510  		if runOnHost {
   511  			setEnv(cmd, "GOARCH", gohostarch)
   512  			setEnv(cmd, "GOOS", gohostos)
   513  		}
   514  	}
   515  
   516  	return
   517  }
   518  
   519  // packages returns the full list of packages to be run by this goTest. This
   520  // will always include at least one package.
   521  func (opts *goTest) packages() []string {
   522  	pkgs := opts.pkgs
   523  	if opts.pkg != "" {
   524  		pkgs = append(pkgs[:len(pkgs):len(pkgs)], opts.pkg)
   525  	}
   526  	if len(pkgs) == 0 {
   527  		panic("no packages")
   528  	}
   529  	return pkgs
   530  }
   531  
   532  // printSkip prints a skip message for all of goTest.
   533  func (opts *goTest) printSkip(t *tester, msg string) {
   534  	if t.json {
   535  		enc := json.NewEncoder(os.Stdout)
   536  		for _, pkg := range opts.packages() {
   537  			synthesizeSkipEvent(enc, pkg, msg)
   538  		}
   539  		return
   540  	}
   541  	fmt.Println(msg)
   542  }
   543  
   544  // ranGoTest and stdMatches are state closed over by the stdlib
   545  // testing func in registerStdTest below. The tests are run
   546  // sequentially, so there's no need for locks.
   547  //
   548  // ranGoBench and benchMatches are the same, but are only used
   549  // in -race mode.
   550  var (
   551  	ranGoTest  bool
   552  	stdMatches []string
   553  
   554  	ranGoBench   bool
   555  	benchMatches []string
   556  )
   557  
   558  func (t *tester) registerStdTest(pkg string) {
   559  	const stdTestHeading = "Testing packages." // known to addTest for a safety check
   560  	gcflags := gogcflags
   561  	name := testName(pkg, "")
   562  	if t.runRx == nil || t.runRx.MatchString(name) == t.runRxWant {
   563  		stdMatches = append(stdMatches, pkg)
   564  	}
   565  	t.addTest(name, stdTestHeading, func(dt *distTest) error {
   566  		if ranGoTest {
   567  			return nil
   568  		}
   569  		t.runPending(dt)
   570  		timelog("start", dt.name)
   571  		defer timelog("end", dt.name)
   572  		ranGoTest = true
   573  
   574  		timeoutSec := 180 * time.Second
   575  		for _, pkg := range stdMatches {
   576  			if pkg == "cmd/go" {
   577  				timeoutSec *= 3
   578  				break
   579  			}
   580  		}
   581  		return (&goTest{
   582  			timeout: timeoutSec,
   583  			gcflags: gcflags,
   584  			pkgs:    stdMatches,
   585  		}).run(t)
   586  	})
   587  }
   588  
   589  func (t *tester) registerRaceBenchTest(pkg string) {
   590  	const raceBenchHeading = "Running benchmarks briefly." // known to addTest for a safety check
   591  	name := testName(pkg, "racebench")
   592  	if t.runRx == nil || t.runRx.MatchString(name) == t.runRxWant {
   593  		benchMatches = append(benchMatches, pkg)
   594  	}
   595  	t.addTest(name, raceBenchHeading, func(dt *distTest) error {
   596  		if ranGoBench {
   597  			return nil
   598  		}
   599  		t.runPending(dt)
   600  		timelog("start", dt.name)
   601  		defer timelog("end", dt.name)
   602  		ranGoBench = true
   603  		return (&goTest{
   604  			variant: "racebench",
   605  			// Include the variant even though there's no overlap in test names.
   606  			// This makes the test targets distinct, allowing our build system to record
   607  			// elapsed time for each one, which is useful for load-balancing test shards.
   608  			omitVariant: false,
   609  			timeout:     1200 * time.Second, // longer timeout for race with benchmarks
   610  			race:        true,
   611  			bench:       true,
   612  			cpu:         "4",
   613  			pkgs:        benchMatches,
   614  		}).run(t)
   615  	})
   616  }
   617  
   618  func (t *tester) registerTests() {
   619  	// registerStdTestSpecially tracks import paths in the standard library
   620  	// whose test registration happens in a special way.
   621  	//
   622  	// These tests *must* be able to run normally as part of "go test std cmd",
   623  	// even if they are also registered separately by dist, because users often
   624  	// run go test directly. Use skips or build tags in preference to expanding
   625  	// this list.
   626  	registerStdTestSpecially := map[string]bool{
   627  		// testdir can run normally as part of "go test std cmd", but because
   628  		// it's a very large test, we register is specially as several shards to
   629  		// enable better load balancing on sharded builders. Ideally the build
   630  		// system would know how to shard any large test package.
   631  		"cmd/internal/testdir": true,
   632  	}
   633  
   634  	// Fast path to avoid the ~1 second of `go list std cmd` when
   635  	// the caller lists specific tests to run. (as the continuous
   636  	// build coordinator does).
   637  	if len(t.runNames) > 0 {
   638  		for _, name := range t.runNames {
   639  			if !strings.Contains(name, ":") {
   640  				t.registerStdTest(name)
   641  			} else if strings.HasSuffix(name, ":racebench") {
   642  				t.registerRaceBenchTest(strings.TrimSuffix(name, ":racebench"))
   643  			}
   644  		}
   645  	} else {
   646  		// Use 'go list std cmd' to get a list of all Go packages
   647  		// that running 'go test std cmd' could find problems in.
   648  		// (In race test mode, also set -tags=race.)
   649  		// This includes vendored packages and other
   650  		// packages without tests so that 'dist test' finds if any of
   651  		// them don't build, have a problem reported by high-confidence
   652  		// vet checks that come with 'go test', and anything else it
   653  		// may check in the future. See go.dev/issue/60463.
   654  		// Most packages have tests, so there is not much saved
   655  		// by skipping non-test packages.
   656  		// For the packages without any test files,
   657  		// 'go test' knows not to actually build a test binary,
   658  		// so the only cost is the vet, and we still want to run vet.
   659  		cmd := exec.Command(gorootBinGo, "list")
   660  		if t.race {
   661  			cmd.Args = append(cmd.Args, "-tags=race")
   662  		}
   663  		cmd.Args = append(cmd.Args, "std", "cmd")
   664  		cmd.Stderr = new(bytes.Buffer)
   665  		all, err := cmd.Output()
   666  		if err != nil {
   667  			fatalf("Error running go list std cmd: %v:\n%s", err, cmd.Stderr)
   668  		}
   669  		pkgs := strings.Fields(string(all))
   670  		for _, pkg := range pkgs {
   671  			if registerStdTestSpecially[pkg] {
   672  				continue
   673  			}
   674  			if t.short && (strings.HasPrefix(pkg, "vendor/") || strings.HasPrefix(pkg, "cmd/vendor/")) {
   675  				// Vendored code has no tests, and we don't care too much about vet errors
   676  				// since we can't modify the code, so skip the tests in short mode.
   677  				// We still let the longtest builders vet them.
   678  				continue
   679  			}
   680  			t.registerStdTest(pkg)
   681  		}
   682  		if t.race && !t.short {
   683  			for _, pkg := range pkgs {
   684  				if t.packageHasBenchmarks(pkg) {
   685  					t.registerRaceBenchTest(pkg)
   686  				}
   687  			}
   688  		}
   689  	}
   690  
   691  	if t.race {
   692  		return
   693  	}
   694  
   695  	// Test the os/user package in the pure-Go mode too.
   696  	if !t.compileOnly {
   697  		t.registerTest("os/user with tag osusergo",
   698  			&goTest{
   699  				variant: "osusergo",
   700  				timeout: 300 * time.Second,
   701  				tags:    []string{"osusergo"},
   702  				pkg:     "os/user",
   703  			})
   704  	}
   705  
   706  	// Tests that the nethttpomithttp2 build tag doesn't rot too much,
   707  	// even if there's not a regular builder on it.
   708  	t.registerTest("net/http with tag nethttpomithttp2", &goTest{
   709  		variant: "nethttpomithttp2",
   710  		tags:    []string{"nethttpomithttp2"},
   711  		pkg:     "net/http",
   712  	})
   713  
   714  	// Check that all crypto packages compile with the purego build tag.
   715  	t.registerTest("crypto with tag purego (build and vet only)", &goTest{
   716  		variant:  "purego",
   717  		tags:     []string{"purego"},
   718  		pkg:      "crypto/...",
   719  		runTests: "^$", // only ensure they compile
   720  	})
   721  
   722  	// Check that all crypto packages compile (and test correctly, in longmode) with fips.
   723  	if t.fipsSupported() {
   724  		// Test standard crypto packages with fips140=on.
   725  		t.registerTest("GOFIPS140=latest go test crypto/...", &goTest{
   726  			variant: "gofips140",
   727  			env:     []string{"GOFIPS140=latest"},
   728  			pkg:     "crypto/...",
   729  		})
   730  
   731  		// Test that earlier FIPS snapshots build.
   732  		// In long mode, test that they work too.
   733  		for _, version := range fipsVersions() {
   734  			suffix := " # (build and vet only)"
   735  			run := "^$" // only ensure they compile
   736  			if !t.short {
   737  				suffix = ""
   738  				run = ""
   739  			}
   740  			t.registerTest("GOFIPS140="+version+" go test crypto/..."+suffix, &goTest{
   741  				variant:  "gofips140-" + version,
   742  				pkg:      "crypto/...",
   743  				runTests: run,
   744  				env:      []string{"GOFIPS140=" + version, "GOMODCACHE=" + filepath.Join(workdir, "fips-"+version)},
   745  			})
   746  		}
   747  	}
   748  
   749  	// Test GOEXPERIMENT=jsonv2.
   750  	if !strings.Contains(goexperiment, "jsonv2") {
   751  		t.registerTest("GOEXPERIMENT=jsonv2 go test encoding/json/...", &goTest{
   752  			variant: "jsonv2",
   753  			env:     []string{"GOEXPERIMENT=" + goexperiments("jsonv2")},
   754  			pkg:     "encoding/json/...",
   755  		})
   756  	}
   757  
   758  	// Test GOEXPERIMENT=runtimesecret.
   759  	if !strings.Contains(goexperiment, "runtimesecret") {
   760  		t.registerTest("GOEXPERIMENT=runtimesecret go test runtime/secret/...", &goTest{
   761  			variant: "runtimesecret",
   762  			env:     []string{"GOEXPERIMENT=" + goexperiments("runtimesecret")},
   763  			pkg:     "runtime/secret/...",
   764  		})
   765  	}
   766  
   767  	// Test GOEXPERIMENT=simd on amd64.
   768  	if goarch == "amd64" && !strings.Contains(goexperiment, "simd") {
   769  		t.registerTest("GOEXPERIMENT=simd go test simd/archsimd/...", &goTest{
   770  			variant: "simd",
   771  			env:     []string{"GOEXPERIMENT=" + goexperiments("simd")},
   772  			pkg:     "simd/archsimd/...",
   773  		})
   774  	}
   775  
   776  	// Test ios/amd64 for the iOS simulator.
   777  	if goos == "darwin" && goarch == "amd64" && t.cgoEnabled {
   778  		t.registerTest("GOOS=ios on darwin/amd64",
   779  			&goTest{
   780  				variant:  "amd64ios",
   781  				timeout:  300 * time.Second,
   782  				runTests: "SystemRoots",
   783  				env:      []string{"GOOS=ios", "CGO_ENABLED=1"},
   784  				pkg:      "crypto/x509",
   785  			})
   786  	}
   787  
   788  	// GC debug mode tests. We only run these in long-test mode
   789  	// (with GO_TEST_SHORT=0) because this is just testing a
   790  	// non-critical debug setting.
   791  	if !t.compileOnly && !t.short {
   792  		t.registerTest("GODEBUG=gcstoptheworld=2 archive/zip",
   793  			&goTest{
   794  				variant: "gcstoptheworld2",
   795  				timeout: 300 * time.Second,
   796  				short:   true,
   797  				env:     []string{"GODEBUG=gcstoptheworld=2"},
   798  				pkg:     "archive/zip",
   799  			})
   800  		t.registerTest("GODEBUG=gccheckmark=1 runtime",
   801  			&goTest{
   802  				variant: "gccheckmark",
   803  				timeout: 300 * time.Second,
   804  				short:   true,
   805  				env:     []string{"GODEBUG=gccheckmark=1"},
   806  				pkg:     "runtime",
   807  			})
   808  	}
   809  
   810  	// Spectre mitigation smoke test.
   811  	if goos == "linux" && goarch == "amd64" && !(gogcflags == "-spectre=all" && t.asmflags == "all=-spectre=all") {
   812  		// Pick a bunch of packages known to have some assembly.
   813  		pkgs := []string{"internal/runtime/...", "reflect", "crypto/..."}
   814  		if !t.short {
   815  			pkgs = append(pkgs, "runtime")
   816  		}
   817  		t.registerTest("spectre",
   818  			&goTest{
   819  				variant: "spectre",
   820  				short:   true,
   821  				env:     []string{"GOFLAGS=-gcflags=all=-spectre=all -asmflags=all=-spectre=all"},
   822  				pkgs:    pkgs,
   823  			})
   824  	}
   825  
   826  	// morestack tests. We only run these in long-test mode
   827  	// (with GO_TEST_SHORT=0) because the runtime test is
   828  	// already quite long and mayMoreStackMove makes it about
   829  	// twice as slow.
   830  	if !t.compileOnly && !t.short {
   831  		// hooks is the set of maymorestack hooks to test with.
   832  		hooks := []string{"mayMoreStackPreempt", "mayMoreStackMove"}
   833  		// hookPkgs is the set of package patterns to apply
   834  		// the maymorestack hook to.
   835  		hookPkgs := []string{"runtime/...", "reflect", "sync"}
   836  		// unhookPkgs is the set of package patterns to
   837  		// exclude from hookPkgs.
   838  		unhookPkgs := []string{"runtime/testdata/..."}
   839  		for _, hook := range hooks {
   840  			// Construct the build flags to use the
   841  			// maymorestack hook in the compiler and
   842  			// assembler. We pass this via the GOFLAGS
   843  			// environment variable so that it applies to
   844  			// both the test itself and to binaries built
   845  			// by the test.
   846  			goFlagsList := []string{}
   847  			for _, flag := range []string{"-gcflags", "-asmflags"} {
   848  				for _, hookPkg := range hookPkgs {
   849  					goFlagsList = append(goFlagsList, flag+"="+hookPkg+"=-d=maymorestack=runtime."+hook)
   850  				}
   851  				for _, unhookPkg := range unhookPkgs {
   852  					goFlagsList = append(goFlagsList, flag+"="+unhookPkg+"=")
   853  				}
   854  			}
   855  			goFlags := strings.Join(goFlagsList, " ")
   856  
   857  			t.registerTest("maymorestack="+hook,
   858  				&goTest{
   859  					variant: hook,
   860  					timeout: 600 * time.Second,
   861  					short:   true,
   862  					env:     []string{"GOFLAGS=" + goFlags},
   863  					pkgs:    []string{"runtime", "reflect", "sync"},
   864  				})
   865  		}
   866  	}
   867  
   868  	// Test that internal linking of standard packages does not
   869  	// require libgcc. This ensures that we can install a Go
   870  	// release on a system that does not have a C compiler
   871  	// installed and still build Go programs (that don't use cgo).
   872  	for _, pkg := range cgoPackages {
   873  		if !t.internalLink() {
   874  			break
   875  		}
   876  
   877  		// ARM libgcc may be Thumb, which internal linking does not support.
   878  		if goarch == "arm" {
   879  			break
   880  		}
   881  
   882  		// What matters is that the tests build and start up.
   883  		// Skip expensive tests, especially x509 TestSystemRoots.
   884  		run := "^Test[^CS]"
   885  		if pkg == "net" {
   886  			run = "TestTCPStress"
   887  		}
   888  		t.registerTest("Testing without libgcc.",
   889  			&goTest{
   890  				variant:  "nolibgcc",
   891  				ldflags:  "-linkmode=internal -libgcc=none",
   892  				runTests: run,
   893  				pkg:      pkg,
   894  			})
   895  	}
   896  
   897  	// Stub out following test on alpine until 54354 resolved.
   898  	builderName := os.Getenv("GO_BUILDER_NAME")
   899  	disablePIE := strings.HasSuffix(builderName, "-alpine")
   900  
   901  	// Test internal linking of PIE binaries where it is supported.
   902  	if t.internalLinkPIE() && !disablePIE {
   903  		t.registerTest("internal linking, -buildmode=pie",
   904  			&goTest{
   905  				variant:   "pie_internal",
   906  				timeout:   60 * time.Second,
   907  				buildmode: "pie",
   908  				ldflags:   "-linkmode=internal",
   909  				env:       []string{"CGO_ENABLED=0"},
   910  				pkg:       "reflect",
   911  			})
   912  		t.registerTest("internal linking, -buildmode=pie",
   913  			&goTest{
   914  				variant:   "pie_internal",
   915  				timeout:   60 * time.Second,
   916  				buildmode: "pie",
   917  				ldflags:   "-linkmode=internal",
   918  				env:       []string{"CGO_ENABLED=0"},
   919  				pkg:       "crypto/internal/fips140test",
   920  				runTests:  "TestFIPSCheck",
   921  			})
   922  		// Also test a cgo package.
   923  		if t.cgoEnabled && t.internalLink() && !disablePIE {
   924  			t.registerTest("internal linking, -buildmode=pie",
   925  				&goTest{
   926  					variant:   "pie_internal",
   927  					timeout:   60 * time.Second,
   928  					buildmode: "pie",
   929  					ldflags:   "-linkmode=internal",
   930  					pkg:       "os/user",
   931  				})
   932  		}
   933  	}
   934  
   935  	if t.extLink() && !t.compileOnly {
   936  		if goos != "android" { // Android does not support non-PIE linking
   937  			t.registerTest("external linking, -buildmode=exe",
   938  				&goTest{
   939  					variant:   "exe_external",
   940  					timeout:   60 * time.Second,
   941  					buildmode: "exe",
   942  					ldflags:   "-linkmode=external",
   943  					env:       []string{"CGO_ENABLED=1"},
   944  					pkg:       "crypto/internal/fips140test",
   945  					runTests:  "TestFIPSCheck",
   946  				})
   947  		}
   948  		if t.externalLinkPIE() && !disablePIE {
   949  			t.registerTest("external linking, -buildmode=pie",
   950  				&goTest{
   951  					variant:   "pie_external",
   952  					timeout:   60 * time.Second,
   953  					buildmode: "pie",
   954  					ldflags:   "-linkmode=external",
   955  					env:       []string{"CGO_ENABLED=1"},
   956  					pkg:       "crypto/internal/fips140test",
   957  					runTests:  "TestFIPSCheck",
   958  				})
   959  		}
   960  	}
   961  
   962  	// sync tests
   963  	if t.hasParallelism() {
   964  		t.registerTest("sync -cpu=10",
   965  			&goTest{
   966  				variant: "cpu10",
   967  				timeout: 120 * time.Second,
   968  				cpu:     "10",
   969  				pkg:     "sync",
   970  			})
   971  	}
   972  
   973  	const cgoHeading = "Testing cgo"
   974  	if t.cgoEnabled {
   975  		t.registerCgoTests(cgoHeading)
   976  	}
   977  
   978  	if goos == "wasip1" {
   979  		t.registerTest("wasip1 host tests",
   980  			&goTest{
   981  				variant:   "host",
   982  				pkg:       "internal/runtime/wasitest",
   983  				timeout:   1 * time.Minute,
   984  				runOnHost: true,
   985  			})
   986  	}
   987  
   988  	// Only run the API check on fast development platforms.
   989  	// Every platform checks the API on every GOOS/GOARCH/CGO_ENABLED combination anyway,
   990  	// so we really only need to run this check once anywhere to get adequate coverage.
   991  	// To help developers avoid trybot-only failures, we try to run on typical developer machines
   992  	// which is darwin,linux,windows/amd64 and darwin/arm64.
   993  	//
   994  	// The same logic applies to the release notes that correspond to each api/next file.
   995  	//
   996  	// TODO: remove the exclusion of goexperiment simd right before dev.simd branch is merged to master.
   997  	if goos == "darwin" || ((goos == "linux" || goos == "windows") && (goarch == "amd64" && !strings.Contains(goexperiment, "simd"))) {
   998  		t.registerTest("API release note check", &goTest{variant: "check", pkg: "cmd/relnote", testFlags: []string{"-check"}})
   999  		t.registerTest("API check", &goTest{variant: "check", pkg: "cmd/api", timeout: 5 * time.Minute, testFlags: []string{"-check"}})
  1000  	}
  1001  
  1002  	// Runtime CPU tests.
  1003  	if !t.compileOnly && t.hasParallelism() {
  1004  		for i := 1; i <= 4; i *= 2 {
  1005  			t.registerTest(fmt.Sprintf("GOMAXPROCS=2 runtime -cpu=%d -quick", i),
  1006  				&goTest{
  1007  					variant:   "cpu" + strconv.Itoa(i),
  1008  					timeout:   300 * time.Second,
  1009  					cpu:       strconv.Itoa(i),
  1010  					gcflags:   gogcflags,
  1011  					short:     true,
  1012  					testFlags: []string{"-quick"},
  1013  					// We set GOMAXPROCS=2 in addition to -cpu=1,2,4 in order to test runtime bootstrap code,
  1014  					// creation of first goroutines and first garbage collections in the parallel setting.
  1015  					env: []string{"GOMAXPROCS=2"},
  1016  					pkg: "runtime",
  1017  				})
  1018  		}
  1019  	}
  1020  
  1021  	if t.raceDetectorSupported() && !t.msan && !t.asan {
  1022  		// N.B. -race is incompatible with -msan and -asan.
  1023  		t.registerRaceTests()
  1024  	}
  1025  
  1026  	if goos != "android" && !t.iOS() {
  1027  		// Only start multiple test dir shards on builders,
  1028  		// where they get distributed to multiple machines.
  1029  		// See issues 20141 and 31834.
  1030  		nShards := 1
  1031  		if os.Getenv("GO_BUILDER_NAME") != "" {
  1032  			nShards = 10
  1033  		}
  1034  		if n, err := strconv.Atoi(os.Getenv("GO_TEST_SHARDS")); err == nil {
  1035  			nShards = n
  1036  		}
  1037  		for shard := 0; shard < nShards; shard++ {
  1038  			id := fmt.Sprintf("%d_%d", shard, nShards)
  1039  			t.registerTest("../test",
  1040  				&goTest{
  1041  					variant: id,
  1042  					// Include the variant even though there's no overlap in test names.
  1043  					// This makes the test target more clearly distinct in our build
  1044  					// results and is important for load-balancing test shards.
  1045  					omitVariant: false,
  1046  					pkg:         "cmd/internal/testdir",
  1047  					testFlags:   []string{fmt.Sprintf("-shard=%d", shard), fmt.Sprintf("-shards=%d", nShards)},
  1048  					runOnHost:   true,
  1049  				},
  1050  			)
  1051  		}
  1052  	}
  1053  }
  1054  
  1055  // addTest adds an arbitrary test callback to the test list.
  1056  //
  1057  // name must uniquely identify the test and heading must be non-empty.
  1058  func (t *tester) addTest(name, heading string, fn func(*distTest) error) {
  1059  	if t.testNames[name] {
  1060  		panic("duplicate registered test name " + name)
  1061  	}
  1062  	if heading == "" {
  1063  		panic("empty heading")
  1064  	}
  1065  	// Two simple checks for cases that would conflict with the fast path in registerTests.
  1066  	if !strings.Contains(name, ":") && heading != "Testing packages." {
  1067  		panic("empty variant is reserved exclusively for registerStdTest")
  1068  	} else if strings.HasSuffix(name, ":racebench") && heading != "Running benchmarks briefly." {
  1069  		panic("racebench variant is reserved exclusively for registerRaceBenchTest")
  1070  	}
  1071  	if t.testNames == nil {
  1072  		t.testNames = make(map[string]bool)
  1073  	}
  1074  	t.testNames[name] = true
  1075  	t.tests = append(t.tests, distTest{
  1076  		name:    name,
  1077  		heading: heading,
  1078  		fn:      fn,
  1079  	})
  1080  }
  1081  
  1082  type registerTestOpt interface {
  1083  	isRegisterTestOpt()
  1084  }
  1085  
  1086  // rtSkipFunc is a registerTest option that runs a skip check function before
  1087  // running the test.
  1088  type rtSkipFunc struct {
  1089  	skip func(*distTest) (string, bool) // Return message, true to skip the test
  1090  }
  1091  
  1092  func (rtSkipFunc) isRegisterTestOpt() {}
  1093  
  1094  // registerTest registers a test that runs the given goTest.
  1095  //
  1096  // Each Go package in goTest will have a corresponding test
  1097  // "<pkg>:<variant>", which must uniquely identify the test.
  1098  //
  1099  // heading and test.variant must be non-empty.
  1100  func (t *tester) registerTest(heading string, test *goTest, opts ...registerTestOpt) {
  1101  	var skipFunc func(*distTest) (string, bool)
  1102  	for _, opt := range opts {
  1103  		switch opt := opt.(type) {
  1104  		case rtSkipFunc:
  1105  			skipFunc = opt.skip
  1106  		}
  1107  	}
  1108  	// Register each test package as a separate test.
  1109  	register1 := func(test *goTest) {
  1110  		if test.variant == "" {
  1111  			panic("empty variant")
  1112  		}
  1113  		name := testName(test.pkg, test.variant)
  1114  		t.addTest(name, heading, func(dt *distTest) error {
  1115  			if skipFunc != nil {
  1116  				msg, skip := skipFunc(dt)
  1117  				if skip {
  1118  					test.printSkip(t, msg)
  1119  					return nil
  1120  				}
  1121  			}
  1122  			w := &work{dt: dt}
  1123  			w.cmd, w.flush = test.bgCommand(t, &w.out, &w.out)
  1124  			t.worklist = append(t.worklist, w)
  1125  			return nil
  1126  		})
  1127  	}
  1128  	if test.pkg != "" && len(test.pkgs) == 0 {
  1129  		// Common case. Avoid copying.
  1130  		register1(test)
  1131  		return
  1132  	}
  1133  	// TODO(dmitshur,austin): It might be better to unify the execution of 'go test pkg'
  1134  	// invocations for the same variant to be done with a single 'go test pkg1 pkg2 pkg3'
  1135  	// command, just like it's already done in registerStdTest and registerRaceBenchTest.
  1136  	// Those methods accumulate matched packages in stdMatches and benchMatches slices,
  1137  	// and we can extend that mechanism to work for all other equal variant registrations.
  1138  	// Do the simple thing to start with.
  1139  	for _, pkg := range test.packages() {
  1140  		test1 := *test
  1141  		test1.pkg, test1.pkgs = pkg, nil
  1142  		register1(&test1)
  1143  	}
  1144  }
  1145  
  1146  // dirCmd constructs a Cmd intended to be run in the foreground.
  1147  // The command will be run in dir, and Stdout and Stderr will go to os.Stdout
  1148  // and os.Stderr.
  1149  func (t *tester) dirCmd(dir string, cmdline ...any) *exec.Cmd {
  1150  	bin, args := flattenCmdline(cmdline)
  1151  	cmd := exec.Command(bin, args...)
  1152  	if filepath.IsAbs(dir) {
  1153  		setDir(cmd, dir)
  1154  	} else {
  1155  		setDir(cmd, filepath.Join(goroot, dir))
  1156  	}
  1157  	cmd.Stdout = os.Stdout
  1158  	cmd.Stderr = os.Stderr
  1159  	if vflag > 1 {
  1160  		errprintf("%#q\n", cmd)
  1161  	}
  1162  	return cmd
  1163  }
  1164  
  1165  // flattenCmdline flattens a mixture of string and []string as single list
  1166  // and then interprets it as a command line: first element is binary, then args.
  1167  func flattenCmdline(cmdline []any) (bin string, args []string) {
  1168  	var list []string
  1169  	for _, x := range cmdline {
  1170  		switch x := x.(type) {
  1171  		case string:
  1172  			list = append(list, x)
  1173  		case []string:
  1174  			list = append(list, x...)
  1175  		default:
  1176  			panic("invalid dirCmd argument type: " + reflect.TypeOf(x).String())
  1177  		}
  1178  	}
  1179  
  1180  	bin = list[0]
  1181  	if !filepath.IsAbs(bin) {
  1182  		panic("command is not absolute: " + bin)
  1183  	}
  1184  	return bin, list[1:]
  1185  }
  1186  
  1187  func (t *tester) iOS() bool {
  1188  	return goos == "ios"
  1189  }
  1190  
  1191  func (t *tester) out(v string) {
  1192  	if t.json {
  1193  		return
  1194  	}
  1195  	if t.banner == "" {
  1196  		return
  1197  	}
  1198  	fmt.Println("\n" + t.banner + v)
  1199  }
  1200  
  1201  // extLink reports whether the current goos/goarch supports
  1202  // external linking.
  1203  func (t *tester) extLink() bool {
  1204  	if !cgoEnabled[goos+"/"+goarch] {
  1205  		return false
  1206  	}
  1207  	if goarch == "ppc64" && goos != "aix" && goos != "linux" {
  1208  		return false
  1209  	}
  1210  	return true
  1211  }
  1212  
  1213  func (t *tester) internalLink() bool {
  1214  	if gohostos == "dragonfly" {
  1215  		// linkmode=internal fails on dragonfly since errno is a TLS relocation.
  1216  		return false
  1217  	}
  1218  	if goos == "android" {
  1219  		return false
  1220  	}
  1221  	if goos == "ios" {
  1222  		return false
  1223  	}
  1224  	// Internally linking cgo is incomplete on some architectures.
  1225  	// https://golang.org/issue/10373
  1226  	// https://golang.org/issue/14449
  1227  	if goarch == "mips64" || goarch == "mips64le" || goarch == "mips" || goarch == "mipsle" || goarch == "riscv64" {
  1228  		return false
  1229  	}
  1230  	if goos == "aix" {
  1231  		// linkmode=internal isn't supported.
  1232  		return false
  1233  	}
  1234  	if t.msan || t.asan {
  1235  		// linkmode=internal isn't supported by msan or asan.
  1236  		return false
  1237  	}
  1238  	return true
  1239  }
  1240  
  1241  func (t *tester) internalLinkPIE() bool {
  1242  	if t.msan || t.asan {
  1243  		// linkmode=internal isn't supported by msan or asan.
  1244  		return false
  1245  	}
  1246  	switch goos + "-" + goarch {
  1247  	case "darwin-amd64", "darwin-arm64",
  1248  		"linux-amd64", "linux-arm64", "linux-loong64", "linux-ppc64", "linux-ppc64le", "linux-s390x",
  1249  		"android-arm64",
  1250  		"windows-amd64", "windows-386", "windows-arm64":
  1251  		return true
  1252  	}
  1253  	return false
  1254  }
  1255  
  1256  func (t *tester) externalLinkPIE() bool {
  1257  	// General rule is if -buildmode=pie and -linkmode=external both work, then they work together.
  1258  	return t.internalLinkPIE() && t.extLink()
  1259  }
  1260  
  1261  // supportedBuildmode reports whether the given build mode is supported.
  1262  func (t *tester) supportedBuildmode(mode string) bool {
  1263  	switch mode {
  1264  	case "c-archive", "c-shared", "shared", "plugin", "pie":
  1265  	default:
  1266  		fatalf("internal error: unknown buildmode %s", mode)
  1267  		return false
  1268  	}
  1269  
  1270  	return buildModeSupported("gc", mode, goos, goarch)
  1271  }
  1272  
  1273  func (t *tester) registerCgoTests(heading string) {
  1274  	cgoTest := func(variant string, subdir, linkmode, buildmode string, opts ...registerTestOpt) *goTest {
  1275  		gt := &goTest{
  1276  			variant:   variant,
  1277  			pkg:       "cmd/cgo/internal/" + subdir,
  1278  			buildmode: buildmode,
  1279  		}
  1280  		var ldflags []string
  1281  		if linkmode != "auto" {
  1282  			// "auto" is the default, so avoid cluttering the command line for "auto"
  1283  			ldflags = append(ldflags, "-linkmode="+linkmode)
  1284  		}
  1285  
  1286  		if linkmode == "internal" {
  1287  			gt.tags = append(gt.tags, "internal")
  1288  			if buildmode == "pie" {
  1289  				gt.tags = append(gt.tags, "internal_pie")
  1290  			}
  1291  		}
  1292  		if buildmode == "static" {
  1293  			// This isn't actually a Go buildmode, just a convenient way to tell
  1294  			// cgoTest we want static linking.
  1295  			gt.buildmode = ""
  1296  			switch linkmode {
  1297  			case "external":
  1298  				ldflags = append(ldflags, `-extldflags "-static -pthread"`)
  1299  			case "auto":
  1300  				gt.env = append(gt.env, "CGO_LDFLAGS=-static -pthread")
  1301  			default:
  1302  				panic("unknown linkmode with static build: " + linkmode)
  1303  			}
  1304  			gt.tags = append(gt.tags, "static")
  1305  		}
  1306  		gt.ldflags = strings.Join(ldflags, " ")
  1307  
  1308  		t.registerTest(heading, gt, opts...)
  1309  		return gt
  1310  	}
  1311  
  1312  	// test, testtls, and testnocgo are run with linkmode="auto", buildmode=""
  1313  	// as part of go test cmd. Here we only have to register the non-default
  1314  	// build modes of these tests.
  1315  
  1316  	// Stub out various buildmode=pie tests  on alpine until 54354 resolved.
  1317  	builderName := os.Getenv("GO_BUILDER_NAME")
  1318  	disablePIE := strings.HasSuffix(builderName, "-alpine")
  1319  
  1320  	if t.internalLink() {
  1321  		cgoTest("internal", "test", "internal", "")
  1322  	}
  1323  
  1324  	os := gohostos
  1325  	p := gohostos + "/" + goarch
  1326  	switch os {
  1327  	case "darwin", "windows":
  1328  		if !t.extLink() {
  1329  			break
  1330  		}
  1331  		// test linkmode=external, but __thread not supported, so skip testtls.
  1332  		cgoTest("external", "test", "external", "")
  1333  
  1334  		gt := cgoTest("external-s", "test", "external", "")
  1335  		gt.ldflags += " -s"
  1336  
  1337  		if t.supportedBuildmode("pie") && !disablePIE {
  1338  			cgoTest("auto-pie", "test", "auto", "pie")
  1339  			if t.internalLink() && t.internalLinkPIE() {
  1340  				cgoTest("internal-pie", "test", "internal", "pie")
  1341  			}
  1342  		}
  1343  
  1344  	case "aix", "android", "dragonfly", "freebsd", "linux", "netbsd", "openbsd":
  1345  		gt := cgoTest("external-g0", "test", "external", "")
  1346  		gt.env = append(gt.env, "CGO_CFLAGS=-g0 -fdiagnostics-color")
  1347  
  1348  		cgoTest("external", "testtls", "external", "")
  1349  		switch {
  1350  		case os == "aix":
  1351  			// no static linking
  1352  		case p == "freebsd/arm":
  1353  			// -fPIC compiled tls code will use __tls_get_addr instead
  1354  			// of __aeabi_read_tp, however, on FreeBSD/ARM, __tls_get_addr
  1355  			// is implemented in rtld-elf, so -fPIC isn't compatible with
  1356  			// static linking on FreeBSD/ARM with clang. (cgo depends on
  1357  			// -fPIC fundamentally.)
  1358  		default:
  1359  			// Check for static linking support
  1360  			var staticCheck rtSkipFunc
  1361  			ccName := compilerEnvLookup("CC", defaultcc, goos, goarch)
  1362  			cc, err := exec.LookPath(ccName)
  1363  			if err != nil {
  1364  				staticCheck.skip = func(*distTest) (string, bool) {
  1365  					return fmt.Sprintf("$CC (%q) not found, skip cgo static linking test.", ccName), true
  1366  				}
  1367  			} else {
  1368  				cmd := t.dirCmd("src/cmd/cgo/internal/test", cc, "-xc", "-o", "/dev/null", "-static", "-")
  1369  				cmd.Stdin = strings.NewReader("int main() {}")
  1370  				cmd.Stdout, cmd.Stderr = nil, nil // Discard output
  1371  				if err := cmd.Run(); err != nil {
  1372  					// Skip these tests
  1373  					staticCheck.skip = func(*distTest) (string, bool) {
  1374  						return "No support for static linking found (lacks libc.a?), skip cgo static linking test.", true
  1375  					}
  1376  				}
  1377  			}
  1378  
  1379  			// Doing a static link with boringcrypto gets
  1380  			// a C linker warning on Linux.
  1381  			// in function `bio_ip_and_port_to_socket_and_addr':
  1382  			// warning: Using 'getaddrinfo' in statically linked applications requires at runtime the shared libraries from the glibc version used for linking
  1383  			if staticCheck.skip == nil && goos == "linux" && strings.Contains(goexperiment, "boringcrypto") {
  1384  				staticCheck.skip = func(*distTest) (string, bool) {
  1385  					return "skipping static linking check on Linux when using boringcrypto to avoid C linker warning about getaddrinfo", true
  1386  				}
  1387  			}
  1388  
  1389  			// Static linking tests
  1390  			if goos != "android" && p != "netbsd/arm" && !t.msan && !t.asan {
  1391  				// TODO(#56629): Why does this fail on netbsd-arm?
  1392  				// TODO(#70080): Why does this fail with msan?
  1393  				// asan doesn't support static linking (this is an explicit build error on the C side).
  1394  				cgoTest("static", "testtls", "external", "static", staticCheck)
  1395  			}
  1396  			cgoTest("external", "testnocgo", "external", "", staticCheck)
  1397  			if goos != "android" && !t.msan && !t.asan {
  1398  				// TODO(#70080): Why does this fail with msan?
  1399  				// asan doesn't support static linking (this is an explicit build error on the C side).
  1400  				cgoTest("static", "testnocgo", "external", "static", staticCheck)
  1401  				cgoTest("static", "test", "external", "static", staticCheck)
  1402  				// -static in CGO_LDFLAGS triggers a different code path
  1403  				// than -static in -extldflags, so test both.
  1404  				// See issue #16651.
  1405  				if goarch != "loong64" && !t.msan && !t.asan {
  1406  					// TODO(#56623): Why does this fail on loong64?
  1407  					cgoTest("auto-static", "test", "auto", "static", staticCheck)
  1408  				}
  1409  			}
  1410  
  1411  			// PIE linking tests
  1412  			if t.supportedBuildmode("pie") && !disablePIE {
  1413  				cgoTest("auto-pie", "test", "auto", "pie")
  1414  				if t.internalLink() && t.internalLinkPIE() {
  1415  					cgoTest("internal-pie", "test", "internal", "pie")
  1416  				}
  1417  				cgoTest("auto-pie", "testtls", "auto", "pie")
  1418  				cgoTest("auto-pie", "testnocgo", "auto", "pie")
  1419  			}
  1420  		}
  1421  	}
  1422  }
  1423  
  1424  // runPending runs pending test commands, in parallel, emitting headers as appropriate.
  1425  // When finished, it emits header for nextTest, which is going to run after the
  1426  // pending commands are done (and runPending returns).
  1427  // A test should call runPending if it wants to make sure that it is not
  1428  // running in parallel with earlier tests, or if it has some other reason
  1429  // for needing the earlier tests to be done.
  1430  func (t *tester) runPending(nextTest *distTest) {
  1431  	worklist := t.worklist
  1432  	t.worklist = nil
  1433  	for _, w := range worklist {
  1434  		w.start = make(chan bool)
  1435  		w.end = make(chan struct{})
  1436  		// w.cmd must be set up to write to w.out. We can't check that, but we
  1437  		// can check for easy mistakes.
  1438  		if w.cmd.Stdout == nil || w.cmd.Stdout == os.Stdout || w.cmd.Stderr == nil || w.cmd.Stderr == os.Stderr {
  1439  			panic("work.cmd.Stdout/Stderr must be redirected")
  1440  		}
  1441  		go func(w *work) {
  1442  			if !<-w.start {
  1443  				timelog("skip", w.dt.name)
  1444  				w.printSkip(t, "skipped due to earlier error")
  1445  			} else {
  1446  				timelog("start", w.dt.name)
  1447  				w.err = w.cmd.Run()
  1448  				if w.flush != nil {
  1449  					w.flush()
  1450  				}
  1451  				if w.err != nil {
  1452  					if isUnsupportedVMASize(w) {
  1453  						timelog("skip", w.dt.name)
  1454  						w.out.Reset()
  1455  						w.printSkip(t, "skipped due to unsupported VMA")
  1456  						w.err = nil
  1457  					}
  1458  				}
  1459  			}
  1460  			timelog("end", w.dt.name)
  1461  			w.end <- struct{}{}
  1462  		}(w)
  1463  	}
  1464  
  1465  	maxbg := maxbg
  1466  	// for runtime.NumCPU() < 4 ||  runtime.GOMAXPROCS(0) == 1, do not change maxbg.
  1467  	// Because there is not enough CPU to parallel the testing of multiple packages.
  1468  	if runtime.NumCPU() > 4 && runtime.GOMAXPROCS(0) != 1 {
  1469  		for _, w := range worklist {
  1470  			// See go.dev/issue/65164
  1471  			// because GOMAXPROCS=2 runtime CPU usage is low,
  1472  			// so increase maxbg to avoid slowing down execution with low CPU usage.
  1473  			// This makes testing a single package slower,
  1474  			// but testing multiple packages together faster.
  1475  			if strings.Contains(w.dt.heading, "GOMAXPROCS=2 runtime") {
  1476  				maxbg = runtime.NumCPU()
  1477  				break
  1478  			}
  1479  		}
  1480  	}
  1481  
  1482  	started := 0
  1483  	ended := 0
  1484  	var last *distTest
  1485  	for ended < len(worklist) {
  1486  		for started < len(worklist) && started-ended < maxbg {
  1487  			w := worklist[started]
  1488  			started++
  1489  			w.start <- !t.failed || t.keepGoing
  1490  		}
  1491  		w := worklist[ended]
  1492  		dt := w.dt
  1493  		if t.lastHeading != dt.heading {
  1494  			t.lastHeading = dt.heading
  1495  			t.out(dt.heading)
  1496  		}
  1497  		if dt != last {
  1498  			// Assumes all the entries for a single dt are in one worklist.
  1499  			last = w.dt
  1500  			if vflag > 0 {
  1501  				fmt.Printf("# go tool dist test -run=^%s$\n", dt.name)
  1502  			}
  1503  		}
  1504  		if vflag > 1 {
  1505  			errprintf("%#q\n", w.cmd)
  1506  		}
  1507  		ended++
  1508  		<-w.end
  1509  		os.Stdout.Write(w.out.Bytes())
  1510  		// We no longer need the output, so drop the buffer.
  1511  		w.out = bytes.Buffer{}
  1512  		if w.err != nil {
  1513  			log.Printf("Failed: %v", w.err)
  1514  			t.failed = true
  1515  		}
  1516  	}
  1517  	if t.failed && !t.keepGoing {
  1518  		fatalf("FAILED")
  1519  	}
  1520  
  1521  	if dt := nextTest; dt != nil {
  1522  		if t.lastHeading != dt.heading {
  1523  			t.lastHeading = dt.heading
  1524  			t.out(dt.heading)
  1525  		}
  1526  		if vflag > 0 {
  1527  			fmt.Printf("# go tool dist test -run=^%s$\n", dt.name)
  1528  		}
  1529  	}
  1530  }
  1531  
  1532  // hasParallelism is a copy of the function
  1533  // internal/testenv.HasParallelism, which can't be used here
  1534  // because cmd/dist can not import internal packages during bootstrap.
  1535  func (t *tester) hasParallelism() bool {
  1536  	switch goos {
  1537  	case "js", "wasip1":
  1538  		return false
  1539  	}
  1540  	return true
  1541  }
  1542  
  1543  func (t *tester) raceDetectorSupported() bool {
  1544  	if gohostos != goos {
  1545  		return false
  1546  	}
  1547  	if !t.cgoEnabled {
  1548  		return false
  1549  	}
  1550  	if !raceDetectorSupported(goos, goarch) {
  1551  		return false
  1552  	}
  1553  	// The race detector doesn't work on Alpine Linux:
  1554  	// golang.org/issue/14481
  1555  	if isAlpineLinux() {
  1556  		return false
  1557  	}
  1558  	// NetBSD support is unfinished.
  1559  	// golang.org/issue/26403
  1560  	if goos == "netbsd" {
  1561  		return false
  1562  	}
  1563  	return true
  1564  }
  1565  
  1566  func isAlpineLinux() bool {
  1567  	if runtime.GOOS != "linux" {
  1568  		return false
  1569  	}
  1570  	fi, err := os.Lstat("/etc/alpine-release")
  1571  	return err == nil && fi.Mode().IsRegular()
  1572  }
  1573  
  1574  func (t *tester) registerRaceTests() {
  1575  	hdr := "Testing race detector"
  1576  	t.registerTest(hdr,
  1577  		&goTest{
  1578  			variant:  "race",
  1579  			race:     true,
  1580  			runTests: "Output",
  1581  			pkg:      "runtime/race",
  1582  		})
  1583  	t.registerTest(hdr,
  1584  		&goTest{
  1585  			variant:  "race",
  1586  			race:     true,
  1587  			runTests: "TestParse|TestEcho|TestStdinCloseRace|TestClosedPipeRace|TestTypeRace|TestFdRace|TestFdReadRace|TestFileCloseRace",
  1588  			pkgs:     []string{"flag", "net", "os", "os/exec", "encoding/gob"},
  1589  		})
  1590  	// We don't want the following line, because it
  1591  	// slows down all.bash (by 10 seconds on my laptop).
  1592  	// The race builder should catch any error here, but doesn't.
  1593  	// TODO(iant): Figure out how to catch this.
  1594  	// t.registerTest(hdr, &goTest{variant: "race", race: true, runTests: "TestParallelTest", pkg: "cmd/go"})
  1595  	if t.cgoEnabled {
  1596  		// Building cmd/cgo/internal/test takes a long time.
  1597  		// There are already cgo-enabled packages being tested with the race detector.
  1598  		// We shouldn't need to redo all of cmd/cgo/internal/test too.
  1599  		// The race builder will take care of this.
  1600  		// t.registerTest(hdr, &goTest{variant: "race", race: true, env: []string{"GOTRACEBACK=2"}, pkg: "cmd/cgo/internal/test"})
  1601  	}
  1602  	if t.extLink() {
  1603  		// Test with external linking; see issue 9133.
  1604  		t.registerTest(hdr,
  1605  			&goTest{
  1606  				variant:  "race-external",
  1607  				race:     true,
  1608  				ldflags:  "-linkmode=external",
  1609  				runTests: "TestParse|TestEcho|TestStdinCloseRace",
  1610  				pkgs:     []string{"flag", "os/exec"},
  1611  			})
  1612  	}
  1613  }
  1614  
  1615  // cgoPackages is the standard packages that use cgo.
  1616  var cgoPackages = []string{
  1617  	"net",
  1618  	"os/user",
  1619  }
  1620  
  1621  var funcBenchmark = []byte("\nfunc Benchmark")
  1622  
  1623  // packageHasBenchmarks reports whether pkg has benchmarks.
  1624  // On any error, it conservatively returns true.
  1625  //
  1626  // This exists just to eliminate work on the builders, since compiling
  1627  // a test in race mode just to discover it has no benchmarks costs a
  1628  // second or two per package, and this function returns false for
  1629  // about 100 packages.
  1630  func (t *tester) packageHasBenchmarks(pkg string) bool {
  1631  	pkgDir := filepath.Join(goroot, "src", pkg)
  1632  	d, err := os.Open(pkgDir)
  1633  	if err != nil {
  1634  		return true // conservatively
  1635  	}
  1636  	defer d.Close()
  1637  	names, err := d.Readdirnames(-1)
  1638  	if err != nil {
  1639  		return true // conservatively
  1640  	}
  1641  	for _, name := range names {
  1642  		if !strings.HasSuffix(name, "_test.go") {
  1643  			continue
  1644  		}
  1645  		slurp, err := os.ReadFile(filepath.Join(pkgDir, name))
  1646  		if err != nil {
  1647  			return true // conservatively
  1648  		}
  1649  		if bytes.Contains(slurp, funcBenchmark) {
  1650  			return true
  1651  		}
  1652  	}
  1653  	return false
  1654  }
  1655  
  1656  // makeGOROOTUnwritable makes all $GOROOT files & directories non-writable to
  1657  // check that no tests accidentally write to $GOROOT.
  1658  func (t *tester) makeGOROOTUnwritable() (undo func()) {
  1659  	dir := os.Getenv("GOROOT")
  1660  	if dir == "" {
  1661  		panic("GOROOT not set")
  1662  	}
  1663  
  1664  	type pathMode struct {
  1665  		path string
  1666  		mode os.FileMode
  1667  	}
  1668  	var dirs []pathMode // in lexical order
  1669  
  1670  	undo = func() {
  1671  		for i := range dirs {
  1672  			os.Chmod(dirs[i].path, dirs[i].mode) // best effort
  1673  		}
  1674  	}
  1675  
  1676  	filepath.WalkDir(dir, func(path string, d fs.DirEntry, err error) error {
  1677  		if suffix := strings.TrimPrefix(path, dir+string(filepath.Separator)); suffix != "" {
  1678  			if suffix == ".git" {
  1679  				// Leave Git metadata in whatever state it was in. It may contain a lot
  1680  				// of files, and it is highly unlikely that a test will try to modify
  1681  				// anything within that directory.
  1682  				return filepath.SkipDir
  1683  			}
  1684  		}
  1685  		if err != nil {
  1686  			return nil
  1687  		}
  1688  
  1689  		info, err := d.Info()
  1690  		if err != nil {
  1691  			return nil
  1692  		}
  1693  
  1694  		mode := info.Mode()
  1695  		if mode&0222 != 0 && (mode.IsDir() || mode.IsRegular()) {
  1696  			dirs = append(dirs, pathMode{path, mode})
  1697  		}
  1698  		return nil
  1699  	})
  1700  
  1701  	// Run over list backward to chmod children before parents.
  1702  	for i := len(dirs) - 1; i >= 0; i-- {
  1703  		err := os.Chmod(dirs[i].path, dirs[i].mode&^0222)
  1704  		if err != nil {
  1705  			dirs = dirs[i:] // Only undo what we did so far.
  1706  			undo()
  1707  			fatalf("failed to make GOROOT read-only: %v", err)
  1708  		}
  1709  	}
  1710  
  1711  	return undo
  1712  }
  1713  
  1714  // raceDetectorSupported is a copy of the function
  1715  // internal/platform.RaceDetectorSupported, which can't be used here
  1716  // because cmd/dist can not import internal packages during bootstrap.
  1717  // The race detector only supports 48-bit VMA on arm64. But we don't have
  1718  // a good solution to check VMA size (see https://go.dev/issue/29948).
  1719  // raceDetectorSupported will always return true for arm64. But race
  1720  // detector tests may abort on non 48-bit VMA configuration, the tests
  1721  // will be marked as "skipped" in this case.
  1722  func raceDetectorSupported(goos, goarch string) bool {
  1723  	switch goos {
  1724  	case "linux":
  1725  		return goarch == "amd64" || goarch == "arm64" || goarch == "loong64" || goarch == "ppc64le" || goarch == "riscv64" || goarch == "s390x"
  1726  	case "darwin":
  1727  		return goarch == "amd64" || goarch == "arm64"
  1728  	case "freebsd", "netbsd", "windows":
  1729  		return goarch == "amd64"
  1730  	default:
  1731  		return false
  1732  	}
  1733  }
  1734  
  1735  // buildModeSupported is a copy of the function
  1736  // internal/platform.BuildModeSupported, which can't be used here
  1737  // because cmd/dist can not import internal packages during bootstrap.
  1738  func buildModeSupported(compiler, buildmode, goos, goarch string) bool {
  1739  	if compiler == "gccgo" {
  1740  		return true
  1741  	}
  1742  
  1743  	platform := goos + "/" + goarch
  1744  
  1745  	switch buildmode {
  1746  	case "archive":
  1747  		return true
  1748  
  1749  	case "c-archive":
  1750  		switch goos {
  1751  		case "aix", "darwin", "ios", "windows":
  1752  			return true
  1753  		case "linux":
  1754  			switch goarch {
  1755  			case "386", "amd64", "arm", "armbe", "arm64", "arm64be", "loong64", "ppc64", "ppc64le", "riscv64", "s390x":
  1756  				return true
  1757  			default:
  1758  				// Other targets do not support -shared,
  1759  				// per ParseFlags in
  1760  				// cmd/compile/internal/base/flag.go.
  1761  				// For c-archive the Go tool passes -shared,
  1762  				// so that the result is suitable for inclusion
  1763  				// in a PIE or shared library.
  1764  				return false
  1765  			}
  1766  		case "freebsd":
  1767  			return goarch == "amd64"
  1768  		}
  1769  		return false
  1770  
  1771  	case "c-shared":
  1772  		switch platform {
  1773  		case "linux/amd64", "linux/arm", "linux/arm64", "linux/loong64", "linux/386", "linux/ppc64", "linux/ppc64le", "linux/riscv64", "linux/s390x",
  1774  			"android/amd64", "android/arm", "android/arm64", "android/386",
  1775  			"freebsd/amd64",
  1776  			"darwin/amd64", "darwin/arm64",
  1777  			"windows/amd64", "windows/386", "windows/arm64",
  1778  			"wasip1/wasm":
  1779  			return true
  1780  		}
  1781  		return false
  1782  
  1783  	case "default":
  1784  		return true
  1785  
  1786  	case "exe":
  1787  		return true
  1788  
  1789  	case "pie":
  1790  		switch platform {
  1791  		case "linux/386", "linux/amd64", "linux/arm", "linux/arm64", "linux/loong64", "linux/ppc64", "linux/ppc64le", "linux/riscv64", "linux/s390x",
  1792  			"android/amd64", "android/arm", "android/arm64", "android/386",
  1793  			"freebsd/amd64",
  1794  			"darwin/amd64", "darwin/arm64",
  1795  			"ios/amd64", "ios/arm64",
  1796  			"aix/ppc64",
  1797  			"openbsd/arm64",
  1798  			"windows/386", "windows/amd64", "windows/arm64":
  1799  			return true
  1800  		}
  1801  		return false
  1802  
  1803  	case "shared":
  1804  		switch platform {
  1805  		case "linux/386", "linux/amd64", "linux/arm", "linux/arm64", "linux/ppc64", "linux/ppc64le", "linux/s390x":
  1806  			return true
  1807  		}
  1808  		return false
  1809  
  1810  	case "plugin":
  1811  		switch platform {
  1812  		case "linux/amd64", "linux/arm", "linux/arm64", "linux/386", "linux/loong64", "linux/riscv64", "linux/s390x", "linux/ppc64", "linux/ppc64le",
  1813  			"android/amd64", "android/386",
  1814  			"darwin/amd64", "darwin/arm64",
  1815  			"freebsd/amd64":
  1816  			return true
  1817  		}
  1818  		return false
  1819  
  1820  	default:
  1821  		return false
  1822  	}
  1823  }
  1824  
  1825  // isUnsupportedVMASize reports whether the failure is caused by an unsupported
  1826  // VMA for the race detector (for example, running the race detector on an
  1827  // arm64 machine configured with 39-bit VMA).
  1828  func isUnsupportedVMASize(w *work) bool {
  1829  	unsupportedVMA := []byte("unsupported VMA range")
  1830  	return strings.Contains(w.dt.name, ":race") && bytes.Contains(w.out.Bytes(), unsupportedVMA)
  1831  }
  1832  
  1833  // isEnvSet reports whether the environment variable evar is
  1834  // set in the environment.
  1835  func isEnvSet(evar string) bool {
  1836  	evarEq := evar + "="
  1837  	for _, e := range os.Environ() {
  1838  		if strings.HasPrefix(e, evarEq) {
  1839  			return true
  1840  		}
  1841  	}
  1842  	return false
  1843  }
  1844  
  1845  func (t *tester) fipsSupported() bool {
  1846  	// Keep this in sync with [crypto/internal/fips140.Supported].
  1847  
  1848  	// We don't test with the purego tag, so no need to check it.
  1849  
  1850  	// Use GOFIPS140 or GOEXPERIMENT=boringcrypto, but not both.
  1851  	if strings.Contains(goexperiment, "boringcrypto") {
  1852  		return false
  1853  	}
  1854  
  1855  	// If this goos/goarch does not support FIPS at all, return no versions.
  1856  	// The logic here matches crypto/internal/fips140/check.Supported for now.
  1857  	// In the future, if some snapshots add support for these, we will have
  1858  	// to make a decision on a per-version basis.
  1859  	switch {
  1860  	case goarch == "wasm",
  1861  		goos == "windows" && goarch == "386",
  1862  		goos == "openbsd",
  1863  		goos == "aix":
  1864  		return false
  1865  	}
  1866  
  1867  	// For now, FIPS+ASAN doesn't need to work.
  1868  	// If this is made to work, also re-enable the test in check_test.go.
  1869  	if t.asan {
  1870  		return false
  1871  	}
  1872  
  1873  	return true
  1874  }
  1875  
  1876  // fipsVersions returns the list of versions available in lib/fips140.
  1877  func fipsVersions() []string {
  1878  	var versions []string
  1879  	zips, err := filepath.Glob(filepath.Join(goroot, "lib/fips140/*.zip"))
  1880  	if err != nil {
  1881  		fatalf("%v", err)
  1882  	}
  1883  	for _, zip := range zips {
  1884  		versions = append(versions, strings.TrimSuffix(filepath.Base(zip), ".zip"))
  1885  	}
  1886  	txts, err := filepath.Glob(filepath.Join(goroot, "lib/fips140/*.txt"))
  1887  	if err != nil {
  1888  		fatalf("%v", err)
  1889  	}
  1890  	for _, txt := range txts {
  1891  		versions = append(versions, strings.TrimSuffix(filepath.Base(txt), ".txt"))
  1892  	}
  1893  	return versions
  1894  }
  1895  
  1896  // goexperiments returns the GOEXPERIMENT value to use
  1897  // when running a test with the given experiments enabled.
  1898  //
  1899  // It preserves any existing GOEXPERIMENTs.
  1900  func goexperiments(exps ...string) string {
  1901  	if len(exps) == 0 {
  1902  		return goexperiment
  1903  	}
  1904  	existing := goexperiment
  1905  	if existing != "" {
  1906  		existing += ","
  1907  	}
  1908  	return existing + strings.Join(exps, ",")
  1909  
  1910  }
  1911  

View as plain text