Changeset 93220 in vbox for trunk/src/VBox

Timestamp:

Jan 13, 2022 11:45:40 AM (3 years ago)

Author:

vboxsync

Message:

Additions: X11: add interface to set custom log prefix, bugref:10134.

Each VBoxClient service instance now can use separate logging prefix,
so it can be easier to look at the log on a host side.

Location:

trunk/src/VBox/Additions/x11/VBoxClient

Files:

• VBoxClient.h (modified) (2 diffs)
• logging.cpp (modified) (5 diffs)

trunk/src/VBox/Additions/x11/VBoxClient/VBoxClient.h

@@ -33 +33 @@
 
 int VBClLogCreate(const char *pszLogFile);
+void VBClLogSetLogPrefix(const char *pszPrefix);
 void VBClLogDestroy(void);
 
@@ -107 +108 @@
 extern VBCLSERVICE g_SvcDisplayDRM;
 extern VBCLSERVICE g_SvcDisplaySVGA;
+extern VBCLSERVICE g_SvcDisplaySVGASession;
 extern VBCLSERVICE g_SvcDragAndDrop;
 extern VBCLSERVICE g_SvcHostVersion;

trunk/src/VBox/Additions/x11/VBoxClient/logging.cpp

@@ -34 +34 @@
 static uint32_t      g_uHistoryFileTime = RT_SEC_1DAY;  /* Max 1 day per file. */
 static uint64_t      g_uHistoryFileSize = 100 * _1M;    /* Max 100MB per file. */
+
+/** Custom log prefix (to be set externally). */
+static char          *g_pszCustomLogPrefix;
 
 extern unsigned      g_cRespawn;
@@ -244 +247 @@
 }
 
+static DECLCALLBACK(size_t) vbClLogPrefixCb(PRTLOGGER pLogger, char *pchBuf, size_t cchBuf, void *pvUser)
+{
+    size_t cbPrefix = 0;
+
+    RT_NOREF(pLogger);
+    RT_NOREF(pvUser);
+
+    if (g_pszCustomLogPrefix)
+    {
+        cbPrefix = RT_MIN(strlen(g_pszCustomLogPrefix), cchBuf);
+        memcpy(pchBuf, g_pszCustomLogPrefix, cbPrefix);
+    }
+
+    return cbPrefix;
+}
+
 /**
  * Creates the default release logger outputting to the specified file.
@@ -259 +278 @@
     /* Create release logger (stdout + file). */
     static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
-    RTUINT fFlags = RTLOGFLAGS_PREFIX_THREAD | RTLOGFLAGS_PREFIX_TIME;
+    RTUINT fFlags = RTLOGFLAGS_PREFIX_THREAD | RTLOGFLAGS_PREFIX_TIME | RTLOGFLAGS_PREFIX_CUSTOM;
 #if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
     fFlags |= RTLOGFLAGS_USECRLF;
@@ -273 +292 @@
         RTLogRelSetDefaultInstance(g_pLoggerRelease);
 
+        rc = RTLogSetCustomPrefixCallback(g_pLoggerRelease, vbClLogPrefixCb, NULL);
+        if (RT_FAILURE(rc))
+            VBClLogError("unable to register custom log prefix callback\n");
+
         /* Explicitly flush the log in case of VBOXSERVICE_RELEASE_LOG=buffered. */
         RTLogFlush(g_pLoggerRelease);
@@ -281 +304 @@
 
 /**
+ * Set custom log prefix.
+ *
+ * @param pszPrefix     Custom log prefix string.
+ */
+void VBClLogSetLogPrefix(const char *pszPrefix)
+{
+    g_pszCustomLogPrefix = (char *)pszPrefix;
+}
+
+/**
  * Destroys the currently active logging instance.
  */