関数トレース（連載１６）

デバッガの機能の一つに、トレースの情報を取得する機能があります。
一般的に思いつくのは、ICEにトレースプローブを付ける方法です。
マイコンチップのトレース用端子とトレースアダプタを接続し、そこから分岐情報やバス情報等拾ってトレースを行います。

この場合、トレースの情報を抽出し出力するのは、ハードウェアによって行われるため、どのようなファームウェアに対してもトレースが取れます。
ブート回り、ベアメタルファームウェア、等、どんな場合にでもトレース用端子を接続しさえすればOK。

思えば、筆者も大変にお世話になりました。
評価ボードを大きくしたくないという理由でトレース用端子がテストピンにまったく出ていない場合でも、その端子を直接極細プローブで引っ掛けて無理矢理トレースを取ったりしていましたね。。。
昔のマイコンチップは端子間がもう少し大きかったなぁ。。。（遠い目）

おっと、昔を懐かしんでしまいました。
話を戻します。
ちなみに、端子を使わなくてよいトレース機能もあります。
デバイスの内部にあるトレースバッファに、情報をためていく方式です。
しかしながら、トレースバッファはあまり大きくはなく、欲しいデータを取ることが難しかったりします。

ここまでは、ハードウェア（端子やデバイス内蔵バッファ）によるトレース機能について、です。

ここからは、関数トレースという機能について。
先のハードウェアによるトレース機能でも、デバッガでフィルタリングし関数トレースを行う事は可能です。
ですがSOLIDでは
特別なハードウェア不要の関数トレース機能
を実現しています。
トレース端子もトレースプローブも不要なので、今すぐここで動かせます。

早速見ていきましょう！

先の例では、命令数が10命令以上の関数すべてをトレース取得の対象にしました。
ですが、
トレース取得の対象にする＝トレース収集のオーバーヘッドが存在する
なので、できれば対象範囲は少ない方が良いです。
それにあまり沢山取れてしまっても、後から見るのが大変だったりもしますよね。。。

という事で、トレース取得したい対象を選択する方法についてご紹介します。
先に説明した、「トレース取得の対象とする関数の命令数を適切に設定する」以外にも、選択する方法があります。

4.1 取得したい関数名を指定する

先程の関数トレースウインドウで、[Patch all]を選択しましたが、そうではなく関数単位に選択することも可能です。
[Patch]を選択します。

このように、選択することが可能です。

例えばイベントフラグの推移をトレースしたい場合、ここでイベント操作系関数のみトレースする、という使い方もできますね。

4.2 ファイル単位で選択する

先のご紹介では、「プロジェクト」のプロパティから[XRay]を有効にしましたが、
実はファイル単位でも可能です。

対象とするファイルのプロパティから、[XRay]を有効にすることができます。

こうすると、選択したファイルに書かれている関数をまるっと全部、トレース対象とすることができます。（命令数が、設定したしきい値以上である全関数です）

実現方法について少し触れます。
Clangコンパイラの” XRay instrumentation”という機能を使って実現しています。
以下に詳細記載されています。

https://llvm.org/docs/XRayExample.html

関数の中にトレースができるような命令を埋め込む機能です。

Xray を有効にしたときに、コンパイラは、命令数のしきい値を越える関数にだけ、先頭と最後尾に、「数個の連続するNOP命令」を出力します。
これが準備③に該当します。

デバッガは、RAM 上の 「数個のNOP命令」 の部分を、「関数トレースのランタイムを呼び出すコード」に書き換えます。準備④に該当します。
書き換え対象とする関数は、準備④で、パッチ適用を行った関数となります。
ここで使われている「パッチ」とは、「バイナリパッチを当てる」という意味です。

関数トレースのランタイムは、SOLID-OSが持っています。

さらに、プログラムが動作しブレークするとします。
この時、SOLID-IDEの方で、トレース情報を吸い上げ、GUIに表示します。

まさに三位一体、OSとデバッガが協力して、Clangコンパイラの機能を使いこなしています。

実行速度についても少し補足します。
命令を埋め込むという事は、実行速度が落ちるようにも思いますが、トレース対象関数ではない場合はNOP数個埋め込むだけですよね。

近年の高速なCPUであれば、NOP命令の実行には、ほとんどCPUのサイクル数を使わないので、メモリサイズの点で許されるのであれば「製品版ソフトも XRay有効でビルド」し、その上で、市場で問題が起きたときに関数トレースを取るといった使い方も考えられます。