server.cpp@ 13835

Last change on this file since 13835 was 13835, checked in by vboxsync, 16 years ago
s/VBOX_SUCCESS/RT_SUCCESS/g s/VBOX_FAILURE/RT_FAILURE/g - VBOX_SUCCESS and VBOX_FAILURE have NOT been retired (because old habbits die hard) just sligtly deprecated.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 36.2 KB

Line
1	/* $Id: server.cpp 13835 2008-11-05 02:34:43Z vboxsync $ */
2	/** @file
3	* XPCOM server process (VBoxSVC) start point.
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 Sun Microsystems, Inc.
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	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18	* Clara, CA 95054 USA or visit http://www.sun.com if you need
19	* additional information or have any questions.
20	*/
21
22	/* Make sure all the stdint.h macros are included - must come first! */
23	#ifndef __STDC_LIMIT_MACROS
24	# define __STDC_LIMIT_MACROS
25	#endif
26	#ifndef __STDC_CONSTANT_MACROS
27	# define __STDC_CONSTANT_MACROS
28	#endif
29
30	#include <ipcIService.h>
31	#include <ipcCID.h>
32
33	#include <nsIComponentRegistrar.h>
34
35	#if defined(XPCOM_GLUE)
36	#include <nsXPCOMGlue.h>
37	#endif
38
39	#include <nsEventQueueUtils.h>
40	#include <nsGenericFactory.h>
41
42	#include "xpcom/server.h"
43
44	#include "Logging.h"
45
46	#include <iprt/runtime.h>
47	#include <iprt/path.h>
48	#include <iprt/critsect.h>
49	#include <iprt/timer.h>
50
51	#include <VBox/param.h>
52	#include <VBox/version.h>
53
54	#include <VBox/com/com.h>
55
56	#include <stdio.h>
57
58	// for the signal handler
59	#include <signal.h>
60	#include <stdlib.h>
61	#include <unistd.h>
62	#include <errno.h>
63	#include <getopt.h>
64
65	// for the backtrace signal handler
66	#if defined(DEBUG) && defined(RT_OS_LINUX)
67	# define USE_BACKTRACE
68	#endif
69	#if defined(USE_BACKTRACE)
70	# include <execinfo.h>
71	// get REG_EIP/RIP from ucontext.h
72	# ifndef __USE_GNU
73	# define __USE_GNU
74	# endif
75	# include <ucontext.h>
76	# ifdef RT_ARCH_AMD64
77	# define REG_PC REG_RIP
78	# else
79	# define REG_PC REG_EIP
80	# endif
81	#endif
82
83	/////////////////////////////////////////////////////////////////////////////
84	// VirtualBox component instantiation
85	/////////////////////////////////////////////////////////////////////////////
86
87	#include <nsIGenericFactory.h>
88
89	#include <VirtualBox_XPCOM.h>
90	#include <VirtualBoxImpl.h>
91	#include <MachineImpl.h>
92	#include <SnapshotImpl.h>
93	#include <MediumImpl.h>
94	#include <HardDisk2Impl.h>
95	#include <HardDiskFormatImpl.h>
96	#include <ProgressImpl.h>
97	#include <DVDDriveImpl.h>
98	#include <FloppyDriveImpl.h>
99	#include <VRDPServerImpl.h>
100	#include <SharedFolderImpl.h>
101	#include <HostImpl.h>
102	#include <HostDVDDriveImpl.h>
103	#include <HostFloppyDriveImpl.h>
104	#include <HostNetworkInterfaceImpl.h>
105	#include <GuestOSTypeImpl.h>
106	#include <NetworkAdapterImpl.h>
107	#include <SerialPortImpl.h>
108	#include <ParallelPortImpl.h>
109	#include <USBControllerImpl.h>
110	#ifdef VBOX_WITH_USB
111	# include <HostUSBDeviceImpl.h>
112	# include <USBDeviceImpl.h>
113	#endif
114	#include <SATAControllerImpl.h>
115	#include <AudioAdapterImpl.h>
116	#include <SystemPropertiesImpl.h>
117	#include <Collection.h>
118
119	/* implement nsISupports parts of our objects with support for nsIClassInfo */
120
121	NS_DECL_CLASSINFO(VirtualBox)
122	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(VirtualBox, IVirtualBox)
123
124	NS_DECL_CLASSINFO(Machine)
125	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(Machine, IMachine)
126
127	NS_DECL_CLASSINFO(SessionMachine)
128	NS_IMPL_THREADSAFE_ISUPPORTS2_CI(SessionMachine, IMachine, IInternalMachineControl)
129
130	NS_DECL_CLASSINFO(SnapshotMachine)
131	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(SnapshotMachine, IMachine)
132
133	NS_DECL_CLASSINFO(Snapshot)
134	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(Snapshot, ISnapshot)
135
136	NS_DECL_CLASSINFO(DVDImage2)
137	NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(DVDImage2,
138	IMedium, ImageMediumBase,
139	IDVDImage2, DVDImage2)
140	NS_DECL_CLASSINFO(FloppyImage2)
141	NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(FloppyImage2,
142	IMedium, ImageMediumBase,
143	IFloppyImage2, FloppyImage2)
144
145	NS_DECL_CLASSINFO(HardDisk2)
146	NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(HardDisk2,
147	IMedium, MediumBase,
148	IHardDisk2, HardDisk2)
149
150	NS_DECL_CLASSINFO(HardDiskFormat)
151	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(HardDiskFormat, IHardDiskFormat)
152
153	NS_DECL_CLASSINFO(HardDisk2Attachment)
154	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(HardDisk2Attachment, IHardDisk2Attachment)
155
156	NS_DECL_CLASSINFO(Progress)
157	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(Progress, IProgress)
158
159	NS_DECL_CLASSINFO(CombinedProgress)
160	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(CombinedProgress, IProgress)
161
162	NS_DECL_CLASSINFO(DVDDrive)
163	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(DVDDrive, IDVDDrive)
164
165	NS_DECL_CLASSINFO(FloppyDrive)
166	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(FloppyDrive, IFloppyDrive)
167
168	NS_DECL_CLASSINFO(SharedFolder)
169	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(SharedFolder, ISharedFolder)
170
171	#ifdef VBOX_WITH_VRDP
172	NS_DECL_CLASSINFO(VRDPServer)
173	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(VRDPServer, IVRDPServer)
174	#endif
175
176	NS_DECL_CLASSINFO(Host)
177	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(Host, IHost)
178
179	NS_DECL_CLASSINFO(HostDVDDrive)
180	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(HostDVDDrive, IHostDVDDrive)
181
182	NS_DECL_CLASSINFO(HostFloppyDrive)
183	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(HostFloppyDrive, IHostFloppyDrive)
184
185	NS_DECL_CLASSINFO(HostNetworkInterface)
186	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(HostNetworkInterface, IHostNetworkInterface)
187
188	NS_DECL_CLASSINFO(GuestOSType)
189	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(GuestOSType, IGuestOSType)
190
191	NS_DECL_CLASSINFO(NetworkAdapter)
192	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(NetworkAdapter, INetworkAdapter)
193
194	NS_DECL_CLASSINFO(SerialPort)
195	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(SerialPort, ISerialPort)
196
197	NS_DECL_CLASSINFO(ParallelPort)
198	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(ParallelPort, IParallelPort)
199
200	NS_DECL_CLASSINFO(USBController)
201	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(USBController, IUSBController)
202
203	NS_DECL_CLASSINFO(SATAController)
204	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(SATAController, ISATAController)
205
206	#ifdef VBOX_WITH_USB
207	NS_DECL_CLASSINFO(USBDeviceFilter)
208	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(USBDeviceFilter, IUSBDeviceFilter)
209
210	NS_DECL_CLASSINFO(HostUSBDevice)
211	NS_IMPL_THREADSAFE_ISUPPORTS2_CI(HostUSBDevice, IUSBDevice, IHostUSBDevice)
212
213	NS_DECL_CLASSINFO(HostUSBDeviceFilter)
214	NS_IMPL_THREADSAFE_ISUPPORTS2_CI(HostUSBDeviceFilter, IUSBDeviceFilter, IHostUSBDeviceFilter)
215	#endif
216
217	NS_DECL_CLASSINFO(AudioAdapter)
218	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(AudioAdapter, IAudioAdapter)
219
220	NS_DECL_CLASSINFO(SystemProperties)
221	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(SystemProperties, ISystemProperties)
222
223	#ifdef VBOX_WITH_RESOURCE_USAGE_API
224	NS_DECL_CLASSINFO(PerformanceCollector)
225	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(PerformanceCollector, IPerformanceCollector)
226	NS_DECL_CLASSINFO(PerformanceMetric)
227	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(PerformanceMetric, IPerformanceMetric)
228	#endif /* VBOX_WITH_RESOURCE_USAGE_API */
229
230	NS_DECL_CLASSINFO(BIOSSettings)
231	NS_IMPL_THREADSAFE_ISUPPORTS1_CI(BIOSSettings, IBIOSSettings)
232
233	/* collections and enumerators */
234
235	COM_IMPL_READONLY_ENUM_AND_COLLECTION(Snapshot)
236	COM_IMPL_READONLY_ENUM_AND_COLLECTION(GuestOSType)
237	COM_IMPL_READONLY_ENUM_AND_COLLECTION(HostDVDDrive)
238	COM_IMPL_READONLY_ENUM_AND_COLLECTION(HostFloppyDrive)
239	COM_IMPL_READONLY_ENUM_AND_COLLECTION(HostNetworkInterface)
240	COM_IMPL_READONLY_ENUM_AND_COLLECTION(SharedFolder)
241	#ifdef VBOX_WITH_USB
242	COM_IMPL_READONLY_ENUM_AND_COLLECTION(HostUSBDevice)
243	COM_IMPL_READONLY_ENUM_AND_COLLECTION(HostUSBDeviceFilter)
244	COM_IMPL_READONLY_ENUM_AND_COLLECTION(USBDeviceFilter)
245	#endif
246
247	COM_IMPL_READONLY_ENUM_AND_COLLECTION_AS(Progress, IProgress)
248	#ifdef VBOX_WITH_USB
249	COM_IMPL_READONLY_ENUM_AND_COLLECTION_AS(IfaceUSBDevice, IUSBDevice)
250	#endif
251
252	////////////////////////////////////////////////////////////////////////////////
253
254	enum
255	{
256	/* Delay before shutting down the VirtualBox server after the last
257	* VirtualBox instance is released, in ms */
258	VBoxSVC_ShutdownDelay = 5000,
259	};
260
261	static bool gAutoShutdown = false;
262
263	static nsIEventQueue* gEventQ = nsnull;
264	static PRBool volatile gKeepRunning = PR_TRUE;
265
266	/////////////////////////////////////////////////////////////////////////////
267
268	/**
269	* Simple but smart PLEvent wrapper.
270	*
271	* @note Instances must be always created with <tt>operator new</tt>!
272	*/
273	class MyEvent
274	{
275	public:
276
277	MyEvent()
278	{
279	mEv.that = NULL;
280	};
281
282	/**
283	* Posts this event to the given message queue. This method may only be
284	* called once. @note On success, the event will be deleted automatically
285	* after it is delivered and handled. On failure, the event will delete
286	* itself before this method returns! The caller must not delete it in
287	* either case.
288	*/
289	nsresult postTo (nsIEventQueue *aEventQ)
290	{
291	AssertReturn (mEv.that == NULL, NS_ERROR_FAILURE);
292	AssertReturn (aEventQ, NS_ERROR_FAILURE);
293	nsresult rv = aEventQ->InitEvent (&mEv.e, NULL,
294	eventHandler, eventDestructor);
295	if (NS_SUCCEEDED (rv))
296	{
297	mEv.that = this;
298	rv = aEventQ->PostEvent (&mEv.e);
299	if (NS_SUCCEEDED (rv))
300	return rv;
301	}
302	delete this;
303	return rv;
304	}
305
306	virtual void *handler() = 0;
307
308	private:
309
310	struct Ev
311	{
312	PLEvent e;
313	MyEvent *that;
314	} mEv;
315
316	static void PR_CALLBACK eventHandler (PLEvent self)
317	{
318	return reinterpret_cast <Ev *> (self)->that->handler();
319	}
320
321	static void PR_CALLBACK eventDestructor (PLEvent *self)
322	{
323	delete reinterpret_cast <Ev *> (self)->that;
324	}
325	};
326
327	////////////////////////////////////////////////////////////////////////////////
328
329	/**
330	* VirtualBox class factory that destroys the created instance right after
331	* the last reference to it is released by the client, and recreates it again
332	* when necessary (so VirtualBox acts like a singleton object).
333	*/
334	class VirtualBoxClassFactory : public VirtualBox
335	{
336	public:
337
338	virtual ~VirtualBoxClassFactory()
339	{
340	LogFlowFunc (("Deleting VirtualBox...\n"));
341
342	FinalRelease();
343	sInstance = 0;
344
345	LogFlowFunc (("VirtualBox object deleted.\n"));
346	printf ("Informational: VirtualBox object deleted.\n");
347	}
348
349	NS_IMETHOD_(nsrefcnt) Release()
350	{
351	/* we overload Release() to guarantee the VirtualBox destructor is
352	* always called on the main thread */
353
354	nsrefcnt count = VirtualBox::Release();
355
356	if (count == 1)
357	{
358	/* the last reference held by clients is being released
359	* (see GetInstance()) */
360
361	PRBool onMainThread = PR_TRUE;
362	if (gEventQ)
363	gEventQ->IsOnCurrentThread (&onMainThread);
364
365	PRBool timerStarted = PR_FALSE;
366
367	/* sTimes is null if this call originates from
368	* FactoryDestructor() */
369	if (sTimer != NULL)
370	{
371	LogFlowFunc (("Last VirtualBox instance was released.\n"));
372	LogFlowFunc (("Scheduling server shutdown in %d ms...\n",
373	VBoxSVC_ShutdownDelay));
374
375	/* make sure the previous timer (if any) is stopped;
376	* otherwise RTTimerStart() will definitely fail. */
377	RTTimerLRStop (sTimer);
378
379	int vrc = RTTimerLRStart (sTimer, uint64_t (VBoxSVC_ShutdownDelay) * 1000000);
380	AssertRC (vrc);
381	timerStarted = SUCCEEDED (vrc);
382	}
383	else
384	{
385	LogFlowFunc (("Last VirtualBox instance was released "
386	"on XPCOM shutdown.\n"));
387	Assert (onMainThread);
388	}
389
390	if (!timerStarted)
391	{
392	if (!onMainThread)
393	{
394	/* Failed to start the timer, post the shutdown event
395	* manually if not on the main thread alreay. */
396	ShutdownTimer (NULL, NULL, 0);
397	}
398	else
399	{
400	/* Here we come if:
401	*
402	* a) gEventQ is 0 which means either FactoryDestructor() is called
403	* or the IPC/DCONNECT shutdown sequence is initiated by the
404	* XPCOM shutdown routine (NS_ShutdownXPCOM()), which always
405	* happens on the main thread.
406	*
407	* b) gEventQ has reported we're on the main thread. This means
408	* that DestructEventHandler() has been called, but another
409	* client was faster and requested VirtualBox again.
410	*
411	* In either case, there is nothing to do.
412	*
413	* Note: case b) is actually no more valid since we don't
414	* call Release() from DestructEventHandler() in this case
415	* any more. Thus, we assert below.
416	*/
417
418	Assert (gEventQ == NULL);
419	}
420	}
421	}
422
423	return count;
424	}
425
426	class MaybeQuitEvent : public MyEvent
427	{
428	/* called on the main thread */
429	void *handler()
430	{
431	LogFlowFunc (("\n"));
432
433	Assert (RTCritSectIsInitialized (&sLock));
434
435	/* stop accepting GetInstance() requests on other threads during
436	* possible destruction */
437	RTCritSectEnter (&sLock);
438
439	nsrefcnt count = 0;
440
441	/* sInstance is NULL here if it was deleted immediately after
442	* creation due to initialization error. See GetInstance(). */
443	if (sInstance != NULL)
444	{
445	/* Release the guard reference added in GetInstance() */
446	count = sInstance->Release();
447	}
448
449	if (count == 0)
450	{
451	if (gAutoShutdown)
452	{
453	Assert (sInstance == NULL);
454	LogFlowFunc (("Terminating the server process...\n"));
455	/* make it leave the event loop */
456	gKeepRunning = PR_FALSE;
457	}
458	}
459	else
460	{
461	/* This condition is quite rare: a new client will have to
462	* connect after this event has been posted to the main queue
463	* but before it started to process it. */
464	LogFlowFunc (("Destruction is canceled (refcnt=%d).\n", count));
465	}
466
467	RTCritSectLeave (&sLock);
468
469	return NULL;
470	}
471	};
472
473	static void ShutdownTimer (RTTIMERLR hTimerLR, void pvUser, uint64_t /iTick*/)
474	{
475	NOREF (hTimerLR);
476	NOREF (pvUser);
477
478	/* A "too late" event is theoretically possible if somebody
479	* manually ended the server after a destruction has been scheduled
480	* and this method was so lucky that it got a chance to run before
481	* the timer was killed. */
482	AssertReturnVoid (gEventQ);
483
484	/* post a quit event to the main queue */
485	MaybeQuitEvent *ev = new MaybeQuitEvent();
486	nsresult rv = ev->postTo (gEventQ);
487	NOREF (rv);
488
489	/* A failure above means we've been already stopped (for example
490	* by Ctrl-C). FactoryDestructor() (NS_ShutdownXPCOM())
491	* will do the job. Nothing to do. */
492	}
493
494	static NS_IMETHODIMP FactoryConstructor()
495	{
496	LogFlowFunc (("\n"));
497
498	/* create a critsect to protect object construction */
499	if (RT_FAILURE (RTCritSectInit (&sLock)))
500	return NS_ERROR_OUT_OF_MEMORY;
501
502	int vrc = RTTimerLRCreateEx (&sTimer, 0, 0, ShutdownTimer, NULL);
503	if (RT_FAILURE (vrc))
504	{
505	LogFlowFunc (("Failed to create a timer! (vrc=%Vrc)\n", vrc));
506	return NS_ERROR_FAILURE;
507	}
508
509	return NS_OK;
510	}
511
512	static NS_IMETHODIMP FactoryDestructor()
513	{
514	LogFlowFunc (("\n"));
515
516	RTTimerLRDestroy (sTimer);
517	sTimer = NULL;
518
519	RTCritSectDelete (&sLock);
520
521	if (sInstance)
522	{
523	/* Either posting a destruction event falied for some reason (most
524	* likely, the quit event has been received before the last release),
525	* or the client has terminated abnormally w/o releasing its
526	* VirtualBox instance (so NS_ShutdownXPCOM() is doing a cleanup).
527	* Release the guard reference we added in GetInstance(). */
528	sInstance->Release();
529	}
530
531	return NS_OK;
532	}
533
534	static nsresult GetInstance (VirtualBox **inst)
535	{
536	LogFlowFunc (("Getting VirtualBox object...\n"));
537
538	RTCritSectEnter (&sLock);
539
540	int rv = NS_OK;
541
542	if (sInstance == 0)
543	{
544	LogFlowFunc (("Creating new VirtualBox object...\n"));
545	sInstance = new VirtualBoxClassFactory();
546	if (sInstance)
547	{
548	/* make an extra AddRef to take the full control
549	* on the VirtualBox destruction (see FinalRelease()) */
550	sInstance->AddRef();
551
552	sInstance->AddRef(); /* protect FinalConstruct() */
553	rv = sInstance->FinalConstruct();
554	printf ("Informational: VirtualBox object created (rc=%08X).\n", rv);
555	if (NS_FAILED (rv))
556	{
557	/* On failure diring VirtualBox initialization, delete it
558	* immediately on the current thread by releasing all
559	* references in order to properly schedule the server
560	* shutdown. Since the object is fully deleted here, there
561	* is a chance to fix the error and request a new
562	* instantiation before the server terminates. However,
563	* the main reason to maintain the shoutdown delay on
564	* failure is to let the front-end completely fetch error
565	* info from a server-side IVirtualBoxErrorInfo object. */
566	sInstance->Release();
567	sInstance->Release();
568	Assert (sInstance == 0);
569	}
570	else
571	{
572	/* On success, make sure the previous timer is stopped to
573	* cancel a scheduled server termination (if any). */
574	RTTimerLRStop (sTimer);
575	}
576	}
577	else
578	{
579	rv = NS_ERROR_OUT_OF_MEMORY;
580	}
581	}
582	else
583	{
584	LogFlowFunc (("Using existing VirtualBox object...\n"));
585	nsrefcnt count = sInstance->AddRef();
586	Assert (count > 1);
587
588	if (count == 2)
589	{
590	LogFlowFunc (("Another client has requested a reference to VirtualBox, "
591	"canceling detruction...\n"));
592
593	/* make sure the previous timer is stopped */
594	RTTimerLRStop (sTimer);
595	}
596	}
597
598	*inst = sInstance;
599
600	RTCritSectLeave (&sLock);
601
602	return rv;
603	}
604
605	private:
606
607	/* Don't be confused that sInstance is of the *ClassFactory type. This is
608	* actually a singleton instance (*ClassFactory inherits the singleton
609	* class; we combined them just for "simplicity" and used "static" for
610	* factory methods. *ClassFactory here is necessary for a couple of extra
611	* methods. */
612
613	static VirtualBoxClassFactory *sInstance;
614	static RTCRITSECT sLock;
615
616	static RTTIMERLR sTimer;
617	};
618
619	VirtualBoxClassFactory *VirtualBoxClassFactory::sInstance = 0;
620	RTCRITSECT VirtualBoxClassFactory::sLock = {0};
621
622	RTTIMERLR VirtualBoxClassFactory::sTimer = NIL_RTTIMERLR;
623
624	NS_GENERIC_FACTORY_SINGLETON_CONSTRUCTOR_WITH_RC
625	(VirtualBox, VirtualBoxClassFactory::GetInstance)
626
627	////////////////////////////////////////////////////////////////////////////////
628
629	typedef NSFactoryDestructorProcPtr NSFactoryConsructorProcPtr;
630
631	/**
632	* Enhanced module component information structure.
633	*
634	* nsModuleComponentInfo lacks the factory construction callback, here we add
635	* it. This callback is called by NS_NewGenericFactoryEx() after a
636	* nsGenericFactory instance is successfully created.
637	*/
638	struct nsModuleComponentInfoEx : nsModuleComponentInfo
639	{
640	nsModuleComponentInfoEx () {}
641	nsModuleComponentInfoEx (int) {}
642
643	nsModuleComponentInfoEx (
644	const char* aDescription,
645	const nsCID& aCID,
646	const char* aContractID,
647	NSConstructorProcPtr aConstructor,
648	NSRegisterSelfProcPtr aRegisterSelfProc,
649	NSUnregisterSelfProcPtr aUnregisterSelfProc,
650	NSFactoryDestructorProcPtr aFactoryDestructor,
651	NSGetInterfacesProcPtr aGetInterfacesProc,
652	NSGetLanguageHelperProcPtr aGetLanguageHelperProc,
653	nsIClassInfo ** aClassInfoGlobal,
654	PRUint32 aFlags,
655	NSFactoryConsructorProcPtr aFactoryConstructor)
656	{
657	mDescription = aDescription;
658	mCID = aCID;
659	mContractID = aContractID;
660	mConstructor = aConstructor;
661	mRegisterSelfProc = aRegisterSelfProc;
662	mUnregisterSelfProc = aUnregisterSelfProc;
663	mFactoryDestructor = aFactoryDestructor;
664	mGetInterfacesProc = aGetInterfacesProc;
665	mGetLanguageHelperProc = aGetLanguageHelperProc;
666	mClassInfoGlobal = aClassInfoGlobal;
667	mFlags = aFlags;
668	mFactoryConstructor = aFactoryConstructor;
669	}
670
671	/** (optional) Factory Construction Callback */
672	NSFactoryConsructorProcPtr mFactoryConstructor;
673	};
674
675	////////////////////////////////////////////////////////////////////////////////
676
677	static const nsModuleComponentInfoEx components[] =
678	{
679	nsModuleComponentInfoEx (
680	"VirtualBox component",
681	(nsCID) NS_VIRTUALBOX_CID,
682	NS_VIRTUALBOX_CONTRACTID,
683	VirtualBoxConstructor, // constructor funcion
684	NULL, // registration function
685	NULL, // deregistration function
686	VirtualBoxClassFactory::FactoryDestructor, // factory destructor function
687	NS_CI_INTERFACE_GETTER_NAME(VirtualBox),
688	NULL, // language helper
689	&NS_CLASSINFO_NAME(VirtualBox),
690	0, // flags
691	VirtualBoxClassFactory::FactoryConstructor // factory constructor function
692	)
693	};
694
695	/////////////////////////////////////////////////////////////////////////////
696
697	/**
698	* Extends NS_NewGenericFactory() by immediately calling
699	* nsModuleComponentInfoEx::mFactoryConstructor before returning to the
700	* caller.
701	*/
702	nsresult
703	NS_NewGenericFactoryEx (nsIGenericFactory **result,
704	const nsModuleComponentInfoEx *info)
705	{
706	AssertReturn (result, NS_ERROR_INVALID_POINTER);
707
708	nsresult rv = NS_NewGenericFactory (result, info);
709	if (NS_SUCCEEDED (rv) && info && info->mFactoryConstructor)
710	{
711	rv = info->mFactoryConstructor();
712	if (NS_FAILED (rv))
713	NS_RELEASE (*result);
714	}
715
716	return rv;
717	}
718
719	/////////////////////////////////////////////////////////////////////////////
720
721	/**
722	* Hhelper function to register self components upon start-up
723	* of the out-of-proc server.
724	*/
725	static nsresult
726	RegisterSelfComponents (nsIComponentRegistrar *registrar,
727	const nsModuleComponentInfoEx *components,
728	PRUint32 count)
729	{
730	nsresult rc = NS_OK;
731	const nsModuleComponentInfoEx *info = components;
732	for (PRUint32 i = 0; i < count && NS_SUCCEEDED (rc); i++, info++)
733	{
734	/* skip components w/o a constructor */
735	if (!info->mConstructor) continue;
736	/* create a new generic factory for a component and register it */
737	nsIGenericFactory *factory;
738	rc = NS_NewGenericFactoryEx (&factory, info);
739	if (NS_SUCCEEDED (rc))
740	{
741	rc = registrar->RegisterFactory (info->mCID,
742	info->mDescription,
743	info->mContractID,
744	factory);
745	factory->Release();
746	}
747	}
748	return rc;
749	}
750
751	/////////////////////////////////////////////////////////////////////////////
752
753	static ipcIService *gIpcServ = nsnull;
754	static char *pszPidFile = NULL;
755
756	class ForceQuitEvent : public MyEvent
757	{
758	void *handler()
759	{
760	LogFlowFunc (("\n"));
761
762	gKeepRunning = PR_FALSE;
763
764	if (pszPidFile)
765	RTFileDelete(pszPidFile);
766
767	return NULL;
768	}
769	};
770
771	static void signal_handler (int sig)
772	{
773	if (gEventQ && gKeepRunning)
774	{
775	/* post a quit event to the queue */
776	ForceQuitEvent *ev = new ForceQuitEvent();
777	ev->postTo (gEventQ);
778	}
779	}
780
781	#if defined(USE_BACKTRACE)
782	/**
783	* the signal handler that prints out a backtrace of the call stack.
784	* the code is taken from http://www.linuxjournal.com/article/6391.
785	*/
786	static void bt_sighandler (int sig, siginfo_t info, void secret)
787	{
788
789	void *trace[16];
790	char messages = (char )NULL;
791	int i, trace_size = 0;
792	ucontext_t uc = (ucontext_t )secret;
793
794	// Do something useful with siginfo_t
795	if (sig == SIGSEGV)
796	Log (("Got signal %d, faulty address is %p, from %p\n",
797	sig, info->si_addr, uc->uc_mcontext.gregs[REG_PC]));
798	else
799	Log (("Got signal %d\n", sig));
800
801	trace_size = backtrace (trace, 16);
802	// overwrite sigaction with caller's address
803	trace[1] = (void *) uc->uc_mcontext.gregs [REG_PC];
804
805	messages = backtrace_symbols (trace, trace_size);
806	// skip first stack frame (points here)
807	Log (("[bt] Execution path:\n"));
808	for (i = 1; i < trace_size; ++i)
809	Log (("[bt] %s\n", messages[i]));
810
811	exit (0);
812	}
813	#endif
814
815	int main (int argc, char **argv)
816	{
817	const struct option options[] =
818	{
819	{ "automate", no_argument, NULL, 'a' },
820	#ifdef RT_OS_DARWIN
821	{ "auto-shutdown", no_argument, NULL, 'A' },
822	#endif
823	{ "daemonize", no_argument, NULL, 'd' },
824	{ "pidfile", required_argument, NULL, 'p' },
825	#ifdef RT_OS_DARWIN
826	{ "pipe", required_argument, NULL, 'P' },
827	#endif
828	{ NULL, 0, NULL, 0 }
829	};
830	int c;
831
832	bool fDaemonize = false;
833	#ifndef RT_OS_OS2
834	static int daemon_pipe_fds[2] = {-1, -1};
835	#endif
836
837	for (;;)
838	{
839	c = getopt_long(argc, argv, "", options, NULL);
840	if (c == -1)
841	break;
842	switch (c)
843	{
844	case 'a':
845	{
846	/* --automate mode means we are started by XPCOM on
847	* demand. Daemonize ourselves and activate
848	* auto-shutdown. */
849	gAutoShutdown = true;
850	fDaemonize = true;
851	break;
852	}
853
854	#ifdef RT_OS_DARWIN
855	/* Used together with '-P', see below. Internal use only. */
856	case 'A':
857	{
858	gAutoShutdown = true;
859	break;
860	}
861	#endif
862
863	case 'd':
864	{
865	fDaemonize = true;
866	break;
867	}
868
869	case 'p':
870	{
871	pszPidFile = optarg;
872	break;
873	}
874
875	#ifdef RT_OS_DARWIN
876	/* we need to exec on darwin, this is just an internal
877	* hack for passing the pipe fd along to the final child. */
878	case 'P':
879	{
880	daemon_pipe_fds[1] = atoi(optarg);
881	break;
882	}
883	#endif
884
885	default:
886	{
887	/* exit on invalid options */
888	return 1;
889	}
890	}
891	}
892
893	static RTFILE pidFile = NIL_RTFILE;
894
895	#ifdef RT_OS_OS2
896
897	/* nothing to do here, the process is supposed to be already
898	* started daemonized when it is necessary */
899	NOREF(fDaemonize);
900
901	#else // ifdef RT_OS_OS2
902
903	if (fDaemonize)
904	{
905	/* create a pipe for communication between child and parent */
906	if (pipe(daemon_pipe_fds) < 0)
907	{
908	printf("ERROR: pipe() failed (errno = %d)\n", errno);
909	return 1;
910	}
911
912	pid_t childpid = fork();
913	if (childpid == -1)
914	{
915	printf("ERROR: fork() failed (errno = %d)\n", errno);
916	return 1;
917	}
918
919	if (childpid != 0)
920	{
921	/* we're the parent process */
922	bool fSuccess = false;
923
924	/* close the writing end of the pipe */
925	close(daemon_pipe_fds[1]);
926
927	/* try to read a message from the pipe */
928	char msg[10] = {0}; /* initialize so it's NULL terminated */
929	if (read(daemon_pipe_fds[0], msg, sizeof(msg)) > 0)
930	{
931	if (strcmp(msg, "READY") == 0)
932	fSuccess = true;
933	else
934	printf ("ERROR: Unknown message from child "
935	"process (%s)\n", msg);
936	}
937	else
938	printf ("ERROR: 0 bytes read from child process\n");
939
940	/* close the reading end of the pipe as well and exit */
941	close(daemon_pipe_fds[0]);
942	return fSuccess ? 0 : 1;
943	}
944	/* we're the child process */
945
946	/* Create a new SID for the child process */
947	pid_t sid = setsid();
948	if (sid < 0)
949	{
950	printf("ERROR: setsid() failed (errno = %d)\n", errno);
951	return 1;
952	}
953
954	/* Need to do another for to get rid of the session leader status.
955	* Otherwise any accidentally opened tty will automatically become a
956	* controlling tty for the daemon process. */
957	childpid = fork();
958	if (childpid == -1)
959	{
960	printf("ERROR: second fork() failed (errno = %d)\n", errno);
961	return 1;
962	}
963
964	if (childpid != 0)
965	{
966	/* we're the parent process, just a dummy so terminate now */
967	exit(0);
968	}
969
970	/* Redirect standard i/o streams to /dev/null */
971	if (daemon_pipe_fds[0] > 2)
972	{
973	freopen ("/dev/null", "r", stdin);
974	freopen ("/dev/null", "w", stdout);
975	freopen ("/dev/null", "w", stderr);
976	}
977
978	/* close the reading end of the pipe */
979	close(daemon_pipe_fds[0]);
980
981	# ifdef RT_OS_DARWIN
982	/*
983	* On leopard we're no longer allowed to use some of the core API's
984	* after forking - this will cause us to hit an int3.
985	* So, we'll have to execv VBoxSVC once again and hand it the pipe
986	* and all other relevant options.
987	*/
988	const char *apszArgs[7];
989	unsigned i = 0;
990	apszArgs[i++] = argv[0];
991	apszArgs[i++] = "--pipe";
992	char szPipeArg[32];
993	RTStrPrintf (szPipeArg, sizeof (szPipeArg), "%d", daemon_pipe_fds[1]);
994	apszArgs[i++] = szPipeArg;
995	if (pszPidFile)
996	{
997	apszArgs[i++] = "--pidfile";
998	apszArgs[i++] = pszPidFile;
999	}
1000	if (gAutoShutdown)
1001	apszArgs[i++] = "--auto-shutdown";
1002	apszArgs[i++] = NULL; Assert(i <= RT_ELEMENTS(apszArgs));
1003	execv (apszArgs[0], (char * const *)apszArgs);
1004	exit (0);
1005	# endif
1006	}
1007
1008	#endif // ifdef RT_OS_OS2
1009
1010	#if defined(USE_BACKTRACE)
1011	{
1012	/* install our signal handler to backtrace the call stack */
1013	struct sigaction sa;
1014	sa.sa_sigaction = bt_sighandler;
1015	sigemptyset (&sa.sa_mask);
1016	sa.sa_flags = SA_RESTART \| SA_SIGINFO;
1017	sigaction (SIGSEGV, &sa, NULL);
1018	sigaction (SIGBUS, &sa, NULL);
1019	sigaction (SIGUSR1, &sa, NULL);
1020	}
1021	#endif
1022
1023	/*
1024	* Initialize the VBox runtime without loading
1025	* the support driver
1026	*/
1027	RTR3Init();
1028
1029	nsresult rc;
1030
1031	do
1032	{
1033	rc = com::Initialize();
1034	if (NS_FAILED (rc))
1035	{
1036	printf ("ERROR: Failed to initialize XPCOM! (rc=%08X)\n", rc);
1037	break;
1038	}
1039
1040	nsCOMPtr <nsIComponentRegistrar> registrar;
1041	rc = NS_GetComponentRegistrar (getter_AddRefs (registrar));
1042	if (NS_FAILED (rc))
1043	{
1044	printf ("ERROR: Failed to get component registrar! (rc=%08X)\n", rc);
1045	break;
1046	}
1047
1048	registrar->AutoRegister (nsnull);
1049	rc = RegisterSelfComponents (registrar, components,
1050	NS_ARRAY_LENGTH (components));
1051	if (NS_FAILED (rc))
1052	{
1053	printf ("ERROR: Failed to register server components! (rc=%08X)\n", rc);
1054	break;
1055	}
1056
1057	/* get the main thread's event queue (afaik, the dconnect service always
1058	* gets created upon XPCOM startup, so it will use the main (this)
1059	* thread's event queue to receive IPC events) */
1060	rc = NS_GetMainEventQ (&gEventQ);
1061	if (NS_FAILED (rc))
1062	{
1063	printf ("ERROR: Failed to get the main event queue! (rc=%08X)\n", rc);
1064	break;
1065	}
1066
1067	nsCOMPtr<ipcIService> ipcServ (do_GetService(IPC_SERVICE_CONTRACTID, &rc));
1068	if (NS_FAILED (rc))
1069	{
1070	printf ("ERROR: Failed to get IPC service! (rc=%08X)\n", rc);
1071	break;
1072	}
1073
1074	NS_ADDREF (gIpcServ = ipcServ);
1075
1076	LogFlowFunc (("Will use \"%s\" as server name.\n", VBOXSVC_IPC_NAME));
1077
1078	rc = gIpcServ->AddName (VBOXSVC_IPC_NAME);
1079	if (NS_FAILED (rc))
1080	{
1081	LogFlowFunc (("Failed to register the server name (rc=%08X)!\n"
1082	"Is another server already running?\n", rc));
1083
1084	printf ("ERROR: Failed to register the server name \"%s\" (rc=%08X)!\n"
1085	"Is another server already running?\n",
1086	VBOXSVC_IPC_NAME, rc);
1087	NS_RELEASE (gIpcServ);
1088	break;
1089	}
1090
1091	{
1092	/* setup signal handling to convert some signals to a quit event */
1093	struct sigaction sa;
1094	sa.sa_handler = signal_handler;
1095	sigemptyset (&sa.sa_mask);
1096	sa.sa_flags = 0;
1097	sigaction (SIGINT, &sa, NULL);
1098	sigaction (SIGQUIT, &sa, NULL);
1099	sigaction (SIGTERM, &sa, NULL);
1100	sigaction (SIGTRAP, &sa, NULL);
1101	}
1102
1103	{
1104	char szBuf[80];
1105	int iSize;
1106
1107	iSize = snprintf (szBuf, sizeof(szBuf),
1108	"Sun xVM VirtualBox XPCOM Server Version "
1109	VBOX_VERSION_STRING);
1110	for (int i=iSize; i>0; i--)
1111	putchar('*');
1112	printf ("\n%s\n", szBuf);
1113	printf ("(C) 2008 Sun Microsystems, Inc.\n"
1114	"All rights reserved.\n");
1115	#ifdef DEBUG
1116	printf ("Debug version.\n");
1117	#endif
1118	#if 0
1119	/* in my opinion two lines enclosing the text look better */
1120	for (int i=iSize; i>0; i--)
1121	putchar('*');
1122	putchar('\n');
1123	#endif
1124	}
1125
1126	#ifndef RT_OS_OS2
1127	if (daemon_pipe_fds[1] >= 0)
1128	{
1129	printf ("\nStarting event loop....\n[send TERM signal to quit]\n");
1130	/* now we're ready, signal the parent process */
1131	write(daemon_pipe_fds[1], "READY", strlen("READY"));
1132	}
1133	else
1134	#endif
1135	{
1136	printf ("\nStarting event loop....\n[press Ctrl-C to quit]\n");
1137	}
1138
1139	if (pszPidFile)
1140	{
1141	char szBuf[32];
1142	const char *lf = "\n";
1143	RTFileOpen(&pidFile, pszPidFile, RTFILE_O_WRITE \| RTFILE_O_CREATE_REPLACE);
1144	RTStrFormatNumber(szBuf, getpid(), 10, 0, 0, 0);
1145	RTFileWrite(pidFile, szBuf, strlen(szBuf), NULL);
1146	RTFileWrite(pidFile, lf, strlen(lf), NULL);
1147	RTFileClose(pidFile);
1148	}
1149
1150	PLEvent *ev;
1151	while (gKeepRunning)
1152	{
1153	gEventQ->WaitForEvent (&ev);
1154	gEventQ->HandleEvent (ev);
1155	}
1156
1157	gIpcServ->RemoveName (VBOXSVC_IPC_NAME);
1158
1159	/* stop accepting new events */
1160	gEventQ->StopAcceptingEvents();
1161
1162	/* process any remaining events */
1163	gEventQ->ProcessPendingEvents();
1164
1165	printf ("Terminated event loop.\n");
1166	}
1167	while (0); // this scopes the nsCOMPtrs
1168
1169	NS_IF_RELEASE (gIpcServ);
1170	NS_IF_RELEASE (gEventQ);
1171
1172	/* no nsCOMPtrs are allowed to be alive when you call com::Shutdown(). */
1173
1174	LogFlowFunc (("Calling com::Shutdown()...\n"));
1175	rc = com::Shutdown();
1176	LogFlowFunc (("Finished com::Shutdown() (rc=%08X)\n", rc));
1177
1178	if (NS_FAILED (rc))
1179	printf ("ERROR: Failed to shutdown XPCOM! (rc=%08X)\n", rc);
1180
1181	printf ("XPCOM server has shutdown.\n");
1182
1183	if (pszPidFile)
1184	{
1185	RTFileDelete(pszPidFile);
1186	}
1187
1188	#ifndef RT_OS_OS2
1189	if (daemon_pipe_fds[1] >= 0)
1190	{
1191	/* close writing end of the pipe as well */
1192	close(daemon_pipe_fds[1]);
1193	}
1194	#endif
1195
1196	return 0;
1197	}

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

source: vbox/trunk/src/VBox/Main/xpcom/server.cpp@ 13835

Download in other formats: