SUPDRV.h@ 7086

Last change on this file since 7086 was 6418, checked in by vboxsync, 17 years ago
cosmetics on the hrtimer stuff.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 24.3 KB

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

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

source: vbox/trunk/src/VBox/HostDrivers/Support/SUPDRV.h@ 7086

Download in other formats: