前回のハックは美しくなかった。Lame 3.98.2ではハックが働いたけれど、x264ではうまく働かなかった。問題は、畢竟、アーカイブファイルにオブジェクトファイルの完全パスが含まれていることにほかならないのだけれど、手を抜いたのは私の責任だ。カレントディレクトリへのシンボリックリンクと言わず、ディレクトリを作成するほうが美しく、汎用性があった。
#! /bin/sh
set -e
case "$1" in
*x*)
for i in `llvm-ar tv "$2" | awk '{ printf " %s", $9 }'`; do
d=`dirname "$i"`
mkdir -p "$d"
done
;;
esac
llvm-ar "$@"
当初はカレントディレクトリにオブジェクトファイルを集めることに固執していたんだけど、どうやら、その必要性はないらしい。
SUSv3はarのx命令を規定しており、llvm-arもx命令を提供する。アーカイブファイルからオブジェクトファイルを抽出するという機能は共通だが、共通の動作は期待できないかもしれない。llvm-arはfモディファイヤを与えない限り、オブジェクトファイルの完全パスをアーカイブファイルに保存する。x命令は、保存された完全パスにオブジェクトファイルを書き出そうとする。ディレクトリが存在していない場合、抽出は失敗する。
Lame 3.98.2はビルドにx命令を使用する。libmpgdecoder.aとliblamevectorroutines.aからオブジェクトファイルを抽出して、libmp3lame/.libs/libmp3lame.0.0.0.{a,dylib}にまとめる（実際の仕事はlibtoolシェルスクリプトが行う）。
$ llvm-ar tv mpglib/.libs/libmpgdecoder.a brw-r--r-- 501/ 20 6508 Oct 23 09:23:37 2008 .libs/common.o brw-r--r-- 501/ 20 8116 Oct 23 09:23:38 2008 .libs/dct64_i386.o brw-r--r-- 501/ 20 15224 Oct 23 09:23:39 2008 .libs/decode_i386.o brw-r--r-- 501/ 20 18900 Oct 23 09:23:40 2008 .libs/interface.o brw-r--r-- 501/ 20 6344 Oct 23 09:23:40 2008 .libs/layer1.o brw-r--r-- 501/ 20 12296 Oct 23 09:23:41 2008 .libs/layer2.o brw-r--r-- 501/ 20 74804 Oct 23 09:23:43 2008 .libs/layer3.o brw-r--r-- 501/ 20 5284 Oct 23 09:23:44 2008 .libs/tabinit.o $ llvm-ar tv libmp3lame/vector/.libs/liblamevectorroutines.a brw-r--r-- 501/ 20 1932 Oct 23 09:23:46 2008 .libs/xmm_quantize_sub.o
xmm_quantize_sub.oは18文字あるので、アーカイブファイルの作成時にfモディファイヤをつけて対処することはできない。簡単な解決策は美しくないハックだ。x命令の実行前にカレントディレクトリへのシンボリックリンクを作成する。
#! /bin/sh
set -e
case "$1" in
*x*)
for i in `llvm-ar tv "$2" | awk '{ printf " %s", $9 }'`; do
ifs="$IFS"
IFS="/"
for d in `dirname "$i"`; do
if [ -f "$d" ] || [ -d "$d" ] || [ -h "$d" ]; then
:
else
ln "-s" "." "$d"
fi
done
IFS="$ifs"
done
;;
esac
llvm-ar "$@"
第一引数が命令とモディファイヤで、第二引数がアーカイブファイルであるならば、シェルスクリプトはほとんどの場合うまく働き、期待した動作を行う。嫌がらせみたいなオブジェクトファイルのパスを含む場合は、もちろん無理だけど。
前回は完膚なきまでに事実を誤認していた。llvm-arはbitcodeとnative codeを同時に含む。llvm-arのマニュアルに曰く、
- t[v]
- Print the table of contents. Without any modifiers, this operation just prints the names of the members to the standard output. With the v modifier, llvm-ar also prints out the file type (B=bitcode, Z=compressed, S=symbol table, blank=regular file), the permission mode, the owner and group, the size, and the date. If any files are specified, the listing is only for those files. If no files are specified, the table of contents for the whole archive is printed.
t命令にvモディファイヤを付けると、たとえばこんな出力が得られる。
rw-r--r-- 501/ 20 636 Oct 14 10:46:35 2008 bar0.o rw-r--r-- 501/ 20 544 Oct 14 10:46:35 2008 bar1.o brw-r--r-- 501/ 20 544 Oct 14 10:46:35 2008 foo0.o brw-r--r-- 501/ 20 540 Oct 14 10:46:35 2008 foo1.o
foo0.oとfoo1.oがbitcodeのオブジェクトファイルで、bar0.oとbar1.oがnative codeのオブジェクトファイルだ。x命令を使うと、アーカイブファイルからオブジェクトファイルを抽出できる。
- x[oP]
- Extract archive members back to files. The o modifier applies to this operation. This operation retrieves the indicated files from the archive and writes them back to the operating system's file system. If no files are specified, the entire archive is extract.
だけど、llvm-ldは、bitcodeとnative codeの両方を含むアーカイブファイルを良きにはからってくれない（tools/llvm-ld/llvm-ld.cppを読むとItemsとNativeLinkItemsに二分しちゃってる）。だったら、x命令を使用してオブジェクトファイルを抽出して、bitcodeだけからなるアーカイブファイルとnative codeだけからなるアーカイブファイルを作成しよう。下記はコンセプトを実証するためのもので、オブジェクトファイルがディレクトリ階層を持っている場合に破綻する（かもしれない）。
#! /bin/sh
set -e
file="$1"
shift
b_objs=`llvm-ar tv "$file" | awk '/^b/ { printf " %s", $9}'`
n_objs=`llvm-ar tv "$file" | awk '/^ / { printf " %s", $9}'`
d=`dirname "$file"`
s=`printf '%s' "$file" | sed -e 's/.*\(\..*\)$/\1/'`
n=`basename "$file" "$s"`
cd "$d"
mkdir "-p" "$n-o"
cd "$n-o"
llvm-ar "xo" "../$n$s"
llvm-ar "rc" "$n-b$s" $b_objs
ar "rc" "$n-n$s" $n_objs
mv "$n-b$s" "$n-n$s" ".."
cd ..
rm "-fr" "$n-o"
話はほとんど、これでおしまい。ただし、native codeがbitcodeのシンボルを参照する場合（多くの場合参照する、そもそも、参照しなかったらそのコードに意味がない）、できあがったアーカイブファイルをリンクする際に-disble-internalizeの付与を検討するべきだ。すべてのbitcodeが先にリンクされ（願わくば最適化され）、その後native codeがリンクされる。最適化はnative codeが参照しているシンボルをどっかにやっちゃうかもしれない（native codeからしか参照されていなかったら、たぶんどっかにやっちゃう）。
ほとんどもう、透過的にLLVMを使うことができるようになった。
Mac OS X 10.5 (darwin9) では、メディアを扱うライブラリやツール、つまり圧縮や暗号化は確かに高速になる。32bitで試した範囲ではGNU/Linuxシステム、畢竟ELF形式もビルドに問題はなさそうだ。ビルドに問題はないが、速度が向上するとは限らない。メディアを扱うライブラリやツールは、しばしばアセンブリ言語で高速なコードを記述する。Native codeがまざるとLLVMの魔法が効きにくくなる。
OpenSSLが良い例だ。OpenSSL 0.9.8iのcpuid命令の実装は、アーキテクチャごとに4個のファイルを用意している。
さまざまのアセンブラに対応するべく、x86-64とx86はアセンブリコードを生成するPerlスクリプトとして記述されている。対応するアセンブラにELF形式は含まれるが、Mach-O形式は含まれない。つまり、Darwinで普通にビルドしたOpenSSLはもろもろのハッシュ、AESやらDESやらをCで書かれたコードで計算している。LLVMの魔法は最大の効果を発揮するだろう。
GNU/Linuxシステムで透過的にLLVMを使用するためには、no-asm付きで./configを実行する羽目になる。静的リンクライブラリはbitcodeとnative codeを同時に含むことができない。静的リンクライブラリはbitcodeとnative codeを同時に含むことはできる（というか含んでしまう）けれど、単純には正しくリンクしてくれない。アセンブリ言語でかりかりに高速化された暗号化にたちうちすることは、さしものLLVMにも難しいようだ。openssl speedで調べた限りでは。
いくつかの解決策があるだろう。
前者ほど最適化の可能性が高く、透過的であり、しかし、実装が困難である。
CentOS 4でLLVMを使いはじめた。__USE_EXTERN_INLINESマクロが定義されていると、GCCはインライン展開を押し進めるべく最適化ヘッダを利用する。/usr/include/stdio.hをひもとこう。
/* If we are compiling with optimizing read this file. It contains several optimizing inline functions and macros. */ #ifdef __USE_EXTERN_INLINES # include <bits/stdio.h> #endif #if __USE_FORTIFY_LEVEL > 0 && !defined __cplusplus # include <bits/stdio2.h> #endif
/usr/include/bits/stdio.hはインライン展開を期待して、関数をいくつか定義する。たとえば、vprintfはvfprintfのラッパーだ。__STDIO_INLINEマクロはextern __inlineに展開されるだろう。
/* Write formatted output to stdout from argument list ARG. */
__STDIO_INLINE int
vprintf (__const char *__restrict __fmt, _G_va_list __arg)
{
return vfprintf (stdout, __fmt, __arg);
}
残念なお知らせがある。最適化オプションとともに-std=c99を与えると、LLVM-GCCはvprintfにインライン展開を期待してくれない。結果、/usr/include/stdio.hを利用する全てのコードにvprintfが偏在する。
LLVM-GCCはAppleのGCCを基に開発された。尋ねよ、さらば見出さん。-fno-gnu89-inlineがあるとLLVM-GCCのマニュアルは教えている。
This option is accepted by GCC versions 4.1.3 and up. In GCC versions /* APPLE LOCAL extern inline */ prior to 4.3 (4.2 for Apple's gcc), C99 inline semantics are not supported, and thus this option is effectively assumed to be present regardless of whether or not it is specified; the only effect of specifying it explicitly is to disable warnings about using inline functions in C99 mode. Likewise, the option -fno-gnu89-inline is not supported in versions of /* APPLE LOCAL extern inline */ GCC before 4.3 (4.2 for Apple's gcc). It is supported only in C99 or gnu99 mode, not in C89 or gnu89 mode.
もっとも、システムヘッダとコンパイラの歩調が合ってないことが問題なのだけれど。
LLVM-GCCの出力結果を眺めていると、当然のようにアウト・オブ・オーダー最適化がなされていて、コンパイラ技術ってやっぱり非モテ技術でありつづけているんだ、と、その瞬間、フラッシュバック、X端末がずらりと並んだ窓のない部屋が襲いかかる。たとえ、iPhoneのクゥゥゥルを実現するためであったとしても、それはイーガンと同じくらいにしかクゥゥゥルでない（コンパイラ技術の因襲だもの、アップルのプレゼンテーションソフトを使ったところで非モテは解消されやしない）。まさに、というよりも、初手から塵理論はそういう話だった。アウト・オブ・オーダー実行がPentiumのハッタリだったように。
そして、Apple (Computer,) Inc.はlibtoolを発明した。Apple libtoolのマニュアルに曰く、
Libtool with -static is intended to replace ar(5) and ranlib.
動的リンクライブラリはさておくとして、問題はMach-Oユニバーサルバイナリだ。もちろん、-Oで終わる単語（うん、たとえば、シロガネ-OとかPARANOIA-Oとか）はXで始まる単語と同じくらいろくでもないに決まっている。
The libtool command takes the specified input object files and creates a library for use with the link editor, ld(1). The library's name is specified by output (the argument to the -o flag). The input object files may be in any correct format that contains object files ("universal" files, archives, archives, object files). Libtool will not put any non-object input file into the output library (unlike ranlib, which allows this in the archives it operates on).
Mach-OユニバーサルバイナリはNeXTに由来する。CPUタイプ（とサブタイプ）ごとのオブジェクトファイルを合体してユニバーサルバイナリにする（うん、厳密にはオブジェクトファイルがそれぞれのアーキテクチャの機械語コードを内包しているかも）。合体は（釣りバカ日誌の）浜チャンにまかせておきたい。同居人はPowerPCのPowerBookを使いつづけているけれど、私はMacBook Proに移行して久しい（初期型なのでx86-64ではないCoreDuoだけど）。
ユニバーサルバイナリを捨てるとしたら、捨てたのだけれど、利点は、静的ライブラリの作成に際して、ranlibを忘れないことくらいだ（うん、それは実際、悪くはない）。動的ライブラリの作成に際しては、特にC++を使用する場合、使用するのだけれど、素直にg++ -dynamiclibを使用するほうがましだ（悪いのはlibstdc++だ）。
畢竟、Apple libtoolがなくても生きていけるし、生きていく資格なら初手から要らない。じゃあ、なぜ、と言えば、Boostが静的リンクライブラリをビルドするためにApple libtoolを使おうとするからだ。
CURL 7.19.0をLLVM-GCC 4.2でコンパイルすると、test539が失敗する。LLVM-GCC固有の問題なのか、GCC 4.2の問題なのかは知らない。
標準は、char *strcat(char *restrict s1, const char *restrict s2);が第一引数s1の末尾に第二引数s2の内容をコピーしてからs1を返すと定めている。充分な最適化オプションを指定し、-fno-builtinを指定しなければ、GCCはstrcatをインライン展開するかもしれない。以下のコードはtests/libtest/lib539.cから抜粋した。
newURL = strcat (strcpy ((char*)malloc (strlen (URL) + 3),
URL),
"./");
新しく確保した領域にURLと"./"を連結した文字列を保存する。newURLはmallocで確保した領域の先頭のアドレスを指すだろう。懐かしさこそ感じれど、このコード自体にどうというところはない。
p = malloc(strlen(URL) + 3); p = strcpy(p, URL); newURL = strcat(p, "./"); assert(p == newURL);
標準はassertが成功することを保証する。LLVM-GCC 4.2はstrcatをstrlenとmemcpyに展開する。なにかがおかしくなる。展開の結果を擬似的にCで表現すると、
p = malloc(strlen (URL) + 3); p = strcpy(p, URL); newURL = p + strlen(p); memcpy(newURL, "./", 3); assert(p == newURL);
assertは成功しない。犯人は誰だろう。これはミステリではないので、strcatの返り値を信用しないようにコードを書き換えれば死人は甦るかもしれない。
静的リンクライブラリはLLVMの世界のなかにある。llvm-arとllvm-ranlibがそれを扱う。llvm-ldは動的リンクライブラリをリンクする（bitcodeで表現された静的リンクライブラリが見つからなかったら）。現代的なオペレーティングシステムにおいて、動的リンクライブラリが実行可能バイナリとほとんど同義であるとしたら、動的リンクライブラリはnative codeで表現されるだろう。
llvm-gcc -emit-llvm -Wall -O2 -g -c foo.c llvm-gcc -emit-llvm -Wall -O2 -g -c bar.c llvm-ld -link-as-library foo.o bar.o -o libfoobar.bc llc libfoobar.bc -f -o libfoobar.s gcc -Wall -O2 -g -c libfoobar.s libtool -dynamic libfoobar.o -o libfoobar.dylib
libtoolはldを呼び出す（もちろんlibtoolはGNU libtoolではない）。自明なオプションとアーキテクチャ関連のオプションは省略しよう。
ld -dylib -ldylib1.o libfoobar.dylib.o -o libfoobar.dylib
ldには既にフックがかけてある。解は単純だ。ldに-dylibオプションが与えられていたら、入力をnative codeに変換してからシステムのldを呼び出せばいい。
GNU Octaveのマニュアルに曰く、
On NeXT systems, if you get errors like this:
/usr/tmp/cc007458.s:unknown:Undefined local symbol LBB7656 /usr/tmp/cc007458.s:unknown:Undefined local symbol LBE7656when compiling Array.cc and Matrix.cc, try recompiling these files without -g.
いやはや、Mac OS X 10.5 (darwin9) においておや、おやおや。フリーなソフトウェアやオープンなソフトウェアをかたっぱしからLLVM-GCCでコンパイルしていくと、アセンブラがときどき「unknown:Undefined local symbol L...」と言い出す（うん、厳密に言うとLLVM-GCCは関係なくて、llvm-ldが呼び出すMax OS Xのアセンブラが文句を言うんだ）。GNU Octaveのマニュアルは-gを付けずにコンパイルしなおせと教えているが、llvm-ldに-strip-debugを与えても同じことだ（すすめはしないけれど-disable-inliningでもいい）。
デバッグ情報の、これは夜の物語である。デバッグ情報の霧についてはさておいて、動的リンクの闇の物語を語ることにしよう。
SQLite 3.6.2をLLVM-GCC 4.2でコンパイルすると、整数からポインタへのキャストが定数値でないというエラーが発生する。LLVM-GCC固有の問題なのか、GCC 4.2の問題なのかは知らない。正確に言うと問題ですらない。
sqlite3.c: In function 'sqlite3RegisterDateTimeFunctions': sqlite3.c:11837: error: initializer element is not constant sqlite3.c:11837: error: (near initialization for 'aDateTimeFuncs[0].pUserData')
コンパイル時定数でない値を配列の初期化に使用していると不平を述べている。
FuncDef構造体の配列を用いてSQL関数を表現する。FuncDef構造体を作成するためにFUNCTIONマクロを定義する。FUNCTIONマクロはSQLITE_INT_TO_PTRマクロを利用して整数をvoid*に変換する。かつて整数とポインタは同義だったかもしれない。そんな昔のことは憶えていないし、そんな先のことは判らない。
#define SQLITE_INT_TO_PTR(X) ((void*)&((char*)0)[X]) #define SQLITE_PTR_TO_INT(X) ((int)(((char*)X)-(char*)0))
コンパイル時定数にするかどうかはコンパイラの自由なので、SQLITE_INT_TO_PTR(X)はコンパイル時定数にならないかもしれない。SQLiteの名誉のために付け加えると、配列の初期化に使用している箇所ではXは0から3までのリテラルだ（SQLITE_OMIT_DATETIME_FUNCSマクロが定義されていない限り）。宗教論争に加わるには人生は短すぎる。整数が何ビットだろうと、ポインタが何ビットだろうと、はたまた関数ポインタが何ビットだろうと知ったこっちゃない。
#define SQLITE_INT_TO_PTR(X) ((void*)(X))
四行詩を諳んじるにはまだ遠い。
./configure make make check make install
前回、ラッパーとなるシェルスクリプトを介してllvm-ldを呼び出すことで、llvm-gccをほとんどgccとして扱えることを示した。こうして、いつでもllvm-gccに-emit-llvmを与えられるようになった。もちろん、gccをllvm-gccへのシンボリックリンクに設定するべきではない。コンパイラドライバとしてのllvm-gccは、アセンブラとしてのgccを必要とする。llvm-gccを呼び出す前に、自分自身が存在するディレクトリを$PATHから削除すれば問題はほとんど解決する。
そもそもの目的に照らせば、いつでもllvm-gccに-emit-llvmを与えることは必然だ。llvm-ldを呼び出す際にどのようなオプションを与えるかは考慮に値する。考慮するべきオプションは、-disable-optと-nativeだ。なにも指定しなければ、llvm-ldは可能な限りの最適化を試みる。ひとつの問題がある。
char function();
char (*f)() = function;
int main() {
return f != function;
}
関数の存在を調べるためにconfigureが（つまりAutoconfのAC_CHECK_FUNCSマクロが）生成したコードだ。リンクに成功すればfunctionが外部に存在していると認識される。なにも指定しなければ、llvm-ldは可能な限りの最適化を試みる。fとfunctionが等しいことを見抜き、f != functionは偽であることを見抜く。
int main() {
return 0;
}
リンクは常に成功する。畢竟、functionは存在する。ひとつの教訓は、configureの実行中、llvm-ldに-disable-optを与えることだ。
-nativeまたは-native-cbeを指定しなければ、llvm-ldはbitcodeとそれを実行するためのシェルスクリプトを生成する。ひとつの問題は動的リンクライブラリのリンクが動的に行われることで、最適化と同様の問題が発生する。さらに、make installがぼくたちの望んだように働かない（シェルスクリプトだけをインストールしてくれちゃう）。
目的に立ち返ろう。ぼくたちのC++のコードがリンクする全ての静的ライブラリをbitcodeで表現すること、最後の最後に最適化をかけることが目的だ。最後の最後が永遠に続くとしても、それはぼくたちのC++のコードの話だ。欲しいのはbitcodeで表現された図書館であって、bitcodeで表現された実行可能バイナリではない。
ふたつめの教訓は、四行詩を諳んじている間、常にllvm-ldに-nativeを与えることだ（ただし副作用はある。-g付きでコンパイルした場合、dsymutilがオブジェクトファイルからDWARFデバッグ情報を抽出しようとするかもしれない）。
自由なUNIXに似たシステムのパッケージシステムは、Autotoolsの分厚い皮がすこし日焼けしたようなものだ。魔法の四行詩（たいていの場合、make checkは抜かすだろうけれど）を諳んじるのだ。
./configure make make check make install
この四行はUNIXの範疇にある。shが実行され、makeが実行される。それらが呼び出すコマンドがUNIXの範疇にあるかどうかは保証されない。SUSv3が定義するCコンパイラはc99だけど、それが存在するかどうかは判らない（自由なUNIXに似たシステムはUNIXじゃないからね）。
目標は、畢竟、ぼくたちのC++のコードがリンクする全ての静的ライブラリをbitcodeで表現すること、最後の最後に最適化をかけることだ。実際問題、ユーザランドで動作する使い勝手の良いライブラリ、特に様々なメディアを扱うライブラリはLLVMの恩恵を受けやすい。C++のライブラリがヘッダー主体になって久しいが、それだって内部では昔ながらのCのライブラリを呼び出している。
makeと呪いを唱える。現実に即し、乱暴に述べるなら、ほとんどの場合、GNU Compiler Collectionが呼び出される。GNU Compiler Collectionは魔術的にリンカを呼び出す。
gcc -Wall -O2 -g -c foo.c gcc -Wall -O2 -g -c bar.c ar rc libfoobar.a foo.o bar.o ranlib libfoobar.a gcc -Wall -O2 -g baz.c -L. -lfoobar -lm -o baz
人工的だけど典型的で例だ（実際、bzip2のMakefileはこんな感じだ）。-vオプションを与えると、gccは内部で呼び出すコマンドを表示する。本当に呼び出しているコマンドを知るためにはdtrace（あるいは他のなにか）を使用する。Mac OS X 10.5では/usr/bin/gccは/usr/bin/gcc-4.0のシンボリックリンクだ。最後の一行を実行すると、コンパイルのためにcc1とasが、リンクのためにcollect2そしてldが呼び出される。
LLVMが透過的だとしたら、接頭辞を加えてコマンドを実行すれば全てがうまくいくだろう（もちろん、そう、-emit-llvmを忘れなければ）。そしてbitcodeが生成されるだろう。
llvm-gcc -emit-llvm -Wall -O2 -g -c foo.c llvm-gcc -emit-llvm -Wall -O2 -g -c bar.c llvm-ar rc libfoobar.a foo.o bar.o llvm-ranlib libfoobar.a llvm-gcc -emit-llvm -Wall baz.c -L. -lfoobar -lm -o baz
はかない望みである。はかなさの理由は、コンパイルとリンクを合わせて行うことがllvmの流儀に反しているからだと説明できるかもしれない。llvm-gccとllvm-ld（またはllvm-link）を別々に実行すれば問題は解決する。bitcodeとそれを実行するためのシェルスクリプトが生成される。
llvm-gcc -Wall -emit-llvm -c baz.c llvm-ld baz.o -L. -lfoobar -lm -o baz
流儀云々は窓から投げ捨てよう。collect2は$PATHからldを決定する（実際には、もっと面倒な決定方法を経る）。特に設定していなければシステムのldを見つける。システムのldが望みを叶えてくれるわけはない。
ldをllvm-ldへのシンボリックリンクに設定すれば、llvm-ldが呼び出されるようになる。しかし、collect2がldに渡す引数のなかにはllvm-ldが解釈できないものがある。典型的には-emit-llvmを扱えないし、Mac OS Xの拡張オプションや癖のあるlibc周りはうまく扱えない（なんだか間尺に合わない話だ）。厳密さを追い求めなければ、対処は難しくない。扱えない引数を削除した後、llvm-ldを呼び出せばいい。