MFC のデバッグ技術

[アーティクル]
03/10/2023

MFC プログラムをデバッグする場合は、次のデバッグ技術が役立ちます。

このトピックの内容

AfxDebugBreak

TRACE マクロ

MFC でのメモリリークの検出

メモリ割り当ての追跡
メモリ診断の有効化
メモリのスナップショットの取得
メモリ統計情報の表示
オブジェクトダンプの取得

AfxDebugBreak

MFC には、ソースコードにハードコーディングされたブレークポイント用に AfxDebugBreak 関数が用意されています。

AfxDebugBreak( );

Intel プラットフォームでは、 AfxDebugBreak は次のコードを生成します。このコードは、カーネルコードではなく、ソースコードでプログラムの実行を停止します。

_asm int 3

他のプラットフォームでは、 AfxDebugBreak は単純に DebugBreakを呼び出します。

AfxDebugBreak ステートメントは、リリースビルドの作成時には必ず削除してください。または、 #ifdef _DEBUG を使用して囲んでください。

このトピックの内容

TRACE マクロ

プログラムからのメッセージをデバッガーの [出力] ウィンドウに表示するには、 ATLTRACE マクロ、または MFC の TRACE マクロを使用します。アサーションと同様に、トレースマクロはプログラムのデバッグバージョンでだけ有効です。リリースバージョンでコンパイルされた場合は無効になります。

TRACE マクロの使用例を次に示します。 printfと同様に、 TRACE マクロは多数の引数を処理できます。

int x = 1;
int y = 16;
float z = 32.0;
TRACE( "This is a TRACE statement\n" );

TRACE( "The value of x is %d\n", x );

TRACE( "x = %d and y = %d\n", x, y );

TRACE( "x = %d and y = %x and z = %f\n", x, y, z );

TRACE マクロは、char* パラメーターと wchar_t* パラメーターの両方を適切に処理します。 TRACE マクロと異なる型の文字列パラメーターを組み合わせて使用する例を次に示します。

TRACE( "This is a test of the TRACE macro that uses an ANSI string: %s %d\n", "The number is:", 2);

TRACE( L"This is a test of the TRACE macro that uses a UNICODE string: %s %d\n", L"The number is:", 2);

TRACE( _T("This is a test of the TRACE macro that uses a TCHAR string: %s %d\n"), _T("The number is:"), 2);

TRACE マクロの詳細については、「診断サービス」を参照してください。

このトピックの内容

MFC でのメモリリークの検出

MFC には、割り当てられた後、解放されていないメモリを検出するためのクラスと関数が用意されています。

メモリ割り当ての追跡

MFC では、通常 new 演算子が使用される場所で DEBUG_NEW マクロを使用して、メモリリークの位置を特定できます。プログラムのデバッグバージョンでは、 DEBUG_NEW はメモリを割り当てた各オブジェクトのファイル名と行番号を記録します。プログラムのリリースバージョンをコンパイルするときは、 DEBUG_NEW は単に new 演算として機能し、ファイル名や行番号の情報を記録しません。したがって、プログラムのリリースバージョンの実行速度が低下することはありません。

ソースファイルで次のように DEBUG_NEW マクロを定義すると、プログラム全体を書き直さなくても、 newの代わりにこのマクロを使用できます。

#define new DEBUG_NEW

オブジェクトのダンプを実行すると、 DEBUG_NEW で割り当てられた各オブジェクトについて、メモリが割り当てられた場所のファイル名と行番号が表示されます。この情報を使用して、メモリリークの原因となったコードを特定できます。

MFC フレームワークのデバッグバージョンでは自動的に DEBUG_NEW が使用されますが、プログラマが記述するコードでは自動的には使用されません。 DEBUG_NEWを使用するには、 DEBUG_NEW を明示的に使用するか、上記のように #define new を使用する必要があります。

このトピックの内容

メモリ診断の有効化

メモリ診断機能を使用するには、あらかじめ診断トレースを有効にしておく必要があります。

メモリ診断を有効または無効にするには

