]> Cypherpunks.ru repositories - gostls13.git/blob - src/cmd/go/internal/modload/load.go
cmd/go: use Join functions instead of adding path separators to strings
[gostls13.git] / src / cmd / go / internal / modload / load.go
1 // Copyright 2018 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 modload
6
7 // This file contains the module-mode package loader, as well as some accessory
8 // functions pertaining to the package import graph.
9 //
10 // There are two exported entry points into package loading — LoadPackages and
11 // ImportFromFiles — both implemented in terms of loadFromRoots, which itself
12 // manipulates an instance of the loader struct.
13 //
14 // Although most of the loading state is maintained in the loader struct,
15 // one key piece - the build list - is a global, so that it can be modified
16 // separate from the loading operation, such as during "go get"
17 // upgrades/downgrades or in "go mod" operations.
18 // TODO(#40775): It might be nice to make the loader take and return
19 // a buildList rather than hard-coding use of the global.
20 //
21 // Loading is an iterative process. On each iteration, we try to load the
22 // requested packages and their transitive imports, then try to resolve modules
23 // for any imported packages that are still missing.
24 //
25 // The first step of each iteration identifies a set of “root” packages.
26 // Normally the root packages are exactly those matching the named pattern
27 // arguments. However, for the "all" meta-pattern, the final set of packages is
28 // computed from the package import graph, and therefore cannot be an initial
29 // input to loading that graph. Instead, the root packages for the "all" pattern
30 // are those contained in the main module, and allPatternIsRoot parameter to the
31 // loader instructs it to dynamically expand those roots to the full "all"
32 // pattern as loading progresses.
33 //
34 // The pkgInAll flag on each loadPkg instance tracks whether that
35 // package is known to match the "all" meta-pattern.
36 // A package matches the "all" pattern if:
37 //      - it is in the main module, or
38 //      - it is imported by any test in the main module, or
39 //      - it is imported by another package in "all", or
40 //      - the main module specifies a go version ≤ 1.15, and the package is imported
41 //        by a *test of* another package in "all".
42 //
43 // When graph pruning is in effect, we want to spot-check the graph-pruning
44 // invariants — which depend on which packages are known to be in "all" — even
45 // when we are only loading individual packages, so we set the pkgInAll flag
46 // regardless of the whether the "all" pattern is a root.
47 // (This is necessary to maintain the “import invariant” described in
48 // https://golang.org/design/36460-lazy-module-loading.)
49 //
50 // Because "go mod vendor" prunes out the tests of vendored packages, the
51 // behavior of the "all" pattern with -mod=vendor in Go 1.11–1.15 is the same
52 // as the "all" pattern (regardless of the -mod flag) in 1.16+.
53 // The loader uses the GoVersion parameter to determine whether the "all"
54 // pattern should close over tests (as in Go 1.11–1.15) or stop at only those
55 // packages transitively imported by the packages and tests in the main module
56 // ("all" in Go 1.16+ and "go mod vendor" in Go 1.11+).
57 //
58 // Note that it is possible for a loaded package NOT to be in "all" even when we
59 // are loading the "all" pattern. For example, packages that are transitive
60 // dependencies of other roots named on the command line must be loaded, but are
61 // not in "all". (The mod_notall test illustrates this behavior.)
62 // Similarly, if the LoadTests flag is set but the "all" pattern does not close
63 // over test dependencies, then when we load the test of a package that is in
64 // "all" but outside the main module, the dependencies of that test will not
65 // necessarily themselves be in "all". (That configuration does not arise in Go
66 // 1.11–1.15, but it will be possible in Go 1.16+.)
67 //
68 // Loading proceeds from the roots, using a parallel work-queue with a limit on
69 // the amount of active work (to avoid saturating disks, CPU cores, and/or
70 // network connections). Each package is added to the queue the first time it is
71 // imported by another package. When we have finished identifying the imports of
72 // a package, we add the test for that package if it is needed. A test may be
73 // needed if:
74 //      - the package matches a root pattern and tests of the roots were requested, or
75 //      - the package is in the main module and the "all" pattern is requested
76 //        (because the "all" pattern includes the dependencies of tests in the main
77 //        module), or
78 //      - the package is in "all" and the definition of "all" we are using includes
79 //        dependencies of tests (as is the case in Go ≤1.15).
80 //
81 // After all available packages have been loaded, we examine the results to
82 // identify any requested or imported packages that are still missing, and if
83 // so, which modules we could add to the module graph in order to make the
84 // missing packages available. We add those to the module graph and iterate,
85 // until either all packages resolve successfully or we cannot identify any
86 // module that would resolve any remaining missing package.
87 //
88 // If the main module is “tidy” (that is, if "go mod tidy" is a no-op for it)
89 // and all requested packages are in "all", then loading completes in a single
90 // iteration.
91 // TODO(bcmills): We should also be able to load in a single iteration if the
92 // requested packages all come from modules that are themselves tidy, regardless
93 // of whether those packages are in "all". Today, that requires two iterations
94 // if those packages are not found in existing dependencies of the main module.
95
96 import (
97         "context"
98         "errors"
99         "fmt"
100         "go/build"
101         "io/fs"
102         "os"
103         "path"
104         pathpkg "path"
105         "path/filepath"
106         "reflect"
107         "runtime"
108         "sort"
109         "strings"
110         "sync"
111         "sync/atomic"
112
113         "cmd/go/internal/base"
114         "cmd/go/internal/cfg"
115         "cmd/go/internal/fsys"
116         "cmd/go/internal/imports"
117         "cmd/go/internal/modfetch"
118         "cmd/go/internal/modindex"
119         "cmd/go/internal/mvs"
120         "cmd/go/internal/par"
121         "cmd/go/internal/search"
122         "cmd/go/internal/str"
123
124         "golang.org/x/mod/module"
125         "golang.org/x/mod/semver"
126 )
127
128 // loaded is the most recently-used package loader.
129 // It holds details about individual packages.
130 //
131 // This variable should only be accessed directly in top-level exported
132 // functions. All other functions that require or produce a *loader should pass
133 // or return it as an explicit parameter.
134 var loaded *loader
135
136 // PackageOpts control the behavior of the LoadPackages function.
137 type PackageOpts struct {
138         // GoVersion is the Go version to which the go.mod file should be updated
139         // after packages have been loaded.
140         //
141         // An empty GoVersion means to use the Go version already specified in the
142         // main module's go.mod file, or the latest Go version if there is no main
143         // module.
144         GoVersion string
145
146         // Tags are the build tags in effect (as interpreted by the
147         // cmd/go/internal/imports package).
148         // If nil, treated as equivalent to imports.Tags().
149         Tags map[string]bool
150
151         // Tidy, if true, requests that the build list and go.sum file be reduced to
152         // the minimial dependencies needed to reproducibly reload the requested
153         // packages.
154         Tidy bool
155
156         // TidyCompatibleVersion is the oldest Go version that must be able to
157         // reproducibly reload the requested packages.
158         //
159         // If empty, the compatible version is the Go version immediately prior to the
160         // 'go' version listed in the go.mod file.
161         TidyCompatibleVersion string
162
163         // VendorModulesInGOROOTSrc indicates that if we are within a module in
164         // GOROOT/src, packages in the module's vendor directory should be resolved as
165         // actual module dependencies (instead of standard-library packages).
166         VendorModulesInGOROOTSrc bool
167
168         // ResolveMissingImports indicates that we should attempt to add module
169         // dependencies as needed to resolve imports of packages that are not found.
170         //
171         // For commands that support the -mod flag, resolving imports may still fail
172         // if the flag is set to "readonly" (the default) or "vendor".
173         ResolveMissingImports bool
174
175         // AssumeRootsImported indicates that the transitive dependencies of the root
176         // packages should be treated as if those roots will be imported by the main
177         // module.
178         AssumeRootsImported bool
179
180         // AllowPackage, if non-nil, is called after identifying the module providing
181         // each package. If AllowPackage returns a non-nil error, that error is set
182         // for the package, and the imports and test of that package will not be
183         // loaded.
184         //
185         // AllowPackage may be invoked concurrently by multiple goroutines,
186         // and may be invoked multiple times for a given package path.
187         AllowPackage func(ctx context.Context, path string, mod module.Version) error
188
189         // LoadTests loads the test dependencies of each package matching a requested
190         // pattern. If ResolveMissingImports is also true, test dependencies will be
191         // resolved if missing.
192         LoadTests bool
193
194         // UseVendorAll causes the "all" package pattern to be interpreted as if
195         // running "go mod vendor" (or building with "-mod=vendor").
196         //
197         // This is a no-op for modules that declare 'go 1.16' or higher, for which this
198         // is the default (and only) interpretation of the "all" pattern in module mode.
199         UseVendorAll bool
200
201         // AllowErrors indicates that LoadPackages should not terminate the process if
202         // an error occurs.
203         AllowErrors bool
204
205         // SilencePackageErrors indicates that LoadPackages should not print errors
206         // that occur while matching or loading packages, and should not terminate the
207         // process if such an error occurs.
208         //
209         // Errors encountered in the module graph will still be reported.
210         //
211         // The caller may retrieve the silenced package errors using the Lookup
212         // function, and matching errors are still populated in the Errs field of the
213         // associated search.Match.)
214         SilencePackageErrors bool
215
216         // SilenceMissingStdImports indicates that LoadPackages should not print
217         // errors or terminate the process if an imported package is missing, and the
218         // import path looks like it might be in the standard library (perhaps in a
219         // future version).
220         SilenceMissingStdImports bool
221
222         // SilenceNoGoErrors indicates that LoadPackages should not print
223         // imports.ErrNoGo errors.
224         // This allows the caller to invoke LoadPackages (and report other errors)
225         // without knowing whether the requested packages exist for the given tags.
226         //
227         // Note that if a requested package does not exist *at all*, it will fail
228         // during module resolution and the error will not be suppressed.
229         SilenceNoGoErrors bool
230
231         // SilenceUnmatchedWarnings suppresses the warnings normally emitted for
232         // patterns that did not match any packages.
233         SilenceUnmatchedWarnings bool
234
235         // Resolve the query against this module.
236         MainModule module.Version
237 }
238
239 // LoadPackages identifies the set of packages matching the given patterns and
240 // loads the packages in the import graph rooted at that set.
241 func LoadPackages(ctx context.Context, opts PackageOpts, patterns ...string) (matches []*search.Match, loadedPackages []string) {
242         if opts.Tags == nil {
243                 opts.Tags = imports.Tags()
244         }
245
246         patterns = search.CleanPatterns(patterns)
247         matches = make([]*search.Match, 0, len(patterns))
248         allPatternIsRoot := false
249         for _, pattern := range patterns {
250                 matches = append(matches, search.NewMatch(pattern))
251                 if pattern == "all" {
252                         allPatternIsRoot = true
253                 }
254         }
255
256         updateMatches := func(rs *Requirements, ld *loader) {
257                 for _, m := range matches {
258                         switch {
259                         case m.IsLocal():
260                                 // Evaluate list of file system directories on first iteration.
261                                 if m.Dirs == nil {
262                                         matchModRoots := modRoots
263                                         if opts.MainModule != (module.Version{}) {
264                                                 matchModRoots = []string{MainModules.ModRoot(opts.MainModule)}
265                                         }
266                                         matchLocalDirs(ctx, matchModRoots, m, rs)
267                                 }
268
269                                 // Make a copy of the directory list and translate to import paths.
270                                 // Note that whether a directory corresponds to an import path
271                                 // changes as the build list is updated, and a directory can change
272                                 // from not being in the build list to being in it and back as
273                                 // the exact version of a particular module increases during
274                                 // the loader iterations.
275                                 m.Pkgs = m.Pkgs[:0]
276                                 for _, dir := range m.Dirs {
277                                         pkg, err := resolveLocalPackage(ctx, dir, rs)
278                                         if err != nil {
279                                                 if !m.IsLiteral() && (err == errPkgIsBuiltin || err == errPkgIsGorootSrc) {
280                                                         continue // Don't include "builtin" or GOROOT/src in wildcard patterns.
281                                                 }
282
283                                                 // If we're outside of a module, ensure that the failure mode
284                                                 // indicates that.
285                                                 if !HasModRoot() {
286                                                         die()
287                                                 }
288
289                                                 if ld != nil {
290                                                         m.AddError(err)
291                                                 }
292                                                 continue
293                                         }
294                                         m.Pkgs = append(m.Pkgs, pkg)
295                                 }
296
297                         case m.IsLiteral():
298                                 m.Pkgs = []string{m.Pattern()}
299
300                         case strings.Contains(m.Pattern(), "..."):
301                                 m.Errs = m.Errs[:0]
302                                 mg, err := rs.Graph(ctx)
303                                 if err != nil {
304                                         // The module graph is (or may be) incomplete — perhaps we failed to
305                                         // load the requirements of some module. This is an error in matching
306                                         // the patterns to packages, because we may be missing some packages
307                                         // or we may erroneously match packages in the wrong versions of
308                                         // modules. However, for cases like 'go list -e', the error should not
309                                         // necessarily prevent us from loading the packages we could find.
310                                         m.Errs = append(m.Errs, err)
311                                 }
312                                 matchPackages(ctx, m, opts.Tags, includeStd, mg.BuildList())
313
314                         case m.Pattern() == "all":
315                                 if ld == nil {
316                                         // The initial roots are the packages in the main module.
317                                         // loadFromRoots will expand that to "all".
318                                         m.Errs = m.Errs[:0]
319                                         matchModules := MainModules.Versions()
320                                         if opts.MainModule != (module.Version{}) {
321                                                 matchModules = []module.Version{opts.MainModule}
322                                         }
323                                         matchPackages(ctx, m, opts.Tags, omitStd, matchModules)
324                                 } else {
325                                         // Starting with the packages in the main module,
326                                         // enumerate the full list of "all".
327                                         m.Pkgs = ld.computePatternAll()
328                                 }
329
330                         case m.Pattern() == "std" || m.Pattern() == "cmd":
331                                 if m.Pkgs == nil {
332                                         m.MatchPackages() // Locate the packages within GOROOT/src.
333                                 }
334
335                         default:
336                                 panic(fmt.Sprintf("internal error: modload missing case for pattern %s", m.Pattern()))
337                         }
338                 }
339         }
340
341         initialRS := LoadModFile(ctx)
342
343         ld := loadFromRoots(ctx, loaderParams{
344                 PackageOpts:  opts,
345                 requirements: initialRS,
346
347                 allPatternIsRoot: allPatternIsRoot,
348
349                 listRoots: func(rs *Requirements) (roots []string) {
350                         updateMatches(rs, nil)
351                         for _, m := range matches {
352                                 roots = append(roots, m.Pkgs...)
353                         }
354                         return roots
355                 },
356         })
357
358         // One last pass to finalize wildcards.
359         updateMatches(ld.requirements, ld)
360
361         // List errors in matching patterns (such as directory permission
362         // errors for wildcard patterns).
363         if !ld.SilencePackageErrors {
364                 for _, match := range matches {
365                         for _, err := range match.Errs {
366                                 ld.errorf("%v\n", err)
367                         }
368                 }
369         }
370         base.ExitIfErrors()
371
372         if !opts.SilenceUnmatchedWarnings {
373                 search.WarnUnmatched(matches)
374         }
375
376         if opts.Tidy {
377                 if cfg.BuildV {
378                         mg, _ := ld.requirements.Graph(ctx)
379
380                         for _, m := range initialRS.rootModules {
381                                 var unused bool
382                                 if ld.requirements.pruning == unpruned {
383                                         // m is unused if it was dropped from the module graph entirely. If it
384                                         // was only demoted from direct to indirect, it may still be in use via
385                                         // a transitive import.
386                                         unused = mg.Selected(m.Path) == "none"
387                                 } else {
388                                         // m is unused if it was dropped from the roots. If it is still present
389                                         // as a transitive dependency, that transitive dependency is not needed
390                                         // by any package or test in the main module.
391                                         _, ok := ld.requirements.rootSelected(m.Path)
392                                         unused = !ok
393                                 }
394                                 if unused {
395                                         fmt.Fprintf(os.Stderr, "unused %s\n", m.Path)
396                                 }
397                         }
398                 }
399
400                 keep := keepSums(ctx, ld, ld.requirements, loadedZipSumsOnly)
401                 if compatDepth := pruningForGoVersion(ld.TidyCompatibleVersion); compatDepth != ld.requirements.pruning {
402                         compatRS := newRequirements(compatDepth, ld.requirements.rootModules, ld.requirements.direct)
403                         ld.checkTidyCompatibility(ctx, compatRS)
404
405                         for m := range keepSums(ctx, ld, compatRS, loadedZipSumsOnly) {
406                                 keep[m] = true
407                         }
408                 }
409
410                 if !ExplicitWriteGoMod {
411                         modfetch.TrimGoSum(keep)
412
413                         // commitRequirements below will also call WriteGoSum, but the "keep" map
414                         // we have here could be strictly larger: commitRequirements only commits
415                         // loaded.requirements, but here we may have also loaded (and want to
416                         // preserve checksums for) additional entities from compatRS, which are
417                         // only needed for compatibility with ld.TidyCompatibleVersion.
418                         if err := modfetch.WriteGoSum(keep, mustHaveCompleteRequirements()); err != nil {
419                                 base.Fatalf("go: %v", err)
420                         }
421                 }
422
423                 // Update the go.mod file's Go version if necessary.
424                 if modFile := ModFile(); modFile != nil && ld.GoVersion != "" {
425                         modFile.AddGoStmt(ld.GoVersion)
426                 }
427         }
428
429         // Success! Update go.mod and go.sum (if needed) and return the results.
430         // We'll skip updating if ExplicitWriteGoMod is true (the caller has opted
431         // to call WriteGoMod itself) or if ResolveMissingImports is false (the
432         // command wants to examine the package graph as-is).
433         loaded = ld
434         requirements = loaded.requirements
435
436         for _, pkg := range ld.pkgs {
437                 if !pkg.isTest() {
438                         loadedPackages = append(loadedPackages, pkg.path)
439                 }
440         }
441         sort.Strings(loadedPackages)
442
443         if !ExplicitWriteGoMod && opts.ResolveMissingImports {
444                 if err := commitRequirements(ctx); err != nil {
445                         base.Fatalf("go: %v", err)
446                 }
447         }
448
449         return matches, loadedPackages
450 }
451
452 // matchLocalDirs is like m.MatchDirs, but tries to avoid scanning directories
453 // outside of the standard library and active modules.
454 func matchLocalDirs(ctx context.Context, modRoots []string, m *search.Match, rs *Requirements) {
455         if !m.IsLocal() {
456                 panic(fmt.Sprintf("internal error: resolveLocalDirs on non-local pattern %s", m.Pattern()))
457         }
458
459         if i := strings.Index(m.Pattern(), "..."); i >= 0 {
460                 // The pattern is local, but it is a wildcard. Its packages will
461                 // only resolve to paths if they are inside of the standard
462                 // library, the main module, or some dependency of the main
463                 // module. Verify that before we walk the filesystem: a filesystem
464                 // walk in a directory like /var or /etc can be very expensive!
465                 dir := filepath.Dir(filepath.Clean(m.Pattern()[:i+3]))
466                 absDir := dir
467                 if !filepath.IsAbs(dir) {
468                         absDir = filepath.Join(base.Cwd(), dir)
469                 }
470
471                 modRoot := findModuleRoot(absDir)
472                 found := false
473                 for _, mainModuleRoot := range modRoots {
474                         if mainModuleRoot == modRoot {
475                                 found = true
476                                 break
477                         }
478                 }
479                 if !found && search.InDir(absDir, cfg.GOROOTsrc) == "" && pathInModuleCache(ctx, absDir, rs) == "" {
480                         m.Dirs = []string{}
481                         scope := "main module or its selected dependencies"
482                         if inWorkspaceMode() {
483                                 scope = "modules listed in go.work or their selected dependencies"
484                         }
485                         m.AddError(fmt.Errorf("directory prefix %s does not contain %s", base.ShortPath(absDir), scope))
486                         return
487                 }
488         }
489
490         m.MatchDirs(modRoots)
491 }
492
493 // resolveLocalPackage resolves a filesystem path to a package path.
494 func resolveLocalPackage(ctx context.Context, dir string, rs *Requirements) (string, error) {
495         var absDir string
496         if filepath.IsAbs(dir) {
497                 absDir = filepath.Clean(dir)
498         } else {
499                 absDir = filepath.Join(base.Cwd(), dir)
500         }
501
502         bp, err := cfg.BuildContext.ImportDir(absDir, 0)
503         if err != nil && (bp == nil || len(bp.IgnoredGoFiles) == 0) {
504                 // golang.org/issue/32917: We should resolve a relative path to a
505                 // package path only if the relative path actually contains the code
506                 // for that package.
507                 //
508                 // If the named directory does not exist or contains no Go files,
509                 // the package does not exist.
510                 // Other errors may affect package loading, but not resolution.
511                 if _, err := fsys.Stat(absDir); err != nil {
512                         if os.IsNotExist(err) {
513                                 // Canonicalize OS-specific errors to errDirectoryNotFound so that error
514                                 // messages will be easier for users to search for.
515                                 return "", &fs.PathError{Op: "stat", Path: absDir, Err: errDirectoryNotFound}
516                         }
517                         return "", err
518                 }
519                 if _, noGo := err.(*build.NoGoError); noGo {
520                         // A directory that does not contain any Go source files — even ignored
521                         // ones! — is not a Go package, and we can't resolve it to a package
522                         // path because that path could plausibly be provided by some other
523                         // module.
524                         //
525                         // Any other error indicates that the package “exists” (at least in the
526                         // sense that it cannot exist in any other module), but has some other
527                         // problem (such as a syntax error).
528                         return "", err
529                 }
530         }
531
532         for _, mod := range MainModules.Versions() {
533                 modRoot := MainModules.ModRoot(mod)
534                 if modRoot != "" && absDir == modRoot {
535                         if absDir == cfg.GOROOTsrc {
536                                 return "", errPkgIsGorootSrc
537                         }
538                         return MainModules.PathPrefix(mod), nil
539                 }
540         }
541
542         // Note: The checks for @ here are just to avoid misinterpreting
543         // the module cache directories (formerly GOPATH/src/mod/foo@v1.5.2/bar).
544         // It's not strictly necessary but helpful to keep the checks.
545         var pkgNotFoundErr error
546         pkgNotFoundLongestPrefix := ""
547         for _, mainModule := range MainModules.Versions() {
548                 modRoot := MainModules.ModRoot(mainModule)
549                 if modRoot != "" && str.HasFilePathPrefix(absDir, modRoot) && !strings.Contains(absDir[len(modRoot):], "@") {
550                         suffix := filepath.ToSlash(str.TrimFilePathPrefix(absDir, modRoot))
551                         if pkg, found := strings.CutPrefix(suffix, "vendor/"); found {
552                                 if cfg.BuildMod != "vendor" {
553                                         return "", fmt.Errorf("without -mod=vendor, directory %s has no package path", absDir)
554                                 }
555
556                                 readVendorList(mainModule)
557                                 if _, ok := vendorPkgModule[pkg]; !ok {
558                                         return "", fmt.Errorf("directory %s is not a package listed in vendor/modules.txt", absDir)
559                                 }
560                                 return pkg, nil
561                         }
562
563                         mainModulePrefix := MainModules.PathPrefix(mainModule)
564                         if mainModulePrefix == "" {
565                                 pkg := suffix
566                                 if pkg == "builtin" {
567                                         // "builtin" is a pseudo-package with a real source file.
568                                         // It's not included in "std", so it shouldn't resolve from "."
569                                         // within module "std" either.
570                                         return "", errPkgIsBuiltin
571                                 }
572                                 return pkg, nil
573                         }
574
575                         pkg := pathpkg.Join(mainModulePrefix, suffix)
576                         if _, ok, err := dirInModule(pkg, mainModulePrefix, modRoot, true); err != nil {
577                                 return "", err
578                         } else if !ok {
579                                 // This main module could contain the directory but doesn't. Other main
580                                 // modules might contain the directory, so wait till we finish the loop
581                                 // to see if another main module contains directory. But if not,
582                                 // return an error.
583                                 if len(mainModulePrefix) > len(pkgNotFoundLongestPrefix) {
584                                         pkgNotFoundLongestPrefix = mainModulePrefix
585                                         pkgNotFoundErr = &PackageNotInModuleError{MainModules: []module.Version{mainModule}, Pattern: pkg}
586                                 }
587                                 continue
588                         }
589                         return pkg, nil
590                 }
591         }
592         if pkgNotFoundErr != nil {
593                 return "", pkgNotFoundErr
594         }
595
596         if sub := search.InDir(absDir, cfg.GOROOTsrc); sub != "" && sub != "." && !strings.Contains(sub, "@") {
597                 pkg := filepath.ToSlash(sub)
598                 if pkg == "builtin" {
599                         return "", errPkgIsBuiltin
600                 }
601                 return pkg, nil
602         }
603
604         pkg := pathInModuleCache(ctx, absDir, rs)
605         if pkg == "" {
606                 dirstr := fmt.Sprintf("directory %s", base.ShortPath(absDir))
607                 if dirstr == "directory ." {
608                         dirstr = "current directory"
609                 }
610                 if inWorkspaceMode() {
611                         if mr := findModuleRoot(absDir); mr != "" {
612                                 return "", fmt.Errorf("%s is contained in a module that is not one of the workspace modules listed in go.work. You can add the module to the workspace using:\n\tgo work use %s", dirstr, base.ShortPath(mr))
613                         }
614                         return "", fmt.Errorf("%s outside modules listed in go.work or their selected dependencies", dirstr)
615                 }
616                 return "", fmt.Errorf("%s outside main module or its selected dependencies", dirstr)
617         }
618         return pkg, nil
619 }
620
621 var (
622         errDirectoryNotFound = errors.New("directory not found")
623         errPkgIsGorootSrc    = errors.New("GOROOT/src is not an importable package")
624         errPkgIsBuiltin      = errors.New(`"builtin" is a pseudo-package, not an importable package`)
625 )
626
627 // pathInModuleCache returns the import path of the directory dir,
628 // if dir is in the module cache copy of a module in our build list.
629 func pathInModuleCache(ctx context.Context, dir string, rs *Requirements) string {
630         tryMod := func(m module.Version) (string, bool) {
631                 var root string
632                 var err error
633                 if repl := Replacement(m); repl.Path != "" && repl.Version == "" {
634                         root = repl.Path
635                         if !filepath.IsAbs(root) {
636                                 root = filepath.Join(replaceRelativeTo(), root)
637                         }
638                 } else if repl.Path != "" {
639                         root, err = modfetch.DownloadDir(repl)
640                 } else {
641                         root, err = modfetch.DownloadDir(m)
642                 }
643                 if err != nil {
644                         return "", false
645                 }
646
647                 sub := search.InDir(dir, root)
648                 if sub == "" {
649                         return "", false
650                 }
651                 sub = filepath.ToSlash(sub)
652                 if strings.Contains(sub, "/vendor/") || strings.HasPrefix(sub, "vendor/") || strings.Contains(sub, "@") {
653                         return "", false
654                 }
655
656                 return path.Join(m.Path, filepath.ToSlash(sub)), true
657         }
658
659         if rs.pruning == pruned {
660                 for _, m := range rs.rootModules {
661                         if v, _ := rs.rootSelected(m.Path); v != m.Version {
662                                 continue // m is a root, but we have a higher root for the same path.
663                         }
664                         if importPath, ok := tryMod(m); ok {
665                                 // checkMultiplePaths ensures that a module can be used for at most one
666                                 // requirement, so this must be it.
667                                 return importPath
668                         }
669                 }
670         }
671
672         // None of the roots contained dir, or the graph is unpruned (so we don't want
673         // to distinguish between roots and transitive dependencies). Either way,
674         // check the full graph to see if the directory is a non-root dependency.
675         //
676         // If the roots are not consistent with the full module graph, the selected
677         // versions of root modules may differ from what we already checked above.
678         // Re-check those paths too.
679
680         mg, _ := rs.Graph(ctx)
681         var importPath string
682         for _, m := range mg.BuildList() {
683                 var found bool
684                 importPath, found = tryMod(m)
685                 if found {
686                         break
687                 }
688         }
689         return importPath
690 }
691
692 // ImportFromFiles adds modules to the build list as needed
693 // to satisfy the imports in the named Go source files.
694 //
695 // Errors in missing dependencies are silenced.
696 //
697 // TODO(bcmills): Silencing errors seems off. Take a closer look at this and
698 // figure out what the error-reporting actually ought to be.
699 func ImportFromFiles(ctx context.Context, gofiles []string) {
700         rs := LoadModFile(ctx)
701
702         tags := imports.Tags()
703         imports, testImports, err := imports.ScanFiles(gofiles, tags)
704         if err != nil {
705                 base.Fatalf("go: %v", err)
706         }
707
708         loaded = loadFromRoots(ctx, loaderParams{
709                 PackageOpts: PackageOpts{
710                         Tags:                  tags,
711                         ResolveMissingImports: true,
712                         SilencePackageErrors:  true,
713                 },
714                 requirements: rs,
715                 listRoots: func(*Requirements) (roots []string) {
716                         roots = append(roots, imports...)
717                         roots = append(roots, testImports...)
718                         return roots
719                 },
720         })
721         requirements = loaded.requirements
722
723         if !ExplicitWriteGoMod {
724                 if err := commitRequirements(ctx); err != nil {
725                         base.Fatalf("go: %v", err)
726                 }
727         }
728 }
729
730 // DirImportPath returns the effective import path for dir,
731 // provided it is within a main module, or else returns ".".
732 func (mms *MainModuleSet) DirImportPath(ctx context.Context, dir string) (path string, m module.Version) {
733         if !HasModRoot() {
734                 return ".", module.Version{}
735         }
736         LoadModFile(ctx) // Sets targetPrefix.
737
738         if !filepath.IsAbs(dir) {
739                 dir = filepath.Join(base.Cwd(), dir)
740         } else {
741                 dir = filepath.Clean(dir)
742         }
743
744         var longestPrefix string
745         var longestPrefixPath string
746         var longestPrefixVersion module.Version
747         for _, v := range mms.Versions() {
748                 modRoot := mms.ModRoot(v)
749                 if dir == modRoot {
750                         return mms.PathPrefix(v), v
751                 }
752                 if str.HasFilePathPrefix(dir, modRoot) {
753                         pathPrefix := MainModules.PathPrefix(v)
754                         if pathPrefix > longestPrefix {
755                                 longestPrefix = pathPrefix
756                                 longestPrefixVersion = v
757                                 suffix := filepath.ToSlash(str.TrimFilePathPrefix(dir, modRoot))
758                                 if strings.HasPrefix(suffix, "vendor/") {
759                                         longestPrefixPath = strings.TrimPrefix(suffix, "vendor/")
760                                         continue
761                                 }
762                                 longestPrefixPath = pathpkg.Join(mms.PathPrefix(v), suffix)
763                         }
764                 }
765         }
766         if len(longestPrefix) > 0 {
767                 return longestPrefixPath, longestPrefixVersion
768         }
769
770         return ".", module.Version{}
771 }
772
773 // PackageModule returns the module providing the package named by the import path.
774 func PackageModule(path string) module.Version {
775         pkg, ok := loaded.pkgCache.Get(path).(*loadPkg)
776         if !ok {
777                 return module.Version{}
778         }
779         return pkg.mod
780 }
781
782 // Lookup returns the source directory, import path, and any loading error for
783 // the package at path as imported from the package in parentDir.
784 // Lookup requires that one of the Load functions in this package has already
785 // been called.
786 func Lookup(parentPath string, parentIsStd bool, path string) (dir, realPath string, err error) {
787         if path == "" {
788                 panic("Lookup called with empty package path")
789         }
790
791         if parentIsStd {
792                 path = loaded.stdVendor(parentPath, path)
793         }
794         pkg, ok := loaded.pkgCache.Get(path).(*loadPkg)
795         if !ok {
796                 // The loader should have found all the relevant paths.
797                 // There are a few exceptions, though:
798                 //      - during go list without -test, the p.Resolve calls to process p.TestImports and p.XTestImports
799                 //        end up here to canonicalize the import paths.
800                 //      - during any load, non-loaded packages like "unsafe" end up here.
801                 //      - during any load, build-injected dependencies like "runtime/cgo" end up here.
802                 //      - because we ignore appengine/* in the module loader,
803                 //        the dependencies of any actual appengine/* library end up here.
804                 dir := findStandardImportPath(path)
805                 if dir != "" {
806                         return dir, path, nil
807                 }
808                 return "", "", errMissing
809         }
810         return pkg.dir, pkg.path, pkg.err
811 }
812
813 // A loader manages the process of loading information about
814 // the required packages for a particular build,
815 // checking that the packages are available in the module set,
816 // and updating the module set if needed.
817 type loader struct {
818         loaderParams
819
820         // allClosesOverTests indicates whether the "all" pattern includes
821         // dependencies of tests outside the main module (as in Go 1.11–1.15).
822         // (Otherwise — as in Go 1.16+ — the "all" pattern includes only the packages
823         // transitively *imported by* the packages and tests in the main module.)
824         allClosesOverTests bool
825
826         work *par.Queue
827
828         // reset on each iteration
829         roots    []*loadPkg
830         pkgCache *par.Cache // package path (string) → *loadPkg
831         pkgs     []*loadPkg // transitive closure of loaded packages and tests; populated in buildStacks
832 }
833
834 // loaderParams configure the packages loaded by, and the properties reported
835 // by, a loader instance.
836 type loaderParams struct {
837         PackageOpts
838         requirements *Requirements
839
840         allPatternIsRoot bool // Is the "all" pattern an additional root?
841
842         listRoots func(rs *Requirements) []string
843 }
844
845 func (ld *loader) reset() {
846         select {
847         case <-ld.work.Idle():
848         default:
849                 panic("loader.reset when not idle")
850         }
851
852         ld.roots = nil
853         ld.pkgCache = new(par.Cache)
854         ld.pkgs = nil
855 }
856
857 // errorf reports an error via either os.Stderr or base.Errorf,
858 // according to whether ld.AllowErrors is set.
859 func (ld *loader) errorf(format string, args ...any) {
860         if ld.AllowErrors {
861                 fmt.Fprintf(os.Stderr, format, args...)
862         } else {
863                 base.Errorf(format, args...)
864         }
865 }
866
867 // A loadPkg records information about a single loaded package.
868 type loadPkg struct {
869         // Populated at construction time:
870         path   string // import path
871         testOf *loadPkg
872
873         // Populated at construction time and updated by (*loader).applyPkgFlags:
874         flags atomicLoadPkgFlags
875
876         // Populated by (*loader).load:
877         mod         module.Version // module providing package
878         dir         string         // directory containing source code
879         err         error          // error loading package
880         imports     []*loadPkg     // packages imported by this one
881         testImports []string       // test-only imports, saved for use by pkg.test.
882         inStd       bool
883         altMods     []module.Version // modules that could have contained the package but did not
884
885         // Populated by (*loader).pkgTest:
886         testOnce sync.Once
887         test     *loadPkg
888
889         // Populated by postprocessing in (*loader).buildStacks:
890         stack *loadPkg // package importing this one in minimal import stack for this pkg
891 }
892
893 // loadPkgFlags is a set of flags tracking metadata about a package.
894 type loadPkgFlags int8
895
896 const (
897         // pkgInAll indicates that the package is in the "all" package pattern,
898         // regardless of whether we are loading the "all" package pattern.
899         //
900         // When the pkgInAll flag and pkgImportsLoaded flags are both set, the caller
901         // who set the last of those flags must propagate the pkgInAll marking to all
902         // of the imports of the marked package.
903         //
904         // A test is marked with pkgInAll if that test would promote the packages it
905         // imports to be in "all" (such as when the test is itself within the main
906         // module, or when ld.allClosesOverTests is true).
907         pkgInAll loadPkgFlags = 1 << iota
908
909         // pkgIsRoot indicates that the package matches one of the root package
910         // patterns requested by the caller.
911         //
912         // If LoadTests is set, then when pkgIsRoot and pkgImportsLoaded are both set,
913         // the caller who set the last of those flags must populate a test for the
914         // package (in the pkg.test field).
915         //
916         // If the "all" pattern is included as a root, then non-test packages in "all"
917         // are also roots (and must be marked pkgIsRoot).
918         pkgIsRoot
919
920         // pkgFromRoot indicates that the package is in the transitive closure of
921         // imports starting at the roots. (Note that every package marked as pkgIsRoot
922         // is also trivially marked pkgFromRoot.)
923         pkgFromRoot
924
925         // pkgImportsLoaded indicates that the imports and testImports fields of a
926         // loadPkg have been populated.
927         pkgImportsLoaded
928 )
929
930 // has reports whether all of the flags in cond are set in f.
931 func (f loadPkgFlags) has(cond loadPkgFlags) bool {
932         return f&cond == cond
933 }
934
935 // An atomicLoadPkgFlags stores a loadPkgFlags for which individual flags can be
936 // added atomically.
937 type atomicLoadPkgFlags struct {
938         bits atomic.Int32
939 }
940
941 // update sets the given flags in af (in addition to any flags already set).
942 //
943 // update returns the previous flag state so that the caller may determine which
944 // flags were newly-set.
945 func (af *atomicLoadPkgFlags) update(flags loadPkgFlags) (old loadPkgFlags) {
946         for {
947                 old := af.bits.Load()
948                 new := old | int32(flags)
949                 if new == old || af.bits.CompareAndSwap(old, new) {
950                         return loadPkgFlags(old)
951                 }
952         }
953 }
954
955 // has reports whether all of the flags in cond are set in af.
956 func (af *atomicLoadPkgFlags) has(cond loadPkgFlags) bool {
957         return loadPkgFlags(af.bits.Load())&cond == cond
958 }
959
960 // isTest reports whether pkg is a test of another package.
961 func (pkg *loadPkg) isTest() bool {
962         return pkg.testOf != nil
963 }
964
965 // fromExternalModule reports whether pkg was loaded from a module other than
966 // the main module.
967 func (pkg *loadPkg) fromExternalModule() bool {
968         if pkg.mod.Path == "" {
969                 return false // loaded from the standard library, not a module
970         }
971         return !MainModules.Contains(pkg.mod.Path)
972 }
973
974 var errMissing = errors.New("cannot find package")
975
976 // loadFromRoots attempts to load the build graph needed to process a set of
977 // root packages and their dependencies.
978 //
979 // The set of root packages is returned by the params.listRoots function, and
980 // expanded to the full set of packages by tracing imports (and possibly tests)
981 // as needed.
982 func loadFromRoots(ctx context.Context, params loaderParams) *loader {
983         ld := &loader{
984                 loaderParams: params,
985                 work:         par.NewQueue(runtime.GOMAXPROCS(0)),
986         }
987
988         if ld.GoVersion == "" {
989                 ld.GoVersion = MainModules.GoVersion()
990
991                 if ld.Tidy && versionLess(LatestGoVersion(), ld.GoVersion) {
992                         ld.errorf("go: go.mod file indicates go %s, but maximum version supported by tidy is %s\n", ld.GoVersion, LatestGoVersion())
993                         base.ExitIfErrors()
994                 }
995         }
996
997         if ld.Tidy {
998                 if ld.TidyCompatibleVersion == "" {
999                         ld.TidyCompatibleVersion = priorGoVersion(ld.GoVersion)
1000                 } else if versionLess(ld.GoVersion, ld.TidyCompatibleVersion) {
1001                         // Each version of the Go toolchain knows how to interpret go.mod and
1002                         // go.sum files produced by all previous versions, so a compatibility
1003                         // version higher than the go.mod version adds nothing.
1004                         ld.TidyCompatibleVersion = ld.GoVersion
1005                 }
1006         }
1007
1008         if semver.Compare("v"+ld.GoVersion, narrowAllVersionV) < 0 && !ld.UseVendorAll {
1009                 // The module's go version explicitly predates the change in "all" for graph
1010                 // pruning, so continue to use the older interpretation.
1011                 ld.allClosesOverTests = true
1012         }
1013
1014         var err error
1015         desiredPruning := pruningForGoVersion(ld.GoVersion)
1016         if ld.requirements.pruning == workspace {
1017                 desiredPruning = workspace
1018         }
1019         ld.requirements, err = convertPruning(ctx, ld.requirements, desiredPruning)
1020         if err != nil {
1021                 ld.errorf("go: %v\n", err)
1022         }
1023
1024         if ld.requirements.pruning == unpruned {
1025                 // If the module graph does not support pruning, we assume that we will need
1026                 // the full module graph in order to load package dependencies.
1027                 //
1028                 // This might not be strictly necessary, but it matches the historical
1029                 // behavior of the 'go' command and keeps the go.mod file more consistent in
1030                 // case of erroneous hand-edits — which are less likely to be detected by
1031                 // spot-checks in modules that do not maintain the expanded go.mod
1032                 // requirements needed for graph pruning.
1033                 var err error
1034                 ld.requirements, _, err = expandGraph(ctx, ld.requirements)
1035                 if err != nil {
1036                         ld.errorf("go: %v\n", err)
1037                 }
1038         }
1039
1040         for {
1041                 ld.reset()
1042
1043                 // Load the root packages and their imports.
1044                 // Note: the returned roots can change on each iteration,
1045                 // since the expansion of package patterns depends on the
1046                 // build list we're using.
1047                 rootPkgs := ld.listRoots(ld.requirements)
1048
1049                 if ld.requirements.pruning == pruned && cfg.BuildMod == "mod" {
1050                         // Before we start loading transitive imports of packages, locate all of
1051                         // the root packages and promote their containing modules to root modules
1052                         // dependencies. If their go.mod files are tidy (the common case) and the
1053                         // set of root packages does not change then we can select the correct
1054                         // versions of all transitive imports on the first try and complete
1055                         // loading in a single iteration.
1056                         changedBuildList := ld.preloadRootModules(ctx, rootPkgs)
1057                         if changedBuildList {
1058                                 // The build list has changed, so the set of root packages may have also
1059                                 // changed. Start over to pick up the changes. (Preloading roots is much
1060                                 // cheaper than loading the full import graph, so we would rather pay
1061                                 // for an extra iteration of preloading than potentially end up
1062                                 // discarding the result of a full iteration of loading.)
1063                                 continue
1064                         }
1065                 }
1066
1067                 inRoots := map[*loadPkg]bool{}
1068                 for _, path := range rootPkgs {
1069                         root := ld.pkg(ctx, path, pkgIsRoot)
1070                         if !inRoots[root] {
1071                                 ld.roots = append(ld.roots, root)
1072                                 inRoots[root] = true
1073                         }
1074                 }
1075
1076                 // ld.pkg adds imported packages to the work queue and calls applyPkgFlags,
1077                 // which adds tests (and test dependencies) as needed.
1078                 //
1079                 // When all of the work in the queue has completed, we'll know that the
1080                 // transitive closure of dependencies has been loaded.
1081                 <-ld.work.Idle()
1082
1083                 ld.buildStacks()
1084
1085                 changed, err := ld.updateRequirements(ctx)
1086                 if err != nil {
1087                         ld.errorf("go: %v\n", err)
1088                         break
1089                 }
1090                 if changed {
1091                         // Don't resolve missing imports until the module graph has stabilized.
1092                         // If the roots are still changing, they may turn out to specify a
1093                         // requirement on the missing package(s), and we would rather use a
1094                         // version specified by a new root than add a new dependency on an
1095                         // unrelated version.
1096                         continue
1097                 }
1098
1099                 if !ld.ResolveMissingImports || (!HasModRoot() && !allowMissingModuleImports) {
1100                         // We've loaded as much as we can without resolving missing imports.
1101                         break
1102                 }
1103
1104                 modAddedBy := ld.resolveMissingImports(ctx)
1105                 if len(modAddedBy) == 0 {
1106                         // The roots are stable, and we've resolved all of the missing packages
1107                         // that we can.
1108                         break
1109                 }
1110
1111                 toAdd := make([]module.Version, 0, len(modAddedBy))
1112                 for m := range modAddedBy {
1113                         toAdd = append(toAdd, m)
1114                 }
1115                 module.Sort(toAdd) // to make errors deterministic
1116
1117                 // We ran updateRequirements before resolving missing imports and it didn't
1118                 // make any changes, so we know that the requirement graph is already
1119                 // consistent with ld.pkgs: we don't need to pass ld.pkgs to updateRoots
1120                 // again. (That would waste time looking for changes that we have already
1121                 // applied.)
1122                 var noPkgs []*loadPkg
1123                 // We also know that we're going to call updateRequirements again next
1124                 // iteration so we don't need to also update it here. (That would waste time
1125                 // computing a "direct" map that we'll have to recompute later anyway.)
1126                 direct := ld.requirements.direct
1127                 rs, err := updateRoots(ctx, direct, ld.requirements, noPkgs, toAdd, ld.AssumeRootsImported)
1128                 if err != nil {
1129                         // If an error was found in a newly added module, report the package
1130                         // import stack instead of the module requirement stack. Packages
1131                         // are more descriptive.
1132                         if err, ok := err.(*mvs.BuildListError); ok {
1133                                 if pkg := modAddedBy[err.Module()]; pkg != nil {
1134                                         ld.errorf("go: %s: %v\n", pkg.stackText(), err.Err)
1135                                         break
1136                                 }
1137                         }
1138                         ld.errorf("go: %v\n", err)
1139                         break
1140                 }
1141                 if reflect.DeepEqual(rs.rootModules, ld.requirements.rootModules) {
1142                         // Something is deeply wrong. resolveMissingImports gave us a non-empty
1143                         // set of modules to add to the graph, but adding those modules had no
1144                         // effect — either they were already in the graph, or updateRoots did not
1145                         // add them as requested.
1146                         panic(fmt.Sprintf("internal error: adding %v to module graph had no effect on root requirements (%v)", toAdd, rs.rootModules))
1147                 }
1148                 ld.requirements = rs
1149         }
1150         base.ExitIfErrors() // TODO(bcmills): Is this actually needed?
1151
1152         // Tidy the build list, if applicable, before we report errors.
1153         // (The process of tidying may remove errors from irrelevant dependencies.)
1154         if ld.Tidy {
1155                 rs, err := tidyRoots(ctx, ld.requirements, ld.pkgs)
1156                 if err != nil {
1157                         ld.errorf("go: %v\n", err)
1158                         base.ExitIfErrors()
1159                 } else {
1160                         if ld.requirements.pruning == pruned {
1161                                 // We continuously add tidy roots to ld.requirements during loading, so at
1162                                 // this point the tidy roots should be a subset of the roots of
1163                                 // ld.requirements, ensuring that no new dependencies are brought inside
1164                                 // the graph-pruning horizon.
1165                                 // If that is not the case, there is a bug in the loading loop above.
1166                                 for _, m := range rs.rootModules {
1167                                         if v, ok := ld.requirements.rootSelected(m.Path); !ok || v != m.Version {
1168                                                 ld.errorf("go: internal error: a requirement on %v is needed but was not added during package loading\n", m)
1169                                                 base.ExitIfErrors()
1170                                         }
1171                                 }
1172                         }
1173                         ld.requirements = rs
1174                 }
1175         }
1176
1177         // Report errors, if any.
1178         for _, pkg := range ld.pkgs {
1179                 if pkg.err == nil {
1180                         continue
1181                 }
1182
1183                 // Add importer information to checksum errors.
1184                 if sumErr := (*ImportMissingSumError)(nil); errors.As(pkg.err, &sumErr) {
1185                         if importer := pkg.stack; importer != nil {
1186                                 sumErr.importer = importer.path
1187                                 sumErr.importerVersion = importer.mod.Version
1188                                 sumErr.importerIsTest = importer.testOf != nil
1189                         }
1190                 }
1191
1192                 if stdErr := (*ImportMissingError)(nil); errors.As(pkg.err, &stdErr) && stdErr.isStd {
1193                         // Add importer go version information to import errors of standard
1194                         // library packages arising from newer releases.
1195                         if importer := pkg.stack; importer != nil {
1196                                 if v, ok := rawGoVersion.Load(importer.mod); ok && versionLess(LatestGoVersion(), v.(string)) {
1197                                         stdErr.importerGoVersion = v.(string)
1198                                 }
1199                         }
1200                         if ld.SilenceMissingStdImports {
1201                                 continue
1202                         }
1203                 }
1204                 if ld.SilencePackageErrors {
1205                         continue
1206                 }
1207                 if ld.SilenceNoGoErrors && errors.Is(pkg.err, imports.ErrNoGo) {
1208                         continue
1209                 }
1210
1211                 ld.errorf("%s: %v\n", pkg.stackText(), pkg.err)
1212         }
1213
1214         ld.checkMultiplePaths()
1215         return ld
1216 }
1217
1218 // versionLess returns whether a < b according to semantic version precedence.
1219 // Both strings are interpreted as go version strings, e.g. "1.19".
1220 func versionLess(a, b string) bool {
1221         return semver.Compare("v"+a, "v"+b) < 0
1222 }
1223
1224 // updateRequirements ensures that ld.requirements is consistent with the
1225 // information gained from ld.pkgs.
1226 //
1227 // In particular:
1228 //
1229 //   - Modules that provide packages directly imported from the main module are
1230 //     marked as direct, and are promoted to explicit roots. If a needed root
1231 //     cannot be promoted due to -mod=readonly or -mod=vendor, the importing
1232 //     package is marked with an error.
1233 //
1234 //   - If ld scanned the "all" pattern independent of build constraints, it is
1235 //     guaranteed to have seen every direct import. Module dependencies that did
1236 //     not provide any directly-imported package are then marked as indirect.
1237 //
1238 //   - Root dependencies are updated to their selected versions.
1239 //
1240 // The "changed" return value reports whether the update changed the selected
1241 // version of any module that either provided a loaded package or may now
1242 // provide a package that was previously unresolved.
1243 func (ld *loader) updateRequirements(ctx context.Context) (changed bool, err error) {
1244         rs := ld.requirements
1245
1246         // direct contains the set of modules believed to provide packages directly
1247         // imported by the main module.
1248         var direct map[string]bool
1249
1250         // If we didn't scan all of the imports from the main module, or didn't use
1251         // imports.AnyTags, then we didn't necessarily load every package that
1252         // contributes “direct” imports — so we can't safely mark existing direct
1253         // dependencies in ld.requirements as indirect-only. Propagate them as direct.
1254         loadedDirect := ld.allPatternIsRoot && reflect.DeepEqual(ld.Tags, imports.AnyTags())
1255         if loadedDirect {
1256                 direct = make(map[string]bool)
1257         } else {
1258                 // TODO(bcmills): It seems like a shame to allocate and copy a map here when
1259                 // it will only rarely actually vary from rs.direct. Measure this cost and
1260                 // maybe avoid the copy.
1261                 direct = make(map[string]bool, len(rs.direct))
1262                 for mPath := range rs.direct {
1263                         direct[mPath] = true
1264                 }
1265         }
1266
1267         for _, pkg := range ld.pkgs {
1268                 if pkg.mod.Version != "" || !MainModules.Contains(pkg.mod.Path) {
1269                         continue
1270                 }
1271                 for _, dep := range pkg.imports {
1272                         if !dep.fromExternalModule() {
1273                                 continue
1274                         }
1275
1276                         if inWorkspaceMode() {
1277                                 // In workspace mode / workspace pruning mode, the roots are the main modules
1278                                 // rather than the main module's direct dependencies. The check below on the selected
1279                                 // roots does not apply.
1280                                 if mg, err := rs.Graph(ctx); err != nil {
1281                                         return false, err
1282                                 } else if _, ok := mg.RequiredBy(dep.mod); !ok {
1283                                         // dep.mod is not an explicit dependency, but needs to be.
1284                                         // See comment on error returned below.
1285                                         pkg.err = &DirectImportFromImplicitDependencyError{
1286                                                 ImporterPath: pkg.path,
1287                                                 ImportedPath: dep.path,
1288                                                 Module:       dep.mod,
1289                                         }
1290                                 }
1291                                 continue
1292                         }
1293
1294                         if pkg.err == nil && cfg.BuildMod != "mod" {
1295                                 if v, ok := rs.rootSelected(dep.mod.Path); !ok || v != dep.mod.Version {
1296                                         // dep.mod is not an explicit dependency, but needs to be.
1297                                         // Because we are not in "mod" mode, we will not be able to update it.
1298                                         // Instead, mark the importing package with an error.
1299                                         //
1300                                         // TODO(#41688): The resulting error message fails to include the file
1301                                         // position of the import statement (because that information is not
1302                                         // tracked by the module loader). Figure out how to plumb the import
1303                                         // position through.
1304                                         pkg.err = &DirectImportFromImplicitDependencyError{
1305                                                 ImporterPath: pkg.path,
1306                                                 ImportedPath: dep.path,
1307                                                 Module:       dep.mod,
1308                                         }
1309                                         // cfg.BuildMod does not allow us to change dep.mod to be a direct
1310                                         // dependency, so don't mark it as such.
1311                                         continue
1312                                 }
1313                         }
1314
1315                         // dep is a package directly imported by a package or test in the main
1316                         // module and loaded from some other module (not the standard library).
1317                         // Mark its module as a direct dependency.
1318                         direct[dep.mod.Path] = true
1319                 }
1320         }
1321
1322         var addRoots []module.Version
1323         if ld.Tidy {
1324                 // When we are tidying a module with a pruned dependency graph, we may need
1325                 // to add roots to preserve the versions of indirect, test-only dependencies
1326                 // that are upgraded above or otherwise missing from the go.mod files of
1327                 // direct dependencies. (For example, the direct dependency might be a very
1328                 // stable codebase that predates modules and thus lacks a go.mod file, or
1329                 // the author of the direct dependency may have forgotten to commit a change
1330                 // to the go.mod file, or may have made an erroneous hand-edit that causes
1331                 // it to be untidy.)
1332                 //
1333                 // Promoting an indirect dependency to a root adds the next layer of its
1334                 // dependencies to the module graph, which may increase the selected
1335                 // versions of other modules from which we have already loaded packages.
1336                 // So after we promote an indirect dependency to a root, we need to reload
1337                 // packages, which means another iteration of loading.
1338                 //
1339                 // As an extra wrinkle, the upgrades due to promoting a root can cause
1340                 // previously-resolved packages to become unresolved. For example, the
1341                 // module providing an unstable package might be upgraded to a version
1342                 // that no longer contains that package. If we then resolve the missing
1343                 // package, we might add yet another root that upgrades away some other
1344                 // dependency. (The tests in mod_tidy_convergence*.txt illustrate some
1345                 // particularly worrisome cases.)
1346                 //
1347                 // To ensure that this process of promoting, adding, and upgrading roots
1348                 // eventually terminates, during iteration we only ever add modules to the
1349                 // root set — we only remove irrelevant roots at the very end of
1350                 // iteration, after we have already added every root that we plan to need
1351                 // in the (eventual) tidy root set.
1352                 //
1353                 // Since we do not remove any roots during iteration, even if they no
1354                 // longer provide any imported packages, the selected versions of the
1355                 // roots can only increase and the set of roots can only expand. The set
1356                 // of extant root paths is finite and the set of versions of each path is
1357                 // finite, so the iteration *must* reach a stable fixed-point.
1358                 tidy, err := tidyRoots(ctx, rs, ld.pkgs)
1359                 if err != nil {
1360                         return false, err
1361                 }
1362                 addRoots = tidy.rootModules
1363         }
1364
1365         rs, err = updateRoots(ctx, direct, rs, ld.pkgs, addRoots, ld.AssumeRootsImported)
1366         if err != nil {
1367                 // We don't actually know what even the root requirements are supposed to be,
1368                 // so we can't proceed with loading. Return the error to the caller
1369                 return false, err
1370         }
1371
1372         if rs != ld.requirements && !reflect.DeepEqual(rs.rootModules, ld.requirements.rootModules) {
1373                 // The roots of the module graph have changed in some way (not just the
1374                 // "direct" markings). Check whether the changes affected any of the loaded
1375                 // packages.
1376                 mg, err := rs.Graph(ctx)
1377                 if err != nil {
1378                         return false, err
1379                 }
1380                 for _, pkg := range ld.pkgs {
1381                         if pkg.fromExternalModule() && mg.Selected(pkg.mod.Path) != pkg.mod.Version {
1382                                 changed = true
1383                                 break
1384                         }
1385                         if pkg.err != nil {
1386                                 // Promoting a module to a root may resolve an import that was
1387                                 // previously missing (by pulling in a previously-prune dependency that
1388                                 // provides it) or ambiguous (by promoting exactly one of the
1389                                 // alternatives to a root and ignoring the second-level alternatives) or
1390                                 // otherwise errored out (by upgrading from a version that cannot be
1391                                 // fetched to one that can be).
1392                                 //
1393                                 // Instead of enumerating all of the possible errors, we'll just check
1394                                 // whether importFromModules returns nil for the package.
1395                                 // False-positives are ok: if we have a false-positive here, we'll do an
1396                                 // extra iteration of package loading this time, but we'll still
1397                                 // converge when the root set stops changing.
1398                                 //
1399                                 // In some sense, we can think of this as ‘upgraded the module providing
1400                                 // pkg.path from "none" to a version higher than "none"’.
1401                                 if _, _, _, _, err = importFromModules(ctx, pkg.path, rs, nil); err == nil {
1402                                         changed = true
1403                                         break
1404                                 }
1405                         }
1406                 }
1407         }
1408
1409         ld.requirements = rs
1410         return changed, nil
1411 }
1412
1413 // resolveMissingImports returns a set of modules that could be added as
1414 // dependencies in order to resolve missing packages from pkgs.
1415 //
1416 // The newly-resolved packages are added to the addedModuleFor map, and
1417 // resolveMissingImports returns a map from each new module version to
1418 // the first missing package that module would resolve.
1419 func (ld *loader) resolveMissingImports(ctx context.Context) (modAddedBy map[module.Version]*loadPkg) {
1420         type pkgMod struct {
1421                 pkg *loadPkg
1422                 mod *module.Version
1423         }
1424         var pkgMods []pkgMod
1425         for _, pkg := range ld.pkgs {
1426                 if pkg.err == nil {
1427                         continue
1428                 }
1429                 if pkg.isTest() {
1430                         // If we are missing a test, we are also missing its non-test version, and
1431                         // we should only add the missing import once.
1432                         continue
1433                 }
1434                 if !errors.As(pkg.err, new(*ImportMissingError)) {
1435                         // Leave other errors for Import or load.Packages to report.
1436                         continue
1437                 }
1438
1439                 pkg := pkg
1440                 var mod module.Version
1441                 ld.work.Add(func() {
1442                         var err error
1443                         mod, err = queryImport(ctx, pkg.path, ld.requirements)
1444                         if err != nil {
1445                                 var ime *ImportMissingError
1446                                 if errors.As(err, &ime) {
1447                                         for curstack := pkg.stack; curstack != nil; curstack = curstack.stack {
1448                                                 if MainModules.Contains(curstack.mod.Path) {
1449                                                         ime.ImportingMainModule = curstack.mod
1450                                                         break
1451                                                 }
1452                                         }
1453                                 }
1454                                 // pkg.err was already non-nil, so we can reasonably attribute the error
1455                                 // for pkg to either the original error or the one returned by
1456                                 // queryImport. The existing error indicates only that we couldn't find
1457                                 // the package, whereas the query error also explains why we didn't fix
1458                                 // the problem — so we prefer the latter.
1459                                 pkg.err = err
1460                         }
1461
1462                         // err is nil, but we intentionally leave pkg.err non-nil and pkg.mod
1463                         // unset: we still haven't satisfied other invariants of a
1464                         // successfully-loaded package, such as scanning and loading the imports
1465                         // of that package. If we succeed in resolving the new dependency graph,
1466                         // the caller can reload pkg and update the error at that point.
1467                         //
1468                         // Even then, the package might not be loaded from the version we've
1469                         // identified here. The module may be upgraded by some other dependency,
1470                         // or by a transitive dependency of mod itself, or — less likely — the
1471                         // package may be rejected by an AllowPackage hook or rendered ambiguous
1472                         // by some other newly-added or newly-upgraded dependency.
1473                 })
1474
1475                 pkgMods = append(pkgMods, pkgMod{pkg: pkg, mod: &mod})
1476         }
1477         <-ld.work.Idle()
1478
1479         modAddedBy = map[module.Version]*loadPkg{}
1480         for _, pm := range pkgMods {
1481                 pkg, mod := pm.pkg, *pm.mod
1482                 if mod.Path == "" {
1483                         continue
1484                 }
1485
1486                 fmt.Fprintf(os.Stderr, "go: found %s in %s %s\n", pkg.path, mod.Path, mod.Version)
1487                 if modAddedBy[mod] == nil {
1488                         modAddedBy[mod] = pkg
1489                 }
1490         }
1491
1492         return modAddedBy
1493 }
1494
1495 // pkg locates the *loadPkg for path, creating and queuing it for loading if
1496 // needed, and updates its state to reflect the given flags.
1497 //
1498 // The imports of the returned *loadPkg will be loaded asynchronously in the
1499 // ld.work queue, and its test (if requested) will also be populated once
1500 // imports have been resolved. When ld.work goes idle, all transitive imports of
1501 // the requested package (and its test, if requested) will have been loaded.
1502 func (ld *loader) pkg(ctx context.Context, path string, flags loadPkgFlags) *loadPkg {
1503         if flags.has(pkgImportsLoaded) {
1504                 panic("internal error: (*loader).pkg called with pkgImportsLoaded flag set")
1505         }
1506
1507         pkg := ld.pkgCache.Do(path, func() any {
1508                 pkg := &loadPkg{
1509                         path: path,
1510                 }
1511                 ld.applyPkgFlags(ctx, pkg, flags)
1512
1513                 ld.work.Add(func() { ld.load(ctx, pkg) })
1514                 return pkg
1515         }).(*loadPkg)
1516
1517         ld.applyPkgFlags(ctx, pkg, flags)
1518         return pkg
1519 }
1520
1521 // applyPkgFlags updates pkg.flags to set the given flags and propagate the
1522 // (transitive) effects of those flags, possibly loading or enqueueing further
1523 // packages as a result.
1524 func (ld *loader) applyPkgFlags(ctx context.Context, pkg *loadPkg, flags loadPkgFlags) {
1525         if flags == 0 {
1526                 return
1527         }
1528
1529         if flags.has(pkgInAll) && ld.allPatternIsRoot && !pkg.isTest() {
1530                 // This package matches a root pattern by virtue of being in "all".
1531                 flags |= pkgIsRoot
1532         }
1533         if flags.has(pkgIsRoot) {
1534                 flags |= pkgFromRoot
1535         }
1536
1537         old := pkg.flags.update(flags)
1538         new := old | flags
1539         if new == old || !new.has(pkgImportsLoaded) {
1540                 // We either didn't change the state of pkg, or we don't know anything about
1541                 // its dependencies yet. Either way, we can't usefully load its test or
1542                 // update its dependencies.
1543                 return
1544         }
1545
1546         if !pkg.isTest() {
1547                 // Check whether we should add (or update the flags for) a test for pkg.
1548                 // ld.pkgTest is idempotent and extra invocations are inexpensive,
1549                 // so it's ok if we call it more than is strictly necessary.
1550                 wantTest := false
1551                 switch {
1552                 case ld.allPatternIsRoot && MainModules.Contains(pkg.mod.Path):
1553                         // We are loading the "all" pattern, which includes packages imported by
1554                         // tests in the main module. This package is in the main module, so we
1555                         // need to identify the imports of its test even if LoadTests is not set.
1556                         //
1557                         // (We will filter out the extra tests explicitly in computePatternAll.)
1558                         wantTest = true
1559
1560                 case ld.allPatternIsRoot && ld.allClosesOverTests && new.has(pkgInAll):
1561                         // This variant of the "all" pattern includes imports of tests of every
1562                         // package that is itself in "all", and pkg is in "all", so its test is
1563                         // also in "all" (as above).
1564                         wantTest = true
1565
1566                 case ld.LoadTests && new.has(pkgIsRoot):
1567                         // LoadTest explicitly requests tests of “the root packages”.
1568                         wantTest = true
1569                 }
1570
1571                 if wantTest {
1572                         var testFlags loadPkgFlags
1573                         if MainModules.Contains(pkg.mod.Path) || (ld.allClosesOverTests && new.has(pkgInAll)) {
1574                                 // Tests of packages in the main module are in "all", in the sense that
1575                                 // they cause the packages they import to also be in "all". So are tests
1576                                 // of packages in "all" if "all" closes over test dependencies.
1577                                 testFlags |= pkgInAll
1578                         }
1579                         ld.pkgTest(ctx, pkg, testFlags)
1580                 }
1581         }
1582
1583         if new.has(pkgInAll) && !old.has(pkgInAll|pkgImportsLoaded) {
1584                 // We have just marked pkg with pkgInAll, or we have just loaded its
1585                 // imports, or both. Now is the time to propagate pkgInAll to the imports.
1586                 for _, dep := range pkg.imports {
1587                         ld.applyPkgFlags(ctx, dep, pkgInAll)
1588                 }
1589         }
1590
1591         if new.has(pkgFromRoot) && !old.has(pkgFromRoot|pkgImportsLoaded) {
1592                 for _, dep := range pkg.imports {
1593                         ld.applyPkgFlags(ctx, dep, pkgFromRoot)
1594                 }
1595         }
1596 }
1597
1598 // preloadRootModules loads the module requirements needed to identify the
1599 // selected version of each module providing a package in rootPkgs,
1600 // adding new root modules to the module graph if needed.
1601 func (ld *loader) preloadRootModules(ctx context.Context, rootPkgs []string) (changedBuildList bool) {
1602         needc := make(chan map[module.Version]bool, 1)
1603         needc <- map[module.Version]bool{}
1604         for _, path := range rootPkgs {
1605                 path := path
1606                 ld.work.Add(func() {
1607                         // First, try to identify the module containing the package using only roots.
1608                         //
1609                         // If the main module is tidy and the package is in "all" — or if we're
1610                         // lucky — we can identify all of its imports without actually loading the
1611                         // full module graph.
1612                         m, _, _, _, err := importFromModules(ctx, path, ld.requirements, nil)
1613                         if err != nil {
1614                                 var missing *ImportMissingError
1615                                 if errors.As(err, &missing) && ld.ResolveMissingImports {
1616                                         // This package isn't provided by any selected module.
1617                                         // If we can find it, it will be a new root dependency.
1618                                         m, err = queryImport(ctx, path, ld.requirements)
1619                                 }
1620                                 if err != nil {
1621                                         // We couldn't identify the root module containing this package.
1622                                         // Leave it unresolved; we will report it during loading.
1623                                         return
1624                                 }
1625                         }
1626                         if m.Path == "" {
1627                                 // The package is in std or cmd. We don't need to change the root set.
1628                                 return
1629                         }
1630
1631                         v, ok := ld.requirements.rootSelected(m.Path)
1632                         if !ok || v != m.Version {
1633                                 // We found the requested package in m, but m is not a root, so
1634                                 // loadModGraph will not load its requirements. We need to promote the
1635                                 // module to a root to ensure that any other packages this package
1636                                 // imports are resolved from correct dependency versions.
1637                                 //
1638                                 // (This is the “argument invariant” from
1639                                 // https://golang.org/design/36460-lazy-module-loading.)
1640                                 need := <-needc
1641                                 need[m] = true
1642                                 needc <- need
1643                         }
1644                 })
1645         }
1646         <-ld.work.Idle()
1647
1648         need := <-needc
1649         if len(need) == 0 {
1650                 return false // No roots to add.
1651         }
1652
1653         toAdd := make([]module.Version, 0, len(need))
1654         for m := range need {
1655                 toAdd = append(toAdd, m)
1656         }
1657         module.Sort(toAdd)
1658
1659         rs, err := updateRoots(ctx, ld.requirements.direct, ld.requirements, nil, toAdd, ld.AssumeRootsImported)
1660         if err != nil {
1661                 // We are missing some root dependency, and for some reason we can't load
1662                 // enough of the module dependency graph to add the missing root. Package
1663                 // loading is doomed to fail, so fail quickly.
1664                 ld.errorf("go: %v\n", err)
1665                 base.ExitIfErrors()
1666                 return false
1667         }
1668         if reflect.DeepEqual(rs.rootModules, ld.requirements.rootModules) {
1669                 // Something is deeply wrong. resolveMissingImports gave us a non-empty
1670                 // set of modules to add to the graph, but adding those modules had no
1671                 // effect — either they were already in the graph, or updateRoots did not
1672                 // add them as requested.
1673                 panic(fmt.Sprintf("internal error: adding %v to module graph had no effect on root requirements (%v)", toAdd, rs.rootModules))
1674         }
1675
1676         ld.requirements = rs
1677         return true
1678 }
1679
1680 // load loads an individual package.
1681 func (ld *loader) load(ctx context.Context, pkg *loadPkg) {
1682         var mg *ModuleGraph
1683         if ld.requirements.pruning == unpruned {
1684                 var err error
1685                 mg, err = ld.requirements.Graph(ctx)
1686                 if err != nil {
1687                         // We already checked the error from Graph in loadFromRoots and/or
1688                         // updateRequirements, so we ignored the error on purpose and we should
1689                         // keep trying to push past it.
1690                         //
1691                         // However, because mg may be incomplete (and thus may select inaccurate
1692                         // versions), we shouldn't use it to load packages. Instead, we pass a nil
1693                         // *ModuleGraph, which will cause mg to first try loading from only the
1694                         // main module and root dependencies.
1695                         mg = nil
1696                 }
1697         }
1698
1699         var modroot string
1700         pkg.mod, modroot, pkg.dir, pkg.altMods, pkg.err = importFromModules(ctx, pkg.path, ld.requirements, mg)
1701         if pkg.dir == "" {
1702                 return
1703         }
1704         if MainModules.Contains(pkg.mod.Path) {
1705                 // Go ahead and mark pkg as in "all". This provides the invariant that a
1706                 // package that is *only* imported by other packages in "all" is always
1707                 // marked as such before loading its imports.
1708                 //
1709                 // We don't actually rely on that invariant at the moment, but it may
1710                 // improve efficiency somewhat and makes the behavior a bit easier to reason
1711                 // about (by reducing churn on the flag bits of dependencies), and costs
1712                 // essentially nothing (these atomic flag ops are essentially free compared
1713                 // to scanning source code for imports).
1714                 ld.applyPkgFlags(ctx, pkg, pkgInAll)
1715         }
1716         if ld.AllowPackage != nil {
1717                 if err := ld.AllowPackage(ctx, pkg.path, pkg.mod); err != nil {
1718                         pkg.err = err
1719                 }
1720         }
1721
1722         pkg.inStd = (search.IsStandardImportPath(pkg.path) && search.InDir(pkg.dir, cfg.GOROOTsrc) != "")
1723
1724         var imports, testImports []string
1725
1726         if cfg.BuildContext.Compiler == "gccgo" && pkg.inStd {
1727                 // We can't scan standard packages for gccgo.
1728         } else {
1729                 var err error
1730                 imports, testImports, err = scanDir(modroot, pkg.dir, ld.Tags)
1731                 if err != nil {
1732                         pkg.err = err
1733                         return
1734                 }
1735         }
1736
1737         pkg.imports = make([]*loadPkg, 0, len(imports))
1738         var importFlags loadPkgFlags
1739         if pkg.flags.has(pkgInAll) {
1740                 importFlags = pkgInAll
1741         }
1742         for _, path := range imports {
1743                 if pkg.inStd {
1744                         // Imports from packages in "std" and "cmd" should resolve using
1745                         // GOROOT/src/vendor even when "std" is not the main module.
1746                         path = ld.stdVendor(pkg.path, path)
1747                 }
1748                 pkg.imports = append(pkg.imports, ld.pkg(ctx, path, importFlags))
1749         }
1750         pkg.testImports = testImports
1751
1752         ld.applyPkgFlags(ctx, pkg, pkgImportsLoaded)
1753 }
1754
1755 // pkgTest locates the test of pkg, creating it if needed, and updates its state
1756 // to reflect the given flags.
1757 //
1758 // pkgTest requires that the imports of pkg have already been loaded (flagged
1759 // with pkgImportsLoaded).
1760 func (ld *loader) pkgTest(ctx context.Context, pkg *loadPkg, testFlags loadPkgFlags) *loadPkg {
1761         if pkg.isTest() {
1762                 panic("pkgTest called on a test package")
1763         }
1764
1765         createdTest := false
1766         pkg.testOnce.Do(func() {
1767                 pkg.test = &loadPkg{
1768                         path:   pkg.path,
1769                         testOf: pkg,
1770                         mod:    pkg.mod,
1771                         dir:    pkg.dir,
1772                         err:    pkg.err,
1773                         inStd:  pkg.inStd,
1774                 }
1775                 ld.applyPkgFlags(ctx, pkg.test, testFlags)
1776                 createdTest = true
1777         })
1778
1779         test := pkg.test
1780         if createdTest {
1781                 test.imports = make([]*loadPkg, 0, len(pkg.testImports))
1782                 var importFlags loadPkgFlags
1783                 if test.flags.has(pkgInAll) {
1784                         importFlags = pkgInAll
1785                 }
1786                 for _, path := range pkg.testImports {
1787                         if pkg.inStd {
1788                                 path = ld.stdVendor(test.path, path)
1789                         }
1790                         test.imports = append(test.imports, ld.pkg(ctx, path, importFlags))
1791                 }
1792                 pkg.testImports = nil
1793                 ld.applyPkgFlags(ctx, test, pkgImportsLoaded)
1794         } else {
1795                 ld.applyPkgFlags(ctx, test, testFlags)
1796         }
1797
1798         return test
1799 }
1800
1801 // stdVendor returns the canonical import path for the package with the given
1802 // path when imported from the standard-library package at parentPath.
1803 func (ld *loader) stdVendor(parentPath, path string) string {
1804         if search.IsStandardImportPath(path) {
1805                 return path
1806         }
1807
1808         if str.HasPathPrefix(parentPath, "cmd") {
1809                 if !ld.VendorModulesInGOROOTSrc || !MainModules.Contains("cmd") {
1810                         vendorPath := pathpkg.Join("cmd", "vendor", path)
1811
1812                         if _, err := os.Stat(filepath.Join(cfg.GOROOTsrc, filepath.FromSlash(vendorPath))); err == nil {
1813                                 return vendorPath
1814                         }
1815                 }
1816         } else if !ld.VendorModulesInGOROOTSrc || !MainModules.Contains("std") || str.HasPathPrefix(parentPath, "vendor") {
1817                 // If we are outside of the 'std' module, resolve imports from within 'std'
1818                 // to the vendor directory.
1819                 //
1820                 // Do the same for importers beginning with the prefix 'vendor/' even if we
1821                 // are *inside* of the 'std' module: the 'vendor/' packages that resolve
1822                 // globally from GOROOT/src/vendor (and are listed as part of 'go list std')
1823                 // are distinct from the real module dependencies, and cannot import
1824                 // internal packages from the real module.
1825                 //
1826                 // (Note that although the 'vendor/' packages match the 'std' *package*
1827                 // pattern, they are not part of the std *module*, and do not affect
1828                 // 'go mod tidy' and similar module commands when working within std.)
1829                 vendorPath := pathpkg.Join("vendor", path)
1830                 if _, err := os.Stat(filepath.Join(cfg.GOROOTsrc, filepath.FromSlash(vendorPath))); err == nil {
1831                         return vendorPath
1832                 }
1833         }
1834
1835         // Not vendored: resolve from modules.
1836         return path
1837 }
1838
1839 // computePatternAll returns the list of packages matching pattern "all",
1840 // starting with a list of the import paths for the packages in the main module.
1841 func (ld *loader) computePatternAll() (all []string) {
1842         for _, pkg := range ld.pkgs {
1843                 if pkg.flags.has(pkgInAll) && !pkg.isTest() {
1844                         all = append(all, pkg.path)
1845                 }
1846         }
1847         sort.Strings(all)
1848         return all
1849 }
1850
1851 // checkMultiplePaths verifies that a given module path is used as itself
1852 // or as a replacement for another module, but not both at the same time.
1853 //
1854 // (See https://golang.org/issue/26607 and https://golang.org/issue/34650.)
1855 func (ld *loader) checkMultiplePaths() {
1856         mods := ld.requirements.rootModules
1857         if cached := ld.requirements.graph.Load(); cached != nil {
1858                 if mg := cached.mg; mg != nil {
1859                         mods = mg.BuildList()
1860                 }
1861         }
1862
1863         firstPath := map[module.Version]string{}
1864         for _, mod := range mods {
1865                 src := resolveReplacement(mod)
1866                 if prev, ok := firstPath[src]; !ok {
1867                         firstPath[src] = mod.Path
1868                 } else if prev != mod.Path {
1869                         ld.errorf("go: %s@%s used for two different module paths (%s and %s)\n", src.Path, src.Version, prev, mod.Path)
1870                 }
1871         }
1872 }
1873
1874 // checkTidyCompatibility emits an error if any package would be loaded from a
1875 // different module under rs than under ld.requirements.
1876 func (ld *loader) checkTidyCompatibility(ctx context.Context, rs *Requirements) {
1877         suggestUpgrade := false
1878         suggestEFlag := false
1879         suggestFixes := func() {
1880                 if ld.AllowErrors {
1881                         // The user is explicitly ignoring these errors, so don't bother them with
1882                         // other options.
1883                         return
1884                 }
1885
1886                 // We print directly to os.Stderr because this information is advice about
1887                 // how to fix errors, not actually an error itself.
1888                 // (The actual errors should have been logged already.)
1889
1890                 fmt.Fprintln(os.Stderr)
1891
1892                 goFlag := ""
1893                 if ld.GoVersion != MainModules.GoVersion() {
1894                         goFlag = " -go=" + ld.GoVersion
1895                 }
1896
1897                 compatFlag := ""
1898                 if ld.TidyCompatibleVersion != priorGoVersion(ld.GoVersion) {
1899                         compatFlag = " -compat=" + ld.TidyCompatibleVersion
1900                 }
1901                 if suggestUpgrade {
1902                         eDesc := ""
1903                         eFlag := ""
1904                         if suggestEFlag {
1905                                 eDesc = ", leaving some packages unresolved"
1906                                 eFlag = " -e"
1907                         }
1908                         fmt.Fprintf(os.Stderr, "To upgrade to the versions selected by go %s%s:\n\tgo mod tidy%s -go=%s && go mod tidy%s -go=%s%s\n", ld.TidyCompatibleVersion, eDesc, eFlag, ld.TidyCompatibleVersion, eFlag, ld.GoVersion, compatFlag)
1909                 } else if suggestEFlag {
1910                         // If some packages are missing but no package is upgraded, then we
1911                         // shouldn't suggest upgrading to the Go 1.16 versions explicitly — that
1912                         // wouldn't actually fix anything for Go 1.16 users, and *would* break
1913                         // something for Go 1.17 users.
1914                         fmt.Fprintf(os.Stderr, "To proceed despite packages unresolved in go %s:\n\tgo mod tidy -e%s%s\n", ld.TidyCompatibleVersion, goFlag, compatFlag)
1915                 }
1916
1917                 fmt.Fprintf(os.Stderr, "If reproducibility with go %s is not needed:\n\tgo mod tidy%s -compat=%s\n", ld.TidyCompatibleVersion, goFlag, ld.GoVersion)
1918
1919                 // TODO(#46141): Populate the linked wiki page.
1920                 fmt.Fprintf(os.Stderr, "For other options, see:\n\thttps://golang.org/doc/modules/pruning\n")
1921         }
1922
1923         mg, err := rs.Graph(ctx)
1924         if err != nil {
1925                 ld.errorf("go: error loading go %s module graph: %v\n", ld.TidyCompatibleVersion, err)
1926                 suggestFixes()
1927                 return
1928         }
1929
1930         // Re-resolve packages in parallel.
1931         //
1932         // We re-resolve each package — rather than just checking versions — to ensure
1933         // that we have fetched module source code (and, importantly, checksums for
1934         // that source code) for all modules that are necessary to ensure that imports
1935         // are unambiguous. That also produces clearer diagnostics, since we can say
1936         // exactly what happened to the package if it became ambiguous or disappeared
1937         // entirely.
1938         //
1939         // We re-resolve the packages in parallel because this process involves disk
1940         // I/O to check for package sources, and because the process of checking for
1941         // ambiguous imports may require us to download additional modules that are
1942         // otherwise pruned out in Go 1.17 — we don't want to block progress on other
1943         // packages while we wait for a single new download.
1944         type mismatch struct {
1945                 mod module.Version
1946                 err error
1947         }
1948         mismatchMu := make(chan map[*loadPkg]mismatch, 1)
1949         mismatchMu <- map[*loadPkg]mismatch{}
1950         for _, pkg := range ld.pkgs {
1951                 if pkg.mod.Path == "" && pkg.err == nil {
1952                         // This package is from the standard library (which does not vary based on
1953                         // the module graph).
1954                         continue
1955                 }
1956
1957                 pkg := pkg
1958                 ld.work.Add(func() {
1959                         mod, _, _, _, err := importFromModules(ctx, pkg.path, rs, mg)
1960                         if mod != pkg.mod {
1961                                 mismatches := <-mismatchMu
1962                                 mismatches[pkg] = mismatch{mod: mod, err: err}
1963                                 mismatchMu <- mismatches
1964                         }
1965                 })
1966         }
1967         <-ld.work.Idle()
1968
1969         mismatches := <-mismatchMu
1970         if len(mismatches) == 0 {
1971                 // Since we're running as part of 'go mod tidy', the roots of the module
1972                 // graph should contain only modules that are relevant to some package in
1973                 // the package graph. We checked every package in the package graph and
1974                 // didn't find any mismatches, so that must mean that all of the roots of
1975                 // the module graph are also consistent.
1976                 //
1977                 // If we're wrong, Go 1.16 in -mod=readonly mode will error out with
1978                 // "updates to go.mod needed", which would be very confusing. So instead,
1979                 // we'll double-check that our reasoning above actually holds — if it
1980                 // doesn't, we'll emit an internal error and hopefully the user will report
1981                 // it as a bug.
1982                 for _, m := range ld.requirements.rootModules {
1983                         if v := mg.Selected(m.Path); v != m.Version {
1984                                 fmt.Fprintln(os.Stderr)
1985                                 base.Fatalf("go: internal error: failed to diagnose selected-version mismatch for module %s: go %s selects %s, but go %s selects %s\n\tPlease report this at https://golang.org/issue.", m.Path, ld.GoVersion, m.Version, ld.TidyCompatibleVersion, v)
1986                         }
1987                 }
1988                 return
1989         }
1990
1991         // Iterate over the packages (instead of the mismatches map) to emit errors in
1992         // deterministic order.
1993         for _, pkg := range ld.pkgs {
1994                 mismatch, ok := mismatches[pkg]
1995                 if !ok {
1996                         continue
1997                 }
1998
1999                 if pkg.isTest() {
2000                         // We already did (or will) report an error for the package itself,
2001                         // so don't report a duplicate (and more vebose) error for its test.
2002                         if _, ok := mismatches[pkg.testOf]; !ok {
2003                                 base.Fatalf("go: internal error: mismatch recorded for test %s, but not its non-test package", pkg.path)
2004                         }
2005                         continue
2006                 }
2007
2008                 switch {
2009                 case mismatch.err != nil:
2010                         // pkg resolved successfully, but errors out using the requirements in rs.
2011                         //
2012                         // This could occur because the import is provided by a single root (and
2013                         // is thus unambiguous in a main module with a pruned module graph) and
2014                         // also one or more transitive dependencies (and is ambiguous with an
2015                         // unpruned graph).
2016                         //
2017                         // It could also occur because some transitive dependency upgrades the
2018                         // module that previously provided the package to a version that no
2019                         // longer does, or to a version for which the module source code (but
2020                         // not the go.mod file in isolation) has a checksum error.
2021                         if missing := (*ImportMissingError)(nil); errors.As(mismatch.err, &missing) {
2022                                 selected := module.Version{
2023                                         Path:    pkg.mod.Path,
2024                                         Version: mg.Selected(pkg.mod.Path),
2025                                 }
2026                                 ld.errorf("%s loaded from %v,\n\tbut go %s would fail to locate it in %s\n", pkg.stackText(), pkg.mod, ld.TidyCompatibleVersion, selected)
2027                         } else {
2028                                 if ambiguous := (*AmbiguousImportError)(nil); errors.As(mismatch.err, &ambiguous) {
2029                                         // TODO: Is this check needed?
2030                                 }
2031                                 ld.errorf("%s loaded from %v,\n\tbut go %s would fail to locate it:\n\t%v\n", pkg.stackText(), pkg.mod, ld.TidyCompatibleVersion, mismatch.err)
2032                         }
2033
2034                         suggestEFlag = true
2035
2036                         // Even if we press ahead with the '-e' flag, the older version will
2037                         // error out in readonly mode if it thinks the go.mod file contains
2038                         // any *explicit* dependency that is not at its selected version,
2039                         // even if that dependency is not relevant to any package being loaded.
2040                         //
2041                         // We check for that condition here. If all of the roots are consistent
2042                         // the '-e' flag suffices, but otherwise we need to suggest an upgrade.
2043                         if !suggestUpgrade {
2044                                 for _, m := range ld.requirements.rootModules {
2045                                         if v := mg.Selected(m.Path); v != m.Version {
2046                                                 suggestUpgrade = true
2047                                                 break
2048                                         }
2049                                 }
2050                         }
2051
2052                 case pkg.err != nil:
2053                         // pkg had an error in with a pruned module graph (presumably suppressed
2054                         // with the -e flag), but the error went away using an unpruned graph.
2055                         //
2056                         // This is possible, if, say, the import is unresolved in the pruned graph
2057                         // (because the "latest" version of each candidate module either is
2058                         // unavailable or does not contain the package), but is resolved in the
2059                         // unpruned graph due to a newer-than-latest dependency that is normally
2060                         // pruned out.
2061                         //
2062                         // This could also occur if the source code for the module providing the
2063                         // package in the pruned graph has a checksum error, but the unpruned
2064                         // graph upgrades that module to a version with a correct checksum.
2065                         //
2066                         // pkg.err should have already been logged elsewhere — along with a
2067                         // stack trace — so log only the import path and non-error info here.
2068                         suggestUpgrade = true
2069                         ld.errorf("%s failed to load from any module,\n\tbut go %s would load it from %v\n", pkg.path, ld.TidyCompatibleVersion, mismatch.mod)
2070
2071                 case pkg.mod != mismatch.mod:
2072                         // The package is loaded successfully by both Go versions, but from a
2073                         // different module in each. This could lead to subtle (and perhaps even
2074                         // unnoticed!) variations in behavior between builds with different
2075                         // toolchains.
2076                         suggestUpgrade = true
2077                         ld.errorf("%s loaded from %v,\n\tbut go %s would select %v\n", pkg.stackText(), pkg.mod, ld.TidyCompatibleVersion, mismatch.mod.Version)
2078
2079                 default:
2080                         base.Fatalf("go: internal error: mismatch recorded for package %s, but no differences found", pkg.path)
2081                 }
2082         }
2083
2084         suggestFixes()
2085         base.ExitIfErrors()
2086 }
2087
2088 // scanDir is like imports.ScanDir but elides known magic imports from the list,
2089 // so that we do not go looking for packages that don't really exist.
2090 //
2091 // The standard magic import is "C", for cgo.
2092 //
2093 // The only other known magic imports are appengine and appengine/*.
2094 // These are so old that they predate "go get" and did not use URL-like paths.
2095 // Most code today now uses google.golang.org/appengine instead,
2096 // but not all code has been so updated. When we mostly ignore build tags
2097 // during "go vendor", we look into "// +build appengine" files and
2098 // may see these legacy imports. We drop them so that the module
2099 // search does not look for modules to try to satisfy them.
2100 func scanDir(modroot string, dir string, tags map[string]bool) (imports_, testImports []string, err error) {
2101         if ip, mierr := modindex.GetPackage(modroot, dir); mierr == nil {
2102                 imports_, testImports, err = ip.ScanDir(tags)
2103                 goto Happy
2104         } else if !errors.Is(mierr, modindex.ErrNotIndexed) {
2105                 return nil, nil, mierr
2106         }
2107
2108         imports_, testImports, err = imports.ScanDir(dir, tags)
2109 Happy:
2110
2111         filter := func(x []string) []string {
2112                 w := 0
2113                 for _, pkg := range x {
2114                         if pkg != "C" && pkg != "appengine" && !strings.HasPrefix(pkg, "appengine/") &&
2115                                 pkg != "appengine_internal" && !strings.HasPrefix(pkg, "appengine_internal/") {
2116                                 x[w] = pkg
2117                                 w++
2118                         }
2119                 }
2120                 return x[:w]
2121         }
2122
2123         return filter(imports_), filter(testImports), err
2124 }
2125
2126 // buildStacks computes minimal import stacks for each package,
2127 // for use in error messages. When it completes, packages that
2128 // are part of the original root set have pkg.stack == nil,
2129 // and other packages have pkg.stack pointing at the next
2130 // package up the import stack in their minimal chain.
2131 // As a side effect, buildStacks also constructs ld.pkgs,
2132 // the list of all packages loaded.
2133 func (ld *loader) buildStacks() {
2134         if len(ld.pkgs) > 0 {
2135                 panic("buildStacks")
2136         }
2137         for _, pkg := range ld.roots {
2138                 pkg.stack = pkg // sentinel to avoid processing in next loop
2139                 ld.pkgs = append(ld.pkgs, pkg)
2140         }
2141         for i := 0; i < len(ld.pkgs); i++ { // not range: appending to ld.pkgs in loop
2142                 pkg := ld.pkgs[i]
2143                 for _, next := range pkg.imports {
2144                         if next.stack == nil {
2145                                 next.stack = pkg
2146                                 ld.pkgs = append(ld.pkgs, next)
2147                         }
2148                 }
2149                 if next := pkg.test; next != nil && next.stack == nil {
2150                         next.stack = pkg
2151                         ld.pkgs = append(ld.pkgs, next)
2152                 }
2153         }
2154         for _, pkg := range ld.roots {
2155                 pkg.stack = nil
2156         }
2157 }
2158
2159 // stackText builds the import stack text to use when
2160 // reporting an error in pkg. It has the general form
2161 //
2162 //      root imports
2163 //              other imports
2164 //              other2 tested by
2165 //              other2.test imports
2166 //              pkg
2167 func (pkg *loadPkg) stackText() string {
2168         var stack []*loadPkg
2169         for p := pkg; p != nil; p = p.stack {
2170                 stack = append(stack, p)
2171         }
2172
2173         var buf strings.Builder
2174         for i := len(stack) - 1; i >= 0; i-- {
2175                 p := stack[i]
2176                 fmt.Fprint(&buf, p.path)
2177                 if p.testOf != nil {
2178                         fmt.Fprint(&buf, ".test")
2179                 }
2180                 if i > 0 {
2181                         if stack[i-1].testOf == p {
2182                                 fmt.Fprint(&buf, " tested by\n\t")
2183                         } else {
2184                                 fmt.Fprint(&buf, " imports\n\t")
2185                         }
2186                 }
2187         }
2188         return buf.String()
2189 }
2190
2191 // why returns the text to use in "go mod why" output about the given package.
2192 // It is less ornate than the stackText but contains the same information.
2193 func (pkg *loadPkg) why() string {
2194         var buf strings.Builder
2195         var stack []*loadPkg
2196         for p := pkg; p != nil; p = p.stack {
2197                 stack = append(stack, p)
2198         }
2199
2200         for i := len(stack) - 1; i >= 0; i-- {
2201                 p := stack[i]
2202                 if p.testOf != nil {
2203                         fmt.Fprintf(&buf, "%s.test\n", p.testOf.path)
2204                 } else {
2205                         fmt.Fprintf(&buf, "%s\n", p.path)
2206                 }
2207         }
2208         return buf.String()
2209 }
2210
2211 // Why returns the "go mod why" output stanza for the given package,
2212 // without the leading # comment.
2213 // The package graph must have been loaded already, usually by LoadPackages.
2214 // If there is no reason for the package to be in the current build,
2215 // Why returns an empty string.
2216 func Why(path string) string {
2217         pkg, ok := loaded.pkgCache.Get(path).(*loadPkg)
2218         if !ok {
2219                 return ""
2220         }
2221         return pkg.why()
2222 }
2223
2224 // WhyDepth returns the number of steps in the Why listing.
2225 // If there is no reason for the package to be in the current build,
2226 // WhyDepth returns 0.
2227 func WhyDepth(path string) int {
2228         n := 0
2229         pkg, _ := loaded.pkgCache.Get(path).(*loadPkg)
2230         for p := pkg; p != nil; p = p.stack {
2231                 n++
2232         }
2233         return n
2234 }