VirtualBox

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

Last change on this file since 102654 was 102654, checked in by vboxsync, 11 months ago

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

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