例外が発生した場合ー２（連載１３）

(2023/9/13)

［連載１３］ 例外が発生した場合ー２

前回は、例外が発生した場合のデバッガの振る舞いについて記載しましたが、すべて書ききれたわけではありません。

今回は、もう一つの機能についてご紹介します。

予期しない例外が発生した場合、その時点のスナップショットを指定の場所に保存しておく機能について、ご紹介します。

先程のURLにある前半部分と、その前準備です。

http://solid.kmckk.com/doc/skit/current/user_guide/crashdump_debug.html

前回同様、Cortex-A9搭載ボード×PARTNER Jet2の組み合わせで動かしてみます。

SOLIDでのスナップショット機能は、OSの実装レイヤを作成することで機能するようになっています。

今回は、この実装レイヤを、スナップショットをメモリに保存する、という方法でご紹介します。
この方法は、評価ボードを使用している時など、デバッグ初期のシステムで有効な手段です。

SOLIDを製品に適応するような場合は、この実装レイヤを、例えばSDカードなど何らかのストレージに保存するように作成することで、JTAGデバッガなどがない時でもスナップショットを取得できるようにする事ができます。

3.1 保存先のアドレスを決める

まず、保存先をどこにするのかを決めます。
書き込みが可能な場所であり、どこからも使われていない場所である必要があります。

今回も引き続き、前回のデータアボート発生プログラムを使用します。

では、使われていないところを見てみましょう。
こういう場合はMMUの登録状態を見れば良いです。
という事で、ソリューションエクスプローラにある、memory_map.smmファイルをダブルクリックして、[メモリマップデザイナ]ウインドウを立ち上げてみましょう。

※[メモリマップデザイナ]ウインドウについては、過去記事でご紹介しています。

https://note.com/yn_2022/n/n40b4e94e7a01#34de5483-0322-4a4e-960a-bd70b75e4139

RAMとして割り当てられている領域の最終物理アドレスは0x4bffffffです。

物理アドレス0x4c000000から0x5cffffffまで空いていることになるので、この領域を「保存先のアドレス」として使いましょう。

3.2 保存先をMMUに登録する

先程開けた0x4c000000～をメモリマップデザイナに登録し(正しくは、[メモリマップデザイナ]ウインドウ経由でMMUに登録し)、使えるようにします。
仮想アドレスは0x20000000あたりが空いているようです。なのでそうしましょう。

[メモリマップデザイナ]ウインドウの左上にある[Add]ボタンを押して、メモリコンフィグレーションを追加します。

新規行を、以下のように変更します。

これで保存先メモリの準備が整いました。

3.3 スナップショットの作成

次に、int SOLID_SNAPSHOT_Create(uint32_t attr, SOLID_CPU_CONTEXT *pContext)により、スナップショットを作成します。

今回は、自作例外ハンドラから、例外発生時のコンテキストの状態をスナップショットすることが目的なので、自作例外ハンドラ内に記述します。

第２引数には、例外ハンドラに渡されている pContextを指定します。

static int my_dabort_handler(void* param, SOLID_CPU_CONTEXT* pContext)
{
    int snapshot_result;

    /* データアボート時にスナップショットを生成 */
    snapshot_result = SOLID_SNAPSHOT_Create(SOLID_SNAPSHOT_ATTR_DEBUG, pContext);

スナップショットとして保存する内容は、以下のURLに記載されています。

http://solid.kmckk.com/doc/skit/current/os/cs/snapshot.html#solid-snapshot-attr

今回はお試しとして、SOLID_SNAPSHOT_ATTR_DEBUG属性を選択しました。

この属性を選択すると、SOLID_CORE, SOLID_HEAP, OSSTACKも保存されるので、後から例外発生時の状況をデバッガで再現することができます（！）

ちなみに、SOLID_SNAPSHOT_AddUserArea(SOLID_ADDRESS addr, size_t size)を使用すれば、スナップショットに保存したい領域を指定することもできます。
「このバッファがどうなっていたか知りたいからスナップショットしてほしい！」
という使い方など、可能です。

3.4 要実装関数

以下３つの要実装関数があります。

int IMPL_SNAPSHOT_Open()：
スナップショット機能の最初に呼び出される

int IMPL_SNAPSHOT_Write(const void *pData, size_t size)：
スナップショットの内容が通知される

int IMPL_SNAPSHOT_Close()：
スナップショット機能の最後に呼び出される

必要であれば実装することができます。
今回は、スナップショットのデータ内容を、先ほど保存領域として設定した場所に書き込んでいくことにします。

ですので、IMPL_SNAPSHOT_Open()関数は不要なので、空の関数として実装しておきます。

IMPL_SNAPSHOT_Write()関数には、先ほど保存領域として設定した場所に書きこむコードを実装します。

IMPL_SNAPSHOT_Close()には、保存した領域の最終アドレスをシリアルターミナルに出力するようにしてみます。

int IMPL_SNAPSHOT_Open(){
	return SOLID_ERR_OK;
}

SOLID_ADDRESS write_addr = 0x20000000;
int IMPL_SNAPSHOT_Write(const void *pData, size_t size){

        if ((write_addr + size) > 0x24000000) return SOLID_ERR_NOMEM;
        memcpy((void *)write_addr, pData, size);
        write_addr += size;

	return SOLID_ERR_OK;
}

int IMPL_SNAPSHOT_Close(){
	syslog(LOG_INFO, "SanpShot from 0x20000000 to 0x%x", (write_addr-1));
	return SOLID_ERR_OK;
}

3.5 実行

では、データアボート例外を発生させ、例外ベクタ関数の最後でブレークしてみましょう。
保存先RAMの中身を、下部に表示してみました。

データが保存されていますね。

シリアルターミナルを見てみます。

スナップショット保存領域が表示されました。

この内容を、ファイルシステムに変換してPCからバイナリエディタで見ることによって、何が発生したのかの解析の手がかりにできます。

さらに、今回はRAM保存にしましたが、システムにSDカードがあるのであればそちらにファイルシステムとして保存すれば簡単に持ち運びできたりもしますね。