VirtualBox

source: vbox/trunk/src/VBox/HostDrivers/Support/SUPDRVIOC.h@ 9380

Last change on this file since 9380 was 8890, checked in by vboxsync, 17 years ago

SUPDRVIOC_VERSION += 1 because of new vboxdrv export (RTMpCpuId()).
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 27.6 KB
Line 
1/* $Revision: 8890 $ */
2/** @file
3 * VirtualBox Support Driver - IOCtl definitions.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
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 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
27 * Clara, CA 95054 USA or visit http://www.sun.com if you need
28 * additional information or have any questions.
29 */
30
31#ifndef ___SUPDRVIOC_h___
32#define ___SUPDRVIOC_h___
33
34/*
35 * Basic types.
36 */
37#include <iprt/stdint.h>
38
39/*
40 * IOCtl numbers.
41 * We're using the Win32 type of numbers here, thus the macros below.
42 * The SUP_IOCTL_FLAG macro is used to separate requests from 32-bit
43 * and 64-bit processes.
44 */
45#ifdef RT_ARCH_AMD64
46# define SUP_IOCTL_FLAG 128
47#elif defined(RT_ARCH_X86)
48# define SUP_IOCTL_FLAG 0
49#else
50# error "dunno which arch this is!"
51#endif
52
53#ifdef RT_OS_WINDOWS
54# ifndef CTL_CODE
55# include <Windows.h>
56# endif
57 /* Automatic buffering, size not encoded. */
58# define SUP_CTL_CODE_SIZE(Function, Size) CTL_CODE(FILE_DEVICE_UNKNOWN, (Function) | SUP_IOCTL_FLAG, METHOD_BUFFERED, FILE_WRITE_ACCESS)
59# define SUP_CTL_CODE_BIG(Function) CTL_CODE(FILE_DEVICE_UNKNOWN, (Function) | SUP_IOCTL_FLAG, METHOD_BUFFERED, FILE_WRITE_ACCESS)
60# define SUP_CTL_CODE_FAST(Function) CTL_CODE(FILE_DEVICE_UNKNOWN, (Function) | SUP_IOCTL_FLAG, METHOD_NEITHER, FILE_WRITE_ACCESS)
61# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
62
63#elif defined(RT_OS_SOLARIS)
64 /* No automatic buffering, size limited to 255 bytes. */
65# include <sys/ioccom.h>
66# define SUP_CTL_CODE_SIZE(Function, Size) _IOWRN('V', (Function) | SUP_IOCTL_FLAG, sizeof(SUPREQHDR))
67# define SUP_CTL_CODE_BIG(Function) _IOWRN('V', (Function) | SUP_IOCTL_FLAG, sizeof(SUPREQHDR))
68# define SUP_CTL_CODE_FAST(Function) _IO( 'V', (Function) | SUP_IOCTL_FLAG)
69# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
70
71#elif defined(RT_OS_OS2)
72 /* No automatic buffering, size not encoded. */
73# define SUP_CTL_CATEGORY 0xc0
74# define SUP_CTL_CODE_SIZE(Function, Size) ((unsigned char)(Function))
75# define SUP_CTL_CODE_BIG(Function) ((unsigned char)(Function))
76# define SUP_CTL_CATEGORY_FAST 0xc1
77# define SUP_CTL_CODE_FAST(Function) ((unsigned char)(Function))
78# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
79
80#elif defined(RT_OS_LINUX)
81 /* No automatic buffering, size limited to 16KB. */
82# include <linux/ioctl.h>
83# define SUP_CTL_CODE_SIZE(Function, Size) _IOC(_IOC_READ | _IOC_WRITE, 'V', (Function) | SUP_IOCTL_FLAG, (Size))
84# define SUP_CTL_CODE_BIG(Function) _IO('V', (Function) | SUP_IOCTL_FLAG)
85# define SUP_CTL_CODE_FAST(Function) _IO('V', (Function) | SUP_IOCTL_FLAG)
86# define SUP_CTL_CODE_NO_SIZE(uIOCtl) ((uIOCtl) & ~IOCSIZE_MASK)
87
88#elif defined(RT_OS_L4)
89 /* Implemented in suplib, no worries. */
90# define SUP_CTL_CODE_SIZE(Function, Size) (Function)
91# define SUP_CTL_CODE_BIG(Function) (Function)
92# define SUP_CTL_CODE_FAST(Function) (Function)
93# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
94
95#else /* BSD Like */
96 /* Automatic buffering, size limited to 4KB on *BSD and 8KB on Darwin - commands the limit, 4KB. */
97# include <sys/ioccom.h>
98# define SUP_CTL_CODE_SIZE(Function, Size) _IOC(IOC_INOUT, 'V', (Function) | SUP_IOCTL_FLAG, (Size))
99# define SUP_CTL_CODE_BIG(Function) _IO('V', (Function) | SUP_IOCTL_FLAG)
100# define SUP_CTL_CODE_FAST(Function) _IO('V', (Function) | SUP_IOCTL_FLAG)
101# define SUP_CTL_CODE_NO_SIZE(uIOCtl) ( (uIOCtl) & ~_IOC(0,0,0,IOCPARM_MASK) )
102#endif
103
104/** Fast path IOCtl: VMMR0_DO_RAW_RUN */
105#define SUP_IOCTL_FAST_DO_RAW_RUN SUP_CTL_CODE_FAST(64)
106/** Fast path IOCtl: VMMR0_DO_HWACC_RUN */
107#define SUP_IOCTL_FAST_DO_HWACC_RUN SUP_CTL_CODE_FAST(65)
108/** Just a NOP call for profiling the latency of a fast ioctl call to VMMR0. */
109#define SUP_IOCTL_FAST_DO_NOP SUP_CTL_CODE_FAST(66)
110
111
112
113/*******************************************************************************
114* Structures and Typedefs *
115*******************************************************************************/
116#ifdef RT_ARCH_AMD64
117# pragma pack(8) /* paranoia. */
118#else
119# pragma pack(4) /* paranoia. */
120#endif
121
122
123/**
124 * Common In/Out header.
125 */
126typedef struct SUPREQHDR
127{
128 /** Cookie. */
129 uint32_t u32Cookie;
130 /** Session cookie. */
131 uint32_t u32SessionCookie;
132 /** The size of the input. */
133 uint32_t cbIn;
134 /** The size of the output. */
135 uint32_t cbOut;
136 /** Flags. See SUPREQHDR_FLAGS_* for details and values. */
137 uint32_t fFlags;
138 /** The VBox status code of the operation, out direction only. */
139 int32_t rc;
140} SUPREQHDR;
141/** Pointer to a IOC header. */
142typedef SUPREQHDR *PSUPREQHDR;
143
144/** @name SUPREQHDR::fFlags values
145 * @{ */
146/** Masks out the magic value. */
147#define SUPREQHDR_FLAGS_MAGIC_MASK UINT32_C(0xff0000ff)
148/** The generic mask. */
149#define SUPREQHDR_FLAGS_GEN_MASK UINT32_C(0x0000ff00)
150/** The request specific mask. */
151#define SUPREQHDR_FLAGS_REQ_MASK UINT32_C(0x00ff0000)
152
153/** There is extra input that needs copying on some platforms. */
154#define SUPREQHDR_FLAGS_EXTRA_IN UINT32_C(0x00000100)
155/** There is extra output that needs copying on some platforms. */
156#define SUPREQHDR_FLAGS_EXTRA_OUT UINT32_C(0x00000200)
157
158/** The magic value. */
159#define SUPREQHDR_FLAGS_MAGIC UINT32_C(0x42000042)
160/** The default value. Use this when no special stuff is requested. */
161#define SUPREQHDR_FLAGS_DEFAULT SUPREQHDR_FLAGS_MAGIC
162/** @} */
163
164
165/** @name SUP_IOCTL_COOKIE
166 * @{
167 */
168/** Negotiate cookie. */
169#define SUP_IOCTL_COOKIE SUP_CTL_CODE_SIZE(1, SUP_IOCTL_COOKIE_SIZE)
170/** The request size. */
171#define SUP_IOCTL_COOKIE_SIZE sizeof(SUPCOOKIE)
172/** The SUPREQHDR::cbIn value. */
173#define SUP_IOCTL_COOKIE_SIZE_IN sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPCOOKIE, u.In)
174/** The SUPREQHDR::cbOut value. */
175#define SUP_IOCTL_COOKIE_SIZE_OUT sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPCOOKIE, u.Out)
176/** SUPCOOKIE_IN magic word. */
177#define SUPCOOKIE_MAGIC "The Magic Word!"
178/** The initial cookie. */
179#define SUPCOOKIE_INITIAL_COOKIE 0x69726f74 /* 'tori' */
180
181/** Current interface version.
182 * The upper 16-bit is the major version, the the lower the minor version.
183 * When incompatible changes are made, the upper major number has to be changed. */
184#define SUPDRVIOC_VERSION 0x00070002
185
186/** SUP_IOCTL_COOKIE. */
187typedef struct SUPCOOKIE
188{
189 /** The header.
190 * u32Cookie must be set to SUPCOOKIE_INITIAL_COOKIE.
191 * u32SessionCookie should be set to some random value. */
192 SUPREQHDR Hdr;
193 union
194 {
195 struct
196 {
197 /** Magic word. */
198 char szMagic[16];
199 /** The requested interface version number. */
200 uint32_t u32ReqVersion;
201 /** The minimum interface version number. */
202 uint32_t u32MinVersion;
203 } In;
204 struct
205 {
206 /** Cookie. */
207 uint32_t u32Cookie;
208 /** Session cookie. */
209 uint32_t u32SessionCookie;
210 /** Interface version for this session. */
211 uint32_t u32SessionVersion;
212 /** The actual interface version in the driver. */
213 uint32_t u32DriverVersion;
214 /** Number of functions available for the SUP_IOCTL_QUERY_FUNCS request. */
215 uint32_t cFunctions;
216 /** Session handle. */
217 R0PTRTYPE(PSUPDRVSESSION) pSession;
218 } Out;
219 } u;
220} SUPCOOKIE, *PSUPCOOKIE;
221/** @} */
222
223
224/** @name SUP_IOCTL_QUERY_FUNCS
225 * Query SUPR0 functions.
226 * @{
227 */
228#define SUP_IOCTL_QUERY_FUNCS(cFuncs) SUP_CTL_CODE_SIZE(2, SUP_IOCTL_QUERY_FUNCS_SIZE(cFuncs))
229#define SUP_IOCTL_QUERY_FUNCS_SIZE(cFuncs) RT_OFFSETOF(SUPQUERYFUNCS, u.Out.aFunctions[(cFuncs)])
230#define SUP_IOCTL_QUERY_FUNCS_SIZE_IN sizeof(SUPREQHDR)
231#define SUP_IOCTL_QUERY_FUNCS_SIZE_OUT(cFuncs) SUP_IOCTL_QUERY_FUNCS_SIZE(cFuncs)
232
233/** A function. */
234typedef struct SUPFUNC
235{
236 /** Name - mangled. */
237 char szName[32];
238 /** Address. */
239 RTR0PTR pfn;
240} SUPFUNC, *PSUPFUNC;
241
242typedef struct SUPQUERYFUNCS
243{
244 /** The header. */
245 SUPREQHDR Hdr;
246 union
247 {
248 struct
249 {
250 /** Number of functions returned. */
251 uint32_t cFunctions;
252 /** Array of functions. */
253 SUPFUNC aFunctions[1];
254 } Out;
255 } u;
256} SUPQUERYFUNCS, *PSUPQUERYFUNCS;
257/** @} */
258
259
260/** @name SUP_IOCTL_IDT_INSTALL
261 * Install IDT patch for calling processor.
262 * @{
263 */
264#define SUP_IOCTL_IDT_INSTALL SUP_CTL_CODE_SIZE(3, SUP_IOCTL_IDT_INSTALL_SIZE)
265#define SUP_IOCTL_IDT_INSTALL_SIZE sizeof(SUPIDTINSTALL)
266#define SUP_IOCTL_IDT_INSTALL_SIZE_IN sizeof(SUPREQHDR)
267#define SUP_IOCTL_IDT_INSTALL_SIZE_OUT sizeof(SUPIDTINSTALL)
268typedef struct SUPIDTINSTALL
269{
270 /** The header. */
271 SUPREQHDR Hdr;
272 union
273 {
274 struct
275 {
276 /** The IDT entry number. */
277 uint8_t u8Idt;
278 } Out;
279 } u;
280} SUPIDTINSTALL, *PSUPIDTINSTALL;
281/** @} */
282
283
284/** @name SUP_IOCTL_IDT_REMOVE
285 * Remove IDT patch for calling processor.
286 * @{
287 */
288#define SUP_IOCTL_IDT_REMOVE SUP_CTL_CODE_SIZE(4, SUP_IOCTL_IDT_REMOVE_SIZE)
289#define SUP_IOCTL_IDT_REMOVE_SIZE sizeof(SUPIDTREMOVE)
290#define SUP_IOCTL_IDT_REMOVE_SIZE_IN sizeof(SUPIDTREMOVE)
291#define SUP_IOCTL_IDT_REMOVE_SIZE_OUT sizeof(SUPIDTREMOVE)
292typedef struct SUPIDTREMOVE
293{
294 /** The header. */
295 SUPREQHDR Hdr;
296} SUPIDTREMOVE, *PSUPIDTREMOVE;
297/** @}*/
298
299
300/** @name SUP_IOCTL_LDR_OPEN
301 * Open an image.
302 * @{
303 */
304#define SUP_IOCTL_LDR_OPEN SUP_CTL_CODE_SIZE(5, SUP_IOCTL_LDR_OPEN_SIZE)
305#define SUP_IOCTL_LDR_OPEN_SIZE sizeof(SUPLDROPEN)
306#define SUP_IOCTL_LDR_OPEN_SIZE_IN sizeof(SUPLDROPEN)
307#define SUP_IOCTL_LDR_OPEN_SIZE_OUT (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPLDROPEN, u.Out))
308typedef struct SUPLDROPEN
309{
310 /** The header. */
311 SUPREQHDR Hdr;
312 union
313 {
314 struct
315 {
316 /** Size of the image we'll be loading. */
317 uint32_t cbImage;
318 /** Image name.
319 * This is the NAME of the image, not the file name. It is used
320 * to share code with other processes. (Max len is 32 chars!) */
321 char szName[32];
322 } In;
323 struct
324 {
325 /** The base address of the image. */
326 RTR0PTR pvImageBase;
327 /** Indicate whether or not the image requires loading. */
328 bool fNeedsLoading;
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(6)
340#define SUP_IOCTL_LDR_LOAD_SIZE(cbImage) RT_OFFSETOF(SUPLDRLOAD, u.In.achImage[cbImage])
341#define SUP_IOCTL_LDR_LOAD_SIZE_IN(cbImage) RT_OFFSETOF(SUPLDRLOAD, u.In.achImage[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 */
351typedef DECLCALLBACK(int) FNR0MODULEINIT(void);
352/** Pointer to a FNR0MODULEINIT(). */
353typedef R0PTRTYPE(FNR0MODULEINIT *) PFNR0MODULEINIT;
354
355/**
356 * Module termination callback function.
357 * This is called once right before the module is being unloaded.
358 */
359typedef DECLCALLBACK(void) FNR0MODULETERM(void);
360/** Pointer to a FNR0MODULETERM(). */
361typedef R0PTRTYPE(FNR0MODULETERM *) PFNR0MODULETERM;
362
363/**
364 * Symbol table entry.
365 */
366typedef struct SUPLDRSYM
367{
368 /** Offset into of the string table. */
369 uint32_t offName;
370 /** Offset of the symbol relative to the image load address. */
371 uint32_t offSymbol;
372} SUPLDRSYM, *PSUPLDRSYM;
373
374/**
375 * SUPLDRLOAD::u::In::EP type.
376 */
377typedef enum SUPLDRLOADEP
378{
379 SUPLDRLOADEP_NOTHING = 0,
380 SUPLDRLOADEP_VMMR0,
381 SUPLDRLOADEP_32BIT_HACK = 0x7fffffff
382} SUPLDRLOADEP;
383
384typedef struct SUPLDRLOAD
385{
386 /** The header. */
387 SUPREQHDR Hdr;
388 union
389 {
390 struct
391 {
392 /** The address of module initialization function. Similar to _DLL_InitTerm(hmod, 0). */
393 PFNR0MODULEINIT pfnModuleInit;
394 /** The address of module termination function. Similar to _DLL_InitTerm(hmod, 1). */
395 PFNR0MODULETERM pfnModuleTerm;
396 /** Special entry points. */
397 union
398 {
399 struct
400 {
401 /** The module handle (i.e. address). */
402 RTR0PTR pvVMMR0;
403 /** Address of VMMR0EntryInt function. */
404 RTR0PTR pvVMMR0EntryInt;
405 /** Address of VMMR0EntryFast function. */
406 RTR0PTR pvVMMR0EntryFast;
407 /** Address of VMMR0EntryEx function. */
408 RTR0PTR pvVMMR0EntryEx;
409 } VMMR0;
410 } EP;
411 /** Address. */
412 RTR0PTR pvImageBase;
413 /** Entry point type. */
414 SUPLDRLOADEP eEPType;
415 /** The offset of the symbol table. */
416 uint32_t offSymbols;
417 /** The number of entries in the symbol table. */
418 uint32_t cSymbols;
419 /** The offset of the string table. */
420 uint32_t offStrTab;
421 /** Size of the string table. */
422 uint32_t cbStrTab;
423 /** Size of image (including string and symbol tables). */
424 uint32_t cbImage;
425 /** The image data. */
426 char achImage[1];
427 } In;
428 } u;
429} SUPLDRLOAD, *PSUPLDRLOAD;
430/** @} */
431
432
433/** @name SUP_IOCTL_LDR_FREE
434 * Free an image.
435 * @{
436 */
437#define SUP_IOCTL_LDR_FREE SUP_CTL_CODE_SIZE(7, SUP_IOCTL_LDR_FREE_SIZE)
438#define SUP_IOCTL_LDR_FREE_SIZE sizeof(SUPLDRFREE)
439#define SUP_IOCTL_LDR_FREE_SIZE_IN sizeof(SUPLDRFREE)
440#define SUP_IOCTL_LDR_FREE_SIZE_OUT sizeof(SUPREQHDR)
441typedef struct SUPLDRFREE
442{
443 /** The header. */
444 SUPREQHDR Hdr;
445 union
446 {
447 struct
448 {
449 /** Address. */
450 RTR0PTR pvImageBase;
451 } In;
452 } u;
453} SUPLDRFREE, *PSUPLDRFREE;
454/** @} */
455
456
457/** @name SUP_IOCTL_LDR_GET_SYMBOL
458 * Get address of a symbol within an image.
459 * @{
460 */
461#define SUP_IOCTL_LDR_GET_SYMBOL SUP_CTL_CODE_SIZE(8, SUP_IOCTL_LDR_GET_SYMBOL_SIZE)
462#define SUP_IOCTL_LDR_GET_SYMBOL_SIZE sizeof(SUPLDRGETSYMBOL)
463#define SUP_IOCTL_LDR_GET_SYMBOL_SIZE_IN sizeof(SUPLDRGETSYMBOL)
464#define SUP_IOCTL_LDR_GET_SYMBOL_SIZE_OUT (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPLDRGETSYMBOL, u.Out))
465typedef struct SUPLDRGETSYMBOL
466{
467 /** The header. */
468 SUPREQHDR Hdr;
469 union
470 {
471 struct
472 {
473 /** Address. */
474 RTR0PTR pvImageBase;
475 /** The symbol name. */
476 char szSymbol[64];
477 } In;
478 struct
479 {
480 /** The symbol address. */
481 RTR0PTR pvSymbol;
482 } Out;
483 } u;
484} SUPLDRGETSYMBOL, *PSUPLDRGETSYMBOL;
485/** @} */
486
487
488/** @name SUP_IOCTL_CALL_VMMR0
489 * Call the R0 VMM Entry point.
490 *
491 * @todo Might have to convert this to a big request...
492 * @{
493 */
494#define SUP_IOCTL_CALL_VMMR0(cbReq) SUP_CTL_CODE_SIZE(9, SUP_IOCTL_CALL_VMMR0_SIZE(cbReq))
495#define SUP_IOCTL_CALL_VMMR0_SIZE(cbReq) RT_OFFSETOF(SUPCALLVMMR0, abReqPkt[cbReq])
496#define SUP_IOCTL_CALL_VMMR0_SIZE_IN(cbReq) SUP_IOCTL_CALL_VMMR0_SIZE(cbReq)
497#define SUP_IOCTL_CALL_VMMR0_SIZE_OUT(cbReq) SUP_IOCTL_CALL_VMMR0_SIZE(cbReq)
498typedef struct SUPCALLVMMR0
499{
500 /** The header. */
501 SUPREQHDR Hdr;
502 union
503 {
504 struct
505 {
506 /** The VM handle. */
507 PVMR0 pVMR0;
508 /** Which operation to execute. */
509 uint32_t uOperation;
510#if R0_ARCH_BITS == 64
511 /** Alignment. */
512 uint32_t u32Reserved;
513#endif
514 /** Argument to use when no request packet is supplied. */
515 uint64_t u64Arg;
516 } In;
517 } u;
518 /** The VMMR0Entry request packet. */
519 uint8_t abReqPkt[1];
520} SUPCALLVMMR0, *PSUPCALLVMMR0;
521/** @} */
522
523
524/** @name SUP_IOCTL_LOW_ALLOC
525 * Allocate memory below 4GB (physically).
526 * @{
527 */
528#define SUP_IOCTL_LOW_ALLOC SUP_CTL_CODE_BIG(10)
529#define SUP_IOCTL_LOW_ALLOC_SIZE(cPages) ((uint32_t)RT_OFFSETOF(SUPLOWALLOC, u.Out.aPages[cPages]))
530#define SUP_IOCTL_LOW_ALLOC_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPLOWALLOC, u.In))
531#define SUP_IOCTL_LOW_ALLOC_SIZE_OUT(cPages) SUP_IOCTL_LOW_ALLOC_SIZE(cPages)
532typedef struct SUPLOWALLOC
533{
534 /** The header. */
535 SUPREQHDR Hdr;
536 union
537 {
538 struct
539 {
540 /** Number of pages to allocate. */
541 uint32_t cPages;
542 } In;
543 struct
544 {
545 /** The ring-3 address of the allocated memory. */
546 RTR3PTR pvR3;
547 /** The ring-0 address of the allocated memory. */
548 RTR0PTR pvR0;
549 /** Array of pages. */
550 RTHCPHYS aPages[1];
551 } Out;
552 } u;
553} SUPLOWALLOC, *PSUPLOWALLOC;
554/** @} */
555
556
557/** @name SUP_IOCTL_LOW_FREE
558 * Free low memory.
559 * @{
560 */
561#define SUP_IOCTL_LOW_FREE SUP_CTL_CODE_SIZE(11, SUP_IOCTL_LOW_FREE_SIZE)
562#define SUP_IOCTL_LOW_FREE_SIZE sizeof(SUPLOWFREE)
563#define SUP_IOCTL_LOW_FREE_SIZE_IN sizeof(SUPLOWFREE)
564#define SUP_IOCTL_LOW_FREE_SIZE_OUT sizeof(SUPREQHDR)
565typedef struct SUPLOWFREE
566{
567 /** The header. */
568 SUPREQHDR Hdr;
569 union
570 {
571 struct
572 {
573 /** The ring-3 address of the memory to free. */
574 RTR3PTR pvR3;
575 } In;
576 } u;
577} SUPLOWFREE, *PSUPLOWFREE;
578/** @} */
579
580
581/** @name SUP_IOCTL_PAGE_ALLOC
582 * Allocate memory and map into the user process.
583 * The memory is of course locked.
584 * @{
585 */
586#define SUP_IOCTL_PAGE_ALLOC SUP_CTL_CODE_BIG(12)
587#define SUP_IOCTL_PAGE_ALLOC_SIZE(cPages) RT_OFFSETOF(SUPPAGEALLOC, u.Out.aPages[cPages])
588#define SUP_IOCTL_PAGE_ALLOC_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPPAGEALLOC, u.In))
589#define SUP_IOCTL_PAGE_ALLOC_SIZE_OUT(cPages) SUP_IOCTL_PAGE_ALLOC_SIZE(cPages)
590typedef struct SUPPAGEALLOC
591{
592 /** The header. */
593 SUPREQHDR Hdr;
594 union
595 {
596 struct
597 {
598 /** Number of pages to allocate */
599 uint32_t cPages;
600 } In;
601 struct
602 {
603 /** Returned ring-3 address. */
604 RTR3PTR pvR3;
605 /** The physical addresses of the allocated pages. */
606 RTHCPHYS aPages[1];
607 } Out;
608 } u;
609} SUPPAGEALLOC, *PSUPPAGEALLOC;
610/** @} */
611
612
613/** @name SUP_IOCTL_PAGE_FREE
614 * Free memory allocated with SUP_IOCTL_PAGE_ALLOC.
615 * @{
616 */
617#define SUP_IOCTL_PAGE_FREE SUP_CTL_CODE_SIZE(13, SUP_IOCTL_PAGE_FREE_SIZE_IN)
618#define SUP_IOCTL_PAGE_FREE_SIZE sizeof(SUPPAGEFREE)
619#define SUP_IOCTL_PAGE_FREE_SIZE_IN sizeof(SUPPAGEFREE)
620#define SUP_IOCTL_PAGE_FREE_SIZE_OUT sizeof(SUPREQHDR)
621typedef struct SUPPAGEFREE
622{
623 /** The header. */
624 SUPREQHDR Hdr;
625 union
626 {
627 struct
628 {
629 /** Address of memory range to free. */
630 RTR3PTR pvR3;
631 } In;
632 } u;
633} SUPPAGEFREE, *PSUPPAGEFREE;
634/** @} */
635
636
637/** @name SUP_IOCTL_PAGE_LOCK
638 * Pin down physical pages.
639 * @{
640 */
641#define SUP_IOCTL_PAGE_LOCK SUP_CTL_CODE_BIG(14)
642#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)))
643#define SUP_IOCTL_PAGE_LOCK_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPPAGELOCK, u.In))
644#define SUP_IOCTL_PAGE_LOCK_SIZE_OUT(cPages) RT_OFFSETOF(SUPPAGELOCK, u.Out.aPages[cPages])
645typedef struct SUPPAGELOCK
646{
647 /** The header. */
648 SUPREQHDR Hdr;
649 union
650 {
651 struct
652 {
653 /** Start of page range. Must be PAGE aligned. */
654 RTR3PTR pvR3;
655 /** The range size given as a page count. */
656 uint32_t cPages;
657 } In;
658
659 struct
660 {
661 /** Array of pages. */
662 RTHCPHYS aPages[1];
663 } Out;
664 } u;
665} SUPPAGELOCK, *PSUPPAGELOCK;
666/** @} */
667
668
669/** @name SUP_IOCTL_PAGE_UNLOCK
670 * Unpin physical pages.
671 * @{ */
672#define SUP_IOCTL_PAGE_UNLOCK SUP_CTL_CODE_SIZE(15, SUP_IOCTL_PAGE_UNLOCK_SIZE)
673#define SUP_IOCTL_PAGE_UNLOCK_SIZE sizeof(SUPPAGEUNLOCK)
674#define SUP_IOCTL_PAGE_UNLOCK_SIZE_IN sizeof(SUPPAGEUNLOCK)
675#define SUP_IOCTL_PAGE_UNLOCK_SIZE_OUT sizeof(SUPREQHDR)
676typedef struct SUPPAGEUNLOCK
677{
678 /** The header. */
679 SUPREQHDR Hdr;
680 union
681 {
682 struct
683 {
684 /** Start of page range of a range previuosly pinned. */
685 RTR3PTR pvR3;
686 } In;
687 } u;
688} SUPPAGEUNLOCK, *PSUPPAGEUNLOCK;
689/** @} */
690
691
692/** @name SUP_IOCTL_CONT_ALLOC
693 * Allocate contious memory.
694 * @{
695 */
696#define SUP_IOCTL_CONT_ALLOC SUP_CTL_CODE_SIZE(16, SUP_IOCTL_CONT_ALLOC_SIZE)
697#define SUP_IOCTL_CONT_ALLOC_SIZE sizeof(SUPCONTALLOC)
698#define SUP_IOCTL_CONT_ALLOC_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPCONTALLOC, u.In))
699#define SUP_IOCTL_CONT_ALLOC_SIZE_OUT sizeof(SUPCONTALLOC)
700typedef struct SUPCONTALLOC
701{
702 /** The header. */
703 SUPREQHDR Hdr;
704 union
705 {
706 struct
707 {
708 /** The allocation size given as a page count. */
709 uint32_t cPages;
710 } In;
711
712 struct
713 {
714 /** The address of the ring-0 mapping of the allocated memory. */
715 RTR0PTR pvR0;
716 /** The address of the ring-3 mapping of the allocated memory. */
717 RTR3PTR pvR3;
718 /** The physical address of the allocation. */
719 RTHCPHYS HCPhys;
720 } Out;
721 } u;
722} SUPCONTALLOC, *PSUPCONTALLOC;
723/** @} */
724
725
726/** @name SUP_IOCTL_CONT_FREE Input.
727 * @{
728 */
729/** Free contious memory. */
730#define SUP_IOCTL_CONT_FREE SUP_CTL_CODE_SIZE(17, SUP_IOCTL_CONT_FREE_SIZE)
731#define SUP_IOCTL_CONT_FREE_SIZE sizeof(SUPCONTFREE)
732#define SUP_IOCTL_CONT_FREE_SIZE_IN sizeof(SUPCONTFREE)
733#define SUP_IOCTL_CONT_FREE_SIZE_OUT sizeof(SUPREQHDR)
734typedef struct SUPCONTFREE
735{
736 /** The header. */
737 SUPREQHDR Hdr;
738 union
739 {
740 struct
741 {
742 /** The ring-3 address of the memory to free. */
743 RTR3PTR pvR3;
744 } In;
745 } u;
746} SUPCONTFREE, *PSUPCONTFREE;
747/** @} */
748
749
750/** @name SUP_IOCTL_GET_PAGING_MODE
751 * Get the host paging mode.
752 * @{
753 */
754#define SUP_IOCTL_GET_PAGING_MODE SUP_CTL_CODE_SIZE(18, SUP_IOCTL_GET_PAGING_MODE_SIZE)
755#define SUP_IOCTL_GET_PAGING_MODE_SIZE sizeof(SUPGETPAGINGMODE)
756#define SUP_IOCTL_GET_PAGING_MODE_SIZE_IN sizeof(SUPREQHDR)
757#define SUP_IOCTL_GET_PAGING_MODE_SIZE_OUT sizeof(SUPGETPAGINGMODE)
758typedef struct SUPGETPAGINGMODE
759{
760 /** The header. */
761 SUPREQHDR Hdr;
762 union
763 {
764 struct
765 {
766 /** The paging mode. */
767 SUPPAGINGMODE enmMode;
768 } Out;
769 } u;
770} SUPGETPAGINGMODE, *PSUPGETPAGINGMODE;
771/** @} */
772
773
774/** @name SUP_IOCTL_SET_VM_FOR_FAST
775 * Set the VM handle for doing fast call ioctl calls.
776 * @{
777 */
778#define SUP_IOCTL_SET_VM_FOR_FAST SUP_CTL_CODE_SIZE(19, SUP_IOCTL_SET_VM_FOR_FAST_SIZE)
779#define SUP_IOCTL_SET_VM_FOR_FAST_SIZE sizeof(SUPSETVMFORFAST)
780#define SUP_IOCTL_SET_VM_FOR_FAST_SIZE_IN sizeof(SUPSETVMFORFAST)
781#define SUP_IOCTL_SET_VM_FOR_FAST_SIZE_OUT sizeof(SUPREQHDR)
782typedef struct SUPSETVMFORFAST
783{
784 /** The header. */
785 SUPREQHDR Hdr;
786 union
787 {
788 struct
789 {
790 /** The ring-0 VM handle (pointer). */
791 PVMR0 pVMR0;
792 } In;
793 } u;
794} SUPSETVMFORFAST, *PSUPSETVMFORFAST;
795/** @} */
796
797
798/** @name SUP_IOCTL_GIP_MAP
799 * Map the GIP into user space.
800 * @{
801 */
802#define SUP_IOCTL_GIP_MAP SUP_CTL_CODE_SIZE(20, SUP_IOCTL_GIP_MAP_SIZE)
803#define SUP_IOCTL_GIP_MAP_SIZE sizeof(SUPGIPMAP)
804#define SUP_IOCTL_GIP_MAP_SIZE_IN sizeof(SUPREQHDR)
805#define SUP_IOCTL_GIP_MAP_SIZE_OUT sizeof(SUPGIPMAP)
806typedef struct SUPGIPMAP
807{
808 /** The header. */
809 SUPREQHDR Hdr;
810 union
811 {
812 struct
813 {
814 /** The physical address of the GIP. */
815 RTHCPHYS HCPhysGip;
816 /** Pointer to the read-only usermode GIP mapping for this session. */
817 R3PTRTYPE(PSUPGLOBALINFOPAGE) pGipR3;
818 /** Pointer to the supervisor mode GIP mapping. */
819 R0PTRTYPE(PSUPGLOBALINFOPAGE) pGipR0;
820 } Out;
821 } u;
822} SUPGIPMAP, *PSUPGIPMAP;
823/** @} */
824
825
826/** @name SUP_IOCTL_GIP_UNMAP
827 * Unmap the GIP.
828 * @{
829 */
830#define SUP_IOCTL_GIP_UNMAP SUP_CTL_CODE_SIZE(21, SUP_IOCTL_GIP_UNMAP_SIZE)
831#define SUP_IOCTL_GIP_UNMAP_SIZE sizeof(SUPGIPUNMAP)
832#define SUP_IOCTL_GIP_UNMAP_SIZE_IN sizeof(SUPGIPUNMAP)
833#define SUP_IOCTL_GIP_UNMAP_SIZE_OUT sizeof(SUPGIPUNMAP)
834typedef struct SUPGIPUNMAP
835{
836 /** The header. */
837 SUPREQHDR Hdr;
838} SUPGIPUNMAP, *PSUPGIPUNMAP;
839/** @} */
840
841
842#pragma pack() /* paranoia */
843
844#endif
845
Note: See TracBrowser for help on using the repository browser.

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