最近、オープンソースなどで配布されているソフトのビルドシステムがCMakeになっているのをよく見かけるようになりました。
CMakeはこれまでも何回か使ったことがありましたが、クロスコンパイルをしたいときの使い方を忘れてしまっていて、思い出すのに時間がかかったので備忘録として書いておきたいと思います。
クロスコンパイルの前にC言語のHello WorldプログラムをCMakeを使って(セルフコンパイル)ビルドしてみます。
ビルドするコード
#include <stdio.h>
int main(int argc, char **argv)
{
printf("hello world\n");
return 0;
}
CMakeLists.txt を書く
CMakeLists.txtを最小限の構成で手っ取り早く書くとこんな感じです。
cmake_minimum_required(VERSION 2.8)
add_executable(helloworld main.c)
cmake_minimum_required は文字通りcmakeのバージョンです。
add_executable でターゲット名とソースファイルを指定します。
ビルド
cmakeの便利な点として、ソースファイルのディレクトリとオブジェクトの出力ディレクトリを分けてビルドできる点があります。
CMakeLists.txt があるディレクトリで、
$ mkdir build
$ cd build
$ cmake ..
とすると、作成したbuildディレクトリ内にMakefileなどビルドに必要なファイルが生成されます。
実行例はこんな感じです。
-- The C compiler identification is GNU 5.4.0
-- The CXX compiler identification is GNU 5.4.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
$ ls
CMakeCache.txt CMakeFiles Makefile cmake_install.cmake
あとはこのbuildディレクトリでmakeコマンドを実行すればビルドできます。
私の環境だとコンパイラはGCCが使われたようです。
$ make
Scanning dependencies of target helloworld
[ 50%] Building C object CMakeFiles/helloworld.dir/main.c.o
[100%] Linking C executable helloworld
[100%] Built target helloworld
$ ./helloworld
hello world
これでCMakeによるセルフコンパイルの準備はできました。
クロスコンパイルを行う場合は、更にツールチェインファイルというファイルを作成する必要があります。
といっても大げさなものではなくて、文字通りクロスコンパイル時に使用するコンパイラの指定をするだけです。
今回はRaspberrypi でも実行できるので、クロスコンパイラとして arm-linux-gnueabihf-gcc を使ってみました。
私が試したビルド環境は64bit版の Linux mint です。
$ uname -a
Linux mint 4.4.0-21-generic #37-Ubuntu SMP Mon Apr 18 18:33:37 UTC 2016 x86_64 x86_64 x86_64 GNU/Linux
Ubuntu系のOSであればインストールは、
$sudo apt install g++-arm-linux-gnueabihf
でインストールできると思います。
ツールチェインファイルの書き方
さて、本題のツールチェインファイルは以下のようになります。
ファイル名を arm-toolchain.cmake として、以下のような記述をします。
SET(CMAKE_SYSTEM_NAME Linux)
SET(CMAKE_C_COMPILER /usr/bin/arm-linux-gnueabihf-gcc)
ツールチェインファイルを書いたら、後はセルフコンパイルの時と同様にビルド用のディレクトリを作ってcmakeコマンドを実行します。
$ mkdir cross-build
$ cd cross-build
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=../arm-toolchain.cmake
セルフコンパイルの時との違いとして、
- DCMAKE_TOOLCHAIN_FILE=../arm-toolchain.cmake
のようにツールチェインファイルのパスを指定してあげる必要があります。
-- The C compiler identification is GNU 5.4.0
-- The CXX compiler identification is GNU 5.4.0
-- Check for working C compiler: /usr/bin/arm-linux-gnueabihf-gcc
-- Check for working C compiler: /usr/bin/arm-linux-gnueabihf-gcc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Configuring done
-- Generating done
$ make
Scanning dependencies of target helloworld
[ 50%] Building C object CMakeFiles/helloworld.dir/main.c.o
[100%] Linking C executable helloworld
[100%] Built target helloworld
$ file helloworld
helloworld: ELF 32-bit LSB executable, ARM, EABI5 version 1 (SYSV), dynamically linked, interpreter /lib/ld-linux-armhf.so.3, for GNU/Linux 3.2.0, BuildID[sha1]=9bd916148cf9880f2494f47199e8c001244a450d, not stripped
ちゃんとARM用にクロスコンパイルできました。
かなりミニマムな構成でのビルドの例なので、実際にオープンソースのプロジェクトなどをビルドする際はもう少しオプションやパスの指定などが必要になってくるかと思います。
自分の雛形用として、Githubにおいています。もし参考にされる方がいらっしゃいましたらどうぞ。
gist.github.com
[2017/10/2 追記]
クロス環境向けのインクルードパスとかのプレフィックスはどうするんだろう・・・ってなったので追記しておきます。
クロス開発環境を使う際には、クロスコンパイラが使用するインクルードパス・ライブラリパスの指定が必要になってきます。
cmakeを使ってプレフィックスパスを指定する場合は、
-DCMAKE_INSTALL_PREFIX:PATH=クロス環境のプレフィックスパス
とすればよいようです。
上記の Raspberry pi の例だと、
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=../arm-toolchain.cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr/arm-linux-gnueabihf/
のような感じになります。
感想
CMakeは書き方を覚えてしまえばMakefileを直接書くよりは楽といえば楽ですね。
昔はMakeの本を読んで一生懸命Makefileを書き方を勉強したものですが、Makefileは書かないとすぐに忘れてしまいます。
Makefileを書きたくないものぐさな私は、
$ echo "gcc main.c hoge.c -o target" > build.sh
$ chmod +x build.sh
$ ./build.sh
みたいなことをよくしています。
小規模な実験的なコードを書く場合はこのやり方でもよいのですが、プロジェクトが育ってくるとやはりビルド管理したくなります。
Makefileさえ知らない新人のころのあるプロジェクトでは、
「ソースコード書いたらmfmkってコマンドを実行すればいいから」
と親切な先輩が教えくれた現場がありました。
あの便利な mkmf はLinux系のOSには標準では入っていないんですね。
依存関係とかを気にせずに特定のディレクトリのソースコード調べてMakefile生成するだけであれば簡単に作れそうに思います。気が向いたら作ってみたいです・・・
