sup.h@ 56957

Last change on this file since 56957 was 56952, checked in by vboxsync, 10 years ago
sup.h: enabled compiling of SUPIsTscFreqCompatible().
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 81.9 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.215389.xyz. 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	/**
555	* Worker for SUPIsTscFreqCompatible().
556	*
557	* @param uBaseCpuHz The reference CPU frequency of the system.
558	* @param uCpuHz The CPU frequency to compare with the base.
559	*
560	* @returns true if it's compatible, false otherwise.
561	* @remarks Don't use directly, use SUPIsTscFreqCompatible() instead. This is
562	* to be used by tstGIP-2 (or the like).
563	*/
564	DECLINLINE(bool) SUPIsTscFreqCompatibleEx(uint64_t uBaseCpuHz, uint64_t uCpuHz)
565	{
566	if (uBaseCpuHz != uCpuHz)
567	{
568	/* Arbitrary tolerance threshold, tweak later if required, perhaps
569	more tolerance on lower frequencies and less tolerance on higher. */
570	uint64_t uLo = (uBaseCpuHz << 11) / 2049;
571	uint64_t uHi = uBaseCpuHz + (uBaseCpuHz - uLo);
572	if ( uCpuHz < uLo
573	\|\| uCpuHz > uHi)
574	return false;
575	}
576	return true;
577	}
578
579
580	/**
581	* Checks if the provided TSC frequency is close enough to the computed TSC
582	* frequency of the host.
583	*
584	* @param u64CpuHz The TSC frequency to check.
585	*
586	* @returns true if it's compatible, false otherwise.
587	*/
588	DECLINLINE(bool) SUPIsTscFreqCompatible(uint64_t u64CpuHz)
589	{
590	PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
591	if ( pGip
592	&& pGip->u32Mode == SUPGIPMODE_INVARIANT_TSC)
593	return SUPIsTscFreqCompatibleEx(pGip->u64CpuHz, u64CpuHz);
594	return false;
595	}
596
597
598	#if defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_X86)
599
600	/** @internal */
601	SUPDECL(uint64_t) SUPReadTscWithDelta(PSUPGLOBALINFOPAGE pGip);
602
603	/**
604	* Read the host TSC value and applies the TSC delta if appropriate.
605	*
606	* @returns the TSC value.
607	* @remarks Requires GIP to be initialized and valid.
608	*/
609	DECLINLINE(uint64_t) SUPReadTsc(void)
610	{
611	PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
612	if (pGip->enmUseTscDelta <= SUPGIPUSETSCDELTA_ROUGHLY_ZERO)
613	return ASMReadTSC();
614	return SUPReadTscWithDelta(pGip);
615	}
616
617	#endif /* X86 \|\| AMD64 */
618
619	/** @internal */
620	SUPDECL(uint64_t) SUPGetTscDeltaSlow(PSUPGLOBALINFOPAGE pGip);
621
622	/**
623	* Gets the TSC delta for the current CPU.
624	*
625	* @returns The TSC delta value (will not return the special INT64_MAX value).
626	* @remarks Requires GIP to be initialized and valid.
627	*/
628	DECLINLINE(int64_t) SUPGetTscDelta(void)
629	{
630	PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
631	if (pGip->enmUseTscDelta <= SUPGIPUSETSCDELTA_ROUGHLY_ZERO)
632	return 0;
633	return SUPGetTscDeltaSlow(pGip);
634	}
635
636
637	/**
638	* Gets the TSC delta for a given CPU.
639	*
640	* @returns The TSC delta value (will not return the special INT64_MAX value).
641	* @param iCpuSet The CPU set index of the CPU which TSC delta we want.
642	* @remarks Requires GIP to be initialized and valid.
643	*/
644	DECLINLINE(int64_t) SUPGetTscDeltaByCpuSetIndex(uint32_t iCpuSet)
645	{
646	PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
647	if (pGip->enmUseTscDelta <= SUPGIPUSETSCDELTA_ROUGHLY_ZERO)
648	return 0;
649	if (RT_LIKELY(iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx)))
650	{
651	uint16_t iCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
652	if (RT_LIKELY(iCpu < pGip->cCpus))
653	{
654	int64_t iTscDelta = pGip->aCPUs[iCpu].i64TSCDelta;
655	if (iTscDelta != INT64_MAX)
656	return iTscDelta;
657	}
658	}
659	AssertFailed();
660	return 0;
661	}
662
663
664	/**
665	* Checks if the TSC delta is available for a given CPU (if TSC-deltas are
666	* relevant).
667	*
668	* @returns true if it's okay to read the TSC, false otherwise.
669	*
670	* @param iCpuSet The CPU set index of the CPU which TSC delta we check.
671	* @remarks Requires GIP to be initialized and valid.
672	*/
673	DECLINLINE(bool) SUPIsTscDeltaAvailableForCpuSetIndex(uint32_t iCpuSet)
674	{
675	PSUPGLOBALINFOPAGE pGip = g_pSUPGlobalInfoPage;
676	if (pGip->enmUseTscDelta <= SUPGIPUSETSCDELTA_ROUGHLY_ZERO)
677	return true;
678	if (RT_LIKELY(iCpuSet < RT_ELEMENTS(pGip->aiCpuFromCpuSetIdx)))
679	{
680	uint16_t iCpu = pGip->aiCpuFromCpuSetIdx[iCpuSet];
681	if (RT_LIKELY(iCpu < pGip->cCpus))
682	{
683	int64_t iTscDelta = pGip->aCPUs[iCpu].i64TSCDelta;
684	if (iTscDelta != INT64_MAX)
685	return true;
686	}
687	}
688	return false;
689	}
690
691
692	/**
693	* Gets the descriptive GIP mode name.
694	*
695	* @returns The name.
696	* @param pGip Pointer to the GIP.
697	*/
698	DECLINLINE(const char *) SUPGetGIPModeName(PSUPGLOBALINFOPAGE pGip)
699	{
700	AssertReturn(pGip, NULL);
701	switch (pGip->u32Mode)
702	{
703	case SUPGIPMODE_INVARIANT_TSC: return "Invariant";
704	case SUPGIPMODE_SYNC_TSC: return "Synchronous";
705	case SUPGIPMODE_ASYNC_TSC: return "Asynchronous";
706	case SUPGIPMODE_INVALID: return "Invalid";
707	default: return "???";
708	}
709	}
710
711
712	/**
713	* Gets the descriptive TSC-delta enum name.
714	*
715	* @returns The name.
716	* @param pGip Pointer to the GIP.
717	*/
718	DECLINLINE(const char *) SUPGetGIPTscDeltaModeName(PSUPGLOBALINFOPAGE pGip)
719	{
720	AssertReturn(pGip, NULL);
721	switch (pGip->enmUseTscDelta)
722	{
723	case SUPGIPUSETSCDELTA_NOT_APPLICABLE: return "Not Applicable";
724	case SUPGIPUSETSCDELTA_ZERO_CLAIMED: return "Zero Claimed";
725	case SUPGIPUSETSCDELTA_PRACTICALLY_ZERO: return "Pratically Zero";
726	case SUPGIPUSETSCDELTA_ROUGHLY_ZERO: return "Roughly Zero";
727	case SUPGIPUSETSCDELTA_NOT_ZERO: return "Not Zero";
728	default: return "???";
729	}
730	}
731
732
733	/**
734	* Request for generic VMMR0Entry calls.
735	*/
736	typedef struct SUPVMMR0REQHDR
737	{
738	/** The magic. (SUPVMMR0REQHDR_MAGIC) */
739	uint32_t u32Magic;
740	/** The size of the request. */
741	uint32_t cbReq;
742	} SUPVMMR0REQHDR;
743	/** Pointer to a ring-0 request header. */
744	typedef SUPVMMR0REQHDR *PSUPVMMR0REQHDR;
745	/** the SUPVMMR0REQHDR::u32Magic value (Ethan Iverson - The Bad Plus). */
746	#define SUPVMMR0REQHDR_MAGIC UINT32_C(0x19730211)
747
748
749	/** For the fast ioctl path.
750	* @{
751	*/
752	/** @see VMMR0_DO_RAW_RUN. */
753	#define SUP_VMMR0_DO_RAW_RUN 0
754	/** @see VMMR0_DO_HM_RUN. */
755	#define SUP_VMMR0_DO_HM_RUN 1
756	/** @see VMMR0_DO_NOP */
757	#define SUP_VMMR0_DO_NOP 2
758	/** @} */
759
760	/** SUPR3QueryVTCaps capability flags
761	* @{
762	*/
763	/** AMD-V support. */
764	#define SUPVTCAPS_AMD_V RT_BIT(0)
765	/** VT-x support. */
766	#define SUPVTCAPS_VT_X RT_BIT(1)
767	/** Nested paging is supported. */
768	#define SUPVTCAPS_NESTED_PAGING RT_BIT(2)
769	/** VT-x: Unrestricted guest execution is supported. */
770	#define SUPVTCAPS_VTX_UNRESTRICTED_GUEST RT_BIT(3)
771	/** @} */
772
773	/**
774	* Request for generic FNSUPR0SERVICEREQHANDLER calls.
775	*/
776	typedef struct SUPR0SERVICEREQHDR
777	{
778	/** The magic. (SUPR0SERVICEREQHDR_MAGIC) */
779	uint32_t u32Magic;
780	/** The size of the request. */
781	uint32_t cbReq;
782	} SUPR0SERVICEREQHDR;
783	/** Pointer to a ring-0 service request header. */
784	typedef SUPR0SERVICEREQHDR *PSUPR0SERVICEREQHDR;
785	/** the SUPVMMR0REQHDR::u32Magic value (Esbjoern Svensson - E.S.P.). */
786	#define SUPR0SERVICEREQHDR_MAGIC UINT32_C(0x19640416)
787
788
789	/**
790	* Creates a single release event semaphore.
791	*
792	* @returns VBox status code.
793	* @param pSession The session handle of the caller.
794	* @param phEvent Where to return the handle to the event semaphore.
795	*/
796	SUPDECL(int) SUPSemEventCreate(PSUPDRVSESSION pSession, PSUPSEMEVENT phEvent);
797
798	/**
799	* Closes a single release event semaphore handle.
800	*
801	* @returns VBox status code.
802	* @retval VINF_OBJECT_DESTROYED if the semaphore was destroyed.
803	* @retval VINF_SUCCESS if the handle was successfully closed but the semaphore
804	* object remained alive because of other references.
805	*
806	* @param pSession The session handle of the caller.
807	* @param hEvent The handle. Nil is quietly ignored.
808	*/
809	SUPDECL(int) SUPSemEventClose(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent);
810
811	/**
812	* Signals a single release event semaphore.
813	*
814	* @returns VBox status code.
815	* @param pSession The session handle of the caller.
816	* @param hEvent The semaphore handle.
817	*/
818	SUPDECL(int) SUPSemEventSignal(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent);
819
820	#ifdef IN_RING0
821	/**
822	* Waits on a single release event semaphore, not interruptible.
823	*
824	* @returns VBox status code.
825	* @param pSession The session handle of the caller.
826	* @param hEvent The semaphore handle.
827	* @param cMillies The number of milliseconds to wait.
828	* @remarks Not available in ring-3.
829	*/
830	SUPDECL(int) SUPSemEventWait(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent, uint32_t cMillies);
831	#endif
832
833	/**
834	* Waits on a single release event semaphore, interruptible.
835	*
836	* @returns VBox status code.
837	* @param pSession The session handle of the caller.
838	* @param hEvent The semaphore handle.
839	* @param cMillies The number of milliseconds to wait.
840	*/
841	SUPDECL(int) SUPSemEventWaitNoResume(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent, uint32_t cMillies);
842
843	/**
844	* Waits on a single release event semaphore, interruptible.
845	*
846	* @returns VBox status code.
847	* @param pSession The session handle of the caller.
848	* @param hEvent The semaphore handle.
849	* @param uNsTimeout The deadline given on the RTTimeNanoTS() clock.
850	*/
851	SUPDECL(int) SUPSemEventWaitNsAbsIntr(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent, uint64_t uNsTimeout);
852
853	/**
854	* Waits on a single release event semaphore, interruptible.
855	*
856	* @returns VBox status code.
857	* @param pSession The session handle of the caller.
858	* @param hEvent The semaphore handle.
859	* @param cNsTimeout The number of nanoseconds to wait.
860	*/
861	SUPDECL(int) SUPSemEventWaitNsRelIntr(PSUPDRVSESSION pSession, SUPSEMEVENT hEvent, uint64_t cNsTimeout);
862
863	/**
864	* Gets the best timeout resolution that SUPSemEventWaitNsAbsIntr and
865	* SUPSemEventWaitNsAbsIntr can do.
866	*
867	* @returns The resolution in nanoseconds.
868	* @param pSession The session handle of the caller.
869	*/
870	SUPDECL(uint32_t) SUPSemEventGetResolution(PSUPDRVSESSION pSession);
871
872
873	/**
874	* Creates a multiple release event semaphore.
875	*
876	* @returns VBox status code.
877	* @param pSession The session handle of the caller.
878	* @param phEventMulti Where to return the handle to the event semaphore.
879	*/
880	SUPDECL(int) SUPSemEventMultiCreate(PSUPDRVSESSION pSession, PSUPSEMEVENTMULTI phEventMulti);
881
882	/**
883	* Closes a multiple release event semaphore handle.
884	*
885	* @returns VBox status code.
886	* @retval VINF_OBJECT_DESTROYED if the semaphore was destroyed.
887	* @retval VINF_SUCCESS if the handle was successfully closed but the semaphore
888	* object remained alive because of other references.
889	*
890	* @param pSession The session handle of the caller.
891	* @param hEventMulti The handle. Nil is quietly ignored.
892	*/
893	SUPDECL(int) SUPSemEventMultiClose(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti);
894
895	/**
896	* Signals a multiple release event semaphore.
897	*
898	* @returns VBox status code.
899	* @param pSession The session handle of the caller.
900	* @param hEventMulti The semaphore handle.
901	*/
902	SUPDECL(int) SUPSemEventMultiSignal(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti);
903
904	/**
905	* Resets a multiple release event semaphore.
906	*
907	* @returns VBox status code.
908	* @param pSession The session handle of the caller.
909	* @param hEventMulti The semaphore handle.
910	*/
911	SUPDECL(int) SUPSemEventMultiReset(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti);
912
913	#ifdef IN_RING0
914	/**
915	* Waits on a multiple release event semaphore, not interruptible.
916	*
917	* @returns VBox status code.
918	* @param pSession The session handle of the caller.
919	* @param hEventMulti The semaphore handle.
920	* @param cMillies The number of milliseconds to wait.
921	* @remarks Not available in ring-3.
922	*/
923	SUPDECL(int) SUPSemEventMultiWait(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti, uint32_t cMillies);
924	#endif
925
926	/**
927	* Waits on a multiple release event semaphore, interruptible.
928	*
929	* @returns VBox status code.
930	* @param pSession The session handle of the caller.
931	* @param hEventMulti The semaphore handle.
932	* @param cMillies The number of milliseconds to wait.
933	*/
934	SUPDECL(int) SUPSemEventMultiWaitNoResume(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti, uint32_t cMillies);
935
936	/**
937	* Waits on a multiple release event semaphore, interruptible.
938	*
939	* @returns VBox status code.
940	* @param pSession The session handle of the caller.
941	* @param hEventMulti The semaphore handle.
942	* @param uNsTimeout The deadline given on the RTTimeNanoTS() clock.
943	*/
944	SUPDECL(int) SUPSemEventMultiWaitNsAbsIntr(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti, uint64_t uNsTimeout);
945
946	/**
947	* Waits on a multiple release event semaphore, interruptible.
948	*
949	* @returns VBox status code.
950	* @param pSession The session handle of the caller.
951	* @param hEventMulti The semaphore handle.
952	* @param cNsTimeout The number of nanoseconds to wait.
953	*/
954	SUPDECL(int) SUPSemEventMultiWaitNsRelIntr(PSUPDRVSESSION pSession, SUPSEMEVENTMULTI hEventMulti, uint64_t cNsTimeout);
955
956	/**
957	* Gets the best timeout resolution that SUPSemEventMultiWaitNsAbsIntr and
958	* SUPSemEventMultiWaitNsRelIntr can do.
959	*
960	* @returns The resolution in nanoseconds.
961	* @param pSession The session handle of the caller.
962	*/
963	SUPDECL(uint32_t) SUPSemEventMultiGetResolution(PSUPDRVSESSION pSession);
964
965
966	#ifdef IN_RING3
967
968	/** @defgroup grp_sup_r3 SUP Host Context Ring-3 API
969	* @{
970	*/
971
972	/**
973	* Installs the support library.
974	*
975	* @returns VBox status code.
976	*/
977	SUPR3DECL(int) SUPR3Install(void);
978
979	/**
980	* Uninstalls the support library.
981	*
982	* @returns VBox status code.
983	*/
984	SUPR3DECL(int) SUPR3Uninstall(void);
985
986	/**
987	* Trusted main entry point.
988	*
989	* This is exported as "TrustedMain" by the dynamic libraries which contains the
990	* "real" application binary for which the hardened stub is built. The entry
991	* point is invoked upon successful initialization of the support library and
992	* runtime.
993	*
994	* @returns main kind of exit code.
995	* @param argc The argument count.
996	* @param argv The argument vector.
997	* @param envp The environment vector.
998	*/
999	typedef DECLCALLBACK(int) FNSUPTRUSTEDMAIN(int argc, char argv, char envp);
1000	/** Pointer to FNSUPTRUSTEDMAIN(). */
1001	typedef FNSUPTRUSTEDMAIN *PFNSUPTRUSTEDMAIN;
1002
1003	/** Which operation failed. */
1004	typedef enum SUPINITOP
1005	{
1006	/** Invalid. */
1007	kSupInitOp_Invalid = 0,
1008	/** Installation integrity error. */
1009	kSupInitOp_Integrity,
1010	/** Setuid related. */
1011	kSupInitOp_RootCheck,
1012	/** Driver related. */
1013	kSupInitOp_Driver,
1014	/** IPRT init related. */
1015	kSupInitOp_IPRT,
1016	/** Miscellaneous. */
1017	kSupInitOp_Misc,
1018	/** Place holder. */
1019	kSupInitOp_End
1020	} SUPINITOP;
1021
1022	/**
1023	* Trusted error entry point, optional.
1024	*
1025	* This is exported as "TrustedError" by the dynamic libraries which contains
1026	* the "real" application binary for which the hardened stub is built. The
1027	* hardened main() must specify SUPSECMAIN_FLAGS_TRUSTED_ERROR when calling
1028	* SUPR3HardenedMain.
1029	*
1030	* @param pszWhere Where the error occurred (function name).
1031	* @param enmWhat Which operation went wrong.
1032	* @param rc The status code.
1033	* @param pszMsgFmt Error message format string.
1034	* @param va The message format arguments.
1035	*/
1036	typedef DECLCALLBACK(void) FNSUPTRUSTEDERROR(const char pszWhere, SUPINITOP enmWhat, int rc, const char pszMsgFmt, va_list va);
1037	/** Pointer to FNSUPTRUSTEDERROR. */
1038	typedef FNSUPTRUSTEDERROR *PFNSUPTRUSTEDERROR;
1039
1040	/**
1041	* Secure main.
1042	*
1043	* This is used for the set-user-ID-on-execute binaries on unixy systems
1044	* and when using the open-vboxdrv-via-root-service setup on Windows.
1045	*
1046	* This function will perform the integrity checks of the VirtualBox
1047	* installation, open the support driver, open the root service (later),
1048	* and load the DLL corresponding to \a pszProgName and execute its main
1049	* function.
1050	*
1051	* @returns Return code appropriate for main().
1052	*
1053	* @param pszProgName The program name. This will be used to figure out which
1054	* DLL/SO/DYLIB to load and execute.
1055	* @param fFlags Flags.
1056	* @param argc The argument count.
1057	* @param argv The argument vector.
1058	* @param envp The environment vector.
1059	*/
1060	DECLHIDDEN(int) SUPR3HardenedMain(const char pszProgName, uint32_t fFlags, int argc, char argv, char *envp);
1061
1062	/** @name SUPR3HardenedMain flags.
1063	* @{ */
1064	/** Don't open the device. (Intended for VirtualBox without -startvm.) */
1065	#define SUPSECMAIN_FLAGS_DONT_OPEN_DEV RT_BIT_32(0)
1066	/** The hardened DLL has a "TrustedError" function (see FNSUPTRUSTEDERROR). */
1067	#define SUPSECMAIN_FLAGS_TRUSTED_ERROR RT_BIT_32(1)
1068	/** Hack for making VirtualBoxVM use VirtualBox.dylib on Mac OS X. */
1069	#define SUPSECMAIN_FLAGS_OSX_VM_APP RT_BIT_32(2)
1070	/** Program binary location mask. */
1071	#define SUPSECMAIN_FLAGS_LOC_MASK UINT32_C(0x00000010)
1072	/** Default binary location is the application binary directory. Does
1073	* not need to be given explicitly (it's 0). */
1074	#define SUPSECMAIN_FLAGS_LOC_APP_BIN UINT32_C(0x00000000)
1075	/** The binary is located in the testcase directory instead of the
1076	* default application binary directory. */
1077	#define SUPSECMAIN_FLAGS_LOC_TESTCASE UINT32_C(0x00000010)
1078	/** @} */
1079
1080	/**
1081	* Initializes the support library.
1082	*
1083	* Each successful call to SUPR3Init() or SUPR3InitEx must be countered by a
1084	* call to SUPR3Term(false).
1085	*
1086	* @returns VBox status code.
1087	* @param ppSession Where to store the session handle. Defaults to NULL.
1088	*/
1089	SUPR3DECL(int) SUPR3Init(PSUPDRVSESSION *ppSession);
1090
1091
1092	/**
1093	* Initializes the support library, extended version.
1094	*
1095	* Each successful call to SUPR3Init() or SUPR3InitEx must be countered by a
1096	* call to SUPR3Term(false).
1097	*
1098	* @returns VBox status code.
1099	* @param fUnrestricted The desired access.
1100	* @param ppSession Where to store the session handle. Defaults to NULL.
1101	*/
1102	SUPR3DECL(int) SUPR3InitEx(bool fUnrestricted, PSUPDRVSESSION *ppSession);
1103
1104	/**
1105	* Terminates the support library.
1106	*
1107	* @returns VBox status code.
1108	* @param fForced Forced termination. This means to ignore the
1109	* init call count and just terminated.
1110	*/
1111	#ifdef __cplusplus
1112	SUPR3DECL(int) SUPR3Term(bool fForced = false);
1113	#else
1114	SUPR3DECL(int) SUPR3Term(int fForced);
1115	#endif
1116
1117	/**
1118	* Sets the ring-0 VM handle for use with fast IOCtls.
1119	*
1120	* @returns VBox status code.
1121	* @param pVMR0 The ring-0 VM handle.
1122	* NIL_RTR0PTR can be used to unset the handle when the
1123	* VM is about to be destroyed.
1124	*/
1125	SUPR3DECL(int) SUPR3SetVMForFastIOCtl(PVMR0 pVMR0);
1126
1127	/**
1128	* Calls the HC R0 VMM entry point.
1129	* See VMMR0Entry() for more details.
1130	*
1131	* @returns error code specific to uFunction.
1132	* @param pVMR0 Pointer to the Ring-0 (Host Context) mapping of the VM structure.
1133	* @param idCpu The virtual CPU ID.
1134	* @param uOperation Operation to execute.
1135	* @param pvArg Argument.
1136	*/
1137	SUPR3DECL(int) SUPR3CallVMMR0(PVMR0 pVMR0, VMCPUID idCpu, unsigned uOperation, void *pvArg);
1138
1139	/**
1140	* Variant of SUPR3CallVMMR0, except that this takes the fast ioclt path
1141	* regardsless of compile-time defaults.
1142	*
1143	* @returns VBox status code.
1144	* @param pVMR0 The ring-0 VM handle.
1145	* @param uOperation The operation; only the SUP_VMMR0_DO_* ones are valid.
1146	* @param idCpu The virtual CPU ID.
1147	*/
1148	SUPR3DECL(int) SUPR3CallVMMR0Fast(PVMR0 pVMR0, unsigned uOperation, VMCPUID idCpu);
1149
1150	/**
1151	* Calls the HC R0 VMM entry point, in a safer but slower manner than
1152	* SUPR3CallVMMR0. When entering using this call the R0 components can call
1153	* into the host kernel (i.e. use the SUPR0 and RT APIs).
1154	*
1155	* See VMMR0Entry() for more details.
1156	*
1157	* @returns error code specific to uFunction.
1158	* @param pVMR0 Pointer to the Ring-0 (Host Context) mapping of the VM structure.
1159	* @param idCpu The virtual CPU ID.
1160	* @param uOperation Operation to execute.
1161	* @param u64Arg Constant argument.
1162	* @param pReqHdr Pointer to a request header. Optional.
1163	* This will be copied in and out of kernel space. There currently is a size
1164	* limit on this, just below 4KB.
1165	*/
1166	SUPR3DECL(int) SUPR3CallVMMR0Ex(PVMR0 pVMR0, VMCPUID idCpu, unsigned uOperation, uint64_t u64Arg, PSUPVMMR0REQHDR pReqHdr);
1167
1168	/**
1169	* Calls a ring-0 service.
1170	*
1171	* The operation and the request packet is specific to the service.
1172	*
1173	* @returns error code specific to uFunction.
1174	* @param pszService The service name.
1175	* @param cchService The length of the service name.
1176	* @param uReq The request number.
1177	* @param u64Arg Constant argument.
1178	* @param pReqHdr Pointer to a request header. Optional.
1179	* This will be copied in and out of kernel space. There currently is a size
1180	* limit on this, just below 4KB.
1181	*/
1182	SUPR3DECL(int) SUPR3CallR0Service(const char *pszService, size_t cchService, uint32_t uOperation, uint64_t u64Arg, PSUPR0SERVICEREQHDR pReqHdr);
1183
1184	/** Which logger. */
1185	typedef enum SUPLOGGER
1186	{
1187	SUPLOGGER_DEBUG = 1,
1188	SUPLOGGER_RELEASE
1189	} SUPLOGGER;
1190
1191	/**
1192	* Changes the settings of the specified ring-0 logger.
1193	*
1194	* @returns VBox status code.
1195	* @param enmWhich Which logger.
1196	* @param pszFlags The flags settings.
1197	* @param pszGroups The groups settings.
1198	* @param pszDest The destination specificier.
1199	*/
1200	SUPR3DECL(int) SUPR3LoggerSettings(SUPLOGGER enmWhich, const char pszFlags, const char pszGroups, const char *pszDest);
1201
1202	/**
1203	* Creates a ring-0 logger instance.
1204	*
1205	* @returns VBox status code.
1206	* @param enmWhich Which logger to create.
1207	* @param pszFlags The flags settings.
1208	* @param pszGroups The groups settings.
1209	* @param pszDest The destination specificier.
1210	*/
1211	SUPR3DECL(int) SUPR3LoggerCreate(SUPLOGGER enmWhich, const char pszFlags, const char pszGroups, const char *pszDest);
1212
1213	/**
1214	* Destroys a ring-0 logger instance.
1215	*
1216	* @returns VBox status code.
1217	* @param enmWhich Which logger.
1218	*/
1219	SUPR3DECL(int) SUPR3LoggerDestroy(SUPLOGGER enmWhich);
1220
1221	/**
1222	* Queries the paging mode of the host OS.
1223	*
1224	* @returns The paging mode.
1225	*/
1226	SUPR3DECL(SUPPAGINGMODE) SUPR3GetPagingMode(void);
1227
1228	/**
1229	* Allocate zero-filled pages.
1230	*
1231	* Use this to allocate a number of pages suitable for seeding / locking.
1232	* Call SUPR3PageFree() to free the pages once done with them.
1233	*
1234	* @returns VBox status.
1235	* @param cPages Number of pages to allocate.
1236	* @param ppvPages Where to store the base pointer to the allocated pages.
1237	*/
1238	SUPR3DECL(int) SUPR3PageAlloc(size_t cPages, void **ppvPages);
1239
1240	/**
1241	* Frees pages allocated with SUPR3PageAlloc().
1242	*
1243	* @returns VBox status.
1244	* @param pvPages Pointer returned by SUPR3PageAlloc().
1245	* @param cPages Number of pages that was allocated.
1246	*/
1247	SUPR3DECL(int) SUPR3PageFree(void *pvPages, size_t cPages);
1248
1249	/**
1250	* Allocate non-zeroed, locked, pages with user and, optionally, kernel
1251	* mappings.
1252	*
1253	* Use SUPR3PageFreeEx() to free memory allocated with this function.
1254	*
1255	* @returns VBox status code.
1256	* @param cPages The number of pages to allocate.
1257	* @param fFlags Flags, reserved. Must be zero.
1258	* @param ppvPages Where to store the address of the user mapping.
1259	* @param pR0Ptr Where to store the address of the kernel mapping.
1260	* NULL if no kernel mapping is desired.
1261	* @param paPages Where to store the physical addresses of each page.
1262	* Optional.
1263	*/
1264	SUPR3DECL(int) SUPR3PageAllocEx(size_t cPages, uint32_t fFlags, void **ppvPages, PRTR0PTR pR0Ptr, PSUPPAGE paPages);
1265
1266	/**
1267	* Maps a portion of a ring-3 only allocation into kernel space.
1268	*
1269	* @returns VBox status code.
1270	*
1271	* @param pvR3 The address SUPR3PageAllocEx return.
1272	* @param off Offset to start mapping at. Must be page aligned.
1273	* @param cb Number of bytes to map. Must be page aligned.
1274	* @param fFlags Flags, must be zero.
1275	* @param pR0Ptr Where to store the address on success.
1276	*
1277	*/
1278	SUPR3DECL(int) SUPR3PageMapKernel(void *pvR3, uint32_t off, uint32_t cb, uint32_t fFlags, PRTR0PTR pR0Ptr);
1279
1280	/**
1281	* Changes the protection of
1282	*
1283	* @returns VBox status code.
1284	* @retval VERR_NOT_SUPPORTED if the OS doesn't allow us to change page level
1285	* protection. See also RTR0MemObjProtect.
1286	*
1287	* @param pvR3 The ring-3 address SUPR3PageAllocEx returned.
1288	* @param R0Ptr The ring-0 address SUPR3PageAllocEx returned if it
1289	* is desired that the corresponding ring-0 page
1290	* mappings should change protection as well. Pass
1291	* NIL_RTR0PTR if the ring-0 pages should remain
1292	* unaffected.
1293	* @param off Offset to start at which to start chagning the page
1294	* level protection. Must be page aligned.
1295	* @param cb Number of bytes to change. Must be page aligned.
1296	* @param fProt The new page level protection, either a combination
1297	* of RTMEM_PROT_READ, RTMEM_PROT_WRITE and
1298	* RTMEM_PROT_EXEC, or just RTMEM_PROT_NONE.
1299	*/
1300	SUPR3DECL(int) SUPR3PageProtect(void *pvR3, RTR0PTR R0Ptr, uint32_t off, uint32_t cb, uint32_t fProt);
1301
1302	/**
1303	* Free pages allocated by SUPR3PageAllocEx.
1304	*
1305	* @returns VBox status code.
1306	* @param pvPages The address of the user mapping.
1307	* @param cPages The number of pages.
1308	*/
1309	SUPR3DECL(int) SUPR3PageFreeEx(void *pvPages, size_t cPages);
1310
1311	/**
1312	* Allocated memory with page aligned memory with a contiguous and locked physical
1313	* memory backing below 4GB.
1314	*
1315	* @returns Pointer to the allocated memory (virtual address).
1316	* *pHCPhys is set to the physical address of the memory.
1317	* If ppvR0 isn't NULL, *ppvR0 is set to the ring-0 mapping.
1318	* The returned memory must be freed using SUPR3ContFree().
1319	* @returns NULL on failure.
1320	* @param cPages Number of pages to allocate.
1321	* @param pR0Ptr Where to store the ring-0 mapping of the allocation. (optional)
1322	* @param pHCPhys Where to store the physical address of the memory block.
1323	*
1324	* @remark This 2nd version of this API exists because we're not able to map the
1325	* ring-3 mapping executable on WIN64. This is a serious problem in regard to
1326	* the world switchers.
1327	*/
1328	SUPR3DECL(void *) SUPR3ContAlloc(size_t cPages, PRTR0PTR pR0Ptr, PRTHCPHYS pHCPhys);
1329
1330	/**
1331	* Frees memory allocated with SUPR3ContAlloc().
1332	*
1333	* @returns VBox status code.
1334	* @param pv Pointer to the memory block which should be freed.
1335	* @param cPages Number of pages to be freed.
1336	*/
1337	SUPR3DECL(int) SUPR3ContFree(void *pv, size_t cPages);
1338
1339	/**
1340	* Allocated non contiguous physical memory below 4GB.
1341	*
1342	* The memory isn't zeroed.
1343	*
1344	* @returns VBox status code.
1345	* @returns NULL on failure.
1346	* @param cPages Number of pages to allocate.
1347	* @param ppvPages Where to store the pointer to the allocated memory.
1348	* The pointer stored here on success must be passed to
1349	* SUPR3LowFree when the memory should be released.
1350	* @param ppvPagesR0 Where to store the ring-0 pointer to the allocated memory. optional.
1351	* @param paPages Where to store the physical addresses of the individual pages.
1352	*/
1353	SUPR3DECL(int) SUPR3LowAlloc(size_t cPages, void **ppvPages, PRTR0PTR ppvPagesR0, PSUPPAGE paPages);
1354
1355	/**
1356	* Frees memory allocated with SUPR3LowAlloc().
1357	*
1358	* @returns VBox status code.
1359	* @param pv Pointer to the memory block which should be freed.
1360	* @param cPages Number of pages that was allocated.
1361	*/
1362	SUPR3DECL(int) SUPR3LowFree(void *pv, size_t cPages);
1363
1364	/**
1365	* Load a module into R0 HC.
1366	*
1367	* This will verify the file integrity in a similar manner as
1368	* SUPR3HardenedVerifyFile before loading it.
1369	*
1370	* @returns VBox status code.
1371	* @param pszFilename The path to the image file.
1372	* @param pszModule The module name. Max 32 bytes.
1373	* @param ppvImageBase Where to store the image address.
1374	* @param pErrInfo Where to return extended error information.
1375	* Optional.
1376	*/
1377	SUPR3DECL(int) SUPR3LoadModule(const char pszFilename, const char pszModule, void **ppvImageBase, PRTERRINFO pErrInfo);
1378
1379	/**
1380	* Load a module into R0 HC.
1381	*
1382	* This will verify the file integrity in a similar manner as
1383	* SUPR3HardenedVerifyFile before loading it.
1384	*
1385	* @returns VBox status code.
1386	* @param pszFilename The path to the image file.
1387	* @param pszModule The module name. Max 32 bytes.
1388	* @param pszSrvReqHandler The name of the service request handler entry
1389	* point. See FNSUPR0SERVICEREQHANDLER.
1390	* @param ppvImageBase Where to store the image address.
1391	*/
1392	SUPR3DECL(int) SUPR3LoadServiceModule(const char pszFilename, const char pszModule,
1393	const char pszSrvReqHandler, void *ppvImageBase);
1394
1395	/**
1396	* Frees a R0 HC module.
1397	*
1398	* @returns VBox status code.
1399	* @param pszModule The module to free.
1400	* @remark This will not actually 'free' the module, there are of course usage counting.
1401	*/
1402	SUPR3DECL(int) SUPR3FreeModule(void *pvImageBase);
1403
1404	/**
1405	* Lock down the module loader interface.
1406	*
1407	* This will lock down the module loader interface. No new modules can be
1408	* loaded and all loaded modules can no longer be freed.
1409	*
1410	* @returns VBox status code.
1411	* @param pErrInfo Where to return extended error information.
1412	* Optional.
1413	*/
1414	SUPR3DECL(int) SUPR3LockDownLoader(PRTERRINFO pErrInfo);
1415
1416	/**
1417	* Get the address of a symbol in a ring-0 module.
1418	*
1419	* @returns VBox status code.
1420	* @param pszModule The module name.
1421	* @param pszSymbol Symbol name. If it's value is less than 64k it's treated like a
1422	* ordinal value rather than a string pointer.
1423	* @param ppvValue Where to store the symbol value.
1424	*/
1425	SUPR3DECL(int) SUPR3GetSymbolR0(void pvImageBase, const char pszSymbol, void **ppvValue);
1426
1427	/**
1428	* Load R0 HC VMM code.
1429	*
1430	* @returns VBox status code.
1431	* @deprecated Use SUPR3LoadModule(pszFilename, "VMMR0.r0", &pvImageBase)
1432	*/
1433	SUPR3DECL(int) SUPR3LoadVMM(const char *pszFilename);
1434
1435	/**
1436	* Unloads R0 HC VMM code.
1437	*
1438	* @returns VBox status code.
1439	* @deprecated Use SUPR3FreeModule().
1440	*/
1441	SUPR3DECL(int) SUPR3UnloadVMM(void);
1442
1443	/**
1444	* Get the physical address of the GIP.
1445	*
1446	* @returns VBox status code.
1447	* @param pHCPhys Where to store the physical address of the GIP.
1448	*/
1449	SUPR3DECL(int) SUPR3GipGetPhys(PRTHCPHYS pHCPhys);
1450
1451	/**
1452	* Initializes only the bits relevant for the SUPR3HardenedVerify* APIs.
1453	*
1454	* This is for users that don't necessarily need to initialize the whole of
1455	* SUPLib. There is no harm in calling this one more time.
1456	*
1457	* @returns VBox status code.
1458	* @remarks Currently not counted, so only call once.
1459	*/
1460	SUPR3DECL(int) SUPR3HardenedVerifyInit(void);
1461
1462	/**
1463	* Reverses the effect of SUPR3HardenedVerifyInit if SUPR3InitEx hasn't been
1464	* called.
1465	*
1466	* Ignored if the support library was initialized using SUPR3Init or
1467	* SUPR3InitEx.
1468	*
1469	* @returns VBox status code.
1470	*/
1471	SUPR3DECL(int) SUPR3HardenedVerifyTerm(void);
1472
1473	/**
1474	* Verifies the integrity of a file, and optionally opens it.
1475	*
1476	* The integrity check is for whether the file is suitable for loading into
1477	* the hypervisor or VM process. The integrity check may include verifying
1478	* the authenticode/elfsign/whatever signature of the file, which can take
1479	* a little while.
1480	*
1481	* @returns VBox status code. On failure it will have printed a LogRel message.
1482	*
1483	* @param pszFilename The file.
1484	* @param pszWhat For the LogRel on failure.
1485	* @param phFile Where to store the handle to the opened file. This is optional, pass NULL
1486	* if the file should not be opened.
1487	* @deprecated Write a new one.
1488	*/
1489	SUPR3DECL(int) SUPR3HardenedVerifyFile(const char pszFilename, const char pszWhat, PRTFILE phFile);
1490
1491	/**
1492	* Verifies the integrity of a the current process, including the image
1493	* location and that the invocation was absolute.
1494	*
1495	* This must currently be called after initializing the runtime. The intended
1496	* audience is set-uid-to-root applications, root services and similar.
1497	*
1498	* @returns VBox status code. On failure
1499	* message.
1500	* @param pszArgv0 The first argument to main().
1501	* @param fInternal Set this to @c true if this is an internal
1502	* VirtualBox application. Otherwise pass @c false.
1503	* @param pErrInfo Where to return extended error information.
1504	*/
1505	SUPR3DECL(int) SUPR3HardenedVerifySelf(const char *pszArgv0, bool fInternal, PRTERRINFO pErrInfo);
1506
1507	/**
1508	* Verifies the integrity of an installation directory.
1509	*
1510	* The integrity check verifies that the directory cannot be tampered with by
1511	* normal users on the system. On Unix this translates to root ownership and
1512	* no symbolic linking.
1513	*
1514	* @returns VBox status code. On failure a message will be stored in @a pszErr.
1515	*
1516	* @param pszDirPath The directory path.
1517	* @param fRecursive Whether the check should be recursive or
1518	* not. When set, all sub-directores will be checked,
1519	* including files (@a fCheckFiles is ignored).
1520	* @param fCheckFiles Whether to apply the same basic integrity check to
1521	* the files in the directory as the directory itself.
1522	* @param pErrInfo Where to return extended error information.
1523	* Optional.
1524	*/
1525	SUPR3DECL(int) SUPR3HardenedVerifyDir(const char *pszDirPath, bool fRecursive, bool fCheckFiles, PRTERRINFO pErrInfo);
1526
1527	/**
1528	* Verifies the integrity of a plug-in module.
1529	*
1530	* This is similar to SUPR3HardenedLdrLoad, except it does not load the module
1531	* and that the module does not have to be shipped with VirtualBox.
1532	*
1533	* @returns VBox status code. On failure a message will be stored in @a pszErr.
1534	*
1535	* @param pszFilename The filename of the plug-in module (nothing can be
1536	* omitted here).
1537	* @param pErrInfo Where to return extended error information.
1538	* Optional.
1539	*/
1540	SUPR3DECL(int) SUPR3HardenedVerifyPlugIn(const char *pszFilename, PRTERRINFO pErrInfo);
1541
1542	/**
1543	* Same as RTLdrLoad() but will verify the files it loads (hardened builds).
1544	*
1545	* Will add dll suffix if missing and try load the file.
1546	*
1547	* @returns iprt status code.
1548	* @param pszFilename Image filename. This must have a path.
1549	* @param phLdrMod Where to store the handle to the loaded module.
1550	* @param fFlags See RTLDRLOAD_FLAGS_XXX.
1551	* @param pErrInfo Where to return extended error information.
1552	* Optional.
1553	*/
1554	SUPR3DECL(int) SUPR3HardenedLdrLoad(const char *pszFilename, PRTLDRMOD phLdrMod, uint32_t fFlags, PRTERRINFO pErrInfo);
1555
1556	/**
1557	* Same as RTLdrLoadAppPriv() but it will verify the files it loads (hardened
1558	* builds).
1559	*
1560	* Will add dll suffix to the file if missing, then look for it in the
1561	* architecture dependent application directory.
1562	*
1563	* @returns iprt status code.
1564	* @param pszFilename Image filename.
1565	* @param phLdrMod Where to store the handle to the loaded module.
1566	* @param fFlags See RTLDRLOAD_FLAGS_XXX.
1567	* @param pErrInfo Where to return extended error information.
1568	* Optional.
1569	*/
1570	SUPR3DECL(int) SUPR3HardenedLdrLoadAppPriv(const char *pszFilename, PRTLDRMOD phLdrMod, uint32_t fFlags, PRTERRINFO pErrInfo);
1571
1572	/**
1573	* Same as RTLdrLoad() but will verify the files it loads (hardened builds).
1574	*
1575	* This differs from SUPR3HardenedLdrLoad() in that it can load modules from
1576	* extension packs and anything else safely installed on the system, provided
1577	* they pass the hardening tests.
1578	*
1579	* @returns iprt status code.
1580	* @param pszFilename The full path to the module, with extension.
1581	* @param phLdrMod Where to store the handle to the loaded module.
1582	* @param pErrInfo Where to return extended error information.
1583	* Optional.
1584	*/
1585	SUPR3DECL(int) SUPR3HardenedLdrLoadPlugIn(const char *pszFilename, PRTLDRMOD phLdrMod, PRTERRINFO pErrInfo);
1586
1587	/**
1588	* Check if the host kernel can run in VMX root mode.
1589	*
1590	* @returns VINF_SUCCESS if supported, error code indicating why if not.
1591	*/
1592	SUPR3DECL(int) SUPR3QueryVTxSupported(void);
1593
1594	/**
1595	* Return VT-x/AMD-V capabilities.
1596	*
1597	* @returns VINF_SUCCESS if supported, error code indicating why if not.
1598	* @param pfCaps Pointer to capability dword (out).
1599	* @todo Intended for main, which means we need to relax the privilege requires
1600	* when accessing certain vboxdrv functions.
1601	*/
1602	SUPR3DECL(int) SUPR3QueryVTCaps(uint32_t *pfCaps);
1603
1604	/**
1605	* Open the tracer.
1606	*
1607	* @returns VBox status code.
1608	* @param uCookie Cookie identifying the tracer we expect to talk to.
1609	* @param uArg Tracer specific open argument.
1610	*/
1611	SUPR3DECL(int) SUPR3TracerOpen(uint32_t uCookie, uintptr_t uArg);
1612
1613	/**
1614	* Closes the tracer.
1615	*
1616	* @returns VBox status code.
1617	*/
1618	SUPR3DECL(int) SUPR3TracerClose(void);
1619
1620	/**
1621	* Perform an I/O request on the tracer.
1622	*
1623	* @returns VBox status.
1624	* @param uCmd The tracer command.
1625	* @param uArg The argument.
1626	* @param piRetVal Where to store the tracer return value.
1627	*/
1628	SUPR3DECL(int) SUPR3TracerIoCtl(uintptr_t uCmd, uintptr_t uArg, int32_t *piRetVal);
1629
1630	/**
1631	* Registers the user module with the tracer.
1632	*
1633	* @returns VBox status code.
1634	* @param hModNative Native module handle. Pass ~(uintptr_t)0 if not
1635	* at hand.
1636	* @param pszModule The module name.
1637	* @param pVtgHdr The VTG header.
1638	* @param uVtgHdrAddr The address to which the VTG header is loaded
1639	* in the relevant execution context.
1640	* @param fFlags See SUP_TRACER_UMOD_FLAGS_XXX
1641	*/
1642	SUPR3DECL(int) SUPR3TracerRegisterModule(uintptr_t hModNative, const char pszModule, struct VTGOBJHDR pVtgHdr,
1643	RTUINTPTR uVtgHdrAddr, uint32_t fFlags);
1644
1645	/**
1646	* Deregisters the user module.
1647	*
1648	* @returns VBox status code.
1649	* @param pVtgHdr The VTG header.
1650	*/
1651	SUPR3DECL(int) SUPR3TracerDeregisterModule(struct VTGOBJHDR *pVtgHdr);
1652
1653	/**
1654	* Fire the probe.
1655	*
1656	* @param pVtgProbeLoc The probe location record.
1657	* @param uArg0 Raw probe argument 0.
1658	* @param uArg1 Raw probe argument 1.
1659	* @param uArg2 Raw probe argument 2.
1660	* @param uArg3 Raw probe argument 3.
1661	* @param uArg4 Raw probe argument 4.
1662	*/
1663	SUPDECL(void) SUPTracerFireProbe(struct VTGPROBELOC *pVtgProbeLoc, uintptr_t uArg0, uintptr_t uArg1, uintptr_t uArg2,
1664	uintptr_t uArg3, uintptr_t uArg4);
1665
1666
1667	/**
1668	* Attempts to read the value of an MSR.
1669	*
1670	* @returns VBox status code.
1671	* @param uMsr The MSR to read.
1672	* @param idCpu The CPU to read it on, NIL_RTCPUID if it doesn't
1673	* matter which CPU.
1674	* @param puValue Where to return the value.
1675	* @param pfGp Where to store the \#GP indicator for the read
1676	* operation.
1677	*/
1678	SUPR3DECL(int) SUPR3MsrProberRead(uint32_t uMsr, RTCPUID idCpu, uint64_t puValue, bool pfGp);
1679
1680	/**
1681	* Attempts to write to an MSR.
1682	*
1683	* @returns VBox status code.
1684	* @param uMsr The MSR to write to.
1685	* @param idCpu The CPU to wrtie it on, NIL_RTCPUID if it
1686	* doesn't matter which CPU.
1687	* @param uValue The value to write.
1688	* @param pfGp Where to store the \#GP indicator for the write
1689	* operation.
1690	*/
1691	SUPR3DECL(int) SUPR3MsrProberWrite(uint32_t uMsr, RTCPUID idCpu, uint64_t uValue, bool *pfGp);
1692
1693	/**
1694	* Attempts to modify the value of an MSR.
1695	*
1696	* @returns VBox status code.
1697	* @param uMsr The MSR to modify.
1698	* @param idCpu The CPU to modify it on, NIL_RTCPUID if it
1699	* doesn't matter which CPU.
1700	* @param fAndMask The bits to keep in the current MSR value.
1701	* @param fOrMask The bits to set before writing.
1702	* @param pResult The result buffer.
1703	*/
1704	SUPR3DECL(int) SUPR3MsrProberModify(uint32_t uMsr, RTCPUID idCpu, uint64_t fAndMask, uint64_t fOrMask,
1705	PSUPMSRPROBERMODIFYRESULT pResult);
1706
1707	/**
1708	* Attempts to modify the value of an MSR, extended version.
1709	*
1710	* @returns VBox status code.
1711	* @param uMsr The MSR to modify.
1712	* @param idCpu The CPU to modify it on, NIL_RTCPUID if it
1713	* doesn't matter which CPU.
1714	* @param fAndMask The bits to keep in the current MSR value.
1715	* @param fOrMask The bits to set before writing.
1716	* @param fFaster If set to @c true some cache/tlb invalidation is
1717	* skipped, otherwise behave like
1718	* SUPR3MsrProberModify.
1719	* @param pResult The result buffer.
1720	*/
1721	SUPR3DECL(int) SUPR3MsrProberModifyEx(uint32_t uMsr, RTCPUID idCpu, uint64_t fAndMask, uint64_t fOrMask, bool fFaster,
1722	PSUPMSRPROBERMODIFYRESULT pResult);
1723
1724	/**
1725	* Resume built-in keyboard on MacBook Air and Pro hosts.
1726	*
1727	* @returns VBox status code.
1728	*/
1729	SUPR3DECL(int) SUPR3ResumeSuspendedKeyboards(void);
1730
1731
1732	/**
1733	* Measure the TSC-delta for the specified CPU.
1734	*
1735	* @returns VBox status code.
1736	* @param idCpu The CPU to measure the TSC-delta for.
1737	* @param fAsync Whether the measurement is asynchronous, returns
1738	* immediately after signalling a measurement
1739	* request.
1740	* @param fForce Whether to perform a measurement even if the
1741	* specified CPU has a (possibly) valid TSC delta.
1742	* @param cRetries Number of times to retry failed delta
1743	* measurements.
1744	* @param cMsWaitRetry Number of milliseconds to wait between retries.
1745	*/
1746	SUPR3DECL(int) SUPR3TscDeltaMeasure(RTCPUID idCpu, bool fAsync, bool fForce, uint8_t cRetries, uint8_t cMsWaitRetry);
1747
1748	/**
1749	* Reads the delta-adjust TSC value.
1750	*
1751	* @returns VBox status code.
1752	* @param puTsc Where to store the read TSC value.
1753	* @param pidApic Where to store the APIC ID of the CPU where the TSC
1754	* was read (optional, can be NULL).
1755	*/
1756	SUPR3DECL(int) SUPR3ReadTsc(uint64_t puTsc, uint16_t pidApic);
1757
1758	/** @} */
1759	#endif /* IN_RING3 */
1760
1761
1762	/** @name User mode module flags (SUPR3TracerRegisterModule & SUP_IOCTL_TRACER_UMOD_REG).
1763	* @{ */
1764	/** Executable image. */
1765	#define SUP_TRACER_UMOD_FLAGS_EXE UINT32_C(1)
1766	/** Shared library (DLL, DYLIB, SO, etc). */
1767	#define SUP_TRACER_UMOD_FLAGS_SHARED UINT32_C(2)
1768	/** Image type mask. */
1769	#define SUP_TRACER_UMOD_FLAGS_TYPE_MASK UINT32_C(3)
1770	/** @} */
1771
1772
1773	#ifdef IN_RING0
1774	/** @defgroup grp_sup_r0 SUP Host Context Ring-0 API
1775	* @{
1776	*/
1777
1778	/**
1779	* Security objectype.
1780	*/
1781	typedef enum SUPDRVOBJTYPE
1782	{
1783	/** The usual invalid object. */
1784	SUPDRVOBJTYPE_INVALID = 0,
1785	/** A Virtual Machine instance. */
1786	SUPDRVOBJTYPE_VM,
1787	/** Internal network. */
1788	SUPDRVOBJTYPE_INTERNAL_NETWORK,
1789	/** Internal network interface. */
1790	SUPDRVOBJTYPE_INTERNAL_NETWORK_INTERFACE,
1791	/** Single release event semaphore. */
1792	SUPDRVOBJTYPE_SEM_EVENT,
1793	/** Multiple release event semaphore. */
1794	SUPDRVOBJTYPE_SEM_EVENT_MULTI,
1795	/** Raw PCI device. */
1796	SUPDRVOBJTYPE_RAW_PCI_DEVICE,
1797	/** The first invalid object type in this end. */
1798	SUPDRVOBJTYPE_END,
1799	/** The usual 32-bit type size hack. */
1800	SUPDRVOBJTYPE_32_BIT_HACK = 0x7ffffff
1801	} SUPDRVOBJTYPE;
1802
1803	/**
1804	* Object destructor callback.
1805	* This is called for reference counted objectes when the count reaches 0.
1806	*
1807	* @param pvObj The object pointer.
1808	* @param pvUser1 The first user argument.
1809	* @param pvUser2 The second user argument.
1810	*/
1811	typedef DECLCALLBACK(void) FNSUPDRVDESTRUCTOR(void pvObj, void pvUser1, void *pvUser2);
1812	/** Pointer to a FNSUPDRVDESTRUCTOR(). */
1813	typedef FNSUPDRVDESTRUCTOR *PFNSUPDRVDESTRUCTOR;
1814
1815	SUPR0DECL(void ) SUPR0ObjRegister(PSUPDRVSESSION pSession, SUPDRVOBJTYPE enmType, PFNSUPDRVDESTRUCTOR pfnDestructor, void pvUser1, void *pvUser2);
1816	SUPR0DECL(int) SUPR0ObjAddRef(void *pvObj, PSUPDRVSESSION pSession);
1817	SUPR0DECL(int) SUPR0ObjAddRefEx(void *pvObj, PSUPDRVSESSION pSession, bool fNoBlocking);
1818	SUPR0DECL(int) SUPR0ObjRelease(void *pvObj, PSUPDRVSESSION pSession);
1819	SUPR0DECL(int) SUPR0ObjVerifyAccess(void pvObj, PSUPDRVSESSION pSession, const char pszObjName);
1820
1821	SUPR0DECL(int) SUPR0LockMem(PSUPDRVSESSION pSession, RTR3PTR pvR3, uint32_t cPages, PRTHCPHYS paPages);
1822	SUPR0DECL(int) SUPR0UnlockMem(PSUPDRVSESSION pSession, RTR3PTR pvR3);
1823	SUPR0DECL(int) SUPR0ContAlloc(PSUPDRVSESSION pSession, uint32_t cPages, PRTR0PTR ppvR0, PRTR3PTR ppvR3, PRTHCPHYS pHCPhys);
1824	SUPR0DECL(int) SUPR0ContFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr);
1825	SUPR0DECL(int) SUPR0LowAlloc(PSUPDRVSESSION pSession, uint32_t cPages, PRTR0PTR ppvR0, PRTR3PTR ppvR3, PRTHCPHYS paPages);
1826	SUPR0DECL(int) SUPR0LowFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr);
1827	SUPR0DECL(int) SUPR0MemAlloc(PSUPDRVSESSION pSession, uint32_t cb, PRTR0PTR ppvR0, PRTR3PTR ppvR3);
1828	SUPR0DECL(int) SUPR0MemGetPhys(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr, PSUPPAGE paPages);
1829	SUPR0DECL(int) SUPR0MemFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr);
1830	SUPR0DECL(int) SUPR0PageAllocEx(PSUPDRVSESSION pSession, uint32_t cPages, uint32_t fFlags, PRTR3PTR ppvR3, PRTR0PTR ppvR0, PRTHCPHYS paPages);
1831	SUPR0DECL(int) SUPR0PageMapKernel(PSUPDRVSESSION pSession, RTR3PTR pvR3, uint32_t offSub, uint32_t cbSub, uint32_t fFlags, PRTR0PTR ppvR0);
1832	SUPR0DECL(int) SUPR0PageProtect(PSUPDRVSESSION pSession, RTR3PTR pvR3, RTR0PTR pvR0, uint32_t offSub, uint32_t cbSub, uint32_t fProt);
1833	SUPR0DECL(int) SUPR0PageFree(PSUPDRVSESSION pSession, RTR3PTR pvR3);
1834	SUPR0DECL(int) SUPR0GipMap(PSUPDRVSESSION pSession, PRTR3PTR ppGipR3, PRTHCPHYS pHCPhysGip);
1835	SUPR0DECL(int) SUPR0GetSvmUsability(bool fInitSvm);
1836	SUPR0DECL(int) SUPR0GetVmxUsability(bool *pfIsSmxModeAmbiguous);
1837	SUPR0DECL(int) SUPR0QueryVTCaps(PSUPDRVSESSION pSession, uint32_t *pfCaps);
1838	SUPR0DECL(int) SUPR0GipUnmap(PSUPDRVSESSION pSession);
1839	SUPR0DECL(int) SUPR0Printf(const char *pszFormat, ...);
1840	SUPR0DECL(SUPPAGINGMODE) SUPR0GetPagingMode(void);
1841	SUPR0DECL(uint32_t) SUPR0GetKernelFeatures(void);
1842	SUPR0DECL(RTCCUINTREG) SUPR0ChangeCR4(RTCCUINTREG fOrMask, RTCCUINTREG fAndMask);
1843	SUPR0DECL(int) SUPR0EnableVTx(bool fEnable);
1844	SUPR0DECL(bool) SUPR0SuspendVTxOnCpu(void);
1845	SUPR0DECL(void) SUPR0ResumeVTxOnCpu(bool fSuspended);
1846	#define SUP_TSCDELTA_MEASURE_F_FORCE RT_BIT_32(0)
1847	#define SUP_TSCDELTA_MEASURE_F_ASYNC RT_BIT_32(1)
1848	#define SUP_TSCDELTA_MEASURE_F_VALID_MASK UINT32_C(0x00000003)
1849	SUPR0DECL(int) SUPR0TscDeltaMeasureBySetIndex(PSUPDRVSESSION pSession, uint32_t iCpuSet, uint32_t fFlags,
1850	RTMSINTERVAL cMsWaitRetry, RTMSINTERVAL cMsWaitThread, uint32_t cTries);
1851
1852	/** @name Absolute symbols
1853	* Take the address of these, don't try call them.
1854	* @{ */
1855	SUPR0DECL(void) SUPR0AbsIs64bit(void);
1856	SUPR0DECL(void) SUPR0Abs64bitKernelCS(void);
1857	SUPR0DECL(void) SUPR0Abs64bitKernelSS(void);
1858	SUPR0DECL(void) SUPR0Abs64bitKernelDS(void);
1859	SUPR0DECL(void) SUPR0AbsKernelCS(void);
1860	SUPR0DECL(void) SUPR0AbsKernelSS(void);
1861	SUPR0DECL(void) SUPR0AbsKernelDS(void);
1862	SUPR0DECL(void) SUPR0AbsKernelES(void);
1863	SUPR0DECL(void) SUPR0AbsKernelFS(void);
1864	SUPR0DECL(void) SUPR0AbsKernelGS(void);
1865	/** @} */
1866
1867	/**
1868	* Support driver component factory.
1869	*
1870	* Component factories are registered by drivers that provides services
1871	* such as the host network interface filtering and access to the host
1872	* TCP/IP stack.
1873	*
1874	* @remark Module dependencies and making sure that a component doesn't
1875	* get unloaded while in use, is the sole responsibility of the
1876	* driver/kext/whatever implementing the component.
1877	*/
1878	typedef struct SUPDRVFACTORY
1879	{
1880	/** The (unique) name of the component factory. */
1881	char szName[56];
1882	/**
1883	* Queries a factory interface.
1884	*
1885	* The factory interface is specific to each component and will be be
1886	* found in the header(s) for the component alongside its UUID.
1887	*
1888	* @returns Pointer to the factory interfaces on success, NULL on failure.
1889	*
1890	* @param pSupDrvFactory Pointer to this structure.
1891	* @param pSession The SUPDRV session making the query.
1892	* @param pszInterfaceUuid The UUID of the factory interface.
1893	*/
1894	DECLR0CALLBACKMEMBER(void , pfnQueryFactoryInterface,(struct SUPDRVFACTORY const pSupDrvFactory, PSUPDRVSESSION pSession, const char *pszInterfaceUuid));
1895	} SUPDRVFACTORY;
1896	/** Pointer to a support driver factory. */
1897	typedef SUPDRVFACTORY *PSUPDRVFACTORY;
1898	/** Pointer to a const support driver factory. */
1899	typedef SUPDRVFACTORY const *PCSUPDRVFACTORY;
1900
1901	SUPR0DECL(int) SUPR0ComponentRegisterFactory(PSUPDRVSESSION pSession, PCSUPDRVFACTORY pFactory);
1902	SUPR0DECL(int) SUPR0ComponentDeregisterFactory(PSUPDRVSESSION pSession, PCSUPDRVFACTORY pFactory);
1903	SUPR0DECL(int) SUPR0ComponentQueryFactory(PSUPDRVSESSION pSession, const char pszName, const char pszInterfaceUuid, void **ppvFactoryIf);
1904
1905
1906	/** @name Tracing
1907	* @{ */
1908
1909	/**
1910	* Tracer data associated with a provider.
1911	*/
1912	typedef union SUPDRVTRACERDATA
1913	{
1914	/** Generic */
1915	uint64_t au64[2];
1916
1917	/** DTrace data. */
1918	struct
1919	{
1920	/** Provider ID. */
1921	uintptr_t idProvider;
1922	/** The number of trace points provided. */
1923	uint32_t volatile cProvidedProbes;
1924	/** Whether we've invalidated this bugger. */
1925	bool fZombie;
1926	} DTrace;
1927	} SUPDRVTRACERDATA;
1928	/** Pointer to the tracer data associated with a provider. */
1929	typedef SUPDRVTRACERDATA *PSUPDRVTRACERDATA;
1930
1931	/**
1932	* Probe location info for ring-0.
1933	*
1934	* Since we cannot trust user tracepoint modules, we need to duplicate the probe
1935	* ID and enabled flag in ring-0.
1936	*/
1937	typedef struct SUPDRVPROBELOC
1938	{
1939	/** The probe ID. */
1940	uint32_t idProbe;
1941	/** Whether it's enabled or not. */
1942	bool fEnabled;
1943	} SUPDRVPROBELOC;
1944	/** Pointer to a ring-0 probe location record. */
1945	typedef SUPDRVPROBELOC *PSUPDRVPROBELOC;
1946
1947	/**
1948	* Probe info for ring-0.
1949	*
1950	* Since we cannot trust user tracepoint modules, we need to duplicate the
1951	* probe enable count.
1952	*/
1953	typedef struct SUPDRVPROBEINFO
1954	{
1955	/** The number of times this probe has been enabled. */
1956	uint32_t volatile cEnabled;
1957	} SUPDRVPROBEINFO;
1958	/** Pointer to a ring-0 probe info record. */
1959	typedef SUPDRVPROBEINFO *PSUPDRVPROBEINFO;
1960
1961	/**
1962	* Support driver tracepoint provider core.
1963	*/
1964	typedef struct SUPDRVVDTPROVIDERCORE
1965	{
1966	/** The tracer data member. */
1967	SUPDRVTRACERDATA TracerData;
1968	/** Pointer to the provider name (a copy that's always available). */
1969	const char *pszName;
1970	/** Pointer to the module name (a copy that's always available). */
1971	const char *pszModName;
1972
1973	/** The provider descriptor. */
1974	struct VTGDESCPROVIDER *pDesc;
1975	/** The VTG header. */
1976	struct VTGOBJHDR *pHdr;
1977
1978	/** The size of the entries in the pvProbeLocsEn table. */
1979	uint8_t cbProbeLocsEn;
1980	/** The actual module bit count (corresponds to cbProbeLocsEn). */
1981	uint8_t cBits;
1982	/** Set if this is a Umod, otherwise clear.. */
1983	bool fUmod;
1984	/** Explicit alignment padding (paranoia). */
1985	uint8_t abAlignment[ARCH_BITS == 32 ? 1 : 5];
1986
1987	/** The probe locations used for descriptive purposes. */
1988	struct VTGPROBELOC const *paProbeLocsRO;
1989	/** Pointer to the probe location array where the enable flag needs
1990	* flipping. For kernel providers, this will always be SUPDRVPROBELOC,
1991	* while user providers can either be 32-bit or 64-bit. Use
1992	* cbProbeLocsEn to calculate the address of an entry. */
1993	void *pvProbeLocsEn;
1994	/** Pointer to the probe array containing the enabled counts. */
1995	uint32_t *pacProbeEnabled;
1996
1997	/** The ring-0 probe location info for user tracepoint modules.
1998	* This is NULL if fUmod is false. */
1999	PSUPDRVPROBELOC paR0ProbeLocs;
2000	/** The ring-0 probe info for user tracepoint modules.
2001	* This is NULL if fUmod is false. */
2002	PSUPDRVPROBEINFO paR0Probes;
2003
2004	} SUPDRVVDTPROVIDERCORE;
2005	/** Pointer to a tracepoint provider core structure. */
2006	typedef SUPDRVVDTPROVIDERCORE *PSUPDRVVDTPROVIDERCORE;
2007
2008	/** Pointer to a tracer registration record. */
2009	typedef struct SUPDRVTRACERREG const *PCSUPDRVTRACERREG;
2010	/**
2011	* Support driver tracer registration record.
2012	*/
2013	typedef struct SUPDRVTRACERREG
2014	{
2015	/** Magic value (SUPDRVTRACERREG_MAGIC). */
2016	uint32_t u32Magic;
2017	/** Version (SUPDRVTRACERREG_VERSION). */
2018	uint32_t u32Version;
2019
2020	/**
2021	* Fire off a kernel probe.
2022	*
2023	* @param pVtgProbeLoc The probe location record.
2024	* @param uArg0 The first raw probe argument.
2025	* @param uArg1 The second raw probe argument.
2026	* @param uArg2 The third raw probe argument.
2027	* @param uArg3 The fourth raw probe argument.
2028	* @param uArg4 The fifth raw probe argument.
2029	*
2030	* @remarks SUPR0TracerFireProbe will do a tail jump thru this member, so
2031	* no extra stack frames will be added.
2032	* @remarks This does not take a 'this' pointer argument because it doesn't map
2033	* well onto VTG or DTrace.
2034	*
2035	*/
2036	DECLR0CALLBACKMEMBER(void, pfnProbeFireKernel, (struct VTGPROBELOC *pVtgProbeLoc, uintptr_t uArg0, uintptr_t uArg1, uintptr_t uArg2,
2037	uintptr_t uArg3, uintptr_t uArg4));
2038
2039	/**
2040	* Fire off a user-mode probe.
2041	*
2042	* @param pThis Pointer to the registration record.
2043	*
2044	* @param pVtgProbeLoc The probe location record.
2045	* @param pSession The user session.
2046	* @param pCtx The usermode context info.
2047	* @param pVtgHdr The VTG header (read-only).
2048	* @param pProbeLocRO The read-only probe location record .
2049	*/
2050	DECLR0CALLBACKMEMBER(void, pfnProbeFireUser, (PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, PCSUPDRVTRACERUSRCTX pCtx,
2051	struct VTGOBJHDR const pVtgHdr, struct VTGPROBELOC const pProbeLocRO));
2052
2053	/**
2054	* Opens up the tracer.
2055	*
2056	* @returns VBox status code.
2057	* @param pThis Pointer to the registration record.
2058	* @param pSession The session doing the opening.
2059	* @param uCookie A cookie (magic) unique to the tracer, so it can
2060	* fend off incompatible clients.
2061	* @param uArg Tracer specific argument.
2062	* @param puSessionData Pointer to the session data variable. This must be
2063	* set to a non-zero value on success.
2064	*/
2065	DECLR0CALLBACKMEMBER(int, pfnTracerOpen, (PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, uint32_t uCookie, uintptr_t uArg,
2066	uintptr_t *puSessionData));
2067
2068	/**
2069	* I/O control style tracer communication method.
2070	*
2071	*
2072	* @returns VBox status code.
2073	* @param pThis Pointer to the registration record.
2074	* @param pSession The session.
2075	* @param uSessionData The session data value.
2076	* @param uCmd The tracer specific command.
2077	* @param uArg The tracer command specific argument.
2078	* @param piRetVal The tracer specific return value.
2079	*/
2080	DECLR0CALLBACKMEMBER(int, pfnTracerIoCtl, (PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, uintptr_t uSessionData,
2081	uintptr_t uCmd, uintptr_t uArg, int32_t *piRetVal));
2082
2083	/**
2084	* Cleans up data the tracer has associated with a session.
2085	*
2086	* @param pThis Pointer to the registration record.
2087	* @param pSession The session handle.
2088	* @param uSessionData The data assoicated with the session.
2089	*/
2090	DECLR0CALLBACKMEMBER(void, pfnTracerClose, (PCSUPDRVTRACERREG pThis, PSUPDRVSESSION pSession, uintptr_t uSessionData));
2091
2092	/**
2093	* Registers a provider.
2094	*
2095	* @returns VBox status code.
2096	* @param pThis Pointer to the registration record.
2097	* @param pCore The provider core data.
2098	*
2099	* @todo Kernel vs. Userland providers.
2100	*/
2101	DECLR0CALLBACKMEMBER(int, pfnProviderRegister, (PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore));
2102
2103	/**
2104	* Attempts to deregisters a provider.
2105	*
2106	* @returns VINF_SUCCESS or VERR_TRY_AGAIN. If the latter, the provider
2107	* should be made as harmless as possible before returning as the
2108	* VTG object and associated code will be unloaded upon return.
2109	*
2110	* @param pThis Pointer to the registration record.
2111	* @param pCore The provider core data.
2112	*/
2113	DECLR0CALLBACKMEMBER(int, pfnProviderDeregister, (PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore));
2114
2115	/**
2116	* Make another attempt at unregister a busy provider.
2117	*
2118	* @returns VINF_SUCCESS or VERR_TRY_AGAIN.
2119	* @param pThis Pointer to the registration record.
2120	* @param pCore The provider core data.
2121	*/
2122	DECLR0CALLBACKMEMBER(int, pfnProviderDeregisterZombie, (PCSUPDRVTRACERREG pThis, PSUPDRVVDTPROVIDERCORE pCore));
2123
2124	/** End marker (SUPDRVTRACERREG_MAGIC). */
2125	uintptr_t uEndMagic;
2126	} SUPDRVTRACERREG;
2127
2128	/** Tracer magic (Kenny Garrett). */
2129	#define SUPDRVTRACERREG_MAGIC UINT32_C(0x19601009)
2130	/** Tracer registration structure version. */
2131	#define SUPDRVTRACERREG_VERSION RT_MAKE_U32(0, 1)
2132
2133	/** Pointer to a trace helper structure. */
2134	typedef struct SUPDRVTRACERHLP const *PCSUPDRVTRACERHLP;
2135	/**
2136	* Helper structure.
2137	*/
2138	typedef struct SUPDRVTRACERHLP
2139	{
2140	/** The structure version (SUPDRVTRACERHLP_VERSION). */
2141	uintptr_t uVersion;
2142
2143	/** @todo ... */
2144
2145	/** End marker (SUPDRVTRACERHLP_VERSION) */
2146	uintptr_t uEndVersion;
2147	} SUPDRVTRACERHLP;
2148	/** Tracer helper structure version. */
2149	#define SUPDRVTRACERHLP_VERSION RT_MAKE_U32(0, 1)
2150
2151	SUPR0DECL(int) SUPR0TracerRegisterImpl(void hMod, PSUPDRVSESSION pSession, PCSUPDRVTRACERREG pReg, PCSUPDRVTRACERHLP ppHlp);
2152	SUPR0DECL(int) SUPR0TracerDeregisterImpl(void *hMod, PSUPDRVSESSION pSession);
2153	SUPR0DECL(int) SUPR0TracerRegisterDrv(PSUPDRVSESSION pSession, struct VTGOBJHDR pVtgHdr, const char pszName);
2154	SUPR0DECL(void) SUPR0TracerDeregisterDrv(PSUPDRVSESSION pSession);
2155	SUPR0DECL(int) SUPR0TracerRegisterModule(void hMod, struct VTGOBJHDR pVtgHdr);
2156	SUPR0DECL(void) SUPR0TracerFireProbe(struct VTGPROBELOC *pVtgProbeLoc, uintptr_t uArg0, uintptr_t uArg1, uintptr_t uArg2,
2157	uintptr_t uArg3, uintptr_t uArg4);
2158	SUPR0DECL(void) SUPR0TracerUmodProbeFire(PSUPDRVSESSION pSession, PSUPDRVTRACERUSRCTX pCtx);
2159	/** @} */
2160
2161
2162	/**
2163	* Service request callback function.
2164	*
2165	* @returns VBox status code.
2166	* @param pSession The caller's session.
2167	* @param u64Arg 64-bit integer argument.
2168	* @param pReqHdr The request header. Input / Output. Optional.
2169	*/
2170	typedef DECLCALLBACK(int) FNSUPR0SERVICEREQHANDLER(PSUPDRVSESSION pSession, uint32_t uOperation,
2171	uint64_t u64Arg, PSUPR0SERVICEREQHDR pReqHdr);
2172	/** Pointer to a FNR0SERVICEREQHANDLER(). */
2173	typedef R0PTRTYPE(FNSUPR0SERVICEREQHANDLER *) PFNSUPR0SERVICEREQHANDLER;
2174
2175
2176	/** @defgroup grp_sup_r0_idc The IDC Interface
2177	* @{
2178	*/
2179
2180	/** The current SUPDRV IDC version.
2181	* This follows the usual high word / low word rules, i.e. high word is the
2182	* major number and it signifies incompatible interface changes. */
2183	#define SUPDRV_IDC_VERSION UINT32_C(0x00010000)
2184
2185	/**
2186	* Inter-Driver Communication Handle.
2187	*/
2188	typedef union SUPDRVIDCHANDLE
2189	{
2190	/** Padding for opaque usage.
2191	* Must be greater or equal in size than the private struct. */
2192	void *apvPadding[4];
2193	#ifdef SUPDRVIDCHANDLEPRIVATE_DECLARED
2194	/** The private view. */
2195	struct SUPDRVIDCHANDLEPRIVATE s;
2196	#endif
2197	} SUPDRVIDCHANDLE;
2198	/** Pointer to a handle. */
2199	typedef SUPDRVIDCHANDLE *PSUPDRVIDCHANDLE;
2200
2201	SUPR0DECL(int) SUPR0IdcOpen(PSUPDRVIDCHANDLE pHandle, uint32_t uReqVersion, uint32_t uMinVersion,
2202	uint32_t puSessionVersion, uint32_t puDriverVersion, uint32_t *puDriverRevision);
2203	SUPR0DECL(int) SUPR0IdcCall(PSUPDRVIDCHANDLE pHandle, uint32_t iReq, void *pvReq, uint32_t cbReq);
2204	SUPR0DECL(int) SUPR0IdcClose(PSUPDRVIDCHANDLE pHandle);
2205	SUPR0DECL(PSUPDRVSESSION) SUPR0IdcGetSession(PSUPDRVIDCHANDLE pHandle);
2206	SUPR0DECL(int) SUPR0IdcComponentRegisterFactory(PSUPDRVIDCHANDLE pHandle, PCSUPDRVFACTORY pFactory);
2207	SUPR0DECL(int) SUPR0IdcComponentDeregisterFactory(PSUPDRVIDCHANDLE pHandle, PCSUPDRVFACTORY pFactory);
2208
2209	/** @} */
2210
2211	/** @name Ring-0 module entry points.
2212	*
2213	* These can be exported by ring-0 modules SUP are told to load.
2214	*
2215	* @{ */
2216	DECLEXPORT(int) ModuleInit(void *hMod);
2217	DECLEXPORT(void) ModuleTerm(void *hMod);
2218	/** @} */
2219
2220
2221	/** @} */
2222	#endif
2223
2224
2225	/** @name Trust Anchors and Certificates
2226	* @{ */
2227
2228	/**
2229	* Trust anchor table entry (in generated Certificates.cpp).
2230	*/
2231	typedef struct SUPTAENTRY
2232	{
2233	/** Pointer to the raw bytes. */
2234	const unsigned char *pch;
2235	/** Number of bytes. */
2236	unsigned cb;
2237	} SUPTAENTRY;
2238	/** Pointer to a trust anchor table entry. */
2239	typedef SUPTAENTRY const *PCSUPTAENTRY;
2240
2241	/** Macro for simplifying generating the trust anchor tables. */
2242	#define SUPTAENTRY_GEN(a_abTA) { &a_abTA[0], sizeof(a_abTA) }
2243
2244	/** All certificates we know. */
2245	extern SUPTAENTRY const g_aSUPAllTAs[];
2246	/** Number of entries in g_aSUPAllTAs. */
2247	extern unsigned const g_cSUPAllTAs;
2248
2249	/** Software publisher certificate roots (Authenticode). */
2250	extern SUPTAENTRY const g_aSUPSpcRootTAs[];
2251	/** Number of entries in g_aSUPSpcRootTAs. */
2252	extern unsigned const g_cSUPSpcRootTAs;
2253
2254	/** Kernel root certificates used by Windows. */
2255	extern SUPTAENTRY const g_aSUPNtKernelRootTAs[];
2256	/** Number of entries in g_aSUPNtKernelRootTAs. */
2257	extern unsigned const g_cSUPNtKernelRootTAs;
2258
2259	/** Timestamp root certificates trusted by Windows. */
2260	extern SUPTAENTRY const g_aSUPTimestampTAs[];
2261	/** Number of entries in g_aSUPTimestampTAs. */
2262	extern unsigned const g_cSUPTimestampTAs;
2263
2264	/** TAs we trust (the build certificate, Oracle VirtualBox). */
2265	extern SUPTAENTRY const g_aSUPTrustedTAs[];
2266	/** Number of entries in g_aSUPTrustedTAs. */
2267	extern unsigned const g_cSUPTrustedTAs;
2268
2269	/** Supplemental certificates, like cross signing certificates. */
2270	extern SUPTAENTRY const g_aSUPSupplementalTAs[];
2271	/** Number of entries in g_aSUPTrustedTAs. */
2272	extern unsigned const g_cSUPSupplementalTAs;
2273
2274	/** The build certificate. */
2275	extern const unsigned char g_abSUPBuildCert[];
2276	/** The size of the build certificate. */
2277	extern const unsigned g_cbSUPBuildCert;
2278
2279	/** @} */
2280
2281
2282	/** @} */
2283
2284	RT_C_DECLS_END
2285
2286	#endif
2287

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

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

Download in other formats: