CRT ライブラリを使用したメモリリークの検出

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

メモリリークは、C/C++ アプリのバグの中でわかりづらく検出しにくいものの 1 つです。メモリリークが発生するのは、以前に割り当てられていたメモリの割り当てを適切に解除できなかった場合です。わずかなメモリリークは最初は認識されないことがありますが、長期にわたると、アプリケーションがメモリ不足になり、パフォーマンスの低下からクラッシュまで、さまざまな兆候が現れる可能性があります。メモリリークしているアプリケーションによってすべての使用可能なメモリが消費されると、別のアプリケーションがクラッシュし、原因となったアプリケーションの特定が困難になることもあります。害のないメモリリークであっても、修正が必要な別の問題を示している可能性があります。

Visual Studio デバッガーと C ランタイムライブラリ (CRT) は、メモリリークを検出して特定するのに役立ちます。

メモリリーク検出の有効化

メモリリークを検出するための主なツールは、C/C++ デバッガーと CRT デバッグヒープ関数です。

すべてのデバッグヒープ関数を有効にするには、次のステートメントを C++ プログラムに次の順序で追加します。

#define _CRTDBG_MAP_ALLOC
#include <stdlib.h>
#include <crtdbg.h>

#define ステートメントにより、CRT ヒープ関数の基本バージョンがデバッグバージョンに対応付けられます。 #define ステートメントを省略した場合、メモリリークダンプに含まれる情報が少なくなります。

crtdbg.h を含めると、関数がmallocfreeデバッグバージョンにマップされ_free_dbg、_malloc_dbgメモリの割り当てと割り当て解除が追跡されます。この対応付けは、 _DEBUGが定義されているデバッグビルドでだけ行われます。リリースビルドでは、通常の malloc 関数と free 関数が使用されます。

上記のステートメントを使用してデバッグヒープ関数を有効にしたら、アプリの終了ポイントの前に _CrtDumpMemoryLeaks 呼び出しを行い、アプリが終了したときにメモリリークレポートを表示します。

_CrtDumpMemoryLeaks();

アプリに複数の終了があっても、すべての終了ポイントに手動で _CrtDumpMemoryLeaks を配置する必要はありません。各終了ポイントで自動的に _CrtDumpMemoryLeaks が呼び出されるようにするには、ここに示すビットフィールドを使用してアプリケーションの先頭に _CrtSetDbgFlag の呼び出しを配置します。

_CrtSetDbgFlag ( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF );

既定では、 _CrtDumpMemoryLeaks は、メモリリークレポートを [出力] ウィンドウの デバッグ ウィンドウに出力します。ライブラリを使用すると、情報の出力場所が別の場所に変更されることがあります。

次に示すように _CrtSetReportMode を使用して、レポートを別の場所にリダイレクトしたり、[出力] ウィンドウに戻したりすることができます。

_CrtSetReportMode( _CRT_WARN, _CRTDBG_MODE_DEBUG );

次の例は、単純なメモリリークを示し、次を使用してメモリリーク情報を _CrtDumpMemoryLeaks();表示します。

// debug_malloc.cpp
// compile by using: cl /EHsc /W4 /D_DEBUG /MDd debug_malloc.cpp
#define _CRTDBG_MAP_ALLOC
#include <stdlib.h>
#include <crtdbg.h>
#include <iostream>

int main()
{
    std::cout << "Hello World!\n";

    int* x = (int*)malloc(sizeof(int));

    *x = 7;

    printf("%d\n", *x);

    x = (int*)calloc(3, sizeof(int));
    x[0] = 7;
    x[1] = 77;
    x[2] = 777;

    printf("%d %d %d\n", x[0], x[1], x[2]);

    _CrtSetReportMode(_CRT_WARN, _CRTDBG_MODE_DEBUG); 
    _CrtDumpMemoryLeaks();
}

メモリリークレポートの解釈

アプリケーションで _CRTDBG_MAP_ALLOCを定義していない場合は、_CrtDumpMemoryLeaks により次のようなメモリリークレポートが出力されます。

Detected memory leaks!
Dumping objects ->
{18} normal block at 0x00780E80, 64 bytes long.
 Data: <                > CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD
Object dump complete.

アプリケーションで _CRTDBG_MAP_ALLOC を定義している場合は、次のようなメモリリークレポートが出力されます。

Detected memory leaks!
Dumping objects ->
c:\users\username\documents\projects\leaktest\leaktest.cpp(20) : {18}
normal block at 0x00780E80, 64 bytes long.
 Data: <                > CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD CD
Object dump complete.

2 つ目のレポートには、リークしているメモリが最初に割り当てられたファイル名と行番号が表示されます。

_CRTDBG_MAP_ALLOC を定義するかどうかにかかわらず、メモリリークレポートには次のように表示されます。

メモリの割り当て番号 (この例では 18)
ブロックの種類 (この例では normal)
16 進形式で表したメモリ位置 (この例では 0x00780E80)
ブロックのサイズ (この例では 64 bytes)
ブロックのデータの最初の 16 バイト (16 進形式)

メモリブロックの種類は、normal、client、または CRT です。 normal ブロック は、プログラムによって割り当てられる通常のメモリです。 client ブロック は、デストラクターを必要とするオブジェクト用に、MFC プログラムが使用する特殊なメモリブロックです。 MFC の new 演算子は、作成されるオブジェクトに応じて、normal ブロックまたは client ブロックを作成します。

CRT ブロック は、CRT ライブラリが独自に使用するために割り当てるメモリブロックです。 CRT ライブラリはこれらのブロックの割り当てを解除するため、CRT ライブラリに重大な問題がある場合を除き、CRT ブロックはメモリリークレポートには表示されません。

これ以外に、メモリリークレポートに表示されないメモリブロックが 2 種類あります。 "free ブロック" は、解放済みのメモリブロックです。名前からわかるように、リークされることはありません。 "ignore ブロック" は、メモリリークレポートに出力しないように明示的にマークされているブロックです。

これらの手法では、標準 CRT の malloc 関数を使用して割り当てられたメモリのメモリリークを特定できます。ただし、プログラムで C++ の new 演算子を使用してメモリを割り当てている場合は、operator new が _malloc_dbg を呼び出すファイル名と行番号のみをメモリリークレポートに表示できます。メモリリークレポートをさらに便利にするには、次のようなマクロを記述して、割り当てを行った行を報告します。

#ifdef _DEBUG
    #define DBG_NEW new ( _NORMAL_BLOCK , __FILE__ , __LINE__ )
    // Replace _NORMAL_BLOCK with _CLIENT_BLOCK if you want the
    // allocations to be of _CLIENT_BLOCK type
#else
    #define DBG_NEW new
#endif

これで、コードで DBG_NEW マクロを使用して、new 演算子を置き換えることができます。デバッグビルドでは、ブロックの種類、 DBG_NEW ファイル、および行番号の追加パラメーターを受け取るグローバル operator new のオーバーロードを使用します。 new のオーバーロードは、追加情報を記録するために _malloc_dbg を呼び出します。メモリリークレポートには、リークしたオブジェクトを割り当てたファイル名と行番号が表示されます。リリースビルドでは依然として既定の new が使用されます。この手法の例を次に示します。

// debug_new.cpp
// compile by using: cl /EHsc /W4 /D_DEBUG /MDd debug_new.cpp
#define _CRTDBG_MAP_ALLOC
#include <cstdlib>
#include <crtdbg.h>

#ifdef _DEBUG
    #define DBG_NEW new ( _NORMAL_BLOCK , __FILE__ , __LINE__ )
    // Replace _NORMAL_BLOCK with _CLIENT_BLOCK if you want the
    // allocations to be of _CLIENT_BLOCK type
#else
    #define DBG_NEW new
#endif

struct Pod {
    int x;
};

void main() {
    Pod* pPod = DBG_NEW Pod;
    pPod = DBG_NEW Pod; // Oops, leaked the original pPod!
    delete pPod;

    _CrtDumpMemoryLeaks();
}

Visual Studio デバッガーでこのコードを実行するとき、_CrtDumpMemoryLeaks を呼び出すと、[出力] ウィンドウに次のようなレポートが生成されます。

Detected memory leaks!
Dumping objects ->
c:\users\username\documents\projects\debug_new\debug_new.cpp(20) : {75}
 normal block at 0x0098B8C8, 4 bytes long.
 Data: <    > CD CD CD CD
Object dump complete.

この出力では、リークした割り当てが debug_new.cpp の 20 行目にあることが報告されています。

Note

new という名前のプリプロセッサマクロやその他の言語キーワードは作成しないことをお勧めします。

メモリ割り当て番号へのブレークポイントの設定

メモリ割り当て番号は、リークしているメモリブロックがいつ割り当てられたかを示します。たとえば、メモリ割り当て番号が 18 のブロックは、アプリケーションの実行中に割り当てられたメモリの 18 番目のブロックです。 CRT レポートでは、実行中のすべてのメモリブロック割り当てが合計されます。これには、CRT ライブラリおよびその他のライブラリ (MFC など) による割り当ても含まれます。したがって、メモリ割り当てブロック番号 18 は、おそらくコードによって 18 番目に割り当てられたブロックではありません。

この割り当て番号を使用して、メモリの割り当てにブレークポイントを設定できます。

ウォッチウィンドウを使用してメモリ割り当てブレークポイントを設定するには

アプリの先頭付近にブレークポイントを設定し、デバッグを開始します。
アプリがブレークポイントで一時停止したら、[デバッグ]>[ウィンドウ]>[ウォッチ 1] (または [ウォッチ 2]、[ウォッチ 3]、または [ウォッチ 4]) を選択してウォッチ ウィンドウを開きます。
ウォッチ ウィンドウの [名前] 列に、「_crtBreakAlloc」と入力します。

マルチスレッド DLL バージョン (/MD オプション) の CRT ライブラリを使用している場合は、コンテキスト演算子を追加して「{,,ucrtbased.dll}_crtBreakAlloc」とします。

デバッグシンボルが読み込まれていることを確認します。それ以外の場合は、 _crtBreakAlloc 未確認として 報告されます。
Enter キーを押します。

デバッガーによって呼び出しが評価され、その結果が [値] 列に表示されます。メモリ割り当てにブレークポイントを設定していない場合、この値は -1 です。
[値] 列の値を、デバッガーで中断するメモリ割り当ての割り当て番号に置き換えます。

メモリ割り当て番号にブレークポイントを設定したら、デバッグを続行できます。メモリ割り当て番号が変更されないように、必ず同じ状態で実行してください。指定したメモリ割り当てでプログラムが停止したら、 [呼び出し履歴] ウィンドウやその他のデバッガーウィンドウを参照して、メモリが割り当てられた状況を確認できます。その後、実行を続行して、オブジェクトで何が起こっているかを確認し、オブジェクトが正常に解放されない原因を調べることができます。

オブジェクトにデータブレークポイントを設定する方法も役に立つことがあります。詳細については、「ブレークポイントの使用」を参照してください。

さらに、コード内でメモリ割り当てブレークポイントを設定することもできます。次のように設定できます。

_crtBreakAlloc = 18;

または

_CrtSetBreakAlloc(18);

メモリ状態の比較

メモリリークの位置を特定するためのもう 1 つの方法では、ある時点におけるアプリケーションのメモリ状態のスナップショットを取得します。アプリケーションの任意の時点でのメモリ状態のスナップショットを取得するには、_CrtMemState 構造体を作成し、_CrtMemCheckpoint 関数に渡します。

_CrtMemState s1;
_CrtMemCheckpoint( &s1 );

_CrtMemCheckpoint関数は、現在のメモリ状態のスナップショットを構造体に格納します。

_CrtMemState 構造体の内容を出力するには、構造体を _ CrtMemDumpStatistics 関数に渡します。

_CrtMemDumpStatistics( &s1 );

_CrtMemDumpStatistics は、次のようなメモリ状態のダンプを出力します。

0 bytes in 0 Free Blocks.
0 bytes in 0 Normal Blocks.
3071 bytes in 16 CRT Blocks.
0 bytes in 0 Ignore Blocks.
0 bytes in 0 Client Blocks.
Largest number used: 3071 bytes.
Total allocations: 3764 bytes.

コード内のセクションでメモリリークが発生したかどうかを調べるには、そのセクションの前後のメモリ状態のスナップショットを取得した後、 _CrtMemDifference を使用して 2 つのメモリ状態を比較します。

_CrtMemCheckpoint( &s1 );
// memory allocations take place here
_CrtMemCheckpoint( &s2 );

if ( _CrtMemDifference( &s3, &s1, &s2) )
   _CrtMemDumpStatistics( &s3 );

_CrtMemDifference は、s1 と s2 のメモリ状態を比較し、s1 と s2 の相違を示す結果 (s3) を返します。

メモリリークを見つけるための 1 つの方法では、最初にアプリケーションの先頭と末尾で _CrtMemCheckpoint を呼び出し、_CrtMemDifference を使用して結果を比較します。 _CrtMemDifference によってメモリリークが示された場合は、さらに多くの _CrtMemCheckpoint の呼び出しを追加して、リークの原因が特定されるまでバイナリ検索を使用してプログラムを分割できます。

誤検知

ライブラリが内部割り当てを CRT ブロックまたは client ブロックではなく normal ブロックとしてマークした場合、_CrtDumpMemoryLeaks によって、メモリリークが誤って検知されることがあります。その場合、 _CrtDumpMemoryLeaks では、ユーザー割り当てとライブラリの内部的な割り当てを区別することができません。ライブラリ割り当てのグローバルデストラクターが、 _CrtDumpMemoryLeaksの呼び出しポイント後に実行される場合、すべての内部ライブラリ割り当てがメモリリークとして報告されます。 Visual Studio .NET より前のバージョンの標準テンプレートライブラリによって、_CrtDumpMemoryLeaks が誤検出を報告する可能性があります。

CRT ライブラリを使用したメモリリークの検出

メモリリーク検出の有効化

メモリリークレポートの解釈

メモリ割り当て番号へのブレークポイントの設定

ウォッチウィンドウを使用してメモリ割り当てブレークポイントを設定するには

メモリ状態の比較

誤検知

関連項目

フィードバック

フィードバック

その他のリソース

CRT ライブラリを使用したメモリ リークの検出

メモリ リーク検出の有効化

メモリ リーク レポートの解釈

メモリ割り当て番号へのブレークポイントの設定

ウォッチ ウィンドウを使用してメモリ割り当てブレークポイントを設定するには

メモリ状態の比較

誤検知

関連項目

フィードバック

フィードバック

その他のリソース

CRT ライブラリを使用したメモリリークの検出

メモリリーク検出の有効化

メモリリークレポートの解釈

ウォッチウィンドウを使用してメモリ割り当てブレークポイントを設定するには