Changeset 109067 in vbox

Timestamp:

Apr 24, 2025 10:08:54 AM (4 weeks ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

168604

Message:

libs/xpcom,Main/glue,++: Bake the automatic re-registration of XPCOM components (in the components directory) into the NS_InitXPCOM2 call to avoid the problem of VBoxXPCOMIPCC.so/dylib being engaged at the end of NS_InitXPCOM2 and unable to re-register if this is done later by the client code. Added a fFlagsInit parameter to indicate whether this auto reg behaviour is required or not and renamed NS_InitXPCOM2 to NS_InitXPCOM2Ex (the latter to prevent confusion). bugref:10896 ticketref:22193

Location:

trunk/src

Files:

• VBox/Frontends/VBoxFB/VBoxFB.cpp (modified) (2 diffs)
• VBox/Main/glue/initterm.cpp (modified) (4 diffs)
• VBox/Main/testcase/tstVBoxAPIXPCOM.cpp (modified) (2 diffs)
• libs/xpcom18a4/VBoxXPCOM.def (modified) (1 diff)
• libs/xpcom18a4/ipc/ipcd/test/TestIPC.cpp (modified) (1 diff)
• libs/xpcom18a4/java/src/nsJavaInterfaces.cpp (modified) (1 diff)
• libs/xpcom18a4/python/src/dllmain.cpp (modified) (1 diff)
• libs/xpcom18a4/xpcom/build/nsXPCOM.h (modified) (6 diffs)
• libs/xpcom18a4/xpcom/build/nsXPComInit.cpp (modified) (7 diffs)
• libs/xpcom18a4/xpcom/components/nsComponentManager.cpp (modified) (5 diffs)
• libs/xpcom18a4/xpcom/io/nsDirectoryServiceDefs.h (modified) (1 diff)
• libs/xpcom18a4/xpcom/tests/TestFactory.cpp (modified) (1 diff)
• libs/xpcom18a4/xpcom/tests/nsIFileTest.cpp (modified) (1 diff)

trunk/src/VBox/Frontends/VBoxFB/VBoxFB.cpp

@@ -153 +153 @@
 #if 0
         nsCOMPtr<nsIServiceManager> serviceManager;
-        rc = NS_InitXPCOM2(getter_AddRefs(serviceManager), nsnull, nsnull);
+        rc = NS_InitXPCOM2Ex(getter_AddRefs(serviceManager), nsnull, nsnull, NS_INIT_XPCOM_F_AUTO_REGISTER_COMPONENTS_WITH_STATUS);
         if (NS_FAILED(rc))
         {
@@ -159 +159 @@
             exit(-1);
         }
-
-        // register our component
-        nsCOMPtr<nsIComponentRegistrar> registrar = do_QueryInterface(serviceManager);
-        if (!registrar)
-        {
-            printf("Error: could not query nsIComponentRegistrar interface!\n");
-            exit(-1);
-        }
-        registrar->AutoRegister(nsnull);
 
         /*

trunk/src/VBox/Main/glue/initterm.cpp

@@ -168 +168 @@
                                   nsIFile **aRetval)
 {
-    nsCOMPtr <nsILocalFile> localFile;
-    nsresult rv = NS_ERROR_FAILURE;
-
     *aRetval = nsnull;
     *aPersistent = PR_TRUE;
 
-    const char *fileLocation = NULL;
-
+    const char *fileLocation;
     if (strcmp(aProp, NS_XPCOM_COMPONENT_REGISTRY_FILE) == 0)
         fileLocation = mCompRegLocation;
@@ -187 +183 @@
         return NS_ERROR_FAILURE;
 
-    rv = NS_NewNativeLocalFile(nsEmbedCString(fileLocation),
-                               PR_TRUE, getter_AddRefs(localFile));
+    nsCOMPtr<nsILocalFile> localFile;
+    nsresult rv = NS_NewNativeLocalFile(nsEmbedCString(fileLocation),
+                                        PR_TRUE, getter_AddRefs(localFile));
     if (NS_FAILED(rv))
         return rv;
@@ -705 +702 @@
             break;
 
-        /* Setup the application path for NS_InitXPCOM2. Note that we properly
+        /* Setup the application path for NS_InitXPCOM2Ex. Note that we properly
          * answer the NS_XPCOM_CURRENT_PROCESS_DIR query in our directory
          * service provider but it seems to be activated after the directory
-         * service is used for the first time (see the source NS_InitXPCOM2). So
+         * service is used for the first time (see the source NS_InitXPCOM2Ex). So
          * use the same value here to be on the safe side. */
         nsCOMPtr <nsIFile> appDir;
@@ -737 +734 @@
         {
             nsCOMPtr<nsIServiceManager> serviceManager;
-            hrc = NS_InitXPCOM2(getter_AddRefs(serviceManager), appDir, dsProv);
+            hrc = NS_InitXPCOM2Ex(getter_AddRefs(serviceManager), appDir, dsProv,
+                                  NS_INIT_XPCOM_F_AUTO_REGISTER_COMPONENTS_WITH_STATUS);
             if (NS_SUCCEEDED(hrc))
             {
-                nsCOMPtr<nsIComponentRegistrar> registrar = do_QueryInterface(serviceManager, &hrc);
-                if (NS_SUCCEEDED(hrc))
-                {
-                    hrc = registrar->AutoRegister(nsnull);
-                    if (NS_SUCCEEDED(hrc))
-                    {
-                        /* We succeeded, stop probing paths */
-                        LogFlowFunc(("Succeeded.\n"));
-                        break;
-                    }
-                }
+                /* We succeeded, stop probing paths */
+                LogFlowFunc(("Succeeded.\n"));
+                break;
             }
         }

trunk/src/VBox/Main/testcase/tstVBoxAPIXPCOM.cpp

@@ -515 +515 @@
     {
         nsCOMPtr<nsIServiceManager> serviceManager;
-        rc = NS_InitXPCOM2(getter_AddRefs(serviceManager), nsnull, nsnull);
+        rc = NS_InitXPCOM2Ex(getter_AddRefs(serviceManager), nsnull, nsnull, 0);
         if (NS_FAILED(rc))
         {
@@ -521 +521 @@
             return -1;
         }
-
-#if 0
-        /*
-         * Register our components. This step is only necessary if this executable
-         * implements XPCOM components itself which is not the case for this
-         * simple example.
-         */
-        nsCOMPtr<nsIComponentRegistrar> registrar = do_QueryInterface(serviceManager);
-        if (!registrar)
-        {
-            printf("Error: could not query nsIComponentRegistrar interface!\n");
-            return -1;
-        }
-        registrar->AutoRegister(nsnull);
-#endif
 
         /*

trunk/src/libs/xpcom18a4/VBoxXPCOM.def

@@ -93 +93 @@
     NS_GetTraceRefcnt
     NS_IsXPCOMInitialized
-    NS_InitXPCOM2
+    NS_InitXPCOM2Ex
     NS_MeanAndStdDev
     NS_NewByteInputStream

trunk/src/libs/xpcom18a4/ipc/ipcd/test/TestIPC.cpp

@@ -196 +196 @@
     {
         nsCOMPtr<nsIServiceManager> servMan;
-        NS_InitXPCOM2(getter_AddRefs(servMan), nsnull, nsnull);
+        NS_InitXPCOM2Ex(getter_AddRefs(servMan), nsnull, nsnull, 0);
         nsCOMPtr<nsIComponentRegistrar> registrar = do_QueryInterface(servMan);
         NS_ASSERTION(registrar, "Null nsIComponentRegistrar");

trunk/src/libs/xpcom18a4/java/src/nsJavaInterfaces.cpp

@@ -212 +212 @@
   // init XPCOM
   nsCOMPtr<nsIServiceManager> servMan;
-  rv = NS_InitXPCOM2(getter_AddRefs(servMan), directory, provider);
+  rv = NS_InitXPCOM2Ex(getter_AddRefs(servMan), directory, provider, 0);
   NS_ENSURE_SUCCESS(rv, rv);
 
-  // create Java proxy for service manager returned by NS_InitXPCOM2
+  // create Java proxy for service manager returned by NS_InitXPCOM2Ex
   return NativeInterfaceToJavaObject(env, servMan, NS_GET_IID(nsIServiceManager),
                                      nsnull, aResult);

trunk/src/libs/xpcom18a4/python/src/dllmain.cpp

@@ -181 +181 @@
                         // not already initialized.
                         // Elsewhere, Mozilla can find it itself (we hope!)
-                        nsresult rv = NS_InitXPCOM2(nsnull, nsnull, nsnull);
+                        nsresult rv = NS_InitXPCOM2Ex(nsnull, nsnull, nsnull, 0);
                         if (NS_FAILED(rv)) {
                                 PyErr_SetString(PyExc_RuntimeError, "The XPCOM subsystem could not be initialized");

trunk/src/libs/xpcom18a4/xpcom/build/nsXPCOM.h

@@ -48 +48 @@
 #ifdef VBOX_WITH_XPCOM_NAMESPACE_CLEANUP
 #define NS_IsXPCOMInitialized VBoxNsxpNS_IsXPCOMInitialized
-#define NS_InitXPCOM2 VBoxNsxpNS_InitXPCOM2
+#define NS_InitXPCOM2Ex VBoxNsxpNS_InitXPCOM2Ex
 #define NS_ShutdownXPCOM VBoxNsxpNS_ShutdownXPCOM
 #define NS_NewNativeLocalFile VBoxNsxpNS_NewNativeLocalFile
@@ -76 +76 @@
 
 /**
- * Checks whether XPCOM was initialized by a call to NS_InitXPCOM2().
+ * Checks whether XPCOM was initialized by a call to NS_InitXPCOM2Ex().
  */
 extern "C" NS_COM PRBool
@@ -109 +109 @@
  *                         <CODE>nsnull</CODE> for the default behaviour.
  *
+ * @param fInitFlags       NS_INIT_XPCOM_F_XXX values ORed together or zero.
+ *                         This was added during @bugref{10896} to workaround
+ *                         the problem that the IPC client component was already
+ *                         in use by the time NS_InitXPCOM2Ex returns and thus
+ *                         cannot be auto-re-registered by the client.
+ *                         (The actual need to trigger auto-reregistration of
+ *                         components is questionable, though, as it ought only
+ *                         to be needed after installing a new version,
+ *                         but we've always done it as part of our COM init glue
+ *                         code (see Main/glue/initterm.cpp).)
+ *
  * @see NS_NewLocalFile
  * @see nsILocalFile
@@ -120 +131 @@
  */
 extern "C" NS_COM nsresult
-NS_InitXPCOM2(nsIServiceManager* *result, 
-              nsIFile* binDirectory,
-              nsIDirectoryServiceProvider* appFileLocationProvider);
+NS_InitXPCOM2Ex(nsIServiceManager* *result,
+                nsIFile* binDirectory,
+                nsIDirectoryServiceProvider* appFileLocationProvider,
+                PRUint32 fFlags);
+
+/** @name NS_INIT_XPCOM_F_XXX - Flags for NS_InitXPCOM2Ex.
+ * @{ */
+/** Auto-register components. */
+#define NS_INIT_XPCOM_F_AUTO_REGISTER_COMPONENTS                1
+/** Auto-register components and return any failure status.
+ * @note When using this, always call NS_ShutdownXPCOM(nsnull) on failure
+ *       (generally a good idea). */
+#define NS_INIT_XPCOM_F_AUTO_REGISTER_COMPONENTS_WITH_STATUS    2
+/** @} */
+
 /**
  * Shutdown XPCOM. You must call this method after you are finished
@@ -129 +152 @@
  * @status FROZEN
  *
- * @param servMgr           The service manager which was returned by NS_InitXPCOM2.  
- *                          This will release servMgr.  You may pass null.
+ * @param servMgr           The service manager which was returned by
+ *                          NS_InitXPCOM2Ex. This will release servMgr.
+ *                          You may pass null.
  *
  * @return NS_OK for success;
@@ -181 +205 @@
 /**
  * Public Method to create an instance of a nsILocalFile.  This function
- * may be called prior to NS_InitXPCOM2.  
+ * may be called prior to NS_InitXPCOM2Ex.
  * 
  * @status FROZEN

trunk/src/libs/xpcom18a4/xpcom/build/nsXPComInit.cpp

@@ -380 +380 @@
 }
 
-nsresult NS_COM NS_InitXPCOM2(nsIServiceManager* *result,
-                              nsIFile* binDirectory,
-                              nsIDirectoryServiceProvider* appFileLocationProvider)
+nsresult NS_COM NS_InitXPCOM2Ex(nsIServiceManager* *result,
+                                nsIFile* binDirectory,
+                                nsIDirectoryServiceProvider* appFileLocationProvider,
+                                PRUint32 fInitFlags)
 {
     nsresult rv = NS_OK;
@@ -388 +389 @@
     /* Make sure IPRT is initialized. */
     RTR3InitDll(RTR3INIT_FLAGS_UNOBTRUSIVE);
-    LogFlow(("NS_InitXPCOM2: done RTR3InitDll\n"));
+    LogFlow(("NS_InitXPCOM2Ex(,%p,%p,%#x): done RTR3InitDll\n", binDirectory, appFileLocationProvider, fInitFlags));
 
      // We are not shutting down
@@ -438 +439 @@
         nsCOMPtr<nsIFile> xpcomLib;
 
-        PRBool value;
         if (binDirectory)
         {
+            PRBool value = PR_FALSE;
             rv = binDirectory->IsDirectory(&value);
-
             if (NS_SUCCEEDED(rv) && value) {
                 gDirectoryService->Set(NS_XPCOM_INIT_CURRENT_PROCESS_DIR, binDirectory);
@@ -448 +448 @@
             }
         }
-        else {
+        else
             gDirectoryService->Get(NS_XPCOM_CURRENT_PROCESS_DIR,
                                    NS_GET_IID(nsIFile),
                                    getter_AddRefs(xpcomLib));
-        }
 
         if (xpcomLib) {
@@ -524 +523 @@
 #endif
 
-    if ( NS_FAILED(rv) || CheckUpdateFile()) {
-        LogFlow(("NS_InitXPCOM2: rv=%#x or CheckUpdateFile()=>true\n", rv));
+    PRBool fCheckUpdateFile = PR_FALSE;
+    if (   NS_FAILED(rv)
+        || (fInitFlags & (NS_INIT_XPCOM_F_AUTO_REGISTER_COMPONENTS | NS_INIT_XPCOM_F_AUTO_REGISTER_COMPONENTS_WITH_STATUS))
+        || (fCheckUpdateFile = CheckUpdateFile())) {
+        LogFlow(("NS_InitXPCOM2Ex: rv=%#x fInitFlags=%#x CheckUpdateFile()=%d --> auto (re-)registering components\n",
+                 rv, fInitFlags, fCheckUpdateFile)); RT_NOREF_PV(fCheckUpdateFile);
 
         // if we find no persistent registry, we will try to autoregister
         // the default components directory.
-        nsComponentManagerImpl::gComponentManager->AutoRegister(nsnull);
+        rv = nsComponentManagerImpl::gComponentManager->AutoRegister(nsnull);
+        if (NS_FAILED(rv) && (fInitFlags & NS_INIT_XPCOM_F_AUTO_REGISTER_COMPONENTS_WITH_STATUS)) {
+            NS_ERROR("gComponentManager->AutoRegister failed!");
+            return rv;
+        }
 
         // If the application is using a GRE, then,
@@ -631 +638 @@
 
     // Notify observers of xpcom autoregistration start
-    LogFlow(("NS_InitXPCOM2: Notifying startup observers (autoreg)\n"));
+    LogFlow(("NS_InitXPCOM2Ex: Notifying startup observers\n"));
     NS_CreateServicesFromCategory(NS_XPCOM_STARTUP_OBSERVER_ID,
                                   nsnull,
@@ -639 +646 @@
     gXPCOMInitialized = PR_TRUE;
 #endif
-    LogFlow(("NS_InitXPCOM2: return NS_OK\n"));
+    LogFlow(("NS_InitXPCOM2Ex: return NS_OK\n"));
     return NS_OK;
 }

trunk/src/libs/xpcom18a4/xpcom/components/nsComponentManager.cpp

@@ -3578 +3578 @@
     {
         // XPCOM needs initialization.
-        rv = NS_InitXPCOM2(nsnull, nsnull, nsnull);
+        rv = NS_InitXPCOM2Ex(nsnull, nsnull, nsnull, 0);
     }
 
@@ -3598 +3598 @@
     {
         // XPCOM needs initialization.
-        nsresult rv = NS_InitXPCOM2(nsnull, nsnull, nsnull);
+        nsresult rv = NS_InitXPCOM2Ex(nsnull, nsnull, nsnull, 0);
         if (NS_FAILED(rv))
             return rv;
@@ -3629 +3629 @@
 #else /* !VBOX */
         // XPCOM needs initialization.
-        rv = NS_InitXPCOM2(nsnull, nsnull, nsnull);
+        rv = NS_InitXPCOM2Ex(nsnull, nsnull, nsnull, 0);
 #endif /* !VBOX */
     }
@@ -3651 +3651 @@
     {
         // XPCOM needs initialization.
-        rv = NS_InitXPCOM2(nsnull, nsnull, nsnull);
+        rv = NS_InitXPCOM2Ex(nsnull, nsnull, nsnull, 0);
     }
 
@@ -3674 +3674 @@
     {
         // XPCOM needs initialization.
-        rv = NS_InitXPCOM2(nsnull, nsnull, nsnull);
+        rv = NS_InitXPCOM2Ex(nsnull, nsnull, nsnull, 0);
     }
 

trunk/src/libs/xpcom18a4/xpcom/io/nsDirectoryServiceDefs.h

@@ -67 +67 @@
 /* This location is similar to NS_OS_CURRENT_PROCESS_DIR, however, 
  * NS_XPCOM_CURRENT_PROCESS_DIR can be overriden by passing a "bin
- * directory" to NS_InitXPCOM2(). 
+ * directory" to NS_InitXPCOM2Ex().
  */
 #define NS_XPCOM_CURRENT_PROCESS_DIR            "XCurProcD"

trunk/src/libs/xpcom18a4/xpcom/tests/TestFactory.cpp

@@ -116 +116 @@
   {
     nsCOMPtr<nsIServiceManager> servMan;
-    rv = NS_InitXPCOM2(getter_AddRefs(servMan), nsnull, nsnull);
+    rv = NS_InitXPCOM2Ex(getter_AddRefs(servMan), nsnull, nsnull, 0);
     if (NS_FAILED(rv)) return -1;
     nsCOMPtr<nsIComponentRegistrar> registrar = do_QueryInterface(servMan);

trunk/src/libs/xpcom18a4/xpcom/tests/nsIFileTest.cpp

@@ -352 +352 @@
 {
     nsCOMPtr<nsIServiceManager> servMan;
-    NS_InitXPCOM2(getter_AddRefs(servMan), nsnull, nsnull);
+    NS_InitXPCOM2Ex(getter_AddRefs(servMan), nsnull, nsnull, 0);
     nsCOMPtr<nsIComponentRegistrar> registrar = do_QueryInterface(servMan);
     NS_ASSERTION(registrar, "Null nsIComponentRegistrar");