Changeset 30052 in vbox for trunk

Timestamp:

Jun 7, 2010 7:57:21 AM (15 years ago)

Author:

vboxsync

Message:

xpcom/ipcd: Fix message processing so that IPCM client up/down messages are not piled up in the dconnect message queue. Mainly involved converting the boolean wait/process message handling logic to a tri-state wait/process/discard style. The IPCM messages can now be processed without being passed to the DConnect message processing logic.

Location:

trunk/src/libs/xpcom18a4/ipc/ipcd/client

Files:

• public/ipcdclient.h (modified) (2 diffs)
• src/ipcdclient.cpp (modified) (13 diffs)

trunk/src/libs/xpcom18a4/ipc/ipcd/client/public/ipcdclient.h

@@ -68 +68 @@
   NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_GENERAL, 10)
 
+#ifdef VBOX
+/* This error code can only be returned by the selector functions called by
+ * WaitTarget. The message should be dropped without processing. */
+#define IPC_DISCARD_MESSAGE \
+  NS_ERROR_GENERATE_FAILURE(NS_ERROR_MODULE_GENERAL, 12)
+#endif /* VBOX */
+
 /* This error code is returned by IPC_WaitMessage under certain conditions. */
 #define IPC_ERROR_WOULD_BLOCK NS_BASE_STREAM_WOULD_BLOCK
@@ -99 +106 @@
  * the IPC_WaitMessage function, that will immediately fail with an error.
  * OnClientStateChange is called on the same thread where this function is
- * called.  
+ * called.
  *
  * @returns NS_ERROR_NOT_INITIALIZED if IPC_Init has not been called or if

trunk/src/libs/xpcom18a4/ipc/ipcd/client/src/ipcdclient.cpp

@@ -289 +289 @@
 // message target.  the selector is called while inside the target's monitor.
 
-typedef PRBool (* ipcMessageSelector)(
+typedef nsresult (* ipcMessageSelector)(
   void *arg,
   ipcTargetData *td,
@@ -296 +296 @@
 
 // selects any
-static PRBool
+static nsresult
 DefaultSelector(void *arg, ipcTargetData *td, const ipcMessage *msg)
 {
-  return PR_TRUE;
+  return NS_OK;
 }
 
@@ -379 +379 @@
       {
         lastChecked->SetFlag(IPC_MSG_FLAG_IN_PROCESS);
-        PRBool accepted = (aSelector)(aArg, td, lastChecked);
+        nsresult acceptedRV = (aSelector)(aArg, td, lastChecked);
         lastChecked->ClearFlag(IPC_MSG_FLAG_IN_PROCESS);
 
-        if (accepted)
+        if (acceptedRV != IPC_WAIT_NEXT_MESSAGE)
         {
           // remove from pending queue
@@ -389 +389 @@
           else
             td->pendingQ.RemoveFirst();
-          lastChecked->mNext = nsnull;
-
-          *aMsg = lastChecked;
-          break;
+
+          if (acceptedRV != IPC_DISCARD_MESSAGE)
+          {
+            lastChecked->mNext = nsnull;
+            *aMsg = lastChecked;
+            break;
+          }
         }
       }
@@ -411 +414 @@
        * This is necessary as there might be several threads waiting for
        * a message from a single client, and only one gets the DOWN msg. */
-      PRBool alive = (aSelector)(aArg, td, NULL);
-      if (!alive)
+      nsresult aliveRV = (aSelector)(aArg, td, NULL);
+      if (aliveRV != IPC_WAIT_NEXT_MESSAGE)
       {
         *aMsg = NULL;
@@ -598 +601 @@
 
 // selects the next IPCM message with matching request index
-static PRBool
+static nsresult
 WaitIPCMResponseSelector(void *arg, ipcTargetData *td, const ipcMessage *msg)
 {
 #ifdef VBOX
   if (!msg)
-    return PR_TRUE;
+    return IPC_WAIT_NEXT_MESSAGE;
 #endif /* VBOX */
   PRUint32 requestIndex = *(PRUint32 *) arg;
-  return IPCM_GetRequestIndex(msg) == requestIndex;
+  return IPCM_GetRequestIndex(msg) == requestIndex ? NS_OK : IPC_WAIT_NEXT_MESSAGE;
 }
 
@@ -929 +932 @@
 };
 
-static PRBool WaitMessageSelector(void *arg, ipcTargetData *td, const ipcMessage *msg)
+static nsresult WaitMessageSelector(void *arg, ipcTargetData *td, const ipcMessage *msg)
 {
   WaitMessageSelectorData *data = (WaitMessageSelectorData *) arg;
@@ -944 +947 @@
     nsresult rv = obs->OnMessageAvailable(IPC_SENDER_ANY, nsID(), 0, 0);
     if (rv != IPC_WAIT_NEXT_MESSAGE)
-    {
       data->senderDead = PR_TRUE;
-      return PR_FALSE;
-    }
-    return PR_TRUE;
+
+    return rv;
   }
 #endif /* VBOX */
@@ -975 +976 @@
 
             data->senderDead = PR_TRUE;
-            return PR_TRUE; // consume the message
+            return IPC_DISCARD_MESSAGE; // consume the message
           }
           else
@@ -990 +991 @@
             nsresult rv = obs->OnMessageAvailable(status->ClientID(), nsID(), 0, 0);
             if (rv != IPC_WAIT_NEXT_MESSAGE)
-            {
               data->senderDead = PR_TRUE;
-              return PR_TRUE; // consume the message
-            }
+
+            return IPC_DISCARD_MESSAGE; // consume the message
           }
         }
@@ -1019 +1019 @@
              * this case. A client ID wraparound can't falsely trigger
              * this, since the waiting thread would have hit the liveness
-             * check in the mean time. Also, DO NOT consume the message,
-             * otherwise it gets passed to the DConnect message handling
-             * without any further checks. IPCM messages are automatically
-             * discarded if they are left unclaimed. */
+             * check in the mean time. We MUST consume the message, otherwise
+             * IPCM messages pile up as long as there is a pending call, which
+             * can lead to severe processing overhead. */
+            return IPC_DISCARD_MESSAGE; // consume the message
           }
         }
@@ -1031 +1031 @@
         NS_NOTREACHED("unexpected message");
     }
-    return PR_FALSE; // continue iterating
+    return IPC_WAIT_NEXT_MESSAGE; // continue iterating
   }
 
@@ -1051 +1051 @@
 
   // stop iterating if we got a match that the observer accepted.
-  return rv != IPC_WAIT_NEXT_MESSAGE;
+  return rv != IPC_WAIT_NEXT_MESSAGE ? NS_OK : IPC_WAIT_NEXT_MESSAGE;
 }