Go交叉编译

Go交叉编译

交叉编译是指在一个硬件平台生成另一个硬件平台的可执行文件。而Go提供了非常方便的交叉编译方式。

如何编译

Go交叉编译,涉及到几个环境变量的设置: GOARCH、GOOS和CGO_ENABLED。

  • GOARCH:编译目标平台的硬件体系架构(amd64, 386, arm, ppc64等)。
  • GOOS:编译目标平台上的操作系统(darwin, freebsd, linux, windows)。
  • CGO_ENABLED:代表是否开启CGO,1表示开启,0表示禁用。由于CGO不能支持交叉编译,所以需要禁用。

GO中env的具体环境变量的注释,可通过输入命令go help environment查看。

1
~ $ go help environment...  GOARCH    The architecture, or processor, for which to compile code.    Examples are amd64, 386, arm, ppc64....  GOOS    The operating system for which to compile code.    Examples are linux, darwin, windows, netbsd....  CGO_ENABLED    Whether the cgo command is supported. Either 0 or 1.

Mac 下编译 Linux 和 Windows 64位可执行程序

1
export CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build main.goexport CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build main.go

Linux 下编译 Mac 和 Windows 64位可执行程序

1
export CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build main.goexport CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build main.go

Windows 下编译 Mac 和 Linux 64位可执行程序

1
SET CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build main.goSET CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build main.go

其他平台或32位系统类似,这里就不再赘述。

GO是如何做到交叉编译?

Go交叉编译的实现通过在文件顶部增加构建标记,进行选择编译。

1
// +build

注:Go源码里的编译器源码位于$GOROOT/src/cmd/compile路径下,链接器源码位于$GOROOT/src/link路径下。

我们的切入点从Go编译器的main函数为入口,代码位于$GOROOT/src/cmd/compile/main.go。以环境变量GOARCH为例,看一下Go编译器是如何通过构建标记来选择对应的体系架构目标进行编译。

1
2
3
4
5
package main
// 引用了Go所能支持的所有架构体系库代码,根据GOARCH选择对应的体系代码import ( "cmd/compile/internal/amd64" "cmd/compile/internal/arm" "cmd/compile/internal/arm64" .... "cmd/compile/internal/x86"...)
// 初始化代码var archInits = map[string]func(*gc.Arch){ "386": x86.Init, "amd64": amd64.Init, "arm": arm.Init, "arm64": arm64.Init,...}
func main() { // disable timestamps for reproducible output log.SetFlags(0) log.SetPrefix("compile: ")
// 通过objabi.GOARCH选择对应的架构体系 archInit, ok := archInits[objabi.GOARCH]... gc.Main(archInit)...}

objabi.GOARCH是$GOROOT/src/cmd/internal/objabi/util.go中的变量GOARCH。

1
2
var (  defaultGOROOT string // set by linker
... GOROOT = envOr("GOROOT", defaultGOROOT) GOARCH = envOr("GOARCH", defaultGOARCH) GOOS = envOr("GOOS", defaultGOOS)...)

defaultGOARCH是runtime包里的GOARCH值,如下所示。

1
2
3
4
// Code generated by go tool dist; DO NOT EDIT.
package objabi
import "runtime"
...const defaultGOOS = runtime.GOOSconst defaultGOARCH = runtime.GOARCH...

而该值又是通过sys.GOARCH赋值。$GOROOT/src/runtime/extern.go。

1
// GOARCH is the running program's architecture target:// one of 386, amd64, arm, s390x, and so on.const GOARCH string = sys.GOARCH

终于来到了重点!$GOROOT/src/runtime/internal/sys/agoarch_amd64.go

1
2
3
4
// Code generated by gengoos.go using 'go generate'. DO NOT EDIT.
// 我的机器平台是amd64,且未对GOARCH的值做修改。因此这里的构建标签是amd64.// +build amd64
package sys
const GOARCH = `amd64`

通过构建amd64的编译标签,从而控制了Go编译时需要选择对应的架构代码。即:如果不是amd64,例如arm,那对应的编译代码就是$GOROOT/src/runtime/internal/sys/agoarch_arm.go。

如何利用交叉编译?

虽然golang 可以跨平台编译,但却无法解决系统的差异性。在靠近底层逻辑的项目中,我们需要直接调用操作系统函数,例如同样是实现IO多路服用,在darwin系统调用kqueue,而linux系统需调用epoll。

相同功能可以编写类似xxx_windows.go xxx.Linux.go文件,根据操作系统编译对应源文件,而不是在文件中用if else规划执行路径。

交叉编译同样可以理解为条件编译,通过构建的build标签,选择需要编译进最终执行二进制文件的代码。

这里给一个简单的条件编译示例,如下。

代码文件

  • go.mod
  • main.go
  • myfunc.go

main.go:程序入口,调用位于myfunc.go中的speak函数。

1
2
3
package main
import "fmt"
func main() { fmt.Println("mike") speak("hello")}

myfunc.go: 构建了build标签,需要build命令 带上-tag speak,该代码才能被编译。

1
2
3
//+build speak
package main
func speak(s string) { println("speak:", s)}

执行命令

1
$ go build -o main$ ./main

输出

1
mike

可以看到,在main函数中的speak()函数并没有被执行,因为myfunc.go没有被编译。如果需要将myfunc.go编译进最终的执行代码,则执行命令

1
$ go build -tags speak -o main$ ./main

输出

1
$ mike$ speak: hello

上述条件编译示例对你是否有启发呢?

举例:项目开发中,如果想打印程序中的某些信息以便调试,而又不想打印相关代码生成到最终的可执行文件中,那么条件编译便可派上用场。

参考链接:
https: //golang.org/cmd/go

https: /golang.org/pkg/go/build

以上内容转载自机器铃砍菜刀

-------------本文结束 感谢阅读-------------