github.com/s1s1ty/go@v0.0.0-20180207192209-104445e3140f/src/cmd/go/internal/work/exec.go (about) 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. 4 5 // Action graph execution. 6 7 package work 8 9 import ( 10 "bytes" 11 "encoding/json" 12 "errors" 13 "fmt" 14 "io" 15 "io/ioutil" 16 "log" 17 "os" 18 "os/exec" 19 "path/filepath" 20 "regexp" 21 "runtime" 22 "strconv" 23 "strings" 24 "sync" 25 "time" 26 27 "cmd/go/internal/base" 28 "cmd/go/internal/cache" 29 "cmd/go/internal/cfg" 30 "cmd/go/internal/load" 31 "cmd/go/internal/str" 32 ) 33 34 // actionList returns the list of actions in the dag rooted at root 35 // as visited in a depth-first post-order traversal. 36 func actionList(root *Action) []*Action { 37 seen := map[*Action]bool{} 38 all := []*Action{} 39 var walk func(*Action) 40 walk = func(a *Action) { 41 if seen[a] { 42 return 43 } 44 seen[a] = true 45 for _, a1 := range a.Deps { 46 walk(a1) 47 } 48 all = append(all, a) 49 } 50 walk(root) 51 return all 52 } 53 54 // do runs the action graph rooted at root. 55 func (b *Builder) Do(root *Action) { 56 if c := cache.Default(); c != nil && !b.ComputeStaleOnly { 57 // If we're doing real work, take time at the end to trim the cache. 58 defer c.Trim() 59 } 60 61 // Build list of all actions, assigning depth-first post-order priority. 62 // The original implementation here was a true queue 63 // (using a channel) but it had the effect of getting 64 // distracted by low-level leaf actions to the detriment 65 // of completing higher-level actions. The order of 66 // work does not matter much to overall execution time, 67 // but when running "go test std" it is nice to see each test 68 // results as soon as possible. The priorities assigned 69 // ensure that, all else being equal, the execution prefers 70 // to do what it would have done first in a simple depth-first 71 // dependency order traversal. 72 all := actionList(root) 73 for i, a := range all { 74 a.priority = i 75 } 76 77 if cfg.DebugActiongraph != "" { 78 js := actionGraphJSON(root) 79 if err := ioutil.WriteFile(cfg.DebugActiongraph, []byte(js), 0666); err != nil { 80 fmt.Fprintf(os.Stderr, "go: writing action graph: %v\n", err) 81 base.SetExitStatus(1) 82 } 83 } 84 85 b.readySema = make(chan bool, len(all)) 86 87 // Initialize per-action execution state. 88 for _, a := range all { 89 for _, a1 := range a.Deps { 90 a1.triggers = append(a1.triggers, a) 91 } 92 a.pending = len(a.Deps) 93 if a.pending == 0 { 94 b.ready.push(a) 95 b.readySema <- true 96 } 97 } 98 99 // Handle runs a single action and takes care of triggering 100 // any actions that are runnable as a result. 101 handle := func(a *Action) { 102 var err error 103 104 if a.Func != nil && (!a.Failed || a.IgnoreFail) { 105 if err == nil { 106 err = a.Func(b, a) 107 } 108 } 109 110 // The actions run in parallel but all the updates to the 111 // shared work state are serialized through b.exec. 112 b.exec.Lock() 113 defer b.exec.Unlock() 114 115 if err != nil { 116 if err == errPrintedOutput { 117 base.SetExitStatus(2) 118 } else { 119 base.Errorf("%s", err) 120 } 121 a.Failed = true 122 } 123 124 for _, a0 := range a.triggers { 125 if a.Failed { 126 a0.Failed = true 127 } 128 if a0.pending--; a0.pending == 0 { 129 b.ready.push(a0) 130 b.readySema <- true 131 } 132 } 133 134 if a == root { 135 close(b.readySema) 136 } 137 } 138 139 var wg sync.WaitGroup 140 141 // Kick off goroutines according to parallelism. 142 // If we are using the -n flag (just printing commands) 143 // drop the parallelism to 1, both to make the output 144 // deterministic and because there is no real work anyway. 145 par := cfg.BuildP 146 if cfg.BuildN { 147 par = 1 148 } 149 for i := 0; i < par; i++ { 150 wg.Add(1) 151 go func() { 152 defer wg.Done() 153 for { 154 select { 155 case _, ok := <-b.readySema: 156 if !ok { 157 return 158 } 159 // Receiving a value from b.readySema entitles 160 // us to take from the ready queue. 161 b.exec.Lock() 162 a := b.ready.pop() 163 b.exec.Unlock() 164 handle(a) 165 case <-base.Interrupted: 166 base.SetExitStatus(1) 167 return 168 } 169 } 170 }() 171 } 172 173 wg.Wait() 174 } 175 176 // buildActionID computes the action ID for a build action. 177 func (b *Builder) buildActionID(a *Action) cache.ActionID { 178 p := a.Package 179 h := cache.NewHash("build " + p.ImportPath) 180 181 // Configuration independent of compiler toolchain. 182 // Note: buildmode has already been accounted for in buildGcflags 183 // and should not be inserted explicitly. Most buildmodes use the 184 // same compiler settings and can reuse each other's results. 185 // If not, the reason is already recorded in buildGcflags. 186 fmt.Fprintf(h, "compile\n") 187 // The compiler hides the exact value of $GOROOT 188 // when building things in GOROOT, 189 // but it does not hide the exact value of $GOPATH. 190 // Include the full dir in that case. 191 // Assume b.WorkDir is being trimmed properly. 192 if !p.Goroot && !strings.HasPrefix(p.Dir, b.WorkDir) { 193 fmt.Fprintf(h, "dir %s\n", p.Dir) 194 } 195 fmt.Fprintf(h, "goos %s goarch %s\n", cfg.Goos, cfg.Goarch) 196 fmt.Fprintf(h, "import %q\n", p.ImportPath) 197 fmt.Fprintf(h, "omitdebug %v standard %v local %v prefix %q\n", p.Internal.OmitDebug, p.Standard, p.Internal.Local, p.Internal.LocalPrefix) 198 if len(p.CgoFiles)+len(p.SwigFiles) > 0 { 199 fmt.Fprintf(h, "cgo %q\n", b.toolID("cgo")) 200 cppflags, cflags, cxxflags, fflags, _, _ := b.CFlags(p) 201 fmt.Fprintf(h, "CC=%q %q %q\n", b.ccExe(), cppflags, cflags) 202 if len(p.CXXFiles)+len(p.SwigFiles) > 0 { 203 fmt.Fprintf(h, "CXX=%q %q\n", b.cxxExe(), cxxflags) 204 } 205 if len(p.FFiles) > 0 { 206 fmt.Fprintf(h, "FC=%q %q\n", b.fcExe(), fflags) 207 } 208 // TODO(rsc): Should we include the SWIG version or Fortran/GCC/G++/Objective-C compiler versions? 209 } 210 if p.Internal.CoverMode != "" { 211 fmt.Fprintf(h, "cover %q %q\n", p.Internal.CoverMode, b.toolID("cover")) 212 } 213 214 // Configuration specific to compiler toolchain. 215 switch cfg.BuildToolchainName { 216 default: 217 base.Fatalf("buildActionID: unknown build toolchain %q", cfg.BuildToolchainName) 218 case "gc": 219 fmt.Fprintf(h, "compile %s %q %q\n", b.toolID("compile"), forcedGcflags, p.Internal.Gcflags) 220 if len(p.SFiles) > 0 { 221 fmt.Fprintf(h, "asm %q %q %q\n", b.toolID("asm"), forcedAsmflags, p.Internal.Asmflags) 222 } 223 fmt.Fprintf(h, "GO$GOARCH=%s\n", os.Getenv("GO"+strings.ToUpper(cfg.BuildContext.GOARCH))) // GO386, GOARM, etc 224 225 // TODO(rsc): Convince compiler team not to add more magic environment variables, 226 // or perhaps restrict the environment variables passed to subprocesses. 227 magic := []string{ 228 "GOCLOBBERDEADHASH", 229 "GOSSAFUNC", 230 "GO_SSA_PHI_LOC_CUTOFF", 231 "GOSSAHASH", 232 } 233 for _, env := range magic { 234 if x := os.Getenv(env); x != "" { 235 fmt.Fprintf(h, "magic %s=%s\n", env, x) 236 } 237 } 238 if os.Getenv("GOSSAHASH") != "" { 239 for i := 0; ; i++ { 240 env := fmt.Sprintf("GOSSAHASH%d", i) 241 x := os.Getenv(env) 242 if x == "" { 243 break 244 } 245 fmt.Fprintf(h, "magic %s=%s\n", env, x) 246 } 247 } 248 if os.Getenv("GSHS_LOGFILE") != "" { 249 // Clumsy hack. Compiler writes to this log file, 250 // so do not allow use of cache at all. 251 // We will still write to the cache but it will be 252 // essentially unfindable. 253 fmt.Fprintf(h, "nocache %d\n", time.Now().UnixNano()) 254 } 255 256 case "gccgo": 257 id, err := b.gccgoToolID(BuildToolchain.compiler(), "go") 258 if err != nil { 259 base.Fatalf("%v", err) 260 } 261 fmt.Fprintf(h, "compile %s %q %q\n", id, forcedGccgoflags, p.Internal.Gccgoflags) 262 fmt.Fprintf(h, "pkgpath %s\n", gccgoPkgpath(p)) 263 if len(p.SFiles) > 0 { 264 id, err = b.gccgoToolID(BuildToolchain.compiler(), "assembler-with-cpp") 265 // Ignore error; different assembler versions 266 // are unlikely to make any difference anyhow. 267 fmt.Fprintf(h, "asm %q\n", id) 268 } 269 } 270 271 // Input files. 272 inputFiles := str.StringList( 273 p.GoFiles, 274 p.CgoFiles, 275 p.CFiles, 276 p.CXXFiles, 277 p.FFiles, 278 p.MFiles, 279 p.HFiles, 280 p.SFiles, 281 p.SysoFiles, 282 p.SwigFiles, 283 p.SwigCXXFiles, 284 ) 285 for _, file := range inputFiles { 286 fmt.Fprintf(h, "file %s %s\n", file, b.fileHash(filepath.Join(p.Dir, file))) 287 } 288 for _, a1 := range a.Deps { 289 p1 := a1.Package 290 if p1 != nil { 291 fmt.Fprintf(h, "import %s %s\n", p1.ImportPath, contentID(a1.buildID)) 292 } 293 } 294 295 return h.Sum() 296 } 297 298 // build is the action for building a single package. 299 // Note that any new influence on this logic must be reported in b.buildActionID above as well. 300 func (b *Builder) build(a *Action) (err error) { 301 p := a.Package 302 cached := false 303 if !p.BinaryOnly { 304 if b.useCache(a, p, b.buildActionID(a), p.Target) { 305 // If this build triggers a header install, run cgo to get the header. 306 // TODO(rsc): Once we can cache multiple file outputs from an action, 307 // the header should be cached, and then this awful test can be deleted. 308 // Need to look for install header actions depending on this action, 309 // or depending on a link that depends on this action. 310 needHeader := false 311 if (a.Package.UsesCgo() || a.Package.UsesSwig()) && (cfg.BuildBuildmode == "c-archive" || cfg.BuildBuildmode == "c-shared") { 312 for _, t1 := range a.triggers { 313 if t1.Mode == "install header" { 314 needHeader = true 315 goto CheckedHeader 316 } 317 } 318 for _, t1 := range a.triggers { 319 for _, t2 := range t1.triggers { 320 if t2.Mode == "install header" { 321 needHeader = true 322 goto CheckedHeader 323 } 324 } 325 } 326 } 327 CheckedHeader: 328 if b.ComputeStaleOnly || !a.needVet && !needHeader { 329 return nil 330 } 331 cached = true 332 } 333 defer b.flushOutput(a) 334 } 335 336 defer func() { 337 if err != nil && err != errPrintedOutput { 338 err = fmt.Errorf("go build %s: %v", a.Package.ImportPath, err) 339 } 340 }() 341 if cfg.BuildN { 342 // In -n mode, print a banner between packages. 343 // The banner is five lines so that when changes to 344 // different sections of the bootstrap script have to 345 // be merged, the banners give patch something 346 // to use to find its context. 347 b.Print("\n#\n# " + a.Package.ImportPath + "\n#\n\n") 348 } 349 350 if cfg.BuildV { 351 b.Print(a.Package.ImportPath + "\n") 352 } 353 354 if a.Package.BinaryOnly { 355 _, err := os.Stat(a.Package.Target) 356 if err == nil { 357 a.built = a.Package.Target 358 a.Target = a.Package.Target 359 a.buildID = b.fileHash(a.Package.Target) 360 a.Package.Stale = false 361 a.Package.StaleReason = "binary-only package" 362 return nil 363 } 364 if b.ComputeStaleOnly { 365 a.Package.Stale = true 366 a.Package.StaleReason = "missing or invalid binary-only package" 367 return nil 368 } 369 return fmt.Errorf("missing or invalid binary-only package") 370 } 371 372 if err := b.Mkdir(a.Objdir); err != nil { 373 return err 374 } 375 objdir := a.Objdir 376 377 // make target directory 378 dir, _ := filepath.Split(a.Target) 379 if dir != "" { 380 if err := b.Mkdir(dir); err != nil { 381 return err 382 } 383 } 384 385 var gofiles, cgofiles, cfiles, sfiles, cxxfiles, objects, cgoObjects, pcCFLAGS, pcLDFLAGS []string 386 387 gofiles = append(gofiles, a.Package.GoFiles...) 388 cgofiles = append(cgofiles, a.Package.CgoFiles...) 389 cfiles = append(cfiles, a.Package.CFiles...) 390 sfiles = append(sfiles, a.Package.SFiles...) 391 cxxfiles = append(cxxfiles, a.Package.CXXFiles...) 392 393 if a.Package.UsesCgo() || a.Package.UsesSwig() { 394 if pcCFLAGS, pcLDFLAGS, err = b.getPkgConfigFlags(a.Package); err != nil { 395 return 396 } 397 } 398 399 // Run SWIG on each .swig and .swigcxx file. 400 // Each run will generate two files, a .go file and a .c or .cxx file. 401 // The .go file will use import "C" and is to be processed by cgo. 402 if a.Package.UsesSwig() { 403 outGo, outC, outCXX, err := b.swig(a, a.Package, objdir, pcCFLAGS) 404 if err != nil { 405 return err 406 } 407 cgofiles = append(cgofiles, outGo...) 408 cfiles = append(cfiles, outC...) 409 cxxfiles = append(cxxfiles, outCXX...) 410 } 411 412 // If we're doing coverage, preprocess the .go files and put them in the work directory 413 if a.Package.Internal.CoverMode != "" { 414 for i, file := range str.StringList(gofiles, cgofiles) { 415 var sourceFile string 416 var coverFile string 417 var key string 418 if strings.HasSuffix(file, ".cgo1.go") { 419 // cgo files have absolute paths 420 base := filepath.Base(file) 421 sourceFile = file 422 coverFile = objdir + base 423 key = strings.TrimSuffix(base, ".cgo1.go") + ".go" 424 } else { 425 sourceFile = filepath.Join(a.Package.Dir, file) 426 coverFile = objdir + file 427 key = file 428 } 429 coverFile = strings.TrimSuffix(coverFile, ".go") + ".cover.go" 430 cover := a.Package.Internal.CoverVars[key] 431 if cover == nil || base.IsTestFile(file) { 432 // Not covering this file. 433 continue 434 } 435 if err := b.cover(a, coverFile, sourceFile, 0666, cover.Var); err != nil { 436 return err 437 } 438 if i < len(gofiles) { 439 gofiles[i] = coverFile 440 } else { 441 cgofiles[i-len(gofiles)] = coverFile 442 } 443 } 444 } 445 446 // Run cgo. 447 if a.Package.UsesCgo() || a.Package.UsesSwig() { 448 // In a package using cgo, cgo compiles the C, C++ and assembly files with gcc. 449 // There is one exception: runtime/cgo's job is to bridge the 450 // cgo and non-cgo worlds, so it necessarily has files in both. 451 // In that case gcc only gets the gcc_* files. 452 var gccfiles []string 453 gccfiles = append(gccfiles, cfiles...) 454 cfiles = nil 455 if a.Package.Standard && a.Package.ImportPath == "runtime/cgo" { 456 filter := func(files, nongcc, gcc []string) ([]string, []string) { 457 for _, f := range files { 458 if strings.HasPrefix(f, "gcc_") { 459 gcc = append(gcc, f) 460 } else { 461 nongcc = append(nongcc, f) 462 } 463 } 464 return nongcc, gcc 465 } 466 sfiles, gccfiles = filter(sfiles, sfiles[:0], gccfiles) 467 } else { 468 for _, sfile := range sfiles { 469 data, err := ioutil.ReadFile(filepath.Join(a.Package.Dir, sfile)) 470 if err == nil { 471 if bytes.HasPrefix(data, []byte("TEXT")) || bytes.Contains(data, []byte("\nTEXT")) || 472 bytes.HasPrefix(data, []byte("DATA")) || bytes.Contains(data, []byte("\nDATA")) || 473 bytes.HasPrefix(data, []byte("GLOBL")) || bytes.Contains(data, []byte("\nGLOBL")) { 474 return fmt.Errorf("package using cgo has Go assembly file %s", sfile) 475 } 476 } 477 } 478 gccfiles = append(gccfiles, sfiles...) 479 sfiles = nil 480 } 481 482 outGo, outObj, err := b.cgo(a, base.Tool("cgo"), objdir, pcCFLAGS, pcLDFLAGS, mkAbsFiles(a.Package.Dir, cgofiles), gccfiles, cxxfiles, a.Package.MFiles, a.Package.FFiles) 483 if err != nil { 484 return err 485 } 486 if cfg.BuildToolchainName == "gccgo" { 487 cgoObjects = append(cgoObjects, a.Objdir+"_cgo_flags") 488 } 489 cgoObjects = append(cgoObjects, outObj...) 490 gofiles = append(gofiles, outGo...) 491 } 492 if cached && !a.needVet { 493 return nil 494 } 495 496 // Sanity check only, since Package.load already checked as well. 497 if len(gofiles) == 0 { 498 return &load.NoGoError{Package: a.Package} 499 } 500 501 // Prepare Go vet config if needed. 502 var vcfg *vetConfig 503 if a.needVet { 504 // Pass list of absolute paths to vet, 505 // so that vet's error messages will use absolute paths, 506 // so that we can reformat them relative to the directory 507 // in which the go command is invoked. 508 vcfg = &vetConfig{ 509 Compiler: cfg.BuildToolchainName, 510 Dir: a.Package.Dir, 511 GoFiles: mkAbsFiles(a.Package.Dir, gofiles), 512 ImportPath: a.Package.ImportPath, 513 ImportMap: make(map[string]string), 514 PackageFile: make(map[string]string), 515 } 516 a.vetCfg = vcfg 517 for i, raw := range a.Package.Internal.RawImports { 518 final := a.Package.Imports[i] 519 vcfg.ImportMap[raw] = final 520 } 521 } 522 523 // Prepare Go import config. 524 // We start it off with a comment so it can't be empty, so icfg.Bytes() below is never nil. 525 // It should never be empty anyway, but there have been bugs in the past that resulted 526 // in empty configs, which then unfortunately turn into "no config passed to compiler", 527 // and the compiler falls back to looking in pkg itself, which mostly works, 528 // except when it doesn't. 529 var icfg bytes.Buffer 530 fmt.Fprintf(&icfg, "# import config\n") 531 532 for i, raw := range a.Package.Internal.RawImports { 533 final := a.Package.Imports[i] 534 if final != raw { 535 fmt.Fprintf(&icfg, "importmap %s=%s\n", raw, final) 536 } 537 } 538 539 // Compute the list of mapped imports in the vet config 540 // so that we can add any missing mappings below. 541 var vcfgMapped map[string]bool 542 if vcfg != nil { 543 vcfgMapped = make(map[string]bool) 544 for _, p := range vcfg.ImportMap { 545 vcfgMapped[p] = true 546 } 547 } 548 549 for _, a1 := range a.Deps { 550 p1 := a1.Package 551 if p1 == nil || p1.ImportPath == "" || a1.built == "" { 552 continue 553 } 554 fmt.Fprintf(&icfg, "packagefile %s=%s\n", p1.ImportPath, a1.built) 555 if vcfg != nil { 556 // Add import mapping if needed 557 // (for imports like "runtime/cgo" that appear only in generated code). 558 if !vcfgMapped[p1.ImportPath] { 559 vcfg.ImportMap[p1.ImportPath] = p1.ImportPath 560 } 561 vcfg.PackageFile[p1.ImportPath] = a1.built 562 } 563 } 564 565 if cached { 566 // The cached package file is OK, so we don't need to run the compile. 567 // We've only going through the motions to prepare the vet configuration, 568 // which is now complete. 569 return nil 570 } 571 572 // Compile Go. 573 objpkg := objdir + "_pkg_.a" 574 ofile, out, err := BuildToolchain.gc(b, a, objpkg, icfg.Bytes(), len(sfiles) > 0, gofiles) 575 if len(out) > 0 { 576 b.showOutput(a, a.Package.Dir, a.Package.ImportPath, b.processOutput(out)) 577 if err != nil { 578 return errPrintedOutput 579 } 580 } 581 if err != nil { 582 return err 583 } 584 if ofile != objpkg { 585 objects = append(objects, ofile) 586 } 587 588 // Copy .h files named for goos or goarch or goos_goarch 589 // to names using GOOS and GOARCH. 590 // For example, defs_linux_amd64.h becomes defs_GOOS_GOARCH.h. 591 _goos_goarch := "_" + cfg.Goos + "_" + cfg.Goarch 592 _goos := "_" + cfg.Goos 593 _goarch := "_" + cfg.Goarch 594 for _, file := range a.Package.HFiles { 595 name, ext := fileExtSplit(file) 596 switch { 597 case strings.HasSuffix(name, _goos_goarch): 598 targ := file[:len(name)-len(_goos_goarch)] + "_GOOS_GOARCH." + ext 599 if err := b.copyFile(a, objdir+targ, filepath.Join(a.Package.Dir, file), 0666, true); err != nil { 600 return err 601 } 602 case strings.HasSuffix(name, _goarch): 603 targ := file[:len(name)-len(_goarch)] + "_GOARCH." + ext 604 if err := b.copyFile(a, objdir+targ, filepath.Join(a.Package.Dir, file), 0666, true); err != nil { 605 return err 606 } 607 case strings.HasSuffix(name, _goos): 608 targ := file[:len(name)-len(_goos)] + "_GOOS." + ext 609 if err := b.copyFile(a, objdir+targ, filepath.Join(a.Package.Dir, file), 0666, true); err != nil { 610 return err 611 } 612 } 613 } 614 615 for _, file := range cfiles { 616 out := file[:len(file)-len(".c")] + ".o" 617 if err := BuildToolchain.cc(b, a, objdir+out, file); err != nil { 618 return err 619 } 620 objects = append(objects, out) 621 } 622 623 // Assemble .s files. 624 if len(sfiles) > 0 { 625 ofiles, err := BuildToolchain.asm(b, a, sfiles) 626 if err != nil { 627 return err 628 } 629 objects = append(objects, ofiles...) 630 } 631 632 // For gccgo on ELF systems, we write the build ID as an assembler file. 633 // This lets us set the the SHF_EXCLUDE flag. 634 // This is read by readGccgoArchive in cmd/internal/buildid/buildid.go. 635 if a.buildID != "" && cfg.BuildToolchainName == "gccgo" { 636 switch cfg.Goos { 637 case "android", "dragonfly", "freebsd", "linux", "netbsd", "openbsd", "solaris": 638 asmfile, err := b.gccgoBuildIDELFFile(a) 639 if err != nil { 640 return err 641 } 642 ofiles, err := BuildToolchain.asm(b, a, []string{asmfile}) 643 if err != nil { 644 return err 645 } 646 objects = append(objects, ofiles...) 647 } 648 } 649 650 // NOTE(rsc): On Windows, it is critically important that the 651 // gcc-compiled objects (cgoObjects) be listed after the ordinary 652 // objects in the archive. I do not know why this is. 653 // https://golang.org/issue/2601 654 objects = append(objects, cgoObjects...) 655 656 // Add system object files. 657 for _, syso := range a.Package.SysoFiles { 658 objects = append(objects, filepath.Join(a.Package.Dir, syso)) 659 } 660 661 // Pack into archive in objdir directory. 662 // If the Go compiler wrote an archive, we only need to add the 663 // object files for non-Go sources to the archive. 664 // If the Go compiler wrote an archive and the package is entirely 665 // Go sources, there is no pack to execute at all. 666 if len(objects) > 0 { 667 if err := BuildToolchain.pack(b, a, objpkg, objects); err != nil { 668 return err 669 } 670 } 671 672 if err := b.updateBuildID(a, objpkg, true); err != nil { 673 return err 674 } 675 676 a.built = objpkg 677 return nil 678 } 679 680 type vetConfig struct { 681 Compiler string 682 Dir string 683 GoFiles []string 684 ImportMap map[string]string 685 PackageFile map[string]string 686 ImportPath string 687 688 SucceedOnTypecheckFailure bool 689 } 690 691 // VetTool is the path to an alternate vet tool binary. 692 // The caller is expected to set it (if needed) before executing any vet actions. 693 var VetTool string 694 695 // VetFlags are the flags to pass to vet. 696 // The caller is expected to set them before executing any vet actions. 697 var VetFlags []string 698 699 func (b *Builder) vet(a *Action) error { 700 // a.Deps[0] is the build of the package being vetted. 701 // a.Deps[1] is the build of the "fmt" package. 702 703 vcfg := a.Deps[0].vetCfg 704 if vcfg == nil { 705 // Vet config should only be missing if the build failed. 706 if !a.Deps[0].Failed { 707 return fmt.Errorf("vet config not found") 708 } 709 return nil 710 } 711 712 if vcfg.ImportMap["fmt"] == "" { 713 a1 := a.Deps[1] 714 vcfg.ImportMap["fmt"] = "fmt" 715 vcfg.PackageFile["fmt"] = a1.built 716 } 717 718 // During go test, ignore type-checking failures during vet. 719 // We only run vet if the compilation has succeeded, 720 // so at least for now assume the bug is in vet. 721 // We know of at least #18395. 722 // TODO(rsc,gri): Try to remove this for Go 1.11. 723 vcfg.SucceedOnTypecheckFailure = cfg.CmdName == "test" 724 725 js, err := json.MarshalIndent(vcfg, "", "\t") 726 if err != nil { 727 return fmt.Errorf("internal error marshaling vet config: %v", err) 728 } 729 js = append(js, '\n') 730 if err := b.writeFile(a.Objdir+"vet.cfg", js); err != nil { 731 return err 732 } 733 734 var env []string 735 if cfg.BuildToolchainName == "gccgo" { 736 env = append(env, "GCCGO="+BuildToolchain.compiler()) 737 } 738 739 p := a.Package 740 tool := VetTool 741 if tool == "" { 742 tool = base.Tool("vet") 743 } 744 return b.run(a, p.Dir, p.ImportPath, env, cfg.BuildToolexec, tool, VetFlags, a.Objdir+"vet.cfg") 745 } 746 747 // linkActionID computes the action ID for a link action. 748 func (b *Builder) linkActionID(a *Action) cache.ActionID { 749 p := a.Package 750 h := cache.NewHash("link " + p.ImportPath) 751 752 // Toolchain-independent configuration. 753 fmt.Fprintf(h, "link\n") 754 fmt.Fprintf(h, "buildmode %s goos %s goarch %s\n", cfg.BuildBuildmode, cfg.Goos, cfg.Goarch) 755 fmt.Fprintf(h, "import %q\n", p.ImportPath) 756 fmt.Fprintf(h, "omitdebug %v standard %v local %v prefix %q\n", p.Internal.OmitDebug, p.Standard, p.Internal.Local, p.Internal.LocalPrefix) 757 758 // Toolchain-dependent configuration, shared with b.linkSharedActionID. 759 b.printLinkerConfig(h, p) 760 761 // Input files. 762 for _, a1 := range a.Deps { 763 p1 := a1.Package 764 if p1 != nil { 765 if a1.built != "" || a1.buildID != "" { 766 buildID := a1.buildID 767 if buildID == "" { 768 buildID = b.buildID(a1.built) 769 } 770 fmt.Fprintf(h, "packagefile %s=%s\n", p1.ImportPath, contentID(buildID)) 771 } 772 // Because we put package main's full action ID into the binary's build ID, 773 // we must also put the full action ID into the binary's action ID hash. 774 if p1.Name == "main" { 775 fmt.Fprintf(h, "packagemain %s\n", a1.buildID) 776 } 777 if p1.Shlib != "" { 778 fmt.Fprintf(h, "packageshlib %s=%s\n", p1.ImportPath, contentID(b.buildID(p1.Shlib))) 779 } 780 } 781 } 782 783 return h.Sum() 784 } 785 786 // printLinkerConfig prints the linker config into the hash h, 787 // as part of the computation of a linker-related action ID. 788 func (b *Builder) printLinkerConfig(h io.Writer, p *load.Package) { 789 switch cfg.BuildToolchainName { 790 default: 791 base.Fatalf("linkActionID: unknown toolchain %q", cfg.BuildToolchainName) 792 793 case "gc": 794 fmt.Fprintf(h, "link %s %q %s\n", b.toolID("link"), forcedLdflags, ldBuildmode) 795 if p != nil { 796 fmt.Fprintf(h, "linkflags %q\n", p.Internal.Ldflags) 797 } 798 fmt.Fprintf(h, "GO$GOARCH=%s\n", os.Getenv("GO"+strings.ToUpper(cfg.BuildContext.GOARCH))) // GO386, GOARM, etc 799 800 // The linker writes source file paths that say GOROOT_FINAL. 801 fmt.Fprintf(h, "GOROOT=%s\n", cfg.GOROOT_FINAL) 802 803 // TODO(rsc): Convince linker team not to add more magic environment variables, 804 // or perhaps restrict the environment variables passed to subprocesses. 805 magic := []string{ 806 "GO_EXTLINK_ENABLED", 807 } 808 for _, env := range magic { 809 if x := os.Getenv(env); x != "" { 810 fmt.Fprintf(h, "magic %s=%s\n", env, x) 811 } 812 } 813 814 // TODO(rsc): Do cgo settings and flags need to be included? 815 // Or external linker settings and flags? 816 817 case "gccgo": 818 id, err := b.gccgoToolID(BuildToolchain.linker(), "go") 819 if err != nil { 820 base.Fatalf("%v", err) 821 } 822 fmt.Fprintf(h, "link %s %s\n", id, ldBuildmode) 823 // TODO(iant): Should probably include cgo flags here. 824 } 825 } 826 827 // link is the action for linking a single command. 828 // Note that any new influence on this logic must be reported in b.linkActionID above as well. 829 func (b *Builder) link(a *Action) (err error) { 830 if b.useCache(a, a.Package, b.linkActionID(a), a.Package.Target) { 831 return nil 832 } 833 defer b.flushOutput(a) 834 835 if err := b.Mkdir(a.Objdir); err != nil { 836 return err 837 } 838 839 importcfg := a.Objdir + "importcfg.link" 840 if err := b.writeLinkImportcfg(a, importcfg); err != nil { 841 return err 842 } 843 844 // make target directory 845 dir, _ := filepath.Split(a.Target) 846 if dir != "" { 847 if err := b.Mkdir(dir); err != nil { 848 return err 849 } 850 } 851 852 if err := BuildToolchain.ld(b, a, a.Target, importcfg, a.Deps[0].built); err != nil { 853 return err 854 } 855 856 // Update the binary with the final build ID. 857 // But if OmitDebug is set, don't rewrite the binary, because we set OmitDebug 858 // on binaries that we are going to run and then delete. 859 // There's no point in doing work on such a binary. 860 // Worse, opening the binary for write here makes it 861 // essentially impossible to safely fork+exec due to a fundamental 862 // incompatibility between ETXTBSY and threads on modern Unix systems. 863 // See golang.org/issue/22220. 864 // We still call updateBuildID to update a.buildID, which is important 865 // for test result caching, but passing rewrite=false (final arg) 866 // means we don't actually rewrite the binary, nor store the 867 // result into the cache. 868 // Not calling updateBuildID means we also don't insert these 869 // binaries into the build object cache. That's probably a net win: 870 // less cache space wasted on large binaries we are not likely to 871 // need again. (On the other hand it does make repeated go test slower.) 872 if err := b.updateBuildID(a, a.Target, !a.Package.Internal.OmitDebug); err != nil { 873 return err 874 } 875 876 a.built = a.Target 877 return nil 878 } 879 880 func (b *Builder) writeLinkImportcfg(a *Action, file string) error { 881 // Prepare Go import cfg. 882 var icfg bytes.Buffer 883 for _, a1 := range a.Deps { 884 p1 := a1.Package 885 if p1 == nil { 886 continue 887 } 888 fmt.Fprintf(&icfg, "packagefile %s=%s\n", p1.ImportPath, a1.built) 889 if p1.Shlib != "" { 890 fmt.Fprintf(&icfg, "packageshlib %s=%s\n", p1.ImportPath, p1.Shlib) 891 } 892 } 893 return b.writeFile(file, icfg.Bytes()) 894 } 895 896 // PkgconfigCmd returns a pkg-config binary name 897 // defaultPkgConfig is defined in zdefaultcc.go, written by cmd/dist. 898 func (b *Builder) PkgconfigCmd() string { 899 return envList("PKG_CONFIG", cfg.DefaultPkgConfig)[0] 900 } 901 902 // splitPkgConfigOutput parses the pkg-config output into a slice of 903 // flags. pkg-config always uses \ to escape special characters. 904 func splitPkgConfigOutput(out []byte) []string { 905 if len(out) == 0 { 906 return nil 907 } 908 var flags []string 909 flag := make([]byte, len(out)) 910 r, w := 0, 0 911 for r < len(out) { 912 switch out[r] { 913 case ' ', '\t', '\r', '\n': 914 if w > 0 { 915 flags = append(flags, string(flag[:w])) 916 } 917 w = 0 918 case '\\': 919 r++ 920 fallthrough 921 default: 922 if r < len(out) { 923 flag[w] = out[r] 924 w++ 925 } 926 } 927 r++ 928 } 929 if w > 0 { 930 flags = append(flags, string(flag[:w])) 931 } 932 return flags 933 } 934 935 // Calls pkg-config if needed and returns the cflags/ldflags needed to build the package. 936 func (b *Builder) getPkgConfigFlags(p *load.Package) (cflags, ldflags []string, err error) { 937 if pkgs := p.CgoPkgConfig; len(pkgs) > 0 { 938 for _, pkg := range pkgs { 939 if !load.SafeArg(pkg) { 940 return nil, nil, fmt.Errorf("invalid pkg-config package name: %s", pkg) 941 } 942 } 943 var out []byte 944 out, err = b.runOut(p.Dir, p.ImportPath, nil, b.PkgconfigCmd(), "--cflags", "--", pkgs) 945 if err != nil { 946 b.showOutput(nil, p.Dir, b.PkgconfigCmd()+" --cflags "+strings.Join(pkgs, " "), string(out)) 947 b.Print(err.Error() + "\n") 948 return nil, nil, errPrintedOutput 949 } 950 if len(out) > 0 { 951 cflags = splitPkgConfigOutput(out) 952 if err := checkCompilerFlags("CFLAGS", "pkg-config --cflags", cflags); err != nil { 953 return nil, nil, err 954 } 955 } 956 out, err = b.runOut(p.Dir, p.ImportPath, nil, b.PkgconfigCmd(), "--libs", "--", pkgs) 957 if err != nil { 958 b.showOutput(nil, p.Dir, b.PkgconfigCmd()+" --libs "+strings.Join(pkgs, " "), string(out)) 959 b.Print(err.Error() + "\n") 960 return nil, nil, errPrintedOutput 961 } 962 if len(out) > 0 { 963 ldflags = strings.Fields(string(out)) 964 if err := checkLinkerFlags("CFLAGS", "pkg-config --cflags", ldflags); err != nil { 965 return nil, nil, err 966 } 967 } 968 } 969 970 return 971 } 972 973 func (b *Builder) installShlibname(a *Action) error { 974 // TODO: BuildN 975 a1 := a.Deps[0] 976 err := ioutil.WriteFile(a.Target, []byte(filepath.Base(a1.Target)+"\n"), 0666) 977 if err != nil { 978 return err 979 } 980 if cfg.BuildX { 981 b.Showcmd("", "echo '%s' > %s # internal", filepath.Base(a1.Target), a.Target) 982 } 983 return nil 984 } 985 986 func (b *Builder) linkSharedActionID(a *Action) cache.ActionID { 987 h := cache.NewHash("linkShared") 988 989 // Toolchain-independent configuration. 990 fmt.Fprintf(h, "linkShared\n") 991 fmt.Fprintf(h, "goos %s goarch %s\n", cfg.Goos, cfg.Goarch) 992 993 // Toolchain-dependent configuration, shared with b.linkActionID. 994 b.printLinkerConfig(h, nil) 995 996 // Input files. 997 for _, a1 := range a.Deps { 998 p1 := a1.Package 999 if a1.built == "" { 1000 continue 1001 } 1002 if p1 != nil { 1003 fmt.Fprintf(h, "packagefile %s=%s\n", p1.ImportPath, contentID(b.buildID(a1.built))) 1004 if p1.Shlib != "" { 1005 fmt.Fprintf(h, "packageshlib %s=%s\n", p1.ImportPath, contentID(b.buildID(p1.Shlib))) 1006 } 1007 } 1008 } 1009 // Files named on command line are special. 1010 for _, a1 := range a.Deps[0].Deps { 1011 p1 := a1.Package 1012 fmt.Fprintf(h, "top %s=%s\n", p1.ImportPath, contentID(b.buildID(a1.built))) 1013 } 1014 1015 return h.Sum() 1016 } 1017 1018 func (b *Builder) linkShared(a *Action) (err error) { 1019 if b.useCache(a, nil, b.linkSharedActionID(a), a.Target) { 1020 return nil 1021 } 1022 defer b.flushOutput(a) 1023 1024 if err := b.Mkdir(a.Objdir); err != nil { 1025 return err 1026 } 1027 1028 importcfg := a.Objdir + "importcfg.link" 1029 if err := b.writeLinkImportcfg(a, importcfg); err != nil { 1030 return err 1031 } 1032 1033 // TODO(rsc): There is a missing updateBuildID here, 1034 // but we have to decide where to store the build ID in these files. 1035 a.built = a.Target 1036 return BuildToolchain.ldShared(b, a, a.Deps[0].Deps, a.Target, importcfg, a.Deps) 1037 } 1038 1039 // BuildInstallFunc is the action for installing a single package or executable. 1040 func BuildInstallFunc(b *Builder, a *Action) (err error) { 1041 defer func() { 1042 if err != nil && err != errPrintedOutput { 1043 // a.Package == nil is possible for the go install -buildmode=shared 1044 // action that installs libmangledname.so, which corresponds to 1045 // a list of packages, not just one. 1046 sep, path := "", "" 1047 if a.Package != nil { 1048 sep, path = " ", a.Package.ImportPath 1049 } 1050 err = fmt.Errorf("go %s%s%s: %v", cfg.CmdName, sep, path, err) 1051 } 1052 }() 1053 1054 a1 := a.Deps[0] 1055 a.buildID = a1.buildID 1056 1057 // If we are using the eventual install target as an up-to-date 1058 // cached copy of the thing we built, then there's no need to 1059 // copy it into itself (and that would probably fail anyway). 1060 // In this case a1.built == a.Target because a1.built == p.Target, 1061 // so the built target is not in the a1.Objdir tree that b.cleanup(a1) removes. 1062 if a1.built == a.Target { 1063 a.built = a.Target 1064 b.cleanup(a1) 1065 // Whether we're smart enough to avoid a complete rebuild 1066 // depends on exactly what the staleness and rebuild algorithms 1067 // are, as well as potentially the state of the Go build cache. 1068 // We don't really want users to be able to infer (or worse start depending on) 1069 // those details from whether the modification time changes during 1070 // "go install", so do a best-effort update of the file times to make it 1071 // look like we rewrote a.Target even if we did not. Updating the mtime 1072 // may also help other mtime-based systems that depend on our 1073 // previous mtime updates that happened more often. 1074 // This is still not perfect - we ignore the error result, and if the file was 1075 // unwritable for some reason then pretending to have written it is also 1076 // confusing - but it's probably better than not doing the mtime update. 1077 // 1078 // But don't do that for the special case where building an executable 1079 // with -linkshared implicitly installs all its dependent libraries. 1080 // We want to hide that awful detail as much as possible, so don't 1081 // advertise it by touching the mtimes (usually the libraries are up 1082 // to date). 1083 if !a.buggyInstall { 1084 now := time.Now() 1085 os.Chtimes(a.Target, now, now) 1086 } 1087 return nil 1088 } 1089 if b.ComputeStaleOnly { 1090 return nil 1091 } 1092 1093 if err := b.Mkdir(a.Objdir); err != nil { 1094 return err 1095 } 1096 1097 perm := os.FileMode(0666) 1098 if a1.Mode == "link" { 1099 switch cfg.BuildBuildmode { 1100 case "c-archive", "c-shared", "plugin": 1101 default: 1102 perm = 0777 1103 } 1104 } 1105 1106 // make target directory 1107 dir, _ := filepath.Split(a.Target) 1108 if dir != "" { 1109 if err := b.Mkdir(dir); err != nil { 1110 return err 1111 } 1112 } 1113 1114 defer b.cleanup(a1) 1115 1116 return b.moveOrCopyFile(a, a.Target, a1.built, perm, false) 1117 } 1118 1119 // cleanup removes a's object dir to keep the amount of 1120 // on-disk garbage down in a large build. On an operating system 1121 // with aggressive buffering, cleaning incrementally like 1122 // this keeps the intermediate objects from hitting the disk. 1123 func (b *Builder) cleanup(a *Action) { 1124 if !cfg.BuildWork { 1125 if cfg.BuildX { 1126 b.Showcmd("", "rm -r %s", a.Objdir) 1127 } 1128 os.RemoveAll(a.Objdir) 1129 } 1130 } 1131 1132 // moveOrCopyFile is like 'mv src dst' or 'cp src dst'. 1133 func (b *Builder) moveOrCopyFile(a *Action, dst, src string, perm os.FileMode, force bool) error { 1134 if cfg.BuildN { 1135 b.Showcmd("", "mv %s %s", src, dst) 1136 return nil 1137 } 1138 1139 // If we can update the mode and rename to the dst, do it. 1140 // Otherwise fall back to standard copy. 1141 1142 // If the source is in the build cache, we need to copy it. 1143 if strings.HasPrefix(src, cache.DefaultDir()) { 1144 return b.copyFile(a, dst, src, perm, force) 1145 } 1146 1147 // On Windows, always copy the file, so that we respect the NTFS 1148 // permissions of the parent folder. https://golang.org/issue/22343. 1149 // What matters here is not cfg.Goos (the system we are building 1150 // for) but runtime.GOOS (the system we are building on). 1151 if runtime.GOOS == "windows" { 1152 return b.copyFile(a, dst, src, perm, force) 1153 } 1154 1155 // If the destination directory has the group sticky bit set, 1156 // we have to copy the file to retain the correct permissions. 1157 // https://golang.org/issue/18878 1158 if fi, err := os.Stat(filepath.Dir(dst)); err == nil { 1159 if fi.IsDir() && (fi.Mode()&os.ModeSetgid) != 0 { 1160 return b.copyFile(a, dst, src, perm, force) 1161 } 1162 } 1163 1164 // The perm argument is meant to be adjusted according to umask, 1165 // but we don't know what the umask is. 1166 // Create a dummy file to find out. 1167 // This avoids build tags and works even on systems like Plan 9 1168 // where the file mask computation incorporates other information. 1169 mode := perm 1170 f, err := os.OpenFile(filepath.Clean(dst)+"-go-tmp-umask", os.O_WRONLY|os.O_CREATE|os.O_EXCL, perm) 1171 if err == nil { 1172 fi, err := f.Stat() 1173 if err == nil { 1174 mode = fi.Mode() & 0777 1175 } 1176 name := f.Name() 1177 f.Close() 1178 os.Remove(name) 1179 } 1180 1181 if err := os.Chmod(src, mode); err == nil { 1182 if err := os.Rename(src, dst); err == nil { 1183 if cfg.BuildX { 1184 b.Showcmd("", "mv %s %s", src, dst) 1185 } 1186 return nil 1187 } 1188 } 1189 1190 return b.copyFile(a, dst, src, perm, force) 1191 } 1192 1193 // copyFile is like 'cp src dst'. 1194 func (b *Builder) copyFile(a *Action, dst, src string, perm os.FileMode, force bool) error { 1195 if cfg.BuildN || cfg.BuildX { 1196 b.Showcmd("", "cp %s %s", src, dst) 1197 if cfg.BuildN { 1198 return nil 1199 } 1200 } 1201 1202 sf, err := os.Open(src) 1203 if err != nil { 1204 return err 1205 } 1206 defer sf.Close() 1207 1208 // Be careful about removing/overwriting dst. 1209 // Do not remove/overwrite if dst exists and is a directory 1210 // or a non-object file. 1211 if fi, err := os.Stat(dst); err == nil { 1212 if fi.IsDir() { 1213 return fmt.Errorf("build output %q already exists and is a directory", dst) 1214 } 1215 if !force && fi.Mode().IsRegular() && !isObject(dst) { 1216 return fmt.Errorf("build output %q already exists and is not an object file", dst) 1217 } 1218 } 1219 1220 // On Windows, remove lingering ~ file from last attempt. 1221 if base.ToolIsWindows { 1222 if _, err := os.Stat(dst + "~"); err == nil { 1223 os.Remove(dst + "~") 1224 } 1225 } 1226 1227 mayberemovefile(dst) 1228 df, err := os.OpenFile(dst, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, perm) 1229 if err != nil && base.ToolIsWindows { 1230 // Windows does not allow deletion of a binary file 1231 // while it is executing. Try to move it out of the way. 1232 // If the move fails, which is likely, we'll try again the 1233 // next time we do an install of this binary. 1234 if err := os.Rename(dst, dst+"~"); err == nil { 1235 os.Remove(dst + "~") 1236 } 1237 df, err = os.OpenFile(dst, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, perm) 1238 } 1239 if err != nil { 1240 return err 1241 } 1242 1243 _, err = io.Copy(df, sf) 1244 df.Close() 1245 if err != nil { 1246 mayberemovefile(dst) 1247 return fmt.Errorf("copying %s to %s: %v", src, dst, err) 1248 } 1249 return nil 1250 } 1251 1252 // writeFile writes the text to file. 1253 func (b *Builder) writeFile(file string, text []byte) error { 1254 if cfg.BuildN || cfg.BuildX { 1255 b.Showcmd("", "cat >%s << 'EOF' # internal\n%sEOF", file, text) 1256 } 1257 if cfg.BuildN { 1258 return nil 1259 } 1260 return ioutil.WriteFile(file, text, 0666) 1261 } 1262 1263 // Install the cgo export header file, if there is one. 1264 func (b *Builder) installHeader(a *Action) error { 1265 src := a.Objdir + "_cgo_install.h" 1266 if _, err := os.Stat(src); os.IsNotExist(err) { 1267 // If the file does not exist, there are no exported 1268 // functions, and we do not install anything. 1269 // TODO(rsc): Once we know that caching is rebuilding 1270 // at the right times (not missing rebuilds), here we should 1271 // probably delete the installed header, if any. 1272 if cfg.BuildX { 1273 b.Showcmd("", "# %s not created", src) 1274 } 1275 return nil 1276 } 1277 1278 dir, _ := filepath.Split(a.Target) 1279 if dir != "" { 1280 if err := b.Mkdir(dir); err != nil { 1281 return err 1282 } 1283 } 1284 1285 return b.moveOrCopyFile(a, a.Target, src, 0666, true) 1286 } 1287 1288 // cover runs, in effect, 1289 // go tool cover -mode=b.coverMode -var="varName" -o dst.go src.go 1290 func (b *Builder) cover(a *Action, dst, src string, perm os.FileMode, varName string) error { 1291 return b.run(a, a.Objdir, "cover "+a.Package.ImportPath, nil, 1292 cfg.BuildToolexec, 1293 base.Tool("cover"), 1294 "-mode", a.Package.Internal.CoverMode, 1295 "-var", varName, 1296 "-o", dst, 1297 src) 1298 } 1299 1300 var objectMagic = [][]byte{ 1301 {'!', '<', 'a', 'r', 'c', 'h', '>', '\n'}, // Package archive 1302 {'\x7F', 'E', 'L', 'F'}, // ELF 1303 {0xFE, 0xED, 0xFA, 0xCE}, // Mach-O big-endian 32-bit 1304 {0xFE, 0xED, 0xFA, 0xCF}, // Mach-O big-endian 64-bit 1305 {0xCE, 0xFA, 0xED, 0xFE}, // Mach-O little-endian 32-bit 1306 {0xCF, 0xFA, 0xED, 0xFE}, // Mach-O little-endian 64-bit 1307 {0x4d, 0x5a, 0x90, 0x00, 0x03, 0x00}, // PE (Windows) as generated by 6l/8l and gcc 1308 {0x00, 0x00, 0x01, 0xEB}, // Plan 9 i386 1309 {0x00, 0x00, 0x8a, 0x97}, // Plan 9 amd64 1310 {0x00, 0x00, 0x06, 0x47}, // Plan 9 arm 1311 } 1312 1313 func isObject(s string) bool { 1314 f, err := os.Open(s) 1315 if err != nil { 1316 return false 1317 } 1318 defer f.Close() 1319 buf := make([]byte, 64) 1320 io.ReadFull(f, buf) 1321 for _, magic := range objectMagic { 1322 if bytes.HasPrefix(buf, magic) { 1323 return true 1324 } 1325 } 1326 return false 1327 } 1328 1329 // mayberemovefile removes a file only if it is a regular file 1330 // When running as a user with sufficient privileges, we may delete 1331 // even device files, for example, which is not intended. 1332 func mayberemovefile(s string) { 1333 if fi, err := os.Lstat(s); err == nil && !fi.Mode().IsRegular() { 1334 return 1335 } 1336 os.Remove(s) 1337 } 1338 1339 // fmtcmd formats a command in the manner of fmt.Sprintf but also: 1340 // 1341 // If dir is non-empty and the script is not in dir right now, 1342 // fmtcmd inserts "cd dir\n" before the command. 1343 // 1344 // fmtcmd replaces the value of b.WorkDir with $WORK. 1345 // fmtcmd replaces the value of goroot with $GOROOT. 1346 // fmtcmd replaces the value of b.gobin with $GOBIN. 1347 // 1348 // fmtcmd replaces the name of the current directory with dot (.) 1349 // but only when it is at the beginning of a space-separated token. 1350 // 1351 func (b *Builder) fmtcmd(dir string, format string, args ...interface{}) string { 1352 cmd := fmt.Sprintf(format, args...) 1353 if dir != "" && dir != "/" { 1354 cmd = strings.Replace(" "+cmd, " "+dir, " .", -1)[1:] 1355 if b.scriptDir != dir { 1356 b.scriptDir = dir 1357 cmd = "cd " + dir + "\n" + cmd 1358 } 1359 } 1360 if b.WorkDir != "" { 1361 cmd = strings.Replace(cmd, b.WorkDir, "$WORK", -1) 1362 } 1363 return cmd 1364 } 1365 1366 // showcmd prints the given command to standard output 1367 // for the implementation of -n or -x. 1368 func (b *Builder) Showcmd(dir string, format string, args ...interface{}) { 1369 b.output.Lock() 1370 defer b.output.Unlock() 1371 b.Print(b.fmtcmd(dir, format, args...) + "\n") 1372 } 1373 1374 // showOutput prints "# desc" followed by the given output. 1375 // The output is expected to contain references to 'dir', usually 1376 // the source directory for the package that has failed to build. 1377 // showOutput rewrites mentions of dir with a relative path to dir 1378 // when the relative path is shorter. This is usually more pleasant. 1379 // For example, if fmt doesn't compile and we are in src/html, 1380 // the output is 1381 // 1382 // $ go build 1383 // # fmt 1384 // ../fmt/print.go:1090: undefined: asdf 1385 // $ 1386 // 1387 // instead of 1388 // 1389 // $ go build 1390 // # fmt 1391 // /usr/gopher/go/src/fmt/print.go:1090: undefined: asdf 1392 // $ 1393 // 1394 // showOutput also replaces references to the work directory with $WORK. 1395 // 1396 // If a is not nil and a.output is not nil, showOutput appends to that slice instead of 1397 // printing to b.Print. 1398 // 1399 func (b *Builder) showOutput(a *Action, dir, desc, out string) { 1400 prefix := "# " + desc 1401 suffix := "\n" + out 1402 if reldir := base.ShortPath(dir); reldir != dir { 1403 suffix = strings.Replace(suffix, " "+dir, " "+reldir, -1) 1404 suffix = strings.Replace(suffix, "\n"+dir, "\n"+reldir, -1) 1405 } 1406 suffix = strings.Replace(suffix, " "+b.WorkDir, " $WORK", -1) 1407 1408 if a != nil && a.output != nil { 1409 a.output = append(a.output, prefix...) 1410 a.output = append(a.output, suffix...) 1411 return 1412 } 1413 1414 b.output.Lock() 1415 defer b.output.Unlock() 1416 b.Print(prefix, suffix) 1417 } 1418 1419 // errPrintedOutput is a special error indicating that a command failed 1420 // but that it generated output as well, and that output has already 1421 // been printed, so there's no point showing 'exit status 1' or whatever 1422 // the wait status was. The main executor, builder.do, knows not to 1423 // print this error. 1424 var errPrintedOutput = errors.New("already printed output - no need to show error") 1425 1426 var cgoLine = regexp.MustCompile(`\[[^\[\]]+\.(cgo1|cover)\.go:[0-9]+(:[0-9]+)?\]`) 1427 var cgoTypeSigRe = regexp.MustCompile(`\b_C2?(type|func|var|macro)_\B`) 1428 1429 // run runs the command given by cmdline in the directory dir. 1430 // If the command fails, run prints information about the failure 1431 // and returns a non-nil error. 1432 func (b *Builder) run(a *Action, dir string, desc string, env []string, cmdargs ...interface{}) error { 1433 out, err := b.runOut(dir, desc, env, cmdargs...) 1434 if len(out) > 0 { 1435 if desc == "" { 1436 desc = b.fmtcmd(dir, "%s", strings.Join(str.StringList(cmdargs...), " ")) 1437 } 1438 b.showOutput(a, dir, desc, b.processOutput(out)) 1439 if err != nil { 1440 err = errPrintedOutput 1441 } 1442 } 1443 return err 1444 } 1445 1446 // processOutput prepares the output of runOut to be output to the console. 1447 func (b *Builder) processOutput(out []byte) string { 1448 if out[len(out)-1] != '\n' { 1449 out = append(out, '\n') 1450 } 1451 messages := string(out) 1452 // Fix up output referring to cgo-generated code to be more readable. 1453 // Replace x.go:19[/tmp/.../x.cgo1.go:18] with x.go:19. 1454 // Replace *[100]_Ctype_foo with *[100]C.foo. 1455 // If we're using -x, assume we're debugging and want the full dump, so disable the rewrite. 1456 if !cfg.BuildX && cgoLine.MatchString(messages) { 1457 messages = cgoLine.ReplaceAllString(messages, "") 1458 messages = cgoTypeSigRe.ReplaceAllString(messages, "C.") 1459 } 1460 return messages 1461 } 1462 1463 // runOut runs the command given by cmdline in the directory dir. 1464 // It returns the command output and any errors that occurred. 1465 func (b *Builder) runOut(dir string, desc string, env []string, cmdargs ...interface{}) ([]byte, error) { 1466 cmdline := str.StringList(cmdargs...) 1467 1468 for _, arg := range cmdline { 1469 // GNU binutils commands, including gcc and gccgo, interpret an argument 1470 // @foo anywhere in the command line (even following --) as meaning 1471 // "read and insert arguments from the file named foo." 1472 // Don't say anything that might be misinterpreted that way. 1473 if strings.HasPrefix(arg, "@") { 1474 return nil, fmt.Errorf("invalid command-line argument %s in command: %s", arg, joinUnambiguously(cmdline)) 1475 } 1476 } 1477 1478 if cfg.BuildN || cfg.BuildX { 1479 var envcmdline string 1480 for _, e := range env { 1481 if j := strings.IndexByte(e, '='); j != -1 { 1482 if strings.ContainsRune(e[j+1:], '\'') { 1483 envcmdline += fmt.Sprintf("%s=%q", e[:j], e[j+1:]) 1484 } else { 1485 envcmdline += fmt.Sprintf("%s='%s'", e[:j], e[j+1:]) 1486 } 1487 envcmdline += " " 1488 } 1489 } 1490 envcmdline += joinUnambiguously(cmdline) 1491 b.Showcmd(dir, "%s", envcmdline) 1492 if cfg.BuildN { 1493 return nil, nil 1494 } 1495 } 1496 1497 var buf bytes.Buffer 1498 cmd := exec.Command(cmdline[0], cmdline[1:]...) 1499 cmd.Stdout = &buf 1500 cmd.Stderr = &buf 1501 cmd.Dir = dir 1502 cmd.Env = base.MergeEnvLists(env, base.EnvForDir(cmd.Dir, os.Environ())) 1503 err := cmd.Run() 1504 1505 // err can be something like 'exit status 1'. 1506 // Add information about what program was running. 1507 // Note that if buf.Bytes() is non-empty, the caller usually 1508 // shows buf.Bytes() and does not print err at all, so the 1509 // prefix here does not make most output any more verbose. 1510 if err != nil { 1511 err = errors.New(cmdline[0] + ": " + err.Error()) 1512 } 1513 return buf.Bytes(), err 1514 } 1515 1516 // joinUnambiguously prints the slice, quoting where necessary to make the 1517 // output unambiguous. 1518 // TODO: See issue 5279. The printing of commands needs a complete redo. 1519 func joinUnambiguously(a []string) string { 1520 var buf bytes.Buffer 1521 for i, s := range a { 1522 if i > 0 { 1523 buf.WriteByte(' ') 1524 } 1525 q := strconv.Quote(s) 1526 if s == "" || strings.Contains(s, " ") || len(q) > len(s)+2 { 1527 buf.WriteString(q) 1528 } else { 1529 buf.WriteString(s) 1530 } 1531 } 1532 return buf.String() 1533 } 1534 1535 // mkdir makes the named directory. 1536 func (b *Builder) Mkdir(dir string) error { 1537 // Make Mkdir(a.Objdir) a no-op instead of an error when a.Objdir == "". 1538 if dir == "" { 1539 return nil 1540 } 1541 1542 b.exec.Lock() 1543 defer b.exec.Unlock() 1544 // We can be a little aggressive about being 1545 // sure directories exist. Skip repeated calls. 1546 if b.mkdirCache[dir] { 1547 return nil 1548 } 1549 b.mkdirCache[dir] = true 1550 1551 if cfg.BuildN || cfg.BuildX { 1552 b.Showcmd("", "mkdir -p %s", dir) 1553 if cfg.BuildN { 1554 return nil 1555 } 1556 } 1557 1558 if err := os.MkdirAll(dir, 0777); err != nil { 1559 return err 1560 } 1561 return nil 1562 } 1563 1564 // symlink creates a symlink newname -> oldname. 1565 func (b *Builder) Symlink(oldname, newname string) error { 1566 if cfg.BuildN || cfg.BuildX { 1567 b.Showcmd("", "ln -s %s %s", oldname, newname) 1568 if cfg.BuildN { 1569 return nil 1570 } 1571 } 1572 return os.Symlink(oldname, newname) 1573 } 1574 1575 // mkAbs returns an absolute path corresponding to 1576 // evaluating f in the directory dir. 1577 // We always pass absolute paths of source files so that 1578 // the error messages will include the full path to a file 1579 // in need of attention. 1580 func mkAbs(dir, f string) string { 1581 // Leave absolute paths alone. 1582 // Also, during -n mode we use the pseudo-directory $WORK 1583 // instead of creating an actual work directory that won't be used. 1584 // Leave paths beginning with $WORK alone too. 1585 if filepath.IsAbs(f) || strings.HasPrefix(f, "$WORK") { 1586 return f 1587 } 1588 return filepath.Join(dir, f) 1589 } 1590 1591 type toolchain interface { 1592 // gc runs the compiler in a specific directory on a set of files 1593 // and returns the name of the generated output file. 1594 gc(b *Builder, a *Action, archive string, importcfg []byte, asmhdr bool, gofiles []string) (ofile string, out []byte, err error) 1595 // cc runs the toolchain's C compiler in a directory on a C file 1596 // to produce an output file. 1597 cc(b *Builder, a *Action, ofile, cfile string) error 1598 // asm runs the assembler in a specific directory on specific files 1599 // and returns a list of named output files. 1600 asm(b *Builder, a *Action, sfiles []string) ([]string, error) 1601 // pack runs the archive packer in a specific directory to create 1602 // an archive from a set of object files. 1603 // typically it is run in the object directory. 1604 pack(b *Builder, a *Action, afile string, ofiles []string) error 1605 // ld runs the linker to create an executable starting at mainpkg. 1606 ld(b *Builder, root *Action, out, importcfg, mainpkg string) error 1607 // ldShared runs the linker to create a shared library containing the pkgs built by toplevelactions 1608 ldShared(b *Builder, root *Action, toplevelactions []*Action, out, importcfg string, allactions []*Action) error 1609 1610 compiler() string 1611 linker() string 1612 } 1613 1614 type noToolchain struct{} 1615 1616 func noCompiler() error { 1617 log.Fatalf("unknown compiler %q", cfg.BuildContext.Compiler) 1618 return nil 1619 } 1620 1621 func (noToolchain) compiler() string { 1622 noCompiler() 1623 return "" 1624 } 1625 1626 func (noToolchain) linker() string { 1627 noCompiler() 1628 return "" 1629 } 1630 1631 func (noToolchain) gc(b *Builder, a *Action, archive string, importcfg []byte, asmhdr bool, gofiles []string) (ofile string, out []byte, err error) { 1632 return "", nil, noCompiler() 1633 } 1634 1635 func (noToolchain) asm(b *Builder, a *Action, sfiles []string) ([]string, error) { 1636 return nil, noCompiler() 1637 } 1638 1639 func (noToolchain) pack(b *Builder, a *Action, afile string, ofiles []string) error { 1640 return noCompiler() 1641 } 1642 1643 func (noToolchain) ld(b *Builder, root *Action, out, importcfg, mainpkg string) error { 1644 return noCompiler() 1645 } 1646 1647 func (noToolchain) ldShared(b *Builder, root *Action, toplevelactions []*Action, out, importcfg string, allactions []*Action) error { 1648 return noCompiler() 1649 } 1650 1651 func (noToolchain) cc(b *Builder, a *Action, ofile, cfile string) error { 1652 return noCompiler() 1653 } 1654 1655 // gcc runs the gcc C compiler to create an object from a single C file. 1656 func (b *Builder) gcc(a *Action, p *load.Package, workdir, out string, flags []string, cfile string) error { 1657 return b.ccompile(a, p, out, flags, cfile, b.GccCmd(p.Dir, workdir)) 1658 } 1659 1660 // gxx runs the g++ C++ compiler to create an object from a single C++ file. 1661 func (b *Builder) gxx(a *Action, p *load.Package, workdir, out string, flags []string, cxxfile string) error { 1662 return b.ccompile(a, p, out, flags, cxxfile, b.GxxCmd(p.Dir, workdir)) 1663 } 1664 1665 // gfortran runs the gfortran Fortran compiler to create an object from a single Fortran file. 1666 func (b *Builder) gfortran(a *Action, p *load.Package, workdir, out string, flags []string, ffile string) error { 1667 return b.ccompile(a, p, out, flags, ffile, b.gfortranCmd(p.Dir, workdir)) 1668 } 1669 1670 // ccompile runs the given C or C++ compiler and creates an object from a single source file. 1671 func (b *Builder) ccompile(a *Action, p *load.Package, outfile string, flags []string, file string, compiler []string) error { 1672 file = mkAbs(p.Dir, file) 1673 desc := p.ImportPath 1674 if !filepath.IsAbs(outfile) { 1675 outfile = filepath.Join(p.Dir, outfile) 1676 } 1677 output, err := b.runOut(filepath.Dir(file), desc, nil, compiler, flags, "-o", outfile, "-c", filepath.Base(file)) 1678 if len(output) > 0 { 1679 // On FreeBSD 11, when we pass -g to clang 3.8 it 1680 // invokes its internal assembler with -dwarf-version=2. 1681 // When it sees .section .note.GNU-stack, it warns 1682 // "DWARF2 only supports one section per compilation unit". 1683 // This warning makes no sense, since the section is empty, 1684 // but it confuses people. 1685 // We work around the problem by detecting the warning 1686 // and dropping -g and trying again. 1687 if bytes.Contains(output, []byte("DWARF2 only supports one section per compilation unit")) { 1688 newFlags := make([]string, 0, len(flags)) 1689 for _, f := range flags { 1690 if !strings.HasPrefix(f, "-g") { 1691 newFlags = append(newFlags, f) 1692 } 1693 } 1694 if len(newFlags) < len(flags) { 1695 return b.ccompile(a, p, outfile, newFlags, file, compiler) 1696 } 1697 } 1698 1699 b.showOutput(a, p.Dir, desc, b.processOutput(output)) 1700 if err != nil { 1701 err = errPrintedOutput 1702 } else if os.Getenv("GO_BUILDER_NAME") != "" { 1703 return errors.New("C compiler warning promoted to error on Go builders") 1704 } 1705 } 1706 return err 1707 } 1708 1709 // gccld runs the gcc linker to create an executable from a set of object files. 1710 func (b *Builder) gccld(p *load.Package, objdir, out string, flags []string, objs []string) error { 1711 var cmd []string 1712 if len(p.CXXFiles) > 0 || len(p.SwigCXXFiles) > 0 { 1713 cmd = b.GxxCmd(p.Dir, objdir) 1714 } else { 1715 cmd = b.GccCmd(p.Dir, objdir) 1716 } 1717 return b.run(nil, p.Dir, p.ImportPath, nil, cmd, "-o", out, objs, flags) 1718 } 1719 1720 // Grab these before main helpfully overwrites them. 1721 var ( 1722 origCC = os.Getenv("CC") 1723 origCXX = os.Getenv("CXX") 1724 ) 1725 1726 // gccCmd returns a gcc command line prefix 1727 // defaultCC is defined in zdefaultcc.go, written by cmd/dist. 1728 func (b *Builder) GccCmd(incdir, workdir string) []string { 1729 return b.compilerCmd(b.ccExe(), incdir, workdir) 1730 } 1731 1732 // gxxCmd returns a g++ command line prefix 1733 // defaultCXX is defined in zdefaultcc.go, written by cmd/dist. 1734 func (b *Builder) GxxCmd(incdir, workdir string) []string { 1735 return b.compilerCmd(b.cxxExe(), incdir, workdir) 1736 } 1737 1738 // gfortranCmd returns a gfortran command line prefix. 1739 func (b *Builder) gfortranCmd(incdir, workdir string) []string { 1740 return b.compilerCmd(b.fcExe(), incdir, workdir) 1741 } 1742 1743 // ccExe returns the CC compiler setting without all the extra flags we add implicitly. 1744 func (b *Builder) ccExe() []string { 1745 return b.compilerExe(origCC, cfg.DefaultCC(cfg.Goos, cfg.Goarch)) 1746 } 1747 1748 // cxxExe returns the CXX compiler setting without all the extra flags we add implicitly. 1749 func (b *Builder) cxxExe() []string { 1750 return b.compilerExe(origCXX, cfg.DefaultCXX(cfg.Goos, cfg.Goarch)) 1751 } 1752 1753 // fcExe returns the FC compiler setting without all the extra flags we add implicitly. 1754 func (b *Builder) fcExe() []string { 1755 return b.compilerExe(os.Getenv("FC"), "gfortran") 1756 } 1757 1758 // compilerExe returns the compiler to use given an 1759 // environment variable setting (the value not the name) 1760 // and a default. The resulting slice is usually just the name 1761 // of the compiler but can have additional arguments if they 1762 // were present in the environment value. 1763 // For example if CC="gcc -DGOPHER" then the result is ["gcc", "-DGOPHER"]. 1764 func (b *Builder) compilerExe(envValue string, def string) []string { 1765 compiler := strings.Fields(envValue) 1766 if len(compiler) == 0 { 1767 compiler = []string{def} 1768 } 1769 return compiler 1770 } 1771 1772 // compilerCmd returns a command line prefix for the given environment 1773 // variable and using the default command when the variable is empty. 1774 func (b *Builder) compilerCmd(compiler []string, incdir, workdir string) []string { 1775 // NOTE: env.go's mkEnv knows that the first three 1776 // strings returned are "gcc", "-I", incdir (and cuts them off). 1777 a := []string{compiler[0], "-I", incdir} 1778 a = append(a, compiler[1:]...) 1779 1780 // Definitely want -fPIC but on Windows gcc complains 1781 // "-fPIC ignored for target (all code is position independent)" 1782 if cfg.Goos != "windows" { 1783 a = append(a, "-fPIC") 1784 } 1785 a = append(a, b.gccArchArgs()...) 1786 // gcc-4.5 and beyond require explicit "-pthread" flag 1787 // for multithreading with pthread library. 1788 if cfg.BuildContext.CgoEnabled { 1789 switch cfg.Goos { 1790 case "windows": 1791 a = append(a, "-mthreads") 1792 default: 1793 a = append(a, "-pthread") 1794 } 1795 } 1796 1797 // disable ASCII art in clang errors, if possible 1798 if b.gccSupportsFlag(compiler, "-fno-caret-diagnostics") { 1799 a = append(a, "-fno-caret-diagnostics") 1800 } 1801 // clang is too smart about command-line arguments 1802 if b.gccSupportsFlag(compiler, "-Qunused-arguments") { 1803 a = append(a, "-Qunused-arguments") 1804 } 1805 1806 // disable word wrapping in error messages 1807 a = append(a, "-fmessage-length=0") 1808 1809 // Tell gcc not to include the work directory in object files. 1810 if b.gccSupportsFlag(compiler, "-fdebug-prefix-map=a=b") { 1811 if workdir == "" { 1812 workdir = b.WorkDir 1813 } 1814 workdir = strings.TrimSuffix(workdir, string(filepath.Separator)) 1815 a = append(a, "-fdebug-prefix-map="+workdir+"=/tmp/go-build") 1816 } 1817 1818 // Tell gcc not to include flags in object files, which defeats the 1819 // point of -fdebug-prefix-map above. 1820 if b.gccSupportsFlag(compiler, "-gno-record-gcc-switches") { 1821 a = append(a, "-gno-record-gcc-switches") 1822 } 1823 1824 // On OS X, some of the compilers behave as if -fno-common 1825 // is always set, and the Mach-O linker in 6l/8l assumes this. 1826 // See https://golang.org/issue/3253. 1827 if cfg.Goos == "darwin" { 1828 a = append(a, "-fno-common") 1829 } 1830 1831 return a 1832 } 1833 1834 // gccNoPie returns the flag to use to request non-PIE. On systems 1835 // with PIE (position independent executables) enabled by default, 1836 // -no-pie must be passed when doing a partial link with -Wl,-r. 1837 // But -no-pie is not supported by all compilers, and clang spells it -nopie. 1838 func (b *Builder) gccNoPie(linker []string) string { 1839 if b.gccSupportsFlag(linker, "-no-pie") { 1840 return "-no-pie" 1841 } 1842 if b.gccSupportsFlag(linker, "-nopie") { 1843 return "-nopie" 1844 } 1845 return "" 1846 } 1847 1848 // gccSupportsFlag checks to see if the compiler supports a flag. 1849 func (b *Builder) gccSupportsFlag(compiler []string, flag string) bool { 1850 key := [2]string{compiler[0], flag} 1851 1852 b.exec.Lock() 1853 defer b.exec.Unlock() 1854 if b, ok := b.flagCache[key]; ok { 1855 return b 1856 } 1857 if b.flagCache == nil { 1858 b.flagCache = make(map[[2]string]bool) 1859 } 1860 // We used to write an empty C file, but that gets complicated with 1861 // go build -n. We tried using a file that does not exist, but that 1862 // fails on systems with GCC version 4.2.1; that is the last GPLv2 1863 // version of GCC, so some systems have frozen on it. 1864 // Now we pass an empty file on stdin, which should work at least for 1865 // GCC and clang. 1866 cmdArgs := str.StringList(compiler, flag, "-c", "-x", "c", "-") 1867 if cfg.BuildN || cfg.BuildX { 1868 b.Showcmd(b.WorkDir, "%s || true", joinUnambiguously(cmdArgs)) 1869 if cfg.BuildN { 1870 return false 1871 } 1872 } 1873 cmd := exec.Command(cmdArgs[0], cmdArgs[1:]...) 1874 cmd.Dir = b.WorkDir 1875 cmd.Env = base.MergeEnvLists([]string{"LC_ALL=C"}, base.EnvForDir(cmd.Dir, os.Environ())) 1876 out, _ := cmd.CombinedOutput() 1877 // GCC says "unrecognized command line option". 1878 // clang says "unknown argument". 1879 // Older versions of GCC say "unrecognised debug output level". 1880 // For -fsplit-stack GCC says "'-fsplit-stack' is not supported". 1881 supported := !bytes.Contains(out, []byte("unrecognized")) && 1882 !bytes.Contains(out, []byte("unknown")) && 1883 !bytes.Contains(out, []byte("unrecognised")) && 1884 !bytes.Contains(out, []byte("is not supported")) 1885 b.flagCache[key] = supported 1886 return supported 1887 } 1888 1889 // gccArchArgs returns arguments to pass to gcc based on the architecture. 1890 func (b *Builder) gccArchArgs() []string { 1891 switch cfg.Goarch { 1892 case "386": 1893 return []string{"-m32"} 1894 case "amd64", "amd64p32": 1895 return []string{"-m64"} 1896 case "arm": 1897 return []string{"-marm"} // not thumb 1898 case "s390x": 1899 return []string{"-m64", "-march=z196"} 1900 case "mips64", "mips64le": 1901 return []string{"-mabi=64"} 1902 case "mips", "mipsle": 1903 return []string{"-mabi=32", "-march=mips32"} 1904 } 1905 return nil 1906 } 1907 1908 // envList returns the value of the given environment variable broken 1909 // into fields, using the default value when the variable is empty. 1910 func envList(key, def string) []string { 1911 v := os.Getenv(key) 1912 if v == "" { 1913 v = def 1914 } 1915 return strings.Fields(v) 1916 } 1917 1918 // CFlags returns the flags to use when invoking the C, C++ or Fortran compilers, or cgo. 1919 func (b *Builder) CFlags(p *load.Package) (cppflags, cflags, cxxflags, fflags, ldflags []string, err error) { 1920 defaults := "-g -O2" 1921 1922 if cppflags, err = buildFlags("CPPFLAGS", "", p.CgoCPPFLAGS, checkCompilerFlags); err != nil { 1923 return 1924 } 1925 if cflags, err = buildFlags("CFLAGS", defaults, p.CgoCFLAGS, checkCompilerFlags); err != nil { 1926 return 1927 } 1928 if cxxflags, err = buildFlags("CXXFLAGS", defaults, p.CgoCXXFLAGS, checkCompilerFlags); err != nil { 1929 return 1930 } 1931 if fflags, err = buildFlags("FFLAGS", defaults, p.CgoFFLAGS, checkCompilerFlags); err != nil { 1932 return 1933 } 1934 if ldflags, err = buildFlags("LDFLAGS", defaults, p.CgoLDFLAGS, checkLinkerFlags); err != nil { 1935 return 1936 } 1937 1938 return 1939 } 1940 1941 func buildFlags(name, defaults string, fromPackage []string, check func(string, string, []string) error) ([]string, error) { 1942 if err := check(name, "#cgo "+name, fromPackage); err != nil { 1943 return nil, err 1944 } 1945 return str.StringList(envList("CGO_"+name, defaults), fromPackage), nil 1946 } 1947 1948 var cgoRe = regexp.MustCompile(`[/\\:]`) 1949 1950 func (b *Builder) cgo(a *Action, cgoExe, objdir string, pcCFLAGS, pcLDFLAGS, cgofiles, gccfiles, gxxfiles, mfiles, ffiles []string) (outGo, outObj []string, err error) { 1951 p := a.Package 1952 cgoCPPFLAGS, cgoCFLAGS, cgoCXXFLAGS, cgoFFLAGS, cgoLDFLAGS, err := b.CFlags(p) 1953 if err != nil { 1954 return nil, nil, err 1955 } 1956 1957 cgoCPPFLAGS = append(cgoCPPFLAGS, pcCFLAGS...) 1958 cgoLDFLAGS = append(cgoLDFLAGS, pcLDFLAGS...) 1959 // If we are compiling Objective-C code, then we need to link against libobjc 1960 if len(mfiles) > 0 { 1961 cgoLDFLAGS = append(cgoLDFLAGS, "-lobjc") 1962 } 1963 1964 // Likewise for Fortran, except there are many Fortran compilers. 1965 // Support gfortran out of the box and let others pass the correct link options 1966 // via CGO_LDFLAGS 1967 if len(ffiles) > 0 { 1968 fc := os.Getenv("FC") 1969 if fc == "" { 1970 fc = "gfortran" 1971 } 1972 if strings.Contains(fc, "gfortran") { 1973 cgoLDFLAGS = append(cgoLDFLAGS, "-lgfortran") 1974 } 1975 } 1976 1977 if cfg.BuildMSan { 1978 cgoCFLAGS = append([]string{"-fsanitize=memory"}, cgoCFLAGS...) 1979 cgoLDFLAGS = append([]string{"-fsanitize=memory"}, cgoLDFLAGS...) 1980 } 1981 1982 // Allows including _cgo_export.h from .[ch] files in the package. 1983 cgoCPPFLAGS = append(cgoCPPFLAGS, "-I", objdir) 1984 1985 // cgo 1986 // TODO: CGO_FLAGS? 1987 gofiles := []string{objdir + "_cgo_gotypes.go"} 1988 cfiles := []string{"_cgo_export.c"} 1989 for _, fn := range cgofiles { 1990 f := strings.TrimSuffix(filepath.Base(fn), ".go") 1991 gofiles = append(gofiles, objdir+f+".cgo1.go") 1992 cfiles = append(cfiles, f+".cgo2.c") 1993 } 1994 1995 // TODO: make cgo not depend on $GOARCH? 1996 1997 cgoflags := []string{} 1998 if p.Standard && p.ImportPath == "runtime/cgo" { 1999 cgoflags = append(cgoflags, "-import_runtime_cgo=false") 2000 } 2001 if p.Standard && (p.ImportPath == "runtime/race" || p.ImportPath == "runtime/msan" || p.ImportPath == "runtime/cgo") { 2002 cgoflags = append(cgoflags, "-import_syscall=false") 2003 } 2004 2005 // Update $CGO_LDFLAGS with p.CgoLDFLAGS. 2006 // These flags are recorded in the generated _cgo_gotypes.go file 2007 // using //go:cgo_ldflag directives, the compiler records them in the 2008 // object file for the package, and then the Go linker passes them 2009 // along to the host linker. At this point in the code, cgoLDFLAGS 2010 // consists of the original $CGO_LDFLAGS (unchecked) and all the 2011 // flags put together from source code (checked). 2012 var cgoenv []string 2013 if len(cgoLDFLAGS) > 0 { 2014 flags := make([]string, len(cgoLDFLAGS)) 2015 for i, f := range cgoLDFLAGS { 2016 flags[i] = strconv.Quote(f) 2017 } 2018 cgoenv = []string{"CGO_LDFLAGS=" + strings.Join(flags, " ")} 2019 } 2020 2021 if cfg.BuildToolchainName == "gccgo" { 2022 switch cfg.Goarch { 2023 case "386", "amd64": 2024 cgoCFLAGS = append(cgoCFLAGS, "-fsplit-stack") 2025 } 2026 cgoflags = append(cgoflags, "-gccgo") 2027 if pkgpath := gccgoPkgpath(p); pkgpath != "" { 2028 cgoflags = append(cgoflags, "-gccgopkgpath="+pkgpath) 2029 } 2030 } 2031 2032 switch cfg.BuildBuildmode { 2033 case "c-archive", "c-shared": 2034 // Tell cgo that if there are any exported functions 2035 // it should generate a header file that C code can 2036 // #include. 2037 cgoflags = append(cgoflags, "-exportheader="+objdir+"_cgo_install.h") 2038 } 2039 2040 if err := b.run(a, p.Dir, p.ImportPath, cgoenv, cfg.BuildToolexec, cgoExe, "-objdir", objdir, "-importpath", p.ImportPath, cgoflags, "--", cgoCPPFLAGS, cgoCFLAGS, cgofiles); err != nil { 2041 return nil, nil, err 2042 } 2043 outGo = append(outGo, gofiles...) 2044 2045 // Use sequential object file names to keep them distinct 2046 // and short enough to fit in the .a header file name slots. 2047 // We no longer collect them all into _all.o, and we'd like 2048 // tools to see both the .o suffix and unique names, so 2049 // we need to make them short enough not to be truncated 2050 // in the final archive. 2051 oseq := 0 2052 nextOfile := func() string { 2053 oseq++ 2054 return objdir + fmt.Sprintf("_x%03d.o", oseq) 2055 } 2056 2057 // gcc 2058 cflags := str.StringList(cgoCPPFLAGS, cgoCFLAGS) 2059 for _, cfile := range cfiles { 2060 ofile := nextOfile() 2061 if err := b.gcc(a, p, a.Objdir, ofile, cflags, objdir+cfile); err != nil { 2062 return nil, nil, err 2063 } 2064 outObj = append(outObj, ofile) 2065 } 2066 2067 for _, file := range gccfiles { 2068 ofile := nextOfile() 2069 if err := b.gcc(a, p, a.Objdir, ofile, cflags, file); err != nil { 2070 return nil, nil, err 2071 } 2072 outObj = append(outObj, ofile) 2073 } 2074 2075 cxxflags := str.StringList(cgoCPPFLAGS, cgoCXXFLAGS) 2076 for _, file := range gxxfiles { 2077 ofile := nextOfile() 2078 if err := b.gxx(a, p, a.Objdir, ofile, cxxflags, file); err != nil { 2079 return nil, nil, err 2080 } 2081 outObj = append(outObj, ofile) 2082 } 2083 2084 for _, file := range mfiles { 2085 ofile := nextOfile() 2086 if err := b.gcc(a, p, a.Objdir, ofile, cflags, file); err != nil { 2087 return nil, nil, err 2088 } 2089 outObj = append(outObj, ofile) 2090 } 2091 2092 fflags := str.StringList(cgoCPPFLAGS, cgoFFLAGS) 2093 for _, file := range ffiles { 2094 ofile := nextOfile() 2095 if err := b.gfortran(a, p, a.Objdir, ofile, fflags, file); err != nil { 2096 return nil, nil, err 2097 } 2098 outObj = append(outObj, ofile) 2099 } 2100 2101 switch cfg.BuildToolchainName { 2102 case "gc": 2103 importGo := objdir + "_cgo_import.go" 2104 if err := b.dynimport(a, p, objdir, importGo, cgoExe, cflags, cgoLDFLAGS, outObj); err != nil { 2105 return nil, nil, err 2106 } 2107 outGo = append(outGo, importGo) 2108 2109 case "gccgo": 2110 defunC := objdir + "_cgo_defun.c" 2111 defunObj := objdir + "_cgo_defun.o" 2112 if err := BuildToolchain.cc(b, a, defunObj, defunC); err != nil { 2113 return nil, nil, err 2114 } 2115 outObj = append(outObj, defunObj) 2116 2117 default: 2118 noCompiler() 2119 } 2120 2121 return outGo, outObj, nil 2122 } 2123 2124 // dynimport creates a Go source file named importGo containing 2125 // //go:cgo_import_dynamic directives for each symbol or library 2126 // dynamically imported by the object files outObj. 2127 func (b *Builder) dynimport(a *Action, p *load.Package, objdir, importGo, cgoExe string, cflags, cgoLDFLAGS, outObj []string) error { 2128 cfile := objdir + "_cgo_main.c" 2129 ofile := objdir + "_cgo_main.o" 2130 if err := b.gcc(a, p, objdir, ofile, cflags, cfile); err != nil { 2131 return err 2132 } 2133 2134 linkobj := str.StringList(ofile, outObj, p.SysoFiles) 2135 dynobj := objdir + "_cgo_.o" 2136 2137 // we need to use -pie for Linux/ARM to get accurate imported sym 2138 ldflags := cgoLDFLAGS 2139 if (cfg.Goarch == "arm" && cfg.Goos == "linux") || cfg.Goos == "android" { 2140 ldflags = append(ldflags, "-pie") 2141 } 2142 if err := b.gccld(p, objdir, dynobj, ldflags, linkobj); err != nil { 2143 return err 2144 } 2145 2146 // cgo -dynimport 2147 var cgoflags []string 2148 if p.Standard && p.ImportPath == "runtime/cgo" { 2149 cgoflags = []string{"-dynlinker"} // record path to dynamic linker 2150 } 2151 return b.run(a, p.Dir, p.ImportPath, nil, cfg.BuildToolexec, cgoExe, "-dynpackage", p.Name, "-dynimport", dynobj, "-dynout", importGo, cgoflags) 2152 } 2153 2154 // Run SWIG on all SWIG input files. 2155 // TODO: Don't build a shared library, once SWIG emits the necessary 2156 // pragmas for external linking. 2157 func (b *Builder) swig(a *Action, p *load.Package, objdir string, pcCFLAGS []string) (outGo, outC, outCXX []string, err error) { 2158 if err := b.swigVersionCheck(); err != nil { 2159 return nil, nil, nil, err 2160 } 2161 2162 intgosize, err := b.swigIntSize(objdir) 2163 if err != nil { 2164 return nil, nil, nil, err 2165 } 2166 2167 for _, f := range p.SwigFiles { 2168 goFile, cFile, err := b.swigOne(a, p, f, objdir, pcCFLAGS, false, intgosize) 2169 if err != nil { 2170 return nil, nil, nil, err 2171 } 2172 if goFile != "" { 2173 outGo = append(outGo, goFile) 2174 } 2175 if cFile != "" { 2176 outC = append(outC, cFile) 2177 } 2178 } 2179 for _, f := range p.SwigCXXFiles { 2180 goFile, cxxFile, err := b.swigOne(a, p, f, objdir, pcCFLAGS, true, intgosize) 2181 if err != nil { 2182 return nil, nil, nil, err 2183 } 2184 if goFile != "" { 2185 outGo = append(outGo, goFile) 2186 } 2187 if cxxFile != "" { 2188 outCXX = append(outCXX, cxxFile) 2189 } 2190 } 2191 return outGo, outC, outCXX, nil 2192 } 2193 2194 // Make sure SWIG is new enough. 2195 var ( 2196 swigCheckOnce sync.Once 2197 swigCheck error 2198 ) 2199 2200 func (b *Builder) swigDoVersionCheck() error { 2201 out, err := b.runOut("", "", nil, "swig", "-version") 2202 if err != nil { 2203 return err 2204 } 2205 re := regexp.MustCompile(`[vV]ersion +([\d]+)([.][\d]+)?([.][\d]+)?`) 2206 matches := re.FindSubmatch(out) 2207 if matches == nil { 2208 // Can't find version number; hope for the best. 2209 return nil 2210 } 2211 2212 major, err := strconv.Atoi(string(matches[1])) 2213 if err != nil { 2214 // Can't find version number; hope for the best. 2215 return nil 2216 } 2217 const errmsg = "must have SWIG version >= 3.0.6" 2218 if major < 3 { 2219 return errors.New(errmsg) 2220 } 2221 if major > 3 { 2222 // 4.0 or later 2223 return nil 2224 } 2225 2226 // We have SWIG version 3.x. 2227 if len(matches[2]) > 0 { 2228 minor, err := strconv.Atoi(string(matches[2][1:])) 2229 if err != nil { 2230 return nil 2231 } 2232 if minor > 0 { 2233 // 3.1 or later 2234 return nil 2235 } 2236 } 2237 2238 // We have SWIG version 3.0.x. 2239 if len(matches[3]) > 0 { 2240 patch, err := strconv.Atoi(string(matches[3][1:])) 2241 if err != nil { 2242 return nil 2243 } 2244 if patch < 6 { 2245 // Before 3.0.6. 2246 return errors.New(errmsg) 2247 } 2248 } 2249 2250 return nil 2251 } 2252 2253 func (b *Builder) swigVersionCheck() error { 2254 swigCheckOnce.Do(func() { 2255 swigCheck = b.swigDoVersionCheck() 2256 }) 2257 return swigCheck 2258 } 2259 2260 // Find the value to pass for the -intgosize option to swig. 2261 var ( 2262 swigIntSizeOnce sync.Once 2263 swigIntSize string 2264 swigIntSizeError error 2265 ) 2266 2267 // This code fails to build if sizeof(int) <= 32 2268 const swigIntSizeCode = ` 2269 package main 2270 const i int = 1 << 32 2271 ` 2272 2273 // Determine the size of int on the target system for the -intgosize option 2274 // of swig >= 2.0.9. Run only once. 2275 func (b *Builder) swigDoIntSize(objdir string) (intsize string, err error) { 2276 if cfg.BuildN { 2277 return "$INTBITS", nil 2278 } 2279 src := filepath.Join(b.WorkDir, "swig_intsize.go") 2280 if err = ioutil.WriteFile(src, []byte(swigIntSizeCode), 0666); err != nil { 2281 return 2282 } 2283 srcs := []string{src} 2284 2285 p := load.GoFilesPackage(srcs) 2286 2287 if _, _, e := BuildToolchain.gc(b, &Action{Mode: "swigDoIntSize", Package: p, Objdir: objdir}, "", nil, false, srcs); e != nil { 2288 return "32", nil 2289 } 2290 return "64", nil 2291 } 2292 2293 // Determine the size of int on the target system for the -intgosize option 2294 // of swig >= 2.0.9. 2295 func (b *Builder) swigIntSize(objdir string) (intsize string, err error) { 2296 swigIntSizeOnce.Do(func() { 2297 swigIntSize, swigIntSizeError = b.swigDoIntSize(objdir) 2298 }) 2299 return swigIntSize, swigIntSizeError 2300 } 2301 2302 // Run SWIG on one SWIG input file. 2303 func (b *Builder) swigOne(a *Action, p *load.Package, file, objdir string, pcCFLAGS []string, cxx bool, intgosize string) (outGo, outC string, err error) { 2304 cgoCPPFLAGS, cgoCFLAGS, cgoCXXFLAGS, _, _, err := b.CFlags(p) 2305 if err != nil { 2306 return "", "", err 2307 } 2308 2309 var cflags []string 2310 if cxx { 2311 cflags = str.StringList(cgoCPPFLAGS, pcCFLAGS, cgoCXXFLAGS) 2312 } else { 2313 cflags = str.StringList(cgoCPPFLAGS, pcCFLAGS, cgoCFLAGS) 2314 } 2315 2316 n := 5 // length of ".swig" 2317 if cxx { 2318 n = 8 // length of ".swigcxx" 2319 } 2320 base := file[:len(file)-n] 2321 goFile := base + ".go" 2322 gccBase := base + "_wrap." 2323 gccExt := "c" 2324 if cxx { 2325 gccExt = "cxx" 2326 } 2327 2328 gccgo := cfg.BuildToolchainName == "gccgo" 2329 2330 // swig 2331 args := []string{ 2332 "-go", 2333 "-cgo", 2334 "-intgosize", intgosize, 2335 "-module", base, 2336 "-o", objdir + gccBase + gccExt, 2337 "-outdir", objdir, 2338 } 2339 2340 for _, f := range cflags { 2341 if len(f) > 3 && f[:2] == "-I" { 2342 args = append(args, f) 2343 } 2344 } 2345 2346 if gccgo { 2347 args = append(args, "-gccgo") 2348 if pkgpath := gccgoPkgpath(p); pkgpath != "" { 2349 args = append(args, "-go-pkgpath", pkgpath) 2350 } 2351 } 2352 if cxx { 2353 args = append(args, "-c++") 2354 } 2355 2356 out, err := b.runOut(p.Dir, p.ImportPath, nil, "swig", args, file) 2357 if err != nil { 2358 if len(out) > 0 { 2359 if bytes.Contains(out, []byte("-intgosize")) || bytes.Contains(out, []byte("-cgo")) { 2360 return "", "", errors.New("must have SWIG version >= 3.0.6") 2361 } 2362 b.showOutput(a, p.Dir, p.ImportPath, b.processOutput(out)) // swig error 2363 return "", "", errPrintedOutput 2364 } 2365 return "", "", err 2366 } 2367 if len(out) > 0 { 2368 b.showOutput(a, p.Dir, p.ImportPath, b.processOutput(out)) // swig warning 2369 } 2370 2371 // If the input was x.swig, the output is x.go in the objdir. 2372 // But there might be an x.go in the original dir too, and if it 2373 // uses cgo as well, cgo will be processing both and will 2374 // translate both into x.cgo1.go in the objdir, overwriting one. 2375 // Rename x.go to _x_swig.go to avoid this problem. 2376 // We ignore files in the original dir that begin with underscore 2377 // so _x_swig.go cannot conflict with an original file we were 2378 // going to compile. 2379 goFile = objdir + goFile 2380 newGoFile := objdir + "_" + base + "_swig.go" 2381 if err := os.Rename(goFile, newGoFile); err != nil { 2382 return "", "", err 2383 } 2384 return newGoFile, objdir + gccBase + gccExt, nil 2385 } 2386 2387 // disableBuildID adjusts a linker command line to avoid creating a 2388 // build ID when creating an object file rather than an executable or 2389 // shared library. Some systems, such as Ubuntu, always add 2390 // --build-id to every link, but we don't want a build ID when we are 2391 // producing an object file. On some of those system a plain -r (not 2392 // -Wl,-r) will turn off --build-id, but clang 3.0 doesn't support a 2393 // plain -r. I don't know how to turn off --build-id when using clang 2394 // other than passing a trailing --build-id=none. So that is what we 2395 // do, but only on systems likely to support it, which is to say, 2396 // systems that normally use gold or the GNU linker. 2397 func (b *Builder) disableBuildID(ldflags []string) []string { 2398 switch cfg.Goos { 2399 case "android", "dragonfly", "linux", "netbsd": 2400 ldflags = append(ldflags, "-Wl,--build-id=none") 2401 } 2402 return ldflags 2403 } 2404 2405 // mkAbsFiles converts files into a list of absolute files, 2406 // assuming they were originally relative to dir, 2407 // and returns that new list. 2408 func mkAbsFiles(dir string, files []string) []string { 2409 abs := make([]string, len(files)) 2410 for i, f := range files { 2411 if !filepath.IsAbs(f) { 2412 f = filepath.Join(dir, f) 2413 } 2414 abs[i] = f 2415 } 2416 return abs 2417 }