1 | /* $Id: server.cpp 65420 2017-01-24 12:08:25Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * XPCOM server process (VBoxSVC) start point.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2004-2017 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 | #include <ipcIService.h>
|
---|
19 | #include <ipcCID.h>
|
---|
20 |
|
---|
21 | #include <nsIComponentRegistrar.h>
|
---|
22 |
|
---|
23 | #include <nsGenericFactory.h>
|
---|
24 |
|
---|
25 | #include "prio.h"
|
---|
26 | #include "prproces.h"
|
---|
27 |
|
---|
28 | #include "server.h"
|
---|
29 |
|
---|
30 | #include "Logging.h"
|
---|
31 |
|
---|
32 | #include <VBox/param.h>
|
---|
33 |
|
---|
34 | #include <iprt/buildconfig.h>
|
---|
35 | #include <iprt/initterm.h>
|
---|
36 | #include <iprt/critsect.h>
|
---|
37 | #include <iprt/getopt.h>
|
---|
38 | #include <iprt/message.h>
|
---|
39 | #include <iprt/string.h>
|
---|
40 | #include <iprt/stream.h>
|
---|
41 | #include <iprt/path.h>
|
---|
42 | #include <iprt/timer.h>
|
---|
43 | #include <iprt/env.h>
|
---|
44 |
|
---|
45 | #include <signal.h> // for the signal handler
|
---|
46 | #include <stdlib.h>
|
---|
47 | #include <unistd.h>
|
---|
48 | #include <errno.h>
|
---|
49 | #include <fcntl.h>
|
---|
50 | #include <sys/stat.h>
|
---|
51 | #include <sys/resource.h>
|
---|
52 |
|
---|
53 | /////////////////////////////////////////////////////////////////////////////
|
---|
54 | // VirtualBox component instantiation
|
---|
55 | /////////////////////////////////////////////////////////////////////////////
|
---|
56 |
|
---|
57 | #include <nsIGenericFactory.h>
|
---|
58 | #include <VirtualBox_XPCOM.h>
|
---|
59 |
|
---|
60 | #include "VBox/com/NativeEventQueue.h"
|
---|
61 |
|
---|
62 | #include "ApplianceImpl.h"
|
---|
63 | #include "AudioAdapterImpl.h"
|
---|
64 | #include "BandwidthControlImpl.h"
|
---|
65 | #include "BandwidthGroupImpl.h"
|
---|
66 | #include "NetworkServiceRunner.h"
|
---|
67 | #include "DHCPServerImpl.h"
|
---|
68 | #include "GuestOSTypeImpl.h"
|
---|
69 | #include "HostImpl.h"
|
---|
70 | #include "HostNetworkInterfaceImpl.h"
|
---|
71 | #include "MachineImpl.h"
|
---|
72 | #include "MediumFormatImpl.h"
|
---|
73 | #include "MediumImpl.h"
|
---|
74 | #include "NATEngineImpl.h"
|
---|
75 | #include "NetworkAdapterImpl.h"
|
---|
76 | #include "ParallelPortImpl.h"
|
---|
77 | #include "ProgressProxyImpl.h"
|
---|
78 | #include "SerialPortImpl.h"
|
---|
79 | #include "SharedFolderImpl.h"
|
---|
80 | #include "SnapshotImpl.h"
|
---|
81 | #include "StorageControllerImpl.h"
|
---|
82 | #include "SystemPropertiesImpl.h"
|
---|
83 | #include "USBControllerImpl.h"
|
---|
84 | #include "USBDeviceFiltersImpl.h"
|
---|
85 | #include "VFSExplorerImpl.h"
|
---|
86 | #include "VirtualBoxImpl.h"
|
---|
87 | #include "VRDEServerImpl.h"
|
---|
88 | #ifdef VBOX_WITH_USB
|
---|
89 | # include "HostUSBDeviceImpl.h"
|
---|
90 | # include "USBDeviceFilterImpl.h"
|
---|
91 | # include "USBDeviceImpl.h"
|
---|
92 | #endif
|
---|
93 | #ifdef VBOX_WITH_EXTPACK
|
---|
94 | # include "ExtPackManagerImpl.h"
|
---|
95 | #endif
|
---|
96 | # include "NATNetworkImpl.h"
|
---|
97 |
|
---|
98 | // This needs to stay - it is needed by the service registration below, and
|
---|
99 | // is defined in the automatically generated VirtualBoxWrap.cpp
|
---|
100 | extern nsIClassInfo *NS_CLASSINFO_NAME(VirtualBoxWrap);
|
---|
101 | NS_DECL_CI_INTERFACE_GETTER(VirtualBoxWrap)
|
---|
102 |
|
---|
103 | ////////////////////////////////////////////////////////////////////////////////
|
---|
104 |
|
---|
105 | static bool gAutoShutdown = false;
|
---|
106 | /** Delay before shutting down the VirtualBox server after the last
|
---|
107 | * VirtualBox instance is released, in ms */
|
---|
108 | static uint32_t gShutdownDelayMs = 5000;
|
---|
109 |
|
---|
110 | static com::NativeEventQueue *gEventQ = NULL;
|
---|
111 | static PRBool volatile gKeepRunning = PR_TRUE;
|
---|
112 | static PRBool volatile gAllowSigUsrQuit = PR_TRUE;
|
---|
113 |
|
---|
114 | /////////////////////////////////////////////////////////////////////////////
|
---|
115 |
|
---|
116 | /**
|
---|
117 | * VirtualBox class factory that destroys the created instance right after
|
---|
118 | * the last reference to it is released by the client, and recreates it again
|
---|
119 | * when necessary (so VirtualBox acts like a singleton object).
|
---|
120 | */
|
---|
121 | class VirtualBoxClassFactory : public VirtualBox
|
---|
122 | {
|
---|
123 | public:
|
---|
124 |
|
---|
125 | virtual ~VirtualBoxClassFactory()
|
---|
126 | {
|
---|
127 | LogFlowFunc(("Deleting VirtualBox...\n"));
|
---|
128 |
|
---|
129 | FinalRelease();
|
---|
130 | sInstance = NULL;
|
---|
131 |
|
---|
132 | LogFlowFunc(("VirtualBox object deleted.\n"));
|
---|
133 | RTPrintf("Informational: VirtualBox object deleted.\n");
|
---|
134 | }
|
---|
135 |
|
---|
136 | NS_IMETHOD_(nsrefcnt) Release()
|
---|
137 | {
|
---|
138 | /* we overload Release() to guarantee the VirtualBox destructor is
|
---|
139 | * always called on the main thread */
|
---|
140 |
|
---|
141 | nsrefcnt count = VirtualBox::Release();
|
---|
142 |
|
---|
143 | if (count == 1)
|
---|
144 | {
|
---|
145 | /* the last reference held by clients is being released
|
---|
146 | * (see GetInstance()) */
|
---|
147 |
|
---|
148 | bool onMainThread = RTThreadIsMain(RTThreadSelf());
|
---|
149 | PRBool timerStarted = PR_FALSE;
|
---|
150 |
|
---|
151 | /* sTimer is null if this call originates from FactoryDestructor()*/
|
---|
152 | if (sTimer != NULL)
|
---|
153 | {
|
---|
154 | LogFlowFunc(("Last VirtualBox instance was released.\n"));
|
---|
155 | LogFlowFunc(("Scheduling server shutdown in %u ms...\n",
|
---|
156 | gShutdownDelayMs));
|
---|
157 |
|
---|
158 | /* make sure the previous timer (if any) is stopped;
|
---|
159 | * otherwise RTTimerStart() will definitely fail. */
|
---|
160 | RTTimerLRStop(sTimer);
|
---|
161 |
|
---|
162 | int vrc = RTTimerLRStart(sTimer, gShutdownDelayMs * RT_NS_1MS_64);
|
---|
163 | AssertRC(vrc);
|
---|
164 | timerStarted = !!(SUCCEEDED(vrc));
|
---|
165 | }
|
---|
166 | else
|
---|
167 | {
|
---|
168 | LogFlowFunc(("Last VirtualBox instance was released "
|
---|
169 | "on XPCOM shutdown.\n"));
|
---|
170 | Assert(onMainThread);
|
---|
171 | }
|
---|
172 |
|
---|
173 | gAllowSigUsrQuit = PR_TRUE;
|
---|
174 |
|
---|
175 | if (!timerStarted)
|
---|
176 | {
|
---|
177 | if (!onMainThread)
|
---|
178 | {
|
---|
179 | /* Failed to start the timer, post the shutdown event
|
---|
180 | * manually if not on the main thread already. */
|
---|
181 | ShutdownTimer(NULL, NULL, 0);
|
---|
182 | }
|
---|
183 | else
|
---|
184 | {
|
---|
185 | /* Here we come if:
|
---|
186 | *
|
---|
187 | * a) gEventQ is 0 which means either FactoryDestructor() is called
|
---|
188 | * or the IPC/DCONNECT shutdown sequence is initiated by the
|
---|
189 | * XPCOM shutdown routine (NS_ShutdownXPCOM()), which always
|
---|
190 | * happens on the main thread.
|
---|
191 | *
|
---|
192 | * b) gEventQ has reported we're on the main thread. This means
|
---|
193 | * that DestructEventHandler() has been called, but another
|
---|
194 | * client was faster and requested VirtualBox again.
|
---|
195 | *
|
---|
196 | * In either case, there is nothing to do.
|
---|
197 | *
|
---|
198 | * Note: case b) is actually no more valid since we don't
|
---|
199 | * call Release() from DestructEventHandler() in this case
|
---|
200 | * any more. Thus, we assert below.
|
---|
201 | */
|
---|
202 |
|
---|
203 | Assert(!gEventQ);
|
---|
204 | }
|
---|
205 | }
|
---|
206 | }
|
---|
207 |
|
---|
208 | return count;
|
---|
209 | }
|
---|
210 |
|
---|
211 | class MaybeQuitEvent : public NativeEvent
|
---|
212 | {
|
---|
213 | public:
|
---|
214 | MaybeQuitEvent() :
|
---|
215 | m_fSignal(false)
|
---|
216 | {
|
---|
217 | }
|
---|
218 |
|
---|
219 | MaybeQuitEvent(bool fSignal) :
|
---|
220 | m_fSignal(fSignal)
|
---|
221 | {
|
---|
222 | }
|
---|
223 |
|
---|
224 | private:
|
---|
225 | /* called on the main thread */
|
---|
226 | void *handler()
|
---|
227 | {
|
---|
228 | LogFlowFuncEnter();
|
---|
229 |
|
---|
230 | Assert(RTCritSectIsInitialized(&sLock));
|
---|
231 |
|
---|
232 | /* stop accepting GetInstance() requests on other threads during
|
---|
233 | * possible destruction */
|
---|
234 | RTCritSectEnter(&sLock);
|
---|
235 |
|
---|
236 | nsrefcnt count = 1;
|
---|
237 |
|
---|
238 | /* sInstance is NULL here if it was deleted immediately after
|
---|
239 | * creation due to initialization error. See GetInstance(). */
|
---|
240 | if (sInstance != NULL)
|
---|
241 | {
|
---|
242 | /* Safe way to get current refcount is by first increasing and
|
---|
243 | * then decreasing. Keep in mind that the Release is overloaded
|
---|
244 | * (see VirtualBoxClassFactory::Release) and will start the
|
---|
245 | * timer again if the returned count is 1. It won't do harm,
|
---|
246 | * but also serves no purpose, so stop it ASAP. */
|
---|
247 | sInstance->AddRef();
|
---|
248 | count = sInstance->Release();
|
---|
249 | if (count == 1)
|
---|
250 | {
|
---|
251 | RTTimerLRStop(sTimer);
|
---|
252 | /* Release the guard reference added in GetInstance() */
|
---|
253 | sInstance->Release();
|
---|
254 | }
|
---|
255 | }
|
---|
256 |
|
---|
257 | if (count == 1)
|
---|
258 | {
|
---|
259 | if (gAutoShutdown || m_fSignal)
|
---|
260 | {
|
---|
261 | Assert(sInstance == NULL);
|
---|
262 | LogFlowFunc(("Terminating the server process...\n"));
|
---|
263 | /* make it leave the event loop */
|
---|
264 | gKeepRunning = PR_FALSE;
|
---|
265 | }
|
---|
266 | else
|
---|
267 | LogFlowFunc(("No automatic shutdown.\n"));
|
---|
268 | }
|
---|
269 | else
|
---|
270 | {
|
---|
271 | /* This condition is quite rare: a new client happened to
|
---|
272 | * connect after this event has been posted to the main queue
|
---|
273 | * but before it started to process it. */
|
---|
274 | LogRel(("Destruction is canceled (refcnt=%d).\n", count));
|
---|
275 | }
|
---|
276 |
|
---|
277 | RTCritSectLeave(&sLock);
|
---|
278 |
|
---|
279 | LogFlowFuncLeave();
|
---|
280 | return NULL;
|
---|
281 | }
|
---|
282 |
|
---|
283 | bool m_fSignal;
|
---|
284 | };
|
---|
285 |
|
---|
286 | static DECLCALLBACK(void) ShutdownTimer(RTTIMERLR hTimerLR, void *pvUser, uint64_t /*iTick*/)
|
---|
287 | {
|
---|
288 | NOREF(hTimerLR);
|
---|
289 | NOREF(pvUser);
|
---|
290 |
|
---|
291 | /* A "too late" event is theoretically possible if somebody
|
---|
292 | * manually ended the server after a destruction has been scheduled
|
---|
293 | * and this method was so lucky that it got a chance to run before
|
---|
294 | * the timer was killed. */
|
---|
295 | com::NativeEventQueue *q = gEventQ;
|
---|
296 | AssertReturnVoid(q);
|
---|
297 |
|
---|
298 | /* post a quit event to the main queue */
|
---|
299 | MaybeQuitEvent *ev = new MaybeQuitEvent(false /* fSignal */);
|
---|
300 | if (!q->postEvent(ev))
|
---|
301 | delete ev;
|
---|
302 |
|
---|
303 | /* A failure above means we've been already stopped (for example
|
---|
304 | * by Ctrl-C). FactoryDestructor() (NS_ShutdownXPCOM())
|
---|
305 | * will do the job. Nothing to do. */
|
---|
306 | }
|
---|
307 |
|
---|
308 | static NS_IMETHODIMP FactoryConstructor()
|
---|
309 | {
|
---|
310 | LogFlowFunc(("\n"));
|
---|
311 |
|
---|
312 | /* create a critsect to protect object construction */
|
---|
313 | if (RT_FAILURE(RTCritSectInit(&sLock)))
|
---|
314 | return NS_ERROR_OUT_OF_MEMORY;
|
---|
315 |
|
---|
316 | int vrc = RTTimerLRCreateEx(&sTimer, 0, 0, ShutdownTimer, NULL);
|
---|
317 | if (RT_FAILURE(vrc))
|
---|
318 | {
|
---|
319 | LogFlowFunc(("Failed to create a timer! (vrc=%Rrc)\n", vrc));
|
---|
320 | return NS_ERROR_FAILURE;
|
---|
321 | }
|
---|
322 |
|
---|
323 | return NS_OK;
|
---|
324 | }
|
---|
325 |
|
---|
326 | static NS_IMETHODIMP FactoryDestructor()
|
---|
327 | {
|
---|
328 | LogFlowFunc(("\n"));
|
---|
329 |
|
---|
330 | RTTimerLRDestroy(sTimer);
|
---|
331 | sTimer = NULL;
|
---|
332 |
|
---|
333 | if (sInstance != NULL)
|
---|
334 | {
|
---|
335 | /* Either posting a destruction event failed for some reason (most
|
---|
336 | * likely, the quit event has been received before the last release),
|
---|
337 | * or the client has terminated abnormally w/o releasing its
|
---|
338 | * VirtualBox instance (so NS_ShutdownXPCOM() is doing a cleanup).
|
---|
339 | * Release the guard reference we added in GetInstance(). */
|
---|
340 | sInstance->Release();
|
---|
341 | }
|
---|
342 |
|
---|
343 | /* Destroy lock after releasing the VirtualBox instance, otherwise
|
---|
344 | * there are races with cleanup. */
|
---|
345 | RTCritSectDelete(&sLock);
|
---|
346 |
|
---|
347 | return NS_OK;
|
---|
348 | }
|
---|
349 |
|
---|
350 | static nsresult GetInstance(VirtualBox **inst)
|
---|
351 | {
|
---|
352 | LogFlowFunc(("Getting VirtualBox object...\n"));
|
---|
353 |
|
---|
354 | RTCritSectEnter(&sLock);
|
---|
355 |
|
---|
356 | if (!gKeepRunning)
|
---|
357 | {
|
---|
358 | LogFlowFunc(("Process termination requested first. Refusing.\n"));
|
---|
359 |
|
---|
360 | RTCritSectLeave(&sLock);
|
---|
361 |
|
---|
362 | /* this rv is what CreateInstance() on the client side returns
|
---|
363 | * when the server process stops accepting events. Do the same
|
---|
364 | * here. The client wrapper should attempt to start a new process in
|
---|
365 | * response to a failure from us. */
|
---|
366 | return NS_ERROR_ABORT;
|
---|
367 | }
|
---|
368 |
|
---|
369 | nsresult rv = NS_OK;
|
---|
370 |
|
---|
371 | if (sInstance == NULL)
|
---|
372 | {
|
---|
373 | LogFlowFunc(("Creating new VirtualBox object...\n"));
|
---|
374 | sInstance = new VirtualBoxClassFactory();
|
---|
375 | if (sInstance != NULL)
|
---|
376 | {
|
---|
377 | /* make an extra AddRef to take the full control
|
---|
378 | * on the VirtualBox destruction (see FinalRelease()) */
|
---|
379 | sInstance->AddRef();
|
---|
380 |
|
---|
381 | sInstance->AddRef(); /* protect FinalConstruct() */
|
---|
382 | rv = sInstance->FinalConstruct();
|
---|
383 | RTPrintf("Informational: VirtualBox object created (rc=%Rhrc).\n", rv);
|
---|
384 | if (NS_FAILED(rv))
|
---|
385 | {
|
---|
386 | /* On failure diring VirtualBox initialization, delete it
|
---|
387 | * immediately on the current thread by releasing all
|
---|
388 | * references in order to properly schedule the server
|
---|
389 | * shutdown. Since the object is fully deleted here, there
|
---|
390 | * is a chance to fix the error and request a new
|
---|
391 | * instantiation before the server terminates. However,
|
---|
392 | * the main reason to maintain the shutdown delay on
|
---|
393 | * failure is to let the front-end completely fetch error
|
---|
394 | * info from a server-side IVirtualBoxErrorInfo object. */
|
---|
395 | sInstance->Release();
|
---|
396 | sInstance->Release();
|
---|
397 | Assert(sInstance == NULL);
|
---|
398 | }
|
---|
399 | else
|
---|
400 | {
|
---|
401 | /* On success, make sure the previous timer is stopped to
|
---|
402 | * cancel a scheduled server termination (if any). */
|
---|
403 | gAllowSigUsrQuit = PR_FALSE;
|
---|
404 | RTTimerLRStop(sTimer);
|
---|
405 | }
|
---|
406 | }
|
---|
407 | else
|
---|
408 | {
|
---|
409 | rv = NS_ERROR_OUT_OF_MEMORY;
|
---|
410 | }
|
---|
411 | }
|
---|
412 | else
|
---|
413 | {
|
---|
414 | LogFlowFunc(("Using existing VirtualBox object...\n"));
|
---|
415 | nsrefcnt count = sInstance->AddRef();
|
---|
416 | Assert(count > 1);
|
---|
417 |
|
---|
418 | if (count >= 2)
|
---|
419 | {
|
---|
420 | LogFlowFunc(("Another client has requested a reference to VirtualBox, canceling destruction...\n"));
|
---|
421 |
|
---|
422 | /* make sure the previous timer is stopped */
|
---|
423 | gAllowSigUsrQuit = PR_FALSE;
|
---|
424 | RTTimerLRStop(sTimer);
|
---|
425 | }
|
---|
426 | }
|
---|
427 |
|
---|
428 | *inst = sInstance;
|
---|
429 |
|
---|
430 | RTCritSectLeave(&sLock);
|
---|
431 |
|
---|
432 | return rv;
|
---|
433 | }
|
---|
434 |
|
---|
435 | private:
|
---|
436 |
|
---|
437 | /* Don't be confused that sInstance is of the *ClassFactory type. This is
|
---|
438 | * actually a singleton instance (*ClassFactory inherits the singleton
|
---|
439 | * class; we combined them just for "simplicity" and used "static" for
|
---|
440 | * factory methods. *ClassFactory here is necessary for a couple of extra
|
---|
441 | * methods. */
|
---|
442 |
|
---|
443 | static VirtualBoxClassFactory *sInstance;
|
---|
444 | static RTCRITSECT sLock;
|
---|
445 |
|
---|
446 | static RTTIMERLR sTimer;
|
---|
447 | };
|
---|
448 |
|
---|
449 | VirtualBoxClassFactory *VirtualBoxClassFactory::sInstance = NULL;
|
---|
450 | RTCRITSECT VirtualBoxClassFactory::sLock;
|
---|
451 |
|
---|
452 | RTTIMERLR VirtualBoxClassFactory::sTimer = NIL_RTTIMERLR;
|
---|
453 |
|
---|
454 | NS_GENERIC_FACTORY_SINGLETON_CONSTRUCTOR_WITH_RC(VirtualBox, VirtualBoxClassFactory::GetInstance)
|
---|
455 |
|
---|
456 | ////////////////////////////////////////////////////////////////////////////////
|
---|
457 |
|
---|
458 | typedef NSFactoryDestructorProcPtr NSFactoryConstructorProcPtr;
|
---|
459 |
|
---|
460 | /**
|
---|
461 | * Enhanced module component information structure.
|
---|
462 | *
|
---|
463 | * nsModuleComponentInfo lacks the factory construction callback, here we add
|
---|
464 | * it. This callback is called straight after a nsGenericFactory instance is
|
---|
465 | * successfully created in RegisterSelfComponents.
|
---|
466 | */
|
---|
467 | struct nsModuleComponentInfoPlusFactoryConstructor
|
---|
468 | {
|
---|
469 | /** standard module component information */
|
---|
470 | const nsModuleComponentInfo *mpModuleComponentInfo;
|
---|
471 | /** (optional) Factory Construction Callback */
|
---|
472 | NSFactoryConstructorProcPtr mFactoryConstructor;
|
---|
473 | };
|
---|
474 |
|
---|
475 | /////////////////////////////////////////////////////////////////////////////
|
---|
476 |
|
---|
477 | /**
|
---|
478 | * Helper function to register self components upon start-up
|
---|
479 | * of the out-of-proc server.
|
---|
480 | */
|
---|
481 | static nsresult
|
---|
482 | RegisterSelfComponents(nsIComponentRegistrar *registrar,
|
---|
483 | const nsModuleComponentInfoPlusFactoryConstructor *aComponents,
|
---|
484 | PRUint32 count)
|
---|
485 | {
|
---|
486 | nsresult rc = NS_OK;
|
---|
487 | const nsModuleComponentInfoPlusFactoryConstructor *info = aComponents;
|
---|
488 | for (PRUint32 i = 0; i < count && NS_SUCCEEDED(rc); i++, info++)
|
---|
489 | {
|
---|
490 | /* skip components w/o a constructor */
|
---|
491 | if (!info->mpModuleComponentInfo->mConstructor)
|
---|
492 | continue;
|
---|
493 | /* create a new generic factory for a component and register it */
|
---|
494 | nsIGenericFactory *factory;
|
---|
495 | rc = NS_NewGenericFactory(&factory, info->mpModuleComponentInfo);
|
---|
496 | if (NS_SUCCEEDED(rc) && info->mFactoryConstructor)
|
---|
497 | {
|
---|
498 | rc = info->mFactoryConstructor();
|
---|
499 | if (NS_FAILED(rc))
|
---|
500 | NS_RELEASE(factory);
|
---|
501 | }
|
---|
502 | if (NS_SUCCEEDED(rc))
|
---|
503 | {
|
---|
504 | rc = registrar->RegisterFactory(info->mpModuleComponentInfo->mCID,
|
---|
505 | info->mpModuleComponentInfo->mDescription,
|
---|
506 | info->mpModuleComponentInfo->mContractID,
|
---|
507 | factory);
|
---|
508 | NS_RELEASE(factory);
|
---|
509 | }
|
---|
510 | }
|
---|
511 | return rc;
|
---|
512 | }
|
---|
513 |
|
---|
514 | /////////////////////////////////////////////////////////////////////////////
|
---|
515 |
|
---|
516 | static ipcIService *gIpcServ = nsnull;
|
---|
517 | static const char *g_pszPidFile = NULL;
|
---|
518 |
|
---|
519 | class ForceQuitEvent : public NativeEvent
|
---|
520 | {
|
---|
521 | void *handler()
|
---|
522 | {
|
---|
523 | LogFlowFunc(("\n"));
|
---|
524 |
|
---|
525 | gKeepRunning = PR_FALSE;
|
---|
526 |
|
---|
527 | if (g_pszPidFile)
|
---|
528 | RTFileDelete(g_pszPidFile);
|
---|
529 |
|
---|
530 | return NULL;
|
---|
531 | }
|
---|
532 | };
|
---|
533 |
|
---|
534 | static void signal_handler(int sig)
|
---|
535 | {
|
---|
536 | com::NativeEventQueue *q = gEventQ;
|
---|
537 | if (q && gKeepRunning)
|
---|
538 | {
|
---|
539 | if (sig == SIGUSR1)
|
---|
540 | {
|
---|
541 | if (gAllowSigUsrQuit)
|
---|
542 | {
|
---|
543 | /* terminate the server process if it is idle */
|
---|
544 | VirtualBoxClassFactory::MaybeQuitEvent *ev = new VirtualBoxClassFactory::MaybeQuitEvent(true /* fSignal */);
|
---|
545 | if (!q->postEvent(ev))
|
---|
546 | delete ev;
|
---|
547 | }
|
---|
548 | /* else do nothing */
|
---|
549 | }
|
---|
550 | else
|
---|
551 | {
|
---|
552 | /* post a force quit event to the queue */
|
---|
553 | ForceQuitEvent *ev = new ForceQuitEvent();
|
---|
554 | if (!q->postEvent(ev))
|
---|
555 | delete ev;
|
---|
556 | }
|
---|
557 | }
|
---|
558 | }
|
---|
559 |
|
---|
560 | static nsresult vboxsvcSpawnDaemonByReExec(const char *pszPath, bool fAutoShutdown, const char *pszPidFile)
|
---|
561 | {
|
---|
562 | PRFileDesc *readable = nsnull, *writable = nsnull;
|
---|
563 | PRProcessAttr *attr = nsnull;
|
---|
564 | nsresult rv = NS_ERROR_FAILURE;
|
---|
565 | PRFileDesc *devNull;
|
---|
566 | unsigned args_index = 0;
|
---|
567 | // The ugly casts are necessary because the PR_CreateProcessDetached has
|
---|
568 | // a const array of writable strings as a parameter. It won't write. */
|
---|
569 | char * args[1 + 1 + 2 + 1];
|
---|
570 | args[args_index++] = (char *)pszPath;
|
---|
571 | if (fAutoShutdown)
|
---|
572 | args[args_index++] = (char *)"--auto-shutdown";
|
---|
573 | if (pszPidFile)
|
---|
574 | {
|
---|
575 | args[args_index++] = (char *)"--pidfile";
|
---|
576 | args[args_index++] = (char *)pszPidFile;
|
---|
577 | }
|
---|
578 | args[args_index++] = 0;
|
---|
579 |
|
---|
580 | // Use a pipe to determine when the daemon process is in the position
|
---|
581 | // to actually process requests. The daemon will write "READY" to the pipe.
|
---|
582 | if (PR_CreatePipe(&readable, &writable) != PR_SUCCESS)
|
---|
583 | goto end;
|
---|
584 | PR_SetFDInheritable(writable, PR_TRUE);
|
---|
585 |
|
---|
586 | attr = PR_NewProcessAttr();
|
---|
587 | if (!attr)
|
---|
588 | goto end;
|
---|
589 |
|
---|
590 | if (PR_ProcessAttrSetInheritableFD(attr, writable, VBOXSVC_STARTUP_PIPE_NAME) != PR_SUCCESS)
|
---|
591 | goto end;
|
---|
592 |
|
---|
593 | devNull = PR_Open("/dev/null", PR_RDWR, 0);
|
---|
594 | if (!devNull)
|
---|
595 | goto end;
|
---|
596 |
|
---|
597 | PR_ProcessAttrSetStdioRedirect(attr, PR_StandardInput, devNull);
|
---|
598 | PR_ProcessAttrSetStdioRedirect(attr, PR_StandardOutput, devNull);
|
---|
599 | PR_ProcessAttrSetStdioRedirect(attr, PR_StandardError, devNull);
|
---|
600 |
|
---|
601 | if (PR_CreateProcessDetached(pszPath, (char * const *)args, nsnull, attr) != PR_SUCCESS)
|
---|
602 | goto end;
|
---|
603 |
|
---|
604 | // Close /dev/null
|
---|
605 | PR_Close(devNull);
|
---|
606 | // Close the child end of the pipe to make it the only owner of the
|
---|
607 | // file descriptor, so that unexpected closing can be detected.
|
---|
608 | PR_Close(writable);
|
---|
609 | writable = nsnull;
|
---|
610 |
|
---|
611 | char msg[10];
|
---|
612 | memset(msg, '\0', sizeof(msg));
|
---|
613 | if ( PR_Read(readable, msg, sizeof(msg)-1) != 5
|
---|
614 | || strcmp(msg, "READY"))
|
---|
615 | goto end;
|
---|
616 |
|
---|
617 | rv = NS_OK;
|
---|
618 |
|
---|
619 | end:
|
---|
620 | if (readable)
|
---|
621 | PR_Close(readable);
|
---|
622 | if (writable)
|
---|
623 | PR_Close(writable);
|
---|
624 | if (attr)
|
---|
625 | PR_DestroyProcessAttr(attr);
|
---|
626 | return rv;
|
---|
627 | }
|
---|
628 |
|
---|
629 | int main(int argc, char **argv)
|
---|
630 | {
|
---|
631 | /*
|
---|
632 | * Initialize the VBox runtime without loading
|
---|
633 | * the support driver
|
---|
634 | */
|
---|
635 | int vrc = RTR3InitExe(argc, &argv, 0);
|
---|
636 | if (RT_FAILURE(vrc))
|
---|
637 | return RTMsgInitFailure(vrc);
|
---|
638 |
|
---|
639 | static const RTGETOPTDEF s_aOptions[] =
|
---|
640 | {
|
---|
641 | { "--automate", 'a', RTGETOPT_REQ_NOTHING },
|
---|
642 | { "--auto-shutdown", 'A', RTGETOPT_REQ_NOTHING },
|
---|
643 | { "--daemonize", 'd', RTGETOPT_REQ_NOTHING },
|
---|
644 | { "--shutdown-delay", 'D', RTGETOPT_REQ_UINT32 },
|
---|
645 | { "--pidfile", 'p', RTGETOPT_REQ_STRING },
|
---|
646 | { "--logfile", 'F', RTGETOPT_REQ_STRING },
|
---|
647 | { "--logrotate", 'R', RTGETOPT_REQ_UINT32 },
|
---|
648 | { "--logsize", 'S', RTGETOPT_REQ_UINT64 },
|
---|
649 | { "--loginterval", 'I', RTGETOPT_REQ_UINT32 }
|
---|
650 | };
|
---|
651 |
|
---|
652 | const char *pszLogFile = NULL;
|
---|
653 | uint32_t cHistory = 10; // enable log rotation, 10 files
|
---|
654 | uint32_t uHistoryFileTime = RT_SEC_1DAY; // max 1 day per file
|
---|
655 | uint64_t uHistoryFileSize = 100 * _1M; // max 100MB per file
|
---|
656 | bool fDaemonize = false;
|
---|
657 | PRFileDesc *daemon_pipe_wr = nsnull;
|
---|
658 |
|
---|
659 | RTGETOPTSTATE GetOptState;
|
---|
660 | vrc = RTGetOptInit(&GetOptState, argc, argv, &s_aOptions[0], RT_ELEMENTS(s_aOptions), 1, 0 /*fFlags*/);
|
---|
661 | AssertRC(vrc);
|
---|
662 |
|
---|
663 | RTGETOPTUNION ValueUnion;
|
---|
664 | while ((vrc = RTGetOpt(&GetOptState, &ValueUnion)))
|
---|
665 | {
|
---|
666 | switch (vrc)
|
---|
667 | {
|
---|
668 | case 'a':
|
---|
669 | /* --automate mode means we are started by XPCOM on
|
---|
670 | * demand. Daemonize ourselves and activate
|
---|
671 | * auto-shutdown. */
|
---|
672 | gAutoShutdown = true;
|
---|
673 | fDaemonize = true;
|
---|
674 | break;
|
---|
675 |
|
---|
676 | case 'A':
|
---|
677 | /* --auto-shutdown mode means we're already daemonized. */
|
---|
678 | gAutoShutdown = true;
|
---|
679 | break;
|
---|
680 |
|
---|
681 | case 'd':
|
---|
682 | fDaemonize = true;
|
---|
683 | break;
|
---|
684 |
|
---|
685 | case 'D':
|
---|
686 | gShutdownDelayMs = ValueUnion.u32;
|
---|
687 | break;
|
---|
688 |
|
---|
689 | case 'p':
|
---|
690 | g_pszPidFile = ValueUnion.psz;
|
---|
691 | break;
|
---|
692 |
|
---|
693 | case 'F':
|
---|
694 | pszLogFile = ValueUnion.psz;
|
---|
695 | break;
|
---|
696 |
|
---|
697 | case 'R':
|
---|
698 | cHistory = ValueUnion.u32;
|
---|
699 | break;
|
---|
700 |
|
---|
701 | case 'S':
|
---|
702 | uHistoryFileSize = ValueUnion.u64;
|
---|
703 | break;
|
---|
704 |
|
---|
705 | case 'I':
|
---|
706 | uHistoryFileTime = ValueUnion.u32;
|
---|
707 | break;
|
---|
708 |
|
---|
709 | case 'h':
|
---|
710 | RTPrintf("no help\n");
|
---|
711 | return RTEXITCODE_SYNTAX;
|
---|
712 |
|
---|
713 | case 'V':
|
---|
714 | RTPrintf("%sr%s\n", RTBldCfgVersion(), RTBldCfgRevisionStr());
|
---|
715 | return RTEXITCODE_SUCCESS;
|
---|
716 |
|
---|
717 | default:
|
---|
718 | return RTGetOptPrintError(vrc, &ValueUnion);
|
---|
719 | }
|
---|
720 | }
|
---|
721 |
|
---|
722 | if (fDaemonize)
|
---|
723 | {
|
---|
724 | vboxsvcSpawnDaemonByReExec(argv[0], gAutoShutdown, g_pszPidFile);
|
---|
725 | exit(126);
|
---|
726 | }
|
---|
727 |
|
---|
728 | nsresult rc;
|
---|
729 |
|
---|
730 | /** @todo Merge this code with svcmain.cpp (use Logging.cpp?). */
|
---|
731 | char szLogFile[RTPATH_MAX];
|
---|
732 | if (!pszLogFile)
|
---|
733 | {
|
---|
734 | vrc = com::GetVBoxUserHomeDirectory(szLogFile, sizeof(szLogFile));
|
---|
735 | if (RT_SUCCESS(vrc))
|
---|
736 | vrc = RTPathAppend(szLogFile, sizeof(szLogFile), "VBoxSVC.log");
|
---|
737 | }
|
---|
738 | else
|
---|
739 | {
|
---|
740 | if (!RTStrPrintf(szLogFile, sizeof(szLogFile), "%s", pszLogFile))
|
---|
741 | vrc = VERR_NO_MEMORY;
|
---|
742 | }
|
---|
743 | if (RT_FAILURE(vrc))
|
---|
744 | return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to create logging file name, rc=%Rrc", vrc);
|
---|
745 |
|
---|
746 | char szError[RTPATH_MAX + 128];
|
---|
747 | vrc = com::VBoxLogRelCreate("XPCOM Server", szLogFile,
|
---|
748 | RTLOGFLAGS_PREFIX_THREAD | RTLOGFLAGS_PREFIX_TIME_PROG,
|
---|
749 | VBOXSVC_LOG_DEFAULT, "VBOXSVC_RELEASE_LOG",
|
---|
750 | RTLOGDEST_FILE, UINT32_MAX /* cMaxEntriesPerGroup */,
|
---|
751 | cHistory, uHistoryFileTime, uHistoryFileSize,
|
---|
752 | szError, sizeof(szError));
|
---|
753 | if (RT_FAILURE(vrc))
|
---|
754 | return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to open release log (%s, %Rrc)", szError, vrc);
|
---|
755 |
|
---|
756 | /* Set up a build identifier so that it can be seen from core dumps what
|
---|
757 | * exact build was used to produce the core. Same as in Console::i_powerUpThread(). */
|
---|
758 | static char saBuildID[48];
|
---|
759 | RTStrPrintf(saBuildID, sizeof(saBuildID), "%s%s%s%s VirtualBox %s r%u %s%s%s%s",
|
---|
760 | "BU", "IL", "DI", "D", RTBldCfgVersion(), RTBldCfgRevision(), "BU", "IL", "DI", "D");
|
---|
761 |
|
---|
762 | daemon_pipe_wr = PR_GetInheritedFD(VBOXSVC_STARTUP_PIPE_NAME);
|
---|
763 | RTEnvUnset("NSPR_INHERIT_FDS");
|
---|
764 |
|
---|
765 | const nsModuleComponentInfo VirtualBoxInfo = {
|
---|
766 | "VirtualBox component",
|
---|
767 | NS_VIRTUALBOX_CID,
|
---|
768 | NS_VIRTUALBOX_CONTRACTID,
|
---|
769 | VirtualBoxConstructor, // constructor function
|
---|
770 | NULL, // registration function
|
---|
771 | NULL, // deregistration function
|
---|
772 | VirtualBoxClassFactory::FactoryDestructor, // factory destructor function
|
---|
773 | NS_CI_INTERFACE_GETTER_NAME(VirtualBoxWrap),
|
---|
774 | NULL, // language helper
|
---|
775 | &NS_CLASSINFO_NAME(VirtualBoxWrap),
|
---|
776 | 0 // flags
|
---|
777 | };
|
---|
778 |
|
---|
779 | const nsModuleComponentInfoPlusFactoryConstructor components[] = {
|
---|
780 | {
|
---|
781 | &VirtualBoxInfo,
|
---|
782 | VirtualBoxClassFactory::FactoryConstructor // factory constructor function
|
---|
783 | }
|
---|
784 | };
|
---|
785 |
|
---|
786 | do /* goto avoidance only */
|
---|
787 | {
|
---|
788 | rc = com::Initialize();
|
---|
789 | if (NS_FAILED(rc))
|
---|
790 | {
|
---|
791 | RTMsgError("Failed to initialize XPCOM! (rc=%Rhrc)\n", rc);
|
---|
792 | break;
|
---|
793 | }
|
---|
794 |
|
---|
795 | nsCOMPtr<nsIComponentRegistrar> registrar;
|
---|
796 | rc = NS_GetComponentRegistrar(getter_AddRefs(registrar));
|
---|
797 | if (NS_FAILED(rc))
|
---|
798 | {
|
---|
799 | RTMsgError("Failed to get component registrar! (rc=%Rhrc)", rc);
|
---|
800 | break;
|
---|
801 | }
|
---|
802 |
|
---|
803 | registrar->AutoRegister(nsnull);
|
---|
804 | rc = RegisterSelfComponents(registrar, components,
|
---|
805 | NS_ARRAY_LENGTH(components));
|
---|
806 | if (NS_FAILED(rc))
|
---|
807 | {
|
---|
808 | RTMsgError("Failed to register server components! (rc=%Rhrc)", rc);
|
---|
809 | break;
|
---|
810 | }
|
---|
811 |
|
---|
812 | nsCOMPtr<ipcIService> ipcServ(do_GetService(IPC_SERVICE_CONTRACTID, &rc));
|
---|
813 | if (NS_FAILED(rc))
|
---|
814 | {
|
---|
815 | RTMsgError("Failed to get IPC service! (rc=%Rhrc)", rc);
|
---|
816 | break;
|
---|
817 | }
|
---|
818 |
|
---|
819 | NS_ADDREF(gIpcServ = ipcServ);
|
---|
820 |
|
---|
821 | LogFlowFunc(("Will use \"%s\" as server name.\n", VBOXSVC_IPC_NAME));
|
---|
822 |
|
---|
823 | rc = gIpcServ->AddName(VBOXSVC_IPC_NAME);
|
---|
824 | if (NS_FAILED(rc))
|
---|
825 | {
|
---|
826 | LogFlowFunc(("Failed to register the server name (rc=%Rhrc (%08X))!\n"
|
---|
827 | "Is another server already running?\n", rc, rc));
|
---|
828 |
|
---|
829 | RTMsgError("Failed to register the server name \"%s\" (rc=%Rhrc)!\n"
|
---|
830 | "Is another server already running?\n",
|
---|
831 | VBOXSVC_IPC_NAME, rc);
|
---|
832 | NS_RELEASE(gIpcServ);
|
---|
833 | break;
|
---|
834 | }
|
---|
835 |
|
---|
836 | {
|
---|
837 | /* setup signal handling to convert some signals to a quit event */
|
---|
838 | struct sigaction sa;
|
---|
839 | sa.sa_handler = signal_handler;
|
---|
840 | sigemptyset(&sa.sa_mask);
|
---|
841 | sa.sa_flags = 0;
|
---|
842 | sigaction(SIGINT, &sa, NULL);
|
---|
843 | sigaction(SIGQUIT, &sa, NULL);
|
---|
844 | sigaction(SIGTERM, &sa, NULL);
|
---|
845 | // XXX Temporary allow release assertions to terminate VBoxSVC
|
---|
846 | // sigaction(SIGTRAP, &sa, NULL);
|
---|
847 | sigaction(SIGUSR1, &sa, NULL);
|
---|
848 | }
|
---|
849 |
|
---|
850 | {
|
---|
851 | char szBuf[80];
|
---|
852 | size_t cSize;
|
---|
853 |
|
---|
854 | cSize = RTStrPrintf(szBuf, sizeof(szBuf),
|
---|
855 | VBOX_PRODUCT" XPCOM Server Version "
|
---|
856 | VBOX_VERSION_STRING);
|
---|
857 | for (size_t i = cSize; i > 0; i--)
|
---|
858 | putchar('*');
|
---|
859 | RTPrintf("\n%s\n", szBuf);
|
---|
860 | RTPrintf("(C) 2004-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
|
---|
861 | "All rights reserved.\n");
|
---|
862 | #ifdef DEBUG
|
---|
863 | RTPrintf("Debug version.\n");
|
---|
864 | #endif
|
---|
865 | }
|
---|
866 |
|
---|
867 | if (daemon_pipe_wr != nsnull)
|
---|
868 | {
|
---|
869 | RTPrintf("\nStarting event loop....\n[send TERM signal to quit]\n");
|
---|
870 | /* now we're ready, signal the parent process */
|
---|
871 | PR_Write(daemon_pipe_wr, RT_STR_TUPLE("READY"));
|
---|
872 | /* close writing end of the pipe, its job is done */
|
---|
873 | PR_Close(daemon_pipe_wr);
|
---|
874 | }
|
---|
875 | else
|
---|
876 | RTPrintf("\nStarting event loop....\n[press Ctrl-C to quit]\n");
|
---|
877 |
|
---|
878 | if (g_pszPidFile)
|
---|
879 | {
|
---|
880 | RTFILE hPidFile = NIL_RTFILE;
|
---|
881 | vrc = RTFileOpen(&hPidFile, g_pszPidFile, RTFILE_O_WRITE | RTFILE_O_CREATE_REPLACE | RTFILE_O_DENY_NONE);
|
---|
882 | if (RT_SUCCESS(vrc))
|
---|
883 | {
|
---|
884 | char szBuf[32];
|
---|
885 | const char *lf = "\n";
|
---|
886 | RTStrFormatNumber(szBuf, getpid(), 10, 0, 0, 0);
|
---|
887 | RTFileWrite(hPidFile, szBuf, strlen(szBuf), NULL);
|
---|
888 | RTFileWrite(hPidFile, lf, strlen(lf), NULL);
|
---|
889 | RTFileClose(hPidFile);
|
---|
890 | }
|
---|
891 | }
|
---|
892 |
|
---|
893 | // Increase the file table size to 10240 or as high as possible.
|
---|
894 | struct rlimit lim;
|
---|
895 | if (getrlimit(RLIMIT_NOFILE, &lim) == 0)
|
---|
896 | {
|
---|
897 | if ( lim.rlim_cur < 10240
|
---|
898 | && lim.rlim_cur < lim.rlim_max)
|
---|
899 | {
|
---|
900 | lim.rlim_cur = RT_MIN(lim.rlim_max, 10240);
|
---|
901 | if (setrlimit(RLIMIT_NOFILE, &lim) == -1)
|
---|
902 | RTPrintf("WARNING: failed to increase file descriptor limit. (%d)\n", errno);
|
---|
903 | }
|
---|
904 | }
|
---|
905 | else
|
---|
906 | RTPrintf("WARNING: failed to obtain per-process file-descriptor limit (%d).\n", errno);
|
---|
907 |
|
---|
908 | /* get the main thread's event queue */
|
---|
909 | gEventQ = com::NativeEventQueue::getMainEventQueue();
|
---|
910 | if (!gEventQ)
|
---|
911 | {
|
---|
912 | RTMsgError("Failed to get the main event queue! (rc=%Rhrc)", rc);
|
---|
913 | break;
|
---|
914 | }
|
---|
915 |
|
---|
916 | while (gKeepRunning)
|
---|
917 | {
|
---|
918 | vrc = gEventQ->processEventQueue(RT_INDEFINITE_WAIT);
|
---|
919 | if (RT_FAILURE(vrc) && vrc != VERR_TIMEOUT)
|
---|
920 | {
|
---|
921 | LogRel(("Failed to wait for events! (rc=%Rrc)", vrc));
|
---|
922 | break;
|
---|
923 | }
|
---|
924 | }
|
---|
925 |
|
---|
926 | gEventQ = NULL;
|
---|
927 | RTPrintf("Terminated event loop.\n");
|
---|
928 |
|
---|
929 | /* unregister ourselves. After this point, clients will start a new
|
---|
930 | * process because they won't be able to resolve the server name.*/
|
---|
931 | gIpcServ->RemoveName(VBOXSVC_IPC_NAME);
|
---|
932 | }
|
---|
933 | while (0); // this scopes the nsCOMPtrs
|
---|
934 |
|
---|
935 | NS_IF_RELEASE(gIpcServ);
|
---|
936 |
|
---|
937 | /* no nsCOMPtrs are allowed to be alive when you call com::Shutdown(). */
|
---|
938 |
|
---|
939 | LogFlowFunc(("Calling com::Shutdown()...\n"));
|
---|
940 | rc = com::Shutdown();
|
---|
941 | LogFlowFunc(("Finished com::Shutdown() (rc=%Rhrc)\n", rc));
|
---|
942 |
|
---|
943 | if (NS_FAILED(rc))
|
---|
944 | RTMsgError("Failed to shutdown XPCOM! (rc=%Rhrc)", rc);
|
---|
945 |
|
---|
946 | RTPrintf("XPCOM server has shutdown.\n");
|
---|
947 |
|
---|
948 | if (g_pszPidFile)
|
---|
949 | RTFileDelete(g_pszPidFile);
|
---|
950 |
|
---|
951 | return RTEXITCODE_SUCCESS;
|
---|
952 | }
|
---|