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.
7 // This file contains the module-mode package loader, as well as some accessory
8 // functions pertaining to the package import graph.
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.
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.
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.
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.
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".
43 // When we implement lazy loading, we will record the modules providing packages
44 // in "all" even when we are only loading individual packages, so we set the
45 // pkgInAll flag regardless of the whether the "all" pattern is a root.
46 // (This is necessary to maintain the “import invariant” described in
47 // https://golang.org/design/36460-lazy-module-loading.)
49 // Because "go mod vendor" prunes out the tests of vendored packages, the
50 // behavior of the "all" pattern with -mod=vendor in Go 1.11–1.15 is the same
51 // as the "all" pattern (regardless of the -mod flag) in 1.16+.
52 // The loader uses the GoVersion parameter to determine whether the "all"
53 // pattern should close over tests (as in Go 1.11–1.15) or stop at only those
54 // packages transitively imported by the packages and tests in the main module
55 // ("all" in Go 1.16+ and "go mod vendor" in Go 1.11+).
57 // Note that it is possible for a loaded package NOT to be in "all" even when we
58 // are loading the "all" pattern. For example, packages that are transitive
59 // dependencies of other roots named on the command line must be loaded, but are
60 // not in "all". (The mod_notall test illustrates this behavior.)
61 // Similarly, if the LoadTests flag is set but the "all" pattern does not close
62 // over test dependencies, then when we load the test of a package that is in
63 // "all" but outside the main module, the dependencies of that test will not
64 // necessarily themselves be in "all". (That configuration does not arise in Go
65 // 1.11–1.15, but it will be possible in Go 1.16+.)
67 // Loading proceeds from the roots, using a parallel work-queue with a limit on
68 // the amount of active work (to avoid saturating disks, CPU cores, and/or
69 // network connections). Each package is added to the queue the first time it is
70 // imported by another package. When we have finished identifying the imports of
71 // a package, we add the test for that package if it is needed. A test may be
73 // - the package matches a root pattern and tests of the roots were requested, or
74 // - the package is in the main module and the "all" pattern is requested
75 // (because the "all" pattern includes the dependencies of tests in the main
77 // - the package is in "all" and the definition of "all" we are using includes
78 // dependencies of tests (as is the case in Go ≤1.15).
80 // After all available packages have been loaded, we examine the results to
81 // identify any requested or imported packages that are still missing, and if
82 // so, which modules we could add to the module graph in order to make the
83 // missing packages available. We add those to the module graph and iterate,
84 // until either all packages resolve successfully or we cannot identify any
85 // module that would resolve any remaining missing package.
87 // If the main module is “tidy” (that is, if "go mod tidy" is a no-op for it)
88 // and all requested packages are in "all", then loading completes in a single
90 // TODO(bcmills): We should also be able to load in a single iteration if the
91 // requested packages all come from modules that are themselves tidy, regardless
92 // of whether those packages are in "all". Today, that requires two iterations
93 // if those packages are not found in existing dependencies of the main module.
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/mvs"
119 "cmd/go/internal/par"
120 "cmd/go/internal/search"
121 "cmd/go/internal/str"
123 "golang.org/x/mod/module"
124 "golang.org/x/mod/semver"
127 // loaded is the most recently-used package loader.
128 // It holds details about individual packages.
130 // This variable should only be accessed directly in top-level exported
131 // functions. All other functions that require or produce a *loader should pass
132 // or return it as an explicit parameter.
135 // PackageOpts control the behavior of the LoadPackages function.
136 type PackageOpts struct {
137 // GoVersion is the Go version to which the go.mod file should be updated
138 // after packages have been loaded.
140 // An empty GoVersion means to use the Go version already specified in the
141 // main module's go.mod file, or the latest Go version if there is no main
145 // Tags are the build tags in effect (as interpreted by the
146 // cmd/go/internal/imports package).
147 // If nil, treated as equivalent to imports.Tags().
150 // Tidy, if true, requests that the build list and go.sum file be reduced to
151 // the minimial dependencies needed to reproducibly reload the requested
155 // TidyCompatibleVersion is the oldest Go version that must be able to
156 // reproducibly reload the requested packages.
158 // If empty, the compatible version is the Go version immediately prior to the
159 // 'go' version listed in the go.mod file.
160 TidyCompatibleVersion string
162 // VendorModulesInGOROOTSrc indicates that if we are within a module in
163 // GOROOT/src, packages in the module's vendor directory should be resolved as
164 // actual module dependencies (instead of standard-library packages).
165 VendorModulesInGOROOTSrc bool
167 // ResolveMissingImports indicates that we should attempt to add module
168 // dependencies as needed to resolve imports of packages that are not found.
170 // For commands that support the -mod flag, resolving imports may still fail
171 // if the flag is set to "readonly" (the default) or "vendor".
172 ResolveMissingImports bool
174 // AssumeRootsImported indicates that the transitive dependencies of the root
175 // packages should be treated as if those roots will be imported by the main
177 AssumeRootsImported bool
179 // AllowPackage, if non-nil, is called after identifying the module providing
180 // each package. If AllowPackage returns a non-nil error, that error is set
181 // for the package, and the imports and test of that package will not be
184 // AllowPackage may be invoked concurrently by multiple goroutines,
185 // and may be invoked multiple times for a given package path.
186 AllowPackage func(ctx context.Context, path string, mod module.Version) error
188 // LoadTests loads the test dependencies of each package matching a requested
189 // pattern. If ResolveMissingImports is also true, test dependencies will be
190 // resolved if missing.
193 // UseVendorAll causes the "all" package pattern to be interpreted as if
194 // running "go mod vendor" (or building with "-mod=vendor").
196 // This is a no-op for modules that declare 'go 1.16' or higher, for which this
197 // is the default (and only) interpretation of the "all" pattern in module mode.
200 // AllowErrors indicates that LoadPackages should not terminate the process if
204 // SilencePackageErrors indicates that LoadPackages should not print errors
205 // that occur while matching or loading packages, and should not terminate the
206 // process if such an error occurs.
208 // Errors encountered in the module graph will still be reported.
210 // The caller may retrieve the silenced package errors using the Lookup
211 // function, and matching errors are still populated in the Errs field of the
212 // associated search.Match.)
213 SilencePackageErrors bool
215 // SilenceMissingStdImports indicates that LoadPackages should not print
216 // errors or terminate the process if an imported package is missing, and the
217 // import path looks like it might be in the standard library (perhaps in a
219 SilenceMissingStdImports bool
221 // SilenceNoGoErrors indicates that LoadPackages should not print
222 // imports.ErrNoGo errors.
223 // This allows the caller to invoke LoadPackages (and report other errors)
224 // without knowing whether the requested packages exist for the given tags.
226 // Note that if a requested package does not exist *at all*, it will fail
227 // during module resolution and the error will not be suppressed.
228 SilenceNoGoErrors bool
230 // SilenceUnmatchedWarnings suppresses the warnings normally emitted for
231 // patterns that did not match any packages.
232 SilenceUnmatchedWarnings bool
235 // LoadPackages identifies the set of packages matching the given patterns and
236 // loads the packages in the import graph rooted at that set.
237 func LoadPackages(ctx context.Context, opts PackageOpts, patterns ...string) (matches []*search.Match, loadedPackages []string) {
238 if opts.Tags == nil {
239 opts.Tags = imports.Tags()
242 patterns = search.CleanPatterns(patterns)
243 matches = make([]*search.Match, 0, len(patterns))
244 allPatternIsRoot := false
245 for _, pattern := range patterns {
246 matches = append(matches, search.NewMatch(pattern))
247 if pattern == "all" {
248 allPatternIsRoot = true
252 updateMatches := func(rs *Requirements, ld *loader) {
253 for _, m := range matches {
256 // Evaluate list of file system directories on first iteration.
258 matchLocalDirs(ctx, m, rs)
261 // Make a copy of the directory list and translate to import paths.
262 // Note that whether a directory corresponds to an import path
263 // changes as the build list is updated, and a directory can change
264 // from not being in the build list to being in it and back as
265 // the exact version of a particular module increases during
266 // the loader iterations.
268 for _, dir := range m.Dirs {
269 pkg, err := resolveLocalPackage(ctx, dir, rs)
271 if !m.IsLiteral() && (err == errPkgIsBuiltin || err == errPkgIsGorootSrc) {
272 continue // Don't include "builtin" or GOROOT/src in wildcard patterns.
275 // If we're outside of a module, ensure that the failure mode
286 m.Pkgs = append(m.Pkgs, pkg)
290 m.Pkgs = []string{m.Pattern()}
292 case strings.Contains(m.Pattern(), "..."):
294 mg, err := rs.Graph(ctx)
296 // The module graph is (or may be) incomplete — perhaps we failed to
297 // load the requirements of some module. This is an error in matching
298 // the patterns to packages, because we may be missing some packages
299 // or we may erroneously match packages in the wrong versions of
300 // modules. However, for cases like 'go list -e', the error should not
301 // necessarily prevent us from loading the packages we could find.
302 m.Errs = append(m.Errs, err)
304 matchPackages(ctx, m, opts.Tags, includeStd, mg.BuildList())
306 case m.Pattern() == "all":
308 // The initial roots are the packages in the main module.
309 // loadFromRoots will expand that to "all".
311 matchPackages(ctx, m, opts.Tags, omitStd, MainModules.Versions())
313 // Starting with the packages in the main module,
314 // enumerate the full list of "all".
315 m.Pkgs = ld.computePatternAll()
318 case m.Pattern() == "std" || m.Pattern() == "cmd":
320 m.MatchPackages() // Locate the packages within GOROOT/src.
324 panic(fmt.Sprintf("internal error: modload missing case for pattern %s", m.Pattern()))
329 initialRS, _ := loadModFile(ctx) // Ignore needCommit — we're going to commit at the end regardless.
331 ld := loadFromRoots(ctx, loaderParams{
333 requirements: initialRS,
335 allPatternIsRoot: allPatternIsRoot,
337 listRoots: func(rs *Requirements) (roots []string) {
338 updateMatches(rs, nil)
339 for _, m := range matches {
340 roots = append(roots, m.Pkgs...)
346 // One last pass to finalize wildcards.
347 updateMatches(ld.requirements, ld)
349 // List errors in matching patterns (such as directory permission
350 // errors for wildcard patterns).
351 if !ld.SilencePackageErrors {
352 for _, match := range matches {
353 for _, err := range match.Errs {
354 ld.errorf("%v\n", err)
360 if !opts.SilenceUnmatchedWarnings {
361 search.WarnUnmatched(matches)
366 mg, _ := ld.requirements.Graph(ctx)
368 for _, m := range initialRS.rootModules {
370 if ld.requirements.depth == eager {
371 // m is unused if it was dropped from the module graph entirely. If it
372 // was only demoted from direct to indirect, it may still be in use via
373 // a transitive import.
374 unused = mg.Selected(m.Path) == "none"
376 // m is unused if it was dropped from the roots. If it is still present
377 // as a transitive dependency, that transitive dependency is not needed
378 // by any package or test in the main module.
379 _, ok := ld.requirements.rootSelected(m.Path)
383 fmt.Fprintf(os.Stderr, "unused %s\n", m.Path)
388 keep := keepSums(ctx, ld, ld.requirements, loadedZipSumsOnly)
389 if compatDepth := modDepthFromGoVersion(ld.TidyCompatibleVersion); compatDepth != ld.requirements.depth {
390 compatRS := newRequirements(compatDepth, ld.requirements.rootModules, ld.requirements.direct)
391 ld.checkTidyCompatibility(ctx, compatRS)
393 for m := range keepSums(ctx, ld, compatRS, loadedZipSumsOnly) {
399 modfetch.TrimGoSum(keep)
401 // commitRequirements below will also call WriteGoSum, but the "keep" map
402 // we have here could be strictly larger: commitRequirements only commits
403 // loaded.requirements, but here we may have also loaded (and want to
404 // preserve checksums for) additional entities from compatRS, which are
405 // only needed for compatibility with ld.TidyCompatibleVersion.
406 modfetch.WriteGoSum(keep)
410 // Success! Update go.mod and go.sum (if needed) and return the results.
412 commitRequirements(ctx, loaded.GoVersion, loaded.requirements)
414 for _, pkg := range ld.pkgs {
416 loadedPackages = append(loadedPackages, pkg.path)
419 sort.Strings(loadedPackages)
420 return matches, loadedPackages
423 // matchLocalDirs is like m.MatchDirs, but tries to avoid scanning directories
424 // outside of the standard library and active modules.
425 func matchLocalDirs(ctx context.Context, m *search.Match, rs *Requirements) {
427 panic(fmt.Sprintf("internal error: resolveLocalDirs on non-local pattern %s", m.Pattern()))
430 if i := strings.Index(m.Pattern(), "..."); i >= 0 {
431 // The pattern is local, but it is a wildcard. Its packages will
432 // only resolve to paths if they are inside of the standard
433 // library, the main module, or some dependency of the main
434 // module. Verify that before we walk the filesystem: a filesystem
435 // walk in a directory like /var or /etc can be very expensive!
436 dir := filepath.Dir(filepath.Clean(m.Pattern()[:i+3]))
438 if !filepath.IsAbs(dir) {
439 absDir = filepath.Join(base.Cwd(), dir)
441 if search.InDir(absDir, cfg.GOROOTsrc) == "" && search.InDir(absDir, ModRoot()) == "" && pathInModuleCache(ctx, absDir, rs) == "" {
443 m.AddError(fmt.Errorf("directory prefix %s outside available modules", base.ShortPath(absDir)))
448 m.MatchDirs(modRoots)
451 // resolveLocalPackage resolves a filesystem path to a package path.
452 func resolveLocalPackage(ctx context.Context, dir string, rs *Requirements) (string, error) {
454 if filepath.IsAbs(dir) {
455 absDir = filepath.Clean(dir)
457 absDir = filepath.Join(base.Cwd(), dir)
460 bp, err := cfg.BuildContext.ImportDir(absDir, 0)
461 if err != nil && (bp == nil || len(bp.IgnoredGoFiles) == 0) {
462 // golang.org/issue/32917: We should resolve a relative path to a
463 // package path only if the relative path actually contains the code
466 // If the named directory does not exist or contains no Go files,
467 // the package does not exist.
468 // Other errors may affect package loading, but not resolution.
469 if _, err := fsys.Stat(absDir); err != nil {
470 if os.IsNotExist(err) {
471 // Canonicalize OS-specific errors to errDirectoryNotFound so that error
472 // messages will be easier for users to search for.
473 return "", &fs.PathError{Op: "stat", Path: absDir, Err: errDirectoryNotFound}
477 if _, noGo := err.(*build.NoGoError); noGo {
478 // A directory that does not contain any Go source files — even ignored
479 // ones! — is not a Go package, and we can't resolve it to a package
480 // path because that path could plausibly be provided by some other
483 // Any other error indicates that the package “exists” (at least in the
484 // sense that it cannot exist in any other module), but has some other
485 // problem (such as a syntax error).
490 for _, mod := range MainModules.Versions() {
491 modRoot := MainModules.ModRoot(mod)
492 if modRoot != "" && absDir == modRoot {
493 if absDir == cfg.GOROOTsrc {
494 return "", errPkgIsGorootSrc
496 return MainModules.PathPrefix(mod), nil
500 // Note: The checks for @ here are just to avoid misinterpreting
501 // the module cache directories (formerly GOPATH/src/mod/foo@v1.5.2/bar).
502 // It's not strictly necessary but helpful to keep the checks.
503 var pkgNotFoundErr error
504 pkgNotFoundLongestPrefix := ""
505 for _, mainModule := range MainModules.Versions() {
506 modRoot := MainModules.ModRoot(mainModule)
507 if modRoot != "" && strings.HasPrefix(absDir, modRoot+string(filepath.Separator)) && !strings.Contains(absDir[len(modRoot):], "@") {
508 suffix := filepath.ToSlash(absDir[len(modRoot):])
509 if strings.HasPrefix(suffix, "/vendor/") {
510 if cfg.BuildMod != "vendor" {
511 return "", fmt.Errorf("without -mod=vendor, directory %s has no package path", absDir)
515 pkg := strings.TrimPrefix(suffix, "/vendor/")
516 if _, ok := vendorPkgModule[pkg]; !ok {
517 return "", fmt.Errorf("directory %s is not a package listed in vendor/modules.txt", absDir)
522 mainModulePrefix := MainModules.PathPrefix(mainModule)
523 if mainModulePrefix == "" {
524 pkg := strings.TrimPrefix(suffix, "/")
525 if pkg == "builtin" {
526 // "builtin" is a pseudo-package with a real source file.
527 // It's not included in "std", so it shouldn't resolve from "."
528 // within module "std" either.
529 return "", errPkgIsBuiltin
534 pkg := mainModulePrefix + suffix
535 if _, ok, err := dirInModule(pkg, mainModulePrefix, modRoot, true); err != nil {
538 // This main module could contain the directory but doesn't. Other main
539 // modules might contain the directory, so wait till we finish the loop
540 // to see if another main module contains directory. But if not,
542 if len(mainModulePrefix) > len(pkgNotFoundLongestPrefix) {
543 pkgNotFoundLongestPrefix = mainModulePrefix
544 pkgNotFoundErr = &PackageNotInModuleError{Mod: mainModule, Pattern: pkg}
552 if pkgNotFoundErr != nil {
553 return "", pkgNotFoundErr
556 if sub := search.InDir(absDir, cfg.GOROOTsrc); sub != "" && sub != "." && !strings.Contains(sub, "@") {
557 pkg := filepath.ToSlash(sub)
558 if pkg == "builtin" {
559 return "", errPkgIsBuiltin
564 pkg := pathInModuleCache(ctx, absDir, rs)
566 return "", fmt.Errorf("directory %s outside available modules", base.ShortPath(absDir))
572 errDirectoryNotFound = errors.New("directory not found")
573 errPkgIsGorootSrc = errors.New("GOROOT/src is not an importable package")
574 errPkgIsBuiltin = errors.New(`"builtin" is a pseudo-package, not an importable package`)
577 // pathInModuleCache returns the import path of the directory dir,
578 // if dir is in the module cache copy of a module in our build list.
579 func pathInModuleCache(ctx context.Context, dir string, rs *Requirements) string {
580 tryMod := func(m module.Version) (string, bool) {
583 if repl := Replacement(m); repl.Path != "" && repl.Version == "" {
585 if !filepath.IsAbs(root) {
586 root = filepath.Join(ModRoot(), root)
588 } else if repl.Path != "" {
589 root, err = modfetch.DownloadDir(repl)
591 root, err = modfetch.DownloadDir(m)
597 sub := search.InDir(dir, root)
601 sub = filepath.ToSlash(sub)
602 if strings.Contains(sub, "/vendor/") || strings.HasPrefix(sub, "vendor/") || strings.Contains(sub, "@") {
606 return path.Join(m.Path, filepath.ToSlash(sub)), true
609 if rs.depth == lazy {
610 for _, m := range rs.rootModules {
611 if v, _ := rs.rootSelected(m.Path); v != m.Version {
612 continue // m is a root, but we have a higher root for the same path.
614 if importPath, ok := tryMod(m); ok {
615 // checkMultiplePaths ensures that a module can be used for at most one
616 // requirement, so this must be it.
622 // None of the roots contained dir, or we're in eager mode and want to load
623 // the full module graph more aggressively. Either way, check the full graph
624 // to see if the directory is a non-root dependency.
626 // If the roots are not consistent with the full module graph, the selected
627 // versions of root modules may differ from what we already checked above.
628 // Re-check those paths too.
630 mg, _ := rs.Graph(ctx)
631 var importPath string
632 for _, m := range mg.BuildList() {
634 importPath, found = tryMod(m)
642 // ImportFromFiles adds modules to the build list as needed
643 // to satisfy the imports in the named Go source files.
645 // Errors in missing dependencies are silenced.
647 // TODO(bcmills): Silencing errors seems off. Take a closer look at this and
648 // figure out what the error-reporting actually ought to be.
649 func ImportFromFiles(ctx context.Context, gofiles []string) {
650 rs := LoadModFile(ctx)
652 tags := imports.Tags()
653 imports, testImports, err := imports.ScanFiles(gofiles, tags)
655 base.Fatalf("go: %v", err)
658 loaded = loadFromRoots(ctx, loaderParams{
659 PackageOpts: PackageOpts{
661 ResolveMissingImports: true,
662 SilencePackageErrors: true,
665 listRoots: func(*Requirements) (roots []string) {
666 roots = append(roots, imports...)
667 roots = append(roots, testImports...)
671 commitRequirements(ctx, loaded.GoVersion, loaded.requirements)
674 // DirImportPath returns the effective import path for dir,
675 // provided it is within a main module, or else returns ".".
676 func (mms *MainModuleSet) DirImportPath(ctx context.Context, dir string) (path string, m module.Version) {
678 return ".", module.Version{}
680 LoadModFile(ctx) // Sets targetPrefix.
682 if !filepath.IsAbs(dir) {
683 dir = filepath.Join(base.Cwd(), dir)
685 dir = filepath.Clean(dir)
688 var longestPrefix string
689 var longestPrefixPath string
690 var longestPrefixVersion module.Version
691 for _, v := range mms.Versions() {
692 modRoot := mms.ModRoot(v)
694 return mms.PathPrefix(v), v
696 if strings.HasPrefix(dir, modRoot+string(filepath.Separator)) {
697 pathPrefix := MainModules.PathPrefix(v)
698 if pathPrefix > longestPrefix {
699 longestPrefix = pathPrefix
700 longestPrefixVersion = v
701 suffix := filepath.ToSlash(dir[len(modRoot):])
702 if strings.HasPrefix(suffix, "/vendor/") {
703 longestPrefixPath = strings.TrimPrefix(suffix, "/vendor/")
705 longestPrefixPath = mms.PathPrefix(v) + suffix
709 if len(longestPrefix) > 0 {
710 return longestPrefixPath, longestPrefixVersion
713 return ".", module.Version{}
716 // TargetPackages returns the list of packages in the target (top-level) module
717 // matching pattern, which may be relative to the working directory, under all
718 // build tag settings.
719 func TargetPackages(ctx context.Context, pattern string) *search.Match {
720 // TargetPackages is relative to the main module, so ensure that the main
721 // module is a thing that can contain packages.
722 LoadModFile(ctx) // Sets Target.
723 ModRoot() // Emits an error if Target cannot contain packages.
725 m := search.NewMatch(pattern)
726 matchPackages(ctx, m, imports.AnyTags(), omitStd, MainModules.Versions())
730 // ImportMap returns the actual package import path
731 // for an import path found in source code.
732 // If the given import path does not appear in the source code
733 // for the packages that have been loaded, ImportMap returns the empty string.
734 func ImportMap(path string) string {
735 pkg, ok := loaded.pkgCache.Get(path).(*loadPkg)
742 // PackageDir returns the directory containing the source code
743 // for the package named by the import path.
744 func PackageDir(path string) string {
745 pkg, ok := loaded.pkgCache.Get(path).(*loadPkg)
752 // PackageModule returns the module providing the package named by the import path.
753 func PackageModule(path string) module.Version {
754 pkg, ok := loaded.pkgCache.Get(path).(*loadPkg)
756 return module.Version{}
761 // PackageImports returns the imports for the package named by the import path.
762 // Test imports will be returned as well if tests were loaded for the package
763 // (i.e., if "all" was loaded or if LoadTests was set and the path was matched
764 // by a command line argument). PackageImports will return nil for
765 // unknown package paths.
766 func PackageImports(path string) (imports, testImports []string) {
767 pkg, ok := loaded.pkgCache.Get(path).(*loadPkg)
771 imports = make([]string, len(pkg.imports))
772 for i, p := range pkg.imports {
776 testImports = make([]string, len(pkg.test.imports))
777 for i, p := range pkg.test.imports {
778 testImports[i] = p.path
781 return imports, testImports
784 // Lookup returns the source directory, import path, and any loading error for
785 // the package at path as imported from the package in parentDir.
786 // Lookup requires that one of the Load functions in this package has already
788 func Lookup(parentPath string, parentIsStd bool, path string) (dir, realPath string, err error) {
790 panic("Lookup called with empty package path")
794 path = loaded.stdVendor(parentPath, path)
796 pkg, ok := loaded.pkgCache.Get(path).(*loadPkg)
798 // The loader should have found all the relevant paths.
799 // There are a few exceptions, though:
800 // - during go list without -test, the p.Resolve calls to process p.TestImports and p.XTestImports
801 // end up here to canonicalize the import paths.
802 // - during any load, non-loaded packages like "unsafe" end up here.
803 // - during any load, build-injected dependencies like "runtime/cgo" end up here.
804 // - because we ignore appengine/* in the module loader,
805 // the dependencies of any actual appengine/* library end up here.
806 dir := findStandardImportPath(path)
808 return dir, path, nil
810 return "", "", errMissing
812 return pkg.dir, pkg.path, pkg.err
815 // A loader manages the process of loading information about
816 // the required packages for a particular build,
817 // checking that the packages are available in the module set,
818 // and updating the module set if needed.
822 // allClosesOverTests indicates whether the "all" pattern includes
823 // dependencies of tests outside the main module (as in Go 1.11–1.15).
824 // (Otherwise — as in Go 1.16+ — the "all" pattern includes only the packages
825 // transitively *imported by* the packages and tests in the main module.)
826 allClosesOverTests bool
830 // reset on each iteration
832 pkgCache *par.Cache // package path (string) → *loadPkg
833 pkgs []*loadPkg // transitive closure of loaded packages and tests; populated in buildStacks
836 // loaderParams configure the packages loaded by, and the properties reported
837 // by, a loader instance.
838 type loaderParams struct {
840 requirements *Requirements
842 allPatternIsRoot bool // Is the "all" pattern an additional root?
844 listRoots func(rs *Requirements) []string
847 func (ld *loader) reset() {
849 case <-ld.work.Idle():
851 panic("loader.reset when not idle")
855 ld.pkgCache = new(par.Cache)
859 // errorf reports an error via either os.Stderr or base.Errorf,
860 // according to whether ld.AllowErrors is set.
861 func (ld *loader) errorf(format string, args ...interface{}) {
863 fmt.Fprintf(os.Stderr, format, args...)
865 base.Errorf(format, args...)
869 // A loadPkg records information about a single loaded package.
870 type loadPkg struct {
871 // Populated at construction time:
872 path string // import path
875 // Populated at construction time and updated by (*loader).applyPkgFlags:
876 flags atomicLoadPkgFlags
878 // Populated by (*loader).load:
879 mod module.Version // module providing package
880 dir string // directory containing source code
881 err error // error loading package
882 imports []*loadPkg // packages imported by this one
883 testImports []string // test-only imports, saved for use by pkg.test.
886 // Populated by (*loader).pkgTest:
890 // Populated by postprocessing in (*loader).buildStacks:
891 stack *loadPkg // package importing this one in minimal import stack for this pkg
894 // loadPkgFlags is a set of flags tracking metadata about a package.
895 type loadPkgFlags int8
898 // pkgInAll indicates that the package is in the "all" package pattern,
899 // regardless of whether we are loading the "all" package pattern.
901 // When the pkgInAll flag and pkgImportsLoaded flags are both set, the caller
902 // who set the last of those flags must propagate the pkgInAll marking to all
903 // of the imports of the marked package.
905 // A test is marked with pkgInAll if that test would promote the packages it
906 // imports to be in "all" (such as when the test is itself within the main
907 // module, or when ld.allClosesOverTests is true).
908 pkgInAll loadPkgFlags = 1 << iota
910 // pkgIsRoot indicates that the package matches one of the root package
911 // patterns requested by the caller.
913 // If LoadTests is set, then when pkgIsRoot and pkgImportsLoaded are both set,
914 // the caller who set the last of those flags must populate a test for the
915 // package (in the pkg.test field).
917 // If the "all" pattern is included as a root, then non-test packages in "all"
918 // are also roots (and must be marked pkgIsRoot).
921 // pkgFromRoot indicates that the package is in the transitive closure of
922 // imports starting at the roots. (Note that every package marked as pkgIsRoot
923 // is also trivially marked pkgFromRoot.)
926 // pkgImportsLoaded indicates that the imports and testImports fields of a
927 // loadPkg have been populated.
931 // has reports whether all of the flags in cond are set in f.
932 func (f loadPkgFlags) has(cond loadPkgFlags) bool {
933 return f&cond == cond
936 // An atomicLoadPkgFlags stores a loadPkgFlags for which individual flags can be
938 type atomicLoadPkgFlags struct {
942 // update sets the given flags in af (in addition to any flags already set).
944 // update returns the previous flag state so that the caller may determine which
945 // flags were newly-set.
946 func (af *atomicLoadPkgFlags) update(flags loadPkgFlags) (old loadPkgFlags) {
948 old := atomic.LoadInt32(&af.bits)
949 new := old | int32(flags)
950 if new == old || atomic.CompareAndSwapInt32(&af.bits, old, new) {
951 return loadPkgFlags(old)
956 // has reports whether all of the flags in cond are set in af.
957 func (af *atomicLoadPkgFlags) has(cond loadPkgFlags) bool {
958 return loadPkgFlags(atomic.LoadInt32(&af.bits))&cond == cond
961 // isTest reports whether pkg is a test of another package.
962 func (pkg *loadPkg) isTest() bool {
963 return pkg.testOf != nil
966 // fromExternalModule reports whether pkg was loaded from a module other than
968 func (pkg *loadPkg) fromExternalModule() bool {
969 if pkg.mod.Path == "" {
970 return false // loaded from the standard library, not a module
972 return !MainModules.Contains(pkg.mod.Path)
975 var errMissing = errors.New("cannot find package")
977 // loadFromRoots attempts to load the build graph needed to process a set of
978 // root packages and their dependencies.
980 // The set of root packages is returned by the params.listRoots function, and
981 // expanded to the full set of packages by tracing imports (and possibly tests)
983 func loadFromRoots(ctx context.Context, params loaderParams) *loader {
985 loaderParams: params,
986 work: par.NewQueue(runtime.GOMAXPROCS(0)),
989 if ld.GoVersion == "" {
990 ld.GoVersion = modFileGoVersion()
992 if ld.Tidy && semver.Compare("v"+ld.GoVersion, "v"+LatestGoVersion()) > 0 {
993 ld.errorf("go mod tidy: go.mod file indicates go %s, but maximum supported version is %s\n", ld.GoVersion, LatestGoVersion())
999 if ld.TidyCompatibleVersion == "" {
1000 ld.TidyCompatibleVersion = priorGoVersion(ld.GoVersion)
1001 } else if semver.Compare("v"+ld.TidyCompatibleVersion, "v"+ld.GoVersion) > 0 {
1002 // Each version of the Go toolchain knows how to interpret go.mod and
1003 // go.sum files produced by all previous versions, so a compatibility
1004 // version higher than the go.mod version adds nothing.
1005 ld.TidyCompatibleVersion = ld.GoVersion
1009 if semver.Compare("v"+ld.GoVersion, narrowAllVersionV) < 0 && !ld.UseVendorAll {
1010 // The module's go version explicitly predates the change in "all" for lazy
1011 // loading, so continue to use the older interpretation.
1012 ld.allClosesOverTests = true
1016 ld.requirements, err = convertDepth(ctx, ld.requirements, modDepthFromGoVersion(ld.GoVersion))
1018 ld.errorf("go: %v\n", err)
1021 if ld.requirements.depth == eager {
1023 ld.requirements, _, err = expandGraph(ctx, ld.requirements)
1025 ld.errorf("go: %v\n", err)
1032 // Load the root packages and their imports.
1033 // Note: the returned roots can change on each iteration,
1034 // since the expansion of package patterns depends on the
1035 // build list we're using.
1036 rootPkgs := ld.listRoots(ld.requirements)
1038 if ld.requirements.depth == lazy && cfg.BuildMod == "mod" {
1039 // Before we start loading transitive imports of packages, locate all of
1040 // the root packages and promote their containing modules to root modules
1041 // dependencies. If their go.mod files are tidy (the common case) and the
1042 // set of root packages does not change then we can select the correct
1043 // versions of all transitive imports on the first try and complete
1044 // loading in a single iteration.
1045 changedBuildList := ld.preloadRootModules(ctx, rootPkgs)
1046 if changedBuildList {
1047 // The build list has changed, so the set of root packages may have also
1048 // changed. Start over to pick up the changes. (Preloading roots is much
1049 // cheaper than loading the full import graph, so we would rather pay
1050 // for an extra iteration of preloading than potentially end up
1051 // discarding the result of a full iteration of loading.)
1056 inRoots := map[*loadPkg]bool{}
1057 for _, path := range rootPkgs {
1058 root := ld.pkg(ctx, path, pkgIsRoot)
1060 ld.roots = append(ld.roots, root)
1061 inRoots[root] = true
1065 // ld.pkg adds imported packages to the work queue and calls applyPkgFlags,
1066 // which adds tests (and test dependencies) as needed.
1068 // When all of the work in the queue has completed, we'll know that the
1069 // transitive closure of dependencies has been loaded.
1074 changed, err := ld.updateRequirements(ctx)
1076 ld.errorf("go: %v\n", err)
1080 // Don't resolve missing imports until the module graph have stabilized.
1081 // If the roots are still changing, they may turn out to specify a
1082 // requirement on the missing package(s), and we would rather use a
1083 // version specified by a new root than add a new dependency on an
1084 // unrelated version.
1088 if !ld.ResolveMissingImports || (!HasModRoot() && !allowMissingModuleImports) {
1089 // We've loaded as much as we can without resolving missing imports.
1093 modAddedBy := ld.resolveMissingImports(ctx)
1094 if len(modAddedBy) == 0 {
1095 // The roots are stable, and we've resolved all of the missing packages
1100 toAdd := make([]module.Version, 0, len(modAddedBy))
1101 for m, _ := range modAddedBy {
1102 toAdd = append(toAdd, m)
1104 module.Sort(toAdd) // to make errors deterministic
1106 // We ran updateRequirements before resolving missing imports and it didn't
1107 // make any changes, so we know that the requirement graph is already
1108 // consistent with ld.pkgs: we don't need to pass ld.pkgs to updateRoots
1109 // again. (That would waste time looking for changes that we have already
1111 var noPkgs []*loadPkg
1112 // We also know that we're going to call updateRequirements again next
1113 // iteration so we don't need to also update it here. (That would waste time
1114 // computing a "direct" map that we'll have to recompute later anyway.)
1115 direct := ld.requirements.direct
1116 rs, err := updateRoots(ctx, direct, ld.requirements, noPkgs, toAdd, ld.AssumeRootsImported)
1118 // If an error was found in a newly added module, report the package
1119 // import stack instead of the module requirement stack. Packages
1120 // are more descriptive.
1121 if err, ok := err.(*mvs.BuildListError); ok {
1122 if pkg := modAddedBy[err.Module()]; pkg != nil {
1123 ld.errorf("go: %s: %v\n", pkg.stackText(), err.Err)
1127 ld.errorf("go: %v\n", err)
1130 if reflect.DeepEqual(rs.rootModules, ld.requirements.rootModules) {
1131 // Something is deeply wrong. resolveMissingImports gave us a non-empty
1132 // set of modules to add to the graph, but adding those modules had no
1133 // effect — either they were already in the graph, or updateRoots did not
1134 // add them as requested.
1135 panic(fmt.Sprintf("internal error: adding %v to module graph had no effect on root requirements (%v)", toAdd, rs.rootModules))
1137 ld.requirements = rs
1139 base.ExitIfErrors() // TODO(bcmills): Is this actually needed?
1141 // Tidy the build list, if applicable, before we report errors.
1142 // (The process of tidying may remove errors from irrelevant dependencies.)
1144 rs, err := tidyRoots(ctx, ld.requirements, ld.pkgs)
1146 ld.errorf("go: %v\n", err)
1149 if ld.requirements.depth == lazy {
1150 // We continuously add tidy roots to ld.requirements during loading, so at
1151 // this point the tidy roots should be a subset of the roots of
1152 // ld.requirements, ensuring that no new dependencies are brought inside
1153 // the lazy-loading horizon.
1154 // If that is not the case, there is a bug in the loading loop above.
1155 for _, m := range rs.rootModules {
1156 if v, ok := ld.requirements.rootSelected(m.Path); !ok || v != m.Version {
1157 ld.errorf("go mod tidy: internal error: a requirement on %v is needed but was not added during package loading\n", m)
1162 ld.requirements = rs
1165 // Report errors, if any.
1166 for _, pkg := range ld.pkgs {
1171 // Add importer information to checksum errors.
1172 if sumErr := (*ImportMissingSumError)(nil); errors.As(pkg.err, &sumErr) {
1173 if importer := pkg.stack; importer != nil {
1174 sumErr.importer = importer.path
1175 sumErr.importerVersion = importer.mod.Version
1176 sumErr.importerIsTest = importer.testOf != nil
1180 if ld.SilencePackageErrors {
1183 if stdErr := (*ImportMissingError)(nil); errors.As(pkg.err, &stdErr) &&
1184 stdErr.isStd && ld.SilenceMissingStdImports {
1187 if ld.SilenceNoGoErrors && errors.Is(pkg.err, imports.ErrNoGo) {
1191 ld.errorf("%s: %v\n", pkg.stackText(), pkg.err)
1194 ld.checkMultiplePaths()
1198 // updateRequirements ensures that ld.requirements is consistent with the
1199 // information gained from ld.pkgs and includes the modules in add as roots at
1200 // at least the given versions.
1204 // - Modules that provide packages directly imported from the main module are
1205 // marked as direct, and are promoted to explicit roots. If a needed root
1206 // cannot be promoted due to -mod=readonly or -mod=vendor, the importing
1207 // package is marked with an error.
1209 // - If ld scanned the "all" pattern independent of build constraints, it is
1210 // guaranteed to have seen every direct import. Module dependencies that did
1211 // not provide any directly-imported package are then marked as indirect.
1213 // - Root dependencies are updated to their selected versions.
1215 // The "changed" return value reports whether the update changed the selected
1216 // version of any module that either provided a loaded package or may now
1217 // provide a package that was previously unresolved.
1218 func (ld *loader) updateRequirements(ctx context.Context) (changed bool, err error) {
1219 rs := ld.requirements
1221 // direct contains the set of modules believed to provide packages directly
1222 // imported by the main module.
1223 var direct map[string]bool
1225 // If we didn't scan all of the imports from the main module, or didn't use
1226 // imports.AnyTags, then we didn't necessarily load every package that
1227 // contributes “direct” imports — so we can't safely mark existing direct
1228 // dependencies in ld.requirements as indirect-only. Propagate them as direct.
1229 loadedDirect := ld.allPatternIsRoot && reflect.DeepEqual(ld.Tags, imports.AnyTags())
1231 direct = make(map[string]bool)
1233 // TODO(bcmills): It seems like a shame to allocate and copy a map here when
1234 // it will only rarely actually vary from rs.direct. Measure this cost and
1235 // maybe avoid the copy.
1236 direct = make(map[string]bool, len(rs.direct))
1237 for mPath := range rs.direct {
1238 direct[mPath] = true
1242 for _, pkg := range ld.pkgs {
1243 if pkg.mod.Version != "" || !MainModules.Contains(pkg.mod.Path) {
1246 for _, dep := range pkg.imports {
1247 if !dep.fromExternalModule() {
1251 if pkg.err == nil && cfg.BuildMod != "mod" {
1252 if v, ok := rs.rootSelected(dep.mod.Path); !ok || v != dep.mod.Version {
1253 // dep.mod is not an explicit dependency, but needs to be.
1254 // Because we are not in "mod" mode, we will not be able to update it.
1255 // Instead, mark the importing package with an error.
1257 // TODO(#41688): The resulting error message fails to include the file
1258 // position of the import statement (because that information is not
1259 // tracked by the module loader). Figure out how to plumb the import
1260 // position through.
1261 pkg.err = &DirectImportFromImplicitDependencyError{
1262 ImporterPath: pkg.path,
1263 ImportedPath: dep.path,
1266 // cfg.BuildMod does not allow us to change dep.mod to be a direct
1267 // dependency, so don't mark it as such.
1272 // dep is a package directly imported by a package or test in the main
1273 // module and loaded from some other module (not the standard library).
1274 // Mark its module as a direct dependency.
1275 direct[dep.mod.Path] = true
1279 var addRoots []module.Version
1281 // When we are tidying a lazy module, we may need to add roots to preserve
1282 // the versions of indirect, test-only dependencies that are upgraded
1283 // above or otherwise missing from the go.mod files of direct
1284 // dependencies. (For example, the direct dependency might be a very
1285 // stable codebase that predates modules and thus lacks a go.mod file, or
1286 // the author of the direct dependency may have forgotten to commit a
1287 // change to the go.mod file, or may have made an erroneous hand-edit that
1288 // causes it to be untidy.)
1290 // Promoting an indirect dependency to a root adds the next layer of its
1291 // dependencies to the module graph, which may increase the selected
1292 // versions of other modules from which we have already loaded packages.
1293 // So after we promote an indirect dependency to a root, we need to reload
1294 // packages, which means another iteration of loading.
1296 // As an extra wrinkle, the upgrades due to promoting a root can cause
1297 // previously-resolved packages to become unresolved. For example, the
1298 // module providing an unstable package might be upgraded to a version
1299 // that no longer contains that package. If we then resolve the missing
1300 // package, we might add yet another root that upgrades away some other
1301 // dependency. (The tests in mod_tidy_convergence*.txt illustrate some
1302 // particularly worrisome cases.)
1304 // To ensure that this process of promoting, adding, and upgrading roots
1305 // eventually terminates, during iteration we only ever add modules to the
1306 // root set — we only remove irrelevant roots at the very end of
1307 // iteration, after we have already added every root that we plan to need
1308 // in the (eventual) tidy root set.
1310 // Since we do not remove any roots during iteration, even if they no
1311 // longer provide any imported packages, the selected versions of the
1312 // roots can only increase and the set of roots can only expand. The set
1313 // of extant root paths is finite and the set of versions of each path is
1314 // finite, so the iteration *must* reach a stable fixed-point.
1315 tidy, err := tidyRoots(ctx, rs, ld.pkgs)
1319 addRoots = tidy.rootModules
1322 rs, err = updateRoots(ctx, direct, rs, ld.pkgs, addRoots, ld.AssumeRootsImported)
1324 // We don't actually know what even the root requirements are supposed to be,
1325 // so we can't proceed with loading. Return the error to the caller
1329 if rs != ld.requirements && !reflect.DeepEqual(rs.rootModules, ld.requirements.rootModules) {
1330 // The roots of the module graph have changed in some way (not just the
1331 // "direct" markings). Check whether the changes affected any of the loaded
1333 mg, err := rs.Graph(ctx)
1337 for _, pkg := range ld.pkgs {
1338 if pkg.fromExternalModule() && mg.Selected(pkg.mod.Path) != pkg.mod.Version {
1343 // Promoting a module to a root may resolve an import that was
1344 // previously missing (by pulling in a previously-prune dependency that
1345 // provides it) or ambiguous (by promoting exactly one of the
1346 // alternatives to a root and ignoring the second-level alternatives) or
1347 // otherwise errored out (by upgrading from a version that cannot be
1348 // fetched to one that can be).
1350 // Instead of enumerating all of the possible errors, we'll just check
1351 // whether importFromModules returns nil for the package.
1352 // False-positives are ok: if we have a false-positive here, we'll do an
1353 // extra iteration of package loading this time, but we'll still
1354 // converge when the root set stops changing.
1356 // In some sense, we can think of this as ‘upgraded the module providing
1357 // pkg.path from "none" to a version higher than "none"’.
1358 if _, _, err = importFromModules(ctx, pkg.path, rs, nil); err == nil {
1366 ld.requirements = rs
1370 // resolveMissingImports returns a set of modules that could be added as
1371 // dependencies in order to resolve missing packages from pkgs.
1373 // The newly-resolved packages are added to the addedModuleFor map, and
1374 // resolveMissingImports returns a map from each new module version to
1375 // the first missing package that module would resolve.
1376 func (ld *loader) resolveMissingImports(ctx context.Context) (modAddedBy map[module.Version]*loadPkg) {
1377 type pkgMod struct {
1381 var pkgMods []pkgMod
1382 for _, pkg := range ld.pkgs {
1387 // If we are missing a test, we are also missing its non-test version, and
1388 // we should only add the missing import once.
1391 if !errors.As(pkg.err, new(*ImportMissingError)) {
1392 // Leave other errors for Import or load.Packages to report.
1397 var mod module.Version
1398 ld.work.Add(func() {
1400 mod, err = queryImport(ctx, pkg.path, ld.requirements)
1402 // pkg.err was already non-nil, so we can reasonably attribute the error
1403 // for pkg to either the original error or the one returned by
1404 // queryImport. The existing error indicates only that we couldn't find
1405 // the package, whereas the query error also explains why we didn't fix
1406 // the problem — so we prefer the latter.
1410 // err is nil, but we intentionally leave pkg.err non-nil and pkg.mod
1411 // unset: we still haven't satisfied other invariants of a
1412 // successfully-loaded package, such as scanning and loading the imports
1413 // of that package. If we succeed in resolving the new dependency graph,
1414 // the caller can reload pkg and update the error at that point.
1416 // Even then, the package might not be loaded from the version we've
1417 // identified here. The module may be upgraded by some other dependency,
1418 // or by a transitive dependency of mod itself, or — less likely — the
1419 // package may be rejected by an AllowPackage hook or rendered ambiguous
1420 // by some other newly-added or newly-upgraded dependency.
1423 pkgMods = append(pkgMods, pkgMod{pkg: pkg, mod: &mod})
1427 modAddedBy = map[module.Version]*loadPkg{}
1428 for _, pm := range pkgMods {
1429 pkg, mod := pm.pkg, *pm.mod
1434 fmt.Fprintf(os.Stderr, "go: found %s in %s %s\n", pkg.path, mod.Path, mod.Version)
1435 if modAddedBy[mod] == nil {
1436 modAddedBy[mod] = pkg
1443 // pkg locates the *loadPkg for path, creating and queuing it for loading if
1444 // needed, and updates its state to reflect the given flags.
1446 // The imports of the returned *loadPkg will be loaded asynchronously in the
1447 // ld.work queue, and its test (if requested) will also be populated once
1448 // imports have been resolved. When ld.work goes idle, all transitive imports of
1449 // the requested package (and its test, if requested) will have been loaded.
1450 func (ld *loader) pkg(ctx context.Context, path string, flags loadPkgFlags) *loadPkg {
1451 if flags.has(pkgImportsLoaded) {
1452 panic("internal error: (*loader).pkg called with pkgImportsLoaded flag set")
1455 pkg := ld.pkgCache.Do(path, func() interface{} {
1459 ld.applyPkgFlags(ctx, pkg, flags)
1461 ld.work.Add(func() { ld.load(ctx, pkg) })
1465 ld.applyPkgFlags(ctx, pkg, flags)
1469 // applyPkgFlags updates pkg.flags to set the given flags and propagate the
1470 // (transitive) effects of those flags, possibly loading or enqueueing further
1471 // packages as a result.
1472 func (ld *loader) applyPkgFlags(ctx context.Context, pkg *loadPkg, flags loadPkgFlags) {
1477 if flags.has(pkgInAll) && ld.allPatternIsRoot && !pkg.isTest() {
1478 // This package matches a root pattern by virtue of being in "all".
1481 if flags.has(pkgIsRoot) {
1482 flags |= pkgFromRoot
1485 old := pkg.flags.update(flags)
1487 if new == old || !new.has(pkgImportsLoaded) {
1488 // We either didn't change the state of pkg, or we don't know anything about
1489 // its dependencies yet. Either way, we can't usefully load its test or
1490 // update its dependencies.
1495 // Check whether we should add (or update the flags for) a test for pkg.
1496 // ld.pkgTest is idempotent and extra invocations are inexpensive,
1497 // so it's ok if we call it more than is strictly necessary.
1500 case ld.allPatternIsRoot && MainModules.Contains(pkg.mod.Path):
1501 // We are loading the "all" pattern, which includes packages imported by
1502 // tests in the main module. This package is in the main module, so we
1503 // need to identify the imports of its test even if LoadTests is not set.
1505 // (We will filter out the extra tests explicitly in computePatternAll.)
1508 case ld.allPatternIsRoot && ld.allClosesOverTests && new.has(pkgInAll):
1509 // This variant of the "all" pattern includes imports of tests of every
1510 // package that is itself in "all", and pkg is in "all", so its test is
1511 // also in "all" (as above).
1514 case ld.LoadTests && new.has(pkgIsRoot):
1515 // LoadTest explicitly requests tests of “the root packages”.
1520 var testFlags loadPkgFlags
1521 if MainModules.Contains(pkg.mod.Path) || (ld.allClosesOverTests && new.has(pkgInAll)) {
1522 // Tests of packages in the main module are in "all", in the sense that
1523 // they cause the packages they import to also be in "all". So are tests
1524 // of packages in "all" if "all" closes over test dependencies.
1525 testFlags |= pkgInAll
1527 ld.pkgTest(ctx, pkg, testFlags)
1531 if new.has(pkgInAll) && !old.has(pkgInAll|pkgImportsLoaded) {
1532 // We have just marked pkg with pkgInAll, or we have just loaded its
1533 // imports, or both. Now is the time to propagate pkgInAll to the imports.
1534 for _, dep := range pkg.imports {
1535 ld.applyPkgFlags(ctx, dep, pkgInAll)
1539 if new.has(pkgFromRoot) && !old.has(pkgFromRoot|pkgImportsLoaded) {
1540 for _, dep := range pkg.imports {
1541 ld.applyPkgFlags(ctx, dep, pkgFromRoot)
1546 // preloadRootModules loads the module requirements needed to identify the
1547 // selected version of each module providing a package in rootPkgs,
1548 // adding new root modules to the module graph if needed.
1549 func (ld *loader) preloadRootModules(ctx context.Context, rootPkgs []string) (changedBuildList bool) {
1550 needc := make(chan map[module.Version]bool, 1)
1551 needc <- map[module.Version]bool{}
1552 for _, path := range rootPkgs {
1554 ld.work.Add(func() {
1555 // First, try to identify the module containing the package using only roots.
1557 // If the main module is tidy and the package is in "all" — or if we're
1558 // lucky — we can identify all of its imports without actually loading the
1559 // full module graph.
1560 m, _, err := importFromModules(ctx, path, ld.requirements, nil)
1562 var missing *ImportMissingError
1563 if errors.As(err, &missing) && ld.ResolveMissingImports {
1564 // This package isn't provided by any selected module.
1565 // If we can find it, it will be a new root dependency.
1566 m, err = queryImport(ctx, path, ld.requirements)
1569 // We couldn't identify the root module containing this package.
1570 // Leave it unresolved; we will report it during loading.
1575 // The package is in std or cmd. We don't need to change the root set.
1579 v, ok := ld.requirements.rootSelected(m.Path)
1580 if !ok || v != m.Version {
1581 // We found the requested package in m, but m is not a root, so
1582 // loadModGraph will not load its requirements. We need to promote the
1583 // module to a root to ensure that any other packages this package
1584 // imports are resolved from correct dependency versions.
1586 // (This is the “argument invariant” from the lazy loading design.)
1597 return false // No roots to add.
1600 toAdd := make([]module.Version, 0, len(need))
1601 for m := range need {
1602 toAdd = append(toAdd, m)
1606 rs, err := updateRoots(ctx, ld.requirements.direct, ld.requirements, nil, toAdd, ld.AssumeRootsImported)
1608 // We are missing some root dependency, and for some reason we can't load
1609 // enough of the module dependency graph to add the missing root. Package
1610 // loading is doomed to fail, so fail quickly.
1611 ld.errorf("go: %v\n", err)
1615 if reflect.DeepEqual(rs.rootModules, ld.requirements.rootModules) {
1616 // Something is deeply wrong. resolveMissingImports gave us a non-empty
1617 // set of modules to add to the graph, but adding those modules had no
1618 // effect — either they were already in the graph, or updateRoots did not
1619 // add them as requested.
1620 panic(fmt.Sprintf("internal error: adding %v to module graph had no effect on root requirements (%v)", toAdd, rs.rootModules))
1623 ld.requirements = rs
1627 // load loads an individual package.
1628 func (ld *loader) load(ctx context.Context, pkg *loadPkg) {
1629 if strings.Contains(pkg.path, "@") {
1630 // Leave for error during load.
1633 if build.IsLocalImport(pkg.path) || filepath.IsAbs(pkg.path) {
1634 // Leave for error during load.
1635 // (Module mode does not allow local imports.)
1639 if search.IsMetaPackage(pkg.path) {
1640 pkg.err = &invalidImportError{
1641 importPath: pkg.path,
1642 err: fmt.Errorf("%q is not an importable package; see 'go help packages'", pkg.path),
1648 if ld.requirements.depth == eager {
1650 mg, err = ld.requirements.Graph(ctx)
1652 // We already checked the error from Graph in loadFromRoots and/or
1653 // updateRequirements, so we ignored the error on purpose and we should
1654 // keep trying to push past it.
1656 // However, because mg may be incomplete (and thus may select inaccurate
1657 // versions), we shouldn't use it to load packages. Instead, we pass a nil
1658 // *ModuleGraph, which will cause mg to first try loading from only the
1659 // main module and root dependencies.
1664 pkg.mod, pkg.dir, pkg.err = importFromModules(ctx, pkg.path, ld.requirements, mg)
1668 if MainModules.Contains(pkg.mod.Path) {
1669 // Go ahead and mark pkg as in "all". This provides the invariant that a
1670 // package that is *only* imported by other packages in "all" is always
1671 // marked as such before loading its imports.
1673 // We don't actually rely on that invariant at the moment, but it may
1674 // improve efficiency somewhat and makes the behavior a bit easier to reason
1675 // about (by reducing churn on the flag bits of dependencies), and costs
1676 // essentially nothing (these atomic flag ops are essentially free compared
1677 // to scanning source code for imports).
1678 ld.applyPkgFlags(ctx, pkg, pkgInAll)
1680 if ld.AllowPackage != nil {
1681 if err := ld.AllowPackage(ctx, pkg.path, pkg.mod); err != nil {
1686 pkg.inStd = (search.IsStandardImportPath(pkg.path) && search.InDir(pkg.dir, cfg.GOROOTsrc) != "")
1688 var imports, testImports []string
1690 if cfg.BuildContext.Compiler == "gccgo" && pkg.inStd {
1691 // We can't scan standard packages for gccgo.
1694 imports, testImports, err = scanDir(pkg.dir, ld.Tags)
1701 pkg.imports = make([]*loadPkg, 0, len(imports))
1702 var importFlags loadPkgFlags
1703 if pkg.flags.has(pkgInAll) {
1704 importFlags = pkgInAll
1706 for _, path := range imports {
1708 // Imports from packages in "std" and "cmd" should resolve using
1709 // GOROOT/src/vendor even when "std" is not the main module.
1710 path = ld.stdVendor(pkg.path, path)
1712 pkg.imports = append(pkg.imports, ld.pkg(ctx, path, importFlags))
1714 pkg.testImports = testImports
1716 ld.applyPkgFlags(ctx, pkg, pkgImportsLoaded)
1719 // pkgTest locates the test of pkg, creating it if needed, and updates its state
1720 // to reflect the given flags.
1722 // pkgTest requires that the imports of pkg have already been loaded (flagged
1723 // with pkgImportsLoaded).
1724 func (ld *loader) pkgTest(ctx context.Context, pkg *loadPkg, testFlags loadPkgFlags) *loadPkg {
1726 panic("pkgTest called on a test package")
1729 createdTest := false
1730 pkg.testOnce.Do(func() {
1731 pkg.test = &loadPkg{
1739 ld.applyPkgFlags(ctx, pkg.test, testFlags)
1745 test.imports = make([]*loadPkg, 0, len(pkg.testImports))
1746 var importFlags loadPkgFlags
1747 if test.flags.has(pkgInAll) {
1748 importFlags = pkgInAll
1750 for _, path := range pkg.testImports {
1752 path = ld.stdVendor(test.path, path)
1754 test.imports = append(test.imports, ld.pkg(ctx, path, importFlags))
1756 pkg.testImports = nil
1757 ld.applyPkgFlags(ctx, test, pkgImportsLoaded)
1759 ld.applyPkgFlags(ctx, test, testFlags)
1765 // stdVendor returns the canonical import path for the package with the given
1766 // path when imported from the standard-library package at parentPath.
1767 func (ld *loader) stdVendor(parentPath, path string) string {
1768 if search.IsStandardImportPath(path) {
1772 if str.HasPathPrefix(parentPath, "cmd") {
1773 if !ld.VendorModulesInGOROOTSrc || !MainModules.Contains("cmd") {
1774 vendorPath := pathpkg.Join("cmd", "vendor", path)
1776 if _, err := os.Stat(filepath.Join(cfg.GOROOTsrc, filepath.FromSlash(vendorPath))); err == nil {
1780 } else if !ld.VendorModulesInGOROOTSrc || !MainModules.Contains("std") || str.HasPathPrefix(parentPath, "vendor") {
1781 // If we are outside of the 'std' module, resolve imports from within 'std'
1782 // to the vendor directory.
1784 // Do the same for importers beginning with the prefix 'vendor/' even if we
1785 // are *inside* of the 'std' module: the 'vendor/' packages that resolve
1786 // globally from GOROOT/src/vendor (and are listed as part of 'go list std')
1787 // are distinct from the real module dependencies, and cannot import
1788 // internal packages from the real module.
1790 // (Note that although the 'vendor/' packages match the 'std' *package*
1791 // pattern, they are not part of the std *module*, and do not affect
1792 // 'go mod tidy' and similar module commands when working within std.)
1793 vendorPath := pathpkg.Join("vendor", path)
1794 if _, err := os.Stat(filepath.Join(cfg.GOROOTsrc, filepath.FromSlash(vendorPath))); err == nil {
1799 // Not vendored: resolve from modules.
1803 // computePatternAll returns the list of packages matching pattern "all",
1804 // starting with a list of the import paths for the packages in the main module.
1805 func (ld *loader) computePatternAll() (all []string) {
1806 for _, pkg := range ld.pkgs {
1807 if pkg.flags.has(pkgInAll) && !pkg.isTest() {
1808 all = append(all, pkg.path)
1815 // checkMultiplePaths verifies that a given module path is used as itself
1816 // or as a replacement for another module, but not both at the same time.
1818 // (See https://golang.org/issue/26607 and https://golang.org/issue/34650.)
1819 func (ld *loader) checkMultiplePaths() {
1820 mods := ld.requirements.rootModules
1821 if cached := ld.requirements.graph.Load(); cached != nil {
1822 if mg := cached.(cachedGraph).mg; mg != nil {
1823 mods = mg.BuildList()
1827 firstPath := map[module.Version]string{}
1828 for _, mod := range mods {
1829 src := resolveReplacement(mod)
1830 if prev, ok := firstPath[src]; !ok {
1831 firstPath[src] = mod.Path
1832 } else if prev != mod.Path {
1833 ld.errorf("go: %s@%s used for two different module paths (%s and %s)\n", src.Path, src.Version, prev, mod.Path)
1838 // checkTidyCompatibility emits an error if any package would be loaded from a
1839 // different module under rs than under ld.requirements.
1840 func (ld *loader) checkTidyCompatibility(ctx context.Context, rs *Requirements) {
1841 suggestUpgrade := false
1842 suggestEFlag := false
1843 suggestFixes := func() {
1845 // The user is explicitly ignoring these errors, so don't bother them with
1850 // We print directly to os.Stderr because this information is advice about
1851 // how to fix errors, not actually an error itself.
1852 // (The actual errors should have been logged already.)
1854 fmt.Fprintln(os.Stderr)
1857 if ld.GoVersion != modFileGoVersion() {
1858 goFlag = " -go=" + ld.GoVersion
1862 if ld.TidyCompatibleVersion != priorGoVersion(ld.GoVersion) {
1863 compatFlag = " -compat=" + ld.TidyCompatibleVersion
1869 eDesc = ", leaving some packages unresolved"
1872 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)
1873 } else if suggestEFlag {
1874 // If some packages are missing but no package is upgraded, then we
1875 // shouldn't suggest upgrading to the Go 1.16 versions explicitly — that
1876 // wouldn't actually fix anything for Go 1.16 users, and *would* break
1877 // something for Go 1.17 users.
1878 fmt.Fprintf(os.Stderr, "To proceed despite packages unresolved in go %s:\n\tgo mod tidy -e%s%s\n", ld.TidyCompatibleVersion, goFlag, compatFlag)
1881 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)
1883 // TODO(#46141): Populate the linked wiki page.
1884 fmt.Fprintf(os.Stderr, "For other options, see:\n\thttps://golang.org/wiki/PruningModules\n")
1887 mg, err := rs.Graph(ctx)
1889 ld.errorf("go mod tidy: error loading go %s module graph: %v\n", ld.TidyCompatibleVersion, err)
1894 // Re-resolve packages in parallel.
1896 // We re-resolve each package — rather than just checking versions — to ensure
1897 // that we have fetched module source code (and, importantly, checksums for
1898 // that source code) for all modules that are necessary to ensure that imports
1899 // are unambiguous. That also produces clearer diagnostics, since we can say
1900 // exactly what happened to the package if it became ambiguous or disappeared
1903 // We re-resolve the packages in parallel because this process involves disk
1904 // I/O to check for package sources, and because the process of checking for
1905 // ambiguous imports may require us to download additional modules that are
1906 // otherwise pruned out in Go 1.17 — we don't want to block progress on other
1907 // packages while we wait for a single new download.
1908 type mismatch struct {
1912 mismatchMu := make(chan map[*loadPkg]mismatch, 1)
1913 mismatchMu <- map[*loadPkg]mismatch{}
1914 for _, pkg := range ld.pkgs {
1915 if pkg.mod.Path == "" && pkg.err == nil {
1916 // This package is from the standard library (which does not vary based on
1917 // the module graph).
1922 ld.work.Add(func() {
1923 mod, _, err := importFromModules(ctx, pkg.path, rs, mg)
1925 mismatches := <-mismatchMu
1926 mismatches[pkg] = mismatch{mod: mod, err: err}
1927 mismatchMu <- mismatches
1933 mismatches := <-mismatchMu
1934 if len(mismatches) == 0 {
1935 // Since we're running as part of 'go mod tidy', the roots of the module
1936 // graph should contain only modules that are relevant to some package in
1937 // the package graph. We checked every package in the package graph and
1938 // didn't find any mismatches, so that must mean that all of the roots of
1939 // the module graph are also consistent.
1941 // If we're wrong, Go 1.16 in -mod=readonly mode will error out with
1942 // "updates to go.mod needed", which would be very confusing. So instead,
1943 // we'll double-check that our reasoning above actually holds — if it
1944 // doesn't, we'll emit an internal error and hopefully the user will report
1946 for _, m := range ld.requirements.rootModules {
1947 if v := mg.Selected(m.Path); v != m.Version {
1948 fmt.Fprintln(os.Stderr)
1949 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)
1955 // Iterate over the packages (instead of the mismatches map) to emit errors in
1956 // deterministic order.
1957 for _, pkg := range ld.pkgs {
1958 mismatch, ok := mismatches[pkg]
1964 // We already did (or will) report an error for the package itself,
1965 // so don't report a duplicate (and more vebose) error for its test.
1966 if _, ok := mismatches[pkg.testOf]; !ok {
1967 base.Fatalf("go: internal error: mismatch recorded for test %s, but not its non-test package", pkg.path)
1973 case mismatch.err != nil:
1974 // pkg resolved successfully, but errors out using the requirements in rs.
1976 // This could occur because the import is provided by a single lazy root
1977 // (and is thus unambiguous in lazy mode) and also one or more
1978 // transitive dependencies (and is ambiguous in eager mode).
1980 // It could also occur because some transitive dependency upgrades the
1981 // module that previously provided the package to a version that no
1982 // longer does, or to a version for which the module source code (but
1983 // not the go.mod file in isolation) has a checksum error.
1984 if missing := (*ImportMissingError)(nil); errors.As(mismatch.err, &missing) {
1985 selected := module.Version{
1987 Version: mg.Selected(pkg.mod.Path),
1989 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)
1991 if ambiguous := (*AmbiguousImportError)(nil); errors.As(mismatch.err, &ambiguous) {
1992 // TODO: Is this check needed?
1994 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)
1999 // Even if we press ahead with the '-e' flag, the older version will
2000 // error out in readonly mode if it thinks the go.mod file contains
2001 // any *explicit* dependency that is not at its selected version,
2002 // even if that dependency is not relevant to any package being loaded.
2004 // We check for that condition here. If all of the roots are consistent
2005 // the '-e' flag suffices, but otherwise we need to suggest an upgrade.
2006 if !suggestUpgrade {
2007 for _, m := range ld.requirements.rootModules {
2008 if v := mg.Selected(m.Path); v != m.Version {
2009 suggestUpgrade = true
2015 case pkg.err != nil:
2016 // pkg had an error in lazy mode (presumably suppressed with the -e flag),
2017 // but not in eager mode.
2019 // This is possible, if, say, the import is unresolved in lazy mode
2020 // (because the "latest" version of each candidate module either is
2021 // unavailable or does not contain the package), but is resolved in
2022 // eager mode due to a newer-than-latest dependency that is normally
2023 // runed out of the module graph.
2025 // This could also occur if the source code for the module providing the
2026 // package in lazy mode has a checksum error, but eager mode upgrades
2027 // that module to a version with a correct checksum.
2029 // pkg.err should have already been logged elsewhere — along with a
2030 // stack trace — so log only the import path and non-error info here.
2031 suggestUpgrade = true
2032 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)
2034 case pkg.mod != mismatch.mod:
2035 // The package is loaded successfully by both Go versions, but from a
2036 // different module in each. This could lead to subtle (and perhaps even
2037 // unnoticed!) variations in behavior between builds with different
2039 suggestUpgrade = true
2040 ld.errorf("%s loaded from %v,\n\tbut go %s would select %v\n", pkg.stackText(), pkg.mod, ld.TidyCompatibleVersion, mismatch.mod.Version)
2043 base.Fatalf("go: internal error: mismatch recorded for package %s, but no differences found", pkg.path)
2051 // scanDir is like imports.ScanDir but elides known magic imports from the list,
2052 // so that we do not go looking for packages that don't really exist.
2054 // The standard magic import is "C", for cgo.
2056 // The only other known magic imports are appengine and appengine/*.
2057 // These are so old that they predate "go get" and did not use URL-like paths.
2058 // Most code today now uses google.golang.org/appengine instead,
2059 // but not all code has been so updated. When we mostly ignore build tags
2060 // during "go vendor", we look into "// +build appengine" files and
2061 // may see these legacy imports. We drop them so that the module
2062 // search does not look for modules to try to satisfy them.
2063 func scanDir(dir string, tags map[string]bool) (imports_, testImports []string, err error) {
2064 imports_, testImports, err = imports.ScanDir(dir, tags)
2066 filter := func(x []string) []string {
2068 for _, pkg := range x {
2069 if pkg != "C" && pkg != "appengine" && !strings.HasPrefix(pkg, "appengine/") &&
2070 pkg != "appengine_internal" && !strings.HasPrefix(pkg, "appengine_internal/") {
2078 return filter(imports_), filter(testImports), err
2081 // buildStacks computes minimal import stacks for each package,
2082 // for use in error messages. When it completes, packages that
2083 // are part of the original root set have pkg.stack == nil,
2084 // and other packages have pkg.stack pointing at the next
2085 // package up the import stack in their minimal chain.
2086 // As a side effect, buildStacks also constructs ld.pkgs,
2087 // the list of all packages loaded.
2088 func (ld *loader) buildStacks() {
2089 if len(ld.pkgs) > 0 {
2090 panic("buildStacks")
2092 for _, pkg := range ld.roots {
2093 pkg.stack = pkg // sentinel to avoid processing in next loop
2094 ld.pkgs = append(ld.pkgs, pkg)
2096 for i := 0; i < len(ld.pkgs); i++ { // not range: appending to ld.pkgs in loop
2098 for _, next := range pkg.imports {
2099 if next.stack == nil {
2101 ld.pkgs = append(ld.pkgs, next)
2104 if next := pkg.test; next != nil && next.stack == nil {
2106 ld.pkgs = append(ld.pkgs, next)
2109 for _, pkg := range ld.roots {
2114 // stackText builds the import stack text to use when
2115 // reporting an error in pkg. It has the general form
2120 // other2.test imports
2123 func (pkg *loadPkg) stackText() string {
2124 var stack []*loadPkg
2125 for p := pkg; p != nil; p = p.stack {
2126 stack = append(stack, p)
2129 var buf bytes.Buffer
2130 for i := len(stack) - 1; i >= 0; i-- {
2132 fmt.Fprint(&buf, p.path)
2133 if p.testOf != nil {
2134 fmt.Fprint(&buf, ".test")
2137 if stack[i-1].testOf == p {
2138 fmt.Fprint(&buf, " tested by\n\t")
2140 fmt.Fprint(&buf, " imports\n\t")
2147 // why returns the text to use in "go mod why" output about the given package.
2148 // It is less ornate than the stackText but contains the same information.
2149 func (pkg *loadPkg) why() string {
2150 var buf strings.Builder
2151 var stack []*loadPkg
2152 for p := pkg; p != nil; p = p.stack {
2153 stack = append(stack, p)
2156 for i := len(stack) - 1; i >= 0; i-- {
2158 if p.testOf != nil {
2159 fmt.Fprintf(&buf, "%s.test\n", p.testOf.path)
2161 fmt.Fprintf(&buf, "%s\n", p.path)
2167 // Why returns the "go mod why" output stanza for the given package,
2168 // without the leading # comment.
2169 // The package graph must have been loaded already, usually by LoadPackages.
2170 // If there is no reason for the package to be in the current build,
2171 // Why returns an empty string.
2172 func Why(path string) string {
2173 pkg, ok := loaded.pkgCache.Get(path).(*loadPkg)
2180 // WhyDepth returns the number of steps in the Why listing.
2181 // If there is no reason for the package to be in the current build,
2182 // WhyDepth returns 0.
2183 func WhyDepth(path string) int {
2185 pkg, _ := loaded.pkgCache.Get(path).(*loadPkg)
2186 for p := pkg; p != nil; p = p.stack {