CMakeとは|Makefileとの違いとCMakeLists.txtの書き方を最小構成から解説

この記事は約8分で読めます。

C言語のプロジェクトでビルドといえば、長らくMakefileが定番でした。自分もそうだったんですが、最近のオープンソースや開発環境を触っていると、やたらとCMakeに出会います。「CMakeLists.txtを書いてください」「ビルドはCMakeで」みたいな案内を見て、正直なところ最初は身構えました。

身構える理由はだいたい決まっていて、ビルドの仕組みがブラックボックスになりがちだからです。Makefileなら、どのソースがどうコンパイルされて、どのオプションが付いているか、ファイルを開けば追えます。ところがCMakeは「何かよく分からないものが、よく分からないMakefileを吐いている」ように見える。この得体の知れなさがハードルなんですよね。

でも、仕組みの入り口さえ押さえれば、CMakeはそこまで怖くありません。この記事ではMakefileの最小例をおさらいしてから、CMakeとは何なのか、CMakeLists.txtの最小構成とよく使うコマンド、Makefileとの使い分けを整理します。

Makefileのイメージ

まずはMakefileのおさらい(最小例)

話を分かりやすくするために、まずはMakefileの最小例です。main.cとsub.cからappという実行ファイルを作るだけのものですね。

CC = gcc
CFLAGS = -Wall -O2

app: main.o sub.o
	$(CC) -o app main.o sub.o

main.o: main.c
	$(CC) $(CFLAGS) -c main.c

sub.o: sub.c
	$(CC) $(CFLAGS) -c sub.c

clean:
	rm -f *.o app

やっていることは単純で、「ターゲット(作りたいもの)」と「依存関係(材料)」と「作り方(コマンド)」の組み合わせです。ビルドするとmakeがこのファイルを読み、依存関係を見ながら必要なコマンドだけを実行してくれます。

弱点も見えてきます。ソースファイルが増えるたびにルールを書き足すのが面倒なこと、コンパイラやOSが変わると書き直しが発生すること、そして「どのファイルがどこに依存しているか」を手で管理し続けなければいけないことです。プロジェクトが小さいうちは気にならなくても、規模が大きくなるとじわじわ効いてきます。

CMakeとは「Makefileを生成するツール」

CMakeを一言でいうと、「Makefile(や各種IDEのプロジェクトファイル)を自動生成するためのツール」です。ここが一番大事なポイントで、CMake自体がコンパイルをするわけではありません。

流れはこうなります。

  1. 人間が「CMakeLists.txt」という設定ファイルを書く
  2. CMakeがそれを読んで、環境に合ったMakefile(やNinja用のファイルなど)を生成する
  3. 実際のビルドは、生成されたMakefileをmakeが実行して行う
CMakeがMakefileを生成する流れのイメージ

つまりCMakeは、Makefileの「一段上」にいるメタツールです。CMakeLists.txtには「このプロジェクトはこういう構成です」という情報だけを書き、具体的なコンパイル手順はCMakeが環境に合わせて落とし込んでくれます。

この構造のおかげで、クロスプラットフォームに強くなります。同じCMakeLists.txtから、LinuxではMakefile、WindowsではVisual Studioのプロジェクト、といった具合に、その環境で普通に使われるビルドファイルを生成できるわけです。コンパイラの違いもCMake側が吸収してくれる部分が多く、「gccならこのオプション、MSVCならこっち」といった分岐を自分でベタ書きしなくて済みます。

もう一つ地味に効くのが、依存関係の自動検出です。Makefileではヘッダファイルへの依存を手で書いたり、依存ファイル生成の仕掛けを入れたりしていましたが、CMakeはそのあたりを標準で面倒見てくれます。

最小のCMakeLists.txtとビルド手順

では最小構成です。先ほどのMakefileと同じく、main.cとsub.cからappを作ります。

cmake_minimum_required(VERSION 3.10)
project(app C)

add_executable(app main.c sub.c)

たった3行(空行除く)です。やっていることは、

  • cmake_minimum_required:このプロジェクトが要求するCMakeの最低バージョン
  • project:プロジェクト名と言語(ここではC)の宣言
  • add_executable:どのソースから何という実行ファイルを作るか

だけ。依存関係もコンパイルコマンドも書いていませんが、これで十分にビルドできます。

ビルド手順は、プロジェクトのルートで次の2コマンドです。

cmake -S . -B build
cmake --build build

1つ目が「生成」のステップで、カレントディレクトリ(-S .)のCMakeLists.txtを読み、buildというフォルダの中にMakefile一式を生成します。ソースツリーの中に生成物が散らからない、この「アウトオブソースビルド」がCMakeの流儀です。2つ目が実際のビルドで、生成された仕組みを使ってコンパイルとリンクが行われ、build/appができあがります。

