VirtualBox

source: vbox/trunk/include/VBox/VBoxGuest.h@ 4532

Last change on this file since 4532 was 4532, checked in by vboxsync, 18 years ago

Memory balloon size change updates
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 45.2 KB
Line 
1/** @file
2 * VBoxGuest - VirtualBox Guest Additions interface
3 */
4
5/*
6 * Copyright (C) 2006-2007 innotek GmbH
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License as published by the Free Software Foundation,
12 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
13 * distribution. VirtualBox OSE is distributed in the hope that it will
14 * be useful, but WITHOUT ANY WARRANTY of any kind.
15 */
16
17#ifndef ___VBox_VBoxGuest_h
18#define ___VBox_VBoxGuest_h
19
20#include <iprt/cdefs.h>
21#include <iprt/types.h>
22#include <VBox/err.h>
23#include <VBox/ostypes.h>
24
25/*******************************************************************************
26* Defined Constants And Macros *
27*******************************************************************************/
28
29/** @todo The following is a temporary fix for the problem of accessing
30 hypervisor pointers from within guest additions */
31
32/** Hypervisor linear pointer size type */
33typedef uint32_t vmmDevHypPtr;
34/** Hypervisor physical pointer size type */
35typedef uint32_t vmmDevHypPhys;
36
37#if defined(RT_OS_LINUX)
38/** The support device name. */
39# define VBOXGUEST_DEVICE_NAME "/dev/vboxadd"
40
41#elif defined(RT_OS_OS2)
42/** The support device name. */
43# define VBOXGUEST_DEVICE_NAME "\\Dev\\VBoxGst$"
44
45#elif defined(RT_OS_WINDOWS)
46/** The support service name. */
47# define VBOXGUEST_SERVICE_NAME "VBoxGuest"
48/** Win32 Device name. */
49# define VBOXGUEST_DEVICE_NAME "\\\\.\\VBoxGuest"
50/** Global name for Win2k+ */
51# define VBOXGUEST_DEVICE_NAME_GLOBAL "\\\\.\\Global\\VBoxGuest"
52/** Win32 driver name */
53# define VBOXGUEST_DEVICE_NAME_NT L"\\Device\\VBoxGuest"
54/** device name */
55# define VBOXGUEST_DEVICE_NAME_DOS L"\\DosDevices\\VBoxGuest"
56
57#else
58/* PORTME */
59#endif
60
61/** VirtualBox vendor ID */
62#define VBOX_PCI_VENDORID (0x80ee)
63
64/** VMMDev PCI card identifiers */
65#define VMMDEV_VENDORID VBOX_PCI_VENDORID
66#define VMMDEV_DEVICEID (0xcafe)
67
68/** VirtualBox graphics card identifiers */
69#define VBOX_VENDORID VBOX_PCI_VENDORID
70#define VBOX_VESA_VENDORID VBOX_PCI_VENDORID
71#define VBOX_DEVICEID (0xbeef)
72#define VBOX_VESA_DEVICEID (0xbeef)
73
74/**
75 * VBoxGuest port definitions
76 * @{
77 */
78
79/** guest can (== wants to) handle absolute coordinates */
80#define VBOXGUEST_MOUSE_GUEST_CAN_ABSOLUTE BIT(0)
81/** host can (== wants to) send absolute coordinates */
82#define VBOXGUEST_MOUSE_HOST_CAN_ABSOLUTE BIT(1)
83/** guest can *NOT* switch to software cursor and therefore depends on the host cursor */
84#define VBOXGUEST_MOUSE_GUEST_NEEDS_HOST_CURSOR BIT(2)
85/** host does NOT provide support for drawing the cursor itself (e.g. L4 console) */
86#define VBOXGUEST_MOUSE_HOST_CANNOT_HWPOINTER BIT(3)
87
88/** fictive start address of the hypervisor physical memory for MmMapIoSpace */
89#define HYPERVISOR_PHYSICAL_START 0xf8000000
90
91/*
92 * VMMDev Generic Request Interface
93 */
94
95/** port for generic request interface */
96#define PORT_VMMDEV_REQUEST_OFFSET 0
97
98/** Current version of the VMMDev interface.
99 *
100 * Additions are allowed to work only if
101 * additions_major == vmmdev_current && additions_minor <= vmmdev_current.
102 * Additions version is reported to host (VMMDev) by VMMDevReq_ReportGuestInfo.
103 *
104 * @remark These defines also live in the 16-bit and assembly versions of this header.
105 */
106#define VMMDEV_VERSION_MAJOR (0x1)
107#define VMMDEV_VERSION_MINOR (0x4)
108#define VMMDEV_VERSION ((VMMDEV_VERSION_MAJOR << 16) | VMMDEV_VERSION_MINOR)
109
110/**
111 * VMMDev request types.
112 * @note when updating this, adjust vmmdevGetRequestSize() as well
113 */
114typedef enum
115{
116 VMMDevReq_InvalidRequest = 0,
117 VMMDevReq_GetMouseStatus = 1,
118 VMMDevReq_SetMouseStatus = 2,
119 VMMDevReq_SetPointerShape = 3,
120 /** @todo implement on host side */
121 VMMDevReq_GetHostVersion = 4,
122 VMMDevReq_Idle = 5,
123 VMMDevReq_GetHostTime = 10,
124 VMMDevReq_GetHypervisorInfo = 20,
125 VMMDevReq_SetHypervisorInfo = 21,
126 VMMDevReq_SetPowerStatus = 30,
127 VMMDevReq_AcknowledgeEvents = 41,
128 VMMDevReq_CtlGuestFilterMask = 42,
129 VMMDevReq_ReportGuestInfo = 50,
130 VMMDevReq_GetDisplayChangeRequest = 51,
131 VMMDevReq_VideoModeSupported = 52,
132 VMMDevReq_GetHeightReduction = 53,
133 VMMDevReq_GetDisplayChangeRequest2 = 54,
134 VMMDevReq_ReportGuestCapabilities = 55,
135#ifdef VBOX_HGCM
136 VMMDevReq_HGCMConnect = 60,
137 VMMDevReq_HGCMDisconnect = 61,
138 VMMDevReq_HGCMCall = 62,
139#endif
140 VMMDevReq_VideoAccelEnable = 70,
141 VMMDevReq_VideoAccelFlush = 71,
142 VMMDevReq_VideoSetVisibleRegion = 72,
143 VMMDevReq_GetSeamlessChangeRequest = 73,
144 VMMDevReq_QueryCredentials = 100,
145 VMMDevReq_ReportCredentialsJudgement = 101,
146 VMMDevReq_ReportGuestStats = 110,
147 VMMDevReq_GetMemBalloonChangeRequest = 111,
148 VMMDevReq_GetStatisticsChangeRequest = 112,
149 VMMDevReq_ChangeMemBalloon = 113,
150 VMMDevReq_LogString = 200,
151 VMMDevReq_SizeHack = 0x7fffffff
152} VMMDevRequestType;
153
154/** Version of VMMDevRequestHeader structure. */
155#define VMMDEV_REQUEST_HEADER_VERSION (0x10001)
156
157#pragma pack(4)
158/** generic VMMDev request header */
159typedef struct
160{
161 /** size of the structure in bytes (including body). Filled by caller */
162 uint32_t size;
163 /** version of the structure. Filled by caller */
164 uint32_t version;
165 /** type of the request */
166 VMMDevRequestType requestType;
167 /** return code. Filled by VMMDev */
168 int32_t rc;
169 /** reserved fields */
170 uint32_t reserved1;
171 uint32_t reserved2;
172} VMMDevRequestHeader;
173
174/** mouse status request structure */
175typedef struct
176{
177 /** header */
178 VMMDevRequestHeader header;
179 /** mouse feature mask */
180 uint32_t mouseFeatures;
181 /** mouse x position */
182 uint32_t pointerXPos;
183 /** mouse y position */
184 uint32_t pointerYPos;
185} VMMDevReqMouseStatus;
186
187/** Note VBOX_MOUSE_POINTER_* flags are used in guest video driver,
188 * values must be <= 0x8000 and must not be changed.
189 */
190
191/** pointer is visible */
192#define VBOX_MOUSE_POINTER_VISIBLE (0x0001)
193/** pointer has alpha channel */
194#define VBOX_MOUSE_POINTER_ALPHA (0x0002)
195/** pointerData contains new pointer shape */
196#define VBOX_MOUSE_POINTER_SHAPE (0x0004)
197
198/** mouse pointer shape/visibility change request */
199typedef struct
200{
201 /** header */
202 VMMDevRequestHeader header;
203 /** VBOX_MOUSE_POINTER_* bit flags */
204 uint32_t fFlags;
205 /** x coordinate of hot spot */
206 uint32_t xHot;
207 /** y coordinate of hot spot */
208 uint32_t yHot;
209 /** width of the pointer in pixels */
210 uint32_t width;
211 /** height of the pointer in scanlines */
212 uint32_t height;
213 /** Pointer data.
214 *
215 ****
216 * The data consists of 1 bpp AND mask followed by 32 bpp XOR (color) mask.
217 *
218 * For pointers without alpha channel the XOR mask pixels are 32 bit values: (lsb)BGR0(msb).
219 * For pointers with alpha channel the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
220 *
221 * Guest driver must create the AND mask for pointers with alpha channel, so if host does not
222 * support alpha, the pointer could be displayed as a normal color pointer. The AND mask can
223 * be constructed from alpha values. For example alpha value >= 0xf0 means bit 0 in the AND mask.
224 *
225 * The AND mask is 1 bpp bitmap with byte aligned scanlines. Size of AND mask,
226 * therefore, is cbAnd = (width + 7) / 8 * height. The padding bits at the
227 * end of any scanline are undefined.
228 *
229 * The XOR mask follows the AND mask on the next 4 bytes aligned offset:
230 * uint8_t *pXor = pAnd + (cbAnd + 3) & ~3
231 * Bytes in the gap between the AND and the XOR mask are undefined.
232 * XOR mask scanlines have no gap between them and size of XOR mask is:
233 * cXor = width * 4 * height.
234 ****
235 *
236 * Preallocate 4 bytes for accessing actual data as p->pointerData
237 */
238 char pointerData[4];
239} VMMDevReqMousePointer;
240
241/** string log request structure */
242typedef struct
243{
244 /** header */
245 VMMDevRequestHeader header;
246 /** variable length string data */
247 char szString[1];
248} VMMDevReqLogString;
249
250/** host version request structure */
251typedef struct
252{
253 /** header */
254 VMMDevRequestHeader header;
255 /** major version */
256 uint32_t major;
257 /** minor version */
258 uint32_t minor;
259 /** build number */
260 uint32_t build;
261} VMMDevReqHostVersion;
262
263/** guest capabilites structure */
264typedef struct
265{
266 /** header */
267 VMMDevRequestHeader header;
268 /** capabilities (VMMDEV_GUEST_*) */
269 uint32_t caps;
270} VMMDevReqGuestCapabilities;
271
272/** idle request structure */
273typedef struct
274{
275 /** header */
276 VMMDevRequestHeader header;
277} VMMDevReqIdle;
278
279/** host time request structure */
280typedef struct
281{
282 /** header */
283 VMMDevRequestHeader header;
284 /** time in milliseconds since unix epoch. Filled by VMMDev. */
285 uint64_t time;
286} VMMDevReqHostTime;
287
288/** hypervisor info structure */
289typedef struct
290{
291 /** header */
292 VMMDevRequestHeader header;
293 /** guest virtual address of proposed hypervisor start */
294 vmmDevHypPtr hypervisorStart;
295 /** hypervisor size in bytes */
296 uint32_t hypervisorSize;
297} VMMDevReqHypervisorInfo;
298
299/** system power requests */
300typedef enum
301{
302 VMMDevPowerState_Invalid = 0,
303 VMMDevPowerState_Pause = 1,
304 VMMDevPowerState_PowerOff = 2,
305 VMMDevPowerState_SaveState = 3,
306 VMMDevPowerState_SizeHack = 0x7fffffff
307} VMMDevPowerState;
308
309/** system power status structure */
310typedef struct
311{
312 /** header */
313 VMMDevRequestHeader header;
314 /** power state request */
315 VMMDevPowerState powerState;
316} VMMDevPowerStateRequest;
317
318/** pending events structure */
319typedef struct
320{
321 /** header */
322 VMMDevRequestHeader header;
323 /** pending event bitmap */
324 uint32_t events;
325} VMMDevEvents;
326
327/** guest filter mask control */
328typedef struct
329{
330 /** header */
331 VMMDevRequestHeader header;
332 /** mask of events to be added to filter */
333 uint32_t u32OrMask;
334 /** mask of events to be removed from filter */
335 uint32_t u32NotMask;
336} VMMDevCtlGuestFilterMask;
337
338/** guest information structure */
339typedef struct VBoxGuestInfo
340{
341 /** The VMMDev interface version expected by additions. */
342 uint32_t additionsVersion;
343 /** guest OS type */
344 OSType osType;
345 /** @todo */
346} VBoxGuestInfo;
347
348/** guest information structure */
349typedef struct
350{
351 /** header */
352 VMMDevRequestHeader header;
353 /** Guest information. */
354 VBoxGuestInfo guestInfo;
355} VMMDevReportGuestInfo;
356
357/** guest statistics values */
358#define VBOX_GUEST_STAT_CPU_LOAD BIT(0)
359#define VBOX_GUEST_STAT_THREADS BIT(1)
360#define VBOX_GUEST_STAT_PROCESSES BIT(2)
361#define VBOX_GUEST_STAT_PHYS_MEM_TOTAL BIT(3)
362#define VBOX_GUEST_STAT_PHYS_MEM_AVAIL BIT(4)
363#define VBOX_GUEST_STAT_PHYS_MEM_BALLOON BIT(5)
364#define VBOX_GUEST_STAT_PAGE_FILE_SIZE BIT(6)
365
366
367/** guest statistics structure */
368typedef struct VBoxGuestStatistics
369{
370 /** Reported statistics */
371 uint32_t u32StatCaps;
372 /** CPU load (0-100) */
373 uint32_t u32CpuLoad;
374 /** Nr of threads */
375 uint32_t u32Threads;
376 /** Nr of processes */
377 uint32_t u32Processes;
378 /** Total physical memory (megabytes) */
379 uint32_t u32PhysMemTotal;
380 /** Available physical memory (megabytes) */
381 uint32_t u32PhysMemAvail;
382 /** Ballooned physical memory (megabytes) */
383 uint32_t u32PhysMemBalloon;
384 /** Pagefile size (megabytes) */
385 uint32_t u32PageFileSize;
386} VBoxGuestStatistics;
387
388/** guest statistics command structure */
389typedef struct
390{
391 /** header */
392 VMMDevRequestHeader header;
393 /** Guest information. */
394 VBoxGuestStatistics guestStats;
395} VMMDevReportGuestStats;
396
397/** memory balloon change request structure */
398#define VMMDEV_MAX_MEMORY_BALLOON(PhysMemTotal) ((90*PhysMemTotal)/100)
399
400typedef struct
401{
402 /** header */
403 VMMDevRequestHeader header;
404 uint32_t u32BalloonSize;
405 uint32_t eventAck;
406} VMMDevGetMemBalloonChangeRequest;
407
408/** inflate/deflate memory balloon structure */
409typedef struct
410{
411 /** header */
412 VMMDevRequestHeader header;
413 uint32_t cPages;
414 uint32_t fInflate; /* true = inflate, false = defalte */
415 RTGCPHYS aPhysPage[1]; /* variable size */
416} VMMDevChangeMemBalloon;
417
418/** guest statistics interval change request structure */
419typedef struct
420{
421 /** header */
422 VMMDevRequestHeader header;
423 uint32_t u32StatInterval; /* interval in seconds */
424 uint32_t eventAck;
425} VMMDevGetStatisticsChangeRequest;
426
427/** display change request structure */
428typedef struct
429{
430 /** header */
431 VMMDevRequestHeader header;
432 /** horizontal pixel resolution (0 = do not change) */
433 uint32_t xres;
434 /** vertical pixel resolution (0 = do not change) */
435 uint32_t yres;
436 /** bits per pixel (0 = do not change) */
437 uint32_t bpp;
438 /** Flag that the request is an acknowlegement for the VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST.
439 * Values: 0 - just querying, VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST - event acknowledged.
440 */
441 uint32_t eventAck;
442} VMMDevDisplayChangeRequest;
443
444typedef struct
445{
446 /** header */
447 VMMDevRequestHeader header;
448 /** horizontal pixel resolution (0 = do not change) */
449 uint32_t xres;
450 /** vertical pixel resolution (0 = do not change) */
451 uint32_t yres;
452 /** bits per pixel (0 = do not change) */
453 uint32_t bpp;
454 /** Flag that the request is an acknowlegement for the VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST.
455 * Values: 0 - just querying, VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST - event acknowledged.
456 */
457 uint32_t eventAck;
458 /** 0 for primary display, 1 for the first secondary, etc. */
459 uint32_t display;
460} VMMDevDisplayChangeRequest2;
461
462/** video mode supported request structure */
463typedef struct
464{
465 /** header */
466 VMMDevRequestHeader header;
467 /** horizontal pixel resolution (input) */
468 uint32_t width;
469 /** vertical pixel resolution (input) */
470 uint32_t height;
471 /** bits per pixel (input) */
472 uint32_t bpp;
473 /** supported flag (output) */
474 bool fSupported;
475} VMMDevVideoModeSupportedRequest;
476
477/** video modes height reduction request structure */
478typedef struct
479{
480 /** header */
481 VMMDevRequestHeader header;
482 /** height reduction in pixels (output) */
483 uint32_t heightReduction;
484} VMMDevGetHeightReductionRequest;
485
486#pragma pack()
487
488#ifdef VBOX_HGCM
489
490/** HGCM flags.
491 * @{
492 */
493#define VBOX_HGCM_REQ_DONE (0x1)
494#define VBOX_HGCM_REQ_CANCELLED (0x2)
495/** @} */
496
497#pragma pack(4)
498typedef struct _VMMDevHGCMRequestHeader
499{
500 /** Request header. */
501 VMMDevRequestHeader header;
502
503 /** HGCM flags. */
504 uint32_t fu32Flags;
505
506 /** Result code. */
507 int32_t result;
508} VMMDevHGCMRequestHeader;
509
510/** HGCM service location types. */
511typedef enum
512{
513 VMMDevHGCMLoc_Invalid = 0,
514 VMMDevHGCMLoc_LocalHost = 1,
515 VMMDevHGCMLoc_LocalHost_Existing = 2,
516 VMMDevHGCMLoc_SizeHack = 0x7fffffff
517} HGCMServiceLocationType;
518
519typedef struct
520{
521 char achName[128];
522} HGCMServiceLocationHost;
523
524typedef struct HGCMSERVICELOCATION
525{
526 /** Type of the location. */
527 HGCMServiceLocationType type;
528
529 union
530 {
531 HGCMServiceLocationHost host;
532 } u;
533} HGCMServiceLocation;
534
535typedef struct
536{
537 /* request header */
538 VMMDevHGCMRequestHeader header;
539
540 /** IN: Description of service to connect to. */
541 HGCMServiceLocation loc;
542
543 /** OUT: Client identifier assigned by local instance of HGCM. */
544 uint32_t u32ClientID;
545} VMMDevHGCMConnect;
546
547typedef struct
548{
549 /* request header */
550 VMMDevHGCMRequestHeader header;
551
552 /** IN: Client identifier. */
553 uint32_t u32ClientID;
554} VMMDevHGCMDisconnect;
555
556typedef enum
557{
558 VMMDevHGCMParmType_Invalid = 0,
559 VMMDevHGCMParmType_32bit = 1,
560 VMMDevHGCMParmType_64bit = 2,
561 VMMDevHGCMParmType_PhysAddr = 3,
562 VMMDevHGCMParmType_LinAddr = 4, /**< In and Out */
563 VMMDevHGCMParmType_LinAddr_In = 5, /**< In (read; host<-guest) */
564 VMMDevHGCMParmType_LinAddr_Out = 6, /**< Out (write; host->guest) */
565 VMMDevHGCMParmType_LinAddr_Locked = 7, /**< Locked In and Out */
566 VMMDevHGCMParmType_LinAddr_Locked_In = 8, /**< Locked In (read; host<-guest) */
567 VMMDevHGCMParmType_LinAddr_Locked_Out = 9, /**< Locked Out (write; host->guest) */
568 VMMDevHGCMParmType_SizeHack = 0x7fffffff
569} HGCMFunctionParameterType;
570
571typedef struct _HGCMFUNCTIONPARAMETER
572{
573 HGCMFunctionParameterType type;
574 union
575 {
576 uint32_t value32;
577 uint64_t value64;
578 struct
579 {
580 uint32_t size;
581
582 union
583 {
584 vmmDevHypPhys physAddr;
585 vmmDevHypPtr linearAddr;
586 } u;
587 } Pointer;
588 } u;
589} HGCMFunctionParameter;
590
591typedef struct
592{
593 /* request header */
594 VMMDevHGCMRequestHeader header;
595
596 /** IN: Client identifier. */
597 uint32_t u32ClientID;
598 /** IN: Service function number. */
599 uint32_t u32Function;
600 /** IN: Number of parameters. */
601 uint32_t cParms;
602 /** Parameters follow in form: HGCMFunctionParameter aParms[X]; */
603} VMMDevHGCMCall;
604#pragma pack()
605
606#define VMMDEV_HGCM_CALL_PARMS(a) ((HGCMFunctionParameter *)((char *)a + sizeof (VMMDevHGCMCall)))
607
608#define VBOX_HGCM_MAX_PARMS 32
609
610#endif /* VBOX_HGCM */
611
612
613#define VBVA_F_STATUS_ACCEPTED (0x01)
614#define VBVA_F_STATUS_ENABLED (0x02)
615
616#pragma pack(4)
617
618typedef struct _VMMDevVideoAccelEnable
619{
620 /* request header */
621 VMMDevRequestHeader header;
622
623 /** 0 - disable, !0 - enable. */
624 uint32_t u32Enable;
625
626 /** The size of VBVAMEMORY::au8RingBuffer expected by driver.
627 * The host will refuse to enable VBVA if the size is not equal to
628 * VBVA_RING_BUFFER_SIZE.
629 */
630 uint32_t cbRingBuffer;
631
632 /** Guest initializes the status to 0. Host sets appropriate VBVA_F_STATUS_ flags. */
633 uint32_t fu32Status;
634
635} VMMDevVideoAccelEnable;
636
637typedef struct _VMMDevVideoAccelFlush
638{
639 /* request header */
640 VMMDevRequestHeader header;
641
642} VMMDevVideoAccelFlush;
643
644
645typedef struct _VMMDevVideoSetVisibleRegion
646{
647 /* request header */
648 VMMDevRequestHeader header;
649
650 /** Number of rectangles */
651 uint32_t cRect;
652
653 /** Rectangle array */
654 RTRECT Rect;
655} VMMDevVideoSetVisibleRegion;
656
657
658/** Seamless mode */
659typedef enum
660{
661 VMMDev_Seamless_Disabled = 0, /* normal mode; entire guest desktop displayed */
662 VMMDev_Seamless_Visible_Region = 1, /* visible region mode; only top-level guest windows displayed */
663 VMMDev_Seamless_Host_Window = 2 /* windowed mode; each top-level guest window is represented in a host window */
664} VMMDevSeamlessMode;
665
666typedef struct
667{
668 /** header */
669 VMMDevRequestHeader header;
670
671 /** New seamless mode */
672 VMMDevSeamlessMode mode;
673 /** Flag that the request is an acknowlegement for the VMMDEV_EVENT_SEAMLESS_MODE_CHANGE_REQUEST.
674 * Values: 0 - just querying, VMMDEV_EVENT_SEAMLESS_MODE_CHANGE_REQUEST - event acknowledged.
675 */
676 uint32_t eventAck;
677} VMMDevSeamlessChangeRequest;
678
679#pragma pack()
680
681#pragma pack(1)
682
683/** VBVA command header. */
684typedef struct _VBVACMDHDR
685{
686 /** Coordinates of affected rectangle. */
687 int16_t x;
688 int16_t y;
689 uint16_t w;
690 uint16_t h;
691} VBVACMDHDR;
692
693/* VBVA order codes. Must be >= 0, because the VRDP server internally
694 * uses negative values to mark some operations.
695 * Values are important since they are used as an index in the
696 * "supported orders" bit mask.
697 */
698#define VBVA_VRDP_DIRTY_RECT (0)
699#define VBVA_VRDP_SOLIDRECT (1)
700#define VBVA_VRDP_SOLIDBLT (2)
701#define VBVA_VRDP_DSTBLT (3)
702#define VBVA_VRDP_SCREENBLT (4)
703#define VBVA_VRDP_PATBLTBRUSH (5)
704#define VBVA_VRDP_MEMBLT (6)
705#define VBVA_VRDP_CACHED_BITMAP (7)
706#define VBVA_VRDP_DELETED_BITMAP (8)
707#define VBVA_VRDP_LINE (9)
708#define VBVA_VRDP_BOUNDS (10)
709#define VBVA_VRDP_REPEAT (11)
710#define VBVA_VRDP_POLYLINE (12)
711#define VBVA_VRDP_ELLIPSE (13)
712#define VBVA_VRDP_SAVESCREEN (14)
713
714#define VBVA_VRDP_INDEX_TO_BIT(__index) (1 << (__index))
715
716#ifndef VRDP_NO_COM
717/* 128 bit bitmap hash. */
718typedef uint8_t VRDPBITMAPHASH[16];
719
720typedef struct _VRDPORDERPOINT
721{
722 int16_t x;
723 int16_t y;
724} VRDPORDERPOINT;
725
726typedef struct _VRDPORDERPOLYPOINTS
727{
728 uint8_t c;
729 VRDPORDERPOINT a[16];
730} VRDPORDERPOLYPOINTS;
731
732typedef struct _VRDPORDERAREA
733{
734 int16_t x;
735 int16_t y;
736 uint16_t w;
737 uint16_t h;
738} VRDPORDERAREA;
739
740typedef struct _VRDPORDERBOUNDS
741{
742 VRDPORDERPOINT pt1;
743 VRDPORDERPOINT pt2;
744} VRDPORDERBOUNDS;
745
746typedef struct _VRDPORDERREPEAT
747{
748 VRDPORDERBOUNDS bounds;
749} VRDPORDERREPEAT;
750
751
752/* Header for bitmap bits in VBVA VRDP operations. */
753typedef struct _VRDPDATABITS
754{
755 /* Size of bitmap data without the header. */
756 uint32_t cb;
757 int16_t x;
758 int16_t y;
759 uint16_t cWidth;
760 uint16_t cHeight;
761 uint8_t cbPixel;
762} VRDPDATABITS;
763
764typedef struct _VRDPORDERSOLIDRECT
765{
766 int16_t x;
767 int16_t y;
768 uint16_t w;
769 uint16_t h;
770 uint32_t rgb;
771} VRDPORDERSOLIDRECT;
772
773typedef struct _VRDPORDERSOLIDBLT
774{
775 int16_t x;
776 int16_t y;
777 uint16_t w;
778 uint16_t h;
779 uint32_t rgb;
780 uint8_t rop;
781} VRDPORDERSOLIDBLT;
782
783typedef struct _VRDPORDERDSTBLT
784{
785 int16_t x;
786 int16_t y;
787 uint16_t w;
788 uint16_t h;
789 uint8_t rop;
790} VRDPORDERDSTBLT;
791
792typedef struct _VRDPORDERSCREENBLT
793{
794 int16_t x;
795 int16_t y;
796 uint16_t w;
797 uint16_t h;
798 int16_t xSrc;
799 int16_t ySrc;
800 uint8_t rop;
801} VRDPORDERSCREENBLT;
802
803typedef struct _VRDPORDERPATBLTBRUSH
804{
805 int16_t x;
806 int16_t y;
807 uint16_t w;
808 uint16_t h;
809 int8_t xSrc;
810 int8_t ySrc;
811 uint32_t rgbFG;
812 uint32_t rgbBG;
813 uint8_t rop;
814 uint8_t pattern[8];
815} VRDPORDERPATBLTBRUSH;
816
817typedef struct _VRDPORDERMEMBLT
818{
819 int16_t x;
820 int16_t y;
821 uint16_t w;
822 uint16_t h;
823 int16_t xSrc;
824 int16_t ySrc;
825 uint8_t rop;
826 VRDPBITMAPHASH hash;
827} VRDPORDERMEMBLT;
828
829typedef struct _VRDPORDERCACHEDBITMAP
830{
831 VRDPBITMAPHASH hash;
832 /* VRDPDATABITS and the bitmap data follows. */
833} VRDPORDERCACHEDBITMAP;
834
835typedef struct _VRDPORDERDELETEDBITMAP
836{
837 VRDPBITMAPHASH hash;
838} VRDPORDERDELETEDBITMAP;
839
840typedef struct _VRDPORDERLINE
841{
842 int16_t x1;
843 int16_t y1;
844 int16_t x2;
845 int16_t y2;
846 int16_t xBounds1;
847 int16_t yBounds1;
848 int16_t xBounds2;
849 int16_t yBounds2;
850 uint8_t mix;
851 uint32_t rgb;
852} VRDPORDERLINE;
853
854typedef struct _VRDPORDERPOLYLINE
855{
856 VRDPORDERPOINT ptStart;
857 uint8_t mix;
858 uint32_t rgb;
859 VRDPORDERPOLYPOINTS points;
860} VRDPORDERPOLYLINE;
861
862typedef struct _VRDPORDERELLIPSE
863{
864 VRDPORDERPOINT pt1;
865 VRDPORDERPOINT pt2;
866 uint8_t mix;
867 uint8_t fillMode;
868 uint32_t rgb;
869} VRDPORDERELLIPSE;
870
871typedef struct _VRDPORDERSAVESCREEN
872{
873 VRDPORDERPOINT pt1;
874 VRDPORDERPOINT pt2;
875 uint8_t ident;
876 uint8_t restore;
877} VRDPORDERSAVESCREEN;
878#endif /* VRDP_NO_COM */
879#pragma pack()
880
881/* The VBVA ring buffer is suitable for transferring large (< 2gb) amount of data.
882 * For example big bitmaps which do not fit to the buffer.
883 *
884 * Guest starts writing to the buffer by initializing a record entry in the
885 * aRecords queue. VBVA_F_RECORD_PARTIAL indicates that the record is being
886 * written. As data is written to the ring buffer, the guest increases off32End
887 * for the record.
888 *
889 * The host reads the aRecords on flushes and processes all completed records.
890 * When host encounters situation when only a partial record presents and
891 * cbRecord & ~VBVA_F_RECORD_PARTIAL >= VBVA_RING_BUFFER_SIZE - VBVA_RING_BUFFER_THRESHOLD,
892 * the host fetched all record data and updates off32Head. After that on each flush
893 * the host continues fetching the data until the record is completed.
894 *
895 */
896
897#define VBVA_RING_BUFFER_SIZE (_4M - _1K)
898#define VBVA_RING_BUFFER_THRESHOLD (4 * _1K)
899
900#define VBVA_MAX_RECORDS (64)
901
902#define VBVA_F_MODE_ENABLED (0x00000001)
903#define VBVA_F_MODE_VRDP (0x00000002)
904#define VBVA_F_MODE_VRDP_RESET (0x00000004)
905#define VBVA_F_MODE_VRDP_ORDER_MASK (0x00000008)
906
907#define VBVA_F_RECORD_PARTIAL (0x80000000)
908
909#pragma pack(1)
910typedef struct _VBVARECORD
911{
912 /** The length of the record. Changed by guest. */
913 uint32_t cbRecord;
914} VBVARECORD;
915
916typedef struct _VBVAMEMORY
917{
918 /** VBVA_F_MODE_* */
919 uint32_t fu32ModeFlags;
920
921 /** The offset where the data start in the buffer. */
922 uint32_t off32Data;
923 /** The offset where next data must be placed in the buffer. */
924 uint32_t off32Free;
925
926 /** The ring buffer for data. */
927 uint8_t au8RingBuffer[VBVA_RING_BUFFER_SIZE];
928
929 /** The queue of record descriptions. */
930 VBVARECORD aRecords[VBVA_MAX_RECORDS];
931 uint32_t indexRecordFirst;
932 uint32_t indexRecordFree;
933
934 /* RDP orders supported by the client. The guest reports only them
935 * and falls back to DIRTY rects for not supported ones.
936 *
937 * (1 << VBVA_VRDP_*)
938 */
939 uint32_t fu32SupportedOrders;
940
941} VBVAMEMORY;
942#pragma pack()
943
944/** @} */
945
946
947/**
948 * VMMDev RAM
949 * @{
950 */
951
952#pragma pack(1)
953/** Layout of VMMDEV RAM region that contains information for guest */
954typedef struct
955{
956 /** size */
957 uint32_t u32Size;
958 /** version */
959 uint32_t u32Version;
960
961 union {
962 /** Flag telling that VMMDev set the IRQ and acknowlegment is required */
963 struct {
964 bool fHaveEvents;
965 } V1_04;
966
967 struct {
968 /** Pending events flags, set by host. */
969 uint32_t u32HostEvents;
970 /** Mask of events the guest wants to see, set by guest. */
971 uint32_t u32GuestEventMask;
972 } V1_03;
973 } V;
974
975 VBVAMEMORY vbvaMemory;
976
977} VMMDevMemory;
978#pragma pack()
979
980/** Version of VMMDevMemory structure. */
981#define VMMDEV_MEMORY_VERSION (1)
982
983/** @} */
984
985
986/**
987 * VMMDev events.
988 * @{
989 */
990
991/** Host mouse capabilities has been changed. */
992#define VMMDEV_EVENT_MOUSE_CAPABILITIES_CHANGED BIT(0)
993/** HGCM event. */
994#define VMMDEV_EVENT_HGCM BIT(1)
995/** A display change request has been issued. */
996#define VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST BIT(2)
997/** Credentials are available for judgement. */
998#define VMMDEV_EVENT_JUDGE_CREDENTIALS BIT(3)
999/** The guest has been restored. */
1000#define VMMDEV_EVENT_RESTORED BIT(4)
1001/** Seamless mode state changed */
1002#define VMMDEV_EVENT_SEAMLESS_MODE_CHANGE_REQUEST BIT(5)
1003/** Memory balloon size changed */
1004#define VMMDEV_EVENT_BALLOON_CHANGE_REQUEST BIT(6)
1005/** Statistics interval changed */
1006#define VMMDEV_EVENT_STATISTICS_INTERVAL_CHANGE_REQUEST BIT(7)
1007/** VRDP status changed. */
1008#define VMMDEV_EVENT_VRDP BIT(7)
1009
1010
1011/** @} */
1012
1013
1014/**
1015 * VBoxGuest IOCTL codes and structures.
1016 *
1017 * The range 0..15 is for basic driver communication.
1018 * The range 16..31 is for HGCM communcation.
1019 * The range 32..47 is reserved for future use.
1020 * The range 48..63 is for OS specific communcation.
1021 * The 7th bit is reserved for future hacks.
1022 * The 8th bit is reserved for distinguishing between 32-bit and 64-bit
1023 * processes in future 64-bit guest additions.
1024 *
1025 * While windows IOCTL function number has to start at 2048 and stop at 4096 there
1026 * never was any need to do this for everyone. A simple ((Function) | 0x800) would
1027 * have sufficed. On Linux we're now intruding upon the type field. Fortunately
1028 * this hasn't caused any trouble because the FILE_DEVICE_UNKNOWN value was set
1029 * to 0x22 (if it were 0x2C it would not have worked soo smoothly). The situation
1030 * would've been the same for *BSD and Darwin since they seems to share common
1031 * _IOC() heritage.
1032 *
1033 * However, on good old OS/2 we only have 8-bit handy for the function number. The
1034 * result from using the old IOCTL function numbers her would've been overlapping
1035 * between the two ranges.
1036 *
1037 * To fix this problem and get rid of all the unnecessary windowsy crap that I
1038 * bet was copied from my SUPDRVIOC.h once upon a time (although the concept of
1039 * prefixing macros with the purpose of avoid clashes with system stuff and
1040 * to indicate exactly how owns them seems to have been lost somewhere along
1041 * the way), I've introduced a VBOXGUEST_IOCTL_CODE for defining generic IN/OUT
1042 * IOCtls on new ports of the additions.
1043 *
1044 * @remark When creating new IOCtl interfaces keep in mind that not all OSes supports
1045 * reporting back the output size. (This got messed up a little bit in VBoxDrv.)
1046 *
1047 * OS/2 restricts the in/out data size to 64KB, while Linux, BSD and Darwin are
1048 * limited by a 14 bits size field (16KB). So, special considerations need to
1049 * be taken if more input/output needs to be passed around.
1050 *
1051 * When passing variable sized input/output special care need to be taken on
1052 * Unix platforms (if we're going to play by the rules) since the size is
1053 * passed as part of the IOCtl code there. IIRC Darwin will use the size to
1054 * perform locking and in/out copying, I don't quite know about linux and *BSD.
1055 *
1056 * @remark If adding interfaces that only has input or only has output, some new macros
1057 * needs to be created so the most efficient IOCtl data buffering method can be
1058 * used.
1059 *
1060 * @{
1061 */
1062#ifdef RT_ARCH_AMD64
1063# define VBOXGUEST_IOCTL_FLAG 128
1064#elif defined(RT_ARCH_X86)
1065# define VBOXGUEST_IOCTL_FLAG 0
1066#else
1067# error "dunno which arch this is!"
1068#endif
1069
1070#if defined(RT_OS_WINDOWS)
1071# define IOCTL_CODE(DeviceType, Function, Method, Access, DataSize_ignored) \
1072 ( ((DeviceType) << 16) | ((Access) << 14) | ((Function) << 2) | (Method))
1073
1074#elif defined(RT_OS_OS2)
1075# define VBOXGUEST_IOCTL_CATEGORY 0xc2
1076# define VBOXGUEST_IOCTL_CODE(Function, Size) ((unsigned char)(Function))
1077# define VBOXGUEST_IOCTL_CATEGORY_FAST 0xc3 /**< Also defined in VBoxGuestA-os2.asm. */
1078# define VBOXGUEST_IOCTL_CODE_FAST(Function) ((unsigned char)(Function))
1079
1080#elif defined(RT_OS_LINUX)
1081# define IOCTL_CODE(DeviceType, Function, Method_ignored, Access_ignored, DataSize) \
1082 ( (3 << 30) | ((DeviceType) << 8) | (Function) | ((DataSize) << 16) )
1083# define METHOD_BUFFERED 0
1084# define FILE_WRITE_ACCESS 0x0002
1085# define FILE_DEVICE_UNKNOWN 0x00000022
1086
1087#elif 0 /* BSD style - needs some adjusting _IORW takes a type and not a size. */
1088# include <sys/ioccom.h>
1089# define VBOXGUEST_IOCTL_CODE(Function, Size) _IORW('V', (Function) | VBOXGUEST_IOCTL_FLAG, (Size))
1090# define VBOXGUEST_IOCTL_CODE_FAST(Function) _IO( 'V', (Function) | VBOXGUEST_IOCTL_FLAG)
1091
1092#else
1093/* PORTME */
1094#endif
1095
1096/** IOCTL to VBoxGuest to query the VMMDev IO port region start. */
1097#ifdef VBOXGUEST_IOCTL_CODE
1098# define VBOXGUEST_IOCTL_GETVMMDEVPORT VBOXGUEST_IOCTL_CODE(1, sizeof(VBoxGuestPortInfo))
1099# define IOCTL_VBOXGUEST_GETVMMDEVPORT VBOXGUEST_IOCTL_GETVMMDEVPORT
1100#else
1101# define IOCTL_VBOXGUEST_GETVMMDEVPORT IOCTL_CODE(FILE_DEVICE_UNKNOWN, 2048, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VBoxGuestPortInfo))
1102#endif
1103
1104#pragma pack(4)
1105typedef struct _VBoxGuestPortInfo
1106{
1107 uint32_t portAddress;
1108 VMMDevMemory *pVMMDevMemory;
1109} VBoxGuestPortInfo;
1110
1111/** IOCTL to VBoxGuest to wait for a VMMDev host notification */
1112#ifdef VBOXGUEST_IOCTL_CODE
1113# define VBOXGUEST_IOCTL_WAITEVENT VBOXGUEST_IOCTL_CODE(2, sizeof(VBoxGuestWaitEventInfo))
1114# define IOCTL_VBOXGUEST_WAITEVENT VBOXGUEST_IOCTL_WAITEVENT
1115#else
1116# define IOCTL_VBOXGUEST_WAITEVENT IOCTL_CODE(FILE_DEVICE_UNKNOWN, 2049, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VBoxGuestWaitEventInfo))
1117#endif
1118
1119/**
1120 * Result codes for VBoxGuestWaitEventInfo::u32Result
1121 * @{
1122 */
1123/** Successful completion, an event occured. */
1124#define VBOXGUEST_WAITEVENT_OK (0)
1125/** Successful completion, timed out. */
1126#define VBOXGUEST_WAITEVENT_TIMEOUT (1)
1127/** Wait was interrupted. */
1128#define VBOXGUEST_WAITEVENT_INTERRUPTED (2)
1129/** An error occured while processing the request. */
1130#define VBOXGUEST_WAITEVENT_ERROR (3)
1131/** @} */
1132
1133/** Input and output buffers layout of the IOCTL_VBOXGUEST_WAITEVENT */
1134typedef struct _VBoxGuestWaitEventInfo
1135{
1136 /** timeout in milliseconds */
1137 uint32_t u32TimeoutIn;
1138 /** events to wait for */
1139 uint32_t u32EventMaskIn;
1140 /** result code */
1141 uint32_t u32Result;
1142 /** events occured */
1143 uint32_t u32EventFlagsOut;
1144} VBoxGuestWaitEventInfo;
1145
1146/** IOCTL to VBoxGuest to perform a VMM request
1147 * @remark The data buffer for this IOCtl has an variable size, keep this in mind
1148 * on systems where this matters. */
1149#ifdef VBOXGUEST_IOCTL_CODE
1150# define VBOXGUEST_IOCTL_VMMREQUEST(Size) VBOXGUEST_IOCTL_CODE(3, sizeof(VMMDevRequestHeader))
1151# define IOCTL_VBOXGUEST_VMMREQUEST VBOXGUEST_IOCTL_VMMREQUEST(sizeof(VMMDevRequestHeader))
1152#else
1153# define IOCTL_VBOXGUEST_VMMREQUEST IOCTL_CODE(FILE_DEVICE_UNKNOWN, 2050, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VMMDevRequestHeader))
1154#endif
1155
1156/** Input and output buffer layout of the IOCTL_VBOXGUEST_CTL_FILTER_MASK. */
1157typedef struct _VBoxGuestFilterMaskInfo
1158{
1159 uint32_t u32OrMask;
1160 uint32_t u32NotMask;
1161} VBoxGuestFilterMaskInfo;
1162#pragma pack()
1163
1164/** IOCTL to VBoxGuest to control event filter mask */
1165#ifdef VBOXGUEST_IOCTL_CODE
1166# define VBOXGUEST_IOCTL_CTL_FILTER_MASK VBOXGUEST_IOCTL_CODE(4, sizeof(VBoxGuestFilterMaskInfo))
1167# define IOCTL_VBOXGUEST_CTL_FILTER_MASK VBOXGUEST_IOCTL_CTL_FILTER_MASK
1168#else
1169# define IOCTL_VBOXGUEST_CTL_FILTER_MASK IOCTL_CODE(FILE_DEVICE_UNKNOWN, 2051, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof (VBoxGuestFilterMaskInfo))
1170#endif
1171
1172/** IOCTL to VBoxGuest to check memory ballooning */
1173#ifdef VBOXGUEST_IOCTL_CODE
1174# define VBOXGUEST_IOCTL_CTL_CHECK_BALLOON_MASK VBOXGUEST_IOCTL_CODE(4, 100)
1175# define IOCTL_VBOXGUEST_CTL_CHECK_BALLOON VBOXGUEST_IOCTL_CTL_CHECK_BALLOON_MASK
1176#else
1177# define IOCTL_VBOXGUEST_CTL_CHECK_BALLOON IOCTL_CODE(FILE_DEVICE_UNKNOWN, 2052, METHOD_BUFFERED, FILE_WRITE_ACCESS, 0)
1178#endif
1179
1180#ifdef VBOX_HGCM
1181/* These structures are shared between the driver and other binaries,
1182 * therefore packing must be defined explicitely.
1183 */
1184#pragma pack(1)
1185typedef struct _VBoxGuestHGCMConnectInfo
1186{
1187 uint32_t result; /**< OUT */
1188 HGCMServiceLocation Loc; /**< IN */
1189 uint32_t u32ClientID; /**< OUT */
1190} VBoxGuestHGCMConnectInfo;
1191
1192typedef struct _VBoxGuestHGCMDisconnectInfo
1193{
1194 uint32_t result; /**< OUT */
1195 uint32_t u32ClientID; /**< IN */
1196} VBoxGuestHGCMDisconnectInfo;
1197
1198typedef struct _VBoxGuestHGCMCallInfo
1199{
1200 uint32_t result; /**< OUT Host HGCM return code.*/
1201 uint32_t u32ClientID; /**< IN The id of the caller. */
1202 uint32_t u32Function; /**< IN Function number. */
1203 uint32_t cParms; /**< IN How many parms. */
1204 /* Parameters follow in form HGCMFunctionParameter aParms[cParms] */
1205} VBoxGuestHGCMCallInfo;
1206#pragma pack()
1207
1208#ifdef VBOXGUEST_IOCTL_CODE
1209# define VBOXGUEST_IOCTL_HGCM_CONNECT VBOXGUEST_IOCTL_CODE(16, sizeof(VBoxGuestHGCMConnectInfo))
1210# define IOCTL_VBOXGUEST_HGCM_CONNECT VBOXGUEST_IOCTL_HGCM_CONNECT
1211# define VBOXGUEST_IOCTL_HGCM_DISCONNECT VBOXGUEST_IOCTL_CODE(17, sizeof(VBoxGuestHGCMDisconnectInfo))
1212# define IOCTL_VBOXGUEST_HGCM_DISCONNECT VBOXGUEST_IOCTL_HGCM_DISCONNECT
1213# define VBOXGUEST_IOCTL_HGCM_CALL(Size) VBOXGUEST_IOCTL_CODE(18, (Size))
1214# define IOCTL_VBOXGUEST_HGCM_CALL VBOXGUEST_IOCTL_HGCM_CALL(sizeof(VBoxGuestHGCMCallInfo))
1215# define VBOXGUEST_IOCTL_CLIPBOARD_CONNECT VBOXGUEST_IOCTL_CODE(19, sizeof(uint32_t))
1216# define IOCTL_VBOXGUEST_CLIPBOARD_CONNECT VBOXGUEST_IOCTL_CLIPBOARD_CONNECT
1217#else
1218# define IOCTL_VBOXGUEST_HGCM_CONNECT IOCTL_CODE(FILE_DEVICE_UNKNOWN, 3072, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VBoxGuestHGCMConnectInfo))
1219# define IOCTL_VBOXGUEST_HGCM_DISCONNECT IOCTL_CODE(FILE_DEVICE_UNKNOWN, 3073, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VBoxGuestHGCMDisconnectInfo))
1220# define IOCTL_VBOXGUEST_HGCM_CALL IOCTL_CODE(FILE_DEVICE_UNKNOWN, 3074, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VBoxGuestHGCMCallInfo))
1221# define IOCTL_VBOXGUEST_CLIPBOARD_CONNECT IOCTL_CODE(FILE_DEVICE_UNKNOWN, 3075, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(uint32_t))
1222#endif
1223
1224#define VBOXGUEST_HGCM_CALL_PARMS(a) ((HGCMFunctionParameter *)((uint8_t *)(a) + sizeof (VBoxGuestHGCMCallInfo)))
1225
1226#endif /* VBOX_HGCM */
1227
1228/*
1229 * Credentials request flags and structure
1230 */
1231
1232#define VMMDEV_CREDENTIALS_STRLEN 128
1233
1234/** query from host whether credentials are present */
1235#define VMMDEV_CREDENTIALS_QUERYPRESENCE BIT(1)
1236/** read credentials from host (can be combined with clear) */
1237#define VMMDEV_CREDENTIALS_READ BIT(2)
1238/** clear credentials on host (can be combined with read) */
1239#define VMMDEV_CREDENTIALS_CLEAR BIT(3)
1240/** read credentials for judgement in the guest */
1241#define VMMDEV_CREDENTIALS_READJUDGE BIT(8)
1242/** clear credentials for judegement on the host */
1243#define VMMDEV_CREDENTIALS_CLEARJUDGE BIT(9)
1244/** report credentials acceptance by guest */
1245#define VMMDEV_CREDENTIALS_JUDGE_OK BIT(10)
1246/** report credentials denial by guest */
1247#define VMMDEV_CREDENTIALS_JUDGE_DENY BIT(11)
1248/** report that no judgement could be made by guest */
1249#define VMMDEV_CREDENTIALS_JUDGE_NOJUDGEMENT BIT(12)
1250
1251/** flag telling the guest that credentials are present */
1252#define VMMDEV_CREDENTIALS_PRESENT BIT(16)
1253/** flag telling guest that local logons should be prohibited */
1254#define VMMDEV_CREDENTIALS_NOLOCALLOGON BIT(17)
1255
1256/** credentials request structure */
1257#pragma pack(4)
1258typedef struct _VMMDevCredentials
1259{
1260 /* request header */
1261 VMMDevRequestHeader header;
1262 /* request flags (in/out) */
1263 uint32_t u32Flags;
1264 /* user name (UTF-8) (out) */
1265 char szUserName[VMMDEV_CREDENTIALS_STRLEN];
1266 /* password (UTF-8) (out) */
1267 char szPassword[VMMDEV_CREDENTIALS_STRLEN];
1268 /* domain name (UTF-8) (out) */
1269 char szDomain[VMMDEV_CREDENTIALS_STRLEN];
1270} VMMDevCredentials;
1271#pragma pack()
1272
1273/** inline helper to determine the request size for the given operation */
1274DECLINLINE(size_t) vmmdevGetRequestSize(VMMDevRequestType requestType)
1275{
1276 switch (requestType)
1277 {
1278 case VMMDevReq_GetMouseStatus:
1279 case VMMDevReq_SetMouseStatus:
1280 return sizeof(VMMDevReqMouseStatus);
1281 case VMMDevReq_SetPointerShape:
1282 return sizeof(VMMDevReqMousePointer);
1283 case VMMDevReq_GetHostVersion:
1284 return sizeof(VMMDevReqHostVersion);
1285 case VMMDevReq_Idle:
1286 return sizeof(VMMDevReqIdle);
1287 case VMMDevReq_GetHostTime:
1288 return sizeof(VMMDevReqHostTime);
1289 case VMMDevReq_GetHypervisorInfo:
1290 case VMMDevReq_SetHypervisorInfo:
1291 return sizeof(VMMDevReqHypervisorInfo);
1292 case VMMDevReq_SetPowerStatus:
1293 return sizeof(VMMDevPowerStateRequest);
1294 case VMMDevReq_AcknowledgeEvents:
1295 return sizeof(VMMDevEvents);
1296 case VMMDevReq_ReportGuestInfo:
1297 return sizeof(VMMDevReportGuestInfo);
1298 case VMMDevReq_GetDisplayChangeRequest:
1299 return sizeof(VMMDevDisplayChangeRequest);
1300 case VMMDevReq_GetDisplayChangeRequest2:
1301 return sizeof(VMMDevDisplayChangeRequest2);
1302 case VMMDevReq_VideoModeSupported:
1303 return sizeof(VMMDevVideoModeSupportedRequest);
1304 case VMMDevReq_GetHeightReduction:
1305 return sizeof(VMMDevGetHeightReductionRequest);
1306 case VMMDevReq_ReportGuestCapabilities:
1307 return sizeof(VMMDevReqGuestCapabilities);
1308#ifdef VBOX_HGCM
1309 case VMMDevReq_HGCMConnect:
1310 return sizeof(VMMDevHGCMConnect);
1311 case VMMDevReq_HGCMDisconnect:
1312 return sizeof(VMMDevHGCMDisconnect);
1313 case VMMDevReq_HGCMCall:
1314 return sizeof(VMMDevHGCMCall);
1315#endif
1316 case VMMDevReq_VideoAccelEnable:
1317 return sizeof(VMMDevVideoAccelEnable);
1318 case VMMDevReq_VideoAccelFlush:
1319 return sizeof(VMMDevVideoAccelFlush);
1320 case VMMDevReq_VideoSetVisibleRegion:
1321 return sizeof(VMMDevVideoSetVisibleRegion);
1322 case VMMDevReq_GetSeamlessChangeRequest:
1323 return sizeof(VMMDevSeamlessChangeRequest);
1324 case VMMDevReq_QueryCredentials:
1325 return sizeof(VMMDevCredentials);
1326 case VMMDevReq_ReportGuestStats:
1327 return sizeof(VMMDevReportGuestStats);
1328 case VMMDevReq_GetMemBalloonChangeRequest:
1329 return sizeof(VMMDevGetMemBalloonChangeRequest);
1330 case VMMDevReq_GetStatisticsChangeRequest:
1331 return sizeof(VMMDevGetStatisticsChangeRequest);
1332 case VMMDevReq_ChangeMemBalloon:
1333 return sizeof(VMMDevChangeMemBalloon);
1334 case VMMDevReq_LogString:
1335 return sizeof(VMMDevReqLogString);
1336 default:
1337 return 0;
1338 }
1339}
1340
1341/**
1342 * Initializes a request structure.
1343 *
1344 */
1345DECLINLINE(int) vmmdevInitRequest(VMMDevRequestHeader *req, VMMDevRequestType type)
1346{
1347 uint32_t requestSize;
1348 if (!req)
1349 return VERR_INVALID_PARAMETER;
1350 requestSize = (uint32_t)vmmdevGetRequestSize(type);
1351 if (!requestSize)
1352 return VERR_INVALID_PARAMETER;
1353 req->size = requestSize;
1354 req->version = VMMDEV_REQUEST_HEADER_VERSION;
1355 req->requestType = type;
1356 req->rc = VERR_GENERAL_FAILURE;
1357 req->reserved1 = 0;
1358 req->reserved2 = 0;
1359 return VINF_SUCCESS;
1360}
1361
1362
1363#ifdef RT_OS_OS2
1364
1365/**
1366 * The data buffer layout for the IDC entry point (AttachDD).
1367 *
1368 * @remark This is defined in multiple 16-bit headers / sources.
1369 * Some places it's called VBGOS2IDC to short things a bit.
1370 */
1371typedef struct VBOXGUESTOS2IDCCONNECT
1372{
1373 /** VMMDEV_VERSION. */
1374 uint32_t u32Version;
1375 /** Opaque session handle. */
1376 uint32_t u32Session;
1377
1378 /**
1379 * The 32-bit service entry point.
1380 *
1381 * @returns VBox status code.
1382 * @param u32Session The above session handle.
1383 * @param iFunction The requested function.
1384 * @param pvData The input/output data buffer. The caller ensures that this
1385 * cannot be swapped out, or that it's acceptable to take a
1386 * page in fault in the current context. If the request doesn't
1387 * take input or produces output, apssing NULL is okay.
1388 * @param cbData The size of the data buffer.
1389 * @param pcbDataReturned Where to store the amount of data that's returned.
1390 * This can be NULL if pvData is NULL.
1391 */
1392 DECLCALLBACKMEMBER(int, pfnServiceEP)(uint32_t u32Session, unsigned iFunction, void *pvData, size_t cbData, size_t *pcbDataReturned);
1393
1394 /** The 16-bit service entry point for C code (cdecl).
1395 *
1396 * It's the same as the 32-bit entry point, but the types has
1397 * changed to 16-bit equivalents.
1398 *
1399 * @code
1400 * int far cdecl
1401 * VBoxGuestOs2IDCService16(uint32_t u32Session, uint16_t iFunction,
1402 * void far *fpvData, uint16_t cbData, uint16_t far *pcbDataReturned);
1403 * @endcode
1404 */
1405 RTFAR16 fpfnServiceEP;
1406
1407 /** The 16-bit service entry point for Assembly code (register).
1408 *
1409 * This is just a wrapper around fpfnServiceEP to simplify calls
1410 * from 16-bit assembly code.
1411 *
1412 * @returns (e)ax: VBox status code; cx: The amount of data returned.
1413 *
1414 * @param u32Session eax - The above session handle.
1415 * @param iFunction dl - The requested function.
1416 * @param pvData es:bx - The input/output data buffer.
1417 * @param cbData cx - The size of the data buffer.
1418 */
1419 RTFAR16 fpfnServiceAsmEP;
1420} VBOXGUESTOS2IDCCONNECT;
1421/** Pointer to VBOXGUESTOS2IDCCONNECT buffer. */
1422typedef VBOXGUESTOS2IDCCONNECT *PVBOXGUESTOS2IDCCONNECT;
1423
1424/** OS/2 specific: IDC client disconnect request.
1425 *
1426 * This takes no input and it doesn't return anything. Obviously this
1427 * is only recognized if it arrives thru the IDC service EP.
1428 */
1429#define VBOXGUEST_IOCTL_OS2_IDC_DISCONNECT VBOXGUEST_IOCTL_CODE(48, sizeof(uint32_t))
1430
1431#endif /* RT_OS_OS2 */
1432
1433/** @} */
1434
1435
1436#ifdef IN_RING3
1437
1438/** @def VBGLR3DECL
1439 * Ring 3 VBGL declaration.
1440 * @param type The return type of the function declaration.
1441 */
1442#define VBGLR3DECL(type) type VBOXCALL
1443
1444/* General-purpose functions */
1445
1446__BEGIN_DECLS
1447VBGLR3DECL(int) VbglR3Init(void);
1448VBGLR3DECL(void) VbglR3Term(void);
1449VBGLR3DECL(int) VbglR3GRPerform(VMMDevRequestHeader *pReq);
1450# ifdef __iprt_time_h__
1451VBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime);
1452# endif
1453VBGLR3DECL(int) VbglR3InterruptEventWaits(void);
1454
1455/* Shared clipboard */
1456
1457VBGLR3DECL(int) VbglR3ClipboardConnect(uint32_t *pu32ClientId);
1458VBGLR3DECL(int) VbglR3ClipboardDisconnect(uint32_t u32ClientId);
1459VBGLR3DECL(int) VbglR3ClipboardGetHostMsg(uint32_t u32ClientId, uint32_t *pMsg, uint32_t *pfFormats);
1460VBGLR3DECL(int) VbglR3ClipboardReadData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcb);
1461VBGLR3DECL(int) VbglR3ClipboardReportFormats(uint32_t u32ClientId, uint32_t fFormats);
1462VBGLR3DECL(int) VbglR3ClipboardWriteData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb);
1463
1464/* Seamless mode */
1465
1466VBGLR3DECL(int) VbglR3SeamlessSetCap(bool bState);
1467VBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
1468VBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
1469
1470__END_DECLS
1471
1472#endif /* IN_RING3 */
1473
1474#endif
Note: See TracBrowser for help on using the repository browser.

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