VirtualBox

source: vbox/trunk/src/VBox/Additions/common/VBoxService/VBoxServiceControl.cpp@ 38157

Last change on this file since 38157 was 38157, checked in by vboxsync, 13 years ago

VBoxService/GuestCtrl: Implemented policy handling for controlling the maximum number of served guest processes.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.3 KB
Line 
1/* $Id: VBoxServiceControl.cpp 38157 2011-07-25 13:10:12Z vboxsync $ */
2/** @file
3 * VBoxServiceControl - Host-driven Guest Control.
4 */
5
6/*
7 * Copyright (C) 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
19/*******************************************************************************
20* Header Files *
21*******************************************************************************/
22#include <iprt/asm.h>
23#include <iprt/assert.h>
24#include <iprt/getopt.h>
25#include <iprt/mem.h>
26#include <iprt/semaphore.h>
27#include <iprt/thread.h>
28#include <VBox/VBoxGuestLib.h>
29#include <VBox/HostServices/GuestControlSvc.h>
30#include "VBoxServiceInternal.h"
31#include "VBoxServiceUtils.h"
32#include "VBoxServiceControlExecThread.h"
33
34using namespace guestControl;
35
36/*******************************************************************************
37* Global Variables *
38*******************************************************************************/
39/** The control interval (milliseconds). */
40uint32_t g_ControlInterval = 0;
41/** The semaphore we're blocking on. */
42static RTSEMEVENTMULTI g_hControlEvent = NIL_RTSEMEVENTMULTI;
43/** The guest control service client ID. */
44static uint32_t g_GuestControlSvcClientID = 0;
45/** How many started guest processes are kept into memory for supplying
46 * information to the host. Default is 5 processes. If 0 is specified,
47 * the maximum number of processes is unlimited. */
48uint32_t g_GuestControlProcsMaxKept = 5;
49/** List of guest control threads. */
50RTLISTNODE g_GuestControlThreads;
51/** Critical section protecting g_GuestControlExecThreads. */
52RTCRITSECT g_GuestControlThreadsCritSect;
53
54/** @copydoc VBOXSERVICE::pfnPreInit */
55static DECLCALLBACK(int) VBoxServiceControlPreInit(void)
56{
57#ifdef VBOX_WITH_GUEST_PROPS
58 /*
59 * Read the service options from the VM's guest properties.
60 * Note that these options can be overridden by the command line options later.
61 */
62 uint32_t uGuestPropSvcClientID;
63 int rc = VbglR3GuestPropConnect(&uGuestPropSvcClientID);
64 if (RT_FAILURE(rc))
65 {
66 if (rc == VERR_HGCM_SERVICE_NOT_FOUND) /* Host service is not available. */
67 {
68 VBoxServiceVerbose(0, "Control: Guest property service is not available, skipping\n");
69 rc = VINF_SUCCESS;
70 }
71 else
72 VBoxServiceError("Control: Failed to connect to the guest property service! Error: %Rrc\n", rc);
73 }
74 else
75 {
76 rc = VBoxServiceReadPropUInt32(uGuestPropSvcClientID, "/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept",
77 &g_GuestControlProcsMaxKept, 0, UINT32_MAX - 1);
78
79 VbglR3GuestPropDisconnect(uGuestPropSvcClientID);
80 }
81
82 if (rc == VERR_NOT_FOUND) /* If a value is not found, don't be sad! */
83 rc = VINF_SUCCESS;
84 return rc;
85#else
86 /* Nothing to do here yet. */
87 return VINF_SUCCESS;
88#endif
89}
90
91
92/** @copydoc VBOXSERVICE::pfnOption */
93static DECLCALLBACK(int) VBoxServiceControlOption(const char **ppszShort, int argc, char **argv, int *pi)
94{
95 int rc = -1;
96 if (ppszShort)
97 /* no short options */;
98 else if (!strcmp(argv[*pi], "--control-interval"))
99 rc = VBoxServiceArgUInt32(argc, argv, "", pi,
100 &g_ControlInterval, 1, UINT32_MAX - 1);
101 else if (!strcmp(argv[*pi], "--control-procs-max-kept"))
102 rc = VBoxServiceArgUInt32(argc, argv, "", pi,
103 &g_GuestControlProcsMaxKept, 0, UINT32_MAX - 1);
104 return rc;
105}
106
107
108/** @copydoc VBOXSERVICE::pfnInit */
109static DECLCALLBACK(int) VBoxServiceControlInit(void)
110{
111 /*
112 * If not specified, find the right interval default.
113 * Then create the event sem to block on.
114 */
115 if (!g_ControlInterval)
116 g_ControlInterval = 1000;
117
118 int rc = RTSemEventMultiCreate(&g_hControlEvent);
119 AssertRCReturn(rc, rc);
120
121 rc = VbglR3GuestCtrlConnect(&g_GuestControlSvcClientID);
122 if (RT_SUCCESS(rc))
123 {
124 VBoxServiceVerbose(3, "Control: Service client ID: %#x\n", g_GuestControlSvcClientID);
125
126 /* Init thread list. */
127 RTListInit(&g_GuestControlThreads);
128 rc = RTCritSectInit(&g_GuestControlThreadsCritSect);
129 AssertRC(rc);
130 }
131 else
132 {
133 /* If the service was not found, we disable this service without
134 causing VBoxService to fail. */
135 if (rc == VERR_HGCM_SERVICE_NOT_FOUND) /* Host service is not available. */
136 {
137 VBoxServiceVerbose(0, "Control: Guest control service is not available\n");
138 rc = VERR_SERVICE_DISABLED;
139 }
140 else
141 VBoxServiceError("Control: Failed to connect to the guest control service! Error: %Rrc\n", rc);
142 RTSemEventMultiDestroy(g_hControlEvent);
143 g_hControlEvent = NIL_RTSEMEVENTMULTI;
144 }
145 return rc;
146}
147
148
149/** @copydoc VBOXSERVICE::pfnWorker */
150DECLCALLBACK(int) VBoxServiceControlWorker(bool volatile *pfShutdown)
151{
152 /*
153 * Tell the control thread that it can continue
154 * spawning services.
155 */
156 RTThreadUserSignal(RTThreadSelf());
157 Assert(g_GuestControlSvcClientID > 0);
158
159 int rc = VINF_SUCCESS;
160
161 /*
162 * Execution loop.
163 *
164 * @todo
165 */
166 for (;;)
167 {
168 uint32_t uMsg;
169 uint32_t uNumParms;
170 VBoxServiceVerbose(3, "Control: Waiting for host msg ...\n");
171 rc = VbglR3GuestCtrlWaitForHostMsg(g_GuestControlSvcClientID, &uMsg, &uNumParms);
172 if (RT_FAILURE(rc))
173 {
174 if (rc == VERR_TOO_MUCH_DATA)
175 {
176 VBoxServiceVerbose(4, "Control: Message requires %ld parameters, but only 2 supplied -- retrying request (no error!)...\n", uNumParms);
177 rc = VINF_SUCCESS; /* Try to get "real" message in next block below. */
178 }
179 else
180 VBoxServiceVerbose(3, "Control: Getting host message failed with %Rrc\n", rc); /* VERR_GEN_IO_FAILURE seems to be normal if ran into timeout. */
181 }
182
183 if (RT_SUCCESS(rc))
184 {
185 VBoxServiceVerbose(3, "Control: Msg=%u (%u parms) retrieved\n", uMsg, uNumParms);
186 switch(uMsg)
187 {
188 case HOST_CANCEL_PENDING_WAITS:
189 VBoxServiceVerbose(3, "Control: Host asked us to quit ...\n");
190 break;
191
192 case HOST_EXEC_CMD:
193 rc = VBoxServiceControlExecHandleCmdStartProcess(g_GuestControlSvcClientID, uNumParms);
194 break;
195
196 case HOST_EXEC_SET_INPUT:
197 /** @todo Make buffer size configurable via guest properties/argv! */
198 rc = VBoxServiceControlExecHandleCmdSetInput(g_GuestControlSvcClientID, uNumParms, _1M /* Buffer size */);
199 break;
200
201 case HOST_EXEC_GET_OUTPUT:
202 rc = VBoxServiceControlExecHandleCmdGetOutput(g_GuestControlSvcClientID, uNumParms);
203 break;
204
205 default:
206 VBoxServiceVerbose(3, "Control: Unsupported message from host! Msg=%u\n", uMsg);
207 /* Don't terminate here; just wait for the next message. */
208 break;
209 }
210
211 if (RT_FAILURE(rc))
212 VBoxServiceVerbose(3, "Control: Message was processed with rc=%Rrc\n", rc);
213 }
214
215 /* Do we need to shutdown? */
216 if ( *pfShutdown
217 || uMsg == HOST_CANCEL_PENDING_WAITS)
218 {
219 rc = VINF_SUCCESS;
220 break;
221 }
222
223 /* Let's sleep for a bit and let others run ... */
224 RTThreadYield();
225 }
226
227 RTSemEventMultiDestroy(g_hControlEvent);
228 g_hControlEvent = NIL_RTSEMEVENTMULTI;
229 return rc;
230}
231
232
233/** @copydoc VBOXSERVICE::pfnStop */
234static DECLCALLBACK(void) VBoxServiceControlStop(void)
235{
236 VBoxServiceVerbose(3, "Control: Stopping ...\n");
237
238 /** @todo Later, figure what to do if we're in RTProcWait(). it's a very
239 * annoying call since doesn't support timeouts in the posix world. */
240 RTSemEventMultiSignal(g_hControlEvent);
241
242 /*
243 * Ask the host service to cancel all pending requests so that we can
244 * shutdown properly here.
245 */
246 if (g_GuestControlSvcClientID)
247 {
248 int rc = VbglR3GuestCtrlCancelPendingWaits(g_GuestControlSvcClientID);
249 if (RT_FAILURE(rc))
250 VBoxServiceError("Control: Cancelling pending waits failed; rc=%Rrc\n", rc);
251 }
252}
253
254void VBoxServiceControlThreadSignalShutdown(const PVBOXSERVICECTRLTHREAD pThread)
255{
256 AssertPtrReturnVoid(pThread);
257 ASMAtomicXchgBool(&pThread->fShutdown, true);
258}
259
260
261int VBoxServiceControlThreadWaitForShutdown(const PVBOXSERVICECTRLTHREAD pThread)
262{
263 AssertPtrReturn(pThread, VERR_INVALID_POINTER);
264 int rc = VINF_SUCCESS;
265 if (pThread->Thread != NIL_RTTHREAD)
266 {
267 /* Wait a bit ... */
268 rc = RTThreadWait(pThread->Thread, 30 * 1000 /* Wait 30 seconds max. */, NULL);
269 }
270 return rc;
271}
272
273
274static void VBoxServiceControlDestroyThreads(void)
275{
276 VBoxServiceVerbose(3, "Control: Destroying threads ...\n");
277
278 int rc = RTCritSectEnter(&g_GuestControlThreadsCritSect);
279 if (RT_SUCCESS(rc))
280 {
281 /* Signal all threads that we want to shutdown. */
282 PVBOXSERVICECTRLTHREAD pNode;
283 RTListForEach(&g_GuestControlThreads, pNode, VBOXSERVICECTRLTHREAD, Node)
284 VBoxServiceControlThreadSignalShutdown(pNode);
285
286 /* Wait for threads to shutdown. */
287 RTListForEach(&g_GuestControlThreads, pNode, VBOXSERVICECTRLTHREAD, Node)
288 {
289 int rc2 = VBoxServiceControlThreadWaitForShutdown(pNode);
290 if (RT_FAILURE(rc2))
291 VBoxServiceError("Control: Thread failed to stop; rc2=%Rrc\n", rc2);
292
293 /* Destroy thread specific data. */
294 switch (pNode->enmType)
295 {
296 case kVBoxServiceCtrlThreadDataExec:
297 VBoxServiceControlExecThreadDataDestroy((PVBOXSERVICECTRLTHREADDATAEXEC)pNode->pvData);
298 break;
299
300 default:
301 break;
302 }
303 }
304
305 /* Finally destroy thread list. */
306 pNode = RTListGetFirst(&g_GuestControlThreads, VBOXSERVICECTRLTHREAD, Node);
307 while (pNode)
308 {
309 PVBOXSERVICECTRLTHREAD pNext = RTListNodeGetNext(&pNode->Node, VBOXSERVICECTRLTHREAD, Node);
310 bool fLast = RTListNodeIsLast(&g_GuestControlThreads, &pNode->Node);
311
312 RTListNodeRemove(&pNode->Node);
313 RTMemFree(pNode);
314
315 if (fLast)
316 break;
317
318 pNode = pNext;
319 }
320
321 int rc2 = RTCritSectLeave(&g_GuestControlThreadsCritSect);
322 if (RT_SUCCESS(rc))
323 rc = rc2;
324 }
325 RTCritSectDelete(&g_GuestControlThreadsCritSect);
326}
327
328
329/** @copydoc VBOXSERVICE::pfnTerm */
330static DECLCALLBACK(void) VBoxServiceControlTerm(void)
331{
332 VBoxServiceVerbose(3, "Control: Terminating ...\n");
333
334 VBoxServiceControlDestroyThreads();
335
336 VbglR3GuestCtrlDisconnect(g_GuestControlSvcClientID);
337 g_GuestControlSvcClientID = 0;
338
339 if (g_hControlEvent != NIL_RTSEMEVENTMULTI)
340 {
341 RTSemEventMultiDestroy(g_hControlEvent);
342 g_hControlEvent = NIL_RTSEMEVENTMULTI;
343 }
344}
345
346
347/**
348 * The 'vminfo' service description.
349 */
350VBOXSERVICE g_Control =
351{
352 /* pszName. */
353 "control",
354 /* pszDescription. */
355 "Host-driven Guest Control",
356 /* pszUsage. */
357 " [--control-interval <ms>] [--control-procs-max-kept <x>]"
358 ,
359 /* pszOptions. */
360 " --control-interval Specifies the interval at which to check for\n"
361 " new control commands. The default is 1000 ms.\n"
362 " --control-procs-max-kept\n"
363 " Specifies how many started guest processes are\n"
364 " kept into memory to work with.\n"
365 ,
366 /* methods */
367 VBoxServiceControlPreInit,
368 VBoxServiceControlOption,
369 VBoxServiceControlInit,
370 VBoxServiceControlWorker,
371 VBoxServiceControlStop,
372 VBoxServiceControlTerm
373};
374
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