sup.h@ 81025

Last change on this file since 81025 was 80531, checked in by vboxsync, 5 years ago
VMM,Devices: Some PDM device model refactoring. bugref:9218
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 92.5 KB

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

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

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

Download in other formats: