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

Timestamp:

Sep 3, 2014 2:38:53 PM (10 years ago)

Author:

vboxsync

Message:

Additions/x11/VBoxClient: re-do virtual terminal switch monitoring to work with the kernel driver on X.Org Server 1.16 and later.

Location:

trunk/src/VBox/Additions/x11/VBoxClient

Files:

• VBoxClient.h (modified) (2 diffs)
• display.cpp (modified) (1 diff)
• main.cpp (modified) (4 diffs)
• seamless.cpp (modified) (1 diff)
• testcase/tstSeamlessX11.cpp (modified) (1 diff)

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

@@ -50 +50 @@
     /** Run the service main loop */
     int (*run)(struct VBCLSERVICE **ppInterface, bool fDaemonised);
-    /** Pause the service loop.  This must be safe to call on a different thread
-     * and potentially before @a run is or after it exits.
-     * This is called by the VT monitoring thread to allow the service to disable
-     * itself when the X server is switched out.  If the monitoring functionality
-     * is available then @a pause or @a resume will be called as soon as it starts
-     * up. */
+    /** Pause the service loop.  This is used to allow the service to disable
+     * itself when the X server is switched out.  It must be safe to call on a
+     * different thread if the VT monitoring thread is used. */
     int (*pause)(struct VBCLSERVICE **ppInterface);
     /** Resume after pausing.  The same applies here as for @a pause. */
@@ -79 +76 @@
 }
 
+union _XEvent;  /* We do not want to pull in the X11 header files here. */
+extern void VBClCheckXOrgVT(union _XEvent *pEvent);
+extern int VBClStartVTMonitor();
+
 extern struct VBCLSERVICE **VBClGetClipboardService();
 extern struct VBCLSERVICE **VBClGetSeamlessService();

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

@@ -349 +349 @@
 {
     struct DISPLAYSERVICE *pSelf = getClassFromInterface(ppInterface);
+    int rc;
 
     if (!pSelf->mfInit)
         return VERR_WRONG_ORDER;
+    rc = VBClStartVTMonitor();
+    if (RT_FAILURE(rc))
+        VBClFatalError(("Failed to start the VT monitor thread: %Rrc\n", rc));
     runDisplay(&pSelf->mState);
     return VERR_INTERNAL_ERROR;  /* "Should never reach here." */

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

@@ -150 +150 @@
 }
 
-/** Connect to the X server and return the "XFree86_VT" root window property,
- * or 0 on failure. */
-static unsigned long getXOrgVT(Display *pDisplay)
+/** Check whether X.Org has acquired or lost the current virtual terminal and
+ * call the service @a pause() or @a resume() call-back if appropriate.
+ * The functionality is provided by the vboxvideo driver for pre-1.16 X servers
+ * and by 1.16 and later series servers.
+ * This can either be called directly from a service's event loop or the service
+ * can call VBClStartVTMonitor() to start an event loop in a separate thread.
+ * Property notification for the root window should be selected first.  Services
+ * are not required to check VT changes if they do not need the information.
+ * @param  pEvent an event received on a display connection which will be
+ *                checked to see if it is change to the XFree86_has_VT property
+ */
+void VBClCheckXOrgVT(union _XEvent *pEvent)
 {
     Atom actualType;
     int actualFormat;
-    unsigned long cItems, cbLeft, cVT = 0;
+    unsigned long cItems, cbLeft;
+    bool fHasVT = false;
     unsigned long *pValue;
-
-    XGetWindowProperty(pDisplay, DefaultRootWindow(pDisplay),
-                       XInternAtom(pDisplay, "XFree86_VT", False), 0, 1, False,
-                       XA_INTEGER, &actualType, &actualFormat, &cItems, &cbLeft,
-                       (unsigned char **)&pValue);
+    int rc;
+    Display *pDisplay = pEvent->xany.display;
+    Atom hasVT = XInternAtom(pDisplay, "XFree86_has_VT", False);
+
+    if (   pEvent->type != PropertyNotify
+        || pEvent->xproperty.window != DefaultRootWindow(pDisplay)
+        || pEvent->xproperty.atom != hasVT)
+        return;
+    XGetWindowProperty(pDisplay, DefaultRootWindow(pDisplay), hasVT, 0, 1,
+                       False, XA_INTEGER, &actualType, &actualFormat, &cItems,
+                       &cbLeft, (unsigned char **)&pValue);
     if (cItems && actualFormat == 32)
     {
-        cVT = *pValue;
+        fHasVT = *pValue != 0;
         XFree(pValue);
     }
-    return cVT;
-}
-
-/** Check whether the current virtual terminal is the one running the X server.
- */
-static void checkVTSysfs(RTFILE hFile, uint32_t cVT)
-{
-    char szTTY[7] = "";
-    uint32_t cTTY;
-    size_t cbRead;
-    int rc;
-    const char *pcszStage;
-
-    do {
-        pcszStage = "reading /sys/class/tty/tty0/active";
-        rc = RTFileReadAt(hFile, 0, (void *)szTTY, sizeof(szTTY), &cbRead);
+    else
+        return;
+    if (fHasVT)
+    {
+        rc = (*g_pService)->resume(g_pService);
         if (RT_FAILURE(rc))
-            break;
-        szTTY[cbRead - 1] = '\0';
-        pcszStage = "getting VT number from sysfs file";
-        rc = RTStrToUInt32Full(&szTTY[3], 10, &cTTY);
+            VBClFatalError(("Error resuming the service: %Rrc\n"));
+    }
+    if (!fHasVT)
+    {
+        rc = (*g_pService)->pause(g_pService);
         if (RT_FAILURE(rc))
-            break;
-        pcszStage = "entering critical section";
-        rc = RTCritSectEnter(&g_critSect);
-        if (RT_FAILURE(rc))
-            break;
-        pcszStage = "asking service to pause or resume";
-        if (cTTY == cVT)
-            rc = (*g_pService)->resume(g_pService);
-        else
-            rc = (*g_pService)->pause(g_pService);
-        if (RT_FAILURE(rc))
-            break;
-        pcszStage = "leaving critical section";
-        rc = RTCritSectLeave(&g_critSect);
-    } while(false);
-    if (RT_FAILURE(rc))
-    {
-        LogRelFunc(("VBoxClient: failed at stage: \"%s\" rc: %Rrc cVT: %d szTTY: %s.\n",
-                    pcszStage, rc, (int) cVT, szTTY));
-        if (RTCritSectIsOwner(&g_critSect))
-            RTCritSectLeave(&g_critSect);
-        VBClCleanUp();
-    }
-}
-
-/** Poll for TTY changes using sysfs and for X server disconnection.
- * Reading from the start of the pollable file "/sys/class/tty/tty0/active"
- * returns the currently active TTY as a string of the form "tty<n>", with n
- * greater than zero.  Polling for POLLPRI returns when the TTY changes.
- * @a cVT should be zero if we do not know the X server's VT. */
-static void pollTTYAndXServer(Display *pDisplay, uint32_t cVT)
-{
-    RTFILE hFile = NIL_RTFILE;
-    struct pollfd pollFD[2];
-    unsigned cPollFD = 1;
-    int rc;
-
-    pollFD[1].fd = -1;
-    pollFD[1].revents = 0;
-    /* This block could be Linux-only, but keeping it on Solaris too, where it
-     * should just fail gracefully, gives us more code path coverage. */
-    if (cVT)
-    {
-        rc = RTFileOpen(&hFile, "/sys/class/tty/tty0/active",
-                        RTFILE_O_READ | RTFILE_O_DENY_NONE | RTFILE_O_OPEN);
-        if (RT_SUCCESS(rc))
-        {
-            pollFD[1].fd = RTFileToNative(hFile);
-            pollFD[1].events = POLLPRI;
-            cPollFD = 2;
-        }
-    }
-    AssertRelease(pollFD[1].fd >= 0 || cPollFD == 1);
-    pollFD[0].fd = ConnectionNumber(pDisplay);
-    pollFD[0].events = POLLIN;
-    while (true)
-    {
-        if (hFile != NIL_RTFILE)
-            checkVTSysfs(hFile, cVT);
-        /* The only point of this loop is to trigger the I/O error handler if
-         * appropriate. */
-        while (XPending(pDisplay))
-        {
-            XEvent ev;
-
-            XNextEvent(pDisplay, &ev);
-        }
-        /* If we get caught in a tight loop for some reason try to limit the
-         * damage. */
-        if (poll(pollFD, cPollFD, 0) > 0)
-        {
-            LogRel(("Monitor thread: unexpectedly fast event, revents=0x%x, 0x%x.\n",
-                    pollFD[0].revents, pollFD[1].revents));
-            RTThreadYield();
-        }
-        if (   (poll(pollFD, cPollFD, -1) < 0 && errno != EINTR)
-            || pollFD[0].revents & POLLNVAL
-            || pollFD[1].revents & POLLNVAL)
-        {
-            LogRel(("Monitor thread: poll failed, stopping.\n"));
-            VBClCleanUp();
-        }
+            VBClFatalError(("Error pausing the service: %Rrc\n"));
     }
 }
@@ -283 +208 @@
 {
     Display *pDisplay;
-    unsigned long cVT;
-    RTFILE hFile;
+    bool fHasVT = true;
     
     pDisplay = XOpenDisplay(NULL);
     if (!pDisplay)
-        return VINF_SUCCESS;
-    cVT = getXOrgVT(pDisplay);
-    /* Note: cVT will be 0 if we failed to get it.  This is valid. */
-    pollTTYAndXServer(pDisplay, (uint32_t) cVT);
-    /* Should never get here. */
-    return VINF_SUCCESS;
-}
-
-/**
- * Start the thread which notifies the service when we switch to a different
- * VT or back, and terminates us when the X server exits.  The first is best
- * effort functionality: XFree86 4.3 and older do not report their VT via the
- * "XFree86_VT" root window property at all, and pre-2.6.38 Linux does not
- * provide the interface in "sysfs" which we use.  If there is a need for this
- * to work with pre-2.6.38 Linux we can send the VT_GETSTATE ioctl to
- * /dev/console at regular intervals.
- */
-static int startMonitorThread()
+        VBClFatalError(("Failed to open the X11 display\n"));
+    XSelectInput(pDisplay, DefaultRootWindow(pDisplay), PropertyChangeMask);
+    while (true)
+    {
+        XEvent event;
+
+        XNextEvent(pDisplay, &event);
+        VBClCheckXOrgVT(&event);
+    }
+    return VINF_SUCCESS;  /* Should never be reached. */
+}
+
+/**
+ * Start a thread which notifies the service when we switch to a different
+ * VT or back, and terminates us when the X server exits.  This should be called
+ * by most services which do not regularly run an X11 event loop.
+ */
+int VBClStartVTMonitor()
 {
     return RTThreadCreate(NULL, pfnMonitorThread, NULL, 0,
@@ -441 +365 @@
     if (RT_FAILURE(rc))
         VBClFatalError(("Initialising critical section: %Rrc\n", rc));
-    if (RT_FAILURE(rc))
-        VBClFatalError(("Initialising critical section: %Rrc\n", rc));
     rc = RTPathUserHome(g_szPidFile, sizeof(g_szPidFile));
     if (RT_FAILURE(rc))
@@ -469 +391 @@
     if (RT_FAILURE(rc))
         VBClFatalError(("Initialising service: %Rrc\n", rc));
-    rc = startMonitorThread();
-    if (RT_FAILURE(rc))
-        VBClFatalError(("Starting monitor thread: %Rrc\n", rc));
-    (*g_pService)->run(g_pService, fDaemonise);  /* Should never return. */
+    rc = (*g_pService)->run(g_pService, fDaemonise);
+    if (RT_FAILURE(rc))
+        VBClFatalError(("Service main loop failed: %Rrc\n", rc));
     VBClCleanUp();
-    return 1;
-}
+    return 0;
+}

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

@@ -377 +377 @@
     if (!pSelf->mIsInitialised)
         return VERR_INTERNAL_ERROR;
+    rc = VBClStartVTMonitor();
+    if (RT_FAILURE(rc))
+        VBClFatalError(("Failed to start the VT monitor thread: %Rrc\n", rc));
     /* This only exits on error. */
     rc = pSelf->mSeamless.run();

trunk/src/VBox/Additions/x11/VBoxClient/testcase/tstSeamlessX11.cpp

@@ -31 +31 @@
     RTPrintf("Fatal error: %s", pszMessage);
     exit(1);
+}
+
+int VBClStartVTMonitor()
+{
+    return VINF_SUCCESS;
 }