C++でWindowsのダンプファイル出力を作る

アクセスバイオレーションなどでクラッシュした際、ダンプファイルを出力できると、後々のデバッグやユーザーサポートに役立ちます。Windows には構造化例外処理というものがあり、それを利用することで、クラッシュ時にダンプファイルを生成するようなプログラムを書くことができます。

クラッシュダンプの出力自体は、以下のページを参考に。

ダンプファイルの出力

クラッシュダンプの分析ページのソースコードをそのまま掲載。しています。

#include <dbghelp.h>
#include <shellapi.h>
#include <shlobj.h>

int GenerateDump(EXCEPTION_POINTERS* pExceptionPointers)
{
    BOOL bMiniDumpSuccessful;
    WCHAR szPath[MAX_PATH]; 
    WCHAR szFileName[MAX_PATH]; 
    WCHAR* szAppName = L"AppName";
    WCHAR* szVersion = L"v1.0";
    DWORD dwBufferSize = MAX_PATH;
    HANDLE hDumpFile;
    SYSTEMTIME stLocalTime;
    MINIDUMP_EXCEPTION_INFORMATION ExpParam;

    GetLocalTime( &stLocalTime );
    GetTempPath( dwBufferSize, szPath );

    StringCchPrintf( szFileName, MAX_PATH, L"%s%s", szPath, szAppName );
    CreateDirectory( szFileName, NULL );

    StringCchPrintf( szFileName, MAX_PATH, L"%s%s\\%s-%04d%02d%02d-%02d%02d%02d-%ld-%ld.dmp", 
               szPath, szAppName, szVersion, 
               stLocalTime.wYear, stLocalTime.wMonth, stLocalTime.wDay, 
               stLocalTime.wHour, stLocalTime.wMinute, stLocalTime.wSecond, 
               GetCurrentProcessId(), GetCurrentThreadId());
    hDumpFile = CreateFile(szFileName, GENERIC_READ|GENERIC_WRITE, 
                FILE_SHARE_WRITE|FILE_SHARE_READ, 0, CREATE_ALWAYS, 0, 0);

    ExpParam.ThreadId = GetCurrentThreadId();
    ExpParam.ExceptionPointers = pExceptionPointers;
    ExpParam.ClientPointers = TRUE;

    bMiniDumpSuccessful = MiniDumpWriteDump(GetCurrentProcess(), GetCurrentProcessId(), 
                    hDumpFile, MiniDumpWithDataSegs, &ExpParam, NULL, NULL);

    return EXCEPTION_EXECUTE_HANDLER;
}


void SomeFunction()
{
    __try
    {
        int *pBadPtr = NULL;
        *pBadPtr = 0;
    }
    __except(GenerateDump(GetExceptionInformation()))
    {
    }
}

さて、なぜこのブログを書いたかというと、

 __try

あたりが、Visual Studio でただ書いただけだとうまくコンパイルが通らないのです。

コンパイル設定を変更

まず、構造化例外処理を使うには、Exe のコンパイル設定を変更する必要があります。

[構成プロパティ] - [C/C++] - [コード生成] - [C++の例外を有効にする] をはい - SEH の例外あり (/EHa) に変更します。

これをやっておかないと、なんだかうまく例外をキャッチしてくれません。

コンパイルが通らなくなる

これで、

__try

が動いてくれるのですが、

__try ～ __except

のが複雑になってくると、コンパイラエラー C2712 が発生するようになってしまいます。正直、これはよくわかりません…

C++ の例外でラッパーする

__try

をやめて、単に C++ の例外で囲めばよいのではないかと思ったのですが、すると、ダンプ生成で欲しい

EXCEPTION_POINTERS

のポインタが取得できません。そこで、調べてみると、C++ での構造化例外の処理という記事があり、これを試してみました。

手順としては以下の通り。

ラッパー用のクラスを定義
変換関数を書く
```
_set_se_translator
```
で変換関数を登録する

ラッパークラスと変換関数は書いてみるとこんな感じ。

class CC_SE_Exception {
private:
	CC_SE_Exception() {}
	unsigned int nSE;
	_EXCEPTION_POINTERS* exPointer;

public:
	CC_SE_Exception(const CC_SE_Exception& e) : nSE(e.nSE), exPointer(e.exPointer) {}
	CC_SE_Exception(unsigned int n, _EXCEPTION_POINTERS* ex) : nSE(n), exPointer(ex) {}
	~CC_SE_Exception() {}
	unsigned int getSeNumber()const { return nSE; }
	_EXCEPTION_POINTERS* getExPointer()const { return exPointer; }
};

void cc_se_trans_func(unsigned int u, _EXCEPTION_POINTERS* pExp) {
	throw CC_SE_Exception(u, pExp);
}

あとは、この例外をキャッチして、メンバの exPointer を GenerateDump に渡せば完了です。この方法なら、先ほどの C2712 も発生しませんでした。

まとめ

ダンプファイルの出力方法をまとめました。ポイントは以下の 3 つ。

MiniDumpWriteDump でダンプファイルを作れる
構造化例外処理を有効にするために、コンパイル設定で /EHa に変更する
C++ の例外処理に変換する

C++でWindowsのダンプファイル出力を作る

ダンプファイルの出力

コンパイル設定を変更

コンパイルが通らなくなる

C++ の例外でラッパーする

まとめ

目次

アウトライン