sup.h@ 51714

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

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

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

Download in other formats: