Linux システムを見える化する kernelshark の使い方 第 1 回

2022 年 11 月 07 日   Linux 技術ネタ

目次

• 1. はじめに
• 2. kernelshark とは
• 3. kernelshark の使い方
  • 3.1 UI
  • 3.2 トレースログを開く
  • 3.3 グラフの見方
    • 3.3.1 マウス操作
    • 3.3.2 イベントの見え方
  • 3.4 グラフを拡大縮小する
  • 3.5 イベント間の時間を計測する
  • 3.6 表示する CPU、タスクを設定する
    • 3.6.1 特定CPUのみを表示する
    • 3.6.2 特定タスクのみを表示する
  • 3.7 表示するイベントを設定する（フィルタ）
    • 3.7.1 特定イベントのみ表示する
    • 3.7.2 特定タスクに関係するイベントのみを表示する
    • 3.7.3 特定CPU にて発生したイベントのみを表示する
  • 3.8 イベントを確認する、検索する
    • 3.8.1 イベントを確認する
    • 3.8.2 イベントを検索する
    • 3.8.3 イベントとグラフを連動する
• 参考文献
• 次回予告

1. はじめに

組込み Linux 開発において、以下のケースに直面することはよくあるのではないでしょうか ?

• 優先度が高いアプリケーションが意図通り動作しているか確認したい
• 定周期のリアルタイムプロセスが期待する周期内に実行完了しないことがあるが何が悪いのかわからない
• 優先度逆転が発生するが原因がわからない
• 開発したドライバの挙動がおかしい。関数経路を調査したい。

このような解析をサポートするために、Linux カーネルには ftrace というトレーサーが搭載されています。様々な情報を取り出せる反面、コマンドラインでの制御が必要なため、使用性が低く、結果ファイルがテキストであるため、可読性が悪いです。この欠点を補うために、OSS ツールとして、ftrace のユーザーインターフェース trace-cmd と結果ファイルをビジュアル表示する kernelshark が用意されています。

このブログエントリでは、組込み Linux からトレースログを取得し、kernelshark で表示する一連の流れと kernelshark の機能概要を紹介します。

本ブログは全 3 部構成となります。
第 1 回目は、kernelshark の概要とその使い方について解説します。

2. kernelshark とは

kernelshark は、ftrace のユーザーインターフェース trace-cmd のフロントエンドです。ftrace のビジュアライザと言えます。いつどのプロセスがどの CPU で実行されたか（コンテキストスイッチトレース）、いつどのイベントがどの CPU で実行されたか（イベントトレース）、いつどのカーネル関数がどの CPU で実行されたか（関数トレース）などをグラフィカルに表示できます。

3. kernelshark の使い方

3.1 UI

kernelshark は、以下5つの UI から構成されます。

3.2 トレースログを開く

1. メニュー File ⇒ Open をクリックします。
2. Open File 画面でトレースログファイルを選択します。

3.3 グラフの見方

Graph Windowには、イベントの発生が時系列でプロットされたグラフが表示されます。
縦軸が表示項目です。CPU とタスクが対象です。後述の Plots メニューで表示する CPU とタスクを設定可能です。横軸は時間です。

3.3.1 マウス操作

グラフ上にマウスを置くと、マウスポインタが指している位置のタイムスタンプと、その位置にあるイベントの情報が GraphInfoArea に表示されます（マウスポインタがグラフ外にある場合は、最後に指していた位置の情報を表示）。

また、グラフ上のイベントを左ダブルクリックすると、そのイベントにマーカーが付きます。
さらに、グラフ上をドラッグして領域選択すると、その範囲を拡大表示できます。

3.3.2 イベントの見え方

• 色付きの太線は、タスクが実行中であることを示しています。
• 突き出ている縦線は、個々のイベントを示しています。
• 色付きの太線がある区間は、CPU で実行中を表します。一方、色付きの太線が無い区間は、CPU で実行されていないことを表します。

3.4 グラフを拡大縮小する

GraphControlArea の以下ボタン操作でグラフを拡大縮小します。また、上述の通り、グラフ上をドラッグして領域選択すると、その範囲を拡大表示できます。

3.5 イベント間の時間を計測する

GraphControlArea のボタンとマウス操作で 2 つの特定イベントにマーカーをつけ、その間の時間を計測することができます。例えば、A ⇒ B の順でマーカーをつけ、AB 間の時間を計測する手順は以下になります。

1. Marker A ボタンの上で左クリックします。緑色に変わります。

   

2. List Area の Graph followsにチェックを入れて、マーカーA をつけたいイベントログをクリックします。該当イベントが緑色で表示されます。また、Graph Window の対応箇所に緑色のカーソル線が表示されます。

   

3. Marker B ボタンの上で左クリックします。青緑色に変わります。

   

4. List Area でマーカー B をつけたいイベントログをクリックします。該当イベントが青緑色で表示されます。また、Graph Window の対応箇所に緑色のカーソル線が表示され、A,B Delta 欄にマーカー A, B 間の時間差が表示されます。

   

   

5. Marker A または B ボタンを右クリックするとマーカーが解除されます。

3.6 表示する CPU、タスクを設定する

Plot メニューでグラフに表示する CPU とタスクを設定することができます。各設定は、組み合わせて使用することが可能です。

3.6.1 特定CPUのみを表示する

1. メニュー Plot ⇒ CPU をクリックします。

2. CPUs 画面でグラフ表示する CPU にのみチェックを入れ、Apply を押下します。

   

   例えば、CPU0 のみにチェックを入れると、CPU0 のみが表示されます。List Area も連動します。

   

3.6.2 特定タスクのみを表示する

1. メニュー Plot ⇒ Tasks をクリックします。

2. Tasks 画面でグラフ表示するタスクのみチェックを入れ、Apply を押下します。

   

   例えば、3.8.1 の例の設定をした状態でidleタスクにチェックを入れると、CPU0 とidleタスクが表示されます。List Area も連動します。

   

3.7 表示するイベントを設定する（フィルタ）

Filter メニューでグラフに表示するイベントを設定することができます。各フィルタは、組み合わせて使用することが可能です。特定条件を指定してイベント抽出する Advanced Filtering 機能については、公式ドキュメントを参照ください。

3.7.1 特定イベントのみ表示する

1. メニュー Filter ⇒ Show events をクリックします。

2. Events 画面で表示するイベントにのみチェックを入れ、Apply を押下します。

   

3.7.2 特定タスクに関係するイベントのみを表示する

1. メニュー Filter ⇒ Show tasks をクリックします。

2. Tasks 画面で表示するタスクに関するイベントにのみチェックを入れ、Apply を押下します。

   

   例えば、<idle> のみにチェックを入れると、idle タスクで発生したイベントのみが表示されます。List Area も連動します。

   

3.7.3 特定CPU にて発生したイベントのみを表示する

1. メニュー Filter ⇒ Show CPUs をクリックします。

2. CPUs 画面で表示する CPU に関するイベントにのみチェックを入れ、Apply を押下します。

   

   例えば、CPU0 のみにチェックを入れると、CPU0 で発生したイベントのみが表示されます。List Area も連動します。

   

3.8 イベントを確認する、検索する

List Area ではイベントの確認、イベントとグラフの連動、イベントの検索を行うことができます。

3.8.1 イベントを確認する

イベント一覧からイベント情報を確認できます。

3.8.2 イベントを検索する

以下の検索ボックスを使用します。

指定の条件でイベントを検索できます。検索は以下の流れで実行します。

1. 検索対象の列を Column から選択します。
2. contains （含む）、 full match（完全一致）、 does not have （含まない）から検索条件を1つ選択します。
3. 検索文字列をボックスに入力します。
4. 後方検索する場合は Next、前方検索する場合は Prev を押下します。

3.8.3 イベントとグラフを連動する

Graph follows のチェックを使用します。

Graph follows のチェックを入れている場合、List Area 上でイベントをクリックすると、アクティブなマーカーがそのイベントに移動します。さらに、Graph Window もその位置に追従します。 選択したイベントは、Graph Window に黄色い四角（小さいので少し見づらい）で表示されます。

参考文献

• ftrace - Function Tracer -- The Linux Kernel documentation
• trace-cmd(1) - Linux manual page
• KernelShark Documentation
• Debugging the kernel using Ftrace - part 2

次回予告

第 2 回目は、kernelshark で表示するトレースログを ftrace で取得する手法について解説します。