Fix for unreported memory leaks with Win32 applications

.github/workflows/dev_test.yml

@@ -0,0 +1,108 @@
+name: TestDevelopment
+
+on:
+  push:
+    branches: [ "dev" ]
+env:
+  # Path to the solution file relative to the root of the project.
+  SOLUTION_FILE_PATH: ./vld.sln
+
+permissions:
+  contents: read
+  checks: write
+
+jobs:
+  build:
+    runs-on: windows-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Install GitVersion
+      uses: gittools/actions/gitversion/setup@v3
+      with:
+        versionSpec: '6.0.5'
+
+    - name: Determine Version
+      uses: gittools/actions/gitversion/execute@v3
+
+    - name: Add MSBuild to PATH
+      uses: microsoft/setup-msbuild@v2
+
+    - name: Restore NuGet packages
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: nuget restore ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Setup VSTest.exe
+      uses: Malcolmnixon/Setup-VSTest@v4
+
+    - name: Update version number in version.h
+      shell: pwsh
+      run: |
+        ./update_version.ps1
+
+    - name: Build Win64 VLD
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Release" /p:Platform=x64 -target:vld ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Build Win64 Tests
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Debug(Release)" /p:Platform=x64 ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Build Win64 StaticCRT Tests
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Debug(Release)_StaticCRT" /p:Platform=x64 ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Test Win64
+      run: |
+        vstest.console '.\bin\tests\x64\debug(release)\vld_tests.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\x64\debug(release)\threads.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\x64\debug(release)\vld_unload.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\x64\debug(release)_staticcrt\vld_tests.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\x64\debug(release)_staticcrt\threads.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\x64\debug(release)_staticcrt\vld_unload.dll' /InIsolation /Logger:trx
+
+    - name: Build Win32 VLD
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Release" /p:Platform=Win32 -target:vld ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Build Win32 Tests
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Debug(Release)" /p:Platform=Win32 ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Build Win32 StaticCRT Tests
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Debug(Release)_StaticCRT" /p:Platform=Win32 ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Test Win32
+      run: |
+        vstest.console '.\bin\tests\win32\debug(release)\vld_tests.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\win32\debug(release)\threads.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\win32\debug(release)\vld_unload.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\win32\debug(release)_staticcrt\vld_tests.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\win32\debug(release)_staticcrt\threads.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\win32\debug(release)_staticcrt\vld_unload.dll' /InIsolation /Logger:trx
+
+    - name: Publish Test Results
+      uses: EnricoMi/publish-unit-test-result-action/windows@v2
+      if: always()
+      with:
+        files: |
+          TestResults\**\*.trx
+        comment_mode: off
+
+    - name: Create installer
+      uses: Minionguyjpro/Inno-Setup-Action@v1.2.4
+      with:
+        path: ./setup/vld-setup.iss
+        options: /V0 /O+ /DMyAppVersion=${{ env.GitVersion_MajorMinorPatch }}
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: Installer
+        path: ./setup/Output/vld-${{ env.GitVersion_MajorMinorPatch }}-setup.exe
+        retention-days: 1

.github/workflows/msbuild.yml

@@ -0,0 +1,119 @@
+name: Build And Test
+
+on:
+  push:
+    branches: [ "dev", "master" ]
+    tags: '*'
+    paths-ignore:
+      - '**/README.md'
+      - '.github/workflows/*'
+  pull_request:
+    branches: [ "master" ]
+
+env:
+  # Path to the solution file relative to the root of the project.
+  SOLUTION_FILE_PATH: ./vld.sln
+
+permissions:
+  contents: read
+  checks: write
+
+jobs:
+  build:
+    runs-on: windows-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Install GitVersion
+      uses: gittools/actions/gitversion/setup@v3
+      with:
+        versionSpec: '6.0.5'
+
+    - name: Determine Version
+      uses: gittools/actions/gitversion/execute@v3
+
+    - name: Add MSBuild to PATH
+      uses: microsoft/setup-msbuild@v2
+
+    - name: Restore NuGet packages
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: nuget restore ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Setup VSTest.exe
+      uses: Malcolmnixon/Setup-VSTest@v4
+
+    - name: Update version number in version.h
+      shell: pwsh
+      run: |
+        ./update_version.ps1
+
+    - name: Add Debugging Tools to PATH
+      run: |
+        echo "C:\Program Files (x86)\Windows Kits\10\Debuggers\x64" >> $env:GITHUB_PATH
+
+    - name: Build Win64 VLD
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Release" /p:Platform=x64 -target:vld ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Build Win64 Tests
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Debug(Release)" /p:Platform=x64 ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Build Win64 StaticCRT Tests
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Debug(Release)_StaticCRT" /p:Platform=x64 ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Test Win64
+      run: |
+        vstest.console '.\bin\tests\x64\debug(release)\vld_tests.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\x64\debug(release)\threads.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\x64\debug(release)\vld_unload.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\x64\debug(release)_staticcrt\vld_tests.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\x64\debug(release)_staticcrt\threads.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\x64\debug(release)_staticcrt\vld_unload.dll' /InIsolation /Logger:trx
+
+    - name: Build Win32 VLD
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Release" /p:Platform=Win32 -target:vld ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Build Win32 Tests
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Debug(Release)" /p:Platform=Win32 ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Build Win32 StaticCRT Tests
+      working-directory: ${{env.GITHUB_WORKSPACE}}
+      run: msbuild /m /p:Configuration="Debug(Release)_StaticCRT" /p:Platform=Win32 ${{env.SOLUTION_FILE_PATH}}
+
+    - name: Test Win32
+      run: |
+        vstest.console '.\bin\tests\win32\debug(release)\vld_tests.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\win32\debug(release)\threads.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\win32\debug(release)\vld_unload.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\win32\debug(release)_staticcrt\vld_tests.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\win32\debug(release)_staticcrt\threads.dll' /InIsolation /Logger:trx
+        vstest.console '.\bin\tests\win32\debug(release)_staticcrt\vld_unload.dll' /InIsolation /Logger:trx
+
+    - name: Publish Test Results
+      uses: EnricoMi/publish-unit-test-result-action/windows@v2
+      if: always()
+      with:
+        files: |
+          TestResults\**\*.trx
+        comment_mode: off
+
+    - name: Create installer
+      uses: Minionguyjpro/Inno-Setup-Action@v1.2.4
+      with:
+        path: ./setup/vld-setup.iss
+        options: /V0 /O+ /DMyAppVersion=${{ env.GitVersion_MajorMinorPatch }}
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: Installer
+        path: ./setup/Output/vld-${{ env.GitVersion_MajorMinorPatch }}-setup.exe
+        retention-days: 1

.gitignore

@@ -1,10 +1,13 @@
 obj/
+
 Debug/
-Debug (Unicode)/
+Debug(Release)/
+Debug(Release)_StaticCRT/
 Release/
-Release (Unicode)/
+
 Win32/
 x64/
+
 *.vcxproj.user
 *.*sdf
 *.suo
@@ -21,4 +24,10 @@ src/bin/vld.ini
 *.VC.opendb
 *.VC.db
 *.aps
-.vs/
+.vs/
+packages/
+TestResults/
+build/
+
+!setup/dbghelp/x64/
+!lib/sdl2/lib/x64/

README.md

@@ -1,38 +1,47 @@
-# Visual Leak Detector [![Build status](https://ci.appveyor.com/api/projects/status/0kvft8un16e80toj/branch/master?svg=true)](https://ci.appveyor.com/project/KindDragon/vld/branch/master) <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&amp;business=N3QTYHP9LH6UY&amp;lc=GB&amp;item_name=Visual%20Leak%20Detector&amp;currency_code=USD&amp;bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted" target="_blank"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a>
+# Visual Leak Detector 
 
-## Microsoft Fork
+[![Build Status](https://github.com/avadae/vld/actions/workflows/msbuild.yml/badge.svg)](https://github.com/avadae/msbuild/actions)
+[![GitHub Release](https://img.shields.io/github/v/release/avadae/vld?logo=github&sort=semver)](https://github.com/avadae/vld/releases/latest)
 
-This fork was created to address some of the issues found in the original repo [https://github.com/KindDragon/vld](https://github.com/KindDragon/vld), which has not been updated since November 24, 2017. The changes in this repo can be merged back into the original repo if it is again accepting pull requests.
+## This personal fork
 
-If you would like to contribute to this fork, please submit a pull request. It will be looked at on a "best effort" basis as our team is available.
+I maintain this fork to be used by students at [Hogeschool West-Vlaanderen in the bachelor Digital Arts and Entertainment](https://www.digitalartsandentertainment.be/). It is created to keep the vld project up to date with the latest visual studio versions and the latest installer tools. We merge all changes applied to the original Azure fork into this one. Please refer to [https://github.com/Azure/vld](https://github.com/Azure/vld) for the original version.
 
-## Introduction
+## Documentation
 
-Visual C++ provides built-in memory leak detection, but its capabilities are minimal at best. This memory leak detector was created as a free alternative to the built-in memory leak detector provided with Visual C++. Here are some of Visual Leak Detector's features, none of which exist in the built-in detector:
+Find the original documentation at [https://github.com/KindDragon/vld/wiki](https://github.com/KindDragon/vld/wiki) however it is outdated.
 
-*   Provides a complete stack trace for each leaked block, including source file and line number information when available.
-*   Detects most, if not all, types of in-process memory leaks including COM-based leaks, and pure Win32 heap-based leaks.
-*   Selected modules (DLLs or even the main EXE) can be excluded from leak detection.
-*   Provides complete data dumps (in hex and ASCII) of leaked blocks.
-*   Customizable memory leak report: can be saved to a file or sent to the debugger and can include a variable level of detail.
+## Using VLD in Cmake projects
 
-Other after-market leak detectors for Visual C++ are already available. But most of the really popular ones, like Purify and BoundsChecker, are very expensive. A few free alternatives exist, but they're often too intrusive, restrictive, or unreliable. Visual Leak Detector is currently the only freely available memory leak detector for Visual C++ that provides all of the above professional-level features packaged neatly in an easy-to-use library.
+Starting version 2.5.11 you can easily use vld in cmake configured projects. Install VLD as usual. Then in your CMakeLists.txt you can write
 
-Visual Leak Detector is [licensed][3] free of charge as a service to the Windows developer community. If you find it to be useful and would like to just say "Thanks!", or you think it stinks and would like to say "This thing sucks!", please feel free to [drop us a note][1]. Or, if you'd prefer, you can [contribute a small donation][2]. Both are very appreciated.
+```
+find_package(VLD CONFIG)
 
-## Documentation
+target_include_directories(your_target PRIVATE ${VLD_INCLUDE_DIRS})
+target_link_libraries(your_target PRIVATE ${VLD_LIBRARIES})
+```
+
+In your main.cpp (or other initial file for your exe/dll) add
+
+```
+#if _DEBUG
+#if __has_include(<vld.h>)
+#include <vld.h>
+#endif
+#endif
+```
 
-Read the documentation at [https://github.com/KindDragon/vld/wiki](https://github.com/KindDragon/vld/wiki)
+And you're good to go! If VLD is installed the project will be checked for leaks. If VLD is not installed the project still builds and leaks will be undetected.
 
-## Contributing
 
-We encourage developers who've added their own features, or fixed bugs they've found, to contribute to the project. The full version-controlled source tree is available publicly via Git at the URL below. Feel free to clone from this URL and submit patches for consideration for inclusion in future versions. You can also issue pull requests for changes that you've made and would like to share.
+## Updating dbghelp.dll
 
-* [Source code](https://github.com/KindDragon/vld)
-* [Microsoft fork code](https://github.com/Azure/vld)
+If you want to update the version of DbgHelp.dll in the project
 
-Copyright © 2005-2017 VLD Team
+- [Install the desired Windows SDK version.](https://developer.microsoft.com/en-us/windows/downloads/sdk-archive/)
+- Copy dbghelp.dll from ```C:\Program Files (x86)\Windows Kits\10\Debuggers\x64``` to ```vld\setup\dbghelp\x64```
+- Copy dbghelp.dll from ```C:\Program Files (x86)\Windows Kits\10\Debuggers\x86``` to ```vld\setup\dbghelp\x86```
+- Update the version number in the manifest files in those folders
+- Important: update the version number in the two dependency manifest files in ```vld\src```
 
- [1]: https://github.com/KindDragon/vld/wiki
- [2]: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=N3QTYHP9LH6UY&lc=GB&item_name=Visual%20Leak%20Detector&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted
- [3]: https://github.com/KindDragon/vld/blob/master/COPYING.txt