Adding tests for static initializers, and a fix that avoids false positives from C++ statics

Author: mattdurak

setup/version.h

@@ -1,9 +1,9 @@
 
-#define VLDVERSION          L"2.5.5"
-#define VERSION_NUMBER		2,5,5,0
-#define VERSION_STRING		"2.5.5.0"
+#define VLDVERSION          L"2.5.6"
+#define VERSION_NUMBER		2,5,6,0
+#define VERSION_STRING		"2.5.6.0"
 #define VERSION_COPYRIGHT	"Copyright (C) 2005-2020"
 
 #ifndef __FILE__
-!define VLD_VERSION "2.5.5"	// NSIS Script
+!define VLD_VERSION "2.5.6"	// NSIS Script
 #endif

setup/vld-setup.iss

@@ -2,7 +2,7 @@
 ; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
 
 #define MyAppName "Visual Leak Detector"
-#define MyAppVersion "2.5.5"
+#define MyAppVersion "2.5.6"
 #define MyAppPublisher "VLD Team"
 #define MyAppURL "http://vld.codeplex.com/"
 #define MyAppRegKey "Software\Visual Leak Detector"

src/callstack.cpp

@@ -546,8 +546,26 @@ UINT CallStack::isCrtStartupFunction( LPCWSTR functionName ) const
     }
 
     if (endWith(functionName, len, L"DllMainCRTStartup")
-        || endWith(functionName, len, L"mainCRTStartup")
-        || beginWith(functionName, len, L"`dynamic initializer for '")) {
+        || endWith(functionName, len, L"mainCRTStartup")
+
+        // NOTE: This is tricky...
+        //   This happens for c++ static initialization
+        //   In some cases, we will see
+        //       "namespace::`dynamic initializer for 'symbol'"
+        //   In other cases, there is no namespace prepended, even if the symbol is in a namespace:
+        //       "`dynamic initializer for 'namespace::symbol'"
+        // This happens above initterm in the stack, which means these statics can be ignored by the code above if they have the namespace
+
+        // Ideally, we would ignore dynamic initializers if we (somehow) know there is also a matching "`dynamic atexit destructor for 'symbol'"
+        // It's possible to use some kind of heuristic to detect this (the stack will have ..., classname::classname, dynamic initializer for, initterm, ...)
+        // That means that the caller really needs a state machine as we are doing some context-sensitive parsing
+
+        // For now, we just make the (possibly wrong) assumption that all dynamic initializations will be cleaned up
+        // Therefore, the following line is commented out.
+        //     Clearly wrong when we have a global written as "static void* foo = malloc(1);"
+        //     But we can look at a more complex fix if we need to handle that
+        //|| beginWith(functionName, len, L"`dynamic initializer for '")
+        ) {
         // When we reach this point there is no reason going further down the stack
         return CALLSTACK_STATUS_NOTSTARTUPCRT;
     }

src/runtests.bat

@@ -30,6 +30,10 @@ ECHO ---------------------------------------------------------------------------
 ECHO [ RUNNING  ] %tests_path%\vld_main_test.exe
 ECHO -------------------------------------------------------------------------------
 !tests_path!\vld_main_test.exe --gtest_output="xml:!tests_path!\vld_main_test.exe.xml"
+ECHO -------------------------------------------------------------------------------
+ECHO [ RUNNING  ] %tests_path%\static_string_test.exe
+ECHO -------------------------------------------------------------------------------
+!tests_path!\static_string_test.exe --gtest_output="xml:!tests_path!\static_string_test.exe.xml"
 ECHO -------------------------------------------------------------------------------
 EXIT /b 0
 

src/tests/static_string_test/static_string.h

@@ -0,0 +1,10 @@
+#pragma once
+
+#include <string>
+
+namespace my_string
+{
+    const std::string the_string("foobar");
+}
+
+const std::string string_global("xyz1234567");

src/tests/static_string_test/static_string_test.cpp

@@ -0,0 +1,35 @@
+// static_string_test.cpp : Defines the entry point for the console application.
+//
+
+#include "stdafx.h"
+#include "vld.h"
+#include "static_string.h"
+
+void access_strings()
+{
+    // Just do something with the string so it isn't optimized away
+    std::string copied_string = my_string::the_string;
+    printf("Copied string %s\n", copied_string.c_str());
+
+    std::string copied_string2 = string_global;
+    printf("Copied string %s\n", copied_string2.c_str());
+}
+
+int main(int argc, char **argv)
+{
+    access_strings();
+
+    int leaks = static_cast<int>(VLDGetLeaksCount());
+    if (0 != leaks)
+    {
+        printf("!!! FAILED - Leaks detected: %i\n", leaks);
+        VLDReportLeaks();
+    }
+    else
+    {
+        printf("PASSED\n");
+    }
+
+
+    return leaks;
+}