VirtualBox

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

Last change on this file since 99134 was 99120, checked in by vboxsync, 23 months ago

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