System Image Building
Building the Julia system image
Juliaには、Baseモジュールの内容を含む、sys.jiという名前のシステムイメージが、あらかじめ解析された状態で同梱されています。このファイルは、起動時間を大幅に短縮するため、可能な限り多くのプラットフォームでsys.{so,dll,dylib}という共有ライブラリにも事前コンパイルされています。事前コンパイル済みのシステムイメージファイルが同梱されていないシステムでは、JuliaのDATAROOTDIR/julia/baseフォルダーに含まれるソースファイルから生成できます。
Juliaはデフォルトで、利用可能なシステムスレッド数の半分を使ってシステムイメージを生成します。この設定は、環境変数JULIA_IMAGE_THREADSで変更できます。
この操作は、いくつかの理由で役立ちます。たとえば、次のことができます。
- 共有ライブラリ形式の事前コンパイル済みシステムイメージを、同梱されていないプラットフォーム向けにビルドして、起動時間を短縮する。
Baseを変更してシステムイメージを再ビルドし、次回のJulia起動時に新しいBaseを使う。- パッケージをシステムイメージに含める
userimg.jlファイルを用意し、起動環境にパッケージを組み込んだシステムイメージを作成する。
PackageCompiler.jl packageには、この処理を自動化する便利なラッパー関数が用意されています。
System image optimized for multiple microarchitectures
システムイメージは、同じ命令セットアーキテクチャ(ISA)に属する複数のCPUマイクロアーキテクチャ向けに、同時にコンパイルできます。異なるISA拡張やその他のマイクロアーキテクチャ機能を活用できるよう、共有関数に最小限のディスパッチポイントを挿入して、同じ関数の複数のバージョンを作成できます。実行時には、利用可能なCPU機能に基づいて、最も高い性能を発揮するバージョンが自動的に選択されます。
Specifying multiple system image targets
システムイメージのコンパイル時に複数のターゲットを渡すと、複数のマイクロアーキテクチャ向けのシステムイメージを有効にできます。これは、makeのオプションJULIA_CPU_TARGETを使う方法と、コンパイルコマンドを手動で実行する際にコマンドラインオプション-Cを使う方法があります。オプション文字列では、複数のターゲットを;で区切ります。各ターゲットはCPU名の後に、,で区切った複数の機能を指定する構文です。LLVMがサポートするすべての機能を指定でき、-を先頭に付けると機能を無効にできます。(LLVMの構文との一貫性を保つため、+を先頭に付けることもできますが、無視されます。)また、関数のクローン作成の動作を制御するための特別な機能もいくつか用意されています。
最初のターゲット以外では、各ターゲットにclone_allまたはbase(<n>)のいずれかを指定するのが望ましい方法です。これにより、すべての関数をクローンするターゲットと、他のターゲットをベースにするターゲットが明確になります。指定しない場合、デフォルトではすべての関数をクローンせず、クローンしない関数には最初のターゲットの関数定義をフォールバックとして使用します。
clone_allデフォルトでは、マイクロアーキテクチャ機能の恩恵を最も受ける可能性が高い関数だけがクローンされます。ただし、ターゲットに
clone_allを指定すると、システムイメージ内のすべての関数がそのターゲット向けにクローンされます。否定形の-clone_allを使うと、組み込みのヒューリスティックによる全関数のクローンを防げます。base(<n>)<n>は、0以上の数値を表すプレースホルダーです(例:base(0)、base(1))。デフォルトでは、一部の関数だけをクローンするターゲット(つまりclone_allではないターゲット)で関数がクローンされていない場合、デフォルトターゲット(最初に指定したターゲット)の関数が使われます。base(<n>)オプションで別のベースを指定すると、この動作を変更できます。0始まりでn番目のターゲットが、デフォルトの0番目のターゲットの代わりにベースターゲットとして使われます。ベースターゲットには、0または別のclone_allターゲットを指定する必要があります。clone_allではないターゲットをベースターゲットに指定すると、エラーになります。opt_size実行時性能への影響が大きくない場合に、そのターゲット向けの関数をサイズ優先で最適化します。これは、GCCおよびClangのオプション
-Osに相当します。min_size実行時性能に大きな影響が生じる可能性がある場合でも、そのターゲット向けの関数をサイズ優先で最適化します。これは、Clangのオプション
-Ozに相当します。
執筆時点では、julialang.orgからダウンロードできる公式のx86_64 Juliaバイナリの作成に、次の文字列が使われています。
generic;sandybridge,-xsaveopt,clone_all;haswell,-rdrnd,base(1)これにより、3つのターゲットを持つシステムイメージが作成されます。1つ目は汎用のx86_64プロセッサ向け、2つ目はsandybridge ISA向け(xsaveoptを明示的に除外)で、すべての関数を明示的にクローンします。3つ目はhaswell ISA向けで、sandybridgeのsysimgバージョンをベースとし、rdrndも除外します。Juliaの実装が生成されたsysimgを読み込む際、ホストプロセッサのCPU機能フラグを確認し、利用可能な最も高いISAレベルを有効にします。なお、ベースレベル(generic)ではcx16命令が必要です。この命令は一部の仮想化ソフトウェアでは無効になっており、genericターゲットを読み込むには有効にする必要があります。互換性を高めるには、代わりにターゲットgeneric,-cx16を指定してsysimgを生成する方法もあります。ただし、一部のコードで性能や安定性に問題が生じる可能性があります。
Implementation overview
ここでは、実装に関わる各部分を簡単に説明します。実装の詳細については、各コンポーネントのコードコメントを参照してください。
システムイメージのコンパイル
解析とクローン作成の判断は
src/processor*で行います。現在は、ループ、SIMD命令、またはその他の数学演算(fastmath、fma、muladdなど)の有無に基づいて関数をクローンできます。この情報は、実際にクローンを行うsrc/llvm-multiversioning.cppに渡されます。クローン作成とディスパッチスロットの挿入(方法についてはMultiVersioning::runOnModuleのコメントを参照)に加え、このパスでは、実行時にシステムイメージを正しく読み込んで初期化できるよう、メタデータも生成します。メタデータの詳細な説明はsrc/processor.hにあります。システムイメージの読み込み
システムイメージの読み込みと初期化は
src/processor*で行います。ここでは、システムイメージの生成時に保存されたメタデータを解析します。ホストの機能検出とターゲット選択の判断は、ISAに応じてsrc/processor_*.cppで行います。ターゲットの選択では、CPU名の完全一致、ベクトルレジスターサイズの大きさ、機能数の多さが優先されます。この処理の概要はsrc/processor.cppにあります。
Trimming
Baseには多くの機能が含まれており、システムイメージは通常かなり大きくなります。また、利便性と後方互換性のため、デフォルトではLinearAlgebraなどのパッケージもいくつか含まれています。多くのプログラムがこれらのパッケージの関数を使うのは一部だけです。そのため、使われない関数を除外してバイナリのサイズを抑える「トリミング」には意味があります。
トリミングの基本的な考え方は妥当ですが、Juliaには動的な機能やリフレクション機能があるため、一般にどの関数が使われないかを判断するのは困難(あるいは不可能)です。極端な例として、次のようなコードを考えてみましょう。
getglobal(Base, Symbol(readchomp(stdin)))(1)このコードは、stdinから関数名を読み取り、その名前のBase関数を値1に対して呼び出します。この場合、どの関数が呼び出されるかを予測できないため、どの関数も確実に「未使用」とは見なせません。注目すべき例外(Julia自身のREPLなど)はありますが、実際のプログラムの大半はこのような処理を行いません。
それほど極端ではない例として、型が不安定なためにコンパイラーが呼び出されるメソッドを予測できない場合があります。しかし、コードの型が適切に定まり、リフレクションを使わないのであれば、必要なメソッドの集合を完全に、かつ(願わくば)比較的小さく特定し、残りを削除できます。コマンドラインオプション--trimは、この種のコンパイルを要求します。
システムイメージのビルドコマンドで--trimを指定すると、コンパイラーはBase.Experimental.entrypointでマークされたメソッドを起点に、呼び出しをたどり始めます。呼び出しが動的すぎて、呼び出し先の候補を妥当な範囲まで絞り込めない場合は、その呼び出し箇所を示すエラーがコンパイル時に発生します。テスト目的であれば、--trim=unsafeまたは--trim=unsafe-warnを指定して、これらのエラーを無視できます。その場合もシステムイメージはビルドされますが、必要なコードが含まれていないと実行時にクラッシュする可能性があります。
トリミング済みバイナリは完全にコンパイルされているため、Julia IRを必要としません。そのため、通常は--strip-irと--trimを併せて指定するとよいでしょう。将来的には--trimによって--strip-irも有効になるようにするかもしれませんが、現時点では両者を独立したオプションとして扱っています。
バイナリを可能な限り小さくするには、--strip-metadataを指定し、Unixのstripユーティリティを実行するのも有効です。ただし、これらの手順では、それぞれJulia固有のデバッグ情報とネイティブのデバッグ情報(DWARF形式)が削除されるため、デバッグが難しくなります。
これらのオプションを手動で指定する代わりに、ほとんどのユーザーはJuliaC.jlを使ってトリミング済みバイナリをビルドするのがよいでしょう。これはjuliacドライバーを提供し、コンパイル、リンク、成果物のバンドルを処理します。
Common problems
- Baseのグローバル変数
stdin、stdout、stderrは定数ではないため、型が分かりません。出力には、型が既知の特定のIOオブジェクトを使ってください。最も簡単な置き換え方法は、print(x)またはprint(stdout, x)の代わりにprint(Core.stdout, x)を使うことです。 - JET.jl、Cthulhu.jl、SnoopCompileなどのツールを使って型推論の失敗を特定し、修正するにはPerformance Tipsに従ってください。
Compatibility concerns
Baseに小さな変更を加えることで、確実にトリミングできるプログラムの範囲が大きく広がることが分かっています。しかし、こうした変更の一部は破壊的変更と見なされるため、トリミングが要求された場合にのみ適用されます(これは外部ビルドスクリプトによって行われ、現在はテストスイート内のtest/trimming/juliac-buildscript.jlで管理されています)。そのため、多くの場合、トリミングを行うにはBaseや一部の標準ライブラリの新しいバリアントを明示的に有効にする必要があります。
トリミングを使う場合は、トリミング済みビルドを実行し、生成されたプログラムを十分にテストする継続的インテグレーション(CI)を設定することが重要です。幸い、プログラムが--trimで正常にコンパイルできれば、以前と同じように動作する可能性は非常に高いでしょう。ただし、開発を続ける中でトリミングを使ったビルドが引き続き成功することを確認するには、CIが必要です。
パッケージ作者は、自分のパッケージが「トリミングに対応している」かどうかをテストしたいかもしれませんが、一般にはそれを確認できません。トリミングが機能するのは、main()のような具体的なエントリーポイントや、Juliaの外部から呼び出すことを想定したライブラリのエントリーポイントがある場合に限られます。汎用パッケージでは、@inferredやJET.@report_callのような、型安定性を確認する既存のテストが、トリミングとの互換性を調べる最善の方法です。
トリミングによって、Juliaのマイナーバージョン間に新たな互換性の問題も生じます。現時点では、あるバージョンのJuliaでトリミングできるプログラムが、今後のすべてのバージョンでもトリミングできるとは保証できません。ただし、この種の問題はまれだと予想されます。また、トリミング可能なプログラムの範囲を今後広げることも目指しています。