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.
21 "cmd/go/internal/fsys"
22 "cmd/go/internal/imports"
23 "cmd/go/internal/modindex"
25 "cmd/go/internal/search"
26 "cmd/go/internal/trace"
27 "cmd/internal/pkgpattern"
29 "golang.org/x/mod/module"
35 omitStd = stdFilter(iota)
39 // matchPackages is like m.MatchPackages, but uses a local variable (rather than
40 // a global) for tags, can include or exclude packages in the standard library,
41 // and is restricted to the given list of modules.
42 func matchPackages(ctx context.Context, m *search.Match, tags map[string]bool, filter stdFilter, modules []module.Version) {
43 ctx, span := trace.StartSpan(ctx, "modload.matchPackages")
48 isMatch := func(string) bool { return true }
49 treeCanMatch := func(string) bool { return true }
51 isMatch = pkgpattern.MatchPattern(m.Pattern())
52 treeCanMatch = pkgpattern.TreeCanMatchPattern(m.Pattern())
56 have := map[string]bool{
57 "builtin": true, // ignore pseudo-package that exists only for documentation
59 addPkg := func(p string) {
61 m.Pkgs = append(m.Pkgs, p)
64 if !cfg.BuildContext.CgoEnabled {
65 have["runtime/cgo"] = true // ignore during walk
70 pruneVendor = pruning(1 << iota)
74 q := par.NewQueue(runtime.GOMAXPROCS(0))
76 walkPkgs := func(root, importPathRoot string, prune pruning) {
77 _, span := trace.StartSpan(ctx, "walkPkgs "+root)
80 root = filepath.Clean(root)
81 err := fsys.Walk(root, func(path string, fi fs.FileInfo, err error) error {
90 // Don't use GOROOT/src but do walk down into it.
92 if importPathRoot == "" {
96 // Avoid .foo, _foo, and testdata subdirectory trees.
97 _, elem = filepath.Split(path)
98 if strings.HasPrefix(elem, ".") || strings.HasPrefix(elem, "_") || elem == "testdata" {
103 name := importPathRoot + filepath.ToSlash(path[len(root):])
104 if importPathRoot == "" {
105 name = name[1:] // cut leading slash
107 if !treeCanMatch(name) {
112 if fi.Mode()&fs.ModeSymlink != 0 && want && strings.Contains(m.Pattern(), "...") {
113 if target, err := fsys.Stat(path); err == nil && target.IsDir() {
114 fmt.Fprintf(os.Stderr, "warning: ignoring symlink %s\n", path)
121 return filepath.SkipDir
123 // Stop at module boundaries.
124 if (prune&pruneGoMod != 0) && path != root {
125 if fi, err := os.Stat(filepath.Join(path, "go.mod")); err == nil && !fi.IsDir() {
126 return filepath.SkipDir
134 if _, _, err := scanDir(root, path, tags); err != imports.ErrNoGo {
141 if elem == "vendor" && (prune&pruneVendor != 0) {
142 return filepath.SkipDir
151 // Wait for all in-flight operations to complete before returning.
154 sort.Strings(m.Pkgs) // sort everything we added for determinism
157 if filter == includeStd {
158 walkPkgs(cfg.GOROOTsrc, "", pruneGoMod)
159 if treeCanMatch("cmd") {
160 walkPkgs(filepath.Join(cfg.GOROOTsrc, "cmd"), "cmd", pruneGoMod)
164 if cfg.BuildMod == "vendor" {
165 mod := MainModules.mustGetSingleMainModule()
166 if modRoot := MainModules.ModRoot(mod); modRoot != "" {
167 walkPkgs(modRoot, MainModules.PathPrefix(mod), pruneGoMod|pruneVendor)
168 walkPkgs(filepath.Join(modRoot, "vendor"), "", pruneVendor)
173 for _, mod := range modules {
174 if !treeCanMatch(mod.Path) {
179 root, modPrefix string
182 if MainModules.Contains(mod.Path) {
183 if MainModules.ModRoot(mod) == "" {
184 continue // If there is no main module, we can't search in it.
186 root = MainModules.ModRoot(mod)
187 modPrefix = MainModules.PathPrefix(mod)
192 root, isLocal, err = fetch(ctx, mod, needSum)
199 if mi, err := modindex.GetModule(root); err == nil {
200 walkFromIndex(mi, modPrefix, isMatch, treeCanMatch, tags, have, addPkg)
202 } else if !errors.Is(err, modindex.ErrNotIndexed) {
210 walkPkgs(root, modPrefix, prune)
216 // walkFromIndex matches packages in a module using the module index. modroot
217 // is the module's root directory on disk, index is the modindex.Module for the
218 // module, and importPathRoot is the module's path prefix.
219 func walkFromIndex(index *modindex.Module, importPathRoot string, isMatch, treeCanMatch func(string) bool, tags, have map[string]bool, addPkg func(string)) {
220 index.Walk(func(reldir string) {
221 // Avoid .foo, _foo, and testdata subdirectory trees.
224 elem, rest, found := strings.Cut(p, string(filepath.Separator))
225 if strings.HasPrefix(elem, ".") || strings.HasPrefix(elem, "_") || elem == "testdata" {
228 if found && elem == "vendor" {
229 // Ignore this path if it contains the element "vendor" anywhere
230 // except for the last element (packages named vendor are allowed
231 // for historical reasons). Note that found is true when this
232 // isn't the last path element.
236 // Didn't find the separator, so we're considering the last element.
242 // Don't use GOROOT/src.
243 if reldir == "" && importPathRoot == "" {
247 name := path.Join(importPathRoot, filepath.ToSlash(reldir))
248 if !treeCanMatch(name) {
255 if _, _, err := index.Package(reldir).ScanDir(tags); err != imports.ErrNoGo {
263 // MatchInModule identifies the packages matching the given pattern within the
264 // given module version, which does not need to be in the build list or module
265 // requirement graph.
267 // If m is the zero module.Version, MatchInModule matches the pattern
268 // against the standard library (std and cmd) in GOROOT/src.
269 func MatchInModule(ctx context.Context, pattern string, m module.Version, tags map[string]bool) *search.Match {
270 match := search.NewMatch(pattern)
271 if m == (module.Version{}) {
272 matchPackages(ctx, match, tags, includeStd, nil)
275 LoadModFile(ctx) // Sets Target, needed by fetch and matchPackages.
277 if !match.IsLiteral() {
278 matchPackages(ctx, match, tags, omitStd, []module.Version{m})
283 root, isLocal, err := fetch(ctx, m, needSum)
285 match.Errs = []error{err}
289 dir, haveGoFiles, err := dirInModule(pattern, m.Path, root, isLocal)
291 match.Errs = []error{err}
295 if _, _, err := scanDir(root, dir, tags); err != imports.ErrNoGo {
296 // ErrNoGo indicates that the directory is not actually a Go package,
297 // perhaps due to the tags in use. Any other non-nil error indicates a
298 // problem with one or more of the Go source files, but such an error does
299 // not stop the package from existing, so it has no impact on matching.
300 match.Pkgs = []string{pattern}