Changeset 7029 in vbox for trunk/src/libs/xpcom18a4/ipc/ipcd/client

Timestamp:

Feb 20, 2008 11:54:09 AM (17 years ago)

Author:

vboxsync

Message:

XPCOM/IPC: Made IPC_AddName()/IPC_RemoveName(), IPC_DefineTarget() to return a failure when the name/target is already defined or when a non-existent name/target is requested for removal.

File:

• trunk/src/libs/xpcom18a4/ipc/ipcd/client/src/ipcdclient.cpp (modified) (27 diffs)

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

@@ -84 +84 @@
   // the message observer is called via this event queue
   nsCOMPtr<nsIEventQueue> eventQ;
-  
+
   // incoming messages are added to this list
   ipcMessageQ pendingQ;
@@ -138 +138 @@
 /* ------------------------------------------------------------------------- */
 
-typedef nsRefPtrHashtable<nsIDHashKey, ipcTargetData> ipcTargetMap; 
+typedef nsRefPtrHashtable<nsIDHashKey, ipcTargetData> ipcTargetMap;
 
 class ipcClientState
@@ -152 +152 @@
 
   //
-  // the monitor protects the targetMap and the connected and shutdown flags.  
+  // the monitor protects the targetMap and the connected and shutdown flags.
   //
   // NOTE: we use a PRMonitor for this instead of a PRLock because we need
@@ -165 +165 @@
 
   // our process's client id
-  PRUint32      selfID; 
+  PRUint32      selfID;
 
   nsCOMArray<ipcIClientObserver> clientObservers;
@@ -319 +319 @@
 
   PRBool isIPCMTarget = aTarget.Equals(IPCM_TARGET);
-  
+
   PRIntervalTime timeStart = PR_IntervalNow();
   PRIntervalTime timeEnd;
@@ -342 +342 @@
   // only the ICPM target is allowed to wait for a message after shutdown
   // (but before disconnection).  this gives client observers called from
-  // IPC_Shutdown a chance to use IPC_SendMessage to send necessary 
+  // IPC_Shutdown a chance to use IPC_SendMessage to send necessary
   // "last minute" messages to other clients.
-  
+
   while (gClientState->connected && (!gClientState->shutdown || isIPCMTarget))
   {
@@ -375 +375 @@
       // to guarantee that every message is processed only once.
       //
-       
+
       if (!lastChecked->TestFlag(IPC_MSG_FLAG_IN_PROCESS))
       {
@@ -381 +381 @@
         PRBool accepted = (aSelector)(aArg, td, lastChecked);
         lastChecked->ClearFlag(IPC_MSG_FLAG_IN_PROCESS);
-        
+
         if (accepted)
         {
@@ -399 +399 @@
       lastChecked = lastChecked->mNext;
     }
-      
+
     if (*aMsg)
     {
@@ -517 +517 @@
 CallProcessPendingQ(const nsID &target, ipcTargetData *td)
 {
-  // we assume that we are inside td's monitor 
+  // we assume that we are inside td's monitor
 
   PLEvent *ev = new ipcEvent_ProcessPendingQ(target);
@@ -562 +562 @@
 /* ------------------------------------------------------------------------- */
 
+// converts IPCM_ERROR_* status codes to NS_ERROR_* status codes
+static nsresult nsresult_from_ipcm_result(PRInt32 status)
+{
+  nsresult rv = NS_ERROR_FAILURE;
+
+  switch (status)
+  {
+    case IPCM_ERROR_GENERIC:        rv = NS_ERROR_FAILURE; break;
+    case IPCM_ERROR_INVALID_ARG:    rv = NS_ERROR_INVALID_ARG; break;
+    // TODO: select better mapping for the below codes
+    case IPCM_ERROR_NO_CLIENT:
+    case IPCM_ERROR_NO_SUCH_DATA:
+    case IPCM_ERROR_ALREADY_EXISTS: rv = NS_ERROR_FAILURE; break;
+    default:                        NS_ASSERTION(PR_FALSE, "No conversion");
+  }
+
+  return rv;
+}
+
+/* ------------------------------------------------------------------------- */
+
 // selects the next IPCM message with matching request index
 static PRBool
@@ -571 +592 @@
 
 // wait for an IPCM response message.  if responseMsg is null, then it is
-// assumed that the caller does not care to get a reference to the 
+// assumed that the caller does not care to get a reference to the
 // response itself.  if the response is an IPCM_MSG_ACK_RESULT, then the
 // status code is mapped to a nsresult and returned by this function.
@@ -588 +609 @@
     ipcMessageCast<ipcmMessageResult> result(msg);
     if (result->Status() < 0)
-      rv = NS_ERROR_FAILURE; // XXX nsresult_from_ipcm_result()
+      rv = nsresult_from_ipcm_result(result->Status());
     else
       rv = NS_OK;
@@ -682 +703 @@
   if (NS_FAILED(rv))
     return rv;
-  
+
   rv = IPC_Connect(dpath.get());
   if (NS_FAILED(rv))
@@ -742 +763 @@
 
   LOG(("IPC_Shutdown: connected=%d\n",gClientState->connected));
-  
+
   if (gClientState->connected)
   {
@@ -748 +769 @@
       // first, set the shutdown flag and unblock any calls to WaitTarget.
       // all targets but IPCM will not be able to use WaitTarget any more.
-      
+
       nsAutoMonitor mon(gClientState->monitor);
       gClientState->shutdown = PR_TRUE;
@@ -759 +780 @@
     // (this is essential for the DConnect extension, for example, to do the
     // proper uninitialization).
-    
+
     ipcEvent_ClientState *ev = new ipcEvent_ClientState(IPC_SENDER_ANY,
                                                         IPCM_CLIENT_STATE_DOWN);
     ipcEvent_ClientState::HandleEvent (ev);
     ipcEvent_ClientState::DestroyEvent (ev);
-    
+
     IPC_Disconnect();
   }
@@ -896 +917 @@
   // process the specially forwarded client state message to see if the
   // sender we're waiting a message from has died.
-  
+
   if (msg->Target().Equals(IPCM_TARGET))
   {
@@ -910 +931 @@
           LOG(("sender (%d) we're waiting a message from (%d) has died\n",
                status->ClientID(), data->senderID));
-               
+
           if (data->senderID != IPC_SENDER_ANY)
           {
             // we're waiting on a particular client, so IPC_WaitMessage must
             // definitely fail with the NS_ERROR_xxx result.
-            
+
             data->senderDead = PR_TRUE;
             return PR_TRUE; // consume the message
@@ -929 +950 @@
               obs = td->observer;
             NS_ASSERTION(obs, "must at least have a default observer");
-            
+
             nsresult rv = obs->OnMessageAvailable(status->ClientID(), nsID(), 0, 0);
             if (rv != IPC_WAIT_NEXT_MESSAGE)
@@ -986 +1007 @@
   if (NS_FAILED(rv))
     return rv;
-  
+
   // if the requested sender has died while waiting, return an error
   if (data.senderDead)
     return NS_ERROR_ABORT; // XXX better error code?
-  
+
   // if the selector has accepted some message, then we pass it to aConsumer
   // for safe processing.  The IPC susbsystem is quite stable here (i.e. we're
@@ -1002 +1023 @@
                                   msg->DataLen());
   }
-  
+
   delete msg;
 
@@ -1081 +1102 @@
     rv = NS_ERROR_UNEXPECTED;
   }
-    
+
   delete msg;
   return rv;
@@ -1225 +1246 @@
     PlaceOnPendingQ(aKey, aData, msg->Clone());
   }
-  
+
   return PL_DHASH_NEXT;
 }
@@ -1276 +1297 @@
         PostEventToMainThread(new ipcEvent_ClientState(status->ClientID(),
                                                        status->ClientState()));
-        
+
         // go through the target map, and place this message to every target's
         // pending event queue.  that unblocks all WaitTarget calls (on all
@@ -1285 +1306 @@
 
         delete msg;
-        
+
         return;
       }
@@ -1295 +1316 @@
   {
     // make copy of target since |msg| may end up pointing to free'd memory
-    // once we notify the monitor inside PlaceOnPendingQ(). 
+    // once we notify the monitor inside PlaceOnPendingQ().
     const nsID target = msg->Target();
-    
+
     PlaceOnPendingQ(target, td, msg);
   }