グローバル関数 AfxEnableMemoryTracking を呼び出して、診断メモリアロケーターを有効または無効にします。デバッグライブラリでは既定でメモリの診断が行われるため、通常はメモリの診断を一時的にオフにするためにこの関数を使用します。診断をオフにすると、プログラムの実行速度が上がり、診断出力の量が少なくなります。

afxMemDF を使用して特定のメモリ診断機能を選択するには

メモリ診断機能をより細かく制御するには、MFC のグローバル変数 afxMemDFに値を設定することにより、個々のメモリ診断機能を個別にオン、オフします。この変数には、 afxMemDF列挙型で指定される次の値を設定できます。

値	説明
allocMemDF	診断メモリアロケーターをオンにします (既定)。
delayFreeMemDF	`delete` や `free` が呼び出された場合に、プログラムが終了するまでメモリの解放を遅らせます。これにより、プログラムで必要とする最大量のメモリが割り当てられます。
checkAlwaysMemDF	メモリが割り当てられるたび、または解放されるたびに、 AfxCheckMemory を呼び出します。

これらの値は、次のように論理 OR 演算を行うことにより、組み合わせて指定できます。

afxMemDF = allocMemDF | delayFreeMemDF | checkAlwaysMemDF;

このトピックの内容

メモリのスナップショットの取得

CMemoryState オブジェクトを作成し、 CMemoryState::Checkpoint メンバー関数を呼び出します。これにより、メモリの最初のスナップショットが作成されます。
プログラムでメモリの割り当てと解放が行われた後、別の CMemoryState オブジェクトを作成し、このオブジェクトの Checkpoint を呼び出します。これにより、メモリ状態の 2 番目のスナップショットが取得されます。
3 番目の CMemoryState オブジェクトを作成し、そのメンバー関数 CMemoryState::Difference を呼び出します。このとき、前に作成した 2 つの CMemoryState オブジェクトを引数として渡します。 2 つのメモリ状態に違いがある場合、 Difference 関数は 0 以外の値を返します。この値は、解放されていないメモリブロックがあることを示します。

コードの例を次に示します。
```
// Declare the variables needed
#ifdef _DEBUG
    CMemoryState oldMemState, newMemState, diffMemState;
    oldMemState.Checkpoint();
#endif

    // Do your memory allocations and deallocations.
    CString s("This is a frame variable");
    // The next object is a heap object.
    CPerson* p = new CPerson( "Smith", "Alan", "581-0215" );

#ifdef _DEBUG
    newMemState.Checkpoint();
    if( diffMemState.Difference( oldMemState, newMemState ) )
    {
        TRACE( "Memory leaked!\n" );
    }
#endif
```
メモリチェック用のステートメントが #ifdef _DEBUG / #endif ブロックで囲まれていることに注意してください。これによって、このコードはプログラムのデバッグバージョンでのみコンパイルされます。

メモリリークが発生していることを確認できたので、別のメンバー関数 CMemoryState::DumpStatistics を使用してメモリリークの位置を特定できます。

このトピックの内容

メモリ統計情報の表示

CMemoryState::Difference 関数は、2 つのメモリ状態オブジェクトを参照し、1 つ目の状態から 2 つ目の状態までの間にヒープから解放されなかったオブジェクトを検出します。メモリのスナップショットを取得して、それらのメモリを CMemoryState::Differenceを使用して比較した後、 CMemoryState::DumpStatistics を呼び出すと、解放されなかったオブジェクトに関する情報を取得できます。

次のような例が考えられます。

if( diffMemState.Difference( oldMemState, newMemState ) )
{
    TRACE( "Memory leaked!\n" );
    diffMemState.DumpStatistics();
}

このコード例では、次の情報がダンプされます。

0 bytes in 0 Free Blocks
22 bytes in 1 Object Blocks
45 bytes in 4 Non-Object Blocks
Largest number used: 67 bytes
Total allocations: 67 bytes

Free Blocks というのは、 afxMemDF が delayFreeMemDFに設定されている場合、解放が遅れているブロックのことです。

2 行目に示されている Object Blocks は、ヒープ上に割り当てられたままになっているブロックです。

Non-Object Blocks には、 newによって割り当てられた配列と構造体が含まれます。この例では、ヒープ上に割り当てられた後で解放されていない Non-Object Blocks が 4 つあります。

Largest number used は、プログラムが占有したメモリの最大値を示します。

Total allocations は、プログラムで使用されたメモリの総量を示します。

このトピックの内容

オブジェクトダンプの取得

MFC プログラムでは、CMemoryState::DumpAllObjectsSince を使用して、割り当て解除されていないヒープ上のすべてのオブジェクトの記述をダンプできます。 DumpAllObjectsSince は、前回の CMemoryState::Checkpointを呼び出します。 Checkpoint が一度も呼び出されていない場合、 DumpAllObjectsSince はメモリ上に存在するオブジェクトと非オブジェクトをすべてダンプします。

Note

MFC のオブジェクトダンプ機能を使用する場合は、あらかじめ診断トレースを有効にしておく必要があります。

Note

MFC では、メモリリークが発生したオブジェクトはすべてプログラムの終了時に自動的にダンプされるため、オブジェクトをダンプするためにコードを作成する必要はありません。

次のコードは、2 つのメモリ状態を比較することによってメモリリークを調べ、リークが検出された場合はすべてのオブジェクトをダンプします。

if( diffMemState.Difference( oldMemState, newMemState ) )
{
    TRACE( "Memory leaked!\n" );
    diffMemState.DumpAllObjectsSince();
}

次のような情報がダンプされます。

Dumping objects ->

{5} strcore.cpp(80) : non-object block at $00A7521A, 9 bytes long
{4} strcore.cpp(80) : non-object block at $00A751F8, 5 bytes long
{3} strcore.cpp(80) : non-object block at $00A751D6, 6 bytes long
{2} a CPerson at $51A4

Last Name: Smith
First Name: Alan
Phone #: 581-0215

{1} strcore.cpp(80) : non-object block at $00A7516E, 25 bytes long

行の先頭に記述されている中かっこ内の数字は、そのオブジェクトが割り当てられた順番を示します。後に割り当てられたオブジェクトほど数字は大きくなり、ダンプ情報の上部に表示されます。

オブジェクトダンプによって最大限の情報を得るには、任意の Dump 派生オブジェクトの CObjectメンバー関数をオーバーライドして、オブジェクトダンプをカスタマイズします。

特定のメモリ割り当てにブレークポイントを設定するには、グローバル変数 _afxBreakAlloc に中かっこ内の数字を設定します。再びプログラムを実行すると、そのメモリ割り当てが行われる時点で停止します。この時点で呼び出し履歴を調べると、問題の割り当てが行われた経緯がわかります。

C ランタイムライブラリにも同様の関数 _CrtSetBreakAllocがあり、C ランタイムでのメモリ割り当てに対して使用できます。

このトピックの内容

メモリダンプの解釈

次のオブジェクトダンプを詳しく検討してください。

{5} strcore.cpp(80) : non-object block at $00A7521A, 9 bytes long
{4} strcore.cpp(80) : non-object block at $00A751F8, 5 bytes long
{3} strcore.cpp(80) : non-object block at $00A751D6, 6 bytes long
{2} a CPerson at $51A4

Last Name: Smith
First Name: Alan
Phone #: 581-0215

{1} strcore.cpp(80) : non-object block at $00A7516E, 25 bytes long

このダンプを生成したプログラムでは、メモリが明示的に割り当てられているのは 2 か所だけ (1 つはスタック上、もう 1 つはヒープ上) です。

// Do your memory allocations and deallocations.
CString s("This is a frame variable");
// The next object is a heap object.
CPerson* p = new CPerson( "Smith", "Alan", "581-0215" );

CPerson コンストラクターは、引数として charへの 3 つのポインターをとり、これらの引数を使用して CString メンバー変数を初期化します。メモリダンプ情報を調べてみると、 CPerson オブジェクトと一緒に 3 つの非オブジェクトブロック (non-object block) (3、4、5) が表示されています。これらのブロックは CString メンバー変数の文字を格納しており、 CPerson オブジェクトのデストラクターが呼び出されても削除されないことがわかります。

2 番目にメモリが割り当てられたブロックは CPerson オブジェクト自体です。 $51A4 はブロックのアドレスを表し、その後にオブジェクトの内容が表示されています。この情報は、 CPersonDumpAllObjectsSinceDump によって呼び出された ::が出力したものです。

1 番目にメモリが割り当てられたブロックは、その割り当て番号とサイズから、 CString のフレーム変数に割り当てられていることがわかります。ブロックサイズは、 CString のフレーム変数の文字数と一致しています。フレーム上に割り当てられた変数は、フレームがスコープ外に出ると自動的に解放されます。

フレーム変数

通常、フレーム変数に割り当てられているヒープオブジェクトについては、フレーム変数がスコープ外に出ると自動的に解放されるため、メモリリークについて心配する必要はありません。メモリダンプの診断出力にフレーム変数の記述が含まれないようにするには、フレーム変数のスコープ外で Checkpoint を呼び出す必要があります。たとえば、次のように、前のプログラム例のメモリ割り当てコードを中かっこで囲んでスコープを限定します。

oldMemState.Checkpoint();
{
    // Do your memory allocations and deallocations ...
    CString s("This is a frame variable");
    // The next object is a heap object.
    CPerson* p = new CPerson( "Smith", "Alan", "581-0215" );
}
newMemState.Checkpoint();

中かっこでスコープを限定したため、この例から出力されるメモリダンプ情報は次のようになります。

Dumping objects ->

{5} strcore.cpp(80) : non-object block at $00A7521A, 9 bytes long
{4} strcore.cpp(80) : non-object block at $00A751F8, 5 bytes long
{3} strcore.cpp(80) : non-object block at $00A751D6, 6 bytes long
{2} a CPerson at $51A4

Last Name: Smith
First Name: Alan
Phone #: 581-0215

非オブジェクトへの割り当て

割り当てには、 CPersonなどのオブジェクトへの割り当てと、非オブジェクトへの割り当てがあります。 "非オブジェクトへの割り当て" とは、CObject から派生していないオブジェクトに対する割り当て、または C のプリミティブ型 (char、int、long など) に対する割り当てのことです。 CObject の派生クラスによって内部バッファーなどの領域が追加で割り当てられる場合、これらのオブジェクトについては、オブジェクトへの割り当てと非オブジェクトへの割り当ての両方が表示されます。

メモリリークの防止

上のコードでは、 CString のフレーム変数に割り当てられたメモリブロックは自動的に解放されたため、メモリリークとして表示されていません。スコープ規則によってメモリを自動的に解放すると、フレーム変数に関連するメモリリークのほとんどを解消できます。

一方、ヒープ上に割り当てられたオブジェクトについては、メモリリークを防ぐために明示的に削除する必要があります。前のプログラム例で、最後のメモリリークを解消するには、ヒープ上に割り当てられた CPerson オブジェクトを次のように削除します。

{
    // Do your memory allocations and deallocations.
    CString s("This is a frame variable");
    // The next object is a heap object.
    CPerson* p = new CPerson( "Smith", "Alan", "581-0215" );
    delete p;
}

このトピックの内容

オブジェクトダンプのカスタマイズ

CObjectから派生クラスを作成するときに Dump メンバー関数をオーバーライドすると、 DumpAllObjectsSince を使用して出力ウィンドウにオブジェクトをダンプするときに、追加情報を提供できます。

Dump 関数は、オブジェクトのメンバー変数の内容をテキスト形式でダンプコンテキスト (CDumpContext) に書き込みます。ダンプコンテキストは、入出力ストリームに類似しています。追加演算子 (<<) を使用して、 CDumpContextを呼び出します。

Dump 関数をオーバーライドするときは、まず基底クラスの Dump を呼び出して、基底クラスのオブジェクトの内容をダンプします。その後、派生クラスの各メンバー変数について、テキスト形式の説明と値を出力します。

Dump 関数の宣言例を次に示します。

class CPerson : public CObject
{
public:
#ifdef _DEBUG
    virtual void Dump( CDumpContext& dc ) const;
#endif

    CString m_firstName;
    CString m_lastName;
    // And so on...
};

オブジェクトのダンプは、プログラムをデバッグする場合にだけ必要です。したがって、 Dump 関数の宣言は #ifdef _DEBUG と #endif で囲みます。

