1 | /* $Id: SUPDrvInternal.h 58873 2015-11-26 02:20:06Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * VirtualBox Support Driver - Internal header.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2006-2015 Oracle Corporation
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
10 | * available from http://www.virtualbox.org. This file is free software;
|
---|
11 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
12 | * General Public License (GPL) as published by the Free Software
|
---|
13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
16 | *
|
---|
17 | * The contents of this file may alternatively be used under the terms
|
---|
18 | * of the Common Development and Distribution License Version 1.0
|
---|
19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
20 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
21 | * CDDL are applicable instead of those of the GPL.
|
---|
22 | *
|
---|
23 | * You may elect to license modified versions of this file under the
|
---|
24 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
25 | */
|
---|
26 |
|
---|
27 | #ifndef ___SUPDrvInternal_h
|
---|
28 | #define ___SUPDrvInternal_h
|
---|
29 |
|
---|
30 |
|
---|
31 | /*******************************************************************************
|
---|
32 | * Header Files *
|
---|
33 | *******************************************************************************/
|
---|
34 | #include <VBox/cdefs.h>
|
---|
35 | #include <VBox/types.h>
|
---|
36 | #include <VBox/sup.h>
|
---|
37 |
|
---|
38 | #include <iprt/assert.h>
|
---|
39 | #include <iprt/list.h>
|
---|
40 | #include <iprt/memobj.h>
|
---|
41 | #include <iprt/time.h>
|
---|
42 | #include <iprt/timer.h>
|
---|
43 | #include <iprt/string.h>
|
---|
44 | #include <iprt/err.h>
|
---|
45 |
|
---|
46 | #ifdef SUPDRV_AGNOSTIC
|
---|
47 | /* do nothing */
|
---|
48 |
|
---|
49 | #elif defined(RT_OS_WINDOWS)
|
---|
50 | RT_C_DECLS_BEGIN
|
---|
51 | # if (_MSC_VER >= 1400) && !defined(VBOX_WITH_PATCHED_DDK)
|
---|
52 | # define _InterlockedExchange _InterlockedExchange_StupidDDKVsCompilerCrap
|
---|
53 | # define _InterlockedExchangeAdd _InterlockedExchangeAdd_StupidDDKVsCompilerCrap
|
---|
54 | # define _InterlockedCompareExchange _InterlockedCompareExchange_StupidDDKVsCompilerCrap
|
---|
55 | # define _InterlockedAddLargeStatistic _InterlockedAddLargeStatistic_StupidDDKVsCompilerCrap
|
---|
56 | # define _interlockedbittestandset _interlockedbittestandset_StupidDDKVsCompilerCrap
|
---|
57 | # define _interlockedbittestandreset _interlockedbittestandreset_StupidDDKVsCompilerCrap
|
---|
58 | # define _interlockedbittestandset64 _interlockedbittestandset64_StupidDDKVsCompilerCrap
|
---|
59 | # define _interlockedbittestandreset64 _interlockedbittestandreset64_StupidDDKVsCompilerCrap
|
---|
60 | # pragma warning(disable : 4163)
|
---|
61 | # include <iprt/nt/nt.h>
|
---|
62 | # pragma warning(default : 4163)
|
---|
63 | # undef _InterlockedExchange
|
---|
64 | # undef _InterlockedExchangeAdd
|
---|
65 | # undef _InterlockedCompareExchange
|
---|
66 | # undef _InterlockedAddLargeStatistic
|
---|
67 | # undef _interlockedbittestandset
|
---|
68 | # undef _interlockedbittestandreset
|
---|
69 | # undef _interlockedbittestandset64
|
---|
70 | # undef _interlockedbittestandreset64
|
---|
71 | # else
|
---|
72 | # include <iprt/nt/nt.h>
|
---|
73 | # endif
|
---|
74 | # include <memory.h>
|
---|
75 | RT_C_DECLS_END
|
---|
76 |
|
---|
77 | #elif defined(RT_OS_LINUX)
|
---|
78 | # include <linux/version.h>
|
---|
79 | # if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 33)
|
---|
80 | # include <generated/autoconf.h>
|
---|
81 | # else
|
---|
82 | # ifndef AUTOCONF_INCLUDED
|
---|
83 | # include <linux/autoconf.h>
|
---|
84 | # endif
|
---|
85 | # endif
|
---|
86 | # if defined(CONFIG_MODVERSIONS) && !defined(MODVERSIONS)
|
---|
87 | # define MODVERSIONS
|
---|
88 | # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 71)
|
---|
89 | # include <linux/modversions.h>
|
---|
90 | # endif
|
---|
91 | # endif
|
---|
92 | # if LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 0)
|
---|
93 | # undef ALIGN
|
---|
94 | # endif
|
---|
95 | # ifndef KBUILD_STR
|
---|
96 | # if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 16)
|
---|
97 | # define KBUILD_STR(s) s
|
---|
98 | # else
|
---|
99 | # define KBUILD_STR(s) #s
|
---|
100 | # endif
|
---|
101 | # endif
|
---|
102 | # include <linux/string.h>
|
---|
103 | # include <linux/spinlock.h>
|
---|
104 | # include <linux/slab.h>
|
---|
105 | # if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 27)
|
---|
106 | # include <linux/semaphore.h>
|
---|
107 | # else /* older kernels */
|
---|
108 | # include <asm/semaphore.h>
|
---|
109 | # endif /* older kernels */
|
---|
110 | # include <linux/timer.h>
|
---|
111 |
|
---|
112 | #elif defined(RT_OS_DARWIN)
|
---|
113 | # include <libkern/libkern.h>
|
---|
114 | # include <iprt/string.h>
|
---|
115 |
|
---|
116 | #elif defined(RT_OS_OS2)
|
---|
117 |
|
---|
118 | #elif defined(RT_OS_FREEBSD)
|
---|
119 | # define memset libkern_memset /** @todo these are just hacks to get it compiling, check out later. */
|
---|
120 | # define memcmp libkern_memcmp
|
---|
121 | # define strchr libkern_strchr
|
---|
122 | # define strrchr libkern_strrchr
|
---|
123 | # define ffsl libkern_ffsl
|
---|
124 | # define fls libkern_fls
|
---|
125 | # define flsl libkern_flsl
|
---|
126 | # include <sys/libkern.h>
|
---|
127 | # undef memset
|
---|
128 | # undef memcmp
|
---|
129 | # undef strchr
|
---|
130 | # undef strrchr
|
---|
131 | # undef ffs
|
---|
132 | # undef ffsl
|
---|
133 | # undef fls
|
---|
134 | # undef flsl
|
---|
135 | # include <iprt/string.h>
|
---|
136 |
|
---|
137 | #elif defined(RT_OS_SOLARIS)
|
---|
138 | # include <sys/cmn_err.h>
|
---|
139 | # include <iprt/string.h>
|
---|
140 |
|
---|
141 | #else
|
---|
142 | # error "unsupported OS."
|
---|
143 | #endif
|
---|
144 |
|
---|
145 | #include "SUPDrvIOC.h"
|
---|
146 | #include "SUPDrvIDC.h"
|
---|
147 |
|
---|
148 |
|
---|
149 |
|
---|
150 | /*******************************************************************************
|
---|
151 | * Defined Constants And Macros *
|
---|
152 | *******************************************************************************/
|
---|
153 | /*
|
---|
154 | * Hardcoded cookies.
|
---|
155 | */
|
---|
156 | #define BIRD 0x64726962 /* 'bird' */
|
---|
157 | #define BIRD_INV 0x62697264 /* 'drib' */
|
---|
158 |
|
---|
159 |
|
---|
160 | #ifdef RT_OS_WINDOWS
|
---|
161 | /** Use a normal mutex for the loader so we remain at the same IRQL after
|
---|
162 | * taking it.
|
---|
163 | * @todo fix the mutex implementation on linux and make this the default. */
|
---|
164 | # define SUPDRV_USE_MUTEX_FOR_LDR
|
---|
165 |
|
---|
166 | /** Use a normal mutex for the GIP so we remain at the same IRQL after
|
---|
167 | * taking it.
|
---|
168 | * @todo fix the mutex implementation on linux and make this the default. */
|
---|
169 | # define SUPDRV_USE_MUTEX_FOR_GIP
|
---|
170 | #endif
|
---|
171 |
|
---|
172 |
|
---|
173 | /**
|
---|
174 | * OS debug print macro.
|
---|
175 | */
|
---|
176 | #define OSDBGPRINT(a) SUPR0Printf a
|
---|
177 |
|
---|
178 | /** Debug printf macro shared with the ring-3 part. */
|
---|
179 | #ifdef DEBUG_bird
|
---|
180 | # define SUP_DPRINTF(a) SUPR0Printf a
|
---|
181 | #else
|
---|
182 | # define SUP_DPRINTF(a) do { } while (0)
|
---|
183 | #endif
|
---|
184 |
|
---|
185 |
|
---|
186 | /** @name Context values for the per-session handle tables.
|
---|
187 | * The context value is used to distinguish between the different kinds of
|
---|
188 | * handles, making the handle table API do all the work.
|
---|
189 | * @{ */
|
---|
190 | /** Handle context value for single release event handles. */
|
---|
191 | #define SUPDRV_HANDLE_CTX_EVENT ((void *)(uintptr_t)(SUPDRVOBJTYPE_SEM_EVENT))
|
---|
192 | /** Handle context value for multiple release event handles. */
|
---|
193 | #define SUPDRV_HANDLE_CTX_EVENT_MULTI ((void *)(uintptr_t)(SUPDRVOBJTYPE_SEM_EVENT_MULTI))
|
---|
194 | /** @} */
|
---|
195 |
|
---|
196 |
|
---|
197 | /**
|
---|
198 | * Validates a session pointer.
|
---|
199 | *
|
---|
200 | * @returns true/false accordingly.
|
---|
201 | * @param pSession The session.
|
---|
202 | */
|
---|
203 | #define SUP_IS_SESSION_VALID(pSession) \
|
---|
204 | ( VALID_PTR(pSession) \
|
---|
205 | && pSession->u32Cookie == BIRD_INV)
|
---|
206 |
|
---|
207 | /**
|
---|
208 | * Validates a device extension pointer.
|
---|
209 | *
|
---|
210 | * @returns true/false accordingly.
|
---|
211 | * @param pDevExt The device extension.
|
---|
212 | */
|
---|
213 | #define SUP_IS_DEVEXT_VALID(pDevExt) \
|
---|
214 | ( VALID_PTR(pDevExt)\
|
---|
215 | && pDevExt->u32Cookie == BIRD)
|
---|
216 |
|
---|
217 |
|
---|
218 | /** @def SUPDRV_WITH_MSR_PROBER
|
---|
219 | * Enables the SUP_IOCTL_MSR_PROBER function.
|
---|
220 | * By default, only enabled in DEBUG builds as it's a sensitive feature.
|
---|
221 | */
|
---|
222 | #if defined(DEBUG) && !defined(SUPDRV_WITH_MSR_PROBER) && !defined(SUPDRV_WITHOUT_MSR_PROBER)
|
---|
223 | # define SUPDRV_WITH_MSR_PROBER
|
---|
224 | #endif
|
---|
225 |
|
---|
226 | /** @def SUPDRV_WITHOUT_MSR_PROBER
|
---|
227 | * Executive overide for disabling the SUP_IOCTL_MSR_PROBER function.
|
---|
228 | */
|
---|
229 | #ifdef SUPDRV_WITHOUT_MSR_PROBER
|
---|
230 | # undef SUPDRV_WITH_MSR_PROBER
|
---|
231 | #endif
|
---|
232 |
|
---|
233 | #ifdef DOXYGEN_RUNNING
|
---|
234 | # define SUPDRV_WITH_MSR_PROBER
|
---|
235 | # define SUPDRV_WITHOUT_MSR_PROBER
|
---|
236 | #endif
|
---|
237 |
|
---|
238 | #if 1
|
---|
239 | /** @def SUPDRV_USE_TSC_DELTA_THREAD
|
---|
240 | * Use a dedicated kernel thread to service TSC-delta measurement requests.
|
---|
241 | * @todo Test on servers with many CPUs and sockets. */
|
---|
242 | # define SUPDRV_USE_TSC_DELTA_THREAD
|
---|
243 | #endif
|
---|
244 |
|
---|
245 |
|
---|
246 | /*******************************************************************************
|
---|
247 | * Structures and Typedefs *
|
---|
248 | *******************************************************************************/
|
---|
249 | /** Pointer to the device extension. */
|
---|
250 | typedef struct SUPDRVDEVEXT *PSUPDRVDEVEXT;
|
---|
251 |
|
---|
252 | #ifdef SUPDRV_USE_TSC_DELTA_THREAD
|
---|
253 | /**
|
---|
254 | * TSC-delta measurement thread state machine.
|
---|
255 | */
|
---|
256 | typedef enum SUPDRVTSCDELTATHREADSTATE
|
---|
257 | {
|
---|
258 | /** Uninitialized/invalid value. */
|
---|
259 | kTscDeltaThreadState_Invalid = 0,
|
---|
260 | /** The thread is being created.
|
---|
261 | * Next state: Listening, Butchered, Terminating */
|
---|
262 | kTscDeltaThreadState_Creating,
|
---|
263 | /** The thread is listening for events.
|
---|
264 | * Previous state: Creating, Measuring
|
---|
265 | * Next state: WaitAndMeasure, Butchered, Terminated */
|
---|
266 | kTscDeltaThreadState_Listening,
|
---|
267 | /** The thread is sleeping before starting a measurement.
|
---|
268 | * Previous state: Listening, Measuring
|
---|
269 | * Next state: Measuring, Butchered, Terminating
|
---|
270 | * @remarks The thread won't enter this state on its own, it is put into this
|
---|
271 | * state by the GIP timer, the CPU online callback and by the
|
---|
272 | * SUP_IOCTL_TSC_DELTA_MEASURE code. */
|
---|
273 | kTscDeltaThreadState_WaitAndMeasure,
|
---|
274 | /** The thread is currently servicing a measurement request.
|
---|
275 | * Previous state: WaitAndMeasure
|
---|
276 | * Next state: Listening, WaitAndMeasure, Terminate */
|
---|
277 | kTscDeltaThreadState_Measuring,
|
---|
278 | /** The thread is terminating.
|
---|
279 | * @remarks The thread won't enter this state on its own, is put into this state
|
---|
280 | * by supdrvTscDeltaTerm. */
|
---|
281 | kTscDeltaThreadState_Terminating,
|
---|
282 | /** The thread is butchered due to an unexpected error.
|
---|
283 | * Previous State: Creating, Listening, WaitAndMeasure */
|
---|
284 | kTscDeltaThreadState_Butchered,
|
---|
285 | /** The thread is destroyed (final).
|
---|
286 | * Previous state: Terminating */
|
---|
287 | kTscDeltaThreadState_Destroyed,
|
---|
288 | /** The usual 32-bit blowup hack. */
|
---|
289 | kTscDeltaThreadState_32BitHack = 0x7fffffff
|
---|
290 | } SUPDRVTSCDELTATHREADSTATE;
|
---|
291 | #endif /* SUPDRV_USE_TSC_DELTA_THREAD */
|
---|
292 |
|
---|
293 | /**
|
---|
294 | * Memory reference types.
|
---|
295 | */
|
---|
296 | typedef enum
|
---|
297 | {
|
---|
298 | /** Unused entry */
|
---|
299 | MEMREF_TYPE_UNUSED = 0,
|
---|
300 | /** Locked memory (r3 mapping only). */
|
---|
301 | MEMREF_TYPE_LOCKED,
|
---|
302 | /** Continuous memory block (r3 and r0 mapping). */
|
---|
303 | MEMREF_TYPE_CONT,
|
---|
304 | /** Low memory block (r3 and r0 mapping). */
|
---|
305 | MEMREF_TYPE_LOW,
|
---|
306 | /** Memory block (r3 and r0 mapping). */
|
---|
307 | MEMREF_TYPE_MEM,
|
---|
308 | /** Locked memory (r3 mapping only) allocated by the support driver. */
|
---|
309 | MEMREF_TYPE_PAGE,
|
---|
310 | /** Blow the type up to 32-bit and mark the end. */
|
---|
311 | MEMREF_TYPE_32BIT_HACK = 0x7fffffff
|
---|
312 | } SUPDRVMEMREFTYPE, *PSUPDRVMEMREFTYPE;
|
---|
313 |
|
---|
314 |
|
---|
315 | /**
|
---|
316 | * Structure used for tracking memory a session
|
---|
317 | * references in one way or another.
|
---|
318 | */
|
---|
319 | typedef struct SUPDRVMEMREF
|
---|
320 | {
|
---|
321 | /** The memory object handle. */
|
---|
322 | RTR0MEMOBJ MemObj;
|
---|
323 | /** The ring-3 mapping memory object handle. */
|
---|
324 | RTR0MEMOBJ MapObjR3;
|
---|
325 | /** Type of memory. */
|
---|
326 | SUPDRVMEMREFTYPE eType;
|
---|
327 | } SUPDRVMEMREF, *PSUPDRVMEMREF;
|
---|
328 |
|
---|
329 |
|
---|
330 | /**
|
---|
331 | * Bundle of locked memory ranges.
|
---|
332 | */
|
---|
333 | typedef struct SUPDRVBUNDLE
|
---|
334 | {
|
---|
335 | /** Pointer to the next bundle. */
|
---|
336 | struct SUPDRVBUNDLE * volatile pNext;
|
---|
337 | /** Referenced memory. */
|
---|
338 | SUPDRVMEMREF aMem[64];
|
---|
339 | /** Number of entries used. */
|
---|
340 | uint32_t volatile cUsed;
|
---|
341 | } SUPDRVBUNDLE, *PSUPDRVBUNDLE;
|
---|
342 |
|
---|
343 |
|
---|
344 | /**
|
---|
345 | * Loaded image.
|
---|
346 | */
|
---|
347 | typedef struct SUPDRVLDRIMAGE
|
---|
348 | {
|
---|
349 | /** Next in chain. */
|
---|
350 | struct SUPDRVLDRIMAGE * volatile pNext;
|
---|
351 | /** Pointer to the image. */
|
---|
352 | void *pvImage;
|
---|
353 | /** Pointer to the allocated image buffer.
|
---|
354 | * pvImage is 32-byte aligned or it may governed by the native loader (this
|
---|
355 | * member is NULL then). */
|
---|
356 | void *pvImageAlloc;
|
---|
357 | /** Size of the image including the tables. This is mainly for verification
|
---|
358 | * of the load request. */
|
---|
359 | uint32_t cbImageWithTabs;
|
---|
360 | /** Size of the image. */
|
---|
361 | uint32_t cbImageBits;
|
---|
362 | /** The number of entries in the symbol table. */
|
---|
363 | uint32_t cSymbols;
|
---|
364 | /** Pointer to the symbol table. */
|
---|
365 | PSUPLDRSYM paSymbols;
|
---|
366 | /** The offset of the string table. */
|
---|
367 | char *pachStrTab;
|
---|
368 | /** Size of the string table. */
|
---|
369 | uint32_t cbStrTab;
|
---|
370 | /** Pointer to the optional module initialization callback. */
|
---|
371 | PFNR0MODULEINIT pfnModuleInit;
|
---|
372 | /** Pointer to the optional module termination callback. */
|
---|
373 | PFNR0MODULETERM pfnModuleTerm;
|
---|
374 | /** Service request handler. This is NULL for non-service modules. */
|
---|
375 | PFNSUPR0SERVICEREQHANDLER pfnServiceReqHandler;
|
---|
376 | /** The ldr image state. (IOCtl code of last operation.) */
|
---|
377 | uint32_t uState;
|
---|
378 | /** Usage count. */
|
---|
379 | uint32_t volatile cUsage;
|
---|
380 | /** Pointer to the device extension. */
|
---|
381 | struct SUPDRVDEVEXT *pDevExt;
|
---|
382 | #ifdef RT_OS_WINDOWS
|
---|
383 | /** The section object for the loaded image (fNative=true). */
|
---|
384 | void *pvNtSectionObj;
|
---|
385 | /** Lock object. */
|
---|
386 | RTR0MEMOBJ hMemLock;
|
---|
387 | #endif
|
---|
388 | #if defined(RT_OS_SOLARIS) && defined(VBOX_WITH_NATIVE_SOLARIS_LOADING)
|
---|
389 | /** The Solaris module ID. */
|
---|
390 | int idSolMod;
|
---|
391 | /** Pointer to the module control structure. */
|
---|
392 | struct modctl *pSolModCtl;
|
---|
393 | #endif
|
---|
394 | #ifdef RT_OS_LINUX
|
---|
395 | /** Hack for seeing the module in perf, dtrace and other stack crawlers. */
|
---|
396 | struct module *pLnxModHack;
|
---|
397 | #endif
|
---|
398 | /** Whether it's loaded by the native loader or not. */
|
---|
399 | bool fNative;
|
---|
400 | /** Image name. */
|
---|
401 | char szName[32];
|
---|
402 | } SUPDRVLDRIMAGE, *PSUPDRVLDRIMAGE;
|
---|
403 |
|
---|
404 |
|
---|
405 | /** Image usage record. */
|
---|
406 | typedef struct SUPDRVLDRUSAGE
|
---|
407 | {
|
---|
408 | /** Next in chain. */
|
---|
409 | struct SUPDRVLDRUSAGE * volatile pNext;
|
---|
410 | /** The image. */
|
---|
411 | PSUPDRVLDRIMAGE pImage;
|
---|
412 | /** Load count. */
|
---|
413 | uint32_t volatile cUsage;
|
---|
414 | } SUPDRVLDRUSAGE, *PSUPDRVLDRUSAGE;
|
---|
415 |
|
---|
416 |
|
---|
417 | /**
|
---|
418 | * Component factory registration record.
|
---|
419 | */
|
---|
420 | typedef struct SUPDRVFACTORYREG
|
---|
421 | {
|
---|
422 | /** Pointer to the next registration. */
|
---|
423 | struct SUPDRVFACTORYREG *pNext;
|
---|
424 | /** Pointer to the registered factory. */
|
---|
425 | PCSUPDRVFACTORY pFactory;
|
---|
426 | /** The session owning the factory.
|
---|
427 | * Used for deregistration and session cleanup. */
|
---|
428 | PSUPDRVSESSION pSession;
|
---|
429 | /** Length of the name. */
|
---|
430 | size_t cchName;
|
---|
431 | } SUPDRVFACTORYREG;
|
---|
432 | /** Pointer to a component factory registration record. */
|
---|
433 | typedef SUPDRVFACTORYREG *PSUPDRVFACTORYREG;
|
---|
434 | /** Pointer to a const component factory registration record. */
|
---|
435 | typedef SUPDRVFACTORYREG const *PCSUPDRVFACTORYREG;
|
---|
436 |
|
---|
437 |
|
---|
438 | /**
|
---|
439 | * Registered object.
|
---|
440 | * This takes care of reference counting and tracking data for access checks.
|
---|
441 | */
|
---|
442 | typedef struct SUPDRVOBJ
|
---|
443 | {
|
---|
444 | /** Magic value (SUPDRVOBJ_MAGIC). */
|
---|
445 | uint32_t u32Magic;
|
---|
446 | /** The object type. */
|
---|
447 | SUPDRVOBJTYPE enmType;
|
---|
448 | /** Pointer to the next in the global list. */
|
---|
449 | struct SUPDRVOBJ * volatile pNext;
|
---|
450 | /** Pointer to the object destructor.
|
---|
451 | * This may be set to NULL if the image containing the destructor get unloaded. */
|
---|
452 | PFNSUPDRVDESTRUCTOR pfnDestructor;
|
---|
453 | /** User argument 1. */
|
---|
454 | void *pvUser1;
|
---|
455 | /** User argument 2. */
|
---|
456 | void *pvUser2;
|
---|
457 | /** The total sum of all per-session usage. */
|
---|
458 | uint32_t volatile cUsage;
|
---|
459 | /** The creator user id. */
|
---|
460 | RTUID CreatorUid;
|
---|
461 | /** The creator group id. */
|
---|
462 | RTGID CreatorGid;
|
---|
463 | /** The creator process id. */
|
---|
464 | RTPROCESS CreatorProcess;
|
---|
465 | } SUPDRVOBJ, *PSUPDRVOBJ;
|
---|
466 |
|
---|
467 | /** Magic number for SUPDRVOBJ::u32Magic. (Dame Agatha Mary Clarissa Christie). */
|
---|
468 | #define SUPDRVOBJ_MAGIC UINT32_C(0x18900915)
|
---|
469 | /** Dead number magic for SUPDRVOBJ::u32Magic. */
|
---|
470 | #define SUPDRVOBJ_MAGIC_DEAD UINT32_C(0x19760112)
|
---|
471 |
|
---|
472 | /**
|
---|
473 | * The per-session object usage record.
|
---|
474 | */
|
---|
475 | typedef struct SUPDRVUSAGE
|
---|
476 | {
|
---|
477 | /** Pointer to the next in the list. */
|
---|
478 | struct SUPDRVUSAGE * volatile pNext;
|
---|
479 | /** Pointer to the object we're recording usage for. */
|
---|
480 | PSUPDRVOBJ pObj;
|
---|
481 | /** The usage count. */
|
---|
482 | uint32_t volatile cUsage;
|
---|
483 | } SUPDRVUSAGE, *PSUPDRVUSAGE;
|
---|
484 |
|
---|
485 |
|
---|
486 | /**
|
---|
487 | * Per session data.
|
---|
488 | * This is mainly for memory tracking.
|
---|
489 | */
|
---|
490 | typedef struct SUPDRVSESSION
|
---|
491 | {
|
---|
492 | /** Pointer to the device extension. */
|
---|
493 | PSUPDRVDEVEXT pDevExt;
|
---|
494 | /** Session Cookie. */
|
---|
495 | uint32_t u32Cookie;
|
---|
496 | /** Set if is an unrestricted session, clear if restricted. */
|
---|
497 | bool fUnrestricted;
|
---|
498 |
|
---|
499 | /** Set if we're in the hash table, clear if not. Protected by the hash
|
---|
500 | * table spinlock. */
|
---|
501 | bool fInHashTable;
|
---|
502 | /** Reference counter. */
|
---|
503 | uint32_t volatile cRefs;
|
---|
504 | /** Pointer to the next session with the same hash (common hash table).
|
---|
505 | * Protected by the hash table spinlock. */
|
---|
506 | PSUPDRVSESSION pCommonNextHash;
|
---|
507 | /** Pointer to the OS specific session pointer, if available and in use.
|
---|
508 | * This is atomically set and cleared as the session is inserted and removed
|
---|
509 | * from the hash table (protected by the session hash table spinlock). */
|
---|
510 | PSUPDRVSESSION *ppOsSessionPtr;
|
---|
511 | /** The process (id) of the session. */
|
---|
512 | RTPROCESS Process;
|
---|
513 | /** Which process this session is associated with.
|
---|
514 | * This is NIL_RTR0PROCESS for kernel sessions and valid for user ones. */
|
---|
515 | RTR0PROCESS R0Process;
|
---|
516 |
|
---|
517 | /** The VM associated with the session. */
|
---|
518 | PVM pVM;
|
---|
519 | /** Handle table for IPRT semaphore wrapper APIs.
|
---|
520 | * This takes care of its own locking in an IRQ safe manner. */
|
---|
521 | RTHANDLETABLE hHandleTable;
|
---|
522 | /** Load usage records. (protected by SUPDRVDEVEXT::mtxLdr) */
|
---|
523 | PSUPDRVLDRUSAGE volatile pLdrUsage;
|
---|
524 |
|
---|
525 | /** Spinlock protecting the bundles, the GIP members and the
|
---|
526 | * fProcessCleanupDone flag. It continues to be valid until the last
|
---|
527 | * reference to the session is released. */
|
---|
528 | RTSPINLOCK Spinlock;
|
---|
529 | /** The ring-3 mapping of the GIP (readonly). */
|
---|
530 | RTR0MEMOBJ GipMapObjR3;
|
---|
531 | /** Set if the session is using the GIP. */
|
---|
532 | uint32_t fGipReferenced;
|
---|
533 | /** Bundle of locked memory objects. */
|
---|
534 | SUPDRVBUNDLE Bundle;
|
---|
535 | /** List of generic usage records. (protected by SUPDRVDEVEXT::SpinLock) */
|
---|
536 | PSUPDRVUSAGE volatile pUsage;
|
---|
537 |
|
---|
538 | /** The user id of the session. (Set by the OS part.) */
|
---|
539 | RTUID Uid;
|
---|
540 | /** The group id of the session. (Set by the OS part.) */
|
---|
541 | RTGID Gid;
|
---|
542 | /** Per session tracer specfic data. */
|
---|
543 | uintptr_t uTracerData;
|
---|
544 | /** The thread currently actively talking to the tracer. (One at the time!) */
|
---|
545 | RTNATIVETHREAD hTracerCaller;
|
---|
546 | /** List of tracepoint providers associated with the session
|
---|
547 | * (SUPDRVTPPROVIDER). */
|
---|
548 | RTLISTANCHOR TpProviders;
|
---|
549 | /** The number of providers in TpProviders. */
|
---|
550 | uint32_t cTpProviders;
|
---|
551 | /** The number of threads active in supdrvIOCtl_TracerUmodProbeFire or
|
---|
552 | * SUPR0TracerUmodProbeFire. */
|
---|
553 | uint32_t volatile cTpProbesFiring;
|
---|
554 | /** User tracepoint modules (PSUPDRVTRACKERUMOD). */
|
---|
555 | RTLISTANCHOR TpUmods;
|
---|
556 | /** The user tracepoint module lookup table. */
|
---|
557 | struct SUPDRVTRACERUMOD *apTpLookupTable[32];
|
---|
558 | /** Whether this is a GIP test-mode client session or not. */
|
---|
559 | bool fGipTestMode;
|
---|
560 | #ifndef SUPDRV_AGNOSTIC
|
---|
561 | # if defined(RT_OS_DARWIN)
|
---|
562 | /** Pointer to the associated org_virtualbox_SupDrvClient object. */
|
---|
563 | void *pvSupDrvClient;
|
---|
564 | /** Whether this session has been opened or not. */
|
---|
565 | bool fOpened;
|
---|
566 | # endif
|
---|
567 | # if defined(RT_OS_OS2)
|
---|
568 | /** The system file number of this session. */
|
---|
569 | uint16_t sfn;
|
---|
570 | uint16_t Alignment; /**< Alignment */
|
---|
571 | # endif
|
---|
572 | # if defined(RT_OS_DARWIN) || defined(RT_OS_OS2) || defined(RT_OS_SOLARIS)
|
---|
573 | /** Pointer to the next session with the same hash. */
|
---|
574 | PSUPDRVSESSION pNextHash;
|
---|
575 | # endif
|
---|
576 | # if defined(RT_OS_WINDOWS) && defined(VBOX_WITH_HARDENING)
|
---|
577 | /** Pointer to the process protection structure for this session. */
|
---|
578 | struct SUPDRVNTPROTECT *pNtProtect;
|
---|
579 | # endif
|
---|
580 | #endif /* !SUPDRV_AGNOSTIC */
|
---|
581 | } SUPDRVSESSION;
|
---|
582 |
|
---|
583 |
|
---|
584 | /**
|
---|
585 | * Device extension.
|
---|
586 | */
|
---|
587 | typedef struct SUPDRVDEVEXT
|
---|
588 | {
|
---|
589 | /** Global cookie. */
|
---|
590 | uint32_t u32Cookie;
|
---|
591 | /** The actual size of SUPDRVSESSION. (SUPDRV_AGNOSTIC) */
|
---|
592 | uint32_t cbSession;
|
---|
593 |
|
---|
594 | /** Spinlock to serialize the initialization, usage counting and objects.
|
---|
595 | * This is IRQ safe because we want to be able signal semaphores from the
|
---|
596 | * special HM context (and later maybe interrupt handlers), so we must be able
|
---|
597 | * to reference and dereference handles when IRQs are disabled. */
|
---|
598 | RTSPINLOCK Spinlock;
|
---|
599 |
|
---|
600 | /** List of registered objects. Protected by the spinlock. */
|
---|
601 | PSUPDRVOBJ volatile pObjs;
|
---|
602 | /** List of free object usage records. */
|
---|
603 | PSUPDRVUSAGE volatile pUsageFree;
|
---|
604 |
|
---|
605 | /** Loader mutex.
|
---|
606 | * This protects pvVMMR0, pvVMMR0Entry, pImages and SUPDRVSESSION::pLdrUsage. */
|
---|
607 | #ifdef SUPDRV_USE_MUTEX_FOR_LDR
|
---|
608 | RTSEMMUTEX mtxLdr;
|
---|
609 | #else
|
---|
610 | RTSEMFASTMUTEX mtxLdr;
|
---|
611 | #endif
|
---|
612 |
|
---|
613 | /** VMM Module 'handle'.
|
---|
614 | * 0 if the code VMM isn't loaded and Idt are nops. */
|
---|
615 | void * volatile pvVMMR0;
|
---|
616 | /** VMMR0EntryFast() pointer. */
|
---|
617 | DECLR0CALLBACKMEMBER(void, pfnVMMR0EntryFast, (PVM pVM, VMCPUID idCpu, unsigned uOperation));
|
---|
618 | /** VMMR0EntryEx() pointer. */
|
---|
619 | DECLR0CALLBACKMEMBER(int, pfnVMMR0EntryEx, (PVM pVM, VMCPUID idCpu, unsigned uOperation, PSUPVMMR0REQHDR pReq, uint64_t u64Arg, PSUPDRVSESSION pSession));
|
---|
620 |
|
---|
621 | /** Linked list of loaded code. */
|
---|
622 | PSUPDRVLDRIMAGE volatile pLdrImages;
|
---|
623 | /** Set if the image loading interface got disabled after loading all needed images */
|
---|
624 | bool fLdrLockedDown;
|
---|
625 |
|
---|
626 | /** @name These members for detecting whether an API caller is in ModuleInit.
|
---|
627 | * Certain APIs are only permitted from ModuleInit, like for instance tracepoint
|
---|
628 | * registration.
|
---|
629 | * @{ */
|
---|
630 | /** The image currently executing its ModuleInit. */
|
---|
631 | PSUPDRVLDRIMAGE volatile pLdrInitImage;
|
---|
632 | /** The thread currently executing a ModuleInit function. */
|
---|
633 | RTNATIVETHREAD volatile hLdrInitThread;
|
---|
634 | /** @} */
|
---|
635 |
|
---|
636 | /** Number of times someone reported bad execution context via SUPR0BadContext.
|
---|
637 | * (This is times EFLAGS.AC is zero when we expected it to be 1.) */
|
---|
638 | uint32_t volatile cBadContextCalls;
|
---|
639 |
|
---|
640 | /** GIP mutex.
|
---|
641 | * Any changes to any of the GIP members requires ownership of this mutex,
|
---|
642 | * except on driver init and termination. */
|
---|
643 | #ifdef SUPDRV_USE_MUTEX_FOR_GIP
|
---|
644 | RTSEMMUTEX mtxGip;
|
---|
645 | #else
|
---|
646 | RTSEMFASTMUTEX mtxGip;
|
---|
647 | #endif
|
---|
648 | /** GIP spinlock protecting GIP members during Mp events.
|
---|
649 | * This is IRQ safe since be may get MP callbacks in contexts where IRQs are
|
---|
650 | * disabled (on some platforms). */
|
---|
651 | RTSPINLOCK hGipSpinlock;
|
---|
652 | /** Pointer to the Global Info Page (GIP). */
|
---|
653 | PSUPGLOBALINFOPAGE pGip;
|
---|
654 | /** The physical address of the GIP. */
|
---|
655 | RTHCPHYS HCPhysGip;
|
---|
656 | /** Number of processes using the GIP.
|
---|
657 | * (The updates are suspend while cGipUsers is 0.)*/
|
---|
658 | uint32_t volatile cGipUsers;
|
---|
659 | /** The ring-0 memory object handle for the GIP page. */
|
---|
660 | RTR0MEMOBJ GipMemObj;
|
---|
661 | /** The GIP timer handle. */
|
---|
662 | PRTTIMER pGipTimer;
|
---|
663 | /** If non-zero we've successfully called RTTimerRequestSystemGranularity(). */
|
---|
664 | uint32_t u32SystemTimerGranularityGrant;
|
---|
665 | /** The CPU id of the GIP master.
|
---|
666 | * This CPU is responsible for the updating the common GIP data and it is
|
---|
667 | * the one used to calculate TSC deltas relative to.
|
---|
668 | * (The initial master will have a 0 zero value, but it it goes offline the
|
---|
669 | * new master may have a non-zero value.) */
|
---|
670 | RTCPUID volatile idGipMaster;
|
---|
671 |
|
---|
672 | /** Component factory mutex.
|
---|
673 | * This protects pComponentFactoryHead and component factory querying. */
|
---|
674 | RTSEMFASTMUTEX mtxComponentFactory;
|
---|
675 | /** The head of the list of registered component factories. */
|
---|
676 | PSUPDRVFACTORYREG pComponentFactoryHead;
|
---|
677 |
|
---|
678 | /** Lock protecting The tracer members. */
|
---|
679 | RTSEMFASTMUTEX mtxTracer;
|
---|
680 | /** List of tracer providers (SUPDRVTPPROVIDER). */
|
---|
681 | RTLISTANCHOR TracerProviderList;
|
---|
682 | /** List of zombie tracer providers (SUPDRVTPPROVIDER). */
|
---|
683 | RTLISTANCHOR TracerProviderZombieList;
|
---|
684 | /** Pointer to the tracer registration record. */
|
---|
685 | PCSUPDRVTRACERREG pTracerOps;
|
---|
686 | /** The ring-0 session of a native tracer provider. */
|
---|
687 | PSUPDRVSESSION pTracerSession;
|
---|
688 | /** The image containing the tracer. */
|
---|
689 | PSUPDRVLDRIMAGE pTracerImage;
|
---|
690 | /** The tracer helpers. */
|
---|
691 | SUPDRVTRACERHLP TracerHlp;
|
---|
692 | /** The number of session having opened the tracer currently. */
|
---|
693 | uint32_t cTracerOpens;
|
---|
694 | /** The number of threads currently calling into the tracer. */
|
---|
695 | uint32_t volatile cTracerCallers;
|
---|
696 | /** Set if the tracer is being unloaded. */
|
---|
697 | bool fTracerUnloading;
|
---|
698 | /** Hash table for user tracer modules (SUPDRVVTGCOPY). */
|
---|
699 | RTLISTANCHOR aTrackerUmodHash[128];
|
---|
700 |
|
---|
701 | /** @name Session Handle Table.
|
---|
702 | * @{ */
|
---|
703 | /** Spinlock protecting apSessionHashTab, cSessions,
|
---|
704 | * SUPDRVSESSION::ppOsSessionPtr, SUPDRVSESSION::pCommonNextHash, and possibly
|
---|
705 | * others depending on the OS. */
|
---|
706 | RTSPINLOCK hSessionHashTabSpinlock;
|
---|
707 | /** Session hash table hash table. The size of this table must make sense in
|
---|
708 | * comparison to GVMM_MAX_HANDLES. */
|
---|
709 | PSUPDRVSESSION apSessionHashTab[HC_ARCH_BITS == 64 ? 8191 : 127];
|
---|
710 | /** The number of open sessions. */
|
---|
711 | int32_t cSessions;
|
---|
712 | /** @} */
|
---|
713 |
|
---|
714 | /** @name Invariant TSC frequency refinement.
|
---|
715 | * @{ */
|
---|
716 | /** Nanosecond timestamp at the start of the TSC frequency refinement phase. */
|
---|
717 | uint64_t nsStartInvarTscRefine;
|
---|
718 | /** TSC reading at the start of the TSC frequency refinement phase. */
|
---|
719 | uint64_t uTscStartInvarTscRefine;
|
---|
720 | /** The CPU id of the CPU that u64TscAnchor was measured on. */
|
---|
721 | RTCPUID idCpuInvarTscRefine;
|
---|
722 | /** Pointer to the timer used to refine the TSC frequency. */
|
---|
723 | PRTTIMER pInvarTscRefineTimer;
|
---|
724 | /** Stop the timer on the next tick because we saw a power event. */
|
---|
725 | bool volatile fInvTscRefinePowerEvent;
|
---|
726 | /** @} */
|
---|
727 |
|
---|
728 | /** @name TSC-delta measurement.
|
---|
729 | * @{ */
|
---|
730 | /** Number of online/offline events, incremented each time a CPU goes online
|
---|
731 | * or offline. */
|
---|
732 | uint32_t volatile cMpOnOffEvents;
|
---|
733 | /** TSC-delta measurement mutext.
|
---|
734 | * At the moment, we don't want to have more than one measurement going on at
|
---|
735 | * any one time. We might be using broadcast IPIs which are heavy and could
|
---|
736 | * perhaps get in each others way. */
|
---|
737 | #ifdef SUPDRV_USE_MUTEX_FOR_GIP
|
---|
738 | RTSEMMUTEX mtxTscDelta;
|
---|
739 | #else
|
---|
740 | RTSEMFASTMUTEX mtxTscDelta;
|
---|
741 | #endif
|
---|
742 | /** The set of CPUs we need to take measurements for. */
|
---|
743 | RTCPUSET TscDeltaCpuSet;
|
---|
744 | /** The set of CPUs we have completed taken measurements for. */
|
---|
745 | RTCPUSET TscDeltaObtainedCpuSet;
|
---|
746 | /** @} */
|
---|
747 |
|
---|
748 | #ifdef SUPDRV_USE_TSC_DELTA_THREAD
|
---|
749 | /** @name TSC-delta measurement thread.
|
---|
750 | * @{ */
|
---|
751 | /** Spinlock protecting enmTscDeltaThreadState. */
|
---|
752 | RTSPINLOCK hTscDeltaSpinlock;
|
---|
753 | /** TSC-delta measurement thread. */
|
---|
754 | RTTHREAD hTscDeltaThread;
|
---|
755 | /** The event signalled during state changes to the TSC-delta thread. */
|
---|
756 | RTSEMEVENT hTscDeltaEvent;
|
---|
757 | /** The state of the TSC-delta measurement thread. */
|
---|
758 | SUPDRVTSCDELTATHREADSTATE enmTscDeltaThreadState;
|
---|
759 | /** Thread timeout time before rechecking state in ms. */
|
---|
760 | RTMSINTERVAL cMsTscDeltaTimeout;
|
---|
761 | /** Whether the TSC-delta measurement was successful. */
|
---|
762 | int32_t volatile rcTscDelta;
|
---|
763 | /** Tell the thread we want TSC-deltas for all CPUs with retries. */
|
---|
764 | bool fTscThreadRecomputeAllDeltas;
|
---|
765 | /** @} */
|
---|
766 | #endif
|
---|
767 |
|
---|
768 | /** @name GIP test mode.
|
---|
769 | * @{ */
|
---|
770 | /** Reference counter for GIP test-mode sessions. */
|
---|
771 | uint32_t cGipTestModeRefs;
|
---|
772 | /** Cache of TSC frequency before enabling test-mode on invariant GIP systems. */
|
---|
773 | uint64_t uGipTestModeInvariantCpuHz;
|
---|
774 | /** @} */
|
---|
775 |
|
---|
776 | /*
|
---|
777 | * Note! The non-agnostic bits must be at the very end of the structure!
|
---|
778 | */
|
---|
779 | #ifndef SUPDRV_AGNOSTIC
|
---|
780 | # ifdef RT_OS_WINDOWS
|
---|
781 | /** Callback object returned by ExCreateCallback. */
|
---|
782 | PCALLBACK_OBJECT pObjPowerCallback;
|
---|
783 | /** Callback handle returned by ExRegisterCallback. */
|
---|
784 | PVOID hPowerCallback;
|
---|
785 | # endif
|
---|
786 | #endif
|
---|
787 | } SUPDRVDEVEXT;
|
---|
788 |
|
---|
789 | /** Calculates the index into g_apSessionHashTab.*/
|
---|
790 | #define SUPDRV_SESSION_HASH(a_pid) ( (a_pid) % RT_ELEMENTS(((SUPDRVDEVEXT *)NULL)->apSessionHashTab) )
|
---|
791 |
|
---|
792 |
|
---|
793 | RT_C_DECLS_BEGIN
|
---|
794 |
|
---|
795 | /*******************************************************************************
|
---|
796 | * OS Specific Functions *
|
---|
797 | *******************************************************************************/
|
---|
798 | /**
|
---|
799 | * Called to clean up the session structure before it's freed.
|
---|
800 | *
|
---|
801 | * @param pDevExt The device globals.
|
---|
802 | * @param pSession The session that's being cleaned up.
|
---|
803 | */
|
---|
804 | void VBOXCALL supdrvOSCleanupSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession);
|
---|
805 |
|
---|
806 | /**
|
---|
807 | * Called to let the OS specfic code perform additional insertion work while
|
---|
808 | * still under the protection of the hash table spinlock.
|
---|
809 | *
|
---|
810 | * @param pDevExt The device globals.
|
---|
811 | * @param pSession The session that was inserted.
|
---|
812 | * @param pvUser User context specified to the insert call.
|
---|
813 | */
|
---|
814 | void VBOXCALL supdrvOSSessionHashTabInserted(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, void *pvUser);
|
---|
815 |
|
---|
816 | /**
|
---|
817 | * Called to let the OS specfic code perform additional removal work while still
|
---|
818 | * under the protection of the hash table spinlock.
|
---|
819 | *
|
---|
820 | * @param pDevExt The device globals.
|
---|
821 | * @param pSession The session that was removed.
|
---|
822 | * @param pvUser User context specified to the remove call.
|
---|
823 | */
|
---|
824 | void VBOXCALL supdrvOSSessionHashTabRemoved(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, void *pvUser);
|
---|
825 |
|
---|
826 | void VBOXCALL supdrvOSObjInitCreator(PSUPDRVOBJ pObj, PSUPDRVSESSION pSession);
|
---|
827 | bool VBOXCALL supdrvOSObjCanAccess(PSUPDRVOBJ pObj, PSUPDRVSESSION pSession, const char *pszObjName, int *prc);
|
---|
828 | bool VBOXCALL supdrvOSGetForcedAsyncTscMode(PSUPDRVDEVEXT pDevExt);
|
---|
829 | bool VBOXCALL supdrvOSAreCpusOfflinedOnSuspend(void);
|
---|
830 | bool VBOXCALL supdrvOSAreTscDeltasInSync(void);
|
---|
831 | int VBOXCALL supdrvOSEnableVTx(bool fEnabled);
|
---|
832 | RTCCUINTREG VBOXCALL supdrvOSChangeCR4(RTCCUINTREG fOrMask, RTCCUINTREG fAndMask);
|
---|
833 | bool VBOXCALL supdrvOSSuspendVTxOnCpu(void);
|
---|
834 | void VBOXCALL supdrvOSResumeVTxOnCpu(bool fSuspended);
|
---|
835 |
|
---|
836 | /**
|
---|
837 | * Try open the image using the native loader.
|
---|
838 | *
|
---|
839 | * @returns IPRT status code.
|
---|
840 | * @retval VERR_NOT_SUPPORTED if native loading isn't supported.
|
---|
841 | *
|
---|
842 | * @param pDevExt The device globals.
|
---|
843 | * @param pImage The image handle. pvImage should be set on
|
---|
844 | * success, pvImageAlloc can also be set if
|
---|
845 | * appropriate.
|
---|
846 | * @param pszFilename The file name - UTF-8, may containing UNIX
|
---|
847 | * slashes on non-UNIX systems.
|
---|
848 | */
|
---|
849 | int VBOXCALL supdrvOSLdrOpen(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage, const char *pszFilename);
|
---|
850 |
|
---|
851 | /**
|
---|
852 | * Notification call indicating that a image is being opened for the first time.
|
---|
853 | *
|
---|
854 | * Called for both native and non-native images (after supdrvOSLdrOpen). Can be
|
---|
855 | * used to log the load address of the image or inform the kernel about the
|
---|
856 | * alien image.
|
---|
857 | *
|
---|
858 | * @param pDevExt The device globals.
|
---|
859 | * @param pImage The image handle.
|
---|
860 | * @param pszFilename The file name - UTF-8, may containing UNIX
|
---|
861 | * slashes on non-UNIX systems.
|
---|
862 | */
|
---|
863 | void VBOXCALL supdrvOSLdrNotifyOpened(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage, const char *pszFilename);
|
---|
864 |
|
---|
865 | /**
|
---|
866 | * Validates an entry point address.
|
---|
867 | *
|
---|
868 | * Called before supdrvOSLdrLoad.
|
---|
869 | *
|
---|
870 | * @returns IPRT status code.
|
---|
871 | * @param pDevExt The device globals.
|
---|
872 | * @param pImage The image data (still in the open state).
|
---|
873 | * @param pv The address within the image.
|
---|
874 | * @param pbImageBits The image bits as loaded by ring-3.
|
---|
875 | */
|
---|
876 | int VBOXCALL supdrvOSLdrValidatePointer(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage,
|
---|
877 | void *pv, const uint8_t *pbImageBits);
|
---|
878 |
|
---|
879 | /**
|
---|
880 | * Load the image.
|
---|
881 | *
|
---|
882 | * @returns IPRT status code.
|
---|
883 | * @param pDevExt The device globals.
|
---|
884 | * @param pImage The image data (up to date). Adjust entrypoints
|
---|
885 | * and exports if necessary.
|
---|
886 | * @param pbImageBits The image bits as loaded by ring-3.
|
---|
887 | * @param pReq Pointer to the request packet so that the VMMR0
|
---|
888 | * entry points can be adjusted.
|
---|
889 | */
|
---|
890 | int VBOXCALL supdrvOSLdrLoad(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage, const uint8_t *pbImageBits, PSUPLDRLOAD pReq);
|
---|
891 |
|
---|
892 |
|
---|
893 | /**
|
---|
894 | * Unload the image (only called if supdrvOSLdrOpen returned success).
|
---|
895 | *
|
---|
896 | * @param pDevExt The device globals.
|
---|
897 | * @param pImage The image data (mostly still valid).
|
---|
898 | */
|
---|
899 | void VBOXCALL supdrvOSLdrUnload(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage);
|
---|
900 |
|
---|
901 | /**
|
---|
902 | * Notification call indicating that a image is being unloaded.
|
---|
903 | *
|
---|
904 | * Called for both native and non-native images. In the former case, it's
|
---|
905 | * called after supdrvOSLdrUnload.
|
---|
906 | *
|
---|
907 | * @param pDevExt The device globals.
|
---|
908 | * @param pImage The image handle.
|
---|
909 | */
|
---|
910 | void VBOXCALL supdrvOSLdrNotifyUnloaded(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage);
|
---|
911 |
|
---|
912 |
|
---|
913 | #ifdef SUPDRV_WITH_MSR_PROBER
|
---|
914 |
|
---|
915 | /**
|
---|
916 | * Tries to read an MSR.
|
---|
917 | *
|
---|
918 | * @returns One of the listed VBox status codes.
|
---|
919 | * @retval VINF_SUCCESS if read successfully, value in *puValue.
|
---|
920 | * @retval VERR_ACCESS_DENIED if we couldn't read it (GP).
|
---|
921 | * @retval VERR_NOT_SUPPORTED if not supported.
|
---|
922 | *
|
---|
923 | * @param uMsr The MSR to read from.
|
---|
924 | * @param idCpu The CPU to read the MSR on. NIL_RTCPUID
|
---|
925 | * indicates any suitable CPU.
|
---|
926 | * @param puValue Where to return the value.
|
---|
927 | */
|
---|
928 | int VBOXCALL supdrvOSMsrProberRead(uint32_t uMsr, RTCPUID idCpu, uint64_t *puValue);
|
---|
929 |
|
---|
930 | /**
|
---|
931 | * Tries to write an MSR.
|
---|
932 | *
|
---|
933 | * @returns One of the listed VBox status codes.
|
---|
934 | * @retval VINF_SUCCESS if written successfully.
|
---|
935 | * @retval VERR_ACCESS_DENIED if we couldn't write the value to it (GP).
|
---|
936 | * @retval VERR_NOT_SUPPORTED if not supported.
|
---|
937 | *
|
---|
938 | * @param uMsr The MSR to write to.
|
---|
939 | * @param idCpu The CPU to write the MSR on. NIL_RTCPUID
|
---|
940 | * indicates any suitable CPU.
|
---|
941 | * @param uValue The value to write.
|
---|
942 | */
|
---|
943 | int VBOXCALL supdrvOSMsrProberWrite(uint32_t uMsr, RTCPUID idCpu, uint64_t uValue);
|
---|
944 |
|
---|
945 | /**
|
---|
946 | * Tries to modify an MSR value.
|
---|
947 | *
|
---|
948 | * @returns One of the listed VBox status codes.
|
---|
949 | * @retval VINF_SUCCESS if succeeded.
|
---|
950 | * @retval VERR_NOT_SUPPORTED if not supported.
|
---|
951 | *
|
---|
952 | * @param idCpu The CPU to modify the MSR on. NIL_RTCPUID
|
---|
953 | * indicates any suitable CPU.
|
---|
954 | * @param pReq The request packet with input arguments and
|
---|
955 | * where to store the results.
|
---|
956 | */
|
---|
957 | int VBOXCALL supdrvOSMsrProberModify(RTCPUID idCpu, PSUPMSRPROBER pReq);
|
---|
958 |
|
---|
959 | #endif /* SUPDRV_WITH_MSR_PROBER */
|
---|
960 |
|
---|
961 | #if defined(RT_OS_DARWIN)
|
---|
962 | int VBOXCALL supdrvDarwinResumeSuspendedKbds(void);
|
---|
963 | #endif
|
---|
964 |
|
---|
965 | /*******************************************************************************
|
---|
966 | * Shared Functions *
|
---|
967 | *******************************************************************************/
|
---|
968 | /* SUPDrv.c */
|
---|
969 | int VBOXCALL supdrvIOCtl(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPREQHDR pReqHdr, size_t cbReq);
|
---|
970 | int VBOXCALL supdrvIOCtlFast(uintptr_t uIOCtl, VMCPUID idCpu, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession);
|
---|
971 | int VBOXCALL supdrvIDC(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPDRVIDCREQHDR pReqHdr);
|
---|
972 | int VBOXCALL supdrvInitDevExt(PSUPDRVDEVEXT pDevExt, size_t cbSession);
|
---|
973 | void VBOXCALL supdrvDeleteDevExt(PSUPDRVDEVEXT pDevExt);
|
---|
974 | int VBOXCALL supdrvCreateSession(PSUPDRVDEVEXT pDevExt, bool fUser, bool fUnrestricted, PSUPDRVSESSION *ppSession);
|
---|
975 | int VBOXCALL supdrvSessionHashTabInsert(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPDRVSESSION *ppOsSessionPtr, void *pvUser);
|
---|
976 | int VBOXCALL supdrvSessionHashTabRemove(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, void *pvUser);
|
---|
977 | PSUPDRVSESSION VBOXCALL supdrvSessionHashTabLookup(PSUPDRVDEVEXT pDevExt, RTPROCESS Process, RTR0PROCESS R0Process,
|
---|
978 | PSUPDRVSESSION *ppOsSessionPtr);
|
---|
979 | uint32_t VBOXCALL supdrvSessionRetain(PSUPDRVSESSION pSession);
|
---|
980 | uint32_t VBOXCALL supdrvSessionRelease(PSUPDRVSESSION pSession);
|
---|
981 | void VBOXCALL supdrvBadContext(PSUPDRVDEVEXT pDevExt, const char *pszFile, uint32_t uLine, const char *pszExtra);
|
---|
982 | int VBOXCALL supdrvQueryVTCapsInternal(uint32_t *pfCaps);
|
---|
983 | int VBOXCALL supdrvLdrLoadError(int rc, PSUPLDRLOAD pReq, const char *pszFormat, ...);
|
---|
984 |
|
---|
985 | /* SUPDrvGip.cpp */
|
---|
986 | int VBOXCALL supdrvGipCreate(PSUPDRVDEVEXT pDevExt);
|
---|
987 | void VBOXCALL supdrvGipDestroy(PSUPDRVDEVEXT pDevExt);
|
---|
988 | int VBOXCALL supdrvIOCtl_TscDeltaMeasure(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPTSCDELTAMEASURE pReq);
|
---|
989 | int VBOXCALL supdrvIOCtl_TscRead(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPTSCREAD pReq);
|
---|
990 | int VBOXCALL supdrvIOCtl_GipSetFlags(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, uint32_t fOrMask, uint32_t fAndMask);
|
---|
991 |
|
---|
992 |
|
---|
993 | /* SUPDrvTracer.cpp */
|
---|
994 | int VBOXCALL supdrvTracerInit(PSUPDRVDEVEXT pDevExt);
|
---|
995 | void VBOXCALL supdrvTracerTerm(PSUPDRVDEVEXT pDevExt);
|
---|
996 | void VBOXCALL supdrvTracerModuleUnloading(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage);
|
---|
997 | void VBOXCALL supdrvTracerCleanupSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession);
|
---|
998 | int VBOXCALL supdrvIOCtl_TracerUmodRegister(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession,
|
---|
999 | RTR3PTR R3PtrVtgHdr, RTUINTPTR uVtgHdrAddr,
|
---|
1000 | RTR3PTR R3PtrStrTab, uint32_t cbStrTab,
|
---|
1001 | const char *pszModName, uint32_t fFlags);
|
---|
1002 | int VBOXCALL supdrvIOCtl_TracerUmodDeregister(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, RTR3PTR R3PtrVtgHdr);
|
---|
1003 | void VBOXCALL supdrvIOCtl_TracerUmodProbeFire(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPDRVTRACERUSRCTX pCtx);
|
---|
1004 | int VBOXCALL supdrvIOCtl_TracerOpen(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, uint32_t uCookie, uintptr_t uArg);
|
---|
1005 | int VBOXCALL supdrvIOCtl_TracerClose(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession);
|
---|
1006 | int VBOXCALL supdrvIOCtl_TracerIOCtl(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, uintptr_t uCmd, uintptr_t uArg, int32_t *piRetVal);
|
---|
1007 | extern PFNRT g_pfnSupdrvProbeFireKernel;
|
---|
1008 | DECLASM(void) supdrvTracerProbeFireStub(void);
|
---|
1009 |
|
---|
1010 | #ifdef VBOX_WITH_NATIVE_DTRACE
|
---|
1011 | const SUPDRVTRACERREG * VBOXCALL supdrvDTraceInit(void);
|
---|
1012 | #endif
|
---|
1013 |
|
---|
1014 | RT_C_DECLS_END
|
---|
1015 |
|
---|
1016 | #endif
|
---|
1017 |
|
---|