// Copyright 2015 The Go Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package main // TODO(crawshaw): build darwin/arm cross compiler on darwin/{386,amd64} // TODO(crawshaw): android/{386,arm64} import ( "archive/tar" "bytes" "compress/gzip" "fmt" "io" "io/ioutil" "net/http" "os" "os/exec" "path" "path/filepath" "runtime" "strings" ) // useStrippedNDK determines whether the init subcommand fetches the GCC // toolchain from the original Android NDK, or from the stripped-down NDK // hosted specifically for the gomobile tool. // // There is a significant size different (400MB compared to 30MB). var useStrippedNDK = true const ndkVersion = "ndk-r10d" const openALVersion = "openal-soft-1.16.0.1" var ( goos = runtime.GOOS goarch = runtime.GOARCH ndkarch string ) func init() { if runtime.GOARCH == "amd64" { ndkarch = "x86_64" } else { ndkarch = runtime.GOARCH } } var cmdInit = &command{ run: runInit, Name: "init", Usage: "[-u]", Short: "install android compiler toolchain", Long: ` Init downloads and installs the Android C++ compiler toolchain. The toolchain is installed in $GOPATH/pkg/gomobile. If the Android C++ compiler toolchain already exists in the path, it skips download and uses the existing toolchain. The -u option forces download and installation of the new toolchain even when the toolchain exists. `, } var initU bool // -u func init() { cmdInit.flag.BoolVar(&initU, "u", false, "force toolchain download") } func runInit(cmd *command) error { version, err := goVersion() if err != nil { return err } gopaths := filepath.SplitList(goEnv("GOPATH")) if len(gopaths) == 0 { return fmt.Errorf("GOPATH is not set") } gomobilepath = filepath.Join(gopaths[0], "pkg/gomobile") ndkccpath = filepath.Join(gopaths[0], "pkg/gomobile/android-"+ndkVersion) verpath := filepath.Join(gopaths[0], "pkg/gomobile/version") if buildX { fmt.Fprintln(xout, "GOMOBILE="+gomobilepath) } removeGomobilepkg() if err := mkdir(ndkccpath); err != nil { return err } if buildN { tmpdir = filepath.Join(gomobilepath, "work") } else { var err error tmpdir, err = ioutil.TempDir(gomobilepath, "work-") if err != nil { return err } } if buildX { fmt.Fprintln(xout, "WORK="+tmpdir) } defer removeAll(tmpdir) goroot := goEnv("GOROOT") tmpGoroot := filepath.Join(tmpdir, "go") if err := copyGoroot(tmpGoroot, goroot); err != nil { return err } if err := fetchNDK(); err != nil { return err } if err := fetchOpenAL(); err != nil { return err } dst := filepath.Join(ndkccpath, "arm") ndkccbin := filepath.Join(dst, "bin") envpath := os.Getenv("PATH") if buildN { envpath = "$PATH" } makeScript := filepath.Join(tmpGoroot, "src/make") if goos == "windows" { makeScript += ".bat" } else { makeScript += ".bash" } bin := func(name string) string { if goos == "windows" { return name + ".exe" } return name } make := exec.Command(makeScript, "--no-clean") make.Dir = filepath.Join(tmpGoroot, "src") make.Env = []string{ `PATH=` + envpath, `GOOS=android`, `GOROOT=` + tmpGoroot, // set to override any bad os.Environ `GOARCH=arm`, `GOARM=7`, `CGO_ENABLED=1`, `CC_FOR_TARGET=` + filepath.Join(ndkccbin, bin("arm-linux-androideabi-gcc")), `CXX_FOR_TARGET=` + filepath.Join(ndkccbin, bin("arm-linux-androideabi-g++")), } if goos == "windows" { make.Env = append(make.Env, `TEMP=`+tmpdir) make.Env = append(make.Env, `TMP=`+tmpdir) make.Env = append(make.Env, `HOMEDRIVE=`+os.Getenv("HOMEDRIVE")) make.Env = append(make.Env, `HOMEPATH=`+os.Getenv("HOMEPATH")) } else { make.Env = append(make.Env, `TMPDIR=`+tmpdir) // for default the go1.4 bootstrap make.Env = append(make.Env, `HOME=`+os.Getenv("HOME")) } if v := goEnv("GOROOT_BOOTSTRAP"); v != "" { make.Env = append(make.Env, `GOROOT_BOOTSTRAP=`+v) } if buildV { fmt.Fprintf(os.Stderr, "building android/arm cross compiler\n") make.Stdout = os.Stdout make.Stderr = os.Stderr } if buildX { printcmd("%s", strings.Join(make.Env, " ")+" "+strings.Join(make.Args, " ")) } if !buildN { make.Env = environ(make.Env) if err := make.Run(); err != nil { return err } if err := checkVersionMatch(tmpGoroot, version); err != nil { return err } } // Move the Go cross compiler toolchain into GOPATH. gotoolsrc := filepath.Join(tmpGoroot, "pkg/tool", goos+"_"+goarch) tools := []string{"5l", "5g", "asm", "cgo", "nm", "old5a", "pack", "link"} for i, name := range tools { tools[i] = bin(name) } if err := move(ndkccbin, gotoolsrc, tools...); err != nil { return err } // Build toolexec command. toolexecSrc := filepath.Join(tmpdir, "toolexec.go") if !buildN { if err := ioutil.WriteFile(toolexecSrc, []byte(toolexec), 0644); err != nil { return err } } make = exec.Command("go", "build", "-o", filepath.Join(ndkccbin, bin("toolexec")), toolexecSrc) if buildV { fmt.Fprintf(os.Stderr, "building gomobile toolexec\n") make.Stdout = os.Stdout make.Stderr = os.Stderr } if buildX { printcmd("%s", strings.Join(make.Args, " ")) } if !buildN { if err := make.Run(); err != nil { return err } } // Move pre-compiled stdlib for android into GOROOT. This is // the only time we modify the user's GOROOT. cannotRemove := false if err := removeAll(filepath.Join(goroot, "pkg/android_arm")); err != nil { cannotRemove = true } if err := move(filepath.Join(goroot, "pkg"), filepath.Join(tmpGoroot, "pkg"), "android_arm"); err != nil { // Move android_arm into a temp directory that outlives // this process and give the user installation instructions. dir, err := ioutil.TempDir("", "gomobile-") if err != nil { return err } if err := move(dir, filepath.Join(tmpGoroot, "pkg"), "android_arm"); err != nil { return err } remove := "" if cannotRemove { if goos == "windows" { remove = "\trd /s /q %s\\pkg\\android_arm\n" } else { remove = "\trm -r -f %s/pkg/android_arm\n" } } return fmt.Errorf( `Cannot install android/arm in GOROOT. Make GOROOT writable (possibly by becoming the super user, using sudo) and run: %s mv %s %s`, remove, filepath.Join(dir, "android_arm"), filepath.Join(goroot, "pkg"), ) } if buildX { printcmd("go version > %s", verpath) } if !buildN { if err := ioutil.WriteFile(verpath, version, 0644); err != nil { return err } } return nil } // toolexec is the source of a small program designed to be passed to // the -toolexec flag of go build. const toolexec = `package main import ( "fmt" "os" "os/exec" "path/filepath" ) func main() { args := append([]string{}, os.Args[1:]...) args[0] = filepath.Join(os.Getenv("GOMOBILEPATH"), filepath.Base(args[0])) cmd := exec.Command(args[0], args[1:]...) cmd.Stdout = os.Stdout cmd.Stderr = os.Stderr if err := cmd.Run(); err != nil { fmt.Fprintf(os.Stderr, "%v\n", err) os.Exit(1) } } ` func removeGomobilepkg() { dir, err := os.Open(gomobilepath) if err != nil { return } names, err := dir.Readdirnames(-1) if err != nil { return } for _, name := range names { if name == "dl" { continue } removeAll(filepath.Join(gomobilepath, name)) } } func move(dst, src string, names ...string) error { for _, name := range names { srcf := filepath.Join(src, name) dstf := filepath.Join(dst, name) if buildX { printcmd("mv %s %s", srcf, dstf) } if buildN { continue } if goos == "windows" { // os.Rename fails if dstf already exists. os.Remove(dstf) } if err := os.Rename(srcf, dstf); err != nil { return err } } return nil } func mkdir(dir string) error { if buildX { printcmd("mkdir -p %s", dir) } if buildN { return nil } return os.MkdirAll(dir, 0755) } func symlink(src, dst string) error { if buildX { printcmd("ln -s %s %s", src, dst) } if buildN { return nil } if goos == "windows" { return doCopyAll(dst, src) } return os.Symlink(src, dst) } func rm(name string) error { if buildX { printcmd("rm %s", name) } if buildN { return nil } return os.Remove(name) } func goVersion() ([]byte, error) { gobin, err := exec.LookPath("go") if err != nil { return nil, fmt.Errorf(`no Go tool on $PATH`) } buildHelp, err := exec.Command(gobin, "help", "build").CombinedOutput() if err != nil { return nil, fmt.Errorf("bad Go tool: %v (%s)", err, buildHelp) } if !bytes.Contains(buildHelp, []byte("-toolexec")) { return nil, fmt.Errorf("installed Go tool does not support -toolexec") } return exec.Command(gobin, "version").Output() } // checkVersionMatch makes sure that the go command in the path matches // the GOROOT that will be used for building the cross compiler. // // This is typically not a problem when using the a release version, but // it is easy for development environments to drift, causing unexpected // errors. // // checkVersionMatch is run after the tmpGoroot is built, so the dist // command is available to call. func checkVersionMatch(tmpGoroot string, version []byte) error { if buildN { return nil } version = bytes.TrimPrefix(version, []byte("go version ")) version = bytes.Trim(version, "\n") dist := filepath.Join(tmpGoroot, "pkg/tool/"+goEnv("GOOS")+"_"+goEnv("GOARCH")+"/dist") if goos == "windows" { dist += ".exe" } cmd := exec.Command(dist, "version") cmd.Dir = tmpGoroot cmd.Env = []string{ "GOROOT=" + tmpGoroot, `PATH=` + os.Getenv("PATH"), } out, err := cmd.CombinedOutput() if err != nil { return fmt.Errorf("cannot get cmd/dist version: %v (%s)", err, out) } out = bytes.Trim(out, "\n") if !bytes.HasPrefix(version, out) { return fmt.Errorf("Go command out of sync with GOROOT. The command `go version` reports:\n\t%s\nbut the GOROOT %q is version:\n\t%s\nRebuild Go.", version, goEnv("GOROOT"), out) } return nil } func fetchOpenAL() error { url := "https://dl.google.com/go/mobile/gomobile-" + openALVersion + ".tar.gz" archive, err := fetch(url) if err != nil { return err } if err := extract("openal", archive); err != nil { return err } dst := filepath.Join(ndkccpath, "arm", "sysroot", "usr", "include") src := filepath.Join(tmpdir, "openal", "include") if err := move(dst, src, "AL"); err != nil { return err } libDst := filepath.Join(ndkccpath, "openal") libSrc := filepath.Join(tmpdir, "openal") if err := mkdir(libDst); err != nil { return nil } if err := move(libDst, libSrc, "lib"); err != nil { return err } return nil } func extract(dst, src string) error { if buildX { printcmd("tar xfz %s", src) } if buildN { return nil } tf, err := os.Open(src) if err != nil { return err } defer tf.Close() zr, err := gzip.NewReader(tf) if err != nil { return err } tr := tar.NewReader(zr) for { hdr, err := tr.Next() if err == io.EOF { break } if err != nil { return err } dst := filepath.Join(tmpdir, dst+"/"+hdr.Name) if hdr.Typeflag == tar.TypeSymlink { if err := symlink(hdr.Linkname, dst); err != nil { return err } continue } if err := os.MkdirAll(filepath.Dir(dst), 0755); err != nil { return err } f, err := os.OpenFile(dst, os.O_CREATE|os.O_EXCL|os.O_WRONLY, os.FileMode(hdr.Mode)&0777) if err != nil { return err } if _, err := io.Copy(f, tr); err != nil { return err } if err := f.Close(); err != nil { return err } } return nil } func fetchNDK() error { if useStrippedNDK { if err := fetchStrippedNDK(); err != nil { return err } } else { if err := fetchFullNDK(); err != nil { return err } } dst := filepath.Join(ndkccpath, "arm") dstSysroot := filepath.Join(dst, "sysroot/usr") if err := mkdir(dstSysroot); err != nil { return err } srcSysroot := filepath.Join(tmpdir, "android-ndk-r10d/platforms/android-15/arch-arm/usr") if err := move(dstSysroot, srcSysroot, "include", "lib"); err != nil { return err } ndkpath := filepath.Join(tmpdir, "android-ndk-r10d/toolchains/arm-linux-androideabi-4.8/prebuilt") if goos == "windows" && ndkarch == "x86" { ndkpath = filepath.Join(ndkpath, "windows") } else { ndkpath = filepath.Join(ndkpath, goos+"-"+ndkarch) } if err := move(dst, ndkpath, "bin", "lib", "libexec"); err != nil { return err } linkpath := filepath.Join(dst, "arm-linux-androideabi/bin") if err := mkdir(linkpath); err != nil { return err } for _, name := range []string{"ld", "as", "gcc", "g++"} { if goos == "windows" { name += ".exe" } if err := symlink(filepath.Join(dst, "bin", "arm-linux-androideabi-"+name), filepath.Join(linkpath, name)); err != nil { return err } } return nil } func fetchStrippedNDK() error { url := "https://dl.google.com/go/mobile/gomobile-ndk-r10d-" + goos + "-" + ndkarch + ".tar.gz" archive, err := fetch(url) if err != nil { return err } return extract("", archive) } func fetchFullNDK() error { url := "https://dl.google.com/android/ndk/android-" + ndkVersion + "-" + goos + "-" + ndkarch + "." if goos == "windows" { url += "exe" } else { url += "bin" } archive, err := fetch(url) if err != nil { return err } // The self-extracting ndk dist file for Windows terminates // with an error (error code 2 - corrupted or incomplete file) // but there are no details on what caused this. // // Strangely, if the file is launched from file browser or // unzipped with 7z.exe no error is reported. // // In general we use the stripped NDK, so this code path // is not used, and 7z.exe is not a normal dependency. var inflate *exec.Cmd if goos != "windows" { inflate = exec.Command(archive) } else { inflate = exec.Command("7z.exe", "x", archive) } inflate.Dir = tmpdir if buildX { printcmd("%s", archive) } if !buildN { out, err := inflate.CombinedOutput() if err != nil { if buildV { os.Stderr.Write(out) } return err } } return nil } // fetch reads a URL into $GOPATH/pkg/gomobile/dl and returns the path // to the downloaded file. Downloading is skipped if the file is // already present. func fetch(url string) (dst string, err error) { if err := mkdir(filepath.Join(gomobilepath, "dl")); err != nil { return "", err } if buildV { fmt.Fprintf(os.Stderr, "fetching %s\n", url) } name := path.Base(url) dst = filepath.Join(gomobilepath, "dl", name) if buildX { printcmd("curl -o%s %s", dst, url) } if buildN { return dst, nil } if _, err = os.Stat(dst); err == nil { return dst, nil } f, err := ioutil.TempFile(tmpdir, "partial-"+name) if err != nil { return "", err } defer func() { if err != nil { f.Close() os.Remove(f.Name()) } }() resp, err := http.Get(url) if err != nil { return "", err } if resp.StatusCode != http.StatusOK { err = fmt.Errorf("error fetching %v, status: %v", url, resp.Status) } else { _, err = io.Copy(f, resp.Body) } if err2 := resp.Body.Close(); err == nil { err = err2 } if err != nil { return "", err } if err = f.Close(); err != nil { return "", err } if err = os.Rename(f.Name(), dst); err != nil { return "", err } return dst, nil } // copyGoroot copies GOROOT from src to dst. // // It skips the pkg directory, which is not necessary for make.bash, // and symlinks .git to avoid a 70MB copy. func copyGoroot(dst, src string) error { if err := mkdir(filepath.Join(dst, "pkg")); err != nil { return err } for _, dir := range []string{"lib", "src"} { if err := copyAll(filepath.Join(dst, dir), filepath.Join(src, dir)); err != nil { return err } } return symlink(filepath.Join(src, ".git"), filepath.Join(dst, ".git")) } func copyAll(dst, src string) error { if buildX { printcmd("cp -a %s %s", src, dst) } if buildN { return nil } return doCopyAll(dst, src) } func doCopyAll(dst, src string) error { return filepath.Walk(src, func(path string, info os.FileInfo, errin error) (err error) { if errin != nil { return errin } prefixLen := len(src) if len(path) > prefixLen { prefixLen++ // file separator } outpath := filepath.Join(dst, path[prefixLen:]) if info.IsDir() { return os.Mkdir(outpath, 0755) } in, err := os.Open(path) if err != nil { return err } defer in.Close() out, err := os.OpenFile(outpath, os.O_CREATE|os.O_EXCL|os.O_WRONLY, info.Mode()) if err != nil { return err } defer func() { if errc := out.Close(); err == nil { err = errc } }() _, err = io.Copy(out, in) return err }) } func removeAll(path string) error { if buildX { printcmd(`rm -r -f "%s"`, path) } if buildN { return nil } // os.RemoveAll behaves differently in windows. // http://golang.org/issues/9606 if goos == "windows" { resetReadOnlyFlagAll(path) } return os.RemoveAll(path) } func resetReadOnlyFlagAll(path string) error { fi, err := os.Stat(path) if err != nil { return err } if !fi.IsDir() { return os.Chmod(path, 0666) } fd, err := os.Open(path) if err != nil { return err } defer fd.Close() names, _ := fd.Readdirnames(-1) for _, name := range names { resetReadOnlyFlagAll(path + string(filepath.Separator) + name) } return nil } func goEnv(name string) string { if val := os.Getenv(name); val != "" { return val } val, err := exec.Command("go", "env", name).Output() if err != nil { panic(err) // the Go tool was tested to work earlier } return strings.TrimSpace(string(val)) }