VirtualBox

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

Last change on this file since 102833 was 102833, checked in by vboxsync, 17 months ago

Guest Control: Added a flag for the get mount points HGCM API, so that we later can specify which mount points we want to get (or skip). bugref:10415
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 108.6 KB
Line 
1/* $Id: VBoxGuestR3LibGuestCtrl.cpp 102833 2024-01-11 09:18:25Z 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.215389.xyz.
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 *
1178 * @returns VBox status code.
1179 * @param pCtx Guest control command context to use.
1180 * @param pszSource Where to return the source path.
1181 * @param cbSource Size (in bytes) of \a pszSource.
1182 * @param pszDest Where to return the destination path.
1183 * @param cbDest Size (in bytes) of \a pszDest.
1184 * @param pfFlags Where to return the rename flags.
1185 */
1186VBGLR3DECL(int) VbglR3GuestCtrlPathGetRename(PVBGLR3GUESTCTRLCMDCTX pCtx,
1187 char *pszSource, uint32_t cbSource,
1188 char *pszDest, uint32_t cbDest,
1189 uint32_t *pfFlags)
1190{
1191 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1192 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
1193
1194 AssertPtrReturn(pszSource, VERR_INVALID_POINTER);
1195 AssertReturn(cbSource, VERR_INVALID_PARAMETER);
1196 AssertPtrReturn(pszDest, VERR_INVALID_POINTER);
1197 AssertReturn(cbDest, VERR_INVALID_PARAMETER);
1198 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1199
1200 int rc;
1201 do
1202 {
1203 HGCMMsgPathRename Msg;
1204 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1205 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_PATH_RENAME);
1206 VbglHGCMParmPtrSet(&Msg.source, pszSource, cbSource);
1207 VbglHGCMParmPtrSet(&Msg.dest, pszDest, cbDest);
1208 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1209
1210 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1211 if (RT_SUCCESS(rc))
1212 {
1213 Msg.context.GetUInt32(&pCtx->uContextID);
1214 Msg.flags.GetUInt32(pfFlags);
1215 }
1216
1217 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1218 return rc;
1219}
1220
1221
1222/**
1223 * Retrieves a HOST_PATH_USER_DOCUMENTS message.
1224 *
1225 * @param pCtx Guest control command context to use.
1226 */
1227VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserDocuments(PVBGLR3GUESTCTRLCMDCTX pCtx)
1228{
1229 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1230 AssertReturn(pCtx->uNumParms == 1, VERR_INVALID_PARAMETER);
1231
1232 int rc;
1233 do
1234 {
1235 HGCMMsgPathUserDocuments Msg;
1236 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1237 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_PATH_USER_DOCUMENTS);
1238
1239 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1240 if (RT_SUCCESS(rc))
1241 Msg.context.GetUInt32(&pCtx->uContextID);
1242 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1243 return rc;
1244}
1245
1246
1247/**
1248 * Retrieves a HOST_PATH_USER_HOME message.
1249 *
1250 * @param pCtx Guest control command context to use.
1251 */
1252VBGLR3DECL(int) VbglR3GuestCtrlPathGetUserHome(PVBGLR3GUESTCTRLCMDCTX pCtx)
1253{
1254 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1255 AssertReturn(pCtx->uNumParms == 1, VERR_INVALID_PARAMETER);
1256
1257 int rc;
1258 do
1259 {
1260 HGCMMsgPathUserHome Msg;
1261 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1262 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_PATH_USER_HOME);
1263
1264 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1265 if (RT_SUCCESS(rc))
1266 Msg.context.GetUInt32(&pCtx->uContextID);
1267 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1268 return rc;
1269}
1270
1271
1272/**
1273 * Retrieves a HOST_MSG_MOUNT_POINTS message.
1274 *
1275 * @param pCtx Guest control command context to use.
1276 * @param pfFlags Where to return the get mount point flags on success.
1277 */
1278VBGLR3DECL(int) VbglR3GuestCtrlGetMountPoints(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfFlags)
1279{
1280 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1281 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
1282 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1283
1284 int rc;
1285 do
1286 {
1287 HGCMMsgMountPoints Msg;
1288 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1289 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_MOUNT_POINTS);
1290
1291 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1292 if (RT_SUCCESS(rc))
1293 {
1294 Msg.context.GetUInt32(&pCtx->uContextID);
1295 Msg.flags.GetUInt32(pfFlags);
1296 }
1297 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1298 return rc;
1299}
1300
1301
1302#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
1303/**
1304 * Retrieves a HOST_MSG_FS_QUERY_INFO message.
1305 *
1306 * @returns VBox status code.
1307 * @param pCtx Guest control command context to use.
1308 * @param pszPath Where to return the path of the file system object to query.
1309 * @param cbPath Size (in bytes) of \a pszPath.
1310 */
1311VBGLR3DECL(int) VbglR3GuestCtrlFsGetQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszPath, uint32_t cbPath)
1312{
1313 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1314
1315 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1316 AssertReturn(cbPath, VERR_INVALID_PARAMETER);
1317
1318 int rc;
1319 do
1320 {
1321 HGCMMsgFsQueryInfo Msg;
1322 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1323 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FS_QUERY_INFO);
1324 VbglHGCMParmPtrSet(&Msg.path, pszPath, cbPath);
1325
1326 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1327 if (RT_SUCCESS(rc))
1328 Msg.context.GetUInt32(&pCtx->uContextID);
1329
1330 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1331 return rc;
1332}
1333
1334/**
1335 * Retrieves a HOST_MSG_FS_OBJ_QUERY_INFO message.
1336 *
1337 * @returns VBox status code.
1338 * @param pCtx Guest control command context to use.
1339 * @param pszPath Where to return the path of the file system object to query.
1340 * @param cbPath Size (in bytes) of \a pszPath.
1341 * @param penmAddAttrib Where to return the additional attributes enumeration.
1342 * @param pfFlags Where to return the flags for .
1343 */
1344VBGLR3DECL(int) VbglR3GuestCtrlFsObjGetQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx,
1345 char *pszPath, uint32_t cbPath, GSTCTLFSOBJATTRADD *penmAddAttrib,
1346 uint32_t *pfFlags)
1347{
1348 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1349 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
1350
1351 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1352 AssertReturn(cbPath, VERR_INVALID_PARAMETER);
1353 AssertPtrReturn(penmAddAttrib, VERR_INVALID_POINTER);
1354 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1355
1356 int rc;
1357 do
1358 {
1359 HGCMMsgFsObjQueryInfo Msg;
1360 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1361 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FS_OBJ_QUERY_INFO);
1362 VbglHGCMParmPtrSet(&Msg.path, pszPath, cbPath);
1363 VbglHGCMParmUInt32Set(&Msg.add_attributes, 0);
1364 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1365
1366 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1367 if (RT_SUCCESS(rc))
1368 {
1369 Msg.context.GetUInt32(&pCtx->uContextID);
1370 Msg.add_attributes.GetUInt32((uint32_t *)penmAddAttrib);
1371 Msg.flags.GetUInt32(pfFlags);
1372 }
1373
1374 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1375 return rc;
1376}
1377
1378
1379/**
1380 * Retrieves a HOST_MSG_FS_CREATE_TEMP message.
1381 *
1382 * @returns VBox status code.
1383 * @param pCtx Guest control command context to use.
1384 * @param pszTemplate Where to return the template name.
1385 * @param cbTemplate Size (in bytes) of \a pszTemplate.
1386 * @param pszPath Where to return the temporary directory path.
1387 * @param cbTemplate Size (in bytes) of \a pszPath.
1388 * @param pfFlags Where to return the creation flags.
1389 * @param pfMode Where to return the creation mode.
1390 */
1391VBGLR3DECL(int) VbglR3GuestCtrlFsGetCreateTemp(PVBGLR3GUESTCTRLCMDCTX pCtx,
1392 char *pszTemplate, uint32_t cbTemplate, char *pszPath, uint32_t cbPath,
1393 uint32_t *pfFlags, uint32_t *pfMode)
1394{
1395 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1396 AssertReturn(pCtx->uNumParms == 5, VERR_INVALID_PARAMETER);
1397
1398 AssertPtrReturn(pszTemplate, VERR_INVALID_POINTER);
1399 AssertReturn(cbTemplate, VERR_INVALID_PARAMETER);
1400 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1401 AssertReturn(cbPath, VERR_INVALID_PARAMETER);
1402 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1403 AssertPtrReturn(pfMode, VERR_INVALID_POINTER);
1404
1405 int rc;
1406 do
1407 {
1408 HGCMMsgFsCreateTemp Msg;
1409 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1410 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FS_CREATE_TEMP);
1411 VbglHGCMParmPtrSet(&Msg.template_name, pszTemplate, cbTemplate);
1412 VbglHGCMParmPtrSet(&Msg.tmpdir, pszPath, cbPath);
1413 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1414 VbglHGCMParmUInt32Set(&Msg.mode, 0);
1415
1416 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1417 if (RT_SUCCESS(rc))
1418 {
1419 Msg.context.GetUInt32(&pCtx->uContextID);
1420 Msg.flags.GetUInt32(pfFlags);
1421 Msg.mode.GetUInt32(pfMode);
1422 }
1423
1424 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1425 return rc;
1426}
1427#endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
1428
1429
1430/**
1431 * Retrieves a HOST_MSG_SHUTDOWN message.
1432 *
1433 * @returns VBox status code.
1434 * @param pCtx Guest control command context to use.
1435 * @param pfAction Where to store the action flags on success.
1436 */
1437VBGLR3DECL(int) VbglR3GuestCtrlGetShutdown(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfAction)
1438{
1439 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1440 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
1441 AssertPtrReturn(pfAction, VERR_INVALID_POINTER);
1442
1443 int rc;
1444 do
1445 {
1446 HGCMMsgShutdown Msg;
1447 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1448 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_SHUTDOWN);
1449 VbglHGCMParmUInt32Set(&Msg.action, 0);
1450
1451 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1452 if (RT_SUCCESS(rc))
1453 {
1454 Msg.context.GetUInt32(&pCtx->uContextID);
1455 Msg.action.GetUInt32(pfAction);
1456 }
1457 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1458 return rc;
1459}
1460
1461/**
1462 * Initializes a process startup info, extended version.
1463 *
1464 * @returns VBox status code.
1465 * @param pStartupInfo Process startup info to initializes.
1466 * @param cbCmd Size (in bytes) to use for the command buffer.
1467 * @param cbArgs Size (in bytes) to use for the arguments buffer.
1468 * @param cbEnv Size (in bytes) to use for the environment buffer.
1469 * @param cbCwd Size (in bytes) to use for the current working directory.
1470 * @param cbUser Size (in bytes) to use for the user name buffer.
1471 * @param cbPassword Size (in bytes) to use for the password buffer.
1472 * @param cbDomain Size (in bytes) to use for the domain buffer.
1473 */
1474VBGLR3DECL(int) VbglR3GuestCtrlProcStartupInfoInitEx(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo,
1475 size_t cbCmd, size_t cbArgs, size_t cbEnv,
1476 size_t cbCwd,
1477 size_t cbUser, size_t cbPassword, size_t cbDomain)
1478{
1479 AssertPtrReturn(pStartupInfo, VERR_INVALID_POINTER);
1480 AssertReturn(cbCmd, VERR_INVALID_PARAMETER);
1481 AssertReturn(cbArgs, VERR_INVALID_PARAMETER);
1482 AssertReturn(cbEnv, VERR_INVALID_PARAMETER);
1483 AssertReturn(cbCwd, VERR_INVALID_PARAMETER);
1484 AssertReturn(cbUser, VERR_INVALID_PARAMETER);
1485 AssertReturn(cbPassword, VERR_INVALID_PARAMETER);
1486 AssertReturn(cbDomain, VERR_INVALID_PARAMETER);
1487
1488 RT_BZERO(pStartupInfo, sizeof(VBGLR3GUESTCTRLPROCSTARTUPINFO));
1489
1490#define ALLOC_STR(a_Str, a_cb) \
1491 if ((a_cb) > 0) \
1492 { \
1493 pStartupInfo->psz##a_Str = RTStrAlloc(a_cb); \
1494 AssertPtrBreak(pStartupInfo->psz##a_Str); \
1495 pStartupInfo->cb##a_Str = (uint32_t)a_cb; \
1496 }
1497
1498 do
1499 {
1500 ALLOC_STR(Cmd, cbCmd);
1501 ALLOC_STR(Args, cbArgs);
1502 ALLOC_STR(Env, cbEnv);
1503 ALLOC_STR(Cwd, cbCwd);
1504 ALLOC_STR(User, cbUser);
1505 ALLOC_STR(Password, cbPassword);
1506 ALLOC_STR(Domain, cbDomain);
1507
1508 return VINF_SUCCESS;
1509
1510 } while (0);
1511
1512#undef ALLOC_STR
1513
1514 VbglR3GuestCtrlProcStartupInfoDestroy(pStartupInfo);
1515 return VERR_NO_MEMORY;
1516}
1517
1518/**
1519 * Initializes a process startup info with default values.
1520 *
1521 * @param pStartupInfo Process startup info to initialize.
1522 */
1523VBGLR3DECL(int) VbglR3GuestCtrlProcStartupInfoInit(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo)
1524{
1525 return VbglR3GuestCtrlProcStartupInfoInitEx(pStartupInfo,
1526 GUEST_PROC_DEF_CMD_LEN, GUEST_PROC_DEF_ARGS_LEN, GUEST_PROC_DEF_ENV_LEN,
1527 GUEST_PROC_DEF_CWD_LEN,
1528 GUEST_PROC_DEF_USER_LEN /* Deprecated, now handled via session creation. */,
1529 GUEST_PROC_DEF_PASSWORD_LEN /* Ditto. */,
1530 GUEST_PROC_DEF_DOMAIN_LEN /* Ditto. */);
1531}
1532
1533/**
1534 * Destroys a process startup info.
1535 *
1536 * @param pStartupInfo Process startup info to destroy.
1537 */
1538VBGLR3DECL(void) VbglR3GuestCtrlProcStartupInfoDestroy(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo)
1539{
1540 if (!pStartupInfo)
1541 return;
1542
1543 RTStrFree(pStartupInfo->pszCmd);
1544 RTStrFree(pStartupInfo->pszArgs);
1545 RTStrFree(pStartupInfo->pszEnv);
1546 RTStrFree(pStartupInfo->pszCwd);
1547 RTStrFree(pStartupInfo->pszUser);
1548 RTStrFree(pStartupInfo->pszPassword);
1549 RTStrFree(pStartupInfo->pszDomain);
1550
1551 RT_BZERO(pStartupInfo, sizeof(VBGLR3GUESTCTRLPROCSTARTUPINFO));
1552}
1553
1554/**
1555 * Free's a process startup info.
1556 *
1557 * @param pStartupInfo Process startup info to free.
1558 * The pointer will not be valid anymore after return.
1559 */
1560VBGLR3DECL(void) VbglR3GuestCtrlProcStartupInfoFree(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo)
1561{
1562 if (!pStartupInfo)
1563 return;
1564
1565 VbglR3GuestCtrlProcStartupInfoDestroy(pStartupInfo);
1566
1567 RTMemFree(pStartupInfo);
1568 pStartupInfo = NULL;
1569}
1570
1571/**
1572 * Duplicates a process startup info.
1573 *
1574 * @returns Duplicated process startup info on success, or NULL on error.
1575 * @param pStartupInfo Process startup info to duplicate.
1576 */
1577VBGLR3DECL(PVBGLR3GUESTCTRLPROCSTARTUPINFO) VbglR3GuestCtrlProcStartupInfoDup(PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo)
1578{
1579 AssertPtrReturn(pStartupInfo, NULL);
1580
1581 PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfoDup = (PVBGLR3GUESTCTRLPROCSTARTUPINFO)
1582 RTMemDup(pStartupInfo, sizeof(VBGLR3GUESTCTRLPROCSTARTUPINFO));
1583 if (pStartupInfoDup)
1584 {
1585 do
1586 {
1587 pStartupInfoDup->pszCmd = NULL;
1588 pStartupInfoDup->pszArgs = NULL;
1589 pStartupInfoDup->pszEnv = NULL;
1590 pStartupInfoDup->pszCwd = NULL;
1591 pStartupInfoDup->pszUser = NULL;
1592 pStartupInfoDup->pszPassword = NULL;
1593 pStartupInfoDup->pszDomain = NULL;
1594
1595#define DUP_STR(a_Str) \
1596 if (pStartupInfo->cb##a_Str) \
1597 { \
1598 pStartupInfoDup->psz##a_Str = (char *)RTStrDup(pStartupInfo->psz##a_Str); \
1599 AssertPtrBreak(pStartupInfoDup->psz##a_Str); \
1600 pStartupInfoDup->cb##a_Str = (uint32_t)strlen(pStartupInfoDup->psz##a_Str) + 1 /* Include terminator */; \
1601 }
1602
1603#define DUP_MEM(a_Str) \
1604 if (pStartupInfo->cb##a_Str) \
1605 { \
1606 pStartupInfoDup->psz##a_Str = (char *)RTMemDup(pStartupInfo->psz##a_Str, pStartupInfo->cb##a_Str); \
1607 AssertPtrBreak(pStartupInfoDup->psz##a_Str); \
1608 pStartupInfoDup->cb##a_Str = (uint32_t)pStartupInfo->cb##a_Str; \
1609 }
1610
1611 DUP_STR(Cmd);
1612 DUP_MEM(Args);
1613 DUP_MEM(Env);
1614 DUP_MEM(Cwd);
1615 DUP_STR(User);
1616 DUP_STR(Password);
1617 DUP_STR(Domain);
1618
1619#undef DUP_STR
1620#undef DUP_MEM
1621
1622 return pStartupInfoDup;
1623
1624 } while (0); /* To use break macros above. */
1625
1626 VbglR3GuestCtrlProcStartupInfoFree(pStartupInfoDup);
1627 }
1628
1629 return NULL;
1630}
1631
1632/**
1633 * Retrieves a HOST_EXEC_CMD message.
1634 *
1635 * @returns VBox status code.
1636 * @param pCtx Guest control command context to use.
1637 * @param ppStartupInfo Where to store the allocated session startup info.
1638 * Needs to be free'd by VbglR3GuestCtrlProcStartupInfoFree().
1639 */
1640VBGLR3DECL(int) VbglR3GuestCtrlProcGetStart(PVBGLR3GUESTCTRLCMDCTX pCtx, PVBGLR3GUESTCTRLPROCSTARTUPINFO *ppStartupInfo)
1641{
1642 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1643 AssertPtrReturn(ppStartupInfo, VERR_INVALID_POINTER);
1644
1645 PVBGLR3GUESTCTRLPROCSTARTUPINFO pStartupInfo
1646 = (PVBGLR3GUESTCTRLPROCSTARTUPINFO)RTMemAlloc(sizeof(VBGLR3GUESTCTRLPROCSTARTUPINFO));
1647 if (!pStartupInfo)
1648 return VERR_NO_MEMORY;
1649
1650 int rc = VbglR3GuestCtrlProcStartupInfoInit(pStartupInfo);
1651 if (RT_FAILURE(rc))
1652 {
1653 VbglR3GuestCtrlProcStartupInfoFree(pStartupInfo);
1654 return rc;
1655 }
1656
1657 unsigned cRetries = 0;
1658 const unsigned cMaxRetries = 32; /* Should be enough for now. */
1659 const unsigned cGrowthFactor = 2; /* By how much the buffers will grow if they're too small yet. */
1660
1661 do
1662 {
1663 LogRel(("VbglR3GuestCtrlProcGetStart: Retrieving\n"));
1664
1665 HGCMMsgProcExec Msg;
1666 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1667 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_EXEC_CMD);
1668 VbglHGCMParmPtrSet(&Msg.cmd, pStartupInfo->pszCmd, pStartupInfo->cbCmd);
1669 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1670 VbglHGCMParmUInt32Set(&Msg.num_args, 0);
1671 VbglHGCMParmPtrSet(&Msg.args, pStartupInfo->pszArgs, pStartupInfo->cbArgs);
1672 VbglHGCMParmUInt32Set(&Msg.num_env, 0);
1673 VbglHGCMParmUInt32Set(&Msg.cb_env, 0);
1674 VbglHGCMParmPtrSet(&Msg.env, pStartupInfo->pszEnv, pStartupInfo->cbEnv);
1675 if (pCtx->uProtocol < 2)
1676 {
1677 VbglHGCMParmPtrSet(&Msg.u.v1.username, pStartupInfo->pszUser, pStartupInfo->cbUser);
1678 VbglHGCMParmPtrSet(&Msg.u.v1.password, pStartupInfo->pszPassword, pStartupInfo->cbPassword);
1679 VbglHGCMParmUInt32Set(&Msg.u.v1.timeout, 0);
1680 }
1681 else
1682 {
1683 VbglHGCMParmUInt32Set(&Msg.u.v2.timeout, 0);
1684 VbglHGCMParmUInt32Set(&Msg.u.v2.priority, 0);
1685 VbglHGCMParmUInt32Set(&Msg.u.v2.num_affinity, 0);
1686 VbglHGCMParmPtrSet(&Msg.u.v2.affinity, pStartupInfo->uAffinity, sizeof(pStartupInfo->uAffinity));
1687 /* v2.cwd was added in 7.1. If the host is older, the Msg struct it sends is
1688 * shorter and these fields are zero-filled, which equals 'no cwd requested'. */
1689 VbglHGCMParmPtrSet(&Msg.u.v2.cwd, pStartupInfo->pszCwd, pStartupInfo->cbCwd);
1690 }
1691
1692 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1693 if (RT_FAILURE(rc))
1694 {
1695 LogRel(("VbglR3GuestCtrlProcGetStart: 1 - %Rrc (retry %u, cbCmd=%RU32, cbCwd=%RU32, cbArgs=%RU32, cbEnv=%RU32)\n",
1696 rc, cRetries, pStartupInfo->cbCmd, pStartupInfo->cbCwd, pStartupInfo->cbArgs, pStartupInfo->cbEnv));
1697
1698 if ( rc == VERR_BUFFER_OVERFLOW
1699 && cRetries++ < cMaxRetries)
1700 {
1701#define GROW_STR(a_Str, a_cbMax) \
1702 pStartupInfo->psz##a_Str = (char *)RTMemRealloc(pStartupInfo->psz##a_Str, \
1703 RT_MIN(pStartupInfo->cb##a_Str * cGrowthFactor, a_cbMax)); \
1704 AssertPtrBreakStmt(pStartupInfo->psz##a_Str, VERR_NO_MEMORY); \
1705 pStartupInfo->cb##a_Str = RT_MIN(pStartupInfo->cb##a_Str * cGrowthFactor, a_cbMax);
1706
1707 /* We can't tell which parameter doesn't fit, so we have to resize all. */
1708 GROW_STR(Cmd , GUEST_PROC_MAX_CMD_LEN);
1709 GROW_STR(Args, GUEST_PROC_MAX_ARGS_LEN);
1710 GROW_STR(Env, GUEST_PROC_MAX_ENV_LEN);
1711 GROW_STR(Cwd, GUEST_PROC_MAX_CWD_LEN);
1712#undef GROW_STR
1713 LogRel(("VbglR3GuestCtrlProcGetStart: 2 - %Rrc (retry %u, cbCmd=%RU32, cbCwd=%RU32, cbArgs=%RU32, cbEnv=%RU32)\n",
1714 rc, cRetries, pStartupInfo->cbCmd, pStartupInfo->cbCwd, pStartupInfo->cbArgs, pStartupInfo->cbEnv));
1715 LogRel(("g_fVbglR3GuestCtrlHavePeekGetCancel=%RTbool\n", RT_BOOL(g_fVbglR3GuestCtrlHavePeekGetCancel)));
1716 }
1717 else
1718 break;
1719 }
1720 else
1721 {
1722 Msg.context.GetUInt32(&pCtx->uContextID);
1723 Msg.flags.GetUInt32(&pStartupInfo->fFlags);
1724 Msg.num_args.GetUInt32(&pStartupInfo->cArgs);
1725 Msg.num_env.GetUInt32(&pStartupInfo->cEnvVars);
1726 Msg.cb_env.GetUInt32(&pStartupInfo->cbEnv);
1727 if (pCtx->uProtocol < 2)
1728 Msg.u.v1.timeout.GetUInt32(&pStartupInfo->uTimeLimitMS);
1729 else
1730 {
1731 Msg.u.v2.timeout.GetUInt32(&pStartupInfo->uTimeLimitMS);
1732 Msg.u.v2.priority.GetUInt32(&pStartupInfo->uPriority);
1733 Msg.u.v2.num_affinity.GetUInt32(&pStartupInfo->cAffinity);
1734 }
1735 }
1736 } while (( rc == VERR_INTERRUPTED
1737 || rc == VERR_BUFFER_OVERFLOW) && g_fVbglR3GuestCtrlHavePeekGetCancel);
1738
1739 if (RT_SUCCESS(rc))
1740 {
1741 *ppStartupInfo = pStartupInfo;
1742 }
1743 else
1744 VbglR3GuestCtrlProcStartupInfoFree(pStartupInfo);
1745
1746 LogRel(("VbglR3GuestCtrlProcGetStart: Returning %Rrc (retry %u, cbCmd=%RU32, cbArgs=%RU32, cbEnv=%RU32)\n",
1747 rc, cRetries, pStartupInfo->cbCmd, pStartupInfo->cbArgs, pStartupInfo->cbEnv));
1748
1749 LogFlowFuncLeaveRC(rc);
1750 return rc;
1751}
1752
1753/**
1754 * Allocates and gets host data, based on the message ID.
1755 *
1756 * This will block until data becomes available.
1757 *
1758 * @returns VBox status code.
1759 * @param pCtx Guest control command context to use.
1760 * @param puPID Where to return the guest PID to retrieve output from on success.
1761 * @param puHandle Where to return the guest process handle to retrieve output from on success.
1762 * @param pfFlags Where to return the output flags on success.
1763 */
1764VBGLR3DECL(int) VbglR3GuestCtrlProcGetOutput(PVBGLR3GUESTCTRLCMDCTX pCtx,
1765 uint32_t *puPID, uint32_t *puHandle, uint32_t *pfFlags)
1766{
1767 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1768 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
1769
1770 AssertPtrReturn(puPID, VERR_INVALID_POINTER);
1771 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
1772 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1773
1774 int rc;
1775 do
1776 {
1777 HGCMMsgProcOutput Msg;
1778 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1779 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_EXEC_GET_OUTPUT);
1780 VbglHGCMParmUInt32Set(&Msg.pid, 0);
1781 VbglHGCMParmUInt32Set(&Msg.handle, 0);
1782 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1783
1784 rc = VbglR3HGCMCall(&Msg.hdr, RT_UOFFSETOF(HGCMMsgProcOutput, data));
1785 if (RT_SUCCESS(rc))
1786 {
1787 Msg.context.GetUInt32(&pCtx->uContextID);
1788 Msg.pid.GetUInt32(puPID);
1789 Msg.handle.GetUInt32(puHandle);
1790 Msg.flags.GetUInt32(pfFlags);
1791 }
1792 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1793 return rc;
1794}
1795
1796
1797/**
1798 * Retrieves the input data from host which then gets sent to the started
1799 * process (HOST_EXEC_SET_INPUT).
1800 *
1801 * This will block until data becomes available.
1802 */
1803VBGLR3DECL(int) VbglR3GuestCtrlProcGetInput(PVBGLR3GUESTCTRLCMDCTX pCtx,
1804 uint32_t *puPID, uint32_t *pfFlags,
1805 void *pvData, uint32_t cbData,
1806 uint32_t *pcbSize)
1807{
1808 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1809 AssertReturn(pCtx->uNumParms == 5, VERR_INVALID_PARAMETER);
1810
1811 AssertPtrReturn(puPID, VERR_INVALID_POINTER);
1812 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1813 AssertPtrReturn(pvData, VERR_INVALID_POINTER);
1814 AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
1815
1816 int rc;
1817 do
1818 {
1819 HGCMMsgProcInput Msg;
1820 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1821 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_EXEC_SET_INPUT);
1822 VbglHGCMParmUInt32Set(&Msg.pid, 0);
1823 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1824 VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
1825 VbglHGCMParmUInt32Set(&Msg.size, 0);
1826
1827 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1828 if (RT_SUCCESS(rc))
1829 {
1830 Msg.context.GetUInt32(&pCtx->uContextID);
1831 Msg.pid.GetUInt32(puPID);
1832 Msg.flags.GetUInt32(pfFlags);
1833 Msg.size.GetUInt32(pcbSize);
1834 }
1835 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1836
1837 if ( rc != VERR_TOO_MUCH_DATA
1838 || g_fVbglR3GuestCtrlHavePeekGetCancel)
1839 return rc;
1840 return VERR_BUFFER_OVERFLOW;
1841}
1842
1843
1844#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
1845/**
1846 * Retrieves a HOST_MSG_DIR_CREATE message.
1847 *
1848 * @returns VBox status code.
1849 * @param pCtx Guest control command context to use.
1850 * @param pszPath Where to return the path.
1851 * @param cbPath Size (in bytes) of \a pszPath.
1852 * @param pfMode Where to return the creation mode.
1853 * @param pfFlags Where to return the creation flags (GSTCTL_CREATEDIRECTORY_F_XXX).
1854 */
1855VBGLR3DECL(int) VbglR3GuestCtrlDirGetCreate(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszPath, uint32_t cbPath, uint32_t *pfMode, uint32_t *pfFlags)
1856{
1857 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1858 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
1859
1860 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1861 AssertReturn(cbPath, VERR_INVALID_PARAMETER);
1862 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1863 AssertPtrReturn(pfMode, VERR_INVALID_POINTER);
1864
1865 int rc;
1866 do
1867 {
1868 HGCMMsgDirCreate Msg;
1869 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1870 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_DIR_CREATE);
1871 VbglHGCMParmPtrSet(&Msg.path, pszPath, cbPath);
1872 VbglHGCMParmUInt32Set(&Msg.mode, 0);
1873 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1874
1875 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1876 if (RT_SUCCESS(rc))
1877 {
1878 Msg.context.GetUInt32(&pCtx->uContextID);
1879 Msg.flags.GetUInt32(pfFlags);
1880 Msg.mode.GetUInt32(pfMode);
1881 }
1882
1883 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1884 return rc;
1885}
1886#endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
1887
1888
1889/**
1890 * Retrieves a HOST_DIR_REMOVE message.
1891 */
1892VBGLR3DECL(int) VbglR3GuestCtrlDirGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx,
1893 char *pszPath, uint32_t cbPath,
1894 uint32_t *pfFlags)
1895{
1896 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1897 AssertReturn(pCtx->uNumParms == 3, VERR_INVALID_PARAMETER);
1898
1899 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
1900 AssertReturn(cbPath, VERR_INVALID_PARAMETER);
1901 AssertPtrReturn(pfFlags, VERR_INVALID_POINTER);
1902
1903 int rc;
1904 do
1905 {
1906 HGCMMsgDirRemove Msg;
1907 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1908 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_DIR_REMOVE);
1909 VbglHGCMParmPtrSet(&Msg.path, pszPath, cbPath);
1910 VbglHGCMParmUInt32Set(&Msg.flags, 0);
1911
1912 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1913 if (RT_SUCCESS(rc))
1914 {
1915 Msg.context.GetUInt32(&pCtx->uContextID);
1916 Msg.flags.GetUInt32(pfFlags);
1917 }
1918 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1919 return rc;
1920}
1921
1922
1923/**
1924 * Retrieves a HOST_FILE_OPEN message.
1925 */
1926VBGLR3DECL(int) VbglR3GuestCtrlFileGetOpen(PVBGLR3GUESTCTRLCMDCTX pCtx,
1927 char *pszFileName, uint32_t cbFileName,
1928 char *pszAccess, uint32_t cbAccess,
1929 char *pszDisposition, uint32_t cbDisposition,
1930 char *pszSharing, uint32_t cbSharing,
1931 uint32_t *puCreationMode,
1932 uint64_t *poffAt)
1933{
1934 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1935 AssertReturn(pCtx->uNumParms == 7, VERR_INVALID_PARAMETER);
1936
1937 AssertPtrReturn(pszFileName, VERR_INVALID_POINTER);
1938 AssertReturn(cbFileName, VERR_INVALID_PARAMETER);
1939 AssertPtrReturn(pszAccess, VERR_INVALID_POINTER);
1940 AssertReturn(cbAccess, VERR_INVALID_PARAMETER);
1941 AssertPtrReturn(pszDisposition, VERR_INVALID_POINTER);
1942 AssertReturn(cbDisposition, VERR_INVALID_PARAMETER);
1943 AssertPtrReturn(pszSharing, VERR_INVALID_POINTER);
1944 AssertReturn(cbSharing, VERR_INVALID_PARAMETER);
1945 AssertPtrReturn(puCreationMode, VERR_INVALID_POINTER);
1946 AssertPtrReturn(poffAt, VERR_INVALID_POINTER);
1947
1948 int rc;
1949 do
1950 {
1951 HGCMMsgFileOpen Msg;
1952 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1953 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_OPEN);
1954 VbglHGCMParmPtrSet(&Msg.filename, pszFileName, cbFileName);
1955 VbglHGCMParmPtrSet(&Msg.openmode, pszAccess, cbAccess);
1956 VbglHGCMParmPtrSet(&Msg.disposition, pszDisposition, cbDisposition);
1957 VbglHGCMParmPtrSet(&Msg.sharing, pszSharing, cbSharing);
1958 VbglHGCMParmUInt32Set(&Msg.creationmode, 0);
1959 VbglHGCMParmUInt64Set(&Msg.offset, 0);
1960
1961 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1962 if (RT_SUCCESS(rc))
1963 {
1964 Msg.context.GetUInt32(&pCtx->uContextID);
1965 Msg.creationmode.GetUInt32(puCreationMode);
1966 Msg.offset.GetUInt64(poffAt);
1967 }
1968 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1969 return rc;
1970}
1971
1972
1973/**
1974 * Retrieves a HOST_FILE_CLOSE message.
1975 */
1976VBGLR3DECL(int) VbglR3GuestCtrlFileGetClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle)
1977{
1978 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
1979
1980 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
1981 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
1982
1983 int rc;
1984 do
1985 {
1986 HGCMMsgFileClose Msg;
1987 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
1988 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_CLOSE);
1989 VbglHGCMParmUInt32Set(&Msg.handle, 0);
1990
1991 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
1992 if (RT_SUCCESS(rc))
1993 {
1994 Msg.context.GetUInt32(&pCtx->uContextID);
1995 Msg.handle.GetUInt32(puHandle);
1996 }
1997 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
1998 return rc;
1999}
2000
2001
2002/**
2003 * Retrieves a HOST_FILE_READ message.
2004 */
2005VBGLR3DECL(int) VbglR3GuestCtrlFileGetRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, uint32_t *puToRead)
2006{
2007 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2008
2009 AssertReturn(pCtx->uNumParms == 3, VERR_INVALID_PARAMETER);
2010 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2011 AssertPtrReturn(puToRead, VERR_INVALID_POINTER);
2012
2013 int rc;
2014 do
2015 {
2016 HGCMMsgFileRead Msg;
2017 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2018 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_READ);
2019 VbglHGCMParmUInt32Set(&Msg.handle, 0);
2020 VbglHGCMParmUInt32Set(&Msg.size, 0);
2021
2022 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2023 if (RT_SUCCESS(rc))
2024 {
2025 Msg.context.GetUInt32(&pCtx->uContextID);
2026 Msg.handle.GetUInt32(puHandle);
2027 Msg.size.GetUInt32(puToRead);
2028 }
2029 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2030 return rc;
2031}
2032
2033
2034/**
2035 * Retrieves a HOST_FILE_READ_AT message.
2036 */
2037VBGLR3DECL(int) VbglR3GuestCtrlFileGetReadAt(PVBGLR3GUESTCTRLCMDCTX pCtx,
2038 uint32_t *puHandle, uint32_t *puToRead, uint64_t *poffAt)
2039{
2040 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2041
2042 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
2043 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2044 AssertPtrReturn(puToRead, VERR_INVALID_POINTER);
2045
2046 int rc;
2047 do
2048 {
2049 HGCMMsgFileReadAt Msg;
2050 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2051 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_READ_AT);
2052 VbglHGCMParmUInt32Set(&Msg.handle, 0);
2053 VbglHGCMParmUInt64Set(&Msg.offset, 0);
2054 VbglHGCMParmUInt32Set(&Msg.size, 0);
2055
2056 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2057 if (RT_SUCCESS(rc))
2058 {
2059 Msg.context.GetUInt32(&pCtx->uContextID);
2060 Msg.handle.GetUInt32(puHandle);
2061 Msg.offset.GetUInt64(poffAt);
2062 Msg.size.GetUInt32(puToRead);
2063 }
2064 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2065 return rc;
2066}
2067
2068
2069/**
2070 * Retrieves a HOST_FILE_WRITE message.
2071 */
2072VBGLR3DECL(int) VbglR3GuestCtrlFileGetWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
2073 void *pvData, uint32_t cbData, uint32_t *pcbSize)
2074{
2075 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2076
2077 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
2078 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2079 AssertPtrReturn(pvData, VERR_INVALID_POINTER);
2080 AssertReturn(cbData, VERR_INVALID_PARAMETER);
2081 AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
2082
2083 int rc;
2084 do
2085 {
2086 HGCMMsgFileWrite Msg;
2087 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2088 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_WRITE);
2089 VbglHGCMParmUInt32Set(&Msg.handle, 0);
2090 VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
2091 VbglHGCMParmUInt32Set(&Msg.size, 0);
2092
2093 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2094 if (RT_SUCCESS(rc))
2095 {
2096 Msg.context.GetUInt32(&pCtx->uContextID);
2097 Msg.handle.GetUInt32(puHandle);
2098 Msg.size.GetUInt32(pcbSize);
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_WRITE_AT message.
2111 */
2112VBGLR3DECL(int) VbglR3GuestCtrlFileGetWriteAt(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle,
2113 void *pvData, uint32_t cbData, uint32_t *pcbSize, uint64_t *poffAt)
2114{
2115 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2116
2117 AssertReturn(pCtx->uNumParms == 5, VERR_INVALID_PARAMETER);
2118 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2119 AssertPtrReturn(pvData, VERR_INVALID_POINTER);
2120 AssertReturn(cbData, VERR_INVALID_PARAMETER);
2121 AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
2122
2123 int rc;
2124 do
2125 {
2126 HGCMMsgFileWriteAt Msg;
2127 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2128 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_WRITE_AT);
2129 VbglHGCMParmUInt32Set(&Msg.handle, 0);
2130 VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
2131 VbglHGCMParmUInt32Set(&Msg.size, 0);
2132 VbglHGCMParmUInt64Set(&Msg.offset, 0);
2133
2134 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2135 if (RT_SUCCESS(rc))
2136 {
2137 Msg.context.GetUInt32(&pCtx->uContextID);
2138 Msg.handle.GetUInt32(puHandle);
2139 Msg.size.GetUInt32(pcbSize);
2140 Msg.offset.GetUInt64(poffAt);
2141 }
2142 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2143
2144 if ( rc != VERR_TOO_MUCH_DATA
2145 || g_fVbglR3GuestCtrlHavePeekGetCancel)
2146 return rc;
2147 return VERR_BUFFER_OVERFLOW;
2148}
2149
2150
2151/**
2152 * Retrieves a HOST_FILE_SEEK message.
2153 */
2154VBGLR3DECL(int) VbglR3GuestCtrlFileGetSeek(PVBGLR3GUESTCTRLCMDCTX pCtx,
2155 uint32_t *puHandle, uint32_t *puSeekMethod, uint64_t *poffAt)
2156{
2157 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2158
2159 AssertReturn(pCtx->uNumParms == 4, VERR_INVALID_PARAMETER);
2160 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2161 AssertPtrReturn(puSeekMethod, VERR_INVALID_POINTER);
2162 AssertPtrReturn(poffAt, VERR_INVALID_POINTER);
2163
2164 int rc;
2165 do
2166 {
2167 HGCMMsgFileSeek Msg;
2168 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2169 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_SEEK);
2170 VbglHGCMParmUInt32Set(&Msg.handle, 0);
2171 VbglHGCMParmUInt32Set(&Msg.method, 0);
2172 VbglHGCMParmUInt64Set(&Msg.offset, 0);
2173
2174 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2175 if (RT_SUCCESS(rc))
2176 {
2177 Msg.context.GetUInt32(&pCtx->uContextID);
2178 Msg.handle.GetUInt32(puHandle);
2179 Msg.method.GetUInt32(puSeekMethod);
2180 Msg.offset.GetUInt64(poffAt);
2181 }
2182 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2183 return rc;
2184}
2185
2186
2187/**
2188 * Retrieves a HOST_FILE_TELL message.
2189 */
2190VBGLR3DECL(int) VbglR3GuestCtrlFileGetTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle)
2191{
2192 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2193
2194 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
2195 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2196
2197 int rc;
2198 do
2199 {
2200 HGCMMsgFileTell Msg;
2201 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2202 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_TELL);
2203 VbglHGCMParmUInt32Set(&Msg.handle, 0);
2204
2205 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2206 if (RT_SUCCESS(rc))
2207 {
2208 Msg.context.GetUInt32(&pCtx->uContextID);
2209 Msg.handle.GetUInt32(puHandle);
2210 }
2211 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2212 return rc;
2213}
2214
2215
2216/**
2217 * Retrieves a HOST_FILE_SET_SIZE message.
2218 */
2219VBGLR3DECL(int) VbglR3GuestCtrlFileGetSetSize(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puHandle, uint64_t *pcbNew)
2220{
2221 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2222
2223 AssertReturn(pCtx->uNumParms == 3, VERR_INVALID_PARAMETER);
2224 AssertPtrReturn(puHandle, VERR_INVALID_POINTER);
2225 AssertPtrReturn(pcbNew, VERR_INVALID_POINTER);
2226
2227 int rc;
2228 do
2229 {
2230 HGCMMsgFileSetSize Msg;
2231 VBGL_HGCM_HDR_INIT(&Msg.Hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2232 VbglHGCMParmUInt32Set(&Msg.id32Context, HOST_MSG_FILE_SET_SIZE);
2233 VbglHGCMParmUInt32Set(&Msg.id32Handle, 0);
2234 VbglHGCMParmUInt64Set(&Msg.cb64NewSize, 0);
2235
2236 rc = VbglR3HGCMCall(&Msg.Hdr, sizeof(Msg));
2237 if (RT_SUCCESS(rc))
2238 {
2239 Msg.id32Context.GetUInt32(&pCtx->uContextID);
2240 Msg.id32Handle.GetUInt32(puHandle);
2241 Msg.cb64NewSize.GetUInt64(pcbNew);
2242 }
2243 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2244 return rc;
2245}
2246
2247
2248#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
2249VBGLR3DECL(int) VbglR3GuestCtrlFileGetRemove(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszFileName, uint32_t cbFileName)
2250{
2251 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2252
2253 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
2254 AssertPtrReturn(pszFileName, VERR_INVALID_POINTER);
2255 AssertReturn(cbFileName, VERR_INVALID_PARAMETER);
2256
2257 int rc;
2258 do
2259 {
2260 HGCMMsgFileRemove Msg;
2261 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2262 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_FILE_REMOVE);
2263 VbglHGCMParmPtrSet(&Msg.filename, pszFileName, cbFileName);
2264
2265 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2266 if (RT_SUCCESS(rc))
2267 {
2268 Msg.context.GetUInt32(&pCtx->uContextID);
2269 }
2270 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2271 return rc;
2272}
2273#endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
2274
2275
2276/**
2277 * Retrieves a HOST_EXEC_TERMINATE message.
2278 */
2279VBGLR3DECL(int) VbglR3GuestCtrlProcGetTerminate(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *puPID)
2280{
2281 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2282
2283 AssertReturn(pCtx->uNumParms == 2, VERR_INVALID_PARAMETER);
2284 AssertPtrReturn(puPID, VERR_INVALID_POINTER);
2285
2286 int rc;
2287 do
2288 {
2289 HGCMMsgProcTerminate Msg;
2290 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2291 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_EXEC_TERMINATE);
2292 VbglHGCMParmUInt32Set(&Msg.pid, 0);
2293
2294 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2295 if (RT_SUCCESS(rc))
2296 {
2297 Msg.context.GetUInt32(&pCtx->uContextID);
2298 Msg.pid.GetUInt32(puPID);
2299 }
2300 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2301 return rc;
2302}
2303
2304
2305/**
2306 * Retrieves a HOST_EXEC_WAIT_FOR message.
2307 */
2308VBGLR3DECL(int) VbglR3GuestCtrlProcGetWaitFor(PVBGLR3GUESTCTRLCMDCTX pCtx,
2309 uint32_t *puPID, uint32_t *puWaitFlags, uint32_t *puTimeoutMS)
2310{
2311 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2312
2313 AssertReturn(pCtx->uNumParms == 5, VERR_INVALID_PARAMETER);
2314 AssertPtrReturn(puPID, VERR_INVALID_POINTER);
2315
2316 int rc;
2317 do
2318 {
2319 HGCMMsgProcWaitFor Msg;
2320 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, vbglR3GuestCtrlGetMsgFunctionNo(pCtx->uClientID), pCtx->uNumParms);
2321 VbglHGCMParmUInt32Set(&Msg.context, HOST_MSG_EXEC_WAIT_FOR);
2322 VbglHGCMParmUInt32Set(&Msg.pid, 0);
2323 VbglHGCMParmUInt32Set(&Msg.flags, 0);
2324 VbglHGCMParmUInt32Set(&Msg.timeout, 0);
2325
2326 rc = VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2327 if (RT_SUCCESS(rc))
2328 {
2329 Msg.context.GetUInt32(&pCtx->uContextID);
2330 Msg.pid.GetUInt32(puPID);
2331 Msg.flags.GetUInt32(puWaitFlags);
2332 Msg.timeout.GetUInt32(puTimeoutMS);
2333 }
2334 } while (rc == VERR_INTERRUPTED && g_fVbglR3GuestCtrlHavePeekGetCancel);
2335 return rc;
2336}
2337
2338
2339/*********************************************************************************************************************************
2340 * Directory callbacks *
2341 ********************************************************************************************************************************/
2342
2343#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
2344/**
2345 * Replies to a HOST_MSG_DIR_OPEN message.
2346 *
2347 * @returns VBox status code.
2348 * @param pCtx Guest control command context to use.
2349 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2350 * @param uDirHandle Directory handle of opened directory.
2351 */
2352VBGLR3DECL(int) VbglR3GuestCtrlDirCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t uDirHandle)
2353{
2354 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2355
2356 HGCMReplyDirNotify Msg;
2357 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_DIR_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS + 1);
2358 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2359 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_DIR_NOTIFYTYPE_OPEN);
2360 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2361
2362 VbglHGCMParmUInt32Set(&Msg.u.open.handle, uDirHandle);
2363
2364 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyDirNotify, u.open));
2365}
2366
2367
2368/**
2369 * Replies to a HOST_MSG_DIR_CLOSE message.
2370 *
2371 * @returns VBox status code.
2372 * @param pCtx Guest control command context to use.
2373 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2374 */
2375VBGLR3DECL(int) VbglR3GuestCtrlDirCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc)
2376{
2377 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2378
2379 HGCMReplyDirNotify Msg;
2380 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_DIR_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS);
2381 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2382 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_DIR_NOTIFYTYPE_CLOSE);
2383 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2384
2385 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyDirNotify, reply_hdr));
2386}
2387
2388
2389/**
2390 * Replies to a HOST_MSG_DIR_READ message, extended version.
2391 *
2392 * @returns VBox status code.
2393 * @param pCtx Guest control command context to use.
2394 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2395 * @param pEntry Directory entry to send.
2396 * @param cbSize Size (in bytes) of the OFFSET(GSTCTLDIRENTRYEX, szName[pEntry->cbName + 1]).
2397 * See RTDirReadEx() for more information.
2398 * @param pszUser Associated user ID (owner, uid) as a string.
2399 * @param pszGroups Associated user groups as a string.
2400 * Multiple groups are delimited by GSTCTL_DIRENTRY_GROUPS_DELIMITER_STR,
2401 * whereas the first group always is the primary group.
2402 */
2403VBGLR3DECL(int) VbglR3GuestCtrlDirCbReadEx(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLDIRENTRYEX pEntry, uint32_t cbSize,
2404 const char *pszUser, const char *pszGroups)
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 + 3);
2410 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2411 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_DIR_NOTIFYTYPE_READ);
2412 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2413
2414 VbglHGCMParmPtrSet (&Msg.u.read.entry, pEntry, cbSize);
2415 VbglHGCMParmPtrSetString(&Msg.u.read.user, pszUser);
2416 VbglHGCMParmPtrSetString(&Msg.u.read.groups, pszGroups);
2417
2418 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyDirNotify, u.read));
2419}
2420
2421
2422/**
2423 * Replies to a HOST_MSG_DIR_READ message.
2424 *
2425 * @returns VBox status code.
2426 * @param pCtx Guest control command context to use.
2427 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2428 * @param pEntry Directory entry to send.
2429 * @param cbSize Size (in bytes) of the OFFSET(GSTCTLDIRENTRYEX, szName[pEntry->cbName + 1]).
2430 * See RTDirReadEx() for more information.
2431 */
2432VBGLR3DECL(int) VbglR3GuestCtrlDirCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLDIRENTRYEX pEntry, uint32_t cbSize)
2433{
2434 char szIgnored[1] = { 0 };
2435 return VbglR3GuestCtrlDirCbReadEx(pCtx, uRc, pEntry, cbSize, szIgnored /* pszUser */, szIgnored /* pszGroups */);
2436}
2437
2438
2439/**
2440 * Replies to a HOST_MSG_DIR_REWIND message.
2441 *
2442 * @returns VBox status code.
2443 * @param pCtx Guest control command context to use.
2444 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2445 */
2446VBGLR3DECL(int) VbglR3GuestCtrlDirCbRewind(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc)
2447{
2448 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2449
2450 HGCMReplyDirNotify Msg;
2451 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_DIR_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS);
2452 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2453 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_DIR_NOTIFYTYPE_REWIND);
2454 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2455
2456 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyDirNotify, u));
2457}
2458
2459
2460/**
2461 * Replies to a HOST_MSG_DIR_LIST message.
2462 *
2463 * @returns VBox status code.
2464 * @param pCtx Guest control command context to use.
2465 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2466 * @þaram cEntries Number of directory entries to send.
2467 * @param pvBuf Buffer of directory entries to send.
2468 * @param cbBuf Size (in bytes) of \a pvBuf.
2469 */
2470VBGLR3DECL(int) VbglR3GuestCtrlDirCbList(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc,
2471 uint32_t cEntries, void *pvBuf, uint32_t cbBuf)
2472{
2473 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2474
2475 HGCMReplyDirNotify Msg;
2476 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_DIR_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS + 2);
2477 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2478 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_DIR_NOTIFYTYPE_LIST);
2479 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2480
2481 VbglHGCMParmUInt32Set(&Msg.u.list.num_entries, cEntries);
2482 VbglHGCMParmPtrSet(&Msg.u.list.buffer, pvBuf, cbBuf);
2483
2484 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyDirNotify, u.list));
2485}
2486#endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
2487
2488
2489/*********************************************************************************************************************************
2490 * File callbacks *
2491 ********************************************************************************************************************************/
2492
2493/**
2494 * Replies to a HOST_MSG_FILE_OPEN message.
2495 *
2496 * @returns VBox status code.
2497 * @param pCtx Guest control command context to use.
2498 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2499 * @param uFileHandle File handle of opened file on success.
2500 */
2501VBGLR3DECL(int) VbglR3GuestCtrlFileCbOpen(PVBGLR3GUESTCTRLCMDCTX pCtx,
2502 uint32_t uRc, uint32_t uFileHandle)
2503{
2504 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2505
2506 HGCMReplyFileNotify Msg;
2507 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2508 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2509 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_OPEN);
2510 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2511 VbglHGCMParmUInt32Set(&Msg.u.open.handle, uFileHandle);
2512
2513 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.open));
2514}
2515
2516
2517/**
2518 * Replies to a HOST_MSG_FILE_CLOSE message.
2519 *
2520 * @returns VBox status code.
2521 * @param pCtx Guest control command context to use.
2522 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2523 */
2524VBGLR3DECL(int) VbglR3GuestCtrlFileCbClose(PVBGLR3GUESTCTRLCMDCTX pCtx,
2525 uint32_t uRc)
2526{
2527 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2528
2529 HGCMReplyFileNotify Msg;
2530 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 3);
2531 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2532 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_CLOSE);
2533 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2534
2535 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSETOF(HGCMReplyFileNotify, u));
2536}
2537
2538
2539/**
2540 * Sends an unexpected file handling error to the host.
2541 *
2542 * @returns VBox status code.
2543 * @param pCtx Guest control command context to use.
2544 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2545 */
2546VBGLR3DECL(int) VbglR3GuestCtrlFileCbError(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc)
2547{
2548 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2549
2550 HGCMReplyFileNotify Msg;
2551 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 3);
2552 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2553 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_ERROR);
2554 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2555
2556 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSETOF(HGCMReplyFileNotify, u));
2557}
2558
2559
2560/**
2561 * Replies to a HOST_MSG_FILE_READ message.
2562 *
2563 * @returns VBox status code.
2564 * @param pCtx Guest control command context to use.
2565 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2566 * @param pvData Pointer to read file data from guest on success.
2567 * @param cbData Size (in bytes) of read file data from guest on success.
2568 */
2569VBGLR3DECL(int) VbglR3GuestCtrlFileCbRead(PVBGLR3GUESTCTRLCMDCTX pCtx,
2570 uint32_t uRc,
2571 void *pvData, uint32_t cbData)
2572{
2573 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2574
2575 HGCMReplyFileNotify Msg;
2576 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2577 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2578 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_READ);
2579 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2580 VbglHGCMParmPtrSet(&Msg.u.read.data, pvData, cbData);
2581
2582 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.read));
2583}
2584
2585
2586/**
2587 * Replies to a HOST_MSG_FILE_READ_AT message.
2588 *
2589 * @returns VBox status code.
2590 * @param pCtx Guest control command context to use.
2591 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2592 * @param pvData Pointer to read file data from guest on success.
2593 * @param cbData Size (in bytes) of read file data from guest on success.
2594 * @param offNew New offset (in bytes) the guest file pointer points at on success.
2595 */
2596VBGLR3DECL(int) VbglR3GuestCtrlFileCbReadOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc,
2597 void *pvData, uint32_t cbData, int64_t offNew)
2598{
2599 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2600
2601 HGCMReplyFileNotify Msg;
2602 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 5);
2603 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2604 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_READ_OFFSET);
2605 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2606 VbglHGCMParmPtrSet(&Msg.u.ReadOffset.pvData, pvData, cbData);
2607 VbglHGCMParmUInt64Set(&Msg.u.ReadOffset.off64New, (uint64_t)offNew);
2608
2609 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.ReadOffset));
2610}
2611
2612
2613/**
2614 * Replies to a HOST_MSG_FILE_WRITE message.
2615 *
2616 * @returns VBox status code.
2617 * @param pCtx Guest control command context to use.
2618 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2619 * @param cbWritten Size (in bytes) of file data successfully written to guest file. Can be partial.
2620 */
2621VBGLR3DECL(int) VbglR3GuestCtrlFileCbWrite(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten)
2622{
2623 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2624
2625 HGCMReplyFileNotify Msg;
2626 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2627 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2628 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_WRITE);
2629 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2630 VbglHGCMParmUInt32Set(&Msg.u.write.written, cbWritten);
2631
2632 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.write));
2633}
2634
2635
2636/**
2637 * Replies to a HOST_MSG_FILE_WRITE_AT message.
2638 *
2639 * @returns VBox status code.
2640 * @param pCtx Guest control command context to use.
2641 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2642 * @param cbWritten Size (in bytes) of file data successfully written to guest file. Can be partial.
2643 * @param offNew New offset (in bytes) the guest file pointer points at on success.
2644 */
2645VBGLR3DECL(int) VbglR3GuestCtrlFileCbWriteOffset(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint32_t cbWritten, int64_t offNew)
2646{
2647 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2648
2649 HGCMReplyFileNotify Msg;
2650 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 5);
2651 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2652 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_WRITE_OFFSET);
2653 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2654 VbglHGCMParmUInt32Set(&Msg.u.WriteOffset.cb32Written, cbWritten);
2655 VbglHGCMParmUInt64Set(&Msg.u.WriteOffset.off64New, (uint64_t)offNew);
2656
2657 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.WriteOffset));
2658}
2659
2660
2661/**
2662 * Replies to a HOST_MSG_FILE_SEEK message.
2663 *
2664 * @returns VBox status code.
2665 * @param pCtx Guest control command context to use.
2666 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2667 * @param offCurrent New offset (in bytes) the guest file pointer points at on success.
2668 */
2669VBGLR3DECL(int) VbglR3GuestCtrlFileCbSeek(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent)
2670{
2671 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2672
2673 HGCMReplyFileNotify Msg;
2674 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2675 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2676 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_SEEK);
2677 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2678 VbglHGCMParmUInt64Set(&Msg.u.seek.offset, offCurrent);
2679
2680 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.seek));
2681}
2682
2683
2684/**
2685 * Replies to a HOST_MSG_FILE_TELL message.
2686 *
2687 * @returns VBox status code.
2688 * @param pCtx Guest control command context to use.
2689 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2690 * @param offCurrent Current offset (in bytes) the guest file pointer points at on success.
2691 */
2692VBGLR3DECL(int) VbglR3GuestCtrlFileCbTell(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t offCurrent)
2693{
2694 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2695
2696 HGCMReplyFileNotify Msg;
2697 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2698 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2699 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_TELL);
2700 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2701 VbglHGCMParmUInt64Set(&Msg.u.tell.offset, offCurrent);
2702
2703 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.tell));
2704}
2705
2706
2707/**
2708 * Replies to a HOST_MSG_FILE_SET_SIZE message.
2709 *
2710 * @returns VBox status code.
2711 * @param pCtx Guest control command context to use.
2712 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2713 * @param cbNew New file size (in bytes) of the guest file on success.
2714 */
2715VBGLR3DECL(int) VbglR3GuestCtrlFileCbSetSize(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, uint64_t cbNew)
2716{
2717 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2718
2719 HGCMReplyFileNotify Msg;
2720 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_FILE_NOTIFY, 4);
2721 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2722 VbglHGCMParmUInt32Set(&Msg.type, GUEST_FILE_NOTIFYTYPE_SET_SIZE);
2723 VbglHGCMParmUInt32Set(&Msg.rc, uRc);
2724 VbglHGCMParmUInt64Set(&Msg.u.SetSize.cb64Size, cbNew);
2725
2726 return VbglR3HGCMCall(&Msg.hdr, RT_UOFFSET_AFTER(HGCMReplyFileNotify, u.SetSize));
2727}
2728
2729
2730/*********************************************************************************************************************************
2731 * File system callbacks *
2732 ********************************************************************************************************************************/
2733
2734#ifdef VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS
2735/**
2736 * Replies to a HOST_MSG_FS_OBJ_QUERY_INFO message, extended version.
2737 *
2738 * @returns VBox status code.
2739 * @param pCtx Guest control command context to use.
2740 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2741 * @param pFsObjInfo Guest file system object information to send.
2742 * @param pszUser Associated user ID (owner, uid) as a string.
2743 * @param pszGroups Associated user groups as a string.
2744 * Multiple groups are delimited by GSTCTL_DIRENTRY_GROUPS_DELIMITER_STR,
2745 * whereas the first group always is the primary group.
2746 */
2747VBGLR3DECL(int) VbglR3GuestCtrlFsObjCbQueryInfoEx(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSOBJINFO pFsObjInfo,
2748 const char *pszUser, const char *pszGroups)
2749{
2750 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2751 AssertPtrReturn(pFsObjInfo, VERR_INVALID_POINTER);
2752 AssertPtrReturn(pszUser, VERR_INVALID_POINTER);
2753 AssertPtrReturn(pszGroups, VERR_INVALID_POINTER);
2754
2755 HGCMReplyFsNotify Msg;
2756 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_FS_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS + 3);
2757 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2758 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_FS_NOTIFYTYPE_QUERY_OBJ_INFO);
2759 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2760
2761 VbglHGCMParmPtrSet (&Msg.u.queryobjinfo.obj_info, pFsObjInfo, sizeof(GSTCTLFSOBJINFO));
2762 VbglHGCMParmPtrSetString(&Msg.u.queryobjinfo.user, pszUser);
2763 VbglHGCMParmPtrSetString(&Msg.u.queryobjinfo.groups, pszGroups);
2764
2765 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyFsNotify, u.queryobjinfo));
2766}
2767
2768
2769/**
2770 * Replies to a HOST_MSG_FS_OBJ_QUERY_INFO message.
2771 *
2772 * @returns VBox status code.
2773 * @param pCtx Guest control command context to use.
2774 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2775 * @param pFsObjInfo Guest file system object information to send.
2776 */
2777VBGLR3DECL(int) VbglR3GuestCtrlFsObjCbQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSOBJINFO pFsObjInfo)
2778{
2779 char szIgnored[1] = { 0 };
2780 return VbglR3GuestCtrlFsObjCbQueryInfoEx(pCtx, uRc, pFsObjInfo, szIgnored /* pszUser */, szIgnored /* pszGroups */);
2781}
2782
2783
2784/**
2785 * Replies to a HOST_MSG_FS_CREATE_TEMP message.
2786 *
2787 * @returns VBox status code.
2788 * @param pCtx Guest control command context to use.
2789 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2790 * @param pszPath Path of created temporary file / directory, if \a uRc marks a success.
2791 * Specify an empty path on failure -- NULL is not allowed!
2792 */
2793VBGLR3DECL(int) VbglR3GuestCtrlFsCbCreateTemp(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, const char *pszPath)
2794{
2795 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2796 AssertPtrReturn(pszPath, VERR_INVALID_POINTER);
2797
2798 HGCMReplyFsNotify Msg;
2799 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_FS_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS + 1);
2800 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2801 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_FS_NOTIFYTYPE_CREATE_TEMP);
2802 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2803
2804 VbglHGCMParmPtrSetString(&Msg.u.createtemp.path, pszPath);
2805
2806 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyFsNotify, u.createtemp));
2807}
2808
2809/**
2810 * Replies to a HOST_MSG_FS_QUERY_INFO message.
2811 *
2812 * @returns VBox status code.
2813 * @param pCtx Guest control command context to use.
2814 * @param uRc Guest rc of operation (note: IPRT-style signed int).
2815 * @param pFsInfo File system information to return.
2816 * @param cbFsInfo Size (in bytes) of \a pFsInfo.
2817 */
2818VBGLR3DECL(int) VbglR3GuestCtrlFsCbQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSINFO pFsInfo, uint32_t cbFsInfo)
2819{
2820 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2821 AssertPtrReturn(pFsInfo, VERR_INVALID_POINTER);
2822 AssertReturn(cbFsInfo, VERR_INVALID_PARAMETER);
2823
2824 HGCMReplyFsNotify Msg;
2825 VBGL_HGCM_HDR_INIT(&Msg.reply_hdr.hdr, pCtx->uClientID, GUEST_MSG_FS_NOTIFY, GSTCTL_HGCM_REPLY_HDR_PARMS + 1);
2826 VbglHGCMParmUInt32Set(&Msg.reply_hdr.context, pCtx->uContextID);
2827 VbglHGCMParmUInt32Set(&Msg.reply_hdr.type, GUEST_FS_NOTIFYTYPE_QUERY_INFO);
2828 VbglHGCMParmUInt32Set(&Msg.reply_hdr.rc, uRc);
2829
2830 VbglHGCMParmPtrSet(&Msg.u.queryinfo.fs_info, pFsInfo, cbFsInfo);
2831
2832 return VbglR3HGCMCall(&Msg.reply_hdr.hdr, RT_UOFFSET_AFTER(HGCMReplyFsNotify, u.queryinfo));
2833}
2834#endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
2835
2836
2837/*********************************************************************************************************************************
2838 * Process callbacks *
2839 ********************************************************************************************************************************/
2840
2841/**
2842 * Callback for reporting a guest process status (along with some other stuff) to the host.
2843 *
2844 * @returns VBox status code.
2845 * @param pCtx Guest control command context to use.
2846 * @param uPID Guest process PID to report status for.
2847 * @param uStatus Status to report. Of type PROC_STS_XXX.
2848 * @param fFlags Additional status flags, depending on the reported status. See RTPROCSTATUS.
2849 * @param pvData Pointer to additional status data. Optional.
2850 * @param cbData Size (in bytes) of additional status data.
2851 */
2852VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatus(PVBGLR3GUESTCTRLCMDCTX pCtx,
2853 uint32_t uPID, uint32_t uStatus, uint32_t fFlags,
2854 void *pvData, uint32_t cbData)
2855{
2856 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2857
2858 HGCMMsgProcStatus Msg;
2859 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_EXEC_STATUS, 5);
2860 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2861 VbglHGCMParmUInt32Set(&Msg.pid, uPID);
2862 VbglHGCMParmUInt32Set(&Msg.status, uStatus);
2863 VbglHGCMParmUInt32Set(&Msg.flags, fFlags);
2864 VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
2865
2866 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2867}
2868
2869
2870/**
2871 * Sends output (from stdout/stderr) from a running process.
2872 *
2873 * @returns VBox status code.
2874 * @param pCtx Guest control command context to use.
2875 * @param uPID Guest process PID to report status for.
2876 * @param uHandle Guest process handle the output belong to.
2877 * @param fFlags Additional output flags.
2878 * @param pvData Pointer to actual output data.
2879 * @param cbData Size (in bytes) of output data.
2880 */
2881VBGLR3DECL(int) VbglR3GuestCtrlProcCbOutput(PVBGLR3GUESTCTRLCMDCTX pCtx,
2882 uint32_t uPID,uint32_t uHandle, uint32_t fFlags,
2883 void *pvData, uint32_t cbData)
2884{
2885 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2886
2887 HGCMMsgProcOutput Msg;
2888 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_EXEC_OUTPUT, 5);
2889 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2890 VbglHGCMParmUInt32Set(&Msg.pid, uPID);
2891 VbglHGCMParmUInt32Set(&Msg.handle, uHandle);
2892 VbglHGCMParmUInt32Set(&Msg.flags, fFlags);
2893 VbglHGCMParmPtrSet(&Msg.data, pvData, cbData);
2894
2895 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2896}
2897
2898
2899/**
2900 * Callback for reporting back the input status of a guest process to the host.
2901 *
2902 * @returns VBox status code.
2903 * @param pCtx Guest control command context to use.
2904 * @param uPID Guest process PID to report status for.
2905 * @param uStatus Status to report. Of type INPUT_STS_XXX.
2906 * @param fFlags Additional input flags.
2907 * @param cbWritten Size (in bytes) of input data handled.
2908 */
2909VBGLR3DECL(int) VbglR3GuestCtrlProcCbStatusInput(PVBGLR3GUESTCTRLCMDCTX pCtx,
2910 uint32_t uPID, uint32_t uStatus,
2911 uint32_t fFlags, uint32_t cbWritten)
2912{
2913 AssertPtrReturn(pCtx, VERR_INVALID_POINTER);
2914
2915 HGCMMsgProcStatusInput Msg;
2916 VBGL_HGCM_HDR_INIT(&Msg.hdr, pCtx->uClientID, GUEST_MSG_EXEC_INPUT_STATUS, 5);
2917 VbglHGCMParmUInt32Set(&Msg.context, pCtx->uContextID);
2918 VbglHGCMParmUInt32Set(&Msg.pid, uPID);
2919 VbglHGCMParmUInt32Set(&Msg.status, uStatus);
2920 VbglHGCMParmUInt32Set(&Msg.flags, fFlags);
2921 VbglHGCMParmUInt32Set(&Msg.written, cbWritten);
2922
2923 return VbglR3HGCMCall(&Msg.hdr, sizeof(Msg));
2924}
2925
Note: See TracBrowser for help on using the repository browser.

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