【Visual Leak Detector】設定項 ForceIncludeModulesmd

說明

使用 VLD 記憶體漏失檢測工具輔助開發時整理的學習筆記。本篇介紹 VLD 組態檔中設定項 ForceIncludeModules 的使用方法。同系列文章目錄可見《記憶體漏失檢測工具》目錄

說明
1. 組態檔使用說明
2. 設定需要檢測的第三方模組

1. 組態檔使用說明

在程式中通過 #include "vld.h" 的方式檢測記憶體漏失時，VLD 首先會嘗試在程式的生成目錄下讀取 vld.ini 檔案，若未讀取成功，則會嘗試在 VLD 的安裝目錄下讀取 vld.ini 檔案，若仍未讀取成功，則會使用內建的預設設定，內建的預設設定如果不動原始碼是無法更改的，因此通過修改相應目錄下的 vld.ini 檔案來客製化 VLD 功能是最好的選擇。當設定引數等號右邊為空，或者給設定了不合法值時，在使用過程中會被程式重置到預設值。

2. 設定需要檢測的第三方模組

引數名：ForceIncludeModules。

有效賦值：包含模組名的列表。

預設值：無。

功能說明：當需要對第三方模組（exe、lib、dll）進行記憶體漏失檢測，但又沒法在這些模組的原始碼中 #include "vld.h" 時，可以在等號右邊列出這些模組的名稱，模組之間可使用任意分隔符，甚至不分隔也可以，但為了便於閱讀，通常使用空格、; 或 , 來進行分隔。需要注意的是，這個功能開啟後程式有崩潰的風險，有時候還會輸出錯誤的記憶體漏失報告。

2.1 測試程式碼

#include <QCoreApplication>
#include "vld.h"
#include "testdll1.h"
#include "testdll2.h"

int main(int argc, char *argv[])
{
    QCoreApplication a(argc, argv);

    TestDll1 aaa;
    aaa.testFun(1);

    TestDll2 bbb;
    bbb.testFun(2);

    return a.exec();
}

測試環境：QT 5.9.2，MSVC 2015 32bit，Debug 模式，VLD 版本為 2.5.1，VLD 組態檔只對該引數做修改，測試工程所在路徑為：E:\Cworkspace\Qt 5.9\QtDemo\testVLD。其中的 testdll1 與 testdll2 是為了測試而打包的庫，兩個庫裡的函數都存在記憶體漏失。

2.2 ForceIncludeModules 為空時的輸出

標準輸出窗顯示：

testDLL1 ptr = 00840bc0, *ptr = 00000001.
testDLL2 ptr = 00840b90, *ptr = 00000002.

VLD 輸出報告：

Visual Leak Detector read settings from: D:\Program Files (x86)\Visual Leak Detector\vld.ini
Visual Leak Detector Version 2.5.1 installed.
No memory leaks detected.
Visual Leak Detector is now exiting.

2.3 ForceIncludeModules = 指定庫時的輸出

以下 ForceIncludeModules 設定的效果相同：

ForceIncludeModules = testDll1.dll;testDll2.dll         // 使用英文分號做分隔符
ForceIncludeModules = testDll1.dll,testDll2.dll         // 使用英文逗號做分隔符
ForceIncludeModules = testDll1.dll testDll2.dll         // 使用空格做分隔符
ForceIncludeModules = testDll1.dll/testDll2.dll         // 使用斜槓做分隔符
ForceIncludeModules = testDll1.dll-testDll2.dll         // 使用減號做分隔符
ForceIncludeModules = testDll1.dlltestDll2.dll          // 不使用任何分隔符
ForceIncludeModules = testDll1.dllabcdefghtestDll2.dll  // 使用字串abcdefgh做分隔符
ForceIncludeModules = testDll1.dll++++++testDll2.dll    // 使用字串++++++做分隔符

標準輸出窗顯示：

testDLL1 ptr = 00e070f8, *ptr = 00000001.
testDLL2 ptr = 00e072a8, *ptr = 00000002.

VLD 輸出報告：

Visual Leak Detector read settings from: D:\Program Files (x86)\Visual Leak Detector\vld.ini
Visual Leak Detector Version 2.5.1 installed.
    Forcing inclusion of these modules in leak detection: testdll1.dll;testdll2.dll
WARNING: Visual Leak Detector detected memory leaks!
---------- Block 1 at 0x00E070F8: 4 bytes ----------
  Leak Hash: 0x8BB01C20, Count: 1, Total 4 bytes
  Call Stack (TID 14012):
    ucrtbased.dll!malloc()
    f:\dd\vctools\crt\vcstartup\src\heap\new_scalar.cpp (19): testDll1.dll!operator new() + 0x9 bytes
    e:\cworkspace\qt 5.9\qtdemo\testdll1\testdll1.cpp (10): testDll1.dll!TestDll1::testFun() + 0x7 bytes
    e:\cworkspace\qt 5.9\qtdemo\testvld\main.cpp (11): testVLD.exe!main() + 0xB bytes
    f:\dd\vctools\crt\vcstartup\src\startup\exe_common.inl (74): testVLD.exe!invoke_main() + 0x1B bytes
    f:\dd\vctools\crt\vcstartup\src\startup\exe_common.inl (264): testVLD.exe!__scrt_common_main_seh() + 0x5 bytes
    f:\dd\vctools\crt\vcstartup\src\startup\exe_common.inl (309): testVLD.exe!__scrt_common_main()
    f:\dd\vctools\crt\vcstartup\src\startup\exe_main.cpp (17): testVLD.exe!mainCRTStartup()
    KERNEL32.DLL!BaseThreadInitThunk() + 0x19 bytes
    ntdll.dll!RtlGetAppContainerNamedObjectPath() + 0x11E bytes
    ntdll.dll!RtlGetAppContainerNamedObjectPath() + 0xEE bytes
  Data:
    01 00 00 00                                                  ........ ........


---------- Block 2 at 0x00E072A8: 4 bytes ----------
  Leak Hash: 0x08AA1CDB, Count: 1, Total 4 bytes
  Call Stack (TID 14012):
    ucrtbased.dll!malloc()
    f:\dd\vctools\crt\vcstartup\src\heap\new_scalar.cpp (19): testDll2.dll!operator new() + 0x9 bytes
    e:\cworkspace\qt 5.9\qtdemo\testdll2\testdll2.cpp (10): testDll2.dll!TestDll2::testFun() + 0x7 bytes
    e:\cworkspace\qt 5.9\qtdemo\testvld\main.cpp (14): testVLD.exe!main() + 0xB bytes
    f:\dd\vctools\crt\vcstartup\src\startup\exe_common.inl (74): testVLD.exe!invoke_main() + 0x1B bytes
    f:\dd\vctools\crt\vcstartup\src\startup\exe_common.inl (264): testVLD.exe!__scrt_common_main_seh() + 0x5 bytes
    f:\dd\vctools\crt\vcstartup\src\startup\exe_common.inl (309): testVLD.exe!__scrt_common_main()
    f:\dd\vctools\crt\vcstartup\src\startup\exe_main.cpp (17): testVLD.exe!mainCRTStartup()
    KERNEL32.DLL!BaseThreadInitThunk() + 0x19 bytes
    ntdll.dll!RtlGetAppContainerNamedObjectPath() + 0x11E bytes
    ntdll.dll!RtlGetAppContainerNamedObjectPath() + 0xEE bytes
  Data:
    02 00 00 00                                                  ........ ........


Visual Leak Detector detected 2 memory leaks (80 bytes).
Largest number used: 80 bytes.
Total allocations: 80 bytes.
Visual Leak Detector is now exiting.

2.4 輸出結果對比

當 ForceIncludeModules 為空時，沒有檢測出動態庫裡的記憶體漏失。
當 ForceIncludeModules 指定了庫 testDll1.dll 與 testDll2.dll 時，成功檢測到了動態庫裡的記憶體漏失，並指出了檔案和行號等資訊。