VirtualBoxBase.h@ 93412

Last change on this file since 93412 was 93115, checked in by vboxsync, 3 years ago
scm --update-copyright-year
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 36.0 KB

Line
1	/* $Id: VirtualBoxBase.h 93115 2022-01-01 11:31:46Z vboxsync $ */
2	/** @file
3	* VirtualBox COM base classes definition
4	*/
5
6	/*
7	* Copyright (C) 2006-2022 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	#ifndef MAIN_INCLUDED_VirtualBoxBase_h
19	#define MAIN_INCLUDED_VirtualBoxBase_h
20	#ifndef RT_WITHOUT_PRAGMA_ONCE
21	# pragma once
22	#endif
23
24	#include <iprt/cdefs.h>
25	#include <iprt/thread.h>
26
27	#include <list>
28	#include <map>
29
30	#include "ObjectState.h"
31
32	#include "VBox/com/AutoLock.h"
33	#include "VBox/com/string.h"
34	#include "VBox/com/Guid.h"
35
36	#include "VBox/com/VirtualBox.h"
37
38	#include "VirtualBoxTranslator.h"
39
40	// avoid including VBox/settings.h and VBox/xml.h; only declare the classes
41	namespace xml
42	{
43	class File;
44	}
45
46	namespace com
47	{
48	class ErrorInfo;
49	}
50
51	using namespace com;
52	using namespace util;
53
54	class VirtualBox;
55	class Machine;
56	class Medium;
57	class Host;
58	typedef std::list<ComObjPtr<Medium> > MediaList;
59	typedef std::list<Utf8Str> StringsList;
60
61	////////////////////////////////////////////////////////////////////////////////
62	//
63	// COM helpers
64	//
65	////////////////////////////////////////////////////////////////////////////////
66
67	#if !defined(VBOX_WITH_XPCOM)
68
69	/* use a special version of the singleton class factory,
70	* see KB811591 in msdn for more info. */
71
72	#undef DECLARE_CLASSFACTORY_SINGLETON
73	#define DECLARE_CLASSFACTORY_SINGLETON(obj) DECLARE_CLASSFACTORY_EX(CMyComClassFactorySingleton<obj>)
74
75	/**
76	* @todo r=bird: This CMyComClassFactorySingleton stuff is probably obsoleted by
77	* microatl.h? Right?
78	*/
79
80	template <class T>
81	class CMyComClassFactorySingleton : public ATL::CComClassFactory
82	{
83	public:
84	CMyComClassFactorySingleton() :
85	m_hrCreate(S_OK), m_spObj(NULL)
86	{
87	}
88	virtual ~CMyComClassFactorySingleton()
89	{
90	if (m_spObj)
91	m_spObj->Release();
92	}
93	// IClassFactory
94	STDMETHOD(CreateInstance)(LPUNKNOWN pUnkOuter, REFIID riid, void** ppvObj)
95	{
96	HRESULT hRes = E_POINTER;
97	if (ppvObj != NULL)
98	{
99	*ppvObj = NULL;
100	// no aggregation for singletons
101	AssertReturn(pUnkOuter == NULL, CLASS_E_NOAGGREGATION);
102	if (m_hrCreate == S_OK && m_spObj == NULL)
103	{
104	Lock();
105	__try
106	{
107	// Fix: The following If statement was moved inside the __try statement.
108	// Did another thread arrive here first?
109	if (m_hrCreate == S_OK && m_spObj == NULL)
110	{
111	// lock the module to indicate activity
112	// (necessary for the monitor shutdown thread to correctly
113	// terminate the module in case when CreateInstance() fails)
114	ATL::_pAtlModule->Lock();
115	ATL::CComObjectCached<T> *p;
116	m_hrCreate = ATL::CComObjectCached<T>::CreateInstance(&p);
117	if (SUCCEEDED(m_hrCreate))
118	{
119	m_hrCreate = p->QueryInterface(IID_IUnknown, (void **)&m_spObj);
120	if (FAILED(m_hrCreate))
121	{
122	delete p;
123	}
124	}
125	ATL::_pAtlModule->Unlock();
126	}
127	}
128	__finally
129	{
130	Unlock();
131	}
132	}
133	if (m_hrCreate == S_OK)
134	{
135	hRes = m_spObj->QueryInterface(riid, ppvObj);
136	}
137	else
138	{
139	hRes = m_hrCreate;
140	}
141	}
142	return hRes;
143	}
144	HRESULT m_hrCreate;
145	IUnknown *m_spObj;
146	};
147
148	#endif /* !defined(VBOX_WITH_XPCOM) */
149
150	////////////////////////////////////////////////////////////////////////////////
151	//
152	// Macros
153	//
154	////////////////////////////////////////////////////////////////////////////////
155
156	/**
157	* Special version of the Assert macro to be used within VirtualBoxBase
158	* subclasses.
159	*
160	* In the debug build, this macro is equivalent to Assert.
161	* In the release build, this macro uses \|setError(E_FAIL, ...)\| to set the
162	* error info from the asserted expression.
163	*
164	* @see VirtualBoxBase::setError
165	*
166	* @param expr Expression which should be true.
167	*/
168	#define ComAssert(expr) \
169	do { \
170	if (RT_LIKELY(!!(expr))) \
171	{ /* likely */ } \
172	else \
173	{ \
174	AssertMsgFailed(("%s\n", #expr)); \
175	setError(E_FAIL, \
176	VirtualBoxBase::tr("Assertion failed: [%s] at '%s' (%d) in %s.\nPlease contact the product vendor!"), \
177	#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__); \
178	} \
179	} while (0)
180
181	/**
182	* Special version of the AssertFailed macro to be used within VirtualBoxBase
183	* subclasses.
184	*
185	* In the debug build, this macro is equivalent to AssertFailed.
186	* In the release build, this macro uses \|setError(E_FAIL, ...)\| to set the
187	* error info from the asserted expression.
188	*
189	* @see VirtualBoxBase::setError
190	*
191	*/
192	#define ComAssertFailed() \
193	do { \
194	AssertFailed(); \
195	setError(E_FAIL, \
196	VirtualBoxBase::tr("Assertion failed: at '%s' (%d) in %s.\nPlease contact the product vendor!"), \
197	__FILE__, __LINE__, __PRETTY_FUNCTION__); \
198	} while (0)
199
200	/**
201	* Special version of the AssertMsg macro to be used within VirtualBoxBase
202	* subclasses.
203	*
204	* See ComAssert for more info.
205	*
206	* @param expr Expression which should be true.
207	* @param a printf argument list (in parenthesis).
208	*/
209	#define ComAssertMsg(expr, a) \
210	do { \
211	if (RT_LIKELY(!!(expr))) \
212	{ /* likely */ } \
213	else \
214	{ \
215	Utf8StrFmt MyAssertMsg a; /* may throw bad_alloc */ \
216	AssertMsgFailed(("%s\n", MyAssertMsg.c_str())); \
217	setError(E_FAIL, \
218	VirtualBoxBase::tr("Assertion failed: [%s] at '%s' (%d) in %s.\n%s.\nPlease contact the product vendor!"), \
219	#expr, __FILE__, __LINE__, __PRETTY_FUNCTION__, MyAssertMsg.c_str()); \
220	} \
221	} while (0)
222
223	/**
224	* Special version of the AssertMsgFailed macro to be used within VirtualBoxBase
225	* subclasses.
226	*
227	* See ComAssert for more info.
228	*
229	* @param a printf argument list (in parenthesis).
230	*/
231	#define ComAssertMsgFailed(a) \
232	do { \
233	Utf8StrFmt MyAssertMsg a; /* may throw bad_alloc */ \
234	AssertMsgFailed(("%s\n", MyAssertMsg.c_str())); \
235	setError(E_FAIL, \
236	VirtualBoxBase::tr("Assertion failed: at '%s' (%d) in %s.\n%s.\nPlease contact the product vendor!"), \
237	__FILE__, __LINE__, __PRETTY_FUNCTION__, MyAssertMsg.c_str()); \
238	} while (0)
239
240	/**
241	* Special version of the AssertRC macro to be used within VirtualBoxBase
242	* subclasses.
243	*
244	* See ComAssert for more info.
245	*
246	* @param vrc VBox status code.
247	*/
248	#define ComAssertRC(vrc) ComAssertMsgRC(vrc, ("%Rra", vrc))
249
250	/**
251	* Special version of the AssertMsgRC macro to be used within VirtualBoxBase
252	* subclasses.
253	*
254	* See ComAssert for more info.
255	*
256	* @param vrc VBox status code.
257	* @param msg printf argument list (in parenthesis).
258	*/
259	#define ComAssertMsgRC(vrc, msg) ComAssertMsg(RT_SUCCESS(vrc), msg)
260
261	/**
262	* Special version of the AssertComRC macro to be used within VirtualBoxBase
263	* subclasses.
264	*
265	* See ComAssert for more info.
266	*
267	* @param hrc COM result code
268	*/
269	#define ComAssertComRC(hrc) ComAssertMsg(SUCCEEDED(hrc), ("COM RC=%Rhrc (0x%08X)", (hrc), (hrc)))
270
271
272	/** Special version of ComAssert that returns ret if expr fails */
273	#define ComAssertRet(expr, ret) \
274	do { ComAssert(expr); if (!(expr)) return (ret); } while (0)
275	/** Special version of ComAssertMsg that returns ret if expr fails */
276	#define ComAssertMsgRet(expr, a, ret) \
277	do { ComAssertMsg(expr, a); if (!(expr)) return (ret); } while (0)
278	/** Special version of ComAssertRC that returns ret if vrc does not succeed */
279	#define ComAssertRCRet(vrc, ret) \
280	do { ComAssertRC(vrc); if (!RT_SUCCESS(vrc)) return (ret); } while (0)
281	/** Special version of ComAssertComRC that returns ret if rc does not succeed */
282	#define ComAssertComRCRet(rc, ret) \
283	do { ComAssertComRC(rc); if (!SUCCEEDED(rc)) return (ret); } while (0)
284	/** Special version of ComAssertComRC that returns rc if rc does not succeed */
285	#define ComAssertComRCRetRC(rc) \
286	do { ComAssertComRC(rc); if (!SUCCEEDED(rc)) return (rc); } while (0)
287	/** Special version of ComAssertFailed that returns ret */
288	#define ComAssertFailedRet(ret) \
289	do { ComAssertFailed(); return (ret); } while (0)
290	/** Special version of ComAssertMsgFailed that returns ret */
291	#define ComAssertMsgFailedRet(msg, ret) \
292	do { ComAssertMsgFailed(msg); return (ret); } while (0)
293
294
295	/** Special version of ComAssert that returns void if expr fails */
296	#define ComAssertRetVoid(expr) \
297	do { ComAssert(expr); if (!(expr)) return; } while (0)
298	/** Special version of ComAssertMsg that returns void if expr fails */
299	#define ComAssertMsgRetVoid(expr, a) \
300	do { ComAssertMsg(expr, a); if (!(expr)) return; } while (0)
301	/** Special version of ComAssertRC that returns void if vrc does not succeed */
302	#define ComAssertRCRetVoid(vrc) \
303	do { ComAssertRC(vrc); if (!RT_SUCCESS(vrc)) return; } while (0)
304	/** Special version of ComAssertComRC that returns void if rc does not succeed */
305	#define ComAssertComRCRetVoid(rc) \
306	do { ComAssertComRC(rc); if (!SUCCEEDED(rc)) return; } while (0)
307	/** Special version of ComAssertFailed that returns void */
308	#define ComAssertFailedRetVoid() \
309	do { ComAssertFailed(); return; } while (0)
310	/** Special version of ComAssertMsgFailed that returns void */
311	#define ComAssertMsgFailedRetVoid(msg) \
312	do { ComAssertMsgFailed(msg); return; } while (0)
313
314
315	/** Special version of ComAssert that evaluates eval and breaks if expr fails */
316	#define ComAssertBreak(expr, eval) \
317	if (1) { ComAssert(expr); if (!(expr)) { eval; break; } } else do {} while (0)
318	/** Special version of ComAssertMsg that evaluates eval and breaks if expr fails */
319	#define ComAssertMsgBreak(expr, a, eval) \
320	if (1) { ComAssertMsg(expr, a); if (!(expr)) { eval; break; } } else do {} while (0)
321	/** Special version of ComAssertRC that evaluates eval and breaks if vrc does not succeed */
322	#define ComAssertRCBreak(vrc, eval) \
323	if (1) { ComAssertRC(vrc); if (!RT_SUCCESS(vrc)) { eval; break; } } else do {} while (0)
324	/** Special version of ComAssertFailed that evaluates eval and breaks */
325	#define ComAssertFailedBreak(eval) \
326	if (1) { ComAssertFailed(); { eval; break; } } else do {} while (0)
327	/** Special version of ComAssertMsgFailed that evaluates eval and breaks */
328	#define ComAssertMsgFailedBreak(msg, eval) \
329	if (1) { ComAssertMsgFailed (msg); { eval; break; } } else do {} while (0)
330	/** Special version of ComAssertComRC that evaluates eval and breaks if rc does not succeed */
331	#define ComAssertComRCBreak(rc, eval) \
332	if (1) { ComAssertComRC(rc); if (!SUCCEEDED(rc)) { eval; break; } } else do {} while (0)
333	/** Special version of ComAssertComRC that just breaks if rc does not succeed */
334	#define ComAssertComRCBreakRC(rc) \
335	if (1) { ComAssertComRC(rc); if (!SUCCEEDED(rc)) { break; } } else do {} while (0)
336
337
338	/** Special version of ComAssert that evaluates eval and throws it if expr fails */
339	#define ComAssertThrow(expr, eval) \
340	do { ComAssert(expr); if (!(expr)) { throw (eval); } } while (0)
341	/** Special version of ComAssertRC that evaluates eval and throws it if vrc does not succeed */
342	#define ComAssertRCThrow(vrc, eval) \
343	do { ComAssertRC(vrc); if (!RT_SUCCESS(vrc)) { throw (eval); } } while (0)
344	/** Special version of ComAssertComRC that evaluates eval and throws it if rc does not succeed */
345	#define ComAssertComRCThrow(rc, eval) \
346	do { ComAssertComRC(rc); if (!SUCCEEDED(rc)) { throw (eval); } } while (0)
347	/** Special version of ComAssertComRC that just throws rc if rc does not succeed */
348	#define ComAssertComRCThrowRC(rc) \
349	do { ComAssertComRC(rc); if (!SUCCEEDED(rc)) { throw rc; } } while (0)
350	/** Special version of ComAssert that throws eval */
351	#define ComAssertFailedThrow(eval) \
352	do { ComAssertFailed(); { throw (eval); } } while (0)
353
354	////////////////////////////////////////////////////////////////////////////////
355
356	/**
357	* Checks that the pointer argument is not NULL and returns E_INVALIDARG +
358	* extended error info on failure.
359	* @param arg Input pointer-type argument (strings, interface pointers...)
360	*/
361	#define CheckComArgNotNull(arg) \
362	do { \
363	if (RT_LIKELY((arg) != NULL)) \
364	{ /* likely */ }\
365	else \
366	return setError(E_INVALIDARG, VirtualBoxBase::tr("Argument %s is NULL"), #arg); \
367	} while (0)
368
369	/**
370	* Checks that the pointer argument is a valid pointer or NULL and returns
371	* E_INVALIDARG + extended error info on failure.
372	* @param arg Input pointer-type argument (strings, interface pointers...)
373	*/
374	#define CheckComArgMaybeNull(arg) \
375	do { \
376	if (RT_LIKELY(RT_VALID_PTR(arg) \|\| (arg) == NULL)) \
377	{ /* likely */ }\
378	else \
379	return setError(E_INVALIDARG, \
380	VirtualBoxBase::tr("Argument %s is an invalid pointer"), #arg); \
381	} while (0)
382
383	/**
384	* Checks that the given pointer to an argument is valid and returns
385	* E_POINTER + extended error info otherwise.
386	* @param arg Pointer argument.
387	*/
388	#define CheckComArgPointerValid(arg) \
389	do { \
390	if (RT_LIKELY(RT_VALID_PTR(arg))) \
391	{ /* likely */ }\
392	else \
393	return setError(E_POINTER, \
394	VirtualBoxBase::tr("Argument %s points to invalid memory location (%p)"), \
395	#arg, (void *)(arg)); \
396	} while (0)
397
398	/**
399	* Checks that safe array argument is not NULL and returns E_INVALIDARG +
400	* extended error info on failure.
401	* @param arg Input safe array argument (strings, interface pointers...)
402	*/
403	#define CheckComArgSafeArrayNotNull(arg) \
404	do { \
405	if (RT_LIKELY(!ComSafeArrayInIsNull(arg))) \
406	{ /* likely */ }\
407	else \
408	return setError(E_INVALIDARG, \
409	VirtualBoxBase::tr("Argument %s is NULL"), #arg); \
410	} while (0)
411
412	/**
413	* Checks that a string input argument is valid (not NULL or obviously invalid
414	* pointer), returning E_INVALIDARG + extended error info if invalid.
415	* @param a_bstrIn Input string argument (IN_BSTR).
416	*/
417	#define CheckComArgStr(a_bstrIn) \
418	do { \
419	IN_BSTR const bstrInCheck = (a_bstrIn); /* type check */ \
420	if (RT_LIKELY(RT_VALID_PTR(bstrInCheck))) \
421	{ /* likely */ }\
422	else \
423	return setError(E_INVALIDARG, \
424	VirtualBoxBase::tr("Argument %s is an invalid pointer"), #a_bstrIn); \
425	} while (0)
426	/**
427	* Checks that the string argument is not a NULL, a invalid pointer or an empty
428	* string, returning E_INVALIDARG + extended error info on failure.
429	* @param a_bstrIn Input string argument (BSTR etc.).
430	*/
431	#define CheckComArgStrNotEmptyOrNull(a_bstrIn) \
432	do { \
433	IN_BSTR const bstrInCheck = (a_bstrIn); /* type check */ \
434	if (RT_LIKELY(RT_VALID_PTR(bstrInCheck) && *(bstrInCheck) != '\0')) \
435	{ /* likely */ }\
436	else \
437	return setError(E_INVALIDARG, \
438	VirtualBoxBase::tr("Argument %s is empty or an invalid pointer"), \
439	#a_bstrIn); \
440	} while (0)
441
442	/**
443	* Converts the Guid input argument (string) to a Guid object, returns with
444	* E_INVALIDARG and error message on failure.
445	*
446	* @param a_Arg Argument.
447	* @param a_GuidVar The Guid variable name.
448	*/
449	#define CheckComArgGuid(a_Arg, a_GuidVar) \
450	do { \
451	Guid tmpGuid(a_Arg); \
452	(a_GuidVar) = tmpGuid; \
453	if (RT_LIKELY((a_GuidVar).isValid())) \
454	{ /* likely */ }\
455	else \
456	return setError(E_INVALIDARG, \
457	VirtualBoxBase::tr("GUID argument %s is not valid (\"%ls\")"), \
458	#a_Arg, Bstr(a_Arg).raw()); \
459	} while (0)
460
461	/**
462	* Checks that the given expression (that must involve the argument) is true and
463	* returns E_INVALIDARG + extended error info on failure.
464	* @param arg Argument.
465	* @param expr Expression to evaluate.
466	*/
467	#define CheckComArgExpr(arg, expr) \
468	do { \
469	if (RT_LIKELY(!!(expr))) \
470	{ /* likely */ }\
471	else \
472	return setError(E_INVALIDARG, \
473	VirtualBoxBase::tr("Argument %s is invalid (must be %s)"), \
474	#arg, #expr); \
475	} while (0)
476
477	/**
478	* Checks that the given expression (that must involve the argument) is true and
479	* returns E_INVALIDARG + extended error info on failure. The error message must
480	* be customized.
481	* @param arg Argument.
482	* @param expr Expression to evaluate.
483	* @param msg Parenthesized printf-like expression (must start with a verb,
484	* like "must be one of...", "is not within...").
485	*/
486	#define CheckComArgExprMsg(arg, expr, msg) \
487	do { \
488	if (RT_LIKELY(!!(expr))) \
489	{ /* likely */ }\
490	else \
491	return setError(E_INVALIDARG, VirtualBoxBase::tr("Argument %s %s"), \
492	#arg, Utf8StrFmt msg .c_str()); \
493	} while (0)
494
495	/**
496	* Checks that the given pointer to an output argument is valid and returns
497	* E_POINTER + extended error info otherwise.
498	* @param arg Pointer argument.
499	*/
500	#define CheckComArgOutPointerValid(arg) \
501	do { \
502	if (RT_LIKELY(RT_VALID_PTR(arg))) \
503	{ /* likely */ }\
504	else \
505	return setError(E_POINTER, \
506	VirtualBoxBase::tr("Output argument %s points to invalid memory location (%p)"), \
507	#arg, (void *)(arg)); \
508	} while (0)
509
510	/**
511	* Checks that the given pointer to an output safe array argument is valid and
512	* returns E_POINTER + extended error info otherwise.
513	* @param arg Safe array argument.
514	*/
515	#define CheckComArgOutSafeArrayPointerValid(arg) \
516	do { \
517	if (RT_LIKELY(!ComSafeArrayOutIsNull(arg))) \
518	{ /* likely */ }\
519	else \
520	return setError(E_POINTER, \
521	VirtualBoxBase::tr("Output argument %s points to invalid memory location (%p)"), \
522	#arg, (void*)(arg)); \
523	} while (0)
524
525	/**
526	* Sets the extended error info and returns E_NOTIMPL.
527	*/
528	#define ReturnComNotImplemented() \
529	do { \
530	return setError(E_NOTIMPL, VirtualBoxBase::tr("Method %s is not implemented"), __FUNCTION__); \
531	} while (0)
532
533	/**
534	* Declares an empty constructor and destructor for the given class.
535	* This is useful to prevent the compiler from generating the default
536	* ctor and dtor, which in turn allows to use forward class statements
537	* (instead of including their header files) when declaring data members of
538	* non-fundamental types with constructors (which are always called implicitly
539	* by constructors and by the destructor of the class).
540	*
541	* This macro is to be placed within (the public section of) the class
542	* declaration. Its counterpart, DEFINE_EMPTY_CTOR_DTOR, must be placed
543	* somewhere in one of the translation units (usually .cpp source files).
544	*
545	* @param cls class to declare a ctor and dtor for
546	*/
547	#define DECLARE_EMPTY_CTOR_DTOR(cls) cls(); virtual ~cls();
548
549	/**
550	* Defines an empty constructor and destructor for the given class.
551	* See DECLARE_EMPTY_CTOR_DTOR for more info.
552	*/
553	#define DEFINE_EMPTY_CTOR_DTOR(cls) \
554	cls::cls() { /empty/ } \
555	cls::~cls() { /empty/ }
556
557	/**
558	* A variant of 'throw' that hits a debug breakpoint first to make
559	* finding the actual thrower possible.
560	*/
561	#ifdef DEBUG
562	# define DebugBreakThrow(a) \
563	do { \
564	RTAssertDebugBreak(); \
565	throw (a); \
566	} while (0)
567	#else
568	# define DebugBreakThrow(a) throw (a)
569	#endif
570
571	////////////////////////////////////////////////////////////////////////////////
572	//
573	// VirtualBoxBase
574	//
575	////////////////////////////////////////////////////////////////////////////////
576
577	#ifdef VBOX_WITH_MAIN_NLS
578	# define DECLARE_TRANSLATE_METHODS(cls) \
579	static inline const char tr(const char aSourceText, \
580	const char *aComment = NULL, \
581	const size_t aNum = ~(size_t)0) \
582	{ \
583	return VirtualBoxTranslator::translate(NULL, #cls, aSourceText, aComment, aNum); \
584	}
585	#else
586	# define DECLARE_TRANSLATE_METHODS(cls) \
587	static inline const char tr(const char aSourceText, \
588	const char *aComment = NULL, \
589	const size_t aNum = ~(size_t)0) \
590	{ \
591	RT_NOREF(aComment, aNum); \
592	return aSourceText; \
593	}
594	#endif
595
596	#define DECLARE_COMMON_CLASS_METHODS(cls) \
597	DECLARE_EMPTY_CTOR_DTOR(cls) \
598	DECLARE_TRANSLATE_METHODS(cls)
599
600	#define VIRTUALBOXBASE_ADD_VIRTUAL_COMPONENT_METHODS(cls, iface) \
601	virtual const IID& getClassIID() const \
602	{ \
603	return cls::getStaticClassIID(); \
604	} \
605	static const IID& getStaticClassIID() \
606	{ \
607	return COM_IIDOF(iface); \
608	} \
609	virtual const char* getComponentName() const \
610	{ \
611	return cls::getStaticComponentName(); \
612	} \
613	static const char* getStaticComponentName() \
614	{ \
615	return #cls; \
616	}
617
618	/**
619	* VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT:
620	* This macro must be used once in the declaration of any class derived
621	* from VirtualBoxBase. It implements the pure virtual getClassIID() and
622	* getComponentName() methods. If this macro is not present, instances
623	* of a class derived from VirtualBoxBase cannot be instantiated.
624	*
625	* @param cls The class name, e.g. "Class".
626	* @param iface The interface name which this class implements, e.g. "IClass".
627	*/
628	#ifdef VBOX_WITH_XPCOM
629	#define VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(cls, iface) \
630	VIRTUALBOXBASE_ADD_VIRTUAL_COMPONENT_METHODS(cls, iface)
631	#else // !VBOX_WITH_XPCOM
632	#define VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(cls, iface) \
633	VIRTUALBOXBASE_ADD_VIRTUAL_COMPONENT_METHODS(cls, iface) \
634	STDMETHOD(InterfaceSupportsErrorInfo)(REFIID riid) \
635	{ \
636	const ATL::_ATL_INTMAP_ENTRY* pEntries = cls::_GetEntries(); \
637	Assert(pEntries); \
638	if (!pEntries) \
639	return S_FALSE; \
640	BOOL bSupports = FALSE; \
641	BOOL bISupportErrorInfoFound = FALSE; \
642	while (pEntries->pFunc != NULL && !bSupports) \
643	{ \
644	if (!bISupportErrorInfoFound) \
645	bISupportErrorInfoFound = InlineIsEqualGUID(*(pEntries->piid), IID_ISupportErrorInfo); \
646	else \
647	bSupports = InlineIsEqualGUID(*(pEntries->piid), riid); \
648	pEntries++; \
649	} \
650	Assert(bISupportErrorInfoFound); \
651	return bSupports ? S_OK : S_FALSE; \
652	}
653	#endif // !VBOX_WITH_XPCOM
654
655	/**
656	* VBOX_TWEAK_INTERFACE_ENTRY:
657	* Macro for defining magic interface entries needed for all interfaces
658	* implemented by any subclass of VirtualBoxBase.
659	*/
660	#ifdef VBOX_WITH_XPCOM
661	#define VBOX_TWEAK_INTERFACE_ENTRY(iface)
662	#else // !VBOX_WITH_XPCOM
663	#define VBOX_TWEAK_INTERFACE_ENTRY(iface) \
664	COM_INTERFACE_ENTRY_AGGREGATE(IID_IMarshal, m_pUnkMarshaler.m_p)
665	#endif // !VBOX_WITH_XPCOM
666
667
668	/**
669	* Abstract base class for all component classes implementing COM
670	* interfaces of the VirtualBox COM library.
671	*
672	* Declares functionality that should be available in all components.
673	*
674	* The object state logic is documented in ObjectState.h.
675	*/
676	class ATL_NO_VTABLE VirtualBoxBase
677	: public Lockable
678	, public ATL::CComObjectRootEx<ATL::CComMultiThreadModel>
679	#if !defined (VBOX_WITH_XPCOM)
680	, public ISupportErrorInfo
681	#endif
682	{
683	protected:
684	#ifdef RT_OS_WINDOWS
685	ComPtr<IUnknown> m_pUnkMarshaler;
686	#endif
687
688	HRESULT BaseFinalConstruct();
689	void BaseFinalRelease();
690
691	public:
692	DECLARE_COMMON_CLASS_METHODS(VirtualBoxBase)
693
694	/**
695	* Uninitialization method.
696	*
697	* Must be called by all final implementations (component classes) when the
698	* last reference to the object is released, before calling the destructor.
699	*
700	* @note Never call this method the AutoCaller scope or after the
701	* ObjectState::addCaller() call not paired by
702	* ObjectState::releaseCaller() because it is a guaranteed deadlock.
703	* See AutoUninitSpan and AutoCaller.h/ObjectState.h for details.
704	*/
705	virtual void uninit()
706	{ }
707
708	/**
709	*/
710	ObjectState &getObjectState()
711	{
712	return mState;
713	}
714
715	/**
716	* Pure virtual method for simple run-time type identification without
717	* having to enable C++ RTTI.
718	*
719	* This must be implemented by every subclass deriving from VirtualBoxBase;
720	* use the VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT macro to do that most easily.
721	*/
722	virtual const IID& getClassIID() const = 0;
723
724	/**
725	* Pure virtual method for simple run-time type identification without
726	* having to enable C++ RTTI.
727	*
728	* This must be implemented by every subclass deriving from VirtualBoxBase;
729	* use the VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT macro to do that most easily.
730	*/
731	virtual const char* getComponentName() const = 0;
732
733	/**
734	* Virtual method which determines the locking class to be used for validating
735	* lock order with the standard member lock handle. This method is overridden
736	* in a number of subclasses.
737	*/
738	virtual VBoxLockingClass getLockingClass() const
739	{
740	return LOCKCLASS_OTHEROBJECT;
741	}
742
743	virtual RWLockHandle *lockHandle() const;
744
745	static HRESULT handleUnexpectedExceptions(VirtualBoxBase *const aThis, RT_SRC_POS_DECL);
746
747	static HRESULT setErrorInternalF(HRESULT aResultCode,
748	const GUID &aIID,
749	const char *aComponent,
750	bool aWarning,
751	bool aLogIt,
752	LONG aResultDetail,
753	const char *aText, ...);
754	static HRESULT setErrorInternalV(HRESULT aResultCode,
755	const GUID &aIID,
756	const char *aComponent,
757	const char *aText,
758	va_list aArgs,
759	bool aWarning,
760	bool aLogIt,
761	LONG aResultDetail = 0);
762	static void clearError(void);
763
764	HRESULT setError(HRESULT aResultCode);
765	HRESULT setError(HRESULT aResultCode, const char *pcsz, ...);
766	HRESULT setError(const ErrorInfo &ei);
767	HRESULT setErrorVrc(int vrc);
768	HRESULT setErrorVrc(int vrc, const char *pcszMsgFmt, ...);
769	HRESULT setErrorBoth(HRESULT hrc, int vrc);
770	HRESULT setErrorBoth(HRESULT hrc, int vrc, const char *pcszMsgFmt, ...);
771	HRESULT setWarning(HRESULT aResultCode, const char *pcsz, ...);
772	HRESULT setErrorNoLog(HRESULT aResultCode, const char *pcsz, ...);
773
774
775	/** Initialize COM for a new thread. */
776	static HRESULT initializeComForThread(void)
777	{
778	#ifndef VBOX_WITH_XPCOM
779	HRESULT hrc = CoInitializeEx(NULL, COINIT_MULTITHREADED \| COINIT_DISABLE_OLE1DDE \| COINIT_SPEED_OVER_MEMORY);
780	AssertComRCReturn(hrc, hrc);
781	#endif
782	return S_OK;
783	}
784
785	/** Uninitializes COM for a dying thread. */
786	static void uninitializeComForThread(void)
787	{
788	#ifndef VBOX_WITH_XPCOM
789	CoUninitialize();
790	#endif
791	}
792
793
794	private:
795	/** Object for representing object state */
796	ObjectState mState;
797
798	/** User-level object lock for subclasses */
799	RWLockHandle *mObjectLock;
800
801	/** Slot of this object in the g_aClassFactoryStats array */
802	uint32_t iFactoryStat;
803
804	private:
805	DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(VirtualBoxBase); /* Shuts up MSC warning C4625. */
806	};
807
808	/** Structure for counting the currently existing and ever created objects
809	* for each component name. */
810	typedef struct CLASSFACTORY_STAT
811	{
812	const char *psz;
813	uint64_t current;
814	uint64_t overall;
815	} CLASSFACTORY_STAT;
816
817	/** Maximum number of component names to deal with. There will be debug
818	* assertions if the value is too low. Since the table is global and its
819	* entries are reasonably small, it's not worth squeezing out the last bit. */
820	#define CLASSFACTORYSTATS_MAX 128
821
822	/* global variables (defined in VirtualBoxBase.cpp) */
823	extern CLASSFACTORY_STAT g_aClassFactoryStats[CLASSFACTORYSTATS_MAX];
824	extern RWLockHandle *g_pClassFactoryStatsLock;
825
826	extern void APIDumpComponentFactoryStats();
827
828	/**
829	* Dummy macro that is used to shut down Qt's lupdate tool warnings in some
830	* situations. This macro needs to be present inside (better at the very
831	* beginning) of the declaration of the class that uses translation, to make
832	* lupdate happy.
833	*/
834	#define Q_OBJECT
835
836	////////////////////////////////////////////////////////////////////////////////
837
838	////////////////////////////////////////////////////////////////////////////////
839
840
841	/**
842	* Simple template that manages data structure allocation/deallocation
843	* and supports data pointer sharing (the instance that shares the pointer is
844	* not responsible for memory deallocation as opposed to the instance that
845	* owns it).
846	*/
847	template <class D>
848	class Shareable
849	{
850	public:
851
852	Shareable() : mData(NULL), mIsShared(FALSE) {}
853	virtual ~Shareable() { free(); }
854
855	void allocate() { attach(new D); }
856
857	virtual void free() {
858	if (mData) {
859	if (!mIsShared)
860	delete mData;
861	mData = NULL;
862	mIsShared = false;
863	}
864	}
865
866	void attach(D *d) {
867	AssertMsg(d, ("new data must not be NULL"));
868	if (d && mData != d) {
869	if (mData && !mIsShared)
870	delete mData;
871	mData = d;
872	mIsShared = false;
873	}
874	}
875
876	void attach(Shareable &d) {
877	AssertMsg(
878	d.mData == mData \|\| !d.mIsShared,
879	("new data must not be shared")
880	);
881	if (this != &d && !d.mIsShared) {
882	attach(d.mData);
883	d.mIsShared = true;
884	}
885	}
886
887	void share(D *d) {
888	AssertMsg(d, ("new data must not be NULL"));
889	if (mData != d) {
890	if (mData && !mIsShared)
891	delete mData;
892	mData = d;
893	mIsShared = true;
894	}
895	}
896
897	void share(const Shareable &d) { share(d.mData); }
898
899	void attachCopy(const D *d) {
900	AssertMsg(d, ("data to copy must not be NULL"));
901	if (d)
902	attach(new D(*d));
903	}
904
905	void attachCopy(const Shareable &d) {
906	attachCopy(d.mData);
907	}
908
909	virtual D *detach() {
910	D *d = mData;
911	mData = NULL;
912	mIsShared = false;
913	return d;
914	}
915
916	D *data() const {
917	return mData;
918	}
919
920	D *operator->() const {
921	AssertMsg(mData, ("data must not be NULL"));
922	return mData;
923	}
924
925	bool isNull() const { return mData == NULL; }
926	bool operator!() const { return isNull(); }
927
928	bool isShared() const { return mIsShared; }
929
930	protected:
931
932	D *mData;
933	bool mIsShared;
934	};
935
936	/**
937	* Simple template that enhances Shareable<> and supports data
938	* backup/rollback/commit (using the copy constructor of the managed data
939	* structure).
940	*/
941	template<class D>
942	class Backupable : public Shareable<D>
943	{
944	public:
945
946	Backupable() : Shareable<D>(), mBackupData(NULL) {}
947
948	void free()
949	{
950	AssertMsg(this->mData \|\| !mBackupData, ("backup must be NULL if data is NULL"));
951	rollback();
952	Shareable<D>::free();
953	}
954
955	D *detach()
956	{
957	AssertMsg(this->mData \|\| !mBackupData, ("backup must be NULL if data is NULL"));
958	rollback();
959	return Shareable<D>::detach();
960	}
961
962	void share(const Backupable &d)
963	{
964	AssertMsg(!d.isBackedUp(), ("data to share must not be backed up"));
965	if (!d.isBackedUp())
966	Shareable<D>::share(d.mData);
967	}
968
969	/**
970	* Stores the current data pointer in the backup area, allocates new data
971	* using the copy constructor on current data and makes new data active.
972	*
973	* @deprecated Use backupEx to avoid throwing wild out-of-memory exceptions.
974	*/
975	void backup()
976	{
977	AssertMsg(this->mData, ("data must not be NULL"));
978	if (this->mData && !mBackupData)
979	{
980	D pNewData = new D(this->mData);
981	mBackupData = this->mData;
982	this->mData = pNewData;
983	}
984	}
985
986	/**
987	* Stores the current data pointer in the backup area, allocates new data
988	* using the copy constructor on current data and makes new data active.
989	*
990	* @returns S_OK, E_OUTOFMEMORY or E_FAIL (internal error).
991	*/
992	HRESULT backupEx()
993	{
994	AssertMsgReturn(this->mData, ("data must not be NULL"), E_FAIL);
995	if (this->mData && !mBackupData)
996	{
997	try
998	{
999	D pNewData = new D(this->mData);
1000	mBackupData = this->mData;
1001	this->mData = pNewData;
1002	}
1003	catch (std::bad_alloc &)
1004	{
1005	return E_OUTOFMEMORY;
1006	}
1007	}
1008	return S_OK;
1009	}
1010
1011	/**
1012	* Deletes new data created by #backup() and restores previous data pointer
1013	* stored in the backup area, making it active again.
1014	*/
1015	void rollback()
1016	{
1017	if (this->mData && mBackupData)
1018	{
1019	delete this->mData;
1020	this->mData = mBackupData;
1021	mBackupData = NULL;
1022	}
1023	}
1024
1025	/**
1026	* Commits current changes by deleting backed up data and clearing up the
1027	* backup area. The new data pointer created by #backup() remains active
1028	* and becomes the only managed pointer.
1029	*
1030	* This method is much faster than #commitCopy() (just a single pointer
1031	* assignment operation), but makes the previous data pointer invalid
1032	* (because it is freed). For this reason, this method must not be
1033	* used if it's possible that data managed by this instance is shared with
1034	* some other Shareable instance. See #commitCopy().
1035	*/
1036	void commit()
1037	{
1038	if (this->mData && mBackupData)
1039	{
1040	if (!this->mIsShared)
1041	delete mBackupData;
1042	mBackupData = NULL;
1043	this->mIsShared = false;
1044	}
1045	}
1046
1047	/**
1048	* Commits current changes by assigning new data to the previous data
1049	* pointer stored in the backup area using the assignment operator.
1050	* New data is deleted, the backup area is cleared and the previous data
1051	* pointer becomes active and the only managed pointer.
1052	*
1053	* This method is slower than #commit(), but it keeps the previous data
1054	* pointer valid (i.e. new data is copied to the same memory location).
1055	* For that reason it's safe to use this method on instances that share
1056	* managed data with other Shareable instances.
1057	*/
1058	void commitCopy()
1059	{
1060	if (this->mData && mBackupData)
1061	{
1062	mBackupData = (this->mData);
1063	delete this->mData;
1064	this->mData = mBackupData;
1065	mBackupData = NULL;
1066	}
1067	}
1068
1069	void assignCopy(const D *pData)
1070	{
1071	AssertMsg(this->mData, ("data must not be NULL"));
1072	AssertMsg(pData, ("data to copy must not be NULL"));
1073	if (this->mData && pData)
1074	{
1075	if (!mBackupData)
1076	{
1077	D pNewData = new D(pData);
1078	mBackupData = this->mData;
1079	this->mData = pNewData;
1080	}
1081	else
1082	this->mData = pData;
1083	}
1084	}
1085
1086	void assignCopy(const Backupable &d)
1087	{
1088	assignCopy(d.mData);
1089	}
1090
1091	bool isBackedUp() const
1092	{
1093	return mBackupData != NULL;
1094	}
1095
1096	D *backedUpData() const
1097	{
1098	return mBackupData;
1099	}
1100
1101	protected:
1102
1103	D *mBackupData;
1104	};
1105
1106	#endif /* !MAIN_INCLUDED_VirtualBoxBase_h */
1107

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

source: vbox/trunk/src/VBox/Main/include/VirtualBoxBase.h@ 93412

Download in other formats: