Instrumenting Julia with DTrace, and bpftrace
DTrace と bpftrace は、プロセスの軽量な計測を可能にするツールです。プロセスが実行中の間に計測をオンとオフに切り替えることができ、計測がオフの状態ではオーバーヘッドは最小限です。
プローブのサポートはJulia 1.8で追加されました。
このドキュメントはLinuxの視点から書かれており、ほとんどの内容はMac OS/DarwinおよびFreeBSDでも適用されるはずです。
Enabling support
Linuxにdtraceのバージョンを含むsystemtapパッケージをインストールし、Make.userファイルを作成します。
WITH_DTRACE=1USDTプローブを有効にする。
Verifying
> readelf -n usr/lib/libjulia-internal.so.1
Displaying notes found in: .note.gnu.build-id
Owner Data size Description
GNU 0x00000014 NT_GNU_BUILD_ID (unique build ID bitstring)
Build ID: 57161002f35548772a87418d2385c284ceb3ead8
Displaying notes found in: .note.stapsdt
Owner Data size Description
stapsdt 0x00000029 NT_STAPSDT (SystemTap probe descriptors)
Provider: julia
Name: gc__begin
Location: 0x000000000013213e, Base: 0x00000000002bb4da, Semaphore: 0x0000000000346cac
Arguments:
stapsdt 0x00000032 NT_STAPSDT (SystemTap probe descriptors)
Provider: julia
Name: gc__stop_the_world
Location: 0x0000000000132144, Base: 0x00000000002bb4da, Semaphore: 0x0000000000346cae
Arguments:
stapsdt 0x00000027 NT_STAPSDT (SystemTap probe descriptors)
Provider: julia
Name: gc__end
Location: 0x000000000013214a, Base: 0x00000000002bb4da, Semaphore: 0x0000000000346cb0
Arguments:
stapsdt 0x0000002d NT_STAPSDT (SystemTap probe descriptors)
Provider: julia
Name: gc__finalizer
Location: 0x0000000000132150, Base: 0x00000000002bb4da, Semaphore: 0x0000000000346cb2
Arguments:Adding probes in libjulia
プローブは、ファイル src/uprobes.d で dtraces 形式で宣言されています。生成されたヘッダーファイルは src/julia_internal.h に含まれており、プローブを追加する場合は、そこで noop 実装を提供する必要があります。
ヘッダーにはセマフォ *_ENABLED が含まれ、実際のプローブへの呼び出しが行われます。プローブの引数を計算するのが高コストである場合、まずプローブが有効かどうかを確認し、その後引数を計算してプローブを呼び出すべきです。
if (JL_PROBE_{PROBE}_ENABLED())
auto expensive_arg = ...;
JL_PROBE_{PROBE}(expensive_arg);引数がない場合、セマフォチェックを含めないことが推奨されます。USDTプローブが有効な場合、セマフォのコストはメモリロードであり、プローブが有効かどうかに関係なく発生します。
#define JL_PROBE_GC_BEGIN_ENABLED() __builtin_expect (julia_gc__begin_semaphore, 0)
__extension__ extern unsigned short julia_gc__begin_semaphore __attribute__ ((unused)) __attribute__ ((section (".probes")));プローブ自体は、プローブハンドラーにトランポリンにパッチされるnoopスレッドです。
Available probes
GC probes
julia:gc__begin: GCが1つのスレッドで実行を開始し、ストップ・ザ・ワールドをトリガーします。julia:gc__stop_the_world: すべてのスレッドがセーフポイントに到達し、GCが実行されます。julia:gc__mark__begin: マークフェーズの開始julia:gc__mark_end(scanned_bytes, perm_scanned): マークフェーズが終了しましたjulia:gc__sweep_begin(full): スイープを開始していますjulia:gc__sweep_end: スイープフェーズが終了しましたjulia:gc__end: GCが終了しました。他のスレッドは作業を続けます。julia:gc__finalizer: 初期GCスレッドがファイナライザの実行を終了しました
Task runtime probes
julia:rt__run__task(task): 現在のスレッドでタスクtaskに切り替えています。julia:rt__pause__task(task): 現在のスレッドでタスクtaskから切り替えています。julia:rt__new__task(parent, child): タスクparentが現在のスレッドでタスクchildを作成しました。julia:rt__start__task(task): タスクtaskが新しいスタックで初めて開始されました。julia:rt__finish__task(task): タスクtaskが完了し、もはや実行されません。julia:rt__start__process__events(task): タスクtaskが libuv イベントの処理を開始しました。julia:rt__finish__process__events(task): タスクtaskが libuv イベントの処理を終了しました。
Task queue probes
julia:rt__taskq__insert(ptls, task): スレッドptlsがtaskを PARTR マルチキューに挿入しようとしました。julia:rt__taskq__get(ptls, task): スレッドptlsが PARTR マルチキューからtaskをポップしました。
Thread sleep/wake probes
julia:rt__sleep__check__wake(ptls, old_state): スレッド (PTLSptls) が目覚めました。以前の状態はold_stateです。julia:rt__sleep__check__wakeup(ptls): スレッド (PTLSptls) が自分自身を起こしました。julia:rt__sleep__check__sleep(ptls): スレッド (PTLSptls) がスリープしようとしています。julia:rt__sleep__check__taskq__wake(ptls): スレッド (PTLSptls) は、PARTR マルチキュー内のタスクのためにスリープできません。julia:rt__sleep__check__task__wake(ptls): スレッド (PTLSptls) は、Base のワークキュー内のタスクのためにスリープできません。julia:rt__sleep__check__uv__wake(ptls): スレッド (PTLSptls) が libuv のウェイクアップによりスリープに失敗しました。
Probe usage examples
GC stop-the-world latency
contrib/gc_stop_the_world_latency.bt に例として bpftrace スクリプトが示されており、すべてのスレッドがセーフポイントに到達するまでのレイテンシのヒストグラムを作成します。
このJuliaコードを実行するには、julia -t 2を使用します。
using Base.Threads
fib(x) = x <= 1 ? 1 : fib(x-1) + fib(x-2)
beaver = @spawn begin
while true
fib(30)
# A manual safepoint is necessary since otherwise this loop
# may never yield to GC.
GC.safepoint()
end
end
allocator = @spawn begin
while true
zeros(1024)
end
end
wait(allocator)そして別のターミナルで
> sudo contrib/bpftrace/gc_stop_the_world_latency.bt
Attaching 4 probes...
Tracing Julia GC Stop-The-World Latency... Hit Ctrl-C to end.
^C
@usecs[1743412]:
[4, 8) 971 |@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@|
[8, 16) 837 |@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ |
[16, 32) 129 |@@@@@@ |
[32, 64) 10 | |
[64, 128) 1 | |実行されたJuliaプロセスにおけるストップ・ザ・ワールドフェーズのレイテンシ分布を見ることができます。
Task spawn monitor
タスクが他のタスクを生成しているときにそれを知ることは、時には便利です。これは rt__new__task を使うと非常に簡単に見ることができます。プローブの最初の引数である parent は、新しいタスクを作成している既存のタスクです。つまり、監視したいタスクのアドレスがわかれば、その特定のタスクが生成したタスクを簡単に見ることができます。これをどうやって行うか見てみましょう。まず、Juliaセッションを開始し、PIDとREPLのタスクアドレスを取得しましょう。
> julia
_
_ _ _(_)_ | Documentation: https://docs.julialang.org
(_) | (_) (_) |
_ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help.
| | | | | | |/ _` | |
| | |_| | | | (_| | | Version 1.6.2 (2021-07-14)
_/ |\__'_|_|_|\__'_| | Official https://julialang.org/ release
|__/ |
1> getpid()
997825
2> current_task()
Task (runnable) @0x00007f524d088010今、bpftraceを起動し、この親に対してのみrt__new__taskを監視することができます：
sudo bpftrace -p 997825 -e 'usdt:usr/lib/libjulia-internal.so:julia:rt__new__task /arg0==0x00007f524d088010/{ printf("タスク: %x\n", arg0); }'
（上記の内容では、arg0 は最初の引数であり、parent です）。
そして、単一のタスクを生成した場合：
@async 1+1
このタスクが作成されるのを見ています：
タスク: 4d088010
しかし、新しく生成されたタスクからたくさんのタスクを生成した場合：
@async for i in 1:10
@async 1+1
endまだ bpftrace からのタスクは1つしか見えません:
タスク: 4d088010
そして、それは私たちが監視していた同じタスクです！もちろん、このフィルターを削除すれば、すべての新しく作成されたタスクを見ることができます。
sudo bpftrace -p 997825 -e 'usdt:usr/lib/libjulia-internal.so:julia:rt__new__task { printf("タスク: %x\n", arg0); }'
Task: 4d088010
Task: 4dc4e290
Task: 4dc4e290
Task: 4dc4e290
Task: 4dc4e290
Task: 4dc4e290
Task: 4dc4e290
Task: 4dc4e290
Task: 4dc4e290
Task: 4dc4e290
Task: 4dc4e290私たちは、ルートタスクと、新たに生成されたタスクを、さらに10の新しいタスクの親として見ることができます。
Thundering herd detection
タスクの実行時間はしばしば「雷鳴の群れ」問題に悩まされることがあります。静かなタスク実行時間に作業が追加されると、すべてのスレッドが眠りから覚まされる可能性がありますが、各スレッドが処理するのに十分な作業がない場合もあります。これにより、すべてのスレッドが目覚める間に余分なレイテンシとCPUサイクルが発生し（同時に作業が見つからず再び眠りに戻る）、問題が生じることがあります。
この問題は bpftrace を使って簡単に示すことができます。まず、1つのターミナルで複数のスレッド（この例では6）を持つJuliaを起動し、そのプロセスのPIDを取得します：
> julia -t 6
_
_ _ _(_)_ | Documentation: https://docs.julialang.org
(_) | (_) (_) |
_ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help.
| | | | | | |/ _` | |
| | |_| | | | (_| | | Version 1.6.2 (2021-07-14)
_/ |\__'_|_|_|\__'_| | Official https://julialang.org/ release
|__/ |
1> getpid()
997825別のターミナルで、bpftraceを起動して、特にrt__sleep__check__wakeフックをプローブしてプロセスを監視します:
sudo bpftrace -p 997825 -e 'usdt:usr/lib/libjulia-internal.so:julia:rt__sleep__check__wake { printf("スレッドが起きました！ %x\n", arg0); }'
今、私たちはJuliaで単一のタスクを作成し、実行します：
Threads.@spawn 1+1
そして bpftrace では、次のような出力が表示されます:
Thread wake up! 3f926100
Thread wake up! 3ebd5140
Thread wake up! 3f876130
Thread wake up! 3e2711a0
Thread wake up! 3e312190たとえ私たちが単一のタスク（同時に処理できるのは1つのスレッドだけ）を生成したとしても、他のすべてのスレッドを起こしました！将来的には、より賢いタスクランタイムが単一のスレッド（または全く起こさない）だけを起こすかもしれません；生成したスレッドがこのタスクを実行することもできます！このような動作はなくなるはずです。
Task Monitor with BPFnative.jl
BPFnative.jlは、bpftraceと同様にUSDTプローブポイントにアタッチすることができます。タスクの実行時間、GC、スレッドのスリープ/ウェイク遷移を監視するためのデモが利用可能です here。
Notes on using bpftrace
bpftraceフォーマットの例となるプローブは次のようになります：
usdt:usr/lib/libjulia-internal.so:julia:gc__begin
{
@start[pid] = nsecs;
}プローブ宣言は usdt の種類を取り、その後にライブラリへのパスまたはPID、プロバイダー名 julia、およびプローブ名 gc__begin を指定します。libjulia-internal.so への相対パスを使用していますが、これは本番システムでは絶対パスである必要があるかもしれません。