次の例の Dump 関数は、まず基底クラスの Dump 関数を呼び出します。その後、各メンバー変数の簡単な説明を各メンバーの値と一緒に診断ストリームに書き込みます。

#ifdef _DEBUG
void CPerson::Dump( CDumpContext& dc ) const
{
    // Call the base class function first.
    CObject::Dump( dc );

    // Now do the stuff for our specific class.
    dc << "last name: " << m_lastName << "\n"
        << "first name: " << m_firstName << "\n";
}
#endif

ダンプの出力先を指定するために、 CDumpContext に引数を渡す必要があります。 MFC のデバッグバージョンでは、 CDumpContext という定義済みの afxDump オブジェクトを渡して、出力をデバッガーに送ります。

CPerson* pMyPerson = new CPerson;
// Set some fields of the CPerson object.
//...
// Now dump the contents.
#ifdef _DEBUG
pMyPerson->Dump( afxDump );
#endif

このトピックの内容

MFC デバッグビルドのサイズの縮小

大型の MFC アプリケーションでは、デバッグ情報でかなりのディスク容量が占有される場合があります。次のいずれかの手順を使用して、サイズを縮小できます。

/Z7 ではなく、/Z7、/Zi、/ZI (デバッグ情報の形式) オプションを使用して、MFC ライブラリをリビルドします。これらのオプションを指定すると、ライブラリ全体のデバッグ情報を格納する単一のプログラムデータベース (PDB) ファイルがビルドされます。これによって、無駄をなくしてディスク容量を節約できます。
MFC ライブラリをデバッグ情報なしでリビルドします (/Z7、/Zi、/ZI (デバッグ情報の形式) オプションがありません)。この場合、デバッグ情報がないため、MFC ライブラリのコード内で大半のデバッガー機能を使用できなくなります。しかし、MFC ライブラリは完全にデバッグ済みであるため、このことは問題にはなりません。
次に示すように、選択したモジュールのデバッグ情報だけを追加してアプリケーションをビルドする。

このトピックの内容

選択したモジュールのデバッグ情報を持つ MFC アプリケーションのビルド

選択したモジュールを MFC デバッグライブラリと一緒にビルドすると、これらのモジュール内で、ステップ実行やその他のデバッグ機能を使用できます。この手順ではプロジェクトのデバッグ構成とリリース構成の両方を使用するため、以下の手順に示した変更が必要になります (また、完全なリリースビルドが必要な場合は、"すべてをリビルドする" 必要があります)。

ソリューションエクスプローラーで、プロジェクトを選択します。
[表示] メニューの [プロパティページ]をクリックします。
まず、新しいプロジェクト構成を作成します。
1. [<プロジェクト> プロパティページ] ダイアログボックスで、[構成マネージャー] ボタンをクリックします。
2. [構成マネージャー] ダイアログボックスのグリッド内でプロジェクトを見つけます。 [構成] 列の [<新規作成>] を選択します。
3. [新規プロジェクト構成] ダイアログボックスの [Project Configuration Name] ボックスに、新しいプロジェクト構成に付ける名前を "Partial Debug" のように入力します。
4. [設定のコピー元] ボックスの [Release]をクリックします。
5. [OK] をクリックして、[新しいプロジェクト構成] ダイアログボックスを閉じます。
6. [構成マネージャー] ダイアログボックスを閉じます。
次に、プロジェクト全体に関するオプションを設定します。
1. [プロパティページ] ダイアログボックスで、 [構成プロパティ] フォルダーの下の [全般] カテゴリを選択します。
2. プロジェクト設定グリッドで、 [プロジェクトの既定値] が展開されていない場合は展開します。
3. [プロジェクトの既定値]の下の [MFC の使用]を見つけます。現在の設定値がグリッドの右列に表示されます。現在の設定値をクリックし、 [スタティックライブラリで MFC を使用する]に変更します。
4. [プロパティページ] ダイアログボックスの左ペインで、 [C/C++] フォルダーを開き、 [プリプロセッサ]を選択します。プロパティグリッドで、 [プロセッサの定義] を見つけ、"NDEBUG" を "_DEBUG" に置き換えます。
5. [プロパティページ] ダイアログボックスの左ペインで、 [リンカー] フォルダーを開き、 [入力] カテゴリを選択します。プロパティグリッドで、 [追加の依存ファイル]を見つけます。 [追加の依存ファイル] の設定値として「NAFXCWD.LIB」および「LIBCMT」と入力します。
6. [OK] をクリックして、新しいビルドオプションを保存し、 [プロパティページ] ダイアログボックスを閉じます。
[ビルド] メニューの [リビルド]をクリックします。これにより、モジュールからデバッグ情報がすべて削除されますが、MFC ライブラリに影響はありません。
次に、選択したアプリケーションモジュールに、デバッグ情報を改めて追加します。ブレークポイントの設定やその他のデバッガー機能を使用できるのは、デバッグ情報を追加してコンパイルしたモジュールだけです。デバッグ情報を追加するプロジェクトファイルごとに、次の手順を実行します。
1. ソリューションエクスプローラーで、該当するプロジェクトの下にある [ソースファイル] フォルダーを開きます。
2. デバッグ情報を設定するファイルを選択します。
3. [表示] メニューの [プロパティページ]をクリックします。
4. [プロパティページ] ダイアログボックスで、 [構成プロパティ] フォルダーの下の [C/C++] フォルダーを開き、 [全般] カテゴリを選択します。
5. プロパティグリッドで、[デバッグ情報の形式] を見つけます。
6. [デバッグ情報の形式] の設定値をクリックし、デバッグ情報のオプション (通常は /ZI) を選択します。
7. アプリケーションウィザードで生成されたアプリケーションを使用している場合や、プリコンパイル済みヘッダーがある場合は、他のモジュールをコンパイルする前に、プリコンパイル済みヘッダーを無効にするか再コンパイルする必要があります。この処理を行わないと、警告メッセージ C4650 とエラーメッセージ C2855 が表示されます。プリコンパイルヘッダーを無効にするには、[<プロジェクト> プロパティページ] ダイアログボックス ([構成プロパティ] フォルダーの [C/C++] サブフォルダーにある [プリコンパイル済みヘッダー] カテゴリ) の [プリコンパイル済みヘッダーの作成/使用] 設定を変更します。
[ビルド] メニューの [ビルド] をクリックし、最新ではないプロジェクトファイルをリビルドします。

このトピックで解説した方法の代わりに、外部メイクファイルを使用して、各ファイルに個別のオプションを定義することもできます。その場合、MFC デバッグライブラリとリンクするには、モジュールごとに _DEBUG フラグを定義する必要があります。 MFC リリースライブラリを使用する場合は、NDEBUG を定義する必要があります。外部メイクファイルの記述方法については、「 NMAKE の実行」を参照してください。

このトピックの内容

ネイティブコードのデバッグ

次の方法で共有

MFC のデバッグ技術

このトピックの内容

AfxDebugBreak

TRACE マクロ

MFC でのメモリリークの検出

メモリ割り当ての追跡

メモリ診断の有効化

メモリのスナップショットの取得

メモリ統計情報の表示

オブジェクトダンプの取得

メモリダンプの解釈

オブジェクトダンプのカスタマイズ

MFC デバッグビルドのサイズの縮小

選択したモジュールのデバッグ情報を持つ MFC アプリケーションのビルド

フィードバック

その他のリソース

次の方法で共有

MFC のデバッグ技術

このトピックの内容

AfxDebugBreak

TRACE マクロ

MFC でのメモリ リークの検出

メモリ割り当ての追跡

メモリ診断の有効化

メモリのスナップショットの取得

メモリ統計情報の表示

オブジェクト ダンプの取得

メモリ ダンプの解釈

オブジェクト ダンプのカスタマイズ

MFC デバッグ ビルドのサイズの縮小

選択したモジュールのデバッグ情報を持つ MFC アプリケーションのビルド

関連するコンテンツ

フィードバック

その他のリソース

MFC でのメモリリークの検出

オブジェクトダンプの取得

メモリダンプの解釈

オブジェクトダンプのカスタマイズ

MFC デバッグビルドのサイズの縮小