VirtualBox

source: vbox/trunk/src/VBox/Main/src-server/xpcom/server_module.cpp@ 37666

Last change on this file since 37666 was 37666, checked in by vboxsync, 14 years ago

Main/VBoxSVC: add release logging, with conservative log rotation settings enabled by default
  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Revision Author Id
File size: 11.0 KB
Line 
1/** @file
2 *
3 * XPCOM server process helper module implementation functions
4 */
5
6/*
7 * Copyright (C) 2006-2011 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#ifdef RT_OS_OS2
19# include <prproces.h>
20#endif
21
22#include <nsMemory.h>
23#include <nsString.h>
24#include <nsCOMPtr.h>
25#include <nsIFile.h>
26#include <nsIGenericFactory.h>
27#include <nsIServiceManagerUtils.h>
28#include <nsICategoryManager.h>
29#include <nsDirectoryServiceDefs.h>
30
31#include <ipcIService.h>
32#include <ipcIDConnectService.h>
33#include <ipcCID.h>
34#include <ipcdclient.h>
35
36#include "prio.h"
37#include "prproces.h"
38
39// official XPCOM headers don't define it yet
40#define IPC_DCONNECTSERVICE_CONTRACTID \
41 "@mozilla.org/ipc/dconnect-service;1"
42
43// generated file
44#include <VirtualBox_XPCOM.h>
45
46#include "server.h"
47#include "Logging.h"
48
49#include <VBox/err.h>
50
51#include <iprt/assert.h>
52#include <iprt/param.h>
53#include <iprt/path.h>
54#include <iprt/process.h>
55#include <iprt/env.h>
56#include <iprt/thread.h>
57
58#include <string.h>
59
60#if defined(RT_OS_SOLARIS)
61# include <sys/systeminfo.h>
62#endif
63
64/// @todo move this to RT headers (and use them in MachineImpl.cpp as well)
65#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
66#define HOSTSUFF_EXE ".exe"
67#else /* !RT_OS_WINDOWS */
68#define HOSTSUFF_EXE ""
69#endif /* !RT_OS_WINDOWS */
70
71
72/** Name of the server executable. */
73const char VBoxSVC_exe[] = RTPATH_SLASH_STR "VBoxSVC" HOSTSUFF_EXE;
74
75enum
76{
77 /** Amount of time to wait for the server to establish a connection, ms */
78 VBoxSVC_Timeout = 30000,
79 /** How often to perform a connection check, ms */
80 VBoxSVC_WaitSlice = 100
81};
82
83/**
84 * Full path to the VBoxSVC executable.
85 */
86static char VBoxSVCPath[RTPATH_MAX];
87static bool IsVBoxSVCPathSet = false;
88
89/*
90 * The following macros define the method necessary to provide a list of
91 * interfaces implemented by the VirtualBox component. Note that this must be
92 * in sync with macros used for VirtualBox in server.cpp for the same purpose.
93 */
94
95NS_DECL_CLASSINFO (VirtualBox)
96NS_IMPL_CI_INTERFACE_GETTER1 (VirtualBox, IVirtualBox)
97
98static nsresult vboxsvcSpawnDaemon(void)
99{
100 PRFileDesc *readable = nsnull, *writable = nsnull;
101 PRProcessAttr *attr = nsnull;
102 nsresult rv = NS_ERROR_FAILURE;
103 PRFileDesc *devNull;
104 // The ugly casts are necessary because the PR_CreateProcessDetached has
105 // a const array of writable strings as a parameter. It won't write. */
106 char * const args[] = { (char *)VBoxSVCPath, (char *)"--auto-shutdown", 0 };
107
108 // Use a pipe to determine when the daemon process is in the position
109 // to actually process requests. The daemon will write "READY" to the pipe.
110 if (PR_CreatePipe(&readable, &writable) != PR_SUCCESS)
111 goto end;
112 PR_SetFDInheritable(writable, PR_TRUE);
113
114 attr = PR_NewProcessAttr();
115 if (!attr)
116 goto end;
117
118 if (PR_ProcessAttrSetInheritableFD(attr, writable, VBOXSVC_STARTUP_PIPE_NAME) != PR_SUCCESS)
119 goto end;
120
121 devNull = PR_Open("/dev/null", PR_RDWR, 0);
122 if (!devNull)
123 goto end;
124
125 PR_ProcessAttrSetStdioRedirect(attr, PR_StandardInput, devNull);
126 PR_ProcessAttrSetStdioRedirect(attr, PR_StandardOutput, devNull);
127 PR_ProcessAttrSetStdioRedirect(attr, PR_StandardError, devNull);
128
129 if (PR_CreateProcessDetached(VBoxSVCPath, args, nsnull, attr) != PR_SUCCESS)
130 goto end;
131
132 // Close /dev/null
133 PR_Close(devNull);
134 // Close the child end of the pipe to make it the only owner of the
135 // file descriptor, so that unexpected closing can be detected.
136 PR_Close(writable);
137 writable = nsnull;
138
139 char msg[10];
140 memset(msg, '\0', sizeof(msg));
141 if ( PR_Read(readable, msg, sizeof(msg)-1) != 5
142 || strcmp(msg, "READY"))
143 {
144 /* If several clients start VBoxSVC simultaneously only one can
145 * succeed. So treat this as success as well. */
146 rv = NS_OK;
147 goto end;
148 }
149
150 rv = NS_OK;
151
152end:
153 if (readable)
154 PR_Close(readable);
155 if (writable)
156 PR_Close(writable);
157 if (attr)
158 PR_DestroyProcessAttr(attr);
159 return rv;
160}
161
162
163/**
164 * VirtualBox component constructor.
165 *
166 * This constructor is responsible for starting the VirtualBox server
167 * process, connecting to it, and redirecting the constructor request to the
168 * VirtualBox component defined on the server.
169 */
170static NS_IMETHODIMP
171VirtualBoxConstructor (nsISupports *aOuter, REFNSIID aIID,
172 void **aResult)
173{
174 LogFlowFuncEnter();
175
176 nsresult rc = NS_OK;
177 int vrc = VINF_SUCCESS;
178
179 do
180 {
181 *aResult = NULL;
182 if (NULL != aOuter)
183 {
184 rc = NS_ERROR_NO_AGGREGATION;
185 break;
186 }
187
188 if (!IsVBoxSVCPathSet)
189 {
190 /* Get the directory containing XPCOM components -- the VBoxSVC
191 * executable is expected in the parent directory. */
192 nsCOMPtr <nsIProperties> dirServ = do_GetService (NS_DIRECTORY_SERVICE_CONTRACTID, &rc);
193 if (NS_SUCCEEDED(rc))
194 {
195 nsCOMPtr <nsIFile> componentDir;
196 rc = dirServ->Get (NS_XPCOM_COMPONENT_DIR,
197 NS_GET_IID (nsIFile), getter_AddRefs (componentDir));
198
199 if (NS_SUCCEEDED(rc))
200 {
201 nsCAutoString path;
202 componentDir->GetNativePath (path);
203
204 LogFlowFunc (("component directory = \"%s\"\n", path.get()));
205 AssertBreakStmt (path.Length() + strlen (VBoxSVC_exe) < RTPATH_MAX,
206 rc = NS_ERROR_FAILURE);
207
208#if defined(RT_OS_SOLARIS) && defined(VBOX_WITH_HARDENING)
209 char achKernArch[128];
210 int cbKernArch = sysinfo (SI_ARCHITECTURE_K, achKernArch, sizeof(achKernArch));
211 if (cbKernArch > 0)
212 {
213 sprintf(VBoxSVCPath, "/opt/VirtualBox/%s%s", achKernArch, VBoxSVC_exe);
214 IsVBoxSVCPathSet = true;
215 }
216 else
217 rc = NS_ERROR_UNEXPECTED;
218#else
219 strcpy (VBoxSVCPath, path.get());
220 RTPathStripFilename (VBoxSVCPath);
221 strcat (VBoxSVCPath, VBoxSVC_exe);
222
223 IsVBoxSVCPathSet = true;
224#endif
225 }
226 }
227 if (NS_FAILED(rc))
228 break;
229 }
230
231 nsCOMPtr <ipcIService> ipcServ = do_GetService (IPC_SERVICE_CONTRACTID, &rc);
232 if (NS_FAILED(rc))
233 break;
234
235 /* connect to the VBoxSVC server process */
236
237 bool startedOnce = false;
238 unsigned timeLeft = VBoxSVC_Timeout;
239
240 do
241 {
242 LogFlowFunc (("Resolving server name \"%s\"...\n", VBOXSVC_IPC_NAME));
243
244 PRUint32 serverID = 0;
245 rc = ipcServ->ResolveClientName (VBOXSVC_IPC_NAME, &serverID);
246 if (NS_FAILED(rc))
247 {
248 LogFlowFunc (("Starting server \"%s\"...\n", VBoxSVCPath));
249
250 startedOnce = true;
251
252 rc = vboxsvcSpawnDaemon();
253 if (NS_FAILED(rc))
254 break;
255
256 /* wait for the server process to establish a connection */
257 do
258 {
259 RTThreadSleep (VBoxSVC_WaitSlice);
260 rc = ipcServ->ResolveClientName (VBOXSVC_IPC_NAME, &serverID);
261 if (NS_SUCCEEDED(rc))
262 break;
263 if (timeLeft <= VBoxSVC_WaitSlice)
264 {
265 timeLeft = 0;
266 break;
267 }
268 timeLeft -= VBoxSVC_WaitSlice;
269 }
270 while (1);
271
272 if (!timeLeft)
273 {
274 rc = IPC_ERROR_WOULD_BLOCK;
275 break;
276 }
277 }
278
279 LogFlowFunc (("Connecting to server (ID=%d)...\n", serverID));
280
281 nsCOMPtr <ipcIDConnectService> dconServ =
282 do_GetService (IPC_DCONNECTSERVICE_CONTRACTID, &rc);
283 if (NS_FAILED(rc))
284 break;
285
286 rc = dconServ->CreateInstance (serverID,
287 CLSID_VirtualBox,
288 aIID, aResult);
289 if (NS_SUCCEEDED(rc))
290 break;
291
292 LogFlowFunc (("Failed to connect (rc=%Rhrc (%#08x))\n", rc, rc));
293
294 /* It's possible that the server gets shut down after we
295 * successfully resolve the server name but before it
296 * receives our CreateInstance() request. So, check for the
297 * name again, and restart the cycle if it fails. */
298 if (!startedOnce)
299 {
300 nsresult rc2 =
301 ipcServ->ResolveClientName (VBOXSVC_IPC_NAME, &serverID);
302 if (NS_SUCCEEDED(rc2))
303 break;
304
305 LogFlowFunc (("Server seems to have terminated before "
306 "receiving our request. Will try again.\n"));
307 }
308 else
309 break;
310 }
311 while (1);
312 }
313 while (0);
314
315 LogFlowFunc (("rc=%Rhrc (%#08x), vrc=%Rrc\n", rc, rc, vrc));
316 LogFlowFuncLeave();
317
318 return rc;
319}
320
321#if 0
322/// @todo not really necessary for the moment
323/**
324 *
325 * @param aCompMgr
326 * @param aPath
327 * @param aLoaderStr
328 * @param aType
329 * @param aInfo
330 *
331 * @return
332 */
333static NS_IMETHODIMP
334VirtualBoxRegistration (nsIComponentManager *aCompMgr,
335 nsIFile *aPath,
336 const char *aLoaderStr,
337 const char *aType,
338 const nsModuleComponentInfo *aInfo)
339{
340 nsCAutoString modulePath;
341 aPath->GetNativePath (modulePath);
342 nsCAutoString moduleTarget;
343 aPath->GetNativeTarget (moduleTarget);
344
345 LogFlowFunc (("aPath=%s, aTarget=%s, aLoaderStr=%s, aType=%s\n",
346 modulePath.get(), moduleTarget.get(), aLoaderStr, aType));
347
348 nsresult rc = NS_OK;
349
350 return rc;
351}
352#endif
353
354/**
355 * Component definition table.
356 * Lists all components defined in this module.
357 */
358static const nsModuleComponentInfo components[] =
359{
360 {
361 "VirtualBox component", // description
362 NS_VIRTUALBOX_CID, NS_VIRTUALBOX_CONTRACTID, // CID/ContractID
363 VirtualBoxConstructor, // constructor function
364 NULL, /* VirtualBoxRegistration, */ // registration function
365 NULL, // deregistration function
366 NULL, // destructor function
367 /// @todo
368 NS_CI_INTERFACE_GETTER_NAME(VirtualBox), // interfaces function
369 NULL, // language helper
370 /// @todo
371 &NS_CLASSINFO_NAME(VirtualBox) // global class info & flags
372 }
373};
374
375NS_IMPL_NSGETMODULE (VirtualBox_Server_Module, components)
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette