Using Valgrind with Julia

Valgrindは、メモリのデバッグ、メモリリークの検出、プロファイリングを行うためのツールです。このセクションでは、Juliaのメモリ問題をデバッグする際にValgrindを使用するうえで留意すべき点を説明します。

General considerations

Valgrindはデフォルトで、実行するプログラムに自己書き換えコードが含まれていないと仮定します。ほとんどの場合、この仮定で問題ありませんが、juliaのようなJITコンパイラでは大きな問題になります。そのため、valgrindには必ず--smc-check=all-non-fileを渡してください。渡さないと、コードがクラッシュしたり、予期しない動作をしたりする可能性があります(しかも、その原因が分かりにくいこともよくあります)。

場合によっては、メモリプールを無効にしてjuliaをコンパイルすると、Valgrindでメモリエラーをより検出しやすくなります。コンパイル時フラグMEMDEBUGはJuliaのメモリプールを無効にし、MEMDEBUG2はFemtoLispのメモリプールを無効にします。両方のフラグを指定してjuliaをビルドするには、Make.userに次の行を追加します。

CFLAGS = -DMEMDEBUG -DMEMDEBUG2

プログラムが複数のワーカープロセスを使用する場合は、親プロセスだけでなく、すべてのワーカープロセスをValgrindの下で実行する必要があるでしょう。そのためには、valgrindに--trace-children=yesを渡します。

また、valgrindの使用時にUnable to find compatible target in system imageでエラーが発生する場合は、ターゲットをgenericにしてsysimageを再ビルドするか、JULIA_CPU_TARGET=genericを指定してjuliaを再ビルドしてみてください。

Suppressions

Valgrindは実行中に、通常は誤検知の警告を表示します。こうした警告を減らすには、Valgrindにsuppressions fileを指定すると効果的です。サンプルの抑制ファイルは、Juliaのソース配布物のcontrib/valgrind-julia.suppに含まれています。

抑制ファイルは、julia/のソースディレクトリから次のように使用できます。

$ valgrind --smc-check=all-non-file --suppressions=contrib/valgrind-julia.supp ./julia progname.jl

表示されたメモリエラーは、バグとして報告するか、追加の抑制ルールとして提供してください。ただし、Valgrindのバージョンによってはshipped with insufficient default suppressionsであるため、バグを報告する前にその点も考慮してください。

Running the Julia test suite under Valgrind

Juliaのテストスイート全体をValgrindの下で実行できますが、かなり時間がかかります(通常は数時間)。実行するには、julia/test/ディレクトリから次のコマンドを実行します。

valgrind --smc-check=all-non-file --trace-children=yes --suppressions=$PWD/../contrib/valgrind-julia.supp ../julia runtests.jl all

「definite」なメモリリークのレポートを表示するには、valgrindにフラグ--leak-check=full --show-leak-kinds=definiteも渡します。

Additional spurious warnings

このセクションでは、抑制ファイルにはまだ追加できないものの、無視しても問題のないValgrindの警告を取り上げます。

Unhandled rr system calls

Valgrindは、system calls that are specific to rr(Record and Replay Framework)を検出すると警告を出します。特に、juliaがrrの下で実行されているかどうかを検出しようとすると、未処理の1008システムコールに関する警告が表示されます。

--xxxxxx-- WARNING: unhandled amd64-linux syscall: 1008
--xxxxxx-- You may be able to write your own handler.
--xxxxxx-- Read the file README_MISSING_SYSCALL_OR_IOCTL.
--xxxxxx-- Nevertheless we consider this a bug.  Please report
--xxxxxx-- it at http://valgrind.org/support/bug_reports.html.

この問題は、Valgrindの開発者から依頼されているため、has been reportedに報告してください。

Caveats

現在、Valgrindはdoes not support multiple rounding modes。そのため、丸めモードを変更するコードは、Valgrindの下で実行すると異なる動作をします。

一般に、--smc-check=all-non-fileを設定した後、Valgrindの下でプログラムの動作が変わる場合は、さらに調査する際にvalgrindへ--tool=noneを渡すと役立つことがあります。これにより、最小限のValgrind機能だけが有効になり、メモリチェッカーを完全に有効にした場合よりも大幅に高速で実行できます。