xmake從入門到精通9：交叉編譯詳解

xmake是一個基於Lua的輕量級現代化c/c 的項目構建工具，主要特點是：語法簡單易上手，提供更加可讀的項目維護，實現跨平臺行爲一致的構建體驗。

除了win, linux, macOS平臺，以及android, ios等移動端平臺的內建構建支持，xmake也支持對各種其他工具鏈的交叉編譯支持，本文我們將會詳細介紹下如何使用xmake進行交叉編譯。

交叉編譯工具鏈簡介

通常，如果我們需要在當前pc環境編譯生成其他設備上才能運行的目標文件時候，就需要通過對應的交叉編譯工具鏈來編譯生成它們，比如在win/macos上編譯linux的程序，或者在linux上編譯其他嵌入式設備的目標文件等。

通常的交叉編譯工具鏈都是基於gcc/clang的，大都具有類似如下的結構：

/home/toolchains_sdkdir
   - bin
       - arm-linux-armeabi-gcc
       - arm-linux-armeabi-ld
       - ...
   - lib
       - libxxx.a
   - include
       - xxx.h

每個工具鏈都有對應的include/lib目錄，用於放置一些系統庫和頭文件，例如libc, stdc 等，而bin目錄下放置的就是編譯工具鏈一系列工具。例如：

arm-linux-armeabi-ar
arm-linux-armeabi-as
arm-linux-armeabi-c  
arm-linux-armeabi-cpp
arm-linux-armeabi-g  
arm-linux-armeabi-gcc
arm-linux-armeabi-ld
arm-linux-armeabi-nm
arm-linux-armeabi-strip

其中arm-linux-armeabi-前綴就是cross，通過用來標示目標平臺和架構，主要用於跟主機自身的gcc/clang進行區分。

裏面的gcc/g 就是c/c 的編譯器，通常也可以作爲鏈接器使用，鏈接的時候內部會去調用ld來鏈接，並且自動追加一些c 庫。cpp是預處理器，as是彙編器，ar用於生成靜態庫，strip用於裁剪掉一些符號信息，使得目標程序會更加的小。nm用於查看導出符號列表。

自動探測和編譯

如果我們的交叉編譯工具鏈是上文的結構，xmake會自動檢測識別這個sdk的結構，提取裏面的cross，以及include/lib路徑位置，用戶通常不需要做額外的參數設置，只需要配置好sdk根目錄就可以編譯了，例如：

$ xmake f -p cross --sdk=/home/toolchains_sdkdir
$ xmake

其中，-p cross用於指定當前的平臺是交叉編譯平臺，--sdk=用於指定交叉工具鏈的根目錄。

注：我們也可以指定-p linux平臺來配置交叉編譯，效果是一樣的，唯一的區別是額外標識了linux平臺名，方便xmake.lua裏面通過is_plat("linux")來判斷平臺。

這個時候，xmake會去自動探測gcc等編譯器的前綴名cross：arm-linux-armeabi-，並且編譯的時候，也會自動加上鏈接庫和頭文件的搜索選項，例如：

-I/home/toolchains_sdkdir/include 
-L/home/toolchains_sdkdir/lib

這些都是xmake自動處理的，不需要手動配置他們。

手動配置編譯

如果上面的自動檢測對某些工具鏈，還無法完全通過編譯，就需要用戶自己手動設置一些交叉編譯相關的配置參數，來調整適應這些特殊的工具鏈了，下面我會逐一講解如何配置。

設置工具鏈bin目錄

對於不規則工具鏈目錄結構，靠單純地--sdk選項設置，沒法完全檢測通過的情況下，可以通過這個選項繼續附加設置工具鏈的bin目錄位置。

例如：一些特殊的交叉工具鏈的，編譯器bin目錄，並不在 /home/toolchains_sdkdir/bin 這個位置，而是獨立到了 /usr/opt/bin

這個時候，我們可以在設置了sdk參數的基礎上追加bin目錄的參數設置，來調整工具鏈的bin目錄。

$ xmake f -p linux --sdk=/home/toolchains_sdkdir --bin=/usr/opt/bin
$ xmake

設置交叉工具鏈工具前綴

像aarch64-linux-android-這種，通常如果你配置了--sdk或者--bin的情況下，xmake會去自動檢測的，不需要自己手動設置。

但是對於一些極特殊的工具鏈，一個目錄下同時有多個cross前綴的工具bin混在一起的情況，你需要手動設置這個配置，來區分到底需要選用哪個bin。

例如，toolchains的bin目錄下同時存在兩個不同的編譯器：

/opt/bin
  - armv7-linux-gcc 
  - aarch64-linux-gcc

我們現在想要選用armv7的版本，那麼我們可以追加--cross=配置編譯工具前綴名，例如：

