sup.h@ 57059

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

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

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

Download in other formats: