👻

boost.testとMFCのメモリリークダンプの折り合いをつける

に公開

概要

VC++で開発していてboost.testをユニットテストをしていると、MFCのメモリリークダンプ出力が多すぎて自分が書いたコードのメモリリークを探せない状況に対応したときのメモです。

当時の状況はこんな感じ。

  • boost.testはビルド済みのdllを使用
  • MFCの共有DLLを使用
  • PCHでafxから始まるヘッダをインクルードしている
  • Visual Studio 2022

対応方法

大まかには次のようなやり方で対応できました。

  • AfxEnableMemoryLeakDump(FALSE);を呼んでMFCのメモリリークダンプを無効にする
  • boost.testのテストスイート、またはテストケース単位で_CrtMemCheckpointを使ったリーク検知を行う

ソースコードは次のようになります。

unit_test_main.cpp

#include "pch.h"

#define BOOST_TEST_MODULE test module name
#include <boost/test/unit_test.hpp>

struct CFixtureDisableAfxMemoryLeakDump {
	CFixtureDisableAfxMemoryLeakDump() 	{
        // MFCによるメモリリークダンプを無効にする
		AfxEnableMemoryLeakDump(FALSE);
	}
	~CFixtureDisableAfxMemoryLeakDump() {}
};

BOOST_GLOBAL_FIXTURE(CFixtureDisableAfxMemoryLeakDump);

test01.cpp

#include "pch.h"
#include <boost/test/unit_test.hpp>

struct CFixtureMemoryLeakDump {
    _CrtMemState s1;
    
    CFixtureMemoryLeakDump() {
        // テストスイート(テストケース)の開始時のデバッグヒープ状態を記録
        _CrtMemCheckpoint(&s1);
    }

    ~CFixtureMemoryLeakDump() {
        _CrtMemState s2, s3;

        // テストスイート(テストケース)の終了時のデバッグヒープ状態を記録
        _CrtMemCheckpoint(&s2);

        // デバッグヒープ状態の差分(リーク)があるか調べる
        if (_CrtMemDifference(&s3, &s1, &s2)) {
            // 差分のダンプ
            _CrtMemDumpStatistics(&s3);
        }
    }
};

// テストスイート単位でメモリリークを検出
BOOST_FIXTURE_TEST_SUITE(test_suite1, CFixtureMemoryLeakDump)

BOOST_AUTO_TEST_CASE(leak_case)
{
    BOOST_TEST(true);
    int* ptr = new int;
}

BOOST_AUTO_TEST_SUITE_END()

グローバルフィクスチャでやろうとすると

CFixtureDisableAfxMemoryLeakDumpで、CFixtureMemoryLeakDumpと同じことをやろとするとすると上手くいかないようです。leak_caseでわざとリークしている箇所を削除してもメモリリークがあるとしてダンプが出力されます。

挙動を見ている感じだと、boost.testのフレームワーク側で取得したメモリの解放がかなり後ろのタイミング(グローバルフィクスチャのデストラクタが動作した後)になっているのだろうと思います。
このタイミングが制御できれば、それでも良さそうですが出来るのかは分かっていません。

Discussion