-
Notifications
You must be signed in to change notification settings - Fork 67
/
SUPDrvIOC.h
1561 lines (1429 loc) · 52.8 KB
/
SUPDrvIOC.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* $Revision$ */
/** @file
* VirtualBox Support Driver - IOCtl definitions.
*/
/*
* Copyright (C) 2006-2015 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___SUPDrvIOC_h___
#define ___SUPDrvIOC_h___
/*
* Basic types.
*/
#include <iprt/types.h>
#include <VBox/sup.h>
/*
* IOCtl numbers.
* We're using the Win32 type of numbers here, thus the macros below.
* The SUP_IOCTL_FLAG macro is used to separate requests from 32-bit
* and 64-bit processes.
*/
#if defined(RT_ARCH_AMD64) || defined(RT_ARCH_SPARC64)
# define SUP_IOCTL_FLAG 128
#elif defined(RT_ARCH_X86) || defined(RT_ARCH_SPARC)
# define SUP_IOCTL_FLAG 0
#else
# error "dunno which arch this is!"
#endif
#ifdef RT_OS_WINDOWS
# ifndef CTL_CODE
# include <Windows.h>
# endif
/* Automatic buffering, size not encoded. */
# define SUP_CTL_CODE_SIZE(Function, Size) CTL_CODE(FILE_DEVICE_UNKNOWN, (Function) | SUP_IOCTL_FLAG, METHOD_BUFFERED, FILE_WRITE_ACCESS)
# define SUP_CTL_CODE_BIG(Function) CTL_CODE(FILE_DEVICE_UNKNOWN, (Function) | SUP_IOCTL_FLAG, METHOD_BUFFERED, FILE_WRITE_ACCESS)
# define SUP_CTL_CODE_FAST(Function) CTL_CODE(FILE_DEVICE_UNKNOWN, (Function) | SUP_IOCTL_FLAG, METHOD_NEITHER, FILE_WRITE_ACCESS)
# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
# define SUP_NT_STATUS_BASE UINT32_C(0xe9860000) /**< STATUS_SEVERITY_ERROR + C-bit + facility 0x986. */
# define SUP_NT_STATUS_IS_VBOX(a_rcNt) ( ((uint32_t)(a_rcNt) & 0xffff0000) == SUP_NT_STATUS_BASE )
# define SUP_NT_STATUS_TO_VBOX(a_rcNt) ( (int)((uint32_t)(a_rcNt) | UINT32_C(0xffff0000)) )
/** NT device name for system access. */
# define SUPDRV_NT_DEVICE_NAME_SYS L"\\Device\\VBoxDrv"
/** NT device name for user access. */
# define SUPDRV_NT_DEVICE_NAME_USR L"\\Device\\VBoxDrvU"
# ifdef VBOX_WITH_HARDENING
/** NT device name for hardened stub access. */
# define SUPDRV_NT_DEVICE_NAME_STUB L"\\Device\\VBoxDrvStub"
/** NT device name for getting error information for failed VBoxDrv or
* VBoxDrvStub open. */
# define SUPDRV_NT_DEVICE_NAME_ERROR_INFO L"\\Device\\VBoxDrvErrorInfo"
# endif
#elif defined(RT_OS_SOLARIS)
/* No automatic buffering, size limited to 255 bytes. */
# include <sys/ioccom.h>
# define SUP_CTL_CODE_SIZE(Function, Size) _IOWRN('V', (Function) | SUP_IOCTL_FLAG, sizeof(SUPREQHDR))
# define SUP_CTL_CODE_BIG(Function) _IOWRN('V', (Function) | SUP_IOCTL_FLAG, sizeof(SUPREQHDR))
# define SUP_CTL_CODE_FAST(Function) _IO( 'V', (Function) | SUP_IOCTL_FLAG)
# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
#elif defined(RT_OS_OS2)
/* No automatic buffering, size not encoded. */
# define SUP_CTL_CATEGORY 0xc0
# define SUP_CTL_CODE_SIZE(Function, Size) ((unsigned char)(Function))
# define SUP_CTL_CODE_BIG(Function) ((unsigned char)(Function))
# define SUP_CTL_CATEGORY_FAST 0xc1
# define SUP_CTL_CODE_FAST(Function) ((unsigned char)(Function))
# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
#elif defined(RT_OS_LINUX)
/* No automatic buffering, size limited to 16KB. */
# include <linux/ioctl.h>
# define SUP_CTL_CODE_SIZE(Function, Size) _IOC(_IOC_READ | _IOC_WRITE, 'V', (Function) | SUP_IOCTL_FLAG, (Size))
# define SUP_CTL_CODE_BIG(Function) _IO('V', (Function) | SUP_IOCTL_FLAG)
# define SUP_CTL_CODE_FAST(Function) _IO('V', (Function) | SUP_IOCTL_FLAG)
# define SUP_CTL_CODE_NO_SIZE(uIOCtl) ((uIOCtl) & ~IOCSIZE_MASK)
#elif defined(RT_OS_L4)
/* Implemented in suplib, no worries. */
# define SUP_CTL_CODE_SIZE(Function, Size) (Function)
# define SUP_CTL_CODE_BIG(Function) (Function)
# define SUP_CTL_CODE_FAST(Function) (Function)
# define SUP_CTL_CODE_NO_SIZE(uIOCtl) (uIOCtl)
#else /* BSD Like */
/* Automatic buffering, size limited to 4KB on *BSD and 8KB on Darwin - commands the limit, 4KB. */
# include <sys/ioccom.h>
# define SUP_CTL_CODE_SIZE(Function, Size) _IOC(IOC_INOUT, 'V', (Function) | SUP_IOCTL_FLAG, (Size))
# define SUP_CTL_CODE_BIG(Function) _IO('V', (Function) | SUP_IOCTL_FLAG)
# define SUP_CTL_CODE_FAST(Function) _IO('V', (Function) | SUP_IOCTL_FLAG)
# define SUP_CTL_CODE_NO_SIZE(uIOCtl) ( (uIOCtl) & ~_IOC(0,0,0,IOCPARM_MASK) )
#endif
/** Fast path IOCtl: VMMR0_DO_RAW_RUN */
#define SUP_IOCTL_FAST_DO_RAW_RUN SUP_CTL_CODE_FAST(64)
/** Fast path IOCtl: VMMR0_DO_HM_RUN */
#define SUP_IOCTL_FAST_DO_HM_RUN SUP_CTL_CODE_FAST(65)
/** Just a NOP call for profiling the latency of a fast ioctl call to VMMR0. */
#define SUP_IOCTL_FAST_DO_NOP SUP_CTL_CODE_FAST(66)
#ifdef RT_OS_DARWIN
/** Cookie used to fend off some unwanted clients to the IOService. */
# define SUP_DARWIN_IOSERVICE_COOKIE 0x64726962 /* 'bird' */
#endif
/*******************************************************************************
* Structures and Typedefs *
*******************************************************************************/
#ifdef RT_ARCH_AMD64
# pragma pack(8) /* paranoia. */
#else
# pragma pack(4) /* paranoia. */
#endif
/**
* Common In/Out header.
*/
typedef struct SUPREQHDR
{
/** Cookie. */
uint32_t u32Cookie;
/** Session cookie. */
uint32_t u32SessionCookie;
/** The size of the input. */
uint32_t cbIn;
/** The size of the output. */
uint32_t cbOut;
/** Flags. See SUPREQHDR_FLAGS_* for details and values. */
uint32_t fFlags;
/** The VBox status code of the operation, out direction only. */
int32_t rc;
} SUPREQHDR;
/** Pointer to a IOC header. */
typedef SUPREQHDR *PSUPREQHDR;
/** @name SUPREQHDR::fFlags values
* @{ */
/** Masks out the magic value. */
#define SUPREQHDR_FLAGS_MAGIC_MASK UINT32_C(0xff0000ff)
/** The generic mask. */
#define SUPREQHDR_FLAGS_GEN_MASK UINT32_C(0x0000ff00)
/** The request specific mask. */
#define SUPREQHDR_FLAGS_REQ_MASK UINT32_C(0x00ff0000)
/** There is extra input that needs copying on some platforms. */
#define SUPREQHDR_FLAGS_EXTRA_IN UINT32_C(0x00000100)
/** There is extra output that needs copying on some platforms. */
#define SUPREQHDR_FLAGS_EXTRA_OUT UINT32_C(0x00000200)
/** The magic value. */
#define SUPREQHDR_FLAGS_MAGIC UINT32_C(0x42000042)
/** The default value. Use this when no special stuff is requested. */
#define SUPREQHDR_FLAGS_DEFAULT SUPREQHDR_FLAGS_MAGIC
/** @} */
/** @name SUP_IOCTL_COOKIE
* @{
*/
/** Negotiate cookie. */
#define SUP_IOCTL_COOKIE SUP_CTL_CODE_SIZE(1, SUP_IOCTL_COOKIE_SIZE)
/** The request size. */
#define SUP_IOCTL_COOKIE_SIZE sizeof(SUPCOOKIE)
/** The SUPREQHDR::cbIn value. */
#define SUP_IOCTL_COOKIE_SIZE_IN sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPCOOKIE, u.In)
/** The SUPREQHDR::cbOut value. */
#define SUP_IOCTL_COOKIE_SIZE_OUT sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPCOOKIE, u.Out)
/** SUPCOOKIE_IN magic word. */
#define SUPCOOKIE_MAGIC "The Magic Word!"
/** The initial cookie. */
#define SUPCOOKIE_INITIAL_COOKIE 0x69726f74 /* 'tori' */
/** Current interface version.
* The upper 16-bit is the major version, the lower the minor version.
* When incompatible changes are made, the upper major number has to be changed.
*
* Update rules:
* -# Only update the major number when incompatible changes have been made to
* the IOC interface or the ABI provided via the functions returned by
* SUPQUERYFUNCS.
* -# When adding new features (new IOC number, new flags, new exports, ++)
* only update the minor number and change SUPLib.cpp to require the
* new IOC version.
* -# When incrementing the major number, clear the minor part and reset
* any IOC version requirements in SUPLib.cpp.
* -# When increment the major number, execute all pending work.
*
* @todo Pending work on next major version change:
* - Fix SUPTSCREAD padding (#if 0 -> #if 1).
*/
#define SUPDRV_IOC_VERSION 0x001f0000
/** SUP_IOCTL_COOKIE. */
typedef struct SUPCOOKIE
{
/** The header.
* u32Cookie must be set to SUPCOOKIE_INITIAL_COOKIE.
* u32SessionCookie should be set to some random value. */
SUPREQHDR Hdr;
union
{
struct
{
/** Magic word. */
char szMagic[16];
/** The requested interface version number. */
uint32_t u32ReqVersion;
/** The minimum interface version number. */
uint32_t u32MinVersion;
} In;
struct
{
/** Cookie. */
uint32_t u32Cookie;
/** Session cookie. */
uint32_t u32SessionCookie;
/** Interface version for this session. */
uint32_t u32SessionVersion;
/** The actual interface version in the driver. */
uint32_t u32DriverVersion;
/** Number of functions available for the SUP_IOCTL_QUERY_FUNCS request. */
uint32_t cFunctions;
/** Session handle. */
R0PTRTYPE(PSUPDRVSESSION) pSession;
} Out;
} u;
} SUPCOOKIE, *PSUPCOOKIE;
/** @} */
/** @name SUP_IOCTL_QUERY_FUNCS
* Query SUPR0 functions.
* @{
*/
#define SUP_IOCTL_QUERY_FUNCS(cFuncs) SUP_CTL_CODE_BIG(2)
#define SUP_IOCTL_QUERY_FUNCS_SIZE(cFuncs) RT_UOFFSETOF(SUPQUERYFUNCS, u.Out.aFunctions[(cFuncs)])
#define SUP_IOCTL_QUERY_FUNCS_SIZE_IN sizeof(SUPREQHDR)
#define SUP_IOCTL_QUERY_FUNCS_SIZE_OUT(cFuncs) SUP_IOCTL_QUERY_FUNCS_SIZE(cFuncs)
/** A function. */
typedef struct SUPFUNC
{
/** Name - mangled. */
char szName[32];
/** Address. */
RTR0PTR pfn;
} SUPFUNC, *PSUPFUNC;
typedef struct SUPQUERYFUNCS
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** Number of functions returned. */
uint32_t cFunctions;
/** Array of functions. */
SUPFUNC aFunctions[1];
} Out;
} u;
} SUPQUERYFUNCS, *PSUPQUERYFUNCS;
/** @} */
/** @name SUP_IOCTL_LDR_OPEN
* Open an image.
* @{
*/
#define SUP_IOCTL_LDR_OPEN SUP_CTL_CODE_SIZE(3, SUP_IOCTL_LDR_OPEN_SIZE)
#define SUP_IOCTL_LDR_OPEN_SIZE sizeof(SUPLDROPEN)
#define SUP_IOCTL_LDR_OPEN_SIZE_IN sizeof(SUPLDROPEN)
#define SUP_IOCTL_LDR_OPEN_SIZE_OUT (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPLDROPEN, u.Out))
typedef struct SUPLDROPEN
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** Size of the image we'll be loading (including tables). */
uint32_t cbImageWithTabs;
/** The size of the image bits. (Less or equal to cbImageWithTabs.) */
uint32_t cbImageBits;
/** Image name.
* This is the NAME of the image, not the file name. It is used
* to share code with other processes. (Max len is 32 chars!) */
char szName[32];
/** Image file name.
* This can be used to load the image using a native loader. */
char szFilename[260];
} In;
struct
{
/** The base address of the image. */
RTR0PTR pvImageBase;
/** Indicate whether or not the image requires loading. */
bool fNeedsLoading;
/** Indicates that we're using the native ring-0 loader. */
bool fNativeLoader;
} Out;
} u;
} SUPLDROPEN, *PSUPLDROPEN;
/** @} */
/** @name SUP_IOCTL_LDR_LOAD
* Upload the image bits.
* @{
*/
#define SUP_IOCTL_LDR_LOAD SUP_CTL_CODE_BIG(4)
#define SUP_IOCTL_LDR_LOAD_SIZE(cbImage) RT_UOFFSETOF(SUPLDRLOAD, u.In.abImage[cbImage])
#define SUP_IOCTL_LDR_LOAD_SIZE_IN(cbImage) RT_UOFFSETOF(SUPLDRLOAD, u.In.abImage[cbImage])
#define SUP_IOCTL_LDR_LOAD_SIZE_OUT sizeof(SUPREQHDR)
/**
* Module initialization callback function.
* This is called once after the module has been loaded.
*
* @returns 0 on success.
* @returns Appropriate error code on failure.
* @param hMod Image handle for use in APIs.
*/
typedef DECLCALLBACK(int) FNR0MODULEINIT(void *hMod);
/** Pointer to a FNR0MODULEINIT(). */
typedef R0PTRTYPE(FNR0MODULEINIT *) PFNR0MODULEINIT;
/**
* Module termination callback function.
* This is called once right before the module is being unloaded.
*
* @param hMod Image handle for use in APIs.
*/
typedef DECLCALLBACK(void) FNR0MODULETERM(void *hMod);
/** Pointer to a FNR0MODULETERM(). */
typedef R0PTRTYPE(FNR0MODULETERM *) PFNR0MODULETERM;
/**
* Symbol table entry.
*/
typedef struct SUPLDRSYM
{
/** Offset into of the string table. */
uint32_t offName;
/** Offset of the symbol relative to the image load address.
* @remarks When used inside the SUPDrv to calculate real addresses, it
* must be cast to int32_t for the sake of native loader support
* on Solaris. (The loader puts the and data in different
* memory areans, and the text one is generally higher.) */
uint32_t offSymbol;
} SUPLDRSYM;
/** Pointer to a symbol table entry. */
typedef SUPLDRSYM *PSUPLDRSYM;
/** Pointer to a const symbol table entry. */
typedef SUPLDRSYM const *PCSUPLDRSYM;
/**
* SUPLDRLOAD::u::In::EP type.
*/
typedef enum SUPLDRLOADEP
{
SUPLDRLOADEP_NOTHING = 0,
SUPLDRLOADEP_VMMR0,
SUPLDRLOADEP_SERVICE,
SUPLDRLOADEP_32BIT_HACK = 0x7fffffff
} SUPLDRLOADEP;
typedef struct SUPLDRLOAD
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** The address of module initialization function. Similar to _DLL_InitTerm(hmod, 0). */
PFNR0MODULEINIT pfnModuleInit;
/** The address of module termination function. Similar to _DLL_InitTerm(hmod, 1). */
PFNR0MODULETERM pfnModuleTerm;
/** Special entry points. */
union
{
/** SUPLDRLOADEP_VMMR0. */
struct
{
/** The module handle (i.e. address). */
RTR0PTR pvVMMR0;
/** Address of VMMR0EntryInt function. */
RTR0PTR pvVMMR0EntryInt;
/** Address of VMMR0EntryFast function. */
RTR0PTR pvVMMR0EntryFast;
/** Address of VMMR0EntryEx function. */
RTR0PTR pvVMMR0EntryEx;
} VMMR0;
/** SUPLDRLOADEP_SERVICE. */
struct
{
/** The service request handler.
* (PFNR0SERVICEREQHANDLER isn't defined yet.) */
RTR0PTR pfnServiceReq;
/** Reserved, must be NIL. */
RTR0PTR apvReserved[3];
} Service;
} EP;
/** Address. */
RTR0PTR pvImageBase;
/** Entry point type. */
SUPLDRLOADEP eEPType;
/** The size of the image bits (starting at offset 0 and
* approaching offSymbols). */
uint32_t cbImageBits;
/** The offset of the symbol table. */
uint32_t offSymbols;
/** The number of entries in the symbol table. */
uint32_t cSymbols;
/** The offset of the string table. */
uint32_t offStrTab;
/** Size of the string table. */
uint32_t cbStrTab;
/** Size of image data in achImage. */
uint32_t cbImageWithTabs;
/** The image data. */
uint8_t abImage[1];
} In;
} u;
} SUPLDRLOAD, *PSUPLDRLOAD;
/** @} */
/** @name SUP_IOCTL_LDR_FREE
* Free an image.
* @{
*/
#define SUP_IOCTL_LDR_FREE SUP_CTL_CODE_SIZE(5, SUP_IOCTL_LDR_FREE_SIZE)
#define SUP_IOCTL_LDR_FREE_SIZE sizeof(SUPLDRFREE)
#define SUP_IOCTL_LDR_FREE_SIZE_IN sizeof(SUPLDRFREE)
#define SUP_IOCTL_LDR_FREE_SIZE_OUT sizeof(SUPREQHDR)
typedef struct SUPLDRFREE
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** Address. */
RTR0PTR pvImageBase;
} In;
} u;
} SUPLDRFREE, *PSUPLDRFREE;
/** @} */
/** @name SUP_IOCTL_LDR_LOCK_DOWN
* Lock down the image loader interface.
* @{
*/
#define SUP_IOCTL_LDR_LOCK_DOWN SUP_CTL_CODE_SIZE(38, SUP_IOCTL_LDR_LOCK_DOWN_SIZE)
#define SUP_IOCTL_LDR_LOCK_DOWN_SIZE sizeof(SUPREQHDR)
#define SUP_IOCTL_LDR_LOCK_DOWN_SIZE_IN sizeof(SUPREQHDR)
#define SUP_IOCTL_LDR_LOCK_DOWN_SIZE_OUT sizeof(SUPREQHDR)
/** @} */
/** @name SUP_IOCTL_LDR_GET_SYMBOL
* Get address of a symbol within an image.
* @{
*/
#define SUP_IOCTL_LDR_GET_SYMBOL SUP_CTL_CODE_SIZE(6, SUP_IOCTL_LDR_GET_SYMBOL_SIZE)
#define SUP_IOCTL_LDR_GET_SYMBOL_SIZE sizeof(SUPLDRGETSYMBOL)
#define SUP_IOCTL_LDR_GET_SYMBOL_SIZE_IN sizeof(SUPLDRGETSYMBOL)
#define SUP_IOCTL_LDR_GET_SYMBOL_SIZE_OUT (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPLDRGETSYMBOL, u.Out))
typedef struct SUPLDRGETSYMBOL
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** Address. */
RTR0PTR pvImageBase;
/** The symbol name. */
char szSymbol[64];
} In;
struct
{
/** The symbol address. */
RTR0PTR pvSymbol;
} Out;
} u;
} SUPLDRGETSYMBOL, *PSUPLDRGETSYMBOL;
/** @} */
/** @name SUP_IOCTL_CALL_VMMR0
* Call the R0 VMM Entry point.
* @{
*/
#define SUP_IOCTL_CALL_VMMR0(cbReq) SUP_CTL_CODE_SIZE(7, SUP_IOCTL_CALL_VMMR0_SIZE(cbReq))
#define SUP_IOCTL_CALL_VMMR0_SIZE(cbReq) RT_UOFFSETOF(SUPCALLVMMR0, abReqPkt[cbReq])
#define SUP_IOCTL_CALL_VMMR0_SIZE_IN(cbReq) SUP_IOCTL_CALL_VMMR0_SIZE(cbReq)
#define SUP_IOCTL_CALL_VMMR0_SIZE_OUT(cbReq) SUP_IOCTL_CALL_VMMR0_SIZE(cbReq)
typedef struct SUPCALLVMMR0
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** The VM handle. */
PVMR0 pVMR0;
/** VCPU id. */
uint32_t idCpu;
/** Which operation to execute. */
uint32_t uOperation;
/** Argument to use when no request packet is supplied. */
uint64_t u64Arg;
} In;
} u;
/** The VMMR0Entry request packet. */
uint8_t abReqPkt[1];
} SUPCALLVMMR0, *PSUPCALLVMMR0;
/** @} */
/** @name SUP_IOCTL_CALL_VMMR0_BIG
* Version of SUP_IOCTL_CALL_VMMR0 for dealing with large requests.
* @{
*/
#define SUP_IOCTL_CALL_VMMR0_BIG SUP_CTL_CODE_BIG(27)
#define SUP_IOCTL_CALL_VMMR0_BIG_SIZE(cbReq) RT_UOFFSETOF(SUPCALLVMMR0, abReqPkt[cbReq])
#define SUP_IOCTL_CALL_VMMR0_BIG_SIZE_IN(cbReq) SUP_IOCTL_CALL_VMMR0_SIZE(cbReq)
#define SUP_IOCTL_CALL_VMMR0_BIG_SIZE_OUT(cbReq) SUP_IOCTL_CALL_VMMR0_SIZE(cbReq)
/** @} */
/** @name SUP_IOCTL_LOW_ALLOC
* Allocate memory below 4GB (physically).
* @{
*/
#define SUP_IOCTL_LOW_ALLOC SUP_CTL_CODE_BIG(8)
#define SUP_IOCTL_LOW_ALLOC_SIZE(cPages) ((uint32_t)RT_UOFFSETOF(SUPLOWALLOC, u.Out.aPages[cPages]))
#define SUP_IOCTL_LOW_ALLOC_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPLOWALLOC, u.In))
#define SUP_IOCTL_LOW_ALLOC_SIZE_OUT(cPages) SUP_IOCTL_LOW_ALLOC_SIZE(cPages)
typedef struct SUPLOWALLOC
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** Number of pages to allocate. */
uint32_t cPages;
} In;
struct
{
/** The ring-3 address of the allocated memory. */
RTR3PTR pvR3;
/** The ring-0 address of the allocated memory. */
RTR0PTR pvR0;
/** Array of pages. */
RTHCPHYS aPages[1];
} Out;
} u;
} SUPLOWALLOC, *PSUPLOWALLOC;
/** @} */
/** @name SUP_IOCTL_LOW_FREE
* Free low memory.
* @{
*/
#define SUP_IOCTL_LOW_FREE SUP_CTL_CODE_SIZE(9, SUP_IOCTL_LOW_FREE_SIZE)
#define SUP_IOCTL_LOW_FREE_SIZE sizeof(SUPLOWFREE)
#define SUP_IOCTL_LOW_FREE_SIZE_IN sizeof(SUPLOWFREE)
#define SUP_IOCTL_LOW_FREE_SIZE_OUT sizeof(SUPREQHDR)
typedef struct SUPLOWFREE
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** The ring-3 address of the memory to free. */
RTR3PTR pvR3;
} In;
} u;
} SUPLOWFREE, *PSUPLOWFREE;
/** @} */
/** @name SUP_IOCTL_PAGE_ALLOC_EX
* Allocate memory and map it into kernel and/or user space. The memory is of
* course locked. The result should be freed using SUP_IOCTL_PAGE_FREE.
*
* @remarks Allocations without a kernel mapping may fail with
* VERR_NOT_SUPPORTED on some platforms.
*
* @{
*/
#define SUP_IOCTL_PAGE_ALLOC_EX SUP_CTL_CODE_BIG(10)
#define SUP_IOCTL_PAGE_ALLOC_EX_SIZE(cPages) RT_UOFFSETOF(SUPPAGEALLOCEX, u.Out.aPages[cPages])
#define SUP_IOCTL_PAGE_ALLOC_EX_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPPAGEALLOCEX, u.In))
#define SUP_IOCTL_PAGE_ALLOC_EX_SIZE_OUT(cPages) SUP_IOCTL_PAGE_ALLOC_EX_SIZE(cPages)
typedef struct SUPPAGEALLOCEX
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** Number of pages to allocate */
uint32_t cPages;
/** Whether it should have kernel mapping. */
bool fKernelMapping;
/** Whether it should have a user mapping. */
bool fUserMapping;
/** Reserved. Must be false. */
bool fReserved0;
/** Reserved. Must be false. */
bool fReserved1;
} In;
struct
{
/** Returned ring-3 address. */
RTR3PTR pvR3;
/** Returned ring-0 address. */
RTR0PTR pvR0;
/** The physical addresses of the allocated pages. */
RTHCPHYS aPages[1];
} Out;
} u;
} SUPPAGEALLOCEX, *PSUPPAGEALLOCEX;
/** @} */
/** @name SUP_IOCTL_PAGE_MAP_KERNEL
* Maps a portion of memory allocated by SUP_IOCTL_PAGE_ALLOC_EX /
* SUPR0PageAllocEx into kernel space for use by a device or similar.
*
* The mapping will be freed together with the ring-3 mapping when
* SUP_IOCTL_PAGE_FREE or SUPR0PageFree is called.
*
* @remarks Not necessarily supported on all platforms.
*
* @{
*/
#define SUP_IOCTL_PAGE_MAP_KERNEL SUP_CTL_CODE_SIZE(11, SUP_IOCTL_PAGE_MAP_KERNEL_SIZE)
#define SUP_IOCTL_PAGE_MAP_KERNEL_SIZE sizeof(SUPPAGEMAPKERNEL)
#define SUP_IOCTL_PAGE_MAP_KERNEL_SIZE_IN sizeof(SUPPAGEMAPKERNEL)
#define SUP_IOCTL_PAGE_MAP_KERNEL_SIZE_OUT sizeof(SUPPAGEMAPKERNEL)
typedef struct SUPPAGEMAPKERNEL
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** The pointer of to the previously allocated memory. */
RTR3PTR pvR3;
/** The offset to start mapping from. */
uint32_t offSub;
/** Size of the section to map. */
uint32_t cbSub;
/** Flags reserved for future fun. */
uint32_t fFlags;
} In;
struct
{
/** The ring-0 address corresponding to pvR3 + offSub. */
RTR0PTR pvR0;
} Out;
} u;
} SUPPAGEMAPKERNEL, *PSUPPAGEMAPKERNEL;
/** @} */
/** @name SUP_IOCTL_PAGE_PROTECT
* Changes the page level protection of the user and/or kernel mappings of
* memory previously allocated by SUPR0PageAllocEx.
*
* @remarks Not necessarily supported on all platforms.
*
* @{
*/
#define SUP_IOCTL_PAGE_PROTECT SUP_CTL_CODE_SIZE(12, SUP_IOCTL_PAGE_PROTECT_SIZE)
#define SUP_IOCTL_PAGE_PROTECT_SIZE sizeof(SUPPAGEPROTECT)
#define SUP_IOCTL_PAGE_PROTECT_SIZE_IN sizeof(SUPPAGEPROTECT)
#define SUP_IOCTL_PAGE_PROTECT_SIZE_OUT sizeof(SUPPAGEPROTECT)
typedef struct SUPPAGEPROTECT
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** The pointer of to the previously allocated memory.
* Pass NIL_RTR3PTR if the ring-0 mapping should remain unaffected. */
RTR3PTR pvR3;
/** The pointer of to the previously allocated memory.
* Pass NIL_RTR0PTR if the ring-0 mapping should remain unaffected. */
RTR0PTR pvR0;
/** The offset to start changing protection at. */
uint32_t offSub;
/** Size of the portion that should be changed. */
uint32_t cbSub;
/** Protection flags, RTMEM_PROT_*. */
uint32_t fProt;
} In;
} u;
} SUPPAGEPROTECT, *PSUPPAGEPROTECT;
/** @} */
/** @name SUP_IOCTL_PAGE_FREE
* Free memory allocated with SUP_IOCTL_PAGE_ALLOC_EX.
* @{
*/
#define SUP_IOCTL_PAGE_FREE SUP_CTL_CODE_SIZE(13, SUP_IOCTL_PAGE_FREE_SIZE_IN)
#define SUP_IOCTL_PAGE_FREE_SIZE sizeof(SUPPAGEFREE)
#define SUP_IOCTL_PAGE_FREE_SIZE_IN sizeof(SUPPAGEFREE)
#define SUP_IOCTL_PAGE_FREE_SIZE_OUT sizeof(SUPREQHDR)
typedef struct SUPPAGEFREE
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** Address of memory range to free. */
RTR3PTR pvR3;
} In;
} u;
} SUPPAGEFREE, *PSUPPAGEFREE;
/** @} */
/** @name SUP_IOCTL_PAGE_LOCK
* Pin down physical pages.
* @{
*/
#define SUP_IOCTL_PAGE_LOCK SUP_CTL_CODE_BIG(14)
#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)))
#define SUP_IOCTL_PAGE_LOCK_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPPAGELOCK, u.In))
#define SUP_IOCTL_PAGE_LOCK_SIZE_OUT(cPages) RT_UOFFSETOF(SUPPAGELOCK, u.Out.aPages[cPages])
typedef struct SUPPAGELOCK
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** Start of page range. Must be PAGE aligned. */
RTR3PTR pvR3;
/** The range size given as a page count. */
uint32_t cPages;
} In;
struct
{
/** Array of pages. */
RTHCPHYS aPages[1];
} Out;
} u;
} SUPPAGELOCK, *PSUPPAGELOCK;
/** @} */
/** @name SUP_IOCTL_PAGE_UNLOCK
* Unpin physical pages.
* @{ */
#define SUP_IOCTL_PAGE_UNLOCK SUP_CTL_CODE_SIZE(15, SUP_IOCTL_PAGE_UNLOCK_SIZE)
#define SUP_IOCTL_PAGE_UNLOCK_SIZE sizeof(SUPPAGEUNLOCK)
#define SUP_IOCTL_PAGE_UNLOCK_SIZE_IN sizeof(SUPPAGEUNLOCK)
#define SUP_IOCTL_PAGE_UNLOCK_SIZE_OUT sizeof(SUPREQHDR)
typedef struct SUPPAGEUNLOCK
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** Start of page range of a range previously pinned. */
RTR3PTR pvR3;
} In;
} u;
} SUPPAGEUNLOCK, *PSUPPAGEUNLOCK;
/** @} */
/** @name SUP_IOCTL_CONT_ALLOC
* Allocate continuous memory.
* @{
*/
#define SUP_IOCTL_CONT_ALLOC SUP_CTL_CODE_SIZE(16, SUP_IOCTL_CONT_ALLOC_SIZE)
#define SUP_IOCTL_CONT_ALLOC_SIZE sizeof(SUPCONTALLOC)
#define SUP_IOCTL_CONT_ALLOC_SIZE_IN (sizeof(SUPREQHDR) + RT_SIZEOFMEMB(SUPCONTALLOC, u.In))
#define SUP_IOCTL_CONT_ALLOC_SIZE_OUT sizeof(SUPCONTALLOC)
typedef struct SUPCONTALLOC
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** The allocation size given as a page count. */
uint32_t cPages;
} In;
struct
{
/** The address of the ring-0 mapping of the allocated memory. */
RTR0PTR pvR0;
/** The address of the ring-3 mapping of the allocated memory. */
RTR3PTR pvR3;
/** The physical address of the allocation. */
RTHCPHYS HCPhys;
} Out;
} u;
} SUPCONTALLOC, *PSUPCONTALLOC;
/** @} */
/** @name SUP_IOCTL_CONT_FREE Input.
* @{
*/
/** Free continuous memory. */
#define SUP_IOCTL_CONT_FREE SUP_CTL_CODE_SIZE(17, SUP_IOCTL_CONT_FREE_SIZE)
#define SUP_IOCTL_CONT_FREE_SIZE sizeof(SUPCONTFREE)
#define SUP_IOCTL_CONT_FREE_SIZE_IN sizeof(SUPCONTFREE)
#define SUP_IOCTL_CONT_FREE_SIZE_OUT sizeof(SUPREQHDR)
typedef struct SUPCONTFREE
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** The ring-3 address of the memory to free. */
RTR3PTR pvR3;
} In;
} u;
} SUPCONTFREE, *PSUPCONTFREE;
/** @} */
/** @name SUP_IOCTL_GET_PAGING_MODE
* Get the host paging mode.
* @{
*/
#define SUP_IOCTL_GET_PAGING_MODE SUP_CTL_CODE_SIZE(18, SUP_IOCTL_GET_PAGING_MODE_SIZE)
#define SUP_IOCTL_GET_PAGING_MODE_SIZE sizeof(SUPGETPAGINGMODE)
#define SUP_IOCTL_GET_PAGING_MODE_SIZE_IN sizeof(SUPREQHDR)
#define SUP_IOCTL_GET_PAGING_MODE_SIZE_OUT sizeof(SUPGETPAGINGMODE)
typedef struct SUPGETPAGINGMODE
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** The paging mode. */
SUPPAGINGMODE enmMode;
} Out;
} u;
} SUPGETPAGINGMODE, *PSUPGETPAGINGMODE;
/** @} */
/** @name SUP_IOCTL_SET_VM_FOR_FAST
* Set the VM handle for doing fast call ioctl calls.
* @{
*/
#define SUP_IOCTL_SET_VM_FOR_FAST SUP_CTL_CODE_SIZE(19, SUP_IOCTL_SET_VM_FOR_FAST_SIZE)
#define SUP_IOCTL_SET_VM_FOR_FAST_SIZE sizeof(SUPSETVMFORFAST)
#define SUP_IOCTL_SET_VM_FOR_FAST_SIZE_IN sizeof(SUPSETVMFORFAST)
#define SUP_IOCTL_SET_VM_FOR_FAST_SIZE_OUT sizeof(SUPREQHDR)
typedef struct SUPSETVMFORFAST
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** The ring-0 VM handle (pointer). */
PVMR0 pVMR0;
} In;
} u;
} SUPSETVMFORFAST, *PSUPSETVMFORFAST;
/** @} */
/** @name SUP_IOCTL_GIP_MAP
* Map the GIP into user space.
* @{
*/
#define SUP_IOCTL_GIP_MAP SUP_CTL_CODE_SIZE(20, SUP_IOCTL_GIP_MAP_SIZE)
#define SUP_IOCTL_GIP_MAP_SIZE sizeof(SUPGIPMAP)
#define SUP_IOCTL_GIP_MAP_SIZE_IN sizeof(SUPREQHDR)
#define SUP_IOCTL_GIP_MAP_SIZE_OUT sizeof(SUPGIPMAP)
typedef struct SUPGIPMAP
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** The physical address of the GIP. */
RTHCPHYS HCPhysGip;
/** Pointer to the read-only usermode GIP mapping for this session. */
R3PTRTYPE(PSUPGLOBALINFOPAGE) pGipR3;
/** Pointer to the supervisor mode GIP mapping. */
R0PTRTYPE(PSUPGLOBALINFOPAGE) pGipR0;
} Out;
} u;
} SUPGIPMAP, *PSUPGIPMAP;
/** @} */
/** @name SUP_IOCTL_GIP_UNMAP
* Unmap the GIP.
* @{
*/
#define SUP_IOCTL_GIP_UNMAP SUP_CTL_CODE_SIZE(21, SUP_IOCTL_GIP_UNMAP_SIZE)
#define SUP_IOCTL_GIP_UNMAP_SIZE sizeof(SUPGIPUNMAP)
#define SUP_IOCTL_GIP_UNMAP_SIZE_IN sizeof(SUPGIPUNMAP)
#define SUP_IOCTL_GIP_UNMAP_SIZE_OUT sizeof(SUPGIPUNMAP)
typedef struct SUPGIPUNMAP
{
/** The header. */
SUPREQHDR Hdr;
} SUPGIPUNMAP, *PSUPGIPUNMAP;
/** @} */
/** @name SUP_IOCTL_CALL_SERVICE
* Call the a ring-0 service.
*
* @todo Might have to convert this to a big request, just like
* SUP_IOCTL_CALL_VMMR0
* @{
*/
#define SUP_IOCTL_CALL_SERVICE(cbReq) SUP_CTL_CODE_SIZE(22, SUP_IOCTL_CALL_SERVICE_SIZE(cbReq))
#define SUP_IOCTL_CALL_SERVICE_SIZE(cbReq) RT_UOFFSETOF(SUPCALLSERVICE, abReqPkt[cbReq])
#define SUP_IOCTL_CALL_SERVICE_SIZE_IN(cbReq) SUP_IOCTL_CALL_SERVICE_SIZE(cbReq)
#define SUP_IOCTL_CALL_SERVICE_SIZE_OUT(cbReq) SUP_IOCTL_CALL_SERVICE_SIZE(cbReq)
typedef struct SUPCALLSERVICE
{
/** The header. */
SUPREQHDR Hdr;
union
{
struct
{
/** The service name. */