VirtualBox

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

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

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