SUPDrvIOC.h@ 53396

Last change on this file since 53396 was 53269, checked in by vboxsync, 10 years ago
HostDrivers/Support: Enabled global TSC rate calculation and implemented TSC calibration over a longer interval for invariant hosts.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 52.1 KB

Line
1	/* $Revision: 53269 $ */
2	/** @file
3	* VirtualBox Support Driver - IOCtl definitions.
4	*/
5
6	/*
7	* Copyright (C) 2006-2014 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* The contents of this file may alternatively be used under the terms
18	* of the Common Development and Distribution License Version 1.0
19	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20	* VirtualBox OSE distribution, in which case the provisions of the
21	* CDDL are applicable instead of those of the GPL.
22	*
23	* You may elect to license modified versions of this file under the
24	* terms and conditions of either the GPL or the CDDL or both.
25	*/
26
27	#ifndef ___SUPDrvIOC_h___
28	#define ___SUPDrvIOC_h___
29
30	/*
31	* Basic types.
32	*/
33	#include <iprt/types.h>
34	#include <VBox/sup.h>
35
36	/*
37	* IOCtl numbers.
38	* We're using the Win32 type of numbers here, thus the macros below.
39	* The SUP_IOCTL_FLAG macro is used to separate requests from 32-bit
40	* and 64-bit processes.
41	*/
42	#if defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_SPARC64)
43	# define SUP_IOCTL_FLAG 128
44	#elif defined(RT_ARCH_X86) \|\| defined(RT_ARCH_SPARC)
45	# define SUP_IOCTL_FLAG 0
46	#else
47	# error "dunno which arch this is!"
48	#endif
49
50	#ifdef RT_OS_WINDOWS
51	# ifndef CTL_CODE
52	# include <Windows.h>
53	# endif
54	/* Automatic buffering, size not encoded. */
55	# define SUP_CTL_CODE_SIZE(Function, Size) CTL_CODE(FILE_DEVICE_UNKNOWN, (Function) \| SUP_IOCTL_FLAG, METHOD_BUFFERED, FILE_WRITE_ACCESS)
56	# define SUP_CTL_CODE_BIG(Function) CTL_CODE(FILE_DEVICE_UNKNOWN, (Function) \| SUP_IOCTL_FLAG, METHOD_BUFFERED, FILE_WRITE_ACCESS)
57	# define SUP_CTL_CODE_FAST(Function) CTL_CODE(FILE_DEVICE_UNKNOWN, (Function) \| SUP_IOCTL_FLAG, METHOD_NEITHER, FILE_WRITE_ACCESS)
58	# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
59
60	# define SUP_NT_STATUS_BASE UINT32_C(0xe9860000) /*< STATUS_SEVERITY_ERROR + C-bit + facility 0x986. /
61	# define SUP_NT_STATUS_IS_VBOX(a_rcNt) ( ((uint32_t)(a_rcNt) & 0xffff0000) == SUP_NT_STATUS_BASE )
62	# define SUP_NT_STATUS_TO_VBOX(a_rcNt) ( (int)((uint32_t)(a_rcNt) \| UINT32_C(0xffff0000)) )
63
64	/** NT device name for system access. */
65	# define SUPDRV_NT_DEVICE_NAME_SYS L"\\Device\\VBoxDrv"
66	/** NT device name for user access. */
67	# define SUPDRV_NT_DEVICE_NAME_USR L"\\Device\\VBoxDrvU"
68	# ifdef VBOX_WITH_HARDENING
69	/** NT device name for hardened stub access. */
70	# define SUPDRV_NT_DEVICE_NAME_STUB L"\\Device\\VBoxDrvStub"
71	/** NT device name for getting error information for failed VBoxDrv or
72	* VBoxDrvStub open. */
73	# define SUPDRV_NT_DEVICE_NAME_ERROR_INFO L"\\Device\\VBoxDrvErrorInfo"
74	# endif
75
76
77	#elif defined(RT_OS_SOLARIS)
78	/* No automatic buffering, size limited to 255 bytes. */
79	# include <sys/ioccom.h>
80	# define SUP_CTL_CODE_SIZE(Function, Size) _IOWRN('V', (Function) \| SUP_IOCTL_FLAG, sizeof(SUPREQHDR))
81	# define SUP_CTL_CODE_BIG(Function) _IOWRN('V', (Function) \| SUP_IOCTL_FLAG, sizeof(SUPREQHDR))
82	# define SUP_CTL_CODE_FAST(Function) _IO( 'V', (Function) \| SUP_IOCTL_FLAG)
83	# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
84
85	#elif defined(RT_OS_OS2)
86	/* No automatic buffering, size not encoded. */
87	# define SUP_CTL_CATEGORY 0xc0
88	# define SUP_CTL_CODE_SIZE(Function, Size) ((unsigned char)(Function))
89	# define SUP_CTL_CODE_BIG(Function) ((unsigned char)(Function))
90	# define SUP_CTL_CATEGORY_FAST 0xc1
91	# define SUP_CTL_CODE_FAST(Function) ((unsigned char)(Function))
92	# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
93
94	#elif defined(RT_OS_LINUX)
95	/* No automatic buffering, size limited to 16KB. */
96	# include <linux/ioctl.h>
97	# define SUP_CTL_CODE_SIZE(Function, Size) _IOC(_IOC_READ \| _IOC_WRITE, 'V', (Function) \| SUP_IOCTL_FLAG, (Size))
98	# define SUP_CTL_CODE_BIG(Function) _IO('V', (Function) \| SUP_IOCTL_FLAG)
99	# define SUP_CTL_CODE_FAST(Function) _IO('V', (Function) \| SUP_IOCTL_FLAG)
100	# define SUP_CTL_CODE_NO_SIZE(uIOCtl) ((uIOCtl) & ~IOCSIZE_MASK)
101
102	#elif defined(RT_OS_L4)
103	/* Implemented in suplib, no worries. */
104	# define SUP_CTL_CODE_SIZE(Function, Size) (Function)
105	# define SUP_CTL_CODE_BIG(Function) (Function)
106	# define SUP_CTL_CODE_FAST(Function) (Function)
107	# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
108
109	#else /* BSD Like */
110	/* Automatic buffering, size limited to 4KB on BSD and 8KB on Darwin - commands the limit, 4KB. /
111	# include <sys/ioccom.h>
112	# define SUP_CTL_CODE_SIZE(Function, Size) _IOC(IOC_INOUT, 'V', (Function) \| SUP_IOCTL_FLAG, (Size))
113	# define SUP_CTL_CODE_BIG(Function) _IO('V', (Function) \| SUP_IOCTL_FLAG)
114	# define SUP_CTL_CODE_FAST(Function) _IO('V', (Function) \| SUP_IOCTL_FLAG)
115	# define SUP_CTL_CODE_NO_SIZE(uIOCtl) ( (uIOCtl) & ~_IOC(0,0,0,IOCPARM_MASK) )
116	#endif
117
118	/** Fast path IOCtl: VMMR0_DO_RAW_RUN */
119	#define SUP_IOCTL_FAST_DO_RAW_RUN SUP_CTL_CODE_FAST(64)
120	/** Fast path IOCtl: VMMR0_DO_HM_RUN */
121	#define SUP_IOCTL_FAST_DO_HM_RUN SUP_CTL_CODE_FAST(65)
122	/** Just a NOP call for profiling the latency of a fast ioctl call to VMMR0. */
123	#define SUP_IOCTL_FAST_DO_NOP SUP_CTL_CODE_FAST(66)
124
125	#ifdef RT_OS_DARWIN
126	/** Cookie used to fend off some unwanted clients to the IOService. */
127	# define SUP_DARWIN_IOSERVICE_COOKIE 0x64726962 /* 'bird' */
128	#endif
129
130
131	/*******************************************************************************
132	* Structures and Typedefs *
133	*******************************************************************************/
134	#ifdef RT_ARCH_AMD64
135	# pragma pack(8) /* paranoia. */
136	#else
137	# pragma pack(4) /* paranoia. */
138	#endif
139
140
141	/**
142	* Common In/Out header.
143	*/
144	typedef struct SUPREQHDR
145	{
146	/** Cookie. */
147	uint32_t u32Cookie;
148	/** Session cookie. */
149	uint32_t u32SessionCookie;
150	/** The size of the input. */
151	uint32_t cbIn;
152	/** The size of the output. */
153	uint32_t cbOut;
154	/** Flags. See SUPREQHDR_FLAGS_* for details and values. */
155	uint32_t fFlags;
156	/** The VBox status code of the operation, out direction only. */
157	int32_t rc;
158	} SUPREQHDR;
159	/** Pointer to a IOC header. */
160	typedef SUPREQHDR *PSUPREQHDR;
161
162	/** @name SUPREQHDR::fFlags values
163	* @{ */
164	/** Masks out the magic value. */
165	#define SUPREQHDR_FLAGS_MAGIC_MASK UINT32_C(0xff0000ff)
166	/** The generic mask. */
167	#define SUPREQHDR_FLAGS_GEN_MASK UINT32_C(0x0000ff00)
168	/** The request specific mask. */
169	#define SUPREQHDR_FLAGS_REQ_MASK UINT32_C(0x00ff0000)
170
171	/** There is extra input that needs copying on some platforms. */
172	#define SUPREQHDR_FLAGS_EXTRA_IN UINT32_C(0x00000100)
173	/** There is extra output that needs copying on some platforms. */
174	#define SUPREQHDR_FLAGS_EXTRA_OUT UINT32_C(0x00000200)
175
176	/** The magic value. */
177	#define SUPREQHDR_FLAGS_MAGIC UINT32_C(0x42000042)
178	/** The default value. Use this when no special stuff is requested. */
179	#define SUPREQHDR_FLAGS_DEFAULT SUPREQHDR_FLAGS_MAGIC
180	/** @} */
181
182
183	/** @name SUP_IOCTL_COOKIE
184	* @{
185	*/
186	/** Negotiate cookie. */
187	#define SUP_IOCTL_COOKIE SUP_CTL_CODE_SIZE(1, SUP_IOCTL_COOKIE_SIZE)
188	/** The request size. */
189	#define SUP_IOCTL_COOKIE_SIZE sizeof(SUPCOOKIE)
190	/** The SUPREQHDR::cbIn value. */
191	#define SUP_IOCTL_COOKIE_SIZE_IN sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPCOOKIE, u.In)
192	/** The SUPREQHDR::cbOut value. */
193	#define SUP_IOCTL_COOKIE_SIZE_OUT sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPCOOKIE, u.Out)
194	/** SUPCOOKIE_IN magic word. */
195	#define SUPCOOKIE_MAGIC "The Magic Word!"
196	/** The initial cookie. */
197	#define SUPCOOKIE_INITIAL_COOKIE 0x69726f74 /* 'tori' */
198
199	/** Current interface version.
200	* The upper 16-bit is the major version, the lower the minor version.
201	* When incompatible changes are made, the upper major number has to be changed.
202	*
203	* Update rules:
204	* -# Only update the major number when incompatible changes have been made to
205	* the IOC interface or the ABI provided via the functions returned by
206	* SUPQUERYFUNCS.
207	* -# When adding new features (new IOC number, new flags, new exports, ++)
208	* only update the minor number and change SUPLib.cpp to require the
209	* new IOC version.
210	* -# When incrementing the major number, clear the minor part and reset
211	* any IOC version requirements in SUPLib.cpp.
212	* -# When increment the major number, execute all pending work.
213	*
214	* @todo Pending work on next major version change:
215	* - (none).
216	*/
217	#define SUPDRV_IOC_VERSION 0x001d0000
218
219	/** SUP_IOCTL_COOKIE. */
220	typedef struct SUPCOOKIE
221	{
222	/** The header.
223	* u32Cookie must be set to SUPCOOKIE_INITIAL_COOKIE.
224	* u32SessionCookie should be set to some random value. */
225	SUPREQHDR Hdr;
226	union
227	{
228	struct
229	{
230	/** Magic word. */
231	char szMagic[16];
232	/** The requested interface version number. */
233	uint32_t u32ReqVersion;
234	/** The minimum interface version number. */
235	uint32_t u32MinVersion;
236	} In;
237	struct
238	{
239	/** Cookie. */
240	uint32_t u32Cookie;
241	/** Session cookie. */
242	uint32_t u32SessionCookie;
243	/** Interface version for this session. */
244	uint32_t u32SessionVersion;
245	/** The actual interface version in the driver. */
246	uint32_t u32DriverVersion;
247	/** Number of functions available for the SUP_IOCTL_QUERY_FUNCS request. */
248	uint32_t cFunctions;
249	/** Session handle. */
250	R0PTRTYPE(PSUPDRVSESSION) pSession;
251	} Out;
252	} u;
253	} SUPCOOKIE, *PSUPCOOKIE;
254	/** @} */
255
256
257	/** @name SUP_IOCTL_QUERY_FUNCS
258	* Query SUPR0 functions.
259	* @{
260	*/
261	#define SUP_IOCTL_QUERY_FUNCS(cFuncs) SUP_CTL_CODE_BIG(2)
262	#define SUP_IOCTL_QUERY_FUNCS_SIZE(cFuncs) RT_UOFFSETOF(SUPQUERYFUNCS, u.Out.aFunctions[(cFuncs)])
263	#define SUP_IOCTL_QUERY_FUNCS_SIZE_IN sizeof(SUPREQHDR)
264	#define SUP_IOCTL_QUERY_FUNCS_SIZE_OUT(cFuncs) SUP_IOCTL_QUERY_FUNCS_SIZE(cFuncs)
265
266	/** A function. */
267	typedef struct SUPFUNC
268	{
269	/** Name - mangled. */
270	char szName[32];
271	/** Address. */
272	RTR0PTR pfn;
273	} SUPFUNC, *PSUPFUNC;
274
275	typedef struct SUPQUERYFUNCS
276	{
277	/** The header. */
278	SUPREQHDR Hdr;
279	union
280	{
281	struct
282	{
283	/** Number of functions returned. */
284	uint32_t cFunctions;
285	/** Array of functions. */
286	SUPFUNC aFunctions[1];
287	} Out;
288	} u;
289	} SUPQUERYFUNCS, *PSUPQUERYFUNCS;
290	/** @} */
291
292
293	/** @name SUP_IOCTL_LDR_OPEN
294	* Open an image.
295	* @{
296	*/
297	#define SUP_IOCTL_LDR_OPEN SUP_CTL_CODE_SIZE(3, SUP_IOCTL_LDR_OPEN_SIZE)
298	#define SUP_IOCTL_LDR_OPEN_SIZE sizeof(SUPLDROPEN)
299	#define SUP_IOCTL_LDR_OPEN_SIZE_IN sizeof(SUPLDROPEN)
300	#define SUP_IOCTL_LDR_OPEN_SIZE_OUT (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPLDROPEN, u.Out))
301	typedef struct SUPLDROPEN
302	{
303	/** The header. */
304	SUPREQHDR Hdr;
305	union
306	{
307	struct
308	{
309	/** Size of the image we'll be loading (including tables). */
310	uint32_t cbImageWithTabs;
311	/** The size of the image bits. (Less or equal to cbImageWithTabs.) */
312	uint32_t cbImageBits;
313	/** Image name.
314	* This is the NAME of the image, not the file name. It is used
315	* to share code with other processes. (Max len is 32 chars!) */
316	char szName[32];
317	/** Image file name.
318	* This can be used to load the image using a native loader. */
319	char szFilename[260];
320	} In;
321	struct
322	{
323	/** The base address of the image. */
324	RTR0PTR pvImageBase;
325	/** Indicate whether or not the image requires loading. */
326	bool fNeedsLoading;
327	/** Indicates that we're using the native ring-0 loader. */
328	bool fNativeLoader;
329	} Out;
330	} u;
331	} SUPLDROPEN, *PSUPLDROPEN;
332	/** @} */
333
334
335	/** @name SUP_IOCTL_LDR_LOAD
336	* Upload the image bits.
337	* @{
338	*/
339	#define SUP_IOCTL_LDR_LOAD SUP_CTL_CODE_BIG(4)
340	#define SUP_IOCTL_LDR_LOAD_SIZE(cbImage) RT_UOFFSETOF(SUPLDRLOAD, u.In.abImage[cbImage])
341	#define SUP_IOCTL_LDR_LOAD_SIZE_IN(cbImage) RT_UOFFSETOF(SUPLDRLOAD, u.In.abImage[cbImage])
342	#define SUP_IOCTL_LDR_LOAD_SIZE_OUT sizeof(SUPREQHDR)
343
344	/**
345	* Module initialization callback function.
346	* This is called once after the module has been loaded.
347	*
348	* @returns 0 on success.
349	* @returns Appropriate error code on failure.
350	* @param hMod Image handle for use in APIs.
351	*/
352	typedef DECLCALLBACK(int) FNR0MODULEINIT(void *hMod);
353	/** Pointer to a FNR0MODULEINIT(). */
354	typedef R0PTRTYPE(FNR0MODULEINIT *) PFNR0MODULEINIT;
355
356	/**
357	* Module termination callback function.
358	* This is called once right before the module is being unloaded.
359	*
360	* @param hMod Image handle for use in APIs.
361	*/
362	typedef DECLCALLBACK(void) FNR0MODULETERM(void *hMod);
363	/** Pointer to a FNR0MODULETERM(). */
364	typedef R0PTRTYPE(FNR0MODULETERM *) PFNR0MODULETERM;
365
366	/**
367	* Symbol table entry.
368	*/
369	typedef struct SUPLDRSYM
370	{
371	/** Offset into of the string table. */
372	uint32_t offName;
373	/** Offset of the symbol relative to the image load address.
374	* @remarks When used inside the SUPDrv to calculate real addresses, it
375	* must be cast to int32_t for the sake of native loader support
376	* on Solaris. (The loader puts the and data in different
377	* memory areans, and the text one is generally higher.) */
378	uint32_t offSymbol;
379	} SUPLDRSYM;
380	/** Pointer to a symbol table entry. */
381	typedef SUPLDRSYM *PSUPLDRSYM;
382	/** Pointer to a const symbol table entry. */
383	typedef SUPLDRSYM const *PCSUPLDRSYM;
384
385	/**
386	* SUPLDRLOAD::u::In::EP type.
387	*/
388	typedef enum SUPLDRLOADEP
389	{
390	SUPLDRLOADEP_NOTHING = 0,
391	SUPLDRLOADEP_VMMR0,
392	SUPLDRLOADEP_SERVICE,
393	SUPLDRLOADEP_32BIT_HACK = 0x7fffffff
394	} SUPLDRLOADEP;
395
396	typedef struct SUPLDRLOAD
397	{
398	/** The header. */
399	SUPREQHDR Hdr;
400	union
401	{
402	struct
403	{
404	/** The address of module initialization function. Similar to _DLL_InitTerm(hmod, 0). */
405	PFNR0MODULEINIT pfnModuleInit;
406	/** The address of module termination function. Similar to _DLL_InitTerm(hmod, 1). */
407	PFNR0MODULETERM pfnModuleTerm;
408	/** Special entry points. */
409	union
410	{
411	/** SUPLDRLOADEP_VMMR0. */
412	struct
413	{
414	/** The module handle (i.e. address). */
415	RTR0PTR pvVMMR0;
416	/** Address of VMMR0EntryInt function. */
417	RTR0PTR pvVMMR0EntryInt;
418	/** Address of VMMR0EntryFast function. */
419	RTR0PTR pvVMMR0EntryFast;
420	/** Address of VMMR0EntryEx function. */
421	RTR0PTR pvVMMR0EntryEx;
422	} VMMR0;
423	/** SUPLDRLOADEP_SERVICE. */
424	struct
425	{
426	/** The service request handler.
427	* (PFNR0SERVICEREQHANDLER isn't defined yet.) */
428	RTR0PTR pfnServiceReq;
429	/** Reserved, must be NIL. */
430	RTR0PTR apvReserved[3];
431	} Service;
432	} EP;
433	/** Address. */
434	RTR0PTR pvImageBase;
435	/** Entry point type. */
436	SUPLDRLOADEP eEPType;
437	/** The size of the image bits (starting at offset 0 and
438	* approaching offSymbols). */
439	uint32_t cbImageBits;
440	/** The offset of the symbol table. */
441	uint32_t offSymbols;
442	/** The number of entries in the symbol table. */
443	uint32_t cSymbols;
444	/** The offset of the string table. */
445	uint32_t offStrTab;
446	/** Size of the string table. */
447	uint32_t cbStrTab;
448	/** Size of image data in achImage. */
449	uint32_t cbImageWithTabs;
450	/** The image data. */
451	uint8_t abImage[1];
452	} In;
453	} u;
454	} SUPLDRLOAD, *PSUPLDRLOAD;
455	/** @} */
456
457
458	/** @name SUP_IOCTL_LDR_FREE
459	* Free an image.
460	* @{
461	*/
462	#define SUP_IOCTL_LDR_FREE SUP_CTL_CODE_SIZE(5, SUP_IOCTL_LDR_FREE_SIZE)
463	#define SUP_IOCTL_LDR_FREE_SIZE sizeof(SUPLDRFREE)
464	#define SUP_IOCTL_LDR_FREE_SIZE_IN sizeof(SUPLDRFREE)
465	#define SUP_IOCTL_LDR_FREE_SIZE_OUT sizeof(SUPREQHDR)
466	typedef struct SUPLDRFREE
467	{
468	/** The header. */
469	SUPREQHDR Hdr;
470	union
471	{
472	struct
473	{
474	/** Address. */
475	RTR0PTR pvImageBase;
476	} In;
477	} u;
478	} SUPLDRFREE, *PSUPLDRFREE;
479	/** @} */
480
481
482	/** @name SUP_IOCTL_LDR_GET_SYMBOL
483	* Get address of a symbol within an image.
484	* @{
485	*/
486	#define SUP_IOCTL_LDR_GET_SYMBOL SUP_CTL_CODE_SIZE(6, SUP_IOCTL_LDR_GET_SYMBOL_SIZE)
487	#define SUP_IOCTL_LDR_GET_SYMBOL_SIZE sizeof(SUPLDRGETSYMBOL)
488	#define SUP_IOCTL_LDR_GET_SYMBOL_SIZE_IN sizeof(SUPLDRGETSYMBOL)
489	#define SUP_IOCTL_LDR_GET_SYMBOL_SIZE_OUT (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPLDRGETSYMBOL, u.Out))
490	typedef struct SUPLDRGETSYMBOL
491	{
492	/** The header. */
493	SUPREQHDR Hdr;
494	union
495	{
496	struct
497	{
498	/** Address. */
499	RTR0PTR pvImageBase;
500	/** The symbol name. */
501	char szSymbol[64];
502	} In;
503	struct
504	{
505	/** The symbol address. */
506	RTR0PTR pvSymbol;
507	} Out;
508	} u;
509	} SUPLDRGETSYMBOL, *PSUPLDRGETSYMBOL;
510	/** @} */
511
512
513	/** @name SUP_IOCTL_CALL_VMMR0
514	* Call the R0 VMM Entry point.
515	* @{
516	*/
517	#define SUP_IOCTL_CALL_VMMR0(cbReq) SUP_CTL_CODE_SIZE(7, SUP_IOCTL_CALL_VMMR0_SIZE(cbReq))
518	#define SUP_IOCTL_CALL_VMMR0_SIZE(cbReq) RT_UOFFSETOF(SUPCALLVMMR0, abReqPkt[cbReq])
519	#define SUP_IOCTL_CALL_VMMR0_SIZE_IN(cbReq) SUP_IOCTL_CALL_VMMR0_SIZE(cbReq)
520	#define SUP_IOCTL_CALL_VMMR0_SIZE_OUT(cbReq) SUP_IOCTL_CALL_VMMR0_SIZE(cbReq)
521	typedef struct SUPCALLVMMR0
522	{
523	/** The header. */
524	SUPREQHDR Hdr;
525	union
526	{
527	struct
528	{
529	/** The VM handle. */
530	PVMR0 pVMR0;
531	/** VCPU id. */
532	uint32_t idCpu;
533	/** Which operation to execute. */
534	uint32_t uOperation;
535	/** Argument to use when no request packet is supplied. */
536	uint64_t u64Arg;
537	} In;
538	} u;
539	/** The VMMR0Entry request packet. */
540	uint8_t abReqPkt[1];
541	} SUPCALLVMMR0, *PSUPCALLVMMR0;
542	/** @} */
543
544
545	/** @name SUP_IOCTL_CALL_VMMR0_BIG
546	* Version of SUP_IOCTL_CALL_VMMR0 for dealing with large requests.
547	* @{
548	*/
549	#define SUP_IOCTL_CALL_VMMR0_BIG SUP_CTL_CODE_BIG(27)
550	#define SUP_IOCTL_CALL_VMMR0_BIG_SIZE(cbReq) RT_UOFFSETOF(SUPCALLVMMR0, abReqPkt[cbReq])
551	#define SUP_IOCTL_CALL_VMMR0_BIG_SIZE_IN(cbReq) SUP_IOCTL_CALL_VMMR0_SIZE(cbReq)
552	#define SUP_IOCTL_CALL_VMMR0_BIG_SIZE_OUT(cbReq) SUP_IOCTL_CALL_VMMR0_SIZE(cbReq)
553	/** @} */
554
555
556	/** @name SUP_IOCTL_LOW_ALLOC
557	* Allocate memory below 4GB (physically).
558	* @{
559	*/
560	#define SUP_IOCTL_LOW_ALLOC SUP_CTL_CODE_BIG(8)
561	#define SUP_IOCTL_LOW_ALLOC_SIZE(cPages) ((uint32_t)RT_UOFFSETOF(SUPLOWALLOC, u.Out.aPages[cPages]))
562	#define SUP_IOCTL_LOW_ALLOC_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPLOWALLOC, u.In))
563	#define SUP_IOCTL_LOW_ALLOC_SIZE_OUT(cPages) SUP_IOCTL_LOW_ALLOC_SIZE(cPages)
564	typedef struct SUPLOWALLOC
565	{
566	/** The header. */
567	SUPREQHDR Hdr;
568	union
569	{
570	struct
571	{
572	/** Number of pages to allocate. */
573	uint32_t cPages;
574	} In;
575	struct
576	{
577	/** The ring-3 address of the allocated memory. */
578	RTR3PTR pvR3;
579	/** The ring-0 address of the allocated memory. */
580	RTR0PTR pvR0;
581	/** Array of pages. */
582	RTHCPHYS aPages[1];
583	} Out;
584	} u;
585	} SUPLOWALLOC, *PSUPLOWALLOC;
586	/** @} */
587
588
589	/** @name SUP_IOCTL_LOW_FREE
590	* Free low memory.
591	* @{
592	*/
593	#define SUP_IOCTL_LOW_FREE SUP_CTL_CODE_SIZE(9, SUP_IOCTL_LOW_FREE_SIZE)
594	#define SUP_IOCTL_LOW_FREE_SIZE sizeof(SUPLOWFREE)
595	#define SUP_IOCTL_LOW_FREE_SIZE_IN sizeof(SUPLOWFREE)
596	#define SUP_IOCTL_LOW_FREE_SIZE_OUT sizeof(SUPREQHDR)
597	typedef struct SUPLOWFREE
598	{
599	/** The header. */
600	SUPREQHDR Hdr;
601	union
602	{
603	struct
604	{
605	/** The ring-3 address of the memory to free. */
606	RTR3PTR pvR3;
607	} In;
608	} u;
609	} SUPLOWFREE, *PSUPLOWFREE;
610	/** @} */
611
612
613	/** @name SUP_IOCTL_PAGE_ALLOC_EX
614	* Allocate memory and map it into kernel and/or user space. The memory is of
615	* course locked. The result should be freed using SUP_IOCTL_PAGE_FREE.
616	*
617	* @remarks Allocations without a kernel mapping may fail with
618	* VERR_NOT_SUPPORTED on some platforms.
619	*
620	* @{
621	*/
622	#define SUP_IOCTL_PAGE_ALLOC_EX SUP_CTL_CODE_BIG(10)
623	#define SUP_IOCTL_PAGE_ALLOC_EX_SIZE(cPages) RT_UOFFSETOF(SUPPAGEALLOCEX, u.Out.aPages[cPages])
624	#define SUP_IOCTL_PAGE_ALLOC_EX_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPPAGEALLOCEX, u.In))
625	#define SUP_IOCTL_PAGE_ALLOC_EX_SIZE_OUT(cPages) SUP_IOCTL_PAGE_ALLOC_EX_SIZE(cPages)
626	typedef struct SUPPAGEALLOCEX
627	{
628	/** The header. */
629	SUPREQHDR Hdr;
630	union
631	{
632	struct
633	{
634	/** Number of pages to allocate */
635	uint32_t cPages;
636	/** Whether it should have kernel mapping. */
637	bool fKernelMapping;
638	/** Whether it should have a user mapping. */
639	bool fUserMapping;
640	/** Reserved. Must be false. */
641	bool fReserved0;
642	/** Reserved. Must be false. */
643	bool fReserved1;
644	} In;
645	struct
646	{
647	/** Returned ring-3 address. */
648	RTR3PTR pvR3;
649	/** Returned ring-0 address. */
650	RTR0PTR pvR0;
651	/** The physical addresses of the allocated pages. */
652	RTHCPHYS aPages[1];
653	} Out;
654	} u;
655	} SUPPAGEALLOCEX, *PSUPPAGEALLOCEX;
656	/** @} */
657
658
659	/** @name SUP_IOCTL_PAGE_MAP_KERNEL
660	* Maps a portion of memory allocated by SUP_IOCTL_PAGE_ALLOC_EX /
661	* SUPR0PageAllocEx into kernel space for use by a device or similar.
662	*
663	* The mapping will be freed together with the ring-3 mapping when
664	* SUP_IOCTL_PAGE_FREE or SUPR0PageFree is called.
665	*
666	* @remarks Not necessarily supported on all platforms.
667	*
668	* @{
669	*/
670	#define SUP_IOCTL_PAGE_MAP_KERNEL SUP_CTL_CODE_SIZE(11, SUP_IOCTL_PAGE_MAP_KERNEL_SIZE)
671	#define SUP_IOCTL_PAGE_MAP_KERNEL_SIZE sizeof(SUPPAGEMAPKERNEL)
672	#define SUP_IOCTL_PAGE_MAP_KERNEL_SIZE_IN sizeof(SUPPAGEMAPKERNEL)
673	#define SUP_IOCTL_PAGE_MAP_KERNEL_SIZE_OUT sizeof(SUPPAGEMAPKERNEL)
674	typedef struct SUPPAGEMAPKERNEL
675	{
676	/** The header. */
677	SUPREQHDR Hdr;
678	union
679	{
680	struct
681	{
682	/** The pointer of to the previously allocated memory. */
683	RTR3PTR pvR3;
684	/** The offset to start mapping from. */
685	uint32_t offSub;
686	/** Size of the section to map. */
687	uint32_t cbSub;
688	/** Flags reserved for future fun. */
689	uint32_t fFlags;
690	} In;
691	struct
692	{
693	/** The ring-0 address corresponding to pvR3 + offSub. */
694	RTR0PTR pvR0;
695	} Out;
696	} u;
697	} SUPPAGEMAPKERNEL, *PSUPPAGEMAPKERNEL;
698	/** @} */
699
700
701	/** @name SUP_IOCTL_PAGE_PROTECT
702	* Changes the page level protection of the user and/or kernel mappings of
703	* memory previously allocated by SUPR0PageAllocEx.
704	*
705	* @remarks Not necessarily supported on all platforms.
706	*
707	* @{
708	*/
709	#define SUP_IOCTL_PAGE_PROTECT SUP_CTL_CODE_SIZE(12, SUP_IOCTL_PAGE_PROTECT_SIZE)
710	#define SUP_IOCTL_PAGE_PROTECT_SIZE sizeof(SUPPAGEPROTECT)
711	#define SUP_IOCTL_PAGE_PROTECT_SIZE_IN sizeof(SUPPAGEPROTECT)
712	#define SUP_IOCTL_PAGE_PROTECT_SIZE_OUT sizeof(SUPPAGEPROTECT)
713	typedef struct SUPPAGEPROTECT
714	{
715	/** The header. */
716	SUPREQHDR Hdr;
717	union
718	{
719	struct
720	{
721	/** The pointer of to the previously allocated memory.
722	* Pass NIL_RTR3PTR if the ring-0 mapping should remain unaffected. */
723	RTR3PTR pvR3;
724	/** The pointer of to the previously allocated memory.
725	* Pass NIL_RTR0PTR if the ring-0 mapping should remain unaffected. */
726	RTR0PTR pvR0;
727	/** The offset to start changing protection at. */
728	uint32_t offSub;
729	/** Size of the portion that should be changed. */
730	uint32_t cbSub;
731	/** Protection flags, RTMEM_PROT_. /
732	uint32_t fProt;
733	} In;
734	} u;
735	} SUPPAGEPROTECT, *PSUPPAGEPROTECT;
736	/** @} */
737
738
739	/** @name SUP_IOCTL_PAGE_FREE
740	* Free memory allocated with SUP_IOCTL_PAGE_ALLOC_EX.
741	* @{
742	*/
743	#define SUP_IOCTL_PAGE_FREE SUP_CTL_CODE_SIZE(13, SUP_IOCTL_PAGE_FREE_SIZE_IN)
744	#define SUP_IOCTL_PAGE_FREE_SIZE sizeof(SUPPAGEFREE)
745	#define SUP_IOCTL_PAGE_FREE_SIZE_IN sizeof(SUPPAGEFREE)
746	#define SUP_IOCTL_PAGE_FREE_SIZE_OUT sizeof(SUPREQHDR)
747	typedef struct SUPPAGEFREE
748	{
749	/** The header. */
750	SUPREQHDR Hdr;
751	union
752	{
753	struct
754	{
755	/** Address of memory range to free. */
756	RTR3PTR pvR3;
757	} In;
758	} u;
759	} SUPPAGEFREE, *PSUPPAGEFREE;
760	/** @} */
761
762
763
764
765	/** @name SUP_IOCTL_PAGE_LOCK
766	* Pin down physical pages.
767	* @{
768	*/
769	#define SUP_IOCTL_PAGE_LOCK SUP_CTL_CODE_BIG(14)
770	#define SUP_IOCTL_PAGE_LOCK_SIZE(cPages) (RT_MAX((size_t)SUP_IOCTL_PAGE_LOCK_SIZE_IN, (size_t)SUP_IOCTL_PAGE_LOCK_SIZE_OUT(cPages)))
771	#define SUP_IOCTL_PAGE_LOCK_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPPAGELOCK, u.In))
772	#define SUP_IOCTL_PAGE_LOCK_SIZE_OUT(cPages) RT_UOFFSETOF(SUPPAGELOCK, u.Out.aPages[cPages])
773	typedef struct SUPPAGELOCK
774	{
775	/** The header. */
776	SUPREQHDR Hdr;
777	union
778	{
779	struct
780	{
781	/** Start of page range. Must be PAGE aligned. */
782	RTR3PTR pvR3;
783	/** The range size given as a page count. */
784	uint32_t cPages;
785	} In;
786
787	struct
788	{
789	/** Array of pages. */
790	RTHCPHYS aPages[1];
791	} Out;
792	} u;
793	} SUPPAGELOCK, *PSUPPAGELOCK;
794	/** @} */
795
796
797	/** @name SUP_IOCTL_PAGE_UNLOCK
798	* Unpin physical pages.
799	* @{ */
800	#define SUP_IOCTL_PAGE_UNLOCK SUP_CTL_CODE_SIZE(15, SUP_IOCTL_PAGE_UNLOCK_SIZE)
801	#define SUP_IOCTL_PAGE_UNLOCK_SIZE sizeof(SUPPAGEUNLOCK)
802	#define SUP_IOCTL_PAGE_UNLOCK_SIZE_IN sizeof(SUPPAGEUNLOCK)
803	#define SUP_IOCTL_PAGE_UNLOCK_SIZE_OUT sizeof(SUPREQHDR)
804	typedef struct SUPPAGEUNLOCK
805	{
806	/** The header. */
807	SUPREQHDR Hdr;
808	union
809	{
810	struct
811	{
812	/** Start of page range of a range previously pinned. */
813	RTR3PTR pvR3;
814	} In;
815	} u;
816	} SUPPAGEUNLOCK, *PSUPPAGEUNLOCK;
817	/** @} */
818
819
820	/** @name SUP_IOCTL_CONT_ALLOC
821	* Allocate continuous memory.
822	* @{
823	*/
824	#define SUP_IOCTL_CONT_ALLOC SUP_CTL_CODE_SIZE(16, SUP_IOCTL_CONT_ALLOC_SIZE)
825	#define SUP_IOCTL_CONT_ALLOC_SIZE sizeof(SUPCONTALLOC)
826	#define SUP_IOCTL_CONT_ALLOC_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPCONTALLOC, u.In))
827	#define SUP_IOCTL_CONT_ALLOC_SIZE_OUT sizeof(SUPCONTALLOC)
828	typedef struct SUPCONTALLOC
829	{
830	/** The header. */
831	SUPREQHDR Hdr;
832	union
833	{
834	struct
835	{
836	/** The allocation size given as a page count. */
837	uint32_t cPages;
838	} In;
839
840	struct
841	{
842	/** The address of the ring-0 mapping of the allocated memory. */
843	RTR0PTR pvR0;
844	/** The address of the ring-3 mapping of the allocated memory. */
845	RTR3PTR pvR3;
846	/** The physical address of the allocation. */
847	RTHCPHYS HCPhys;
848	} Out;
849	} u;
850	} SUPCONTALLOC, *PSUPCONTALLOC;
851	/** @} */
852
853
854	/** @name SUP_IOCTL_CONT_FREE Input.
855	* @{
856	*/
857	/** Free continuous memory. */
858	#define SUP_IOCTL_CONT_FREE SUP_CTL_CODE_SIZE(17, SUP_IOCTL_CONT_FREE_SIZE)
859	#define SUP_IOCTL_CONT_FREE_SIZE sizeof(SUPCONTFREE)
860	#define SUP_IOCTL_CONT_FREE_SIZE_IN sizeof(SUPCONTFREE)
861	#define SUP_IOCTL_CONT_FREE_SIZE_OUT sizeof(SUPREQHDR)
862	typedef struct SUPCONTFREE
863	{
864	/** The header. */
865	SUPREQHDR Hdr;
866	union
867	{
868	struct
869	{
870	/** The ring-3 address of the memory to free. */
871	RTR3PTR pvR3;
872	} In;
873	} u;
874	} SUPCONTFREE, *PSUPCONTFREE;
875	/** @} */
876
877
878	/** @name SUP_IOCTL_GET_PAGING_MODE
879	* Get the host paging mode.
880	* @{
881	*/
882	#define SUP_IOCTL_GET_PAGING_MODE SUP_CTL_CODE_SIZE(18, SUP_IOCTL_GET_PAGING_MODE_SIZE)
883	#define SUP_IOCTL_GET_PAGING_MODE_SIZE sizeof(SUPGETPAGINGMODE)
884	#define SUP_IOCTL_GET_PAGING_MODE_SIZE_IN sizeof(SUPREQHDR)
885	#define SUP_IOCTL_GET_PAGING_MODE_SIZE_OUT sizeof(SUPGETPAGINGMODE)
886	typedef struct SUPGETPAGINGMODE
887	{
888	/** The header. */
889	SUPREQHDR Hdr;
890	union
891	{
892	struct
893	{
894	/** The paging mode. */
895	SUPPAGINGMODE enmMode;
896	} Out;
897	} u;
898	} SUPGETPAGINGMODE, *PSUPGETPAGINGMODE;
899	/** @} */
900
901
902	/** @name SUP_IOCTL_SET_VM_FOR_FAST
903	* Set the VM handle for doing fast call ioctl calls.
904	* @{
905	*/
906	#define SUP_IOCTL_SET_VM_FOR_FAST SUP_CTL_CODE_SIZE(19, SUP_IOCTL_SET_VM_FOR_FAST_SIZE)
907	#define SUP_IOCTL_SET_VM_FOR_FAST_SIZE sizeof(SUPSETVMFORFAST)
908	#define SUP_IOCTL_SET_VM_FOR_FAST_SIZE_IN sizeof(SUPSETVMFORFAST)
909	#define SUP_IOCTL_SET_VM_FOR_FAST_SIZE_OUT sizeof(SUPREQHDR)
910	typedef struct SUPSETVMFORFAST
911	{
912	/** The header. */
913	SUPREQHDR Hdr;
914	union
915	{
916	struct
917	{
918	/** The ring-0 VM handle (pointer). */
919	PVMR0 pVMR0;
920	} In;
921	} u;
922	} SUPSETVMFORFAST, *PSUPSETVMFORFAST;
923	/** @} */
924
925
926	/** @name SUP_IOCTL_GIP_MAP
927	* Map the GIP into user space.
928	* @{
929	*/
930	#define SUP_IOCTL_GIP_MAP SUP_CTL_CODE_SIZE(20, SUP_IOCTL_GIP_MAP_SIZE)
931	#define SUP_IOCTL_GIP_MAP_SIZE sizeof(SUPGIPMAP)
932	#define SUP_IOCTL_GIP_MAP_SIZE_IN sizeof(SUPREQHDR)
933	#define SUP_IOCTL_GIP_MAP_SIZE_OUT sizeof(SUPGIPMAP)
934	typedef struct SUPGIPMAP
935	{
936	/** The header. */
937	SUPREQHDR Hdr;
938	union
939	{
940	struct
941	{
942	/** The physical address of the GIP. */
943	RTHCPHYS HCPhysGip;
944	/** Pointer to the read-only usermode GIP mapping for this session. */
945	R3PTRTYPE(PSUPGLOBALINFOPAGE) pGipR3;
946	/** Pointer to the supervisor mode GIP mapping. */
947	R0PTRTYPE(PSUPGLOBALINFOPAGE) pGipR0;
948	} Out;
949	} u;
950	} SUPGIPMAP, *PSUPGIPMAP;
951	/** @} */
952
953
954	/** @name SUP_IOCTL_GIP_UNMAP
955	* Unmap the GIP.
956	* @{
957	*/
958	#define SUP_IOCTL_GIP_UNMAP SUP_CTL_CODE_SIZE(21, SUP_IOCTL_GIP_UNMAP_SIZE)
959	#define SUP_IOCTL_GIP_UNMAP_SIZE sizeof(SUPGIPUNMAP)
960	#define SUP_IOCTL_GIP_UNMAP_SIZE_IN sizeof(SUPGIPUNMAP)
961	#define SUP_IOCTL_GIP_UNMAP_SIZE_OUT sizeof(SUPGIPUNMAP)
962	typedef struct SUPGIPUNMAP
963	{
964	/** The header. */
965	SUPREQHDR Hdr;
966	} SUPGIPUNMAP, *PSUPGIPUNMAP;
967	/** @} */
968
969
970	/** @name SUP_IOCTL_CALL_SERVICE
971	* Call the a ring-0 service.
972	*
973	* @todo Might have to convert this to a big request, just like
974	* SUP_IOCTL_CALL_VMMR0
975	* @{
976	*/
977	#define SUP_IOCTL_CALL_SERVICE(cbReq) SUP_CTL_CODE_SIZE(22, SUP_IOCTL_CALL_SERVICE_SIZE(cbReq))
978	#define SUP_IOCTL_CALL_SERVICE_SIZE(cbReq) RT_UOFFSETOF(SUPCALLSERVICE, abReqPkt[cbReq])
979	#define SUP_IOCTL_CALL_SERVICE_SIZE_IN(cbReq) SUP_IOCTL_CALL_SERVICE_SIZE(cbReq)
980	#define SUP_IOCTL_CALL_SERVICE_SIZE_OUT(cbReq) SUP_IOCTL_CALL_SERVICE_SIZE(cbReq)
981	typedef struct SUPCALLSERVICE
982	{
983	/** The header. */
984	SUPREQHDR Hdr;
985	union
986	{
987	struct
988	{
989	/** The service name. */
990	char szName[28];
991	/** Which operation to execute. */
992	uint32_t uOperation;
993	/** Argument to use when no request packet is supplied. */
994	uint64_t u64Arg;
995	} In;
996	} u;
997	/** The request packet passed to SUP. */
998	uint8_t abReqPkt[1];
999	} SUPCALLSERVICE, *PSUPCALLSERVICE;
1000	/** @} */
1001
1002
1003	/** @name SUP_IOCTL_LOGGER_SETTINGS
1004	* Changes the ring-0 release or debug logger settings.
1005	* @{
1006	*/
1007	#define SUP_IOCTL_LOGGER_SETTINGS(cbStrTab) SUP_CTL_CODE_SIZE(23, SUP_IOCTL_LOGGER_SETTINGS_SIZE(cbStrTab))
1008	#define SUP_IOCTL_LOGGER_SETTINGS_SIZE(cbStrTab) RT_UOFFSETOF(SUPLOGGERSETTINGS, u.In.szStrings[cbStrTab])
1009	#define SUP_IOCTL_LOGGER_SETTINGS_SIZE_IN(cbStrTab) RT_UOFFSETOF(SUPLOGGERSETTINGS, u.In.szStrings[cbStrTab])
1010	#define SUP_IOCTL_LOGGER_SETTINGS_SIZE_OUT sizeof(SUPREQHDR)
1011	typedef struct SUPLOGGERSETTINGS
1012	{
1013	/** The header. */
1014	SUPREQHDR Hdr;
1015	union
1016	{
1017	struct
1018	{
1019	/** Which logger. */
1020	uint32_t fWhich;
1021	/** What to do with it. */
1022	uint32_t fWhat;
1023	/** Offset of the flags setting string. */
1024	uint32_t offFlags;
1025	/** Offset of the groups setting string. */
1026	uint32_t offGroups;
1027	/** Offset of the destination setting string. */
1028	uint32_t offDestination;
1029	/** The string table. */
1030	char szStrings[1];
1031	} In;
1032	} u;
1033	} SUPLOGGERSETTINGS, *PSUPLOGGERSETTINGS;
1034
1035	/** Debug logger. */
1036	#define SUPLOGGERSETTINGS_WHICH_DEBUG 0
1037	/** Release logger. */
1038	#define SUPLOGGERSETTINGS_WHICH_RELEASE 1
1039
1040	/** Change the settings. */
1041	#define SUPLOGGERSETTINGS_WHAT_SETTINGS 0
1042	/** Create the logger instance. */
1043	#define SUPLOGGERSETTINGS_WHAT_CREATE 1
1044	/** Destroy the logger instance. */
1045	#define SUPLOGGERSETTINGS_WHAT_DESTROY 2
1046
1047	/** @} */
1048
1049
1050	/** @name Semaphore Types
1051	* @{ */
1052	#define SUP_SEM_TYPE_EVENT 0
1053	#define SUP_SEM_TYPE_EVENT_MULTI 1
1054	/** @} */
1055
1056
1057	/** @name SUP_IOCTL_SEM_OP2
1058	* Semaphore operations.
1059	* @remarks This replaces the old SUP_IOCTL_SEM_OP interface.
1060	* @{
1061	*/
1062	#define SUP_IOCTL_SEM_OP2 SUP_CTL_CODE_SIZE(24, SUP_IOCTL_SEM_OP2_SIZE)
1063	#define SUP_IOCTL_SEM_OP2_SIZE sizeof(SUPSEMOP2)
1064	#define SUP_IOCTL_SEM_OP2_SIZE_IN sizeof(SUPSEMOP2)
1065	#define SUP_IOCTL_SEM_OP2_SIZE_OUT sizeof(SUPREQHDR)
1066	typedef struct SUPSEMOP2
1067	{
1068	/** The header. */
1069	SUPREQHDR Hdr;
1070	union
1071	{
1072	struct
1073	{
1074	/** The semaphore type. */
1075	uint32_t uType;
1076	/** The semaphore handle. */
1077	uint32_t hSem;
1078	/** The operation. */
1079	uint32_t uOp;
1080	/** Reserved, must be zero. */
1081	uint32_t uReserved;
1082	/** The number of milliseconds to wait if it's a wait operation. */
1083	union
1084	{
1085	/** Absolute timeout (RTTime[System]NanoTS).
1086	* Used by SUPSEMOP2_WAIT_NS_ABS. */
1087	uint64_t uAbsNsTimeout;
1088	/** Relative nanosecond timeout.
1089	* Used by SUPSEMOP2_WAIT_NS_REL. */
1090	uint64_t cRelNsTimeout;
1091	/** Relative millisecond timeout.
1092	* Used by SUPSEMOP2_WAIT_MS_REL. */
1093	uint32_t cRelMsTimeout;
1094	/** Generic 64-bit accessor.
1095	* ASSUMES little endian! */
1096	uint64_t u64;
1097	} uArg;
1098	} In;
1099	} u;
1100	} SUPSEMOP2, *PSUPSEMOP2;
1101
1102	/** Wait for a number of milliseconds. */
1103	#define SUPSEMOP2_WAIT_MS_REL 0
1104	/** Wait until the specified deadline is reached. */
1105	#define SUPSEMOP2_WAIT_NS_ABS 1
1106	/** Wait for a number of nanoseconds. */
1107	#define SUPSEMOP2_WAIT_NS_REL 2
1108	/** Signal the semaphore. */
1109	#define SUPSEMOP2_SIGNAL 3
1110	/** Reset the semaphore (only applicable to SUP_SEM_TYPE_EVENT_MULTI). */
1111	#define SUPSEMOP2_RESET 4
1112	/** Close the semaphore handle. */
1113	#define SUPSEMOP2_CLOSE 5
1114	/** @} */
1115
1116
1117	/** @name SUP_IOCTL_SEM_OP3
1118	* Semaphore operations.
1119	* @{
1120	*/
1121	#define SUP_IOCTL_SEM_OP3 SUP_CTL_CODE_SIZE(25, SUP_IOCTL_SEM_OP3_SIZE)
1122	#define SUP_IOCTL_SEM_OP3_SIZE sizeof(SUPSEMOP3)
1123	#define SUP_IOCTL_SEM_OP3_SIZE_IN sizeof(SUPSEMOP3)
1124	#define SUP_IOCTL_SEM_OP3_SIZE_OUT sizeof(SUPSEMOP3)
1125	typedef struct SUPSEMOP3
1126	{
1127	/** The header. */
1128	SUPREQHDR Hdr;
1129	union
1130	{
1131	struct
1132	{
1133	/** The semaphore type. */
1134	uint32_t uType;
1135	/** The semaphore handle. */
1136	uint32_t hSem;
1137	/** The operation. */
1138	uint32_t uOp;
1139	/** Reserved, must be zero. */
1140	uint32_t u32Reserved;
1141	/** Reserved for future use. */
1142	uint64_t u64Reserved;
1143	} In;
1144	union
1145	{
1146	/** The handle of the created semaphore.
1147	* Used by SUPSEMOP3_CREATE. */
1148	uint32_t hSem;
1149	/** The semaphore resolution in nano seconds.
1150	* Used by SUPSEMOP3_GET_RESOLUTION. */
1151	uint32_t cNsResolution;
1152	/** The 32-bit view. */
1153	uint32_t u32;
1154	/** Reserved some space for later expansion. */
1155	uint64_t u64Reserved;
1156	} Out;
1157	} u;
1158	} SUPSEMOP3, *PSUPSEMOP3;
1159
1160	/** Get the wait resolution. */
1161	#define SUPSEMOP3_CREATE 0
1162	/** Get the wait resolution. */
1163	#define SUPSEMOP3_GET_RESOLUTION 1
1164	/** @} */
1165
1166
1167	/** @name SUP_IOCTL_VT_CAPS
1168	* Get the VT-x/AMD-V capabilities.
1169	*
1170	* @todo Intended for main, which means we need to relax the privilege requires
1171	* when accessing certain vboxdrv functions.
1172	*
1173	* @{
1174	*/
1175	#define SUP_IOCTL_VT_CAPS SUP_CTL_CODE_SIZE(26, SUP_IOCTL_VT_CAPS_SIZE)
1176	#define SUP_IOCTL_VT_CAPS_SIZE sizeof(SUPVTCAPS)
1177	#define SUP_IOCTL_VT_CAPS_SIZE_IN sizeof(SUPREQHDR)
1178	#define SUP_IOCTL_VT_CAPS_SIZE_OUT sizeof(SUPVTCAPS)
1179	typedef struct SUPVTCAPS
1180	{
1181	/** The header. */
1182	SUPREQHDR Hdr;
1183	union
1184	{
1185	struct
1186	{
1187	/** The VT capability dword. */
1188	uint32_t Caps;
1189	} Out;
1190	} u;
1191	} SUPVTCAPS, *PSUPVTCAPS;
1192	/** @} */
1193
1194
1195	/** @name SUP_IOCTL_TRACER_OPEN
1196	* Open the tracer.
1197	*
1198	* Should be matched by an SUP_IOCTL_TRACER_CLOSE call.
1199	*
1200	* @{
1201	*/
1202	#define SUP_IOCTL_TRACER_OPEN SUP_CTL_CODE_SIZE(28, SUP_IOCTL_TRACER_OPEN_SIZE)
1203	#define SUP_IOCTL_TRACER_OPEN_SIZE sizeof(SUPTRACEROPEN)
1204	#define SUP_IOCTL_TRACER_OPEN_SIZE_IN sizeof(SUPTRACEROPEN)
1205	#define SUP_IOCTL_TRACER_OPEN_SIZE_OUT sizeof(SUPREQHDR)
1206	typedef struct SUPTRACEROPEN
1207	{
1208	/** The header. */
1209	SUPREQHDR Hdr;
1210	union
1211	{
1212	struct
1213	{
1214	/** Tracer cookie. Used to make sure we only open a matching tracer. */
1215	uint32_t uCookie;
1216	/** Tracer specific argument. */
1217	RTHCUINTPTR uArg;
1218	} In;
1219	} u;
1220	} SUPTRACEROPEN, *PSUPTRACEROPEN;
1221	/** @} */
1222
1223
1224	/** @name SUP_IOCTL_TRACER_CLOSE
1225	* Close the tracer.
1226	*
1227	* Must match a SUP_IOCTL_TRACER_OPEN call.
1228	*
1229	* @{
1230	*/
1231	#define SUP_IOCTL_TRACER_CLOSE SUP_CTL_CODE_SIZE(29, SUP_IOCTL_TRACER_CLOSE_SIZE)
1232	#define SUP_IOCTL_TRACER_CLOSE_SIZE sizeof(SUPREQHDR)
1233	#define SUP_IOCTL_TRACER_CLOSE_SIZE_IN sizeof(SUPREQHDR)
1234	#define SUP_IOCTL_TRACER_CLOSE_SIZE_OUT sizeof(SUPREQHDR)
1235	/** @} */
1236
1237
1238	/** @name SUP_IOCTL_TRACER_IOCTL
1239	* Speak UNIX ioctl() with the tracer.
1240	*
1241	* The session must have opened the tracer prior to issuing this request.
1242	*
1243	* @{
1244	*/
1245	#define SUP_IOCTL_TRACER_IOCTL SUP_CTL_CODE_SIZE(30, SUP_IOCTL_TRACER_IOCTL_SIZE)
1246	#define SUP_IOCTL_TRACER_IOCTL_SIZE sizeof(SUPTRACERIOCTL)
1247	#define SUP_IOCTL_TRACER_IOCTL_SIZE_IN sizeof(SUPTRACERIOCTL)
1248	#define SUP_IOCTL_TRACER_IOCTL_SIZE_OUT (RT_UOFFSETOF(SUPTRACERIOCTL, u.Out.iRetVal) + sizeof(int32_t))
1249	typedef struct SUPTRACERIOCTL
1250	{
1251	/** The header. */
1252	SUPREQHDR Hdr;
1253	union
1254	{
1255	struct
1256	{
1257	/** The command. */
1258	RTHCUINTPTR uCmd;
1259	/** Argument to the command. */
1260	RTHCUINTPTR uArg;
1261	} In;
1262
1263	struct
1264	{
1265	/** The return value. */
1266	int32_t iRetVal;
1267	} Out;
1268	} u;
1269	} SUPTRACERIOCTL, *PSUPTRACERIOCTL;
1270	/** @} */
1271
1272
1273	/** @name SUP_IOCTL_TRACER_UMOD_REG
1274	* Registers tracepoints in a user mode module.
1275	*
1276	* @{
1277	*/
1278	#define SUP_IOCTL_TRACER_UMOD_REG SUP_CTL_CODE_SIZE(31, SUP_IOCTL_TRACER_UMOD_REG_SIZE)
1279	#define SUP_IOCTL_TRACER_UMOD_REG_SIZE sizeof(SUPTRACERUMODREG)
1280	#define SUP_IOCTL_TRACER_UMOD_REG_SIZE_IN sizeof(SUPTRACERUMODREG)
1281	#define SUP_IOCTL_TRACER_UMOD_REG_SIZE_OUT sizeof(SUPREQHDR)
1282	typedef struct SUPTRACERUMODREG
1283	{
1284	/** The header. */
1285	SUPREQHDR Hdr;
1286	union
1287	{
1288	struct
1289	{
1290	/** The address at which the VTG header actually resides.
1291	* This will differ from R3PtrVtgHdr for raw-mode context
1292	* modules. */
1293	RTUINTPTR uVtgHdrAddr;
1294	/** The ring-3 pointer of the VTG header. */
1295	RTR3PTR R3PtrVtgHdr;
1296	/** The ring-3 pointer of the probe location string table. */
1297	RTR3PTR R3PtrStrTab;
1298	/** The size of the string table. */
1299	uint32_t cbStrTab;
1300	/** Future flags, MBZ. */
1301	uint32_t fFlags;
1302	/** The module name. */
1303	char szName[64];
1304	} In;
1305	} u;
1306	} SUPTRACERUMODREG, *PSUPTRACERUMODREG;
1307	/** @} */
1308
1309
1310	/** @name SUP_IOCTL_TRACER_UMOD_DEREG
1311	* Deregisters tracepoints in a user mode module.
1312	*
1313	* @{
1314	*/
1315	#define SUP_IOCTL_TRACER_UMOD_DEREG SUP_CTL_CODE_SIZE(32, SUP_IOCTL_TRACER_UMOD_DEREG_SIZE)
1316	#define SUP_IOCTL_TRACER_UMOD_DEREG_SIZE sizeof(SUPTRACERUMODDEREG)
1317	#define SUP_IOCTL_TRACER_UMOD_DEREG_SIZE_IN sizeof(SUPTRACERUMODDEREG)
1318	#define SUP_IOCTL_TRACER_UMOD_DEREG_SIZE_OUT sizeof(SUPREQHDR)
1319	typedef struct SUPTRACERUMODDEREG
1320	{
1321	/** The header. */
1322	SUPREQHDR Hdr;
1323	union
1324	{
1325	struct
1326	{
1327	/** Pointer to the VTG header. */
1328	RTR3PTR pVtgHdr;
1329	} In;
1330	} u;
1331	} SUPTRACERUMODDEREG, *PSUPTRACERUMODDEREG;
1332	/** @} */
1333
1334
1335	/** @name SUP_IOCTL_TRACER_UMOD_FIRE_PROBE
1336	* Fire a probe in a user tracepoint module.
1337	*
1338	* @{
1339	*/
1340	#define SUP_IOCTL_TRACER_UMOD_FIRE_PROBE SUP_CTL_CODE_SIZE(33, SUP_IOCTL_TRACER_UMOD_FIRE_PROBE_SIZE)
1341	#define SUP_IOCTL_TRACER_UMOD_FIRE_PROBE_SIZE sizeof(SUPTRACERUMODFIREPROBE)
1342	#define SUP_IOCTL_TRACER_UMOD_FIRE_PROBE_SIZE_IN sizeof(SUPTRACERUMODFIREPROBE)
1343	#define SUP_IOCTL_TRACER_UMOD_FIRE_PROBE_SIZE_OUT sizeof(SUPREQHDR)
1344	typedef struct SUPTRACERUMODFIREPROBE
1345	{
1346	/** The header. */
1347	SUPREQHDR Hdr;
1348	union
1349	{
1350	SUPDRVTRACERUSRCTX In;
1351	} u;
1352	} SUPTRACERUMODFIREPROBE, *PSUPTRACERUMODFIREPROBE;
1353	/** @} */
1354
1355
1356	/** @name SUP_IOCTL_MSR_PROBER
1357	* MSR probing interface, not available in normal builds.
1358	*
1359	* @{
1360	*/
1361	#define SUP_IOCTL_MSR_PROBER SUP_CTL_CODE_SIZE(34, SUP_IOCTL_MSR_PROBER_SIZE)
1362	#define SUP_IOCTL_MSR_PROBER_SIZE sizeof(SUPMSRPROBER)
1363	#define SUP_IOCTL_MSR_PROBER_SIZE_IN sizeof(SUPMSRPROBER)
1364	#define SUP_IOCTL_MSR_PROBER_SIZE_OUT sizeof(SUPMSRPROBER)
1365
1366	typedef enum SUPMSRPROBEROP
1367	{
1368	SUPMSRPROBEROP_INVALID = 0, /*< The customary invalid zero value. /
1369	SUPMSRPROBEROP_READ, /*< Read an MSR. /
1370	SUPMSRPROBEROP_WRITE, /*< Write a value to an MSR (use with care!). /
1371	SUPMSRPROBEROP_MODIFY, /*< Read-modify-restore-flushall. /
1372	SUPMSRPROBEROP_MODIFY_FASTER, /*< Read-modify-restore, skip the flushing. /
1373	SUPMSRPROBEROP_END, /*< End of valid values. /
1374	SUPMSRPROBEROP_32BIT_HACK = 0x7fffffff /*< The customary 32-bit type hack. /
1375	} SUPMSRPROBEROP;
1376
1377	typedef struct SUPMSRPROBER
1378	{
1379	/** The header. */
1380	SUPREQHDR Hdr;
1381
1382	/** Input/output union. */
1383	union
1384	{
1385	/** Inputs. */
1386	struct
1387	{
1388	/** The operation. */
1389	SUPMSRPROBEROP enmOp;
1390	/** The MSR to test. */
1391	uint32_t uMsr;
1392	/** The CPU to perform the operation on.
1393	* Use UINT32_MAX to indicate that any CPU will do. */
1394	uint32_t idCpu;
1395	/** Alignment padding. */
1396	uint32_t u32Padding;
1397	/** Operation specific arguments. */
1398	union
1399	{
1400	/* SUPMSRPROBEROP_READ takes no extra arguments. */
1401
1402	/** For SUPMSRPROBEROP_WRITE. */
1403	struct
1404	{
1405	/** The value to write. */
1406	uint64_t uToWrite;
1407	} Write;
1408
1409	/** For SUPMSRPROBEROP_MODIFY and SUPMSRPROBEROP_MODIFY_FASTER. */
1410	struct
1411	{
1412	/** The value to AND the current MSR value with to construct the value to
1413	* write. This applied first. */
1414	uint64_t fAndMask;
1415	/** The value to OR the result of the above mentioned AND operation with
1416	* attempting to modify the MSR. */
1417	uint64_t fOrMask;
1418	} Modify;
1419
1420	/** Reserve space for the future.. */
1421	uint64_t auPadding[3];
1422	} uArgs;
1423	} In;
1424
1425	/** Outputs. */
1426	struct
1427	{
1428	/** Operation specific results. */
1429	union
1430	{
1431	/** For SUPMSRPROBEROP_READ. */
1432	struct
1433	{
1434	/** The value we've read. */
1435	uint64_t uValue;
1436	/** Set if we GPed while reading it. */
1437	bool fGp;
1438	} Read;
1439
1440	/** For SUPMSRPROBEROP_WRITE. */
1441	struct
1442	{
1443	/** Set if we GPed while writing it. */
1444	bool fGp;
1445	} Write;
1446
1447	/** For SUPMSRPROBEROP_MODIFY and SUPMSRPROBEROP_MODIFY_FASTER. */
1448	SUPMSRPROBERMODIFYRESULT Modify;
1449
1450	/** Size padding/aligning. */
1451	uint64_t auPadding[5];
1452	} uResults;
1453	} Out;
1454	} u;
1455	} SUPMSRPROBER, *PSUPMSRPROBER;
1456	AssertCompileMemberAlignment(SUPMSRPROBER, u, 8);
1457	AssertCompileMemberAlignment(SUPMSRPROBER, u.In.uArgs, 8);
1458	AssertCompileMembersSameSizeAndOffset(SUPMSRPROBER, u.In, SUPMSRPROBER, u.Out);
1459	/** @} */
1460
1461	/** @name SUP_IOCTL_RESUME_SUSPENDED_KBDS
1462	* Resume suspended keyboard devices if any found in the system.
1463	*
1464	* @{
1465	*/
1466	#define SUP_IOCTL_RESUME_SUSPENDED_KBDS SUP_CTL_CODE_SIZE(35, SUP_IOCTL_RESUME_SUSPENDED_KBDS_SIZE)
1467	#define SUP_IOCTL_RESUME_SUSPENDED_KBDS_SIZE sizeof(SUPREQHDR)
1468	#define SUP_IOCTL_RESUME_SUSPENDED_KBDS_SIZE_IN sizeof(SUPREQHDR)
1469	#define SUP_IOCTL_RESUME_SUSPENDED_KBDS_SIZE_OUT sizeof(SUPREQHDR)
1470	/** @} */
1471
1472
1473	/** @name SUP_IOCTL_TSC_DELTA_MEASURE
1474	* Measure the TSC-delta between the specified CPU and the master TSC.
1475	*
1476	* @{
1477	*/
1478	#define SUP_IOCTL_TSC_DELTA_MEASURE SUP_CTL_CODE_SIZE(36, SUP_IOCTL_TSC_DELTA_MEASURE_SIZE)
1479	#define SUP_IOCTL_TSC_DELTA_MEASURE_SIZE sizeof(SUPTSCDELTAMEASURE)
1480	#define SUP_IOCTL_TSC_DELTA_MEASURE_SIZE_IN sizeof(SUPTSCDELTAMEASURE)
1481	#define SUP_IOCTL_TSC_DELTA_MEASURE_SIZE_OUT sizeof(SUPREQHDR)
1482	typedef struct SUPTSCDELTAMEASURE
1483	{
1484	/** The header. */
1485	SUPREQHDR Hdr;
1486
1487	/** Input/output union. */
1488	union
1489	{
1490	struct
1491	{
1492	/** Which CPU to take the TSC-delta measurement for. */
1493	RTCPUID idCpu;
1494	/** Number of times to retry on failure (specify 0 for default). */
1495	uint8_t cRetries;
1496	/** Number of milliseconds to wait before each retry. */
1497	uint8_t cMsWaitRetry;
1498	/** Whether to force taking a measurement if one exists already. */
1499	bool fForce;
1500	/** Whether to do the measurement asynchronously (if possible). */
1501	bool fAsync;
1502	/** Padding for future. */
1503	uint64_t auPadding[3];
1504	} In;
1505	} u;
1506	} SUPTSCDELTAMEASURE, *PSUPTSCDELTAMEASURE;
1507	AssertCompileMemberAlignment(SUPTSCDELTAMEASURE, u, 8);
1508	/** @} */
1509
1510	/** @name SUP_IOCTL_TSC_READ
1511	* Reads the TSC and TSC-delta atomically and returns the delta-adjusted TSC
1512	* value.
1513	*
1514	* @{
1515	*/
1516	#define SUP_IOCTL_TSC_READ SUP_CTL_CODE_SIZE(37, SUP_IOCTL_TSC_READ_SIZE)
1517	#define SUP_IOCTL_TSC_READ_SIZE sizeof(SUPTSCREAD)
1518	#define SUP_IOCTL_TSC_READ_SIZE_IN sizeof(SUPTSCREAD)
1519	#define SUP_IOCTL_TSC_READ_SIZE_OUT sizeof(SUPREQHDR)
1520	typedef struct SUPTSCREAD
1521	{
1522	/** The header. */
1523	SUPREQHDR Hdr;
1524
1525	/** Input/output union. */
1526	union
1527	{
1528	struct
1529	{
1530	/** The TSC after applying the relevant delta. */
1531	uint64_t u64AdjustedTsc;
1532	/** The APIC Id of the CPU where the TSC was read. */
1533	uint16_t idApic;
1534	/** Padding for future. */
1535	uint64_t auPadding[3];
1536	} Out;
1537	} u;
1538	} SUPTSCREAD, *PSUPTSCREAD;
1539	AssertCompileMemberAlignment(SUPTSCREAD, u, 8);
1540	/** @} */
1541
1542	#pragma pack() /* paranoia */
1543
1544	#endif
1545

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/HostDrivers/Support/SUPDrvIOC.h@ 53396

Download in other formats: