blob: e8c6f22f82d8c5cc16486e61218b271c01eb3d67 [file] [log] [blame]
// Copyright 2017 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Microfactory is a tool to incrementally compile a go program. It's similar
// to `go install`, but doesn't require a GOPATH. A package->path mapping can
// be specified as command line options:
//
// -pkg-path android/soong=build/soong
// -pkg-path github.com/google/blueprint=build/blueprint
//
// The paths can be relative to the current working directory, or an absolute
// path. Both packages and paths are compared with full directory names, so the
// android/soong-test package wouldn't be mapped in the above case.
//
// Microfactory will ignore *_test.go files, and limits *_darwin.go and
// *_linux.go files to MacOS and Linux respectively. It does not support build
// tags or any other suffixes.
//
// Builds are incremental by package. All input files are hashed, and if the
// hash of an input or dependency changes, the package is rebuilt.
//
// It also exposes the -trimpath option from go's compiler so that embedded
// path names (such as in log.Llongfile) are relative paths instead of absolute
// paths.
//
// If you don't have a previously built version of Microfactory, when used with
// -s <microfactory_src_dir> -b <microfactory_bin_file>, Microfactory can
// rebuild itself as necessary. Combined with a shell script like soong_ui.bash
// that uses `go run` to run Microfactory for the first time, go programs can be
// quickly bootstrapped entirely from source (and a standard go distribution).
package main
import (
"bytes"
"crypto/sha1"
"flag"
"fmt"
"go/ast"
"go/parser"
"go/token"
"io"
"io/ioutil"
"os"
"os/exec"
"path/filepath"
"runtime"
"sort"
"strconv"
"strings"
"sync"
"syscall"
"time"
)
var (
race = false
verbose = false
goToolDir = filepath.Join(runtime.GOROOT(), "pkg", "tool", runtime.GOOS+"_"+runtime.GOARCH)
goVersion = findGoVersion()
isGo18 = strings.Contains(goVersion, "go1.8")
)
func findGoVersion() string {
if version, err := ioutil.ReadFile(filepath.Join(runtime.GOROOT(), "VERSION")); err == nil {
return string(version)
}
cmd := exec.Command(filepath.Join(runtime.GOROOT(), "bin", "go"), "version")
if version, err := cmd.Output(); err == nil {
return string(version)
} else {
panic(fmt.Sprintf("Unable to discover go version: %v", err))
}
}
type GoPackage struct {
Name string
// Inputs
directDeps []*GoPackage // specified directly by the module
allDeps []*GoPackage // direct dependencies and transitive dependencies
files []string
// Outputs
pkgDir string
output string
hashResult []byte
// Status
mutex sync.Mutex
compiled bool
failed error
rebuilt bool
}
// LinkedHashMap<string, GoPackage>
type linkedDepSet struct {
packageSet map[string](*GoPackage)
packageList []*GoPackage
}
func newDepSet() *linkedDepSet {
return &linkedDepSet{packageSet: make(map[string]*GoPackage)}
}
func (s *linkedDepSet) tryGetByName(name string) (*GoPackage, bool) {
pkg, contained := s.packageSet[name]
return pkg, contained
}
func (s *linkedDepSet) getByName(name string) *GoPackage {
pkg, _ := s.tryGetByName(name)
return pkg
}
func (s *linkedDepSet) add(name string, goPackage *GoPackage) {
s.packageSet[name] = goPackage
s.packageList = append(s.packageList, goPackage)
}
func (s *linkedDepSet) ignore(name string) {
s.packageSet[name] = nil
}
// FindDeps searches all applicable go files in `path`, parses all of them
// for import dependencies that exist in pkgMap, then recursively does the
// same for all of those dependencies.
func (p *GoPackage) FindDeps(path string, pkgMap *pkgPathMapping) error {
defer un(trace("findDeps"))
depSet := newDepSet()
err := p.findDeps(path, pkgMap, depSet)
if err != nil {
return err
}
p.allDeps = depSet.packageList
return nil
}
// findDeps is the recursive version of FindDeps. allPackages is the map of
// all locally defined packages so that the same dependency of two different
// packages is only resolved once.
func (p *GoPackage) findDeps(path string, pkgMap *pkgPathMapping, allPackages *linkedDepSet) error {
// If this ever becomes too slow, we can look at reading the files once instead of twice
// But that just complicates things today, and we're already really fast.
foundPkgs, err := parser.ParseDir(token.NewFileSet(), path, func(fi os.FileInfo) bool {
name := fi.Name()
if fi.IsDir() || strings.HasSuffix(name, "_test.go") || name[0] == '.' || name[0] == '_' {
return false
}
if runtime.GOOS != "darwin" && strings.HasSuffix(name, "_darwin.go") {
return false
}
if runtime.GOOS != "linux" && strings.HasSuffix(name, "_linux.go") {
return false
}
return true
}, parser.ImportsOnly)
if err != nil {
return fmt.Errorf("Error parsing directory %q: %v", path, err)
}
var foundPkg *ast.Package
// foundPkgs is a map[string]*ast.Package, but we only want one package
if len(foundPkgs) != 1 {
return fmt.Errorf("Expected one package in %q, got %d", path, len(foundPkgs))
}
// Extract the first (and only) entry from the map.
for _, pkg := range foundPkgs {
foundPkg = pkg
}
var deps []string
localDeps := make(map[string]bool)
for filename, astFile := range foundPkg.Files {
p.files = append(p.files, filename)
for _, importSpec := range astFile.Imports {
name, err := strconv.Unquote(importSpec.Path.Value)
if err != nil {
return fmt.Errorf("%s: invalid quoted string: <%s> %v", filename, importSpec.Path.Value, err)
}
if pkg, ok := allPackages.tryGetByName(name); ok {
if pkg != nil {
if _, ok := localDeps[name]; !ok {
deps = append(deps, name)
localDeps[name] = true
}
}
continue
}
var pkgPath string
if path, ok, err := pkgMap.Path(name); err != nil {
return err
} else if !ok {
// Probably in the stdlib, but if not, then the compiler will fail with a reasonable error message
// Mark it as such so that we don't try to decode its path again.
allPackages.ignore(name)
continue
} else {
pkgPath = path
}
pkg := &GoPackage{
Name: name,
}
deps = append(deps, name)
allPackages.add(name, pkg)
localDeps[name] = true
if err := pkg.findDeps(pkgPath, pkgMap, allPackages); err != nil {
return err
}
}
}
sort.Strings(p.files)
if verbose {
fmt.Fprintf(os.Stderr, "Package %q depends on %v\n", p.Name, deps)
}
sort.Strings(deps)
for _, dep := range deps {
p.directDeps = append(p.directDeps, allPackages.getByName(dep))
}
return nil
}
func (p *GoPackage) Compile(outDir, trimPath string) error {
p.mutex.Lock()
defer p.mutex.Unlock()
if p.compiled {
return p.failed
}
p.compiled = true
// Build all dependencies in parallel, then fail if any of them failed.
var wg sync.WaitGroup
for _, dep := range p.directDeps {
wg.Add(1)
go func(dep *GoPackage) {
defer wg.Done()
dep.Compile(outDir, trimPath)
}(dep)
}
wg.Wait()
for _, dep := range p.directDeps {
if dep.failed != nil {
p.failed = dep.failed
return p.failed
}
}
endTrace := trace("check compile %s", p.Name)
p.pkgDir = filepath.Join(outDir, strings.Replace(p.Name, "/", "-", -1))
p.output = filepath.Join(p.pkgDir, p.Name) + ".a"
shaFile := p.output + ".hash"
hash := sha1.New()
fmt.Fprintln(hash, runtime.GOOS, runtime.GOARCH, goVersion)
cmd := exec.Command(filepath.Join(goToolDir, "compile"),
"-o", p.output,
"-p", p.Name,
"-complete", "-pack", "-nolocalimports")
if !isGo18 {
cmd.Args = append(cmd.Args, "-c", fmt.Sprintf("%d", runtime.NumCPU()))
}
if race {
cmd.Args = append(cmd.Args, "-race")
fmt.Fprintln(hash, "-race")
}
if trimPath != "" {
cmd.Args = append(cmd.Args, "-trimpath", trimPath)
fmt.Fprintln(hash, trimPath)
}
for _, dep := range p.directDeps {
cmd.Args = append(cmd.Args, "-I", dep.pkgDir)
hash.Write(dep.hashResult)
}
for _, filename := range p.files {
cmd.Args = append(cmd.Args, filename)
fmt.Fprintln(hash, filename)
// Hash the contents of the input files
f, err := os.Open(filename)
if err != nil {
f.Close()
err = fmt.Errorf("%s: %v", filename, err)
p.failed = err
return err
}
_, err = io.Copy(hash, f)
if err != nil {
f.Close()
err = fmt.Errorf("%s: %v", filename, err)
p.failed = err
return err
}
f.Close()
}
p.hashResult = hash.Sum(nil)
var rebuild bool
if _, err := os.Stat(p.output); err != nil {
rebuild = true
}
if !rebuild {
if oldSha, err := ioutil.ReadFile(shaFile); err == nil {
rebuild = !bytes.Equal(oldSha, p.hashResult)
} else {
rebuild = true
}
}
endTrace()
if !rebuild {
return nil
}
defer un(trace("compile %s", p.Name))
err := os.RemoveAll(p.pkgDir)
if err != nil {
err = fmt.Errorf("%s: %v", p.Name, err)
p.failed = err
return err
}
err = os.MkdirAll(filepath.Dir(p.output), 0777)
if err != nil {
err = fmt.Errorf("%s: %v", p.Name, err)
p.failed = err
return err
}
cmd.Stdin = nil
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
if verbose {
fmt.Fprintln(os.Stderr, cmd.Args)
}
err = cmd.Run()
if err != nil {
err = fmt.Errorf("%s: %v", p.Name, err)
p.failed = err
return err
}
err = ioutil.WriteFile(shaFile, p.hashResult, 0666)
if err != nil {
err = fmt.Errorf("%s: %v", p.Name, err)
p.failed = err
return err
}
p.rebuilt = true
return nil
}
func (p *GoPackage) Link(out string) error {
if p.Name != "main" {
return fmt.Errorf("Can only link main package")
}
endTrace := trace("check link %s", p.Name)
shaFile := filepath.Join(filepath.Dir(out), "."+filepath.Base(out)+"_hash")
if !p.rebuilt {
if _, err := os.Stat(out); err != nil {
p.rebuilt = true
} else if oldSha, err := ioutil.ReadFile(shaFile); err != nil {
p.rebuilt = true
} else {
p.rebuilt = !bytes.Equal(oldSha, p.hashResult)
}
}
endTrace()
if !p.rebuilt {
return nil
}
defer un(trace("link %s", p.Name))
err := os.Remove(shaFile)
if err != nil && !os.IsNotExist(err) {
return err
}
err = os.Remove(out)
if err != nil && !os.IsNotExist(err) {
return err
}
cmd := exec.Command(filepath.Join(goToolDir, "link"), "-o", out)
if race {
cmd.Args = append(cmd.Args, "-race")
}
for _, dep := range p.allDeps {
cmd.Args = append(cmd.Args, "-L", dep.pkgDir)
}
cmd.Args = append(cmd.Args, p.output)
cmd.Stdin = nil
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
if verbose {
fmt.Fprintln(os.Stderr, cmd.Args)
}
err = cmd.Run()
if err != nil {
return fmt.Errorf("command %s failed with error %v", cmd.Args, err)
}
return ioutil.WriteFile(shaFile, p.hashResult, 0666)
}
// rebuildMicrofactory checks to see if microfactory itself needs to be rebuilt,
// and if does, it will launch a new copy and return true. Otherwise it will return
// false to continue executing.
func rebuildMicrofactory(mybin, mysrc string, pkgMap *pkgPathMapping) bool {
intermediates := filepath.Join(filepath.Dir(mybin), "."+filepath.Base(mybin)+"_intermediates")
err := os.MkdirAll(intermediates, 0777)
if err != nil {
fmt.Fprintln(os.Stderr, "Failed to create intermediates directory: %v", err)
os.Exit(1)
}
pkg := &GoPackage{
Name: "main",
}
if err := pkg.FindDeps(mysrc, pkgMap); err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
if err := pkg.Compile(intermediates, mysrc); err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
if err := pkg.Link(mybin); err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
if !pkg.rebuilt {
return false
}
cmd := exec.Command(mybin, os.Args[1:]...)
cmd.Stdin = os.Stdin
cmd.Stdout = os.Stdout
cmd.Stderr = os.Stderr
if err := cmd.Run(); err == nil {
return true
} else if e, ok := err.(*exec.ExitError); ok {
os.Exit(e.ProcessState.Sys().(syscall.WaitStatus).ExitStatus())
}
os.Exit(1)
return true
}
var traceFile *os.File
func trace(format string, a ...interface{}) func() {
if traceFile == nil {
return func() {}
}
s := strings.TrimSpace(fmt.Sprintf(format, a...))
fmt.Fprintf(traceFile, "%d B %s\n", time.Now().UnixNano()/1000, s)
return func() {
fmt.Fprintf(traceFile, "%d E %s\n", time.Now().UnixNano()/1000, s)
}
}
func un(f func()) {
f()
}
func main() {
var output, mysrc, mybin, trimPath string
var pkgMap pkgPathMapping
flags := flag.NewFlagSet("", flag.ExitOnError)
flags.BoolVar(&race, "race", false, "enable data race detection.")
flags.BoolVar(&verbose, "v", false, "Verbose")
flags.StringVar(&output, "o", "", "Output file")
flags.StringVar(&mysrc, "s", "", "Microfactory source directory (for rebuilding microfactory if necessary)")
flags.StringVar(&mybin, "b", "", "Microfactory binary location")
flags.StringVar(&trimPath, "trimpath", "", "remove prefix from recorded source file paths")
flags.Var(&pkgMap, "pkg-path", "Mapping of package prefixes to file paths")
err := flags.Parse(os.Args[1:])
if err == flag.ErrHelp || flags.NArg() != 1 || output == "" {
fmt.Fprintln(os.Stderr, "Usage:", os.Args[0], "-o out/binary <main-package>")
flags.PrintDefaults()
os.Exit(1)
}
tracePath := filepath.Join(filepath.Dir(output), "."+filepath.Base(output)+".trace")
traceFile, err = os.OpenFile(tracePath, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0666)
if err != nil {
traceFile = nil
}
if executable, err := os.Executable(); err == nil {
defer un(trace("microfactory %s", executable))
} else {
defer un(trace("microfactory <unknown>"))
}
if mybin != "" && mysrc != "" {
if rebuildMicrofactory(mybin, mysrc, &pkgMap) {
return
}
}
mainPackage := &GoPackage{
Name: "main",
}
if path, ok, err := pkgMap.Path(flags.Arg(0)); err != nil {
fmt.Fprintln(os.Stderr, "Error finding main path:", err)
os.Exit(1)
} else if !ok {
fmt.Fprintln(os.Stderr, "Cannot find path for", flags.Arg(0))
} else {
if err := mainPackage.FindDeps(path, &pkgMap); err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
}
intermediates := filepath.Join(filepath.Dir(output), "."+filepath.Base(output)+"_intermediates")
err = os.MkdirAll(intermediates, 0777)
if err != nil {
fmt.Fprintln(os.Stderr, "Failed to create intermediates directory: %ve", err)
os.Exit(1)
}
err = mainPackage.Compile(intermediates, trimPath)
if err != nil {
fmt.Fprintln(os.Stderr, "Failed to compile:", err)
os.Exit(1)
}
err = mainPackage.Link(output)
if err != nil {
fmt.Fprintln(os.Stderr, "microfactory.go failed to link:", err)
os.Exit(1)
}
}
// pkgPathMapping can be used with flag.Var to parse -pkg-path arguments of
// <package-prefix>=<path-prefix> mappings.
type pkgPathMapping struct {
pkgs []string
paths map[string]string
}
func (pkgPathMapping) String() string {
return "<package-prefix>=<path-prefix>"
}
func (p *pkgPathMapping) Set(value string) error {
equalPos := strings.Index(value, "=")
if equalPos == -1 {
return fmt.Errorf("Argument must be in the form of: %q", p.String())
}
pkgPrefix := strings.TrimSuffix(value[:equalPos], "/")
pathPrefix := strings.TrimSuffix(value[equalPos+1:], "/")
if p.paths == nil {
p.paths = make(map[string]string)
}
if _, ok := p.paths[pkgPrefix]; ok {
return fmt.Errorf("Duplicate package prefix: %q", pkgPrefix)
}
p.pkgs = append(p.pkgs, pkgPrefix)
p.paths[pkgPrefix] = pathPrefix
return nil
}
// Path takes a package name, applies the path mappings and returns the resulting path.
//
// If the package isn't mapped, we'll return false to prevent compilation attempts.
func (p *pkgPathMapping) Path(pkg string) (string, bool, error) {
if p.paths == nil {
return "", false, fmt.Errorf("No package mappings")
}
for _, pkgPrefix := range p.pkgs {
if pkg == pkgPrefix {
return p.paths[pkgPrefix], true, nil
} else if strings.HasPrefix(pkg, pkgPrefix+"/") {
return filepath.Join(p.paths[pkgPrefix], strings.TrimPrefix(pkg, pkgPrefix+"/")), true, nil
}
}
return "", false, nil
}