含有CGO代码的项目如何实现跨平台编译

目前小菜刀的项目中需要用到SQLite数据库，https://github.com/mattn/go-sqlite3支持database/sql接口，采用Go的标准接口有利于项目后续扩展，因此选择了该驱动。但是，它是基于CGO实现的，所以跨平台编译会比较麻烦，小菜刀总结了一些经验，特分享给读者朋友们。

什么是跨平台编译？

简单地说，就是在一个平台上生成另一个平台上的可执行代码。这里需要注意的是，所谓平台，实际上包含两个概念：体系架构(Architecture)、操作系统 (Operating System）。同一个体系架构可以运行不同的操作系统；同样，同一个操作系统也可以在不同的体系架构上运行。

GOARCH=xxxGOOS=xxx

CGO编译存在的问题

有一点需要注意：Go所谓的跨平台编译只是针对Go代码部分，它是Go的交叉编译器（cross-compiler toolchains）。当我们使用了CGO时，要想实现跨平台编译，同时需要让C/C++代码也支持跨平台。

package main

/*
#include <stdio.h>

void printint(int v) {
    printf("printint: %d\n", v);
}
*/
import "C"

func main() {
    v := 42
    C.printint(C.int(v))
}

小菜刀的开发机器：amd64架构，darwin系统。目标编译平台：amd64架构，linux系统。现想将上述含有CGO的代码编译为目标平台的可执行文件。

$ GOOS=linux GOARCH=amd64 CGO_ENABLED=1 go build -o main main.go

通过以上命令，得到编译错误如下

/usr/local/go/pkg/tool/darwin_amd64/link: running clang failed: exit status 1
ld: warning: ignoring file /var/folders/xk/gn46n46d503dsztbc6_9qb2h0000gn/T/go-link-220081766/go.o, building for macOS-x86_64 but attempting to link with file built for unknown-unsupported file format ( 0x7F 0x45 0x4C 0x46 0x02 0x01 0x01 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x00 )
Undefined symbols for architecture x86_64:
  "_main", referenced from:
     implicit entry/start for main executable
ld: symbol(s) not found for architecture x86_64
clang: error: linker command failed with exit code 1 (use -v to see invocation)

可以看到，由于CGO的存在，跨平台编译失败。那该如何解决呢？

其实思路可以很简单：和Go一样，当我们拥有目标平台的C/C++代码翻译系统后，自然就能够编译为目标平台的可执行文件。

Mac下的可行方案

下载linux编译工具链

brew install FiloSottile/musl-cross/musl-cross

或者windows编译工具链

brew install mingw-w64

以linux编译工具链为例。在下载完毕后，/usr/local/bin下会存在以下对应平台C/C++编译器

x86_64-linux-musl-addr2line   x86_64-linux-musl-elfedit     x86_64-linux-musl-gcov        x86_64-linux-musl-objcopy
x86_64-linux-musl-ar          x86_64-linux-musl-g++         x86_64-linux-musl-gcov-dump   x86_64-linux-musl-objdump
x86_64-linux-musl-as          x86_64-linux-musl-gcc         x86_64-linux-musl-gcov-tool   x86_64-linux-musl-ranlib
x86_64-linux-musl-c++         x86_64-linux-musl-gcc-9.2.0   x86_64-linux-musl-gprof       x86_64-linux-musl-readelf
x86_64-linux-musl-c++filt     x86_64-linux-musl-gcc-ar      x86_64-linux-musl-ld          x86_64-linux-musl-size
x86_64-linux-musl-cc          x86_64-linux-musl-gcc-nm      x86_64-linux-musl-ld.bfd      x86_64-linux-musl-strings
x86_64-linux-musl-cpp         x86_64-linux-musl-gcc-ranlib  x86_64-linux-musl-nm          x86_64-linux-musl-strip

brew info musl-cross

$ brew info musl-cross
filosottile/musl-cross/musl-cross: stable 0.9.9 (bottled), HEAD
Linux cross compilers based on musl libc
https://github.com/richfelker/musl-cross-make
/usr/local/Cellar/musl-cross/0.9.9 (1,851 files, 245.8MB) *
  Poured from bottle on 2020-11-16 at 17:09:31
From: https://github.com/filosottile/homebrew-musl-cross/blob/master/musl-cross.rb
==> Dependencies
Build: gnu-sed ✔, make ✔
==> Options
--with-aarch64
    Build cross-compilers targeting arm-linux-muslaarch64
--with-arm
    Build cross-compilers targeting arm-linux-musleabi
--with-arm-hf
    Build cross-compilers targeting arm-linux-musleabihf
--with-i486
    Build cross-compilers targeting i486-linux-musl
--with-mips
    Build cross-compilers targeting mips-linux-musl
--with-mips64
    Build cross-compilers targeting mips64-linux-musl
--with-mips64el
    Build cross-compilers targeting mips64el-linux-musl
--with-mipsel
    Build cross-compilers targeting mipsel-linux-musl
--without-x86_64
    Do not build cross-compilers targeting x86_64-linux-musl
--HEAD
    Install HEAD version

/usr/local/bin/x86_64-linux-musl-gccgo env CC

$ GOOS=linux CC="/usr/local/bin/x86_64-linux-musl-gcc" GOARCH=amd64 CGO_ENABLED=1 go build -ldflags "-linkmode external -extldflags -static" main.go

最终，在本机mac系统上就编译得到了amd64 linux平台的可执行文件。

Docker解决方案

在小菜刀通过上述方式完成cgo的跨平台编译之余，找到了另外一种可行方案：基于Docker容器的xgo打包工具。

它的实现也很简单：将多平台所需要的Go工具链，C/C++交叉编译器和头文件/库都组装到Docker容器中（因此，在镜像拉取时，会下载大量的依赖资源），再借助xgo打包工具实现跨平台编译。

Docker安装（省略）
拉取镜像

docker pull karalabe/xgo-latest

打包工具安装

go get github.com/karalabe/xgo

轻量级的命令包装器，它的作用就是简化复杂的Docker命令。

跨平台编译

$GOPATH/src/workspace/example/cgoDemo2/

xgo $GOPATH/src/workspace/example/cgoDemo2/

编译之后，本目录下会存在以下各平台可执行文件

$ ls -al
total 44960
drwxr-xr-x  23 slp  staff      736 Nov 17 11:43 .
drwxr-xr-x  39 slp  staff     1248 Nov 16 17:59 ..
-rwxr-xr-x   1 slp  staff  1761872 Nov 17 11:42 cgoDemo2-android-16-386
drwxr-xr-x   5 slp  staff      160 Nov 17 11:42 cgoDemo2-android-16-aar
-rwxr-xr-x   1 slp  staff  1778464 Nov 17 11:42 cgoDemo2-android-16-arm
-rwxr-xr-x   1 slp  staff   902436 Nov 17 11:43 cgoDemo2-darwin-10.6-386
-rwxr-xr-x   1 slp  staff  1053816 Nov 17 11:43 cgoDemo2-darwin-10.6-amd64
-rwxr-xr-x   1 slp  staff  1065232 Nov 17 11:43 cgoDemo2-ios-5.0-arm64
-rwxr-xr-x   1 slp  staff   978016 Nov 17 11:43 cgoDemo2-ios-5.0-armv7
drwxrwxrwx   3 slp  staff       96 Nov 17 11:43 cgoDemo2-ios-5.0-framework
-rwxr-xr-x   1 slp  staff  1084208 Nov 17 11:42 cgoDemo2-linux-386
-rwxr-xr-x   1 slp  staff  1226072 Nov 17 11:42 cgoDemo2-linux-amd64
-rwxr-xr-x   1 slp  staff  1093728 Nov 17 11:42 cgoDemo2-linux-arm-5
-rwxr-xr-x   1 slp  staff  1074348 Nov 17 11:43 cgoDemo2-linux-arm-6
-rwxr-xr-x   1 slp  staff  1073800 Nov 17 11:43 cgoDemo2-linux-arm-7
-rwxr-xr-x   1 slp  staff  1196520 Nov 17 11:43 cgoDemo2-linux-arm64
-rwxr-xr-x   1 slp  staff  1152088 Nov 17 11:43 cgoDemo2-linux-mips
-rwxr-xr-x   1 slp  staff  1274272 Nov 17 11:43 cgoDemo2-linux-mips64
-rwxr-xr-x   1 slp  staff  1271464 Nov 17 11:43 cgoDemo2-linux-mips64le
-rwxr-xr-x   1 slp  staff  1148892 Nov 17 11:43 cgoDemo2-linux-mipsle
-rwxr-xr-x   1 slp  staff  1712214 Nov 17 11:43 cgoDemo2-windows-4.0-386.exe
-rwxr-xr-x   1 slp  staff  2115121 Nov 17 11:43 cgoDemo2-windows-4.0-amd64.exe
-rw-r--r--   1 slp  staff      157 Nov 16 16:51 main.go

--targets--targets=windows/amd64,linux/amd64

$ xgo --targets=windows/amd64,linux/amd64 $GOPATH/src/workspace/example/cgoDemo2/

目前支持的平台列表如下

androiddarwinioslinuxwindows386amd64arm-5arm-6arm-7arm64mipsmipslemips64mips64le

$ xgo -h

含有CGO代码的项目如何实现跨平台编译

什么是跨平台编译？

CGO编译存在的问题

Mac下的可行方案

Docker解决方案

参考链接