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

Timestamp:

May 8, 2023 9:35:54 AM (23 months ago)

Author:

vboxsync

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

157187

Message:

Guest Additions/VBoxClient: Added "--session-detect" command to only perform a display server detection (w/ exit code set). Useful for (user) diagnosis + testcase. bugref:10427

Location:

trunk/src/VBox/Additions/x11/VBoxClient

Files:

• VBoxClient.h (modified) (1 diff)
• logging.cpp (modified) (5 diffs)
• main.cpp (modified) (5 diffs)

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

@@ -48 +48 @@
 
 int VBClLogCreate(const char *pszLogFile);
+int VBClLogCreateEx(const char *pszLogFile, bool fPrintHeader);
 void VBClLogSetLogPrefix(const char *pszPrefix);
 void VBClLogDestroy(void);

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

@@ -32 +32 @@
 #include <iprt/buildconfig.h>
 #include <iprt/file.h>
+#include <iprt/message.h>
 #include <iprt/process.h>
 #include <iprt/stream.h>
@@ -365 +366 @@
 
 /**
- * Creates the default release logger outputting to the specified file.
- *
- * Pass NULL to disabled logging.
+ * Creates the default release logger outputting to the specified file, extended version.
  *
  * @return  IPRT status code.
- * @param   pszLogFile      Filename for log output.  NULL disables custom handling.
- */
-int VBClLogCreate(const char *pszLogFile)
+ * @param   pszLogFile      Filename for log output. Empty filename allowed.
+ * @param   fPrintHeader    Whether to print the VBoxClient logging header or not.
+ */
+int VBClLogCreateEx(const char *pszLogFile, bool fPrintHeader)
 {
     if (!pszLogFile)
@@ -386 +386 @@
                            RT_ELEMENTS(s_apszGroups), s_apszGroups, UINT32_MAX /*cMaxEntriesPerGroup*/,
                            0 /*cBufDescs*/, NULL /*paBufDescs*/, RTLOGDEST_STDOUT | RTLOGDEST_USER,
-                           vbClLogHeaderFooter, g_cHistory, g_uHistoryFileSize, g_uHistoryFileTime,
+                           fPrintHeader ? vbClLogHeaderFooter : NULL, g_cHistory, g_uHistoryFileSize, g_uHistoryFileTime,
                            NULL /*pOutputIf*/, NULL /*pvOutputIfUser*/,
                            NULL /*pErrInfo*/, "%s", pszLogFile ? pszLogFile : "");
@@ -396 +396 @@
         rc = RTLogSetCustomPrefixCallback(g_pLoggerRelease, vbClLogPrefixCb, NULL);
         if (RT_FAILURE(rc))
-            VBClLogError("unable to register custom log prefix callback\n");
+            RTMsgError("unable to register custom log prefix callback\n");
 
         /* Explicitly flush the log in case of VBOXSERVICE_RELEASE_LOG=buffered. */
         RTLogFlush(g_pLoggerRelease);
     }
+    else
+        RTMsgError("Failed to create release log '%s', rc=%Rrc\n", pszLogFile, rc);
 
     return rc;
@@ -406 +408 @@
 
 /**
+ * Creates the default release logger outputting to the specified file.
+ *
+ * @return  IPRT status code.
+ * @param   pszLogFile      Filename for log output. Empty filename allowed.
+ */
+int VBClLogCreate(const char *pszLogFile)
+{
+    return VBClLogCreateEx(pszLogFile, true /* fPrintHeader */);
+}
+
+/**
  * Set custom log prefix.
  *

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

@@ -64 +64 @@
 #define VBOXCLIENT_OPT_VMSVGA_SESSION       VBOXCLIENT_OPT_SERVICES + 5
 #define VBOXCLIENT_OPT_DISPLAY              VBOXCLIENT_OPT_SERVICES + 6
-#define VBOXCLIENT_OPT_SESSION_TYPE         VBOXCLIENT_OPT_SERVICES + 7
+#define VBOXCLIENT_OPT_SESSION_DETECT       VBOXCLIENT_OPT_SERVICES + 7
+#define VBOXCLIENT_OPT_SESSION_TYPE         VBOXCLIENT_OPT_SERVICES + 8
 
 
@@ -327 +328 @@
 #endif
     RTPrintf("  --session-type       specifies the session type to use (auto, x11, wayland)\n");
+    RTPrintf("  --session-detect     detects and prints the current session type\n"
+             "                       (exit code 0 if detection succeeded)\n");
     RTPrintf("  -f, --foreground     run in the foreground (no daemonizing)\n");
     RTPrintf("  -d, --nodaemon       continues running as a system service\n");
@@ -534 +537 @@
         { "--display",                      VBOXCLIENT_OPT_DISPLAY,             RTGETOPT_REQ_NOTHING },
 #endif
+        { "--session-detect",               VBOXCLIENT_OPT_SESSION_DETECT,      RTGETOPT_REQ_NOTHING },
         { "--session-type",                 VBOXCLIENT_OPT_SESSION_TYPE,        RTGETOPT_REQ_STRING }
     };
@@ -665 +669 @@
             }
 #endif
+            case VBOXCLIENT_OPT_SESSION_DETECT:
+            {
+                rc = VBClLogCreateEx("" /* No file logging */, false /* No header */);
+                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;
+                }
+
+                return RTEXITCODE_FAILURE;
+            }
+
             case VBOXCLIENT_OPT_SESSION_TYPE:
             {
@@ -720 +738 @@
     rc = VBClLogCreate(g_szLogFile[0] ? g_szLogFile : "");
     if (RT_FAILURE(rc))
-        return RTMsgErrorExitFailure("Failed to create release log '%s', rc=%Rrc\n",
-                              g_szLogFile[0] ? g_szLogFile : "<None>", rc);
+        return RTEXITCODE_FAILURE; /* Error message already printed in VBClLogCreateEx(). */
 
     if (!fDaemonise)