SUPDRVShared.c@ 9212

Last change on this file since 9212 was 9212, checked in by vboxsync, 17 years ago

Major changes for sizeof(RTGCPTR) == uint64_t.
Introduced RCPTRTYPE for pointers valid in raw mode only (RTGCPTR32).

Disabled by default. Enable by adding VBOX_WITH_64_BITS_GUESTS to your LocalConfig.kmk.

Property svn:eol-style set to native
Property svn:keywords set to Author Date Id Revision

File size: 147.1 KB

Line
1	/* $Revision: 9212 $ */
2	/** @file
3	* VirtualBox Support Driver - Shared code.
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
32	/*******************************************************************************
33	* Header Files *
34	*******************************************************************************/
35	#include "SUPDRV.h"
36	#ifndef PAGE_SHIFT
37	# include <iprt/param.h>
38	#endif
39	#include <iprt/alloc.h>
40	#include <iprt/semaphore.h>
41	#include <iprt/spinlock.h>
42	#include <iprt/thread.h>
43	#include <iprt/process.h>
44	#include <iprt/mp.h>
45	#include <iprt/cpuset.h>
46	#include <iprt/log.h>
47	/* VBox/x86.h not compatible with the Linux kernel sources */
48	#ifdef RT_OS_LINUX
49	# define X86_CPUID_VENDOR_AMD_EBX 0x68747541
50	# define X86_CPUID_VENDOR_AMD_ECX 0x444d4163
51	# define X86_CPUID_VENDOR_AMD_EDX 0x69746e65
52	#else
53	# include <VBox/x86.h>
54	#endif
55
56	/*
57	* Logging assignments:
58	* Log - useful stuff, like failures.
59	* LogFlow - program flow, except the really noisy bits.
60	* Log2 - Cleanup and IDTE
61	* Log3 - Loader flow noise.
62	* Log4 - Call VMMR0 flow noise.
63	* Log5 - Native yet-to-be-defined noise.
64	* Log6 - Native ioctl flow noise.
65	*
66	* Logging requires BUILD_TYPE=debug and possibly changes to the logger
67	* instanciation in log-vbox.c(pp).
68	*/
69
70
71	/*******************************************************************************
72	* Defined Constants And Macros *
73	*******************************************************************************/
74	/* from x86.h - clashes with linux thus this duplication */
75	#undef X86_CR0_PG
76	#define X86_CR0_PG RT_BIT(31)
77	#undef X86_CR0_PE
78	#define X86_CR0_PE RT_BIT(0)
79	#undef X86_CPUID_AMD_FEATURE_EDX_NX
80	#define X86_CPUID_AMD_FEATURE_EDX_NX RT_BIT(20)
81	#undef MSR_K6_EFER
82	#define MSR_K6_EFER 0xc0000080
83	#undef MSR_K6_EFER_NXE
84	#define MSR_K6_EFER_NXE RT_BIT(11)
85	#undef MSR_K6_EFER_LMA
86	#define MSR_K6_EFER_LMA RT_BIT(10)
87	#undef X86_CR4_PGE
88	#define X86_CR4_PGE RT_BIT(7)
89	#undef X86_CR4_PAE
90	#define X86_CR4_PAE RT_BIT(5)
91	#undef X86_CPUID_AMD_FEATURE_EDX_LONG_MODE
92	#define X86_CPUID_AMD_FEATURE_EDX_LONG_MODE RT_BIT(29)
93
94
95	/** The frequency by which we recalculate the u32UpdateHz and
96	* u32UpdateIntervalNS GIP members. The value must be a power of 2. */
97	#define GIP_UPDATEHZ_RECALC_FREQ 0x800
98
99	/**
100	* Validates a session pointer.
101	*
102	* @returns true/false accordingly.
103	* @param pSession The session.
104	*/
105	#define SUP_IS_SESSION_VALID(pSession) \
106	( VALID_PTR(pSession) \
107	&& pSession->u32Cookie == BIRD_INV)
108
109
110	/*******************************************************************************
111	* Global Variables *
112	*******************************************************************************/
113	/**
114	* Array of the R0 SUP API.
115	*/
116	static SUPFUNC g_aFunctions[] =
117	{
118	/* name function */
119	{ "SUPR0ObjRegister", (void *)SUPR0ObjRegister },
120	{ "SUPR0ObjAddRef", (void *)SUPR0ObjAddRef },
121	{ "SUPR0ObjRelease", (void *)SUPR0ObjRelease },
122	{ "SUPR0ObjVerifyAccess", (void *)SUPR0ObjVerifyAccess },
123	{ "SUPR0LockMem", (void *)SUPR0LockMem },
124	{ "SUPR0UnlockMem", (void *)SUPR0UnlockMem },
125	{ "SUPR0ContAlloc", (void *)SUPR0ContAlloc },
126	{ "SUPR0ContFree", (void *)SUPR0ContFree },
127	{ "SUPR0LowAlloc", (void *)SUPR0LowAlloc },
128	{ "SUPR0LowFree", (void *)SUPR0LowFree },
129	{ "SUPR0MemAlloc", (void *)SUPR0MemAlloc },
130	{ "SUPR0MemGetPhys", (void *)SUPR0MemGetPhys },
131	{ "SUPR0MemFree", (void *)SUPR0MemFree },
132	{ "SUPR0PageAlloc", (void *)SUPR0PageAlloc },
133	{ "SUPR0PageFree", (void *)SUPR0PageFree },
134	{ "SUPR0Printf", (void *)SUPR0Printf },
135	{ "RTMemAlloc", (void *)RTMemAlloc },
136	{ "RTMemAllocZ", (void *)RTMemAllocZ },
137	{ "RTMemFree", (void *)RTMemFree },
138	/{ "RTMemDup", (void )RTMemDup },*/
139	{ "RTMemRealloc", (void *)RTMemRealloc },
140	{ "RTR0MemObjAllocLow", (void *)RTR0MemObjAllocLow },
141	{ "RTR0MemObjAllocPage", (void *)RTR0MemObjAllocPage },
142	{ "RTR0MemObjAllocPhys", (void *)RTR0MemObjAllocPhys },
143	{ "RTR0MemObjAllocPhysNC", (void *)RTR0MemObjAllocPhysNC },
144	{ "RTR0MemObjAllocCont", (void *)RTR0MemObjAllocCont },
145	{ "RTR0MemObjLockUser", (void *)RTR0MemObjLockUser },
146	{ "RTR0MemObjMapKernel", (void *)RTR0MemObjMapKernel },
147	{ "RTR0MemObjMapUser", (void *)RTR0MemObjMapUser },
148	{ "RTR0MemObjAddress", (void *)RTR0MemObjAddress },
149	{ "RTR0MemObjAddressR3", (void *)RTR0MemObjAddressR3 },
150	{ "RTR0MemObjSize", (void *)RTR0MemObjSize },
151	{ "RTR0MemObjIsMapping", (void *)RTR0MemObjIsMapping },
152	{ "RTR0MemObjGetPagePhysAddr", (void *)RTR0MemObjGetPagePhysAddr },
153	{ "RTR0MemObjFree", (void *)RTR0MemObjFree },
154	/* These don't work yet on linux - use fast mutexes!
155	{ "RTSemMutexCreate", (void *)RTSemMutexCreate },
156	{ "RTSemMutexRequest", (void *)RTSemMutexRequest },
157	{ "RTSemMutexRelease", (void *)RTSemMutexRelease },
158	{ "RTSemMutexDestroy", (void *)RTSemMutexDestroy },
159	*/
160	{ "RTProcSelf", (void *)RTProcSelf },
161	{ "RTR0ProcHandleSelf", (void *)RTR0ProcHandleSelf },
162	{ "RTSemFastMutexCreate", (void *)RTSemFastMutexCreate },
163	{ "RTSemFastMutexDestroy", (void *)RTSemFastMutexDestroy },
164	{ "RTSemFastMutexRequest", (void *)RTSemFastMutexRequest },
165	{ "RTSemFastMutexRelease", (void *)RTSemFastMutexRelease },
166	{ "RTSemEventCreate", (void *)RTSemEventCreate },
167	{ "RTSemEventSignal", (void *)RTSemEventSignal },
168	{ "RTSemEventWait", (void *)RTSemEventWait },
169	{ "RTSemEventWaitNoResume", (void *)RTSemEventWaitNoResume },
170	{ "RTSemEventDestroy", (void *)RTSemEventDestroy },
171	{ "RTSemEventMultiCreate", (void *)RTSemEventMultiCreate },
172	{ "RTSemEventMultiSignal", (void *)RTSemEventMultiSignal },
173	{ "RTSemEventMultiReset", (void *)RTSemEventMultiReset },
174	{ "RTSemEventMultiWait", (void *)RTSemEventMultiWait },
175	{ "RTSemEventMultiWaitNoResume", (void *)RTSemEventMultiWaitNoResume },
176	{ "RTSemEventMultiDestroy", (void *)RTSemEventMultiDestroy },
177	{ "RTSpinlockCreate", (void *)RTSpinlockCreate },
178	{ "RTSpinlockDestroy", (void *)RTSpinlockDestroy },
179	{ "RTSpinlockAcquire", (void *)RTSpinlockAcquire },
180	{ "RTSpinlockRelease", (void *)RTSpinlockRelease },
181	{ "RTSpinlockAcquireNoInts", (void *)RTSpinlockAcquireNoInts },
182	{ "RTSpinlockReleaseNoInts", (void *)RTSpinlockReleaseNoInts },
183	{ "RTThreadNativeSelf", (void *)RTThreadNativeSelf },
184	{ "RTThreadSleep", (void *)RTThreadSleep },
185	{ "RTThreadYield", (void *)RTThreadYield },
186	#if 0 /* Thread APIs, Part 2. */
187	{ "RTThreadSelf", (void *)RTThreadSelf },
188	{ "RTThreadCreate", (void *)RTThreadCreate },
189	{ "RTThreadGetNative", (void *)RTThreadGetNative },
190	{ "RTThreadWait", (void *)RTThreadWait },
191	{ "RTThreadWaitNoResume", (void *)RTThreadWaitNoResume },
192	{ "RTThreadGetName", (void *)RTThreadGetName },
193	{ "RTThreadSelfName", (void *)RTThreadSelfName },
194	{ "RTThreadGetType", (void *)RTThreadGetType },
195	{ "RTThreadUserSignal", (void *)RTThreadUserSignal },
196	{ "RTThreadUserReset", (void *)RTThreadUserReset },
197	{ "RTThreadUserWait", (void *)RTThreadUserWait },
198	{ "RTThreadUserWaitNoResume", (void *)RTThreadUserWaitNoResume },
199	#endif
200	{ "RTLogDefaultInstance", (void *)RTLogDefaultInstance },
201	{ "RTMpCpuId", (void *)RTMpCpuId },
202	{ "RTMpCpuIdFromSetIndex", (void *)RTMpCpuIdFromSetIndex },
203	{ "RTMpCpuIdToSetIndex", (void *)RTMpCpuIdToSetIndex },
204	{ "RTMpDoesCpuExist", (void *)RTMpDoesCpuExist },
205	{ "RTMpGetCount", (void *)RTMpGetCount },
206	{ "RTMpGetMaxCpuId", (void *)RTMpGetMaxCpuId },
207	{ "RTMpGetOnlineCount", (void *)RTMpGetOnlineCount },
208	{ "RTMpGetOnlineSet", (void *)RTMpGetOnlineSet },
209	{ "RTMpGetSet", (void *)RTMpGetSet },
210	{ "RTMpIsCpuOnline", (void *)RTMpIsCpuOnline },
211	{ "RTMpOnAll", (void *)RTMpOnAll },
212	{ "RTMpOnOthers", (void *)RTMpOnOthers },
213	{ "RTMpOnSpecific", (void *)RTMpOnSpecific },
214	{ "RTLogRelDefaultInstance", (void *)RTLogRelDefaultInstance },
215	{ "RTLogSetDefaultInstanceThread", (void *)RTLogSetDefaultInstanceThread },
216	{ "RTLogLogger", (void *)RTLogLogger },
217	{ "RTLogLoggerEx", (void *)RTLogLoggerEx },
218	{ "RTLogLoggerExV", (void *)RTLogLoggerExV },
219	{ "RTLogPrintf", (void *)RTLogPrintf },
220	{ "RTLogPrintfV", (void *)RTLogPrintfV },
221	{ "AssertMsg1", (void *)AssertMsg1 },
222	{ "AssertMsg2", (void *)AssertMsg2 },
223	};
224
225
226	/*******************************************************************************
227	* Internal Functions *
228	*******************************************************************************/
229	static int supdrvMemAdd(PSUPDRVMEMREF pMem, PSUPDRVSESSION pSession);
230	static int supdrvMemRelease(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr, SUPDRVMEMREFTYPE eType);
231	#ifdef VBOX_WITH_IDT_PATCHING
232	static int supdrvIOCtl_IdtInstall(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPIDTINSTALL pReq);
233	static PSUPDRVPATCH supdrvIdtPatchOne(PSUPDRVDEVEXT pDevExt, PSUPDRVPATCH pPatch);
234	static int supdrvIOCtl_IdtRemoveAll(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession);
235	static void supdrvIdtRemoveOne(PSUPDRVDEVEXT pDevExt, PSUPDRVPATCH pPatch);
236	static void supdrvIdtWrite(volatile void pvIdtEntry, const SUPDRVIDTE pNewIDTEntry);
237	#endif /* VBOX_WITH_IDT_PATCHING */
238	static int supdrvIOCtl_LdrOpen(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDROPEN pReq);
239	static int supdrvIOCtl_LdrLoad(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRLOAD pReq);
240	static int supdrvIOCtl_LdrFree(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRFREE pReq);
241	static int supdrvIOCtl_LdrGetSymbol(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRGETSYMBOL pReq);
242	static int supdrvLdrSetR0EP(PSUPDRVDEVEXT pDevExt, void pvVMMR0, void pvVMMR0EntryInt, void pvVMMR0EntryFast, void pvVMMR0EntryEx);
243	static void supdrvLdrUnsetR0EP(PSUPDRVDEVEXT pDevExt);
244	static void supdrvLdrAddUsage(PSUPDRVSESSION pSession, PSUPDRVLDRIMAGE pImage);
245	static void supdrvLdrFree(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage);
246	static SUPPAGINGMODE supdrvIOCtl_GetPagingMode(void);
247	static SUPGIPMODE supdrvGipDeterminTscMode(PSUPDRVDEVEXT pDevExt);
248	#ifdef RT_OS_WINDOWS
249	static int supdrvPageGetPhys(PSUPDRVSESSION pSession, RTR3PTR pvR3, uint32_t cPages, PRTHCPHYS paPages);
250	static bool supdrvPageWasLockedByPageAlloc(PSUPDRVSESSION pSession, RTR3PTR pvR3);
251	#endif
252	#ifdef USE_NEW_OS_INTERFACE_FOR_GIP
253	static int supdrvGipCreate(PSUPDRVDEVEXT pDevExt);
254	static void supdrvGipDestroy(PSUPDRVDEVEXT pDevExt);
255	static DECLCALLBACK(void) supdrvGipTimer(PRTTIMER pTimer, void *pvUser);
256	#endif
257
258
259	/**
260	* Initializes the device extentsion structure.
261	*
262	* @returns IPRT status code.
263	* @param pDevExt The device extension to initialize.
264	*/
265	int VBOXCALL supdrvInitDevExt(PSUPDRVDEVEXT pDevExt)
266	{
267	/*
268	* Initialize it.
269	*/
270	int rc;
271	memset(pDevExt, 0, sizeof(*pDevExt));
272	rc = RTSpinlockCreate(&pDevExt->Spinlock);
273	if (!rc)
274	{
275	rc = RTSemFastMutexCreate(&pDevExt->mtxLdr);
276	if (!rc)
277	{
278	rc = RTSemFastMutexCreate(&pDevExt->mtxGip);
279	if (!rc)
280	{
281	#ifdef USE_NEW_OS_INTERFACE_FOR_GIP
282	rc = supdrvGipCreate(pDevExt);
283	if (RT_SUCCESS(rc))
284	{
285	pDevExt->u32Cookie = BIRD; /** @todo make this random? */
286	return VINF_SUCCESS;
287	}
288	#else
289	pDevExt->u32Cookie = BIRD;
290	return VINF_SUCCESS;
291	#endif
292	}
293	RTSemFastMutexDestroy(pDevExt->mtxLdr);
294	pDevExt->mtxLdr = NIL_RTSEMFASTMUTEX;
295	}
296	RTSpinlockDestroy(pDevExt->Spinlock);
297	pDevExt->Spinlock = NIL_RTSPINLOCK;
298	}
299	return rc;
300	}
301
302
303	/**
304	* Delete the device extension (e.g. cleanup members).
305	*
306	* @param pDevExt The device extension to delete.
307	*/
308	void VBOXCALL supdrvDeleteDevExt(PSUPDRVDEVEXT pDevExt)
309	{
310	#ifdef VBOX_WITH_IDT_PATCHING
311	PSUPDRVPATCH pPatch;
312	#endif
313	PSUPDRVOBJ pObj;
314	PSUPDRVUSAGE pUsage;
315
316	/*
317	* Kill mutexes and spinlocks.
318	*/
319	RTSemFastMutexDestroy(pDevExt->mtxGip);
320	pDevExt->mtxGip = NIL_RTSEMFASTMUTEX;
321	RTSemFastMutexDestroy(pDevExt->mtxLdr);
322	pDevExt->mtxLdr = NIL_RTSEMFASTMUTEX;
323	RTSpinlockDestroy(pDevExt->Spinlock);
324	pDevExt->Spinlock = NIL_RTSPINLOCK;
325
326	/*
327	* Free lists.
328	*/
329	#ifdef VBOX_WITH_IDT_PATCHING
330	/* patches */
331	/** @todo make sure we don't uninstall patches which has been patched by someone else. */
332	pPatch = pDevExt->pIdtPatchesFree;
333	pDevExt->pIdtPatchesFree = NULL;
334	while (pPatch)
335	{
336	void *pvFree = pPatch;
337	pPatch = pPatch->pNext;
338	RTMemExecFree(pvFree);
339	}
340	#endif /* VBOX_WITH_IDT_PATCHING */
341
342	/* objects. */
343	pObj = pDevExt->pObjs;
344	#if !defined(DEBUG_bird) \|\| !defined(RT_OS_LINUX) /* breaks unloading, temporary, remove me! */
345	Assert(!pObj); /* (can trigger on forced unloads) */
346	#endif
347	pDevExt->pObjs = NULL;
348	while (pObj)
349	{
350	void *pvFree = pObj;
351	pObj = pObj->pNext;
352	RTMemFree(pvFree);
353	}
354
355	/* usage records. */
356	pUsage = pDevExt->pUsageFree;
357	pDevExt->pUsageFree = NULL;
358	while (pUsage)
359	{
360	void *pvFree = pUsage;
361	pUsage = pUsage->pNext;
362	RTMemFree(pvFree);
363	}
364
365	#ifdef USE_NEW_OS_INTERFACE_FOR_GIP
366	/* kill the GIP */
367	supdrvGipDestroy(pDevExt);
368	#endif
369	}
370
371
372	/**
373	* Create session.
374	*
375	* @returns IPRT status code.
376	* @param pDevExt Device extension.
377	* @param ppSession Where to store the pointer to the session data.
378	*/
379	int VBOXCALL supdrvCreateSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION *ppSession)
380	{
381	/*
382	* Allocate memory for the session data.
383	*/
384	int rc = VERR_NO_MEMORY;
385	PSUPDRVSESSION pSession = ppSession = (PSUPDRVSESSION)RTMemAllocZ(sizeof(pSession));
386	if (pSession)
387	{
388	/* Initialize session data. */
389	rc = RTSpinlockCreate(&pSession->Spinlock);
390	if (!rc)
391	{
392	Assert(pSession->Spinlock != NIL_RTSPINLOCK);
393	pSession->pDevExt = pDevExt;
394	pSession->u32Cookie = BIRD_INV;
395	/*pSession->pLdrUsage = NULL;
396	pSession->pPatchUsage = NULL;
397	pSession->pUsage = NULL;
398	pSession->pGip = NULL;
399	pSession->fGipReferenced = false;
400	pSession->Bundle.cUsed = 0 */
401
402	LogFlow(("Created session %p initial cookie=%#x\n", pSession, pSession->u32Cookie));
403	return VINF_SUCCESS;
404	}
405
406	RTMemFree(pSession);
407	*ppSession = NULL;
408	Log(("Failed to create spinlock, rc=%d!\n", rc));
409	}
410
411	return rc;
412	}
413
414
415	/**
416	* Shared code for cleaning up a session.
417	*
418	* @param pDevExt Device extension.
419	* @param pSession Session data.
420	* This data will be freed by this routine.
421	*/
422	void VBOXCALL supdrvCloseSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession)
423	{
424	/*
425	* Cleanup the session first.
426	*/
427	supdrvCleanupSession(pDevExt, pSession);
428
429	/*
430	* Free the rest of the session stuff.
431	*/
432	RTSpinlockDestroy(pSession->Spinlock);
433	pSession->Spinlock = NIL_RTSPINLOCK;
434	pSession->pDevExt = NULL;
435	RTMemFree(pSession);
436	LogFlow(("supdrvCloseSession: returns\n"));
437	}
438
439
440	/**
441	* Shared code for cleaning up a session (but not quite freeing it).
442	*
443	* This is primarily intended for MAC OS X where we have to clean up the memory
444	* stuff before the file handle is closed.
445	*
446	* @param pDevExt Device extension.
447	* @param pSession Session data.
448	* This data will be freed by this routine.
449	*/
450	void VBOXCALL supdrvCleanupSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession)
451	{
452	PSUPDRVBUNDLE pBundle;
453	LogFlow(("supdrvCleanupSession: pSession=%p\n", pSession));
454
455	/*
456	* Remove logger instances related to this session.
457	*/
458	RTLogSetDefaultInstanceThread(NULL, (uintptr_t)pSession);
459
460	#ifdef VBOX_WITH_IDT_PATCHING
461	/*
462	* Uninstall any IDT patches installed for this session.
463	*/
464	supdrvIOCtl_IdtRemoveAll(pDevExt, pSession);
465	#endif
466
467	/*
468	* Release object references made in this session.
469	* In theory there should be noone racing us in this session.
470	*/
471	Log2(("release objects - start\n"));
472	if (pSession->pUsage)
473	{
474	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
475	PSUPDRVUSAGE pUsage;
476	RTSpinlockAcquire(pDevExt->Spinlock, &SpinlockTmp);
477
478	while ((pUsage = pSession->pUsage) != NULL)
479	{
480	PSUPDRVOBJ pObj = pUsage->pObj;
481	pSession->pUsage = pUsage->pNext;
482
483	AssertMsg(pUsage->cUsage >= 1 && pObj->cUsage >= pUsage->cUsage, ("glob %d; sess %d\n", pObj->cUsage, pUsage->cUsage));
484	if (pUsage->cUsage < pObj->cUsage)
485	{
486	pObj->cUsage -= pUsage->cUsage;
487	RTSpinlockRelease(pDevExt->Spinlock, &SpinlockTmp);
488	}
489	else
490	{
491	/* Destroy the object and free the record. */
492	if (pDevExt->pObjs == pObj)
493	pDevExt->pObjs = pObj->pNext;
494	else
495	{
496	PSUPDRVOBJ pObjPrev;
497	for (pObjPrev = pDevExt->pObjs; pObjPrev; pObjPrev = pObjPrev->pNext)
498	if (pObjPrev->pNext == pObj)
499	{
500	pObjPrev->pNext = pObj->pNext;
501	break;
502	}
503	Assert(pObjPrev);
504	}
505	RTSpinlockRelease(pDevExt->Spinlock, &SpinlockTmp);
506
507	Log(("supdrvCleanupSession: destroying %p/%d (%p/%p) cpid=%RTproc pid=%RTproc dtor=%p\n",
508	pObj, pObj->enmType, pObj->pvUser1, pObj->pvUser2, pObj->CreatorProcess, RTProcSelf(), pObj->pfnDestructor));
509	if (pObj->pfnDestructor)
510	pObj->pfnDestructor(pObj, pObj->pvUser1, pObj->pvUser2);
511	RTMemFree(pObj);
512	}
513
514	/* free it and continue. */
515	RTMemFree(pUsage);
516
517	RTSpinlockAcquire(pDevExt->Spinlock, &SpinlockTmp);
518	}
519
520	RTSpinlockRelease(pDevExt->Spinlock, &SpinlockTmp);
521	AssertMsg(!pSession->pUsage, ("Some buster reregistered an object during desturction!\n"));
522	}
523	Log2(("release objects - done\n"));
524
525	/*
526	* Release memory allocated in the session.
527	*
528	* We do not serialize this as we assume that the application will
529	* not allocated memory while closing the file handle object.
530	*/
531	Log2(("freeing memory:\n"));
532	pBundle = &pSession->Bundle;
533	while (pBundle)
534	{
535	PSUPDRVBUNDLE pToFree;
536	unsigned i;
537
538	/*
539	* Check and unlock all entries in the bundle.
540	*/
541	for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
542	{
543	if (pBundle->aMem[i].MemObj != NIL_RTR0MEMOBJ)
544	{
545	int rc;
546	Log2(("eType=%d pvR0=%p pvR3=%p cb=%ld\n", pBundle->aMem[i].eType, RTR0MemObjAddress(pBundle->aMem[i].MemObj),
547	(void *)RTR0MemObjAddressR3(pBundle->aMem[i].MapObjR3), (long)RTR0MemObjSize(pBundle->aMem[i].MemObj)));
548	if (pBundle->aMem[i].MapObjR3 != NIL_RTR0MEMOBJ)
549	{
550	rc = RTR0MemObjFree(pBundle->aMem[i].MapObjR3, false);
551	AssertRC(rc); /** @todo figure out how to handle this. */
552	pBundle->aMem[i].MapObjR3 = NIL_RTR0MEMOBJ;
553	}
554	rc = RTR0MemObjFree(pBundle->aMem[i].MemObj, false);
555	AssertRC(rc); /** @todo figure out how to handle this. */
556	pBundle->aMem[i].MemObj = NIL_RTR0MEMOBJ;
557	pBundle->aMem[i].eType = MEMREF_TYPE_UNUSED;
558	}
559	}
560
561	/*
562	* Advance and free previous bundle.
563	*/
564	pToFree = pBundle;
565	pBundle = pBundle->pNext;
566
567	pToFree->pNext = NULL;
568	pToFree->cUsed = 0;
569	if (pToFree != &pSession->Bundle)
570	RTMemFree(pToFree);
571	}
572	Log2(("freeing memory - done\n"));
573
574	/*
575	* Loaded images needs to be dereferenced and possibly freed up.
576	*/
577	RTSemFastMutexRequest(pDevExt->mtxLdr);
578	Log2(("freeing images:\n"));
579	if (pSession->pLdrUsage)
580	{
581	PSUPDRVLDRUSAGE pUsage = pSession->pLdrUsage;
582	pSession->pLdrUsage = NULL;
583	while (pUsage)
584	{
585	void *pvFree = pUsage;
586	PSUPDRVLDRIMAGE pImage = pUsage->pImage;
587	if (pImage->cUsage > pUsage->cUsage)
588	pImage->cUsage -= pUsage->cUsage;
589	else
590	supdrvLdrFree(pDevExt, pImage);
591	pUsage->pImage = NULL;
592	pUsage = pUsage->pNext;
593	RTMemFree(pvFree);
594	}
595	}
596	RTSemFastMutexRelease(pDevExt->mtxLdr);
597	Log2(("freeing images - done\n"));
598
599	/*
600	* Unmap the GIP.
601	*/
602	Log2(("umapping GIP:\n"));
603	#ifdef USE_NEW_OS_INTERFACE_FOR_GIP
604	if (pSession->GipMapObjR3 != NIL_RTR0MEMOBJ)
605	#else
606	if (pSession->pGip)
607	#endif
608	{
609	SUPR0GipUnmap(pSession);
610	#ifndef USE_NEW_OS_INTERFACE_FOR_GIP
611	pSession->pGip = NULL;
612	#endif
613	pSession->fGipReferenced = 0;
614	}
615	Log2(("umapping GIP - done\n"));
616	}
617
618
619	/**
620	* Fast path I/O Control worker.
621	*
622	* @returns VBox status code that should be passed down to ring-3 unchanged.
623	* @param uIOCtl Function number.
624	* @param pDevExt Device extention.
625	* @param pSession Session data.
626	*/
627	int VBOXCALL supdrvIOCtlFast(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession)
628	{
629	int rc;
630
631	/*
632	* We check the two prereqs after doing this only to allow the compiler to optimize things better.
633	*/
634	if (RT_LIKELY(pSession->pVM && pDevExt->pfnVMMR0EntryFast))
635	{
636	switch (uIOCtl)
637	{
638	case SUP_IOCTL_FAST_DO_RAW_RUN:
639	rc = pDevExt->pfnVMMR0EntryFast(pSession->pVM, SUP_VMMR0_DO_RAW_RUN);
640	break;
641	case SUP_IOCTL_FAST_DO_HWACC_RUN:
642	rc = pDevExt->pfnVMMR0EntryFast(pSession->pVM, SUP_VMMR0_DO_HWACC_RUN);
643	break;
644	case SUP_IOCTL_FAST_DO_NOP:
645	rc = pDevExt->pfnVMMR0EntryFast(pSession->pVM, SUP_VMMR0_DO_NOP);
646	break;
647	default:
648	rc = VERR_INTERNAL_ERROR;
649	break;
650	}
651	}
652	else
653	rc = VERR_INTERNAL_ERROR;
654
655	return rc;
656	}
657
658
659	/**
660	* Helper for supdrvIOCtl. Check if pszStr contains any character of pszChars.
661	* We would use strpbrk here if this function would be contained in the RedHat kABI white
662	* list, see http://www.kerneldrivers.org/RHEL5.
663	*
664	* @return 1 if pszStr does contain any character of pszChars, 0 otherwise.
665	* @param pszStr String to check
666	* @param pszChars Character set
667	*/
668	static int supdrvCheckInvalidChar(const char pszStr, const char pszChars)
669	{
670	int chCur;
671	while ((chCur = *pszStr++) != '\0')
672	{
673	int ch;
674	const char *psz = pszChars;
675	while ((ch = *psz++) != '\0')
676	if (ch == chCur)
677	return 1;
678
679	}
680	return 0;
681	}
682
683
684	/**
685	* I/O Control worker.
686	*
687	* @returns 0 on success.
688	* @returns VERR_INVALID_PARAMETER if the request is invalid.
689	*
690	* @param uIOCtl Function number.
691	* @param pDevExt Device extention.
692	* @param pSession Session data.
693	* @param pReqHdr The request header.
694	*/
695	int VBOXCALL supdrvIOCtl(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPREQHDR pReqHdr)
696	{
697	/*
698	* Validate the request.
699	*/
700	/* this first check could probably be omitted as its also done by the OS specific code... */
701	if (RT_UNLIKELY( (pReqHdr->fFlags & SUPREQHDR_FLAGS_MAGIC_MASK) != SUPREQHDR_FLAGS_MAGIC
702	\|\| pReqHdr->cbIn < sizeof(*pReqHdr)
703	\|\| pReqHdr->cbOut < sizeof(*pReqHdr)))
704	{
705	OSDBGPRINT(("vboxdrv: Bad ioctl request header; cbIn=%#lx cbOut=%#lx fFlags=%#lx\n",
706	(long)pReqHdr->cbIn, (long)pReqHdr->cbOut, (long)pReqHdr->fFlags));
707	return VERR_INVALID_PARAMETER;
708	}
709	if (RT_UNLIKELY(uIOCtl == SUP_IOCTL_COOKIE))
710	{
711	if (pReqHdr->u32Cookie != SUPCOOKIE_INITIAL_COOKIE)
712	{
713	OSDBGPRINT(("SUP_IOCTL_COOKIE: bad cookie %#lx\n", (long)pReqHdr->u32Cookie));
714	return VERR_INVALID_PARAMETER;
715	}
716	}
717	else if (RT_UNLIKELY( pReqHdr->u32Cookie != pDevExt->u32Cookie
718	\|\| pReqHdr->u32SessionCookie != pSession->u32Cookie))
719	{
720	OSDBGPRINT(("vboxdrv: bad cookie %#lx / %#lx.\n", (long)pReqHdr->u32Cookie, (long)pReqHdr->u32SessionCookie));
721	return VERR_INVALID_PARAMETER;
722	}
723
724	/*
725	* Validation macros
726	*/
727	#define REQ_CHECK_SIZES_EX(Name, cbInExpect, cbOutExpect) \
728	do { \
729	if (RT_UNLIKELY(pReqHdr->cbIn != (cbInExpect) \|\| pReqHdr->cbOut != (cbOutExpect))) \
730	{ \
731	OSDBGPRINT(( #Name ": Invalid input/output sizes. cbIn=%ld expected %ld. cbOut=%ld expected %ld.\n", \
732	(long)pReq->Hdr.cbIn, (long)(cbInExpect), (long)pReq->Hdr.cbOut, (long)(cbOutExpect))); \
733	return pReq->Hdr.rc = VERR_INVALID_PARAMETER; \
734	} \
735	} while (0)
736
737	#define REQ_CHECK_SIZES(Name) REQ_CHECK_SIZES_EX(Name, Name ## _SIZE_IN, Name ## _SIZE_OUT)
738
739	#define REQ_CHECK_SIZE_IN(Name, cbInExpect) \
740	do { \
741	if (RT_UNLIKELY(pReqHdr->cbIn != (cbInExpect))) \
742	{ \
743	OSDBGPRINT(( #Name ": Invalid input/output sizes. cbIn=%ld expected %ld.\n", \
744	(long)pReq->Hdr.cbIn, (long)(cbInExpect))); \
745	return pReq->Hdr.rc = VERR_INVALID_PARAMETER; \
746	} \
747	} while (0)
748
749	#define REQ_CHECK_SIZE_OUT(Name, cbOutExpect) \
750	do { \
751	if (RT_UNLIKELY(pReqHdr->cbOut != (cbOutExpect))) \
752	{ \
753	OSDBGPRINT(( #Name ": Invalid input/output sizes. cbOut=%ld expected %ld.\n", \
754	(long)pReq->Hdr.cbOut, (long)(cbOutExpect))); \
755	return pReq->Hdr.rc = VERR_INVALID_PARAMETER; \
756	} \
757	} while (0)
758
759	#define REQ_CHECK_EXPR(Name, expr) \
760	do { \
761	if (RT_UNLIKELY(!(expr))) \
762	{ \
763	OSDBGPRINT(( #Name ": %s\n", #expr)); \
764	return pReq->Hdr.rc = VERR_INVALID_PARAMETER; \
765	} \
766	} while (0)
767
768	#define REQ_CHECK_EXPR_FMT(expr, fmt) \
769	do { \
770	if (RT_UNLIKELY(!(expr))) \
771	{ \
772	OSDBGPRINT( fmt ); \
773	return pReq->Hdr.rc = VERR_INVALID_PARAMETER; \
774	} \
775	} while (0)
776
777
778	/*
779	* The switch.
780	*/
781	switch (SUP_CTL_CODE_NO_SIZE(uIOCtl))
782	{
783	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_COOKIE):
784	{
785	PSUPCOOKIE pReq = (PSUPCOOKIE)pReqHdr;
786	REQ_CHECK_SIZES(SUP_IOCTL_COOKIE);
787	if (strncmp(pReq->u.In.szMagic, SUPCOOKIE_MAGIC, sizeof(pReq->u.In.szMagic)))
788	{
789	OSDBGPRINT(("SUP_IOCTL_COOKIE: invalid magic %.16s\n", pReq->u.In.szMagic));
790	pReq->Hdr.rc = VERR_INVALID_MAGIC;
791	return 0;
792	}
793
794	#if 0
795	/*
796	* Call out to the OS specific code and let it do permission checks on the
797	* client process.
798	*/
799	if (!supdrvOSValidateClientProcess(pDevExt, pSession))
800	{
801	pReq->u.Out.u32Cookie = 0xffffffff;
802	pReq->u.Out.u32SessionCookie = 0xffffffff;
803	pReq->u.Out.u32SessionVersion = 0xffffffff;
804	pReq->u.Out.u32DriverVersion = SUPDRVIOC_VERSION;
805	pReq->u.Out.pSession = NULL;
806	pReq->u.Out.cFunctions = 0;
807	pReq->Hdr.rc = VERR_PERMISSION_DENIED;
808	return 0;
809	}
810	#endif
811
812	/*
813	* Match the version.
814	* The current logic is very simple, match the major interface version.
815	*/
816	if ( pReq->u.In.u32MinVersion > SUPDRVIOC_VERSION
817	\|\| (pReq->u.In.u32MinVersion & 0xffff0000) != (SUPDRVIOC_VERSION & 0xffff0000))
818	{
819	OSDBGPRINT(("SUP_IOCTL_COOKIE: Version mismatch. Requested: %#x Min: %#x Current: %#x\n",
820	pReq->u.In.u32ReqVersion, pReq->u.In.u32MinVersion, SUPDRVIOC_VERSION));
821	pReq->u.Out.u32Cookie = 0xffffffff;
822	pReq->u.Out.u32SessionCookie = 0xffffffff;
823	pReq->u.Out.u32SessionVersion = 0xffffffff;
824	pReq->u.Out.u32DriverVersion = SUPDRVIOC_VERSION;
825	pReq->u.Out.pSession = NULL;
826	pReq->u.Out.cFunctions = 0;
827	pReq->Hdr.rc = VERR_VERSION_MISMATCH;
828	return 0;
829	}
830
831	/*
832	* Fill in return data and be gone.
833	* N.B. The first one to change SUPDRVIOC_VERSION shall makes sure that
834	* u32SessionVersion <= u32ReqVersion!
835	*/
836	/** @todo Somehow validate the client and negotiate a secure cookie... */
837	pReq->u.Out.u32Cookie = pDevExt->u32Cookie;
838	pReq->u.Out.u32SessionCookie = pSession->u32Cookie;
839	pReq->u.Out.u32SessionVersion = SUPDRVIOC_VERSION;
840	pReq->u.Out.u32DriverVersion = SUPDRVIOC_VERSION;
841	pReq->u.Out.pSession = pSession;
842	pReq->u.Out.cFunctions = sizeof(g_aFunctions) / sizeof(g_aFunctions[0]);
843	pReq->Hdr.rc = VINF_SUCCESS;
844	return 0;
845	}
846
847	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_QUERY_FUNCS(0)):
848	{
849	/* validate */
850	PSUPQUERYFUNCS pReq = (PSUPQUERYFUNCS)pReqHdr;
851	REQ_CHECK_SIZES_EX(SUP_IOCTL_QUERY_FUNCS, SUP_IOCTL_QUERY_FUNCS_SIZE_IN, SUP_IOCTL_QUERY_FUNCS_SIZE_OUT(RT_ELEMENTS(g_aFunctions)));
852
853	/* execute */
854	pReq->u.Out.cFunctions = RT_ELEMENTS(g_aFunctions);
855	memcpy(&pReq->u.Out.aFunctions[0], g_aFunctions, sizeof(g_aFunctions));
856	pReq->Hdr.rc = VINF_SUCCESS;
857	return 0;
858	}
859
860	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_IDT_INSTALL):
861	{
862	/* validate */
863	PSUPIDTINSTALL pReq = (PSUPIDTINSTALL)pReqHdr;
864	REQ_CHECK_SIZES(SUP_IOCTL_IDT_INSTALL);
865
866	/* execute */
867	#ifdef VBOX_WITH_IDT_PATCHING
868	pReq->Hdr.rc = supdrvIOCtl_IdtInstall(pDevExt, pSession, pReq);
869	#else
870	pReq->u.Out.u8Idt = 3;
871	pReq->Hdr.rc = VERR_NOT_SUPPORTED;
872	#endif
873	return 0;
874	}
875
876	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_IDT_REMOVE):
877	{
878	/* validate */
879	PSUPIDTREMOVE pReq = (PSUPIDTREMOVE)pReqHdr;
880	REQ_CHECK_SIZES(SUP_IOCTL_IDT_REMOVE);
881
882	/* execute */
883	#ifdef VBOX_WITH_IDT_PATCHING
884	pReq->Hdr.rc = supdrvIOCtl_IdtRemoveAll(pDevExt, pSession);
885	#else
886	pReq->Hdr.rc = VERR_NOT_SUPPORTED;
887	#endif
888	return 0;
889	}
890
891	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_PAGE_LOCK):
892	{
893	/* validate */
894	PSUPPAGELOCK pReq = (PSUPPAGELOCK)pReqHdr;
895	REQ_CHECK_SIZE_IN(SUP_IOCTL_PAGE_LOCK, SUP_IOCTL_PAGE_LOCK_SIZE_IN);
896	REQ_CHECK_SIZE_OUT(SUP_IOCTL_PAGE_LOCK, SUP_IOCTL_PAGE_LOCK_SIZE_OUT(pReq->u.In.cPages));
897	REQ_CHECK_EXPR(SUP_IOCTL_PAGE_LOCK, pReq->u.In.cPages > 0);
898	REQ_CHECK_EXPR(SUP_IOCTL_PAGE_LOCK, pReq->u.In.pvR3 >= PAGE_SIZE);
899
900	/* execute */
901	pReq->Hdr.rc = SUPR0LockMem(pSession, pReq->u.In.pvR3, pReq->u.In.cPages, &pReq->u.Out.aPages[0]);
902	if (RT_FAILURE(pReq->Hdr.rc))
903	pReq->Hdr.cbOut = sizeof(pReq->Hdr);
904	return 0;
905	}
906
907	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_PAGE_UNLOCK):
908	{
909	/* validate */
910	PSUPPAGEUNLOCK pReq = (PSUPPAGEUNLOCK)pReqHdr;
911	REQ_CHECK_SIZES(SUP_IOCTL_PAGE_UNLOCK);
912
913	/* execute */
914	pReq->Hdr.rc = SUPR0UnlockMem(pSession, pReq->u.In.pvR3);
915	return 0;
916	}
917
918	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_CONT_ALLOC):
919	{
920	/* validate */
921	PSUPCONTALLOC pReq = (PSUPCONTALLOC)pReqHdr;
922	REQ_CHECK_SIZES(SUP_IOCTL_CONT_ALLOC);
923
924	/* execute */
925	pReq->Hdr.rc = SUPR0ContAlloc(pSession, pReq->u.In.cPages, &pReq->u.Out.pvR0, &pReq->u.Out.pvR3, &pReq->u.Out.HCPhys);
926	if (RT_FAILURE(pReq->Hdr.rc))
927	pReq->Hdr.cbOut = sizeof(pReq->Hdr);
928	return 0;
929	}
930
931	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_CONT_FREE):
932	{
933	/* validate */
934	PSUPCONTFREE pReq = (PSUPCONTFREE)pReqHdr;
935	REQ_CHECK_SIZES(SUP_IOCTL_CONT_FREE);
936
937	/* execute */
938	pReq->Hdr.rc = SUPR0ContFree(pSession, (RTHCUINTPTR)pReq->u.In.pvR3);
939	return 0;
940	}
941
942	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LDR_OPEN):
943	{
944	/* validate */
945	PSUPLDROPEN pReq = (PSUPLDROPEN)pReqHdr;
946	REQ_CHECK_SIZES(SUP_IOCTL_LDR_OPEN);
947	REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, pReq->u.In.cbImage > 0);
948	REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, pReq->u.In.cbImage < _1M*16);
949	REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, pReq->u.In.szName[0]);
950	REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, memchr(pReq->u.In.szName, '\0', sizeof(pReq->u.In.szName)));
951	REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, !supdrvCheckInvalidChar(pReq->u.In.szName, ";:()[]{}/\\\|&*%#@!~`\"'"));
952
953	/* execute */
954	pReq->Hdr.rc = supdrvIOCtl_LdrOpen(pDevExt, pSession, pReq);
955	return 0;
956	}
957
958	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LDR_LOAD):
959	{
960	/* validate */
961	PSUPLDRLOAD pReq = (PSUPLDRLOAD)pReqHdr;
962	REQ_CHECK_EXPR(Name, pReq->Hdr.cbIn >= sizeof(*pReq));
963	REQ_CHECK_SIZES_EX(SUP_IOCTL_LDR_LOAD, SUP_IOCTL_LDR_LOAD_SIZE_IN(pReq->u.In.cbImage), SUP_IOCTL_LDR_LOAD_SIZE_OUT);
964	REQ_CHECK_EXPR(SUP_IOCTL_LDR_LOAD, pReq->u.In.cSymbols <= 16384);
965	REQ_CHECK_EXPR_FMT( !pReq->u.In.cSymbols
966	\|\| ( pReq->u.In.offSymbols < pReq->u.In.cbImage
967	&& pReq->u.In.offSymbols + pReq->u.In.cSymbols * sizeof(SUPLDRSYM) <= pReq->u.In.cbImage),
968	("SUP_IOCTL_LDR_LOAD: offSymbols=%#lx cSymbols=%#lx cbImage=%#lx\n", (long)pReq->u.In.offSymbols,
969	(long)pReq->u.In.cSymbols, (long)pReq->u.In.cbImage));
970	REQ_CHECK_EXPR_FMT( !pReq->u.In.cbStrTab
971	\|\| ( pReq->u.In.offStrTab < pReq->u.In.cbImage
972	&& pReq->u.In.offStrTab + pReq->u.In.cbStrTab <= pReq->u.In.cbImage
973	&& pReq->u.In.cbStrTab <= pReq->u.In.cbImage),
974	("SUP_IOCTL_LDR_LOAD: offStrTab=%#lx cbStrTab=%#lx cbImage=%#lx\n", (long)pReq->u.In.offStrTab,
975	(long)pReq->u.In.cbStrTab, (long)pReq->u.In.cbImage));
976
977	if (pReq->u.In.cSymbols)
978	{
979	uint32_t i;
980	PSUPLDRSYM paSyms = (PSUPLDRSYM)&pReq->u.In.achImage[pReq->u.In.offSymbols];
981	for (i = 0; i < pReq->u.In.cSymbols; i++)
982	{
983	REQ_CHECK_EXPR_FMT(paSyms[i].offSymbol < pReq->u.In.cbImage,
984	("SUP_IOCTL_LDR_LOAD: sym #%ld: symb off %#lx (max=%#lx)\n", (long)i, (long)paSyms[i].offSymbol, (long)pReq->u.In.cbImage));
985	REQ_CHECK_EXPR_FMT(paSyms[i].offName < pReq->u.In.cbStrTab,
986	("SUP_IOCTL_LDR_LOAD: sym #%ld: name off %#lx (max=%#lx)\n", (long)i, (long)paSyms[i].offName, (long)pReq->u.In.cbImage));
987	REQ_CHECK_EXPR_FMT(memchr(&pReq->u.In.achImage[pReq->u.In.offStrTab + paSyms[i].offName], '\0', pReq->u.In.cbStrTab - paSyms[i].offName),
988	("SUP_IOCTL_LDR_LOAD: sym #%ld: unterminated name! (%#lx / %#lx)\n", (long)i, (long)paSyms[i].offName, (long)pReq->u.In.cbImage));
989	}
990	}
991
992	/* execute */
993	pReq->Hdr.rc = supdrvIOCtl_LdrLoad(pDevExt, pSession, pReq);
994	return 0;
995	}
996
997	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LDR_FREE):
998	{
999	/* validate */
1000	PSUPLDRFREE pReq = (PSUPLDRFREE)pReqHdr;
1001	REQ_CHECK_SIZES(SUP_IOCTL_LDR_FREE);
1002
1003	/* execute */
1004	pReq->Hdr.rc = supdrvIOCtl_LdrFree(pDevExt, pSession, pReq);
1005	return 0;
1006	}
1007
1008	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LDR_GET_SYMBOL):
1009	{
1010	/* validate */
1011	PSUPLDRGETSYMBOL pReq = (PSUPLDRGETSYMBOL)pReqHdr;
1012	REQ_CHECK_SIZES(SUP_IOCTL_LDR_GET_SYMBOL);
1013	REQ_CHECK_EXPR(SUP_IOCTL_LDR_GET_SYMBOL, memchr(pReq->u.In.szSymbol, '\0', sizeof(pReq->u.In.szSymbol)));
1014
1015	/* execute */
1016	pReq->Hdr.rc = supdrvIOCtl_LdrGetSymbol(pDevExt, pSession, pReq);
1017	return 0;
1018	}
1019
1020	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_CALL_VMMR0(0)):
1021	{
1022	/* validate */
1023	PSUPCALLVMMR0 pReq = (PSUPCALLVMMR0)pReqHdr;
1024	Log4(("SUP_IOCTL_CALL_VMMR0: op=%u in=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
1025	pReq->u.In.uOperation, pReq->Hdr.cbIn, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
1026
1027	if (pReq->Hdr.cbIn == SUP_IOCTL_CALL_VMMR0_SIZE(0))
1028	{
1029	REQ_CHECK_SIZES_EX(SUP_IOCTL_CALL_VMMR0, SUP_IOCTL_CALL_VMMR0_SIZE_IN(0), SUP_IOCTL_CALL_VMMR0_SIZE_OUT(0));
1030
1031	/* execute */
1032	if (RT_LIKELY(pDevExt->pfnVMMR0EntryEx))
1033	pReq->Hdr.rc = pDevExt->pfnVMMR0EntryEx(pReq->u.In.pVMR0, pReq->u.In.uOperation, NULL, pReq->u.In.u64Arg);
1034	else
1035	pReq->Hdr.rc = VERR_WRONG_ORDER;
1036	}
1037	else
1038	{
1039	PSUPVMMR0REQHDR pVMMReq = (PSUPVMMR0REQHDR)&pReq->abReqPkt[0];
1040	REQ_CHECK_EXPR_FMT(pReq->Hdr.cbIn >= SUP_IOCTL_CALL_VMMR0_SIZE(sizeof(SUPVMMR0REQHDR)),
1041	("SUP_IOCTL_CALL_VMMR0: cbIn=%#x < %#x\n", pReq->Hdr.cbIn, SUP_IOCTL_CALL_VMMR0_SIZE(sizeof(SUPVMMR0REQHDR))));
1042	REQ_CHECK_EXPR(SUP_IOCTL_CALL_VMMR0, pVMMReq->u32Magic == SUPVMMR0REQHDR_MAGIC);
1043	REQ_CHECK_SIZES_EX(SUP_IOCTL_CALL_VMMR0, SUP_IOCTL_CALL_VMMR0_SIZE_IN(pVMMReq->cbReq), SUP_IOCTL_CALL_VMMR0_SIZE_OUT(pVMMReq->cbReq));
1044
1045	/* execute */
1046	if (RT_LIKELY(pDevExt->pfnVMMR0EntryEx))
1047	pReq->Hdr.rc = pDevExt->pfnVMMR0EntryEx(pReq->u.In.pVMR0, pReq->u.In.uOperation, pVMMReq, pReq->u.In.u64Arg);
1048	else
1049	pReq->Hdr.rc = VERR_WRONG_ORDER;
1050	}
1051
1052	if ( RT_FAILURE(pReq->Hdr.rc)
1053	&& pReq->Hdr.rc != VERR_INTERRUPTED
1054	&& pReq->Hdr.rc != VERR_TIMEOUT)
1055	Log(("SUP_IOCTL_CALL_VMMR0: rc=%Rrc op=%u out=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
1056	pReq->Hdr.rc, pReq->u.In.uOperation, pReq->Hdr.cbOut, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
1057	else
1058	Log4(("SUP_IOCTL_CALL_VMMR0: rc=%Rrc op=%u out=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
1059	pReq->Hdr.rc, pReq->u.In.uOperation, pReq->Hdr.cbOut, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
1060	return 0;
1061	}
1062
1063	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_GET_PAGING_MODE):
1064	{
1065	/* validate */
1066	PSUPGETPAGINGMODE pReq = (PSUPGETPAGINGMODE)pReqHdr;
1067	REQ_CHECK_SIZES(SUP_IOCTL_GET_PAGING_MODE);
1068
1069	/* execute */
1070	pReq->Hdr.rc = VINF_SUCCESS;
1071	pReq->u.Out.enmMode = supdrvIOCtl_GetPagingMode();
1072	return 0;
1073	}
1074
1075	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LOW_ALLOC):
1076	{
1077	/* validate */
1078	PSUPLOWALLOC pReq = (PSUPLOWALLOC)pReqHdr;
1079	REQ_CHECK_EXPR(SUP_IOCTL_LOW_ALLOC, pReq->Hdr.cbIn <= SUP_IOCTL_LOW_ALLOC_SIZE_IN);
1080	REQ_CHECK_SIZES_EX(SUP_IOCTL_LOW_ALLOC, SUP_IOCTL_LOW_ALLOC_SIZE_IN, SUP_IOCTL_LOW_ALLOC_SIZE_OUT(pReq->u.In.cPages));
1081
1082	/* execute */
1083	pReq->Hdr.rc = SUPR0LowAlloc(pSession, pReq->u.In.cPages, &pReq->u.Out.pvR0, &pReq->u.Out.pvR3, &pReq->u.Out.aPages[0]);
1084	if (RT_FAILURE(pReq->Hdr.rc))
1085	pReq->Hdr.cbOut = sizeof(pReq->Hdr);
1086	return 0;
1087	}
1088
1089	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LOW_FREE):
1090	{
1091	/* validate */
1092	PSUPLOWFREE pReq = (PSUPLOWFREE)pReqHdr;
1093	REQ_CHECK_SIZES(SUP_IOCTL_LOW_FREE);
1094
1095	/* execute */
1096	pReq->Hdr.rc = SUPR0LowFree(pSession, (RTHCUINTPTR)pReq->u.In.pvR3);
1097	return 0;
1098	}
1099
1100	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_GIP_MAP):
1101	{
1102	/* validate */
1103	PSUPGIPMAP pReq = (PSUPGIPMAP)pReqHdr;
1104	REQ_CHECK_SIZES(SUP_IOCTL_GIP_MAP);
1105
1106	/* execute */
1107	pReq->Hdr.rc = SUPR0GipMap(pSession, &pReq->u.Out.pGipR3, &pReq->u.Out.HCPhysGip);
1108	if (RT_SUCCESS(pReq->Hdr.rc))
1109	pReq->u.Out.pGipR0 = pDevExt->pGip;
1110	return 0;
1111	}
1112
1113	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_GIP_UNMAP):
1114	{
1115	/* validate */
1116	PSUPGIPUNMAP pReq = (PSUPGIPUNMAP)pReqHdr;
1117	REQ_CHECK_SIZES(SUP_IOCTL_GIP_UNMAP);
1118
1119	/* execute */
1120	pReq->Hdr.rc = SUPR0GipUnmap(pSession);
1121	return 0;
1122	}
1123
1124	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_SET_VM_FOR_FAST):
1125	{
1126	/* validate */
1127	PSUPSETVMFORFAST pReq = (PSUPSETVMFORFAST)pReqHdr;
1128	REQ_CHECK_SIZES(SUP_IOCTL_SET_VM_FOR_FAST);
1129	REQ_CHECK_EXPR_FMT( !pReq->u.In.pVMR0
1130	\|\| ( VALID_PTR(pReq->u.In.pVMR0)
1131	&& !((uintptr_t)pReq->u.In.pVMR0 & (PAGE_SIZE - 1))),
1132	("SUP_IOCTL_SET_VM_FOR_FAST: pVMR0=%p!\n", pReq->u.In.pVMR0));
1133	/* execute */
1134	pSession->pVM = pReq->u.In.pVMR0;
1135	pReq->Hdr.rc = VINF_SUCCESS;
1136	return 0;
1137	}
1138
1139	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_PAGE_ALLOC):
1140	{
1141	/* validate */
1142	PSUPPAGEALLOC pReq = (PSUPPAGEALLOC)pReqHdr;
1143	REQ_CHECK_EXPR(SUP_IOCTL_PAGE_ALLOC, pReq->Hdr.cbIn <= SUP_IOCTL_PAGE_ALLOC_SIZE_IN);
1144	REQ_CHECK_SIZES_EX(SUP_IOCTL_PAGE_ALLOC, SUP_IOCTL_PAGE_ALLOC_SIZE_IN, SUP_IOCTL_PAGE_ALLOC_SIZE_OUT(pReq->u.In.cPages));
1145
1146	/* execute */
1147	pReq->Hdr.rc = SUPR0PageAlloc(pSession, pReq->u.In.cPages, &pReq->u.Out.pvR3, &pReq->u.Out.aPages[0]);
1148	if (RT_FAILURE(pReq->Hdr.rc))
1149	pReq->Hdr.cbOut = sizeof(pReq->Hdr);
1150	return 0;
1151	}
1152
1153	case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_PAGE_FREE):
1154	{
1155	/* validate */
1156	PSUPPAGEFREE pReq = (PSUPPAGEFREE)pReqHdr;
1157	REQ_CHECK_SIZES(SUP_IOCTL_PAGE_FREE);
1158
1159	/* execute */
1160	pReq->Hdr.rc = SUPR0PageFree(pSession, pReq->u.In.pvR3);
1161	return 0;
1162	}
1163
1164	default:
1165	Log(("Unknown IOCTL %#lx\n", (long)uIOCtl));
1166	break;
1167	}
1168	return SUPDRV_ERR_GENERAL_FAILURE;
1169	}
1170
1171
1172	/**
1173	* Register a object for reference counting.
1174	* The object is registered with one reference in the specified session.
1175	*
1176	* @returns Unique identifier on success (pointer).
1177	* All future reference must use this identifier.
1178	* @returns NULL on failure.
1179	* @param pfnDestructor The destructore function which will be called when the reference count reaches 0.
1180	* @param pvUser1 The first user argument.
1181	* @param pvUser2 The second user argument.
1182	*/
1183	SUPR0DECL(void ) SUPR0ObjRegister(PSUPDRVSESSION pSession, SUPDRVOBJTYPE enmType, PFNSUPDRVDESTRUCTOR pfnDestructor, void pvUser1, void *pvUser2)
1184	{
1185	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
1186	PSUPDRVDEVEXT pDevExt = pSession->pDevExt;
1187	PSUPDRVOBJ pObj;
1188	PSUPDRVUSAGE pUsage;
1189
1190	/*
1191	* Validate the input.
1192	*/
1193	AssertReturn(SUP_IS_SESSION_VALID(pSession), NULL);
1194	AssertReturn(enmType > SUPDRVOBJTYPE_INVALID && enmType < SUPDRVOBJTYPE_END, NULL);
1195	AssertPtrReturn(pfnDestructor, NULL);
1196
1197	/*
1198	* Allocate and initialize the object.
1199	*/
1200	pObj = (PSUPDRVOBJ)RTMemAlloc(sizeof(*pObj));
1201	if (!pObj)
1202	return NULL;
1203	pObj->u32Magic = SUPDRVOBJ_MAGIC;
1204	pObj->enmType = enmType;
1205	pObj->pNext = NULL;
1206	pObj->cUsage = 1;
1207	pObj->pfnDestructor = pfnDestructor;
1208	pObj->pvUser1 = pvUser1;
1209	pObj->pvUser2 = pvUser2;
1210	pObj->CreatorUid = pSession->Uid;
1211	pObj->CreatorGid = pSession->Gid;
1212	pObj->CreatorProcess= pSession->Process;
1213	supdrvOSObjInitCreator(pObj, pSession);
1214
1215	/*
1216	* Allocate the usage record.
1217	* (We keep freed usage records around to simplity SUPR0ObjAddRef().)
1218	*/
1219	RTSpinlockAcquire(pDevExt->Spinlock, &SpinlockTmp);
1220
1221	pUsage = pDevExt->pUsageFree;
1222	if (pUsage)
1223	pDevExt->pUsageFree = pUsage->pNext;
1224	else
1225	{
1226	RTSpinlockRelease(pDevExt->Spinlock, &SpinlockTmp);
1227	pUsage = (PSUPDRVUSAGE)RTMemAlloc(sizeof(*pUsage));
1228	if (!pUsage)
1229	{
1230	RTMemFree(pObj);
1231	return NULL;
1232	}
1233	RTSpinlockAcquire(pDevExt->Spinlock, &SpinlockTmp);
1234	}
1235
1236	/*
1237	* Insert the object and create the session usage record.
1238	*/
1239	/* The object. */
1240	pObj->pNext = pDevExt->pObjs;
1241	pDevExt->pObjs = pObj;
1242
1243	/* The session record. */
1244	pUsage->cUsage = 1;
1245	pUsage->pObj = pObj;
1246	pUsage->pNext = pSession->pUsage;
1247	Log2(("SUPR0ObjRegister: pUsage=%p:{.pObj=%p, .pNext=%p}\n", pUsage, pUsage->pObj, pUsage->pNext));
1248	pSession->pUsage = pUsage;
1249
1250	RTSpinlockRelease(pDevExt->Spinlock, &SpinlockTmp);
1251
1252	Log(("SUPR0ObjRegister: returns %p (pvUser1=%p, pvUser=%p)\n", pObj, pvUser1, pvUser2));
1253	return pObj;
1254	}
1255
1256
1257	/**
1258	* Increment the reference counter for the object associating the reference
1259	* with the specified session.
1260	*
1261	* @returns IPRT status code.
1262	* @param pvObj The identifier returned by SUPR0ObjRegister().
1263	* @param pSession The session which is referencing the object.
1264	*/
1265	SUPR0DECL(int) SUPR0ObjAddRef(void *pvObj, PSUPDRVSESSION pSession)
1266	{
1267	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
1268	PSUPDRVDEVEXT pDevExt = pSession->pDevExt;
1269	PSUPDRVOBJ pObj = (PSUPDRVOBJ)pvObj;
1270	PSUPDRVUSAGE pUsagePre;
1271	PSUPDRVUSAGE pUsage;
1272
1273	/*
1274	* Validate the input.
1275	*/
1276	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1277	AssertMsgReturn(VALID_PTR(pObj) && pObj->u32Magic == SUPDRVOBJ_MAGIC,
1278	("Invalid pvObj=%p magic=%#x (exepcted %#x)\n", pvObj, pObj ? pObj->u32Magic : 0, SUPDRVOBJ_MAGIC),
1279	VERR_INVALID_PARAMETER);
1280
1281	/*
1282	* Preallocate the usage record.
1283	*/
1284	RTSpinlockAcquire(pDevExt->Spinlock, &SpinlockTmp);
1285
1286	pUsagePre = pDevExt->pUsageFree;
1287	if (pUsagePre)
1288	pDevExt->pUsageFree = pUsagePre->pNext;
1289	else
1290	{
1291	RTSpinlockRelease(pDevExt->Spinlock, &SpinlockTmp);
1292	pUsagePre = (PSUPDRVUSAGE)RTMemAlloc(sizeof(*pUsagePre));
1293	if (!pUsagePre)
1294	return VERR_NO_MEMORY;
1295	RTSpinlockAcquire(pDevExt->Spinlock, &SpinlockTmp);
1296	}
1297
1298	/*
1299	* Reference the object.
1300	*/
1301	pObj->cUsage++;
1302
1303	/*
1304	* Look for the session record.
1305	*/
1306	for (pUsage = pSession->pUsage; pUsage; pUsage = pUsage->pNext)
1307	{
1308	Log(("SUPR0AddRef: pUsage=%p:{.pObj=%p, .pNext=%p}\n", pUsage, pUsage->pObj, pUsage->pNext));
1309	if (pUsage->pObj == pObj)
1310	break;
1311	}
1312	if (pUsage)
1313	pUsage->cUsage++;
1314	else
1315	{
1316	/* create a new session record. */
1317	pUsagePre->cUsage = 1;
1318	pUsagePre->pObj = pObj;
1319	pUsagePre->pNext = pSession->pUsage;
1320	pSession->pUsage = pUsagePre;
1321	Log(("SUPR0AddRef: pUsagePre=%p:{.pObj=%p, .pNext=%p}\n", pUsagePre, pUsagePre->pObj, pUsagePre->pNext));
1322
1323	pUsagePre = NULL;
1324	}
1325
1326	/*
1327	* Put any unused usage record into the free list..
1328	*/
1329	if (pUsagePre)
1330	{
1331	pUsagePre->pNext = pDevExt->pUsageFree;
1332	pDevExt->pUsageFree = pUsagePre;
1333	}
1334
1335	RTSpinlockRelease(pDevExt->Spinlock, &SpinlockTmp);
1336
1337	return VINF_SUCCESS;
1338	}
1339
1340
1341	/**
1342	* Decrement / destroy a reference counter record for an object.
1343	*
1344	* The object is uniquely identified by pfnDestructor+pvUser1+pvUser2.
1345	*
1346	* @returns IPRT status code.
1347	* @param pvObj The identifier returned by SUPR0ObjRegister().
1348	* @param pSession The session which is referencing the object.
1349	*/
1350	SUPR0DECL(int) SUPR0ObjRelease(void *pvObj, PSUPDRVSESSION pSession)
1351	{
1352	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
1353	PSUPDRVDEVEXT pDevExt = pSession->pDevExt;
1354	PSUPDRVOBJ pObj = (PSUPDRVOBJ)pvObj;
1355	bool fDestroy = false;
1356	PSUPDRVUSAGE pUsage;
1357	PSUPDRVUSAGE pUsagePrev;
1358
1359	/*
1360	* Validate the input.
1361	*/
1362	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1363	AssertMsgReturn(VALID_PTR(pObj) && pObj->u32Magic == SUPDRVOBJ_MAGIC,
1364	("Invalid pvObj=%p magic=%#x (exepcted %#x)\n", pvObj, pObj ? pObj->u32Magic : 0, SUPDRVOBJ_MAGIC),
1365	VERR_INVALID_PARAMETER);
1366
1367	/*
1368	* Acquire the spinlock and look for the usage record.
1369	*/
1370	RTSpinlockAcquire(pDevExt->Spinlock, &SpinlockTmp);
1371
1372	for (pUsagePrev = NULL, pUsage = pSession->pUsage;
1373	pUsage;
1374	pUsagePrev = pUsage, pUsage = pUsage->pNext)
1375	{
1376	Log2(("SUPR0ObjRelease: pUsage=%p:{.pObj=%p, .pNext=%p}\n", pUsage, pUsage->pObj, pUsage->pNext));
1377	if (pUsage->pObj == pObj)
1378	{
1379	AssertMsg(pUsage->cUsage >= 1 && pObj->cUsage >= pUsage->cUsage, ("glob %d; sess %d\n", pObj->cUsage, pUsage->cUsage));
1380	if (pUsage->cUsage > 1)
1381	{
1382	pObj->cUsage--;
1383	pUsage->cUsage--;
1384	}
1385	else
1386	{
1387	/*
1388	* Free the session record.
1389	*/
1390	if (pUsagePrev)
1391	pUsagePrev->pNext = pUsage->pNext;
1392	else
1393	pSession->pUsage = pUsage->pNext;
1394	pUsage->pNext = pDevExt->pUsageFree;
1395	pDevExt->pUsageFree = pUsage;
1396
1397	/* What about the object? */
1398	if (pObj->cUsage > 1)
1399	pObj->cUsage--;
1400	else
1401	{
1402	/*
1403	* Object is to be destroyed, unlink it.
1404	*/
1405	pObj->u32Magic = SUPDRVOBJ_MAGIC + 1;
1406	fDestroy = true;
1407	if (pDevExt->pObjs == pObj)
1408	pDevExt->pObjs = pObj->pNext;
1409	else
1410	{
1411	PSUPDRVOBJ pObjPrev;
1412	for (pObjPrev = pDevExt->pObjs; pObjPrev; pObjPrev = pObjPrev->pNext)
1413	if (pObjPrev->pNext == pObj)
1414	{
1415	pObjPrev->pNext = pObj->pNext;
1416	break;
1417	}
1418	Assert(pObjPrev);
1419	}
1420	}
1421	}
1422	break;
1423	}
1424	}
1425
1426	RTSpinlockRelease(pDevExt->Spinlock, &SpinlockTmp);
1427
1428	/*
1429	* Call the destructor and free the object if required.
1430	*/
1431	if (fDestroy)
1432	{
1433	Log(("SUPR0ObjRelease: destroying %p/%d (%p/%p) cpid=%RTproc pid=%RTproc dtor=%p\n",
1434	pObj, pObj->enmType, pObj->pvUser1, pObj->pvUser2, pObj->CreatorProcess, RTProcSelf(), pObj->pfnDestructor));
1435	if (pObj->pfnDestructor)
1436	pObj->pfnDestructor(pObj, pObj->pvUser1, pObj->pvUser2);
1437	RTMemFree(pObj);
1438	}
1439
1440	AssertMsg(pUsage, ("pvObj=%p\n", pvObj));
1441	return pUsage ? VINF_SUCCESS : VERR_INVALID_PARAMETER;
1442	}
1443
1444	/**
1445	* Verifies that the current process can access the specified object.
1446	*
1447	* @returns The following IPRT status code:
1448	* @retval VINF_SUCCESS if access was granted.
1449	* @retval VERR_PERMISSION_DENIED if denied access.
1450	* @retval VERR_INVALID_PARAMETER if invalid parameter.
1451	*
1452	* @param pvObj The identifier returned by SUPR0ObjRegister().
1453	* @param pSession The session which wishes to access the object.
1454	* @param pszObjName Object string name. This is optional and depends on the object type.
1455	*
1456	* @remark The caller is responsible for making sure the object isn't removed while
1457	* we're inside this function. If uncertain about this, just call AddRef before calling us.
1458	*/
1459	SUPR0DECL(int) SUPR0ObjVerifyAccess(void pvObj, PSUPDRVSESSION pSession, const char pszObjName)
1460	{
1461	PSUPDRVOBJ pObj = (PSUPDRVOBJ)pvObj;
1462	int rc;
1463
1464	/*
1465	* Validate the input.
1466	*/
1467	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1468	AssertMsgReturn(VALID_PTR(pObj) && pObj->u32Magic == SUPDRVOBJ_MAGIC,
1469	("Invalid pvObj=%p magic=%#x (exepcted %#x)\n", pvObj, pObj ? pObj->u32Magic : 0, SUPDRVOBJ_MAGIC),
1470	VERR_INVALID_PARAMETER);
1471
1472	/*
1473	* Check access. (returns true if a decision has been made.)
1474	*/
1475	rc = VERR_INTERNAL_ERROR;
1476	if (supdrvOSObjCanAccess(pObj, pSession, pszObjName, &rc))
1477	return rc;
1478
1479	/*
1480	* Default policy is to allow the user to access his own
1481	* stuff but nothing else.
1482	*/
1483	if (pObj->CreatorUid == pSession->Uid)
1484	return VINF_SUCCESS;
1485	return VERR_PERMISSION_DENIED;
1486	}
1487
1488
1489	/**
1490	* Lock pages.
1491	*
1492	* @returns IPRT status code.
1493	* @param pSession Session to which the locked memory should be associated.
1494	* @param pvR3 Start of the memory range to lock.
1495	* This must be page aligned.
1496	* @param cb Size of the memory range to lock.
1497	* This must be page aligned.
1498	*/
1499	SUPR0DECL(int) SUPR0LockMem(PSUPDRVSESSION pSession, RTR3PTR pvR3, uint32_t cPages, PRTHCPHYS paPages)
1500	{
1501	int rc;
1502	SUPDRVMEMREF Mem = {0};
1503	const size_t cb = (size_t)cPages << PAGE_SHIFT;
1504	LogFlow(("SUPR0LockMem: pSession=%p pvR3=%p cPages=%d paPages=%p\n", pSession, (void *)pvR3, cPages, paPages));
1505
1506	/*
1507	* Verify input.
1508	*/
1509	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1510	AssertPtrReturn(paPages, VERR_INVALID_PARAMETER);
1511	if ( RT_ALIGN_R3PT(pvR3, PAGE_SIZE, RTR3PTR) != pvR3
1512	\|\| !pvR3)
1513	{
1514	Log(("pvR3 (%p) must be page aligned and not NULL!\n", (void *)pvR3));
1515	return VERR_INVALID_PARAMETER;
1516	}
1517
1518	#ifdef RT_OS_WINDOWS /* A temporary hack for windows, will be removed once all ring-3 code has been cleaned up. */
1519	/* First check if we allocated it using SUPPageAlloc; if so then we don't need to lock it again */
1520	rc = supdrvPageGetPhys(pSession, pvR3, cPages, paPages);
1521	if (RT_SUCCESS(rc))
1522	return rc;
1523	#endif
1524
1525	/*
1526	* Let IPRT do the job.
1527	*/
1528	Mem.eType = MEMREF_TYPE_LOCKED;
1529	rc = RTR0MemObjLockUser(&Mem.MemObj, pvR3, cb, RTR0ProcHandleSelf());
1530	if (RT_SUCCESS(rc))
1531	{
1532	uint32_t iPage = cPages;
1533	AssertMsg(RTR0MemObjAddressR3(Mem.MemObj) == pvR3, ("%p == %p\n", RTR0MemObjAddressR3(Mem.MemObj), pvR3));
1534	AssertMsg(RTR0MemObjSize(Mem.MemObj) == cb, ("%x == %x\n", RTR0MemObjSize(Mem.MemObj), cb));
1535
1536	while (iPage-- > 0)
1537	{
1538	paPages[iPage] = RTR0MemObjGetPagePhysAddr(Mem.MemObj, iPage);
1539	if (RT_UNLIKELY(paPages[iPage] == NIL_RTCCPHYS))
1540	{
1541	AssertMsgFailed(("iPage=%d\n", iPage));
1542	rc = VERR_INTERNAL_ERROR;
1543	break;
1544	}
1545	}
1546	if (RT_SUCCESS(rc))
1547	rc = supdrvMemAdd(&Mem, pSession);
1548	if (RT_FAILURE(rc))
1549	{
1550	int rc2 = RTR0MemObjFree(Mem.MemObj, false);
1551	AssertRC(rc2);
1552	}
1553	}
1554
1555	return rc;
1556	}
1557
1558
1559	/**
1560	* Unlocks the memory pointed to by pv.
1561	*
1562	* @returns IPRT status code.
1563	* @param pSession Session to which the memory was locked.
1564	* @param pvR3 Memory to unlock.
1565	*/
1566	SUPR0DECL(int) SUPR0UnlockMem(PSUPDRVSESSION pSession, RTR3PTR pvR3)
1567	{
1568	LogFlow(("SUPR0UnlockMem: pSession=%p pvR3=%p\n", pSession, (void *)pvR3));
1569	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1570	#ifdef RT_OS_WINDOWS
1571	/*
1572	* Temporary hack for windows - SUPR0PageFree will unlock SUPR0PageAlloc
1573	* allocations; ignore this call.
1574	*/
1575	if (supdrvPageWasLockedByPageAlloc(pSession, pvR3))
1576	{
1577	LogFlow(("Page will be unlocked in SUPR0PageFree -> ignore\n"));
1578	return VINF_SUCCESS;
1579	}
1580	#endif
1581	return supdrvMemRelease(pSession, (RTHCUINTPTR)pvR3, MEMREF_TYPE_LOCKED);
1582	}
1583
1584
1585	/**
1586	* Allocates a chunk of page aligned memory with contiguous and fixed physical
1587	* backing.
1588	*
1589	* @returns IPRT status code.
1590	* @param pSession Session data.
1591	* @param cb Number of bytes to allocate.
1592	* @param ppvR0 Where to put the address of Ring-0 mapping the allocated memory.
1593	* @param ppvR3 Where to put the address of Ring-3 mapping the allocated memory.
1594	* @param pHCPhys Where to put the physical address of allocated memory.
1595	*/
1596	SUPR0DECL(int) SUPR0ContAlloc(PSUPDRVSESSION pSession, uint32_t cPages, PRTR0PTR ppvR0, PRTR3PTR ppvR3, PRTHCPHYS pHCPhys)
1597	{
1598	int rc;
1599	SUPDRVMEMREF Mem = {0};
1600	LogFlow(("SUPR0ContAlloc: pSession=%p cPages=%d ppvR0=%p ppvR3=%p pHCPhys=%p\n", pSession, cPages, ppvR0, ppvR3, pHCPhys));
1601
1602	/*
1603	* Validate input.
1604	*/
1605	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1606	if (!ppvR3 \|\| !ppvR0 \|\| !pHCPhys)
1607	{
1608	Log(("Null pointer. All of these should be set: pSession=%p ppvR0=%p ppvR3=%p pHCPhys=%p\n",
1609	pSession, ppvR0, ppvR3, pHCPhys));
1610	return VERR_INVALID_PARAMETER;
1611
1612	}
1613	if (cPages < 1 \|\| cPages >= 256)
1614	{
1615	Log(("Illegal request cPages=%d, must be greater than 0 and smaller than 256\n", cPages));
1616	return VERR_INVALID_PARAMETER;
1617	}
1618
1619	/*
1620	* Let IPRT do the job.
1621	*/
1622	rc = RTR0MemObjAllocCont(&Mem.MemObj, cPages << PAGE_SHIFT, true /* executable R0 mapping */);
1623	if (RT_SUCCESS(rc))
1624	{
1625	int rc2;
1626	rc = RTR0MemObjMapUser(&Mem.MapObjR3, Mem.MemObj, (RTR3PTR)-1, 0,
1627	RTMEM_PROT_EXEC \| RTMEM_PROT_WRITE \| RTMEM_PROT_READ, RTR0ProcHandleSelf());
1628	if (RT_SUCCESS(rc))
1629	{
1630	Mem.eType = MEMREF_TYPE_CONT;
1631	rc = supdrvMemAdd(&Mem, pSession);
1632	if (!rc)
1633	{
1634	*ppvR0 = RTR0MemObjAddress(Mem.MemObj);
1635	*ppvR3 = RTR0MemObjAddressR3(Mem.MapObjR3);
1636	*pHCPhys = RTR0MemObjGetPagePhysAddr(Mem.MemObj, 0);
1637	return 0;
1638	}
1639
1640	rc2 = RTR0MemObjFree(Mem.MapObjR3, false);
1641	AssertRC(rc2);
1642	}
1643	rc2 = RTR0MemObjFree(Mem.MemObj, false);
1644	AssertRC(rc2);
1645	}
1646
1647	return rc;
1648	}
1649
1650
1651	/**
1652	* Frees memory allocated using SUPR0ContAlloc().
1653	*
1654	* @returns IPRT status code.
1655	* @param pSession The session to which the memory was allocated.
1656	* @param uPtr Pointer to the memory (ring-3 or ring-0).
1657	*/
1658	SUPR0DECL(int) SUPR0ContFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr)
1659	{
1660	LogFlow(("SUPR0ContFree: pSession=%p uPtr=%p\n", pSession, (void *)uPtr));
1661	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1662	return supdrvMemRelease(pSession, uPtr, MEMREF_TYPE_CONT);
1663	}
1664
1665
1666	/**
1667	* Allocates a chunk of page aligned memory with fixed physical backing below 4GB.
1668	*
1669	* The memory isn't zeroed.
1670	*
1671	* @returns IPRT status code.
1672	* @param pSession Session data.
1673	* @param cPages Number of pages to allocate.
1674	* @param ppvR0 Where to put the address of Ring-0 mapping of the allocated memory.
1675	* @param ppvR3 Where to put the address of Ring-3 mapping of the allocated memory.
1676	* @param paPages Where to put the physical addresses of allocated memory.
1677	*/
1678	SUPR0DECL(int) SUPR0LowAlloc(PSUPDRVSESSION pSession, uint32_t cPages, PRTR0PTR ppvR0, PRTR3PTR ppvR3, PRTHCPHYS paPages)
1679	{
1680	unsigned iPage;
1681	int rc;
1682	SUPDRVMEMREF Mem = {0};
1683	LogFlow(("SUPR0LowAlloc: pSession=%p cPages=%d ppvR3=%p ppvR0=%p paPages=%p\n", pSession, cPages, ppvR3, ppvR0, paPages));
1684
1685	/*
1686	* Validate input.
1687	*/
1688	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1689	if (!ppvR3 \|\| !ppvR0 \|\| !paPages)
1690	{
1691	Log(("Null pointer. All of these should be set: pSession=%p ppvR3=%p ppvR0=%p paPages=%p\n",
1692	pSession, ppvR3, ppvR0, paPages));
1693	return VERR_INVALID_PARAMETER;
1694
1695	}
1696	if (cPages < 1 \|\| cPages > 256)
1697	{
1698	Log(("Illegal request cPages=%d, must be greater than 0 and smaller than 256.\n", cPages));
1699	return VERR_INVALID_PARAMETER;
1700	}
1701
1702	/*
1703	* Let IPRT do the work.
1704	*/
1705	rc = RTR0MemObjAllocLow(&Mem.MemObj, cPages << PAGE_SHIFT, true /* executable ring-0 mapping */);
1706	if (RT_SUCCESS(rc))
1707	{
1708	int rc2;
1709	rc = RTR0MemObjMapUser(&Mem.MapObjR3, Mem.MemObj, (RTR3PTR)-1, 0,
1710	RTMEM_PROT_EXEC \| RTMEM_PROT_WRITE \| RTMEM_PROT_READ, RTR0ProcHandleSelf());
1711	if (RT_SUCCESS(rc))
1712	{
1713	Mem.eType = MEMREF_TYPE_LOW;
1714	rc = supdrvMemAdd(&Mem, pSession);
1715	if (!rc)
1716	{
1717	for (iPage = 0; iPage < cPages; iPage++)
1718	{
1719	paPages[iPage] = RTR0MemObjGetPagePhysAddr(Mem.MemObj, iPage);
1720	AssertMsg(!(paPages[iPage] & (PAGE_SIZE - 1)), ("iPage=%d Phys=%VHp\n", paPages[iPage]));
1721	}
1722	*ppvR0 = RTR0MemObjAddress(Mem.MemObj);
1723	*ppvR3 = RTR0MemObjAddressR3(Mem.MapObjR3);
1724	return 0;
1725	}
1726
1727	rc2 = RTR0MemObjFree(Mem.MapObjR3, false);
1728	AssertRC(rc2);
1729	}
1730
1731	rc2 = RTR0MemObjFree(Mem.MemObj, false);
1732	AssertRC(rc2);
1733	}
1734
1735	return rc;
1736	}
1737
1738
1739	/**
1740	* Frees memory allocated using SUPR0LowAlloc().
1741	*
1742	* @returns IPRT status code.
1743	* @param pSession The session to which the memory was allocated.
1744	* @param uPtr Pointer to the memory (ring-3 or ring-0).
1745	*/
1746	SUPR0DECL(int) SUPR0LowFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr)
1747	{
1748	LogFlow(("SUPR0LowFree: pSession=%p uPtr=%p\n", pSession, (void *)uPtr));
1749	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1750	return supdrvMemRelease(pSession, uPtr, MEMREF_TYPE_LOW);
1751	}
1752
1753
1754
1755	/**
1756	* Allocates a chunk of memory with both R0 and R3 mappings.
1757	* The memory is fixed and it's possible to query the physical addresses using SUPR0MemGetPhys().
1758	*
1759	* @returns IPRT status code.
1760	* @param pSession The session to associated the allocation with.
1761	* @param cb Number of bytes to allocate.
1762	* @param ppvR0 Where to store the address of the Ring-0 mapping.
1763	* @param ppvR3 Where to store the address of the Ring-3 mapping.
1764	*/
1765	SUPR0DECL(int) SUPR0MemAlloc(PSUPDRVSESSION pSession, uint32_t cb, PRTR0PTR ppvR0, PRTR3PTR ppvR3)
1766	{
1767	int rc;
1768	SUPDRVMEMREF Mem = {0};
1769	LogFlow(("SUPR0MemAlloc: pSession=%p cb=%d ppvR0=%p ppvR3=%p\n", pSession, cb, ppvR0, ppvR3));
1770
1771	/*
1772	* Validate input.
1773	*/
1774	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1775	AssertPtrReturn(ppvR0, VERR_INVALID_POINTER);
1776	AssertPtrReturn(ppvR3, VERR_INVALID_POINTER);
1777	if (cb < 1 \|\| cb >= _4M)
1778	{
1779	Log(("Illegal request cb=%u; must be greater than 0 and smaller than 4MB.\n", cb));
1780	return VERR_INVALID_PARAMETER;
1781	}
1782
1783	/*
1784	* Let IPRT do the work.
1785	*/
1786	rc = RTR0MemObjAllocPage(&Mem.MemObj, cb, true /* executable ring-0 mapping */);
1787	if (RT_SUCCESS(rc))
1788	{
1789	int rc2;
1790	rc = RTR0MemObjMapUser(&Mem.MapObjR3, Mem.MemObj, (RTR3PTR)-1, 0,
1791	RTMEM_PROT_EXEC \| RTMEM_PROT_WRITE \| RTMEM_PROT_READ, RTR0ProcHandleSelf());
1792	if (RT_SUCCESS(rc))
1793	{
1794	Mem.eType = MEMREF_TYPE_MEM;
1795	rc = supdrvMemAdd(&Mem, pSession);
1796	if (!rc)
1797	{
1798	*ppvR0 = RTR0MemObjAddress(Mem.MemObj);
1799	*ppvR3 = RTR0MemObjAddressR3(Mem.MapObjR3);
1800	return VINF_SUCCESS;
1801	}
1802	rc2 = RTR0MemObjFree(Mem.MapObjR3, false);
1803	AssertRC(rc2);
1804	}
1805
1806	rc2 = RTR0MemObjFree(Mem.MemObj, false);
1807	AssertRC(rc2);
1808	}
1809
1810	return rc;
1811	}
1812
1813
1814	/**
1815	* Get the physical addresses of memory allocated using SUPR0MemAlloc().
1816	*
1817	* @returns IPRT status code.
1818	* @param pSession The session to which the memory was allocated.
1819	* @param uPtr The Ring-0 or Ring-3 address returned by SUPR0MemAlloc().
1820	* @param paPages Where to store the physical addresses.
1821	*/
1822	SUPR0DECL(int) SUPR0MemGetPhys(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr, PSUPPAGE paPages) /** @todo switch this bugger to RTHCPHYS */
1823	{
1824	PSUPDRVBUNDLE pBundle;
1825	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
1826	LogFlow(("SUPR0MemGetPhys: pSession=%p uPtr=%p paPages=%p\n", pSession, (void *)uPtr, paPages));
1827
1828	/*
1829	* Validate input.
1830	*/
1831	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1832	AssertPtrReturn(paPages, VERR_INVALID_POINTER);
1833	AssertReturn(uPtr, VERR_INVALID_PARAMETER);
1834
1835	/*
1836	* Search for the address.
1837	*/
1838	RTSpinlockAcquire(pSession->Spinlock, &SpinlockTmp);
1839	for (pBundle = &pSession->Bundle; pBundle; pBundle = pBundle->pNext)
1840	{
1841	if (pBundle->cUsed > 0)
1842	{
1843	unsigned i;
1844	for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
1845	{
1846	if ( pBundle->aMem[i].eType == MEMREF_TYPE_MEM
1847	&& pBundle->aMem[i].MemObj != NIL_RTR0MEMOBJ
1848	&& ( (RTHCUINTPTR)RTR0MemObjAddress(pBundle->aMem[i].MemObj) == uPtr
1849	\|\| ( pBundle->aMem[i].MapObjR3 != NIL_RTR0MEMOBJ
1850	&& RTR0MemObjAddressR3(pBundle->aMem[i].MapObjR3) == uPtr)
1851	)
1852	)
1853	{
1854	const unsigned cPages = RTR0MemObjSize(pBundle->aMem[i].MemObj) >> PAGE_SHIFT;
1855	unsigned iPage;
1856	for (iPage = 0; iPage < cPages; iPage++)
1857	{
1858	paPages[iPage].Phys = RTR0MemObjGetPagePhysAddr(pBundle->aMem[i].MemObj, iPage);
1859	paPages[iPage].uReserved = 0;
1860	}
1861	RTSpinlockRelease(pSession->Spinlock, &SpinlockTmp);
1862	return VINF_SUCCESS;
1863	}
1864	}
1865	}
1866	}
1867	RTSpinlockRelease(pSession->Spinlock, &SpinlockTmp);
1868	Log(("Failed to find %p!!!\n", (void *)uPtr));
1869	return VERR_INVALID_PARAMETER;
1870	}
1871
1872
1873	/**
1874	* Free memory allocated by SUPR0MemAlloc().
1875	*
1876	* @returns IPRT status code.
1877	* @param pSession The session owning the allocation.
1878	* @param uPtr The Ring-0 or Ring-3 address returned by SUPR0MemAlloc().
1879	*/
1880	SUPR0DECL(int) SUPR0MemFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr)
1881	{
1882	LogFlow(("SUPR0MemFree: pSession=%p uPtr=%p\n", pSession, (void *)uPtr));
1883	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1884	return supdrvMemRelease(pSession, uPtr, MEMREF_TYPE_MEM);
1885	}
1886
1887
1888	/**
1889	* Allocates a chunk of memory with only a R3 mappings.
1890	* The memory is fixed and it's possible to query the physical addresses using SUPR0MemGetPhys().
1891	*
1892	* @returns IPRT status code.
1893	* @param pSession The session to associated the allocation with.
1894	* @param cPages The number of pages to allocate.
1895	* @param ppvR3 Where to store the address of the Ring-3 mapping.
1896	* @param paPages Where to store the addresses of the pages. Optional.
1897	*/
1898	SUPR0DECL(int) SUPR0PageAlloc(PSUPDRVSESSION pSession, uint32_t cPages, PRTR3PTR ppvR3, PRTHCPHYS paPages)
1899	{
1900	int rc;
1901	SUPDRVMEMREF Mem = {0};
1902	LogFlow(("SUPR0PageAlloc: pSession=%p cb=%d ppvR3=%p\n", pSession, cPages, ppvR3));
1903
1904	/*
1905	* Validate input. The allowed allocation size must be at least equal to the maximum guest VRAM size.
1906	*/
1907	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1908	AssertPtrReturn(ppvR3, VERR_INVALID_POINTER);
1909	if (cPages < 1 \|\| cPages > (128 * _1M)/PAGE_SIZE)
1910	{
1911	Log(("SUPR0PageAlloc: Illegal request cb=%u; must be greater than 0 and smaller than 128MB.\n", cPages));
1912	return VERR_INVALID_PARAMETER;
1913	}
1914
1915	/*
1916	* Let IPRT do the work.
1917	*/
1918	rc = RTR0MemObjAllocPhysNC(&Mem.MemObj, (size_t)cPages * PAGE_SIZE, NIL_RTHCPHYS);
1919	if (RT_SUCCESS(rc))
1920	{
1921	int rc2;
1922	rc = RTR0MemObjMapUser(&Mem.MapObjR3, Mem.MemObj, (RTR3PTR)-1, 0,
1923	RTMEM_PROT_EXEC \| RTMEM_PROT_WRITE \| RTMEM_PROT_READ, RTR0ProcHandleSelf());
1924	if (RT_SUCCESS(rc))
1925	{
1926	Mem.eType = MEMREF_TYPE_LOCKED_SUP;
1927	rc = supdrvMemAdd(&Mem, pSession);
1928	if (!rc)
1929	{
1930	*ppvR3 = RTR0MemObjAddressR3(Mem.MapObjR3);
1931	if (paPages)
1932	{
1933	uint32_t iPage = cPages;
1934	while (iPage-- > 0)
1935	{
1936	paPages[iPage] = RTR0MemObjGetPagePhysAddr(Mem.MapObjR3, iPage);
1937	Assert(paPages[iPage] != NIL_RTHCPHYS);
1938	}
1939	}
1940	return VINF_SUCCESS;
1941	}
1942	rc2 = RTR0MemObjFree(Mem.MapObjR3, false);
1943	AssertRC(rc2);
1944	}
1945
1946	rc2 = RTR0MemObjFree(Mem.MemObj, false);
1947	AssertRC(rc2);
1948	}
1949	return rc;
1950	}
1951
1952
1953	#ifdef RT_OS_WINDOWS
1954	/**
1955	* Check if the pages were locked by SUPR0PageAlloc
1956	*
1957	* This function will be removed along with the lock/unlock hacks when
1958	* we've cleaned up the ring-3 code properly.
1959	*
1960	* @returns boolean
1961	* @param pSession The session to which the memory was allocated.
1962	* @param pvR3 The Ring-3 address returned by SUPR0PageAlloc().
1963	*/
1964	static bool supdrvPageWasLockedByPageAlloc(PSUPDRVSESSION pSession, RTR3PTR pvR3)
1965	{
1966	PSUPDRVBUNDLE pBundle;
1967	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
1968	LogFlow(("SUPR0PageIsLockedByPageAlloc: pSession=%p pvR3=%p\n", pSession, (void *)pvR3));
1969
1970	/*
1971	* Search for the address.
1972	*/
1973	RTSpinlockAcquire(pSession->Spinlock, &SpinlockTmp);
1974	for (pBundle = &pSession->Bundle; pBundle; pBundle = pBundle->pNext)
1975	{
1976	if (pBundle->cUsed > 0)
1977	{
1978	unsigned i;
1979	for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
1980	{
1981	if ( pBundle->aMem[i].eType == MEMREF_TYPE_LOCKED_SUP
1982	&& pBundle->aMem[i].MemObj != NIL_RTR0MEMOBJ
1983	&& pBundle->aMem[i].MapObjR3 != NIL_RTR0MEMOBJ
1984	&& RTR0MemObjAddressR3(pBundle->aMem[i].MapObjR3) == pvR3)
1985	{
1986	RTSpinlockRelease(pSession->Spinlock, &SpinlockTmp);
1987	return true;
1988	}
1989	}
1990	}
1991	}
1992	RTSpinlockRelease(pSession->Spinlock, &SpinlockTmp);
1993	return false;
1994	}
1995
1996
1997	/**
1998	* Get the physical addresses of memory allocated using SUPR0PageAlloc().
1999	*
2000	* This function will be removed along with the lock/unlock hacks when
2001	* we've cleaned up the ring-3 code properly.
2002	*
2003	* @returns IPRT status code.
2004	* @param pSession The session to which the memory was allocated.
2005	* @param pvR3 The Ring-3 address returned by SUPR0PageAlloc().
2006	* @param cPages Number of pages in paPages
2007	* @param paPages Where to store the physical addresses.
2008	*/
2009	static int supdrvPageGetPhys(PSUPDRVSESSION pSession, RTR3PTR pvR3, uint32_t cPages, PRTHCPHYS paPages)
2010	{
2011	PSUPDRVBUNDLE pBundle;
2012	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
2013	LogFlow(("supdrvPageGetPhys: pSession=%p pvR3=%p cPages=%#lx paPages=%p\n", pSession, (void *)pvR3, (long)cPages, paPages));
2014
2015	/*
2016	* Search for the address.
2017	*/
2018	RTSpinlockAcquire(pSession->Spinlock, &SpinlockTmp);
2019	for (pBundle = &pSession->Bundle; pBundle; pBundle = pBundle->pNext)
2020	{
2021	if (pBundle->cUsed > 0)
2022	{
2023	unsigned i;
2024	for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
2025	{
2026	if ( pBundle->aMem[i].eType == MEMREF_TYPE_LOCKED_SUP
2027	&& pBundle->aMem[i].MemObj != NIL_RTR0MEMOBJ
2028	&& pBundle->aMem[i].MapObjR3 != NIL_RTR0MEMOBJ
2029	&& RTR0MemObjAddressR3(pBundle->aMem[i].MapObjR3) == pvR3)
2030	{
2031	uint32_t iPage = RTR0MemObjSize(pBundle->aMem[i].MemObj) >> PAGE_SHIFT;
2032	cPages = RT_MIN(iPage, cPages);
2033	for (iPage = 0; iPage < cPages; iPage++)
2034	paPages[iPage] = RTR0MemObjGetPagePhysAddr(pBundle->aMem[i].MemObj, iPage);
2035	RTSpinlockRelease(pSession->Spinlock, &SpinlockTmp);
2036	return VINF_SUCCESS;
2037	}
2038	}
2039	}
2040	}
2041	RTSpinlockRelease(pSession->Spinlock, &SpinlockTmp);
2042	return VERR_INVALID_PARAMETER;
2043	}
2044	#endif /* RT_OS_WINDOWS */
2045
2046
2047	/**
2048	* Free memory allocated by SUPR0PageAlloc().
2049	*
2050	* @returns IPRT status code.
2051	* @param pSession The session owning the allocation.
2052	* @param pvR3 The Ring-3 address returned by SUPR0PageAlloc().
2053	*/
2054	SUPR0DECL(int) SUPR0PageFree(PSUPDRVSESSION pSession, RTR3PTR pvR3)
2055	{
2056	LogFlow(("SUPR0PageFree: pSession=%p pvR3=%p\n", pSession, (void *)pvR3));
2057	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
2058	return supdrvMemRelease(pSession, (RTHCUINTPTR)pvR3, MEMREF_TYPE_LOCKED_SUP);
2059	}
2060
2061
2062	/**
2063	* Maps the GIP into userspace and/or get the physical address of the GIP.
2064	*
2065	* @returns IPRT status code.
2066	* @param pSession Session to which the GIP mapping should belong.
2067	* @param ppGipR3 Where to store the address of the ring-3 mapping. (optional)
2068	* @param pHCPhysGip Where to store the physical address. (optional)
2069	*
2070	* @remark There is no reference counting on the mapping, so one call to this function
2071	* count globally as one reference. One call to SUPR0GipUnmap() is will unmap GIP
2072	* and remove the session as a GIP user.
2073	*/
2074	SUPR0DECL(int) SUPR0GipMap(PSUPDRVSESSION pSession, PRTR3PTR ppGipR3, PRTHCPHYS pHCPhysGip)
2075	{
2076	int rc = 0;
2077	PSUPDRVDEVEXT pDevExt = pSession->pDevExt;
2078	RTR3PTR pGip = NIL_RTR3PTR;
2079	RTHCPHYS HCPhys = NIL_RTHCPHYS;
2080	LogFlow(("SUPR0GipMap: pSession=%p ppGipR3=%p pHCPhysGip=%p\n", pSession, ppGipR3, pHCPhysGip));
2081
2082	/*
2083	* Validate
2084	*/
2085	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
2086	AssertPtrNullReturn(ppGipR3, VERR_INVALID_POINTER);
2087	AssertPtrNullReturn(pHCPhysGip, VERR_INVALID_POINTER);
2088
2089	RTSemFastMutexRequest(pDevExt->mtxGip);
2090	if (pDevExt->pGip)
2091	{
2092	/*
2093	* Map it?
2094	*/
2095	if (ppGipR3)
2096	{
2097	#ifdef USE_NEW_OS_INTERFACE_FOR_GIP
2098	if (pSession->GipMapObjR3 == NIL_RTR0MEMOBJ)
2099	rc = RTR0MemObjMapUser(&pSession->GipMapObjR3, pDevExt->GipMemObj, (RTR3PTR)-1, 0,
2100	RTMEM_PROT_READ, RTR0ProcHandleSelf());
2101	if (RT_SUCCESS(rc))
2102	{
2103	pGip = RTR0MemObjAddressR3(pSession->GipMapObjR3);
2104	rc = VINF_SUCCESS; /** @todo remove this and replace the !rc below with RT_SUCCESS(rc). */
2105	}
2106	#else /* !USE_NEW_OS_INTERFACE_FOR_GIP */
2107	if (!pSession->pGip)
2108	rc = supdrvOSGipMap(pSession->pDevExt, &pSession->pGip);
2109	if (!rc)
2110	pGip = (RTR3PTR)pSession->pGip;
2111	#endif /* !USE_NEW_OS_INTERFACE_FOR_GIP */
2112	}
2113
2114	/*
2115	* Get physical address.
2116	*/
2117	if (pHCPhysGip && !rc)
2118	HCPhys = pDevExt->HCPhysGip;
2119
2120	/*
2121	* Reference globally.
2122	*/
2123	if (!pSession->fGipReferenced && !rc)
2124	{
2125	pSession->fGipReferenced = 1;
2126	pDevExt->cGipUsers++;
2127	if (pDevExt->cGipUsers == 1)
2128	{
2129	PSUPGLOBALINFOPAGE pGip = pDevExt->pGip;
2130	unsigned i;
2131
2132	LogFlow(("SUPR0GipMap: Resumes GIP updating\n"));
2133
2134	for (i = 0; i < RT_ELEMENTS(pGip->aCPUs); i++)
2135	ASMAtomicXchgU32(&pGip->aCPUs[i].u32TransactionId, pGip->aCPUs[i].u32TransactionId & ~(GIP_UPDATEHZ_RECALC_FREQ * 2 - 1));
2136	ASMAtomicXchgU64(&pGip->u64NanoTSLastUpdateHz, 0);
2137
2138	#ifdef USE_NEW_OS_INTERFACE_FOR_GIP
2139	rc = RTTimerStart(pDevExt->pGipTimer, 0);
2140	AssertRC(rc); rc = VINF_SUCCESS;
2141	#else
2142	supdrvOSGipResume(pDevExt);
2143	#endif
2144	}
2145	}
2146	}
2147	else
2148	{
2149	rc = SUPDRV_ERR_GENERAL_FAILURE;
2150	Log(("SUPR0GipMap: GIP is not available!\n"));
2151	}
2152	RTSemFastMutexRelease(pDevExt->mtxGip);
2153
2154	/*
2155	* Write returns.
2156	*/
2157	if (pHCPhysGip)
2158	*pHCPhysGip = HCPhys;
2159	if (ppGipR3)
2160	*ppGipR3 = pGip;
2161
2162	#ifdef DEBUG_DARWIN_GIP
2163	OSDBGPRINT(("SUPR0GipMap: returns %d pHCPhysGip=%lx ppGip=%p GipMapObjR3\n", rc, (unsigned long)HCPhys, pGip, pSession->GipMapObjR3));
2164	#else
2165	LogFlow(("SUPR0GipMap: returns %d pHCPhysGip=%lx ppGipR3=%p\n", rc, (unsigned long)HCPhys, (void *)(uintptr_t)pGip));
2166	#endif
2167	return rc;
2168	}
2169
2170
2171	/**
2172	* Unmaps any user mapping of the GIP and terminates all GIP access
2173	* from this session.
2174	*
2175	* @returns IPRT status code.
2176	* @param pSession Session to which the GIP mapping should belong.
2177	*/
2178	SUPR0DECL(int) SUPR0GipUnmap(PSUPDRVSESSION pSession)
2179	{
2180	int rc = VINF_SUCCESS;
2181	PSUPDRVDEVEXT pDevExt = pSession->pDevExt;
2182	#ifdef DEBUG_DARWIN_GIP
2183	OSDBGPRINT(("SUPR0GipUnmap: pSession=%p pGip=%p GipMapObjR3=%p\n",
2184	pSession,
2185	pSession->GipMapObjR3 != NIL_RTR0MEMOBJ ? RTR0MemObjAddress(pSession->GipMapObjR3) : NULL,
2186	pSession->GipMapObjR3));
2187	#else
2188	LogFlow(("SUPR0GipUnmap: pSession=%p\n", pSession));
2189	#endif
2190	AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
2191
2192	RTSemFastMutexRequest(pDevExt->mtxGip);
2193
2194	/*
2195	* Unmap anything?
2196	*/
2197	#ifdef USE_NEW_OS_INTERFACE_FOR_GIP
2198	if (pSession->GipMapObjR3 != NIL_RTR0MEMOBJ)
2199	{
2200	rc = RTR0MemObjFree(pSession->GipMapObjR3, false);
2201	AssertRC(rc);
2202	if (RT_SUCCESS(rc))
2203	pSession->GipMapObjR3 = NIL_RTR0MEMOBJ;
2204	}
2205	#else
2206	if (pSession->pGip)
2207	{
2208	rc = supdrvOSGipUnmap(pDevExt, pSession->pGip);
2209	if (!rc)
2210	pSession->pGip = NULL;
2211	}
2212	#endif
2213
2214	/*
2215	* Dereference global GIP.
2216	*/
2217	if (pSession->fGipReferenced && !rc)
2218	{
2219	pSession->fGipReferenced = 0;
2220	if ( pDevExt->cGipUsers > 0
2221	&& !--pDevExt->cGipUsers)
2222	{
2223	LogFlow(("SUPR0GipUnmap: Suspends GIP updating\n"));
2224	#ifdef USE_NEW_OS_INTERFACE_FOR_GIP
2225	rc = RTTimerStop(pDevExt->pGipTimer); AssertRC(rc); rc = 0;
2226	#else
2227	supdrvOSGipSuspend(pDevExt);
2228	#endif
2229	}
2230	}
2231
2232	RTSemFastMutexRelease(pDevExt->mtxGip);
2233
2234	return rc;
2235	}
2236
2237
2238	/**
2239	* Adds a memory object to the session.
2240	*
2241	* @returns IPRT status code.
2242	* @param pMem Memory tracking structure containing the
2243	* information to track.
2244	* @param pSession The session.
2245	*/
2246	static int supdrvMemAdd(PSUPDRVMEMREF pMem, PSUPDRVSESSION pSession)
2247	{
2248	PSUPDRVBUNDLE pBundle;
2249	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
2250
2251	/*
2252	* Find free entry and record the allocation.
2253	*/
2254	RTSpinlockAcquire(pSession->Spinlock, &SpinlockTmp);
2255	for (pBundle = &pSession->Bundle; pBundle; pBundle = pBundle->pNext)
2256	{
2257	if (pBundle->cUsed < RT_ELEMENTS(pBundle->aMem))
2258	{
2259	unsigned i;
2260	for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
2261	{
2262	if (pBundle->aMem[i].MemObj == NIL_RTR0MEMOBJ)
2263	{
2264	pBundle->cUsed++;
2265	pBundle->aMem[i] = *pMem;
2266	RTSpinlockRelease(pSession->Spinlock, &SpinlockTmp);
2267	return VINF_SUCCESS;
2268	}
2269	}
2270	AssertFailed(); /* !!this can't be happening!!! */
2271	}
2272	}
2273	RTSpinlockRelease(pSession->Spinlock, &SpinlockTmp);
2274
2275	/*
2276	* Need to allocate a new bundle.
2277	* Insert into the last entry in the bundle.
2278	*/
2279	pBundle = (PSUPDRVBUNDLE)RTMemAllocZ(sizeof(*pBundle));
2280	if (!pBundle)
2281	return VERR_NO_MEMORY;
2282
2283	/* take last entry. */
2284	pBundle->cUsed++;
2285	pBundle->aMem[RT_ELEMENTS(pBundle->aMem) - 1] = *pMem;
2286
2287	/* insert into list. */
2288	RTSpinlockAcquire(pSession->Spinlock, &SpinlockTmp);
2289	pBundle->pNext = pSession->Bundle.pNext;
2290	pSession->Bundle.pNext = pBundle;
2291	RTSpinlockRelease(pSession->Spinlock, &SpinlockTmp);
2292
2293	return VINF_SUCCESS;
2294	}
2295
2296
2297	/**
2298	* Releases a memory object referenced by pointer and type.
2299	*
2300	* @returns IPRT status code.
2301	* @param pSession Session data.
2302	* @param uPtr Pointer to memory. This is matched against both the R0 and R3 addresses.
2303	* @param eType Memory type.
2304	*/
2305	static int supdrvMemRelease(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr, SUPDRVMEMREFTYPE eType)
2306	{
2307	PSUPDRVBUNDLE pBundle;
2308	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
2309
2310	/*
2311	* Validate input.
2312	*/
2313	if (!uPtr)
2314	{
2315	Log(("Illegal address %p\n", (void *)uPtr));
2316	return VERR_INVALID_PARAMETER;
2317	}
2318
2319	/*
2320	* Search for the address.
2321	*/
2322	RTSpinlockAcquire(pSession->Spinlock, &SpinlockTmp);
2323	for (pBundle = &pSession->Bundle; pBundle; pBundle = pBundle->pNext)
2324	{
2325	if (pBundle->cUsed > 0)
2326	{
2327	unsigned i;
2328	for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
2329	{
2330	if ( pBundle->aMem[i].eType == eType
2331	&& pBundle->aMem[i].MemObj != NIL_RTR0MEMOBJ
2332	&& ( (RTHCUINTPTR)RTR0MemObjAddress(pBundle->aMem[i].MemObj) == uPtr
2333	\|\| ( pBundle->aMem[i].MapObjR3 != NIL_RTR0MEMOBJ
2334	&& RTR0MemObjAddressR3(pBundle->aMem[i].MapObjR3) == uPtr))
2335	)
2336	{
2337	/* Make a copy of it and release it outside the spinlock. */
2338	SUPDRVMEMREF Mem = pBundle->aMem[i];
2339	pBundle->aMem[i].eType = MEMREF_TYPE_UNUSED;
2340	pBundle->aMem[i].MemObj = NIL_RTR0MEMOBJ;
2341	pBundle->aMem[i].MapObjR3 = NIL_RTR0MEMOBJ;
2342	RTSpinlockRelease(pSession->Spinlock, &SpinlockTmp);
2343
2344	if (Mem.MapObjR3)
2345	{
2346	int rc = RTR0MemObjFree(Mem.MapObjR3, false);
2347	AssertRC(rc); /** @todo figure out how to handle this. */
2348	}
2349	if (Mem.MemObj)
2350	{
2351	int rc = RTR0MemObjFree(Mem.MemObj, false);
2352	AssertRC(rc); /** @todo figure out how to handle this. */
2353	}
2354	return VINF_SUCCESS;
2355	}
2356	}
2357	}
2358	}
2359	RTSpinlockRelease(pSession->Spinlock, &SpinlockTmp);
2360	Log(("Failed to find %p!!! (eType=%d)\n", (void *)uPtr, eType));
2361	return VERR_INVALID_PARAMETER;
2362	}
2363
2364
2365	#ifdef VBOX_WITH_IDT_PATCHING
2366	/**
2367	* Install IDT for the current CPU.
2368	*
2369	* @returns One of the following IPRT status codes:
2370	* @retval VINF_SUCCESS on success.
2371	* @retval VERR_IDT_FAILED.
2372	* @retval VERR_NO_MEMORY.
2373	* @param pDevExt The device extension.
2374	* @param pSession The session data.
2375	* @param pReq The request.
2376	*/
2377	static int supdrvIOCtl_IdtInstall(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPIDTINSTALL pReq)
2378	{
2379	PSUPDRVPATCHUSAGE pUsagePre;
2380	PSUPDRVPATCH pPatchPre;
2381	RTIDTR Idtr;
2382	PSUPDRVPATCH pPatch;
2383	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
2384	LogFlow(("supdrvIOCtl_IdtInstall\n"));
2385
2386	/*
2387	* Preallocate entry for this CPU cause we don't wanna do
2388	* that inside the spinlock!
2389	*/
2390	pUsagePre = (PSUPDRVPATCHUSAGE)RTMemAlloc(sizeof(*pUsagePre));
2391	if (!pUsagePre)
2392	return VERR_NO_MEMORY;
2393
2394	/*
2395	* Take the spinlock and see what we need to do.
2396	*/
2397	RTSpinlockAcquireNoInts(pDevExt->Spinlock, &SpinlockTmp);
2398
2399	/* check if we already got a free patch. */
2400	if (!pDevExt->pIdtPatchesFree)
2401	{
2402	/*
2403	* Allocate a patch - outside the spinlock of course.
2404	*/
2405	RTSpinlockReleaseNoInts(pDevExt->Spinlock, &SpinlockTmp);
2406
2407	pPatchPre = (PSUPDRVPATCH)RTMemExecAlloc(sizeof(*pPatchPre));
2408	if (!pPatchPre)
2409	return VERR_NO_MEMORY;
2410
2411	RTSpinlockAcquireNoInts(pDevExt->Spinlock, &SpinlockTmp);
2412	}
2413	else
2414	{
2415	pPatchPre = pDevExt->pIdtPatchesFree;
2416	pDevExt->pIdtPatchesFree = pPatchPre->pNext;
2417	}
2418
2419	/* look for matching patch entry */
2420	ASMGetIDTR(&Idtr);
2421	pPatch = pDevExt->pIdtPatches;
2422	while (pPatch && pPatch->pvIdt != (void *)Idtr.pIdt)
2423	pPatch = pPatch->pNext;
2424
2425	if (!pPatch)
2426	{
2427	/*
2428	* Create patch.
2429	*/
2430	pPatch = supdrvIdtPatchOne(pDevExt, pPatchPre);
2431	if (pPatch)
2432	pPatchPre = NULL; /* mark as used. */
2433	}
2434	else
2435	{
2436	/*
2437	* Simply increment patch usage.
2438	*/
2439	pPatch->cUsage++;
2440	}
2441
2442	if (pPatch)
2443	{
2444	/*
2445	* Increment and add if need be the session usage record for this patch.
2446	*/
2447	PSUPDRVPATCHUSAGE pUsage = pSession->pPatchUsage;
2448	while (pUsage && pUsage->pPatch != pPatch)
2449	pUsage = pUsage->pNext;
2450
2451	if (!pUsage)
2452	{
2453	/*
2454	* Add usage record.
2455	*/
2456	pUsagePre->cUsage = 1;
2457	pUsagePre->pPatch = pPatch;
2458	pUsagePre->pNext = pSession->pPatchUsage;
2459	pSession->pPatchUsage = pUsagePre;
2460	pUsagePre = NULL; /* mark as used. */
2461	}
2462	else
2463	{
2464	/*
2465	* Increment usage count.
2466	*/
2467	pUsage->cUsage++;
2468	}
2469	}
2470
2471	/* free patch - we accumulate them for paranoid saftly reasons. */
2472	if (pPatchPre)
2473	{
2474	pPatchPre->pNext = pDevExt->pIdtPatchesFree;
2475	pDevExt->pIdtPatchesFree = pPatchPre;
2476	}
2477
2478	RTSpinlockReleaseNoInts(pDevExt->Spinlock, &SpinlockTmp);
2479
2480	/*
2481	* Free unused preallocated buffers.
2482	*/
2483	if (pUsagePre)
2484	RTMemFree(pUsagePre);
2485
2486	pReq->u.Out.u8Idt = pDevExt->u8Idt;
2487
2488	return pPatch ? VINF_SUCCESS : VERR_IDT_FAILED;
2489	}
2490
2491
2492	/**
2493	* This creates a IDT patch entry.
2494	* If the first patch being installed it'll also determin the IDT entry
2495	* to use.
2496	*
2497	* @returns pPatch on success.
2498	* @returns NULL on failure.
2499	* @param pDevExt Pointer to globals.
2500	* @param pPatch Patch entry to use.
2501	* This will be linked into SUPDRVDEVEXT::pIdtPatches on
2502	* successful return.
2503	* @remark Call must be owning the SUPDRVDEVEXT::Spinlock!
2504	*/
2505	static PSUPDRVPATCH supdrvIdtPatchOne(PSUPDRVDEVEXT pDevExt, PSUPDRVPATCH pPatch)
2506	{
2507	RTIDTR Idtr;
2508	PSUPDRVIDTE paIdt;
2509	LogFlow(("supdrvIOCtl_IdtPatchOne: pPatch=%p\n", pPatch));
2510
2511	/*
2512	* Get IDT.
2513	*/
2514	ASMGetIDTR(&Idtr);
2515	paIdt = (PSUPDRVIDTE)Idtr.pIdt;
2516	/*
2517	* Recent Linux kernels can be configured to 1G user /3G kernel.
2518	*/
2519	if ((uintptr_t)paIdt < 0x40000000)
2520	{
2521	AssertMsgFailed(("bad paIdt=%p\n", paIdt));
2522	return NULL;
2523	}
2524
2525	if (!pDevExt->u8Idt)
2526	{
2527	/*
2528	* Test out the alternatives.
2529	*
2530	* At the moment we do not support chaining thus we ASSUME that one of
2531	* these 48 entries is unused (which is not a problem on Win32 and
2532	* Linux to my knowledge).
2533	*/
2534	/** @todo we MUST change this detection to try grab an entry which is NOT in use. This can be
2535	* combined with gathering info about which guest system call gates we can hook up directly. */
2536	unsigned i;
2537	uint8_t u8Idt = 0;
2538	static uint8_t au8Ints[] =
2539	{
2540	#ifdef RT_OS_WINDOWS /* We don't use 0xef and above because they are system stuff on linux (ef is IPI,
2541	* local apic timer, or some other frequently fireing thing). */
2542	0xef, 0xee, 0xed, 0xec,
2543	#endif
2544	0xeb, 0xea, 0xe9, 0xe8,
2545	0xdf, 0xde, 0xdd, 0xdc,
2546	0x7b, 0x7a, 0x79, 0x78,
2547	0xbf, 0xbe, 0xbd, 0xbc,
2548	};
2549	#if defined(RT_ARCH_AMD64) && defined(DEBUG)
2550	static int s_iWobble = 0;
2551	unsigned iMax = !(s_iWobble++ % 2) ? 0x80 : 0x100;
2552	Log2(("IDT: Idtr=%p:%#x\n", (void *)Idtr.pIdt, (unsigned)Idtr.cbIdt));
2553	for (i = iMax - 0x80; i*16+15 < Idtr.cbIdt && i < iMax; i++)
2554	{
2555	Log2(("%#x: %04x:%08x%04x%04x P=%d DPL=%d IST=%d Type1=%#x u32Reserved=%#x u5Reserved=%#x\n",
2556	i, paIdt[i].u16SegSel, paIdt[i].u32OffsetTop, paIdt[i].u16OffsetHigh, paIdt[i].u16OffsetLow,
2557	paIdt[i].u1Present, paIdt[i].u2DPL, paIdt[i].u3IST, paIdt[i].u5Type2,
2558	paIdt[i].u32Reserved, paIdt[i].u5Reserved));
2559	}
2560	#endif
2561	/* look for entries which are not present or otherwise unused. */
2562	for (i = 0; i < sizeof(au8Ints) / sizeof(au8Ints[0]); i++)
2563	{
2564	u8Idt = au8Ints[i];
2565	if ( u8Idt * sizeof(SUPDRVIDTE) < Idtr.cbIdt
2566	&& ( !paIdt[u8Idt].u1Present
2567	\|\| paIdt[u8Idt].u5Type2 == 0))
2568	break;
2569	u8Idt = 0;
2570	}
2571	if (!u8Idt)
2572	{
2573	/* try again, look for a compatible entry .*/
2574	for (i = 0; i < sizeof(au8Ints) / sizeof(au8Ints[0]); i++)
2575	{
2576	u8Idt = au8Ints[i];
2577	if ( u8Idt * sizeof(SUPDRVIDTE) < Idtr.cbIdt
2578	&& paIdt[u8Idt].u1Present
2579	&& paIdt[u8Idt].u5Type2 == SUPDRV_IDTE_TYPE2_INTERRUPT_GATE
2580	&& !(paIdt[u8Idt].u16SegSel & 3))
2581	break;
2582	u8Idt = 0;
2583	}
2584	if (!u8Idt)
2585	{
2586	Log(("Failed to find appropirate IDT entry!!\n"));
2587	return NULL;
2588	}
2589	}
2590	pDevExt->u8Idt = u8Idt;
2591	LogFlow(("supdrvIOCtl_IdtPatchOne: u8Idt=%x\n", u8Idt));
2592	}
2593
2594	/*
2595	* Prepare the patch
2596	*/
2597	memset(pPatch, 0, sizeof(*pPatch));
2598	pPatch->pvIdt = paIdt;
2599	pPatch->cUsage = 1;
2600	pPatch->pIdtEntry = &paIdt[pDevExt->u8Idt];
2601	pPatch->SavedIdt = paIdt[pDevExt->u8Idt];
2602	pPatch->ChangedIdt.u16OffsetLow = (uint32_t)((uintptr_t)&pPatch->auCode[0] & 0xffff);
2603	pPatch->ChangedIdt.u16OffsetHigh = (uint32_t)((uintptr_t)&pPatch->auCode[0] >> 16);
2604	#ifdef RT_ARCH_AMD64
2605	pPatch->ChangedIdt.u32OffsetTop = (uint32_t)((uintptr_t)&pPatch->auCode[0] >> 32);
2606	#endif
2607	pPatch->ChangedIdt.u16SegSel = ASMGetCS();
2608	#ifdef RT_ARCH_AMD64
2609	pPatch->ChangedIdt.u3IST = 0;
2610	pPatch->ChangedIdt.u5Reserved = 0;
2611	#else /* x86 */
2612	pPatch->ChangedIdt.u5Reserved = 0;
2613	pPatch->ChangedIdt.u3Type1 = 0;
2614	#endif /* x86 */
2615	pPatch->ChangedIdt.u5Type2 = SUPDRV_IDTE_TYPE2_INTERRUPT_GATE;
2616	pPatch->ChangedIdt.u2DPL = 3;
2617	pPatch->ChangedIdt.u1Present = 1;
2618
2619	/*
2620	* Generate the patch code.
2621	*/
2622	{
2623	#ifdef RT_ARCH_AMD64
2624	union
2625	{
2626	uint8_t *pb;
2627	uint32_t *pu32;
2628	uint64_t *pu64;
2629	} u, uFixJmp, uFixCall, uNotNested;
2630	u.pb = &pPatch->auCode[0];
2631
2632	/* check the cookie */
2633	*u.pb++ = 0x3d; // cmp eax, GLOBALCOOKIE
2634	*u.pu32++ = pDevExt->u32Cookie;
2635
2636	*u.pb++ = 0x74; // jz @VBoxCall
2637	*u.pb++ = 2;
2638
2639	/* jump to forwarder code. */
2640	*u.pb++ = 0xeb;
2641	uFixJmp = u;
2642	*u.pb++ = 0xfe;
2643
2644	// @VBoxCall:
2645	*u.pb++ = 0x0f; // swapgs
2646	*u.pb++ = 0x01;
2647	*u.pb++ = 0xf8;
2648
2649	/*
2650	* Call VMMR0Entry
2651	* We don't have to push the arguments here, but we have top
2652	* reserve some stack space for the interrupt forwarding.
2653	*/
2654	# ifdef RT_OS_WINDOWS
2655	*u.pb++ = 0x50; // push rax ; alignment filler.
2656	*u.pb++ = 0x41; // push r8 ; uArg
2657	*u.pb++ = 0x50;
2658	*u.pb++ = 0x52; // push rdx ; uOperation
2659	*u.pb++ = 0x51; // push rcx ; pVM
2660	# else
2661	*u.pb++ = 0x51; // push rcx ; alignment filler.
2662	*u.pb++ = 0x52; // push rdx ; uArg
2663	*u.pb++ = 0x56; // push rsi ; uOperation
2664	*u.pb++ = 0x57; // push rdi ; pVM
2665	# endif
2666
2667	*u.pb++ = 0xff; // call qword [pfnVMMR0EntryInt wrt rip]
2668	*u.pb++ = 0x15;
2669	uFixCall = u;
2670	*u.pu32++ = 0;
2671
2672	*u.pb++ = 0x48; // add rsp, 20h ; remove call frame.
2673	*u.pb++ = 0x81;
2674	*u.pb++ = 0xc4;
2675	*u.pu32++ = 0x20;
2676
2677	*u.pb++ = 0x0f; // swapgs
2678	*u.pb++ = 0x01;
2679	*u.pb++ = 0xf8;
2680
2681	/* Return to R3. */
2682	uNotNested = u;
2683	*u.pb++ = 0x48; // iretq
2684	*u.pb++ = 0xcf;
2685
2686	while ((uintptr_t)u.pb & 0x7) // align 8
2687	*u.pb++ = 0xcc;
2688
2689	/* Pointer to the VMMR0Entry. */ // pfnVMMR0EntryInt dq StubVMMR0Entry
2690	*uFixCall.pu32 = (uint32_t)(u.pb - uFixCall.pb - 4); uFixCall.pb = NULL;
2691	pPatch->offVMMR0EntryFixup = (uint16_t)(u.pb - &pPatch->auCode[0]);
2692	*u.pu64++ = pDevExt->pvVMMR0 ? (uint64_t)pDevExt->pfnVMMR0EntryInt : (uint64_t)u.pb + 8;
2693
2694	/* stub entry. */ // StubVMMR0Entry:
2695	pPatch->offStub = (uint16_t)(u.pb - &pPatch->auCode[0]);
2696	*u.pb++ = 0x33; // xor eax, eax
2697	*u.pb++ = 0xc0;
2698
2699	*u.pb++ = 0x48; // dec rax
2700	*u.pb++ = 0xff;
2701	*u.pb++ = 0xc8;
2702
2703	*u.pb++ = 0xc3; // ret
2704
2705	/* forward to the original handler using a retf. */
2706	*uFixJmp.pb = (uint8_t)(u.pb - uFixJmp.pb - 1); uFixJmp.pb = NULL;
2707
2708	*u.pb++ = 0x68; // push <target cs>
2709	*u.pu32++ = !pPatch->SavedIdt.u5Type2 ? ASMGetCS() : pPatch->SavedIdt.u16SegSel;
2710
2711	*u.pb++ = 0x68; // push <low target rip>
2712	*u.pu32++ = !pPatch->SavedIdt.u5Type2
2713	? (uint32_t)(uintptr_t)uNotNested.pb
2714	: (uint32_t)pPatch->SavedIdt.u16OffsetLow
2715	\| (uint32_t)pPatch->SavedIdt.u16OffsetHigh << 16;
2716
2717	*u.pb++ = 0xc7; // mov dword [rsp + 4], <high target rip>
2718	*u.pb++ = 0x44;
2719	*u.pb++ = 0x24;
2720	*u.pb++ = 0x04;
2721	*u.pu32++ = !pPatch->SavedIdt.u5Type2
2722	? (uint32_t)((uint64_t)uNotNested.pb >> 32)
2723	: pPatch->SavedIdt.u32OffsetTop;
2724
2725	*u.pb++ = 0x48; // retf ; does this require prefix?
2726	*u.pb++ = 0xcb;
2727
2728	#else /* RT_ARCH_X86 */
2729
2730	union
2731	{
2732	uint8_t *pb;
2733	uint16_t *pu16;
2734	uint32_t *pu32;
2735	} u, uFixJmpNotNested, uFixJmp, uFixCall, uNotNested;
2736	u.pb = &pPatch->auCode[0];
2737
2738	/* check the cookie */
2739	*u.pb++ = 0x81; // cmp esi, GLOBALCOOKIE
2740	*u.pb++ = 0xfe;
2741	*u.pu32++ = pDevExt->u32Cookie;
2742
2743	*u.pb++ = 0x74; // jz VBoxCall
2744	uFixJmp = u;
2745	*u.pb++ = 0;
2746
2747	/* jump (far) to the original handler / not-nested-stub. */
2748	*u.pb++ = 0xea; // jmp far NotNested
2749	uFixJmpNotNested = u;
2750	*u.pu32++ = 0;
2751	*u.pu16++ = 0;
2752
2753	/* save selector registers. */ // VBoxCall:
2754	*uFixJmp.pb = (uint8_t)(u.pb - uFixJmp.pb - 1);
2755	*u.pb++ = 0x0f; // push fs
2756	*u.pb++ = 0xa0;
2757
2758	*u.pb++ = 0x1e; // push ds
2759
2760	*u.pb++ = 0x06; // push es
2761
2762	/* call frame */
2763	*u.pb++ = 0x51; // push ecx
2764
2765	*u.pb++ = 0x52; // push edx
2766
2767	*u.pb++ = 0x50; // push eax
2768
2769	/* load ds, es and perhaps fs before call. */
2770	*u.pb++ = 0xb8; // mov eax, KernelDS
2771	*u.pu32++ = ASMGetDS();
2772
2773	*u.pb++ = 0x8e; // mov ds, eax
2774	*u.pb++ = 0xd8;
2775
2776	*u.pb++ = 0x8e; // mov es, eax
2777	*u.pb++ = 0xc0;
2778
2779	#ifdef RT_OS_WINDOWS
2780	*u.pb++ = 0xb8; // mov eax, KernelFS
2781	*u.pu32++ = ASMGetFS();
2782
2783	*u.pb++ = 0x8e; // mov fs, eax
2784	*u.pb++ = 0xe0;
2785	#endif
2786
2787	/* do the call. */
2788	*u.pb++ = 0xe8; // call _VMMR0Entry / StubVMMR0Entry
2789	uFixCall = u;
2790	pPatch->offVMMR0EntryFixup = (uint16_t)(u.pb - &pPatch->auCode[0]);
2791	*u.pu32++ = 0xfffffffb;
2792
2793	*u.pb++ = 0x83; // add esp, 0ch ; cdecl
2794	*u.pb++ = 0xc4;
2795	*u.pb++ = 0x0c;
2796
2797	/* restore selector registers. */
2798	*u.pb++ = 0x07; // pop es
2799	//
2800	*u.pb++ = 0x1f; // pop ds
2801
2802	*u.pb++ = 0x0f; // pop fs
2803	*u.pb++ = 0xa1;
2804
2805	uNotNested = u; // NotNested:
2806	*u.pb++ = 0xcf; // iretd
2807
2808	/* the stub VMMR0Entry. */ // StubVMMR0Entry:
2809	pPatch->offStub = (uint16_t)(u.pb - &pPatch->auCode[0]);
2810	*u.pb++ = 0x33; // xor eax, eax
2811	*u.pb++ = 0xc0;
2812
2813	*u.pb++ = 0x48; // dec eax
2814
2815	*u.pb++ = 0xc3; // ret
2816
2817	/* Fixup the VMMR0Entry call. */
2818	if (pDevExt->pvVMMR0)
2819	*uFixCall.pu32 = (uint32_t)pDevExt->pfnVMMR0EntryInt - (uint32_t)(uFixCall.pu32 + 1);
2820	else
2821	*uFixCall.pu32 = (uint32_t)&pPatch->auCode[pPatch->offStub] - (uint32_t)(uFixCall.pu32 + 1);
2822
2823	/* Fixup the forward / nested far jump. */
2824	if (!pPatch->SavedIdt.u5Type2)
2825	{
2826	*uFixJmpNotNested.pu32++ = (uint32_t)uNotNested.pb;
2827	*uFixJmpNotNested.pu16++ = ASMGetCS();
2828	}
2829	else
2830	{
2831	*uFixJmpNotNested.pu32++ = ((uint32_t)pPatch->SavedIdt.u16OffsetHigh << 16) \| pPatch->SavedIdt.u16OffsetLow;
2832	*uFixJmpNotNested.pu16++ = pPatch->SavedIdt.u16SegSel;
2833	}
2834	#endif /* RT_ARCH_X86 */
2835	Assert(u.pb <= &pPatch->auCode[sizeof(pPatch->auCode)]);
2836	#if 0
2837	/* dump the patch code */
2838	Log2(("patch code: %p\n", &pPatch->auCode[0]));
2839	for (uFixCall.pb = &pPatch->auCode[0]; uFixCall.pb < u.pb; uFixCall.pb++)
2840	Log2(("0x%02x,\n", *uFixCall.pb));
2841	#endif
2842	}
2843
2844	/*
2845	* Install the patch.
2846	*/
2847	supdrvIdtWrite(pPatch->pIdtEntry, &pPatch->ChangedIdt);
2848	AssertMsg(!memcmp((void *)pPatch->pIdtEntry, &pPatch->ChangedIdt, sizeof(pPatch->ChangedIdt)), ("The stupid change code didn't work!!!!!\n"));
2849
2850	/*
2851	* Link in the patch.
2852	*/
2853	pPatch->pNext = pDevExt->pIdtPatches;
2854	pDevExt->pIdtPatches = pPatch;
2855
2856	return pPatch;
2857	}
2858
2859
2860	/**
2861	* Removes the sessions IDT references.
2862	* This will uninstall our IDT patch if we left unreferenced.
2863	*
2864	* @returns VINF_SUCCESS.
2865	* @param pDevExt Device globals.
2866	* @param pSession Session data.
2867	*/
2868	static int supdrvIOCtl_IdtRemoveAll(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession)
2869	{
2870	PSUPDRVPATCHUSAGE pUsage;
2871	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
2872	LogFlow(("supdrvIOCtl_IdtRemoveAll: pSession=%p\n", pSession));
2873
2874	/*
2875	* Take the spinlock.
2876	*/
2877	RTSpinlockAcquireNoInts(pDevExt->Spinlock, &SpinlockTmp);
2878
2879	/*
2880	* Walk usage list, removing patches as their usage count reaches zero.
2881	*/
2882	pUsage = pSession->pPatchUsage;
2883	while (pUsage)
2884	{
2885	if (pUsage->pPatch->cUsage <= pUsage->cUsage)
2886	supdrvIdtRemoveOne(pDevExt, pUsage->pPatch);
2887	else
2888	pUsage->pPatch->cUsage -= pUsage->cUsage;
2889
2890	/* next */
2891	pUsage = pUsage->pNext;
2892	}
2893
2894	/*
2895	* Empty the usage chain and we're done inside the spinlock.
2896	*/
2897	pUsage = pSession->pPatchUsage;
2898	pSession->pPatchUsage = NULL;
2899
2900	RTSpinlockReleaseNoInts(pDevExt->Spinlock, &SpinlockTmp);
2901
2902	/*
2903	* Free usage entries.
2904	*/
2905	while (pUsage)
2906	{
2907	void *pvToFree = pUsage;
2908	pUsage->cUsage = 0;
2909	pUsage->pPatch = NULL;
2910	pUsage = pUsage->pNext;
2911	RTMemFree(pvToFree);
2912	}
2913
2914	return VINF_SUCCESS;
2915	}
2916
2917
2918	/**
2919	* Remove one patch.
2920	*
2921	* Worker for supdrvIOCtl_IdtRemoveAll.
2922	*
2923	* @param pDevExt Device globals.
2924	* @param pPatch Patch entry to remove.
2925	* @remark Caller must own SUPDRVDEVEXT::Spinlock!
2926	*/
2927	static void supdrvIdtRemoveOne(PSUPDRVDEVEXT pDevExt, PSUPDRVPATCH pPatch)
2928	{
2929	LogFlow(("supdrvIdtRemoveOne: pPatch=%p\n", pPatch));
2930
2931	pPatch->cUsage = 0;
2932
2933	/*
2934	* If the IDT entry was changed it have to kick around for ever!
2935	* This will be attempted freed again, perhaps next time we'll succeed :-)
2936	*/
2937	if (memcmp((void *)pPatch->pIdtEntry, &pPatch->ChangedIdt, sizeof(pPatch->ChangedIdt)))
2938	{
2939	AssertMsgFailed(("The hijacked IDT entry has CHANGED!!!\n"));
2940	return;
2941	}
2942
2943	/*
2944	* Unlink it.
2945	*/
2946	if (pDevExt->pIdtPatches != pPatch)
2947	{
2948	PSUPDRVPATCH pPatchPrev = pDevExt->pIdtPatches;
2949	while (pPatchPrev)
2950	{
2951	if (pPatchPrev->pNext == pPatch)
2952	{
2953	pPatchPrev->pNext = pPatch->pNext;
2954	break;
2955	}
2956	pPatchPrev = pPatchPrev->pNext;
2957	}
2958	Assert(!pPatchPrev);
2959	}
2960	else
2961	pDevExt->pIdtPatches = pPatch->pNext;
2962	pPatch->pNext = NULL;
2963
2964
2965	/*
2966	* Verify and restore the IDT.
2967	*/
2968	AssertMsg(!memcmp((void *)pPatch->pIdtEntry, &pPatch->ChangedIdt, sizeof(pPatch->ChangedIdt)), ("The hijacked IDT entry has CHANGED!!!\n"));
2969	supdrvIdtWrite(pPatch->pIdtEntry, &pPatch->SavedIdt);
2970	AssertMsg(!memcmp((void *)pPatch->pIdtEntry, &pPatch->SavedIdt, sizeof(pPatch->SavedIdt)), ("The hijacked IDT entry has CHANGED!!!\n"));
2971
2972	/*
2973	* Put it in the free list.
2974	* (This free list stuff is to calm my paranoia.)
2975	*/
2976	pPatch->pvIdt = NULL;
2977	pPatch->pIdtEntry = NULL;
2978
2979	pPatch->pNext = pDevExt->pIdtPatchesFree;
2980	pDevExt->pIdtPatchesFree = pPatch;
2981	}
2982
2983
2984	/**
2985	* Write to an IDT entry.
2986	*
2987	* @param pvIdtEntry Where to write.
2988	* @param pNewIDTEntry What to write.
2989	*/
2990	static void supdrvIdtWrite(volatile void pvIdtEntry, const SUPDRVIDTE pNewIDTEntry)
2991	{
2992	RTR0UINTREG uCR0;
2993	RTR0UINTREG uFlags;
2994
2995	/*
2996	* On SMP machines (P4 hyperthreading included) we must preform a
2997	* 64-bit locked write when updating the IDT entry.
2998	*
2999	* The F00F bugfix for linux (and probably other OSes) causes
3000	* the IDT to be pointing to an readonly mapping. We get around that
3001	* by temporarily turning of WP. Since we're inside a spinlock at this
3002	* point, interrupts are disabled and there isn't any way the WP bit
3003	* flipping can cause any trouble.
3004	*/
3005
3006	/* Save & Clear interrupt flag; Save & clear WP. */
3007	uFlags = ASMGetFlags();
3008	ASMSetFlags(uFlags & ~(RTR0UINTREG)(1 << 9)); /X86_EFL_IF/
3009	Assert(!(ASMGetFlags() & (1 << 9)));
3010	uCR0 = ASMGetCR0();
3011	ASMSetCR0(uCR0 & ~(RTR0UINTREG)(1 << 16)); /X86_CR0_WP/
3012
3013	/* Update IDT Entry */
3014	#ifdef RT_ARCH_AMD64
3015	ASMAtomicXchgU128((volatile uint128_t )pvIdtEntry, (uint128_t *)(uintptr_t)pNewIDTEntry);
3016	#else
3017	ASMAtomicXchgU64((volatile uint64_t )pvIdtEntry, (uint64_t *)(uintptr_t)pNewIDTEntry);
3018	#endif
3019
3020	/* Restore CR0 & Flags */
3021	ASMSetCR0(uCR0);
3022	ASMSetFlags(uFlags);
3023	}
3024	#endif /* VBOX_WITH_IDT_PATCHING */
3025
3026
3027	/**
3028	* Opens an image. If it's the first time it's opened the call must upload
3029	* the bits using the supdrvIOCtl_LdrLoad() / SUPDRV_IOCTL_LDR_LOAD function.
3030	*
3031	* This is the 1st step of the loading.
3032	*
3033	* @returns IPRT status code.
3034	* @param pDevExt Device globals.
3035	* @param pSession Session data.
3036	* @param pReq The open request.
3037	*/
3038	static int supdrvIOCtl_LdrOpen(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDROPEN pReq)
3039	{
3040	PSUPDRVLDRIMAGE pImage;
3041	unsigned cb;
3042	void *pv;
3043	LogFlow(("supdrvIOCtl_LdrOpen: szName=%s cbImage=%d\n", pReq->u.In.szName, pReq->u.In.cbImage));
3044
3045	/*
3046	* Check if we got an instance of the image already.
3047	*/
3048	RTSemFastMutexRequest(pDevExt->mtxLdr);
3049	for (pImage = pDevExt->pLdrImages; pImage; pImage = pImage->pNext)
3050	{
3051	if (!strcmp(pImage->szName, pReq->u.In.szName))
3052	{
3053	pImage->cUsage++;
3054	pReq->u.Out.pvImageBase = pImage->pvImage;
3055	pReq->u.Out.fNeedsLoading = pImage->uState == SUP_IOCTL_LDR_OPEN;
3056	supdrvLdrAddUsage(pSession, pImage);
3057	RTSemFastMutexRelease(pDevExt->mtxLdr);
3058	return VINF_SUCCESS;
3059	}
3060	}
3061	/* (not found - add it!) */
3062
3063	/*
3064	* Allocate memory.
3065	*/
3066	cb = pReq->u.In.cbImage + sizeof(SUPDRVLDRIMAGE) + 31;
3067	pv = RTMemExecAlloc(cb);
3068	if (!pv)
3069	{
3070	RTSemFastMutexRelease(pDevExt->mtxLdr);
3071	Log(("supdrvIOCtl_LdrOpen: RTMemExecAlloc(%u) failed\n", cb));
3072	return VERR_NO_MEMORY;
3073	}
3074
3075	/*
3076	* Setup and link in the LDR stuff.
3077	*/
3078	pImage = (PSUPDRVLDRIMAGE)pv;
3079	pImage->pvImage = RT_ALIGN_P(pImage + 1, 32);
3080	pImage->cbImage = pReq->u.In.cbImage;
3081	pImage->pfnModuleInit = NULL;
3082	pImage->pfnModuleTerm = NULL;
3083	pImage->uState = SUP_IOCTL_LDR_OPEN;
3084	pImage->cUsage = 1;
3085	strcpy(pImage->szName, pReq->u.In.szName);
3086
3087	pImage->pNext = pDevExt->pLdrImages;
3088	pDevExt->pLdrImages = pImage;
3089
3090	supdrvLdrAddUsage(pSession, pImage);
3091
3092	pReq->u.Out.pvImageBase = pImage->pvImage;
3093	pReq->u.Out.fNeedsLoading = true;
3094	RTSemFastMutexRelease(pDevExt->mtxLdr);
3095	return VINF_SUCCESS;
3096	}
3097
3098
3099	/**
3100	* Loads the image bits.
3101	*
3102	* This is the 2nd step of the loading.
3103	*
3104	* @returns IPRT status code.
3105	* @param pDevExt Device globals.
3106	* @param pSession Session data.
3107	* @param pReq The request.
3108	*/
3109	static int supdrvIOCtl_LdrLoad(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRLOAD pReq)
3110	{
3111	PSUPDRVLDRUSAGE pUsage;
3112	PSUPDRVLDRIMAGE pImage;
3113	int rc;
3114	LogFlow(("supdrvIOCtl_LdrLoad: pvImageBase=%p cbImage=%d\n", pReq->u.In.pvImageBase, pReq->u.In.cbImage));
3115
3116	/*
3117	* Find the ldr image.
3118	*/
3119	RTSemFastMutexRequest(pDevExt->mtxLdr);
3120	pUsage = pSession->pLdrUsage;
3121	while (pUsage && pUsage->pImage->pvImage != pReq->u.In.pvImageBase)
3122	pUsage = pUsage->pNext;
3123	if (!pUsage)
3124	{
3125	RTSemFastMutexRelease(pDevExt->mtxLdr);
3126	Log(("SUP_IOCTL_LDR_LOAD: couldn't find image!\n"));
3127	return VERR_INVALID_HANDLE;
3128	}
3129	pImage = pUsage->pImage;
3130	if (pImage->cbImage != pReq->u.In.cbImage)
3131	{
3132	RTSemFastMutexRelease(pDevExt->mtxLdr);
3133	Log(("SUP_IOCTL_LDR_LOAD: image size mismatch!! %d(prep) != %d(load)\n", pImage->cbImage, pReq->u.In.cbImage));
3134	return VERR_INVALID_HANDLE;
3135	}
3136	if (pImage->uState != SUP_IOCTL_LDR_OPEN)
3137	{
3138	unsigned uState = pImage->uState;
3139	RTSemFastMutexRelease(pDevExt->mtxLdr);
3140	if (uState != SUP_IOCTL_LDR_LOAD)
3141	AssertMsgFailed(("SUP_IOCTL_LDR_LOAD: invalid image state %d (%#x)!\n", uState, uState));
3142	return SUPDRV_ERR_ALREADY_LOADED;
3143	}
3144	switch (pReq->u.In.eEPType)
3145	{
3146	case SUPLDRLOADEP_NOTHING:
3147	break;
3148	case SUPLDRLOADEP_VMMR0:
3149	if ( !pReq->u.In.EP.VMMR0.pvVMMR0
3150	\|\| !pReq->u.In.EP.VMMR0.pvVMMR0EntryInt
3151	\|\| !pReq->u.In.EP.VMMR0.pvVMMR0EntryFast
3152	\|\| !pReq->u.In.EP.VMMR0.pvVMMR0EntryEx)
3153	{
3154	RTSemFastMutexRelease(pDevExt->mtxLdr);
3155	Log(("NULL pointer: pvVMMR0=%p pvVMMR0EntryInt=%p pvVMMR0EntryFast=%p pvVMMR0EntryEx=%p!\n",
3156	pReq->u.In.EP.VMMR0.pvVMMR0, pReq->u.In.EP.VMMR0.pvVMMR0EntryInt,
3157	pReq->u.In.EP.VMMR0.pvVMMR0EntryFast, pReq->u.In.EP.VMMR0.pvVMMR0EntryEx));
3158	return VERR_INVALID_PARAMETER;
3159	}
3160	if ( (uintptr_t)pReq->u.In.EP.VMMR0.pvVMMR0EntryInt - (uintptr_t)pImage->pvImage >= pReq->u.In.cbImage
3161	\|\| (uintptr_t)pReq->u.In.EP.VMMR0.pvVMMR0EntryFast - (uintptr_t)pImage->pvImage >= pReq->u.In.cbImage
3162	\|\| (uintptr_t)pReq->u.In.EP.VMMR0.pvVMMR0EntryEx - (uintptr_t)pImage->pvImage >= pReq->u.In.cbImage)
3163	{
3164	RTSemFastMutexRelease(pDevExt->mtxLdr);
3165	Log(("Out of range (%p LB %#x): pvVMMR0EntryInt=%p, pvVMMR0EntryFast=%p or pvVMMR0EntryEx=%p is NULL!\n",
3166	pImage->pvImage, pReq->u.In.cbImage, pReq->u.In.EP.VMMR0.pvVMMR0EntryInt,
3167	pReq->u.In.EP.VMMR0.pvVMMR0EntryFast, pReq->u.In.EP.VMMR0.pvVMMR0EntryEx));
3168	return VERR_INVALID_PARAMETER;
3169	}
3170	break;
3171	default:
3172	RTSemFastMutexRelease(pDevExt->mtxLdr);
3173	Log(("Invalid eEPType=%d\n", pReq->u.In.eEPType));
3174	return VERR_INVALID_PARAMETER;
3175	}
3176	if ( pReq->u.In.pfnModuleInit
3177	&& (uintptr_t)pReq->u.In.pfnModuleInit - (uintptr_t)pImage->pvImage >= pReq->u.In.cbImage)
3178	{
3179	RTSemFastMutexRelease(pDevExt->mtxLdr);
3180	Log(("SUP_IOCTL_LDR_LOAD: pfnModuleInit=%p is outside the image (%p %d bytes)\n",
3181	pReq->u.In.pfnModuleInit, pImage->pvImage, pReq->u.In.cbImage));
3182	return VERR_INVALID_PARAMETER;
3183	}
3184	if ( pReq->u.In.pfnModuleTerm
3185	&& (uintptr_t)pReq->u.In.pfnModuleTerm - (uintptr_t)pImage->pvImage >= pReq->u.In.cbImage)
3186	{
3187	RTSemFastMutexRelease(pDevExt->mtxLdr);
3188	Log(("SUP_IOCTL_LDR_LOAD: pfnModuleTerm=%p is outside the image (%p %d bytes)\n",
3189	pReq->u.In.pfnModuleTerm, pImage->pvImage, pReq->u.In.cbImage));
3190	return VERR_INVALID_PARAMETER;
3191	}
3192
3193	/*
3194	* Copy the memory.
3195	*/
3196	/* no need to do try/except as this is a buffered request. */
3197	memcpy(pImage->pvImage, &pReq->u.In.achImage[0], pImage->cbImage);
3198	pImage->uState = SUP_IOCTL_LDR_LOAD;
3199	pImage->pfnModuleInit = pReq->u.In.pfnModuleInit;
3200	pImage->pfnModuleTerm = pReq->u.In.pfnModuleTerm;
3201	pImage->offSymbols = pReq->u.In.offSymbols;
3202	pImage->cSymbols = pReq->u.In.cSymbols;
3203	pImage->offStrTab = pReq->u.In.offStrTab;
3204	pImage->cbStrTab = pReq->u.In.cbStrTab;
3205
3206	/*
3207	* Update any entry points.
3208	*/
3209	switch (pReq->u.In.eEPType)
3210	{
3211	default:
3212	case SUPLDRLOADEP_NOTHING:
3213	rc = VINF_SUCCESS;
3214	break;
3215	case SUPLDRLOADEP_VMMR0:
3216	rc = supdrvLdrSetR0EP(pDevExt, pReq->u.In.EP.VMMR0.pvVMMR0, pReq->u.In.EP.VMMR0.pvVMMR0EntryInt,
3217	pReq->u.In.EP.VMMR0.pvVMMR0EntryFast, pReq->u.In.EP.VMMR0.pvVMMR0EntryEx);
3218	break;
3219	}
3220
3221	/*
3222	* On success call the module initialization.
3223	*/
3224	LogFlow(("supdrvIOCtl_LdrLoad: pfnModuleInit=%p\n", pImage->pfnModuleInit));
3225	if (RT_SUCCESS(rc) && pImage->pfnModuleInit)
3226	{
3227	Log(("supdrvIOCtl_LdrLoad: calling pfnModuleInit=%p\n", pImage->pfnModuleInit));
3228	rc = pImage->pfnModuleInit();
3229	if (rc && pDevExt->pvVMMR0 == pImage->pvImage)
3230	supdrvLdrUnsetR0EP(pDevExt);
3231	}
3232
3233	if (rc)
3234	pImage->uState = SUP_IOCTL_LDR_OPEN;
3235
3236	RTSemFastMutexRelease(pDevExt->mtxLdr);
3237	return rc;
3238	}
3239
3240
3241	/**
3242	* Frees a previously loaded (prep'ed) image.
3243	*
3244	* @returns IPRT status code.
3245	* @param pDevExt Device globals.
3246	* @param pSession Session data.
3247	* @param pReq The request.
3248	*/
3249	static int supdrvIOCtl_LdrFree(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRFREE pReq)
3250	{
3251	int rc;
3252	PSUPDRVLDRUSAGE pUsagePrev;
3253	PSUPDRVLDRUSAGE pUsage;
3254	PSUPDRVLDRIMAGE pImage;
3255	LogFlow(("supdrvIOCtl_LdrFree: pvImageBase=%p\n", pReq->u.In.pvImageBase));
3256
3257	/*
3258	* Find the ldr image.
3259	*/
3260	RTSemFastMutexRequest(pDevExt->mtxLdr);
3261	pUsagePrev = NULL;
3262	pUsage = pSession->pLdrUsage;
3263	while (pUsage && pUsage->pImage->pvImage != pReq->u.In.pvImageBase)
3264	{
3265	pUsagePrev = pUsage;
3266	pUsage = pUsage->pNext;
3267	}
3268	if (!pUsage)
3269	{
3270	RTSemFastMutexRelease(pDevExt->mtxLdr);
3271	Log(("SUP_IOCTL_LDR_FREE: couldn't find image!\n"));
3272	return VERR_INVALID_HANDLE;
3273	}
3274
3275	/*
3276	* Check if we can remove anything.
3277	*/
3278	rc = VINF_SUCCESS;
3279	pImage = pUsage->pImage;
3280	if (pImage->cUsage <= 1 \|\| pUsage->cUsage <= 1)
3281	{
3282	/*
3283	* Check if there are any objects with destructors in the image, if
3284	* so leave it for the session cleanup routine so we get a chance to
3285	* clean things up in the right order and not leave them all dangling.
3286	*/
3287	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
3288	RTSpinlockAcquire(pDevExt->Spinlock, &SpinlockTmp);
3289	if (pImage->cUsage <= 1)
3290	{
3291	PSUPDRVOBJ pObj;
3292	for (pObj = pDevExt->pObjs; pObj; pObj = pObj->pNext)
3293	if (RT_UNLIKELY((uintptr_t)pObj->pfnDestructor - (uintptr_t)pImage->pvImage < pImage->cbImage))
3294	{
3295	rc = VERR_SHARING_VIOLATION; /** @todo VERR_DANGLING_OBJECTS */
3296	break;
3297	}
3298	}
3299	else
3300	{
3301	PSUPDRVUSAGE pGenUsage;
3302	for (pGenUsage = pSession->pUsage; pGenUsage; pGenUsage = pGenUsage->pNext)
3303	if (RT_UNLIKELY((uintptr_t)pGenUsage->pObj->pfnDestructor - (uintptr_t)pImage->pvImage < pImage->cbImage))
3304	{
3305	rc = VERR_SHARING_VIOLATION; /** @todo VERR_DANGLING_OBJECTS */
3306	break;
3307	}
3308	}
3309	RTSpinlockRelease(pDevExt->Spinlock, &SpinlockTmp);
3310	if (rc == VINF_SUCCESS)
3311	{
3312	/* unlink it */
3313	if (pUsagePrev)
3314	pUsagePrev->pNext = pUsage->pNext;
3315	else
3316	pSession->pLdrUsage = pUsage->pNext;
3317
3318	/* free it */
3319	pUsage->pImage = NULL;
3320	pUsage->pNext = NULL;
3321	RTMemFree(pUsage);
3322
3323	/*
3324	* Derefrence the image.
3325	*/
3326	if (pImage->cUsage <= 1)
3327	supdrvLdrFree(pDevExt, pImage);
3328	else
3329	pImage->cUsage--;
3330	}
3331	else
3332	Log(("supdrvIOCtl_LdrFree: Dangling objects in %p/%s!\n", pImage->pvImage, pImage->szName));
3333	}
3334	else
3335	{
3336	/*
3337	* Dereference both image and usage.
3338	*/
3339	pImage->cUsage--;
3340	pUsage->cUsage--;
3341	}
3342
3343	RTSemFastMutexRelease(pDevExt->mtxLdr);
3344	return VINF_SUCCESS;
3345	}
3346
3347
3348	/**
3349	* Gets the address of a symbol in an open image.
3350	*
3351	* @returns 0 on success.
3352	* @returns SUPDRV_ERR_* on failure.
3353	* @param pDevExt Device globals.
3354	* @param pSession Session data.
3355	* @param pReq The request buffer.
3356	*/
3357	static int supdrvIOCtl_LdrGetSymbol(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRGETSYMBOL pReq)
3358	{
3359	PSUPDRVLDRIMAGE pImage;
3360	PSUPDRVLDRUSAGE pUsage;
3361	uint32_t i;
3362	PSUPLDRSYM paSyms;
3363	const char *pchStrings;
3364	const size_t cbSymbol = strlen(pReq->u.In.szSymbol) + 1;
3365	void *pvSymbol = NULL;
3366	int rc = VERR_GENERAL_FAILURE;
3367	Log3(("supdrvIOCtl_LdrGetSymbol: pvImageBase=%p szSymbol=\"%s\"\n", pReq->u.In.pvImageBase, pReq->u.In.szSymbol));
3368
3369	/*
3370	* Find the ldr image.
3371	*/
3372	RTSemFastMutexRequest(pDevExt->mtxLdr);
3373	pUsage = pSession->pLdrUsage;
3374	while (pUsage && pUsage->pImage->pvImage != pReq->u.In.pvImageBase)
3375	pUsage = pUsage->pNext;
3376	if (!pUsage)
3377	{
3378	RTSemFastMutexRelease(pDevExt->mtxLdr);
3379	Log(("SUP_IOCTL_LDR_GET_SYMBOL: couldn't find image!\n"));
3380	return VERR_INVALID_HANDLE;
3381	}
3382	pImage = pUsage->pImage;
3383	if (pImage->uState != SUP_IOCTL_LDR_LOAD)
3384	{
3385	unsigned uState = pImage->uState;
3386	RTSemFastMutexRelease(pDevExt->mtxLdr);
3387	Log(("SUP_IOCTL_LDR_GET_SYMBOL: invalid image state %d (%#x)!\n", uState, uState)); NOREF(uState);
3388	return VERR_ALREADY_LOADED;
3389	}
3390
3391	/*
3392	* Search the symbol string.
3393	*/
3394	pchStrings = (const char )((uint8_t )pImage->pvImage + pImage->offStrTab);
3395	paSyms = (PSUPLDRSYM)((uint8_t *)pImage->pvImage + pImage->offSymbols);
3396	for (i = 0; i < pImage->cSymbols; i++)
3397	{
3398	if ( paSyms[i].offSymbol < pImage->cbImage /* paranoia */
3399	&& paSyms[i].offName + cbSymbol <= pImage->cbStrTab
3400	&& !memcmp(pchStrings + paSyms[i].offName, pReq->u.In.szSymbol, cbSymbol))
3401	{
3402	pvSymbol = (uint8_t *)pImage->pvImage + paSyms[i].offSymbol;
3403	rc = VINF_SUCCESS;
3404	break;
3405	}
3406	}
3407	RTSemFastMutexRelease(pDevExt->mtxLdr);
3408	pReq->u.Out.pvSymbol = pvSymbol;
3409	return rc;
3410	}
3411
3412
3413	/**
3414	* Updates the IDT patches to point to the specified VMM R0 entry
3415	* point (i.e. VMMR0Enter()).
3416	*
3417	* @returns IPRT status code.
3418	* @param pDevExt Device globals.
3419	* @param pSession Session data.
3420	* @param pVMMR0 VMMR0 image handle.
3421	* @param pvVMMR0EntryInt VMMR0EntryInt address.
3422	* @param pvVMMR0EntryFast VMMR0EntryFast address.
3423	* @param pvVMMR0EntryEx VMMR0EntryEx address.
3424	* @remark Caller must own the loader mutex.
3425	*/
3426	static int supdrvLdrSetR0EP(PSUPDRVDEVEXT pDevExt, void pvVMMR0, void pvVMMR0EntryInt, void pvVMMR0EntryFast, void pvVMMR0EntryEx)
3427	{
3428	int rc = VINF_SUCCESS;
3429	LogFlow(("supdrvLdrSetR0EP pvVMMR0=%p pvVMMR0EntryInt=%p\n", pvVMMR0, pvVMMR0EntryInt));
3430
3431
3432	/*
3433	* Check if not yet set.
3434	*/
3435	if (!pDevExt->pvVMMR0)
3436	{
3437	#ifdef VBOX_WITH_IDT_PATCHING
3438	PSUPDRVPATCH pPatch;
3439	#endif
3440
3441	/*
3442	* Set it and update IDT patch code.
3443	*/
3444	pDevExt->pvVMMR0 = pvVMMR0;
3445	pDevExt->pfnVMMR0EntryInt = pvVMMR0EntryInt;
3446	pDevExt->pfnVMMR0EntryFast = pvVMMR0EntryFast;
3447	pDevExt->pfnVMMR0EntryEx = pvVMMR0EntryEx;
3448	#ifdef VBOX_WITH_IDT_PATCHING
3449	for (pPatch = pDevExt->pIdtPatches; pPatch; pPatch = pPatch->pNext)
3450	{
3451	# ifdef RT_ARCH_AMD64
3452	ASMAtomicXchgU64((volatile uint64_t *)&pPatch->auCode[pPatch->offVMMR0EntryFixup], (uint64_t)pvVMMR0);
3453	# else /* RT_ARCH_X86 */
3454	ASMAtomicXchgU32((volatile uint32_t *)&pPatch->auCode[pPatch->offVMMR0EntryFixup],
3455	(uint32_t)pvVMMR0 - (uint32_t)&pPatch->auCode[pPatch->offVMMR0EntryFixup + 4]);
3456	# endif
3457	}
3458	#endif /* VBOX_WITH_IDT_PATCHING */
3459	}
3460	else
3461	{
3462	/*
3463	* Return failure or success depending on whether the values match or not.
3464	*/
3465	if ( pDevExt->pvVMMR0 != pvVMMR0
3466	\|\| (void *)pDevExt->pfnVMMR0EntryInt != pvVMMR0EntryInt
3467	\|\| (void *)pDevExt->pfnVMMR0EntryFast != pvVMMR0EntryFast
3468	\|\| (void *)pDevExt->pfnVMMR0EntryEx != pvVMMR0EntryEx)
3469	{
3470	AssertMsgFailed(("SUP_IOCTL_LDR_SETR0EP: Already set pointing to a different module!\n"));
3471	rc = VERR_INVALID_PARAMETER;
3472	}
3473	}
3474	return rc;
3475	}
3476
3477
3478	/**
3479	* Unsets the R0 entry point installed by supdrvLdrSetR0EP.
3480	*
3481	* @param pDevExt Device globals.
3482	*/
3483	static void supdrvLdrUnsetR0EP(PSUPDRVDEVEXT pDevExt)
3484	{
3485	#ifdef VBOX_WITH_IDT_PATCHING
3486	PSUPDRVPATCH pPatch;
3487	#endif
3488
3489	pDevExt->pvVMMR0 = NULL;
3490	pDevExt->pfnVMMR0EntryInt = NULL;
3491	pDevExt->pfnVMMR0EntryFast = NULL;
3492	pDevExt->pfnVMMR0EntryEx = NULL;
3493
3494	#ifdef VBOX_WITH_IDT_PATCHING
3495	for (pPatch = pDevExt->pIdtPatches; pPatch; pPatch = pPatch->pNext)
3496	{
3497	# ifdef RT_ARCH_AMD64
3498	ASMAtomicXchgU64((volatile uint64_t *)&pPatch->auCode[pPatch->offVMMR0EntryFixup],
3499	(uint64_t)&pPatch->auCode[pPatch->offStub]);
3500	# else /* RT_ARCH_X86 */
3501	ASMAtomicXchgU32((volatile uint32_t *)&pPatch->auCode[pPatch->offVMMR0EntryFixup],
3502	(uint32_t)&pPatch->auCode[pPatch->offStub] - (uint32_t)&pPatch->auCode[pPatch->offVMMR0EntryFixup + 4]);
3503	# endif
3504	}
3505	#endif /* VBOX_WITH_IDT_PATCHING */
3506	}
3507
3508
3509	/**
3510	* Adds a usage reference in the specified session of an image.
3511	*
3512	* @param pSession Session in question.
3513	* @param pImage Image which the session is using.
3514	*/
3515	static void supdrvLdrAddUsage(PSUPDRVSESSION pSession, PSUPDRVLDRIMAGE pImage)
3516	{
3517	PSUPDRVLDRUSAGE pUsage;
3518	LogFlow(("supdrvLdrAddUsage: pImage=%p\n", pImage));
3519
3520	/*
3521	* Referenced it already?
3522	*/
3523	pUsage = pSession->pLdrUsage;
3524	while (pUsage)
3525	{
3526	if (pUsage->pImage == pImage)
3527	{
3528	pUsage->cUsage++;
3529	return;
3530	}
3531	pUsage = pUsage->pNext;
3532	}
3533
3534	/*
3535	* Allocate new usage record.
3536	*/
3537	pUsage = (PSUPDRVLDRUSAGE)RTMemAlloc(sizeof(*pUsage));
3538	Assert(pUsage);
3539	if (pUsage)
3540	{
3541	pUsage->cUsage = 1;
3542	pUsage->pImage = pImage;
3543	pUsage->pNext = pSession->pLdrUsage;
3544	pSession->pLdrUsage = pUsage;
3545	}
3546	/* ignore errors... */
3547	}
3548
3549
3550	/**
3551	* Frees a load image.
3552	*
3553	* @param pDevExt Pointer to device extension.
3554	* @param pImage Pointer to the image we're gonna free.
3555	* This image must exit!
3556	* @remark The caller MUST own SUPDRVDEVEXT::mtxLdr!
3557	*/
3558	static void supdrvLdrFree(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage)
3559	{
3560	PSUPDRVLDRIMAGE pImagePrev;
3561	LogFlow(("supdrvLdrFree: pImage=%p\n", pImage));
3562
3563	/* find it - arg. should've used doubly linked list. */
3564	Assert(pDevExt->pLdrImages);
3565	pImagePrev = NULL;
3566	if (pDevExt->pLdrImages != pImage)
3567	{
3568	pImagePrev = pDevExt->pLdrImages;
3569	while (pImagePrev->pNext != pImage)
3570	pImagePrev = pImagePrev->pNext;
3571	Assert(pImagePrev->pNext == pImage);
3572	}
3573
3574	/* unlink */
3575	if (pImagePrev)
3576	pImagePrev->pNext = pImage->pNext;
3577	else
3578	pDevExt->pLdrImages = pImage->pNext;
3579
3580	/* check if this is VMMR0.r0 and fix the Idt patches if it is. */
3581	if (pDevExt->pvVMMR0 == pImage->pvImage)
3582	supdrvLdrUnsetR0EP(pDevExt);
3583
3584	/* check for objects with destructors in this image. (Shouldn't happen.) */
3585	if (pDevExt->pObjs)
3586	{
3587	unsigned cObjs = 0;
3588	PSUPDRVOBJ pObj;
3589	RTSPINLOCKTMP SpinlockTmp = RTSPINLOCKTMP_INITIALIZER;
3590	RTSpinlockAcquire(pDevExt->Spinlock, &SpinlockTmp);
3591	for (pObj = pDevExt->pObjs; pObj; pObj = pObj->pNext)
3592	if (RT_UNLIKELY((uintptr_t)pObj->pfnDestructor - (uintptr_t)pImage->pvImage < pImage->cbImage))
3593	{
3594	pObj->pfnDestructor = NULL;
3595	cObjs++;
3596	}
3597	RTSpinlockRelease(pDevExt->Spinlock, &SpinlockTmp);
3598	if (cObjs)
3599	OSDBGPRINT(("supdrvLdrFree: Image '%s' has %d dangling objects!\n", pImage->szName, cObjs));
3600	}
3601
3602	/* call termination function if fully loaded. */
3603	if ( pImage->pfnModuleTerm
3604	&& pImage->uState == SUP_IOCTL_LDR_LOAD)
3605	{
3606	LogFlow(("supdrvIOCtl_LdrLoad: calling pfnModuleTerm=%p\n", pImage->pfnModuleTerm));
3607	pImage->pfnModuleTerm();
3608	}
3609
3610	/* free the image */
3611	pImage->cUsage = 0;
3612	pImage->pNext = 0;
3613	pImage->uState = SUP_IOCTL_LDR_FREE;
3614	RTMemExecFree(pImage);
3615	}
3616
3617
3618	/**
3619	* Gets the current paging mode of the CPU and stores in in pOut.
3620	*/
3621	static SUPPAGINGMODE supdrvIOCtl_GetPagingMode(void)
3622	{
3623	SUPPAGINGMODE enmMode;
3624
3625	RTR0UINTREG cr0 = ASMGetCR0();
3626	if ((cr0 & (X86_CR0_PG \| X86_CR0_PE)) != (X86_CR0_PG \| X86_CR0_PE))
3627	enmMode = SUPPAGINGMODE_INVALID;
3628	else
3629	{
3630	RTR0UINTREG cr4 = ASMGetCR4();
3631	uint32_t fNXEPlusLMA = 0;
3632	if (cr4 & X86_CR4_PAE)
3633	{
3634	uint32_t fAmdFeatures = ASMCpuId_EDX(0x80000001);
3635	if (fAmdFeatures & (X86_CPUID_AMD_FEATURE_EDX_NX \| X86_CPUID_AMD_FEATURE_EDX_LONG_MODE))
3636	{
3637	uint64_t efer = ASMRdMsr(MSR_K6_EFER);
3638	if ((fAmdFeatures & X86_CPUID_AMD_FEATURE_EDX_NX) && (efer & MSR_K6_EFER_NXE))
3639	fNXEPlusLMA \|= RT_BIT(0);
3640	if ((fAmdFeatures & X86_CPUID_AMD_FEATURE_EDX_LONG_MODE) && (efer & MSR_K6_EFER_LMA))
3641	fNXEPlusLMA \|= RT_BIT(1);
3642	}
3643	}
3644
3645	switch ((cr4 & (X86_CR4_PAE \| X86_CR4_PGE)) \| fNXEPlusLMA)
3646	{
3647	case 0:
3648	enmMode = SUPPAGINGMODE_32_BIT;
3649	break;
3650
3651	case X86_CR4_PGE:
3652	enmMode = SUPPAGINGMODE_32_BIT_GLOBAL;
3653	break;
3654
3655	case X86_CR4_PAE:
3656	enmMode = SUPPAGINGMODE_PAE;
3657	break;
3658
3659	case X86_CR4_PAE \| RT_BIT(0):
3660	enmMode = SUPPAGINGMODE_PAE_NX;
3661	break;
3662
3663	case X86_CR4_PAE \| X86_CR4_PGE:
3664	enmMode = SUPPAGINGMODE_PAE_GLOBAL;
3665	break;
3666
3667	case X86_CR4_PAE \| X86_CR4_PGE \| RT_BIT(0):
3668	enmMode = SUPPAGINGMODE_PAE_GLOBAL;
3669	break;
3670
3671	case RT_BIT(1) \| X86_CR4_PAE:
3672	enmMode = SUPPAGINGMODE_AMD64;
3673	break;
3674
3675	case RT_BIT(1) \| X86_CR4_PAE \| RT_BIT(0):
3676	enmMode = SUPPAGINGMODE_AMD64_NX;
3677	break;
3678
3679	case RT_BIT(1) \| X86_CR4_PAE \| X86_CR4_PGE:
3680	enmMode = SUPPAGINGMODE_AMD64_GLOBAL;
3681	break;
3682
3683	case RT_BIT(1) \| X86_CR4_PAE \| X86_CR4_PGE \| RT_BIT(0):
3684	enmMode = SUPPAGINGMODE_AMD64_GLOBAL_NX;
3685	break;
3686
3687	default:
3688	AssertMsgFailed(("Cannot happen! cr4=%#x fNXEPlusLMA=%d\n", cr4, fNXEPlusLMA));
3689	enmMode = SUPPAGINGMODE_INVALID;
3690	break;
3691	}
3692	}
3693	return enmMode;
3694	}
3695
3696
3697	#ifdef USE_NEW_OS_INTERFACE_FOR_GIP
3698	/**
3699	* Creates the GIP.
3700	*
3701	* @returns negative errno.
3702	* @param pDevExt Instance data. GIP stuff may be updated.
3703	*/
3704	static int supdrvGipCreate(PSUPDRVDEVEXT pDevExt)
3705	{
3706	PSUPGLOBALINFOPAGE pGip;
3707	RTHCPHYS HCPhysGip;
3708	uint32_t u32SystemResolution;
3709	uint32_t u32Interval;
3710	int rc;
3711
3712	LogFlow(("supdrvGipCreate:\n"));
3713
3714	/* assert order */
3715	Assert(pDevExt->u32SystemTimerGranularityGrant == 0);
3716	Assert(pDevExt->GipMemObj == NIL_RTR0MEMOBJ);
3717	Assert(!pDevExt->pGipTimer);
3718
3719	/*
3720	* Allocate a suitable page with a default kernel mapping.
3721	*/
3722	rc = RTR0MemObjAllocLow(&pDevExt->GipMemObj, PAGE_SIZE, false);
3723	if (RT_FAILURE(rc))
3724	{
3725	OSDBGPRINT(("supdrvGipCreate: failed to allocate the GIP page. rc=%d\n", rc));
3726	return rc;
3727	}
3728	pGip = (PSUPGLOBALINFOPAGE)RTR0MemObjAddress(pDevExt->GipMemObj); AssertPtr(pGip);
3729	HCPhysGip = RTR0MemObjGetPagePhysAddr(pDevExt->GipMemObj, 0); Assert(HCPhysGip != NIL_RTHCPHYS);
3730
3731	/*
3732	* Try bump up the system timer resolution.
3733	* The more interrupts the better...
3734	*/
3735	if ( RT_SUCCESS(RTTimerRequestSystemGranularity( 976563 /* 1024 HZ */, &u32SystemResolution))
3736	\|\| RT_SUCCESS(RTTimerRequestSystemGranularity( 1000000 /* 1000 HZ */, &u32SystemResolution))
3737	\|\| RT_SUCCESS(RTTimerRequestSystemGranularity( 3906250 /* 256 HZ */, &u32SystemResolution))
3738	\|\| RT_SUCCESS(RTTimerRequestSystemGranularity( 4000000 /* 250 HZ */, &u32SystemResolution))
3739	\|\| RT_SUCCESS(RTTimerRequestSystemGranularity( 7812500 /* 128 HZ */, &u32SystemResolution))
3740	\|\| RT_SUCCESS(RTTimerRequestSystemGranularity(10000000 /* 100 HZ */, &u32SystemResolution))
3741	\|\| RT_SUCCESS(RTTimerRequestSystemGranularity(15625000 /* 64 HZ */, &u32SystemResolution))
3742	\|\| RT_SUCCESS(RTTimerRequestSystemGranularity(31250000 /* 32 HZ */, &u32SystemResolution))
3743	)
3744	{
3745	Assert(RTTimerGetSystemGranularity() <= u32SystemResolution);
3746	pDevExt->u32SystemTimerGranularityGrant = u32SystemResolution;
3747	}
3748
3749	/*
3750	* Find a reasonable update interval, something close to 10ms would be nice,
3751	* and create a recurring timer.
3752	*/
3753	u32Interval = u32SystemResolution = RTTimerGetSystemGranularity();
3754	while (u32Interval < 10000000 /* 10 ms */)
3755	u32Interval += u32SystemResolution;
3756
3757	rc = RTTimerCreateEx(&pDevExt->pGipTimer, u32Interval, 0, supdrvGipTimer, pDevExt);
3758	if (RT_FAILURE(rc))
3759	{
3760	OSDBGPRINT(("supdrvGipCreate: failed create GIP timer at %RU32 ns interval. rc=%d\n", u32Interval, rc));
3761	Assert(!pDevExt->pGipTimer);
3762	supdrvGipDestroy(pDevExt);
3763	return rc;
3764	}
3765
3766	/*
3767	* We're good.
3768	*/
3769	supdrvGipInit(pDevExt, pGip, HCPhysGip, RTTimeSystemNanoTS(), 1000000000 / u32Interval /=Hz/);
3770	return VINF_SUCCESS;
3771	}
3772
3773
3774	/**
3775	* Terminates the GIP.
3776	*
3777	* @param pDevExt Instance data. GIP stuff may be updated.
3778	*/
3779	static void supdrvGipDestroy(PSUPDRVDEVEXT pDevExt)
3780	{
3781	int rc;
3782	#ifdef DEBUG_DARWIN_GIP
3783	OSDBGPRINT(("supdrvGipDestroy: pDevExt=%p pGip=%p pGipTimer=%p GipMemObj=%p\n", pDevExt,
3784	pDevExt->GipMemObj != NIL_RTR0MEMOBJ ? RTR0MemObjAddress(pDevExt->GipMemObj) : NULL,
3785	pDevExt->pGipTimer, pDevExt->GipMemObj));
3786	#endif
3787
3788	/*
3789	* Invalid the GIP data.
3790	*/
3791	if (pDevExt->pGip)
3792	{
3793	supdrvGipTerm(pDevExt->pGip);
3794	pDevExt->pGip = NULL;
3795	}
3796
3797	/*
3798	* Destroy the timer and free the GIP memory object.
3799	*/
3800	if (pDevExt->pGipTimer)
3801	{
3802	rc = RTTimerDestroy(pDevExt->pGipTimer); AssertRC(rc);
3803	pDevExt->pGipTimer = NULL;
3804	}
3805
3806	if (pDevExt->GipMemObj != NIL_RTR0MEMOBJ)
3807	{
3808	rc = RTR0MemObjFree(pDevExt->GipMemObj, true /* free mappings */); AssertRC(rc);
3809	pDevExt->GipMemObj = NIL_RTR0MEMOBJ;
3810	}
3811
3812	/*
3813	* Finally, release the system timer resolution request if one succeeded.
3814	*/
3815	if (pDevExt->u32SystemTimerGranularityGrant)
3816	{
3817	rc = RTTimerReleaseSystemGranularity(pDevExt->u32SystemTimerGranularityGrant); AssertRC(rc);
3818	pDevExt->u32SystemTimerGranularityGrant = 0;
3819	}
3820	}
3821
3822
3823	/**
3824	* Timer callback function.
3825	* @param pTimer The timer.
3826	* @param pvUser The device extension.
3827	*/
3828	static DECLCALLBACK(void) supdrvGipTimer(PRTTIMER pTimer, void *pvUser)
3829	{
3830	PSUPDRVDEVEXT pDevExt = (PSUPDRVDEVEXT)pvUser;
3831	supdrvGipUpdate(pDevExt->pGip, RTTimeSystemNanoTS());
3832	}
3833	#endif /* USE_NEW_OS_INTERFACE_FOR_GIP */
3834
3835
3836	/**
3837	* Initializes the GIP data.
3838	*
3839	* @returns IPRT status code.
3840	* @param pDevExt Pointer to the device instance data.
3841	* @param pGip Pointer to the read-write kernel mapping of the GIP.
3842	* @param HCPhys The physical address of the GIP.
3843	* @param u64NanoTS The current nanosecond timestamp.
3844	* @param uUpdateHz The update freqence.
3845	*/
3846	int VBOXCALL supdrvGipInit(PSUPDRVDEVEXT pDevExt, PSUPGLOBALINFOPAGE pGip, RTHCPHYS HCPhys, uint64_t u64NanoTS, unsigned uUpdateHz)
3847	{
3848	unsigned i;
3849	#ifdef DEBUG_DARWIN_GIP
3850	OSDBGPRINT(("supdrvGipInit: pGip=%p HCPhys=%lx u64NanoTS=%llu uUpdateHz=%d\n", pGip, (long)HCPhys, u64NanoTS, uUpdateHz));
3851	#else
3852	LogFlow(("supdrvGipInit: pGip=%p HCPhys=%lx u64NanoTS=%llu uUpdateHz=%d\n", pGip, (long)HCPhys, u64NanoTS, uUpdateHz));
3853	#endif
3854
3855	/*
3856	* Initialize the structure.
3857	*/
3858	memset(pGip, 0, PAGE_SIZE);
3859	pGip->u32Magic = SUPGLOBALINFOPAGE_MAGIC;
3860	pGip->u32Version = SUPGLOBALINFOPAGE_VERSION;
3861	pGip->u32Mode = supdrvGipDeterminTscMode(pDevExt);
3862	pGip->u32UpdateHz = uUpdateHz;
3863	pGip->u32UpdateIntervalNS = 1000000000 / uUpdateHz;
3864	pGip->u64NanoTSLastUpdateHz = u64NanoTS;
3865
3866	for (i = 0; i < RT_ELEMENTS(pGip->aCPUs); i++)
3867	{
3868	pGip->aCPUs[i].u32TransactionId = 2;
3869	pGip->aCPUs[i].u64NanoTS = u64NanoTS;
3870	pGip->aCPUs[i].u64TSC = ASMReadTSC();
3871
3872	/*
3873	* We don't know the following values until we've executed updates.
3874	* So, we'll just insert very high values.
3875	*/
3876	pGip->aCPUs[i].u64CpuHz = _4G + 1;
3877	pGip->aCPUs[i].u32UpdateIntervalTSC = _2G / 4;
3878	pGip->aCPUs[i].au32TSCHistory[0] = _2G / 4;
3879	pGip->aCPUs[i].au32TSCHistory[1] = _2G / 4;
3880	pGip->aCPUs[i].au32TSCHistory[2] = _2G / 4;
3881	pGip->aCPUs[i].au32TSCHistory[3] = _2G / 4;
3882	pGip->aCPUs[i].au32TSCHistory[4] = _2G / 4;
3883	pGip->aCPUs[i].au32TSCHistory[5] = _2G / 4;
3884	pGip->aCPUs[i].au32TSCHistory[6] = _2G / 4;
3885	pGip->aCPUs[i].au32TSCHistory[7] = _2G / 4;
3886	}
3887
3888	/*
3889	* Link it to the device extension.
3890	*/
3891	pDevExt->pGip = pGip;
3892	pDevExt->HCPhysGip = HCPhys;
3893	pDevExt->cGipUsers = 0;
3894
3895	return VINF_SUCCESS;
3896	}
3897
3898
3899	/**
3900	* Determin the GIP TSC mode.
3901	*
3902	* @returns The most suitable TSC mode.
3903	* @param pDevExt Pointer to the device instance data.
3904	*/
3905	static SUPGIPMODE supdrvGipDeterminTscMode(PSUPDRVDEVEXT pDevExt)
3906	{
3907	#ifndef USE_NEW_OS_INTERFACE_FOR_GIP
3908	/*
3909	* The problem here is that AMD processors with power management features
3910	* may easily end up with different TSCs because the CPUs or even cores
3911	* on the same physical chip run at different frequencies to save power.
3912	*
3913	* It is rumoured that this will be corrected with Barcelona and it's
3914	* expected that this will be indicated by the TscInvariant bit in
3915	* cpuid(0x80000007). So, the "difficult" bit here is to correctly
3916	* identify the older CPUs which don't do different frequency and
3917	* can be relied upon to have somewhat uniform TSC between the cpus.
3918	*/
3919	if (supdrvOSGetCPUCount(pDevExt) > 1)
3920	{
3921	uint32_t uEAX, uEBX, uECX, uEDX;
3922
3923	/* Permit user users override. */
3924	if (supdrvOSGetForcedAsyncTscMode(pDevExt))
3925	return SUPGIPMODE_ASYNC_TSC;
3926
3927	/* Check for "AuthenticAMD" */
3928	ASMCpuId(0, &uEAX, &uEBX, &uECX, &uEDX);
3929	if ( uEAX >= 1
3930	&& uEBX == X86_CPUID_VENDOR_AMD_EBX
3931	&& uECX == X86_CPUID_VENDOR_AMD_ECX
3932	&& uEDX == X86_CPUID_VENDOR_AMD_EDX)
3933	{
3934	/* Check for APM support and that TscInvariant is cleared. */
3935	ASMCpuId(0x80000000, &uEAX, &uEBX, &uECX, &uEDX);
3936	if (uEAX >= 0x80000007)
3937	{
3938	ASMCpuId(0x80000007, &uEAX, &uEBX, &uECX, &uEDX);
3939	if ( !(uEDX & RT_BIT(8))/* TscInvariant */
3940	&& (uEDX & 0x3e)) /* STC\|TM\|THERMTRIP\|VID\|FID. Ignore TS. */
3941	return SUPGIPMODE_ASYNC_TSC;
3942	}
3943	}
3944	}
3945	#endif
3946	return SUPGIPMODE_SYNC_TSC;
3947	}
3948
3949
3950	/**
3951	* Invalidates the GIP data upon termination.
3952	*
3953	* @param pGip Pointer to the read-write kernel mapping of the GIP.
3954	*/
3955	void VBOXCALL supdrvGipTerm(PSUPGLOBALINFOPAGE pGip)
3956	{
3957	unsigned i;
3958	pGip->u32Magic = 0;
3959	for (i = 0; i < RT_ELEMENTS(pGip->aCPUs); i++)
3960	{
3961	pGip->aCPUs[i].u64NanoTS = 0;
3962	pGip->aCPUs[i].u64TSC = 0;
3963	pGip->aCPUs[i].iTSCHistoryHead = 0;
3964	}
3965	}
3966
3967
3968	/**
3969	* Worker routine for supdrvGipUpdate and supdrvGipUpdatePerCpu that
3970	* updates all the per cpu data except the transaction id.
3971	*
3972	* @param pGip The GIP.
3973	* @param pGipCpu Pointer to the per cpu data.
3974	* @param u64NanoTS The current time stamp.
3975	*/
3976	static void supdrvGipDoUpdateCpu(PSUPGLOBALINFOPAGE pGip, PSUPGIPCPU pGipCpu, uint64_t u64NanoTS)
3977	{
3978	uint64_t u64TSC;
3979	uint64_t u64TSCDelta;
3980	uint32_t u32UpdateIntervalTSC;
3981	uint32_t u32UpdateIntervalTSCSlack;
3982	unsigned iTSCHistoryHead;
3983	uint64_t u64CpuHz;
3984
3985	/*
3986	* Update the NanoTS.
3987	*/
3988	ASMAtomicXchgU64(&pGipCpu->u64NanoTS, u64NanoTS);
3989
3990	/*
3991	* Calc TSC delta.
3992	*/
3993	/** @todo validate the NanoTS delta, don't trust the OS to call us when it should... */
3994	u64TSC = ASMReadTSC();
3995	u64TSCDelta = u64TSC - pGipCpu->u64TSC;
3996	ASMAtomicXchgU64(&pGipCpu->u64TSC, u64TSC);
3997
3998	if (u64TSCDelta >> 32)
3999	{
4000	u64TSCDelta = pGipCpu->u32UpdateIntervalTSC;
4001	pGipCpu->cErrors++;
4002	}
4003
4004	/*
4005	* TSC History.
4006	*/
4007	Assert(ELEMENTS(pGipCpu->au32TSCHistory) == 8);
4008
4009	iTSCHistoryHead = (pGipCpu->iTSCHistoryHead + 1) & 7;
4010	ASMAtomicXchgU32(&pGipCpu->iTSCHistoryHead, iTSCHistoryHead);
4011	ASMAtomicXchgU32(&pGipCpu->au32TSCHistory[iTSCHistoryHead], (uint32_t)u64TSCDelta);
4012
4013	/*
4014	* UpdateIntervalTSC = average of last 8,2,1 intervals depending on update HZ.
4015	*/
4016	if (pGip->u32UpdateHz >= 1000)
4017	{
4018	uint32_t u32;
4019	u32 = pGipCpu->au32TSCHistory[0];
4020	u32 += pGipCpu->au32TSCHistory[1];
4021	u32 += pGipCpu->au32TSCHistory[2];
4022	u32 += pGipCpu->au32TSCHistory[3];
4023	u32 >>= 2;
4024	u32UpdateIntervalTSC = pGipCpu->au32TSCHistory[4];
4025	u32UpdateIntervalTSC += pGipCpu->au32TSCHistory[5];
4026	u32UpdateIntervalTSC += pGipCpu->au32TSCHistory[6];
4027	u32UpdateIntervalTSC += pGipCpu->au32TSCHistory[7];
4028	u32UpdateIntervalTSC >>= 2;
4029	u32UpdateIntervalTSC += u32;
4030	u32UpdateIntervalTSC >>= 1;
4031
4032	/* Value choosen for a 2GHz Athlon64 running linux 2.6.10/11, . */
4033	u32UpdateIntervalTSCSlack = u32UpdateIntervalTSC >> 14;
4034	}
4035	else if (pGip->u32UpdateHz >= 90)
4036	{
4037	u32UpdateIntervalTSC = (uint32_t)u64TSCDelta;
4038	u32UpdateIntervalTSC += pGipCpu->au32TSCHistory[(iTSCHistoryHead - 1) & 7];
4039	u32UpdateIntervalTSC >>= 1;
4040
4041	/* value choosen on a 2GHz thinkpad running windows */
4042	u32UpdateIntervalTSCSlack = u32UpdateIntervalTSC >> 7;
4043	}
4044	else
4045	{
4046	u32UpdateIntervalTSC = (uint32_t)u64TSCDelta;
4047
4048	/* This value hasn't be checked yet.. waiting for OS/2 and 33Hz timers.. :-) */
4049	u32UpdateIntervalTSCSlack = u32UpdateIntervalTSC >> 6;
4050	}
4051	ASMAtomicXchgU32(&pGipCpu->u32UpdateIntervalTSC, u32UpdateIntervalTSC + u32UpdateIntervalTSCSlack);
4052
4053	/*
4054	* CpuHz.
4055	*/
4056	u64CpuHz = ASMMult2xU32RetU64(u32UpdateIntervalTSC, pGip->u32UpdateHz);
4057	ASMAtomicXchgU64(&pGipCpu->u64CpuHz, u64CpuHz);
4058	}
4059
4060
4061	/**
4062	* Updates the GIP.
4063	*
4064	* @param pGip Pointer to the GIP.
4065	* @param u64NanoTS The current nanosecond timesamp.
4066	*/
4067	void VBOXCALL supdrvGipUpdate(PSUPGLOBALINFOPAGE pGip, uint64_t u64NanoTS)
4068	{
4069	/*
4070	* Determin the relevant CPU data.
4071	*/
4072	PSUPGIPCPU pGipCpu;
4073	if (pGip->u32Mode != SUPGIPMODE_ASYNC_TSC)
4074	pGipCpu = &pGip->aCPUs[0];
4075	else
4076	{
4077	unsigned iCpu = ASMGetApicId();
4078	if (RT_LIKELY(iCpu >= RT_ELEMENTS(pGip->aCPUs)))
4079	return;
4080	pGipCpu = &pGip->aCPUs[iCpu];
4081	}
4082
4083	/*
4084	* Start update transaction.
4085	*/
4086	if (!(ASMAtomicIncU32(&pGipCpu->u32TransactionId) & 1))
4087	{
4088	/* this can happen on win32 if we're taking to long and there are more CPUs around. shouldn't happen though. */
4089	AssertMsgFailed(("Invalid transaction id, %#x, not odd!\n", pGipCpu->u32TransactionId));
4090	ASMAtomicIncU32(&pGipCpu->u32TransactionId);
4091	pGipCpu->cErrors++;
4092	return;
4093	}
4094
4095	/*
4096	* Recalc the update frequency every 0x800th time.
4097	*/
4098	if (!(pGipCpu->u32TransactionId & (GIP_UPDATEHZ_RECALC_FREQ * 2 - 2)))
4099	{
4100	if (pGip->u64NanoTSLastUpdateHz)
4101	{
4102	#ifdef RT_ARCH_AMD64 /** @todo fix 64-bit div here to work on x86 linux. */
4103	uint64_t u64Delta = u64NanoTS - pGip->u64NanoTSLastUpdateHz;
4104	uint32_t u32UpdateHz = (uint32_t)((UINT64_C(1000000000) * GIP_UPDATEHZ_RECALC_FREQ) / u64Delta);
4105	if (u32UpdateHz <= 2000 && u32UpdateHz >= 30)
4106	{
4107	ASMAtomicXchgU32(&pGip->u32UpdateHz, u32UpdateHz);
4108	ASMAtomicXchgU32(&pGip->u32UpdateIntervalNS, 1000000000 / u32UpdateHz);
4109	}
4110	#endif
4111	}
4112	ASMAtomicXchgU64(&pGip->u64NanoTSLastUpdateHz, u64NanoTS);
4113	}
4114
4115	/*
4116	* Update the data.
4117	*/
4118	supdrvGipDoUpdateCpu(pGip, pGipCpu, u64NanoTS);
4119
4120	/*
4121	* Complete transaction.
4122	*/
4123	ASMAtomicIncU32(&pGipCpu->u32TransactionId);
4124	}
4125
4126
4127	/**
4128	* Updates the per cpu GIP data for the calling cpu.
4129	*
4130	* @param pGip Pointer to the GIP.
4131	* @param u64NanoTS The current nanosecond timesamp.
4132	* @param iCpu The CPU index.
4133	*/
4134	void VBOXCALL supdrvGipUpdatePerCpu(PSUPGLOBALINFOPAGE pGip, uint64_t u64NanoTS, unsigned iCpu)
4135	{
4136	PSUPGIPCPU pGipCpu;
4137
4138	if (RT_LIKELY(iCpu < RT_ELEMENTS(pGip->aCPUs)))
4139	{
4140	pGipCpu = &pGip->aCPUs[iCpu];
4141
4142	/*
4143	* Start update transaction.
4144	*/
4145	if (!(ASMAtomicIncU32(&pGipCpu->u32TransactionId) & 1))
4146	{
4147	AssertMsgFailed(("Invalid transaction id, %#x, not odd!\n", pGipCpu->u32TransactionId));
4148	ASMAtomicIncU32(&pGipCpu->u32TransactionId);
4149	pGipCpu->cErrors++;
4150	return;
4151	}
4152
4153	/*
4154	* Update the data.
4155	*/
4156	supdrvGipDoUpdateCpu(pGip, pGipCpu, u64NanoTS);
4157
4158	/*
4159	* Complete transaction.
4160	*/
4161	ASMAtomicIncU32(&pGipCpu->u32TransactionId);
4162	}
4163	}
4164
4165
4166	/**
4167	* Callback used by supdrvDetermineAsyncTSC to read the TSC on a CPU.
4168	*
4169	* @param idCpu Ignored.
4170	* @param pvUser1 Where to put the TSC.
4171	* @param pvUser2 Ignored.
4172	*/
4173	static DECLCALLBACK(void) supdrvDetermineAsyncTscWorker(RTCPUID idCpu, void pvUser1, void pvUser2)
4174	{
4175	(uint64_t )pvUser1 = ASMReadTSC();
4176	}
4177
4178
4179	/**
4180	* Determine if Async GIP mode is required because of TSC drift.
4181	*
4182	* When using the default/normal timer code it is essential that the time stamp counter
4183	* (TSC) runs never backwards, that is, a read operation to the counter should return
4184	* a bigger value than any previous read operation. This is guaranteed by the latest
4185	* AMD CPUs and by newer Intel CPUs which never enter the C2 state (P4). In any other
4186	* case we have to choose the asynchronous timer mode.
4187	*
4188	* @param pu64Diff pointer to the determined difference between different cores.
4189	* @return false if the time stamp counters appear to be synchron, true otherwise.
4190	*/
4191	bool VBOXCALL supdrvDetermineAsyncTsc(uint64_t *pu64DiffCores)
4192	{
4193	static uint64_t s_aTsc[8][RTCPUSET_MAX_CPUS];
4194	uint64_t u64Diff, u64DiffMin, u64DiffMax, u64TscLast;
4195	int iSlot, iCpu, cCpus;
4196	bool fBackwards;
4197	RTCPUSET OnlineCpus;
4198	int rc;
4199
4200	*pu64DiffCores = 1;
4201
4202	RTMpGetOnlineSet(&OnlineCpus);
4203	cCpus = RTCpuSetCount(&OnlineCpus);
4204	if (cCpus < 2)
4205	return false;
4206	Assert(cCpus <= RT_ELEMENTS(s_aTsc[0]));
4207
4208	/*
4209	* Collect data from the online CPUs.
4210	*/
4211	for (iSlot = 0; iSlot < RT_ELEMENTS(s_aTsc); iSlot++)
4212	{
4213	RTCPUID iCpuSet = 0;
4214	for (iCpu = 0; iCpu < cCpus; iCpu++)
4215	{
4216	while (!RTCpuSetIsMember(&OnlineCpus, iCpuSet))
4217	iCpuSet++; /* skip offline CPU */
4218	rc = RTMpOnSpecific(RTMpCpuIdFromSetIndex(iCpuSet), supdrvDetermineAsyncTscWorker, &s_aTsc[iSlot][iCpu], NULL);
4219	if (rc == VERR_NOT_SUPPORTED)
4220	return false;
4221	iCpuSet++;
4222	}
4223	}
4224
4225	/*
4226	* Check that the TSC reads are strictly ascending.
4227	*/
4228	fBackwards = false;
4229	u64DiffMin = (uint64_t)~0;
4230	u64TscLast = 0;
4231	for (iSlot = 0; iSlot < RT_ELEMENTS(s_aTsc); iSlot++)
4232	{
4233	uint64_t u64Tsc0 = s_aTsc[iSlot][0];
4234	u64DiffMax = 0;
4235	if (u64Tsc0 <= u64TscLast)
4236	fBackwards = true;
4237	u64TscLast = u64Tsc0;
4238	for (iCpu = 1; iCpu < cCpus; iCpu++)
4239	{
4240	uint64_t u64TscN = s_aTsc[iSlot][iCpu];
4241	if (u64TscN <= u64TscLast)
4242	fBackwards = true;
4243	u64TscLast = u64TscN;
4244
4245	u64Diff = u64TscN > u64Tsc0 ? u64TscN - u64Tsc0 : u64Tsc0 - u64TscN;
4246	if (u64DiffMax < u64Diff)
4247	u64DiffMax = u64Diff;
4248	}
4249	if (u64DiffMin > u64DiffMax)
4250	u64DiffMin = u64DiffMax;
4251	}
4252	/* informational */
4253	*pu64DiffCores = u64DiffMin;
4254
4255	return fBackwards;
4256	}
4257
4258
4259	#ifndef DEBUG /** @todo change #ifndef DEBUG -> #ifdef LOG_ENABLED */
4260	/**
4261	* Stub function for non-debug builds.
4262	*/
4263	RTDECL(PRTLOGGER) RTLogDefaultInstance(void)
4264	{
4265	return NULL;
4266	}
4267
4268	RTDECL(PRTLOGGER) RTLogRelDefaultInstance(void)
4269	{
4270	return NULL;
4271	}
4272
4273	/**
4274	* Stub function for non-debug builds.
4275	*/
4276	RTDECL(int) RTLogSetDefaultInstanceThread(PRTLOGGER pLogger, uintptr_t uKey)
4277	{
4278	return 0;
4279	}
4280
4281	/**
4282	* Stub function for non-debug builds.
4283	*/
4284	RTDECL(void) RTLogLogger(PRTLOGGER pLogger, void pvCallerRet, const char pszFormat, ...)
4285	{
4286	}
4287
4288	/**
4289	* Stub function for non-debug builds.
4290	*/
4291	RTDECL(void) RTLogLoggerEx(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...)
4292	{
4293	}
4294
4295	/**
4296	* Stub function for non-debug builds.
4297	*/
4298	RTDECL(void) RTLogLoggerExV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args)
4299	{
4300	}
4301
4302	/**
4303	* Stub function for non-debug builds.
4304	*/
4305	RTDECL(void) RTLogPrintf(const char *pszFormat, ...)
4306	{
4307	}
4308
4309	/**
4310	* Stub function for non-debug builds.
4311	*/
4312	RTDECL(void) RTLogPrintfV(const char *pszFormat, va_list args)
4313	{
4314	}
4315	#endif /* !DEBUG */
4316

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

source: vbox/trunk/src/VBox/HostDrivers/Support/SUPDRVShared.c@ 9212

Download in other formats: