Changeset 95955 in vbox for trunk/src/VBox/Additions/3D/win

Timestamp:

Jul 29, 2022 8:52:37 PM (3 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

152711

Message:

Add/Nt/Graphics: Made the debug logging code compile in IPRT_NO_CRT mode, cleaning it up a little in the process (_snpring doesn't terminate buffers on overflow, don't use sprintf). bugref:10261

Location:

trunk/src/VBox/Additions/3D/win/VBoxWddmUmHlp

Files:

• VBoxMpLogger.cpp (modified) (3 diffs)
• VBoxWddmUmHlp.h (modified) (2 diffs)

trunk/src/VBox/Additions/3D/win/VBoxWddmUmHlp/VBoxMpLogger.cpp

@@ -22 +22 @@
  */
 
+#define IPRT_NO_CRT_FOR_3RD_PARTY /* To get malloc and free wrappers in IPRT_NO_CRT mode. Doesn't link with IPRT in non-no-CRT mode. */
 #include "UmHlpInternal.h"
 
 #include <../../../common/wddm/VBoxMPIf.h>
-
-#include <stdio.h>
+#include <stdlib.h>
+#ifdef IPRT_NO_CRT
+# include <iprt/process.h>
+# include <iprt/string.h>
+#else
+# include <stdio.h>
+#endif
 
 DECLCALLBACK(void) VBoxDispMpLoggerLog(const char *pszString)
@@ -70 +76 @@
 }
 
-DECLCALLBACK(void) VBoxDispMpLoggerLogF(const char *pszString, ...)
+DECLCALLBACK(void) VBoxDispMpLoggerLogF(const char *pszFormat, ...)
 {
-    char szBuffer[4096] = {0};
-    va_list pArgList;
-    va_start(pArgList, pszString);
-    _vsnprintf(szBuffer, sizeof(szBuffer) / sizeof(szBuffer[0]), pszString, pArgList);
-    va_end(pArgList);
+    /** @todo would make a whole lot more sense to just allocate
+     *        VBOXDISPIFESCAPE_DBGPRINT here and printf into it's buffer than
+     *        double buffering it like this */
+    char szBuffer[4096];
+    va_list va;
+    va_start(va, pszFormat);
+#ifdef IPRT_NO_CRT
+    RTStrPrintf(szBuffer, sizeof(szBuffer), pszFormat, va);
+#else
+    _vsnprintf(szBuffer, sizeof(szBuffer), pszFormat, va);
+    szBuffer[sizeof(szBuffer) - 1] = '\0'; /* Don't trust the _vsnprintf function terminate the string! */
+#endif
+    va_end(va);
 
     VBoxDispMpLoggerLog(szBuffer);
 }
 
-/*
- * Prefix the output string with module name and pid/tid.
+/**
+ * Prefix the output string with exe name and pid/tid.
  */
-static const char *vboxUmLogGetModuleName(void)
+#ifndef IPRT_NO_CRT
+static const char *vboxUmLogGetExeName(void)
 {
     static int s_fModuleNameInited = 0;
@@ -93 +108 @@
         const DWORD cchName = GetModuleFileNameA(NULL, s_szModuleName, RT_ELEMENTS(s_szModuleName));
         if (cchName == 0)
-        {
             return "<no module>";
-        }
         s_fModuleNameInited = 1;
     }
     return &s_szModuleName[0];
 }
+#endif
 
 DECLCALLBACK(void) VBoxWddmUmLog(const char *pszString)
 {
+    /** @todo Allocate VBOXDISPIFESCAPE_DBGPRINT here and format right into it
+     *        instead? That would be a lot more flexible and a little faster. */
     char szBuffer[4096];
-    const int cbBuffer = sizeof(szBuffer);
-    char *pszBuffer = &szBuffer[0];
-
-    int cbWritten = _snprintf(pszBuffer, cbBuffer, "['%s' 0x%lx.0x%lx]: ",
-                              vboxUmLogGetModuleName(), GetCurrentProcessId(), GetCurrentThreadId());
-    if (cbWritten < 0 || cbWritten >= cbBuffer)
-    {
-        Assert(0);
-        pszBuffer[0] = 0;
-        cbWritten = 0;
-    }
-
-    const size_t cbLeft = cbBuffer - cbWritten;
-    const size_t cbString = strlen(pszString) + 1;
-    if (cbString <= cbLeft)
-    {
-        memcpy(pszBuffer + cbWritten, pszString, cbString);
-    }
-    else
-    {
-        memcpy(pszBuffer + cbWritten, pszString, cbLeft - 1);
-        pszBuffer[cbWritten + cbLeft - 1] = 0;
-    }
+#ifdef IPRT_NO_CRT
+    /** @todo use RTProcShortName instead of RTProcExecutablePath? Will avoid
+     *        chopping off log text if the executable path is too long. */
+    RTStrPrintf(szBuffer, sizeof(szBuffer), "['%s' 0x%lx.0x%lx]: %s",
+                RTProcExecutablePath() /* should've been initialized by nocrt-startup-dll-win.cpp already */,
+                GetCurrentProcessId(), GetCurrentThreadId(), pszString);
+#else
+    int cch = _snprintf(szBuffer, sizeof(szBuffer), "['%s' 0x%lx.0x%lx]: %s",
+                        vboxUmLogGetExeName(), GetCurrentProcessId(), GetCurrentThreadId(), pszString);
+    AssertReturnVoid(cch > 0);             /* unlikely that we'll have string encoding problems, but just in case. */
+    szBuffer[sizeof(szBuffer) - 1] = '\0'; /* the function doesn't necessarily terminate the buffer on overflow. */
+#endif
 
     VBoxDispMpLoggerLog(szBuffer);

trunk/src/VBox/Additions/3D/win/VBoxWddmUmHlp/VBoxWddmUmHlp.h

@@ -30 +30 @@
 
 /* Do not require IPRT library. */
-#if defined(Assert)
-#undef Assert
-#endif
-#ifdef RT_STRICT
-#define Assert(_e) (void)( (!!(_e)) || (ASMBreakpoint(), 0) )
-#else
-#define Assert(_e) (void)( 0 )
+/** @todo r=bird: It is *NOT* okay to redefine Assert* (or Log*) macros!  It
+ * causes confusing as the code no longer behaves in the way one expect.  Thus,
+ * it is strictly forbidden. */
+#ifndef IPRT_NO_CRT
+# undef Assert
+# undef AssertReturnVoid
+# ifdef RT_STRICT
+#  define Assert(_e) (void)( (!!(_e)) || (ASMBreakpoint(), 0) )
+#  define AssertReturnVoid(a_Expr) do { if (RT_LIKELY(a_Expr)) {} else { ASMBreakpoint(); return; } } while (0)
+# else
+#  define Assert(_e) (void)( 0 )
+#  define AssertReturnVoid(a_Expr) do { if (RT_LIKELY(a_Expr)) {} else return; } while (0)
+# endif
 #endif
 
@@ -88 +94 @@
 DECLCALLBACK(D3DKMTFUNCTIONS const *) D3DKMTFunctions(void);
 
-DECLCALLBACK(void) VBoxDispMpLoggerLogF(const char *pszString, ...);
+DECLCALLBACK(void) VBoxDispMpLoggerLogF(const char *pszFormat, ...);
 DECLCALLBACK(void) VBoxWddmUmLog(const char *pszString);