$ xmake f -p linux --sdk=/usr/toolsdk --bin=/opt/bin --cross=armv7-linux-

設置c/c 編譯器

如果還要繼續細分選擇編譯器，則繼續追加相關編譯器選項，例如：

$ xmake f -p linux --sdk=/user/toolsdk --cc=armv7-linux-clang --cxx=armv7-linux-clang

當然，我們也可以指定編譯器全路徑。

--cc用於指定c編譯器名，--cxx用於指定c 編譯器名。

注：如果存在CC/CXX環境變量的話，會優先使用當前環境變量中指定的值。

如果指定的編譯器名不是那些xmake內置可識別的名字（帶有gcc, clang等字樣），那麼編譯器工具檢測就會失敗。

這個時候我們可以通過：

xmake f --cxx=clang  @/home/xxx/c  mips.exe

設置c mips.exe編譯器作爲類clang 的使用方式來編譯。

也就是說，在指定編譯器爲c mips.exe的同時，告訴xmake，它跟clang 用法和參數選項基本相同。

設置c/c 連接器

如果還要繼續細分選擇鏈接器，則繼續追加相關鏈接器選項，例如：

$ xmake f -p linux --sdk=/user/toolsdk --ld=armv7-linux-clang   --sh=armv7-linux-clang   --ar=armv7-linux-ar

ld指定可執行程序鏈接器，sh指定共享庫程序鏈接器，ar指定生成靜態庫的歸檔器。

注：如果存在LD/SH/AR環境變量的話，會優先使用當前環境變量中指定的值。

設置頭文件和庫搜索目錄

如果sdk裏面還有額外的其他include/lib目錄不在標準的結構中，導致交叉編譯找不到庫和頭文件，那麼我們可以通過--includedirs和--linkdirs來追加搜索路徑，然後通過--links添加額外的鏈接庫。

$ xmake f -p linux --sdk=/usr/toolsdk --includedirs=/usr/toolsdk/xxx/include --linkdirs=/usr/toolsdk/xxx/lib --links=pthread

注：如果要指定多個搜索目錄，可以通過:或者;來分割，也就是不同主機平臺的路徑分隔符，linux/macos下用:，win下用;。

設置編譯和鏈接選項

我們也可以根據實際情況通過--cflags, --cxxflags，--ldflags，--shflags和--arflags額外配置一些編譯和鏈接選項。

cflags: 指定c編譯參數
cxxflags：指定c 編譯參數
cxflags: 指定c/c 編譯參數
asflags: 指定彙編器編譯參數
ldflags: 指定可執行程序鏈接參數
shflags: 指定動態庫程序鏈接參數
arflags: 指定靜態庫的生成參數

例如：

$ xmake f -p linux --sdk=/usr/toolsdk --cflags="-DTEST -I/xxx/xxx" --ldflags="-lpthread"

mingw工具鏈

使用mingw工具鏈編譯，其實也是交叉編譯，但是由於這個比較常用，xmake專門增加了一個mingw的平臺來快速處理使用mingw工具鏈的編譯。

因此，xmake對mingw的工具鏈檢測會更加完善，在macos下，基本上連sdk路徑都不需要配置，也能直接檢測到，只需要切到mingw平臺編譯即可。

$ xmake f -p mingw
$ xmake -v
configure
{
    ld = /usr/local/opt/mingw-w64/bin/x86_64-w64-mingw32-g  
    ndk_stdcxx = true
    plat = mingw
    mingw = /usr/local/opt/mingw-w64
    buildir = build
    arch = x86_64
    xcode = /Applications/Xcode.app
    mode = release
    cxx = /usr/local/opt/mingw-w64/bin/x86_64-w64-mingw32-gcc
    cross = x86_64-w64-mingw32-
    theme = default
    kind = static
    ccache = true
    host = macosx
    clean = true
    bin = /usr/local/opt/mingw-w64/bin
}
[  0%]: ccache compiling.release src/main.cpp
/usr/local/bin/ccache /usr/local/opt/mingw-w64/bin/x86_64-w64-mingw32-gcc -c -fvisibility=hidden -O3 -m64 -o build/.objs/test/mingw/x86_64/release/src/main.cpp.obj src/main.cpp
[100%]: linking.release test.exe
/usr/local/opt/mingw-w64/bin/x86_64-w64-mingw32-g   -o build/mingw/x86_64/release/test.exe build/.objs/test/mingw/x86_64/release/src/main.cpp.obj -s -fvisibility=hidden -m64
build ok!

這裏我們追加了-v參數，看了下詳細的編譯命令和檢測到的mingw工具鏈配置值，其中cross被自動檢測爲：x86_64-w64-mingw32-，bin目錄也被自動檢測到了，還有編譯器和鏈接器也是。

