sup.h@ 55461

Last change on this file since 55461 was 55436, checked in by vboxsync, 10 years ago
Reverted bad commit r99781.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 81.5 KB

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

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

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

Download in other formats: