Changeset 7029 in vbox for trunk/src/libs/xpcom18a4

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.

Location:

trunk/src/libs/xpcom18a4/ipc/ipcd

Files:

• client/src/ipcdclient.cpp (modified) (27 diffs)
• daemon/src/ipcClient.cpp (modified) (4 diffs)
• daemon/src/ipcClient.h (modified) (4 diffs)
• daemon/src/ipcCommandModule.cpp (modified) (8 diffs)
• shared/src/ipcIDList.h (modified) (1 diff)
• shared/src/ipcStringList.h (modified) (1 diff)
• shared/src/ipcm.h (modified) (5 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);
   }

trunk/src/libs/xpcom18a4/ipc/ipcd/daemon/src/ipcClient.cpp

@@ -96 +96 @@
 }
 
-void
+PRBool
 ipcClient::DelName(const char *name)
 {
     LOG(("deleting client name: %s\n", name));
 
-    mNames.FindAndDelete(name);
+    return mNames.FindAndDelete(name);
 }
 
@@ -115 +115 @@
 }
 
-void
+PRBool
 ipcClient::DelTarget(const nsID &target)
 {
@@ -124 +124 @@
     //
     if (!target.Equals(IPCM_TARGET))
-        mTargets.FindAndDelete(target);
+        return mTargets.FindAndDelete(target);
+
+    return PR_FALSE;
 }
 
@@ -185 +187 @@
         }
     }
-  
+
     if (inFlags & PR_POLL_WRITE) {
         LOG(("client socket is now writable\n"));

trunk/src/libs/xpcom18a4/ipc/ipcd/daemon/src/ipcClient.h

@@ -65 +65 @@
 
     void   AddName(const char *name);
-    void   DelName(const char *name);
+    PRBool DelName(const char *name);
     PRBool HasName(const char *name) const { return mNames.Find(name) != NULL; }
 
     void   AddTarget(const nsID &target);
-    void   DelTarget(const nsID &target);
+    PRBool DelTarget(const nsID &target);
     PRBool HasTarget(const nsID &target) const { return mTargets.Find(target) != NULL; }
 
@@ -96 +96 @@
     //
     // returns:
-    //   0             - to cancel client connection  
+    //   0             - to cancel client connection
     //   PR_POLL_READ  - to poll for a readable socket
     //   PR_POLL_WRITE - to poll for a writable socket
@@ -102 +102 @@
     //
     // the socket is non-blocking.
-    // 
+    //
     int Process(PRFileDesc *sockFD, int pollFlags);
 
@@ -125 +125 @@
     // encoded in it.
     PRUint32      mPID;
-    
+
     // the hwnd of the client's message window.
     HWND          mHwnd;

trunk/src/libs/xpcom18a4/ipc/ipcd/daemon/src/ipcCommandModule.cpp

@@ -62 +62 @@
 
         const ipcStringNode *node;
-        
+
         for (node = nodes; node; node = node->mNext)
             count++;
@@ -84 +84 @@
 
         const ipcIDNode *node;
-        
+
         for (node = nodes; node; node = node->mNext)
             count++;
@@ -133 +133 @@
         LOG(("got CLIENT_ADD_NAME\n"));
 
+        PRInt32 status = IPCM_OK;
+        PRUint32 requestIndex = IPCM_GetRequestIndex(rawMsg);
+
         ipcMessageCast<ipcmMessageClientAddName> msg(rawMsg);
         const char *name = msg->Name();
-        if (name)
-            client->AddName(name);
-
-        // TODO: send better status code (e.g., suppose name already defined for client)
-        IPC_SendMsg(client, new ipcmMessageResult(IPCM_GetRequestIndex(rawMsg), IPCM_OK));
+        if (name) {
+            ipcClient *result = IPC_GetClientByName(msg->Name());
+            if (result) {
+                LOG(("  client with such name already exists (ID = %d)\n", result->ID()));
+                status = IPCM_ERROR_ALREADY_EXISTS;
+            }
+            else
+                client->AddName(name);
+        }
+        else
+            status = IPCM_ERROR_INVALID_ARG;
+
+        IPC_SendMsg(client, new ipcmMessageResult(requestIndex, status));
     }
 
@@ -146 +157 @@
     {
         LOG(("got CLIENT_DEL_NAME\n"));
+
+        PRInt32 status = IPCM_OK;
+        PRUint32 requestIndex = IPCM_GetRequestIndex(rawMsg);
 
         ipcMessageCast<ipcmMessageClientDelName> msg(rawMsg);
         const char *name = msg->Name();
-        if (name)
-            client->DelName(name);
-
-        // TODO: send better status code (e.g., suppose name not defined for client)
-        IPC_SendMsg(client, new ipcmMessageResult(IPCM_GetRequestIndex(rawMsg), IPCM_OK));
+        if (name) {
+            if (!client->DelName(name)) {
+                LOG(("  client doesn't have name '%s'\n", name));
+                status = IPCM_ERROR_NO_SUCH_DATA;
+            }
+        }
+        else
+            status = IPCM_ERROR_INVALID_ARG;
+
+        IPC_SendMsg(client, new ipcmMessageResult(requestIndex, status));
     }
 
@@ -161 +180 @@
         LOG(("got CLIENT_ADD_TARGET\n"));
 
+        PRInt32 status = IPCM_OK;
+        PRUint32 requestIndex = IPCM_GetRequestIndex(rawMsg);
+
         ipcMessageCast<ipcmMessageClientAddTarget> msg(rawMsg);
-        client->AddTarget(msg->Target());
-
-        // TODO: send better status code (e.g., suppose target already defined for client)
-        IPC_SendMsg(client, new ipcmMessageResult(IPCM_GetRequestIndex(rawMsg), IPCM_OK));
+        if (client->HasTarget(msg->Target())) {
+            LOG(("  target already defined for client\n"));
+            status = IPCM_ERROR_ALREADY_EXISTS;
+        }
+        else
+            client->AddTarget(msg->Target());
+
+        IPC_SendMsg(client, new ipcmMessageResult(requestIndex, status));
     }
 
@@ -173 +199 @@
         LOG(("got CLIENT_DEL_TARGET\n"));
 
+        PRInt32 status = IPCM_OK;
+        PRUint32 requestIndex = IPCM_GetRequestIndex(rawMsg);
+
         ipcMessageCast<ipcmMessageClientDelTarget> msg(rawMsg);
-        client->DelTarget(msg->Target());
-
-        // TODO: send better status code (e.g., suppose target not defined for client)
-        IPC_SendMsg(client, new ipcmMessageResult(IPCM_GetRequestIndex(rawMsg), IPCM_OK));
+        if (!client->DelTarget(msg->Target())) {
+            LOG(("  client doesn't have the given target\n"));
+            status = IPCM_ERROR_NO_SUCH_DATA;
+        }
+
+        IPC_SendMsg(client, new ipcmMessageResult(requestIndex, status));
     }
 
@@ -222 +253 @@
         else {
             LOG(("  client does not exist\n"));
-            IPC_SendMsg(client, new ipcmMessageError(IPCM_ERROR_CLIENT_NOT_FOUND, msg->RequestIndex()));
+            IPC_SendMsg(client, new ipcmMessageError(IPCM_ERROR_NO_CLIENT, msg->RequestIndex()));
         }
     }
@@ -278 +309 @@
     type--;
     if (type < 0 || type >= (int) (sizeof(handlers)/sizeof(handlers[0]))) {
-        LOG(("unknown request -- ignoring message\n")); 
+        LOG(("unknown request -- ignoring message\n"));
         return;
     }

trunk/src/libs/xpcom18a4/ipc/ipcd/shared/src/ipcIDList.h

@@ -86 +86 @@
     }
 
-    void FindAndDelete(const nsID &id)
+    PRBool FindAndDelete(const nsID &id)
     {
         ipcIDNode *node = FindNodeBefore(mHead, id);
-        if (node)
+        if (node) {
             DeleteAfter(node);
-        else
+            return PR_TRUE;
+        }
+        else if (!IsEmpty()) {
             DeleteFirst();
+            return PR_TRUE;
+        }
+
+        return PR_FALSE;
     }
 

trunk/src/libs/xpcom18a4/ipc/ipcd/shared/src/ipcStringList.h

@@ -92 +92 @@
     }
 
-    void FindAndDelete(const char *str)
+    PRBool FindAndDelete(const char *str)
     {
         ipcStringNode *node = FindNodeBefore(mHead, str);
-        if (node)
+        if (node) {
             DeleteAfter(node);
-        else
+            return PR_TRUE;
+        }
+        else if (!IsEmpty()) {
             DeleteFirst();
+            return PR_TRUE;
+        }
+
+        return PR_FALSE;
     }
 

trunk/src/libs/xpcom18a4/ipc/ipcd/shared/src/ipcm.h

@@ -129 +129 @@
 
 //
-// return IPCM message request index.  
+// return IPCM message request index.
 //
 static inline PRUint32
@@ -258 +258 @@
 // This request message has as its payload a null-terminated ASCII character
 // string indicating the client name to query.
-// 
+//
 
 // ACKNOWLEDGEMENTS
@@ -272 +272 @@
 // codes):
 //
-#define IPCM_OK               0  // success: generic
-#define IPCM_ERROR_GENERIC   -1  // failure: generic
-#define IPCM_ERROR_NO_CLIENT -2  // failure: client does not exist
+#define IPCM_OK                      0  // success: generic
+#define IPCM_ERROR_GENERIC          -1  // failure: generic
+#define IPCM_ERROR_NO_CLIENT        -2  // failure: client does not exist
+#define IPCM_ERROR_INVALID_ARG      -3  // failure: invalid request argument
+#define IPCM_ERROR_NO_SUCH_DATA     -4  // failure: requested data does not exist
+#define IPCM_ERROR_ALREADY_EXISTS   -5  // failure: data to set already exists
 
 //
@@ -310 +313 @@
 // This message is sent by the daemon to a client on behalf of another client.
 // The recipient is expected to unpack the contained message and process it.
-// 
+//
 // The payload of this message matches the payload of IPCM_MSG_REQ_FORWARD,
 // with the exception that the clientID field is set to the clientID of the
@@ -323 +326 @@
 //       adds no additional member variables.  |operator new| should be used
 //       to allocate one of the IPCM helper classes, e.g.:
-//         
+//
 //          ipcMessage *msg = new ipcmMessageClientHello("foo");
 //