コグノスケ

linux-next が久しぶりに更新された

ここしばらく更新されていなかった linux-next が約 10日ぶりに更新（9/4 の次が 9/15）されたので、喜んで git fetch して Tinker Board のカーネルを書き換えたところ、ウンともスンとも言わなくなってしまいました。

質の悪いことにエラーメッセージも何も出さずにハングアップするため、起動しなくなった原因がさっぱりわかりません。

仕方ないので頑張って git bisect し、起動しなくなった原因のコミットを見つけましたが、実は 9/17 に LKML にて既に指摘済みで、直し方まで検討されていました（LKML へのリンク）。今までの苦労は何だったのか。

結果だけ見ると、最初に LKML のメールスレッドに気づいていれば bisect なんて不要でした。しかし、一切エラーメッセージを出さずにハングするので、検索のヒントがありません。ノーヒントで LKML の当該メールスレッドを探せたか？と考えてみると、ちょっと難しい気がします。

いわゆる鶏と卵の問題ですね……。

今まで知らなかった make の挙動

シェルから make に渡す環境変数と make 変数の関係を知らなくて、かなりハマったのでメモしておきます。

まず、どういう関係か説明します。下記のような Makefile を 2つ用意します。

$ tree
.
|-- Makefile
`-- sub
    `-- Makefile

VAR_A = aaa
VAR_B = bbb

all:
	@echo "In parent"
	@echo "VAR_A: '$(VAR_A)'"
	@echo "VAR_B: '$(VAR_B)'"
	@echo "VAR_C: '$(VAR_C)'"
	make -C sub

all:
	@echo "In sub"
	@echo "VAR_A: '$(VAR_A)'"
	@echo "VAR_B: '$(VAR_B)'"
	@echo "VAR_C: '$(VAR_C)'"

親 Makefile は変数 VAR_A, VAR_B を書き換え、子 sub/Makefile を再帰的に呼び出します。各 Makefile では変数の値を表示しています。

では、トップディレクトリにて make を実行してみましょう。

$ make
In parent
VAR_A: 'aaa'    ★VAR_A は設定した値になっている★
VAR_B: 'bbb'    ★VAR_B は設定した値になっている★
VAR_C: ''       ★VAR_C は特に書き換えていないので空★
make -C sub
make[1]: Entering directory '/home/katsuhiro/share/falcon/projects/c/makefile_env_var/sub'
In sub
VAR_A: ''    ★VAR_A は渡されない★
VAR_B: ''    ★VAR_B は渡されない★
VAR_C: ''    ★VAR_C は渡されない★
make[1]: Leaving directory '/home/katsuhiro/share/falcon/projects/c/makefile_env_var/sub'

ご覧の通り、親の Makefile で値を設定した VAR_A や VAR_B といった変数は、子の sub/Makefile に「引き継がれません」。

make 変数の渡し方

外部から make に変数を渡すには、下記の 2つの方法があります。

• 環境変数として渡す方法。例: VAR_A=A make
• make に渡す方法。例: make VAR_A=A

私は今まで、この 2つの渡し方に何も差はないと思っていたのですが、実は全く動きが違いました。

環境変数の場合

下記のように VAR_A, VAR_C を環境変数として与えると、子 Makefile 側の結果がかなり変わります。

$ VAR_A=A VAR_C=C make
In parent
VAR_A: 'aaa'    ★VAR_A は親が設定した値になる★
VAR_B: 'bbb'
VAR_C: 'C'      ★VAR_C は特に書き換えていないので、渡された値のまま★
make -C sub
make[1]: Entering directory '/home/katsuhiro/share/falcon/projects/c/makefile_env_var/sub'
In sub
VAR_A: 'aaa'    ★VAR_A が渡される、A ではなく親が設定した値 aaa になっている★
VAR_B: ''
VAR_C: 'C'      ★VAR_C が渡される、値は変わらず★
make[1]: Leaving directory '/home/katsuhiro/share/falcon/projects/c/makefile_env_var/sub'

何も渡さなかった場合の実行結果と異なり、子の sub/Makefile にも VAR_A, VAR_C が渡されます。もし、親 Makefile が変数の値を書き換えた場合は、書き換えた値が子 Makefile に渡されます。

この動作は知りませんでした。特に子プロセスへの変数の渡し方が変わる点が衝撃的です。

make に渡す場合

下記のように VAR_A, VAR_C を make に渡すと、環境変数として渡す場合とは違う結果になります。

$ make VAR_A=A VAR_C=C
In parent
VAR_A: 'A'      ★VAR_A は親が設定した値にならない★
VAR_B: 'bbb'
VAR_C: 'C'
make -C sub
make[1]: Entering directory '/home/katsuhiro/share/falcon/projects/c/makefile_env_var/sub'
In sub
VAR_A: 'A'      ★VAR_A が渡される、VAR_A は親が設定した値にならない★
VAR_B: ''
VAR_C: 'C'      ★VAR_C が渡される、値は変わらず★
make[1]: Leaving directory '/home/katsuhiro/share/falcon/projects/c/makefile_env_var/sub'

環境変数で渡した場合と同様に、子 Makefile に変数の内容が渡されます。その点は同じです。しかし、親 Makefile で行っている aaa という値の代入が無効化され、渡される値が全く違います。

この動作も知りませんでした……。私は Makefile や make とは長い付き合いですし、動きも何となくわかっていた気分になっていましたが、勘違いだったようです。make は難しすぎます。

ハマったポイント

この動きによって、何が困ったかを紹介しておきます。同じ状況に陥る人は、まずもっていないと思いますけど、ご参考まで。

現象としては「make でビルドすると成功するが、debuild（Debian のパッケージング作成スクリプト）経由でビルドすると失敗する」です。この現象から原因が予想できた人、あなたは凄い（少なくとも私より凄い）です！この先は読む必要はございません。

下記のような感じの、ちょっと変わった Makefile を使っているソフトウェアをビルドしていました。

• 親 Makefile から、子の ./configure を呼ぶ
• 親 Makefile は CFLAGS や LDFLAGS を固定値に設定している（固有のライブラリをリンクするため）

もう一つ大事な点は、親 Makefile が使っている LDFLAGS を、子 ./configure に渡すと「そんなライブラリはないというエラー」になってしまう欠点があることです。

じゃあビルドエラーが起きるのか？というとそうではなく、先ほどご紹介した通り、何も指定せずに make を起動すれば、親 Makefile の変数は、子 ./configure に渡りませんから、make だけ実行すればエラーを起こさずビルドできるのです。

debuild と環境変数の罠

一見、正常にビルドできて問題ないように見えますが、このソフトウェアを *.deb にパッケージングしようとするとハマります。Debian のパッケージ作成スクリプト debuild は下記のような動作をするからです。

• debuild はエラーチェック、セキュリティ強化のため CFLAGS, LDFLAGS にいくつかオプションを指定する
• CFLAGS, LDFLAGS は「環境変数」で make に渡される

そろそろ何が起きるか予想が付くでしょう。そう、こうなるんです。

• debuild が、親 Makefile に環境変数で CFLAGS, LDFLAGS を渡す
• 親 Makefile が CFLAGS, LDFLAGS を書き換える
• 親 Makefile が、子 ./configure に書き換わった後の CFLAGS, LDFLAGS を渡す

この華麗なコンボが決まって、make とするとビルドが成功し、debuild 経由だとビルドが失敗する、謎のビルド環境ができあがります。

感想

こんなバグ、初見で分かる、はずもなし。

Makefile は大抵の人には難しすぎます。Makefile を手で書いているといつか地獄に落ちますよ、CMake とか automake を使いましょう。便利だよ！