儘管在linux/win上還沒法自動檢測到sdk路徑，我們也可以手動指定sdk路徑，需要注意的是，xmake爲mingw專門提供了一個--mingw=參數用來指定mingw的工具鏈根目錄，其效果跟--sdk=是一樣的，但是它可以作爲全局配置被設置。

$ xmake g --mingw=/home/mingwsdk
$ xmake f -p mingw
$ xmake

我們通過xmake g/global命令設置--mingw根目錄到全局配置後，之後每次編譯和切換編譯平臺，就不用額外指定mingw工具鏈路徑了，方便使用。

另外，其他的工具鏈配置參數用法，跟上文描述的沒什麼區別，像--cross, --bin=等都可以根據實際的環境需要，自己控制是否需要額外追加配置來適配自己的mingw工具鏈。

項目描述設置

set_toolchain

如果覺得每次通過命令行配置比較繁瑣，有些配置可以通過在xmake.lua預先配置好，來簡化命令配置，比如編譯器的指定，就可以通過set_toolchain來對每個target單獨設置。

target("test")
    set_kind("binary")
    set_toolchain("cxx", "clang")
    set_toolchain("ld", "clang  ")

強制test目標的編譯器和鏈接器使用clang編譯器，或者指定交叉編譯工具鏈中的編譯器名或者路徑。

set_config

我們也可以通過set_config來設置在xmake f/config命令中的每個配置參數的默認值，這是個全局api，對每個target都會生效。

set_config("cflags", "-DTEST")
set_config("sdk", "/home/xxx/tooksdk")
set_config("cc", "gcc")
set_config("ld", "g  ")

不過，我們還是可以通過xmake f --name=value的方式，去修改xmake.lua中的默認配置。

自定義編譯平臺

如果某個交叉工具鏈編譯後目標程序有對應的平臺需要指定，並且需要在xmake.lua裏面根據不同的交叉編譯平臺，還需要配置一些額外的編譯參數，那麼上文的-p cross設置就不能滿足需求了。

其實，-p/--plat=參數也可以設置爲其他自定義的值，只需要跟is_plat保持對應關係就可以，所有非內置平臺名，都會默認採用交叉編譯模式，例如：

$ xmake f -p myplat --sdk=/usr/local/arm-xxx-gcc/
$ xmake

我們傳入了myplat自定義平臺名，作爲當前交叉工具鏈的編譯平臺，然後xmake.lua裏面我們對這個平臺，配置下對應的設置：

if is_plat("myplat") then
    add_defines("TEST")
end

通過這種方式，xmake就可以很方便的擴展處理各種編譯平臺，用戶可以自己擴展支持freebsd, netbsd, sunos等其他各種平臺的交叉編譯。

我摘錄一段之前移植libuv寫的交叉編譯的配置，直觀感受下：

-- for gragonfly/freebsd/netbsd/openbsd platform
if is_plat("gragonfly", "freebsd", "netbsd", "openbsd") then
    add_files("src/unix/bsd-ifaddrs.c")
    add_files("src/unix/freebsd.c")
    add_files("src/unix/kqueue.c")
    add_files("src/unix/posix-hrtime.c")
    add_headerfiles("(include/uv-bsd.h)")
end 

-- for sunos platform
if is_plat("sunos") then
     add_files("src/unix/no-proctitle.c")
    add_files("src/unix/sunos.c")
    add_defines("__EXTENSIONS_", "_XOPEN_SOURCE=600")
    add_headerfiles("(include/uv-sunos.h)")
end

然後，我們就可以切換這些平臺來編譯：

$ xmake f -p [gragonfly|freebsd|netbsd|openbsd|sunos] --sdk=/home/arm-xxx-gcc/
$ xmake

另外，內置的linux平臺也是支持交叉編譯的哦，如果不想配置其他平臺名，統一作爲linux平臺來交叉編譯，也是可以的。

$ xmake f -p linux --sdk=/usr/local/arm-xxx-gcc/
$ xmake

只要設置了--sdk=等參數，就會啓用linux平臺的交叉編譯模式。

個人主頁

個人項目

xmake從入門到精通9：交叉編譯詳解

交叉編譯工具鏈簡介

自動探測和編譯

手動配置編譯

設置工具鏈bin目錄

設置交叉工具鏈工具前綴

設置c/c 編譯器

設置c/c 連接器

設置頭文件和庫搜索目錄

設置編譯和鏈接選項

mingw工具鏈

項目描述設置

set_toolchain

set_config

自定義編譯平臺

Xmake v2.8.7 發佈，新增 cosmocc 工具鏈支持，一次編譯到處運行

Xmake v2.8.6 發佈，新的打包插件：XPack

Xmake v2.8.5 發佈，支持鏈接排序和單元測試

Xmake v2.8.3 發佈，改進 Wasm 並支持 Xmake 源碼調試

Xmake v2.8.1 發佈，大量細節特性改進

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結