【Visual Leak Detector】在 VS 2015 中使用 VLD

说明

使用 VLD 内存泄漏检测工具辅助开发时整理的学习笔记。 同系列文章目录可见 《内存泄漏检测工具》目录

目录

• 说明
• 1. 使用前的准备
• 2. 在 VS 2015 中使用 VLD
  • 2.1 无内存泄漏时的输出报告
  • 2.2 有内存泄漏时的输出报告
• 3. 无法正常使用的可能原因

1. 使用前的准备

参考本人另一篇博客 安装 Visual Leak Detector 下载 vld-2.5.1-setup.exe 并按步骤安装 VLD。注意配置环境的时候一定要把三个选项都打上勾，在一台电脑上配置完成后，用的时候十分方便，包含头文件就可以使用，不需添加任何多余的代码。

2. 在 VS 2015 中使用 VLD

在项目的 main.cpp 文件中，添加头文件：

#include <vld.h>

选择 x86 或者 x64 编译器，选择 Debug 模式，编译运行，就可以正常使用了。我的 VS 版本是 Microsoft Visual Studio Professional 2015，VLD 安装目录为 D:\Program Files (x86)\Visual Leak Detector。

2.1 无内存泄漏时的输出报告

程序运行结束后，若没有检测到内存泄漏，VLD 会输出以下 4 行报告：

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.2 有内存泄漏时的输出报告

程序运行结束后，若检测到内存泄漏，VLD 会输出以下报告（本例中出现一处内存泄漏，使用 x86 编译器）：

Visual Leak Detector read settings from: D:\Program Files (x86)\Visual Leak Detector\vld.ini
Visual Leak Detector Version 2.5.1 installed.
WARNING: Visual Leak Detector detected memory leaks!
---------- Block 1 at 0x008D8980: 20 bytes ----------
  Leak Hash: 0xC3828EE7, Count: 1, Total 20 bytes
  Call Stack (TID 12948):
    f:\dd\vctools\crt\vcstartup\src\heap\new_array.cpp (15): testVLD.exe!operator new[]() + 0x9 bytes
    e:\cworkspace\vsdemo\testvld\testvld\main.cpp (8): testVLD.exe!main() + 0x7 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!__RtlUserThreadStart() + 0x2F bytes
    ntdll.dll!_RtlUserThreadStart() + 0x1B bytes
  Data:
    CD CD CD CD    CD CD CD CD    CD CD CD CD    CD CD CD CD     ........ ........
    CD CD CD CD                                                  ........ ........


Visual Leak Detector detected 1 memory leak (56 bytes).
Largest number used: 56 bytes.
Total allocations: 56 bytes.
Visual Leak Detector is now exiting.

若使用的是 x64 编译器，报告输出如下：

Visual Leak Detector read settings from: D:\Program Files (x86)\Visual Leak Detector\vld.ini
Visual Leak Detector Version 2.5.1 installed.
“testVLD.exe”(Win32): 已加载“C:\Windows\System32\kernel.appcore.dll”。已加载符号。
WARNING: Visual Leak Detector detected memory leaks!
---------- Block 1 at 0x00000000650C6AD0: 20 bytes ----------
  Leak Hash: 0x72624394, Count: 1, Total 20 bytes
  Call Stack (TID 12984):
    f:\dd\vctools\crt\vcstartup\src\heap\new_array.cpp (16): testVLD.exe!operator new[]()
    e:\cworkspace\vsdemo\testvld\testvld\main.cpp (8): testVLD.exe!main() + 0xA bytes
    f:\dd\vctools\crt\vcstartup\src\startup\exe_common.inl (75): testVLD.exe!invoke_main()
    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() + 0x14 bytes
    ntdll.dll!RtlUserThreadStart() + 0x21 bytes
  Data:
    CD CD CD CD    CD CD CD CD    CD CD CD CD    CD CD CD CD     ........ ........
    CD CD CD CD                                                  ........ ........


Visual Leak Detector detected 1 memory leak (72 bytes).
Largest number used: 72 bytes.
Total allocations: 72 bytes.
Visual Leak Detector is now exiting.

3. 无法正常使用的可能原因

• 检查是否是 Debug 模式，VLD 无法直接在 Release 模式下使用。
• 检查环境变量是否正确配置，环境变量是 VLD 安装程序自动配置的，但是若在安装时没有勾选自动配置，会导致环境变量缺失，查看 Path 这一系统变量中是否添加了 VLD 的 bin 路径（我的是 D:\Program Files (x86)\Visual Leak Detector\bin\Win32 和 D:\Program Files (x86)\Visual Leak Detector\bin\Win64 这两个）。
• 在 VLD 安装成功后，是否已经重启了 VS，因为要加载 VLD 安装时新添的环境变量，若没重启 VS，可能找不到 VLD 的依赖环境。
• 检查 include 与 lib 目录是否被正确添加，这一步也是 VLD 安装程序自动进行的，打开项目属性页，点击 C/C++ -> 常规 -> 附加包含目录 查看是否添加了 VLD 的 include 目录（我的是 D:\Program Files (x86)\Visual Leak Detector\include），然后点击 链接器 -> 常规 -> 附加库目录 查看是否添加了 VLD 的 lib 目录（在我电脑上，使用 x86 编译器时是 D:\Program Files (x86)\Visual Leak Detector\lib\Win32，使用 x64 编译器时是 D:\Program Files (x86)\Visual Leak Detector\lib\Win64）。
• 清除上一次的编译文件，重新编译运行一下。
• 如果存在预编译头文件（例如 stdafx.h），则应先包含 stdafx.h，再包含 vld.h。如果 stdafx.h 文件中有 #include <afxwin.h> ，就需将 #include "vld.h" 放在 stdafx.h 文件里面，且要放在 #include <afxwin.h> 的前面，不然泄漏检测功能无法正常使用。