initterm.cpp@ 80872

Last change on this file since 80872 was 78088, checked in by vboxsync, 6 years ago
Main/glue: Consolidated the bool parameters of com::Initialize() into a bit mask; added COM hack to prevent out-of-process IRundown::DoCallback calls. bugref:9425
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 27.4 KB

Line
1	/* $Id: initterm.cpp 78088 2019-04-10 13:36:19Z vboxsync $ */
2	/** @file
3	* MS COM / XPCOM Abstraction Layer - Initialization and Termination.
4	*/
5
6	/*
7	* Copyright (C) 2006-2019 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#define LOG_GROUP LOG_GROUP_MAIN
19	#if !defined(VBOX_WITH_XPCOM)
20
21	# if !defined(_WIN32_WINNT) \|\| _WIN32_WINNT < 0x600
22	# undef _WIN32_WINNT
23	# define _WIN32_WINNT 0x600 /* GetModuleHandleExW */
24	# endif
25	# include <iprt/nt/nt-and-windows.h>
26	# include <iprt/win/objbase.h>
27	# include <iprt/win/rpcproxy.h>
28	# include <rpcasync.h>
29
30	#else /* !defined(VBOX_WITH_XPCOM) */
31
32	# include <stdlib.h>
33
34	# include <nsIComponentRegistrar.h>
35	# include <nsIServiceManager.h>
36	# include <nsCOMPtr.h>
37	# include <nsEventQueueUtils.h>
38	# include <nsEmbedString.h>
39
40	# include <nsILocalFile.h>
41	# include <nsIDirectoryService.h>
42	# include <nsDirectoryServiceDefs.h>
43
44	#endif /* !defined(VBOX_WITH_XPCOM) */
45
46	#include "VBox/com/com.h"
47	#include "VBox/com/assert.h"
48	#include "VBox/com/NativeEventQueue.h"
49	#include "VBox/com/AutoLock.h"
50
51	#include "../include/LoggingNew.h"
52
53	#include <iprt/asm.h>
54	#include <iprt/env.h>
55	#include <iprt/ldr.h>
56	#include <iprt/param.h>
57	#include <iprt/path.h>
58	#include <iprt/string.h>
59	#include <iprt/system.h>
60	#include <iprt/thread.h>
61
62	#include <VBox/err.h>
63
64	namespace com
65	{
66
67	#if defined(VBOX_WITH_XPCOM)
68
69	class DirectoryServiceProvider : public nsIDirectoryServiceProvider
70	{
71	public:
72
73	NS_DECL_ISUPPORTS
74
75	DirectoryServiceProvider()
76	: mCompRegLocation(NULL), mXPTIDatLocation(NULL)
77	, mComponentDirLocation(NULL), mCurrProcDirLocation(NULL)
78	{}
79
80	virtual ~DirectoryServiceProvider();
81
82	HRESULT init(const char *aCompRegLocation,
83	const char *aXPTIDatLocation,
84	const char *aComponentDirLocation,
85	const char *aCurrProcDirLocation);
86
87	NS_DECL_NSIDIRECTORYSERVICEPROVIDER
88
89	private:
90	/** @remarks This is not a UTF-8 string. */
91	char *mCompRegLocation;
92	/** @remarks This is not a UTF-8 string. */
93	char *mXPTIDatLocation;
94	/** @remarks This is not a UTF-8 string. */
95	char *mComponentDirLocation;
96	/** @remarks This is not a UTF-8 string. */
97	char *mCurrProcDirLocation;
98	};
99
100	NS_IMPL_ISUPPORTS1(DirectoryServiceProvider, nsIDirectoryServiceProvider)
101
102	DirectoryServiceProvider::~DirectoryServiceProvider()
103	{
104	if (mCompRegLocation)
105	{
106	RTStrFree(mCompRegLocation);
107	mCompRegLocation = NULL;
108	}
109	if (mXPTIDatLocation)
110	{
111	RTStrFree(mXPTIDatLocation);
112	mXPTIDatLocation = NULL;
113	}
114	if (mComponentDirLocation)
115	{
116	RTStrFree(mComponentDirLocation);
117	mComponentDirLocation = NULL;
118	}
119	if (mCurrProcDirLocation)
120	{
121	RTStrFree(mCurrProcDirLocation);
122	mCurrProcDirLocation = NULL;
123	}
124	}
125
126	/**
127	* @param aCompRegLocation Path to compreg.dat, in Utf8.
128	* @param aXPTIDatLocation Path to xpti.data, in Utf8.
129	*/
130	HRESULT
131	DirectoryServiceProvider::init(const char *aCompRegLocation,
132	const char *aXPTIDatLocation,
133	const char *aComponentDirLocation,
134	const char *aCurrProcDirLocation)
135	{
136	AssertReturn(aCompRegLocation, NS_ERROR_INVALID_ARG);
137	AssertReturn(aXPTIDatLocation, NS_ERROR_INVALID_ARG);
138
139	/** @todo r=bird: Gotta check how this encoding stuff plays out on darwin!
140	* We get down to [VBoxNsxp]NS_NewNativeLocalFile and that file isn't
141	* nsLocalFileUnix.cpp on 32-bit darwin. On 64-bit darwin it's a question
142	* of what we're doing in IPRT and such... We should probably add a
143	* RTPathConvertToNative for use here. */
144	int vrc = RTStrUtf8ToCurrentCP(&mCompRegLocation, aCompRegLocation);
145	if (RT_SUCCESS(vrc))
146	vrc = RTStrUtf8ToCurrentCP(&mXPTIDatLocation, aXPTIDatLocation);
147	if (RT_SUCCESS(vrc) && aComponentDirLocation)
148	vrc = RTStrUtf8ToCurrentCP(&mComponentDirLocation, aComponentDirLocation);
149	if (RT_SUCCESS(vrc) && aCurrProcDirLocation)
150	vrc = RTStrUtf8ToCurrentCP(&mCurrProcDirLocation, aCurrProcDirLocation);
151
152	return RT_SUCCESS(vrc) ? NS_OK : NS_ERROR_OUT_OF_MEMORY;
153	}
154
155	NS_IMETHODIMP
156	DirectoryServiceProvider::GetFile(const char *aProp,
157	PRBool *aPersistent,
158	nsIFile **aRetval)
159	{
160	nsCOMPtr <nsILocalFile> localFile;
161	nsresult rv = NS_ERROR_FAILURE;
162
163	*aRetval = nsnull;
164	*aPersistent = PR_TRUE;
165
166	const char *fileLocation = NULL;
167
168	if (strcmp(aProp, NS_XPCOM_COMPONENT_REGISTRY_FILE) == 0)
169	fileLocation = mCompRegLocation;
170	else if (strcmp(aProp, NS_XPCOM_XPTI_REGISTRY_FILE) == 0)
171	fileLocation = mXPTIDatLocation;
172	else if (mComponentDirLocation && strcmp(aProp, NS_XPCOM_COMPONENT_DIR) == 0)
173	fileLocation = mComponentDirLocation;
174	else if (mCurrProcDirLocation && strcmp(aProp, NS_XPCOM_CURRENT_PROCESS_DIR) == 0)
175	fileLocation = mCurrProcDirLocation;
176	else
177	return NS_ERROR_FAILURE;
178
179	rv = NS_NewNativeLocalFile(nsEmbedCString(fileLocation),
180	PR_TRUE, getter_AddRefs(localFile));
181	if (NS_FAILED(rv))
182	return rv;
183
184	return localFile->QueryInterface(NS_GET_IID(nsIFile), (void **)aRetval);
185	}
186
187	/**
188	* Global XPCOM initialization flag (we maintain it ourselves since XPCOM
189	* doesn't provide such functionality)
190	*/
191	static bool volatile gIsXPCOMInitialized = false;
192
193	/**
194	* Number of Initialize() calls on the main thread.
195	*/
196	static unsigned int gXPCOMInitCount = 0;
197
198	#else /* !defined(VBOX_WITH_XPCOM) */
199
200	/**
201	* Replacement function for the InvokeStub method for the IRundown stub.
202	*/
203	static HRESULT STDMETHODCALLTYPE Rundown_InvokeStub(IRpcStubBuffer pThis, RPCOLEMESSAGE pMsg, IRpcChannelBuffer *pBuf)
204	{
205	/*
206	* Our mission here is to prevent remote calls to methods #8 and #9,
207	* as these contain raw pointers to callback functions.
208	*
209	* Note! APIs like I_RpcServerInqTransportType, I_RpcBindingInqLocalClientPID
210	* and RpcServerInqCallAttributesW are not usable in this context without
211	* a rpc binding handle (latter two).
212	*
213	* P.S. In more recent windows versions, the buffer implements a interface
214	* IID_IRpcChannelBufferMarshalingContext (undocumented) which has a
215	* GetIMarshallingContextAttribute() method that will return the client PID
216	* when asking for attribute #0x8000000e.
217	*/
218	uint32_t const iMethod = pMsg->iMethod & 0xffff; /* Uncertain, but there are hints that the upper bits are flags. */
219	HRESULT hrc;
220	if ( ( iMethod != 8
221	&& iMethod != 9)
222	\|\| (pMsg->rpcFlags & RPCFLG_LOCAL_CALL) )
223	hrc = CStdStubBuffer_Invoke(pThis, pMsg, pBuf);
224	else
225	{
226	LogRel(("Rundown_InvokeStub: Rejected call to CRundown::%s: rpcFlags=%#x cbBuffer=%#x dataRepresentation=%d buffer=%p:{%.*Rhxs} reserved1=%p reserved2={%p,%p,%p,%p,%p}\n",
227	pMsg->iMethod == 8 ? "DoCallback" : "DoNonreentrantCallback", pMsg->rpcFlags, pMsg->cbBuffer,
228	pMsg->dataRepresentation, pMsg->Buffer, RT_VALID_PTR(pMsg->Buffer) ? pMsg->cbBuffer : 0, pMsg->Buffer,
229	pMsg->reserved1, pMsg->reserved2[0], pMsg->reserved2[1], pMsg->reserved2[2], pMsg->reserved2[3], pMsg->reserved2[4]));
230	hrc = E_ACCESSDENIED;
231	}
232	return hrc;
233	}
234
235	/**
236	* Replaces the IRundown InvokeStub method with Rundown_InvokeStub so we can
237	* reject remote calls to a couple of misdesigned methods.
238	*/
239	void PatchComBugs(void)
240	{
241	static volatile bool s_fPatched = false;
242	if (s_fPatched)
243	return;
244
245	/*
246	* The combase.dll / ole32.dll is exporting a DllGetClassObject function
247	* that is implemented using NdrDllGetClassObject just like our own
248	* proxy/stub DLL. This means we can get at the stub interface lists,
249	* since what NdrDllGetClassObject has CStdPSFactoryBuffer as layout.
250	*
251	* Note! Tried using CoRegisterPSClsid instead of this mess, but no luck.
252	*/
253	/* Locate the COM DLL, it must be loaded by now: */
254	HMODULE hmod = GetModuleHandleW(L"COMBASE.DLL");
255	if (!hmod)
256	hmod = GetModuleHandleW(L"OLE32.DLL"); /* w7 */
257	AssertReturnVoid(hmod != NULL);
258
259	/* Resolve the class getter: */
260	LPFNGETCLASSOBJECT pfnGetClassObject = (LPFNGETCLASSOBJECT)GetProcAddress(hmod, "DllGetClassObject");
261	AssertReturnVoid(pfnGetClassObject != NULL);
262
263	/* Get the factory instance: */
264	static const CLSID s_PSOlePrx32ClsId = {0x00000320,0x0000,0x0000,{0xc0,0x00,0x00,0x00,0x00,0x00,0x00,0x46}};
265	CStdPSFactoryBuffer *pFactoryBuffer = NULL;
266	HRESULT hrc = pfnGetClassObject(s_PSOlePrx32ClsId, IID_IPSFactoryBuffer, (void **)&pFactoryBuffer);
267	AssertMsgReturnVoid(SUCCEEDED(hrc), ("hrc=%Rhrc\n", hrc));
268	AssertReturnVoid(pFactoryBuffer != NULL);
269
270	/*
271	* Search thru the file list for the interface we want to patch.
272	*/
273	static const IID s_IID_Rundown = {0x00000134,0x0000,0x0000,{0xc0,0x00,0x00,0x00,0x00,0x00,0x00,0x46}};
274	decltype(CStdStubBuffer_Invoke) *pfnInvoke = (decltype(pfnInvoke))GetProcAddress(hmod, "CStdStubBuffer_Invoke");
275	if (!pfnInvoke)
276	pfnInvoke = (decltype(pfnInvoke))GetProcAddress(GetModuleHandleW(L"RPCRT4.DLL"), "CStdStubBuffer_Invoke");
277
278	unsigned cPatched = 0;
279	unsigned cAlreadyPatched = 0;
280	Assert(pFactoryBuffer->pProxyFileList != NULL);
281	for (ProxyFileInfo const *ppCur = pFactoryBuffer->pProxyFileList; ppCur != NULL; ppCur++)
282	{
283	ProxyFileInfo const pCur = ppCur;
284
285	if (pCur->pStubVtblList)
286	{
287	for (PCInterfaceStubVtblList const ppCurStub = pCur->pStubVtblList; ppCurStub != NULL; ppCurStub++)
288	{
289	PCInterfaceStubVtblList const pCurStub = *ppCurStub;
290	IID const *piid = pCurStub->header.piid;
291	if (piid)
292	{
293	if (IsEqualIID(*piid, s_IID_Rundown))
294	{
295	if (pCurStub->Vtbl.Invoke == pfnInvoke)
296	{
297	DWORD fOld = 0;
298	if (VirtualProtect(&pCurStub->Vtbl.Invoke, sizeof(pCurStub->Vtbl.Invoke), PAGE_READWRITE, &fOld))
299	{
300	pCurStub->Vtbl.Invoke = Rundown_InvokeStub;
301	VirtualProtect(&pCurStub->Vtbl.Invoke, sizeof(pCurStub->Vtbl.Invoke), fOld, &fOld);
302	cPatched++;
303	}
304	else
305	AssertMsgFailed(("%d\n", GetLastError()));
306	}
307	else
308	cAlreadyPatched++;
309	}
310	}
311	}
312	}
313	}
314
315	/* done */
316	pFactoryBuffer->lpVtbl->Release((IPSFactoryBuffer *)pFactoryBuffer);
317
318	/*
319	* If we patched anything we should try prevent being unloaded.
320	*/
321	if (cPatched > 0)
322	{
323	s_fPatched = true;
324	HMODULE hmodSelf;
325	AssertLogRelMsg(GetModuleHandleExW(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS \| GET_MODULE_HANDLE_EX_FLAG_PIN,
326	(LPCWSTR)(uintptr_t)Rundown_InvokeStub, &hmodSelf),
327	("last error: %u; Rundown_InvokeStub=%p\n", GetLastError(), Rundown_InvokeStub));
328	}
329	else
330	AssertLogRelMsg(cAlreadyPatched > 0, ("COM patching of IRundown failed!\n"));
331	}
332
333
334	/**
335	* The COM main thread handle. (The first caller of com::Initialize().)
336	*/
337	static RTTHREAD volatile gCOMMainThread = NIL_RTTHREAD;
338
339	/**
340	* Number of Initialize() calls on the main thread.
341	*/
342	static uint32_t gCOMMainInitCount = 0;
343
344	#endif /* !defined(VBOX_WITH_XPCOM) */
345
346
347	/**
348	* Initializes the COM runtime.
349	*
350	* This method must be called on each thread of the client application that
351	* wants to access COM facilities. The initialization must be performed before
352	* calling any other COM method or attempting to instantiate COM objects.
353	*
354	* On platforms using XPCOM, this method uses the following scheme to search for
355	* XPCOM runtime:
356	*
357	* 1. If the VBOX_APP_HOME environment variable is set, the path it specifies
358	* is used to search XPCOM libraries and components. If this method fails to
359	* initialize XPCOM runtime using this path, it will immediately return a
360	* failure and will NOT check for other paths as described below.
361	*
362	* 2. If VBOX_APP_HOME is not set, this methods tries the following paths in the
363	* given order:
364	*
365	* a) Compiled-in application data directory (as returned by
366	* RTPathAppPrivateArch())
367	* b) "/usr/lib/virtualbox" (Linux only)
368	* c) "/opt/VirtualBox" (Linux only)
369	*
370	* The first path for which the initialization succeeds will be used.
371	*
372	* On MS COM platforms, the COM runtime is provided by the system and does not
373	* need to be searched for.
374	*
375	* Once the COM subsystem is no longer necessary on a given thread, Shutdown()
376	* must be called to free resources allocated for it. Note that a thread may
377	* call Initialize() several times but for each of tese calls there must be a
378	* corresponding Shutdown() call.
379	*
380	* @return S_OK on success and a COM result code in case of failure.
381	*/
382	HRESULT Initialize(uint32_t fInitFlags /=VBOX_COM_INIT_F_DEFAULT/)
383	{
384	HRESULT rc = E_FAIL;
385
386	#if !defined(VBOX_WITH_XPCOM)
387
388	# ifdef VBOX_WITH_AUTO_COM_REG_UPDATE
389	/*
390	* First time we're called in a process, we refresh the VBox COM
391	* registrations. Use a global mutex to prevent updating when there are
392	* API users already active, as that could lead to a bit of a mess.
393	*/
394	if ( (fInitFlags & VBOX_COM_INIT_F_AUTO_REG_UPDATE)
395	&& gCOMMainThread == NIL_RTTHREAD)
396	{
397	SetLastError(ERROR_SUCCESS);
398	HANDLE hLeakIt = CreateMutexW(NULL/pSecAttr/, FALSE, L"Global\\VirtualBoxComLazyRegistrationMutant");
399	DWORD dwErr = GetLastError();
400	AssertMsg(dwErr == ERROR_SUCCESS \|\| dwErr == ERROR_ALREADY_EXISTS \|\| dwErr == ERROR_ACCESS_DENIED, ("%u\n", dwErr));
401	if (dwErr == ERROR_SUCCESS)
402	{
403	char szPath[RTPATH_MAX];
404	int vrc = RTPathAppPrivateArch(szPath, sizeof(szPath));
405	if (RT_SUCCESS(vrc))
406	# ifndef VBOX_IN_32_ON_64_MAIN_API
407	vrc = RTPathAppend(szPath, sizeof(szPath),
408	RT_MAKE_U64(((PKUSER_SHARED_DATA)MM_SHARED_USER_DATA_VA)->NtMinorVersion,
409	((PKUSER_SHARED_DATA)MM_SHARED_USER_DATA_VA)->NtMajorVersion)
410	>= RT_MAKE_U64(1/Lo/,6/Hi/)
411	? "VBoxProxyStub.dll" : "VBoxProxyStubLegacy.dll");
412	# else
413	vrc = RTPathAppend(szPath, sizeof(szPath), "x86\\VBoxProxyStub-x86.dll");
414	# endif
415	if (RT_SUCCESS(vrc))
416	{
417	RTLDRMOD hMod;
418	vrc = RTLdrLoad(szPath, &hMod);
419	if (RT_SUCCESS(vrc))
420	{
421	union
422	{
423	void *pv;
424	DECLCALLBACKMEMBER(uint32_t, pfnRegUpdate)(void);
425	} u;
426	vrc = RTLdrGetSymbol(hMod, "VbpsUpdateRegistrations", &u.pv);
427	if (RT_SUCCESS(vrc))
428	u.pfnRegUpdate();
429	/* Just keep it loaded. */
430	}
431	}
432	Assert(hLeakIt != NULL); NOREF(hLeakIt);
433	}
434	}
435	# endif
436
437	/*
438	* We initialize COM in GUI thread in STA, to be compliant with QT and
439	* OLE requirments (for example to allow D&D), while other threads
440	* initialized in regular MTA. To allow fast proxyless access from
441	* GUI thread to COM objects, we explicitly provide our COM objects
442	* with free threaded marshaller.
443	* !!!!! Please think twice before touching this code !!!!!
444	*/
445	DWORD flags = fInitFlags & VBOX_COM_INIT_F_GUI
446	? COINIT_APARTMENTTHREADED
447	\| COINIT_SPEED_OVER_MEMORY
448	: COINIT_MULTITHREADED
449	\| COINIT_DISABLE_OLE1DDE
450	\| COINIT_SPEED_OVER_MEMORY;
451
452	rc = CoInitializeEx(NULL, flags);
453
454	/* the overall result must be either S_OK or S_FALSE (S_FALSE means
455	* "already initialized using the same apartment model") */
456	AssertMsg(rc == S_OK \|\| rc == S_FALSE, ("rc=%08X\n", rc));
457
458	/*
459	* IRundown has unsafe two methods we need to patch to prevent remote access.
460	* Do that before we start using COM and open ourselves to possible attacks.
461	*/
462	if (!(fInitFlags & VBOX_COM_INIT_F_NO_COM_PATCHING))
463	PatchComBugs();
464
465	/* To be flow compatible with the XPCOM case, we return here if this isn't
466	* the main thread or if it isn't its first initialization call.
467	* Note! CoInitializeEx and CoUninitialize does it's own reference
468	* counting, so this exercise is entirely for the EventQueue init. */
469	bool fRc;
470	RTTHREAD hSelf = RTThreadSelf();
471	if (hSelf != NIL_RTTHREAD)
472	ASMAtomicCmpXchgHandle(&gCOMMainThread, hSelf, NIL_RTTHREAD, fRc);
473	else
474	fRc = false;
475
476	if (fInitFlags & VBOX_COM_INIT_F_GUI)
477	Assert(RTThreadIsMain(hSelf));
478
479	if (!fRc)
480	{
481	if ( gCOMMainThread == hSelf
482	&& SUCCEEDED(rc))
483	gCOMMainInitCount++;
484
485	AssertComRC(rc);
486	return rc;
487	}
488	Assert(RTThreadIsMain(hSelf));
489
490	/* this is the first main thread initialization */
491	Assert(gCOMMainInitCount == 0);
492	if (SUCCEEDED(rc))
493	gCOMMainInitCount = 1;
494
495	#else /* !defined(VBOX_WITH_XPCOM) */
496
497	/* Unused here */
498	RT_NOREF(fInitFlags);
499
500	if (ASMAtomicXchgBool(&gIsXPCOMInitialized, true) == true)
501	{
502	/* XPCOM is already initialized on the main thread, no special
503	* initialization is necessary on additional threads. Just increase
504	* the init counter if it's a main thread again (to correctly support
505	* nested calls to Initialize()/Shutdown() for compatibility with
506	* Win32). */
507
508	nsCOMPtr<nsIEventQueue> eventQ;
509	rc = NS_GetMainEventQ(getter_AddRefs(eventQ));
510
511	if (NS_SUCCEEDED(rc))
512	{
513	PRBool isOnMainThread = PR_FALSE;
514	rc = eventQ->IsOnCurrentThread(&isOnMainThread);
515	if (NS_SUCCEEDED(rc) && isOnMainThread)
516	++gXPCOMInitCount;
517	}
518
519	AssertComRC(rc);
520	return rc;
521	}
522	Assert(RTThreadIsMain(RTThreadSelf()));
523
524	/* this is the first initialization */
525	gXPCOMInitCount = 1;
526
527	/* prepare paths for registry files */
528	char szCompReg[RTPATH_MAX];
529	char szXptiDat[RTPATH_MAX];
530
531	int vrc = GetVBoxUserHomeDirectory(szCompReg, sizeof(szCompReg));
532	if (vrc == VERR_ACCESS_DENIED)
533	return NS_ERROR_FILE_ACCESS_DENIED;
534	AssertRCReturn(vrc, NS_ERROR_FAILURE);
535	vrc = RTStrCopy(szXptiDat, sizeof(szXptiDat), szCompReg);
536	AssertRCReturn(vrc, NS_ERROR_FAILURE);
537	# ifdef VBOX_IN_32_ON_64_MAIN_API
538	vrc = RTPathAppend(szCompReg, sizeof(szCompReg), "compreg-x86.dat");
539	AssertRCReturn(vrc, NS_ERROR_FAILURE);
540	vrc = RTPathAppend(szXptiDat, sizeof(szXptiDat), "xpti-x86.dat");
541	AssertRCReturn(vrc, NS_ERROR_FAILURE);
542	# else
543	vrc = RTPathAppend(szCompReg, sizeof(szCompReg), "compreg.dat");
544	AssertRCReturn(vrc, NS_ERROR_FAILURE);
545	vrc = RTPathAppend(szXptiDat, sizeof(szXptiDat), "xpti.dat");
546	AssertRCReturn(vrc, NS_ERROR_FAILURE);
547	# endif
548
549	LogFlowFunc(("component registry : \"%s\"\n", szCompReg));
550	LogFlowFunc(("XPTI data file : \"%s\"\n", szXptiDat));
551
552	static const char *kAppPathsToProbe[] =
553	{
554	NULL, /* 0: will use VBOX_APP_HOME */
555	NULL, /* 1: will try RTPathAppPrivateArch(), correctly installed release builds will never go further */
556	NULL, /* 2: will try parent directory of RTPathAppPrivateArch(), only for testcases in non-hardened builds */
557	/* There used to be hard coded paths, but they only caused trouble
558	* because they often led to mixing of builds or even versions.
559	* If you feel tempted to add anything here, think again. They would
560	* only be used if option 1 would not work, which is a sign of a big
561	* problem, as it returns a fixed location defined at compile time.
562	* It is better to fail than blindly trying to cover the problem. */
563	};
564
565	/* Find out the directory where VirtualBox binaries are located */
566	for (size_t i = 0; i < RT_ELEMENTS(kAppPathsToProbe); ++ i)
567	{
568	char szAppHomeDir[RTPATH_MAX];
569
570	if (i == 0)
571	{
572	/* Use VBOX_APP_HOME if present */
573	vrc = RTEnvGetEx(RTENV_DEFAULT, "VBOX_APP_HOME", szAppHomeDir, sizeof(szAppHomeDir), NULL);
574	if (vrc == VERR_ENV_VAR_NOT_FOUND)
575	continue;
576	AssertRC(vrc);
577	}
578	else if (i == 1)
579	{
580	/* Use RTPathAppPrivateArch() first */
581	vrc = RTPathAppPrivateArch(szAppHomeDir, sizeof(szAppHomeDir));
582	AssertRC(vrc);
583	}
584	else if (i == 2)
585	{
586	# ifdef VBOX_WITH_HARDENING
587	continue;
588	# else /* !VBOX_WITH_HARDENING */
589	/* Use parent of RTPathAppPrivateArch() if ends with "testcase" */
590	vrc = RTPathAppPrivateArch(szAppHomeDir, sizeof(szAppHomeDir));
591	AssertRC(vrc);
592	vrc = RTPathStripTrailingSlash(szAppHomeDir);
593	AssertRC(vrc);
594	char *filename = RTPathFilename(szAppHomeDir);
595	if (!filename \|\| strcmp(filename, "testcase"))
596	continue;
597	RTPathStripFilename(szAppHomeDir);
598	# endif /* !VBOX_WITH_HARDENING */
599	}
600	else
601	{
602	/* Iterate over all other paths */
603	RTStrCopy(szAppHomeDir, sizeof(szAppHomeDir), kAppPathsToProbe[i]);
604	vrc = VINF_SUCCESS;
605	}
606	if (RT_FAILURE(vrc))
607	{
608	rc = NS_ERROR_FAILURE;
609	continue;
610	}
611	char szCompDir[RTPATH_MAX];
612	vrc = RTStrCopy(szCompDir, sizeof(szCompDir), szAppHomeDir);
613	if (RT_FAILURE(vrc))
614	{
615	rc = NS_ERROR_FAILURE;
616	continue;
617	}
618	vrc = RTPathAppend(szCompDir, sizeof(szCompDir), "components");
619	if (RT_FAILURE(vrc))
620	{
621	rc = NS_ERROR_FAILURE;
622	continue;
623	}
624	LogFlowFunc(("component directory : \"%s\"\n", szCompDir));
625
626	nsCOMPtr<DirectoryServiceProvider> dsProv;
627	dsProv = new DirectoryServiceProvider();
628	if (dsProv)
629	rc = dsProv->init(szCompReg, szXptiDat, szCompDir, szAppHomeDir);
630	else
631	rc = NS_ERROR_OUT_OF_MEMORY;
632	if (NS_FAILED(rc))
633	break;
634
635	/* Setup the application path for NS_InitXPCOM2. Note that we properly
636	* answer the NS_XPCOM_CURRENT_PROCESS_DIR query in our directory
637	* service provider but it seems to be activated after the directory
638	* service is used for the first time (see the source NS_InitXPCOM2). So
639	* use the same value here to be on the safe side. */
640	nsCOMPtr <nsIFile> appDir;
641	{
642	char *appDirCP = NULL;
643	vrc = RTStrUtf8ToCurrentCP(&appDirCP, szAppHomeDir);
644	if (RT_SUCCESS(vrc))
645	{
646	nsCOMPtr<nsILocalFile> file;
647	rc = NS_NewNativeLocalFile(nsEmbedCString(appDirCP),
648	PR_FALSE, getter_AddRefs(file));
649	if (NS_SUCCEEDED(rc))
650	appDir = do_QueryInterface(file, &rc);
651
652	RTStrFree(appDirCP);
653	}
654	else
655	rc = NS_ERROR_FAILURE;
656	}
657	if (NS_FAILED(rc))
658	break;
659
660	/* Set VBOX_XPCOM_HOME to the same app path to make XPCOM sources that
661	* still use it instead of the directory service happy */
662	vrc = RTEnvSetEx(RTENV_DEFAULT, "VBOX_XPCOM_HOME", szAppHomeDir);
663	AssertRC(vrc);
664
665	/* Finally, initialize XPCOM */
666	{
667	nsCOMPtr<nsIServiceManager> serviceManager;
668	rc = NS_InitXPCOM2(getter_AddRefs(serviceManager), appDir, dsProv);
669	if (NS_SUCCEEDED(rc))
670	{
671	nsCOMPtr<nsIComponentRegistrar> registrar =
672	do_QueryInterface(serviceManager, &rc);
673	if (NS_SUCCEEDED(rc))
674	{
675	rc = registrar->AutoRegister(nsnull);
676	if (NS_SUCCEEDED(rc))
677	{
678	/* We succeeded, stop probing paths */
679	LogFlowFunc(("Succeeded.\n"));
680	break;
681	}
682	}
683	}
684	}
685
686	/* clean up before the new try */
687	HRESULT rc2 = NS_ShutdownXPCOM(nsnull);
688	if (SUCCEEDED(rc))
689	rc = rc2;
690
691	if (i == 0)
692	{
693	/* We failed with VBOX_APP_HOME, don't probe other paths */
694	break;
695	}
696	}
697
698	#endif /* !defined(VBOX_WITH_XPCOM) */
699
700	AssertComRCReturnRC(rc);
701
702	// for both COM and XPCOM, we only get here if this is the main thread;
703	// only then initialize the autolock system (AutoLock.cpp)
704	Assert(RTThreadIsMain(RTThreadSelf()));
705	util::InitAutoLockSystem();
706
707	/*
708	* Init the main event queue (ASSUMES it cannot fail).
709	*/
710	if (SUCCEEDED(rc))
711	NativeEventQueue::init();
712
713	return rc;
714	}
715
716	HRESULT Shutdown()
717	{
718	HRESULT rc = S_OK;
719
720	#if !defined(VBOX_WITH_XPCOM)
721
722	/* EventQueue::uninit reference counting fun. */
723	RTTHREAD hSelf = RTThreadSelf();
724	if ( hSelf == gCOMMainThread
725	&& hSelf != NIL_RTTHREAD)
726	{
727	if (-- gCOMMainInitCount == 0)
728	{
729	NativeEventQueue::uninit();
730	ASMAtomicWriteHandle(&gCOMMainThread, NIL_RTTHREAD);
731	}
732	}
733
734	CoUninitialize();
735
736	#else /* !defined(VBOX_WITH_XPCOM) */
737
738	nsCOMPtr<nsIEventQueue> eventQ;
739	rc = NS_GetMainEventQ(getter_AddRefs(eventQ));
740
741	if (NS_SUCCEEDED(rc) \|\| rc == NS_ERROR_NOT_AVAILABLE)
742	{
743	/* NS_ERROR_NOT_AVAILABLE seems to mean that
744	* nsIEventQueue::StopAcceptingEvents() has been called (see
745	* nsEventQueueService.cpp). We hope that this error code always means
746	* just that in this case and assume that we're on the main thread
747	* (it's a kind of unexpected behavior if a non-main thread ever calls
748	* StopAcceptingEvents() on the main event queue). */
749
750	PRBool isOnMainThread = PR_FALSE;
751	if (NS_SUCCEEDED(rc))
752	{
753	rc = eventQ->IsOnCurrentThread(&isOnMainThread);
754	eventQ = nsnull; /* early release before shutdown */
755	}
756	else
757	{
758	isOnMainThread = RTThreadIsMain(RTThreadSelf());
759	rc = NS_OK;
760	}
761
762	if (NS_SUCCEEDED(rc) && isOnMainThread)
763	{
764	/* only the main thread needs to uninitialize XPCOM and only if
765	* init counter drops to zero */
766	if (--gXPCOMInitCount == 0)
767	{
768	NativeEventQueue::uninit();
769	rc = NS_ShutdownXPCOM(nsnull);
770
771	/* This is a thread initialized XPCOM and set gIsXPCOMInitialized to
772	* true. Reset it back to false. */
773	bool wasInited = ASMAtomicXchgBool(&gIsXPCOMInitialized, false);
774	Assert(wasInited == true);
775	NOREF(wasInited);
776	}
777	}
778	}
779
780	#endif /* !defined(VBOX_WITH_XPCOM) */
781
782	AssertComRC(rc);
783
784	return rc;
785	}
786
787	} /* namespace com */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/glue/initterm.cpp@ 80872

Download in other formats: