Changeset 99689 in vbox for trunk/src/VBox/Additions/x11/VBoxClient

Timestamp:

May 9, 2023 8:28:38 AM (2 years ago)

Author:

vboxsync

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

157237

Message:

Guest Additions/VBoxClient: Dropped the idea of having an own logging facility (VBGHLogXXX) for shared guest/host code again; the (release) logger is flexible enough for this. bugref:10427

Location:

trunk/src/VBox/Additions/x11/VBoxClient

Files:

• Makefile.kmk (modified) (1 diff)
• VBoxClient.h (modified) (2 diffs)
• logging.cpp (modified) (8 diffs)
• main.cpp (modified) (2 diffs)

trunk/src/VBox/Additions/x11/VBoxClient/Makefile.kmk

@@ -51 +51 @@
 # Common Guest / Host sources.
 VBOX_GH_SOURCES := \
-        $(PATH_ROOT)/src/VBox/GuestHost/Log.cpp \
         $(PATH_ROOT)/src/VBox/GuestHost/DisplayServerType.cpp
 

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

@@ -37 +37 @@
 #include <iprt/string.h>
 
-#include <VBox/GuestHost/Log.h>
 #include <VBox/GuestHost/DisplayServerType.h>
 
@@ -49 +48 @@
 int VBClLogCreate(const char *pszLogFile);
 int VBClLogCreateEx(const char *pszLogFile, bool fPrintHeader);
+int VBClLogModify(const char *pszDest, unsigned uVerbosity);
 void VBClLogSetLogPrefix(const char *pszPrefix);
 void VBClLogDestroy(void);

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

@@ -41 +41 @@
 #endif
 #include <VBox/VBoxGuestLib.h>
-
-#include <VBox/GuestHost/Log.h>
 
 #include <package-generated.h>
@@ -223 +221 @@
 
 /**
+ * Logs a message with a given prefix, format string and a va_list.
+ *
+ * @param   pszPrefix           Log prefix to use.
+ * @param   pszFormat           Format string to use.
+ * @param   va                  va_list to use.
+ */
+static void vbclLogV(const char *pszPrefix, const char *pszFormat, va_list va)
+{
+    char *psz = NULL;
+    RTStrAPrintfV(&psz, pszFormat, va);
+    AssertPtrReturnVoid(psz);
+    LogRel(("%s%s", pszPrefix ? pszPrefix : "", psz));
+    RTStrFree(psz);
+}
+
+/**
  * Logs a fatal error, notifies the desktop environment via a message and
  * exits the application immediately.
@@ -233 +247 @@
     va_list va;
     va_start(va, pszFormat);
-    VBGHLogFatalErrorV(pszFormat, va);
+    vbclLogV("Fatal Error: ", pszFormat, va);
     va_end(va);
 }
@@ -246 +260 @@
     va_list va;
     va_start(va, pszFormat);
-    VBGHLogErrorV(pszFormat, va);
+    vbclLogV("Error: ", pszFormat, va);
     va_end(va);
 }
@@ -259 +273 @@
     va_list va;
     va_start(va, pszFormat);
-    VBGHLogInfoV(pszFormat, va);
+    vbclLogV("", pszFormat, va);
     va_end(va);
 }
@@ -275 +289 @@
     va_list va;
     va_start(va, pszFormat);
-    VBGHLogVerboseV(iLevel, pszFormat, va);
+    if (iLevel <= g_cVerbosity)
+        vbclLogV("", pszFormat, va);
     va_end(va);
 }
@@ -419 +434 @@
 
 /**
+ * Destroys the currently active logging instance.
+ */
+void VBClLogDestroy(void)
+{
+    RTLogDestroy(RTLogRelSetDefaultInstance(NULL));
+}
+
+/**
+ * Modifies the (release) log settings.
+ *
+ * @returns VBox status code.
+ * @param   pszDest             Log destination string to set.
+ * @param   uVerbosity          Verbosity level to set.
+ *
+ * @note    Errors will be logged to stderr.
+ */
+int VBClLogModify(const char *pszDest, unsigned uVerbosity)
+{
+    AssertPtrReturn(pszDest, VERR_INVALID_POINTER);
+    AssertPtrReturn(g_pLoggerRelease, VERR_INVALID_POINTER);
+
+    int rc = RTLogDestinations(g_pLoggerRelease, pszDest);
+    if (RT_SUCCESS(rc))
+    {
+#define LOG_GROUP_SET_BREAK(a_Val) \
+        rc = RTLogGroupSettings(g_pLoggerRelease, "all.e" a_Val); break;
+
+        switch (uVerbosity)
+        {
+            case 0:  LOG_GROUP_SET_BREAK("");
+            case 1:  LOG_GROUP_SET_BREAK(".l");
+            case 2:  LOG_GROUP_SET_BREAK(".l.l2");
+            case 3:  LOG_GROUP_SET_BREAK(".l.l2.l3");
+            default: LOG_GROUP_SET_BREAK(".l.l2.l3.l4");
+        }
+#undef LOG_GROUP_SET_BREAK
+    }
+
+    if (RT_FAILURE(rc)) /* Print to stderr in the hope that anyone can read this. */
+        RTMsgError("Failed to set/modify log output, rc=%Rrc", rc);
+
+    return rc;
+}
+
+/**
  * Set custom log prefix.
  *
@@ -428 +488 @@
 }
 
-/**
- * Destroys the currently active logging instance.
- */
-void VBClLogDestroy(void)
-{
-    RTLogDestroy(RTLogRelSetDefaultInstance(NULL));
-}
-

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

@@ -674 +674 @@
                 if (RT_SUCCESS(rc))
                 {
-                    VBGHLogVerbositySet(2);
-                    VBGHDISPLAYSERVERTYPE const enmType = VBGHDisplayServerTypeDetect();
-                    VBClLogInfo("Detected session: %s\n", VBGHDisplayServerTypeToStr(enmType));
-                    return enmType != VBGHDISPLAYSERVERTYPE_NONE ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
+                    /* Make sure that we increase the verbosity (if needed), to gain some more insights
+                     * when detecting the display server. */
+                    rc = VBClLogModify("stdout", g_cVerbosity);
+                    if (RT_SUCCESS(rc))
+                    {
+                        VBGHDISPLAYSERVERTYPE const enmType = VBGHDisplayServerTypeDetect();
+                        VBClLogInfo("Detected session: %s\n", VBGHDisplayServerTypeToStr(enmType));
+                        return enmType != VBGHDISPLAYSERVERTYPE_NONE ? RTEXITCODE_SUCCESS : RTEXITCODE_FAILURE;
+                    }
                 }
 
@@ -740 +745 @@
         return RTEXITCODE_FAILURE; /* Error message already printed in VBClLogCreateEx(). */
 
-    if (!fDaemonise)
-    {
-        /* If the user is running in "no daemon" mode, send critical logging to stdout as well. */
-        PRTLOGGER pReleaseLog = RTLogRelGetDefaultInstance();
-        if (pReleaseLog)
-        {
-            rc = RTLogDestinations(pReleaseLog, "stdout");
-            if (RT_FAILURE(rc))
-                return RTMsgErrorExitFailure("Failed to redivert error output, rc=%Rrc", rc);
-        }
-    }
+    /* If the user is running in "no daemon" mode, send critical logging to stdout as well. */
+    rc = VBClLogModify(fDaemonise ? "" : "stdout", g_cVerbosity);
+    if (RT_FAILURE(rc))
+        return RTEXITCODE_FAILURE; /* Error message already printed in VBClLogModify(). */
 
     VBClLogInfo("VBoxClient %s r%s started. Verbose level = %d\n",
                 RTBldCfgVersion(), RTBldCfgRevisionStr(), g_cVerbosity);
-
-    VBGHLogVerbositySet(g_cVerbosity);
 
     /* Try to detect the current session type early on, if needed. */