The seq serialization machinery is a historic artifact from when Go mobile code had to run in a separate process. Now that Go code is running in-process, replace the explicit serialization with direct calls and pass arguments on the stack. The benefits are a much smaller bind runtime, much less garbage (and, in Java, fewer objects with finalizers), less argument copying, and faster cross-language calls. The cost is a more complex generator, because some of the work from the bind runtime is moved to generated code. Generated code now handles conversion between Go and Java/ObjC types, multiple return values and memory management of byte slice and string arguments. To overcome the lack of calling C code between Go packages, all bound packages now end up in the same (fake) package, "gomobile_bind", instead of separate packages (go_<pkgname>). To avoid name clashes, the package name is added as a prefix to generated functions and types. Also, don't copy byte arrays passed to Go, saving call time and allowing read([]byte)-style interfaces to foreign callers (#12113). Finally, add support for nil interfaces and struct pointers to objc. This is a large CL, but most of the changes stem from changing testdata. The full benchcmp output on the CL/20095 benchmarks on my Nexus 5 is reproduced below. Note that the savings for the JavaSlice* benchmarks are skewed because byte slices are no longer copied before passing them to Go. benchmark old ns/op new ns/op delta BenchmarkJavaEmpty 26.0 19.0 -26.92% BenchmarkJavaEmptyDirect 23.0 22.0 -4.35% BenchmarkJavaNoargs 7685 2339 -69.56% BenchmarkJavaNoargsDirect 17405 8041 -53.80% BenchmarkJavaOnearg 26887 2366 -91.20% BenchmarkJavaOneargDirect 34266 7910 -76.92% BenchmarkJavaOneret 38325 2245 -94.14% BenchmarkJavaOneretDirect 46265 7708 -83.34% BenchmarkJavaManyargs 41720 2535 -93.92% BenchmarkJavaManyargsDirect 51026 8373 -83.59% BenchmarkJavaRefjava 38139 21260 -44.26% BenchmarkJavaRefjavaDirect 42706 28150 -34.08% BenchmarkJavaRefgo 34403 6843 -80.11% BenchmarkJavaRefgoDirect 40193 16582 -58.74% BenchmarkJavaStringShort 32366 9323 -71.20% BenchmarkJavaStringShortDirect 41973 19118 -54.45% BenchmarkJavaStringLong 127879 94420 -26.16% BenchmarkJavaStringLongDirect 133776 114760 -14.21% BenchmarkJavaStringShortUnicode 32562 9221 -71.68% BenchmarkJavaStringShortUnicodeDirect 41464 19094 -53.95% BenchmarkJavaStringLongUnicode 131015 89401 -31.76% BenchmarkJavaStringLongUnicodeDirect 134130 90786 -32.31% BenchmarkJavaSliceShort 42462 7538 -82.25% BenchmarkJavaSliceShortDirect 52940 17017 -67.86% BenchmarkJavaSliceLong 138391 8466 -93.88% BenchmarkJavaSliceLongDirect 205804 15666 -92.39% BenchmarkGoEmpty 3.00 3.00 +0.00% BenchmarkGoEmptyDirect 3.00 3.00 +0.00% BenchmarkGoNoarg 40342 13716 -66.00% BenchmarkGoNoargDirect 46691 13569 -70.94% BenchmarkGoOnearg 43529 13757 -68.40% BenchmarkGoOneargDirect 44867 14078 -68.62% BenchmarkGoOneret 45456 13559 -70.17% BenchmarkGoOneretDirect 44694 13442 -69.92% BenchmarkGoRefjava 55111 28071 -49.06% BenchmarkGoRefjavaDirect 60883 26872 -55.86% BenchmarkGoRefgo 57038 29223 -48.77% BenchmarkGoRefgoDirect 56153 27812 -50.47% BenchmarkGoManyargs 67967 17398 -74.40% BenchmarkGoManyargsDirect 60617 16998 -71.96% BenchmarkGoStringShort 57538 22600 -60.72% BenchmarkGoStringShortDirect 52627 22704 -56.86% BenchmarkGoStringLong 128485 52530 -59.12% BenchmarkGoStringLongDirect 138377 52079 -62.36% BenchmarkGoStringShortUnicode 57062 22994 -59.70% BenchmarkGoStringShortUnicodeDirect 62563 22938 -63.34% BenchmarkGoStringLongUnicode 139913 55553 -60.29% BenchmarkGoStringLongUnicodeDirect 150863 57791 -61.69% BenchmarkGoSliceShort 59279 20215 -65.90% BenchmarkGoSliceShortDirect 60160 21136 -64.87% BenchmarkGoSliceLong 411225 301870 -26.59% BenchmarkGoSliceLongDirect 399029 298915 -25.09% Fixes golang/go#12619 Fixes golang/go#12113 Fixes golang/go#13033 Change-Id: I2b45e9e98a1248e3c23a5137f775f7364908bec7 Reviewed-on: https://go-review.googlesource.com/19821 Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
209 lines
4.9 KiB
Go
209 lines
4.9 KiB
Go
// 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
|
|
|
|
import (
|
|
"fmt"
|
|
"go/build"
|
|
"io"
|
|
"io/ioutil"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"strings"
|
|
"text/template"
|
|
)
|
|
|
|
func goIOSBind(pkgs []*build.Package) error {
|
|
typesPkgs, err := loadExportData(pkgs, darwinArmEnv)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
binder, err := newBinder(typesPkgs)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
name := binder.pkgs[0].Name()
|
|
title := strings.Title(name)
|
|
|
|
if buildO != "" && !strings.HasSuffix(buildO, ".framework") {
|
|
return fmt.Errorf("static framework name %q missing .framework suffix", buildO)
|
|
}
|
|
if buildO == "" {
|
|
buildO = title + ".framework"
|
|
}
|
|
|
|
srcDir := filepath.Join(tmpdir, "src", "gomobile_bind")
|
|
for _, pkg := range typesPkgs {
|
|
if err := binder.GenGo(pkg, srcDir); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
mainFile := filepath.Join(tmpdir, "src/iosbin/main.go")
|
|
err = writeFile(mainFile, func(w io.Writer) error {
|
|
_, err := w.Write(iosBindFile)
|
|
return err
|
|
})
|
|
if err != nil {
|
|
return fmt.Errorf("failed to create the binding package for iOS: %v", err)
|
|
}
|
|
|
|
fileBases := make([]string, len(typesPkgs))
|
|
for i, pkg := range typesPkgs {
|
|
if fileBases[i], err = binder.GenObjc(pkg, srcDir); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
if err := binder.GenObjcSupport(srcDir); err != nil {
|
|
return err
|
|
}
|
|
if err := binder.GenGoSupport(srcDir); err != nil {
|
|
return err
|
|
}
|
|
|
|
cmd := exec.Command("xcrun", "lipo", "-create")
|
|
|
|
for _, env := range [][]string{darwinArmEnv, darwinArm64Env, darwinAmd64Env} {
|
|
arch := archClang(getenv(env, "GOARCH"))
|
|
path, err := goIOSBindArchive(name, mainFile, env, fileBases)
|
|
if err != nil {
|
|
return fmt.Errorf("darwin-%s: %v", arch, err)
|
|
}
|
|
cmd.Args = append(cmd.Args, "-arch", arch, path)
|
|
}
|
|
|
|
// Build static framework output directory.
|
|
if err := removeAll(buildO); err != nil {
|
|
return err
|
|
}
|
|
headers := buildO + "/Versions/A/Headers"
|
|
if err := mkdir(headers); err != nil {
|
|
return err
|
|
}
|
|
if err := symlink("A", buildO+"/Versions/Current"); err != nil {
|
|
return err
|
|
}
|
|
if err := symlink("Versions/Current/Headers", buildO+"/Headers"); err != nil {
|
|
return err
|
|
}
|
|
if err := symlink("Versions/Current/"+title, buildO+"/"+title); err != nil {
|
|
return err
|
|
}
|
|
|
|
cmd.Args = append(cmd.Args, "-o", buildO+"/Versions/A/"+title)
|
|
if err := runCmd(cmd); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Copy header file next to output archive.
|
|
headerFiles := make([]string, len(fileBases))
|
|
if len(fileBases) == 1 {
|
|
headerFiles[0] = title + ".h"
|
|
err = copyFile(
|
|
headers+"/"+title+".h",
|
|
srcDir+"/"+bindPrefix+title+".h",
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
} else {
|
|
for i, fileBase := range fileBases {
|
|
headerFiles[i] = fileBase + ".h"
|
|
err = copyFile(
|
|
headers+"/"+fileBase+".h",
|
|
srcDir+"/"+fileBase+".h")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
headerFiles = append(headerFiles, title+".h")
|
|
err = writeFile(headers+"/"+title+".h", func(w io.Writer) error {
|
|
return iosBindHeaderTmpl.Execute(w, map[string]interface{}{
|
|
"pkgs": pkgs, "title": title, "bases": fileBases,
|
|
})
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
resources := buildO + "/Versions/A/Resources"
|
|
if err := mkdir(resources); err != nil {
|
|
return err
|
|
}
|
|
if err := symlink("Versions/Current/Resources", buildO+"/Resources"); err != nil {
|
|
return err
|
|
}
|
|
if err := ioutil.WriteFile(buildO+"/Resources/Info.plist", []byte(iosBindInfoPlist), 0666); err != nil {
|
|
return err
|
|
}
|
|
|
|
var mmVals = struct {
|
|
Module string
|
|
Headers []string
|
|
}{
|
|
Module: title,
|
|
Headers: headerFiles,
|
|
}
|
|
err = writeFile(buildO+"/Versions/A/Modules/module.modulemap", func(w io.Writer) error {
|
|
return iosModuleMapTmpl.Execute(w, mmVals)
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return symlink("Versions/Current/Modules", buildO+"/Modules")
|
|
}
|
|
|
|
const iosBindInfoPlist = `<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
|
<plist version="1.0">
|
|
<dict>
|
|
</dict>
|
|
</plist>
|
|
`
|
|
|
|
var iosModuleMapTmpl = template.Must(template.New("iosmmap").Parse(`framework module "{{.Module}}" {
|
|
{{range .Headers}} header "{{.}}"
|
|
{{end}}
|
|
export *
|
|
}`))
|
|
|
|
func goIOSBindArchive(name, path string, env, fileBases []string) (string, error) {
|
|
arch := getenv(env, "GOARCH")
|
|
archive := filepath.Join(tmpdir, name+"-"+arch+".a")
|
|
err := goBuild(path, env, "-buildmode=c-archive", "-tags=ios", "-o", archive)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
return archive, nil
|
|
}
|
|
|
|
var iosBindFile = []byte(`
|
|
package main
|
|
|
|
import (
|
|
_ "../gomobile_bind"
|
|
)
|
|
|
|
import "C"
|
|
|
|
func main() {}
|
|
`)
|
|
|
|
var iosBindHeaderTmpl = template.Must(template.New("ios.h").Parse(`
|
|
// Objective-C API for talking to the following Go packages
|
|
//
|
|
{{range .pkgs}}// {{.ImportPath}}
|
|
{{end}}//
|
|
// File is generated by gomobile bind. Do not edit.
|
|
#ifndef __{{.title}}_H__
|
|
#define __{{.title}}_H__
|
|
|
|
{{range .bases}}#include "{{.}}.h"
|
|
{{end}}
|
|
#endif
|
|
`))
|