1 // Copyright 2011 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
16 exec "internal/execabs"
33 // A Context specifies the supporting context for a build.
35 GOARCH string // target architecture
36 GOOS string // target operating system
37 GOROOT string // Go root
38 GOPATH string // Go path
40 // Dir is the caller's working directory, or the empty string to use
41 // the current directory of the running process. In module mode, this is used
42 // to locate the main module.
44 // If Dir is non-empty, directories passed to Import and ImportDir must
48 CgoEnabled bool // whether cgo files are included
49 UseAllFiles bool // use files regardless of +build lines, file names
50 Compiler string // compiler to assume when computing target paths
52 // The build, tool, and release tags specify build constraints
53 // that should be considered satisfied when processing +build lines.
54 // Clients creating a new context may customize BuildTags, which
55 // defaults to empty, but it is usually an error to customize ToolTags or ReleaseTags.
56 // ToolTags defaults to build tags appropriate to the current Go toolchain configuration.
57 // ReleaseTags defaults to the list of Go releases the current release is compatible with.
58 // BuildTags is not set for the Default build Context.
59 // In addition to the BuildTags, ToolTags, and ReleaseTags, build constraints
60 // consider the values of GOARCH and GOOS as satisfied tags.
61 // The last element in ReleaseTags is assumed to be the current release.
66 // The install suffix specifies a suffix to use in the name of the installation
67 // directory. By default it is empty, but custom builds that need to keep
68 // their outputs separate can set InstallSuffix to do so. For example, when
69 // using the race detector, the go command uses InstallSuffix = "race", so
70 // that on a Linux/386 system, packages are written to a directory named
71 // "linux_386_race" instead of the usual "linux_386".
74 // By default, Import uses the operating system's file system calls
75 // to read directories and files. To read from other sources,
76 // callers can set the following functions. They all have default
77 // behaviors that use the local file system, so clients need only set
78 // the functions whose behaviors they wish to change.
80 // JoinPath joins the sequence of path fragments into a single path.
81 // If JoinPath is nil, Import uses filepath.Join.
82 JoinPath func(elem ...string) string
84 // SplitPathList splits the path list into a slice of individual paths.
85 // If SplitPathList is nil, Import uses filepath.SplitList.
86 SplitPathList func(list string) []string
88 // IsAbsPath reports whether path is an absolute path.
89 // If IsAbsPath is nil, Import uses filepath.IsAbs.
90 IsAbsPath func(path string) bool
92 // IsDir reports whether the path names a directory.
93 // If IsDir is nil, Import calls os.Stat and uses the result's IsDir method.
94 IsDir func(path string) bool
96 // HasSubdir reports whether dir is lexically a subdirectory of
97 // root, perhaps multiple levels below. It does not try to check
98 // whether dir exists.
99 // If so, HasSubdir sets rel to a slash-separated path that
100 // can be joined to root to produce a path equivalent to dir.
101 // If HasSubdir is nil, Import uses an implementation built on
102 // filepath.EvalSymlinks.
103 HasSubdir func(root, dir string) (rel string, ok bool)
105 // ReadDir returns a slice of fs.FileInfo, sorted by Name,
106 // describing the content of the named directory.
107 // If ReadDir is nil, Import uses ioutil.ReadDir.
108 ReadDir func(dir string) ([]fs.FileInfo, error)
110 // OpenFile opens a file (not a directory) for reading.
111 // If OpenFile is nil, Import uses os.Open.
112 OpenFile func(path string) (io.ReadCloser, error)
115 // joinPath calls ctxt.JoinPath (if not nil) or else filepath.Join.
116 func (ctxt *Context) joinPath(elem ...string) string {
117 if f := ctxt.JoinPath; f != nil {
120 return filepath.Join(elem...)
123 // splitPathList calls ctxt.SplitPathList (if not nil) or else filepath.SplitList.
124 func (ctxt *Context) splitPathList(s string) []string {
125 if f := ctxt.SplitPathList; f != nil {
128 return filepath.SplitList(s)
131 // isAbsPath calls ctxt.IsAbsPath (if not nil) or else filepath.IsAbs.
132 func (ctxt *Context) isAbsPath(path string) bool {
133 if f := ctxt.IsAbsPath; f != nil {
136 return filepath.IsAbs(path)
139 // isDir calls ctxt.IsDir (if not nil) or else uses os.Stat.
140 func (ctxt *Context) isDir(path string) bool {
141 if f := ctxt.IsDir; f != nil {
144 fi, err := os.Stat(path)
145 return err == nil && fi.IsDir()
148 // hasSubdir calls ctxt.HasSubdir (if not nil) or else uses
149 // the local file system to answer the question.
150 func (ctxt *Context) hasSubdir(root, dir string) (rel string, ok bool) {
151 if f := ctxt.HasSubdir; f != nil {
155 // Try using paths we received.
156 if rel, ok = hasSubdir(root, dir); ok {
160 // Try expanding symlinks and comparing
161 // expanded against unexpanded and
162 // expanded against expanded.
163 rootSym, _ := filepath.EvalSymlinks(root)
164 dirSym, _ := filepath.EvalSymlinks(dir)
166 if rel, ok = hasSubdir(rootSym, dir); ok {
169 if rel, ok = hasSubdir(root, dirSym); ok {
172 return hasSubdir(rootSym, dirSym)
175 // hasSubdir reports if dir is within root by performing lexical analysis only.
176 func hasSubdir(root, dir string) (rel string, ok bool) {
177 const sep = string(filepath.Separator)
178 root = filepath.Clean(root)
179 if !strings.HasSuffix(root, sep) {
182 dir = filepath.Clean(dir)
183 if !strings.HasPrefix(dir, root) {
186 return filepath.ToSlash(dir[len(root):]), true
189 // readDir calls ctxt.ReadDir (if not nil) or else ioutil.ReadDir.
190 func (ctxt *Context) readDir(path string) ([]fs.FileInfo, error) {
191 if f := ctxt.ReadDir; f != nil {
194 // TODO: use os.ReadDir
195 return ioutil.ReadDir(path)
198 // openFile calls ctxt.OpenFile (if not nil) or else os.Open.
199 func (ctxt *Context) openFile(path string) (io.ReadCloser, error) {
200 if fn := ctxt.OpenFile; fn != nil {
204 f, err := os.Open(path)
206 return nil, err // nil interface
211 // isFile determines whether path is a file by trying to open it.
212 // It reuses openFile instead of adding another function to the
214 func (ctxt *Context) isFile(path string) bool {
215 f, err := ctxt.openFile(path)
223 // gopath returns the list of Go path directories.
224 func (ctxt *Context) gopath() []string {
226 for _, p := range ctxt.splitPathList(ctxt.GOPATH) {
227 if p == "" || p == ctxt.GOROOT {
228 // Empty paths are uninteresting.
229 // If the path is the GOROOT, ignore it.
230 // People sometimes set GOPATH=$GOROOT.
231 // Do not get confused by this common mistake.
234 if strings.HasPrefix(p, "~") {
235 // Path segments starting with ~ on Unix are almost always
236 // users who have incorrectly quoted ~ while setting GOPATH,
237 // preventing it from expanding to $HOME.
238 // The situation is made more confusing by the fact that
239 // bash allows quoted ~ in $PATH (most shells do not).
240 // Do not get confused by this, and do not try to use the path.
241 // It does not exist, and printing errors about it confuses
242 // those users even more, because they think "sure ~ exists!".
243 // The go command diagnoses this situation and prints a
245 // On Windows, ~ is used in short names, such as c:\progra~1
246 // for c:\program files.
254 // SrcDirs returns a list of package source root directories.
255 // It draws from the current Go root and Go path but omits directories
256 // that do not exist.
257 func (ctxt *Context) SrcDirs() []string {
259 if ctxt.GOROOT != "" && ctxt.Compiler != "gccgo" {
260 dir := ctxt.joinPath(ctxt.GOROOT, "src")
262 all = append(all, dir)
265 for _, p := range ctxt.gopath() {
266 dir := ctxt.joinPath(p, "src")
268 all = append(all, dir)
274 // Default is the default Context for builds.
275 // It uses the GOARCH, GOOS, GOROOT, and GOPATH environment variables
276 // if set, or else the compiled code's GOARCH, GOOS, and GOROOT.
277 var Default Context = defaultContext()
279 func defaultGOPATH() string {
281 if runtime.GOOS == "windows" {
283 } else if runtime.GOOS == "plan9" {
286 if home := os.Getenv(env); home != "" {
287 def := filepath.Join(home, "go")
288 if filepath.Clean(def) == filepath.Clean(runtime.GOROOT()) {
289 // Don't set the default GOPATH to GOROOT,
290 // as that will trigger warnings from the go tool.
298 var defaultToolTags, defaultReleaseTags []string
300 func defaultContext() Context {
303 c.GOARCH = buildcfg.GOARCH
304 c.GOOS = buildcfg.GOOS
305 c.GOROOT = pathpkg.Clean(runtime.GOROOT())
306 c.GOPATH = envOr("GOPATH", defaultGOPATH())
307 c.Compiler = runtime.Compiler
309 // For each experiment that has been enabled in the toolchain, define a
310 // build tag with the same name but prefixed by "goexperiment." which can be
311 // used for compiling alternative files for the experiment. This allows
312 // changes for the experiment, like extra struct fields in the runtime,
313 // without affecting the base non-experiment code at all.
314 for _, exp := range buildcfg.EnabledExperiments() {
315 c.ToolTags = append(c.ToolTags, "goexperiment."+exp)
317 defaultToolTags = append([]string{}, c.ToolTags...) // our own private copy
319 // Each major Go release in the Go 1.x series adds a new
320 // "go1.x" release tag. That is, the go1.x tag is present in
321 // all releases >= Go 1.x. Code that requires Go 1.x or later
322 // should say "+build go1.x", and code that should only be
323 // built before Go 1.x (perhaps it is the stub to use in that
324 // case) should say "+build !go1.x".
325 // The last element in ReleaseTags is the current release.
326 for i := 1; i <= goversion.Version; i++ {
327 c.ReleaseTags = append(c.ReleaseTags, "go1."+strconv.Itoa(i))
330 defaultReleaseTags = append([]string{}, c.ReleaseTags...) // our own private copy
332 env := os.Getenv("CGO_ENABLED")
334 env = defaultCGO_ENABLED
342 // cgo must be explicitly enabled for cross compilation builds
343 if runtime.GOARCH == c.GOARCH && runtime.GOOS == c.GOOS {
344 c.CgoEnabled = cgoEnabled[c.GOOS+"/"+c.GOARCH]
353 func envOr(name, def string) string {
361 // An ImportMode controls the behavior of the Import method.
365 // If FindOnly is set, Import stops after locating the directory
366 // that should contain the sources for a package. It does not
367 // read any files in the directory.
368 FindOnly ImportMode = 1 << iota
370 // If AllowBinary is set, Import can be satisfied by a compiled
371 // package object without corresponding sources.
374 // The supported way to create a compiled-only package is to
375 // write source code containing a //go:binary-only-package comment at
376 // the top of the file. Such a package will be recognized
377 // regardless of this flag setting (because it has source code)
378 // and will have BinaryOnly set to true in the returned Package.
381 // If ImportComment is set, parse import comments on package statements.
382 // Import returns an error if it finds a comment it cannot understand
383 // or finds conflicting comments in multiple source files.
384 // See golang.org/s/go14customimport for more information.
387 // By default, Import searches vendor directories
388 // that apply in the given source directory before searching
389 // the GOROOT and GOPATH roots.
390 // If an Import finds and returns a package using a vendor
391 // directory, the resulting ImportPath is the complete path
392 // to the package, including the path elements leading up
393 // to and including "vendor".
394 // For example, if Import("y", "x/subdir", 0) finds
395 // "x/vendor/y", the returned package's ImportPath is "x/vendor/y",
397 // See golang.org/s/go15vendor for more information.
399 // Setting IgnoreVendor ignores vendor directories.
401 // In contrast to the package's ImportPath,
402 // the returned package's Imports, TestImports, and XTestImports
403 // are always the exact import paths from the source files:
404 // Import makes no attempt to resolve or check those paths.
408 // A Package describes the Go package found in a directory.
409 type Package struct {
410 Dir string // directory containing package sources
411 Name string // package name
412 ImportComment string // path in import comment on package statement
413 Doc string // documentation synopsis
414 ImportPath string // import path of package ("" if unknown)
415 Root string // root of Go tree where this package lives
416 SrcRoot string // package source root directory ("" if unknown)
417 PkgRoot string // package install root directory ("" if unknown)
418 PkgTargetRoot string // architecture dependent install root directory ("" if unknown)
419 BinDir string // command install directory ("" if unknown)
420 Goroot bool // package found in Go root
421 PkgObj string // installed .a file
422 AllTags []string // tags that can influence file selection in this directory
423 ConflictDir string // this directory shadows Dir in $GOPATH
424 BinaryOnly bool // cannot be rebuilt from source (has //go:binary-only-package comment)
427 GoFiles []string // .go source files (excluding CgoFiles, TestGoFiles, XTestGoFiles)
428 CgoFiles []string // .go source files that import "C"
429 IgnoredGoFiles []string // .go source files ignored for this build (including ignored _test.go files)
430 InvalidGoFiles []string // .go source files with detected problems (parse error, wrong package name, and so on)
431 IgnoredOtherFiles []string // non-.go source files ignored for this build
432 CFiles []string // .c source files
433 CXXFiles []string // .cc, .cpp and .cxx source files
434 MFiles []string // .m (Objective-C) source files
435 HFiles []string // .h, .hh, .hpp and .hxx source files
436 FFiles []string // .f, .F, .for and .f90 Fortran source files
437 SFiles []string // .s source files
438 SwigFiles []string // .swig files
439 SwigCXXFiles []string // .swigcxx files
440 SysoFiles []string // .syso system object files to add to archive
443 CgoCFLAGS []string // Cgo CFLAGS directives
444 CgoCPPFLAGS []string // Cgo CPPFLAGS directives
445 CgoCXXFLAGS []string // Cgo CXXFLAGS directives
446 CgoFFLAGS []string // Cgo FFLAGS directives
447 CgoLDFLAGS []string // Cgo LDFLAGS directives
448 CgoPkgConfig []string // Cgo pkg-config directives
451 TestGoFiles []string // _test.go files in package
452 XTestGoFiles []string // _test.go files outside package
454 // Dependency information
455 Imports []string // import paths from GoFiles, CgoFiles
456 ImportPos map[string][]token.Position // line information for Imports
457 TestImports []string // import paths from TestGoFiles
458 TestImportPos map[string][]token.Position // line information for TestImports
459 XTestImports []string // import paths from XTestGoFiles
460 XTestImportPos map[string][]token.Position // line information for XTestImports
462 // //go:embed patterns found in Go source files
463 // For example, if a source file says
465 // then the list will contain those two strings as separate entries.
466 // (See package embed for more details about //go:embed.)
467 EmbedPatterns []string // patterns from GoFiles, CgoFiles
468 EmbedPatternPos map[string][]token.Position // line information for EmbedPatterns
469 TestEmbedPatterns []string // patterns from TestGoFiles
470 TestEmbedPatternPos map[string][]token.Position // line information for TestEmbedPatterns
471 XTestEmbedPatterns []string // patterns from XTestGoFiles
472 XTestEmbedPatternPos map[string][]token.Position // line information for XTestEmbedPatternPos
475 // IsCommand reports whether the package is considered a
476 // command to be installed (not just a library).
477 // Packages named "main" are treated as commands.
478 func (p *Package) IsCommand() bool {
479 return p.Name == "main"
482 // ImportDir is like Import but processes the Go package found in
483 // the named directory.
484 func (ctxt *Context) ImportDir(dir string, mode ImportMode) (*Package, error) {
485 return ctxt.Import(".", dir, mode)
488 // NoGoError is the error used by Import to describe a directory
489 // containing no buildable Go source files. (It may still contain
490 // test files, files hidden by build tags, and so on.)
491 type NoGoError struct {
495 func (e *NoGoError) Error() string {
496 return "no buildable Go source files in " + e.Dir
499 // MultiplePackageError describes a directory containing
500 // multiple buildable Go source files for multiple packages.
501 type MultiplePackageError struct {
502 Dir string // directory containing files
503 Packages []string // package names found
504 Files []string // corresponding files: Files[i] declares package Packages[i]
507 func (e *MultiplePackageError) Error() string {
508 // Error string limited to two entries for compatibility.
509 return fmt.Sprintf("found packages %s (%s) and %s (%s) in %s", e.Packages[0], e.Files[0], e.Packages[1], e.Files[1], e.Dir)
512 func nameExt(name string) string {
513 i := strings.LastIndex(name, ".")
520 // Import returns details about the Go package named by the import path,
521 // interpreting local import paths relative to the srcDir directory.
522 // If the path is a local import path naming a package that can be imported
523 // using a standard import path, the returned package will set p.ImportPath
526 // In the directory containing the package, .go, .c, .h, and .s files are
527 // considered part of the package except for:
529 // - .go files in package documentation
530 // - files starting with _ or . (likely editor temporary files)
531 // - files with build constraints not satisfied by the context
533 // If an error occurs, Import returns a non-nil error and a non-nil
534 // *Package containing partial information.
536 func (ctxt *Context) Import(path string, srcDir string, mode ImportMode) (*Package, error) {
541 return p, fmt.Errorf("import %q: invalid import path", path)
544 var pkgtargetroot string
548 if ctxt.InstallSuffix != "" {
549 suffix = "_" + ctxt.InstallSuffix
551 switch ctxt.Compiler {
553 pkgtargetroot = "pkg/gccgo_" + ctxt.GOOS + "_" + ctxt.GOARCH + suffix
555 pkgtargetroot = "pkg/" + ctxt.GOOS + "_" + ctxt.GOARCH + suffix
557 // Save error for end of function.
558 pkgerr = fmt.Errorf("import %q: unknown compiler %q", path, ctxt.Compiler)
561 switch ctxt.Compiler {
563 dir, elem := pathpkg.Split(p.ImportPath)
564 pkga = pkgtargetroot + "/" + dir + "lib" + elem + ".a"
566 pkga = pkgtargetroot + "/" + p.ImportPath + ".a"
572 if IsLocalImport(path) {
573 pkga = "" // local imports have no installed path
575 return p, fmt.Errorf("import %q: import relative to unknown directory", path)
577 if !ctxt.isAbsPath(path) {
578 p.Dir = ctxt.joinPath(srcDir, path)
580 // p.Dir directory may or may not exist. Gather partial information first, check if it exists later.
581 // Determine canonical import path, if any.
582 // Exclude results where the import path would include /testdata/.
583 inTestdata := func(sub string) bool {
584 return strings.Contains(sub, "/testdata/") || strings.HasSuffix(sub, "/testdata") || strings.HasPrefix(sub, "testdata/") || sub == "testdata"
586 if ctxt.GOROOT != "" {
587 root := ctxt.joinPath(ctxt.GOROOT, "src")
588 if sub, ok := ctxt.hasSubdir(root, p.Dir); ok && !inTestdata(sub) {
592 setPkga() // p.ImportPath changed
597 for i, root := range all {
598 rootsrc := ctxt.joinPath(root, "src")
599 if sub, ok := ctxt.hasSubdir(rootsrc, p.Dir); ok && !inTestdata(sub) {
600 // We found a potential import path for dir,
601 // but check that using it wouldn't find something
603 if ctxt.GOROOT != "" && ctxt.Compiler != "gccgo" {
604 if dir := ctxt.joinPath(ctxt.GOROOT, "src", sub); ctxt.isDir(dir) {
609 for _, earlyRoot := range all[:i] {
610 if dir := ctxt.joinPath(earlyRoot, "src", sub); ctxt.isDir(dir) {
616 // sub would not name some other directory instead of this one.
620 setPkga() // p.ImportPath changed
624 // It's okay that we didn't find a root containing dir.
625 // Keep going with the information we have.
627 if strings.HasPrefix(path, "/") {
628 return p, fmt.Errorf("import %q: cannot import absolute path", path)
631 if err := ctxt.importGo(p, path, srcDir, mode); err == nil {
633 } else if err != errNoModules {
637 gopath := ctxt.gopath() // needed twice below; avoid computing many times
639 // tried records the location of unsuccessful package lookups
646 // Vendor directories get first chance to satisfy import.
647 if mode&IgnoreVendor == 0 && srcDir != "" {
648 searchVendor := func(root string, isGoroot bool) bool {
649 sub, ok := ctxt.hasSubdir(root, srcDir)
650 if !ok || !strings.HasPrefix(sub, "src/") || strings.Contains(sub, "/testdata/") {
654 vendor := ctxt.joinPath(root, sub, "vendor")
655 if ctxt.isDir(vendor) {
656 dir := ctxt.joinPath(vendor, path)
657 if ctxt.isDir(dir) && hasGoFiles(ctxt, dir) {
659 p.ImportPath = strings.TrimPrefix(pathpkg.Join(sub, "vendor", path), "src/")
662 setPkga() // p.ImportPath changed
665 tried.vendor = append(tried.vendor, dir)
667 i := strings.LastIndex(sub, "/")
675 if ctxt.Compiler != "gccgo" && searchVendor(ctxt.GOROOT, true) {
678 for _, root := range gopath {
679 if searchVendor(root, false) {
685 // Determine directory from import path.
686 if ctxt.GOROOT != "" {
687 // If the package path starts with "vendor/", only search GOROOT before
688 // GOPATH if the importer is also within GOROOT. That way, if the user has
689 // vendored in a package that is subsequently included in the standard
690 // distribution, they'll continue to pick up their own vendored copy.
691 gorootFirst := srcDir == "" || !strings.HasPrefix(path, "vendor/")
693 _, gorootFirst = ctxt.hasSubdir(ctxt.GOROOT, srcDir)
696 dir := ctxt.joinPath(ctxt.GOROOT, "src", path)
697 if ctxt.Compiler != "gccgo" {
698 isDir := ctxt.isDir(dir)
699 binaryOnly = !isDir && mode&AllowBinary != 0 && pkga != "" && ctxt.isFile(ctxt.joinPath(ctxt.GOROOT, pkga))
700 if isDir || binaryOnly {
710 if ctxt.Compiler == "gccgo" && goroot.IsStandardPackage(ctxt.GOROOT, ctxt.Compiler, path) {
711 p.Dir = ctxt.joinPath(ctxt.GOROOT, "src", path)
716 for _, root := range gopath {
717 dir := ctxt.joinPath(root, "src", path)
718 isDir := ctxt.isDir(dir)
719 binaryOnly = !isDir && mode&AllowBinary != 0 && pkga != "" && ctxt.isFile(ctxt.joinPath(root, pkga))
720 if isDir || binaryOnly {
725 tried.gopath = append(tried.gopath, dir)
728 // If we tried GOPATH first due to a "vendor/" prefix, fall back to GOPATH.
729 // That way, the user can still get useful results from 'go list' for
730 // standard-vendored paths passed on the command line.
731 if ctxt.GOROOT != "" && tried.goroot == "" {
732 dir := ctxt.joinPath(ctxt.GOROOT, "src", path)
733 if ctxt.Compiler != "gccgo" {
734 isDir := ctxt.isDir(dir)
735 binaryOnly = !isDir && mode&AllowBinary != 0 && pkga != "" && ctxt.isFile(ctxt.joinPath(ctxt.GOROOT, pkga))
736 if isDir || binaryOnly {
746 // package was not found
748 format := "\t%s (vendor tree)"
749 for _, dir := range tried.vendor {
750 paths = append(paths, fmt.Sprintf(format, dir))
753 if tried.goroot != "" {
754 paths = append(paths, fmt.Sprintf("\t%s (from $GOROOT)", tried.goroot))
756 paths = append(paths, "\t($GOROOT not set)")
758 format = "\t%s (from $GOPATH)"
759 for _, dir := range tried.gopath {
760 paths = append(paths, fmt.Sprintf(format, dir))
763 if len(tried.gopath) == 0 {
764 paths = append(paths, "\t($GOPATH not set. For more details see: 'go help gopath')")
766 return p, fmt.Errorf("cannot find package %q in any of:\n%s", path, strings.Join(paths, "\n"))
771 p.SrcRoot = ctxt.joinPath(p.Root, "src")
772 p.PkgRoot = ctxt.joinPath(p.Root, "pkg")
773 p.BinDir = ctxt.joinPath(p.Root, "bin")
775 p.PkgTargetRoot = ctxt.joinPath(p.Root, pkgtargetroot)
776 p.PkgObj = ctxt.joinPath(p.Root, pkga)
780 // If it's a local import path, by the time we get here, we still haven't checked
781 // that p.Dir directory exists. This is the right time to do that check.
782 // We can't do it earlier, because we want to gather partial information for the
783 // non-nil *Package returned when an error occurs.
784 // We need to do this before we return early on FindOnly flag.
785 if IsLocalImport(path) && !ctxt.isDir(p.Dir) {
786 if ctxt.Compiler == "gccgo" && p.Goroot {
787 // gccgo has no sources for GOROOT packages.
791 // package was not found
792 return p, fmt.Errorf("cannot find package %q in:\n\t%s", path, p.Dir)
795 if mode&FindOnly != 0 {
798 if binaryOnly && (mode&AllowBinary) != 0 {
802 if ctxt.Compiler == "gccgo" && p.Goroot {
803 // gccgo has no sources for GOROOT packages.
807 dirs, err := ctxt.readDir(p.Dir)
813 badFiles := make(map[string]bool)
814 badFile := func(name string, err error) {
815 if badGoError == nil {
819 p.InvalidGoFiles = append(p.InvalidGoFiles, name)
820 badFiles[name] = true
824 var Sfiles []string // files with ".S"(capital S)/.sx(capital s equivalent for case insensitive filesystems)
825 var firstFile, firstCommentFile string
826 embedPos := make(map[string][]token.Position)
827 testEmbedPos := make(map[string][]token.Position)
828 xTestEmbedPos := make(map[string][]token.Position)
829 importPos := make(map[string][]token.Position)
830 testImportPos := make(map[string][]token.Position)
831 xTestImportPos := make(map[string][]token.Position)
832 allTags := make(map[string]bool)
833 fset := token.NewFileSet()
834 for _, d := range dirs {
838 if d.Mode()&fs.ModeSymlink != 0 {
839 if ctxt.isDir(ctxt.joinPath(p.Dir, d.Name())) {
840 // Symlinks to directories are not source files.
848 info, err := ctxt.matchFile(p.Dir, name, allTags, &p.BinaryOnly, fset)
854 if strings.HasPrefix(name, "_") || strings.HasPrefix(name, ".") {
855 // not due to build constraints - don't report
856 } else if ext == ".go" {
857 p.IgnoredGoFiles = append(p.IgnoredGoFiles, name)
858 } else if fileListForExt(p, ext) != nil {
859 p.IgnoredOtherFiles = append(p.IgnoredOtherFiles, name)
863 data, filename := info.header, info.name
865 // Going to save the file. For non-Go files, can stop here.
870 // special case for cgo, handled at end
871 Sfiles = append(Sfiles, name)
874 if list := fileListForExt(p, ext); list != nil {
875 *list = append(*list, name)
880 if info.parseErr != nil {
881 badFile(name, info.parseErr)
882 // Fall through: we might still have a partial AST in info.parsed,
883 // and we want to list files with parse errors anyway.
887 if info.parsed != nil {
888 pkg = info.parsed.Name.Name
889 if pkg == "documentation" {
890 p.IgnoredGoFiles = append(p.IgnoredGoFiles, name)
895 isTest := strings.HasSuffix(name, "_test.go")
897 if isTest && strings.HasSuffix(pkg, "_test") {
899 pkg = pkg[:len(pkg)-len("_test")]
905 } else if pkg != p.Name {
906 // TODO(#45999): The choice of p.Name is arbitrary based on file iteration
907 // order. Instead of resolving p.Name arbitrarily, we should clear out the
908 // existing name and mark the existing files as also invalid.
909 badFile(name, &MultiplePackageError{
911 Packages: []string{p.Name, pkg},
912 Files: []string{firstFile, name},
915 // Grab the first package comment as docs, provided it is not from a test file.
916 if info.parsed != nil && info.parsed.Doc != nil && p.Doc == "" && !isTest && !isXTest {
917 p.Doc = doc.Synopsis(info.parsed.Doc.Text())
920 if mode&ImportComment != 0 {
921 qcom, line := findImportComment(data)
923 com, err := strconv.Unquote(qcom)
925 badFile(name, fmt.Errorf("%s:%d: cannot parse import comment", filename, line))
926 } else if p.ImportComment == "" {
927 p.ImportComment = com
928 firstCommentFile = name
929 } else if p.ImportComment != com {
930 badFile(name, fmt.Errorf("found import comments %q (%s) and %q (%s) in %s", p.ImportComment, firstCommentFile, com, name, p.Dir))
935 // Record imports and information about cgo.
937 for _, imp := range info.imports {
940 badFile(name, fmt.Errorf("use of cgo in test %s not supported", filename))
945 if err := ctxt.saveCgo(filename, p, imp.doc); err != nil {
952 var fileList *[]string
953 var importMap, embedMap map[string][]token.Position
956 allTags["cgo"] = true
958 fileList = &p.CgoFiles
959 importMap = importPos
962 // Ignore imports and embeds from cgo files if cgo is disabled.
963 fileList = &p.IgnoredGoFiles
966 fileList = &p.XTestGoFiles
967 importMap = xTestImportPos
968 embedMap = xTestEmbedPos
970 fileList = &p.TestGoFiles
971 importMap = testImportPos
972 embedMap = testEmbedPos
974 fileList = &p.GoFiles
975 importMap = importPos
978 *fileList = append(*fileList, name)
979 if importMap != nil {
980 for _, imp := range info.imports {
981 importMap[imp.path] = append(importMap[imp.path], fset.Position(imp.pos))
985 for _, emb := range info.embeds {
986 embedMap[emb.pattern] = append(embedMap[emb.pattern], emb.pos)
991 for tag := range allTags {
992 p.AllTags = append(p.AllTags, tag)
994 sort.Strings(p.AllTags)
996 p.EmbedPatterns, p.EmbedPatternPos = cleanDecls(embedPos)
997 p.TestEmbedPatterns, p.TestEmbedPatternPos = cleanDecls(testEmbedPos)
998 p.XTestEmbedPatterns, p.XTestEmbedPatternPos = cleanDecls(xTestEmbedPos)
1000 p.Imports, p.ImportPos = cleanDecls(importPos)
1001 p.TestImports, p.TestImportPos = cleanDecls(testImportPos)
1002 p.XTestImports, p.XTestImportPos = cleanDecls(xTestImportPos)
1004 // add the .S/.sx files only if we are using cgo
1005 // (which means gcc will compile them).
1006 // The standard assemblers expect .s files.
1007 if len(p.CgoFiles) > 0 {
1008 p.SFiles = append(p.SFiles, Sfiles...)
1009 sort.Strings(p.SFiles)
1011 p.IgnoredOtherFiles = append(p.IgnoredOtherFiles, Sfiles...)
1012 sort.Strings(p.IgnoredOtherFiles)
1015 if badGoError != nil {
1016 return p, badGoError
1018 if len(p.GoFiles)+len(p.CgoFiles)+len(p.TestGoFiles)+len(p.XTestGoFiles) == 0 {
1019 return p, &NoGoError{p.Dir}
1024 func fileListForExt(p *Package, ext string) *[]string {
1028 case ".cc", ".cpp", ".cxx":
1032 case ".h", ".hh", ".hpp", ".hxx":
1034 case ".f", ".F", ".for", ".f90":
1036 case ".s", ".S", ".sx":
1041 return &p.SwigCXXFiles
1048 func uniq(list []string) []string {
1052 out := make([]string, len(list))
1056 for _, x := range out {
1057 if len(uniq) == 0 || uniq[len(uniq)-1] != x {
1058 uniq = append(uniq, x)
1064 var errNoModules = errors.New("not using modules")
1066 // importGo checks whether it can use the go command to find the directory for path.
1067 // If using the go command is not appropriate, importGo returns errNoModules.
1068 // Otherwise, importGo tries using the go command and reports whether that succeeded.
1069 // Using the go command lets build.Import and build.Context.Import find code
1070 // in Go modules. In the long term we want tools to use go/packages (currently golang.org/x/tools/go/packages),
1071 // which will also use the go command.
1072 // Invoking the go command here is not very efficient in that it computes information
1073 // about the requested package and all dependencies and then only reports about the requested package.
1074 // Then we reinvoke it for every dependency. But this is still better than not working at all.
1075 // See golang.org/issue/26504.
1076 func (ctxt *Context) importGo(p *Package, path, srcDir string, mode ImportMode) error {
1077 // To invoke the go command,
1078 // we must not being doing special things like AllowBinary or IgnoreVendor,
1079 // and all the file system callbacks must be nil (we're meant to use the local file system).
1080 if mode&AllowBinary != 0 || mode&IgnoreVendor != 0 ||
1081 ctxt.JoinPath != nil || ctxt.SplitPathList != nil || ctxt.IsAbsPath != nil || ctxt.IsDir != nil || ctxt.HasSubdir != nil || ctxt.ReadDir != nil || ctxt.OpenFile != nil || !equal(ctxt.ToolTags, defaultToolTags) || !equal(ctxt.ReleaseTags, defaultReleaseTags) {
1085 // Predict whether module aware mode is enabled by checking the value of
1086 // GO111MODULE and looking for a go.mod file in the source directory or
1087 // one of its parents. Running 'go env GOMOD' in the source directory would
1088 // give a canonical answer, but we'd prefer not to execute another command.
1089 go111Module := os.Getenv("GO111MODULE")
1090 switch go111Module {
1093 default: // "", "on", "auto", anything else
1094 // Maybe use modules.
1098 var absSrcDir string
1099 if filepath.IsAbs(srcDir) {
1101 } else if ctxt.Dir != "" {
1102 return fmt.Errorf("go/build: Dir is non-empty, so relative srcDir is not allowed: %v", srcDir)
1104 // Find the absolute source directory. hasSubdir does not handle
1105 // relative paths (and can't because the callbacks don't support this).
1107 absSrcDir, err = filepath.Abs(srcDir)
1113 // If the source directory is in GOROOT, then the in-process code works fine
1114 // and we should keep using it. Moreover, the 'go list' approach below doesn't
1115 // take standard-library vendoring into account and will fail.
1116 if _, ok := ctxt.hasSubdir(filepath.Join(ctxt.GOROOT, "src"), absSrcDir); ok {
1121 // For efficiency, if path is a standard library package, let the usual lookup code handle it.
1122 if ctxt.GOROOT != "" {
1123 dir := ctxt.joinPath(ctxt.GOROOT, "src", path)
1124 if ctxt.isDir(dir) {
1129 // If GO111MODULE=auto, look to see if there is a go.mod.
1130 // Since go1.13, it doesn't matter if we're inside GOPATH.
1131 if go111Module == "auto" {
1137 parent, err = os.Getwd()
1139 // A nonexistent working directory can't be in a module.
1143 parent, err = filepath.Abs(ctxt.Dir)
1145 // If the caller passed a bogus Dir explicitly, that's materially
1146 // different from not having modules enabled.
1151 if f, err := ctxt.openFile(ctxt.joinPath(parent, "go.mod")); err == nil {
1152 buf := make([]byte, 100)
1153 _, err := f.Read(buf)
1155 if err == nil || err == io.EOF {
1156 // go.mod exists and is readable (is a file, not a directory).
1160 d := filepath.Dir(parent)
1161 if len(d) >= len(parent) {
1162 return errNoModules // reached top of file system, no go.mod
1168 cmd := exec.Command("go", "list", "-e", "-compiler="+ctxt.Compiler, "-tags="+strings.Join(ctxt.BuildTags, ","), "-installsuffix="+ctxt.InstallSuffix, "-f={{.Dir}}\n{{.ImportPath}}\n{{.Root}}\n{{.Goroot}}\n{{if .Error}}{{.Error}}{{end}}\n", "--", path)
1174 var stdout, stderr strings.Builder
1175 cmd.Stdout = &stdout
1176 cmd.Stderr = &stderr
1179 if ctxt.CgoEnabled {
1182 cmd.Env = append(os.Environ(),
1184 "GOARCH="+ctxt.GOARCH,
1185 "GOROOT="+ctxt.GOROOT,
1186 "GOPATH="+ctxt.GOPATH,
1190 if err := cmd.Run(); err != nil {
1191 return fmt.Errorf("go/build: go list %s: %v\n%s\n", path, err, stderr.String())
1194 f := strings.SplitN(stdout.String(), "\n", 5)
1196 return fmt.Errorf("go/build: importGo %s: unexpected output:\n%s\n", path, stdout.String())
1199 errStr := strings.TrimSpace(f[4])
1200 if errStr != "" && dir == "" {
1201 // If 'go list' could not locate the package (dir is empty),
1202 // return the same error that 'go list' reported.
1203 return errors.New(errStr)
1206 // If 'go list' did locate the package, ignore the error.
1207 // It was probably related to loading source files, and we'll
1208 // encounter it ourselves shortly if the FindOnly flag isn't set.
1212 p.Goroot = f[3] == "true"
1216 func equal(x, y []string) bool {
1217 if len(x) != len(y) {
1220 for i, xi := range x {
1228 // hasGoFiles reports whether dir contains any files with names ending in .go.
1229 // For a vendor check we must exclude directories that contain no .go files.
1230 // Otherwise it is not possible to vendor just a/b/c and still import the
1231 // non-vendored a/b. See golang.org/issue/13832.
1232 func hasGoFiles(ctxt *Context, dir string) bool {
1233 ents, _ := ctxt.readDir(dir)
1234 for _, ent := range ents {
1235 if !ent.IsDir() && strings.HasSuffix(ent.Name(), ".go") {
1242 func findImportComment(data []byte) (s string, line int) {
1243 // expect keyword package
1244 word, data := parseWord(data)
1245 if string(word) != "package" {
1249 // expect package name
1250 _, data = parseWord(data)
1252 // now ready for import comment, a // or /* */ comment
1253 // beginning and ending on the current line.
1254 for len(data) > 0 && (data[0] == ' ' || data[0] == '\t' || data[0] == '\r') {
1260 case bytes.HasPrefix(data, slashSlash):
1261 comment, _, _ = bytes.Cut(data[2:], newline)
1262 case bytes.HasPrefix(data, slashStar):
1264 comment, _, ok = bytes.Cut(data[2:], starSlash)
1266 // malformed comment
1269 if bytes.Contains(comment, newline) {
1273 comment = bytes.TrimSpace(comment)
1275 // split comment into `import`, `"pkg"`
1276 word, arg := parseWord(comment)
1277 if string(word) != "import" {
1281 line = 1 + bytes.Count(data[:cap(data)-cap(arg)], newline)
1282 return strings.TrimSpace(string(arg)), line
1286 slashSlash = []byte("//")
1287 slashStar = []byte("/*")
1288 starSlash = []byte("*/")
1289 newline = []byte("\n")
1292 // skipSpaceOrComment returns data with any leading spaces or comments removed.
1293 func skipSpaceOrComment(data []byte) []byte {
1296 case ' ', '\t', '\r', '\n':
1300 if bytes.HasPrefix(data, slashSlash) {
1301 i := bytes.Index(data, newline)
1308 if bytes.HasPrefix(data, slashStar) {
1310 i := bytes.Index(data, starSlash)
1323 // parseWord skips any leading spaces or comments in data
1324 // and then parses the beginning of data as an identifier or keyword,
1325 // returning that word and what remains after the word.
1326 func parseWord(data []byte) (word, rest []byte) {
1327 data = skipSpaceOrComment(data)
1329 // Parse past leading word characters.
1332 r, size := utf8.DecodeRune(rest)
1333 if unicode.IsLetter(r) || '0' <= r && r <= '9' || r == '_' {
1340 word = data[:len(data)-len(rest)]
1348 // MatchFile reports whether the file with the given name in the given directory
1349 // matches the context and would be included in a Package created by ImportDir
1350 // of that directory.
1352 // MatchFile considers the name of the file and may use ctxt.OpenFile to
1353 // read some or all of the file's content.
1354 func (ctxt *Context) MatchFile(dir, name string) (match bool, err error) {
1355 info, err := ctxt.matchFile(dir, name, nil, nil, nil)
1356 return info != nil, err
1359 var dummyPkg Package
1361 // fileInfo records information learned about a file included in a build.
1362 type fileInfo struct {
1363 name string // full name including dir
1368 imports []fileImport
1373 type fileImport struct {
1376 doc *ast.CommentGroup
1379 type fileEmbed struct {
1384 // matchFile determines whether the file with the given name in the given directory
1385 // should be included in the package being constructed.
1386 // If the file should be included, matchFile returns a non-nil *fileInfo (and a nil error).
1387 // Non-nil errors are reserved for unexpected problems.
1389 // If name denotes a Go program, matchFile reads until the end of the
1390 // imports and returns that section of the file in the fileInfo's header field,
1391 // even though it only considers text until the first non-comment
1392 // for +build lines.
1394 // If allTags is non-nil, matchFile records any encountered build tag
1395 // by setting allTags[tag] = true.
1396 func (ctxt *Context) matchFile(dir, name string, allTags map[string]bool, binaryOnly *bool, fset *token.FileSet) (*fileInfo, error) {
1397 if strings.HasPrefix(name, "_") ||
1398 strings.HasPrefix(name, ".") {
1402 i := strings.LastIndex(name, ".")
1408 if !ctxt.goodOSArchFile(name, allTags) && !ctxt.UseAllFiles {
1412 if ext != ".go" && fileListForExt(&dummyPkg, ext) == nil {
1417 info := &fileInfo{name: ctxt.joinPath(dir, name), fset: fset}
1419 // binary, no reading
1423 f, err := ctxt.openFile(info.name)
1428 if strings.HasSuffix(name, ".go") {
1429 err = readGoInfo(f, info)
1430 if strings.HasSuffix(name, "_test.go") {
1431 binaryOnly = nil // ignore //go:binary-only-package comments in _test.go files
1434 binaryOnly = nil // ignore //go:binary-only-package comments in non-Go sources
1435 info.header, err = readComments(f)
1439 return nil, fmt.Errorf("read %s: %v", info.name, err)
1442 // Look for +build comments to accept or reject the file.
1443 ok, sawBinaryOnly, err := ctxt.shouldBuild(info.header, allTags)
1445 return nil, fmt.Errorf("%s: %v", name, err)
1447 if !ok && !ctxt.UseAllFiles {
1451 if binaryOnly != nil && sawBinaryOnly {
1458 func cleanDecls(m map[string][]token.Position) ([]string, map[string][]token.Position) {
1459 all := make([]string, 0, len(m))
1460 for path := range m {
1461 all = append(all, path)
1467 // Import is shorthand for Default.Import.
1468 func Import(path, srcDir string, mode ImportMode) (*Package, error) {
1469 return Default.Import(path, srcDir, mode)
1472 // ImportDir is shorthand for Default.ImportDir.
1473 func ImportDir(dir string, mode ImportMode) (*Package, error) {
1474 return Default.ImportDir(dir, mode)
1478 bSlashSlash = []byte(slashSlash)
1479 bStarSlash = []byte(starSlash)
1480 bSlashStar = []byte(slashStar)
1481 bPlusBuild = []byte("+build")
1483 goBuildComment = []byte("//go:build")
1485 errGoBuildWithoutBuild = errors.New("//go:build comment without // +build comment")
1486 errMultipleGoBuild = errors.New("multiple //go:build comments")
1489 func isGoBuildComment(line []byte) bool {
1490 if !bytes.HasPrefix(line, goBuildComment) {
1493 line = bytes.TrimSpace(line)
1494 rest := line[len(goBuildComment):]
1495 return len(rest) == 0 || len(bytes.TrimSpace(rest)) < len(rest)
1498 // Special comment denoting a binary-only package.
1499 // See https://golang.org/design/2775-binary-only-packages
1500 // for more about the design of binary-only packages.
1501 var binaryOnlyComment = []byte("//go:binary-only-package")
1503 // shouldBuild reports whether it is okay to use this file,
1504 // The rule is that in the file's leading run of // comments
1505 // and blank lines, which must be followed by a blank line
1506 // (to avoid including a Go package clause doc comment),
1507 // lines beginning with '// +build' are taken as build directives.
1509 // The file is accepted only if each such line lists something
1510 // matching the file. For example:
1512 // // +build windows linux
1514 // marks the file as applicable only on Windows and Linux.
1516 // For each build tag it consults, shouldBuild sets allTags[tag] = true.
1518 // shouldBuild reports whether the file should be built
1519 // and whether a //go:binary-only-package comment was found.
1520 func (ctxt *Context) shouldBuild(content []byte, allTags map[string]bool) (shouldBuild, binaryOnly bool, err error) {
1521 // Identify leading run of // comments and blank lines,
1522 // which must be followed by a blank line.
1523 // Also identify any //go:build comments.
1524 content, goBuild, sawBinaryOnly, err := parseFileHeader(content)
1526 return false, false, err
1529 // If //go:build line is present, it controls.
1530 // Otherwise fall back to +build processing.
1532 case goBuild != nil:
1533 x, err := constraint.Parse(string(goBuild))
1535 return false, false, fmt.Errorf("parsing //go:build line: %v", err)
1537 shouldBuild = ctxt.eval(x, allTags)
1544 if i := bytes.IndexByte(line, '\n'); i >= 0 {
1545 line, p = line[:i], p[i+1:]
1549 line = bytes.TrimSpace(line)
1550 if !bytes.HasPrefix(line, bSlashSlash) || !bytes.Contains(line, bPlusBuild) {
1553 text := string(line)
1554 if !constraint.IsPlusBuild(text) {
1557 if x, err := constraint.Parse(text); err == nil {
1558 if !ctxt.eval(x, allTags) {
1565 return shouldBuild, sawBinaryOnly, nil
1568 func parseFileHeader(content []byte) (trimmed, goBuild []byte, sawBinaryOnly bool, err error) {
1571 ended := false // found non-blank, non-// line, so stopped accepting // +build lines
1572 inSlashStar := false // in /* */ comment
1577 if i := bytes.IndexByte(line, '\n'); i >= 0 {
1578 line, p = line[:i], p[i+1:]
1582 line = bytes.TrimSpace(line)
1583 if len(line) == 0 && !ended { // Blank line
1584 // Remember position of most recent blank line.
1585 // When we find the first non-blank, non-// line,
1586 // this "end" position marks the latest file position
1587 // where a // +build line can appear.
1588 // (It must appear _before_ a blank line before the non-blank, non-// line.
1589 // Yes, that's confusing, which is part of why we moved to //go:build lines.)
1590 // Note that ended==false here means that inSlashStar==false,
1591 // since seeing a /* would have set ended==true.
1592 end = len(content) - len(p)
1595 if !bytes.HasPrefix(line, slashSlash) { // Not comment line
1599 if !inSlashStar && isGoBuildComment(line) {
1601 return nil, nil, false, errMultipleGoBuild
1605 if !inSlashStar && bytes.Equal(line, binaryOnlyComment) {
1606 sawBinaryOnly = true
1612 if i := bytes.Index(line, starSlash); i >= 0 {
1614 line = bytes.TrimSpace(line[i+len(starSlash):])
1619 if bytes.HasPrefix(line, bSlashSlash) {
1622 if bytes.HasPrefix(line, bSlashStar) {
1624 line = bytes.TrimSpace(line[len(bSlashStar):])
1627 // Found non-comment text.
1632 return content[:end], goBuild, sawBinaryOnly, nil
1635 // saveCgo saves the information from the #cgo lines in the import "C" comment.
1636 // These lines set CFLAGS, CPPFLAGS, CXXFLAGS and LDFLAGS and pkg-config directives
1637 // that affect the way cgo's C code is built.
1638 func (ctxt *Context) saveCgo(filename string, di *Package, cg *ast.CommentGroup) error {
1640 for _, line := range strings.Split(text, "\n") {
1644 // #cgo [GOOS/GOARCH...] LDFLAGS: stuff
1646 line = strings.TrimSpace(line)
1647 if len(line) < 5 || line[:4] != "#cgo" || (line[4] != ' ' && line[4] != '\t') {
1652 line, argstr, ok := strings.Cut(strings.TrimSpace(line[4:]), ":")
1654 return fmt.Errorf("%s: invalid #cgo line: %s", filename, orig)
1657 // Parse GOOS/GOARCH stuff.
1658 f := strings.Fields(line)
1660 return fmt.Errorf("%s: invalid #cgo line: %s", filename, orig)
1663 cond, verb := f[:len(f)-1], f[len(f)-1]
1666 for _, c := range cond {
1667 if ctxt.matchAuto(c, nil) {
1677 args, err := splitQuoted(argstr)
1679 return fmt.Errorf("%s: invalid #cgo line: %s", filename, orig)
1681 for i, arg := range args {
1682 if arg, ok = expandSrcDir(arg, di.Dir); !ok {
1683 return fmt.Errorf("%s: malformed #cgo argument: %s", filename, arg)
1689 case "CFLAGS", "CPPFLAGS", "CXXFLAGS", "FFLAGS", "LDFLAGS":
1690 // Change relative paths to absolute.
1691 ctxt.makePathsAbsolute(args, di.Dir)
1696 di.CgoCFLAGS = append(di.CgoCFLAGS, args...)
1698 di.CgoCPPFLAGS = append(di.CgoCPPFLAGS, args...)
1700 di.CgoCXXFLAGS = append(di.CgoCXXFLAGS, args...)
1702 di.CgoFFLAGS = append(di.CgoFFLAGS, args...)
1704 di.CgoLDFLAGS = append(di.CgoLDFLAGS, args...)
1706 di.CgoPkgConfig = append(di.CgoPkgConfig, args...)
1708 return fmt.Errorf("%s: invalid #cgo verb: %s", filename, orig)
1714 // expandSrcDir expands any occurrence of ${SRCDIR}, making sure
1715 // the result is safe for the shell.
1716 func expandSrcDir(str string, srcdir string) (string, bool) {
1717 // "\" delimited paths cause safeCgoName to fail
1718 // so convert native paths with a different delimiter
1719 // to "/" before starting (eg: on windows).
1720 srcdir = filepath.ToSlash(srcdir)
1722 chunks := strings.Split(str, "${SRCDIR}")
1723 if len(chunks) < 2 {
1724 return str, safeCgoName(str)
1727 for _, chunk := range chunks {
1728 ok = ok && (chunk == "" || safeCgoName(chunk))
1730 ok = ok && (srcdir == "" || safeCgoName(srcdir))
1731 res := strings.Join(chunks, srcdir)
1732 return res, ok && res != ""
1735 // makePathsAbsolute looks for compiler options that take paths and
1736 // makes them absolute. We do this because through the 1.8 release we
1737 // ran the compiler in the package directory, so any relative -I or -L
1738 // options would be relative to that directory. In 1.9 we changed to
1739 // running the compiler in the build directory, to get consistent
1740 // build results (issue #19964). To keep builds working, we change any
1741 // relative -I or -L options to be absolute.
1743 // Using filepath.IsAbs and filepath.Join here means the results will be
1744 // different on different systems, but that's OK: -I and -L options are
1745 // inherently system-dependent.
1746 func (ctxt *Context) makePathsAbsolute(args []string, srcDir string) {
1748 for i, arg := range args {
1750 if !filepath.IsAbs(arg) {
1751 args[i] = filepath.Join(srcDir, arg)
1754 } else if strings.HasPrefix(arg, "-I") || strings.HasPrefix(arg, "-L") {
1758 if !filepath.IsAbs(arg[2:]) {
1759 args[i] = arg[:2] + filepath.Join(srcDir, arg[2:])
1766 // NOTE: $ is not safe for the shell, but it is allowed here because of linker options like -Wl,$ORIGIN.
1767 // We never pass these arguments to a shell (just to programs we construct argv for), so this should be okay.
1768 // See golang.org/issue/6038.
1769 // The @ is for OS X. See golang.org/issue/13720.
1770 // The % is for Jenkins. See golang.org/issue/16959.
1771 // The ! is because module paths may use them. See golang.org/issue/26716.
1772 // The ~ and ^ are for sr.ht. See golang.org/issue/32260.
1773 const safeString = "+-.,/0123456789=ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz:$@%! ~^"
1775 func safeCgoName(s string) bool {
1779 for i := 0; i < len(s); i++ {
1780 if c := s[i]; c < utf8.RuneSelf && strings.IndexByte(safeString, c) < 0 {
1787 // splitQuoted splits the string s around each instance of one or more consecutive
1788 // white space characters while taking into account quotes and escaping, and
1789 // returns an array of substrings of s or an empty list if s contains only white space.
1790 // Single quotes and double quotes are recognized to prevent splitting within the
1791 // quoted region, and are removed from the resulting substrings. If a quote in s
1792 // isn't closed err will be set and r will have the unclosed argument as the
1793 // last element. The backslash is used for escaping.
1795 // For example, the following string:
1797 // a b:"c d" 'e''f' "g\""
1799 // Would be parsed as:
1801 // []string{"a", "b:c d", "ef", `g"`}
1803 func splitQuoted(s string) (r []string, err error) {
1805 arg := make([]rune, len(s))
1810 for _, rune := range s {
1817 case quote != '\x00':
1822 case rune == '"' || rune == '\'':
1826 case unicode.IsSpace(rune):
1827 if quoted || i > 0 {
1829 args = append(args, string(arg[:i]))
1837 if quoted || i > 0 {
1838 args = append(args, string(arg[:i]))
1841 err = errors.New("unclosed quote")
1843 err = errors.New("unfinished escaping")
1848 // matchAuto interprets text as either a +build or //go:build expression (whichever works),
1849 // reporting whether the expression matches the build context.
1851 // matchAuto is only used for testing of tag evaluation
1852 // and in #cgo lines, which accept either syntax.
1853 func (ctxt *Context) matchAuto(text string, allTags map[string]bool) bool {
1854 if strings.ContainsAny(text, "&|()") {
1855 text = "//go:build " + text
1857 text = "// +build " + text
1859 x, err := constraint.Parse(text)
1863 return ctxt.eval(x, allTags)
1866 func (ctxt *Context) eval(x constraint.Expr, allTags map[string]bool) bool {
1867 return x.Eval(func(tag string) bool { return ctxt.matchTag(tag, allTags) })
1870 // matchTag reports whether the name is one of:
1872 // cgo (if cgo is enabled)
1877 // linux (if GOOS = android)
1878 // solaris (if GOOS = illumos)
1879 // tag (if tag is listed in ctxt.BuildTags or ctxt.ReleaseTags)
1881 // It records all consulted tags in allTags.
1882 func (ctxt *Context) matchTag(name string, allTags map[string]bool) bool {
1884 allTags[name] = true
1888 if ctxt.CgoEnabled && name == "cgo" {
1891 if name == ctxt.GOOS || name == ctxt.GOARCH || name == ctxt.Compiler {
1894 if ctxt.GOOS == "android" && name == "linux" {
1897 if ctxt.GOOS == "illumos" && name == "solaris" {
1900 if ctxt.GOOS == "ios" && name == "darwin" {
1903 // Let applications know that the Go+BoringCrypto toolchain is in use.
1904 if name == "boringcrypto" {
1909 for _, tag := range ctxt.BuildTags {
1914 for _, tag := range ctxt.ToolTags {
1919 for _, tag := range ctxt.ReleaseTags {
1928 // goodOSArchFile returns false if the name contains a $GOOS or $GOARCH
1929 // suffix which does not match the current system.
1930 // The recognized name formats are:
1934 // name_$(GOOS)_$(GOARCH).*
1935 // name_$(GOOS)_test.*
1936 // name_$(GOARCH)_test.*
1937 // name_$(GOOS)_$(GOARCH)_test.*
1940 // if GOOS=android, then files with GOOS=linux are also matched.
1941 // if GOOS=illumos, then files with GOOS=solaris are also matched.
1942 // if GOOS=ios, then files with GOOS=darwin are also matched.
1943 func (ctxt *Context) goodOSArchFile(name string, allTags map[string]bool) bool {
1944 name, _, _ = strings.Cut(name, ".")
1946 // Before Go 1.4, a file called "linux.go" would be equivalent to having a
1947 // build tag "linux" in that file. For Go 1.4 and beyond, we require this
1948 // auto-tagging to apply only to files with a non-empty prefix, so
1949 // "foo_linux.go" is tagged but "linux.go" is not. This allows new operating
1950 // systems, such as android, to arrive without breaking existing code with
1951 // innocuous source code in "android.go". The easiest fix: cut everything
1952 // in the name before the initial _.
1953 i := strings.Index(name, "_")
1957 name = name[i:] // ignore everything before first _
1959 l := strings.Split(name, "_")
1960 if n := len(l); n > 0 && l[n-1] == "test" {
1964 if n >= 2 && knownOS[l[n-2]] && knownArch[l[n-1]] {
1965 return ctxt.matchTag(l[n-1], allTags) && ctxt.matchTag(l[n-2], allTags)
1967 if n >= 1 && (knownOS[l[n-1]] || knownArch[l[n-1]]) {
1968 return ctxt.matchTag(l[n-1], allTags)
1973 var knownOS = make(map[string]bool)
1974 var knownArch = make(map[string]bool)
1977 for _, v := range strings.Fields(goosList) {
1980 for _, v := range strings.Fields(goarchList) {
1985 // ToolDir is the directory containing build tools.
1986 var ToolDir = getToolDir()
1988 // IsLocalImport reports whether the import path is
1989 // a local import path, like ".", "..", "./foo", or "../foo".
1990 func IsLocalImport(path string) bool {
1991 return path == "." || path == ".." ||
1992 strings.HasPrefix(path, "./") || strings.HasPrefix(path, "../")
1995 // ArchChar returns "?" and an error.
1996 // In earlier versions of Go, the returned string was used to derive
1997 // the compiler and linker tool names, the default object file suffix,
1998 // and the default linker output name. As of Go 1.5, those strings
1999 // no longer vary by architecture; they are compile, link, .o, and a.out, respectively.
2000 func ArchChar(goarch string) (string, error) {
2001 return "?", errors.New("architecture letter no longer used")