VirtualBox

source: vbox/trunk/src/VBox/HostDrivers/Support/SUPDrvInternal.h@ 12653

Last change on this file since 12653 was 12653, checked in by vboxsync, 16 years ago

various files: doxygen fixes.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 22.6 KB
Line 
1/* $Revision: 12653 $ */
2/** @file
3 * VirtualBox Support Driver - Internal header.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
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 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
27 * Clara, CA 95054 USA or visit http://www.sun.com if you need
28 * additional information or have any questions.
29 */
30
31#ifndef ___SUPDrvInternal_h
32#define ___SUPDrvInternal_h
33
34
35/*******************************************************************************
36* Header Files *
37*******************************************************************************/
38#include <VBox/cdefs.h>
39#include <VBox/types.h>
40#include <iprt/assert.h>
41#include <iprt/asm.h>
42#include <VBox/sup.h>
43#include <iprt/memobj.h>
44#include <iprt/time.h>
45#include <iprt/timer.h>
46#include <iprt/string.h>
47#include <iprt/err.h>
48
49
50#if defined(RT_OS_WINDOWS)
51 __BEGIN_DECLS
52# if (_MSC_VER >= 1400) && !defined(VBOX_WITH_PATCHED_DDK)
53# define _InterlockedExchange _InterlockedExchange_StupidDDKVsCompilerCrap
54# define _InterlockedExchangeAdd _InterlockedExchangeAdd_StupidDDKVsCompilerCrap
55# define _InterlockedCompareExchange _InterlockedCompareExchange_StupidDDKVsCompilerCrap
56# define _InterlockedAddLargeStatistic _InterlockedAddLargeStatistic_StupidDDKVsCompilerCrap
57# define _interlockedbittestandset _interlockedbittestandset_StupidDDKVsCompilerCrap
58# define _interlockedbittestandreset _interlockedbittestandreset_StupidDDKVsCompilerCrap
59# define _interlockedbittestandset64 _interlockedbittestandset64_StupidDDKVsCompilerCrap
60# define _interlockedbittestandreset64 _interlockedbittestandreset64_StupidDDKVsCompilerCrap
61# include <ntddk.h>
62# undef _InterlockedExchange
63# undef _InterlockedExchangeAdd
64# undef _InterlockedCompareExchange
65# undef _InterlockedAddLargeStatistic
66# undef _interlockedbittestandset
67# undef _interlockedbittestandreset
68# undef _interlockedbittestandset64
69# undef _interlockedbittestandreset64
70# else
71# include <ntddk.h>
72# endif
73# include <memory.h>
74# define memcmp(a,b,c) mymemcmp(a,b,c)
75 int VBOXCALL mymemcmp(const void *, const void *, size_t);
76 __END_DECLS
77
78#elif defined(RT_OS_LINUX)
79# include <linux/autoconf.h>
80# include <linux/version.h>
81# if defined(CONFIG_MODVERSIONS) && !defined(MODVERSIONS)
82# define MODVERSIONS
83# if LINUX_VERSION_CODE < KERNEL_VERSION(2, 5, 71)
84# include <linux/modversions.h>
85# endif
86# endif
87# if LINUX_VERSION_CODE > KERNEL_VERSION(2, 6, 0)
88# undef ALIGN
89# endif
90# ifndef KBUILD_STR
91# if LINUX_VERSION_CODE < KERNEL_VERSION(2, 6, 16)
92# define KBUILD_STR(s) s
93# else
94# define KBUILD_STR(s) #s
95# endif
96# endif
97# include <linux/string.h>
98# include <linux/spinlock.h>
99# include <linux/slab.h>
100# if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 27)
101# include <linux/semaphore.h>
102# else /* older kernels */
103# include <asm/semaphore.h>
104# endif /* older kernels */
105# include <linux/timer.h>
106
107# if 0
108# include <linux/hrtimer.h>
109# define VBOX_HRTIMER
110# endif
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# include <sys/libkern.h>
120# include <iprt/string.h>
121
122#elif defined(RT_OS_SOLARIS)
123# include <sys/cmn_err.h>
124# include <iprt/string.h>
125
126#else
127# error "unsupported OS."
128#endif
129
130#include "SUPDrvIOC.h"
131#include "SUPDrvIDC.h"
132
133
134
135/*******************************************************************************
136* Defined Constants And Macros *
137*******************************************************************************/
138/*
139 * Hardcoded cookies.
140 */
141#define BIRD 0x64726962 /* 'bird' */
142#define BIRD_INV 0x62697264 /* 'drib' */
143
144
145/*
146 * Win32
147 */
148#if defined(RT_OS_WINDOWS)
149
150/* debug printf */
151# define OSDBGPRINT(a) DbgPrint a
152
153/** Maximum number of bytes we try to lock down in one go.
154 * This is supposed to have a limit right below 256MB, but this appears
155 * to actually be much lower. The values here have been determined experimentally.
156 */
157#ifdef RT_ARCH_X86
158# define MAX_LOCK_MEM_SIZE (32*1024*1024) /* 32mb */
159#endif
160#ifdef RT_ARCH_AMD64
161# define MAX_LOCK_MEM_SIZE (24*1024*1024) /* 24mb */
162#endif
163
164
165/*
166 * Linux
167 */
168#elif defined(RT_OS_LINUX)
169
170/* check kernel version */
171#if LINUX_VERSION_CODE < KERNEL_VERSION(2, 4, 0)
172# error Unsupported kernel version!
173#endif
174
175__BEGIN_DECLS
176int linux_dprintf(const char *format, ...);
177__END_DECLS
178
179/* debug printf */
180# define OSDBGPRINT(a) printk a
181
182
183/*
184 * Darwin
185 */
186#elif defined(RT_OS_DARWIN)
187
188/* debug printf */
189# define OSDBGPRINT(a) printf a
190
191
192/*
193 * OS/2
194 */
195#elif defined(RT_OS_OS2)
196
197/* No log API in OS/2 only COM port. */
198# define OSDBGPRINT(a) SUPR0Printf a
199
200
201/*
202 * FreeBSD
203 */
204#elif defined(RT_OS_FREEBSD)
205
206/* debug printf */
207# define OSDBGPRINT(a) printf a
208
209
210/*
211 * Solaris
212 */
213#elif defined(RT_OS_SOLARIS)
214# define OSDBGPRINT(a) SUPR0Printf a
215
216
217#else
218/** @todo other os'es */
219# error "OS interface defines is not done for this OS!"
220#endif
221
222
223/* dprintf */
224#if (defined(DEBUG) && !defined(NO_LOGGING)) || defined(RT_OS_FREEBSD)
225# ifdef LOG_TO_COM
226# include <VBox/log.h>
227# define dprintf(a) RTLogComPrintf a
228# else
229# define dprintf(a) OSDBGPRINT(a)
230# endif
231#else
232# define dprintf(a) do {} while (0)
233#endif
234
235/* dprintf2 - extended logging. */
236#if defined(RT_OS_DARWIN) || defined(RT_OS_OS2) || defined(RT_OS_FREEBSD)
237# define dprintf2 dprintf
238#else
239# define dprintf2(a) do { } while (0)
240#endif
241
242
243/** @def SUPDRV_WITH_UNWIND_HACK
244 * Changes a function name into the wrapped version if we've
245 * enabled the unwind hack.
246 *
247 * The unwind hack is for making the NT unwind procedures skip
248 * our dynamically loaded code when they try to walk the call
249 * stack. Needless to say, they kind of don't expect what
250 * we're doing here and get kind of confused and may BSOD. */
251#ifdef DOXYGEN_RUNNING
252# define SUPDRV_WITH_UNWIND_HACK
253#endif
254/** @def UNWIND_WRAP
255 * If SUPDRV_WITH_UNWIND_HACK is defined, the name will be prefixed with
256 * 'supdrvNtWrap'.
257 * @param Name The function to wrapper. */
258#ifdef SUPDRV_WITH_UNWIND_HACK
259# define UNWIND_WRAP(Name) supdrvNtWrap##Name
260#else
261# define UNWIND_WRAP(Name) Name
262#endif
263
264
265/*
266 * Error codes.
267 */
268/** @todo retire the SUPDRV_ERR_* stuff, we ship err.h now. */
269/** Invalid parameter. */
270#define SUPDRV_ERR_GENERAL_FAILURE (-1)
271/** Invalid parameter. */
272#define SUPDRV_ERR_INVALID_PARAM (-2)
273/** Invalid magic or cookie. */
274#define SUPDRV_ERR_INVALID_MAGIC (-3)
275/** Invalid loader handle. */
276#define SUPDRV_ERR_INVALID_HANDLE (-4)
277/** Failed to lock the address range. */
278#define SUPDRV_ERR_LOCK_FAILED (-5)
279/** Invalid memory pointer. */
280#define SUPDRV_ERR_INVALID_POINTER (-6)
281/** Failed to patch the IDT. */
282#define SUPDRV_ERR_IDT_FAILED (-7)
283/** Memory allocation failed. */
284#define SUPDRV_ERR_NO_MEMORY (-8)
285/** Already loaded. */
286#define SUPDRV_ERR_ALREADY_LOADED (-9)
287/** Permission denied. */
288#define SUPDRV_ERR_PERMISSION_DENIED (-10)
289/** Version mismatch. */
290#define SUPDRV_ERR_VERSION_MISMATCH (-11)
291
292
293
294/*******************************************************************************
295* Structures and Typedefs *
296*******************************************************************************/
297/** Pointer to the device extension. */
298typedef struct SUPDRVDEVEXT *PSUPDRVDEVEXT;
299
300#ifdef VBOX_WITH_IDT_PATCHING
301
302/**
303 * An IDT Entry.
304 */
305typedef struct SUPDRVIDTE
306{
307 /** Low offset word. */
308 uint32_t u16OffsetLow : 16;
309 /** Segment Selector. */
310 uint32_t u16SegSel : 16;
311#ifdef RT_ARCH_AMD64
312 /** Interrupt Stack Table index. */
313 uint32_t u3IST : 3;
314 /** Reserved, ignored. */
315 uint32_t u5Reserved : 5;
316#else
317 /** Reserved. */
318 uint32_t u5Reserved : 5;
319 /** IDT Type part one (not used for task gate). */
320 uint32_t u3Type1 : 3;
321#endif
322 /** IDT Type part two. */
323 uint32_t u5Type2 : 5;
324 /** Descriptor Privilege level. */
325 uint32_t u2DPL : 2;
326 /** Present flag. */
327 uint32_t u1Present : 1;
328 /** High offset word. */
329 uint32_t u16OffsetHigh : 16;
330#ifdef RT_ARCH_AMD64
331 /** The upper top part of the address. */
332 uint32_t u32OffsetTop;
333 /** Reserved dword for qword (aligning the struct), ignored. */
334 uint32_t u32Reserved;
335#endif
336} SUPDRVIDTE, *PSUPDRVIDTE;
337
338/** The u5Type2 value for an interrupt gate. */
339#define SUPDRV_IDTE_TYPE2_INTERRUPT_GATE 0x0e
340
341
342/**
343 * Patch code.
344 */
345typedef struct SUPDRVPATCH
346{
347#define SUPDRV_PATCH_CODE_SIZE 0x50
348 /** Patch code. */
349 uint8_t auCode[SUPDRV_PATCH_CODE_SIZE];
350 /** Changed IDT entry (for parnoid UnpatchIdt()). */
351 SUPDRVIDTE ChangedIdt;
352 /** Saved IDT entry. */
353 SUPDRVIDTE SavedIdt;
354 /** Pointer to the IDT.
355 * We ASSUME the IDT is not re(al)located after bootup and use this as key
356 * for the patches rather than processor number. This prevents some
357 * stupid nesting stuff from happening in case of processors sharing the
358 * IDT.
359 * We're fucked if the processors have different physical mapping for
360 * the(se) page(s), but we'll find that out soon enough in VBOX_STRICT mode.
361 */
362 void *pvIdt;
363 /** Pointer to the IDT entry. */
364 SUPDRVIDTE volatile *pIdtEntry;
365 /** Usage counter. */
366 uint32_t volatile cUsage;
367 /** The offset into auCode of the VMMR0Entry fixup. */
368 uint16_t offVMMR0EntryFixup;
369 /** The offset into auCode of the stub function. */
370 uint16_t offStub;
371 /** Pointer to the next patch. */
372 struct SUPDRVPATCH * volatile pNext;
373} SUPDRVPATCH, *PSUPDRVPATCH;
374
375/**
376 * Usage record for a patch.
377 */
378typedef struct SUPDRVPATCHUSAGE
379{
380 /** Next in the chain. */
381 struct SUPDRVPATCHUSAGE * volatile pNext;
382 /** The patch this usage applies to. */
383 PSUPDRVPATCH pPatch;
384 /** Usage count. */
385 uint32_t volatile cUsage;
386} SUPDRVPATCHUSAGE, *PSUPDRVPATCHUSAGE;
387
388#endif /* VBOX_WITH_IDT_PATCHING */
389
390
391/**
392 * Memory reference types.
393 */
394typedef enum
395{
396 /** Unused entry */
397 MEMREF_TYPE_UNUSED = 0,
398 /** Locked memory (r3 mapping only). */
399 MEMREF_TYPE_LOCKED,
400 /** Continous memory block (r3 and r0 mapping). */
401 MEMREF_TYPE_CONT,
402 /** Low memory block (r3 and r0 mapping). */
403 MEMREF_TYPE_LOW,
404 /** Memory block (r3 and r0 mapping). */
405 MEMREF_TYPE_MEM,
406 /** Locked memory (r3 mapping only) allocated by the support driver. */
407 MEMREF_TYPE_LOCKED_SUP,
408 /** Blow the type up to 32-bit and mark the end. */
409 MEMREG_TYPE_32BIT_HACK = 0x7fffffff
410} SUPDRVMEMREFTYPE, *PSUPDRVMEMREFTYPE;
411
412
413/**
414 * Structure used for tracking memory a session
415 * references in one way or another.
416 */
417typedef struct SUPDRVMEMREF
418{
419 /** The memory object handle. */
420 RTR0MEMOBJ MemObj;
421 /** The ring-3 mapping memory object handle. */
422 RTR0MEMOBJ MapObjR3;
423 /** Type of memory. */
424 SUPDRVMEMREFTYPE eType;
425} SUPDRVMEMREF, *PSUPDRVMEMREF;
426
427
428/**
429 * Bundle of locked memory ranges.
430 */
431typedef struct SUPDRVBUNDLE
432{
433 /** Pointer to the next bundle. */
434 struct SUPDRVBUNDLE * volatile pNext;
435 /** Referenced memory. */
436 SUPDRVMEMREF aMem[64];
437 /** Number of entries used. */
438 uint32_t volatile cUsed;
439} SUPDRVBUNDLE, *PSUPDRVBUNDLE;
440
441
442/**
443 * Loaded image.
444 */
445typedef struct SUPDRVLDRIMAGE
446{
447 /** Next in chain. */
448 struct SUPDRVLDRIMAGE * volatile pNext;
449 /** Pointer to the image. */
450 void *pvImage;
451 /** Pointer to the optional module initialization callback. */
452 PFNR0MODULEINIT pfnModuleInit;
453 /** Pointer to the optional module termination callback. */
454 PFNR0MODULETERM pfnModuleTerm;
455 /** Size of the image. */
456 uint32_t cbImage;
457 /** The offset of the symbol table. */
458 uint32_t offSymbols;
459 /** The number of entries in the symbol table. */
460 uint32_t cSymbols;
461 /** The offset of the string table. */
462 uint32_t offStrTab;
463 /** Size of the string table. */
464 uint32_t cbStrTab;
465 /** The ldr image state. (IOCtl code of last opration.) */
466 uint32_t uState;
467 /** Usage count. */
468 uint32_t volatile cUsage;
469 /** Image name. */
470 char szName[32];
471} SUPDRVLDRIMAGE, *PSUPDRVLDRIMAGE;
472
473
474/** Image usage record. */
475typedef struct SUPDRVLDRUSAGE
476{
477 /** Next in chain. */
478 struct SUPDRVLDRUSAGE * volatile pNext;
479 /** The image. */
480 PSUPDRVLDRIMAGE pImage;
481 /** Load count. */
482 uint32_t volatile cUsage;
483} SUPDRVLDRUSAGE, *PSUPDRVLDRUSAGE;
484
485
486/**
487 * Component factory registration record.
488 */
489typedef struct SUPDRVFACTORYREG
490{
491 /** Pointer to the next registration. */
492 struct SUPDRVFACTORYREG *pNext;
493 /** Pointer to the registered factory. */
494 PCSUPDRVFACTORY pFactory;
495 /** The session owning the factory.
496 * Used for deregistration and session cleanup. */
497 PSUPDRVSESSION pSession;
498 /** Length of the name. */
499 size_t cchName;
500} SUPDRVFACTORYREG;
501/** Pointer to a component factory registration record. */
502typedef SUPDRVFACTORYREG *PSUPDRVFACTORYREG;
503/** Pointer to a const component factory registration record. */
504typedef SUPDRVFACTORYREG const *PCSUPDRVFACTORYREG;
505
506
507/**
508 * Registered object.
509 * This takes care of reference counting and tracking data for access checks.
510 */
511typedef struct SUPDRVOBJ
512{
513 /** Magic value (SUPDRVOBJ_MAGIC). */
514 uint32_t u32Magic;
515 /** The object type. */
516 SUPDRVOBJTYPE enmType;
517 /** Pointer to the next in the global list. */
518 struct SUPDRVOBJ * volatile pNext;
519 /** Pointer to the object destructor.
520 * This may be set to NULL if the image containing the destructor get unloaded. */
521 PFNSUPDRVDESTRUCTOR pfnDestructor;
522 /** User argument 1. */
523 void *pvUser1;
524 /** User argument 2. */
525 void *pvUser2;
526 /** The total sum of all per-session usage. */
527 uint32_t volatile cUsage;
528 /** The creator user id. */
529 RTUID CreatorUid;
530 /** The creator group id. */
531 RTGID CreatorGid;
532 /** The creator process id. */
533 RTPROCESS CreatorProcess;
534} SUPDRVOBJ, *PSUPDRVOBJ;
535
536/** Magic number for SUPDRVOBJ::u32Magic. (Dame Agatha Mary Clarissa Christie). */
537#define SUPDRVOBJ_MAGIC 0x18900915
538
539/**
540 * The per-session object usage record.
541 */
542typedef struct SUPDRVUSAGE
543{
544 /** Pointer to the next in the list. */
545 struct SUPDRVUSAGE * volatile pNext;
546 /** Pointer to the object we're recording usage for. */
547 PSUPDRVOBJ pObj;
548 /** The usage count. */
549 uint32_t volatile cUsage;
550} SUPDRVUSAGE, *PSUPDRVUSAGE;
551
552
553/**
554 * Per session data.
555 * This is mainly for memory tracking.
556 */
557typedef struct SUPDRVSESSION
558{
559 /** Pointer to the device extension. */
560 PSUPDRVDEVEXT pDevExt;
561 /** Session Cookie. */
562 uint32_t u32Cookie;
563
564 /** Load usage records. (protected by SUPDRVDEVEXT::mtxLdr) */
565 PSUPDRVLDRUSAGE volatile pLdrUsage;
566#ifdef VBOX_WITH_IDT_PATCHING
567 /** Patch usage records. (protected by SUPDRVDEVEXT::SpinLock) */
568 PSUPDRVPATCHUSAGE volatile pPatchUsage;
569#endif
570 /** The VM associated with the session. */
571 PVM pVM;
572 /** List of generic usage records. (protected by SUPDRVDEVEXT::SpinLock) */
573 PSUPDRVUSAGE volatile pUsage;
574
575 /** Spinlock protecting the bundles and the GIP members. */
576 RTSPINLOCK Spinlock;
577 /** The ring-3 mapping of the GIP (readonly). */
578 RTR0MEMOBJ GipMapObjR3;
579 /** Set if the session is using the GIP. */
580 uint32_t fGipReferenced;
581 /** Bundle of locked memory objects. */
582 SUPDRVBUNDLE Bundle;
583
584 /** The user id of the session. (Set by the OS part.) */
585 RTUID Uid;
586 /** The group id of the session. (Set by the OS part.) */
587 RTGID Gid;
588 /** The process (id) of the session. */
589 RTPROCESS Process;
590 /** Which process this session is associated with.
591 * This is NIL_RTR0PROCESS for kernel sessions and valid for user ones. */
592 RTR0PROCESS R0Process;
593#if defined(RT_OS_DARWIN)
594 /** Pointer to the associated org_virtualbox_SupDrvClient object. */
595 void *pvSupDrvClient;
596 /** Whether this session has been opened or not. */
597 bool fOpened;
598#endif
599#if defined(RT_OS_OS2)
600 /** The system file number of this session. */
601 uint16_t sfn;
602 uint16_t Alignment; /**< Alignment */
603#endif
604#if defined(RT_OS_DARWIN) || defined(RT_OS_OS2) || defined(RT_OS_SOLARIS)
605 /** Pointer to the next session with the same hash. */
606 PSUPDRVSESSION pNextHash;
607#endif
608} SUPDRVSESSION;
609
610
611/**
612 * Device extension.
613 */
614typedef struct SUPDRVDEVEXT
615{
616 /** Spinlock to serialize the initialization,
617 * usage counting and destruction of the IDT entry override and objects. */
618 RTSPINLOCK Spinlock;
619
620#ifdef VBOX_WITH_IDT_PATCHING
621 /** List of patches. */
622 PSUPDRVPATCH volatile pIdtPatches;
623 /** List of patches Free. */
624 PSUPDRVPATCH volatile pIdtPatchesFree;
625#endif
626
627 /** List of registered objects. Protected by the spinlock. */
628 PSUPDRVOBJ volatile pObjs;
629 /** List of free object usage records. */
630 PSUPDRVUSAGE volatile pUsageFree;
631
632 /** Global cookie. */
633 uint32_t u32Cookie;
634
635 /** The IDT entry number.
636 * Only valid if pIdtPatches is set. */
637 uint8_t volatile u8Idt;
638
639 /** Loader mutex.
640 * This protects pvVMMR0, pvVMMR0Entry, pImages and SUPDRVSESSION::pLdrUsage. */
641 RTSEMFASTMUTEX mtxLdr;
642
643 /** VMM Module 'handle'.
644 * 0 if the code VMM isn't loaded and Idt are nops. */
645 void * volatile pvVMMR0;
646 /** VMMR0EntryInt() pointer. */
647 DECLR0CALLBACKMEMBER(int, pfnVMMR0EntryInt, (PVM pVM, unsigned uOperation, void *pvArg));
648 /** VMMR0EntryFast() pointer. */
649 DECLR0CALLBACKMEMBER(void, pfnVMMR0EntryFast, (PVM pVM, unsigned uOperation));
650 /** VMMR0EntryEx() pointer. */
651 DECLR0CALLBACKMEMBER(int, pfnVMMR0EntryEx, (PVM pVM, unsigned uOperation, PSUPVMMR0REQHDR pReq, uint64_t u64Arg, PSUPDRVSESSION pSession));
652
653 /** Linked list of loaded code. */
654 PSUPDRVLDRIMAGE volatile pLdrImages;
655
656 /** GIP mutex.
657 * Any changes to any of the GIP members requires ownership of this mutex,
658 * except on driver init and termination. */
659 RTSEMFASTMUTEX mtxGip;
660 /** Pointer to the Global Info Page (GIP). */
661 PSUPGLOBALINFOPAGE pGip;
662 /** The physical address of the GIP. */
663 RTHCPHYS HCPhysGip;
664 /** Number of processes using the GIP.
665 * (The updates are suspend while cGipUsers is 0.)*/
666 uint32_t volatile cGipUsers;
667 /** The ring-0 memory object handle for the GIP page. */
668 RTR0MEMOBJ GipMemObj;
669 /** The GIP timer handle. */
670 PRTTIMER pGipTimer;
671 /** If non-zero we've successfully called RTTimerRequestSystemGranularity(). */
672 uint32_t u32SystemTimerGranularityGrant;
673 /** The CPU id of the GIP master.
674 * This CPU is responsible for the updating the common GIP data. */
675 RTCPUID volatile idGipMaster;
676
677 /** Component factory mutex.
678 * This protects pComponentFactoryHead and component factory querying. */
679 RTSEMFASTMUTEX mtxComponentFactory;
680 /** The head of the list of registered component factories. */
681 PSUPDRVFACTORYREG pComponentFactoryHead;
682} SUPDRVDEVEXT;
683
684
685__BEGIN_DECLS
686
687/*******************************************************************************
688* OS Specific Functions *
689*******************************************************************************/
690void VBOXCALL supdrvOSObjInitCreator(PSUPDRVOBJ pObj, PSUPDRVSESSION pSession);
691bool VBOXCALL supdrvOSObjCanAccess(PSUPDRVOBJ pObj, PSUPDRVSESSION pSession, const char *pszObjName, int *prc);
692bool VBOXCALL supdrvOSGetForcedAsyncTscMode(PSUPDRVDEVEXT pDevExt);
693
694/*******************************************************************************
695* Shared Functions *
696*******************************************************************************/
697int VBOXCALL supdrvIOCtl(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPREQHDR pReqHdr);
698int VBOXCALL supdrvIOCtlFast(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession);
699int VBOXCALL supdrvIDC(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPDRVIDCREQHDR pReqHdr);
700int VBOXCALL supdrvInitDevExt(PSUPDRVDEVEXT pDevExt);
701void VBOXCALL supdrvDeleteDevExt(PSUPDRVDEVEXT pDevExt);
702int VBOXCALL supdrvCreateSession(PSUPDRVDEVEXT pDevExt, bool fUser, PSUPDRVSESSION *ppSession);
703void VBOXCALL supdrvCloseSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession);
704void VBOXCALL supdrvCleanupSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession);
705int VBOXCALL supdrvGipInit(PSUPDRVDEVEXT pDevExt, PSUPGLOBALINFOPAGE pGip, RTHCPHYS HCPhys, uint64_t u64NanoTS, unsigned uUpdateHz);
706void VBOXCALL supdrvGipTerm(PSUPGLOBALINFOPAGE pGip);
707void VBOXCALL supdrvGipUpdate(PSUPGLOBALINFOPAGE pGip, uint64_t u64NanoTS);
708void VBOXCALL supdrvGipUpdatePerCpu(PSUPGLOBALINFOPAGE pGip, uint64_t u64NanoTS, unsigned iCpu);
709bool VBOXCALL supdrvDetermineAsyncTsc(uint64_t *pu64DiffCores);
710
711__END_DECLS
712
713#endif
714
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