VirtualBox

source: vbox/trunk/src/VBox/Additions/common/VBoxGuest/lib/VBoxGuestR3LibGuestCtrl.cpp@ 102447

Last change on this file since 102447 was 99395, checked in by vboxsync, 22 months ago

Guest Additions/VBoxService: Fixed HGCM parameter in VbglR3GuestCtrlFsObjCbQueryInfoEx(). bugref:9783
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 107.1 KB
Line 
1/* $Id: VBoxGuestR3LibGuestCtrl.cpp 99395 2023-04-14 08:48:03Z vboxsync $ */
2/** @file
3 * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, guest control.
4 */
5
6/*
7 * Copyright (C) 2010-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37
38/*********************************************************************************************************************************
39* Header Files *
40*********************************************************************************************************************************/
41#include <iprt/string.h>
42#include <iprt/mem.h>
43#include <iprt/assert.h>
44#include <iprt/cpp/autores.h>
45#include <iprt/stdarg.h>
46#include <VBox/err.h>
47#include <VBox/log.h>
48#include <VBox/GuestHost/GuestControl.h>
49#include <VBox/HostServices/GuestControlSvc.h>
50
51#ifndef RT_OS_WINDOWS
52# include <signal.h>
53# ifdef RT_OS_DARWIN
54# include <pthread.h>
55# define sigprocmask pthread_sigmask /* On xnu sigprocmask works on the process, not the calling thread as elsewhere. */
56# endif
57#endif
58
59#include "VBoxGuestR3LibInternal.h"
60
61using namespace guestControl;
62
63
64/*********************************************************************************************************************************
65* Global Variables *
66*********************************************************************************************************************************/
67/** Set if GUEST_MSG_PEEK_WAIT and friends are supported. */
68static int g_fVbglR3GuestCtrlHavePeekGetCancel = -1;
69
70
71/**
72 * Connects to the guest control service.
73 *
74 * @returns VBox status code
75 * @param pidClient Where to put The client ID on success. The client ID
76 * must be passed to all the other calls to the service.
77 */
78VBGLR3DECL(int) VbglR3GuestCtrlConnect(uint32_t *pidClient)
79{
80 return VbglR3HGCMConnect("VBoxGuestControlSvc", pidClient);
81}
82
83
84/**
85 * Disconnect from the guest control service.
86 *
87 * @returns VBox status code.
88 * @param idClient The client ID returned by VbglR3GuestCtrlConnect().
89 */
90VBGLR3DECL(int) VbglR3GuestCtrlDisconnect(uint32_t idClient)
91{
92 return VbglR3HGCMDisconnect(idClient);
93}
94
95
96/**
97 * Waits until a new host message arrives.
98 * This will block until a message becomes available.
99 *
100 * @returns VBox status code.
101 * @param idClient The client ID returned by VbglR3GuestCtrlConnect().
102 * @param pidMsg Where to store the message id.
103 * @param pcParameters Where to store the number of parameters which will
104 * be received in a second call to the host.
105 */
106static int vbglR3GuestCtrlMsgWaitFor(uint32_t idClient, uint32_t *pidMsg, uint32_t *pcParameters)
107{
108 AssertPtrReturn(pidMsg, VERR_INVALID_POINTER);
109 AssertPtrReturn(pcParameters, VERR_INVALID_POINTER);
110
111 HGCMMsgWaitFor Msg;
112 VBGL_HGCM_HDR_INIT(&Msg.hdr, idClient,
113 GUEST_MSG_WAIT, /* Tell the host we want our next message. */
114 2); /* Just peek for the next message! */
115 VbglHGCMParmUInt32Set(&Msg.msg, 0);
116 VbglHGCMParmUInt32Set(&Msg.num_parms, 0);
117
118 /*
119 * We should always get a VERR_TOO_MUCH_DATA response here, see
120 * guestControl::HostMessage::Peek() and its caller ClientState::SendReply().
121 * We accept success too here, in case someone decide to make the protocol
122 * slightly more sane.
123 *
124 * Note! A really sane protocol design would have a separate call for getting
125 * info about a pending message (returning VINF_SUCCESS), and a separate
126 * one for retriving the actual message parameters. Not this weird
127 * stuff, to put it rather bluntly.
128 *
129 * Note! As a result of this weird design, we are not able to correctly
130 * retrieve message if we're interrupted by a signal, like SIGCHLD.
131 * Because IPRT wants to use waitpid(), we're forced to have a handler
132 * installed for SIGCHLD, so when working with child processes there
133 * will be signals in the air and we will get VERR_INTERRUPTED returns.
134 * The way HGCM handles interrupted calls is to silently (?) drop them
135 * as they complete (see VMMDev), so the server knows little about it
136 * and just goes on to the next message inline.
137 *
138 * So, as a "temporary" mesasure, we block SIGCHLD here while waiting,
139 * because it will otherwise be impossible do simple stuff like 'mkdir'
140 * on a mac os x guest, and probably most other unix guests.
141 */
142#ifdef RT_OS_WINDOWS
143 int rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
144#else
145 sigset_t SigSet;
146 sigemptyset(&SigSet);
147 sigaddset(&SigSet, SIGCHLD);
148 sigprocmask(SIG_BLOCK, &SigSet, NULL);
149 int rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
150 sigprocmask(SIG_UNBLOCK, &SigSet, NULL);
151#endif
152 if ( rc == VERR_TOO_MUCH_DATA
153 || RT_SUCCESS(rc))
154 {
155 int rc2 = VbglHGCMParmUInt32Get(&Msg.msg, pidMsg);
156 if (RT_SUCCESS(rc2))
157 {
158 rc2 = VbglHGCMParmUInt32Get(&Msg.num_parms, pcParameters);
159 if (RT_SUCCESS(rc2))
160 {
161 /* Ok, so now we know what message type and how much parameters there are. */
162 return rc;
163 }
164 }
165 rc = rc2;
166 }
167 *pidMsg = UINT32_MAX - 1;
168 *pcParameters = UINT32_MAX - 2;
169 return rc;
170}
171
172
173/**
174 * Determins the value of g_fVbglR3GuestCtrlHavePeekGetCancel.
175 *
176 * @returns true if supported, false if not.
177 * @param idClient The client ID to use for the testing.
178 */
179DECL_NO_INLINE(static, bool) vbglR3GuestCtrlDetectPeekGetCancelSupport(uint32_t idClient)
180{
181 /*
182 * Seems we get VINF_SUCCESS back from the host if we try unsupported
183 * guest control messages, so we need to supply some random message
184 * parameters and check that they change.
185 */
186 uint32_t const idDummyMsg = UINT32_C(0x8350bdca);
187 uint32_t const cDummyParmeters = UINT32_C(0x7439604f);
188 uint32_t const cbDummyMask = UINT32_C(0xc0ffe000);
189 Assert(cDummyParmeters > VMMDEV_MAX_HGCM_PARMS);
190
191 int rc;
192 struct
193 {
194 VBGLIOCHGCMCALL Hdr;
195 HGCMFunctionParameter idMsg;
196 HGCMFunctionParameter cParams;
197 HGCMFunctionParameter acbParams[14];
198 } PeekCall;
199 Assert(RT_ELEMENTS(PeekCall.acbParams) + 2 < VMMDEV_MAX_HGCM_PARMS);
200
201 do
202 {
203 memset(&PeekCall, 0xf6, sizeof(PeekCall));
204 VBGL_HGCM_HDR_INIT(&PeekCall.Hdr, idClient, GUEST_MSG_PEEK_NOWAIT, 16);
205 VbglHGCMParmUInt32Set(&PeekCall.idMsg, idDummyMsg);
206 VbglHGCMParmUInt32Set(&PeekCall.cParams, cDummyParmeters);
207 for (uint32_t i = 0; i < RT_ELEMENTS(PeekCall.acbParams); i++)
208 VbglHGCMParmUInt32Set(&PeekCall.acbParams[i], i | cbDummyMask);
209
210 rc = VbglR3HGCMCall(&PeekCall.Hdr, sizeof(PeekCall));
211 } while (rc == VERR_INTERRUPTED);
212
213 LogRel2(("vbglR3GuestCtrlDetectPeekGetCancelSupport: rc=%Rrc %#x %#x %#x %#x %#x %#x %#x %#x %#x %#x %#x %#x %#x %#x %#x %#x\n",
214 rc, PeekCall.idMsg.u.value32, PeekCall.cParams.u.value32,
215 PeekCall.acbParams[ 0].u.value32, PeekCall.acbParams[ 1].u.value32,
216 PeekCall.acbParams[ 2].u.value32, PeekCall.acbParams[ 3].u.value32,
217 PeekCall.acbParams[ 4].u.value32, PeekCall.acbParams[ 5].u.value32,
218 PeekCall.acbParams[ 6].u.value32, PeekCall.acbParams[ 7].u.value32,
219 PeekCall.acbParams[ 8].u.value32, PeekCall.acbParams[ 9].u.value32,
220 PeekCall.acbParams[10].u.value32, PeekCall.acbParams[11].u.value32,
221 PeekCall.acbParams[12].u.value32, PeekCall.acbParams[13].u.value32));
222
223 /*
224 * VERR_TRY_AGAIN is likely and easy.
225 */
226 if ( rc == VERR_TRY_AGAIN
227 && PeekCall.idMsg.u.value32 == 0
228 && PeekCall.cParams.u.value32 == 0
229 && PeekCall.acbParams[0].u.value32 == 0
230 && PeekCall.acbParams[1].u.value32 == 0
231 && PeekCall.acbParams[2].u.value32 == 0
232 && PeekCall.acbParams[3].u.value32 == 0)
233 {
234 g_fVbglR3GuestCtrlHavePeekGetCancel = 1;
235 LogRel(("vbglR3GuestCtrlDetectPeekGetCancelSupport: Supported (#1)\n"));
236 return true;
237 }
238
239 /*
240 * VINF_SUCCESS is annoying but with 16 parameters we've got plenty to check.
241 */
242 if ( rc == VINF_SUCCESS
243 && PeekCall.idMsg.u.value32 != idDummyMsg
244 && PeekCall.idMsg.u.value32 != 0
245 && PeekCall.cParams.u.value32 <= VMMDEV_MAX_HGCM_PARMS)
246 {
247 for (uint32_t i = 0; i < RT_ELEMENTS(PeekCall.acbParams); i++)
248 if (PeekCall.acbParams[i].u.value32 != (i | cbDummyMask))
249 {
250 g_fVbglR3GuestCtrlHavePeekGetCancel = 0;
251 LogRel(("vbglR3GuestCtrlDetectPeekGetCancelSupport: Not supported (#1)\n"));
252 return false;
253 }
254 g_fVbglR3GuestCtrlHavePeekGetCancel = 1;
255 LogRel(("vbglR3GuestCtrlDetectPeekGetCancelSupport: Supported (#2)\n"));
256 return true;
257 }
258
259 /*
260 * Okay, pretty sure it's not supported then.
261 */
262 LogRel(("vbglR3GuestCtrlDetectPeekGetCancelSupport: Not supported (#3)\n"));
263 g_fVbglR3GuestCtrlHavePeekGetCancel = 0;
264 return false;
265}
266
267
268/**
269 * Reads g_fVbglR3GuestCtrlHavePeekGetCancel and resolved -1.
270 *
271 * @returns true if supported, false if not.
272 * @param idClient The client ID to use for the testing.
273 */
274DECLINLINE(bool) vbglR3GuestCtrlSupportsPeekGetCancel(uint32_t idClient)
275{
276 int fState = g_fVbglR3GuestCtrlHavePeekGetCancel;
277 if (RT_LIKELY(fState != -1))
278 return fState != 0;
279 return vbglR3GuestCtrlDetectPeekGetCancelSupport(idClient);
280}
281
282
283/**
284 * Figures which getter function to use to retrieve the message.
285 */
286DECLINLINE(uint32_t) vbglR3GuestCtrlGetMsgFunctionNo(uint32_t idClient)
287{
288 return vbglR3GuestCtrlSupportsPeekGetCancel(idClient) ? GUEST_MSG_GET : GUEST_MSG_WAIT;
289}
290
291
292/**
293 * Checks if the host supports the optimizes message and session functions.
294 *
295 * @returns true / false.
296 * @param idClient The client ID returned by VbglR3GuestCtrlConnect().
297 * We may need to use this for checking.
298 * @since 6.0
299 */
300VBGLR3DECL(bool) VbglR3GuestCtrlSupportsOptimizations(uint32_t idClient)
301{
302 return vbglR3GuestCtrlSupportsPeekGetCancel(idClient);
303}
304
305
306/**
307 * Make us the guest control master client.
308 *
309 * @returns VBox status code.
310 * @param idClient The client ID returned by VbglR3GuestCtrlConnect().
311 */
312VBGLR3DECL(int) VbglR3GuestCtrlMakeMeMaster(uint32_t idClient)
313{
314 int rc;
315 do
316 {
317 VBGLIOCHGCMCALL Hdr;
318 VBGL_HGCM_HDR_INIT(&Hdr, idClient, GUEST_MSG_MAKE_ME_MASTER, 0);
319 rc = VbglR3HGCMCall(&Hdr, sizeof(Hdr));
320 } while (rc == VERR_INTERRUPTED);
321 return rc;
322}
323
324
325/**
326 * Reports features to the host and retrieve host feature set.
327 *
328 * @returns VBox status code.
329 * @param idClient The client ID returned by VbglR3GuestCtrlConnect().
330 * @param fGuestFeatures Features to report, VBOX_GUESTCTRL_GF_XXX.
331 * @param pfHostFeatures Where to store the features VBOX_GUESTCTRL_HF_XXX.
332 */
333VBGLR3DECL(int) VbglR3GuestCtrlReportFeatures(uint32_t idClient, uint64_t fGuestFeatures, uint64_t *pfHostFeatures)
334{
335 int rc;
336 do
337 {
338 struct
339 {
340 VBGLIOCHGCMCALL Hdr;
341 HGCMFunctionParameter f64Features0;
342 HGCMFunctionParameter f64Features1;
343 } Msg;
344 VBGL_HGCM_HDR_INIT(&Msg.Hdr, idClient, GUEST_MSG_REPORT_FEATURES, 2);
345 VbglHGCMParmUInt64Set(&Msg.f64Features0, fGuestFeatures);
346 VbglHGCMParmUInt64Set(&Msg.f64Features1, VBOX_GUESTCTRL_GF_1_MUST_BE_ONE);
347
348 rc = VbglR3HGCMCall(&Msg.Hdr, sizeof(Msg));
349 if (RT_SUCCESS(rc))
350 {
351 Assert(Msg.f64Features0.type == VMMDevHGCMParmType_64bit);
352 Assert(Msg.f64Features1.type == VMMDevHGCMParmType_64bit);
353 if (Msg.f64Features1.u.value64 & VBOX_GUESTCTRL_GF_1_MUST_BE_ONE)
354 rc = VERR_NOT_SUPPORTED;
355 else if (pfHostFeatures)
356 *pfHostFeatures = Msg.f64Features0.u.value64;
357 break;
358 }
359 } while (rc == VERR_INTERRUPTED);
360 return rc;
361
362}
363
364
365/**
366 * Query the host features.
367 *
368 * @returns VBox status code.
369 * @param idClient The client ID returned by VbglR3GuestCtrlConnect().
370 * @param pfHostFeatures Where to store the host feature, VBOX_GUESTCTRL_HF_XXX.
371 */
372VBGLR3DECL(int) VbglR3GuestCtrlQueryFeatures(uint32_t idClient, uint64_t *pfHostFeatures)
373{
374 int rc;
375 do
376 {
377 struct
378 {
379 VBGLIOCHGCMCALL Hdr;
380 HGCMFunctionParameter f64Features0;
381 HGCMFunctionParameter f64Features1;
382 } Msg;
383 VBGL_HGCM_HDR_INIT(&Msg.Hdr, idClient, GUEST_MSG_QUERY_FEATURES, 2);
384 VbglHGCMParmUInt64Set(&Msg.f64Features0, 0);
385 VbglHGCMParmUInt64Set(&Msg.f64Features1, RT_BIT_64(63));
386
387 rc = VbglR3HGCMCall(&Msg.Hdr, sizeof(Msg));
388 if (RT_SUCCESS(rc))
389 {
390 Assert(Msg.f64Features0.type == VMMDevHGCMParmType_64bit);
391 Assert(Msg.f64Features1.type == VMMDevHGCMParmType_64bit);
392 if (Msg.f64Features1.u.value64 & RT_BIT_64(63))
393 rc = VERR_NOT_SUPPORTED;
394 else if (pfHostFeatures)
395 *pfHostFeatures = Msg.f64Features0.u.value64;
396 break;
397 }
398 } while (rc == VERR_INTERRUPTED);
399 return rc;
400
401}
402
403
404/**
405 * Peeks at the next host message, waiting for one to turn up.
406 *
407 * @returns VBox status code.
408 * @retval VERR_INTERRUPTED if interrupted. Does the necessary cleanup, so
409 * caller just have to repeat this call.
410 * @retval VERR_VM_RESTORED if the VM has been restored (idRestoreCheck).
411 *
412 * @param idClient The client ID returned by VbglR3GuestCtrlConnect().
413 * @param pidMsg Where to store the message id.
414 * @param pcParameters Where to store the number of parameters which will
415 * be received in a second call to the host.
416 * @param pidRestoreCheck Pointer to the VbglR3GetSessionId() variable to use
417 * for the VM restore check. Optional.
418 *
419 * @note Restore check is only performed optimally with a 6.0 host.
420 */
421VBGLR3DECL(int) VbglR3GuestCtrlMsgPeekWait(uint32_t idClient, uint32_t *pidMsg, uint32_t *pcParameters, uint64_t *pidRestoreCheck)
422{
423 AssertPtrReturn(pidMsg, VERR_INVALID_POINTER);
424 AssertPtrReturn(pcParameters, VERR_INVALID_POINTER);
425
426 int rc;
427 if (vbglR3GuestCtrlSupportsPeekGetCancel(idClient))
428 {
429 struct
430 {
431 VBGLIOCHGCMCALL Hdr;
432 HGCMFunctionParameter idMsg; /* Doubles as restore check on input. */
433 HGCMFunctionParameter cParameters;
434 } Msg;
435 VBGL_HGCM_HDR_INIT(&Msg.Hdr, idClient, GUEST_MSG_PEEK_WAIT, 2);
436 VbglHGCMParmUInt64Set(&Msg.idMsg, pidRestoreCheck ? *pidRestoreCheck : 0);
437 VbglHGCMParmUInt32Set(&Msg.cParameters, 0);
438 rc = VbglR3HGCMCall(&Msg.Hdr, sizeof(Msg));
439 LogRel2(("VbglR3GuestCtrlMsgPeekWait -> %Rrc\n", rc));
440 if (RT_SUCCESS(rc))
441 {
442 AssertMsgReturn( Msg.idMsg.type == VMMDevHGCMParmType_64bit
443 && Msg.cParameters.type == VMMDevHGCMParmType_32bit,
444 ("msg.type=%d num_parms.type=%d\n", Msg.idMsg.type, Msg.cParameters.type),
445 VERR_INTERNAL_ERROR_3);
446
447 *pidMsg = (uint32_t)Msg.idMsg.u.value64;
448 *pcParameters = Msg.cParameters.u.value32;
449 return rc;
450 }
451
452 /*
453 * If interrupted we must cancel the call so it doesn't prevent us from making another one.
454 */
455 if (rc == VERR_INTERRUPTED)
456 {
457 VBGL_HGCM_HDR_INIT(&Msg.Hdr, idClient, GUEST_MSG_CANCEL, 0);
458 int rc2 = VbglR3HGCMCall(&Msg.Hdr, sizeof(Msg.Hdr));
459 AssertRC(rc2);
460 }
461
462 /*
463 * If restored, update pidRestoreCheck.
464 */
465 if (rc == VERR_VM_RESTORED && pidRestoreCheck)
466 *pidRestoreCheck = Msg.idMsg.u.value64;
467
468 *pidMsg = UINT32_MAX - 1;
469 *pcParameters = UINT32_MAX - 2;
470 return rc;
471 }
472
473 /*
474 * Fallback if host < v6.0.
475 *
476 * Note! The restore check isn't perfect. Would require checking afterwards
477 * and stash the result if we were restored during the call. Too much
478 * hazzle for a downgrade scenario.
479 */
480 if (pidRestoreCheck)
481 {
482 uint64_t idRestoreCur = *pidRestoreCheck;
483 rc = VbglR3GetSessionId(&idRestoreCur);
484 if (RT_SUCCESS(rc) && idRestoreCur != *pidRestoreCheck)
485 {
486 *pidRestoreCheck = idRestoreCur;
487 return VERR_VM_RESTORED;
488 }
489 }
490
491 rc = vbglR3GuestCtrlMsgWaitFor(idClient, pidMsg, pcParameters);
492 if (rc == VERR_TOO_MUCH_DATA)
493 rc = VINF_SUCCESS;
494 return rc;
495}
496
497
498/**
499 * Asks the host guest control service to set a message filter to this
500 * client so that it only will receive certain messages in the future.
501 * The filter(s) are a bitmask for the context IDs, served from the host.
502 *
503 * @return IPRT status code.
504 * @param idClient The client ID returned by VbglR3GuestCtrlConnect().
505 * @param uValue The value to filter messages for.
506 * @param uMaskAdd Filter mask to add.
507 * @param uMaskRemove Filter mask to remove.
508 */
509VBGLR3DECL(int) VbglR3GuestCtrlMsgFilterSet(uint32_t idClient, uint32_t uValue, uint32_t uMaskAdd, uint32_t uMaskRemove)
510{
511 HGCMMsgFilterSet Msg;
512
513 /* Tell the host we want to set a filter. */
514 VBGL_HGCM_HDR_INIT(&Msg.hdr, idClient, GUEST_MSG_FILTER_SET, 4);
515 VbglHGCMParmUInt32Set(&Msg.value, uValue);
516 VbglHGCMParmUInt32Set(&Msg.mask_add, uMaskAdd);
517 VbglHGCMParmUInt32Set(&Msg.mask_remove, uMaskRemove);
518 VbglHGCMParmUInt32Set(&Msg.flags, 0 /* Flags, unused */);
519
520 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
521}
522
523
524/**
525 * Replies to a message from the host.
526 *
527 * @returns VBox status code.
528 * @param pCtx Guest control command context to use.
529 * @param rc Guest rc to reply.
530 */
531VBGLR3DECL(int) VbglR3GuestCtrlMsgReply(PVBGLR3GUESTCTRLCMDCTX pCtx,
532 int rc)
533{
534 return VbglR3GuestCtrlMsgReplyEx(pCtx, rc, 0 /* uType */,
535 NULL /* pvPayload */, 0 /* cbPayload */);
536}
537
538
539/**
540 * Replies to a message from the host, extended version.
541 *
542 * @returns VBox status code.
543 * @param pCtx Guest control command context to use.
544 * @param rc Guest rc to reply.
545 * @param uType Reply type; not used yet and must be 0.
546 * @param pvPayload Pointer to data payload to reply. Optional.
547 * @param cbPayload Size of data payload (in bytes) to reply.
548 */
549VBGLR3DECL(int) VbglR3GuestCtrlMsgReplyEx(PVBGLR3GUESTCTRLCMDCTX pCtx,
550 int rc, uint32_t uType,
551 void *pvPayload, uint32_t cbPayload)
552{
553 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
554 /* Everything else is optional. */
555
556 HGCMMsgReply Msg;
557 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_REPLY, 4);
558 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
559 VbglHGCMParmUInt32Set(&Msg.type, uType);
560 VbglHGCMParmUInt32Set(&Msg.rc, (uint32_t)rc); /* int vs. uint32_t */
561 VbglHGCMParmPtrSet(&Msg.payload, pvPayload, cbPayload);
562
563 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
564}
565
566/**
567 * Tell the host to skip the current message replying VERR_NOT_SUPPORTED
568 *
569 * @return IPRT status code.
570 * @param idClient The client ID returned by VbglR3GuestCtrlConnect().
571 * @param rcSkip The status code to pass back to Main when skipping.
572 * @param idMsg The message ID to skip, pass UINT32_MAX to pass any.
573 */
574VBGLR3DECL(int) VbglR3GuestCtrlMsgSkip(uint32_t idClient, int rcSkip, uint32_t idMsg)
575{
576 if (vbglR3GuestCtrlSupportsPeekGetCancel(idClient))
577 {
578 struct
579 {
580 VBGLIOCHGCMCALL Hdr;
581 HGCMFunctionParameter rcSkip;
582 HGCMFunctionParameter idMsg;
583 } Msg;
584 VBGL_HGCM_HDR_INIT(&Msg.Hdr, idClient, GUEST_MSG_SKIP, 2);
585 VbglHGCMParmUInt32Set(&Msg.rcSkip, (uint32_t)rcSkip);
586 VbglHGCMParmUInt32Set(&Msg.idMsg, idMsg);
587 return VbglR3HGCMCall(&Msg.Hdr, sizeof(Msg));
588 }
589
590 /* This is generally better than nothing... */
591 return VbglR3GuestCtrlMsgSkipOld(idClient);
592}
593
594
595/**
596 * Tells the host service to skip the current message returned by
597 * VbglR3GuestCtrlMsgWaitFor().
598 *
599 * @return IPRT status code.
600 * @param idClient The client ID returned by VbglR3GuestCtrlConnect().
601 */
602VBGLR3DECL(int) VbglR3GuestCtrlMsgSkipOld(uint32_t idClient)
603{
604 HGCMMsgSkip Msg;
605
606 /* Tell the host we want to skip the current assigned message. */
607 VBGL_HGCM_HDR_INIT(&Msg.hdr, idClient, GUEST_MSG_SKIP_OLD, 1);
608 VbglHGCMParmUInt32Set(&Msg.flags, 0 /* Flags, unused */);
609 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
610}
611
612
613/**
614 * Asks the host to cancel (release) all pending waits which were deferred.
615 *
616 * @returns VBox status code.
617 * @param idClient The client ID returned by VbglR3GuestCtrlConnect().
618 */
619VBGLR3DECL(int) VbglR3GuestCtrlCancelPendingWaits(uint32_t idClient)
620{
621 HGCMMsgCancelPendingWaits Msg;
622 VBGL_HGCM_HDR_INIT(&Msg.hdr, idClient, GUEST_MSG_CANCEL, 0);
623 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
624}
625
626
627/**
628 * Prepares a session.
629 * @since 6.0
630 * @sa GUEST_SESSION_PREPARE
631 */
632VBGLR3DECL(int) VbglR3GuestCtrlSessionPrepare(uint32_t idClient, uint32_t idSession, void const *pvKey, uint32_t cbKey)
633{
634 int rc;
635 do
636 {
637 struct
638 {
639 VBGLIOCHGCMCALL Hdr;
640 HGCMFunctionParameter idSession;
641 HGCMFunctionParameter pKey;
642 } Msg;
643 VBGL_HGCM_HDR_INIT(&Msg.Hdr, idClient, GUEST_MSG_SESSION_PREPARE, 2);
644 VbglHGCMParmUInt32Set(&Msg.idSession, idSession);
645 VbglHGCMParmPtrSet(&Msg.pKey, (void *)pvKey, cbKey);
646 rc = VbglR3HGCMCall(&Msg.Hdr, sizeof(Msg));
647 } while (rc == VERR_INTERRUPTED);
648 return rc;
649}
650
651
652/**
653 * Accepts a session.
654 * @since 6.0
655 * @sa GUEST_SESSION_ACCEPT
656 */
657VBGLR3DECL(int) VbglR3GuestCtrlSessionAccept(uint32_t idClient, uint32_t idSession, void const *pvKey, uint32_t cbKey)
658{
659 int rc;
660 do
661 {
662 struct
663 {
664 VBGLIOCHGCMCALL Hdr;
665 HGCMFunctionParameter idSession;
666 HGCMFunctionParameter pKey;
667 } Msg;
668 VBGL_HGCM_HDR_INIT(&Msg.Hdr, idClient, GUEST_MSG_SESSION_ACCEPT, 2);
669 VbglHGCMParmUInt32Set(&Msg.idSession, idSession);
670 VbglHGCMParmPtrSet(&Msg.pKey, (void *)pvKey, cbKey);
671 rc = VbglR3HGCMCall(&Msg.Hdr, sizeof(Msg));
672 } while (rc == VERR_INTERRUPTED);
673 return rc;
674}
675
676
677/**
678 * Cancels a prepared session.
679 * @since 6.0
680 * @sa GUEST_SESSION_CANCEL_PREPARED
681 */
682VBGLR3DECL(int) VbglR3GuestCtrlSessionCancelPrepared(uint32_t idClient, uint32_t idSession)
683{
684 int rc;
685 do
686 {
687 struct
688 {
689 VBGLIOCHGCMCALL Hdr;
690 HGCMFunctionParameter idSession;
691 } Msg;
692 VBGL_HGCM_HDR_INIT(&Msg.Hdr, idClient, GUEST_MSG_SESSION_CANCEL_PREPARED, 1);
693 VbglHGCMParmUInt32Set(&Msg.idSession, idSession);
694 rc = VbglR3HGCMCall(&Msg.Hdr, sizeof(Msg));
695 } while (rc == VERR_INTERRUPTED);
696 return rc;
697}
698
699
700/**
701 * Invalidates the internal state because the (VM) session has been changed (i.e. restored).
702 *
703 * @returns VBox status code.
704 * @param idClient Client ID to use for invalidating state.
705 * @param idNewControlSession New control session ID. Currently unused.
706 */
707VBGLR3DECL(int) VbglR3GuestCtrlSessionHasChanged(uint32_t idClient, uint64_t idNewControlSession)
708{
709 RT_NOREF(idNewControlSession);
710
711 vbglR3GuestCtrlDetectPeekGetCancelSupport(idClient);
712
713 return VINF_SUCCESS;
714}
715
716
717/**
718 * Asks a specific guest session to close.
719 *
720 * @return IPRT status code.
721 * @param pCtx Guest control command context to use.
722 * @param fFlags Some kind of flag. Figure it out yourself.
723 */
724VBGLR3DECL(int) VbglR3GuestCtrlSessionClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t fFlags)
725{
726 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
727 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
728
729 HGCMMsgSessionClose Msg;
730 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_SESSION_CLOSE, pCtx->uNumParms);
731 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
732 VbglHGCMParmUInt32Set(&Msg.flags, fFlags);
733
734 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
735}
736
737
738/**
739 * Notifies a guest session.
740 *
741 * @returns VBox status code.
742 * @param pCtx Guest control command context to use.
743 * @param uType Notification type of type GUEST_SESSION_NOTIFYTYPE_XXX.
744 * @param iResult Result code (rc) to notify.
745 */
746VBGLR3DECL(int) VbglR3GuestCtrlSessionNotify(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uType, int32_t iResult)
747{
748 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
749
750 HGCMMsgSessionNotify Msg;
751 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_SESSION_NOTIFY, 3);
752 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
753 VbglHGCMParmUInt32Set(&Msg.type, uType);
754 VbglHGCMParmUInt32Set(&Msg.result, (uint32_t)iResult);
755
756 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
757}
758
759/**
760 * Initializes a session startup info, extended version.
761 *
762 * @returns VBox status code.
763 * @param pStartupInfo Session startup info to initializes.
764 * @param cbUser Size (in bytes) to use for the user name buffer.
765 * @param cbPassword Size (in bytes) to use for the password buffer.
766 * @param cbDomain Size (in bytes) to use for the domain name buffer.
767 */
768VBGLR3DECL(int) VbglR3GuestCtrlSessionStartupInfoInitEx(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo,
769 size_t cbUser, size_t cbPassword, size_t cbDomain)
770{
771 AssertPtrReturn(pStartupInfo, VERR_INVALID_POINTER);
772
773 RT_BZERO(pStartupInfo, sizeof(VBGLR3GUESTCTRLSESSIONSTARTUPINFO));
774
775#define ALLOC_STR(a_Str, a_cb) \
776 if ((a_cb) > 0) \
777 { \
778 pStartupInfo->psz##a_Str = RTStrAlloc(a_cb); \
779 AssertPtrBreak(pStartupInfo->psz##a_Str); \
780 pStartupInfo->cb##a_Str = (uint32_t)a_cb; \
781 }
782
783 do
784 {
785 ALLOC_STR(User, cbUser);
786 ALLOC_STR(Password, cbPassword);
787 ALLOC_STR(Domain, cbDomain);
788
789 return VINF_SUCCESS;
790
791 } while (0);
792
793#undef ALLOC_STR
794
795 VbglR3GuestCtrlSessionStartupInfoDestroy(pStartupInfo);
796 return VERR_NO_MEMORY;
797}
798
799/**
800 * Initializes a session startup info.
801 *
802 * @returns VBox status code.
803 * @param pStartupInfo Session startup info to initializes.
804 */
805VBGLR3DECL(int) VbglR3GuestCtrlSessionStartupInfoInit(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo)
806{
807 return VbglR3GuestCtrlSessionStartupInfoInitEx(pStartupInfo,
808 GUEST_PROC_DEF_USER_LEN, GUEST_PROC_DEF_PASSWORD_LEN,
809 GUEST_PROC_DEF_DOMAIN_LEN);
810}
811
812/**
813 * Destroys a session startup info.
814 *
815 * @param pStartupInfo Session startup info to destroy.
816 */
817VBGLR3DECL(void) VbglR3GuestCtrlSessionStartupInfoDestroy(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo)
818{
819 if (!pStartupInfo)
820 return;
821
822 RTStrFree(pStartupInfo->pszUser);
823 RTStrFree(pStartupInfo->pszPassword);
824 RTStrFree(pStartupInfo->pszDomain);
825
826 RT_BZERO(pStartupInfo, sizeof(VBGLR3GUESTCTRLSESSIONSTARTUPINFO));
827}
828
829/**
830 * Free's a session startup info.
831 *
832 * @param pStartupInfo Session startup info to free.
833 * The pointer will not be valid anymore after return.
834 */
835VBGLR3DECL(void) VbglR3GuestCtrlSessionStartupInfoFree(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo)
836{
837 if (!pStartupInfo)
838 return;
839
840 VbglR3GuestCtrlSessionStartupInfoDestroy(pStartupInfo);
841
842 RTMemFree(pStartupInfo);
843 pStartupInfo = NULL;
844}
845
846/**
847 * Duplicates a session startup info.
848 *
849 * @returns Duplicated session startup info on success, or NULL on error.
850 * @param pStartupInfo Session startup info to duplicate.
851 */
852VBGLR3DECL(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO) VbglR3GuestCtrlSessionStartupInfoDup(PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo)
853{
854 AssertPtrReturn(pStartupInfo, NULL);
855
856 PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfoDup = (PVBGLR3GUESTCTRLSESSIONSTARTUPINFO)
857 RTMemDup(pStartupInfo, sizeof(VBGLR3GUESTCTRLSESSIONSTARTUPINFO));
858 if (pStartupInfoDup)
859 {
860 do
861 {
862 pStartupInfoDup->pszUser = NULL;
863 pStartupInfoDup->pszPassword = NULL;
864 pStartupInfoDup->pszDomain = NULL;
865
866#define DUP_STR(a_Str) \
867 if (pStartupInfo->cb##a_Str) \
868 { \
869 pStartupInfoDup->psz##a_Str = (char *)RTStrDup(pStartupInfo->psz##a_Str); \
870 AssertPtrBreak(pStartupInfoDup->psz##a_Str); \
871 pStartupInfoDup->cb##a_Str = (uint32_t)strlen(pStartupInfoDup->psz##a_Str) + 1 /* Include terminator */; \
872 }
873 DUP_STR(User);
874 DUP_STR(Password);
875 DUP_STR(Domain);
876
877#undef DUP_STR
878
879 return pStartupInfoDup;
880
881 } while (0); /* To use break macros above. */
882
883 VbglR3GuestCtrlSessionStartupInfoFree(pStartupInfoDup);
884 }
885
886 return NULL;
887}
888
889/**
890 * Retrieves a HOST_SESSION_CREATE message.
891 *
892 * @returns VBox status code.
893 * @param pCtx Guest control command context to use.
894 * @param ppStartupInfo Where to store the allocated session startup info.
895 * Needs to be free'd by VbglR3GuestCtrlSessionStartupInfoFree().
896 */
897VBGLR3DECL(int) VbglR3GuestCtrlSessionGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, PVBGLR3GUESTCTRLSESSIONSTARTUPINFO *ppStartupInfo)
898{
899 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
900 AssertReturn(pCtx->uNumParms == 6, VERR_INVALID_PARAMETER);
901 AssertPtrReturn(ppStartupInfo, VERR_INVALID_POINTER);
902
903 PVBGLR3GUESTCTRLSESSIONSTARTUPINFO pStartupInfo
904 = (PVBGLR3GUESTCTRLSESSIONSTARTUPINFO)RTMemAlloc(sizeof(VBGLR3GUESTCTRLSESSIONSTARTUPINFO));
905 if (!pStartupInfo)
906 return VERR_NO_MEMORY;
907
908 int rc = VbglR3GuestCtrlSessionStartupInfoInit(pStartupInfo);
909 if (RT_FAILURE(rc))
910 {
911 VbglR3GuestCtrlSessionStartupInfoFree(pStartupInfo);
912 return rc;
913 }
914
915 do
916 {
917 HGCMMsgSessionOpen Msg;
918 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
919 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_SESSION_CREATE);
920 VbglHGCMParmUInt32Set(&Msg.protocol, 0);
921 VbglHGCMParmPtrSet(&Msg.username, pStartupInfo->pszUser, pStartupInfo->cbUser);
922 VbglHGCMParmPtrSet(&Msg.password, pStartupInfo->pszPassword, pStartupInfo->cbPassword);
923 VbglHGCMParmPtrSet(&Msg.domain, pStartupInfo->pszDomain, pStartupInfo->cbDomain);
924 VbglHGCMParmUInt32Set(&Msg.flags, 0);
925
926 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
927 if (RT_SUCCESS(rc))
928 {
929 Msg.context.GetUInt32(&pCtx->uContextID);
930 Msg.protocol.GetUInt32(&pStartupInfo->uProtocol);
931 Msg.flags.GetUInt32(&pStartupInfo->fFlags);
932
933 pStartupInfo->uSessionID = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(pCtx->uContextID);
934 }
935
936 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
937
938 if (RT_SUCCESS(rc))
939 {
940 *ppStartupInfo = pStartupInfo;
941 }
942 else
943 VbglR3GuestCtrlSessionStartupInfoFree(pStartupInfo);
944
945 LogFlowFuncLeaveRC(rc);
946 return rc;
947}
948
949
950/**
951 * Retrieves a HOST_SESSION_CLOSE message.
952 */
953VBGLR3DECL(int) VbglR3GuestCtrlSessionGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfFlags, uint32_t *pidSession)
954{
955 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
956 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
957
958 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
959
960 int rc;
961 do
962 {
963 HGCMMsgSessionClose Msg;
964 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
965 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_SESSION_CLOSE);
966 VbglHGCMParmUInt32Set(&Msg.flags, 0);
967
968 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
969 if (RT_SUCCESS(rc))
970 {
971 Msg.context.GetUInt32(&pCtx->uContextID);
972 Msg.flags.GetUInt32(pfFlags);
973
974 if (pidSession)
975 *pidSession = VBOX_GUESTCTRL_CONTEXTID_GET_SESSION(pCtx->uContextID);
976 }
977 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
978 return rc;
979}
980
981
982#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
983/**
984 * Retrieves a HOST_MSG_DIR_OPEN message.
985 *
986 * @returns VBox status code.
987 * @param pCtx Guest control command context to use.
988 * @param pszPath Where to return the directory path to open.
989 * @param cbPath Size (in bytes) of \a pszPath.
990 * @param pfFlags Where to return the directory listing flags.
991 * @param enmFilter Where to return the directory filter type.
992 * @param penmAttrAdd Where to return the additional attributes enumeration to use for reading directory entries later.
993 * @param pfReadFlags Where to return the flags for reading directory entries later.
994 */
995VBGLR3DECL(int) VbglR3GuestCtrlDirGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszPath, uint32_t cbPath, uint32_t *pfFlags,
996 GSTCTLDIRFILTER *penmFilter, GSTCTLFSOBJATTRADD *penmReadAttrAdd, uint32_t *pfReadFlags)
997{
998 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
999 AssertReturn(pCtx->uNumParms == 6, VERR_INVALID_PARAMETER);
1000
1001 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1002 AssertReturn(cbPath, VERR_INVALID_PARAMETER);
1003 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1004 AssertPtrReturn(penmFilter, VERR_INVALID_POINTER);
1005 AssertPtrReturn(penmReadAttrAdd, VERR_INVALID_POINTER);
1006 AssertPtrReturn(pfReadFlags, VERR_INVALID_POINTER);
1007
1008 int rc;
1009 do
1010 {
1011 HGCMMsgDirOpen Msg;
1012 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1013 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_DIR_OPEN);
1014 VbglHGCMParmPtrSet(&Msg.path, pszPath, cbPath);
1015 VbglHGCMParmUInt32Set(&Msg.filter, 0);
1016 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1017 VbglHGCMParmUInt32Set(&Msg.read_attr_add, 0);
1018 VbglHGCMParmUInt32Set(&Msg.read_flags, 0);
1019
1020 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1021 if (RT_SUCCESS(rc))
1022 {
1023 Msg.context.GetUInt32(&pCtx->uContextID);
1024 Msg.filter.GetUInt32((uint32_t *)penmFilter);
1025 Msg.flags.GetUInt32(pfFlags);
1026 Msg.read_attr_add.GetUInt32((uint32_t *)penmReadAttrAdd);
1027 Msg.read_flags.GetUInt32(pfReadFlags);
1028 }
1029 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1030 return rc;
1031}
1032
1033
1034/**
1035 * Retrieves a HOST_MSG_DIR_CLOSE message.
1036 *
1037 * @returns VBox status code.
1038 * @param pCtx Guest control command context to use.
1039 * @param puHandle Where to return the handle of the guest directory to close.
1040 */
1041VBGLR3DECL(int) VbglR3GuestCtrlDirGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle)
1042{
1043 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1044 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
1045
1046 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
1047
1048 int rc;
1049 do
1050 {
1051 HGCMMsgDirClose Msg;
1052 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1053 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_DIR_CLOSE);
1054 VbglHGCMParmUInt32Set(&Msg.handle, 0);
1055
1056 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1057 if (RT_SUCCESS(rc))
1058 {
1059 Msg.context.GetUInt32(&pCtx->uContextID);
1060 Msg.handle.GetUInt32(puHandle);
1061 }
1062 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1063 return rc;
1064}
1065
1066
1067/**
1068 * Retrieves a HOST_MSG_DIR_READ message.
1069 *
1070 * @returns VBox status code.
1071 * @param pCtx Guest control command context to use.
1072 * @param puHandle Where to return the directory handle to rewind.
1073 */
1074VBGLR3DECL(int) VbglR3GuestCtrlDirGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle)
1075{
1076 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1077 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
1078
1079 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
1080
1081 int rc;
1082 do
1083 {
1084 HGCMMsgDirRead Msg;
1085 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1086 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_DIR_READ);
1087 VbglHGCMParmUInt32Set(&Msg.handle, 0);
1088
1089 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1090 if (RT_SUCCESS(rc))
1091 {
1092 Msg.context.GetUInt32(&pCtx->uContextID);
1093 Msg.handle.GetUInt32(puHandle);
1094 }
1095 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1096 return rc;
1097}
1098
1099
1100/**
1101 * Retrieves a HOST_MSG_DIR_REWIND message.
1102 *
1103 * @returns VBox status code.
1104 * @param pCtx Guest control command context to use.
1105 * @param puHandle Where to return the directory handle to rewind.
1106 */
1107VBGLR3DECL(int) VbglR3GuestCtrlDirGetRewind(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle)
1108{
1109 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1110 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
1111
1112 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
1113
1114 int rc;
1115 do
1116 {
1117 HGCMMsgDirRewind Msg;
1118 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1119 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_DIR_REWIND);
1120 VbglHGCMParmUInt32Set(&Msg.handle, 0);
1121
1122 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1123 if (RT_SUCCESS(rc))
1124 {
1125 Msg.context.GetUInt32(&pCtx->uContextID);
1126 Msg.handle.GetUInt32(puHandle);
1127 }
1128 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1129 return rc;
1130}
1131
1132
1133/**
1134 * Retrieves a HOST_MSG_DIR_LIST message.
1135 *
1136 * @returns VBox status code.
1137 * @param pCtx Guest control command context to use.
1138 * @param puHandle Where to return the directory handle to rewind.
1139 * @param pcEntries Where to return the number of directory entries to read.
1140 * @param pfFlags Where to return the directory listing flags.
1141 */
1142VBGLR3DECL(int) VbglR3GuestCtrlDirGetList(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, uint32_t *pcEntries, uint32_t *pfFlags)
1143{
1144 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1145 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
1146
1147 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
1148 AssertPtrReturn(pcEntries, VERR_INVALID_POINTER);
1149 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1150
1151 int rc;
1152 do
1153 {
1154 HGCMMsgDirList Msg;
1155 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1156 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_DIR_LIST);
1157 VbglHGCMParmUInt32Set(&Msg.handle, 0);
1158 VbglHGCMParmUInt32Set(&Msg.num_entries, 0);
1159 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1160
1161 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1162 if (RT_SUCCESS(rc))
1163 {
1164 Msg.context.GetUInt32(&pCtx->uContextID);
1165 Msg.handle.GetUInt32(puHandle);
1166 Msg.num_entries.GetUInt32(pcEntries);
1167 Msg.flags.GetUInt32(pfFlags);
1168 }
1169 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1170 return rc;
1171}
1172#endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
1173
1174
1175/**
1176 * Retrieves a HOST_PATH_RENAME message.
1177 */
1178VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX pCtx,
1179 char *pszSource, uint32_t cbSource,
1180 char *pszDest, uint32_t cbDest,
1181 uint32_t *pfFlags)
1182{
1183 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1184 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
1185
1186 AssertPtrReturn(pszSource, VERR_INVALID_POINTER);
1187 AssertReturn(cbSource, VERR_INVALID_PARAMETER);
1188 AssertPtrReturn(pszDest, VERR_INVALID_POINTER);
1189 AssertReturn(cbDest, VERR_INVALID_PARAMETER);
1190 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1191
1192 int rc;
1193 do
1194 {
1195 HGCMMsgPathRename Msg;
1196 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1197 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_PATH_RENAME);
1198 VbglHGCMParmPtrSet(&Msg.source, pszSource, cbSource);
1199 VbglHGCMParmPtrSet(&Msg.dest, pszDest, cbDest);
1200 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1201
1202 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1203 if (RT_SUCCESS(rc))
1204 {
1205 Msg.context.GetUInt32(&pCtx->uContextID);
1206 Msg.flags.GetUInt32(pfFlags);
1207 }
1208
1209 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1210 return rc;
1211}
1212
1213
1214/**
1215 * Retrieves a HOST_PATH_USER_DOCUMENTS message.
1216 */
1217VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserDocuments(PVBGLR3GUESTCTRLCMDCTX pCtx)
1218{
1219 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1220 AssertReturn(pCtx->uNumParms == 1, VERR_INVALID_PARAMETER);
1221
1222 int rc;
1223 do
1224 {
1225 HGCMMsgPathUserDocuments Msg;
1226 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1227 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_PATH_USER_DOCUMENTS);
1228
1229 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1230 if (RT_SUCCESS(rc))
1231 Msg.context.GetUInt32(&pCtx->uContextID);
1232 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1233 return rc;
1234}
1235
1236
1237/**
1238 * Retrieves a HOST_PATH_USER_HOME message.
1239 */
1240VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserHome(PVBGLR3GUESTCTRLCMDCTX pCtx)
1241{
1242 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1243 AssertReturn(pCtx->uNumParms == 1, VERR_INVALID_PARAMETER);
1244
1245 int rc;
1246 do
1247 {
1248 HGCMMsgPathUserHome Msg;
1249 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1250 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_PATH_USER_HOME);
1251
1252 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1253 if (RT_SUCCESS(rc))
1254 Msg.context.GetUInt32(&pCtx->uContextID);
1255 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1256 return rc;
1257}
1258
1259
1260#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
1261/**
1262 * Retrieves a HOST_MSG_FS_QUERY_INFO message.
1263 *
1264 * @returns VBox status code.
1265 * @param pCtx Guest control command context to use.
1266 * @param pszPath Where to return the path of the file system object to query.
1267 * @param cbPath Size (in bytes) of \a pszPath.
1268 */
1269VBGLR3DECL(int) VbglR3GuestCtrlFsGetQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszPath, uint32_t cbPath)
1270{
1271 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1272
1273 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1274 AssertReturn(cbPath, VERR_INVALID_PARAMETER);
1275
1276 int rc;
1277 do
1278 {
1279 HGCMMsgFsQueryInfo Msg;
1280 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1281 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FS_QUERY_INFO);
1282 VbglHGCMParmPtrSet(&Msg.path, pszPath, cbPath);
1283
1284 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1285 if (RT_SUCCESS(rc))
1286 Msg.context.GetUInt32(&pCtx->uContextID);
1287
1288 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1289 return rc;
1290}
1291
1292/**
1293 * Retrieves a HOST_MSG_FS_OBJ_QUERY_INFO message.
1294 *
1295 * @returns VBox status code.
1296 * @param pCtx Guest control command context to use.
1297 * @param pszPath Where to return the path of the file system object to query.
1298 * @param cbPath Size (in bytes) of \a pszPath.
1299 * @param penmAddAttrib Where to return the additional attributes enumeration.
1300 * @param pfFlags Where to return the flags for .
1301 */
1302VBGLR3DECL(int) VbglR3GuestCtrlFsObjGetQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx,
1303 char *pszPath, uint32_t cbPath, GSTCTLFSOBJATTRADD *penmAddAttrib,
1304 uint32_t *pfFlags)
1305{
1306 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1307 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
1308
1309 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1310 AssertReturn(cbPath, VERR_INVALID_PARAMETER);
1311 AssertPtrReturn(penmAddAttrib, VERR_INVALID_POINTER);
1312 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1313
1314 int rc;
1315 do
1316 {
1317 HGCMMsgFsObjQueryInfo Msg;
1318 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1319 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FS_OBJ_QUERY_INFO);
1320 VbglHGCMParmPtrSet(&Msg.path, pszPath, cbPath);
1321 VbglHGCMParmUInt32Set(&Msg.add_attributes, 0);
1322 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1323
1324 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1325 if (RT_SUCCESS(rc))
1326 {
1327 Msg.context.GetUInt32(&pCtx->uContextID);
1328 Msg.add_attributes.GetUInt32((uint32_t *)penmAddAttrib);
1329 Msg.flags.GetUInt32(pfFlags);
1330 }
1331
1332 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1333 return rc;
1334}
1335
1336
1337/**
1338 * Retrieves a HOST_MSG_FS_CREATE_TEMP message.
1339 *
1340 * @returns VBox status code.
1341 * @param pCtx Guest control command context to use.
1342 * @param pszTemplate Where to return the template name.
1343 * @param cbTemplate Size (in bytes) of \a pszTemplate.
1344 * @param pszPath Where to return the temporary directory path.
1345 * @param cbTemplate Size (in bytes) of \a pszPath.
1346 * @param pfFlags Where to return the creation flags.
1347 * @param pfMode Where to return the creation mode.
1348 */
1349VBGLR3DECL(int) VbglR3GuestCtrlFsGetCreateTemp(PVBGLR3GUESTCTRLCMDCTX pCtx,
1350 char *pszTemplate, uint32_t cbTemplate, char *pszPath, uint32_t cbPath,
1351 uint32_t *pfFlags, uint32_t *pfMode)
1352{
1353 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1354 AssertReturn(pCtx->uNumParms == 5, VERR_INVALID_PARAMETER);
1355
1356 AssertPtrReturn(pszTemplate, VERR_INVALID_POINTER);
1357 AssertReturn(cbTemplate, VERR_INVALID_PARAMETER);
1358 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1359 AssertReturn(cbPath, VERR_INVALID_PARAMETER);
1360 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1361 AssertPtrReturn(pfMode, VERR_INVALID_POINTER);
1362
1363 int rc;
1364 do
1365 {
1366 HGCMMsgFsCreateTemp Msg;
1367 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1368 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FS_CREATE_TEMP);
1369 VbglHGCMParmPtrSet(&Msg.template_name, pszTemplate, cbTemplate);
1370 VbglHGCMParmPtrSet(&Msg.tmpdir, pszPath, cbPath);
1371 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1372 VbglHGCMParmUInt32Set(&Msg.mode, 0);
1373
1374 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1375 if (RT_SUCCESS(rc))
1376 {
1377 Msg.context.GetUInt32(&pCtx->uContextID);
1378 Msg.flags.GetUInt32(pfFlags);
1379 Msg.mode.GetUInt32(pfMode);
1380 }
1381
1382 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1383 return rc;
1384}
1385#endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
1386
1387
1388/**
1389 * Retrieves a HOST_MSG_SHUTDOWN message.
1390 *
1391 * @returns VBox status code.
1392 * @param pCtx Guest control command context to use.
1393 * @param pfAction Where to store the action flags on success.
1394 */
1395VBGLR3DECL(int) VbglR3GuestCtrlGetShutdown(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfAction)
1396{
1397 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1398 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
1399 AssertPtrReturn(pfAction, VERR_INVALID_POINTER);
1400
1401 int rc;
1402 do
1403 {
1404 HGCMMsgShutdown Msg;
1405 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1406 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_SHUTDOWN);
1407 VbglHGCMParmUInt32Set(&Msg.action, 0);
1408
1409 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1410 if (RT_SUCCESS(rc))
1411 {
1412 Msg.context.GetUInt32(&pCtx->uContextID);
1413 Msg.action.GetUInt32(pfAction);
1414 }
1415 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1416 return rc;
1417}
1418
1419/**
1420 * Initializes a process startup info, extended version.
1421 *
1422 * @returns VBox status code.
1423 * @param pStartupInfo Process startup info to initializes.
1424 * @param cbCmd Size (in bytes) to use for the command buffer.
1425 * @param cbArgs Size (in bytes) to use for the arguments buffer.
1426 * @param cbEnv Size (in bytes) to use for the environment buffer.
1427 * @param cbCwd Size (in bytes) to use for the current working directory.
1428 * @param cbUser Size (in bytes) to use for the user name buffer.
1429 * @param cbPassword Size (in bytes) to use for the password buffer.
1430 * @param cbDomain Size (in bytes) to use for the domain buffer.
1431 */
1432VBGLR3DECL(int) VbglR3GuestCtrlProcStartupInfoInitEx(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo,
1433 size_t cbCmd, size_t cbArgs, size_t cbEnv,
1434 size_t cbCwd,
1435 size_t cbUser, size_t cbPassword, size_t cbDomain)
1436{
1437 AssertPtrReturn(pStartupInfo, VERR_INVALID_POINTER);
1438 AssertReturn(cbCmd, VERR_INVALID_PARAMETER);
1439 AssertReturn(cbArgs, VERR_INVALID_PARAMETER);
1440 AssertReturn(cbEnv, VERR_INVALID_PARAMETER);
1441 AssertReturn(cbCwd, VERR_INVALID_PARAMETER);
1442 AssertReturn(cbUser, VERR_INVALID_PARAMETER);
1443 AssertReturn(cbPassword, VERR_INVALID_PARAMETER);
1444 AssertReturn(cbDomain, VERR_INVALID_PARAMETER);
1445
1446 RT_BZERO(pStartupInfo, sizeof(VBGLR3GUESTCTRLPROCSTARTUPINFO));
1447
1448#define ALLOC_STR(a_Str, a_cb) \
1449 if ((a_cb) > 0) \
1450 { \
1451 pStartupInfo->psz##a_Str = RTStrAlloc(a_cb); \
1452 AssertPtrBreak(pStartupInfo->psz##a_Str); \
1453 pStartupInfo->cb##a_Str = (uint32_t)a_cb; \
1454 }
1455
1456 do
1457 {
1458 ALLOC_STR(Cmd, cbCmd);
1459 ALLOC_STR(Args, cbArgs);
1460 ALLOC_STR(Env, cbEnv);
1461 ALLOC_STR(Cwd, cbCwd);
1462 ALLOC_STR(User, cbUser);
1463 ALLOC_STR(Password, cbPassword);
1464 ALLOC_STR(Domain, cbDomain);
1465
1466 return VINF_SUCCESS;
1467
1468 } while (0);
1469
1470#undef ALLOC_STR
1471
1472 VbglR3GuestCtrlProcStartupInfoDestroy(pStartupInfo);
1473 return VERR_NO_MEMORY;
1474}
1475
1476/**
1477 * Initializes a process startup info with default values.
1478 *
1479 * @param pStartupInfo Process startup info to initialize.
1480 */
1481VBGLR3DECL(int) VbglR3GuestCtrlProcStartupInfoInit(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo)
1482{
1483 return VbglR3GuestCtrlProcStartupInfoInitEx(pStartupInfo,
1484 GUEST_PROC_DEF_CMD_LEN, GUEST_PROC_DEF_ARGS_LEN, GUEST_PROC_DEF_ENV_LEN,
1485 GUEST_PROC_DEF_CWD_LEN,
1486 GUEST_PROC_DEF_USER_LEN /* Deprecated, now handled via session creation. */,
1487 GUEST_PROC_DEF_PASSWORD_LEN /* Ditto. */,
1488 GUEST_PROC_DEF_DOMAIN_LEN /* Ditto. */);
1489}
1490
1491/**
1492 * Destroys a process startup info.
1493 *
1494 * @param pStartupInfo Process startup info to destroy.
1495 */
1496VBGLR3DECL(void) VbglR3GuestCtrlProcStartupInfoDestroy(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo)
1497{
1498 if (!pStartupInfo)
1499 return;
1500
1501 RTStrFree(pStartupInfo->pszCmd);
1502 RTStrFree(pStartupInfo->pszArgs);
1503 RTStrFree(pStartupInfo->pszEnv);
1504 RTStrFree(pStartupInfo->pszCwd);
1505 RTStrFree(pStartupInfo->pszUser);
1506 RTStrFree(pStartupInfo->pszPassword);
1507 RTStrFree(pStartupInfo->pszDomain);
1508
1509 RT_BZERO(pStartupInfo, sizeof(VBGLR3GUESTCTRLPROCSTARTUPINFO));
1510}
1511
1512/**
1513 * Free's a process startup info.
1514 *
1515 * @param pStartupInfo Process startup info to free.
1516 * The pointer will not be valid anymore after return.
1517 */
1518VBGLR3DECL(void) VbglR3GuestCtrlProcStartupInfoFree(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo)
1519{
1520 if (!pStartupInfo)
1521 return;
1522
1523 VbglR3GuestCtrlProcStartupInfoDestroy(pStartupInfo);
1524
1525 RTMemFree(pStartupInfo);
1526 pStartupInfo = NULL;
1527}
1528
1529/**
1530 * Duplicates a process startup info.
1531 *
1532 * @returns Duplicated process startup info on success, or NULL on error.
1533 * @param pStartupInfo Process startup info to duplicate.
1534 */
1535VBGLR3DECL(PVBGLR3GUESTCTRLPROCSTARTUPINFO) VbglR3GuestCtrlProcStartupInfoDup(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo)
1536{
1537 AssertPtrReturn(pStartupInfo, NULL);
1538
1539 PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfoDup = (PVBGLR3GUESTCTRLPROCSTARTUPINFO)
1540 RTMemDup(pStartupInfo, sizeof(VBGLR3GUESTCTRLPROCSTARTUPINFO));
1541 if (pStartupInfoDup)
1542 {
1543 do
1544 {
1545 pStartupInfoDup->pszCmd = NULL;
1546 pStartupInfoDup->pszArgs = NULL;
1547 pStartupInfoDup->pszEnv = NULL;
1548 pStartupInfoDup->pszCwd = NULL;
1549 pStartupInfoDup->pszUser = NULL;
1550 pStartupInfoDup->pszPassword = NULL;
1551 pStartupInfoDup->pszDomain = NULL;
1552
1553#define DUP_STR(a_Str) \
1554 if (pStartupInfo->cb##a_Str) \
1555 { \
1556 pStartupInfoDup->psz##a_Str = (char *)RTStrDup(pStartupInfo->psz##a_Str); \
1557 AssertPtrBreak(pStartupInfoDup->psz##a_Str); \
1558 pStartupInfoDup->cb##a_Str = (uint32_t)strlen(pStartupInfoDup->psz##a_Str) + 1 /* Include terminator */; \
1559 }
1560
1561#define DUP_MEM(a_Str) \
1562 if (pStartupInfo->cb##a_Str) \
1563 { \
1564 pStartupInfoDup->psz##a_Str = (char *)RTMemDup(pStartupInfo->psz##a_Str, pStartupInfo->cb##a_Str); \
1565 AssertPtrBreak(pStartupInfoDup->psz##a_Str); \
1566 pStartupInfoDup->cb##a_Str = (uint32_t)pStartupInfo->cb##a_Str; \
1567 }
1568
1569 DUP_STR(Cmd);
1570 DUP_MEM(Args);
1571 DUP_MEM(Env);
1572 DUP_MEM(Cwd);
1573 DUP_STR(User);
1574 DUP_STR(Password);
1575 DUP_STR(Domain);
1576
1577#undef DUP_STR
1578#undef DUP_MEM
1579
1580 return pStartupInfoDup;
1581
1582 } while (0); /* To use break macros above. */
1583
1584 VbglR3GuestCtrlProcStartupInfoFree(pStartupInfoDup);
1585 }
1586
1587 return NULL;
1588}
1589
1590/**
1591 * Retrieves a HOST_EXEC_CMD message.
1592 *
1593 * @returns VBox status code.
1594 * @param pCtx Guest control command context to use.
1595 * @param ppStartupInfo Where to store the allocated session startup info.
1596 * Needs to be free'd by VbglR3GuestCtrlProcStartupInfoFree().
1597 */
1598VBGLR3DECL(int) VbglR3GuestCtrlProcGetStart(PVBGLR3GUESTCTRLCMDCTX pCtx, PVBGLR3GUESTCTRLPROCSTARTUPINFO *ppStartupInfo)
1599{
1600 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1601 AssertPtrReturn(ppStartupInfo, VERR_INVALID_POINTER);
1602
1603 PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo
1604 = (PVBGLR3GUESTCTRLPROCSTARTUPINFO)RTMemAlloc(sizeof(VBGLR3GUESTCTRLPROCSTARTUPINFO));
1605 if (!pStartupInfo)
1606 return VERR_NO_MEMORY;
1607
1608 int rc = VbglR3GuestCtrlProcStartupInfoInit(pStartupInfo);
1609 if (RT_FAILURE(rc))
1610 {
1611 VbglR3GuestCtrlProcStartupInfoFree(pStartupInfo);
1612 return rc;
1613 }
1614
1615 unsigned cRetries = 0;
1616 const unsigned cMaxRetries = 32; /* Should be enough for now. */
1617 const unsigned cGrowthFactor = 2; /* By how much the buffers will grow if they're too small yet. */
1618
1619 do
1620 {
1621 LogRel(("VbglR3GuestCtrlProcGetStart: Retrieving\n"));
1622
1623 HGCMMsgProcExec Msg;
1624 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1625 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_EXEC_CMD);
1626 VbglHGCMParmPtrSet(&Msg.cmd, pStartupInfo->pszCmd, pStartupInfo->cbCmd);
1627 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1628 VbglHGCMParmUInt32Set(&Msg.num_args, 0);
1629 VbglHGCMParmPtrSet(&Msg.args, pStartupInfo->pszArgs, pStartupInfo->cbArgs);
1630 VbglHGCMParmUInt32Set(&Msg.num_env, 0);
1631 VbglHGCMParmUInt32Set(&Msg.cb_env, 0);
1632 VbglHGCMParmPtrSet(&Msg.env, pStartupInfo->pszEnv, pStartupInfo->cbEnv);
1633 if (pCtx->uProtocol < 2)
1634 {
1635 VbglHGCMParmPtrSet(&Msg.u.v1.username, pStartupInfo->pszUser, pStartupInfo->cbUser);
1636 VbglHGCMParmPtrSet(&Msg.u.v1.password, pStartupInfo->pszPassword, pStartupInfo->cbPassword);
1637 VbglHGCMParmUInt32Set(&Msg.u.v1.timeout, 0);
1638 }
1639 else
1640 {
1641 VbglHGCMParmUInt32Set(&Msg.u.v2.timeout, 0);
1642 VbglHGCMParmUInt32Set(&Msg.u.v2.priority, 0);
1643 VbglHGCMParmUInt32Set(&Msg.u.v2.num_affinity, 0);
1644 VbglHGCMParmPtrSet(&Msg.u.v2.affinity, pStartupInfo->uAffinity, sizeof(pStartupInfo->uAffinity));
1645 /* v2.cwd was added in 7.1. If the host is older, the Msg struct it sends is
1646 * shorter and these fields are zero-filled, which equals 'no cwd requested'. */
1647 VbglHGCMParmPtrSet(&Msg.u.v2.cwd, pStartupInfo->pszCwd, pStartupInfo->cbCwd);
1648 }
1649
1650 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1651 if (RT_FAILURE(rc))
1652 {
1653 LogRel(("VbglR3GuestCtrlProcGetStart: 1 - %Rrc (retry %u, cbCmd=%RU32, cbCwd=%RU32, cbArgs=%RU32, cbEnv=%RU32)\n",
1654 rc, cRetries, pStartupInfo->cbCmd, pStartupInfo->cbCwd, pStartupInfo->cbArgs, pStartupInfo->cbEnv));
1655
1656 if ( rc == VERR_BUFFER_OVERFLOW
1657 && cRetries++ < cMaxRetries)
1658 {
1659#define GROW_STR(a_Str, a_cbMax) \
1660 pStartupInfo->psz##a_Str = (char *)RTMemRealloc(pStartupInfo->psz##a_Str, \
1661 RT_MIN(pStartupInfo->cb##a_Str * cGrowthFactor, a_cbMax)); \
1662 AssertPtrBreakStmt(pStartupInfo->psz##a_Str, VERR_NO_MEMORY); \
1663 pStartupInfo->cb##a_Str = RT_MIN(pStartupInfo->cb##a_Str * cGrowthFactor, a_cbMax);
1664
1665 /* We can't tell which parameter doesn't fit, so we have to resize all. */
1666 GROW_STR(Cmd , GUEST_PROC_MAX_CMD_LEN);
1667 GROW_STR(Args, GUEST_PROC_MAX_ARGS_LEN);
1668 GROW_STR(Env, GUEST_PROC_MAX_ENV_LEN);
1669 GROW_STR(Cwd, GUEST_PROC_MAX_CWD_LEN);
1670#undef GROW_STR
1671 LogRel(("VbglR3GuestCtrlProcGetStart: 2 - %Rrc (retry %u, cbCmd=%RU32, cbCwd=%RU32, cbArgs=%RU32, cbEnv=%RU32)\n",
1672 rc, cRetries, pStartupInfo->cbCmd, pStartupInfo->cbCwd, pStartupInfo->cbArgs, pStartupInfo->cbEnv));
1673 LogRel(("g_fVbglR3GuestCtrlHavePeekGetCancel=%RTbool\n", RT_BOOL(g_fVbglR3GuestCtrlHavePeekGetCancel)));
1674 }
1675 else
1676 break;
1677 }
1678 else
1679 {
1680 Msg.context.GetUInt32(&pCtx->uContextID);
1681 Msg.flags.GetUInt32(&pStartupInfo->fFlags);
1682 Msg.num_args.GetUInt32(&pStartupInfo->cArgs);
1683 Msg.num_env.GetUInt32(&pStartupInfo->cEnvVars);
1684 Msg.cb_env.GetUInt32(&pStartupInfo->cbEnv);
1685 if (pCtx->uProtocol < 2)
1686 Msg.u.v1.timeout.GetUInt32(&pStartupInfo->uTimeLimitMS);
1687 else
1688 {
1689 Msg.u.v2.timeout.GetUInt32(&pStartupInfo->uTimeLimitMS);
1690 Msg.u.v2.priority.GetUInt32(&pStartupInfo->uPriority);
1691 Msg.u.v2.num_affinity.GetUInt32(&pStartupInfo->cAffinity);
1692 }
1693 }
1694 } while (( rc == VERR_INTERRUPTED
1695 || rc == VERR_BUFFER_OVERFLOW) && g_fVbglR3GuestCtrlHavePeekGetCancel);
1696
1697 if (RT_SUCCESS(rc))
1698 {
1699 *ppStartupInfo = pStartupInfo;
1700 }
1701 else
1702 VbglR3GuestCtrlProcStartupInfoFree(pStartupInfo);
1703
1704 LogRel(("VbglR3GuestCtrlProcGetStart: Returning %Rrc (retry %u, cbCmd=%RU32, cbArgs=%RU32, cbEnv=%RU32)\n",
1705 rc, cRetries, pStartupInfo->cbCmd, pStartupInfo->cbArgs, pStartupInfo->cbEnv));
1706
1707 LogFlowFuncLeaveRC(rc);
1708 return rc;
1709}
1710
1711/**
1712 * Allocates and gets host data, based on the message ID.
1713 *
1714 * This will block until data becomes available.
1715 *
1716 * @returns VBox status code.
1717 * @param pCtx Guest control command context to use.
1718 * @param puPID Where to return the guest PID to retrieve output from on success.
1719 * @param puHandle Where to return the guest process handle to retrieve output from on success.
1720 * @param pfFlags Where to return the output flags on success.
1721 */
1722VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx,
1723 uint32_t *puPID, uint32_t *puHandle, uint32_t *pfFlags)
1724{
1725 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1726 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
1727
1728 AssertPtrReturn(puPID, VERR_INVALID_POINTER);
1729 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
1730 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1731
1732 int rc;
1733 do
1734 {
1735 HGCMMsgProcOutput Msg;
1736 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1737 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_EXEC_GET_OUTPUT);
1738 VbglHGCMParmUInt32Set(&Msg.pid, 0);
1739 VbglHGCMParmUInt32Set(&Msg.handle, 0);
1740 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1741
1742 rc = VbglR3HGCMCall(&Msg.hdr, RT_UOFFSETOF(HGCMMsgProcOutput, data));
1743 if (RT_SUCCESS(rc))
1744 {
1745 Msg.context.GetUInt32(&pCtx->uContextID);
1746 Msg.pid.GetUInt32(puPID);
1747 Msg.handle.GetUInt32(puHandle);
1748 Msg.flags.GetUInt32(pfFlags);
1749 }
1750 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1751 return rc;
1752}
1753
1754
1755/**
1756 * Retrieves the input data from host which then gets sent to the started
1757 * process (HOST_EXEC_SET_INPUT).
1758 *
1759 * This will block until data becomes available.
1760 */
1761VBGLR3DECL(int) VbglR3GuestCtrlProcGetInput(PVBGLR3GUESTCTRLCMDCTX pCtx,
1762 uint32_t *puPID, uint32_t *pfFlags,
1763 void *pvData, uint32_t cbData,
1764 uint32_t *pcbSize)
1765{
1766 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1767 AssertReturn(pCtx->uNumParms == 5, VERR_INVALID_PARAMETER);
1768
1769 AssertPtrReturn(puPID, VERR_INVALID_POINTER);
1770 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1771 AssertPtrReturn(pvData, VERR_INVALID_POINTER);
1772 AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
1773
1774 int rc;
1775 do
1776 {
1777 HGCMMsgProcInput Msg;
1778 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1779 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_EXEC_SET_INPUT);
1780 VbglHGCMParmUInt32Set(&Msg.pid, 0);
1781 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1782 VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
1783 VbglHGCMParmUInt32Set(&Msg.size, 0);
1784
1785 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1786 if (RT_SUCCESS(rc))
1787 {
1788 Msg.context.GetUInt32(&pCtx->uContextID);
1789 Msg.pid.GetUInt32(puPID);
1790 Msg.flags.GetUInt32(pfFlags);
1791 Msg.size.GetUInt32(pcbSize);
1792 }
1793 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1794
1795 if ( rc != VERR_TOO_MUCH_DATA
1796 || g_fVbglR3GuestCtrlHavePeekGetCancel)
1797 return rc;
1798 return VERR_BUFFER_OVERFLOW;
1799}
1800
1801
1802#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
1803/**
1804 * Retrieves a HOST_MSG_DIR_CREATE message.
1805 *
1806 * @returns VBox status code.
1807 * @param pCtx Guest control command context to use.
1808 * @param pszPath Where to return the path.
1809 * @param cbPath Size (in bytes) of \a pszPath.
1810 * @param pfMode Where to return the creation mode.
1811 * @param pfFlags Where to return the creation flags (GSTCTL_CREATEDIRECTORY_F_XXX).
1812 */
1813VBGLR3DECL(int) VbglR3GuestCtrlDirGetCreate(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszPath, uint32_t cbPath, uint32_t *pfMode, uint32_t *pfFlags)
1814{
1815 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1816 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
1817
1818 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1819 AssertReturn(cbPath, VERR_INVALID_PARAMETER);
1820 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1821 AssertPtrReturn(pfMode, VERR_INVALID_POINTER);
1822
1823 int rc;
1824 do
1825 {
1826 HGCMMsgDirCreate Msg;
1827 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1828 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_DIR_CREATE);
1829 VbglHGCMParmPtrSet(&Msg.path, pszPath, cbPath);
1830 VbglHGCMParmUInt32Set(&Msg.mode, 0);
1831 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1832
1833 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1834 if (RT_SUCCESS(rc))
1835 {
1836 Msg.context.GetUInt32(&pCtx->uContextID);
1837 Msg.flags.GetUInt32(pfFlags);
1838 Msg.mode.GetUInt32(pfMode);
1839 }
1840
1841 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1842 return rc;
1843}
1844#endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
1845
1846
1847/**
1848 * Retrieves a HOST_DIR_REMOVE message.
1849 */
1850VBGLR3DECL(int) VbglR3GuestCtrlDirGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx,
1851 char *pszPath, uint32_t cbPath,
1852 uint32_t *pfFlags)
1853{
1854 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1855 AssertReturn(pCtx->uNumParms == 3, VERR_INVALID_PARAMETER);
1856
1857 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1858 AssertReturn(cbPath, VERR_INVALID_PARAMETER);
1859 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1860
1861 int rc;
1862 do
1863 {
1864 HGCMMsgDirRemove Msg;
1865 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1866 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_DIR_REMOVE);
1867 VbglHGCMParmPtrSet(&Msg.path, pszPath, cbPath);
1868 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1869
1870 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1871 if (RT_SUCCESS(rc))
1872 {
1873 Msg.context.GetUInt32(&pCtx->uContextID);
1874 Msg.flags.GetUInt32(pfFlags);
1875 }
1876 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1877 return rc;
1878}
1879
1880
1881/**
1882 * Retrieves a HOST_FILE_OPEN message.
1883 */
1884VBGLR3DECL(int) VbglR3GuestCtrlFileGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx,
1885 char *pszFileName, uint32_t cbFileName,
1886 char *pszAccess, uint32_t cbAccess,
1887 char *pszDisposition, uint32_t cbDisposition,
1888 char *pszSharing, uint32_t cbSharing,
1889 uint32_t *puCreationMode,
1890 uint64_t *poffAt)
1891{
1892 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1893 AssertReturn(pCtx->uNumParms == 7, VERR_INVALID_PARAMETER);
1894
1895 AssertPtrReturn(pszFileName, VERR_INVALID_POINTER);
1896 AssertReturn(cbFileName, VERR_INVALID_PARAMETER);
1897 AssertPtrReturn(pszAccess, VERR_INVALID_POINTER);
1898 AssertReturn(cbAccess, VERR_INVALID_PARAMETER);
1899 AssertPtrReturn(pszDisposition, VERR_INVALID_POINTER);
1900 AssertReturn(cbDisposition, VERR_INVALID_PARAMETER);
1901 AssertPtrReturn(pszSharing, VERR_INVALID_POINTER);
1902 AssertReturn(cbSharing, VERR_INVALID_PARAMETER);
1903 AssertPtrReturn(puCreationMode, VERR_INVALID_POINTER);
1904 AssertPtrReturn(poffAt, VERR_INVALID_POINTER);
1905
1906 int rc;
1907 do
1908 {
1909 HGCMMsgFileOpen Msg;
1910 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1911 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_OPEN);
1912 VbglHGCMParmPtrSet(&Msg.filename, pszFileName, cbFileName);
1913 VbglHGCMParmPtrSet(&Msg.openmode, pszAccess, cbAccess);
1914 VbglHGCMParmPtrSet(&Msg.disposition, pszDisposition, cbDisposition);
1915 VbglHGCMParmPtrSet(&Msg.sharing, pszSharing, cbSharing);
1916 VbglHGCMParmUInt32Set(&Msg.creationmode, 0);
1917 VbglHGCMParmUInt64Set(&Msg.offset, 0);
1918
1919 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1920 if (RT_SUCCESS(rc))
1921 {
1922 Msg.context.GetUInt32(&pCtx->uContextID);
1923 Msg.creationmode.GetUInt32(puCreationMode);
1924 Msg.offset.GetUInt64(poffAt);
1925 }
1926 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1927 return rc;
1928}
1929
1930
1931/**
1932 * Retrieves a HOST_FILE_CLOSE message.
1933 */
1934VBGLR3DECL(int) VbglR3GuestCtrlFileGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle)
1935{
1936 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1937
1938 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
1939 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
1940
1941 int rc;
1942 do
1943 {
1944 HGCMMsgFileClose Msg;
1945 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1946 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_CLOSE);
1947 VbglHGCMParmUInt32Set(&Msg.handle, 0);
1948
1949 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1950 if (RT_SUCCESS(rc))
1951 {
1952 Msg.context.GetUInt32(&pCtx->uContextID);
1953 Msg.handle.GetUInt32(puHandle);
1954 }
1955 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1956 return rc;
1957}
1958
1959
1960/**
1961 * Retrieves a HOST_FILE_READ message.
1962 */
1963VBGLR3DECL(int) VbglR3GuestCtrlFileGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, uint32_t *puToRead)
1964{
1965 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1966
1967 AssertReturn(pCtx->uNumParms == 3, VERR_INVALID_PARAMETER);
1968 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
1969 AssertPtrReturn(puToRead, VERR_INVALID_POINTER);
1970
1971 int rc;
1972 do
1973 {
1974 HGCMMsgFileRead Msg;
1975 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1976 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_READ);
1977 VbglHGCMParmUInt32Set(&Msg.handle, 0);
1978 VbglHGCMParmUInt32Set(&Msg.size, 0);
1979
1980 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1981 if (RT_SUCCESS(rc))
1982 {
1983 Msg.context.GetUInt32(&pCtx->uContextID);
1984 Msg.handle.GetUInt32(puHandle);
1985 Msg.size.GetUInt32(puToRead);
1986 }
1987 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1988 return rc;
1989}
1990
1991
1992/**
1993 * Retrieves a HOST_FILE_READ_AT message.
1994 */
1995VBGLR3DECL(int) VbglR3GuestCtrlFileGetReadAt(PVBGLR3GUESTCTRLCMDCTX pCtx,
1996 uint32_t *puHandle, uint32_t *puToRead, uint64_t *poffAt)
1997{
1998 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1999
2000 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
2001 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2002 AssertPtrReturn(puToRead, VERR_INVALID_POINTER);
2003
2004 int rc;
2005 do
2006 {
2007 HGCMMsgFileReadAt Msg;
2008 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2009 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_READ_AT);
2010 VbglHGCMParmUInt32Set(&Msg.handle, 0);
2011 VbglHGCMParmUInt64Set(&Msg.offset, 0);
2012 VbglHGCMParmUInt32Set(&Msg.size, 0);
2013
2014 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2015 if (RT_SUCCESS(rc))
2016 {
2017 Msg.context.GetUInt32(&pCtx->uContextID);
2018 Msg.handle.GetUInt32(puHandle);
2019 Msg.offset.GetUInt64(poffAt);
2020 Msg.size.GetUInt32(puToRead);
2021 }
2022 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2023 return rc;
2024}
2025
2026
2027/**
2028 * Retrieves a HOST_FILE_WRITE message.
2029 */
2030VBGLR3DECL(int) VbglR3GuestCtrlFileGetWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
2031 void *pvData, uint32_t cbData, uint32_t *pcbSize)
2032{
2033 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2034
2035 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
2036 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2037 AssertPtrReturn(pvData, VERR_INVALID_POINTER);
2038 AssertReturn(cbData, VERR_INVALID_PARAMETER);
2039 AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
2040
2041 int rc;
2042 do
2043 {
2044 HGCMMsgFileWrite Msg;
2045 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2046 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_WRITE);
2047 VbglHGCMParmUInt32Set(&Msg.handle, 0);
2048 VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
2049 VbglHGCMParmUInt32Set(&Msg.size, 0);
2050
2051 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2052 if (RT_SUCCESS(rc))
2053 {
2054 Msg.context.GetUInt32(&pCtx->uContextID);
2055 Msg.handle.GetUInt32(puHandle);
2056 Msg.size.GetUInt32(pcbSize);
2057 }
2058 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2059
2060 if ( rc != VERR_TOO_MUCH_DATA
2061 || g_fVbglR3GuestCtrlHavePeekGetCancel)
2062 return rc;
2063 return VERR_BUFFER_OVERFLOW;
2064}
2065
2066
2067/**
2068 * Retrieves a HOST_FILE_WRITE_AT message.
2069 */
2070VBGLR3DECL(int) VbglR3GuestCtrlFileGetWriteAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
2071 void *pvData, uint32_t cbData, uint32_t *pcbSize, uint64_t *poffAt)
2072{
2073 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2074
2075 AssertReturn(pCtx->uNumParms == 5, VERR_INVALID_PARAMETER);
2076 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2077 AssertPtrReturn(pvData, VERR_INVALID_POINTER);
2078 AssertReturn(cbData, VERR_INVALID_PARAMETER);
2079 AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
2080
2081 int rc;
2082 do
2083 {
2084 HGCMMsgFileWriteAt Msg;
2085 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2086 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_WRITE_AT);
2087 VbglHGCMParmUInt32Set(&Msg.handle, 0);
2088 VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
2089 VbglHGCMParmUInt32Set(&Msg.size, 0);
2090 VbglHGCMParmUInt64Set(&Msg.offset, 0);
2091
2092 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2093 if (RT_SUCCESS(rc))
2094 {
2095 Msg.context.GetUInt32(&pCtx->uContextID);
2096 Msg.handle.GetUInt32(puHandle);
2097 Msg.size.GetUInt32(pcbSize);
2098 Msg.offset.GetUInt64(poffAt);
2099 }
2100 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2101
2102 if ( rc != VERR_TOO_MUCH_DATA
2103 || g_fVbglR3GuestCtrlHavePeekGetCancel)
2104 return rc;
2105 return VERR_BUFFER_OVERFLOW;
2106}
2107
2108
2109/**
2110 * Retrieves a HOST_FILE_SEEK message.
2111 */
2112VBGLR3DECL(int) VbglR3GuestCtrlFileGetSeek(PVBGLR3GUESTCTRLCMDCTX pCtx,
2113 uint32_t *puHandle, uint32_t *puSeekMethod, uint64_t *poffAt)
2114{
2115 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2116
2117 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
2118 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2119 AssertPtrReturn(puSeekMethod, VERR_INVALID_POINTER);
2120 AssertPtrReturn(poffAt, VERR_INVALID_POINTER);
2121
2122 int rc;
2123 do
2124 {
2125 HGCMMsgFileSeek Msg;
2126 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2127 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_SEEK);
2128 VbglHGCMParmUInt32Set(&Msg.handle, 0);
2129 VbglHGCMParmUInt32Set(&Msg.method, 0);
2130 VbglHGCMParmUInt64Set(&Msg.offset, 0);
2131
2132 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2133 if (RT_SUCCESS(rc))
2134 {
2135 Msg.context.GetUInt32(&pCtx->uContextID);
2136 Msg.handle.GetUInt32(puHandle);
2137 Msg.method.GetUInt32(puSeekMethod);
2138 Msg.offset.GetUInt64(poffAt);
2139 }
2140 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2141 return rc;
2142}
2143
2144
2145/**
2146 * Retrieves a HOST_FILE_TELL message.
2147 */
2148VBGLR3DECL(int) VbglR3GuestCtrlFileGetTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle)
2149{
2150 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2151
2152 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
2153 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2154
2155 int rc;
2156 do
2157 {
2158 HGCMMsgFileTell Msg;
2159 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2160 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_TELL);
2161 VbglHGCMParmUInt32Set(&Msg.handle, 0);
2162
2163 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2164 if (RT_SUCCESS(rc))
2165 {
2166 Msg.context.GetUInt32(&pCtx->uContextID);
2167 Msg.handle.GetUInt32(puHandle);
2168 }
2169 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2170 return rc;
2171}
2172
2173
2174/**
2175 * Retrieves a HOST_FILE_SET_SIZE message.
2176 */
2177VBGLR3DECL(int) VbglR3GuestCtrlFileGetSetSize(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, uint64_t *pcbNew)
2178{
2179 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2180
2181 AssertReturn(pCtx->uNumParms == 3, VERR_INVALID_PARAMETER);
2182 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2183 AssertPtrReturn(pcbNew, VERR_INVALID_POINTER);
2184
2185 int rc;
2186 do
2187 {
2188 HGCMMsgFileSetSize Msg;
2189 VBGL_HGCM_HDR_INIT(&Msg.Hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2190 VbglHGCMParmUInt32Set(&Msg.id32Context, HOST_MSG_FILE_SET_SIZE);
2191 VbglHGCMParmUInt32Set(&Msg.id32Handle, 0);
2192 VbglHGCMParmUInt64Set(&Msg.cb64NewSize, 0);
2193
2194 rc = VbglR3HGCMCall(&Msg.Hdr, sizeof(Msg));
2195 if (RT_SUCCESS(rc))
2196 {
2197 Msg.id32Context.GetUInt32(&pCtx->uContextID);
2198 Msg.id32Handle.GetUInt32(puHandle);
2199 Msg.cb64NewSize.GetUInt64(pcbNew);
2200 }
2201 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2202 return rc;
2203}
2204
2205
2206#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
2207VBGLR3DECL(int) VbglR3GuestCtrlFileGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszFileName, uint32_t cbFileName)
2208{
2209 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2210
2211 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
2212 AssertPtrReturn(pszFileName, VERR_INVALID_POINTER);
2213 AssertReturn(cbFileName, VERR_INVALID_PARAMETER);
2214
2215 int rc;
2216 do
2217 {
2218 HGCMMsgFileRemove Msg;
2219 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2220 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_REMOVE);
2221 VbglHGCMParmPtrSet(&Msg.filename, pszFileName, cbFileName);
2222
2223 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2224 if (RT_SUCCESS(rc))
2225 {
2226 Msg.context.GetUInt32(&pCtx->uContextID);
2227 }
2228 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2229 return rc;
2230}
2231#endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
2232
2233
2234/**
2235 * Retrieves a HOST_EXEC_TERMINATE message.
2236 */
2237VBGLR3DECL(int) VbglR3GuestCtrlProcGetTerminate(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID)
2238{
2239 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2240
2241 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
2242 AssertPtrReturn(puPID, VERR_INVALID_POINTER);
2243
2244 int rc;
2245 do
2246 {
2247 HGCMMsgProcTerminate Msg;
2248 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2249 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_EXEC_TERMINATE);
2250 VbglHGCMParmUInt32Set(&Msg.pid, 0);
2251
2252 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2253 if (RT_SUCCESS(rc))
2254 {
2255 Msg.context.GetUInt32(&pCtx->uContextID);
2256 Msg.pid.GetUInt32(puPID);
2257 }
2258 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2259 return rc;
2260}
2261
2262
2263/**
2264 * Retrieves a HOST_EXEC_WAIT_FOR message.
2265 */
2266VBGLR3DECL(int) VbglR3GuestCtrlProcGetWaitFor(PVBGLR3GUESTCTRLCMDCTX pCtx,
2267 uint32_t *puPID, uint32_t *puWaitFlags, uint32_t *puTimeoutMS)
2268{
2269 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2270
2271 AssertReturn(pCtx->uNumParms == 5, VERR_INVALID_PARAMETER);
2272 AssertPtrReturn(puPID, VERR_INVALID_POINTER);
2273
2274 int rc;
2275 do
2276 {
2277 HGCMMsgProcWaitFor Msg;
2278 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2279 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_EXEC_WAIT_FOR);
2280 VbglHGCMParmUInt32Set(&Msg.pid, 0);
2281 VbglHGCMParmUInt32Set(&Msg.flags, 0);
2282 VbglHGCMParmUInt32Set(&Msg.timeout, 0);
2283
2284 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2285 if (RT_SUCCESS(rc))
2286 {
2287 Msg.context.GetUInt32(&pCtx->uContextID);
2288 Msg.pid.GetUInt32(puPID);
2289 Msg.flags.GetUInt32(puWaitFlags);
2290 Msg.timeout.GetUInt32(puTimeoutMS);
2291 }
2292 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2293 return rc;
2294}
2295
2296
2297/*********************************************************************************************************************************
2298 * Directory callbacks *
2299 ********************************************************************************************************************************/
2300
2301#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
2302/**
2303 * Replies to a HOST_MSG_DIR_OPEN message.
2304 *
2305 * @returns VBox status code.
2306 * @param pCtx Guest control command context to use.
2307 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2308 * @param uDirHandle Directory handle of opened directory.
2309 */
2310VBGLR3DECL(int) VbglR3GuestCtrlDirCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uDirHandle)
2311{
2312 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2313
2314 HGCMReplyDirNotify Msg;
2315 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_DIR_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS + 1);
2316 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2317 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_DIR_NOTIFYTYPE_OPEN);
2318 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2319
2320 VbglHGCMParmUInt32Set(&Msg.u.open.handle, uDirHandle);
2321
2322 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyDirNotify, u.open));
2323}
2324
2325
2326/**
2327 * Replies to a HOST_MSG_DIR_CLOSE message.
2328 *
2329 * @returns VBox status code.
2330 * @param pCtx Guest control command context to use.
2331 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2332 */
2333VBGLR3DECL(int) VbglR3GuestCtrlDirCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc)
2334{
2335 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2336
2337 HGCMReplyDirNotify Msg;
2338 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_DIR_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS);
2339 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2340 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_DIR_NOTIFYTYPE_CLOSE);
2341 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2342
2343 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyDirNotify, reply_hdr));
2344}
2345
2346
2347/**
2348 * Replies to a HOST_MSG_DIR_READ message, extended version.
2349 *
2350 * @returns VBox status code.
2351 * @param pCtx Guest control command context to use.
2352 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2353 * @param pEntry Directory entry to send.
2354 * @param cbSize Size (in bytes) of the OFFSET(GSTCTLDIRENTRYEX, szName[pEntry->cbName + 1]).
2355 * See RTDirReadEx() for more information.
2356 * @param pszUser Associated user ID (owner, uid) as a string.
2357 * @param pszGroups Associated user groups as a string.
2358 * Multiple groups are delimited by GSTCTL_DIRENTRY_GROUPS_DELIMITER_STR,
2359 * whereas the first group always is the primary group.
2360 */
2361VBGLR3DECL(int) VbglR3GuestCtrlDirCbReadEx(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLDIRENTRYEX pEntry, uint32_t cbSize,
2362 const char *pszUser, const char *pszGroups)
2363{
2364 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2365
2366 HGCMReplyDirNotify Msg;
2367 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_DIR_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS + 3);
2368 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2369 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_DIR_NOTIFYTYPE_READ);
2370 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2371
2372 VbglHGCMParmPtrSet (&Msg.u.read.entry, pEntry, cbSize);
2373 VbglHGCMParmPtrSetString(&Msg.u.read.user, pszUser);
2374 VbglHGCMParmPtrSetString(&Msg.u.read.groups, pszGroups);
2375
2376 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyDirNotify, u.read));
2377}
2378
2379
2380/**
2381 * Replies to a HOST_MSG_DIR_READ message.
2382 *
2383 * @returns VBox status code.
2384 * @param pCtx Guest control command context to use.
2385 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2386 * @param pEntry Directory entry to send.
2387 * @param cbSize Size (in bytes) of the OFFSET(GSTCTLDIRENTRYEX, szName[pEntry->cbName + 1]).
2388 * See RTDirReadEx() for more information.
2389 */
2390VBGLR3DECL(int) VbglR3GuestCtrlDirCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLDIRENTRYEX pEntry, uint32_t cbSize)
2391{
2392 char szIgnored[1] = { 0 };
2393 return VbglR3GuestCtrlDirCbReadEx(pCtx, uRc, pEntry, cbSize, szIgnored /* pszUser */, szIgnored /* pszGroups */);
2394}
2395
2396
2397/**
2398 * Replies to a HOST_MSG_DIR_REWIND message.
2399 *
2400 * @returns VBox status code.
2401 * @param pCtx Guest control command context to use.
2402 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2403 */
2404VBGLR3DECL(int) VbglR3GuestCtrlDirCbRewind(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc)
2405{
2406 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2407
2408 HGCMReplyDirNotify Msg;
2409 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_DIR_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS);
2410 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2411 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_DIR_NOTIFYTYPE_REWIND);
2412 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2413
2414 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyDirNotify, u));
2415}
2416
2417
2418/**
2419 * Replies to a HOST_MSG_DIR_LIST message.
2420 *
2421 * @returns VBox status code.
2422 * @param pCtx Guest control command context to use.
2423 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2424 * @þaram cEntries Number of directory entries to send.
2425 * @param pvBuf Buffer of directory entries to send.
2426 * @param cbBuf Size (in bytes) of \a pvBuf.
2427 */
2428VBGLR3DECL(int) VbglR3GuestCtrlDirCbList(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc,
2429 uint32_t cEntries, void *pvBuf, uint32_t cbBuf)
2430{
2431 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2432
2433 HGCMReplyDirNotify Msg;
2434 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_DIR_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS + 2);
2435 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2436 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_DIR_NOTIFYTYPE_LIST);
2437 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2438
2439 VbglHGCMParmUInt32Set(&Msg.u.list.num_entries, cEntries);
2440 VbglHGCMParmPtrSet(&Msg.u.list.buffer, pvBuf, cbBuf);
2441
2442 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyDirNotify, u.list));
2443}
2444#endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
2445
2446
2447/*********************************************************************************************************************************
2448 * File callbacks *
2449 ********************************************************************************************************************************/
2450
2451/**
2452 * Replies to a HOST_MSG_FILE_OPEN message.
2453 *
2454 * @returns VBox status code.
2455 * @param pCtx Guest control command context to use.
2456 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2457 * @param uFileHandle File handle of opened file on success.
2458 */
2459VBGLR3DECL(int) VbglR3GuestCtrlFileCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx,
2460 uint32_t uRc, uint32_t uFileHandle)
2461{
2462 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2463
2464 HGCMReplyFileNotify Msg;
2465 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2466 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2467 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_OPEN);
2468 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2469 VbglHGCMParmUInt32Set(&Msg.u.open.handle, uFileHandle);
2470
2471 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.open));
2472}
2473
2474
2475/**
2476 * Replies to a HOST_MSG_FILE_CLOSE message.
2477 *
2478 * @returns VBox status code.
2479 * @param pCtx Guest control command context to use.
2480 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2481 */
2482VBGLR3DECL(int) VbglR3GuestCtrlFileCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx,
2483 uint32_t uRc)
2484{
2485 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2486
2487 HGCMReplyFileNotify Msg;
2488 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 3);
2489 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2490 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_CLOSE);
2491 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2492
2493 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSETOF(HGCMReplyFileNotify, u));
2494}
2495
2496
2497/**
2498 * Sends an unexpected file handling error to the host.
2499 *
2500 * @returns VBox status code.
2501 * @param pCtx Guest control command context to use.
2502 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2503 */
2504VBGLR3DECL(int) VbglR3GuestCtrlFileCbError(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc)
2505{
2506 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2507
2508 HGCMReplyFileNotify Msg;
2509 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 3);
2510 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2511 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_ERROR);
2512 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2513
2514 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSETOF(HGCMReplyFileNotify, u));
2515}
2516
2517
2518/**
2519 * Replies to a HOST_MSG_FILE_READ message.
2520 *
2521 * @returns VBox status code.
2522 * @param pCtx Guest control command context to use.
2523 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2524 * @param pvData Pointer to read file data from guest on success.
2525 * @param cbData Size (in bytes) of read file data from guest on success.
2526 */
2527VBGLR3DECL(int) VbglR3GuestCtrlFileCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx,
2528 uint32_t uRc,
2529 void *pvData, uint32_t cbData)
2530{
2531 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2532
2533 HGCMReplyFileNotify Msg;
2534 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2535 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2536 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_READ);
2537 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2538 VbglHGCMParmPtrSet(&Msg.u.read.data, pvData, cbData);
2539
2540 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.read));
2541}
2542
2543
2544/**
2545 * Replies to a HOST_MSG_FILE_READ_AT message.
2546 *
2547 * @returns VBox status code.
2548 * @param pCtx Guest control command context to use.
2549 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2550 * @param pvData Pointer to read file data from guest on success.
2551 * @param cbData Size (in bytes) of read file data from guest on success.
2552 * @param offNew New offset (in bytes) the guest file pointer points at on success.
2553 */
2554VBGLR3DECL(int) VbglR3GuestCtrlFileCbReadOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc,
2555 void *pvData, uint32_t cbData, int64_t offNew)
2556{
2557 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2558
2559 HGCMReplyFileNotify Msg;
2560 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 5);
2561 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2562 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_READ_OFFSET);
2563 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2564 VbglHGCMParmPtrSet(&Msg.u.ReadOffset.pvData, pvData, cbData);
2565 VbglHGCMParmUInt64Set(&Msg.u.ReadOffset.off64New, (uint64_t)offNew);
2566
2567 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.ReadOffset));
2568}
2569
2570
2571/**
2572 * Replies to a HOST_MSG_FILE_WRITE message.
2573 *
2574 * @returns VBox status code.
2575 * @param pCtx Guest control command context to use.
2576 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2577 * @param cbWritten Size (in bytes) of file data successfully written to guest file. Can be partial.
2578 */
2579VBGLR3DECL(int) VbglR3GuestCtrlFileCbWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten)
2580{
2581 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2582
2583 HGCMReplyFileNotify Msg;
2584 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2585 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2586 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_WRITE);
2587 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2588 VbglHGCMParmUInt32Set(&Msg.u.write.written, cbWritten);
2589
2590 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.write));
2591}
2592
2593
2594/**
2595 * Replies to a HOST_MSG_FILE_WRITE_AT message.
2596 *
2597 * @returns VBox status code.
2598 * @param pCtx Guest control command context to use.
2599 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2600 * @param cbWritten Size (in bytes) of file data successfully written to guest file. Can be partial.
2601 * @param offNew New offset (in bytes) the guest file pointer points at on success.
2602 */
2603VBGLR3DECL(int) VbglR3GuestCtrlFileCbWriteOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten, int64_t offNew)
2604{
2605 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2606
2607 HGCMReplyFileNotify Msg;
2608 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 5);
2609 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2610 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_WRITE_OFFSET);
2611 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2612 VbglHGCMParmUInt32Set(&Msg.u.WriteOffset.cb32Written, cbWritten);
2613 VbglHGCMParmUInt64Set(&Msg.u.WriteOffset.off64New, (uint64_t)offNew);
2614
2615 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.WriteOffset));
2616}
2617
2618
2619/**
2620 * Replies to a HOST_MSG_FILE_SEEK message.
2621 *
2622 * @returns VBox status code.
2623 * @param pCtx Guest control command context to use.
2624 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2625 * @param offCurrent New offset (in bytes) the guest file pointer points at on success.
2626 */
2627VBGLR3DECL(int) VbglR3GuestCtrlFileCbSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent)
2628{
2629 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2630
2631 HGCMReplyFileNotify Msg;
2632 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2633 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2634 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_SEEK);
2635 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2636 VbglHGCMParmUInt64Set(&Msg.u.seek.offset, offCurrent);
2637
2638 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.seek));
2639}
2640
2641
2642/**
2643 * Replies to a HOST_MSG_FILE_TELL message.
2644 *
2645 * @returns VBox status code.
2646 * @param pCtx Guest control command context to use.
2647 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2648 * @param offCurrent Current offset (in bytes) the guest file pointer points at on success.
2649 */
2650VBGLR3DECL(int) VbglR3GuestCtrlFileCbTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent)
2651{
2652 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2653
2654 HGCMReplyFileNotify Msg;
2655 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2656 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2657 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_TELL);
2658 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2659 VbglHGCMParmUInt64Set(&Msg.u.tell.offset, offCurrent);
2660
2661 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.tell));
2662}
2663
2664
2665/**
2666 * Replies to a HOST_MSG_FILE_SET_SIZE message.
2667 *
2668 * @returns VBox status code.
2669 * @param pCtx Guest control command context to use.
2670 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2671 * @param cbNew New file size (in bytes) of the guest file on success.
2672 */
2673VBGLR3DECL(int) VbglR3GuestCtrlFileCbSetSize(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t cbNew)
2674{
2675 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2676
2677 HGCMReplyFileNotify Msg;
2678 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2679 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2680 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_SET_SIZE);
2681 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2682 VbglHGCMParmUInt64Set(&Msg.u.SetSize.cb64Size, cbNew);
2683
2684 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.SetSize));
2685}
2686
2687
2688/*********************************************************************************************************************************
2689 * File system callbacks *
2690 ********************************************************************************************************************************/
2691
2692#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
2693/**
2694 * Replies to a HOST_MSG_FS_OBJ_QUERY_INFO message, extended version.
2695 *
2696 * @returns VBox status code.
2697 * @param pCtx Guest control command context to use.
2698 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2699 * @param pFsObjInfo Guest file system object information to send.
2700 * @param pszUser Associated user ID (owner, uid) as a string.
2701 * @param pszGroups Associated user groups as a string.
2702 * Multiple groups are delimited by GSTCTL_DIRENTRY_GROUPS_DELIMITER_STR,
2703 * whereas the first group always is the primary group.
2704 */
2705VBGLR3DECL(int) VbglR3GuestCtrlFsObjCbQueryInfoEx(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSOBJINFO pFsObjInfo,
2706 const char *pszUser, const char *pszGroups)
2707{
2708 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2709 AssertPtrReturn(pFsObjInfo, VERR_INVALID_POINTER);
2710 AssertPtrReturn(pszUser, VERR_INVALID_POINTER);
2711 AssertPtrReturn(pszGroups, VERR_INVALID_POINTER);
2712
2713 HGCMReplyFsNotify Msg;
2714 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_FS_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS + 3);
2715 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2716 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_FS_NOTIFYTYPE_QUERY_OBJ_INFO);
2717 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2718
2719 VbglHGCMParmPtrSet (&Msg.u.queryobjinfo.obj_info, pFsObjInfo, sizeof(GSTCTLFSOBJINFO));
2720 VbglHGCMParmPtrSetString(&Msg.u.queryobjinfo.user, pszUser);
2721 VbglHGCMParmPtrSetString(&Msg.u.queryobjinfo.groups, pszGroups);
2722
2723 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyFsNotify, u.queryobjinfo));
2724}
2725
2726
2727/**
2728 * Replies to a HOST_MSG_FS_OBJ_QUERY_INFO message.
2729 *
2730 * @returns VBox status code.
2731 * @param pCtx Guest control command context to use.
2732 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2733 * @param pFsObjInfo Guest file system object information to send.
2734 */
2735VBGLR3DECL(int) VbglR3GuestCtrlFsObjCbQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSOBJINFO pFsObjInfo)
2736{
2737 char szIgnored[1] = { 0 };
2738 return VbglR3GuestCtrlFsObjCbQueryInfoEx(pCtx, uRc, pFsObjInfo, szIgnored /* pszUser */, szIgnored /* pszGroups */);
2739}
2740
2741
2742/**
2743 * Replies to a HOST_MSG_FS_CREATE_TEMP message.
2744 *
2745 * @returns VBox status code.
2746 * @param pCtx Guest control command context to use.
2747 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2748 * @param pszPath Path of created temporary file / directory, if \a uRc marks a success.
2749 * Specify an empty path on failure -- NULL is not allowed!
2750 */
2751VBGLR3DECL(int) VbglR3GuestCtrlFsCbCreateTemp(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, const char *pszPath)
2752{
2753 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2754 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
2755
2756 HGCMReplyFsNotify Msg;
2757 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_FS_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS + 1);
2758 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2759 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_FS_NOTIFYTYPE_CREATE_TEMP);
2760 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2761
2762 VbglHGCMParmPtrSetString(&Msg.u.createtemp.path, pszPath);
2763
2764 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyFsNotify, u.createtemp));
2765}
2766
2767/**
2768 * Replies to a HOST_MSG_FS_QUERY_INFO message.
2769 *
2770 * @returns VBox status code.
2771 * @param pCtx Guest control command context to use.
2772 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2773 * @param pFsInfo File system information to return.
2774 * @param cbFsInfo Size (in bytes) of \a pFsInfo.
2775 */
2776VBGLR3DECL(int) VbglR3GuestCtrlFsCbQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSINFO pFsInfo, uint32_t cbFsInfo)
2777{
2778 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2779 AssertPtrReturn(pFsInfo, VERR_INVALID_POINTER);
2780 AssertReturn(cbFsInfo, VERR_INVALID_PARAMETER);
2781
2782 HGCMReplyFsNotify Msg;
2783 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_FS_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS + 1);
2784 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2785 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_FS_NOTIFYTYPE_QUERY_INFO);
2786 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2787
2788 VbglHGCMParmPtrSet(&Msg.u.queryinfo.fs_info, pFsInfo, cbFsInfo);
2789
2790 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyFsNotify, u.queryinfo));
2791}
2792#endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
2793
2794
2795/*********************************************************************************************************************************
2796 * Process callbacks *
2797 ********************************************************************************************************************************/
2798
2799/**
2800 * Callback for reporting a guest process status (along with some other stuff) to the host.
2801 *
2802 * @returns VBox status code.
2803 * @param pCtx Guest control command context to use.
2804 * @param uPID Guest process PID to report status for.
2805 * @param uStatus Status to report. Of type PROC_STS_XXX.
2806 * @param fFlags Additional status flags, depending on the reported status. See RTPROCSTATUS.
2807 * @param pvData Pointer to additional status data. Optional.
2808 * @param cbData Size (in bytes) of additional status data.
2809 */
2810VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx,
2811 uint32_t uPID, uint32_t uStatus, uint32_t fFlags,
2812 void *pvData, uint32_t cbData)
2813{
2814 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2815
2816 HGCMMsgProcStatus Msg;
2817 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_EXEC_STATUS, 5);
2818 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2819 VbglHGCMParmUInt32Set(&Msg.pid, uPID);
2820 VbglHGCMParmUInt32Set(&Msg.status, uStatus);
2821 VbglHGCMParmUInt32Set(&Msg.flags, fFlags);
2822 VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
2823
2824 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2825}
2826
2827
2828/**
2829 * Sends output (from stdout/stderr) from a running process.
2830 *
2831 * @returns VBox status code.
2832 * @param pCtx Guest control command context to use.
2833 * @param uPID Guest process PID to report status for.
2834 * @param uHandle Guest process handle the output belong to.
2835 * @param fFlags Additional output flags.
2836 * @param pvData Pointer to actual output data.
2837 * @param cbData Size (in bytes) of output data.
2838 */
2839VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx,
2840 uint32_t uPID,uint32_t uHandle, uint32_t fFlags,
2841 void *pvData, uint32_t cbData)
2842{
2843 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2844
2845 HGCMMsgProcOutput Msg;
2846 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_EXEC_OUTPUT, 5);
2847 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2848 VbglHGCMParmUInt32Set(&Msg.pid, uPID);
2849 VbglHGCMParmUInt32Set(&Msg.handle, uHandle);
2850 VbglHGCMParmUInt32Set(&Msg.flags, fFlags);
2851 VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
2852
2853 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2854}
2855
2856
2857/**
2858 * Callback for reporting back the input status of a guest process to the host.
2859 *
2860 * @returns VBox status code.
2861 * @param pCtx Guest control command context to use.
2862 * @param uPID Guest process PID to report status for.
2863 * @param uStatus Status to report. Of type INPUT_STS_XXX.
2864 * @param fFlags Additional input flags.
2865 * @param cbWritten Size (in bytes) of input data handled.
2866 */
2867VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx,
2868 uint32_t uPID, uint32_t uStatus,
2869 uint32_t fFlags, uint32_t cbWritten)
2870{
2871 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2872
2873 HGCMMsgProcStatusInput Msg;
2874 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_EXEC_INPUT_STATUS, 5);
2875 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2876 VbglHGCMParmUInt32Set(&Msg.pid, uPID);
2877 VbglHGCMParmUInt32Set(&Msg.status, uStatus);
2878 VbglHGCMParmUInt32Set(&Msg.flags, fFlags);
2879 VbglHGCMParmUInt32Set(&Msg.written, cbWritten);
2880
2881 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2882}
2883
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