VirtualBox

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

Last change on this file since 49156 was 44528, checked in by vboxsync, 12 years ago

header (C) fixes

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette