VirtualBox

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

Last change on this file since 27944 was 27926, checked in by vboxsync, 15 years ago

Guest Control: Update (VBoxService).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.7 KB
Line 
1
2/* $Id: VBoxServiceControl.cpp 27926 2010-04-01 08:58:39Z vboxsync $ */
3/** @file
4 * VBoxServiceControl - Host-driven Guest Control.
5 */
6
7/*
8 * Copyright (C) 2010 Sun Microsystems, Inc.
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 *
18 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
19 * Clara, CA 95054 USA or visit http://www.sun.com if you need
20 * additional information or have any questions.
21 */
22
23
24/*******************************************************************************
25* Header Files *
26*******************************************************************************/
27#include <iprt/assert.h>
28#include <iprt/getopt.h>
29#include <iprt/mem.h>
30#include <iprt/semaphore.h>
31#include <iprt/thread.h>
32#include <VBox/VBoxGuestLib.h>
33#include <VBox/HostServices/GuestControlSvc.h>
34#include "VBoxServiceInternal.h"
35#include "VBoxServiceUtils.h"
36
37using namespace guestControl;
38
39/*******************************************************************************
40* Global Variables *
41*******************************************************************************/
42/** The control interval (millseconds). */
43uint32_t g_ControlInterval = 0;
44/** The semaphore we're blocking on. */
45static RTSEMEVENTMULTI g_hControlEvent = NIL_RTSEMEVENTMULTI;
46/** The guest property service client ID. */
47static uint32_t g_GuestControlSvcClientID = 0;
48
49/** @copydoc VBOXSERVICE::pfnPreInit */
50static DECLCALLBACK(int) VBoxServiceControlPreInit(void)
51{
52 return VINF_SUCCESS;
53}
54
55
56/** @copydoc VBOXSERVICE::pfnOption */
57static DECLCALLBACK(int) VBoxServiceControlOption(const char **ppszShort, int argc, char **argv, int *pi)
58{
59 int rc = -1;
60 if (ppszShort)
61 /* no short options */;
62 else if (!strcmp(argv[*pi], "--control-interval"))
63 rc = VBoxServiceArgUInt32(argc, argv, "", pi,
64 &g_ControlInterval, 1, UINT32_MAX - 1);
65 return rc;
66}
67
68
69/** @copydoc VBOXSERVICE::pfnInit */
70static DECLCALLBACK(int) VBoxServiceControlInit(void)
71{
72 /*
73 * If not specified, find the right interval default.
74 * Then create the event sem to block on.
75 */
76 if (!g_ControlInterval)
77 g_ControlInterval = 1000;
78
79 int rc = RTSemEventMultiCreate(&g_hControlEvent);
80 AssertRCReturn(rc, rc);
81
82 rc = VbglR3GuestCtrlConnect(&g_GuestControlSvcClientID);
83 if (RT_SUCCESS(rc))
84 VBoxServiceVerbose(3, "Control: Service Client ID: %#x\n", g_GuestControlSvcClientID);
85 else
86 {
87 VBoxServiceError("Control: Failed to connect to the guest control service! Error: %Rrc\n", rc);
88 RTSemEventMultiDestroy(g_hControlEvent);
89 g_hControlEvent = NIL_RTSEMEVENTMULTI;
90 }
91
92 return rc;
93}
94
95
96static int VBoxServiceControlHandleCmdExec(uint32_t u32ClientId, uint32_t uNumParms)
97{
98 VBoxServiceVerbose(3, "VBoxServiceControlHandleCmdExec: Called uNumParms=%ld\n", uNumParms);
99
100 VBOXSERVICECTRLPROCDATA execData;
101 execData.cbEnv = sizeof(execData.szEnv);
102
103 int rc = VbglR3GuestCtrlGetHostCmdExec(u32ClientId, uNumParms,
104 execData.szCmd, sizeof(execData.szCmd),
105 &execData.uFlags,
106 execData.szArgs, sizeof(execData.szArgs), &execData.uNumArgs,
107 execData.szEnv, &execData.cbEnv, &execData.uNumEnvVars,
108 execData.szStdIn, sizeof(execData.szStdIn),
109 execData.szStdOut, sizeof(execData.szStdOut),
110 execData.szStdErr, sizeof(execData.szStdErr),
111 execData.szUser, sizeof(execData.szUser),
112 execData.szPassword, sizeof(execData.szPassword),
113 &execData.uTimeLimitMS);
114 if (RT_SUCCESS(rc))
115 {
116 /* Adjust time limit value. */
117 execData.uTimeLimitMS = UINT32_MAX ?
118 RT_INDEFINITE_WAIT : execData.uTimeLimitMS;
119
120 /* Prepare argument list. */
121 char **ppaArg;
122 int iArgs;
123 rc = RTGetOptArgvFromString(&ppaArg, &iArgs, execData.szArgs, NULL);
124 Assert(execData.uNumArgs == iArgs);
125 if (RT_SUCCESS(rc))
126 {
127 /* Prepare environment list. */
128 char **ppaEnv;
129 if (execData.uNumEnvVars)
130 {
131 ppaEnv = (char**)RTMemAlloc(execData.uNumEnvVars * sizeof(char*));
132 AssertPtr(ppaEnv);
133
134 char *pcCur = execData.szEnv;
135 uint32_t i = 0;
136 while (pcCur < execData.szEnv + execData.cbEnv)
137 {
138 if (RTStrAPrintf(&ppaEnv[i++], "%s", pcCur) < 0)
139 {
140 rc = VERR_NO_MEMORY;
141 break;
142 }
143 pcCur += strlen(pcCur) + 1; /* Skip terminating zero. */
144 }
145 }
146
147 if (RT_SUCCESS(rc))
148 {
149 /* Do the actual execution. */
150 rc = VBoxServiceControlExecProcess(&execData, ppaArg, ppaEnv);
151 for (uint32_t i = 0; i < execData.uNumEnvVars; i++)
152 RTStrFree(ppaEnv[i]);
153 RTMemFree(ppaEnv);
154 }
155 RTGetOptArgvFree(ppaArg);
156 }
157 }
158 return rc;
159}
160
161
162/** @copydoc VBOXSERVICE::pfnWorker */
163DECLCALLBACK(int) VBoxServiceControlWorker(bool volatile *pfShutdown)
164{
165 /*
166 * Tell the control thread that it can continue
167 * spawning services.
168 */
169 RTThreadUserSignal(RTThreadSelf());
170 Assert(g_GuestControlSvcClientID > 0);
171
172 int rc = VINF_SUCCESS;
173
174 /*
175 * Execution loop.
176 *
177 * @todo
178 */
179 for (;;)
180 {
181 uint32_t uMsg;
182 uint32_t uNumParms;
183 rc = VbglR3GuestCtrlGetHostMsg(g_GuestControlSvcClientID, &uMsg, &uNumParms);
184 if (RT_SUCCESS(rc))
185 {
186 switch(uMsg)
187 {
188 case GETHOSTMSG_EXEC_CMD:
189 rc = VBoxServiceControlHandleCmdExec(g_GuestControlSvcClientID, uNumParms);
190 break;
191
192 default:
193 VBoxServiceVerbose(3, "VBoxServiceControlWorker: Unsupported message from host! Msg=%ld\n", uMsg);
194 /* Don't terminate here; just wait for the next message. */
195 break;
196 }
197 break; /* DEBUG BREAK */
198 }
199
200 /*
201 * Block for a while.
202 *
203 * The event semaphore takes care of ignoring interruptions and it
204 * allows us to implement service wakeup later.
205 */
206 if (*pfShutdown)
207 break;
208 int rc2 = RTSemEventMultiWait(g_hControlEvent, g_ControlInterval);
209 if (*pfShutdown)
210 break;
211 if (rc2 != VERR_TIMEOUT && RT_FAILURE(rc2))
212 {
213 VBoxServiceError("VBoxServiceControlWorker: RTSemEventMultiWait failed; rc2=%Rrc\n", rc2);
214 rc = rc2;
215 break;
216 }
217 }
218
219 RTSemEventMultiDestroy(g_hControlEvent);
220 g_hControlEvent = NIL_RTSEMEVENTMULTI;
221 return rc;
222}
223
224
225/** @copydoc VBOXSERVICE::pfnStop */
226static DECLCALLBACK(void) VBoxServiceControlStop(void)
227{
228 /** @todo Later, figure what to do if we're in RTProcWait(). it's a very
229 * annoying call since doesn't support timeouts in the posix world. */
230 RTSemEventMultiSignal(g_hControlEvent);
231}
232
233
234/** @copydoc VBOXSERVICE::pfnTerm */
235static DECLCALLBACK(void) VBoxServiceControlTerm(void)
236{
237 /* Nothing here yet. */
238 VbglR3GuestCtrlDisconnect(g_GuestControlSvcClientID);
239 g_GuestControlSvcClientID = 0;
240
241 if (g_hControlEvent != NIL_RTSEMEVENTMULTI)
242 {
243 RTSemEventMultiDestroy(g_hControlEvent);
244 g_hControlEvent = NIL_RTSEMEVENTMULTI;
245 }
246}
247
248
249/**
250 * The 'vminfo' service description.
251 */
252VBOXSERVICE g_Control =
253{
254 /* pszName. */
255 "control",
256 /* pszDescription. */
257 "Host-driven Guest Control",
258 /* pszUsage. */
259 "[--control-interval <ms>]"
260 ,
261 /* pszOptions. */
262 " --control-interval Specifies the interval at which to check for\n"
263 " new ocntrol commands. The default is 1000 ms.\n"
264 ,
265 /* methods */
266 VBoxServiceControlPreInit,
267 VBoxServiceControlOption,
268 VBoxServiceControlInit,
269 VBoxServiceControlWorker,
270 VBoxServiceControlStop,
271 VBoxServiceControlTerm
272};
273
Note: See TracBrowser for help on using the repository browser.

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