sup.h@ 52664

Last change on this file since 52664 was 52618, checked in by vboxsync, 10 years ago
HostDrivers, Runtime, Devices, Additions: TSC delta measurement and other changes resulting from bumping supdrv major version. TSC delta measurement currently disabled.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 70.4 KB

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

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

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

Download in other formats: