sup.h@ 54309

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

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

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

Download in other formats: