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.
5 // Package load loads packages.
21 "cmd/go/internal/base"
26 var IgnoreImports
bool // control whether we ignore imports in packages
28 // A Package describes a single package found in a directory.
30 PackagePublic
// visible in 'go list'
31 Internal PackageInternal
// for use inside go command only
34 type PackagePublic
struct {
35 // Note: These fields are part of the go command's public API.
36 // See list.go. It is okay to add fields, but not to change or
37 // remove existing ones. Keep in sync with list.go
38 Dir
string `json:",omitempty"` // directory containing package sources
39 ImportPath
string `json:",omitempty"` // import path of package in dir
40 ImportComment
string `json:",omitempty"` // path in import comment on package statement
41 Name
string `json:",omitempty"` // package name
42 Doc
string `json:",omitempty"` // package documentation string
43 Target
string `json:",omitempty"` // installed target for this package (may be executable)
44 Shlib
string `json:",omitempty"` // the shared library that contains this package (only set when -linkshared)
45 Goroot
bool `json:",omitempty"` // is this package found in the Go root?
46 Standard
bool `json:",omitempty"` // is this package part of the standard Go library?
47 Root
string `json:",omitempty"` // Go root or Go path dir containing this package
48 ConflictDir
string `json:",omitempty"` // Dir is hidden by this other directory
49 BinaryOnly
bool `json:",omitempty"` // package cannot be recompiled
51 // Stale and StaleReason remain here *only* for the list command.
52 // They are only initialized in preparation for list execution.
53 // The regular build determines staleness on the fly during action execution.
54 Stale
bool `json:",omitempty"` // would 'go install' do anything for this package?
55 StaleReason
string `json:",omitempty"` // why is Stale true?
58 // If you add to this list you MUST add to p.AllFiles (below) too.
59 // Otherwise file name security lists will not apply to any new additions.
60 GoFiles
[]string `json:",omitempty"` // .go source files (excluding CgoFiles, TestGoFiles, XTestGoFiles)
61 CgoFiles
[]string `json:",omitempty"` // .go sources files that import "C"
62 IgnoredGoFiles
[]string `json:",omitempty"` // .go sources ignored due to build constraints
63 CFiles
[]string `json:",omitempty"` // .c source files
64 CXXFiles
[]string `json:",omitempty"` // .cc, .cpp and .cxx source files
65 MFiles
[]string `json:",omitempty"` // .m source files
66 HFiles
[]string `json:",omitempty"` // .h, .hh, .hpp and .hxx source files
67 FFiles
[]string `json:",omitempty"` // .f, .F, .for and .f90 Fortran source files
68 SFiles
[]string `json:",omitempty"` // .s source files
69 SwigFiles
[]string `json:",omitempty"` // .swig files
70 SwigCXXFiles
[]string `json:",omitempty"` // .swigcxx files
71 SysoFiles
[]string `json:",omitempty"` // .syso system object files added to package
74 CgoCFLAGS
[]string `json:",omitempty"` // cgo: flags for C compiler
75 CgoCPPFLAGS
[]string `json:",omitempty"` // cgo: flags for C preprocessor
76 CgoCXXFLAGS
[]string `json:",omitempty"` // cgo: flags for C++ compiler
77 CgoFFLAGS
[]string `json:",omitempty"` // cgo: flags for Fortran compiler
78 CgoLDFLAGS
[]string `json:",omitempty"` // cgo: flags for linker
79 CgoPkgConfig
[]string `json:",omitempty"` // cgo: pkg-config names
81 // Dependency information
82 Imports
[]string `json:",omitempty"` // import paths used by this package
83 Deps
[]string `json:",omitempty"` // all (recursively) imported dependencies
86 Incomplete
bool `json:",omitempty"` // was there an error loading this package or dependencies?
87 Error
*PackageError
`json:",omitempty"` // error loading this package (not dependencies)
88 DepsErrors
[]*PackageError
`json:",omitempty"` // errors loading dependencies
91 // If you add to this list you MUST add to p.AllFiles (below) too.
92 // Otherwise file name security lists will not apply to any new additions.
93 TestGoFiles
[]string `json:",omitempty"` // _test.go files in package
94 TestImports
[]string `json:",omitempty"` // imports from TestGoFiles
95 XTestGoFiles
[]string `json:",omitempty"` // _test.go files outside package
96 XTestImports
[]string `json:",omitempty"` // imports from XTestGoFiles
99 // AllFiles returns the names of all the files considered for the package.
100 // This is used for sanity and security checks, so we include all files,
101 // even IgnoredGoFiles, because some subcommands consider them.
102 // The go/build package filtered others out (like foo_wrongGOARCH.s)
104 func (p
*Package
) AllFiles() []string {
105 return str
.StringList(
123 type PackageInternal
struct {
124 // Unexported fields are not part of the public API.
126 Imports
[]*Package
// this package's direct imports
127 RawImports
[]string // this package's original imports as they appear in the text of the program
128 ForceLibrary
bool // this package is a library (even if named "main")
129 CmdlineFiles
bool // package built from files listed on command line
130 CmdlinePkg
bool // package listed on command line
131 Local
bool // imported via local path (./ or ../)
132 LocalPrefix
string // interpret ./ and ../ imports relative to this prefix
133 ExeName
string // desired name for temporary executable
134 CoverMode
string // preprocess Go source files with the coverage tool in this mode
135 CoverVars
map[string]*CoverVar
// variables created by coverage analysis
136 OmitDebug
bool // tell linker not to write debug information
137 GobinSubdir
bool // install target would be subdir of GOBIN
139 Asmflags
[]string // -asmflags for this package
140 Gcflags
[]string // -gcflags for this package
141 Ldflags
[]string // -ldflags for this package
142 Gccgoflags
[]string // -gccgoflags for this package
145 type NoGoError
struct {
149 func (e
*NoGoError
) Error() string {
150 // Count files beginning with _ and ., which we will pretend don't exist at all.
152 for _
, name
:= range e
.Package
.IgnoredGoFiles
{
153 if strings
.HasPrefix(name
, "_") || strings
.HasPrefix(name
, ".") {
158 if len(e
.Package
.IgnoredGoFiles
) > dummy
{
159 // Go files exist, but they were ignored due to build constraints.
160 return "build constraints exclude all Go files in " + e
.Package
.Dir
162 if len(e
.Package
.TestGoFiles
)+len(e
.Package
.XTestGoFiles
) > 0 {
163 // Test Go files exist, but we're not interested in them.
164 // The double-negative is unfortunate but we want e.Package.Dir
165 // to appear at the end of error message.
166 return "no non-test Go files in " + e
.Package
.Dir
168 return "no Go files in " + e
.Package
.Dir
171 // Vendored returns the vendor-resolved version of imports,
172 // which should be p.TestImports or p.XTestImports, NOT p.Imports.
173 // The imports in p.TestImports and p.XTestImports are not recursively
174 // loaded during the initial load of p, so they list the imports found in
175 // the source file, but most processing should be over the vendor-resolved
176 // import paths. We do this resolution lazily both to avoid file system work
177 // and because the eventual real load of the test imports (during 'go test')
178 // can produce better error messages if it starts with the original paths.
179 // The initial load of p loads all the non-test imports and rewrites
180 // the vendored paths, so nothing should ever call p.vendored(p.Imports).
181 func (p
*Package
) Vendored(imports
[]string) []string {
182 if len(imports
) > 0 && len(p
.Imports
) > 0 && &imports
[0] == &p
.Imports
[0] {
183 panic("internal error: p.vendored(p.Imports) called")
185 seen
:= make(map[string]bool)
187 for _
, path
:= range imports
{
188 path
= VendoredImportPath(p
, path
)
191 all
= append(all
, path
)
198 // CoverVar holds the name of the generated coverage variables targeting the named file.
199 type CoverVar
struct {
200 File
string // local file name
201 Var
string // name of count struct
204 func (p
*Package
) copyBuild(pp
*build
.Package
) {
205 p
.Internal
.Build
= pp
207 if pp
.PkgTargetRoot
!= "" && cfg
.BuildPkgdir
!= "" {
208 old
:= pp
.PkgTargetRoot
209 pp
.PkgRoot
= cfg
.BuildPkgdir
210 pp
.PkgTargetRoot
= cfg
.BuildPkgdir
211 pp
.PkgObj
= filepath
.Join(cfg
.BuildPkgdir
, strings
.TrimPrefix(pp
.PkgObj
, old
))
215 p
.ImportPath
= pp
.ImportPath
216 p
.ImportComment
= pp
.ImportComment
220 p
.ConflictDir
= pp
.ConflictDir
221 p
.BinaryOnly
= pp
.BinaryOnly
225 p
.Standard
= p
.Goroot
&& p
.ImportPath
!= "" && isStandardImportPath(p
.ImportPath
)
226 p
.GoFiles
= pp
.GoFiles
227 p
.CgoFiles
= pp
.CgoFiles
228 p
.IgnoredGoFiles
= pp
.IgnoredGoFiles
230 p
.CXXFiles
= pp
.CXXFiles
235 p
.SwigFiles
= pp
.SwigFiles
236 p
.SwigCXXFiles
= pp
.SwigCXXFiles
237 p
.SysoFiles
= pp
.SysoFiles
238 p
.CgoCFLAGS
= pp
.CgoCFLAGS
239 p
.CgoCPPFLAGS
= pp
.CgoCPPFLAGS
240 p
.CgoCXXFLAGS
= pp
.CgoCXXFLAGS
241 p
.CgoFFLAGS
= pp
.CgoFFLAGS
242 p
.CgoLDFLAGS
= pp
.CgoLDFLAGS
243 p
.CgoPkgConfig
= pp
.CgoPkgConfig
244 // We modify p.Imports in place, so make copy now.
245 p
.Imports
= make([]string, len(pp
.Imports
))
246 copy(p
.Imports
, pp
.Imports
)
247 p
.Internal
.RawImports
= pp
.Imports
248 p
.TestGoFiles
= pp
.TestGoFiles
249 p
.TestImports
= pp
.TestImports
250 p
.XTestGoFiles
= pp
.XTestGoFiles
251 p
.XTestImports
= pp
.XTestImports
259 // isStandardImportPath reports whether $GOROOT/src/path should be considered
260 // part of the standard distribution. For historical reasons we allow people to add
261 // their own code to $GOROOT instead of using $GOPATH, but we assume that
262 // code will start with a domain name (dot in the first element).
263 func isStandardImportPath(path
string) bool {
264 i
:= strings
.Index(path
, "/")
269 return !strings
.Contains(elem
, ".")
272 // A PackageError describes an error loading information about a package.
273 type PackageError
struct {
274 ImportStack
[]string // shortest path from package named on command line to this one
275 Pos
string // position of error
276 Err
string // the error itself
277 IsImportCycle
bool `json:"-"` // the error is an import cycle
278 Hard
bool `json:"-"` // whether the error is soft or hard; soft errors are ignored in some places
281 func (p
*PackageError
) Error() string {
282 // Import cycles deserve special treatment.
284 return fmt
.Sprintf("%s\npackage %s\n", p
.Err
, strings
.Join(p
.ImportStack
, "\n\timports "))
287 // Omit import stack. The full path to the file where the error
288 // is the most important thing.
289 return p
.Pos
+ ": " + p
.Err
291 if len(p
.ImportStack
) == 0 {
294 return "package " + strings
.Join(p
.ImportStack
, "\n\timports ") + ": " + p
.Err
297 // An ImportStack is a stack of import paths.
298 type ImportStack
[]string
300 func (s
*ImportStack
) Push(p
string) {
304 func (s
*ImportStack
) Pop() {
305 *s
= (*s
)[0 : len(*s
)-1]
308 func (s
*ImportStack
) Copy() []string {
309 return append([]string{}, *s
...)
312 // shorterThan reports whether sp is shorter than t.
313 // We use this to record the shortest import sequence
314 // that leads to a particular package.
315 func (sp
*ImportStack
) shorterThan(t
[]string) bool {
317 if len(s
) != len(t
) {
318 return len(s
) < len(t
)
320 // If they are the same length, settle ties using string ordering.
326 return false // they are equal
329 // packageCache is a lookup cache for loadPackage,
330 // so that if we look up a package multiple times
331 // we return the same pointer each time.
332 var packageCache
= map[string]*Package
{}
334 func ClearPackageCache() {
335 for name
:= range packageCache
{
336 delete(packageCache
, name
)
340 func ClearPackageCachePartial(args
[]string) {
341 for _
, arg
:= range args
{
342 p
:= packageCache
[arg
]
344 delete(packageCache
, p
.Dir
)
345 delete(packageCache
, p
.ImportPath
)
350 // reloadPackage is like loadPackage but makes sure
351 // not to use the package cache.
352 func ReloadPackage(arg
string, stk
*ImportStack
) *Package
{
353 p
:= packageCache
[arg
]
355 delete(packageCache
, p
.Dir
)
356 delete(packageCache
, p
.ImportPath
)
358 return LoadPackage(arg
, stk
)
361 // dirToImportPath returns the pseudo-import path we use for a package
362 // outside the Go path. It begins with _/ and then contains the full path
363 // to the directory. If the package lives in c:\home\gopher\my\pkg then
364 // the pseudo-import path is _/c_/home/gopher/my/pkg.
365 // Using a pseudo-import path like this makes the ./ imports no longer
366 // a special case, so that all the code to deal with ordinary imports works
368 func dirToImportPath(dir
string) string {
369 return pathpkg
.Join("_", strings
.Map(makeImportValid
, filepath
.ToSlash(dir
)))
372 func makeImportValid(r rune
) rune
{
373 // Should match Go spec, compilers, and ../../go/parser/parser.go:/isValidImport.
374 const illegalChars
= `!"#$%&'()*,:;<=>?[\]^{|}` + "`\uFFFD"
375 if !unicode
.IsGraphic(r
) || unicode
.IsSpace(r
) || strings
.ContainsRune(illegalChars
, r
) {
381 // Mode flags for loadImport and download (in get.go).
383 // UseVendor means that loadImport should do vendor expansion
384 // (provided the vendoring experiment is enabled).
385 // That is, useVendor means that the import path came from
386 // a source file and has not been vendor-expanded yet.
387 // Every import path should be loaded initially with useVendor,
388 // and then the expanded version (with the /vendor/ in it) gets
389 // recorded as the canonical import path. At that point, future loads
390 // of that package must not pass useVendor, because
391 // disallowVendor will reject direct use of paths containing /vendor/.
392 UseVendor
= 1 << iota
394 // GetTestDeps is for download (part of "go get") and indicates
395 // that test dependencies should be fetched too.
399 // LoadImport scans the directory named by path, which must be an import path,
400 // but possibly a local import path (an absolute file system path or one beginning
401 // with ./ or ../). A local relative path is interpreted relative to srcDir.
402 // It returns a *Package describing the package found in that directory.
403 func LoadImport(path
, srcDir
string, parent
*Package
, stk
*ImportStack
, importPos
[]token
.Position
, mode
int) *Package
{
407 // Determine canonical identifier for this package.
408 // For a local import the identifier is the pseudo-import path
409 // we create from the full directory to the package.
410 // Otherwise it is the usual import path.
411 // For vendored imports, it is the expanded form.
414 isLocal
:= build
.IsLocalImport(path
)
415 var debugDeprecatedImportcfgDir
string
417 importPath
= dirToImportPath(filepath
.Join(srcDir
, path
))
418 } else if DebugDeprecatedImportcfg
.enabled
{
419 if d
, i
:= DebugDeprecatedImportcfg
.lookup(parent
, path
); d
!= "" {
420 debugDeprecatedImportcfgDir
= d
423 } else if mode
&UseVendor
!= 0 {
424 // We do our own vendor resolution, because we want to
425 // find out the key to use in packageCache without the
426 // overhead of repeated calls to buildContext.Import.
427 // The code is also needed in a few other places anyway.
428 path
= VendoredImportPath(parent
, path
)
432 p
:= packageCache
[importPath
]
434 p
= reusePackage(p
, stk
)
437 p
.Internal
.Local
= isLocal
438 p
.ImportPath
= importPath
439 packageCache
[importPath
] = p
442 // Import always returns bp != nil, even if an error occurs,
443 // in order to return partial information.
444 var bp
*build
.Package
446 if debugDeprecatedImportcfgDir
!= "" {
447 bp
, err
= cfg
.BuildContext
.ImportDir(debugDeprecatedImportcfgDir
, 0)
448 } else if DebugDeprecatedImportcfg
.enabled
{
449 bp
= new(build
.Package
)
450 err
= fmt
.Errorf("unknown import path %q: not in import cfg", importPath
)
452 buildMode
:= build
.ImportComment
453 if mode
&UseVendor
== 0 || path
!= origPath
{
454 // Not vendoring, or we already found the vendored path.
455 buildMode |
= build
.IgnoreVendor
457 bp
, err
= cfg
.BuildContext
.Import(path
, srcDir
, buildMode
)
459 bp
.ImportPath
= importPath
461 bp
.BinDir
= cfg
.GOBIN
463 if debugDeprecatedImportcfgDir
== "" && err
== nil && !isLocal
&& bp
.ImportComment
!= "" && bp
.ImportComment
!= path
&&
464 !strings
.Contains(path
, "/vendor/") && !strings
.HasPrefix(path
, "vendor/") {
465 err
= fmt
.Errorf("code in directory %s expects import %q", bp
.Dir
, bp
.ImportComment
)
468 if p
.Error
!= nil && p
.Error
.Pos
== "" {
469 p
= setErrorPos(p
, importPos
)
472 if debugDeprecatedImportcfgDir
== "" && origPath
!= cleanImport(origPath
) {
473 p
.Error
= &PackageError
{
474 ImportStack
: stk
.Copy(),
475 Err
: fmt
.Sprintf("non-canonical import path: %q should be %q", origPath
, pathpkg
.Clean(origPath
)),
481 // Checked on every import because the rules depend on the code doing the importing.
482 if perr
:= disallowInternal(srcDir
, p
, stk
); perr
!= p
{
483 return setErrorPos(perr
, importPos
)
485 if mode
&UseVendor
!= 0 {
486 if perr
:= disallowVendor(srcDir
, origPath
, p
, stk
); perr
!= p
{
487 return setErrorPos(perr
, importPos
)
491 if p
.Name
== "main" && parent
!= nil && parent
.Dir
!= p
.Dir
{
493 perr
.Error
= &PackageError
{
494 ImportStack
: stk
.Copy(),
495 Err
: fmt
.Sprintf("import %q is a program, not an importable package", path
),
497 return setErrorPos(&perr
, importPos
)
500 if p
.Internal
.Local
&& parent
!= nil && !parent
.Internal
.Local
{
502 perr
.Error
= &PackageError
{
503 ImportStack
: stk
.Copy(),
504 Err
: fmt
.Sprintf("local import %q in non-local package", path
),
506 return setErrorPos(&perr
, importPos
)
512 func setErrorPos(p
*Package
, importPos
[]token
.Position
) *Package
{
513 if len(importPos
) > 0 {
515 pos
.Filename
= base
.ShortPath(pos
.Filename
)
516 p
.Error
.Pos
= pos
.String()
521 func cleanImport(path
string) string {
523 path
= pathpkg
.Clean(path
)
524 if strings
.HasPrefix(orig
, "./") && path
!= ".." && !strings
.HasPrefix(path
, "../") {
530 var isDirCache
= map[string]bool{}
532 func isDir(path
string) bool {
533 result
, ok
:= isDirCache
[path
]
538 fi
, err
:= os
.Stat(path
)
539 result
= err
== nil && fi
.IsDir()
540 isDirCache
[path
] = result
544 // VendoredImportPath returns the expansion of path when it appears in parent.
545 // If parent is x/y/z, then path might expand to x/y/z/vendor/path, x/y/vendor/path,
546 // x/vendor/path, vendor/path, or else stay path if none of those exist.
547 // VendoredImportPath returns the expanded path or, if no expansion is found, the original.
548 func VendoredImportPath(parent
*Package
, path
string) (found
string) {
549 if DebugDeprecatedImportcfg
.enabled
{
550 if d
, i
:= DebugDeprecatedImportcfg
.lookup(parent
, path
); d
!= "" {
556 if parent
== nil || parent
.Root
== "" {
560 dir
:= filepath
.Clean(parent
.Dir
)
561 root
:= filepath
.Join(parent
.Root
, "src")
562 if !str
.HasFilePathPrefix(dir
, root
) || parent
.ImportPath
!= "command-line-arguments" && filepath
.Join(root
, parent
.ImportPath
) != dir
{
563 // Look for symlinks before reporting error.
564 dir
= expandPath(dir
)
565 root
= expandPath(root
)
568 if !str
.HasFilePathPrefix(dir
, root
) ||
len(dir
) <= len(root
) || dir
[len(root
)] != filepath
.Separator || parent
.ImportPath
!= "command-line-arguments" && !parent
.Internal
.Local
&& filepath
.Join(root
, parent
.ImportPath
) != dir
{
569 base
.Fatalf("unexpected directory layout:\n"+
570 " import path: %s\n"+
573 " expand root: %s\n"+
577 filepath
.Join(parent
.Root
, "src"),
578 filepath
.Clean(parent
.Dir
),
581 string(filepath
.Separator
))
584 vpath
:= "vendor/" + path
585 for i
:= len(dir
); i
>= len(root
); i
-- {
586 if i
< len(dir
) && dir
[i
] != filepath
.Separator
{
589 // Note: checking for the vendor directory before checking
590 // for the vendor/path directory helps us hit the
591 // isDir cache more often. It also helps us prepare a more useful
592 // list of places we looked, to report when an import is not found.
593 if !isDir(filepath
.Join(dir
[:i
], "vendor")) {
596 targ
:= filepath
.Join(dir
[:i
], vpath
)
597 if isDir(targ
) && hasGoFiles(targ
) {
598 importPath
:= parent
.ImportPath
599 if importPath
== "command-line-arguments" {
600 // If parent.ImportPath is 'command-line-arguments'.
601 // set to relative directory to root (also chopped root directory)
602 importPath
= dir
[len(root
)+1:]
604 // We started with parent's dir c:\gopath\src\foo\bar\baz\quux\xyzzy.
605 // We know the import path for parent's dir.
606 // We chopped off some number of path elements and
607 // added vendor\path to produce c:\gopath\src\foo\bar\baz\vendor\path.
608 // Now we want to know the import path for that directory.
609 // Construct it by chopping the same number of path elements
610 // (actually the same number of bytes) from parent's import path
611 // and then append /vendor/path.
612 chopped
:= len(dir
) - i
613 if chopped
== len(importPath
)+1 {
614 // We walked up from c:\gopath\src\foo\bar
615 // and found c:\gopath\src\vendor\path.
616 // We chopped \foo\bar (length 8) but the import path is "foo/bar" (length 7).
617 // Use "vendor/path" without any prefix.
620 return importPath
[:len(importPath
)-chopped
] + "/" + vpath
626 // hasGoFiles reports whether dir contains any files with names ending in .go.
627 // For a vendor check we must exclude directories that contain no .go files.
628 // Otherwise it is not possible to vendor just a/b/c and still import the
629 // non-vendored a/b. See golang.org/issue/13832.
630 func hasGoFiles(dir
string) bool {
631 fis
, _
:= ioutil
.ReadDir(dir
)
632 for _
, fi
:= range fis
{
633 if !fi
.IsDir() && strings
.HasSuffix(fi
.Name(), ".go") {
640 // reusePackage reuses package p to satisfy the import at the top
641 // of the import stack stk. If this use causes an import loop,
642 // reusePackage updates p's error information to record the loop.
643 func reusePackage(p
*Package
, stk
*ImportStack
) *Package
{
644 // We use p.Internal.Imports==nil to detect a package that
645 // is in the midst of its own loadPackage call
646 // (all the recursion below happens before p.Internal.Imports gets set).
647 if p
.Internal
.Imports
== nil {
649 p
.Error
= &PackageError
{
650 ImportStack
: stk
.Copy(),
651 Err
: "import cycle not allowed",
657 // Don't rewrite the import stack in the error if we have an import cycle.
658 // If we do, we'll lose the path that describes the cycle.
659 if p
.Error
!= nil && !p
.Error
.IsImportCycle
&& stk
.shorterThan(p
.Error
.ImportStack
) {
660 p
.Error
.ImportStack
= stk
.Copy()
665 // disallowInternal checks that srcDir is allowed to import p.
666 // If the import is allowed, disallowInternal returns the original package p.
667 // If not, it returns a new package containing just an appropriate error.
668 func disallowInternal(srcDir
string, p
*Package
, stk
*ImportStack
) *Package
{
669 // golang.org/s/go14internal:
670 // An import of a path containing the element “internal”
671 // is disallowed if the importing code is outside the tree
672 // rooted at the parent of the “internal” directory.
674 // There was an error loading the package; stop here.
679 // The generated 'testmain' package is allowed to access testing/internal/...,
680 // as if it were generated into the testing directory tree
681 // (it's actually in a temporary directory outside any Go tree).
682 // This cleans up a former kludge in passing functionality to the testing package.
683 if strings
.HasPrefix(p
.ImportPath
, "testing/internal") && len(*stk
) >= 2 && (*stk
)[len(*stk
)-2] == "testmain" {
687 // We can't check standard packages with gccgo.
688 if cfg
.BuildContext
.Compiler
== "gccgo" && p
.Standard
{
692 // The stack includes p.ImportPath.
693 // If that's the only thing on the stack, we started
694 // with a name given on the command line, not an
695 // import. Anything listed on the command line is fine.
700 // Check for "internal" element: three cases depending on begin of string and/or end of string.
701 i
, ok
:= findInternal(p
.ImportPath
)
706 // Internal is present.
707 // Map import path back to directory corresponding to parent of internal.
709 i
-- // rewind over slash in ".../internal"
711 parent
:= p
.Dir
[:i
+len(p
.Dir
)-len(p
.ImportPath
)]
712 if str
.HasFilePathPrefix(filepath
.Clean(srcDir
), filepath
.Clean(parent
)) {
716 // Look for symlinks before reporting error.
717 srcDir
= expandPath(srcDir
)
718 parent
= expandPath(parent
)
719 if str
.HasFilePathPrefix(filepath
.Clean(srcDir
), filepath
.Clean(parent
)) {
723 // Internal is present, and srcDir is outside parent's tree. Not allowed.
725 perr
.Error
= &PackageError
{
726 ImportStack
: stk
.Copy(),
727 Err
: "use of internal package not allowed",
729 perr
.Incomplete
= true
733 // findInternal looks for the final "internal" path element in the given import path.
734 // If there isn't one, findInternal returns ok=false.
735 // Otherwise, findInternal returns ok=true and the index of the "internal".
736 func findInternal(path
string) (index
int, ok
bool) {
737 // Three cases, depending on internal at start/end of string or not.
738 // The order matters: we must return the index of the final element,
739 // because the final one produces the most restrictive requirement
742 case strings
.HasSuffix(path
, "/internal"):
743 return len(path
) - len("internal"), true
744 case strings
.Contains(path
, "/internal/"):
745 return strings
.LastIndex(path
, "/internal/") + 1, true
746 case path
== "internal", strings
.HasPrefix(path
, "internal/"):
752 // disallowVendor checks that srcDir is allowed to import p as path.
753 // If the import is allowed, disallowVendor returns the original package p.
754 // If not, it returns a new package containing just an appropriate error.
755 func disallowVendor(srcDir
, path
string, p
*Package
, stk
*ImportStack
) *Package
{
756 // The stack includes p.ImportPath.
757 // If that's the only thing on the stack, we started
758 // with a name given on the command line, not an
759 // import. Anything listed on the command line is fine.
764 if perr
:= disallowVendorVisibility(srcDir
, p
, stk
); perr
!= p
{
768 // Paths like x/vendor/y must be imported as y, never as x/vendor/y.
769 if i
, ok
:= FindVendor(path
); ok
{
771 perr
.Error
= &PackageError
{
772 ImportStack
: stk
.Copy(),
773 Err
: "must be imported as " + path
[i
+len("vendor/"):],
775 perr
.Incomplete
= true
782 // disallowVendorVisibility checks that srcDir is allowed to import p.
783 // The rules are the same as for /internal/ except that a path ending in /vendor
784 // is not subject to the rules, only subdirectories of vendor.
785 // This allows people to have packages and commands named vendor,
786 // for maximal compatibility with existing source trees.
787 func disallowVendorVisibility(srcDir
string, p
*Package
, stk
*ImportStack
) *Package
{
788 // The stack includes p.ImportPath.
789 // If that's the only thing on the stack, we started
790 // with a name given on the command line, not an
791 // import. Anything listed on the command line is fine.
796 // Check for "vendor" element.
797 i
, ok
:= FindVendor(p
.ImportPath
)
802 // Vendor is present.
803 // Map import path back to directory corresponding to parent of vendor.
805 i
-- // rewind over slash in ".../vendor"
807 truncateTo
:= i
+ len(p
.Dir
) - len(p
.ImportPath
)
808 if truncateTo
< 0 ||
len(p
.Dir
) < truncateTo
{
811 parent
:= p
.Dir
[:truncateTo
]
812 if str
.HasFilePathPrefix(filepath
.Clean(srcDir
), filepath
.Clean(parent
)) {
816 // Look for symlinks before reporting error.
817 srcDir
= expandPath(srcDir
)
818 parent
= expandPath(parent
)
819 if str
.HasFilePathPrefix(filepath
.Clean(srcDir
), filepath
.Clean(parent
)) {
823 // Vendor is present, and srcDir is outside parent's tree. Not allowed.
825 perr
.Error
= &PackageError
{
826 ImportStack
: stk
.Copy(),
827 Err
: "use of vendored package not allowed",
829 perr
.Incomplete
= true
833 // FindVendor looks for the last non-terminating "vendor" path element in the given import path.
834 // If there isn't one, FindVendor returns ok=false.
835 // Otherwise, FindVendor returns ok=true and the index of the "vendor".
837 // Note that terminating "vendor" elements don't count: "x/vendor" is its own package,
838 // not the vendored copy of an import "" (the empty import path).
839 // This will allow people to have packages or commands named vendor.
840 // This may help reduce breakage, or it may just be confusing. We'll see.
841 func FindVendor(path
string) (index
int, ok
bool) {
842 // Two cases, depending on internal at start of string or not.
843 // The order matters: we must return the index of the final element,
844 // because the final one is where the effective import path starts.
846 case strings
.Contains(path
, "/vendor/"):
847 return strings
.LastIndex(path
, "/vendor/") + 1, true
848 case strings
.HasPrefix(path
, "vendor/"):
857 ToTool TargetDir
= iota // to GOROOT/pkg/tool (default for cmd/*)
858 ToBin
// to bin dir inside package root (default for non-cmd/*)
859 StalePath
// an old import path; fail to build
862 // InstallTargetDir reports the target directory for installing the command p.
863 func InstallTargetDir(p
*Package
) TargetDir
{
864 if strings
.HasPrefix(p
.ImportPath
, "code.google.com/p/go.tools/cmd/") {
867 if p
.Goroot
&& strings
.HasPrefix(p
.ImportPath
, "cmd/") && p
.Name
== "main" {
868 switch p
.ImportPath
{
869 case "cmd/go", "cmd/gofmt":
877 var cgoExclude
= map[string]bool{
881 var cgoSyscallExclude
= map[string]bool{
883 "runtime/race": true,
884 "runtime/msan": true,
887 var foldPath
= make(map[string]string)
889 // load populates p using information from bp, err, which should
890 // be the result of calling build.Context.Import.
891 func (p
*Package
) load(stk
*ImportStack
, bp
*build
.Package
, err error
) {
894 // Decide whether p was listed on the command line.
895 // Given that load is called while processing the command line,
896 // you might think we could simply pass a flag down into load
897 // saying whether we are loading something named on the command
898 // line or something to satisfy an import. But the first load of a
899 // package named on the command line may be as a dependency
900 // of an earlier package named on the command line, not when we
901 // get to that package during command line processing.
902 // For example "go test fmt reflect" will load reflect as a dependency
903 // of fmt before it attempts to load as a command-line argument.
904 // Because loads are cached, the later load will be a no-op,
905 // so it is important that the first load can fill in CmdlinePkg correctly.
906 // Hence the call to an explicit matching check here.
907 p
.Internal
.CmdlinePkg
= isCmdlinePkg(p
)
909 p
.Internal
.Asmflags
= BuildAsmflags
.For(p
)
910 p
.Internal
.Gcflags
= BuildGcflags
.For(p
)
911 p
.Internal
.Ldflags
= BuildLdflags
.For(p
)
912 p
.Internal
.Gccgoflags
= BuildGccgoflags
.For(p
)
914 // The localPrefix is the path we interpret ./ imports relative to.
915 // Synthesized main packages sometimes override this.
916 if p
.Internal
.Local
{
917 p
.Internal
.LocalPrefix
= dirToImportPath(p
.Dir
)
921 if _
, ok
:= err
.(*build
.NoGoError
); ok
{
922 err
= &NoGoError
{Package
: p
}
925 err
= base
.ExpandScanner(err
)
926 p
.Error
= &PackageError
{
927 ImportStack
: stk
.Copy(),
933 useBindir
:= p
.Name
== "main"
935 switch cfg
.BuildBuildmode
{
936 case "c-archive", "c-shared", "plugin":
942 // Report an error when the old code.google.com/p/go.tools paths are used.
943 if InstallTargetDir(p
) == StalePath
{
944 newPath
:= strings
.Replace(p
.ImportPath
, "code.google.com/p/go.", "golang.org/x/", 1)
945 e
:= fmt
.Sprintf("the %v command has moved; use %v instead.", p
.ImportPath
, newPath
)
946 p
.Error
= &PackageError
{Err
: e
}
949 _
, elem
:= filepath
.Split(p
.Dir
)
950 full
:= cfg
.BuildContext
.GOOS
+ "_" + cfg
.BuildContext
.GOARCH
+ "/" + elem
951 if cfg
.BuildContext
.GOOS
!= base
.ToolGOOS || cfg
.BuildContext
.GOARCH
!= base
.ToolGOARCH
{
952 // Install cross-compiled binaries to subdirectories of bin.
955 if p
.Internal
.Build
.BinDir
!= "" {
956 // Install to GOBIN or bin of GOPATH entry.
957 p
.Target
= filepath
.Join(p
.Internal
.Build
.BinDir
, elem
)
958 if !p
.Goroot
&& strings
.Contains(elem
, "/") && cfg
.GOBIN
!= "" {
959 // Do not create $GOBIN/goos_goarch/elem.
961 p
.Internal
.GobinSubdir
= true
964 if InstallTargetDir(p
) == ToTool
{
965 // This is for 'go tool'.
966 // Override all the usual logic and force it into the tool directory.
967 if cfg
.BuildToolchainName
== "gccgo" {
968 p
.Target
= filepath
.Join(base
.ToolDir
, elem
)
970 p
.Target
= filepath
.Join(cfg
.GOROOTpkg
, "tool", full
)
973 if p
.Target
!= "" && cfg
.BuildContext
.GOOS
== "windows" {
976 } else if p
.Internal
.Local
{
977 // Local import turned into absolute path.
978 // No permanent install target.
981 p
.Target
= p
.Internal
.Build
.PkgObj
982 if cfg
.BuildLinkshared
{
983 shlibnamefile
:= p
.Target
[:len(p
.Target
)-2] + ".shlibname"
984 shlib
, err
:= ioutil
.ReadFile(shlibnamefile
)
985 if err
!= nil && !os
.IsNotExist(err
) {
986 base
.Fatalf("reading shlibname: %v", err
)
989 libname
:= strings
.TrimSpace(string(shlib
))
990 if cfg
.BuildContext
.Compiler
== "gccgo" {
991 p
.Shlib
= filepath
.Join(p
.Internal
.Build
.PkgTargetRoot
, "shlibs", libname
)
993 p
.Shlib
= filepath
.Join(p
.Internal
.Build
.PkgTargetRoot
, libname
)
999 // Build augmented import list to add implicit dependencies.
1000 // Be careful not to add imports twice, just to avoid confusion.
1001 importPaths
:= p
.Imports
1002 addImport
:= func(path
string) {
1003 for _
, p
:= range importPaths
{
1008 importPaths
= append(importPaths
, path
)
1011 // Cgo translation adds imports of "runtime/cgo" and "syscall",
1012 // except for certain packages, to avoid circular dependencies.
1013 if p
.UsesCgo() && (!p
.Standard ||
!cgoExclude
[p
.ImportPath
]) && cfg
.BuildContext
.Compiler
!= "gccgo" {
1014 addImport("runtime/cgo")
1016 if p
.UsesCgo() && (!p
.Standard ||
!cgoSyscallExclude
[p
.ImportPath
]) {
1017 addImport("syscall")
1020 // SWIG adds imports of some standard packages.
1022 if cfg
.BuildContext
.Compiler
!= "gccgo" {
1023 addImport("runtime/cgo")
1025 addImport("syscall")
1028 // TODO: The .swig and .swigcxx files can use
1029 // %go_import directives to import other packages.
1032 // The linker loads implicit dependencies.
1033 if p
.Name
== "main" && !p
.Internal
.ForceLibrary
{
1034 for _
, dep
:= range LinkerDeps(p
) {
1039 // Check for case-insensitive collision of input files.
1040 // To avoid problems on case-insensitive files, we reject any package
1041 // where two different input files have equal names under a case-insensitive
1043 inputs
:= p
.AllFiles()
1044 f1
, f2
:= str
.FoldDup(inputs
)
1046 p
.Error
= &PackageError
{
1047 ImportStack
: stk
.Copy(),
1048 Err
: fmt
.Sprintf("case-insensitive file name collision: %q and %q", f1
, f2
),
1053 // If first letter of input file is ASCII, it must be alphanumeric.
1054 // This avoids files turning into flags when invoking commands,
1055 // and other problems we haven't thought of yet.
1056 // Also, _cgo_ files must be generated by us, not supplied.
1057 // They are allowed to have //go:cgo_ldflag directives.
1058 // The directory scan ignores files beginning with _,
1059 // so we shouldn't see any _cgo_ files anyway, but just be safe.
1060 for _
, file
:= range inputs
{
1061 if !SafeArg(file
) || strings
.HasPrefix(file
, "_cgo_") {
1062 p
.Error
= &PackageError
{
1063 ImportStack
: stk
.Copy(),
1064 Err
: fmt
.Sprintf("invalid input file name %q", file
),
1069 if name
:= pathpkg
.Base(p
.ImportPath
); !SafeArg(name
) {
1070 p
.Error
= &PackageError
{
1071 ImportStack
: stk
.Copy(),
1072 Err
: fmt
.Sprintf("invalid input directory name %q", name
),
1076 if !SafeArg(p
.ImportPath
) {
1077 p
.Error
= &PackageError
{
1078 ImportStack
: stk
.Copy(),
1079 Err
: fmt
.Sprintf("invalid import path %q", p
.ImportPath
),
1084 // Build list of imported packages and full dependency list.
1085 imports
:= make([]*Package
, 0, len(p
.Imports
))
1086 for i
, path
:= range importPaths
{
1090 p1
:= LoadImport(path
, p
.Dir
, p
, stk
, p
.Internal
.Build
.ImportPos
[path
], UseVendor
)
1091 if p
.Standard
&& p
.Error
== nil && !p1
.Standard
&& p1
.Error
== nil {
1092 p
.Error
= &PackageError
{
1093 ImportStack
: stk
.Copy(),
1094 Err
: fmt
.Sprintf("non-standard import %q in standard package %q", path
, p
.ImportPath
),
1096 pos
:= p
.Internal
.Build
.ImportPos
[path
]
1098 p
.Error
.Pos
= pos
[0].String()
1102 path
= p1
.ImportPath
1103 importPaths
[i
] = path
1104 if i
< len(p
.Imports
) {
1108 imports
= append(imports
, p1
)
1113 p
.Internal
.Imports
= imports
1115 deps
:= make(map[string]*Package
)
1117 q
= append(q
, imports
...)
1118 for i
:= 0; i
< len(q
); i
++ {
1120 path
:= p1
.ImportPath
1121 // The same import path could produce an error or not,
1122 // depending on what tries to import it.
1123 // Prefer to record entries with errors, so we can report them.
1125 if p0
== nil || p1
.Error
!= nil && (p0
.Error
== nil ||
len(p0
.Error
.ImportStack
) > len(p1
.Error
.ImportStack
)) {
1127 for _
, p2
:= range p1
.Internal
.Imports
{
1128 if deps
[p2
.ImportPath
] != p2
{
1135 p
.Deps
= make([]string, 0, len(deps
))
1136 for dep
:= range deps
{
1137 p
.Deps
= append(p
.Deps
, dep
)
1139 sort
.Strings(p
.Deps
)
1140 for _
, dep
:= range p
.Deps
{
1143 panic("impossible: missing entry in package cache for " + dep
+ " imported by " + p
.ImportPath
)
1145 if p1
.Error
!= nil {
1146 p
.DepsErrors
= append(p
.DepsErrors
, p1
.Error
)
1150 // unsafe is a fake package.
1151 if p
.Standard
&& (p
.ImportPath
== "unsafe" || cfg
.BuildContext
.Compiler
== "gccgo") {
1155 // If cgo is not enabled, ignore cgo supporting sources
1156 // just as we ignore go files containing import "C".
1157 if !cfg
.BuildContext
.CgoEnabled
{
1162 p
.SwigCXXFiles
= nil
1163 // Note that SFiles are okay (they go to the Go assembler)
1164 // and HFiles are okay (they might be used by the SFiles).
1165 // Also Sysofiles are okay (they might not contain object
1166 // code; see issue #16050).
1169 setError
:= func(msg
string) {
1170 p
.Error
= &PackageError
{
1171 ImportStack
: stk
.Copy(),
1176 // The gc toolchain only permits C source files with cgo or SWIG.
1177 if len(p
.CFiles
) > 0 && !p
.UsesCgo() && !p
.UsesSwig() && cfg
.BuildContext
.Compiler
== "gc" {
1178 setError(fmt
.Sprintf("C source files not allowed when not using cgo or SWIG: %s", strings
.Join(p
.CFiles
, " ")))
1182 // C++, Objective-C, and Fortran source files are permitted only with cgo or SWIG,
1183 // regardless of toolchain.
1184 if len(p
.CXXFiles
) > 0 && !p
.UsesCgo() && !p
.UsesSwig() {
1185 setError(fmt
.Sprintf("C++ source files not allowed when not using cgo or SWIG: %s", strings
.Join(p
.CXXFiles
, " ")))
1188 if len(p
.MFiles
) > 0 && !p
.UsesCgo() && !p
.UsesSwig() {
1189 setError(fmt
.Sprintf("Objective-C source files not allowed when not using cgo or SWIG: %s", strings
.Join(p
.MFiles
, " ")))
1192 if len(p
.FFiles
) > 0 && !p
.UsesCgo() && !p
.UsesSwig() {
1193 setError(fmt
.Sprintf("Fortran source files not allowed when not using cgo or SWIG: %s", strings
.Join(p
.FFiles
, " ")))
1197 // Check for case-insensitive collisions of import paths.
1198 fold
:= str
.ToFold(p
.ImportPath
)
1199 if other
:= foldPath
[fold
]; other
== "" {
1200 foldPath
[fold
] = p
.ImportPath
1201 } else if other
!= p
.ImportPath
{
1202 setError(fmt
.Sprintf("case-insensitive import collision: %q and %q", p
.ImportPath
, other
))
1207 // SafeArg reports whether arg is a "safe" command-line argument,
1208 // meaning that when it appears in a command-line, it probably
1209 // doesn't have some special meaning other than its own name.
1210 // Obviously args beginning with - are not safe (they look like flags).
1211 // Less obviously, args beginning with @ are not safe (they look like
1212 // GNU binutils flagfile specifiers, sometimes called "response files").
1213 // To be conservative, we reject almost any arg beginning with non-alphanumeric ASCII.
1214 // We accept leading . _ and / as likely in file system paths.
1215 // There is a copy of this function in cmd/compile/internal/gc/noder.go.
1216 func SafeArg(name
string) bool {
1221 return '0' <= c
&& c
<= '9' ||
'A' <= c
&& c
<= 'Z' ||
'a' <= c
&& c
<= 'z' || c
== '.' || c
== '_' || c
== '/' || c
>= utf8
.RuneSelf
1224 // LinkerDeps returns the list of linker-induced dependencies for main package p.
1225 func LinkerDeps(p
*Package
) []string {
1226 // Everything links runtime.
1227 deps
:= []string{"runtime"}
1229 // External linking mode forces an import of runtime/cgo.
1230 if externalLinkingForced(p
) && cfg
.BuildContext
.Compiler
!= "gccgo" {
1231 deps
= append(deps
, "runtime/cgo")
1233 // On ARM with GOARM=5, it forces an import of math, for soft floating point.
1234 if cfg
.Goarch
== "arm" {
1235 deps
= append(deps
, "math")
1237 // Using the race detector forces an import of runtime/race.
1239 deps
= append(deps
, "runtime/race")
1241 // Using memory sanitizer forces an import of runtime/msan.
1243 deps
= append(deps
, "runtime/msan")
1249 // externalLinkingForced reports whether external linking is being
1250 // forced even for programs that do not use cgo.
1251 func externalLinkingForced(p
*Package
) bool {
1252 // Some targets must use external linking even inside GOROOT.
1253 switch cfg
.BuildContext
.GOOS
{
1257 switch cfg
.BuildContext
.GOARCH
{
1258 case "arm", "arm64":
1263 if !cfg
.BuildContext
.CgoEnabled
{
1266 // Currently build modes c-shared, pie (on systems that do not
1267 // support PIE with internal linking mode (currently all
1268 // systems: issue #18968)), plugin, and -linkshared force
1269 // external linking mode, as of course does
1270 // -ldflags=-linkmode=external. External linking mode forces
1271 // an import of runtime/cgo.
1272 pieCgo
:= cfg
.BuildBuildmode
== "pie"
1273 linkmodeExternal
:= false
1275 ldflags
:= BuildLdflags
.For(p
)
1276 for i
, a
:= range ldflags
{
1277 if a
== "-linkmode=external" {
1278 linkmodeExternal
= true
1280 if a
== "-linkmode" && i
+1 < len(ldflags
) && ldflags
[i
+1] == "external" {
1281 linkmodeExternal
= true
1286 return cfg
.BuildBuildmode
== "c-shared" || cfg
.BuildBuildmode
== "plugin" || pieCgo || cfg
.BuildLinkshared || linkmodeExternal
1289 // mkAbs rewrites list, which must be paths relative to p.Dir,
1290 // into a sorted list of absolute paths. It edits list in place but for
1291 // convenience also returns list back to its caller.
1292 func (p
*Package
) mkAbs(list
[]string) []string {
1293 for i
, f
:= range list
{
1294 list
[i
] = filepath
.Join(p
.Dir
, f
)
1300 // InternalGoFiles returns the list of Go files being built for the package,
1301 // using absolute paths.
1302 func (p
*Package
) InternalGoFiles() []string {
1303 return p
.mkAbs(str
.StringList(p
.GoFiles
, p
.CgoFiles
, p
.TestGoFiles
, p
.XTestGoFiles
))
1306 // InternalGoFiles returns the list of all Go files possibly relevant for the package,
1307 // using absolute paths. "Possibly relevant" means that files are not excluded
1308 // due to build tags, but files with names beginning with . or _ are still excluded.
1309 func (p
*Package
) InternalAllGoFiles() []string {
1311 for _
, f
:= range p
.IgnoredGoFiles
{
1312 if f
!= "" && f
[0] != '.' || f
[0] != '_' {
1313 extra
= append(extra
, f
)
1316 return p
.mkAbs(str
.StringList(extra
, p
.GoFiles
, p
.CgoFiles
, p
.TestGoFiles
, p
.XTestGoFiles
))
1319 // usesSwig reports whether the package needs to run SWIG.
1320 func (p
*Package
) UsesSwig() bool {
1321 return len(p
.SwigFiles
) > 0 ||
len(p
.SwigCXXFiles
) > 0
1324 // usesCgo reports whether the package needs to run cgo
1325 func (p
*Package
) UsesCgo() bool {
1326 return len(p
.CgoFiles
) > 0
1329 // packageList returns the list of packages in the dag rooted at roots
1330 // as visited in a depth-first post-order traversal.
1331 func PackageList(roots
[]*Package
) []*Package
{
1332 seen
:= map[*Package
]bool{}
1334 var walk
func(*Package
)
1335 walk
= func(p
*Package
) {
1340 for _
, p1
:= range p
.Internal
.Imports
{
1343 all
= append(all
, p
)
1345 for _
, root
:= range roots
{
1351 var cmdCache
= map[string]*Package
{}
1353 func ClearCmdCache() {
1354 for name
:= range cmdCache
{
1355 delete(cmdCache
, name
)
1359 // loadPackage is like loadImport but is used for command-line arguments,
1360 // not for paths found in import statements. In addition to ordinary import paths,
1361 // loadPackage accepts pseudo-paths beginning with cmd/ to denote commands
1362 // in the Go command directory, as well as paths to those directories.
1363 func LoadPackage(arg
string, stk
*ImportStack
) *Package
{
1364 if build
.IsLocalImport(arg
) {
1366 if !filepath
.IsAbs(dir
) {
1367 if abs
, err
:= filepath
.Abs(dir
); err
== nil {
1368 // interpret relative to current directory
1372 if sub
, ok
:= hasSubdir(cfg
.GOROOTsrc
, dir
); ok
&& strings
.HasPrefix(sub
, "cmd/") && !strings
.Contains(sub
[4:], "/") {
1376 if strings
.HasPrefix(arg
, "cmd/") && !strings
.Contains(arg
[4:], "/") {
1377 if p
:= cmdCache
[arg
]; p
!= nil {
1383 bp
, err
:= cfg
.BuildContext
.ImportDir(filepath
.Join(cfg
.GOROOTsrc
, arg
), 0)
1386 bp
.BinDir
= cfg
.GOROOTbin
1387 if cfg
.GOROOTbin
!= "" {
1388 bp
.BinDir
= cfg
.GOROOTbin
1390 bp
.Root
= cfg
.GOROOT
1391 bp
.SrcRoot
= cfg
.GOROOTsrc
1394 p
.load(stk
, bp
, err
)
1395 if p
.Error
== nil && p
.Name
!= "main" {
1396 p
.Error
= &PackageError
{
1397 ImportStack
: stk
.Copy(),
1398 Err
: fmt
.Sprintf("expected package main but found package %s in %s", p
.Name
, p
.Dir
),
1404 // Wasn't a command; must be a package.
1405 // If it is a local import path but names a standard package,
1406 // we treat it as if the user specified the standard package.
1407 // This lets you run go test ./ioutil in package io and be
1408 // referring to io/ioutil rather than a hypothetical import of
1410 if build
.IsLocalImport(arg
) {
1411 bp
, _
:= cfg
.BuildContext
.ImportDir(filepath
.Join(base
.Cwd
, arg
), build
.FindOnly
)
1412 if bp
.ImportPath
!= "" && bp
.ImportPath
!= "." {
1417 return LoadImport(arg
, base
.Cwd
, nil, stk
, nil, 0)
1420 // packages returns the packages named by the
1421 // command line arguments 'args'. If a named package
1422 // cannot be loaded at all (for example, if the directory does not exist),
1423 // then packages prints an error and does not include that
1424 // package in the results. However, if errors occur trying
1425 // to load dependencies of a named package, the named
1426 // package is still returned, with p.Incomplete = true
1427 // and details in p.DepsErrors.
1428 func Packages(args
[]string) []*Package
{
1430 for _
, pkg
:= range PackagesAndErrors(args
) {
1431 if pkg
.Error
!= nil {
1432 base
.Errorf("can't load package: %s", pkg
.Error
)
1435 pkgs
= append(pkgs
, pkg
)
1440 // packagesAndErrors is like 'packages' but returns a
1441 // *Package for every argument, even the ones that
1442 // cannot be loaded at all.
1443 // The packages that fail to load will have p.Error != nil.
1444 func PackagesAndErrors(args
[]string) []*Package
{
1445 if len(args
) > 0 && strings
.HasSuffix(args
[0], ".go") {
1446 return []*Package
{GoFilesPackage(args
)}
1449 args
= ImportPaths(args
)
1453 seenArg
= make(map[string]bool)
1454 seenPkg
= make(map[*Package
]bool)
1457 for _
, arg
:= range args
{
1462 pkg
:= LoadPackage(arg
, &stk
)
1467 pkgs
= append(pkgs
, pkg
)
1473 // packagesForBuild is like 'packages' but fails if any of
1474 // the packages or their dependencies have errors
1475 // (cannot be built).
1476 func PackagesForBuild(args
[]string) []*Package
{
1477 pkgs
:= PackagesAndErrors(args
)
1478 printed
:= map[*PackageError
]bool{}
1479 for _
, pkg
:= range pkgs
{
1480 if pkg
.Error
!= nil {
1481 base
.Errorf("can't load package: %s", pkg
.Error
)
1483 for _
, err
:= range pkg
.DepsErrors
{
1484 // Since these are errors in dependencies,
1485 // the same error might show up multiple times,
1486 // once in each package that depends on it.
1487 // Only print each once.
1490 base
.Errorf("%s", err
)
1496 // Check for duplicate loads of the same package.
1497 // That should be impossible, but if it does happen then
1498 // we end up trying to build the same package twice,
1499 // usually in parallel overwriting the same files,
1500 // which doesn't work very well.
1501 seen
:= map[string]bool{}
1502 reported
:= map[string]bool{}
1503 for _
, pkg
:= range PackageList(pkgs
) {
1504 if seen
[pkg
.ImportPath
] && !reported
[pkg
.ImportPath
] {
1505 reported
[pkg
.ImportPath
] = true
1506 base
.Errorf("internal error: duplicate loads of %s", pkg
.ImportPath
)
1508 seen
[pkg
.ImportPath
] = true
1515 // GoFilesPackage creates a package for building a collection of Go files
1516 // (typically named on the command line). The target is named p.a for
1517 // package p or named after the first Go file for package main.
1518 func GoFilesPackage(gofiles
[]string) *Package
{
1519 // TODO: Remove this restriction.
1520 for _
, f
:= range gofiles
{
1521 if !strings
.HasSuffix(f
, ".go") {
1522 base
.Fatalf("named files must be .go files")
1527 ctxt
:= cfg
.BuildContext
1528 ctxt
.UseAllFiles
= true
1530 // Synthesize fake "directory" that only shows the named files,
1531 // to make it look like this is a standard package or
1532 // command directory. So that local imports resolve
1533 // consistently, the files must all be in the same directory.
1534 var dirent
[]os
.FileInfo
1536 for _
, file
:= range gofiles
{
1537 fi
, err
:= os
.Stat(file
)
1539 base
.Fatalf("%s", err
)
1542 base
.Fatalf("%s is a directory, should be a Go file", file
)
1544 dir1
, _
:= filepath
.Split(file
)
1550 } else if dir
!= dir1
{
1551 base
.Fatalf("named files must all be in one directory; have %s and %s", dir
, dir1
)
1553 dirent
= append(dirent
, fi
)
1555 ctxt
.ReadDir
= func(string) ([]os
.FileInfo
, error
) { return dirent
, nil }
1561 dir
, err
= filepath
.Abs(dir
)
1563 base
.Fatalf("%s", err
)
1566 bp
, err
:= ctxt
.ImportDir(dir
, 0)
1568 pkg
.Internal
.Local
= true
1569 pkg
.Internal
.CmdlineFiles
= true
1571 pkg
.load(&stk
, bp
, err
)
1573 pkg
.Internal
.LocalPrefix
= dirToImportPath(dir
)
1574 pkg
.ImportPath
= "command-line-arguments"
1577 if pkg
.Name
== "main" {
1578 _
, elem
:= filepath
.Split(gofiles
[0])
1579 exe
:= elem
[:len(elem
)-len(".go")] + cfg
.ExeSuffix
1580 if cfg
.BuildO
== "" {
1583 if cfg
.GOBIN
!= "" {
1584 pkg
.Target
= filepath
.Join(cfg
.GOBIN
, exe
)
1591 // GetTestPackagesFor returns package structs ptest, the package p plus
1592 // its test files, and pxtest, the external tests of package p.
1593 // pxtest may be nil. If there are no test files, forceTest decides
1594 // whether this returns a new package struct or just returns p.
1595 func GetTestPackagesFor(p
*Package
, forceTest
bool) (ptest
, pxtest
*Package
, err error
) {
1596 var imports
, ximports
[]*Package
1598 stk
.Push(p
.ImportPath
+ " (test)")
1599 rawTestImports
:= str
.StringList(p
.TestImports
)
1600 for i
, path
:= range p
.TestImports
{
1601 p1
:= LoadImport(path
, p
.Dir
, p
, &stk
, p
.Internal
.Build
.TestImportPos
[path
], UseVendor
)
1602 if p1
.Error
!= nil {
1603 return nil, nil, p1
.Error
1605 if len(p1
.DepsErrors
) > 0 {
1606 err
:= p1
.DepsErrors
[0]
1607 err
.Pos
= "" // show full import stack
1608 return nil, nil, err
1610 if str
.Contains(p1
.Deps
, p
.ImportPath
) || p1
.ImportPath
== p
.ImportPath
{
1611 // Same error that loadPackage returns (via reusePackage) in pkg.go.
1612 // Can't change that code, because that code is only for loading the
1613 // non-test copy of a package.
1614 err
:= &PackageError
{
1615 ImportStack
: testImportStack(stk
[0], p1
, p
.ImportPath
),
1616 Err
: "import cycle not allowed in test",
1617 IsImportCycle
: true,
1619 return nil, nil, err
1621 p
.TestImports
[i
] = p1
.ImportPath
1622 imports
= append(imports
, p1
)
1625 stk
.Push(p
.ImportPath
+ "_test")
1626 pxtestNeedsPtest
:= false
1627 rawXTestImports
:= str
.StringList(p
.XTestImports
)
1628 for i
, path
:= range p
.XTestImports
{
1629 p1
:= LoadImport(path
, p
.Dir
, p
, &stk
, p
.Internal
.Build
.XTestImportPos
[path
], UseVendor
)
1630 if p1
.Error
!= nil {
1631 return nil, nil, p1
.Error
1633 if len(p1
.DepsErrors
) > 0 {
1634 err
:= p1
.DepsErrors
[0]
1635 err
.Pos
= "" // show full import stack
1636 return nil, nil, err
1638 if p1
.ImportPath
== p
.ImportPath
{
1639 pxtestNeedsPtest
= true
1641 ximports
= append(ximports
, p1
)
1643 p
.XTestImports
[i
] = p1
.ImportPath
1648 if len(p
.TestGoFiles
) > 0 || forceTest
{
1649 ptest
= new(Package
)
1652 ptest
.GoFiles
= append(ptest
.GoFiles
, p
.GoFiles
...)
1653 ptest
.GoFiles
= append(ptest
.GoFiles
, p
.TestGoFiles
...)
1655 // Note: The preparation of the vet config requires that common
1656 // indexes in ptest.Imports, ptest.Internal.Imports, and ptest.Internal.RawImports
1657 // all line up (but RawImports can be shorter than the others).
1658 // That is, for 0 ≤ i < len(RawImports),
1659 // RawImports[i] is the import string in the program text,
1660 // Imports[i] is the expanded import string (vendoring applied or relative path expanded away),
1661 // and Internal.Imports[i] is the corresponding *Package.
1662 // Any implicitly added imports appear in Imports and Internal.Imports
1663 // but not RawImports (because they were not in the source code).
1664 // We insert TestImports, imports, and rawTestImports at the start of
1665 // these lists to preserve the alignment.
1666 ptest
.Imports
= str
.StringList(p
.TestImports
, p
.Imports
)
1667 ptest
.Internal
.Imports
= append(imports
, p
.Internal
.Imports
...)
1668 ptest
.Internal
.RawImports
= str
.StringList(rawTestImports
, p
.Internal
.RawImports
)
1669 ptest
.Internal
.ForceLibrary
= true
1670 ptest
.Internal
.Build
= new(build
.Package
)
1671 *ptest
.Internal
.Build
= *p
.Internal
.Build
1672 m
:= map[string][]token
.Position
{}
1673 for k
, v
:= range p
.Internal
.Build
.ImportPos
{
1674 m
[k
] = append(m
[k
], v
...)
1676 for k
, v
:= range p
.Internal
.Build
.TestImportPos
{
1677 m
[k
] = append(m
[k
], v
...)
1679 ptest
.Internal
.Build
.ImportPos
= m
1684 // External test package.
1685 if len(p
.XTestGoFiles
) > 0 {
1687 PackagePublic
: PackagePublic
{
1688 Name
: p
.Name
+ "_test",
1689 ImportPath
: p
.ImportPath
+ "_test",
1692 GoFiles
: p
.XTestGoFiles
,
1693 Imports
: p
.XTestImports
,
1695 Internal
: PackageInternal
{
1696 LocalPrefix
: p
.Internal
.LocalPrefix
,
1697 Build
: &build
.Package
{
1698 ImportPos
: p
.Internal
.Build
.XTestImportPos
,
1701 RawImports
: rawXTestImports
,
1703 Asmflags
: p
.Internal
.Asmflags
,
1704 Gcflags
: p
.Internal
.Gcflags
,
1705 Ldflags
: p
.Internal
.Ldflags
,
1706 Gccgoflags
: p
.Internal
.Gccgoflags
,
1709 if pxtestNeedsPtest
{
1710 pxtest
.Internal
.Imports
= append(pxtest
.Internal
.Imports
, ptest
)
1714 return ptest
, pxtest
, nil
1717 func testImportStack(top
string, p
*Package
, target
string) []string {
1718 stk
:= []string{top
, p
.ImportPath
}
1720 for p
.ImportPath
!= target
{
1721 for _
, p1
:= range p
.Internal
.Imports
{
1722 if p1
.ImportPath
== target || str
.Contains(p1
.Deps
, target
) {
1723 stk
= append(stk
, p1
.ImportPath
)
1728 // Can't happen, but in case it does...
1729 stk
= append(stk
, "<lost path to cycle>")