Changeset 21095 in vbox for trunk

Timestamp:

Jun 30, 2009 6:54:01 PM (16 years ago)

Author:

vboxsync

Message:

VBoxGuest (common): mouse polling.

Location:

trunk/src/VBox/Additions/common/VBoxGuest

Files:

• VBoxGuest-linux.c (modified) (10 diffs)
• VBoxGuest.cpp (modified) (3 diffs)
• VBoxGuestInternal.h (modified) (3 diffs)

trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuest-linux.c

@@ -41 +41 @@
 #include "the-linux-kernel.h"
 #include <linux/miscdevice.h>
+#include <linux/poll.h>
 #include "version-generated.h"
 
 #include <iprt/assert.h>
+#include <iprt/asm.h>
+#include <iprt/err.h>
+#include <iprt/initterm.h>
+#include <iprt/mem.h>
+#include <iprt/mp.h>
+#include <iprt/process.h>
 #include <iprt/spinlock.h>
 #include <iprt/semaphore.h>
-#include <iprt/initterm.h>
-#include <iprt/process.h>
-#include <iprt/err.h>
-#include <iprt/mem.h>
 #include <VBox/log.h>
-#include <iprt/mp.h>
-#include <iprt/mem.h>
-
-
-#define xstr(s) str(s)
-#define str(s) #s
-
+
+
+/*******************************************************************************
+*   Defined Constants And Macros                                               *
+*******************************************************************************/
 /** The device name. */
 #define DEVICE_NAME             "vboxguest"
@@ -91 +92 @@
 static int  vboxguestLinuxIOCtl(struct inode *pInode, struct file *pFilp, unsigned int uCmd, unsigned long ulArg);
 #endif
+static int  vboxguestFAsync(int fd, struct file *pFile, int fOn);
+static unsigned int vboxguestPoll(struct file *pFile, poll_table *pPt);
+static ssize_t vboxguestRead(struct file *pFile, char *pbBuf, size_t cbRead, loff_t *poff);
 
 
@@ -110 +114 @@
 /** The pointer to the mapping of the MMIO range. */
 static void                    *g_pvMMIOBase;
+/** Wait queue used by polling. */
+static wait_queue_head_t        g_PollEventQueue;
+/** Asynchronous notification stuff.  */
+static struct fasync_struct    *g_pFAsyncQueue;
 
 /** Our file node major id.
@@ -118 +126 @@
 static unsigned int             g_iModuleMajor = 0;
 #endif
-
 
 /** The file_operations structure. */
@@ -131 +138 @@
     ioctl:          vboxguestLinuxIOCtl,
 #endif
+    read:           vboxguestRead,
+    poll:           vboxguestPoll,
+    fasync:         vboxguestFAsync,
 };
 
@@ -442 +452 @@
     if (RT_FAILURE(rc))
     {
-        Log((DEVICE_NAME ": RTR0Init failed.\n"));
+        printk(KERN_ERR DEVICE_NAME ": RTR0Init failed, rc=%d.\n", rc);
         return -EINVAL;
     }
@@ -487 +497 @@
                 {
                     /* some useful information for the user but don't show this on the console */
-                    LogRel(("VirtualBox device settings: major %d, IRQ %d, I/O port 0x%x, MMIO at 0x%x (size 0x%x)\n",
+                    LogRel((DEVICE_NAME ": major %d, IRQ %d, I/O port 0x%x, MMIO at 0x%x (size 0x%x)\n",
                             g_iModuleMajor, g_pPciDev->irq, g_IOPortBase, g_MMIOPhysAddr, g_cbMMIO));
                     printk(KERN_DEBUG DEVICE_NAME ": Successfully loaded version "
-                            VBOX_VERSION_STRING " (interface " xstr(VMMDEV_VERSION) ")\n");
+                            VBOX_VERSION_STRING " (interface " RT_XSTR(VMMDEV_VERSION) ")\n");
                     return rc;
                 }
@@ -499 +509 @@
             else
             {
-                LogRel(( DEVICE_NAME ": VBoxGuestInitDevExt failed with rc=%Rrc\n", rc));
+                LogRel((DEVICE_NAME ": VBoxGuestInitDevExt failed with rc=%Rrc\n", rc));
                 rc = RTErrConvertFromErrno(rc);
             }
@@ -657 +667 @@
 }
 
+
+/**
+ * Poll function.
+ *
+ * This returns ready to read if the mouse pointer mode or the pointer position
+ * has changed since last call to read.
+ *
+ * @returns 0 if no changes, POLLIN | POLLRDNORM if there are unseen changes.
+ *
+ * @param   pFile       The file structure.
+ * @param   pPt         The poll table.
+ */
+static unsigned int vboxguestPoll(struct file *pFile, poll_table *pPt)
+{
+    PVBOXGUESTSESSION   pSession  = (PVBOXGUESTSESSION)pFile->private_data;
+    uint32_t            u32CurSeq = ASMAtomicUoReadU32(&g_DevExt.u32MousePosChangedSeq);
+    unsigned int        fMask     = pSession->u32MousePosChangedSeq != u32CurSeq
+                                  ? POLLIN | POLLRDNORM
+                                  : 0;
+#if 1 /** @todo this isn't quite right... but it's what we used to do. */
+    pSession->u32MousePosChangedSeq = u32CurSeq;
+#endif
+    poll_wait(pFile, &g_PollEventQueue, pPt);
+    return fMask;
+}
+
+
+/**
+ * Asynchronous notification activation method.
+ *
+ * @returns 0 on success, negative errno on failure.
+ *
+ * @param   fd          The file descriptor.
+ * @param   pFile       The file structure.
+ * @param   fOn         On/off indicator.
+ */
+static int vboxguestFAsync(int fd, struct file *pFile, int fOn)
+{
+    return fasync_helper(fd, pFile, fOn, &g_pFAsyncQueue);
+}
+
+
+/**
+ * Read to go with our poll/fasync response.
+ *
+ * @returns 1 or -EINVAL.
+ *
+ * @param   pFile       The file structure.
+ * @param   pbBuf       The buffer to read into.
+ * @param   cbRead      The max number of bytes to read.
+ * @param   poff        The current file position.
+ */
+static ssize_t vboxguestRead(struct file *pFile, char *pbBuf, size_t cbRead, loff_t *poff)
+{
+    if (*poff != 0)
+        return -EINVAL;
+
+    if (cbRead > 0)
+    {
+        /* Indicate that we're up to speed. */
+        PVBOXGUESTSESSION   pSession    = (PVBOXGUESTSESSION)pFile->private_data;
+        uint32_t            u32CurSeq   = ASMAtomicUoReadU32(&g_DevExt.u32MousePosChangedSeq);
+        pSession->u32MousePosChangedSeq = u32CurSeq;
+
+        pbBuf[0] = 0;
+        return 1;
+    }
+
+#if 1 /** @todo This is wrong, see man 2 read. Does it server any purpose? */
+    return -EINVAL;
+#else
+    return 0;
+#endif
+}
+
+
+void VBoxGuestNativeISRMousePollEvent(PVBOXGUESTDEVEXT pDevExt)
+{
+    NOREF(pDevExt);
+
+    /*
+     * Wake up everyone that's in a poll() and post anyone that has
+     * subscribed to async notifications.
+     */
+    wake_up_all(&g_PollEventQueue);
+    kill_fasync(&g_pFAsyncQueue, SIGIO, POLL_IN);
+}
+
+
 /* Common code that depend on g_DevExt. */
 #include "VBoxGuestIDC-unix.c.h"
@@ -671 +770 @@
 MODULE_LICENSE("GPL");
 #ifdef MODULE_VERSION
-MODULE_VERSION(VBOX_VERSION_STRING " (" xstr(SUPDRV_IOC_VERSION) ")");
-#endif
-
+MODULE_VERSION(VBOX_VERSION_STRING " (" RT_XSTR(SUPDRV_IOC_VERSION) ")");
+#endif
+

trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuest.cpp

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- * VBoxGuest - Guest Additions Driver.
+ * VBoxGuest - Guest Additions Driver, Common Code.
  */
 
 /*
- * Copyright (C) 2007 Sun Microsystems, Inc.
+ * Copyright (C) 2007-2009 Sun Microsystems, Inc.
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -1411 +1411 @@
             RTSpinlockAcquireNoInts(pDevExt->WaitSpinlock, &Tmp);
 
+            /** @todo This looks wrong: Seems like VMMDEV_EVENT_HGCM will always be set in
+             *        f32PendingEvents... */
 #ifdef VBOX_WITH_HGCM
             /* The HGCM event/list is kind of different in that we evaluate all entries. */
@@ -1423 +1425 @@
 #endif
 
+            /* VMMDEV_EVENT_MOUSE_POSITION_CHANGED can only be polled for. */
+#if defined(RT_OS_LINUX)
+            if (fEvents & VMMDEV_EVENT_MOUSE_POSITION_CHANGED)
+            {
+                pDevExt->u32MousePosChangedSeq++;
+                VBoxGuestNativeISRMousePollEvent(pDevExt);
+            }
+#endif
+            fEvents &= ~VMMDEV_EVENT_MOUSE_POSITION_CHANGED;
+
             /* Normal FIFO evaluation. */
             fEvents |= pDevExt->f32PendingEvents;

trunk/src/VBox/Additions/common/VBoxGuest/VBoxGuestInternal.h

@@ -97 +97 @@
     /** Mask of pending events. */
     uint32_t volatile           f32PendingEvents;
+    /** Current VMMDEV_EVENT_MOUSE_POSITION_CHANGED sequence number.
+     * Used to implement polling.  */
+    uint32_t volatile           u32MousePosChangedSeq;
 
     /** Spinlock various items in the VBOXGUESTSESSION. */
@@ -144 +147 @@
     uint32_t volatile           aHGCMClientIds[8];
 #endif
+
+    /** The last consumed VMMDEV_EVENT_MOUSE_POSITION_CHANGED sequence number.
+     * Used to implement polling.  */
+    uint32_t volatile           u32MousePosChangedSeq;
 } VBOXGUESTSESSION;
 
@@ -170 +177 @@
 #endif
 
+/**
+ * ISR callback for notifying threads polling for mouse events.
+ *
+ * @param   pDevExt     The device extension.
+ */
+void VBoxGuestNativeISRMousePollEvent(PVBOXGUESTDEVEXT pDevExt);
+
 RT_C_DECLS_END