sup.h@ 93593

Last change on this file since 93593 was 93115, checked in by vboxsync, 3 years ago
scm --update-copyright-year
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 102.6 KB

Line
1	/** @file
2	* SUP - Support Library. (HDrv)
3	*/
4
5	/*
6	* Copyright (C) 2006-2022 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef VBOX_INCLUDED_sup_h
27	#define VBOX_INCLUDED_sup_h
28	#ifndef RT_WITHOUT_PRAGMA_ONCE
29	# pragma once
30	#endif
31
32	#include <VBox/cdefs.h>
33	#include <VBox/types.h>
34	#include <iprt/assert.h>
35	#include <iprt/stdarg.h>
36	#include <iprt/cpuset.h>
37	#if defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_X86)
38	# include <iprt/asm-amd64-x86.h>
39	#endif
40
41	RT_C_DECLS_BEGIN
42
43	struct VTGOBJHDR;
44	struct VTGPROBELOC;
45
46
47	/** @defgroup grp_sup The Support Library API
48	* @{
49	*/
50
51	/**
52	* Physical page descriptor.
53	*/
54	#pragma pack(4) /* space is more important. */
55	typedef struct SUPPAGE
56	{
57	/** Physical memory address. */
58	RTHCPHYS Phys;
59	/** Reserved entry for internal use by the caller. */
60	RTHCUINTPTR uReserved;
61	} SUPPAGE;
62	#pragma pack()
63	/** Pointer to a page descriptor. */
64	typedef SUPPAGE *PSUPPAGE;
65	/** Pointer to a const page descriptor. */
66	typedef const SUPPAGE *PCSUPPAGE;
67
68	/**
69	* The paging mode.
70	*
71	* @remarks Users are making assumptions about the order here!
72	*/
73	typedef enum SUPPAGINGMODE
74	{
75	/** The usual invalid entry.
76	* This is returned by SUPR3GetPagingMode() */
77	SUPPAGINGMODE_INVALID = 0,
78	/** Normal 32-bit paging, no global pages */
79	SUPPAGINGMODE_32_BIT,
80	/** Normal 32-bit paging with global pages. */
81	SUPPAGINGMODE_32_BIT_GLOBAL,
82	/** PAE mode, no global pages, no NX. */
83	SUPPAGINGMODE_PAE,
84	/** PAE mode with global pages. */
85	SUPPAGINGMODE_PAE_GLOBAL,
86	/** PAE mode with NX, no global pages. */
87	SUPPAGINGMODE_PAE_NX,
88	/** PAE mode with global pages and NX. */
89	SUPPAGINGMODE_PAE_GLOBAL_NX,
90	/** AMD64 mode, no global pages. */
91	SUPPAGINGMODE_AMD64,
92	/** AMD64 mode with global pages, no NX. */
93	SUPPAGINGMODE_AMD64_GLOBAL,
94	/** AMD64 mode with NX, no global pages. */
95	SUPPAGINGMODE_AMD64_NX,
96	/** AMD64 mode with global pages and NX. */
97	SUPPAGINGMODE_AMD64_GLOBAL_NX
98	} SUPPAGINGMODE;
99
100
101	/** @name Flags returned by SUPR0GetKernelFeatures().
102	* @{
103	*/
104	/** GDT is read-only. */
105	#define SUPKERNELFEATURES_GDT_READ_ONLY RT_BIT(0)
106	/** SMAP is possibly enabled. */
107	#define SUPKERNELFEATURES_SMAP RT_BIT(1)
108	/** GDT is read-only but the writable GDT can be fetched by SUPR0GetCurrentGdtRw(). */
109	#define SUPKERNELFEATURES_GDT_NEED_WRITABLE RT_BIT(2)
110	/** @} */
111
112	/**
113	* An VT-x control MSR.
114	* @sa VMXCTLSMSR.
115	*/
116	typedef union SUPVMXCTLSMSR
117	{
118	uint64_t u;
119	struct
120	{
121	/** Bits set here _must_ be set in the corresponding VM-execution controls. */
122	uint32_t allowed0;
123	/** Bits cleared here _must_ be cleared in the corresponding VM-execution controls. */
124	uint32_t allowed1;
125	} n;
126	} SUPVMXCTLSMSR;
127	AssertCompileSize(SUPVMXCTLSMSR, sizeof(uint64_t));
128
129	/**
130	* Hardware-virtualization MSRs.
131	*/
132	typedef struct SUPHWVIRTMSRS
133	{
134	union
135	{
136	/** @sa VMXMSRS */
137	struct
138	{
139	uint64_t u64FeatCtrl;
140	uint64_t u64Basic;
141	/** Pin-based VM-execution controls. */
142	SUPVMXCTLSMSR PinCtls;
143	/** Processor-based VM-execution controls. */
144	SUPVMXCTLSMSR ProcCtls;
145	/** Secondary processor-based VM-execution controls. */
146	SUPVMXCTLSMSR ProcCtls2;
147	/** VM-exit controls. */
148	SUPVMXCTLSMSR ExitCtls;
149	/** VM-entry controls. */
150	SUPVMXCTLSMSR EntryCtls;
151	/** True pin-based VM-execution controls. */
152	SUPVMXCTLSMSR TruePinCtls;
153	/** True processor-based VM-execution controls. */
154	SUPVMXCTLSMSR TrueProcCtls;
155	/** True VM-entry controls. */
156	SUPVMXCTLSMSR TrueEntryCtls;
157	/** True VM-exit controls. */
158	SUPVMXCTLSMSR TrueExitCtls;
159	uint64_t u64Misc;
160	uint64_t u64Cr0Fixed0;
161	uint64_t u64Cr0Fixed1;
162	uint64_t u64Cr4Fixed0;
163	uint64_t u64Cr4Fixed1;
164	uint64_t u64VmcsEnum;
165	uint64_t u64VmFunc;
166	uint64_t u64EptVpidCaps;
167	uint64_t u64ProcCtls3;
168	uint64_t au64Reserved[8];
169	} vmx;
170	struct
171	{
172	uint64_t u64MsrHwcr;
173	uint64_t u64MsrSmmAddr;
174	uint64_t u64MsrSmmMask;
175	uint64_t u64Padding[25];
176	} svm;
177	} u;
178	} SUPHWVIRTMSRS;
179	AssertCompileSize(SUPHWVIRTMSRS, 224);
180	/** Pointer to a hardware-virtualization MSRs struct. */
181	typedef SUPHWVIRTMSRS *PSUPHWVIRTMSRS;
182	/** Pointer to a hardware-virtualization MSRs struct. */
183	typedef const SUPHWVIRTMSRS *PCSUPHWVIRTMSRS;
184
185
186	/**
187	* Usermode probe context information.
188	*/
189	typedef struct SUPDRVTRACERUSRCTX
190	{
191	/** The probe ID from the VTG location record. */
192	uint32_t idProbe;
193	/** 32 if X86, 64 if AMD64. */
194	uint8_t cBits;
195	/** Reserved padding. */
196	uint8_t abReserved[3];
197	/** Data which format is dictated by the cBits member. */
198	union
199	{
200	/** X86 context info. */
201	struct
202	{
203	uint32_t uVtgProbeLoc; /*< Location record address. /
204	uint32_t aArgs[20]; /*< Raw arguments. /
205	uint32_t eip;
206	uint32_t eflags;
207	uint32_t eax;
208	uint32_t ecx;
209	uint32_t edx;
210	uint32_t ebx;
211	uint32_t esp;
212	uint32_t ebp;
213	uint32_t esi;
214	uint32_t edi;
215	uint16_t cs;
216	uint16_t ss;
217	uint16_t ds;
218	uint16_t es;
219	uint16_t fs;
220	uint16_t gs;
221	} X86;
222
223	/** AMD64 context info. */
224	struct
225	{
226	uint64_t uVtgProbeLoc; /*< Location record address. /
227	uint64_t aArgs[10]; /*< Raw arguments. /
228	uint64_t rip;
229	uint64_t rflags;
230	uint64_t rax;
231	uint64_t rcx;
232	uint64_t rdx;
233	uint64_t rbx;
234	uint64_t rsp;
235	uint64_t rbp;
236	uint64_t rsi;
237	uint64_t rdi;
238	uint64_t r8;
239	uint64_t r9;
240	uint64_t r10;
241	uint64_t r11;
242	uint64_t r12;
243	uint64_t r13;
244	uint64_t r14;
245	uint64_t r15;
246	} Amd64;
247	} u;
248	} SUPDRVTRACERUSRCTX;
249	/** Pointer to the usermode probe context information. */
250	typedef SUPDRVTRACERUSRCTX *PSUPDRVTRACERUSRCTX;
251	/** Pointer to the const usermode probe context information. */
252	typedef SUPDRVTRACERUSRCTX const *PCSUPDRVTRACERUSRCTX;
253
254	/**
255	* The result of a modification operation (SUPMSRPROBEROP_MODIFY or
256	* SUPMSRPROBEROP_MODIFY_FASTER).
257	*/
258	typedef struct SUPMSRPROBERMODIFYRESULT
259	{
260	/** The MSR value prior to the modifications. Valid if fBeforeGp is false */
261	uint64_t uBefore;
262	/** The value that was written. Valid if fBeforeGp is false */
263	uint64_t uWritten;
264	/** The MSR value after the modifications. Valid if AfterGp is false. */
265	uint64_t uAfter;
266	/** Set if we GPed reading the MSR before the modification. */
267	bool fBeforeGp;
268	/** Set if we GPed while trying to write the modified value.
269	* This is set when fBeforeGp is true. */
270	bool fModifyGp;
271	/** Set if we GPed while trying to read the MSR after the modification.
272	* This is set when fBeforeGp is true. */
273	bool fAfterGp;
274	/** Set if we GPed while trying to restore the MSR after the modification.
275	* This is set when fBeforeGp is true. */
276	bool fRestoreGp;
277	/** Structure size alignment padding. */
278	bool afReserved[4];
279	} SUPMSRPROBERMODIFYRESULT, *PSUPMSRPROBERMODIFYRESULT;
280
281
282	/**
283	* The CPU state.
284	*/
285	typedef enum SUPGIPCPUSTATE
286	{
287	/** Invalid CPU state / unused CPU entry. */
288	SUPGIPCPUSTATE_INVALID = 0,
289	/** The CPU is not present. */
290	SUPGIPCPUSTATE_ABSENT,
291	/** The CPU is offline. */
292	SUPGIPCPUSTATE_OFFLINE,
293	/** The CPU is online. */
294	SUPGIPCPUSTATE_ONLINE,
295	/** Force 32-bit enum type. */
296	SUPGIPCPUSTATE_32_BIT_HACK = 0x7fffffff
297	} SUPGIPCPUSTATE;
298
299	/**
300	* Per CPU data.
301	*/
302	typedef struct SUPGIPCPU
303	{
304	/** Update transaction number.
305	* This number is incremented at the start and end of each update. It follows
306	* thusly that odd numbers indicates update in progress, while even numbers
307	* indicate stable data. Use this to make sure that the data items you fetch
308	* are consistent. */
309	volatile uint32_t u32TransactionId;
310	/** The interval in TSC ticks between two NanoTS updates.
311	* This is the average interval over the last 2, 4 or 8 updates + a little slack.
312	* The slack makes the time go a tiny tiny bit slower and extends the interval enough
313	* to avoid ending up with too many 1ns increments. */
314	volatile uint32_t u32UpdateIntervalTSC;
315	/** Current nanosecond timestamp. */
316	volatile uint64_t u64NanoTS;
317	/** The TSC at the time of u64NanoTS. */
318	volatile uint64_t u64TSC;
319	/** Current CPU Frequency. */
320	volatile uint64_t u64CpuHz;
321	/** The TSC delta with reference to the master TSC, subtract from RDTSC. */
322	volatile int64_t i64TSCDelta;
323	/** Number of errors during updating.
324	* Typical errors are under/overflows. */
325	volatile uint32_t cErrors;
326	/** Index of the head item in au32TSCHistory. */
327	volatile uint32_t iTSCHistoryHead;
328	/** Array of recent TSC interval deltas.
329	* The most recent item is at index iTSCHistoryHead.
330	* This history is used to calculate u32UpdateIntervalTSC.
331	*/
332	volatile uint32_t au32TSCHistory[8];
333	/** The interval between the last two NanoTS updates. (experiment for now) */
334	volatile uint32_t u32PrevUpdateIntervalNS;
335
336	/** Reserved for future per processor data. */
337	volatile uint32_t u32Reserved;
338	/** The TSC value read while doing TSC delta measurements across CPUs. */
339	volatile uint64_t u64TSCSample;
340	/** Reserved for future per processor data. */
341	volatile uint32_t au32Reserved1[3];
342
343	/** The CPU state. */
344	SUPGIPCPUSTATE volatile enmState;
345	/** The host CPU ID of this CPU (the SUPGIPCPU is indexed by APIC ID). */
346	RTCPUID idCpu;
347	/** The CPU set index of this CPU. */
348	int16_t iCpuSet;
349	/** CPU group number (always zero, except on windows). */
350	uint16_t iCpuGroup;
351	/** CPU group member number (same as iCpuSet, except on windows). */
352	uint16_t iCpuGroupMember;
353	/** The APIC ID of this CPU. */
354	uint16_t idApic;
355	/** @todo Add topology/NUMA info. */
356	uint32_t iReservedForNumaNode;
357	} SUPGIPCPU;
358	AssertCompileSize(RTCPUID, 4);
359	AssertCompileSize(SUPGIPCPU, 128);
360	AssertCompileMemberAlignment(SUPGIPCPU, u64NanoTS, 8);
361	AssertCompileMemberAlignment(SUPGIPCPU, u64TSC, 8);
362	AssertCompileMemberAlignment(SUPGIPCPU, u64TSCSample, 8);
363
364	/** Pointer to per cpu data.
365	* @remark there is no const version of this typedef, see g_pSUPGlobalInfoPage for details. */
366	typedef SUPGIPCPU *PSUPGIPCPU;
367
368	/**
369	* CPU group information.
370	* @remarks Windows only.
371	*/
372	typedef struct SUPGIPCPUGROUP
373	{
374	/** Current number of CPUs in this group. */
375	uint16_t volatile cMembers;
376	/** Maximum number of CPUs in the group. */
377	uint16_t cMaxMembers;
378	/** The CPU set index of the members. This table has cMaxMembers entries.
379	* @note For various reasons, entries from cMembers and up to cMaxMembers are
380	* may change as the host OS does set dynamic assignments during CPU
381	* hotplugging. */
382	int16_t aiCpuSetIdxs[1];
383	} SUPGIPCPUGROUP;
384	/** Pointer to a GIP CPU group structure. */
385	typedef SUPGIPCPUGROUP *PSUPGIPCPUGROUP;
386	/** Pointer to a const GIP CPU group structure. */
387	typedef SUPGIPCPUGROUP const *PCSUPGIPCPUGROUP;
388
389	/**
390	* The rules concerning the applicability of SUPGIPCPU::i64TscDelta.
391	*/
392	typedef enum SUPGIPUSETSCDELTA
393	{
394	/** Value for SUPGIPMODE_ASYNC_TSC. */
395	SUPGIPUSETSCDELTA_NOT_APPLICABLE = 0,
396	/** The OS specific part of SUPDrv (or the user) claims the TSC is as
397	* good as zero. */
398	SUPGIPUSETSCDELTA_ZERO_CLAIMED,
399	/** The differences in RDTSC output between the CPUs/cores/threads should
400	* be considered zero for all practical purposes. */
401	SUPGIPUSETSCDELTA_PRACTICALLY_ZERO,
402	/** The differences in RDTSC output between the CPUs/cores/threads are a few
403	* hundred ticks or less. (Probably not worth calling ASMGetApicId two times
404	* just to apply deltas.) */
405	SUPGIPUSETSCDELTA_ROUGHLY_ZERO,
406	/** Significant differences in RDTSC output between the CPUs/cores/threads,
407	* deltas must be applied. */
408	SUPGIPUSETSCDELTA_NOT_ZERO,
409	/** End of valid values (exclusive). */
410	SUPGIPUSETSCDELTA_END,
411	/** Make sure the type is 32-bit sized. */
412	SUPGIPUSETSCDELTA_32BIT_HACK = 0x7fffffff
413	} SUPGIPUSETSCDELTA;
414
415
416	/** @name SUPGIPGETCPU_XXX - methods that aCPUs can be indexed.
417	*
418	* @note Linux offers information via selector 0x78, and Windows via selector
419	* 0x53. But since they both support RDTSCP as well, and because most
420	* CPUs now have RDTSCP, we prefer it over LSL. We can implement more
421	* alternatives if it becomes necessary.
422	*
423	* @{
424	*/
425	/** Use ASMGetApicId (or equivalent) and translate the result via
426	* aiCpuFromApicId. */
427	#define SUPGIPGETCPU_APIC_ID RT_BIT_32(0)
428	/** Use RDTSCP and translate the first RTCPUSET_MAX_CPUS of ECX via
429	* aiCpuFromCpuSetIdx.
430	*
431	* Linux stores the RTMpCpuId() value in ECX[11:0] and NUMA node number in
432	* ECX[12:31]. Solaris only stores RTMpCpuId() in ECX. On both systems
433	* RTMpCpuId() == RTMpCpuIdToSetIndex(RTMpCpuId()). RTCPUSET_MAX_CPUS is
434	* currently 64, 256 or 1024 in size, which lower than
435	* 4096, so there shouldn't be any range issues. */
436	#define SUPGIPGETCPU_RDTSCP_MASK_MAX_SET_CPUS RT_BIT_32(1)
437	/** Subtract the max IDT size from IDTR.LIMIT, extract the
438	* first RTCPUSET_MAX_CPUS and translate it via aiCpuFromCpuSetIdx.
439	*
440	* Darwin stores the RTMpCpuId() (== RTMpCpuIdToSetIndex(RTMpCpuId()))
441	* value in the IDT limit. The masking is a precaution against what linux
442	* does with RDTSCP. */
443	#define SUPGIPGETCPU_IDTR_LIMIT_MASK_MAX_SET_CPUS RT_BIT_32(2)
444	/** Windows specific RDTSCP variant, where CH gives you the group and CL gives
445	* you the CPU number within that group.
446	*
447	* Use SUPGLOBALINFOPAGE::aidFirstCpuFromCpuGroup to get the group base CPU set
448	* index, then translate the sum of thru aiCpuFromCpuSetIdx to find the aCPUs
449	* entry.
450	*
451	* @note The group number is actually 16-bit wide (ECX[23:8]), but we simplify
452	* it since we only support 256 CPUs/groups at the moment.
453	*/
454	#define SUPGIPGETCPU_RDTSCP_GROUP_IN_CH_NUMBER_IN_CL RT_BIT_32(3)
455	/** Can use CPUID[0xb].EDX and translate the result via aiCpuFromApicId. */
456	#define SUPGIPGETCPU_APIC_ID_EXT_0B RT_BIT_32(4)
457	/** Can use CPUID[0x8000001e].EAX and translate the result via aiCpuFromApicId. */
458	#define SUPGIPGETCPU_APIC_ID_EXT_8000001E RT_BIT_32(5)
459	/** @} */
460
461	/** @def SUPGIP_MAX_CPU_GROUPS
462	* Maximum number of CPU groups. */
463	#if RTCPUSET_MAX_CPUS >= 256
464	# define SUPGIP_MAX_CPU_GROUPS 256
465	#else
466	# define SUPGIP_MAX_CPU_GROUPS RTCPUSET_MAX_CPUS
467	#endif
468
469	/**
470	* Global Information Page.
471	*
472	* This page contains useful information and can be mapped into any
473	* process or VM. It can be accessed thru the g_pSUPGlobalInfoPage
474	* pointer when a session is open.
475	*/
476	typedef struct SUPGLOBALINFOPAGE
477	{
478	/** Magic (SUPGLOBALINFOPAGE_MAGIC). */
479	uint32_t u32Magic;
480	/** The GIP version. */
481	uint32_t u32Version;
482
483	/** The GIP update mode, see SUPGIPMODE. */
484	uint32_t u32Mode;
485	/** The number of entries in the CPU table.
486	* (This can work as RTMpGetArraySize().) */
487	uint16_t cCpus;
488	/** The size of the GIP in pages. */
489	uint16_t cPages;
490	/** The update frequency of the of the NanoTS. */
491	volatile uint32_t u32UpdateHz;
492	/** The update interval in nanoseconds. (10^9 / u32UpdateHz) */
493	volatile uint32_t u32UpdateIntervalNS;
494	/** The timestamp of the last time we update the update frequency. */
495	volatile uint64_t u64NanoTSLastUpdateHz;
496	/** The TSC frequency of the system. */
497	uint64_t u64CpuHz;
498	/** The number of CPUs that are online. */
499	volatile uint16_t cOnlineCpus;
500	/** The number of CPUs present in the system. */
501	volatile uint16_t cPresentCpus;
502	/** The highest number of CPUs possible. */
503	uint16_t cPossibleCpus;
504	/** The highest number of CPU groups possible. */
505	uint16_t cPossibleCpuGroups;
506	/** The max CPU ID (RTMpGetMaxCpuId). */
507	RTCPUID idCpuMax;
508	/** The applicability of SUPGIPCPU::i64TscDelta. */
509	SUPGIPUSETSCDELTA enmUseTscDelta;
510	/** Mask of SUPGIPGETCPU_XXX values that indicates different ways that aCPU
511	* can be accessed from ring-3 and raw-mode context. */
512	uint32_t fGetGipCpu;
513	/** GIP flags, see SUPGIP_FLAGS_XXX. */
514	volatile uint32_t fFlags;
515	/** The set of online CPUs. */
516	RTCPUSET OnlineCpuSet;
517	#if RTCPUSET_MAX_CPUS < 1024
518	uint64_t abOnlineCpuSetPadding[(1024 - RTCPUSET_MAX_CPUS) / 64];
519	#endif
520	/** The set of present CPUs. */
521	RTCPUSET PresentCpuSet;
522	#if RTCPUSET_MAX_CPUS < 1024
523	uint64_t abPresentCpuSetPadding[(1024 - RTCPUSET_MAX_CPUS) / 64];
524	#endif
525	/** The set of possible CPUs. */
526	RTCPUSET PossibleCpuSet;
527	#if RTCPUSET_MAX_CPUS < 1024
528	uint64_t abPossibleCpuSetPadding[(1024 - RTCPUSET_MAX_CPUS) / 64];
529	#endif
530
531	/** Padding / reserved space for future data. */
532	uint32_t au32Padding1[48];
533
534	/** Table indexed by the CPU APIC ID to get the CPU table index. */
535	uint16_t aiCpuFromApicId[4096];
536	/** CPU set index to CPU table index. */
537	uint16_t aiCpuFromCpuSetIdx[1024];
538	/** Table indexed by CPU group to containing offsets to SUPGIPCPUGROUP
539	* structures, invalid entries are set to UINT32_MAX. The offsets are relative
540	* to the start of this structure.
541	* @note Windows only. The other hosts sets all entries to UINT32_MAX! */
542	uint32_t aoffCpuGroup[SUPGIP_MAX_CPU_GROUPS];
543
544	/** Array of per-cpu data.
545	* This is index by ApicId via the aiCpuFromApicId table.
546	*
547	* The clock and frequency information is updated for all CPUs if @c u32Mode
548	* is SUPGIPMODE_ASYNC_TSC. If @c u32Mode is SUPGIPMODE_SYNC_TSC only the first
549	* entry is updated. If @c u32Mode is SUPGIPMODE_SYNC_TSC the TSC frequency in
550	* @c u64CpuHz is copied to all CPUs. */
551	SUPGIPCPU aCPUs[1];
552	} SUPGLOBALINFOPAGE;
553	AssertCompileMemberAlignment(SUPGLOBALINFOPAGE, u64NanoTSLastUpdateHz, 8);
554	AssertCompileMemberAlignment(SUPGLOBALINFOPAGE, OnlineCpuSet, 64);
555	AssertCompileMemberAlignment(SUPGLOBALINFOPAGE, PresentCpuSet, 64);
556	AssertCompileMemberAlignment(SUPGLOBALINFOPAGE, PossibleCpuSet, 64);
557	#if defined(RT_ARCH_SPARC) \|\| defined(RT_ARCH_SPARC64) /* ?? needed ?? */
558	AssertCompileMemberAlignment(SUPGLOBALINFOPAGE, aCPUs, 32);
559	#else
560	AssertCompileMemberAlignment(SUPGLOBALINFOPAGE, aCPUs, 128);
561	#endif
562
563	/** Pointer to the global info page.
564	* @remark there is no const version of this typedef, see g_pSUPGlobalInfoPage for details. */
565	typedef SUPGLOBALINFOPAGE *PSUPGLOBALINFOPAGE;
566
567
568	/** The value of the SUPGLOBALINFOPAGE::u32Magic field. (Soryo Fuyumi) */
569	#define SUPGLOBALINFOPAGE_MAGIC 0x19590106
570	/** The GIP version.
571	* Upper 16 bits is the major version. Major version is only changed with
572	* incompatible changes in the GIP. */
573	#define SUPGLOBALINFOPAGE_VERSION 0x000a0000
574
575	/**
576	* SUPGLOBALINFOPAGE::u32Mode values.
577	*/
578	typedef enum SUPGIPMODE
579	{
580	/** The usual invalid null entry. */
581	SUPGIPMODE_INVALID = 0,
582	/** The TSC of the cores and cpus in the system is in sync. */
583	SUPGIPMODE_SYNC_TSC,
584	/** Each core has it's own TSC. */
585	SUPGIPMODE_ASYNC_TSC,
586	/** The TSC of the cores are non-stop and have a constant frequency. */
587	SUPGIPMODE_INVARIANT_TSC,
588	/** End of valid GIP mode values (exclusive). */
589	SUPGIPMODE_END,
590	/** The usual 32-bit hack. */
591	SUPGIPMODE_32BIT_HACK = 0x7fffffff
592	} SUPGIPMODE;
593
594	/** Pointer to the Global Information Page.
595	*
596	* This pointer is valid as long as SUPLib has a open session. Anyone using
597	* the page must treat this pointer as highly volatile and not trust it beyond
598	* one transaction.
599	*
600	* @remark The GIP page is read-only to everyone but the support driver and
601	* is actually mapped read only everywhere but in ring-0. However
602	* it is not marked 'const' as this might confuse compilers into
603	* thinking that values doesn't change even if members are marked
604	* as volatile. Thus, there is no PCSUPGLOBALINFOPAGE type.
605	*/
606	#if defined(IN_SUP_R3) \|\| defined(IN_SUP_R0)
607	extern DECLEXPORT(PSUPGLOBALINFOPAGE) g_pSUPGlobalInfoPage;
608
609	#elif !defined(IN_RING0) \|\| defined(RT_OS_WINDOWS) \|\| defined(RT_OS_SOLARIS) \|\| defined(VBOX_WITH_KMOD_WRAPPED_R0_MODS)
610	extern DECLIMPORT(PSUPGLOBALINFOPAGE) g_pSUPGlobalInfoPage;
611
612	#else /* IN_RING0 && !RT_OS_WINDOWS */
613	# if !defined(__GNUC__) \|\| defined(RT_OS_DARWIN) \|\| !defined(RT_ARCH_AMD64)
614	# define g_pSUPGlobalInfoPage (&g_SUPGlobalInfoPage)
615	# else
616	# define g_pSUPGlobalInfoPage (SUPGetGIPHlp())
617	/** Workaround for ELF+GCC problem on 64-bit hosts.
618	* (GCC emits a mov with a R_X86_64_32 reloc, we need R_X86_64_64.) */
619	DECLINLINE(PSUPGLOBALINFOPAGE) SUPGetGIPHlp(void)
620	{
621	PSUPGLOBALINFOPAGE pGIP;
622	__asm__ __volatile__ ("movabs $g_SUPGlobalInfoPage,%0\n\t"
623	: "=a" (pGIP));
624	return pGIP;
625	}
626	# endif
627	/** The GIP.
628	* We save a level of indirection by exporting the GIP instead of a variable
629	* pointing to it. */
630	extern DECLIMPORT(SUPGLOBALINFOPAGE) g_SUPGlobalInfoPage;
631	#endif
632
633	/**
634	* Gets the GIP pointer.
635	*
636	* @returns Pointer to the GIP or NULL.
637	*/
638	SUPDECL(PSUPGLOBALINFOPAGE) SUPGetGIP(void);
639
640	/** @name SUPGIP_FLAGS_XXX - SUPR3GipSetFlags flags.
641	* @{ */
642	/** Enable GIP test mode. */
643	#define SUPGIP_FLAGS_TESTING_ENABLE RT_BIT_32(0)
644	/** Valid mask of flags that can be set through the ioctl. */
645	#define SUPGIP_FLAGS_VALID_MASK RT_BIT_32(0)
646	/** GIP test mode needs to be checked (e.g. when enabled or being disabled). */
647	#define SUPGIP_FLAGS_TESTING RT_BIT_32(24)
648	/** Prepare to start GIP test mode. */
649	#define SUPGIP_FLAGS_TESTING_START RT_BIT_32(25)
650	/** Prepare to stop GIP test mode. */
651	#define SUPGIP_FLAGS_TESTING_STOP RT_BIT_32(26)
652	/** @} */
653
654	/** @internal */
655	SUPDECL(PSUPGIPCPU) SUPGetGipCpuPtrForAsyncMode(PSUPGLOBALINFOPAGE pGip);
656	SUPDECL(uint64_t) SUPGetCpuHzFromGipForAsyncMode(PSUPGLOBALINFOPAGE pGip);
657	SUPDECL(bool) SUPIsTscFreqCompatible(uint64_t uCpuHz, uint64_t *puGipCpuHz, bool fRelax);
658	SUPDECL(bool) SUPIsTscFreqCompatibleEx(uint64_t uBaseCpuHz, uint64_t uCpuHz, bool fRelax);
659
660
661	/**
662	* Gets CPU entry of the calling CPU.
663	*
664	* @returns Pointer to the CPU entry on success, NULL on failure.
665	* @param pGip The GIP pointer.
666	*/
667	DECLINLINE(PSUPGIPCPU) SUPGetGipCpuPtr(PSUPGLOBALINFOPAGE pGip)
668	{
669	if (RT_LIKELY( pGip
670	&& pGip->u32Magic == SUPGLOBALINFOPAGE_MAGIC))
671	{
672	switch (pGip->u32Mode)
673	{
674	case SUPGIPMODE_INVARIANT_TSC:
675	case SUPGIPMODE_SYNC_TSC:
676	return &pGip->aCPUs[0];
677	case SUPGIPMODE_ASYNC_TSC:
678	return SUPGetGipCpuPtrForAsyncMode(pGip);
679	default: break; /* shut up gcc */
680	}
681	}
682	AssertFailed();
683	return NULL;
684	}
685
686	/**
687	* Gets the TSC frequency of the calling CPU.
688	*
689	* @returns TSC frequency, UINT64_MAX on failure (asserted).
690	* @param pGip The GIP pointer.
691	*/
692	DECLINLINE(uint64_t) SUPGetCpuHzFromGip(PSUPGLOBALINFOPAGE pGip)
693	{
694	if (RT_LIKELY( pGip
695	&& pGip->u32Magic == SUPGLOBALINFOPAGE_MAGIC))
696	{
697	switch (pGip->u32Mode)
698	{
699	case SUPGIPMODE_INVARIANT_TSC:
700	case SUPGIPMODE_SYNC_TSC:
701	return pGip->aCPUs[0].u64CpuHz;
702	case SUPGIPMODE_ASYNC_TSC:
703	return SUPGetCpuHzFromGipForAsyncMode(pGip);
704	default: break; /* shut up gcc */
705	}
706	}
707	AssertFailed();
708	return UINT64_MAX;
709	}
710
711
712	/**
713	* Gets the TSC frequency of the specified CPU.
714	*
715	* @returns TSC frequency, UINT64_MAX on failure (asserted).
716	* @param pGip The GIP pointer.
717	* @param iCpuSet The CPU set index of the CPU in question.
718	*/
719	DECLINLINE(uint64_t) SUPGetCpuHzFromGipBySetIndex(PSUPGLOBALINFOPAGE pGip, uint32_t iCpuSet)
720	{
721	if (RT_LIKELY( pGip
722	&& pGip->u32Magic == SUPGLOBALINFOPAGE_MAGIC))
723	{
724	switch (pGip->u32Mode)
725	{
726	case SUPGIPMODE_INVARIANT_TSC:
727	case SUPGIPMODE_SYNC_TSC:
728	return pGip->aCPUs[0].u64CpuHz;
729	case SUPGIPMODE_ASYNC_TSC:
730	if (RT_LIKELY(iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx)))
731	{
732	uint16_t iCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
733	if (RT_LIKELY(iCpu < pGip->cCpus))
734	return pGip->aCPUs[iCpu].u64CpuHz;
735	}
736	break;
737	default: break; /* shut up gcc */
738	}
739	}
740	AssertFailed();
741	return UINT64_MAX;
742	}
743
744
745	/**
746	* Gets the pointer to the per CPU data for a CPU given by its set index.
747	*
748	* @returns Pointer to the corresponding per CPU structure, or NULL if invalid.
749	* @param pGip The GIP pointer.
750	* @param iCpuSet The CPU set index of the CPU which we want.
751	*/
752	DECLINLINE(PSUPGIPCPU) SUPGetGipCpuBySetIndex(PSUPGLOBALINFOPAGE pGip, uint32_t iCpuSet)
753	{
754	if (RT_LIKELY( pGip
755	&& pGip->u32Magic == SUPGLOBALINFOPAGE_MAGIC))
756	{
757	if (RT_LIKELY(iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx)))
758	{
759	uint16_t iCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
760	if (RT_LIKELY(iCpu < pGip->cCpus))
761	return &pGip->aCPUs[iCpu];
762	}
763	}
764	return NULL;
765	}
766
767
768	#if defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_X86)
769
770	/** @internal */
771	SUPDECL(uint64_t) SUPReadTscWithDelta(PSUPGLOBALINFOPAGE pGip);
772
773	/**
774	* Read the host TSC value and applies the TSC delta if appropriate.
775	*
776	* @returns the TSC value.
777	* @remarks Requires GIP to be initialized and valid.
778	*/
779	DECLINLINE(uint64_t) SUPReadTsc(void)
780	{
781	PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
782	if (!pGip \|\| pGip->enmUseTscDelta <= SUPGIPUSETSCDELTA_ROUGHLY_ZERO)
783	return ASMReadTSC();
784	return SUPReadTscWithDelta(pGip);
785	}
786
787	#endif /* X86 \|\| AMD64 */
788
789	/** @internal */
790	SUPDECL(int64_t) SUPGetTscDeltaSlow(PSUPGLOBALINFOPAGE pGip);
791
792	/**
793	* Gets the TSC delta for the current CPU.
794	*
795	* @returns The TSC delta value (will not return the special INT64_MAX value).
796	* @param pGip The GIP, NULL is okay in ring-3.
797	* @remarks Requires GIP to be initialized and valid if pGip isn't NULL.
798	*/
799	DECLINLINE(int64_t) SUPGetTscDelta(PSUPGLOBALINFOPAGE pGip)
800	{
801	#ifdef IN_RING3
802	if (!pGip \|\| pGip->enmUseTscDelta <= SUPGIPUSETSCDELTA_ROUGHLY_ZERO)
803	#else
804	if (pGip->enmUseTscDelta <= SUPGIPUSETSCDELTA_ROUGHLY_ZERO)
805	#endif
806	return 0;
807	return SUPGetTscDeltaSlow(pGip);
808	}
809
810
811	/**
812	* Gets the TSC delta for a given CPU.
813	*
814	* @returns The TSC delta value (will not return the special INT64_MAX value).
815	* @param iCpuSet The CPU set index of the CPU which TSC delta we want.
816	* @remarks Requires GIP to be initialized and valid.
817	*/
818	DECLINLINE(int64_t) SUPGetTscDeltaByCpuSetIndex(uint32_t iCpuSet)
819	{
820	PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
821	if (pGip->enmUseTscDelta <= SUPGIPUSETSCDELTA_ROUGHLY_ZERO)
822	return 0;
823	if (RT_LIKELY(iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx)))
824	{
825	uint16_t iCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
826	if (RT_LIKELY(iCpu < pGip->cCpus))
827	{
828	int64_t iTscDelta = pGip->aCPUs[iCpu].i64TSCDelta;
829	if (iTscDelta != INT64_MAX)
830	return iTscDelta;
831	}
832	}
833	AssertFailed();
834	return 0;
835	}
836
837
838	/**
839	* Checks if the TSC delta is available for a given CPU (if TSC-deltas are
840	* relevant).
841	*
842	* @returns true if it's okay to read the TSC, false otherwise.
843	*
844	* @param iCpuSet The CPU set index of the CPU which TSC delta we check.
845	* @remarks Requires GIP to be initialized and valid.
846	*/
847	DECLINLINE(bool) SUPIsTscDeltaAvailableForCpuSetIndex(uint32_t iCpuSet)
848	{
849	PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
850	if (pGip->enmUseTscDelta <= SUPGIPUSETSCDELTA_ROUGHLY_ZERO)
851	return true;
852	if (RT_LIKELY(iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx)))
853	{
854	uint16_t iCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
855	if (RT_LIKELY(iCpu < pGip->cCpus))
856	{
857	int64_t iTscDelta = pGip->aCPUs[iCpu].i64TSCDelta;
858	if (iTscDelta != INT64_MAX)
859	return true;
860	}
861	}
862	return false;
863	}
864
865
866	/**
867	* Gets the descriptive GIP mode name.
868	*
869	* @returns The name.
870	* @param pGip Pointer to the GIP.
871	*/
872	DECLINLINE(const char *) SUPGetGIPModeName(PSUPGLOBALINFOPAGE pGip)
873	{
874	AssertReturn(pGip, NULL);
875	switch (pGip->u32Mode)
876	{
877	case SUPGIPMODE_INVARIANT_TSC: return "Invariant";
878	case SUPGIPMODE_SYNC_TSC: return "Synchronous";
879	case SUPGIPMODE_ASYNC_TSC: return "Asynchronous";
880	case SUPGIPMODE_INVALID: return "Invalid";
881	default: return "???";
882	}
883	}
884
885
886	/**
887	* Gets the descriptive TSC-delta enum name.
888	*
889	* @returns The name.
890	* @param pGip Pointer to the GIP.
891	*/
892	DECLINLINE(const char *) SUPGetGIPTscDeltaModeName(PSUPGLOBALINFOPAGE pGip)
893	{
894	AssertReturn(pGip, NULL);
895	switch (pGip->enmUseTscDelta)
896	{
897	case SUPGIPUSETSCDELTA_NOT_APPLICABLE: return "Not Applicable";
898	case SUPGIPUSETSCDELTA_ZERO_CLAIMED: return "Zero Claimed";
899	case SUPGIPUSETSCDELTA_PRACTICALLY_ZERO: return "Practically Zero";
900	case SUPGIPUSETSCDELTA_ROUGHLY_ZERO: return "Roughly Zero";
901	case SUPGIPUSETSCDELTA_NOT_ZERO: return "Not Zero";
902	default: return "???";
903	}
904	}
905
906
907	/**
908	* Request for generic VMMR0Entry calls.
909	*/
910	typedef struct SUPVMMR0REQHDR
911	{
912	/** The magic. (SUPVMMR0REQHDR_MAGIC) */
913	uint32_t u32Magic;
914	/** The size of the request. */
915	uint32_t cbReq;
916	} SUPVMMR0REQHDR;
917	/** Pointer to a ring-0 request header. */
918	typedef SUPVMMR0REQHDR *PSUPVMMR0REQHDR;
919	/** the SUPVMMR0REQHDR::u32Magic value (Ethan Iverson - The Bad Plus). */
920	#define SUPVMMR0REQHDR_MAGIC UINT32_C(0x19730211)
921
922
923	/** For the fast ioctl path.
924	* @{
925	*/
926	/** @see VMMR0_DO_HM_RUN. */
927	#define SUP_VMMR0_DO_HM_RUN 0
928	/** @see VMMR0_DO_NEM_RUN */
929	#define SUP_VMMR0_DO_NEM_RUN 1
930	/** @see VMMR0_DO_NOP */
931	#define SUP_VMMR0_DO_NOP 2
932	/** @} */
933
934	/** SUPR3QueryVTCaps capability flags.
935	* @{
936	*/
937	/** AMD-V support. */
938	#define SUPVTCAPS_AMD_V RT_BIT(0)
939	/** VT-x support. */
940	#define SUPVTCAPS_VT_X RT_BIT(1)
941	/** Nested paging is supported. */
942	#define SUPVTCAPS_NESTED_PAGING RT_BIT(2)
943	/** VT-x: Unrestricted guest execution is supported. */
944	#define SUPVTCAPS_VTX_UNRESTRICTED_GUEST RT_BIT(3)
945	/** VT-x: VMCS shadowing is supported. */
946	#define SUPVTCAPS_VTX_VMCS_SHADOWING RT_BIT(4)
947	/** AMD-V: Virtualized VMSAVE/VMLOAD is supported. */
948	#define SUPVTCAPS_AMDV_VIRT_VMSAVE_VMLOAD RT_BIT(5)
949	/** @} */
950
951	/**
952	* Request for generic FNSUPR0SERVICEREQHANDLER calls.
953	*/
954	typedef struct SUPR0SERVICEREQHDR
955	{
956	/** The magic. (SUPR0SERVICEREQHDR_MAGIC) */
957	uint32_t u32Magic;
958	/** The size of the request. */
959	uint32_t cbReq;
960	} SUPR0SERVICEREQHDR;
961	/** Pointer to a ring-0 service request header. */
962	typedef SUPR0SERVICEREQHDR *PSUPR0SERVICEREQHDR;
963	/** the SUPVMMR0REQHDR::u32Magic value (Esbjoern Svensson - E.S.P.). */
964	#define SUPR0SERVICEREQHDR_MAGIC UINT32_C(0x19640416)
965
966
967	/**
968	* Creates a single release event semaphore.
969	*
970	* @returns VBox status code.
971	* @param pSession The session handle of the caller.
972	* @param phEvent Where to return the handle to the event semaphore.
973	*/
974	SUPDECL(int) SUPSemEventCreate(PSUPDRVSESSION pSession, PSUPSEMEVENT phEvent);
975
976	/**
977	* Closes a single release event semaphore handle.
978	*
979	* @returns VBox status code.
980	* @retval VINF_OBJECT_DESTROYED if the semaphore was destroyed.
981	* @retval VINF_SUCCESS if the handle was successfully closed but the semaphore
982	* object remained alive because of other references.
983	*
984	* @param pSession The session handle of the caller.
985	* @param hEvent The handle. Nil is quietly ignored.
986	*/
987	SUPDECL(int) SUPSemEventClose(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent);
988
989	/**
990	* Signals a single release event semaphore.
991	*
992	* @returns VBox status code.
993	* @param pSession The session handle of the caller.
994	* @param hEvent The semaphore handle.
995	*/
996	SUPDECL(int) SUPSemEventSignal(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent);
997
998	#ifdef IN_RING0
999	/**
1000	* Waits on a single release event semaphore, not interruptible.
1001	*
1002	* @returns VBox status code.
1003	* @param pSession The session handle of the caller.
1004	* @param hEvent The semaphore handle.
1005	* @param cMillies The number of milliseconds to wait.
1006	* @remarks Not available in ring-3.
1007	*/
1008	SUPDECL(int) SUPSemEventWait(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent, uint32_t cMillies);
1009	#endif
1010
1011	/**
1012	* Waits on a single release event semaphore, interruptible.
1013	*
1014	* @returns VBox status code.
1015	* @param pSession The session handle of the caller.
1016	* @param hEvent The semaphore handle.
1017	* @param cMillies The number of milliseconds to wait.
1018	*/
1019	SUPDECL(int) SUPSemEventWaitNoResume(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent, uint32_t cMillies);
1020
1021	/**
1022	* Waits on a single release event semaphore, interruptible.
1023	*
1024	* @returns VBox status code.
1025	* @param pSession The session handle of the caller.
1026	* @param hEvent The semaphore handle.
1027	* @param uNsTimeout The deadline given on the RTTimeNanoTS() clock.
1028	*/
1029	SUPDECL(int) SUPSemEventWaitNsAbsIntr(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent, uint64_t uNsTimeout);
1030
1031	/**
1032	* Waits on a single release event semaphore, interruptible.
1033	*
1034	* @returns VBox status code.
1035	* @param pSession The session handle of the caller.
1036	* @param hEvent The semaphore handle.
1037	* @param cNsTimeout The number of nanoseconds to wait.
1038	*/
1039	SUPDECL(int) SUPSemEventWaitNsRelIntr(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent, uint64_t cNsTimeout);
1040
1041	/**
1042	* Gets the best timeout resolution that SUPSemEventWaitNsAbsIntr and
1043	* SUPSemEventWaitNsAbsIntr can do.
1044	*
1045	* @returns The resolution in nanoseconds.
1046	* @param pSession The session handle of the caller.
1047	*/
1048	SUPDECL(uint32_t) SUPSemEventGetResolution(PSUPDRVSESSION pSession);
1049
1050
1051	/**
1052	* Creates a multiple release event semaphore.
1053	*
1054	* @returns VBox status code.
1055	* @param pSession The session handle of the caller.
1056	* @param phEventMulti Where to return the handle to the event semaphore.
1057	*/
1058	SUPDECL(int) SUPSemEventMultiCreate(PSUPDRVSESSION pSession, PSUPSEMEVENTMULTI phEventMulti);
1059
1060	/**
1061	* Closes a multiple release event semaphore handle.
1062	*
1063	* @returns VBox status code.
1064	* @retval VINF_OBJECT_DESTROYED if the semaphore was destroyed.
1065	* @retval VINF_SUCCESS if the handle was successfully closed but the semaphore
1066	* object remained alive because of other references.
1067	*
1068	* @param pSession The session handle of the caller.
1069	* @param hEventMulti The handle. Nil is quietly ignored.
1070	*/
1071	SUPDECL(int) SUPSemEventMultiClose(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti);
1072
1073	/**
1074	* Signals a multiple release event semaphore.
1075	*
1076	* @returns VBox status code.
1077	* @param pSession The session handle of the caller.
1078	* @param hEventMulti The semaphore handle.
1079	*/
1080	SUPDECL(int) SUPSemEventMultiSignal(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti);
1081
1082	/**
1083	* Resets a multiple release event semaphore.
1084	*
1085	* @returns VBox status code.
1086	* @param pSession The session handle of the caller.
1087	* @param hEventMulti The semaphore handle.
1088	*/
1089	SUPDECL(int) SUPSemEventMultiReset(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti);
1090
1091	#ifdef IN_RING0
1092	/**
1093	* Waits on a multiple release event semaphore, not interruptible.
1094	*
1095	* @returns VBox status code.
1096	* @param pSession The session handle of the caller.
1097	* @param hEventMulti The semaphore handle.
1098	* @param cMillies The number of milliseconds to wait.
1099	* @remarks Not available in ring-3.
1100	*/
1101	SUPDECL(int) SUPSemEventMultiWait(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti, uint32_t cMillies);
1102	#endif
1103
1104	/**
1105	* Waits on a multiple release event semaphore, interruptible.
1106	*
1107	* @returns VBox status code.
1108	* @param pSession The session handle of the caller.
1109	* @param hEventMulti The semaphore handle.
1110	* @param cMillies The number of milliseconds to wait.
1111	*/
1112	SUPDECL(int) SUPSemEventMultiWaitNoResume(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti, uint32_t cMillies);
1113
1114	/**
1115	* Waits on a multiple release event semaphore, interruptible.
1116	*
1117	* @returns VBox status code.
1118	* @param pSession The session handle of the caller.
1119	* @param hEventMulti The semaphore handle.
1120	* @param uNsTimeout The deadline given on the RTTimeNanoTS() clock.
1121	*/
1122	SUPDECL(int) SUPSemEventMultiWaitNsAbsIntr(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti, uint64_t uNsTimeout);
1123
1124	/**
1125	* Waits on a multiple release event semaphore, interruptible.
1126	*
1127	* @returns VBox status code.
1128	* @param pSession The session handle of the caller.
1129	* @param hEventMulti The semaphore handle.
1130	* @param cNsTimeout The number of nanoseconds to wait.
1131	*/
1132	SUPDECL(int) SUPSemEventMultiWaitNsRelIntr(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti, uint64_t cNsTimeout);
1133
1134	/**
1135	* Gets the best timeout resolution that SUPSemEventMultiWaitNsAbsIntr and
1136	* SUPSemEventMultiWaitNsRelIntr can do.
1137	*
1138	* @returns The resolution in nanoseconds.
1139	* @param pSession The session handle of the caller.
1140	*/
1141	SUPDECL(uint32_t) SUPSemEventMultiGetResolution(PSUPDRVSESSION pSession);
1142
1143
1144	#ifdef IN_RING3
1145
1146	/** @defgroup grp_sup_r3 SUP Host Context Ring-3 API
1147	* @{
1148	*/
1149
1150	/**
1151	* Installs the support library.
1152	*
1153	* @returns VBox status code.
1154	*/
1155	SUPR3DECL(int) SUPR3Install(void);
1156
1157	/**
1158	* Uninstalls the support library.
1159	*
1160	* @returns VBox status code.
1161	*/
1162	SUPR3DECL(int) SUPR3Uninstall(void);
1163
1164	/**
1165	* Trusted main entry point.
1166	*
1167	* This is exported as "TrustedMain" by the dynamic libraries which contains the
1168	* "real" application binary for which the hardened stub is built. The entry
1169	* point is invoked upon successful initialization of the support library and
1170	* runtime.
1171	*
1172	* @returns main kind of exit code.
1173	* @param argc The argument count.
1174	* @param argv The argument vector.
1175	* @param envp The environment vector.
1176	*/
1177	typedef DECLCALLBACKTYPE(int, FNSUPTRUSTEDMAIN,(int argc, char argv, char envp));
1178	/** Pointer to FNSUPTRUSTEDMAIN(). */
1179	typedef FNSUPTRUSTEDMAIN *PFNSUPTRUSTEDMAIN;
1180
1181	/** Which operation failed. */
1182	typedef enum SUPINITOP
1183	{
1184	/** Invalid. */
1185	kSupInitOp_Invalid = 0,
1186	/** Installation integrity error. */
1187	kSupInitOp_Integrity,
1188	/** Setuid related. */
1189	kSupInitOp_RootCheck,
1190	/** Driver related. */
1191	kSupInitOp_Driver,
1192	/** IPRT init related. */
1193	kSupInitOp_IPRT,
1194	/** Miscellaneous. */
1195	kSupInitOp_Misc,
1196	/** Place holder. */
1197	kSupInitOp_End
1198	} SUPINITOP;
1199
1200	/**
1201	* Trusted error entry point, optional.
1202	*
1203	* This is exported as "TrustedError" by the dynamic libraries which contains
1204	* the "real" application binary for which the hardened stub is built. The
1205	* hardened main() must specify SUPSECMAIN_FLAGS_TRUSTED_ERROR when calling
1206	* SUPR3HardenedMain.
1207	*
1208	* @param pszWhere Where the error occurred (function name).
1209	* @param enmWhat Which operation went wrong.
1210	* @param rc The status code.
1211	* @param pszMsgFmt Error message format string.
1212	* @param va The message format arguments.
1213	*/
1214	typedef DECLCALLBACKTYPE(void, FNSUPTRUSTEDERROR,(const char *pszWhere, SUPINITOP enmWhat, int rc,
1215	const char *pszMsgFmt, va_list va)) RT_IPRT_FORMAT_ATTR(4, 0);
1216	/** Pointer to FNSUPTRUSTEDERROR. */
1217	typedef FNSUPTRUSTEDERROR *PFNSUPTRUSTEDERROR;
1218
1219	/**
1220	* Secure main.
1221	*
1222	* This is used for the set-user-ID-on-execute binaries on unixy systems
1223	* and when using the open-vboxdrv-via-root-service setup on Windows.
1224	*
1225	* This function will perform the integrity checks of the VirtualBox
1226	* installation, open the support driver, open the root service (later),
1227	* and load the DLL corresponding to \a pszProgName and execute its main
1228	* function.
1229	*
1230	* @returns Return code appropriate for main().
1231	*
1232	* @param pszProgName The program name. This will be used to figure out which
1233	* DLL/SO/DYLIB to load and execute.
1234	* @param fFlags SUPSECMAIN_FLAGS_XXX.
1235	* @param argc The argument count.
1236	* @param argv The argument vector.
1237	* @param envp The environment vector.
1238	*/
1239	DECLHIDDEN(int) SUPR3HardenedMain(const char pszProgName, uint32_t fFlags, int argc, char argv, char *envp);
1240
1241	/** @name SUPSECMAIN_FLAGS_XXX - SUPR3HardenedMain flags.
1242	* @{ */
1243	/** Don't open the device. (Intended for VirtualBox without -startvm.) */
1244	#define SUPSECMAIN_FLAGS_DONT_OPEN_DEV RT_BIT_32(0)
1245	/** The hardened DLL has a "TrustedError" function (see FNSUPTRUSTEDERROR). */
1246	#define SUPSECMAIN_FLAGS_TRUSTED_ERROR RT_BIT_32(1)
1247	/** Hack for making VirtualBoxVM use VirtualBox.dylib on Mac OS X.
1248	* @note Not used since 6.0 */
1249	#define SUPSECMAIN_FLAGS_OSX_VM_APP RT_BIT_32(2)
1250	/** The first process.
1251	* @internal */
1252	#define SUPSECMAIN_FLAGS_FIRST_PROCESS RT_BIT_32(3)
1253	/** Program binary location mask. */
1254	#define SUPSECMAIN_FLAGS_LOC_MASK UINT32_C(0x00000030)
1255	/** Default binary location is the application binary directory. Does
1256	* not need to be given explicitly (it's 0). */
1257	#define SUPSECMAIN_FLAGS_LOC_APP_BIN UINT32_C(0x00000000)
1258	/** The binary is located in the testcase directory instead of the
1259	* default application binary directory. */
1260	#define SUPSECMAIN_FLAGS_LOC_TESTCASE UINT32_C(0x00000010)
1261	/** The binary is located in a nested application bundle under Resources/ in the
1262	* main Mac OS X application (think Resources/VirtualBoxVM.app). */
1263	#define SUPSECMAIN_FLAGS_LOC_OSX_HLP_APP UINT32_C(0x00000020)
1264	/** Force driverless mode. */
1265	#define SUPSECMAIN_FLAGS_DRIVERLESS RT_BIT_32(8)
1266	/** Driverless IEM-only mode is allowed, so don't fail fatally just because
1267	* the VBox support driver is unavailable. */
1268	#define SUPSECMAIN_FLAGS_DRIVERLESS_IEM_ALLOWED RT_BIT_32(9)
1269	#ifdef VBOX_WITH_DRIVERLESS_NEM_FALLBACK
1270	/** Driverless NEM is a fallback posibility, so don't fail fatally just
1271	* because the VBox support driver is unavailable.
1272	* This may imply checking NEM requirements, depending on the host.
1273	* @note Not supported on Windows. */
1274	# define SUPSECMAIN_FLAGS_DRIVERLESS_NEM_FALLBACK RT_BIT_32(10)
1275	#endif
1276
1277	/** @} */
1278
1279	/**
1280	* Initializes the support library.
1281	*
1282	* Each successful call to SUPR3Init() or SUPR3InitEx must be countered by a
1283	* call to SUPR3Term(false).
1284	*
1285	* @returns VBox status code.
1286	* @param ppSession Where to store the session handle. Defaults to NULL.
1287	*/
1288	SUPR3DECL(int) SUPR3Init(PSUPDRVSESSION *ppSession);
1289
1290	/**
1291	* Initializes the support library, extended version.
1292	*
1293	* Each successful call to SUPR3Init() or SUPR3InitEx must be countered by a
1294	* call to SUPR3Term(false).
1295	*
1296	* @returns VBox status code.
1297	* @param fFlags SUPR3INIT_F_XXX
1298	* @param ppSession Where to store the session handle. Defaults to NULL.
1299	*/
1300	SUPR3DECL(int) SUPR3InitEx(uint32_t fFlags, PSUPDRVSESSION *ppSession);
1301	/** @name SUPR3INIT_F_XXX - Flags for SUPR3InitEx
1302	* @{ */
1303	/** Unrestricted access. */
1304	#define SUPR3INIT_F_UNRESTRICTED RT_BIT_32(0)
1305	/** Limited access (for Main). */
1306	#define SUPR3INIT_F_LIMITED RT_BIT_32(1)
1307	/** Force driverless mode. */
1308	#define SUPR3INIT_F_DRIVERLESS RT_BIT_32(2)
1309	/** Allow driverless IEM mode if the VBox support driver is unavailable.
1310	* @see SUPSECMAIN_FLAGS_DRIVERLESS_IEM_ALLOWED */
1311	#define SUPR3INIT_F_DRIVERLESS_IEM_ALLOWED RT_BIT_32(3)
1312	#ifdef VBOX_WITH_DRIVERLESS_NEM_FALLBACK
1313	/** Allow driverless NEM mode as fallback if the VBox support driver is unavailable.
1314	* @see SUPSECMAIN_FLAGS_DRIVERLESS_NEM_FALLBACK */
1315	# define SUPR3INIT_F_DRIVERLESS_NEM_FALLBACK RT_BIT_32(4)
1316	#endif
1317	/** Mask with all the flags that may trigger driverless mode. */
1318	#ifdef VBOX_WITH_DRIVERLESS_NEM_FALLBACK
1319	# define SUPR3INIT_F_DRIVERLESS_MASK UINT32_C(0x0000001c)
1320	#else
1321	# define SUPR3INIT_F_DRIVERLESS_MASK UINT32_C(0x0000000c)
1322	#endif
1323	/** @} */
1324
1325	/**
1326	* Terminates the support library.
1327	*
1328	* @returns VBox status code.
1329	* @param fForced Forced termination. This means to ignore the
1330	* init call count and just terminated.
1331	*/
1332	#ifdef __cplusplus
1333	SUPR3DECL(int) SUPR3Term(bool fForced = false);
1334	#else
1335	SUPR3DECL(int) SUPR3Term(int fForced);
1336	#endif
1337
1338	/**
1339	* Check if the support library is operating in driverless mode.
1340	*
1341	* @returns true/false accordingly.
1342	* @see SUPR3INIT_F_DRIVERLESS_IEM_ALLOWED,
1343	* SUPR3INIT_F_DRIVERLESS_NEM_FALLBACK
1344	*/
1345	SUPR3DECL(bool) SUPR3IsDriverless(void);
1346
1347	/**
1348	* Sets the ring-0 VM handle for use with fast IOCtls.
1349	*
1350	* @returns VBox status code.
1351	* @param pVMR0 The ring-0 VM handle.
1352	* NIL_RTR0PTR can be used to unset the handle when the
1353	* VM is about to be destroyed.
1354	*/
1355	SUPR3DECL(int) SUPR3SetVMForFastIOCtl(PVMR0 pVMR0);
1356
1357	/**
1358	* Calls the HC R0 VMM entry point.
1359	* See VMMR0Entry() for more details.
1360	*
1361	* @returns error code specific to uFunction.
1362	* @param pVMR0 Pointer to the Ring-0 (Host Context) mapping of the VM structure.
1363	* @param idCpu The virtual CPU ID.
1364	* @param uOperation Operation to execute.
1365	* @param pvArg Argument.
1366	*/
1367	SUPR3DECL(int) SUPR3CallVMMR0(PVMR0 pVMR0, VMCPUID idCpu, unsigned uOperation, void *pvArg);
1368
1369	/**
1370	* Variant of SUPR3CallVMMR0, except that this takes the fast ioclt path
1371	* regardsless of compile-time defaults.
1372	*
1373	* @returns VBox status code.
1374	* @param pVMR0 The ring-0 VM handle.
1375	* @param uOperation The operation; only the SUP_VMMR0_DO_* ones are valid.
1376	* @param idCpu The virtual CPU ID.
1377	*/
1378	SUPR3DECL(int) SUPR3CallVMMR0Fast(PVMR0 pVMR0, unsigned uOperation, VMCPUID idCpu);
1379
1380	/**
1381	* Calls the HC R0 VMM entry point, in a safer but slower manner than
1382	* SUPR3CallVMMR0. When entering using this call the R0 components can call
1383	* into the host kernel (i.e. use the SUPR0 and RT APIs).
1384	*
1385	* See VMMR0Entry() for more details.
1386	*
1387	* @returns error code specific to uFunction.
1388	* @param pVMR0 Pointer to the Ring-0 (Host Context) mapping of the VM structure.
1389	* @param idCpu The virtual CPU ID.
1390	* @param uOperation Operation to execute.
1391	* @param u64Arg Constant argument.
1392	* @param pReqHdr Pointer to a request header. Optional.
1393	* This will be copied in and out of kernel space. There currently is a size
1394	* limit on this, just below 4KB.
1395	*/
1396	SUPR3DECL(int) SUPR3CallVMMR0Ex(PVMR0 pVMR0, VMCPUID idCpu, unsigned uOperation, uint64_t u64Arg, PSUPVMMR0REQHDR pReqHdr);
1397
1398	/**
1399	* Calls a ring-0 service.
1400	*
1401	* The operation and the request packet is specific to the service.
1402	*
1403	* @returns error code specific to uFunction.
1404	* @param pszService The service name.
1405	* @param cchService The length of the service name.
1406	* @param uOperation The request number.
1407	* @param u64Arg Constant argument.
1408	* @param pReqHdr Pointer to a request header. Optional.
1409	* This will be copied in and out of kernel space. There currently is a size
1410	* limit on this, just below 4KB.
1411	*/
1412	SUPR3DECL(int) SUPR3CallR0Service(const char *pszService, size_t cchService, uint32_t uOperation, uint64_t u64Arg, PSUPR0SERVICEREQHDR pReqHdr);
1413
1414	/** Which logger. */
1415	typedef enum SUPLOGGER
1416	{
1417	SUPLOGGER_DEBUG = 1,
1418	SUPLOGGER_RELEASE
1419	} SUPLOGGER;
1420
1421	/**
1422	* Changes the settings of the specified ring-0 logger.
1423	*
1424	* @returns VBox status code.
1425	* @param enmWhich Which logger.
1426	* @param pszFlags The flags settings.
1427	* @param pszGroups The groups settings.
1428	* @param pszDest The destination specificier.
1429	*/
1430	SUPR3DECL(int) SUPR3LoggerSettings(SUPLOGGER enmWhich, const char pszFlags, const char pszGroups, const char *pszDest);
1431
1432	/**
1433	* Creates a ring-0 logger instance.
1434	*
1435	* @returns VBox status code.
1436	* @param enmWhich Which logger to create.
1437	* @param pszFlags The flags settings.
1438	* @param pszGroups The groups settings.
1439	* @param pszDest The destination specificier.
1440	*/
1441	SUPR3DECL(int) SUPR3LoggerCreate(SUPLOGGER enmWhich, const char pszFlags, const char pszGroups, const char *pszDest);
1442
1443	/**
1444	* Destroys a ring-0 logger instance.
1445	*
1446	* @returns VBox status code.
1447	* @param enmWhich Which logger.
1448	*/
1449	SUPR3DECL(int) SUPR3LoggerDestroy(SUPLOGGER enmWhich);
1450
1451	/**
1452	* Queries the paging mode of the host OS.
1453	*
1454	* @returns The paging mode.
1455	*/
1456	SUPR3DECL(SUPPAGINGMODE) SUPR3GetPagingMode(void);
1457
1458	/**
1459	* Allocate zero-filled pages.
1460	*
1461	* Use this to allocate a number of pages suitable for seeding / locking.
1462	* Call SUPR3PageFree() to free the pages once done with them.
1463	*
1464	* @returns VBox status.
1465	* @param cPages Number of pages to allocate.
1466	* @param fFlags SUP_PAGE_ALLOC_F_XXX
1467	* @param ppvPages Where to store the base pointer to the allocated pages.
1468	*/
1469	SUPR3DECL(int) SUPR3PageAlloc(size_t cPages, uint32_t fFlags, void **ppvPages);
1470
1471	/** @name SUP_PAGE_ALLOC_F_XXX - SUPR3PageAlloc flags.
1472	* @{ */
1473	/** Use large pages if available. */
1474	#define SUP_PAGE_ALLOC_F_LARGE_PAGES RT_BIT_32(0)
1475	/** Advice that the allocated pages will probably be locked by
1476	* RTR0MemObjLockUser later, so play nice if needed. */
1477	#define SUP_PAGE_ALLOC_F_FOR_LOCKING RT_BIT_32(1)
1478	/** Mask of valid flags. */
1479	#define SUP_PAGE_ALLOC_F_VALID_MASK UINT32_C(0x00000003)
1480	/** @} */
1481
1482	/**
1483	* Frees pages allocated with SUPR3PageAlloc().
1484	*
1485	* @returns VBox status.
1486	* @param pvPages Pointer returned by SUPR3PageAlloc().
1487	* @param cPages Number of pages that was allocated.
1488	*/
1489	SUPR3DECL(int) SUPR3PageFree(void *pvPages, size_t cPages);
1490
1491	/**
1492	* Allocate non-zeroed, locked, pages with user and, optionally, kernel
1493	* mappings.
1494	*
1495	* Use SUPR3PageFreeEx() to free memory allocated with this function.
1496	*
1497	* @returns VBox status code.
1498	* @param cPages The number of pages to allocate.
1499	* @param fFlags Flags, reserved. Must be zero.
1500	* @param ppvPages Where to store the address of the user mapping.
1501	* @param pR0Ptr Where to store the address of the kernel mapping.
1502	* NULL if no kernel mapping is desired.
1503	* @param paPages Where to store the physical addresses of each page.
1504	* Optional.
1505	*/
1506	SUPR3DECL(int) SUPR3PageAllocEx(size_t cPages, uint32_t fFlags, void **ppvPages, PRTR0PTR pR0Ptr, PSUPPAGE paPages);
1507
1508	/**
1509	* Maps a portion of a ring-3 only allocation into kernel space.
1510	*
1511	* @returns VBox status code.
1512	*
1513	* @param pvR3 The address SUPR3PageAllocEx return.
1514	* @param off Offset to start mapping at. Must be page aligned.
1515	* @param cb Number of bytes to map. Must be page aligned.
1516	* @param fFlags Flags, must be zero.
1517	* @param pR0Ptr Where to store the address on success.
1518	*
1519	*/
1520	SUPR3DECL(int) SUPR3PageMapKernel(void *pvR3, uint32_t off, uint32_t cb, uint32_t fFlags, PRTR0PTR pR0Ptr);
1521
1522	/**
1523	* Changes the protection of
1524	*
1525	* @returns VBox status code.
1526	* @retval VERR_NOT_SUPPORTED if the OS doesn't allow us to change page level
1527	* protection. See also RTR0MemObjProtect.
1528	*
1529	* @param pvR3 The ring-3 address SUPR3PageAllocEx returned.
1530	* @param R0Ptr The ring-0 address SUPR3PageAllocEx returned if it
1531	* is desired that the corresponding ring-0 page
1532	* mappings should change protection as well. Pass
1533	* NIL_RTR0PTR if the ring-0 pages should remain
1534	* unaffected.
1535	* @param off Offset to start at which to start chagning the page
1536	* level protection. Must be page aligned.
1537	* @param cb Number of bytes to change. Must be page aligned.
1538	* @param fProt The new page level protection, either a combination
1539	* of RTMEM_PROT_READ, RTMEM_PROT_WRITE and
1540	* RTMEM_PROT_EXEC, or just RTMEM_PROT_NONE.
1541	*/
1542	SUPR3DECL(int) SUPR3PageProtect(void *pvR3, RTR0PTR R0Ptr, uint32_t off, uint32_t cb, uint32_t fProt);
1543
1544	/**
1545	* Free pages allocated by SUPR3PageAllocEx.
1546	*
1547	* @returns VBox status code.
1548	* @param pvPages The address of the user mapping.
1549	* @param cPages The number of pages.
1550	*/
1551	SUPR3DECL(int) SUPR3PageFreeEx(void *pvPages, size_t cPages);
1552
1553	/**
1554	* Allocated memory with page aligned memory with a contiguous and locked physical
1555	* memory backing below 4GB.
1556	*
1557	* @returns Pointer to the allocated memory (virtual address).
1558	* *pHCPhys is set to the physical address of the memory.
1559	* If ppvR0 isn't NULL, *ppvR0 is set to the ring-0 mapping.
1560	* The returned memory must be freed using SUPR3ContFree().
1561	* @returns NULL on failure.
1562	* @param cPages Number of pages to allocate.
1563	* @param pR0Ptr Where to store the ring-0 mapping of the allocation. (optional)
1564	* @param pHCPhys Where to store the physical address of the memory block.
1565	*
1566	* @remark This 2nd version of this API exists because we're not able to map the
1567	* ring-3 mapping executable on WIN64. This is a serious problem in regard to
1568	* the world switchers.
1569	*/
1570	SUPR3DECL(void *) SUPR3ContAlloc(size_t cPages, PRTR0PTR pR0Ptr, PRTHCPHYS pHCPhys);
1571
1572	/**
1573	* Frees memory allocated with SUPR3ContAlloc().
1574	*
1575	* @returns VBox status code.
1576	* @param pv Pointer to the memory block which should be freed.
1577	* @param cPages Number of pages to be freed.
1578	*/
1579	SUPR3DECL(int) SUPR3ContFree(void *pv, size_t cPages);
1580
1581	/**
1582	* Allocated non contiguous physical memory below 4GB.
1583	*
1584	* The memory isn't zeroed.
1585	*
1586	* @returns VBox status code.
1587	* @returns NULL on failure.
1588	* @param cPages Number of pages to allocate.
1589	* @param ppvPages Where to store the pointer to the allocated memory.
1590	* The pointer stored here on success must be passed to
1591	* SUPR3LowFree when the memory should be released.
1592	* @param ppvPagesR0 Where to store the ring-0 pointer to the allocated memory. optional.
1593	* @param paPages Where to store the physical addresses of the individual pages.
1594	*/
1595	SUPR3DECL(int) SUPR3LowAlloc(size_t cPages, void **ppvPages, PRTR0PTR ppvPagesR0, PSUPPAGE paPages);
1596
1597	/**
1598	* Frees memory allocated with SUPR3LowAlloc().
1599	*
1600	* @returns VBox status code.
1601	* @param pv Pointer to the memory block which should be freed.
1602	* @param cPages Number of pages that was allocated.
1603	*/
1604	SUPR3DECL(int) SUPR3LowFree(void *pv, size_t cPages);
1605
1606	/**
1607	* Load a module into R0 HC.
1608	*
1609	* This will verify the file integrity in a similar manner as
1610	* SUPR3HardenedVerifyFile before loading it.
1611	*
1612	* @returns VBox status code.
1613	* @param pszFilename The path to the image file.
1614	* @param pszModule The module name. Max 32 bytes.
1615	* @param ppvImageBase Where to store the image address.
1616	* @param pErrInfo Where to return extended error information.
1617	* Optional.
1618	*/
1619	SUPR3DECL(int) SUPR3LoadModule(const char pszFilename, const char pszModule, void **ppvImageBase, PRTERRINFO pErrInfo);
1620
1621	/**
1622	* Load a module into R0 HC.
1623	*
1624	* This will verify the file integrity in a similar manner as
1625	* SUPR3HardenedVerifyFile before loading it.
1626	*
1627	* @returns VBox status code.
1628	* @param pszFilename The path to the image file.
1629	* @param pszModule The module name. Max 32 bytes.
1630	* @param pszSrvReqHandler The name of the service request handler entry
1631	* point. See FNSUPR0SERVICEREQHANDLER.
1632	* @param ppvImageBase Where to store the image address.
1633	*/
1634	SUPR3DECL(int) SUPR3LoadServiceModule(const char pszFilename, const char pszModule,
1635	const char pszSrvReqHandler, void *ppvImageBase);
1636
1637	/**
1638	* Frees a R0 HC module.
1639	*
1640	* @returns VBox status code.
1641	* @param pvImageBase The base address of the image to free.
1642	* @remark This will not actually 'free' the module, there are of course usage counting.
1643	*/
1644	SUPR3DECL(int) SUPR3FreeModule(void *pvImageBase);
1645
1646	/**
1647	* Lock down the module loader interface.
1648	*
1649	* This will lock down the module loader interface. No new modules can be
1650	* loaded and all loaded modules can no longer be freed.
1651	*
1652	* @returns VBox status code.
1653	* @param pErrInfo Where to return extended error information.
1654	* Optional.
1655	*/
1656	SUPR3DECL(int) SUPR3LockDownLoader(PRTERRINFO pErrInfo);
1657
1658	/**
1659	* Get the address of a symbol in a ring-0 module.
1660	*
1661	* @returns VBox status code.
1662	* @param pvImageBase The base address of the image to search.
1663	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
1664	* ordinal value rather than a string pointer.
1665	* @param ppvValue Where to store the symbol value.
1666	*/
1667	SUPR3DECL(int) SUPR3GetSymbolR0(void pvImageBase, const char pszSymbol, void **ppvValue);
1668
1669	/**
1670	* Load R0 HC VMM code.
1671	*
1672	* @returns VBox status code.
1673	* @deprecated Use SUPR3LoadModule(pszFilename, "VMMR0.r0", &pvImageBase)
1674	* @param pszFilename Full path to the VMMR0.r0 file (silly).
1675	* @param pErrInfo Where to return extended error information.
1676	* Optional.
1677	*/
1678	SUPR3DECL(int) SUPR3LoadVMM(const char *pszFilename, PRTERRINFO pErrInfo);
1679
1680	/**
1681	* Unloads R0 HC VMM code.
1682	*
1683	* @returns VBox status code.
1684	* @deprecated Use SUPR3FreeModule().
1685	*/
1686	SUPR3DECL(int) SUPR3UnloadVMM(void);
1687
1688	/**
1689	* Get the physical address of the GIP.
1690	*
1691	* @returns VBox status code.
1692	* @param pHCPhys Where to store the physical address of the GIP.
1693	*/
1694	SUPR3DECL(int) SUPR3GipGetPhys(PRTHCPHYS pHCPhys);
1695
1696	/**
1697	* Initializes only the bits relevant for the SUPR3HardenedVerify* APIs.
1698	*
1699	* This is for users that don't necessarily need to initialize the whole of
1700	* SUPLib. There is no harm in calling this one more time.
1701	*
1702	* @returns VBox status code.
1703	* @remarks Currently not counted, so only call once.
1704	*/
1705	SUPR3DECL(int) SUPR3HardenedVerifyInit(void);
1706
1707	/**
1708	* Reverses the effect of SUPR3HardenedVerifyInit if SUPR3InitEx hasn't been
1709	* called.
1710	*
1711	* Ignored if the support library was initialized using SUPR3Init or
1712	* SUPR3InitEx.
1713	*
1714	* @returns VBox status code.
1715	*/
1716	SUPR3DECL(int) SUPR3HardenedVerifyTerm(void);
1717
1718	/**
1719	* Verifies the integrity of a file, and optionally opens it.
1720	*
1721	* The integrity check is for whether the file is suitable for loading into
1722	* the hypervisor or VM process. The integrity check may include verifying
1723	* the authenticode/elfsign/whatever signature of the file, which can take
1724	* a little while.
1725	*
1726	* @returns VBox status code. On failure it will have printed a LogRel message.
1727	*
1728	* @param pszFilename The file.
1729	* @param pszWhat For the LogRel on failure.
1730	* @param phFile Where to store the handle to the opened file. This is optional, pass NULL
1731	* if the file should not be opened.
1732	* @deprecated Write a new one.
1733	*/
1734	SUPR3DECL(int) SUPR3HardenedVerifyFile(const char pszFilename, const char pszWhat, PRTFILE phFile);
1735
1736	/**
1737	* Verifies the integrity of a the current process, including the image
1738	* location and that the invocation was absolute.
1739	*
1740	* This must currently be called after initializing the runtime. The intended
1741	* audience is set-uid-to-root applications, root services and similar.
1742	*
1743	* @returns VBox status code. On failure
1744	* message.
1745	* @param pszArgv0 The first argument to main().
1746	* @param fInternal Set this to @c true if this is an internal
1747	* VirtualBox application. Otherwise pass @c false.
1748	* @param pErrInfo Where to return extended error information.
1749	*/
1750	SUPR3DECL(int) SUPR3HardenedVerifySelf(const char *pszArgv0, bool fInternal, PRTERRINFO pErrInfo);
1751
1752	/**
1753	* Verifies the integrity of an installation directory.
1754	*
1755	* The integrity check verifies that the directory cannot be tampered with by
1756	* normal users on the system. On Unix this translates to root ownership and
1757	* no symbolic linking.
1758	*
1759	* @returns VBox status code. On failure a message will be stored in @a pszErr.
1760	*
1761	* @param pszDirPath The directory path.
1762	* @param fRecursive Whether the check should be recursive or
1763	* not. When set, all sub-directores will be checked,
1764	* including files (@a fCheckFiles is ignored).
1765	* @param fCheckFiles Whether to apply the same basic integrity check to
1766	* the files in the directory as the directory itself.
1767	* @param pErrInfo Where to return extended error information.
1768	* Optional.
1769	*/
1770	SUPR3DECL(int) SUPR3HardenedVerifyDir(const char *pszDirPath, bool fRecursive, bool fCheckFiles, PRTERRINFO pErrInfo);
1771
1772	/**
1773	* Verifies the integrity of a plug-in module.
1774	*
1775	* This is similar to SUPR3HardenedLdrLoad, except it does not load the module
1776	* and that the module does not have to be shipped with VirtualBox.
1777	*
1778	* @returns VBox status code. On failure a message will be stored in @a pszErr.
1779	*
1780	* @param pszFilename The filename of the plug-in module (nothing can be
1781	* omitted here).
1782	* @param pErrInfo Where to return extended error information.
1783	* Optional.
1784	*/
1785	SUPR3DECL(int) SUPR3HardenedVerifyPlugIn(const char *pszFilename, PRTERRINFO pErrInfo);
1786
1787	/**
1788	* Same as RTLdrLoad() but will verify the files it loads (hardened builds).
1789	*
1790	* Will add dll suffix if missing and try load the file.
1791	*
1792	* @returns iprt status code.
1793	* @param pszFilename Image filename. This must have a path.
1794	* @param phLdrMod Where to store the handle to the loaded module.
1795	* @param fFlags See RTLDRLOAD_FLAGS_XXX.
1796	* @param pErrInfo Where to return extended error information.
1797	* Optional.
1798	*/
1799	SUPR3DECL(int) SUPR3HardenedLdrLoad(const char *pszFilename, PRTLDRMOD phLdrMod, uint32_t fFlags, PRTERRINFO pErrInfo);
1800
1801	/**
1802	* Same as RTLdrLoadAppPriv() but it will verify the files it loads (hardened
1803	* builds).
1804	*
1805	* Will add dll suffix to the file if missing, then look for it in the
1806	* architecture dependent application directory.
1807	*
1808	* @returns iprt status code.
1809	* @param pszFilename Image filename.
1810	* @param phLdrMod Where to store the handle to the loaded module.
1811	* @param fFlags See RTLDRLOAD_FLAGS_XXX.
1812	* @param pErrInfo Where to return extended error information.
1813	* Optional.
1814	*/
1815	SUPR3DECL(int) SUPR3HardenedLdrLoadAppPriv(const char *pszFilename, PRTLDRMOD phLdrMod, uint32_t fFlags, PRTERRINFO pErrInfo);
1816
1817	/**
1818	* Same as RTLdrLoad() but will verify the files it loads (hardened builds).
1819	*
1820	* This differs from SUPR3HardenedLdrLoad() in that it can load modules from
1821	* extension packs and anything else safely installed on the system, provided
1822	* they pass the hardening tests.
1823	*
1824	* @returns iprt status code.
1825	* @param pszFilename The full path to the module, with extension.
1826	* @param phLdrMod Where to store the handle to the loaded module.
1827	* @param pErrInfo Where to return extended error information.
1828	* Optional.
1829	*/
1830	SUPR3DECL(int) SUPR3HardenedLdrLoadPlugIn(const char *pszFilename, PRTLDRMOD phLdrMod, PRTERRINFO pErrInfo);
1831
1832	/**
1833	* Check if the host kernel can run in VMX root mode.
1834	*
1835	* @returns VINF_SUCCESS if supported, error code indicating why if not.
1836	* @param ppszWhy Where to return an explanatory message on failure.
1837	*/
1838	SUPR3DECL(int) SUPR3QueryVTxSupported(const char **ppszWhy);
1839
1840	/**
1841	* Return VT-x/AMD-V capabilities.
1842	*
1843	* @returns VINF_SUCCESS if supported, error code indicating why if not.
1844	* @param pfCaps Pointer to capability dword (out).
1845	* @todo Intended for main, which means we need to relax the privilege requires
1846	* when accessing certain vboxdrv functions.
1847	*/
1848	SUPR3DECL(int) SUPR3QueryVTCaps(uint32_t *pfCaps);
1849
1850	/**
1851	* Check if NEM is supported when no VT-x/AMD-V is indicated by the CPU.
1852	*
1853	* This is really only for the windows case where we're running in a root
1854	* partition and isn't allowed to use the hardware directly.
1855	*
1856	* @returns True if NEM API support, false if not.
1857	*/
1858	SUPR3DECL(bool) SUPR3IsNemSupportedWhenNoVtxOrAmdV(void);
1859
1860	/**
1861	* Open the tracer.
1862	*
1863	* @returns VBox status code.
1864	* @param uCookie Cookie identifying the tracer we expect to talk to.
1865	* @param uArg Tracer specific open argument.
1866	*/
1867	SUPR3DECL(int) SUPR3TracerOpen(uint32_t uCookie, uintptr_t uArg);
1868
1869	/**
1870	* Closes the tracer.
1871	*
1872	* @returns VBox status code.
1873	*/
1874	SUPR3DECL(int) SUPR3TracerClose(void);
1875
1876	/**
1877	* Perform an I/O request on the tracer.
1878	*
1879	* @returns VBox status.
1880	* @param uCmd The tracer command.
1881	* @param uArg The argument.
1882	* @param piRetVal Where to store the tracer return value.
1883	*/
1884	SUPR3DECL(int) SUPR3TracerIoCtl(uintptr_t uCmd, uintptr_t uArg, int32_t *piRetVal);
1885
1886	/**
1887	* Registers the user module with the tracer.
1888	*
1889	* @returns VBox status code.
1890	* @param hModNative Native module handle. Pass ~(uintptr_t)0 if not
1891	* at hand.
1892	* @param pszModule The module name.
1893	* @param pVtgHdr The VTG header.
1894	* @param uVtgHdrAddr The address to which the VTG header is loaded
1895	* in the relevant execution context.
1896	* @param fFlags See SUP_TRACER_UMOD_FLAGS_XXX
1897	*/
1898	SUPR3DECL(int) SUPR3TracerRegisterModule(uintptr_t hModNative, const char pszModule, struct VTGOBJHDR pVtgHdr,
1899	RTUINTPTR uVtgHdrAddr, uint32_t fFlags);
1900
1901	/**
1902	* Deregisters the user module.
1903	*
1904	* @returns VBox status code.
1905	* @param pVtgHdr The VTG header.
1906	*/
1907	SUPR3DECL(int) SUPR3TracerDeregisterModule(struct VTGOBJHDR *pVtgHdr);
1908
1909	/**
1910	* Fire the probe.
1911	*
1912	* @param pVtgProbeLoc The probe location record.
1913	* @param uArg0 Raw probe argument 0.
1914	* @param uArg1 Raw probe argument 1.
1915	* @param uArg2 Raw probe argument 2.
1916	* @param uArg3 Raw probe argument 3.
1917	* @param uArg4 Raw probe argument 4.
1918	*/
1919	SUPDECL(void) SUPTracerFireProbe(struct VTGPROBELOC *pVtgProbeLoc, uintptr_t uArg0, uintptr_t uArg1, uintptr_t uArg2,
1920	uintptr_t uArg3, uintptr_t uArg4);
1921
1922	/**
1923	* Attempts to read the value of an MSR.
1924	*
1925	* @returns VBox status code.
1926	* @param uMsr The MSR to read.
1927	* @param idCpu The CPU to read it on, NIL_RTCPUID if it doesn't
1928	* matter which CPU.
1929	* @param puValue Where to return the value.
1930	* @param pfGp Where to store the \#GP indicator for the read
1931	* operation.
1932	*/
1933	SUPR3DECL(int) SUPR3MsrProberRead(uint32_t uMsr, RTCPUID idCpu, uint64_t puValue, bool pfGp);
1934
1935	/**
1936	* Attempts to write to an MSR.
1937	*
1938	* @returns VBox status code.
1939	* @param uMsr The MSR to write to.
1940	* @param idCpu The CPU to wrtie it on, NIL_RTCPUID if it
1941	* doesn't matter which CPU.
1942	* @param uValue The value to write.
1943	* @param pfGp Where to store the \#GP indicator for the write
1944	* operation.
1945	*/
1946	SUPR3DECL(int) SUPR3MsrProberWrite(uint32_t uMsr, RTCPUID idCpu, uint64_t uValue, bool *pfGp);
1947
1948	/**
1949	* Attempts to modify the value of an MSR.
1950	*
1951	* @returns VBox status code.
1952	* @param uMsr The MSR to modify.
1953	* @param idCpu The CPU to modify it on, NIL_RTCPUID if it
1954	* doesn't matter which CPU.
1955	* @param fAndMask The bits to keep in the current MSR value.
1956	* @param fOrMask The bits to set before writing.
1957	* @param pResult The result buffer.
1958	*/
1959	SUPR3DECL(int) SUPR3MsrProberModify(uint32_t uMsr, RTCPUID idCpu, uint64_t fAndMask, uint64_t fOrMask,
1960	PSUPMSRPROBERMODIFYRESULT pResult);
1961
1962	/**
1963	* Attempts to modify the value of an MSR, extended version.
1964	*
1965	* @returns VBox status code.
1966	* @param uMsr The MSR to modify.
1967	* @param idCpu The CPU to modify it on, NIL_RTCPUID if it
1968	* doesn't matter which CPU.
1969	* @param fAndMask The bits to keep in the current MSR value.
1970	* @param fOrMask The bits to set before writing.
1971	* @param fFaster If set to @c true some cache/tlb invalidation is
1972	* skipped, otherwise behave like
1973	* SUPR3MsrProberModify.
1974	* @param pResult The result buffer.
1975	*/
1976	SUPR3DECL(int) SUPR3MsrProberModifyEx(uint32_t uMsr, RTCPUID idCpu, uint64_t fAndMask, uint64_t fOrMask, bool fFaster,
1977	PSUPMSRPROBERMODIFYRESULT pResult);
1978
1979	/**
1980	* Resume built-in keyboard on MacBook Air and Pro hosts.
1981	*
1982	* @returns VBox status code.
1983	*/
1984	SUPR3DECL(int) SUPR3ResumeSuspendedKeyboards(void);
1985
1986	/**
1987	* Measure the TSC-delta for the specified CPU.
1988	*
1989	* @returns VBox status code.
1990	* @param idCpu The CPU to measure the TSC-delta for.
1991	* @param fAsync Whether the measurement is asynchronous, returns
1992	* immediately after signalling a measurement
1993	* request.
1994	* @param fForce Whether to perform a measurement even if the
1995	* specified CPU has a (possibly) valid TSC delta.
1996	* @param cRetries Number of times to retry failed delta
1997	* measurements.
1998	* @param cMsWaitRetry Number of milliseconds to wait between retries.
1999	*/
2000	SUPR3DECL(int) SUPR3TscDeltaMeasure(RTCPUID idCpu, bool fAsync, bool fForce, uint8_t cRetries, uint8_t cMsWaitRetry);
2001
2002	/**
2003	* Reads the delta-adjust TSC value.
2004	*
2005	* @returns VBox status code.
2006	* @param puTsc Where to store the read TSC value.
2007	* @param pidApic Where to store the APIC ID of the CPU where the TSC
2008	* was read (optional, can be NULL).
2009	*/
2010	SUPR3DECL(int) SUPR3ReadTsc(uint64_t puTsc, uint16_t pidApic);
2011
2012	/**
2013	* Modifies the GIP flags.
2014	*
2015	* @returns VBox status code.
2016	* @param fOrMask The OR mask of the GIP flags, see SUPGIP_FLAGS_XXX.
2017	* @param fAndMask The AND mask of the GIP flags, see SUPGIP_FLAGS_XXX.
2018	*/
2019	SUPR3DECL(int) SUPR3GipSetFlags(uint32_t fOrMask, uint32_t fAndMask);
2020
2021	/**
2022	* Return processor microcode revision, if applicable.
2023	*
2024	* @returns VINF_SUCCESS if supported, error code indicating why if not.
2025	* @param puMicrocodeRev Pointer to microcode revision dword (out).
2026	*/
2027	SUPR3DECL(int) SUPR3QueryMicrocodeRev(uint32_t *puMicrocodeRev);
2028
2029	/**
2030	* Gets hardware-virtualization MSRs of the CPU, if available.
2031	*
2032	* @returns VINF_SUCCESS if available, error code indicating why if not.
2033	* @param pHwvirtMsrs Where to store the hardware-virtualization MSRs.
2034	* @param fForceRequery Whether to force complete re-querying of MSRs (rather
2035	* than fetching cached values when available).
2036	*/
2037	SUPR3DECL(int) SUPR3GetHwvirtMsrs(PSUPHWVIRTMSRS pHwvirtMsrs, bool fForceRequery);
2038
2039	/** @} */
2040	#endif /* IN_RING3 */
2041
2042
2043	/** @name User mode module flags (SUPR3TracerRegisterModule & SUP_IOCTL_TRACER_UMOD_REG).
2044	* @{ */
2045	/** Executable image. */
2046	#define SUP_TRACER_UMOD_FLAGS_EXE UINT32_C(1)
2047	/** Shared library (DLL, DYLIB, SO, etc). */
2048	#define SUP_TRACER_UMOD_FLAGS_SHARED UINT32_C(2)
2049	/** Image type mask. */
2050	#define SUP_TRACER_UMOD_FLAGS_TYPE_MASK UINT32_C(3)
2051	/** @} */
2052
2053
2054	#ifdef IN_RING0
2055	/** @defgroup grp_sup_r0 SUP Host Context Ring-0 API
2056	* @{
2057	*/
2058
2059	/**
2060	* Security objectype.
2061	*/
2062	typedef enum SUPDRVOBJTYPE
2063	{
2064	/** The usual invalid object. */
2065	SUPDRVOBJTYPE_INVALID = 0,
2066	/** A Virtual Machine instance. */
2067	SUPDRVOBJTYPE_VM,
2068	/** Internal network. */
2069	SUPDRVOBJTYPE_INTERNAL_NETWORK,
2070	/** Internal network interface. */
2071	SUPDRVOBJTYPE_INTERNAL_NETWORK_INTERFACE,
2072	/** Single release event semaphore. */
2073	SUPDRVOBJTYPE_SEM_EVENT,
2074	/** Multiple release event semaphore. */
2075	SUPDRVOBJTYPE_SEM_EVENT_MULTI,
2076	/** Raw PCI device. */
2077	SUPDRVOBJTYPE_RAW_PCI_DEVICE,
2078	/** The first invalid object type in this end. */
2079	SUPDRVOBJTYPE_END,
2080	/** The usual 32-bit type size hack. */
2081	SUPDRVOBJTYPE_32_BIT_HACK = 0x7ffffff
2082	} SUPDRVOBJTYPE;
2083
2084	/**
2085	* Object destructor callback.
2086	* This is called for reference counted objectes when the count reaches 0.
2087	*
2088	* @param pvObj The object pointer.
2089	* @param pvUser1 The first user argument.
2090	* @param pvUser2 The second user argument.
2091	*/
2092	typedef DECLCALLBACKTYPE(void, FNSUPDRVDESTRUCTOR,(void pvObj, void pvUser1, void *pvUser2));
2093	/** Pointer to a FNSUPDRVDESTRUCTOR(). */
2094	typedef FNSUPDRVDESTRUCTOR *PFNSUPDRVDESTRUCTOR;
2095
2096	/**
2097	* Service request callback function.
2098	*
2099	* @returns VBox status code.
2100	* @param pSession The caller's session.
2101	* @param uOperation The operation identifier.
2102	* @param u64Arg 64-bit integer argument.
2103	* @param pReqHdr The request header. Input / Output. Optional.
2104	*/
2105	typedef DECLCALLBACKTYPE(int, FNSUPR0SERVICEREQHANDLER,(PSUPDRVSESSION pSession, uint32_t uOperation,
2106	uint64_t u64Arg, PSUPR0SERVICEREQHDR pReqHdr));
2107	/** Pointer to a FNR0SERVICEREQHANDLER(). */
2108	typedef R0PTRTYPE(FNSUPR0SERVICEREQHANDLER *) PFNSUPR0SERVICEREQHANDLER;
2109
2110	/**
2111	* Symbol entry for a wrapped module (SUPLDRWRAPPEDMODULE).
2112	*/
2113	typedef struct SUPLDRWRAPMODSYMBOL
2114	{
2115	/** The symbol namel. */
2116	const char *pszSymbol;
2117	/** The symbol address/value. */
2118	PFNRT pfnValue;
2119	} SUPLDRWRAPMODSYMBOL;
2120	/** Pointer to a symbol entry for a wrapped module. */
2121	typedef SUPLDRWRAPMODSYMBOL const *PCSUPLDRWRAPMODSYMBOL;
2122
2123	/**
2124	* Registration structure for SUPR0LdrRegisterWrapperModule.
2125	*
2126	* This is used to register a .r0 module when loaded manually as a native kernel
2127	* module/extension/driver/whatever.
2128	*/
2129	typedef struct SUPLDRWRAPPEDMODULE
2130	{
2131	/** Magic value (SUPLDRWRAPPEDMODULE_MAGIC). */
2132	uint32_t uMagic;
2133	/** The structure version. */
2134	uint16_t uVersion;
2135	/** SUPLDRWRAPPEDMODULE_F_XXX. */
2136	uint16_t fFlags;
2137
2138	/** As close as possible to the start of the image. */
2139	void *pvImageStart;
2140	/** As close as possible to the end of the image. */
2141	void *pvImageEnd;
2142
2143	/** @name Standar entry points
2144	* @{ */
2145	/** Pointer to the module initialization function (optional). */
2146	DECLCALLBACKMEMBER(int, pfnModuleInit,(void *hMod));
2147	/** Pointer to the module termination function (optional). */
2148	DECLCALLBACKMEMBER(void, pfnModuleTerm,(void *hMod));
2149	/** The VMMR0EntryFast entry point for VMMR0. */
2150	PFNRT pfnVMMR0EntryFast;
2151	/** The VMMR0EntryEx entry point for VMMR0. */
2152	PFNRT pfnVMMR0EntryEx;
2153	/** The service request handler entry point. */
2154	PFNSUPR0SERVICEREQHANDLER pfnServiceReqHandler;
2155	/** @} */
2156
2157	/** The symbol table. */
2158	PCSUPLDRWRAPMODSYMBOL paSymbols;
2159	/** Number of symbols. */
2160	uint32_t cSymbols;
2161
2162	/** The normal VBox module name. */
2163	char szName[32];
2164	/** Repeating the magic value here (SUPLDRWRAPPEDMODULE_MAGIC). */
2165	uint32_t uEndMagic;
2166	} SUPLDRWRAPPEDMODULE;
2167	/** Pointer to the wrapped module registration structure. */
2168	typedef SUPLDRWRAPPEDMODULE const *PCSUPLDRWRAPPEDMODULE;
2169
2170	/** Magic value for the wrapped module structure (Doris lessing). */
2171	#define SUPLDRWRAPPEDMODULE_MAGIC UINT32_C(0x19191117)
2172	/** Current SUPLDRWRAPPEDMODULE structure version. */
2173	#define SUPLDRWRAPPEDMODULE_VERSION UINT16_C(0x0001)
2174
2175	/** Set if this is the VMMR0 module. */
2176	#define SUPLDRWRAPPEDMODULE_F_VMMR0 UINT16_C(0x0001)
2177
2178
2179	SUPR0DECL(void ) SUPR0ObjRegister(PSUPDRVSESSION pSession, SUPDRVOBJTYPE enmType, PFNSUPDRVDESTRUCTOR pfnDestructor, void pvUser1, void *pvUser2);
2180	SUPR0DECL(int) SUPR0ObjAddRef(void *pvObj, PSUPDRVSESSION pSession);
2181	SUPR0DECL(int) SUPR0ObjAddRefEx(void *pvObj, PSUPDRVSESSION pSession, bool fNoBlocking);
2182	SUPR0DECL(int) SUPR0ObjRelease(void *pvObj, PSUPDRVSESSION pSession);
2183	SUPR0DECL(int) SUPR0ObjVerifyAccess(void pvObj, PSUPDRVSESSION pSession, const char pszObjName);
2184
2185	SUPR0DECL(PVM) SUPR0GetSessionVM(PSUPDRVSESSION pSession);
2186	SUPR0DECL(PGVM) SUPR0GetSessionGVM(PSUPDRVSESSION pSession);
2187	SUPR0DECL(int) SUPR0SetSessionVM(PSUPDRVSESSION pSession, PGVM pGVM, PVM pVM);
2188	SUPR0DECL(RTUID) SUPR0GetSessionUid(PSUPDRVSESSION pSession);
2189
2190	SUPR0DECL(int) SUPR0LockMem(PSUPDRVSESSION pSession, RTR3PTR pvR3, uint32_t cPages, PRTHCPHYS paPages);
2191	SUPR0DECL(int) SUPR0UnlockMem(PSUPDRVSESSION pSession, RTR3PTR pvR3);
2192	SUPR0DECL(int) SUPR0ContAlloc(PSUPDRVSESSION pSession, uint32_t cPages, PRTR0PTR ppvR0, PRTR3PTR ppvR3, PRTHCPHYS pHCPhys);
2193	SUPR0DECL(int) SUPR0ContFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr);
2194	SUPR0DECL(int) SUPR0LowAlloc(PSUPDRVSESSION pSession, uint32_t cPages, PRTR0PTR ppvR0, PRTR3PTR ppvR3, PRTHCPHYS paPages);
2195	SUPR0DECL(int) SUPR0LowFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr);
2196	SUPR0DECL(int) SUPR0MemAlloc(PSUPDRVSESSION pSession, uint32_t cb, PRTR0PTR ppvR0, PRTR3PTR ppvR3);
2197	SUPR0DECL(int) SUPR0MemGetPhys(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr, PSUPPAGE paPages);
2198	SUPR0DECL(int) SUPR0MemFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr);
2199	SUPR0DECL(int) SUPR0PageAllocEx(PSUPDRVSESSION pSession, uint32_t cPages, uint32_t fFlags, PRTR3PTR ppvR3, PRTR0PTR ppvR0, PRTHCPHYS paPages);
2200	SUPR0DECL(int) SUPR0PageMapKernel(PSUPDRVSESSION pSession, RTR3PTR pvR3, uint32_t offSub, uint32_t cbSub, uint32_t fFlags, PRTR0PTR ppvR0);
2201	SUPR0DECL(int) SUPR0PageProtect(PSUPDRVSESSION pSession, RTR3PTR pvR3, RTR0PTR pvR0, uint32_t offSub, uint32_t cbSub, uint32_t fProt);
2202	SUPR0DECL(int) SUPR0PageFree(PSUPDRVSESSION pSession, RTR3PTR pvR3);
2203	SUPR0DECL(int) SUPR0GipMap(PSUPDRVSESSION pSession, PRTR3PTR ppGipR3, PRTHCPHYS pHCPhysGip);
2204	SUPR0DECL(int) SUPR0LdrLock(PSUPDRVSESSION pSession);
2205	SUPR0DECL(int) SUPR0LdrUnlock(PSUPDRVSESSION pSession);
2206	SUPR0DECL(bool) SUPR0LdrIsLockOwnerByMod(void *hMod, bool fWantToHear);
2207	SUPR0DECL(int) SUPR0LdrModByName(PSUPDRVSESSION pSession, const char pszName, void *phMod);
2208	SUPR0DECL(int) SUPR0LdrModRetain(PSUPDRVSESSION pSession, void *hMod);
2209	SUPR0DECL(int) SUPR0LdrModRelease(PSUPDRVSESSION pSession, void *hMod);
2210	#ifdef RT_OS_LINUX
2211	SUPR0DECL(int) SUPDrvLinuxLdrRegisterWrappedModule(PCSUPLDRWRAPPEDMODULE pWrappedModInfo, const char pszLnxModName, void *phMod);
2212	SUPR0DECL(int) SUPDrvLinuxLdrDeregisterWrappedModule(PCSUPLDRWRAPPEDMODULE pWrappedModInfo, void **phMod);
2213	#endif
2214	SUPR0DECL(int) SUPR0GetVTSupport(uint32_t *pfCaps);
2215	SUPR0DECL(int) SUPR0GetHwvirtMsrs(PSUPHWVIRTMSRS pMsrs, uint32_t fCaps, bool fForce);
2216	SUPR0DECL(int) SUPR0GetSvmUsability(bool fInitSvm);
2217	SUPR0DECL(int) SUPR0GetVmxUsability(bool *pfIsSmxModeAmbiguous);
2218	SUPR0DECL(int) SUPR0GetCurrentGdtRw(RTHCUINTPTR *pGdtRw);
2219	SUPR0DECL(int) SUPR0QueryVTCaps(PSUPDRVSESSION pSession, uint32_t *pfCaps);
2220	SUPR0DECL(int) SUPR0GipUnmap(PSUPDRVSESSION pSession);
2221	SUPR0DECL(int) SUPR0QueryUcodeRev(PSUPDRVSESSION pSession, uint32_t *puMicrocodeRev);
2222	SUPR0DECL(SUPPAGINGMODE) SUPR0GetPagingMode(void);
2223	SUPR0DECL(RTCCUINTREG) SUPR0ChangeCR4(RTCCUINTREG fOrMask, RTCCUINTREG fAndMask);
2224	SUPR0DECL(int) SUPR0EnableVTx(bool fEnable);
2225	SUPR0DECL(bool) SUPR0SuspendVTxOnCpu(void);
2226	SUPR0DECL(void) SUPR0ResumeVTxOnCpu(bool fSuspended);
2227	#define SUP_TSCDELTA_MEASURE_F_FORCE RT_BIT_32(0)
2228	#define SUP_TSCDELTA_MEASURE_F_ASYNC RT_BIT_32(1)
2229	#define SUP_TSCDELTA_MEASURE_F_VALID_MASK UINT32_C(0x00000003)
2230	SUPR0DECL(int) SUPR0TscDeltaMeasureBySetIndex(PSUPDRVSESSION pSession, uint32_t iCpuSet, uint32_t fFlags,
2231	RTMSINTERVAL cMsWaitRetry, RTMSINTERVAL cMsWaitThread, uint32_t cTries);
2232
2233	SUPR0DECL(void) SUPR0BadContext(PSUPDRVSESSION pSession, const char pszFile, uint32_t uLine, const char pszExpr);
2234
2235	#if defined(RT_OS_LINUX) \|\| defined(RT_OS_SOLARIS) \|\| defined(RT_OS_FREEBSD)
2236	/**
2237	* Translates a physical address to a virtual mapping (valid up to end of page).
2238	* @returns VBox status code.
2239	* @param HCPhys The physical address, must be page aligned.
2240	* @param ppv Where to store the mapping address on success.
2241	*/
2242	SUPR0DECL(int) SUPR0HCPhysToVirt(RTHCPHYS HCPhys, void **ppv);
2243	#endif
2244
2245	/** Context structure returned by SUPR0IoCtlSetup for use with
2246	* SUPR0IoCtlPerform and cleaned up by SUPR0IoCtlCleanup. */
2247	typedef struct SUPR0IOCTLCTX *PSUPR0IOCTLCTX;
2248
2249	/**
2250	* Sets up a I/O control context for the given handle.
2251	*
2252	* @returns VBox status code.
2253	* @param pSession The support driver session.
2254	* @param hHandle The handle.
2255	* @param fFlags Flag, MBZ.
2256	* @param ppCtx Where the context is returned.
2257	*/
2258	SUPR0DECL(int) SUPR0IoCtlSetupForHandle(PSUPDRVSESSION pSession, intptr_t hHandle, uint32_t fFlags, PSUPR0IOCTLCTX *ppCtx);
2259
2260	/**
2261	* Cleans up the I/O control context when done.
2262	*
2263	* This won't close the handle passed to SUPR0IoCtlSetupForHandle.
2264	*
2265	* @returns VBox status code.
2266	* @param pCtx The I/O control context to cleanup.
2267	*/
2268	SUPR0DECL(int) SUPR0IoCtlCleanup(PSUPR0IOCTLCTX pCtx);
2269
2270	/**
2271	* Performs an I/O control operation.
2272	*
2273	* @returns VBox status code.
2274	* @param pCtx The I/O control context returned by
2275	* SUPR0IoCtlSetupForHandle.
2276	* @param uFunction The I/O control function to perform.
2277	* @param pvInput Pointer to input buffer (ring-0).
2278	* @param pvInputUser Ring-3 pointer corresponding to @a pvInput.
2279	* @param cbInput The amount of input. If zero, both input pointers
2280	* are expected to be NULL.
2281	* @param pvOutput Pointer to output buffer (ring-0).
2282	* @param pvOutputUser Ring-3 pointer corresponding to @a pvInput.
2283	* @param cbOutput The amount of input. If zero, both input pointers
2284	* are expected to be NULL.
2285	* @param piNativeRc Where to return the native return code. When
2286	* specified the VBox status code will typically be
2287	* VINF_SUCCESS and the caller have to consult this for
2288	* the actual result of the operation. (This saves
2289	* pointless status code conversion.) Optional.
2290	*
2291	* @note On unix systems where there is only one set of buffers possible,
2292	* pass the same pointers as input and output.
2293	*/
2294	SUPR0DECL(int) SUPR0IoCtlPerform(PSUPR0IOCTLCTX pCtx, uintptr_t uFunction,
2295	void *pvInput, RTR3PTR pvInputUser, size_t cbInput,
2296	void *pvOutput, RTR3PTR pvOutputUser, size_t cbOutput,
2297	int32_t *piNativeRc);
2298
2299	/**
2300	* Writes to the debugger and/or kernel log, va_list version.
2301	*
2302	* The length of the formatted message is somewhat limited, so keep things short
2303	* and to the point.
2304	*
2305	* @returns Number of bytes written, mabye.
2306	* @param pszFormat IPRT format string.
2307	* @param va Arguments referenced by the format string.
2308	*/
2309	SUPR0DECL(int) SUPR0PrintfV(const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(1, 0);
2310
2311	/**
2312	* Writes to the debugger and/or kernel log.
2313	*
2314	* The length of the formatted message is somewhat limited, so keep things short
2315	* and to the point.
2316	*
2317	* @returns Number of bytes written, mabye.
2318	* @param pszFormat IPRT format string.
2319	* @param ... Arguments referenced by the format string.
2320	*/
2321	#if defined(__GNUC__) && defined(__inline__)
2322	/* Define it as static for GCC as it cannot inline functions using va_start() anyway,
2323	and linux redefines __inline__ to always inlining forcing gcc to issue an error. */
2324	static int __attribute__((__unused__))
2325	#else
2326	DECLINLINE(int)
2327	#endif
2328	RT_IPRT_FORMAT_ATTR(1, 2) SUPR0Printf(const char *pszFormat, ...)
2329	{
2330	va_list va;
2331	va_start(va, pszFormat);
2332	SUPR0PrintfV(pszFormat, va);
2333	va_end(va);
2334	return 0;
2335	}
2336
2337	/* HACK ALERT! See above. */
2338	#ifdef SUPR0PRINTF_UNDO_INLINE_HACK
2339	# define __inline__ inline
2340	#endif
2341
2342	#ifdef IN_RING0
2343	/** Debug printf macro. This also exist in SUPLib, see SUPLibInternal.h. */
2344	# ifdef DEBUG
2345	# define SUP_DPRINTF(a) SUPR0Printf a
2346	# else
2347	# define SUP_DPRINTF(a) do { } while (0)
2348	# endif
2349	#endif
2350
2351	/**
2352	* Returns configuration flags of the host kernel.
2353	*
2354	* @returns Combination of SUPKERNELFEATURES_XXX flags.
2355	*/
2356	SUPR0DECL(uint32_t) SUPR0GetKernelFeatures(void);
2357
2358	/** @copydoc RTLogDefaultInstanceEx
2359	* @remarks To allow overriding RTLogDefaultInstanceEx locally. */
2360	SUPR0DECL(struct RTLOGGER *) SUPR0DefaultLogInstanceEx(uint32_t fFlagsAndGroup);
2361	/** @copydoc RTLogGetDefaultInstanceEx
2362	* @remarks To allow overriding RTLogGetDefaultInstanceEx locally. */
2363	SUPR0DECL(struct RTLOGGER *) SUPR0GetDefaultLogInstanceEx(uint32_t fFlagsAndGroup);
2364	/** @copydoc RTLogRelGetDefaultInstanceEx
2365	* @remarks To allow overriding RTLogRelGetDefaultInstanceEx locally. */
2366	SUPR0DECL(struct RTLOGGER *) SUPR0GetDefaultLogRelInstanceEx(uint32_t fFlagsAndGroup);
2367
2368
2369	/** @name Absolute symbols
2370	* Take the address of these, don't try call them.
2371	* @{ */
2372	SUPR0DECL(void) SUPR0AbsIs64bit(void);
2373	SUPR0DECL(void) SUPR0Abs64bitKernelCS(void);
2374	SUPR0DECL(void) SUPR0Abs64bitKernelSS(void);
2375	SUPR0DECL(void) SUPR0Abs64bitKernelDS(void);
2376	SUPR0DECL(void) SUPR0AbsKernelCS(void);
2377	SUPR0DECL(void) SUPR0AbsKernelSS(void);
2378	SUPR0DECL(void) SUPR0AbsKernelDS(void);
2379	SUPR0DECL(void) SUPR0AbsKernelES(void);
2380	SUPR0DECL(void) SUPR0AbsKernelFS(void);
2381	SUPR0DECL(void) SUPR0AbsKernelGS(void);
2382	/** @} */
2383
2384	/**
2385	* Support driver component factory.
2386	*
2387	* Component factories are registered by drivers that provides services
2388	* such as the host network interface filtering and access to the host
2389	* TCP/IP stack.
2390	*
2391	* @remark Module dependencies and making sure that a component doesn't
2392	* get unloaded while in use, is the sole responsibility of the
2393	* driver/kext/whatever implementing the component.
2394	*/
2395	typedef struct SUPDRVFACTORY
2396	{
2397	/** The (unique) name of the component factory. */
2398	char szName[56];
2399	/**
2400	* Queries a factory interface.
2401	*
2402	* The factory interface is specific to each component and will be be
2403	* found in the header(s) for the component alongside its UUID.
2404	*
2405	* @returns Pointer to the factory interfaces on success, NULL on failure.
2406	*
2407	* @param pSupDrvFactory Pointer to this structure.
2408	* @param pSession The SUPDRV session making the query.
2409	* @param pszInterfaceUuid The UUID of the factory interface.
2410	*/
2411	DECLR0CALLBACKMEMBER(void , pfnQueryFactoryInterface,(struct SUPDRVFACTORY const pSupDrvFactory, PSUPDRVSESSION pSession, const char *pszInterfaceUuid));
2412	} SUPDRVFACTORY;
2413	/** Pointer to a support driver factory. */
2414	typedef SUPDRVFACTORY *PSUPDRVFACTORY;
2415	/** Pointer to a const support driver factory. */
2416	typedef SUPDRVFACTORY const *PCSUPDRVFACTORY;
2417
2418	SUPR0DECL(int) SUPR0ComponentRegisterFactory(PSUPDRVSESSION pSession, PCSUPDRVFACTORY pFactory);
2419	SUPR0DECL(int) SUPR0ComponentDeregisterFactory(PSUPDRVSESSION pSession, PCSUPDRVFACTORY pFactory);
2420	SUPR0DECL(int) SUPR0ComponentQueryFactory(PSUPDRVSESSION pSession, const char pszName, const char pszInterfaceUuid, void **ppvFactoryIf);
2421
2422
2423	/** @name Tracing
2424	* @{ */
2425
2426	/**
2427	* Tracer data associated with a provider.
2428	*/
2429	typedef union SUPDRVTRACERDATA
2430	{
2431	/** Generic */
2432	uint64_t au64[2];
2433
2434	/** DTrace data. */
2435	struct
2436	{
2437	/** Provider ID. */
2438	uintptr_t idProvider;
2439	/** The number of trace points provided. */
2440	uint32_t volatile cProvidedProbes;
2441	/** Whether we've invalidated this bugger. */
2442	bool fZombie;
2443	} DTrace;
2444	} SUPDRVTRACERDATA;
2445	/** Pointer to the tracer data associated with a provider. */
2446	typedef SUPDRVTRACERDATA *PSUPDRVTRACERDATA;
2447
2448	/**
2449	* Probe location info for ring-0.
2450	*
2451	* Since we cannot trust user tracepoint modules, we need to duplicate the probe
2452	* ID and enabled flag in ring-0.
2453	*/
2454	typedef struct SUPDRVPROBELOC
2455	{
2456	/** The probe ID. */
2457	uint32_t idProbe;
2458	/** Whether it's enabled or not. */
2459	bool fEnabled;
2460	} SUPDRVPROBELOC;
2461	/** Pointer to a ring-0 probe location record. */
2462	typedef SUPDRVPROBELOC *PSUPDRVPROBELOC;
2463
2464	/**
2465	* Probe info for ring-0.
2466	*
2467	* Since we cannot trust user tracepoint modules, we need to duplicate the
2468	* probe enable count.
2469	*/
2470	typedef struct SUPDRVPROBEINFO
2471	{
2472	/** The number of times this probe has been enabled. */
2473	uint32_t volatile cEnabled;
2474	} SUPDRVPROBEINFO;
2475	/** Pointer to a ring-0 probe info record. */
2476	typedef SUPDRVPROBEINFO *PSUPDRVPROBEINFO;
2477
2478	/**
2479	* Support driver tracepoint provider core.
2480	*/
2481	typedef struct SUPDRVVDTPROVIDERCORE
2482	{
2483	/** The tracer data member. */
2484	SUPDRVTRACERDATA TracerData;
2485	/** Pointer to the provider name (a copy that's always available). */
2486	const char *pszName;
2487	/** Pointer to the module name (a copy that's always available). */
2488	const char *pszModName;
2489
2490	/** The provider descriptor. */
2491	struct VTGDESCPROVIDER *pDesc;
2492	/** The VTG header. */
2493	struct VTGOBJHDR *pHdr;
2494
2495	/** The size of the entries in the pvProbeLocsEn table. */
2496	uint8_t cbProbeLocsEn;
2497	/** The actual module bit count (corresponds to cbProbeLocsEn). */
2498	uint8_t cBits;
2499	/** Set if this is a Umod, otherwise clear. */
2500	bool fUmod;
2501	/** Explicit alignment padding (paranoia). */
2502	uint8_t abAlignment[ARCH_BITS == 32 ? 1 : 5];
2503
2504	/** The probe locations used for descriptive purposes. */
2505	struct VTGPROBELOC const *paProbeLocsRO;
2506	/** Pointer to the probe location array where the enable flag needs
2507	* flipping. For kernel providers, this will always be SUPDRVPROBELOC,
2508	* while user providers can either be 32-bit or 64-bit. Use
2509	* cbProbeLocsEn to calculate the address of an entry. */
2510	void *pvProbeLocsEn;
2511	/** Pointer to the probe array containing the enabled counts. */
2512	uint32_t *pacProbeEnabled;
2513
2514	/** The ring-0 probe location info for user tracepoint modules.
2515	* This is NULL if fUmod is false. */
2516	PSUPDRVPROBELOC paR0ProbeLocs;
2517	/** The ring-0 probe info for user tracepoint modules.
2518	* This is NULL if fUmod is false. */
2519	PSUPDRVPROBEINFO paR0Probes;
2520
2521	} SUPDRVVDTPROVIDERCORE;
2522	/** Pointer to a tracepoint provider core structure. */
2523	typedef SUPDRVVDTPROVIDERCORE *PSUPDRVVDTPROVIDERCORE;
2524
2525	/** Pointer to a tracer registration record. */
2526	typedef struct SUPDRVTRACERREG const *PCSUPDRVTRACERREG;
2527	/**
2528	* Support driver tracer registration record.
2529	*/
2530	typedef struct SUPDRVTRACERREG
2531	{
2532	/** Magic value (SUPDRVTRACERREG_MAGIC). */
2533	uint32_t u32Magic;
2534	/** Version (SUPDRVTRACERREG_VERSION). */
2535	uint32_t u32Version;
2536
2537	/**
2538	* Fire off a kernel probe.
2539	*
2540	* @param pVtgProbeLoc The probe location record.
2541	* @param uArg0 The first raw probe argument.
2542	* @param uArg1 The second raw probe argument.
2543	* @param uArg2 The third raw probe argument.
2544	* @param uArg3 The fourth raw probe argument.
2545	* @param uArg4 The fifth raw probe argument.
2546	*
2547	* @remarks SUPR0TracerFireProbe will do a tail jump thru this member, so
2548	* no extra stack frames will be added.
2549	* @remarks This does not take a 'this' pointer argument because it doesn't map
2550	* well onto VTG or DTrace.
2551	*
2552	*/
2553	DECLR0CALLBACKMEMBER(void, pfnProbeFireKernel, (struct VTGPROBELOC *pVtgProbeLoc, uintptr_t uArg0, uintptr_t uArg1, uintptr_t uArg2,
2554	uintptr_t uArg3, uintptr_t uArg4));
2555
2556	/**
2557	* Fire off a user-mode probe.
2558	*
2559	* @param pThis Pointer to the registration record.
2560	*
2561	* @param pVtgProbeLoc The probe location record.
2562	* @param pSession The user session.
2563	* @param pCtx The usermode context info.
2564	* @param pVtgHdr The VTG header (read-only).
2565	* @param pProbeLocRO The read-only probe location record .
2566	*/
2567	DECLR0CALLBACKMEMBER(void, pfnProbeFireUser, (PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, PCSUPDRVTRACERUSRCTX pCtx,
2568	struct VTGOBJHDR const pVtgHdr, struct VTGPROBELOC const pProbeLocRO));
2569
2570	/**
2571	* Opens up the tracer.
2572	*
2573	* @returns VBox status code.
2574	* @param pThis Pointer to the registration record.
2575	* @param pSession The session doing the opening.
2576	* @param uCookie A cookie (magic) unique to the tracer, so it can
2577	* fend off incompatible clients.
2578	* @param uArg Tracer specific argument.
2579	* @param puSessionData Pointer to the session data variable. This must be
2580	* set to a non-zero value on success.
2581	*/
2582	DECLR0CALLBACKMEMBER(int, pfnTracerOpen, (PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, uint32_t uCookie, uintptr_t uArg,
2583	uintptr_t *puSessionData));
2584
2585	/**
2586	* I/O control style tracer communication method.
2587	*
2588	*
2589	* @returns VBox status code.
2590	* @param pThis Pointer to the registration record.
2591	* @param pSession The session.
2592	* @param uSessionData The session data value.
2593	* @param uCmd The tracer specific command.
2594	* @param uArg The tracer command specific argument.
2595	* @param piRetVal The tracer specific return value.
2596	*/
2597	DECLR0CALLBACKMEMBER(int, pfnTracerIoCtl, (PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, uintptr_t uSessionData,
2598	uintptr_t uCmd, uintptr_t uArg, int32_t *piRetVal));
2599
2600	/**
2601	* Cleans up data the tracer has associated with a session.
2602	*
2603	* @param pThis Pointer to the registration record.
2604	* @param pSession The session handle.
2605	* @param uSessionData The data assoicated with the session.
2606	*/
2607	DECLR0CALLBACKMEMBER(void, pfnTracerClose, (PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, uintptr_t uSessionData));
2608
2609	/**
2610	* Registers a provider.
2611	*
2612	* @returns VBox status code.
2613	* @param pThis Pointer to the registration record.
2614	* @param pCore The provider core data.
2615	*
2616	* @todo Kernel vs. Userland providers.
2617	*/
2618	DECLR0CALLBACKMEMBER(int, pfnProviderRegister, (PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore));
2619
2620	/**
2621	* Attempts to deregisters a provider.
2622	*
2623	* @returns VINF_SUCCESS or VERR_TRY_AGAIN. If the latter, the provider
2624	* should be made as harmless as possible before returning as the
2625	* VTG object and associated code will be unloaded upon return.
2626	*
2627	* @param pThis Pointer to the registration record.
2628	* @param pCore The provider core data.
2629	*/
2630	DECLR0CALLBACKMEMBER(int, pfnProviderDeregister, (PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore));
2631
2632	/**
2633	* Make another attempt at unregister a busy provider.
2634	*
2635	* @returns VINF_SUCCESS or VERR_TRY_AGAIN.
2636	* @param pThis Pointer to the registration record.
2637	* @param pCore The provider core data.
2638	*/
2639	DECLR0CALLBACKMEMBER(int, pfnProviderDeregisterZombie, (PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore));
2640
2641	/** End marker (SUPDRVTRACERREG_MAGIC). */
2642	uintptr_t uEndMagic;
2643	} SUPDRVTRACERREG;
2644
2645	/** Tracer magic (Kenny Garrett). */
2646	#define SUPDRVTRACERREG_MAGIC UINT32_C(0x19601009)
2647	/** Tracer registration structure version. */
2648	#define SUPDRVTRACERREG_VERSION RT_MAKE_U32(0, 1)
2649
2650	/** Pointer to a trace helper structure. */
2651	typedef struct SUPDRVTRACERHLP const *PCSUPDRVTRACERHLP;
2652	/**
2653	* Helper structure.
2654	*/
2655	typedef struct SUPDRVTRACERHLP
2656	{
2657	/** The structure version (SUPDRVTRACERHLP_VERSION). */
2658	uintptr_t uVersion;
2659
2660	/** @todo ... */
2661
2662	/** End marker (SUPDRVTRACERHLP_VERSION) */
2663	uintptr_t uEndVersion;
2664	} SUPDRVTRACERHLP;
2665	/** Tracer helper structure version. */
2666	#define SUPDRVTRACERHLP_VERSION RT_MAKE_U32(0, 1)
2667
2668	SUPR0DECL(int) SUPR0TracerRegisterImpl(void hMod, PSUPDRVSESSION pSession, PCSUPDRVTRACERREG pReg, PCSUPDRVTRACERHLP ppHlp);
2669	SUPR0DECL(int) SUPR0TracerDeregisterImpl(void *hMod, PSUPDRVSESSION pSession);
2670	SUPR0DECL(int) SUPR0TracerRegisterDrv(PSUPDRVSESSION pSession, struct VTGOBJHDR pVtgHdr, const char pszName);
2671	SUPR0DECL(void) SUPR0TracerDeregisterDrv(PSUPDRVSESSION pSession);
2672	SUPR0DECL(int) SUPR0TracerRegisterModule(void hMod, struct VTGOBJHDR pVtgHdr);
2673	SUPR0DECL(void) SUPR0TracerFireProbe(struct VTGPROBELOC *pVtgProbeLoc, uintptr_t uArg0, uintptr_t uArg1, uintptr_t uArg2,
2674	uintptr_t uArg3, uintptr_t uArg4);
2675	SUPR0DECL(void) SUPR0TracerUmodProbeFire(PSUPDRVSESSION pSession, PSUPDRVTRACERUSRCTX pCtx);
2676	/** @} */
2677
2678
2679	/** @defgroup grp_sup_r0_idc The IDC Interface
2680	* @{
2681	*/
2682
2683	/** The current SUPDRV IDC version.
2684	* This follows the usual high word / low word rules, i.e. high word is the
2685	* major number and it signifies incompatible interface changes. */
2686	#define SUPDRV_IDC_VERSION UINT32_C(0x00010000)
2687
2688	/**
2689	* Inter-Driver Communication Handle.
2690	*/
2691	typedef union SUPDRVIDCHANDLE
2692	{
2693	/** Padding for opaque usage.
2694	* Must be greater or equal in size than the private struct. */
2695	void *apvPadding[4];
2696	#ifdef SUPDRVIDCHANDLEPRIVATE_DECLARED
2697	/** The private view. */
2698	struct SUPDRVIDCHANDLEPRIVATE s;
2699	#endif
2700	} SUPDRVIDCHANDLE;
2701	/** Pointer to a handle. */
2702	typedef SUPDRVIDCHANDLE *PSUPDRVIDCHANDLE;
2703
2704	SUPR0DECL(int) SUPR0IdcOpen(PSUPDRVIDCHANDLE pHandle, uint32_t uReqVersion, uint32_t uMinVersion,
2705	uint32_t puSessionVersion, uint32_t puDriverVersion, uint32_t *puDriverRevision);
2706	SUPR0DECL(int) SUPR0IdcCall(PSUPDRVIDCHANDLE pHandle, uint32_t iReq, void *pvReq, uint32_t cbReq);
2707	SUPR0DECL(int) SUPR0IdcClose(PSUPDRVIDCHANDLE pHandle);
2708	SUPR0DECL(PSUPDRVSESSION) SUPR0IdcGetSession(PSUPDRVIDCHANDLE pHandle);
2709	SUPR0DECL(int) SUPR0IdcComponentRegisterFactory(PSUPDRVIDCHANDLE pHandle, PCSUPDRVFACTORY pFactory);
2710	SUPR0DECL(int) SUPR0IdcComponentDeregisterFactory(PSUPDRVIDCHANDLE pHandle, PCSUPDRVFACTORY pFactory);
2711
2712	/** @} */
2713
2714	/** @name Ring-0 module entry points.
2715	*
2716	* These can be exported by ring-0 modules SUP are told to load.
2717	*
2718	* @{ */
2719	DECLEXPORT(int) ModuleInit(void *hMod);
2720	DECLEXPORT(void) ModuleTerm(void *hMod);
2721	/** @} */
2722
2723
2724	/** @} */
2725	#endif
2726
2727
2728	/** @name Trust Anchors and Certificates
2729	* @{ */
2730
2731	/**
2732	* Trust anchor table entry (in generated Certificates.cpp).
2733	*/
2734	typedef struct SUPTAENTRY
2735	{
2736	/** Pointer to the raw bytes. */
2737	const unsigned char *pch;
2738	/** Number of bytes. */
2739	unsigned cb;
2740	} SUPTAENTRY;
2741	/** Pointer to a trust anchor table entry. */
2742	typedef SUPTAENTRY const *PCSUPTAENTRY;
2743
2744	/** Macro for simplifying generating the trust anchor tables. */
2745	#define SUPTAENTRY_GEN(a_abTA) { &a_abTA[0], sizeof(a_abTA) }
2746
2747	/** All certificates we know. */
2748	extern SUPTAENTRY const g_aSUPAllTAs[];
2749	/** Number of entries in g_aSUPAllTAs. */
2750	extern unsigned const g_cSUPAllTAs;
2751
2752	/** Software publisher certificate roots (Authenticode). */
2753	extern SUPTAENTRY const g_aSUPSpcRootTAs[];
2754	/** Number of entries in g_aSUPSpcRootTAs. */
2755	extern unsigned const g_cSUPSpcRootTAs;
2756
2757	/** Kernel root certificates used by Windows. */
2758	extern SUPTAENTRY const g_aSUPNtKernelRootTAs[];
2759	/** Number of entries in g_aSUPNtKernelRootTAs. */
2760	extern unsigned const g_cSUPNtKernelRootTAs;
2761
2762	/** Timestamp root certificates trusted by Windows. */
2763	extern SUPTAENTRY const g_aSUPTimestampTAs[];
2764	/** Number of entries in g_aSUPTimestampTAs. */
2765	extern unsigned const g_cSUPTimestampTAs;
2766
2767	/** Root certificates trusted by Apple code signing. */
2768	extern SUPTAENTRY const g_aSUPAppleRootTAs[];
2769	/** Number of entries in g_cSUPAppleRootTAs. */
2770	extern unsigned const g_cSUPAppleRootTAs;
2771
2772	/** TAs we trust (the build certificate, Oracle VirtualBox). */
2773	extern SUPTAENTRY const g_aSUPTrustedTAs[];
2774	/** Number of entries in g_aSUPTrustedTAs. */
2775	extern unsigned const g_cSUPTrustedTAs;
2776
2777	/** Supplemental certificates, like cross signing certificates. */
2778	extern SUPTAENTRY const g_aSUPSupplementalTAs[];
2779	/** Number of entries in g_aSUPTrustedTAs. */
2780	extern unsigned const g_cSUPSupplementalTAs;
2781
2782	/** The build certificate. */
2783	extern const unsigned char g_abSUPBuildCert[];
2784	/** The size of the build certificate. */
2785	extern const unsigned g_cbSUPBuildCert;
2786
2787	/** @} */
2788
2789
2790	/** @} */
2791
2792	RT_C_DECLS_END
2793
2794	#endif /* !VBOX_INCLUDED_sup_h */
2795

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

source: vbox/trunk/include/VBox/sup.h@ 93593

Download in other formats: