SystemTapを使ってみる
SystemTapはRedhatを中心として作られたフリーソフトで、主にカーネルの動作確認や解析などに使用できるツールです。2005年に発表されて以来、2011年にはメジャーdistroで動作するようになり、現在bpftraceと並んで不動の地位を得ています。
効能の割にそれほど情報がないこともあり、Ubuntu 22.04での使用感などを含め、とりあえず記事にしてみました。
目的
Ubuntu 22.04でSystemTapを使用し、Linuxカーネルの解析をしてみる
背景
従来Linuxカーネルの動きを知りたければ、ドキュメントで分からないことがあればソースを見て、それでも分からなければカーネルのソースコードを直接いじってprintk
を挿入してちまちまログ出力させて、それをビルドしては配備して動かす(再起動する)感じでした。環境を整えるだけでも一苦労だし、ビルド自体も非常に時間がかかる作業でした。アプリならデバッガを使用してブレークポイントで止めて見るのもすぐですが、カーネルでは気軽に出来ないからです。
SystemTapを使用すると、この作業を従来よりはるかに楽に出来るようになります。
インストール
カーネルをいじりたい人がこの辺で詰まっていては話にならないということなのか、この辺のドキュメントもあまり更新する人がいません。本家の公式ドキュメントはRedhat一色で、.debのデの字もなく(wikiにはある)…Ubuntu側の資料を漁っても、以下のようなあまりメンテされてなさそうなものしかありません。
https://wiki.ubuntu.com/Kernel/Systemtap
流れは実際書いてあるとおりなのですが…まずインストールするパッケージ、公式リポジトリのパッケージをそのまま使っていても、バージョンが古くて動きません。ガチの最新夜間ビルドになりますが、PPAのリポジトリを使った方がいいです。
https://launchpad.net/%7Eubuntu-support-team/+archive/ubuntu/systemtap
また、カーネルのデバッグ情報(dbgsym)が必要になるのですが、リポジトリのうち現在securityはありませんし、apt-keyを使用した署名検証用情報の管理がdeperecatedだと怒られます。
上記を考慮した修正済手順は以下のとおりです。
インストール手順の中にgccが含まれていますが、Ubuntuの場合、Desktop版とServer版でカーネルのバージョンが違っており、Desktop版の場合はデフォルトでインスールされるgcc-11ではなく、gcc-12にする必要があります。
使い方
systemtapは基本的に所定のイベントにhookしてその際に何をするかを指定する、という使い方です。
今回はsystemtapで予め用意しているvfs.read
というイベント(fs/read_write.c
のvfs_read()
です)をhookして、一度だけ変数とstack traceの出力をしてみます。
printkと比較すると格段の進化を感じます。hookは任意の関数のentry/return(return&inlineはダメ)で仕掛けられます。
あとはRHEL7用なのでかなり古いが、redhatが出しているビギナーズガイド辺りが簡単なので最初に読むと概要が分かります。
慣れたら本家のdocumentを漁りましょう。
注意点は、変数に参照したい場合、構造体のメンバを表すのに.
(ドット)が使えないこと(文字列連結に使ったらしい)。ポインタであろうとなかろうと一律->
で参照してください。あとは変数の最後に$$
を付けると、どんな型でもtoStringよろしく勝手に文字列にしてくれるので便利です。
bpftraceとどっちがいいか?
systemtapだとユーザーモードにもアクセスできます。bpftraceも便利らしいのですが、今の所systemtapの方が年季が長い分痒いところに手が届きそうです。どちらもprintkと比べると格段の進歩を見せてくれます。2021年時点の資料だと以下のとおりです。
https://lwn.net/Articles/852112/
まとめ
Linuxカーネルがとても調べやすくなるsystemtapをUbuntu 22.04に導入してみました。今までは一日潰すつもりで調べてた作業が、体感ユーザーアプリと同じくらいの感覚で手を付けられるようになります。
ディスカッション
コメント一覧
まだ、コメントがありません