Makefile版と比べてみると、「ルールを書く」から「構成を宣言する」に変わっているのが分かると思います。ソースが増えても、add_executableの行にファイル名を足すだけです。

よく使うコマンド集

実務でよく出てくる基本コマンドを並べておきます。だいたいこの辺を押さえれば、他人のCMakeLists.txtも読めるようになります。

# 実行ファイルの定義
add_executable(app main.c sub.c)

# ライブラリの定義(.aや.soになる)
add_library(mylib STATIC lib.c)

# 実行ファイルにライブラリをリンク
target_link_libraries(app PRIVATE mylib)

# インクルードディレクトリの追加
target_include_directories(app PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include)

# コンパイルオプションの追加
target_compile_options(app PRIVATE -Wall -O2)

# コンパイル時のマクロ定義
target_compile_definitions(app PRIVATE DEBUG_MODE=1)

# C標準の指定
set(CMAKE_C_STANDARD 11)

ポイントは、最近のCMakeでは「target_〜」系のコマンドが主役だということです。昔の書き方では include_directories() のようにプロジェクト全体へ一括で設定する命令がよく使われていましたが、今は「どのターゲットに効かせるか」を明示する target_include_directories() などの書き方が推奨されています。他人のプロジェクトを読むときも、この target_ 系が軸になっていると思って間違いありません。

PRIVATE / PUBLIC / INTERFACE というキーワードも頻出します。ざっくり言うと、その設定を「自分だけに効かせるか(PRIVATE)」「リンクした相手にも伝えるか(PUBLIC)」の指定です。最初はPRIVATEで書いておき、ライブラリのヘッダが利用側にも必要な場面でPUBLICを検討する、くらいの理解で進めて大丈夫です。

Makefileとの違い・使い分け

ここまでの内容を表にまとめます。

観点MakefileCMake
役割ビルド手順そのものを記述ビルドファイルを生成する設定を記述
書く内容コマンドと依存関係プロジェクトの構成(宣言的)
クロスプラットフォームOS・コンパイラごとに書き分けが必要同じ設定から環境ごとのファイルを生成
依存関係手書き or 仕掛けが必要ヘッダ依存などを自動検出
生成物の置き場ソースと同じ場所にできがちbuildフォルダに分離(アウトオブソース)
向いている規模小規模・単純なプロジェクト中〜大規模、複数環境で使うもの

使い分けの感覚としては、手元のちょっとした検証コードや、構成が固定された小さなツールならMakefileで十分です。むしろ直接コマンドが見える分、Makefileの方が分かりやすい場面も多い。一方で、ライブラリが増える、対応OSやコンパイラが複数ある、他のプロジェクトから部品として使われる、といった条件が重なってきたらCMakeの出番です。「生成する」という一段の抽象化が、規模の大きさに効いてきます。

組み込み開発とCMakeのイメージ

組み込み開発での位置づけ

組み込みの現場でも、CMakeの存在感は年々増しています。というのも、最近の開発環境やSDKはCMakeベースのものが増えているからです。たとえばZephyr OSのビルドシステムはCMakeが土台になっていますし、ESP-IDFなど他の環境でもCMakeが採用されています。

つまり、組み込みエンジニアにとっても「CMakeはWebやアプリの世界の話」という時代ではなくなってきています。ターゲットがマイコンであっても、ホスト側のビルドの仕組みはCMake、という構成が普通になってきたわけです。クロスコンパイラを使う場合も、ツールチェインファイルという形でコンパイラやsysrootを指定し、同じ作法でビルドできるようになっています。

Zephyrについては入門記事を書いているので、実際の開発環境でCMakeがどう使われているかを見たい方は、そちらもどうぞ。

Zephyr OS入門&実践開発ロードマップ

「アプリのソースはC、ビルドの作法はCMake」という形に慣れておくと、新しいSDKを触るときの入り口がだいぶ楽になります。

まとめ

  • CMakeはコンパイラではなく、Makefileなどを「生成する」メタツール
  • 書くのは手順ではなく構成。最小構成はprojectとadd_executableが軸
  • ビルドは「cmake -S . -B build」で生成、「cmake –build build」で実行の2ステップ
  • 最近の書き方は target_ 系コマンドでターゲット単位に設定する
  • 小規模ならMakefile、中〜大規模や複数環境ならCMakeが目安
  • 組み込みでもZephyrをはじめCMakeベースの環境が増えており、覚えておいて損はない

Makefileしか知らなかった頃の自分は「また新しいツールを覚えるのか」と思っていましたが、実際に触ってみると、やっていることはMakefileで書いていた構成情報の整理でした。まずは最小構成で一度ビルドを通してみると、得体の知れなさはだいぶ薄れるはずです。

コメント

タイトルとURLをコピーしました