VirtualBox

source: vbox/trunk/src/VBox/HostDrivers/Support/SUPDrv.cpp@ 71699

Last change on this file since 71699 was 71699, checked in by vboxsync, 7 years ago

SUPDrv,VBoxVMM: Require SSE2 to be present.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 229.5 KB
Line 
1/* $Id: SUPDrv.cpp 71699 2018-04-06 10:45:31Z vboxsync $ */
2/** @file
3 * VBoxDrv - The VirtualBox Support Driver - Common code.
4 */
5
6/*
7 * Copyright (C) 2006-2017 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27
28/*********************************************************************************************************************************
29* Header Files *
30*********************************************************************************************************************************/
31#define LOG_GROUP LOG_GROUP_SUP_DRV
32#define SUPDRV_AGNOSTIC
33#include "SUPDrvInternal.h"
34#ifndef PAGE_SHIFT
35# include <iprt/param.h>
36#endif
37#include <iprt/asm.h>
38#include <iprt/asm-amd64-x86.h>
39#include <iprt/asm-math.h>
40#include <iprt/cpuset.h>
41#if defined(RT_OS_DARWIN) || defined(RT_OS_SOLARIS) || defined(RT_OS_WINDOWS)
42# include <iprt/dbg.h>
43#endif
44#include <iprt/handletable.h>
45#include <iprt/mem.h>
46#include <iprt/mp.h>
47#include <iprt/power.h>
48#include <iprt/process.h>
49#include <iprt/semaphore.h>
50#include <iprt/spinlock.h>
51#include <iprt/thread.h>
52#include <iprt/uuid.h>
53#include <iprt/net.h>
54#include <iprt/crc.h>
55#include <iprt/string.h>
56#include <iprt/timer.h>
57#if defined(RT_OS_DARWIN) || defined(RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
58# include <iprt/rand.h>
59# include <iprt/path.h>
60#endif
61#include <iprt/uint128.h>
62#include <iprt/x86.h>
63
64#include <VBox/param.h>
65#include <VBox/log.h>
66#include <VBox/err.h>
67#include <VBox/vmm/hm_vmx.h>
68
69#if defined(RT_OS_SOLARIS) || defined(RT_OS_DARWIN)
70# include "dtrace/SUPDrv.h"
71#else
72# define VBOXDRV_SESSION_CREATE(pvSession, fUser) do { } while (0)
73# define VBOXDRV_SESSION_CLOSE(pvSession) do { } while (0)
74# define VBOXDRV_IOCTL_ENTRY(pvSession, uIOCtl, pvReqHdr) do { } while (0)
75# define VBOXDRV_IOCTL_RETURN(pvSession, uIOCtl, pvReqHdr, rcRet, rcReq) do { } while (0)
76#endif
77
78/*
79 * Logging assignments:
80 * Log - useful stuff, like failures.
81 * LogFlow - program flow, except the really noisy bits.
82 * Log2 - Cleanup.
83 * Log3 - Loader flow noise.
84 * Log4 - Call VMMR0 flow noise.
85 * Log5 - Native yet-to-be-defined noise.
86 * Log6 - Native ioctl flow noise.
87 *
88 * Logging requires BUILD_TYPE=debug and possibly changes to the logger
89 * instantiation in log-vbox.c(pp).
90 */
91
92
93/*********************************************************************************************************************************
94* Defined Constants And Macros *
95*********************************************************************************************************************************/
96/** @def VBOX_SVN_REV
97 * The makefile should define this if it can. */
98#ifndef VBOX_SVN_REV
99# define VBOX_SVN_REV 0
100#endif
101
102/** @ SUPDRV_CHECK_SMAP_SETUP
103 * SMAP check setup. */
104/** @def SUPDRV_CHECK_SMAP_CHECK
105 * Checks that the AC flag is set if SMAP is enabled. If AC is not set, it
106 * will be logged and @a a_BadExpr is executed. */
107#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX)
108# define SUPDRV_CHECK_SMAP_SETUP() uint32_t const fKernelFeatures = SUPR0GetKernelFeatures()
109# define SUPDRV_CHECK_SMAP_CHECK(a_pDevExt, a_BadExpr) \
110 do { \
111 if (fKernelFeatures & SUPKERNELFEATURES_SMAP) \
112 { \
113 RTCCUINTREG fEfl = ASMGetFlags(); \
114 if (RT_LIKELY(fEfl & X86_EFL_AC)) \
115 { /* likely */ } \
116 else \
117 { \
118 supdrvBadContext(a_pDevExt, "SUPDrv.cpp", __LINE__, "EFLAGS.AC is 0!"); \
119 a_BadExpr; \
120 } \
121 } \
122 } while (0)
123#else
124# define SUPDRV_CHECK_SMAP_SETUP() uint32_t const fKernelFeatures = 0
125# define SUPDRV_CHECK_SMAP_CHECK(a_pDevExt, a_BadExpr) NOREF(fKernelFeatures)
126#endif
127
128
129/*********************************************************************************************************************************
130* Internal Functions *
131*********************************************************************************************************************************/
132static DECLCALLBACK(int) supdrvSessionObjHandleRetain(RTHANDLETABLE hHandleTable, void *pvObj, void *pvCtx, void *pvUser);
133static DECLCALLBACK(void) supdrvSessionObjHandleDelete(RTHANDLETABLE hHandleTable, uint32_t h, void *pvObj, void *pvCtx, void *pvUser);
134static int supdrvMemAdd(PSUPDRVMEMREF pMem, PSUPDRVSESSION pSession);
135static int supdrvMemRelease(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr, SUPDRVMEMREFTYPE eType);
136static int supdrvIOCtl_LdrOpen(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDROPEN pReq);
137static int supdrvIOCtl_LdrLoad(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRLOAD pReq);
138static int supdrvIOCtl_LdrFree(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRFREE pReq);
139static int supdrvIOCtl_LdrLockDown(PSUPDRVDEVEXT pDevExt);
140static int supdrvIOCtl_LdrGetSymbol(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRGETSYMBOL pReq);
141static int supdrvIDC_LdrGetSymbol(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPDRVIDCREQGETSYM pReq);
142static int supdrvLdrSetVMMR0EPs(PSUPDRVDEVEXT pDevExt, void *pvVMMR0, void *pvVMMR0EntryFast, void *pvVMMR0EntryEx);
143static void supdrvLdrUnsetVMMR0EPs(PSUPDRVDEVEXT pDevExt);
144static int supdrvLdrAddUsage(PSUPDRVSESSION pSession, PSUPDRVLDRIMAGE pImage);
145static void supdrvLdrFree(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage);
146DECLINLINE(int) supdrvLdrLock(PSUPDRVDEVEXT pDevExt);
147DECLINLINE(int) supdrvLdrUnlock(PSUPDRVDEVEXT pDevExt);
148static int supdrvIOCtl_CallServiceModule(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPCALLSERVICE pReq);
149static int supdrvIOCtl_LoggerSettings(PSUPLOGGERSETTINGS pReq);
150static int supdrvIOCtl_MsrProber(PSUPDRVDEVEXT pDevExt, PSUPMSRPROBER pReq);
151static int supdrvIOCtl_ResumeSuspendedKbds(void);
152
153
154/*********************************************************************************************************************************
155* Global Variables *
156*********************************************************************************************************************************/
157/**
158 * Array of the R0 SUP API.
159 *
160 * While making changes to these exports, make sure to update the IOC
161 * minor version (SUPDRV_IOC_VERSION).
162 *
163 * @remarks This array is processed by SUPR0-def-pe.sed and SUPR0-def-lx.sed to
164 * produce definition files from which import libraries are generated.
165 * Take care when commenting things and especially with \#ifdef'ing.
166 */
167static SUPFUNC g_aFunctions[] =
168{
169/* SED: START */
170 /* name function */
171 /* Entries with absolute addresses determined at runtime, fixup
172 code makes ugly ASSUMPTIONS about the order here: */
173 { "SUPR0AbsIs64bit", (void *)0 },
174 { "SUPR0Abs64bitKernelCS", (void *)0 },
175 { "SUPR0Abs64bitKernelSS", (void *)0 },
176 { "SUPR0Abs64bitKernelDS", (void *)0 },
177 { "SUPR0AbsKernelCS", (void *)0 },
178 { "SUPR0AbsKernelSS", (void *)0 },
179 { "SUPR0AbsKernelDS", (void *)0 },
180 { "SUPR0AbsKernelES", (void *)0 },
181 { "SUPR0AbsKernelFS", (void *)0 },
182 { "SUPR0AbsKernelGS", (void *)0 },
183 /* Normal function pointers: */
184 { "g_pSUPGlobalInfoPage", (void *)&g_pSUPGlobalInfoPage }, /* SED: DATA */
185 { "SUPGetGIP", (void *)(uintptr_t)SUPGetGIP },
186 { "SUPReadTscWithDelta", (void *)(uintptr_t)SUPReadTscWithDelta },
187 { "SUPGetTscDeltaSlow", (void *)(uintptr_t)SUPGetTscDeltaSlow },
188 { "SUPGetCpuHzFromGipForAsyncMode", (void *)(uintptr_t)SUPGetCpuHzFromGipForAsyncMode },
189 { "SUPIsTscFreqCompatible", (void *)(uintptr_t)SUPIsTscFreqCompatible },
190 { "SUPIsTscFreqCompatibleEx", (void *)(uintptr_t)SUPIsTscFreqCompatibleEx },
191 { "SUPR0BadContext", (void *)(uintptr_t)SUPR0BadContext },
192 { "SUPR0ComponentDeregisterFactory", (void *)(uintptr_t)SUPR0ComponentDeregisterFactory },
193 { "SUPR0ComponentQueryFactory", (void *)(uintptr_t)SUPR0ComponentQueryFactory },
194 { "SUPR0ComponentRegisterFactory", (void *)(uintptr_t)SUPR0ComponentRegisterFactory },
195 { "SUPR0ContAlloc", (void *)(uintptr_t)SUPR0ContAlloc },
196 { "SUPR0ContFree", (void *)(uintptr_t)SUPR0ContFree },
197 { "SUPR0ChangeCR4", (void *)(uintptr_t)SUPR0ChangeCR4 },
198 { "SUPR0EnableVTx", (void *)(uintptr_t)SUPR0EnableVTx },
199 { "SUPR0SuspendVTxOnCpu", (void *)(uintptr_t)SUPR0SuspendVTxOnCpu },
200 { "SUPR0ResumeVTxOnCpu", (void *)(uintptr_t)SUPR0ResumeVTxOnCpu },
201 { "SUPR0GetCurrentGdtRw", (void *)(uintptr_t)SUPR0GetCurrentGdtRw },
202 { "SUPR0GetKernelFeatures", (void *)(uintptr_t)SUPR0GetKernelFeatures },
203 { "SUPR0GetPagingMode", (void *)(uintptr_t)SUPR0GetPagingMode },
204 { "SUPR0GetSvmUsability", (void *)(uintptr_t)SUPR0GetSvmUsability },
205 { "SUPR0GetVmxUsability", (void *)(uintptr_t)SUPR0GetVmxUsability },
206 { "SUPR0GetRawModeUsability", (void *)(uintptr_t)SUPR0GetRawModeUsability },
207 { "SUPR0LockMem", (void *)(uintptr_t)SUPR0LockMem },
208 { "SUPR0LowAlloc", (void *)(uintptr_t)SUPR0LowAlloc },
209 { "SUPR0LowFree", (void *)(uintptr_t)SUPR0LowFree },
210 { "SUPR0MemAlloc", (void *)(uintptr_t)SUPR0MemAlloc },
211 { "SUPR0MemFree", (void *)(uintptr_t)SUPR0MemFree },
212 { "SUPR0MemGetPhys", (void *)(uintptr_t)SUPR0MemGetPhys },
213 { "SUPR0ObjAddRef", (void *)(uintptr_t)SUPR0ObjAddRef },
214 { "SUPR0ObjAddRefEx", (void *)(uintptr_t)SUPR0ObjAddRefEx },
215 { "SUPR0ObjRegister", (void *)(uintptr_t)SUPR0ObjRegister },
216 { "SUPR0ObjRelease", (void *)(uintptr_t)SUPR0ObjRelease },
217 { "SUPR0ObjVerifyAccess", (void *)(uintptr_t)SUPR0ObjVerifyAccess },
218 { "SUPR0PageAllocEx", (void *)(uintptr_t)SUPR0PageAllocEx },
219 { "SUPR0PageFree", (void *)(uintptr_t)SUPR0PageFree },
220 { "SUPR0Printf", (void *)(uintptr_t)SUPR0Printf },
221 { "SUPR0GetSessionGVM", (void *)(uintptr_t)SUPR0GetSessionGVM },
222 { "SUPR0GetSessionVM", (void *)(uintptr_t)SUPR0GetSessionVM },
223 { "SUPR0SetSessionVM", (void *)(uintptr_t)SUPR0SetSessionVM },
224 { "SUPR0TscDeltaMeasureBySetIndex", (void *)(uintptr_t)SUPR0TscDeltaMeasureBySetIndex },
225 { "SUPR0TracerDeregisterDrv", (void *)(uintptr_t)SUPR0TracerDeregisterDrv },
226 { "SUPR0TracerDeregisterImpl", (void *)(uintptr_t)SUPR0TracerDeregisterImpl },
227 { "SUPR0TracerFireProbe", (void *)(uintptr_t)SUPR0TracerFireProbe },
228 { "SUPR0TracerRegisterDrv", (void *)(uintptr_t)SUPR0TracerRegisterDrv },
229 { "SUPR0TracerRegisterImpl", (void *)(uintptr_t)SUPR0TracerRegisterImpl },
230 { "SUPR0TracerRegisterModule", (void *)(uintptr_t)SUPR0TracerRegisterModule },
231 { "SUPR0TracerUmodProbeFire", (void *)(uintptr_t)SUPR0TracerUmodProbeFire },
232 { "SUPR0UnlockMem", (void *)(uintptr_t)SUPR0UnlockMem },
233#ifdef RT_OS_WINDOWS
234 { "SUPR0IoCtlSetupForHandle", (void *)(uintptr_t)SUPR0IoCtlSetupForHandle }, /* only-windows */
235 { "SUPR0IoCtlPerform", (void *)(uintptr_t)SUPR0IoCtlPerform }, /* only-windows */
236 { "SUPR0IoCtlCleanup", (void *)(uintptr_t)SUPR0IoCtlCleanup }, /* only-windows */
237#endif
238 { "SUPSemEventClose", (void *)(uintptr_t)SUPSemEventClose },
239 { "SUPSemEventCreate", (void *)(uintptr_t)SUPSemEventCreate },
240 { "SUPSemEventGetResolution", (void *)(uintptr_t)SUPSemEventGetResolution },
241 { "SUPSemEventMultiClose", (void *)(uintptr_t)SUPSemEventMultiClose },
242 { "SUPSemEventMultiCreate", (void *)(uintptr_t)SUPSemEventMultiCreate },
243 { "SUPSemEventMultiGetResolution", (void *)(uintptr_t)SUPSemEventMultiGetResolution },
244 { "SUPSemEventMultiReset", (void *)(uintptr_t)SUPSemEventMultiReset },
245 { "SUPSemEventMultiSignal", (void *)(uintptr_t)SUPSemEventMultiSignal },
246 { "SUPSemEventMultiWait", (void *)(uintptr_t)SUPSemEventMultiWait },
247 { "SUPSemEventMultiWaitNoResume", (void *)(uintptr_t)SUPSemEventMultiWaitNoResume },
248 { "SUPSemEventMultiWaitNsAbsIntr", (void *)(uintptr_t)SUPSemEventMultiWaitNsAbsIntr },
249 { "SUPSemEventMultiWaitNsRelIntr", (void *)(uintptr_t)SUPSemEventMultiWaitNsRelIntr },
250 { "SUPSemEventSignal", (void *)(uintptr_t)SUPSemEventSignal },
251 { "SUPSemEventWait", (void *)(uintptr_t)SUPSemEventWait },
252 { "SUPSemEventWaitNoResume", (void *)(uintptr_t)SUPSemEventWaitNoResume },
253 { "SUPSemEventWaitNsAbsIntr", (void *)(uintptr_t)SUPSemEventWaitNsAbsIntr },
254 { "SUPSemEventWaitNsRelIntr", (void *)(uintptr_t)SUPSemEventWaitNsRelIntr },
255
256 { "RTAssertAreQuiet", (void *)(uintptr_t)RTAssertAreQuiet },
257 { "RTAssertMayPanic", (void *)(uintptr_t)RTAssertMayPanic },
258 { "RTAssertMsg1", (void *)(uintptr_t)RTAssertMsg1 },
259 { "RTAssertMsg2AddV", (void *)(uintptr_t)RTAssertMsg2AddV },
260 { "RTAssertMsg2V", (void *)(uintptr_t)RTAssertMsg2V },
261 { "RTAssertSetMayPanic", (void *)(uintptr_t)RTAssertSetMayPanic },
262 { "RTAssertSetQuiet", (void *)(uintptr_t)RTAssertSetQuiet },
263 { "RTCrc32", (void *)(uintptr_t)RTCrc32 },
264 { "RTCrc32Finish", (void *)(uintptr_t)RTCrc32Finish },
265 { "RTCrc32Process", (void *)(uintptr_t)RTCrc32Process },
266 { "RTCrc32Start", (void *)(uintptr_t)RTCrc32Start },
267 { "RTErrConvertFromErrno", (void *)(uintptr_t)RTErrConvertFromErrno },
268 { "RTErrConvertToErrno", (void *)(uintptr_t)RTErrConvertToErrno },
269 { "RTHandleTableAllocWithCtx", (void *)(uintptr_t)RTHandleTableAllocWithCtx },
270 { "RTHandleTableCreate", (void *)(uintptr_t)RTHandleTableCreate },
271 { "RTHandleTableCreateEx", (void *)(uintptr_t)RTHandleTableCreateEx },
272 { "RTHandleTableDestroy", (void *)(uintptr_t)RTHandleTableDestroy },
273 { "RTHandleTableFreeWithCtx", (void *)(uintptr_t)RTHandleTableFreeWithCtx },
274 { "RTHandleTableLookupWithCtx", (void *)(uintptr_t)RTHandleTableLookupWithCtx },
275 { "RTLogDefaultInstance", (void *)(uintptr_t)RTLogDefaultInstance },
276 { "RTLogDefaultInstanceEx", (void *)(uintptr_t)RTLogDefaultInstanceEx },
277 { "RTLogGetDefaultInstance", (void *)(uintptr_t)RTLogGetDefaultInstance },
278 { "RTLogGetDefaultInstanceEx", (void *)(uintptr_t)RTLogGetDefaultInstanceEx },
279 { "RTLogLoggerExV", (void *)(uintptr_t)RTLogLoggerExV },
280 { "RTLogPrintfV", (void *)(uintptr_t)RTLogPrintfV },
281 { "RTLogRelGetDefaultInstance", (void *)(uintptr_t)RTLogRelGetDefaultInstance },
282 { "RTLogRelGetDefaultInstanceEx", (void *)(uintptr_t)RTLogRelGetDefaultInstanceEx },
283 { "RTLogSetDefaultInstanceThread", (void *)(uintptr_t)RTLogSetDefaultInstanceThread },
284 { "RTMemAllocExTag", (void *)(uintptr_t)RTMemAllocExTag },
285 { "RTMemAllocTag", (void *)(uintptr_t)RTMemAllocTag },
286 { "RTMemAllocVarTag", (void *)(uintptr_t)RTMemAllocVarTag },
287 { "RTMemAllocZTag", (void *)(uintptr_t)RTMemAllocZTag },
288 { "RTMemAllocZVarTag", (void *)(uintptr_t)RTMemAllocZVarTag },
289 { "RTMemDupExTag", (void *)(uintptr_t)RTMemDupExTag },
290 { "RTMemDupTag", (void *)(uintptr_t)RTMemDupTag },
291 { "RTMemFree", (void *)(uintptr_t)RTMemFree },
292 { "RTMemFreeEx", (void *)(uintptr_t)RTMemFreeEx },
293 { "RTMemReallocTag", (void *)(uintptr_t)RTMemReallocTag },
294 { "RTMpCpuId", (void *)(uintptr_t)RTMpCpuId },
295 { "RTMpCpuIdFromSetIndex", (void *)(uintptr_t)RTMpCpuIdFromSetIndex },
296 { "RTMpCpuIdToSetIndex", (void *)(uintptr_t)RTMpCpuIdToSetIndex },
297 { "RTMpCurSetIndex", (void *)(uintptr_t)RTMpCurSetIndex },
298 { "RTMpCurSetIndexAndId", (void *)(uintptr_t)RTMpCurSetIndexAndId },
299 { "RTMpGetArraySize", (void *)(uintptr_t)RTMpGetArraySize },
300 { "RTMpGetCount", (void *)(uintptr_t)RTMpGetCount },
301 { "RTMpGetMaxCpuId", (void *)(uintptr_t)RTMpGetMaxCpuId },
302 { "RTMpGetOnlineCount", (void *)(uintptr_t)RTMpGetOnlineCount },
303 { "RTMpGetOnlineSet", (void *)(uintptr_t)RTMpGetOnlineSet },
304 { "RTMpGetSet", (void *)(uintptr_t)RTMpGetSet },
305 { "RTMpIsCpuOnline", (void *)(uintptr_t)RTMpIsCpuOnline },
306 { "RTMpIsCpuPossible", (void *)(uintptr_t)RTMpIsCpuPossible },
307 { "RTMpIsCpuWorkPending", (void *)(uintptr_t)RTMpIsCpuWorkPending },
308 { "RTMpNotificationDeregister", (void *)(uintptr_t)RTMpNotificationDeregister },
309 { "RTMpNotificationRegister", (void *)(uintptr_t)RTMpNotificationRegister },
310 { "RTMpOnAll", (void *)(uintptr_t)RTMpOnAll },
311 { "RTMpOnOthers", (void *)(uintptr_t)RTMpOnOthers },
312 { "RTMpOnSpecific", (void *)(uintptr_t)RTMpOnSpecific },
313 { "RTMpPokeCpu", (void *)(uintptr_t)RTMpPokeCpu },
314 { "RTNetIPv4AddDataChecksum", (void *)(uintptr_t)RTNetIPv4AddDataChecksum },
315 { "RTNetIPv4AddTCPChecksum", (void *)(uintptr_t)RTNetIPv4AddTCPChecksum },
316 { "RTNetIPv4AddUDPChecksum", (void *)(uintptr_t)RTNetIPv4AddUDPChecksum },
317 { "RTNetIPv4FinalizeChecksum", (void *)(uintptr_t)RTNetIPv4FinalizeChecksum },
318 { "RTNetIPv4HdrChecksum", (void *)(uintptr_t)RTNetIPv4HdrChecksum },
319 { "RTNetIPv4IsDHCPValid", (void *)(uintptr_t)RTNetIPv4IsDHCPValid },
320 { "RTNetIPv4IsHdrValid", (void *)(uintptr_t)RTNetIPv4IsHdrValid },
321 { "RTNetIPv4IsTCPSizeValid", (void *)(uintptr_t)RTNetIPv4IsTCPSizeValid },
322 { "RTNetIPv4IsTCPValid", (void *)(uintptr_t)RTNetIPv4IsTCPValid },
323 { "RTNetIPv4IsUDPSizeValid", (void *)(uintptr_t)RTNetIPv4IsUDPSizeValid },
324 { "RTNetIPv4IsUDPValid", (void *)(uintptr_t)RTNetIPv4IsUDPValid },
325 { "RTNetIPv4PseudoChecksum", (void *)(uintptr_t)RTNetIPv4PseudoChecksum },
326 { "RTNetIPv4PseudoChecksumBits", (void *)(uintptr_t)RTNetIPv4PseudoChecksumBits },
327 { "RTNetIPv4TCPChecksum", (void *)(uintptr_t)RTNetIPv4TCPChecksum },
328 { "RTNetIPv4UDPChecksum", (void *)(uintptr_t)RTNetIPv4UDPChecksum },
329 { "RTNetIPv6PseudoChecksum", (void *)(uintptr_t)RTNetIPv6PseudoChecksum },
330 { "RTNetIPv6PseudoChecksumBits", (void *)(uintptr_t)RTNetIPv6PseudoChecksumBits },
331 { "RTNetIPv6PseudoChecksumEx", (void *)(uintptr_t)RTNetIPv6PseudoChecksumEx },
332 { "RTNetTCPChecksum", (void *)(uintptr_t)RTNetTCPChecksum },
333 { "RTNetUDPChecksum", (void *)(uintptr_t)RTNetUDPChecksum },
334 { "RTPowerNotificationDeregister", (void *)(uintptr_t)RTPowerNotificationDeregister },
335 { "RTPowerNotificationRegister", (void *)(uintptr_t)RTPowerNotificationRegister },
336 { "RTProcSelf", (void *)(uintptr_t)RTProcSelf },
337 { "RTR0AssertPanicSystem", (void *)(uintptr_t)RTR0AssertPanicSystem },
338#if defined(RT_OS_DARWIN) || defined(RT_OS_SOLARIS) || defined(RT_OS_WINDOWS)
339 { "RTR0DbgKrnlInfoOpen", (void *)(uintptr_t)RTR0DbgKrnlInfoOpen }, /* only-darwin, only-solaris, only-windows */
340 { "RTR0DbgKrnlInfoQueryMember", (void *)(uintptr_t)RTR0DbgKrnlInfoQueryMember }, /* only-darwin, only-solaris, only-windows */
341# if defined(RT_OS_SOLARIS)
342 { "RTR0DbgKrnlInfoQuerySize", (void *)(uintptr_t)RTR0DbgKrnlInfoQuerySize }, /* only-solaris */
343# endif
344 { "RTR0DbgKrnlInfoQuerySymbol", (void *)(uintptr_t)RTR0DbgKrnlInfoQuerySymbol }, /* only-darwin, only-solaris, only-windows */
345 { "RTR0DbgKrnlInfoRelease", (void *)(uintptr_t)RTR0DbgKrnlInfoRelease }, /* only-darwin, only-solaris, only-windows */
346 { "RTR0DbgKrnlInfoRetain", (void *)(uintptr_t)RTR0DbgKrnlInfoRetain }, /* only-darwin, only-solaris, only-windows */
347#endif
348 { "RTR0MemAreKrnlAndUsrDifferent", (void *)(uintptr_t)RTR0MemAreKrnlAndUsrDifferent },
349 { "RTR0MemKernelIsValidAddr", (void *)(uintptr_t)RTR0MemKernelIsValidAddr },
350 { "RTR0MemKernelCopyFrom", (void *)(uintptr_t)RTR0MemKernelCopyFrom },
351 { "RTR0MemKernelCopyTo", (void *)(uintptr_t)RTR0MemKernelCopyTo },
352 { "RTR0MemObjAddress", (void *)(uintptr_t)RTR0MemObjAddress },
353 { "RTR0MemObjAddressR3", (void *)(uintptr_t)RTR0MemObjAddressR3 },
354 { "RTR0MemObjAllocContTag", (void *)(uintptr_t)RTR0MemObjAllocContTag },
355 { "RTR0MemObjAllocLowTag", (void *)(uintptr_t)RTR0MemObjAllocLowTag },
356 { "RTR0MemObjAllocPageTag", (void *)(uintptr_t)RTR0MemObjAllocPageTag },
357 { "RTR0MemObjAllocPhysExTag", (void *)(uintptr_t)RTR0MemObjAllocPhysExTag },
358 { "RTR0MemObjAllocPhysNCTag", (void *)(uintptr_t)RTR0MemObjAllocPhysNCTag },
359 { "RTR0MemObjAllocPhysTag", (void *)(uintptr_t)RTR0MemObjAllocPhysTag },
360 { "RTR0MemObjEnterPhysTag", (void *)(uintptr_t)RTR0MemObjEnterPhysTag },
361 { "RTR0MemObjFree", (void *)(uintptr_t)RTR0MemObjFree },
362 { "RTR0MemObjGetPagePhysAddr", (void *)(uintptr_t)RTR0MemObjGetPagePhysAddr },
363 { "RTR0MemObjIsMapping", (void *)(uintptr_t)RTR0MemObjIsMapping },
364 { "RTR0MemObjLockUserTag", (void *)(uintptr_t)RTR0MemObjLockUserTag },
365 { "RTR0MemObjMapKernelExTag", (void *)(uintptr_t)RTR0MemObjMapKernelExTag },
366 { "RTR0MemObjMapKernelTag", (void *)(uintptr_t)RTR0MemObjMapKernelTag },
367 { "RTR0MemObjMapUserTag", (void *)(uintptr_t)RTR0MemObjMapUserTag },
368 { "RTR0MemObjProtect", (void *)(uintptr_t)RTR0MemObjProtect },
369 { "RTR0MemObjSize", (void *)(uintptr_t)RTR0MemObjSize },
370 { "RTR0MemUserCopyFrom", (void *)(uintptr_t)RTR0MemUserCopyFrom },
371 { "RTR0MemUserCopyTo", (void *)(uintptr_t)RTR0MemUserCopyTo },
372 { "RTR0MemUserIsValidAddr", (void *)(uintptr_t)RTR0MemUserIsValidAddr },
373 { "RTR0ProcHandleSelf", (void *)(uintptr_t)RTR0ProcHandleSelf },
374 { "RTSemEventCreate", (void *)(uintptr_t)RTSemEventCreate },
375 { "RTSemEventDestroy", (void *)(uintptr_t)RTSemEventDestroy },
376 { "RTSemEventGetResolution", (void *)(uintptr_t)RTSemEventGetResolution },
377 { "RTSemEventMultiCreate", (void *)(uintptr_t)RTSemEventMultiCreate },
378 { "RTSemEventMultiDestroy", (void *)(uintptr_t)RTSemEventMultiDestroy },
379 { "RTSemEventMultiGetResolution", (void *)(uintptr_t)RTSemEventMultiGetResolution },
380 { "RTSemEventMultiReset", (void *)(uintptr_t)RTSemEventMultiReset },
381 { "RTSemEventMultiSignal", (void *)(uintptr_t)RTSemEventMultiSignal },
382 { "RTSemEventMultiWait", (void *)(uintptr_t)RTSemEventMultiWait },
383 { "RTSemEventMultiWaitEx", (void *)(uintptr_t)RTSemEventMultiWaitEx },
384 { "RTSemEventMultiWaitExDebug", (void *)(uintptr_t)RTSemEventMultiWaitExDebug },
385 { "RTSemEventMultiWaitNoResume", (void *)(uintptr_t)RTSemEventMultiWaitNoResume },
386 { "RTSemEventSignal", (void *)(uintptr_t)RTSemEventSignal },
387 { "RTSemEventWait", (void *)(uintptr_t)RTSemEventWait },
388 { "RTSemEventWaitEx", (void *)(uintptr_t)RTSemEventWaitEx },
389 { "RTSemEventWaitExDebug", (void *)(uintptr_t)RTSemEventWaitExDebug },
390 { "RTSemEventWaitNoResume", (void *)(uintptr_t)RTSemEventWaitNoResume },
391 { "RTSemFastMutexCreate", (void *)(uintptr_t)RTSemFastMutexCreate },
392 { "RTSemFastMutexDestroy", (void *)(uintptr_t)RTSemFastMutexDestroy },
393 { "RTSemFastMutexRelease", (void *)(uintptr_t)RTSemFastMutexRelease },
394 { "RTSemFastMutexRequest", (void *)(uintptr_t)RTSemFastMutexRequest },
395 { "RTSemMutexCreate", (void *)(uintptr_t)RTSemMutexCreate },
396 { "RTSemMutexDestroy", (void *)(uintptr_t)RTSemMutexDestroy },
397 { "RTSemMutexRelease", (void *)(uintptr_t)RTSemMutexRelease },
398 { "RTSemMutexRequest", (void *)(uintptr_t)RTSemMutexRequest },
399 { "RTSemMutexRequestDebug", (void *)(uintptr_t)RTSemMutexRequestDebug },
400 { "RTSemMutexRequestNoResume", (void *)(uintptr_t)RTSemMutexRequestNoResume },
401 { "RTSemMutexRequestNoResumeDebug", (void *)(uintptr_t)RTSemMutexRequestNoResumeDebug },
402 { "RTSpinlockAcquire", (void *)(uintptr_t)RTSpinlockAcquire },
403 { "RTSpinlockCreate", (void *)(uintptr_t)RTSpinlockCreate },
404 { "RTSpinlockDestroy", (void *)(uintptr_t)RTSpinlockDestroy },
405 { "RTSpinlockRelease", (void *)(uintptr_t)RTSpinlockRelease },
406 { "RTStrCopy", (void *)(uintptr_t)RTStrCopy },
407 { "RTStrDupTag", (void *)(uintptr_t)RTStrDupTag },
408 { "RTStrFormat", (void *)(uintptr_t)RTStrFormat },
409 { "RTStrFormatNumber", (void *)(uintptr_t)RTStrFormatNumber },
410 { "RTStrFormatTypeDeregister", (void *)(uintptr_t)RTStrFormatTypeDeregister },
411 { "RTStrFormatTypeRegister", (void *)(uintptr_t)RTStrFormatTypeRegister },
412 { "RTStrFormatTypeSetUser", (void *)(uintptr_t)RTStrFormatTypeSetUser },
413 { "RTStrFormatV", (void *)(uintptr_t)RTStrFormatV },
414 { "RTStrFree", (void *)(uintptr_t)RTStrFree },
415 { "RTStrNCmp", (void *)(uintptr_t)RTStrNCmp },
416 { "RTStrPrintf", (void *)(uintptr_t)RTStrPrintf },
417 { "RTStrPrintfEx", (void *)(uintptr_t)RTStrPrintfEx },
418 { "RTStrPrintfExV", (void *)(uintptr_t)RTStrPrintfExV },
419 { "RTStrPrintfV", (void *)(uintptr_t)RTStrPrintfV },
420 { "RTThreadCreate", (void *)(uintptr_t)RTThreadCreate },
421 { "RTThreadCtxHookIsEnabled", (void *)(uintptr_t)RTThreadCtxHookIsEnabled },
422 { "RTThreadCtxHookCreate", (void *)(uintptr_t)RTThreadCtxHookCreate },
423 { "RTThreadCtxHookDestroy", (void *)(uintptr_t)RTThreadCtxHookDestroy },
424 { "RTThreadCtxHookDisable", (void *)(uintptr_t)RTThreadCtxHookDisable },
425 { "RTThreadCtxHookEnable", (void *)(uintptr_t)RTThreadCtxHookEnable },
426 { "RTThreadGetName", (void *)(uintptr_t)RTThreadGetName },
427 { "RTThreadGetNative", (void *)(uintptr_t)RTThreadGetNative },
428 { "RTThreadGetType", (void *)(uintptr_t)RTThreadGetType },
429 { "RTThreadIsInInterrupt", (void *)(uintptr_t)RTThreadIsInInterrupt },
430 { "RTThreadNativeSelf", (void *)(uintptr_t)RTThreadNativeSelf },
431 { "RTThreadPreemptDisable", (void *)(uintptr_t)RTThreadPreemptDisable },
432 { "RTThreadPreemptIsEnabled", (void *)(uintptr_t)RTThreadPreemptIsEnabled },
433 { "RTThreadPreemptIsPending", (void *)(uintptr_t)RTThreadPreemptIsPending },
434 { "RTThreadPreemptIsPendingTrusty", (void *)(uintptr_t)RTThreadPreemptIsPendingTrusty },
435 { "RTThreadPreemptIsPossible", (void *)(uintptr_t)RTThreadPreemptIsPossible },
436 { "RTThreadPreemptRestore", (void *)(uintptr_t)RTThreadPreemptRestore },
437 { "RTThreadSelf", (void *)(uintptr_t)RTThreadSelf },
438 { "RTThreadSelfName", (void *)(uintptr_t)RTThreadSelfName },
439 { "RTThreadSleep", (void *)(uintptr_t)RTThreadSleep },
440 { "RTThreadUserReset", (void *)(uintptr_t)RTThreadUserReset },
441 { "RTThreadUserSignal", (void *)(uintptr_t)RTThreadUserSignal },
442 { "RTThreadUserWait", (void *)(uintptr_t)RTThreadUserWait },
443 { "RTThreadUserWaitNoResume", (void *)(uintptr_t)RTThreadUserWaitNoResume },
444 { "RTThreadWait", (void *)(uintptr_t)RTThreadWait },
445 { "RTThreadWaitNoResume", (void *)(uintptr_t)RTThreadWaitNoResume },
446 { "RTThreadYield", (void *)(uintptr_t)RTThreadYield },
447 { "RTTimeMilliTS", (void *)(uintptr_t)RTTimeMilliTS },
448 { "RTTimeNanoTS", (void *)(uintptr_t)RTTimeNanoTS },
449 { "RTTimeNow", (void *)(uintptr_t)RTTimeNow },
450 { "RTTimerCanDoHighResolution", (void *)(uintptr_t)RTTimerCanDoHighResolution },
451 { "RTTimerChangeInterval", (void *)(uintptr_t)RTTimerChangeInterval },
452 { "RTTimerCreate", (void *)(uintptr_t)RTTimerCreate },
453 { "RTTimerCreateEx", (void *)(uintptr_t)RTTimerCreateEx },
454 { "RTTimerDestroy", (void *)(uintptr_t)RTTimerDestroy },
455 { "RTTimerGetSystemGranularity", (void *)(uintptr_t)RTTimerGetSystemGranularity },
456 { "RTTimerReleaseSystemGranularity", (void *)(uintptr_t)RTTimerReleaseSystemGranularity },
457 { "RTTimerRequestSystemGranularity", (void *)(uintptr_t)RTTimerRequestSystemGranularity },
458 { "RTTimerStart", (void *)(uintptr_t)RTTimerStart },
459 { "RTTimerStop", (void *)(uintptr_t)RTTimerStop },
460 { "RTTimeSystemMilliTS", (void *)(uintptr_t)RTTimeSystemMilliTS },
461 { "RTTimeSystemNanoTS", (void *)(uintptr_t)RTTimeSystemNanoTS },
462 { "RTUuidCompare", (void *)(uintptr_t)RTUuidCompare },
463 { "RTUuidCompareStr", (void *)(uintptr_t)RTUuidCompareStr },
464 { "RTUuidFromStr", (void *)(uintptr_t)RTUuidFromStr },
465/* SED: END */
466};
467
468#if defined(RT_OS_DARWIN) || defined(RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
469/**
470 * Drag in the rest of IRPT since we share it with the
471 * rest of the kernel modules on darwin.
472 */
473PFNRT g_apfnVBoxDrvIPRTDeps[] =
474{
475 /* VBoxNetAdp */
476 (PFNRT)RTRandBytes,
477 /* VBoxUSB */
478 (PFNRT)RTPathStripFilename,
479 (PFNRT)RTHandleTableAlloc,
480#if !defined(RT_OS_FREEBSD)
481 (PFNRT)RTStrPurgeEncoding,
482#endif
483 NULL
484};
485#endif /* RT_OS_DARWIN || RT_OS_SOLARIS || RT_OS_SOLARIS */
486
487
488/**
489 * Initializes the device extentsion structure.
490 *
491 * @returns IPRT status code.
492 * @param pDevExt The device extension to initialize.
493 * @param cbSession The size of the session structure. The size of
494 * SUPDRVSESSION may be smaller when SUPDRV_AGNOSTIC is
495 * defined because we're skipping the OS specific members
496 * then.
497 */
498int VBOXCALL supdrvInitDevExt(PSUPDRVDEVEXT pDevExt, size_t cbSession)
499{
500 int rc;
501
502#ifdef SUPDRV_WITH_RELEASE_LOGGER
503 /*
504 * Create the release log.
505 */
506 static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
507 PRTLOGGER pRelLogger;
508 rc = RTLogCreate(&pRelLogger, 0 /* fFlags */, "all",
509 "VBOX_RELEASE_LOG", RT_ELEMENTS(s_apszGroups), s_apszGroups, RTLOGDEST_STDOUT | RTLOGDEST_DEBUGGER, NULL);
510 if (RT_SUCCESS(rc))
511 RTLogRelSetDefaultInstance(pRelLogger);
512 /** @todo Add native hook for getting logger config parameters and setting
513 * them. On linux we should use the module parameter stuff... */
514#endif
515
516#if (defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)) && !defined(VBOX_WITH_OLD_CPU_SUPPORT)
517 /*
518 * Require SSE2 to be present.
519 */
520 if (!(ASMCpuId_EDX(1) & X86_CPUID_FEATURE_EDX_SSE2))
521 {
522 SUPR0Printf("vboxdrv: Requires SSE2 (cpuid(0).EDX=%#x)\n", ASMCpuId_EDX(1));
523 return VERR_UNSUPPORTED_CPU;
524 }
525#endif
526
527 /*
528 * Initialize it.
529 */
530 memset(pDevExt, 0, sizeof(*pDevExt)); /* Does not wipe OS specific tail section of the structure. */
531 pDevExt->Spinlock = NIL_RTSPINLOCK;
532 pDevExt->hGipSpinlock = NIL_RTSPINLOCK;
533 pDevExt->hSessionHashTabSpinlock = NIL_RTSPINLOCK;
534#ifdef SUPDRV_USE_MUTEX_FOR_LDR
535 pDevExt->mtxLdr = NIL_RTSEMMUTEX;
536#else
537 pDevExt->mtxLdr = NIL_RTSEMFASTMUTEX;
538#endif
539#ifdef SUPDRV_USE_MUTEX_FOR_GIP
540 pDevExt->mtxGip = NIL_RTSEMMUTEX;
541 pDevExt->mtxTscDelta = NIL_RTSEMMUTEX;
542#else
543 pDevExt->mtxGip = NIL_RTSEMFASTMUTEX;
544 pDevExt->mtxTscDelta = NIL_RTSEMFASTMUTEX;
545#endif
546
547 rc = RTSpinlockCreate(&pDevExt->Spinlock, RTSPINLOCK_FLAGS_INTERRUPT_SAFE, "SUPDrvDevExt");
548 if (RT_SUCCESS(rc))
549 rc = RTSpinlockCreate(&pDevExt->hGipSpinlock, RTSPINLOCK_FLAGS_INTERRUPT_SAFE, "SUPDrvGip");
550 if (RT_SUCCESS(rc))
551 rc = RTSpinlockCreate(&pDevExt->hSessionHashTabSpinlock, RTSPINLOCK_FLAGS_INTERRUPT_SAFE, "SUPDrvSession");
552
553 if (RT_SUCCESS(rc))
554#ifdef SUPDRV_USE_MUTEX_FOR_LDR
555 rc = RTSemMutexCreate(&pDevExt->mtxLdr);
556#else
557 rc = RTSemFastMutexCreate(&pDevExt->mtxLdr);
558#endif
559 if (RT_SUCCESS(rc))
560#ifdef SUPDRV_USE_MUTEX_FOR_GIP
561 rc = RTSemMutexCreate(&pDevExt->mtxTscDelta);
562#else
563 rc = RTSemFastMutexCreate(&pDevExt->mtxTscDelta);
564#endif
565 if (RT_SUCCESS(rc))
566 {
567 rc = RTSemFastMutexCreate(&pDevExt->mtxComponentFactory);
568 if (RT_SUCCESS(rc))
569 {
570#ifdef SUPDRV_USE_MUTEX_FOR_GIP
571 rc = RTSemMutexCreate(&pDevExt->mtxGip);
572#else
573 rc = RTSemFastMutexCreate(&pDevExt->mtxGip);
574#endif
575 if (RT_SUCCESS(rc))
576 {
577 rc = supdrvGipCreate(pDevExt);
578 if (RT_SUCCESS(rc))
579 {
580 rc = supdrvTracerInit(pDevExt);
581 if (RT_SUCCESS(rc))
582 {
583 pDevExt->pLdrInitImage = NULL;
584 pDevExt->hLdrInitThread = NIL_RTNATIVETHREAD;
585 pDevExt->u32Cookie = BIRD; /** @todo make this random? */
586 pDevExt->cbSession = (uint32_t)cbSession;
587
588 /*
589 * Fixup the absolute symbols.
590 *
591 * Because of the table indexing assumptions we'll have a little #ifdef orgy
592 * here rather than distributing this to OS specific files. At least for now.
593 */
594#ifdef RT_OS_DARWIN
595# if ARCH_BITS == 32
596 if (SUPR0GetPagingMode() >= SUPPAGINGMODE_AMD64)
597 {
598 g_aFunctions[0].pfn = (void *)1; /* SUPR0AbsIs64bit */
599 g_aFunctions[1].pfn = (void *)0x80; /* SUPR0Abs64bitKernelCS - KERNEL64_CS, seg.h */
600 g_aFunctions[2].pfn = (void *)0x88; /* SUPR0Abs64bitKernelSS - KERNEL64_SS, seg.h */
601 g_aFunctions[3].pfn = (void *)0x88; /* SUPR0Abs64bitKernelDS - KERNEL64_SS, seg.h */
602 }
603 else
604 g_aFunctions[0].pfn = g_aFunctions[1].pfn = g_aFunctions[2].pfn = g_aFunctions[3].pfn = (void *)0;
605 g_aFunctions[4].pfn = (void *)0x08; /* SUPR0AbsKernelCS - KERNEL_CS, seg.h */
606 g_aFunctions[5].pfn = (void *)0x10; /* SUPR0AbsKernelSS - KERNEL_DS, seg.h */
607 g_aFunctions[6].pfn = (void *)0x10; /* SUPR0AbsKernelDS - KERNEL_DS, seg.h */
608 g_aFunctions[7].pfn = (void *)0x10; /* SUPR0AbsKernelES - KERNEL_DS, seg.h */
609 g_aFunctions[8].pfn = (void *)0x10; /* SUPR0AbsKernelFS - KERNEL_DS, seg.h */
610 g_aFunctions[9].pfn = (void *)0x48; /* SUPR0AbsKernelGS - CPU_DATA_GS, seg.h */
611# else /* 64-bit darwin: */
612 g_aFunctions[0].pfn = (void *)1; /* SUPR0AbsIs64bit */
613 g_aFunctions[1].pfn = (void *)(uintptr_t)ASMGetCS(); /* SUPR0Abs64bitKernelCS */
614 g_aFunctions[2].pfn = (void *)(uintptr_t)ASMGetSS(); /* SUPR0Abs64bitKernelSS */
615 g_aFunctions[3].pfn = (void *)0; /* SUPR0Abs64bitKernelDS */
616 g_aFunctions[4].pfn = (void *)(uintptr_t)ASMGetCS(); /* SUPR0AbsKernelCS */
617 g_aFunctions[5].pfn = (void *)(uintptr_t)ASMGetSS(); /* SUPR0AbsKernelSS */
618 g_aFunctions[6].pfn = (void *)0; /* SUPR0AbsKernelDS */
619 g_aFunctions[7].pfn = (void *)0; /* SUPR0AbsKernelES */
620 g_aFunctions[8].pfn = (void *)0; /* SUPR0AbsKernelFS */
621 g_aFunctions[9].pfn = (void *)0; /* SUPR0AbsKernelGS */
622
623# endif
624#else /* !RT_OS_DARWIN */
625# if ARCH_BITS == 64
626 g_aFunctions[0].pfn = (void *)1; /* SUPR0AbsIs64bit */
627 g_aFunctions[1].pfn = (void *)(uintptr_t)ASMGetCS(); /* SUPR0Abs64bitKernelCS */
628 g_aFunctions[2].pfn = (void *)(uintptr_t)ASMGetSS(); /* SUPR0Abs64bitKernelSS */
629 g_aFunctions[3].pfn = (void *)(uintptr_t)ASMGetDS(); /* SUPR0Abs64bitKernelDS */
630# else
631 g_aFunctions[0].pfn = g_aFunctions[1].pfn = g_aFunctions[2].pfn = g_aFunctions[3].pfn = (void *)0;
632# endif
633 g_aFunctions[4].pfn = (void *)(uintptr_t)ASMGetCS(); /* SUPR0AbsKernelCS */
634 g_aFunctions[5].pfn = (void *)(uintptr_t)ASMGetSS(); /* SUPR0AbsKernelSS */
635 g_aFunctions[6].pfn = (void *)(uintptr_t)ASMGetDS(); /* SUPR0AbsKernelDS */
636 g_aFunctions[7].pfn = (void *)(uintptr_t)ASMGetES(); /* SUPR0AbsKernelES */
637 g_aFunctions[8].pfn = (void *)(uintptr_t)ASMGetFS(); /* SUPR0AbsKernelFS */
638 g_aFunctions[9].pfn = (void *)(uintptr_t)ASMGetGS(); /* SUPR0AbsKernelGS */
639#endif /* !RT_OS_DARWIN */
640 return VINF_SUCCESS;
641 }
642
643 supdrvGipDestroy(pDevExt);
644 }
645
646#ifdef SUPDRV_USE_MUTEX_FOR_GIP
647 RTSemMutexDestroy(pDevExt->mtxGip);
648 pDevExt->mtxGip = NIL_RTSEMMUTEX;
649#else
650 RTSemFastMutexDestroy(pDevExt->mtxGip);
651 pDevExt->mtxGip = NIL_RTSEMFASTMUTEX;
652#endif
653 }
654 RTSemFastMutexDestroy(pDevExt->mtxComponentFactory);
655 pDevExt->mtxComponentFactory = NIL_RTSEMFASTMUTEX;
656 }
657 }
658
659#ifdef SUPDRV_USE_MUTEX_FOR_GIP
660 RTSemMutexDestroy(pDevExt->mtxTscDelta);
661 pDevExt->mtxTscDelta = NIL_RTSEMMUTEX;
662#else
663 RTSemFastMutexDestroy(pDevExt->mtxTscDelta);
664 pDevExt->mtxTscDelta = NIL_RTSEMFASTMUTEX;
665#endif
666#ifdef SUPDRV_USE_MUTEX_FOR_LDR
667 RTSemMutexDestroy(pDevExt->mtxLdr);
668 pDevExt->mtxLdr = NIL_RTSEMMUTEX;
669#else
670 RTSemFastMutexDestroy(pDevExt->mtxLdr);
671 pDevExt->mtxLdr = NIL_RTSEMFASTMUTEX;
672#endif
673 RTSpinlockDestroy(pDevExt->Spinlock);
674 pDevExt->Spinlock = NIL_RTSPINLOCK;
675 RTSpinlockDestroy(pDevExt->hGipSpinlock);
676 pDevExt->hGipSpinlock = NIL_RTSPINLOCK;
677 RTSpinlockDestroy(pDevExt->hSessionHashTabSpinlock);
678 pDevExt->hSessionHashTabSpinlock = NIL_RTSPINLOCK;
679
680#ifdef SUPDRV_WITH_RELEASE_LOGGER
681 RTLogDestroy(RTLogRelSetDefaultInstance(NULL));
682 RTLogDestroy(RTLogSetDefaultInstance(NULL));
683#endif
684
685 return rc;
686}
687
688
689/**
690 * Delete the device extension (e.g. cleanup members).
691 *
692 * @param pDevExt The device extension to delete.
693 */
694void VBOXCALL supdrvDeleteDevExt(PSUPDRVDEVEXT pDevExt)
695{
696 PSUPDRVOBJ pObj;
697 PSUPDRVUSAGE pUsage;
698
699 /*
700 * Kill mutexes and spinlocks.
701 */
702#ifdef SUPDRV_USE_MUTEX_FOR_GIP
703 RTSemMutexDestroy(pDevExt->mtxGip);
704 pDevExt->mtxGip = NIL_RTSEMMUTEX;
705 RTSemMutexDestroy(pDevExt->mtxTscDelta);
706 pDevExt->mtxTscDelta = NIL_RTSEMMUTEX;
707#else
708 RTSemFastMutexDestroy(pDevExt->mtxGip);
709 pDevExt->mtxGip = NIL_RTSEMFASTMUTEX;
710 RTSemFastMutexDestroy(pDevExt->mtxTscDelta);
711 pDevExt->mtxTscDelta = NIL_RTSEMFASTMUTEX;
712#endif
713#ifdef SUPDRV_USE_MUTEX_FOR_LDR
714 RTSemMutexDestroy(pDevExt->mtxLdr);
715 pDevExt->mtxLdr = NIL_RTSEMMUTEX;
716#else
717 RTSemFastMutexDestroy(pDevExt->mtxLdr);
718 pDevExt->mtxLdr = NIL_RTSEMFASTMUTEX;
719#endif
720 RTSpinlockDestroy(pDevExt->Spinlock);
721 pDevExt->Spinlock = NIL_RTSPINLOCK;
722 RTSemFastMutexDestroy(pDevExt->mtxComponentFactory);
723 pDevExt->mtxComponentFactory = NIL_RTSEMFASTMUTEX;
724 RTSpinlockDestroy(pDevExt->hSessionHashTabSpinlock);
725 pDevExt->hSessionHashTabSpinlock = NIL_RTSPINLOCK;
726
727 /*
728 * Free lists.
729 */
730 /* objects. */
731 pObj = pDevExt->pObjs;
732 Assert(!pObj); /* (can trigger on forced unloads) */
733 pDevExt->pObjs = NULL;
734 while (pObj)
735 {
736 void *pvFree = pObj;
737 pObj = pObj->pNext;
738 RTMemFree(pvFree);
739 }
740
741 /* usage records. */
742 pUsage = pDevExt->pUsageFree;
743 pDevExt->pUsageFree = NULL;
744 while (pUsage)
745 {
746 void *pvFree = pUsage;
747 pUsage = pUsage->pNext;
748 RTMemFree(pvFree);
749 }
750
751 /* kill the GIP. */
752 supdrvGipDestroy(pDevExt);
753 RTSpinlockDestroy(pDevExt->hGipSpinlock);
754 pDevExt->hGipSpinlock = NIL_RTSPINLOCK;
755
756 supdrvTracerTerm(pDevExt);
757
758#ifdef SUPDRV_WITH_RELEASE_LOGGER
759 /* destroy the loggers. */
760 RTLogDestroy(RTLogRelSetDefaultInstance(NULL));
761 RTLogDestroy(RTLogSetDefaultInstance(NULL));
762#endif
763}
764
765
766/**
767 * Create session.
768 *
769 * @returns IPRT status code.
770 * @param pDevExt Device extension.
771 * @param fUser Flag indicating whether this is a user or kernel
772 * session.
773 * @param fUnrestricted Unrestricted access (system) or restricted access
774 * (user)?
775 * @param ppSession Where to store the pointer to the session data.
776 */
777int VBOXCALL supdrvCreateSession(PSUPDRVDEVEXT pDevExt, bool fUser, bool fUnrestricted, PSUPDRVSESSION *ppSession)
778{
779 int rc;
780 PSUPDRVSESSION pSession;
781
782 if (!SUP_IS_DEVEXT_VALID(pDevExt))
783 return VERR_INVALID_PARAMETER;
784
785 /*
786 * Allocate memory for the session data.
787 */
788 pSession = *ppSession = (PSUPDRVSESSION)RTMemAllocZ(pDevExt->cbSession);
789 if (pSession)
790 {
791 /* Initialize session data. */
792 rc = RTSpinlockCreate(&pSession->Spinlock, RTSPINLOCK_FLAGS_INTERRUPT_UNSAFE, "SUPDrvSession");
793 if (!rc)
794 {
795 rc = RTHandleTableCreateEx(&pSession->hHandleTable,
796 RTHANDLETABLE_FLAGS_LOCKED_IRQ_SAFE | RTHANDLETABLE_FLAGS_CONTEXT,
797 1 /*uBase*/, 32768 /*cMax*/, supdrvSessionObjHandleRetain, pSession);
798 if (RT_SUCCESS(rc))
799 {
800 Assert(pSession->Spinlock != NIL_RTSPINLOCK);
801 pSession->pDevExt = pDevExt;
802 pSession->u32Cookie = BIRD_INV;
803 pSession->fUnrestricted = fUnrestricted;
804 /*pSession->fInHashTable = false; */
805 pSession->cRefs = 1;
806 /*pSession->pCommonNextHash = NULL;
807 pSession->ppOsSessionPtr = NULL; */
808 if (fUser)
809 {
810 pSession->Process = RTProcSelf();
811 pSession->R0Process = RTR0ProcHandleSelf();
812 }
813 else
814 {
815 pSession->Process = NIL_RTPROCESS;
816 pSession->R0Process = NIL_RTR0PROCESS;
817 }
818 /*pSession->pLdrUsage = NULL;
819 pSession->pVM = NULL;
820 pSession->pUsage = NULL;
821 pSession->pGip = NULL;
822 pSession->fGipReferenced = false;
823 pSession->Bundle.cUsed = 0; */
824 pSession->Uid = NIL_RTUID;
825 pSession->Gid = NIL_RTGID;
826 /*pSession->uTracerData = 0;*/
827 pSession->hTracerCaller = NIL_RTNATIVETHREAD;
828 RTListInit(&pSession->TpProviders);
829 /*pSession->cTpProviders = 0;*/
830 /*pSession->cTpProbesFiring = 0;*/
831 RTListInit(&pSession->TpUmods);
832 /*RT_ZERO(pSession->apTpLookupTable);*/
833
834 VBOXDRV_SESSION_CREATE(pSession, fUser);
835 LogFlow(("Created session %p initial cookie=%#x\n", pSession, pSession->u32Cookie));
836 return VINF_SUCCESS;
837 }
838
839 RTSpinlockDestroy(pSession->Spinlock);
840 }
841 RTMemFree(pSession);
842 *ppSession = NULL;
843 Log(("Failed to create spinlock, rc=%d!\n", rc));
844 }
845 else
846 rc = VERR_NO_MEMORY;
847
848 return rc;
849}
850
851
852/**
853 * Cleans up the session in the context of the process to which it belongs, the
854 * caller will free the session and the session spinlock.
855 *
856 * This should normally occur when the session is closed or as the process
857 * exits. Careful reference counting in the OS specfic code makes sure that
858 * there cannot be any races between process/handle cleanup callbacks and
859 * threads doing I/O control calls.
860 *
861 * @param pDevExt The device extension.
862 * @param pSession Session data.
863 */
864static void supdrvCleanupSession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession)
865{
866 int rc;
867 PSUPDRVBUNDLE pBundle;
868 LogFlow(("supdrvCleanupSession: pSession=%p\n", pSession));
869
870 Assert(!pSession->fInHashTable);
871 Assert(!pSession->ppOsSessionPtr);
872 AssertLogRelMsg(pSession->R0Process == RTR0ProcHandleSelf() || pSession->R0Process == NIL_RTR0PROCESS,
873 ("R0Process=%p cur=%p; curpid=%u\n",
874 pSession->R0Process, RTR0ProcHandleSelf(), RTProcSelf()));
875
876 /*
877 * Remove logger instances related to this session.
878 */
879 RTLogSetDefaultInstanceThread(NULL, (uintptr_t)pSession);
880
881 /*
882 * Destroy the handle table.
883 */
884 rc = RTHandleTableDestroy(pSession->hHandleTable, supdrvSessionObjHandleDelete, pSession);
885 AssertRC(rc);
886 pSession->hHandleTable = NIL_RTHANDLETABLE;
887
888 /*
889 * Release object references made in this session.
890 * In theory there should be noone racing us in this session.
891 */
892 Log2(("release objects - start\n"));
893 if (pSession->pUsage)
894 {
895 PSUPDRVUSAGE pUsage;
896 RTSpinlockAcquire(pDevExt->Spinlock);
897
898 while ((pUsage = pSession->pUsage) != NULL)
899 {
900 PSUPDRVOBJ pObj = pUsage->pObj;
901 pSession->pUsage = pUsage->pNext;
902
903 AssertMsg(pUsage->cUsage >= 1 && pObj->cUsage >= pUsage->cUsage, ("glob %d; sess %d\n", pObj->cUsage, pUsage->cUsage));
904 if (pUsage->cUsage < pObj->cUsage)
905 {
906 pObj->cUsage -= pUsage->cUsage;
907 RTSpinlockRelease(pDevExt->Spinlock);
908 }
909 else
910 {
911 /* Destroy the object and free the record. */
912 if (pDevExt->pObjs == pObj)
913 pDevExt->pObjs = pObj->pNext;
914 else
915 {
916 PSUPDRVOBJ pObjPrev;
917 for (pObjPrev = pDevExt->pObjs; pObjPrev; pObjPrev = pObjPrev->pNext)
918 if (pObjPrev->pNext == pObj)
919 {
920 pObjPrev->pNext = pObj->pNext;
921 break;
922 }
923 Assert(pObjPrev);
924 }
925 RTSpinlockRelease(pDevExt->Spinlock);
926
927 Log(("supdrvCleanupSession: destroying %p/%d (%p/%p) cpid=%RTproc pid=%RTproc dtor=%p\n",
928 pObj, pObj->enmType, pObj->pvUser1, pObj->pvUser2, pObj->CreatorProcess, RTProcSelf(), pObj->pfnDestructor));
929 if (pObj->pfnDestructor)
930 pObj->pfnDestructor(pObj, pObj->pvUser1, pObj->pvUser2);
931 RTMemFree(pObj);
932 }
933
934 /* free it and continue. */
935 RTMemFree(pUsage);
936
937 RTSpinlockAcquire(pDevExt->Spinlock);
938 }
939
940 RTSpinlockRelease(pDevExt->Spinlock);
941 AssertMsg(!pSession->pUsage, ("Some buster reregistered an object during desturction!\n"));
942 }
943 Log2(("release objects - done\n"));
944
945 /*
946 * Make sure the associated VM pointers are NULL.
947 */
948 if (pSession->pSessionGVM || pSession->pSessionVM || pSession->pFastIoCtrlVM)
949 {
950 SUPR0Printf("supdrvCleanupSession: VM not disassociated! pSessionGVM=%p pSessionVM=%p pFastIoCtrlVM=%p\n",
951 pSession->pSessionGVM, pSession->pSessionVM, pSession->pFastIoCtrlVM);
952 pSession->pSessionGVM = NULL;
953 pSession->pSessionVM = NULL;
954 pSession->pFastIoCtrlVM = NULL;
955 }
956
957 /*
958 * Do tracer cleanups related to this session.
959 */
960 Log2(("release tracer stuff - start\n"));
961 supdrvTracerCleanupSession(pDevExt, pSession);
962 Log2(("release tracer stuff - end\n"));
963
964 /*
965 * Release memory allocated in the session.
966 *
967 * We do not serialize this as we assume that the application will
968 * not allocated memory while closing the file handle object.
969 */
970 Log2(("freeing memory:\n"));
971 pBundle = &pSession->Bundle;
972 while (pBundle)
973 {
974 PSUPDRVBUNDLE pToFree;
975 unsigned i;
976
977 /*
978 * Check and unlock all entries in the bundle.
979 */
980 for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
981 {
982 if (pBundle->aMem[i].MemObj != NIL_RTR0MEMOBJ)
983 {
984 Log2(("eType=%d pvR0=%p pvR3=%p cb=%ld\n", pBundle->aMem[i].eType, RTR0MemObjAddress(pBundle->aMem[i].MemObj),
985 (void *)RTR0MemObjAddressR3(pBundle->aMem[i].MapObjR3), (long)RTR0MemObjSize(pBundle->aMem[i].MemObj)));
986 if (pBundle->aMem[i].MapObjR3 != NIL_RTR0MEMOBJ)
987 {
988 rc = RTR0MemObjFree(pBundle->aMem[i].MapObjR3, false);
989 AssertRC(rc); /** @todo figure out how to handle this. */
990 pBundle->aMem[i].MapObjR3 = NIL_RTR0MEMOBJ;
991 }
992 rc = RTR0MemObjFree(pBundle->aMem[i].MemObj, true /* fFreeMappings */);
993 AssertRC(rc); /** @todo figure out how to handle this. */
994 pBundle->aMem[i].MemObj = NIL_RTR0MEMOBJ;
995 pBundle->aMem[i].eType = MEMREF_TYPE_UNUSED;
996 }
997 }
998
999 /*
1000 * Advance and free previous bundle.
1001 */
1002 pToFree = pBundle;
1003 pBundle = pBundle->pNext;
1004
1005 pToFree->pNext = NULL;
1006 pToFree->cUsed = 0;
1007 if (pToFree != &pSession->Bundle)
1008 RTMemFree(pToFree);
1009 }
1010 Log2(("freeing memory - done\n"));
1011
1012 /*
1013 * Deregister component factories.
1014 */
1015 RTSemFastMutexRequest(pDevExt->mtxComponentFactory);
1016 Log2(("deregistering component factories:\n"));
1017 if (pDevExt->pComponentFactoryHead)
1018 {
1019 PSUPDRVFACTORYREG pPrev = NULL;
1020 PSUPDRVFACTORYREG pCur = pDevExt->pComponentFactoryHead;
1021 while (pCur)
1022 {
1023 if (pCur->pSession == pSession)
1024 {
1025 /* unlink it */
1026 PSUPDRVFACTORYREG pNext = pCur->pNext;
1027 if (pPrev)
1028 pPrev->pNext = pNext;
1029 else
1030 pDevExt->pComponentFactoryHead = pNext;
1031
1032 /* free it */
1033 pCur->pNext = NULL;
1034 pCur->pSession = NULL;
1035 pCur->pFactory = NULL;
1036 RTMemFree(pCur);
1037
1038 /* next */
1039 pCur = pNext;
1040 }
1041 else
1042 {
1043 /* next */
1044 pPrev = pCur;
1045 pCur = pCur->pNext;
1046 }
1047 }
1048 }
1049 RTSemFastMutexRelease(pDevExt->mtxComponentFactory);
1050 Log2(("deregistering component factories - done\n"));
1051
1052 /*
1053 * Loaded images needs to be dereferenced and possibly freed up.
1054 */
1055 supdrvLdrLock(pDevExt);
1056 Log2(("freeing images:\n"));
1057 if (pSession->pLdrUsage)
1058 {
1059 PSUPDRVLDRUSAGE pUsage = pSession->pLdrUsage;
1060 pSession->pLdrUsage = NULL;
1061 while (pUsage)
1062 {
1063 void *pvFree = pUsage;
1064 PSUPDRVLDRIMAGE pImage = pUsage->pImage;
1065 if (pImage->cUsage > pUsage->cUsage)
1066 pImage->cUsage -= pUsage->cUsage;
1067 else
1068 supdrvLdrFree(pDevExt, pImage);
1069 pUsage->pImage = NULL;
1070 pUsage = pUsage->pNext;
1071 RTMemFree(pvFree);
1072 }
1073 }
1074 supdrvLdrUnlock(pDevExt);
1075 Log2(("freeing images - done\n"));
1076
1077 /*
1078 * Unmap the GIP.
1079 */
1080 Log2(("umapping GIP:\n"));
1081 if (pSession->GipMapObjR3 != NIL_RTR0MEMOBJ)
1082 {
1083 SUPR0GipUnmap(pSession);
1084 pSession->fGipReferenced = 0;
1085 }
1086 Log2(("umapping GIP - done\n"));
1087}
1088
1089
1090/**
1091 * Common code for freeing a session when the reference count reaches zero.
1092 *
1093 * @param pDevExt Device extension.
1094 * @param pSession Session data.
1095 * This data will be freed by this routine.
1096 */
1097static void supdrvDestroySession(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession)
1098{
1099 VBOXDRV_SESSION_CLOSE(pSession);
1100
1101 /*
1102 * Cleanup the session first.
1103 */
1104 supdrvCleanupSession(pDevExt, pSession);
1105 supdrvOSCleanupSession(pDevExt, pSession);
1106
1107 /*
1108 * Free the rest of the session stuff.
1109 */
1110 RTSpinlockDestroy(pSession->Spinlock);
1111 pSession->Spinlock = NIL_RTSPINLOCK;
1112 pSession->pDevExt = NULL;
1113 RTMemFree(pSession);
1114 LogFlow(("supdrvDestroySession: returns\n"));
1115}
1116
1117
1118/**
1119 * Inserts the session into the global hash table.
1120 *
1121 * @retval VINF_SUCCESS on success.
1122 * @retval VERR_WRONG_ORDER if the session was already inserted (asserted).
1123 * @retval VERR_INVALID_PARAMETER if the session handle is invalid or a ring-0
1124 * session (asserted).
1125 * @retval VERR_DUPLICATE if there is already a session for that pid.
1126 *
1127 * @param pDevExt The device extension.
1128 * @param pSession The session.
1129 * @param ppOsSessionPtr Pointer to the OS session pointer, if any is
1130 * available and used. This will set to point to the
1131 * session while under the protection of the session
1132 * hash table spinlock. It will also be kept in
1133 * PSUPDRVSESSION::ppOsSessionPtr for lookup and
1134 * cleanup use.
1135 * @param pvUser Argument for supdrvOSSessionHashTabInserted.
1136 */
1137int VBOXCALL supdrvSessionHashTabInsert(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPDRVSESSION *ppOsSessionPtr,
1138 void *pvUser)
1139{
1140 PSUPDRVSESSION pCur;
1141 unsigned iHash;
1142
1143 /*
1144 * Validate input.
1145 */
1146 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1147 AssertReturn(pSession->R0Process != NIL_RTR0PROCESS, VERR_INVALID_PARAMETER);
1148
1149 /*
1150 * Calculate the hash table index and acquire the spinlock.
1151 */
1152 iHash = SUPDRV_SESSION_HASH(pSession->Process);
1153
1154 RTSpinlockAcquire(pDevExt->hSessionHashTabSpinlock);
1155
1156 /*
1157 * If there are a collisions, we need to carefully check if we got a
1158 * duplicate. There can only be one open session per process.
1159 */
1160 pCur = pDevExt->apSessionHashTab[iHash];
1161 if (pCur)
1162 {
1163 while (pCur && pCur->Process != pSession->Process)
1164 pCur = pCur->pCommonNextHash;
1165
1166 if (pCur)
1167 {
1168 RTSpinlockRelease(pDevExt->hSessionHashTabSpinlock);
1169 if (pCur == pSession)
1170 {
1171 Assert(pSession->fInHashTable);
1172 AssertFailed();
1173 return VERR_WRONG_ORDER;
1174 }
1175 Assert(!pSession->fInHashTable);
1176 if (pCur->R0Process == pSession->R0Process)
1177 return VERR_RESOURCE_IN_USE;
1178 return VERR_DUPLICATE;
1179 }
1180 }
1181 Assert(!pSession->fInHashTable);
1182 Assert(!pSession->ppOsSessionPtr);
1183
1184 /*
1185 * Insert it, doing a callout to the OS specific code in case it has
1186 * anything it wishes to do while we're holding the spinlock.
1187 */
1188 pSession->pCommonNextHash = pDevExt->apSessionHashTab[iHash];
1189 pDevExt->apSessionHashTab[iHash] = pSession;
1190 pSession->fInHashTable = true;
1191 ASMAtomicIncS32(&pDevExt->cSessions);
1192
1193 pSession->ppOsSessionPtr = ppOsSessionPtr;
1194 if (ppOsSessionPtr)
1195 ASMAtomicWritePtr(ppOsSessionPtr, pSession);
1196
1197 supdrvOSSessionHashTabInserted(pDevExt, pSession, pvUser);
1198
1199 /*
1200 * Retain a reference for the pointer in the session table.
1201 */
1202 ASMAtomicIncU32(&pSession->cRefs);
1203
1204 RTSpinlockRelease(pDevExt->hSessionHashTabSpinlock);
1205 return VINF_SUCCESS;
1206}
1207
1208
1209/**
1210 * Removes the session from the global hash table.
1211 *
1212 * @retval VINF_SUCCESS on success.
1213 * @retval VERR_NOT_FOUND if the session was already removed (asserted).
1214 * @retval VERR_INVALID_PARAMETER if the session handle is invalid or a ring-0
1215 * session (asserted).
1216 *
1217 * @param pDevExt The device extension.
1218 * @param pSession The session. The caller is expected to have a reference
1219 * to this so it won't croak on us when we release the hash
1220 * table reference.
1221 * @param pvUser OS specific context value for the
1222 * supdrvOSSessionHashTabInserted callback.
1223 */
1224int VBOXCALL supdrvSessionHashTabRemove(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, void *pvUser)
1225{
1226 PSUPDRVSESSION pCur;
1227 unsigned iHash;
1228 int32_t cRefs;
1229
1230 /*
1231 * Validate input.
1232 */
1233 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
1234 AssertReturn(pSession->R0Process != NIL_RTR0PROCESS, VERR_INVALID_PARAMETER);
1235
1236 /*
1237 * Calculate the hash table index and acquire the spinlock.
1238 */
1239 iHash = SUPDRV_SESSION_HASH(pSession->Process);
1240
1241 RTSpinlockAcquire(pDevExt->hSessionHashTabSpinlock);
1242
1243 /*
1244 * Unlink it.
1245 */
1246 pCur = pDevExt->apSessionHashTab[iHash];
1247 if (pCur == pSession)
1248 pDevExt->apSessionHashTab[iHash] = pSession->pCommonNextHash;
1249 else
1250 {
1251 PSUPDRVSESSION pPrev = pCur;
1252 while (pCur && pCur != pSession)
1253 {
1254 pPrev = pCur;
1255 pCur = pCur->pCommonNextHash;
1256 }
1257 if (pCur)
1258 pPrev->pCommonNextHash = pCur->pCommonNextHash;
1259 else
1260 {
1261 Assert(!pSession->fInHashTable);
1262 RTSpinlockRelease(pDevExt->hSessionHashTabSpinlock);
1263 return VERR_NOT_FOUND;
1264 }
1265 }
1266
1267 pSession->pCommonNextHash = NULL;
1268 pSession->fInHashTable = false;
1269
1270 ASMAtomicDecS32(&pDevExt->cSessions);
1271
1272 /*
1273 * Clear OS specific session pointer if available and do the OS callback.
1274 */
1275 if (pSession->ppOsSessionPtr)
1276 {
1277 ASMAtomicCmpXchgPtr(pSession->ppOsSessionPtr, NULL, pSession);
1278 pSession->ppOsSessionPtr = NULL;
1279 }
1280
1281 supdrvOSSessionHashTabRemoved(pDevExt, pSession, pvUser);
1282
1283 RTSpinlockRelease(pDevExt->hSessionHashTabSpinlock);
1284
1285 /*
1286 * Drop the reference the hash table had to the session. This shouldn't
1287 * be the last reference!
1288 */
1289 cRefs = ASMAtomicDecU32(&pSession->cRefs);
1290 Assert(cRefs > 0 && cRefs < _1M);
1291 if (cRefs == 0)
1292 supdrvDestroySession(pDevExt, pSession);
1293
1294 return VINF_SUCCESS;
1295}
1296
1297
1298/**
1299 * Looks up the session for the current process in the global hash table or in
1300 * OS specific pointer.
1301 *
1302 * @returns Pointer to the session with a reference that the caller must
1303 * release. If no valid session was found, NULL is returned.
1304 *
1305 * @param pDevExt The device extension.
1306 * @param Process The process ID.
1307 * @param R0Process The ring-0 process handle.
1308 * @param ppOsSessionPtr The OS session pointer if available. If not NULL,
1309 * this is used instead of the hash table. For
1310 * additional safety it must then be equal to the
1311 * SUPDRVSESSION::ppOsSessionPtr member.
1312 * This can be NULL even if the OS has a session
1313 * pointer.
1314 */
1315PSUPDRVSESSION VBOXCALL supdrvSessionHashTabLookup(PSUPDRVDEVEXT pDevExt, RTPROCESS Process, RTR0PROCESS R0Process,
1316 PSUPDRVSESSION *ppOsSessionPtr)
1317{
1318 PSUPDRVSESSION pCur;
1319 unsigned iHash;
1320
1321 /*
1322 * Validate input.
1323 */
1324 AssertReturn(R0Process != NIL_RTR0PROCESS, NULL);
1325
1326 /*
1327 * Calculate the hash table index and acquire the spinlock.
1328 */
1329 iHash = SUPDRV_SESSION_HASH(Process);
1330
1331 RTSpinlockAcquire(pDevExt->hSessionHashTabSpinlock);
1332
1333 /*
1334 * If an OS session pointer is provided, always use it.
1335 */
1336 if (ppOsSessionPtr)
1337 {
1338 pCur = *ppOsSessionPtr;
1339 if ( pCur
1340 && ( pCur->ppOsSessionPtr != ppOsSessionPtr
1341 || pCur->Process != Process
1342 || pCur->R0Process != R0Process) )
1343 pCur = NULL;
1344 }
1345 else
1346 {
1347 /*
1348 * Otherwise, do the hash table lookup.
1349 */
1350 pCur = pDevExt->apSessionHashTab[iHash];
1351 while ( pCur
1352 && ( pCur->Process != Process
1353 || pCur->R0Process != R0Process) )
1354 pCur = pCur->pCommonNextHash;
1355 }
1356
1357 /*
1358 * Retain the session.
1359 */
1360 if (pCur)
1361 {
1362 uint32_t cRefs = ASMAtomicIncU32(&pCur->cRefs);
1363 NOREF(cRefs);
1364 Assert(cRefs > 1 && cRefs < _1M);
1365 }
1366
1367 RTSpinlockRelease(pDevExt->hSessionHashTabSpinlock);
1368
1369 return pCur;
1370}
1371
1372
1373/**
1374 * Retain a session to make sure it doesn't go away while it is in use.
1375 *
1376 * @returns New reference count on success, UINT32_MAX on failure.
1377 * @param pSession Session data.
1378 */
1379uint32_t VBOXCALL supdrvSessionRetain(PSUPDRVSESSION pSession)
1380{
1381 uint32_t cRefs;
1382 AssertPtrReturn(pSession, UINT32_MAX);
1383 AssertReturn(SUP_IS_SESSION_VALID(pSession), UINT32_MAX);
1384
1385 cRefs = ASMAtomicIncU32(&pSession->cRefs);
1386 AssertMsg(cRefs > 1 && cRefs < _1M, ("%#x %p\n", cRefs, pSession));
1387 return cRefs;
1388}
1389
1390
1391/**
1392 * Releases a given session.
1393 *
1394 * @returns New reference count on success (0 if closed), UINT32_MAX on failure.
1395 * @param pSession Session data.
1396 */
1397uint32_t VBOXCALL supdrvSessionRelease(PSUPDRVSESSION pSession)
1398{
1399 uint32_t cRefs;
1400 AssertPtrReturn(pSession, UINT32_MAX);
1401 AssertReturn(SUP_IS_SESSION_VALID(pSession), UINT32_MAX);
1402
1403 cRefs = ASMAtomicDecU32(&pSession->cRefs);
1404 AssertMsg(cRefs < _1M, ("%#x %p\n", cRefs, pSession));
1405 if (cRefs == 0)
1406 supdrvDestroySession(pSession->pDevExt, pSession);
1407 return cRefs;
1408}
1409
1410
1411/**
1412 * RTHandleTableDestroy callback used by supdrvCleanupSession.
1413 *
1414 * @returns IPRT status code, see SUPR0ObjAddRef.
1415 * @param hHandleTable The handle table handle. Ignored.
1416 * @param pvObj The object pointer.
1417 * @param pvCtx Context, the handle type. Ignored.
1418 * @param pvUser Session pointer.
1419 */
1420static DECLCALLBACK(int) supdrvSessionObjHandleRetain(RTHANDLETABLE hHandleTable, void *pvObj, void *pvCtx, void *pvUser)
1421{
1422 NOREF(pvCtx);
1423 NOREF(hHandleTable);
1424 return SUPR0ObjAddRefEx(pvObj, (PSUPDRVSESSION)pvUser, true /*fNoBlocking*/);
1425}
1426
1427
1428/**
1429 * RTHandleTableDestroy callback used by supdrvCleanupSession.
1430 *
1431 * @param hHandleTable The handle table handle. Ignored.
1432 * @param h The handle value. Ignored.
1433 * @param pvObj The object pointer.
1434 * @param pvCtx Context, the handle type. Ignored.
1435 * @param pvUser Session pointer.
1436 */
1437static DECLCALLBACK(void) supdrvSessionObjHandleDelete(RTHANDLETABLE hHandleTable, uint32_t h, void *pvObj, void *pvCtx, void *pvUser)
1438{
1439 NOREF(pvCtx);
1440 NOREF(h);
1441 NOREF(hHandleTable);
1442 SUPR0ObjRelease(pvObj, (PSUPDRVSESSION)pvUser);
1443}
1444
1445
1446/**
1447 * Fast path I/O Control worker.
1448 *
1449 * @returns VBox status code that should be passed down to ring-3 unchanged.
1450 * @param uOperation SUP_VMMR0_DO_XXX (not the I/O control number!).
1451 * @param idCpu VMCPU id.
1452 * @param pDevExt Device extention.
1453 * @param pSession Session data.
1454 */
1455int VBOXCALL supdrvIOCtlFast(uintptr_t uOperation, VMCPUID idCpu, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession)
1456{
1457 /*
1458 * Validate input and check that the VM has a session.
1459 */
1460 if (RT_LIKELY(RT_VALID_PTR(pSession)))
1461 {
1462 PVM pVM = pSession->pSessionVM;
1463 PGVM pGVM = pSession->pSessionGVM;
1464 if (RT_LIKELY( pGVM != NULL
1465 && pVM != NULL
1466 && pVM == pSession->pFastIoCtrlVM))
1467 {
1468 if (RT_LIKELY(pDevExt->pfnVMMR0EntryFast))
1469 {
1470 /*
1471 * Make the call.
1472 */
1473 pDevExt->pfnVMMR0EntryFast(pGVM, pVM, idCpu, uOperation);
1474 return VINF_SUCCESS;
1475 }
1476
1477 SUPR0Printf("supdrvIOCtlFast: pfnVMMR0EntryFast is NULL\n");
1478 }
1479 else
1480 SUPR0Printf("supdrvIOCtlFast: Misconfig session: pGVM=%p pVM=%p pFastIoCtrlVM=%p\n",
1481 pGVM, pVM, pSession->pFastIoCtrlVM);
1482 }
1483 else
1484 SUPR0Printf("supdrvIOCtlFast: Bad session pointer %p\n", pSession);
1485 return VERR_INTERNAL_ERROR;
1486}
1487
1488
1489/**
1490 * Helper for supdrvIOCtl used to validate module names passed to SUP_IOCTL_LDR_OPEN.
1491 *
1492 * Check if pszStr contains any character of pszChars. We would use strpbrk
1493 * here if this function would be contained in the RedHat kABI white list, see
1494 * http://www.kerneldrivers.org/RHEL5.
1495 *
1496 * @returns true if fine, false if not.
1497 * @param pszName The module name to check.
1498 */
1499static bool supdrvIsLdrModuleNameValid(const char *pszName)
1500{
1501 int chCur;
1502 while ((chCur = *pszName++) != '\0')
1503 {
1504 static const char s_szInvalidChars[] = ";:()[]{}/\\|&*%#@!~`\"'";
1505 unsigned offInv = RT_ELEMENTS(s_szInvalidChars);
1506 while (offInv-- > 0)
1507 if (s_szInvalidChars[offInv] == chCur)
1508 return false;
1509 }
1510 return true;
1511}
1512
1513
1514
1515/**
1516 * I/O Control inner worker (tracing reasons).
1517 *
1518 * @returns IPRT status code.
1519 * @retval VERR_INVALID_PARAMETER if the request is invalid.
1520 *
1521 * @param uIOCtl Function number.
1522 * @param pDevExt Device extention.
1523 * @param pSession Session data.
1524 * @param pReqHdr The request header.
1525 */
1526static int supdrvIOCtlInnerUnrestricted(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPREQHDR pReqHdr)
1527{
1528 /*
1529 * Validation macros
1530 */
1531#define REQ_CHECK_SIZES_EX(Name, cbInExpect, cbOutExpect) \
1532 do { \
1533 if (RT_UNLIKELY(pReqHdr->cbIn != (cbInExpect) || pReqHdr->cbOut != (cbOutExpect))) \
1534 { \
1535 OSDBGPRINT(( #Name ": Invalid input/output sizes. cbIn=%ld expected %ld. cbOut=%ld expected %ld.\n", \
1536 (long)pReqHdr->cbIn, (long)(cbInExpect), (long)pReqHdr->cbOut, (long)(cbOutExpect))); \
1537 return pReqHdr->rc = VERR_INVALID_PARAMETER; \
1538 } \
1539 } while (0)
1540
1541#define REQ_CHECK_SIZES(Name) REQ_CHECK_SIZES_EX(Name, Name ## _SIZE_IN, Name ## _SIZE_OUT)
1542
1543#define REQ_CHECK_SIZE_IN(Name, cbInExpect) \
1544 do { \
1545 if (RT_UNLIKELY(pReqHdr->cbIn != (cbInExpect))) \
1546 { \
1547 OSDBGPRINT(( #Name ": Invalid input/output sizes. cbIn=%ld expected %ld.\n", \
1548 (long)pReqHdr->cbIn, (long)(cbInExpect))); \
1549 return pReqHdr->rc = VERR_INVALID_PARAMETER; \
1550 } \
1551 } while (0)
1552
1553#define REQ_CHECK_SIZE_OUT(Name, cbOutExpect) \
1554 do { \
1555 if (RT_UNLIKELY(pReqHdr->cbOut != (cbOutExpect))) \
1556 { \
1557 OSDBGPRINT(( #Name ": Invalid input/output sizes. cbOut=%ld expected %ld.\n", \
1558 (long)pReqHdr->cbOut, (long)(cbOutExpect))); \
1559 return pReqHdr->rc = VERR_INVALID_PARAMETER; \
1560 } \
1561 } while (0)
1562
1563#define REQ_CHECK_EXPR(Name, expr) \
1564 do { \
1565 if (RT_UNLIKELY(!(expr))) \
1566 { \
1567 OSDBGPRINT(( #Name ": %s\n", #expr)); \
1568 return pReqHdr->rc = VERR_INVALID_PARAMETER; \
1569 } \
1570 } while (0)
1571
1572#define REQ_CHECK_EXPR_FMT(expr, fmt) \
1573 do { \
1574 if (RT_UNLIKELY(!(expr))) \
1575 { \
1576 OSDBGPRINT( fmt ); \
1577 return pReqHdr->rc = VERR_INVALID_PARAMETER; \
1578 } \
1579 } while (0)
1580
1581 /*
1582 * The switch.
1583 */
1584 switch (SUP_CTL_CODE_NO_SIZE(uIOCtl))
1585 {
1586 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_COOKIE):
1587 {
1588 PSUPCOOKIE pReq = (PSUPCOOKIE)pReqHdr;
1589 REQ_CHECK_SIZES(SUP_IOCTL_COOKIE);
1590 if (strncmp(pReq->u.In.szMagic, SUPCOOKIE_MAGIC, sizeof(pReq->u.In.szMagic)))
1591 {
1592 OSDBGPRINT(("SUP_IOCTL_COOKIE: invalid magic %.16s\n", pReq->u.In.szMagic));
1593 pReq->Hdr.rc = VERR_INVALID_MAGIC;
1594 return 0;
1595 }
1596
1597#if 0
1598 /*
1599 * Call out to the OS specific code and let it do permission checks on the
1600 * client process.
1601 */
1602 if (!supdrvOSValidateClientProcess(pDevExt, pSession))
1603 {
1604 pReq->u.Out.u32Cookie = 0xffffffff;
1605 pReq->u.Out.u32SessionCookie = 0xffffffff;
1606 pReq->u.Out.u32SessionVersion = 0xffffffff;
1607 pReq->u.Out.u32DriverVersion = SUPDRV_IOC_VERSION;
1608 pReq->u.Out.pSession = NULL;
1609 pReq->u.Out.cFunctions = 0;
1610 pReq->Hdr.rc = VERR_PERMISSION_DENIED;
1611 return 0;
1612 }
1613#endif
1614
1615 /*
1616 * Match the version.
1617 * The current logic is very simple, match the major interface version.
1618 */
1619 if ( pReq->u.In.u32MinVersion > SUPDRV_IOC_VERSION
1620 || (pReq->u.In.u32MinVersion & 0xffff0000) != (SUPDRV_IOC_VERSION & 0xffff0000))
1621 {
1622 OSDBGPRINT(("SUP_IOCTL_COOKIE: Version mismatch. Requested: %#x Min: %#x Current: %#x\n",
1623 pReq->u.In.u32ReqVersion, pReq->u.In.u32MinVersion, SUPDRV_IOC_VERSION));
1624 pReq->u.Out.u32Cookie = 0xffffffff;
1625 pReq->u.Out.u32SessionCookie = 0xffffffff;
1626 pReq->u.Out.u32SessionVersion = 0xffffffff;
1627 pReq->u.Out.u32DriverVersion = SUPDRV_IOC_VERSION;
1628 pReq->u.Out.pSession = NULL;
1629 pReq->u.Out.cFunctions = 0;
1630 pReq->Hdr.rc = VERR_VERSION_MISMATCH;
1631 return 0;
1632 }
1633
1634 /*
1635 * Fill in return data and be gone.
1636 * N.B. The first one to change SUPDRV_IOC_VERSION shall makes sure that
1637 * u32SessionVersion <= u32ReqVersion!
1638 */
1639 /** @todo Somehow validate the client and negotiate a secure cookie... */
1640 pReq->u.Out.u32Cookie = pDevExt->u32Cookie;
1641 pReq->u.Out.u32SessionCookie = pSession->u32Cookie;
1642 pReq->u.Out.u32SessionVersion = SUPDRV_IOC_VERSION;
1643 pReq->u.Out.u32DriverVersion = SUPDRV_IOC_VERSION;
1644 pReq->u.Out.pSession = pSession;
1645 pReq->u.Out.cFunctions = sizeof(g_aFunctions) / sizeof(g_aFunctions[0]);
1646 pReq->Hdr.rc = VINF_SUCCESS;
1647 return 0;
1648 }
1649
1650 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_QUERY_FUNCS(0)):
1651 {
1652 /* validate */
1653 PSUPQUERYFUNCS pReq = (PSUPQUERYFUNCS)pReqHdr;
1654 REQ_CHECK_SIZES_EX(SUP_IOCTL_QUERY_FUNCS, SUP_IOCTL_QUERY_FUNCS_SIZE_IN, SUP_IOCTL_QUERY_FUNCS_SIZE_OUT(RT_ELEMENTS(g_aFunctions)));
1655
1656 /* execute */
1657 pReq->u.Out.cFunctions = RT_ELEMENTS(g_aFunctions);
1658 memcpy(&pReq->u.Out.aFunctions[0], g_aFunctions, sizeof(g_aFunctions));
1659 pReq->Hdr.rc = VINF_SUCCESS;
1660 return 0;
1661 }
1662
1663 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_PAGE_LOCK):
1664 {
1665 /* validate */
1666 PSUPPAGELOCK pReq = (PSUPPAGELOCK)pReqHdr;
1667 REQ_CHECK_SIZE_IN(SUP_IOCTL_PAGE_LOCK, SUP_IOCTL_PAGE_LOCK_SIZE_IN);
1668 REQ_CHECK_SIZE_OUT(SUP_IOCTL_PAGE_LOCK, SUP_IOCTL_PAGE_LOCK_SIZE_OUT(pReq->u.In.cPages));
1669 REQ_CHECK_EXPR(SUP_IOCTL_PAGE_LOCK, pReq->u.In.cPages > 0);
1670 REQ_CHECK_EXPR(SUP_IOCTL_PAGE_LOCK, pReq->u.In.pvR3 >= PAGE_SIZE);
1671
1672 /* execute */
1673 pReq->Hdr.rc = SUPR0LockMem(pSession, pReq->u.In.pvR3, pReq->u.In.cPages, &pReq->u.Out.aPages[0]);
1674 if (RT_FAILURE(pReq->Hdr.rc))
1675 pReq->Hdr.cbOut = sizeof(pReq->Hdr);
1676 return 0;
1677 }
1678
1679 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_PAGE_UNLOCK):
1680 {
1681 /* validate */
1682 PSUPPAGEUNLOCK pReq = (PSUPPAGEUNLOCK)pReqHdr;
1683 REQ_CHECK_SIZES(SUP_IOCTL_PAGE_UNLOCK);
1684
1685 /* execute */
1686 pReq->Hdr.rc = SUPR0UnlockMem(pSession, pReq->u.In.pvR3);
1687 return 0;
1688 }
1689
1690 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_CONT_ALLOC):
1691 {
1692 /* validate */
1693 PSUPCONTALLOC pReq = (PSUPCONTALLOC)pReqHdr;
1694 REQ_CHECK_SIZES(SUP_IOCTL_CONT_ALLOC);
1695
1696 /* execute */
1697 pReq->Hdr.rc = SUPR0ContAlloc(pSession, pReq->u.In.cPages, &pReq->u.Out.pvR0, &pReq->u.Out.pvR3, &pReq->u.Out.HCPhys);
1698 if (RT_FAILURE(pReq->Hdr.rc))
1699 pReq->Hdr.cbOut = sizeof(pReq->Hdr);
1700 return 0;
1701 }
1702
1703 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_CONT_FREE):
1704 {
1705 /* validate */
1706 PSUPCONTFREE pReq = (PSUPCONTFREE)pReqHdr;
1707 REQ_CHECK_SIZES(SUP_IOCTL_CONT_FREE);
1708
1709 /* execute */
1710 pReq->Hdr.rc = SUPR0ContFree(pSession, (RTHCUINTPTR)pReq->u.In.pvR3);
1711 return 0;
1712 }
1713
1714 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LDR_OPEN):
1715 {
1716 /* validate */
1717 PSUPLDROPEN pReq = (PSUPLDROPEN)pReqHdr;
1718 REQ_CHECK_SIZES(SUP_IOCTL_LDR_OPEN);
1719 REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, pReq->u.In.cbImageWithTabs > 0);
1720 REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, pReq->u.In.cbImageWithTabs < 16*_1M);
1721 REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, pReq->u.In.cbImageBits > 0);
1722 REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, pReq->u.In.cbImageBits > 0);
1723 REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, pReq->u.In.cbImageBits < pReq->u.In.cbImageWithTabs);
1724 REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, pReq->u.In.szName[0]);
1725 REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, RTStrEnd(pReq->u.In.szName, sizeof(pReq->u.In.szName)));
1726 REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, supdrvIsLdrModuleNameValid(pReq->u.In.szName));
1727 REQ_CHECK_EXPR(SUP_IOCTL_LDR_OPEN, RTStrEnd(pReq->u.In.szFilename, sizeof(pReq->u.In.szFilename)));
1728
1729 /* execute */
1730 pReq->Hdr.rc = supdrvIOCtl_LdrOpen(pDevExt, pSession, pReq);
1731 return 0;
1732 }
1733
1734 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LDR_LOAD):
1735 {
1736 /* validate */
1737 PSUPLDRLOAD pReq = (PSUPLDRLOAD)pReqHdr;
1738 REQ_CHECK_EXPR(Name, pReq->Hdr.cbIn >= SUP_IOCTL_LDR_LOAD_SIZE_IN(32));
1739 REQ_CHECK_SIZES_EX(SUP_IOCTL_LDR_LOAD, SUP_IOCTL_LDR_LOAD_SIZE_IN(pReq->u.In.cbImageWithTabs), SUP_IOCTL_LDR_LOAD_SIZE_OUT);
1740 REQ_CHECK_EXPR(SUP_IOCTL_LDR_LOAD, pReq->u.In.cSymbols <= 16384);
1741 REQ_CHECK_EXPR_FMT( !pReq->u.In.cSymbols
1742 || ( pReq->u.In.offSymbols < pReq->u.In.cbImageWithTabs
1743 && pReq->u.In.offSymbols + pReq->u.In.cSymbols * sizeof(SUPLDRSYM) <= pReq->u.In.cbImageWithTabs),
1744 ("SUP_IOCTL_LDR_LOAD: offSymbols=%#lx cSymbols=%#lx cbImageWithTabs=%#lx\n", (long)pReq->u.In.offSymbols,
1745 (long)pReq->u.In.cSymbols, (long)pReq->u.In.cbImageWithTabs));
1746 REQ_CHECK_EXPR_FMT( !pReq->u.In.cbStrTab
1747 || ( pReq->u.In.offStrTab < pReq->u.In.cbImageWithTabs
1748 && pReq->u.In.offStrTab + pReq->u.In.cbStrTab <= pReq->u.In.cbImageWithTabs
1749 && pReq->u.In.cbStrTab <= pReq->u.In.cbImageWithTabs),
1750 ("SUP_IOCTL_LDR_LOAD: offStrTab=%#lx cbStrTab=%#lx cbImageWithTabs=%#lx\n", (long)pReq->u.In.offStrTab,
1751 (long)pReq->u.In.cbStrTab, (long)pReq->u.In.cbImageWithTabs));
1752
1753 if (pReq->u.In.cSymbols)
1754 {
1755 uint32_t i;
1756 PSUPLDRSYM paSyms = (PSUPLDRSYM)&pReq->u.In.abImage[pReq->u.In.offSymbols];
1757 for (i = 0; i < pReq->u.In.cSymbols; i++)
1758 {
1759 REQ_CHECK_EXPR_FMT(paSyms[i].offSymbol < pReq->u.In.cbImageWithTabs,
1760 ("SUP_IOCTL_LDR_LOAD: sym #%ld: symb off %#lx (max=%#lx)\n", (long)i, (long)paSyms[i].offSymbol, (long)pReq->u.In.cbImageWithTabs));
1761 REQ_CHECK_EXPR_FMT(paSyms[i].offName < pReq->u.In.cbStrTab,
1762 ("SUP_IOCTL_LDR_LOAD: sym #%ld: name off %#lx (max=%#lx)\n", (long)i, (long)paSyms[i].offName, (long)pReq->u.In.cbImageWithTabs));
1763 REQ_CHECK_EXPR_FMT(RTStrEnd((char const *)&pReq->u.In.abImage[pReq->u.In.offStrTab + paSyms[i].offName],
1764 pReq->u.In.cbStrTab - paSyms[i].offName),
1765 ("SUP_IOCTL_LDR_LOAD: sym #%ld: unterminated name! (%#lx / %#lx)\n", (long)i, (long)paSyms[i].offName, (long)pReq->u.In.cbImageWithTabs));
1766 }
1767 }
1768
1769 /* execute */
1770 pReq->Hdr.rc = supdrvIOCtl_LdrLoad(pDevExt, pSession, pReq);
1771 return 0;
1772 }
1773
1774 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LDR_FREE):
1775 {
1776 /* validate */
1777 PSUPLDRFREE pReq = (PSUPLDRFREE)pReqHdr;
1778 REQ_CHECK_SIZES(SUP_IOCTL_LDR_FREE);
1779
1780 /* execute */
1781 pReq->Hdr.rc = supdrvIOCtl_LdrFree(pDevExt, pSession, pReq);
1782 return 0;
1783 }
1784
1785 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LDR_LOCK_DOWN):
1786 {
1787 /* validate */
1788 REQ_CHECK_SIZES(SUP_IOCTL_LDR_LOCK_DOWN);
1789
1790 /* execute */
1791 pReqHdr->rc = supdrvIOCtl_LdrLockDown(pDevExt);
1792 return 0;
1793 }
1794
1795 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LDR_GET_SYMBOL):
1796 {
1797 /* validate */
1798 PSUPLDRGETSYMBOL pReq = (PSUPLDRGETSYMBOL)pReqHdr;
1799 REQ_CHECK_SIZES(SUP_IOCTL_LDR_GET_SYMBOL);
1800 REQ_CHECK_EXPR(SUP_IOCTL_LDR_GET_SYMBOL, RTStrEnd(pReq->u.In.szSymbol, sizeof(pReq->u.In.szSymbol)));
1801
1802 /* execute */
1803 pReq->Hdr.rc = supdrvIOCtl_LdrGetSymbol(pDevExt, pSession, pReq);
1804 return 0;
1805 }
1806
1807 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_CALL_VMMR0_NO_SIZE()):
1808 {
1809 /* validate */
1810 PSUPCALLVMMR0 pReq = (PSUPCALLVMMR0)pReqHdr;
1811 Log4(("SUP_IOCTL_CALL_VMMR0: op=%u in=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
1812 pReq->u.In.uOperation, pReq->Hdr.cbIn, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
1813
1814 if (pReq->Hdr.cbIn == SUP_IOCTL_CALL_VMMR0_SIZE(0))
1815 {
1816 REQ_CHECK_SIZES_EX(SUP_IOCTL_CALL_VMMR0, SUP_IOCTL_CALL_VMMR0_SIZE_IN(0), SUP_IOCTL_CALL_VMMR0_SIZE_OUT(0));
1817
1818 /* execute */
1819 if (RT_LIKELY(pDevExt->pfnVMMR0EntryEx))
1820 {
1821 if (pReq->u.In.pVMR0 == NULL)
1822 pReq->Hdr.rc = pDevExt->pfnVMMR0EntryEx(NULL, NULL, pReq->u.In.idCpu,
1823 pReq->u.In.uOperation, NULL, pReq->u.In.u64Arg, pSession);
1824 else if (pReq->u.In.pVMR0 == pSession->pSessionVM)
1825 pReq->Hdr.rc = pDevExt->pfnVMMR0EntryEx(pSession->pSessionGVM, pSession->pSessionVM, pReq->u.In.idCpu,
1826 pReq->u.In.uOperation, NULL, pReq->u.In.u64Arg, pSession);
1827 else
1828 pReq->Hdr.rc = VERR_INVALID_VM_HANDLE;
1829 }
1830 else
1831 pReq->Hdr.rc = VERR_WRONG_ORDER;
1832 }
1833 else
1834 {
1835 PSUPVMMR0REQHDR pVMMReq = (PSUPVMMR0REQHDR)&pReq->abReqPkt[0];
1836 REQ_CHECK_EXPR_FMT(pReq->Hdr.cbIn >= SUP_IOCTL_CALL_VMMR0_SIZE(sizeof(SUPVMMR0REQHDR)),
1837 ("SUP_IOCTL_CALL_VMMR0: cbIn=%#x < %#lx\n", pReq->Hdr.cbIn, SUP_IOCTL_CALL_VMMR0_SIZE(sizeof(SUPVMMR0REQHDR))));
1838 REQ_CHECK_EXPR(SUP_IOCTL_CALL_VMMR0, pVMMReq->u32Magic == SUPVMMR0REQHDR_MAGIC);
1839 REQ_CHECK_SIZES_EX(SUP_IOCTL_CALL_VMMR0, SUP_IOCTL_CALL_VMMR0_SIZE_IN(pVMMReq->cbReq), SUP_IOCTL_CALL_VMMR0_SIZE_OUT(pVMMReq->cbReq));
1840
1841 /* execute */
1842 if (RT_LIKELY(pDevExt->pfnVMMR0EntryEx))
1843 {
1844 if (pReq->u.In.pVMR0 == NULL)
1845 pReq->Hdr.rc = pDevExt->pfnVMMR0EntryEx(NULL, NULL, pReq->u.In.idCpu,
1846 pReq->u.In.uOperation, pVMMReq, pReq->u.In.u64Arg, pSession);
1847 else if (pReq->u.In.pVMR0 == pSession->pSessionVM)
1848 pReq->Hdr.rc = pDevExt->pfnVMMR0EntryEx(pSession->pSessionGVM, pSession->pSessionVM, pReq->u.In.idCpu,
1849 pReq->u.In.uOperation, pVMMReq, pReq->u.In.u64Arg, pSession);
1850 else
1851 pReq->Hdr.rc = VERR_INVALID_VM_HANDLE;
1852 }
1853 else
1854 pReq->Hdr.rc = VERR_WRONG_ORDER;
1855 }
1856
1857 if ( RT_FAILURE(pReq->Hdr.rc)
1858 && pReq->Hdr.rc != VERR_INTERRUPTED
1859 && pReq->Hdr.rc != VERR_TIMEOUT)
1860 Log(("SUP_IOCTL_CALL_VMMR0: rc=%Rrc op=%u out=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
1861 pReq->Hdr.rc, pReq->u.In.uOperation, pReq->Hdr.cbOut, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
1862 else
1863 Log4(("SUP_IOCTL_CALL_VMMR0: rc=%Rrc op=%u out=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
1864 pReq->Hdr.rc, pReq->u.In.uOperation, pReq->Hdr.cbOut, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
1865 return 0;
1866 }
1867
1868 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_CALL_VMMR0_BIG):
1869 {
1870 /* validate */
1871 PSUPCALLVMMR0 pReq = (PSUPCALLVMMR0)pReqHdr;
1872 PSUPVMMR0REQHDR pVMMReq;
1873 Log4(("SUP_IOCTL_CALL_VMMR0_BIG: op=%u in=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
1874 pReq->u.In.uOperation, pReq->Hdr.cbIn, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
1875
1876 pVMMReq = (PSUPVMMR0REQHDR)&pReq->abReqPkt[0];
1877 REQ_CHECK_EXPR_FMT(pReq->Hdr.cbIn >= SUP_IOCTL_CALL_VMMR0_BIG_SIZE(sizeof(SUPVMMR0REQHDR)),
1878 ("SUP_IOCTL_CALL_VMMR0_BIG: cbIn=%#x < %#lx\n", pReq->Hdr.cbIn, SUP_IOCTL_CALL_VMMR0_BIG_SIZE(sizeof(SUPVMMR0REQHDR))));
1879 REQ_CHECK_EXPR(SUP_IOCTL_CALL_VMMR0_BIG, pVMMReq->u32Magic == SUPVMMR0REQHDR_MAGIC);
1880 REQ_CHECK_SIZES_EX(SUP_IOCTL_CALL_VMMR0_BIG, SUP_IOCTL_CALL_VMMR0_BIG_SIZE_IN(pVMMReq->cbReq), SUP_IOCTL_CALL_VMMR0_BIG_SIZE_OUT(pVMMReq->cbReq));
1881
1882 /* execute */
1883 if (RT_LIKELY(pDevExt->pfnVMMR0EntryEx))
1884 {
1885 if (pReq->u.In.pVMR0 == NULL)
1886 pReq->Hdr.rc = pDevExt->pfnVMMR0EntryEx(NULL, NULL, pReq->u.In.idCpu, pReq->u.In.uOperation, pVMMReq, pReq->u.In.u64Arg, pSession);
1887 else if (pReq->u.In.pVMR0 == pSession->pSessionVM)
1888 pReq->Hdr.rc = pDevExt->pfnVMMR0EntryEx(pSession->pSessionGVM, pSession->pSessionVM, pReq->u.In.idCpu,
1889 pReq->u.In.uOperation, pVMMReq, pReq->u.In.u64Arg, pSession);
1890 else
1891 pReq->Hdr.rc = VERR_INVALID_VM_HANDLE;
1892 }
1893 else
1894 pReq->Hdr.rc = VERR_WRONG_ORDER;
1895
1896 if ( RT_FAILURE(pReq->Hdr.rc)
1897 && pReq->Hdr.rc != VERR_INTERRUPTED
1898 && pReq->Hdr.rc != VERR_TIMEOUT)
1899 Log(("SUP_IOCTL_CALL_VMMR0_BIG: rc=%Rrc op=%u out=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
1900 pReq->Hdr.rc, pReq->u.In.uOperation, pReq->Hdr.cbOut, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
1901 else
1902 Log4(("SUP_IOCTL_CALL_VMMR0_BIG: rc=%Rrc op=%u out=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
1903 pReq->Hdr.rc, pReq->u.In.uOperation, pReq->Hdr.cbOut, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
1904 return 0;
1905 }
1906
1907 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_GET_PAGING_MODE):
1908 {
1909 /* validate */
1910 PSUPGETPAGINGMODE pReq = (PSUPGETPAGINGMODE)pReqHdr;
1911 REQ_CHECK_SIZES(SUP_IOCTL_GET_PAGING_MODE);
1912
1913 /* execute */
1914 pReq->Hdr.rc = VINF_SUCCESS;
1915 pReq->u.Out.enmMode = SUPR0GetPagingMode();
1916 return 0;
1917 }
1918
1919 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LOW_ALLOC):
1920 {
1921 /* validate */
1922 PSUPLOWALLOC pReq = (PSUPLOWALLOC)pReqHdr;
1923 REQ_CHECK_EXPR(SUP_IOCTL_LOW_ALLOC, pReq->Hdr.cbIn <= SUP_IOCTL_LOW_ALLOC_SIZE_IN);
1924 REQ_CHECK_SIZES_EX(SUP_IOCTL_LOW_ALLOC, SUP_IOCTL_LOW_ALLOC_SIZE_IN, SUP_IOCTL_LOW_ALLOC_SIZE_OUT(pReq->u.In.cPages));
1925
1926 /* execute */
1927 pReq->Hdr.rc = SUPR0LowAlloc(pSession, pReq->u.In.cPages, &pReq->u.Out.pvR0, &pReq->u.Out.pvR3, &pReq->u.Out.aPages[0]);
1928 if (RT_FAILURE(pReq->Hdr.rc))
1929 pReq->Hdr.cbOut = sizeof(pReq->Hdr);
1930 return 0;
1931 }
1932
1933 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LOW_FREE):
1934 {
1935 /* validate */
1936 PSUPLOWFREE pReq = (PSUPLOWFREE)pReqHdr;
1937 REQ_CHECK_SIZES(SUP_IOCTL_LOW_FREE);
1938
1939 /* execute */
1940 pReq->Hdr.rc = SUPR0LowFree(pSession, (RTHCUINTPTR)pReq->u.In.pvR3);
1941 return 0;
1942 }
1943
1944 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_GIP_MAP):
1945 {
1946 /* validate */
1947 PSUPGIPMAP pReq = (PSUPGIPMAP)pReqHdr;
1948 REQ_CHECK_SIZES(SUP_IOCTL_GIP_MAP);
1949
1950 /* execute */
1951 pReq->Hdr.rc = SUPR0GipMap(pSession, &pReq->u.Out.pGipR3, &pReq->u.Out.HCPhysGip);
1952 if (RT_SUCCESS(pReq->Hdr.rc))
1953 pReq->u.Out.pGipR0 = pDevExt->pGip;
1954 return 0;
1955 }
1956
1957 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_GIP_UNMAP):
1958 {
1959 /* validate */
1960 PSUPGIPUNMAP pReq = (PSUPGIPUNMAP)pReqHdr;
1961 REQ_CHECK_SIZES(SUP_IOCTL_GIP_UNMAP);
1962
1963 /* execute */
1964 pReq->Hdr.rc = SUPR0GipUnmap(pSession);
1965 return 0;
1966 }
1967
1968 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_SET_VM_FOR_FAST):
1969 {
1970 /* validate */
1971 PSUPSETVMFORFAST pReq = (PSUPSETVMFORFAST)pReqHdr;
1972 REQ_CHECK_SIZES(SUP_IOCTL_SET_VM_FOR_FAST);
1973 REQ_CHECK_EXPR_FMT( !pReq->u.In.pVMR0
1974 || ( VALID_PTR(pReq->u.In.pVMR0)
1975 && !((uintptr_t)pReq->u.In.pVMR0 & (PAGE_SIZE - 1))),
1976 ("SUP_IOCTL_SET_VM_FOR_FAST: pVMR0=%p!\n", pReq->u.In.pVMR0));
1977
1978 /* execute */
1979 RTSpinlockAcquire(pDevExt->Spinlock);
1980 if (pSession->pSessionVM == pReq->u.In.pVMR0)
1981 {
1982 if (pSession->pFastIoCtrlVM == NULL)
1983 {
1984 pSession->pFastIoCtrlVM = pSession->pSessionVM;
1985 RTSpinlockRelease(pDevExt->Spinlock);
1986 pReq->Hdr.rc = VINF_SUCCESS;
1987 }
1988 else
1989 {
1990 RTSpinlockRelease(pDevExt->Spinlock);
1991 OSDBGPRINT(("SUP_IOCTL_SET_VM_FOR_FAST: pSession->pFastIoCtrlVM=%p! (pVMR0=%p)\n",
1992 pSession->pFastIoCtrlVM, pReq->u.In.pVMR0));
1993 pReq->Hdr.rc = VERR_ALREADY_EXISTS;
1994 }
1995 }
1996 else
1997 {
1998 RTSpinlockRelease(pDevExt->Spinlock);
1999 OSDBGPRINT(("SUP_IOCTL_SET_VM_FOR_FAST: pSession->pSessionVM=%p vs pVMR0=%p)\n",
2000 pSession->pSessionVM, pReq->u.In.pVMR0));
2001 pReq->Hdr.rc = pSession->pSessionVM ? VERR_ACCESS_DENIED : VERR_WRONG_ORDER;
2002 }
2003 return 0;
2004 }
2005
2006 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_PAGE_ALLOC_EX):
2007 {
2008 /* validate */
2009 PSUPPAGEALLOCEX pReq = (PSUPPAGEALLOCEX)pReqHdr;
2010 REQ_CHECK_EXPR(SUP_IOCTL_PAGE_ALLOC_EX, pReq->Hdr.cbIn <= SUP_IOCTL_PAGE_ALLOC_EX_SIZE_IN);
2011 REQ_CHECK_SIZES_EX(SUP_IOCTL_PAGE_ALLOC_EX, SUP_IOCTL_PAGE_ALLOC_EX_SIZE_IN, SUP_IOCTL_PAGE_ALLOC_EX_SIZE_OUT(pReq->u.In.cPages));
2012 REQ_CHECK_EXPR_FMT(pReq->u.In.fKernelMapping || pReq->u.In.fUserMapping,
2013 ("SUP_IOCTL_PAGE_ALLOC_EX: No mapping requested!\n"));
2014 REQ_CHECK_EXPR_FMT(pReq->u.In.fUserMapping,
2015 ("SUP_IOCTL_PAGE_ALLOC_EX: Must have user mapping!\n"));
2016 REQ_CHECK_EXPR_FMT(!pReq->u.In.fReserved0 && !pReq->u.In.fReserved1,
2017 ("SUP_IOCTL_PAGE_ALLOC_EX: fReserved0=%d fReserved1=%d\n", pReq->u.In.fReserved0, pReq->u.In.fReserved1));
2018
2019 /* execute */
2020 pReq->Hdr.rc = SUPR0PageAllocEx(pSession, pReq->u.In.cPages, 0 /* fFlags */,
2021 pReq->u.In.fUserMapping ? &pReq->u.Out.pvR3 : NULL,
2022 pReq->u.In.fKernelMapping ? &pReq->u.Out.pvR0 : NULL,
2023 &pReq->u.Out.aPages[0]);
2024 if (RT_FAILURE(pReq->Hdr.rc))
2025 pReq->Hdr.cbOut = sizeof(pReq->Hdr);
2026 return 0;
2027 }
2028
2029 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_PAGE_MAP_KERNEL):
2030 {
2031 /* validate */
2032 PSUPPAGEMAPKERNEL pReq = (PSUPPAGEMAPKERNEL)pReqHdr;
2033 REQ_CHECK_SIZES(SUP_IOCTL_PAGE_MAP_KERNEL);
2034 REQ_CHECK_EXPR_FMT(!pReq->u.In.fFlags, ("SUP_IOCTL_PAGE_MAP_KERNEL: fFlags=%#x! MBZ\n", pReq->u.In.fFlags));
2035 REQ_CHECK_EXPR_FMT(!(pReq->u.In.offSub & PAGE_OFFSET_MASK), ("SUP_IOCTL_PAGE_MAP_KERNEL: offSub=%#x\n", pReq->u.In.offSub));
2036 REQ_CHECK_EXPR_FMT(pReq->u.In.cbSub && !(pReq->u.In.cbSub & PAGE_OFFSET_MASK),
2037 ("SUP_IOCTL_PAGE_MAP_KERNEL: cbSub=%#x\n", pReq->u.In.cbSub));
2038
2039 /* execute */
2040 pReq->Hdr.rc = SUPR0PageMapKernel(pSession, pReq->u.In.pvR3, pReq->u.In.offSub, pReq->u.In.cbSub,
2041 pReq->u.In.fFlags, &pReq->u.Out.pvR0);
2042 if (RT_FAILURE(pReq->Hdr.rc))
2043 pReq->Hdr.cbOut = sizeof(pReq->Hdr);
2044 return 0;
2045 }
2046
2047 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_PAGE_PROTECT):
2048 {
2049 /* validate */
2050 PSUPPAGEPROTECT pReq = (PSUPPAGEPROTECT)pReqHdr;
2051 REQ_CHECK_SIZES(SUP_IOCTL_PAGE_PROTECT);
2052 REQ_CHECK_EXPR_FMT(!(pReq->u.In.fProt & ~(RTMEM_PROT_READ | RTMEM_PROT_WRITE | RTMEM_PROT_EXEC | RTMEM_PROT_NONE)),
2053 ("SUP_IOCTL_PAGE_PROTECT: fProt=%#x!\n", pReq->u.In.fProt));
2054 REQ_CHECK_EXPR_FMT(!(pReq->u.In.offSub & PAGE_OFFSET_MASK), ("SUP_IOCTL_PAGE_PROTECT: offSub=%#x\n", pReq->u.In.offSub));
2055 REQ_CHECK_EXPR_FMT(pReq->u.In.cbSub && !(pReq->u.In.cbSub & PAGE_OFFSET_MASK),
2056 ("SUP_IOCTL_PAGE_PROTECT: cbSub=%#x\n", pReq->u.In.cbSub));
2057
2058 /* execute */
2059 pReq->Hdr.rc = SUPR0PageProtect(pSession, pReq->u.In.pvR3, pReq->u.In.pvR0, pReq->u.In.offSub, pReq->u.In.cbSub, pReq->u.In.fProt);
2060 return 0;
2061 }
2062
2063 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_PAGE_FREE):
2064 {
2065 /* validate */
2066 PSUPPAGEFREE pReq = (PSUPPAGEFREE)pReqHdr;
2067 REQ_CHECK_SIZES(SUP_IOCTL_PAGE_FREE);
2068
2069 /* execute */
2070 pReq->Hdr.rc = SUPR0PageFree(pSession, pReq->u.In.pvR3);
2071 return 0;
2072 }
2073
2074 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_CALL_SERVICE_NO_SIZE()):
2075 {
2076 /* validate */
2077 PSUPCALLSERVICE pReq = (PSUPCALLSERVICE)pReqHdr;
2078 Log4(("SUP_IOCTL_CALL_SERVICE: op=%u in=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
2079 pReq->u.In.uOperation, pReq->Hdr.cbIn, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
2080
2081 if (pReq->Hdr.cbIn == SUP_IOCTL_CALL_SERVICE_SIZE(0))
2082 REQ_CHECK_SIZES_EX(SUP_IOCTL_CALL_SERVICE, SUP_IOCTL_CALL_SERVICE_SIZE_IN(0), SUP_IOCTL_CALL_SERVICE_SIZE_OUT(0));
2083 else
2084 {
2085 PSUPR0SERVICEREQHDR pSrvReq = (PSUPR0SERVICEREQHDR)&pReq->abReqPkt[0];
2086 REQ_CHECK_EXPR_FMT(pReq->Hdr.cbIn >= SUP_IOCTL_CALL_SERVICE_SIZE(sizeof(SUPR0SERVICEREQHDR)),
2087 ("SUP_IOCTL_CALL_SERVICE: cbIn=%#x < %#lx\n", pReq->Hdr.cbIn, SUP_IOCTL_CALL_SERVICE_SIZE(sizeof(SUPR0SERVICEREQHDR))));
2088 REQ_CHECK_EXPR(SUP_IOCTL_CALL_SERVICE, pSrvReq->u32Magic == SUPR0SERVICEREQHDR_MAGIC);
2089 REQ_CHECK_SIZES_EX(SUP_IOCTL_CALL_SERVICE, SUP_IOCTL_CALL_SERVICE_SIZE_IN(pSrvReq->cbReq), SUP_IOCTL_CALL_SERVICE_SIZE_OUT(pSrvReq->cbReq));
2090 }
2091 REQ_CHECK_EXPR(SUP_IOCTL_CALL_SERVICE, RTStrEnd(pReq->u.In.szName, sizeof(pReq->u.In.szName)));
2092
2093 /* execute */
2094 pReq->Hdr.rc = supdrvIOCtl_CallServiceModule(pDevExt, pSession, pReq);
2095 return 0;
2096 }
2097
2098 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_LOGGER_SETTINGS_NO_SIZE()):
2099 {
2100 /* validate */
2101 PSUPLOGGERSETTINGS pReq = (PSUPLOGGERSETTINGS)pReqHdr;
2102 size_t cbStrTab;
2103 REQ_CHECK_SIZE_OUT(SUP_IOCTL_LOGGER_SETTINGS, SUP_IOCTL_LOGGER_SETTINGS_SIZE_OUT);
2104 REQ_CHECK_EXPR(SUP_IOCTL_LOGGER_SETTINGS, pReq->Hdr.cbIn >= SUP_IOCTL_LOGGER_SETTINGS_SIZE_IN(1));
2105 cbStrTab = pReq->Hdr.cbIn - SUP_IOCTL_LOGGER_SETTINGS_SIZE_IN(0);
2106 REQ_CHECK_EXPR(SUP_IOCTL_LOGGER_SETTINGS, pReq->u.In.offGroups < cbStrTab);
2107 REQ_CHECK_EXPR(SUP_IOCTL_LOGGER_SETTINGS, pReq->u.In.offFlags < cbStrTab);
2108 REQ_CHECK_EXPR(SUP_IOCTL_LOGGER_SETTINGS, pReq->u.In.offDestination < cbStrTab);
2109 REQ_CHECK_EXPR_FMT(pReq->u.In.szStrings[cbStrTab - 1] == '\0',
2110 ("SUP_IOCTL_LOGGER_SETTINGS: cbIn=%#x cbStrTab=%#zx LastChar=%d\n",
2111 pReq->Hdr.cbIn, cbStrTab, pReq->u.In.szStrings[cbStrTab - 1]));
2112 REQ_CHECK_EXPR(SUP_IOCTL_LOGGER_SETTINGS, pReq->u.In.fWhich <= SUPLOGGERSETTINGS_WHICH_RELEASE);
2113 REQ_CHECK_EXPR(SUP_IOCTL_LOGGER_SETTINGS, pReq->u.In.fWhat <= SUPLOGGERSETTINGS_WHAT_DESTROY);
2114
2115 /* execute */
2116 pReq->Hdr.rc = supdrvIOCtl_LoggerSettings(pReq);
2117 return 0;
2118 }
2119
2120 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_SEM_OP2):
2121 {
2122 /* validate */
2123 PSUPSEMOP2 pReq = (PSUPSEMOP2)pReqHdr;
2124 REQ_CHECK_SIZES_EX(SUP_IOCTL_SEM_OP2, SUP_IOCTL_SEM_OP2_SIZE_IN, SUP_IOCTL_SEM_OP2_SIZE_OUT);
2125 REQ_CHECK_EXPR(SUP_IOCTL_SEM_OP2, pReq->u.In.uReserved == 0);
2126
2127 /* execute */
2128 switch (pReq->u.In.uType)
2129 {
2130 case SUP_SEM_TYPE_EVENT:
2131 {
2132 SUPSEMEVENT hEvent = (SUPSEMEVENT)(uintptr_t)pReq->u.In.hSem;
2133 switch (pReq->u.In.uOp)
2134 {
2135 case SUPSEMOP2_WAIT_MS_REL:
2136 pReq->Hdr.rc = SUPSemEventWaitNoResume(pSession, hEvent, pReq->u.In.uArg.cRelMsTimeout);
2137 break;
2138 case SUPSEMOP2_WAIT_NS_ABS:
2139 pReq->Hdr.rc = SUPSemEventWaitNsAbsIntr(pSession, hEvent, pReq->u.In.uArg.uAbsNsTimeout);
2140 break;
2141 case SUPSEMOP2_WAIT_NS_REL:
2142 pReq->Hdr.rc = SUPSemEventWaitNsRelIntr(pSession, hEvent, pReq->u.In.uArg.cRelNsTimeout);
2143 break;
2144 case SUPSEMOP2_SIGNAL:
2145 pReq->Hdr.rc = SUPSemEventSignal(pSession, hEvent);
2146 break;
2147 case SUPSEMOP2_CLOSE:
2148 pReq->Hdr.rc = SUPSemEventClose(pSession, hEvent);
2149 break;
2150 case SUPSEMOP2_RESET:
2151 default:
2152 pReq->Hdr.rc = VERR_INVALID_FUNCTION;
2153 break;
2154 }
2155 break;
2156 }
2157
2158 case SUP_SEM_TYPE_EVENT_MULTI:
2159 {
2160 SUPSEMEVENTMULTI hEventMulti = (SUPSEMEVENTMULTI)(uintptr_t)pReq->u.In.hSem;
2161 switch (pReq->u.In.uOp)
2162 {
2163 case SUPSEMOP2_WAIT_MS_REL:
2164 pReq->Hdr.rc = SUPSemEventMultiWaitNoResume(pSession, hEventMulti, pReq->u.In.uArg.cRelMsTimeout);
2165 break;
2166 case SUPSEMOP2_WAIT_NS_ABS:
2167 pReq->Hdr.rc = SUPSemEventMultiWaitNsAbsIntr(pSession, hEventMulti, pReq->u.In.uArg.uAbsNsTimeout);
2168 break;
2169 case SUPSEMOP2_WAIT_NS_REL:
2170 pReq->Hdr.rc = SUPSemEventMultiWaitNsRelIntr(pSession, hEventMulti, pReq->u.In.uArg.cRelNsTimeout);
2171 break;
2172 case SUPSEMOP2_SIGNAL:
2173 pReq->Hdr.rc = SUPSemEventMultiSignal(pSession, hEventMulti);
2174 break;
2175 case SUPSEMOP2_CLOSE:
2176 pReq->Hdr.rc = SUPSemEventMultiClose(pSession, hEventMulti);
2177 break;
2178 case SUPSEMOP2_RESET:
2179 pReq->Hdr.rc = SUPSemEventMultiReset(pSession, hEventMulti);
2180 break;
2181 default:
2182 pReq->Hdr.rc = VERR_INVALID_FUNCTION;
2183 break;
2184 }
2185 break;
2186 }
2187
2188 default:
2189 pReq->Hdr.rc = VERR_INVALID_PARAMETER;
2190 break;
2191 }
2192 return 0;
2193 }
2194
2195 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_SEM_OP3):
2196 {
2197 /* validate */
2198 PSUPSEMOP3 pReq = (PSUPSEMOP3)pReqHdr;
2199 REQ_CHECK_SIZES_EX(SUP_IOCTL_SEM_OP3, SUP_IOCTL_SEM_OP3_SIZE_IN, SUP_IOCTL_SEM_OP3_SIZE_OUT);
2200 REQ_CHECK_EXPR(SUP_IOCTL_SEM_OP3, pReq->u.In.u32Reserved == 0 && pReq->u.In.u64Reserved == 0);
2201
2202 /* execute */
2203 switch (pReq->u.In.uType)
2204 {
2205 case SUP_SEM_TYPE_EVENT:
2206 {
2207 SUPSEMEVENT hEvent = (SUPSEMEVENT)(uintptr_t)pReq->u.In.hSem;
2208 switch (pReq->u.In.uOp)
2209 {
2210 case SUPSEMOP3_CREATE:
2211 REQ_CHECK_EXPR(SUP_IOCTL_SEM_OP3, hEvent == NIL_SUPSEMEVENT);
2212 pReq->Hdr.rc = SUPSemEventCreate(pSession, &hEvent);
2213 pReq->u.Out.hSem = (uint32_t)(uintptr_t)hEvent;
2214 break;
2215 case SUPSEMOP3_GET_RESOLUTION:
2216 REQ_CHECK_EXPR(SUP_IOCTL_SEM_OP3, hEvent == NIL_SUPSEMEVENT);
2217 pReq->Hdr.rc = VINF_SUCCESS;
2218 pReq->Hdr.cbOut = sizeof(*pReq);
2219 pReq->u.Out.cNsResolution = SUPSemEventGetResolution(pSession);
2220 break;
2221 default:
2222 pReq->Hdr.rc = VERR_INVALID_FUNCTION;
2223 break;
2224 }
2225 break;
2226 }
2227
2228 case SUP_SEM_TYPE_EVENT_MULTI:
2229 {
2230 SUPSEMEVENTMULTI hEventMulti = (SUPSEMEVENTMULTI)(uintptr_t)pReq->u.In.hSem;
2231 switch (pReq->u.In.uOp)
2232 {
2233 case SUPSEMOP3_CREATE:
2234 REQ_CHECK_EXPR(SUP_IOCTL_SEM_OP3, hEventMulti == NIL_SUPSEMEVENTMULTI);
2235 pReq->Hdr.rc = SUPSemEventMultiCreate(pSession, &hEventMulti);
2236 pReq->u.Out.hSem = (uint32_t)(uintptr_t)hEventMulti;
2237 break;
2238 case SUPSEMOP3_GET_RESOLUTION:
2239 REQ_CHECK_EXPR(SUP_IOCTL_SEM_OP3, hEventMulti == NIL_SUPSEMEVENTMULTI);
2240 pReq->Hdr.rc = VINF_SUCCESS;
2241 pReq->u.Out.cNsResolution = SUPSemEventMultiGetResolution(pSession);
2242 break;
2243 default:
2244 pReq->Hdr.rc = VERR_INVALID_FUNCTION;
2245 break;
2246 }
2247 break;
2248 }
2249
2250 default:
2251 pReq->Hdr.rc = VERR_INVALID_PARAMETER;
2252 break;
2253 }
2254 return 0;
2255 }
2256
2257 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_VT_CAPS):
2258 {
2259 /* validate */
2260 PSUPVTCAPS pReq = (PSUPVTCAPS)pReqHdr;
2261 REQ_CHECK_SIZES(SUP_IOCTL_VT_CAPS);
2262
2263 /* execute */
2264 pReq->Hdr.rc = SUPR0QueryVTCaps(pSession, &pReq->u.Out.fCaps);
2265 if (RT_FAILURE(pReq->Hdr.rc))
2266 pReq->Hdr.cbOut = sizeof(pReq->Hdr);
2267 return 0;
2268 }
2269
2270 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_TRACER_OPEN):
2271 {
2272 /* validate */
2273 PSUPTRACEROPEN pReq = (PSUPTRACEROPEN)pReqHdr;
2274 REQ_CHECK_SIZES(SUP_IOCTL_TRACER_OPEN);
2275
2276 /* execute */
2277 pReq->Hdr.rc = supdrvIOCtl_TracerOpen(pDevExt, pSession, pReq->u.In.uCookie, pReq->u.In.uArg);
2278 return 0;
2279 }
2280
2281 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_TRACER_CLOSE):
2282 {
2283 /* validate */
2284 REQ_CHECK_SIZES(SUP_IOCTL_TRACER_CLOSE);
2285
2286 /* execute */
2287 pReqHdr->rc = supdrvIOCtl_TracerClose(pDevExt, pSession);
2288 return 0;
2289 }
2290
2291 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_TRACER_IOCTL):
2292 {
2293 /* validate */
2294 PSUPTRACERIOCTL pReq = (PSUPTRACERIOCTL)pReqHdr;
2295 REQ_CHECK_SIZES(SUP_IOCTL_TRACER_IOCTL);
2296
2297 /* execute */
2298 pReqHdr->rc = supdrvIOCtl_TracerIOCtl(pDevExt, pSession, pReq->u.In.uCmd, pReq->u.In.uArg, &pReq->u.Out.iRetVal);
2299 return 0;
2300 }
2301
2302 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_TRACER_UMOD_REG):
2303 {
2304 /* validate */
2305 PSUPTRACERUMODREG pReq = (PSUPTRACERUMODREG)pReqHdr;
2306 REQ_CHECK_SIZES(SUP_IOCTL_TRACER_UMOD_REG);
2307 if (!RTStrEnd(pReq->u.In.szName, sizeof(pReq->u.In.szName)))
2308 return VERR_INVALID_PARAMETER;
2309
2310 /* execute */
2311 pReqHdr->rc = supdrvIOCtl_TracerUmodRegister(pDevExt, pSession,
2312 pReq->u.In.R3PtrVtgHdr, pReq->u.In.uVtgHdrAddr,
2313 pReq->u.In.R3PtrStrTab, pReq->u.In.cbStrTab,
2314 pReq->u.In.szName, pReq->u.In.fFlags);
2315 return 0;
2316 }
2317
2318 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_TRACER_UMOD_DEREG):
2319 {
2320 /* validate */
2321 PSUPTRACERUMODDEREG pReq = (PSUPTRACERUMODDEREG)pReqHdr;
2322 REQ_CHECK_SIZES(SUP_IOCTL_TRACER_UMOD_DEREG);
2323
2324 /* execute */
2325 pReqHdr->rc = supdrvIOCtl_TracerUmodDeregister(pDevExt, pSession, pReq->u.In.pVtgHdr);
2326 return 0;
2327 }
2328
2329 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_TRACER_UMOD_FIRE_PROBE):
2330 {
2331 /* validate */
2332 PSUPTRACERUMODFIREPROBE pReq = (PSUPTRACERUMODFIREPROBE)pReqHdr;
2333 REQ_CHECK_SIZES(SUP_IOCTL_TRACER_UMOD_FIRE_PROBE);
2334
2335 supdrvIOCtl_TracerUmodProbeFire(pDevExt, pSession, &pReq->u.In);
2336 pReqHdr->rc = VINF_SUCCESS;
2337 return 0;
2338 }
2339
2340 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_MSR_PROBER):
2341 {
2342 /* validate */
2343 PSUPMSRPROBER pReq = (PSUPMSRPROBER)pReqHdr;
2344 REQ_CHECK_SIZES(SUP_IOCTL_MSR_PROBER);
2345 REQ_CHECK_EXPR(SUP_IOCTL_MSR_PROBER,
2346 pReq->u.In.enmOp > SUPMSRPROBEROP_INVALID && pReq->u.In.enmOp < SUPMSRPROBEROP_END);
2347
2348 pReqHdr->rc = supdrvIOCtl_MsrProber(pDevExt, pReq);
2349 return 0;
2350 }
2351
2352 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_RESUME_SUSPENDED_KBDS):
2353 {
2354 /* validate */
2355 REQ_CHECK_SIZES(SUP_IOCTL_RESUME_SUSPENDED_KBDS);
2356
2357 pReqHdr->rc = supdrvIOCtl_ResumeSuspendedKbds();
2358 return 0;
2359 }
2360
2361 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_TSC_DELTA_MEASURE):
2362 {
2363 /* validate */
2364 PSUPTSCDELTAMEASURE pReq = (PSUPTSCDELTAMEASURE)pReqHdr;
2365 REQ_CHECK_SIZES(SUP_IOCTL_TSC_DELTA_MEASURE);
2366
2367 pReqHdr->rc = supdrvIOCtl_TscDeltaMeasure(pDevExt, pSession, pReq);
2368 return 0;
2369 }
2370
2371 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_TSC_READ):
2372 {
2373 /* validate */
2374 PSUPTSCREAD pReq = (PSUPTSCREAD)pReqHdr;
2375 REQ_CHECK_SIZES(SUP_IOCTL_TSC_READ);
2376
2377 pReqHdr->rc = supdrvIOCtl_TscRead(pDevExt, pSession, pReq);
2378 return 0;
2379 }
2380
2381 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_GIP_SET_FLAGS):
2382 {
2383 /* validate */
2384 PSUPGIPSETFLAGS pReq = (PSUPGIPSETFLAGS)pReqHdr;
2385 REQ_CHECK_SIZES(SUP_IOCTL_GIP_SET_FLAGS);
2386
2387 pReqHdr->rc = supdrvIOCtl_GipSetFlags(pDevExt, pSession, pReq->u.In.fOrMask, pReq->u.In.fAndMask);
2388 return 0;
2389 }
2390
2391 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_UCODE_REV):
2392 {
2393 /* validate */
2394 PSUPUCODEREV pReq = (PSUPUCODEREV)pReqHdr;
2395 REQ_CHECK_SIZES(SUP_IOCTL_UCODE_REV);
2396
2397 /* execute */
2398 pReq->Hdr.rc = SUPR0QueryUcodeRev(pSession, &pReq->u.Out.MicrocodeRev);
2399 if (RT_FAILURE(pReq->Hdr.rc))
2400 pReq->Hdr.cbOut = sizeof(pReq->Hdr);
2401 return 0;
2402 }
2403
2404 default:
2405 Log(("Unknown IOCTL %#lx\n", (long)uIOCtl));
2406 break;
2407 }
2408 return VERR_GENERAL_FAILURE;
2409}
2410
2411
2412/**
2413 * I/O Control inner worker for the restricted operations.
2414 *
2415 * @returns IPRT status code.
2416 * @retval VERR_INVALID_PARAMETER if the request is invalid.
2417 *
2418 * @param uIOCtl Function number.
2419 * @param pDevExt Device extention.
2420 * @param pSession Session data.
2421 * @param pReqHdr The request header.
2422 */
2423static int supdrvIOCtlInnerRestricted(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPREQHDR pReqHdr)
2424{
2425 /*
2426 * The switch.
2427 */
2428 switch (SUP_CTL_CODE_NO_SIZE(uIOCtl))
2429 {
2430 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_COOKIE):
2431 {
2432 PSUPCOOKIE pReq = (PSUPCOOKIE)pReqHdr;
2433 REQ_CHECK_SIZES(SUP_IOCTL_COOKIE);
2434 if (strncmp(pReq->u.In.szMagic, SUPCOOKIE_MAGIC, sizeof(pReq->u.In.szMagic)))
2435 {
2436 OSDBGPRINT(("SUP_IOCTL_COOKIE: invalid magic %.16s\n", pReq->u.In.szMagic));
2437 pReq->Hdr.rc = VERR_INVALID_MAGIC;
2438 return 0;
2439 }
2440
2441 /*
2442 * Match the version.
2443 * The current logic is very simple, match the major interface version.
2444 */
2445 if ( pReq->u.In.u32MinVersion > SUPDRV_IOC_VERSION
2446 || (pReq->u.In.u32MinVersion & 0xffff0000) != (SUPDRV_IOC_VERSION & 0xffff0000))
2447 {
2448 OSDBGPRINT(("SUP_IOCTL_COOKIE: Version mismatch. Requested: %#x Min: %#x Current: %#x\n",
2449 pReq->u.In.u32ReqVersion, pReq->u.In.u32MinVersion, SUPDRV_IOC_VERSION));
2450 pReq->u.Out.u32Cookie = 0xffffffff;
2451 pReq->u.Out.u32SessionCookie = 0xffffffff;
2452 pReq->u.Out.u32SessionVersion = 0xffffffff;
2453 pReq->u.Out.u32DriverVersion = SUPDRV_IOC_VERSION;
2454 pReq->u.Out.pSession = NULL;
2455 pReq->u.Out.cFunctions = 0;
2456 pReq->Hdr.rc = VERR_VERSION_MISMATCH;
2457 return 0;
2458 }
2459
2460 /*
2461 * Fill in return data and be gone.
2462 * N.B. The first one to change SUPDRV_IOC_VERSION shall makes sure that
2463 * u32SessionVersion <= u32ReqVersion!
2464 */
2465 /** @todo Somehow validate the client and negotiate a secure cookie... */
2466 pReq->u.Out.u32Cookie = pDevExt->u32Cookie;
2467 pReq->u.Out.u32SessionCookie = pSession->u32Cookie;
2468 pReq->u.Out.u32SessionVersion = SUPDRV_IOC_VERSION;
2469 pReq->u.Out.u32DriverVersion = SUPDRV_IOC_VERSION;
2470 pReq->u.Out.pSession = pSession;
2471 pReq->u.Out.cFunctions = 0;
2472 pReq->Hdr.rc = VINF_SUCCESS;
2473 return 0;
2474 }
2475
2476 case SUP_CTL_CODE_NO_SIZE(SUP_IOCTL_VT_CAPS):
2477 {
2478 /* validate */
2479 PSUPVTCAPS pReq = (PSUPVTCAPS)pReqHdr;
2480 REQ_CHECK_SIZES(SUP_IOCTL_VT_CAPS);
2481
2482 /* execute */
2483 pReq->Hdr.rc = SUPR0QueryVTCaps(pSession, &pReq->u.Out.fCaps);
2484 if (RT_FAILURE(pReq->Hdr.rc))
2485 pReq->Hdr.cbOut = sizeof(pReq->Hdr);
2486 return 0;
2487 }
2488
2489 default:
2490 Log(("Unknown IOCTL %#lx\n", (long)uIOCtl));
2491 break;
2492 }
2493 return VERR_GENERAL_FAILURE;
2494}
2495
2496
2497/**
2498 * I/O Control worker.
2499 *
2500 * @returns IPRT status code.
2501 * @retval VERR_INVALID_PARAMETER if the request is invalid.
2502 *
2503 * @param uIOCtl Function number.
2504 * @param pDevExt Device extention.
2505 * @param pSession Session data.
2506 * @param pReqHdr The request header.
2507 * @param cbReq The size of the request buffer.
2508 */
2509int VBOXCALL supdrvIOCtl(uintptr_t uIOCtl, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPREQHDR pReqHdr, size_t cbReq)
2510{
2511 int rc;
2512 VBOXDRV_IOCTL_ENTRY(pSession, uIOCtl, pReqHdr);
2513
2514 /*
2515 * Validate the request.
2516 */
2517 if (RT_UNLIKELY(cbReq < sizeof(*pReqHdr)))
2518 {
2519 OSDBGPRINT(("vboxdrv: Bad ioctl request size; cbReq=%#lx\n", (long)cbReq));
2520 VBOXDRV_IOCTL_RETURN(pSession, uIOCtl, pReqHdr, VERR_INVALID_PARAMETER, VINF_SUCCESS);
2521 return VERR_INVALID_PARAMETER;
2522 }
2523 if (RT_UNLIKELY( (pReqHdr->fFlags & SUPREQHDR_FLAGS_MAGIC_MASK) != SUPREQHDR_FLAGS_MAGIC
2524 || pReqHdr->cbIn < sizeof(*pReqHdr)
2525 || pReqHdr->cbIn > cbReq
2526 || pReqHdr->cbOut < sizeof(*pReqHdr)
2527 || pReqHdr->cbOut > cbReq))
2528 {
2529 OSDBGPRINT(("vboxdrv: Bad ioctl request header; cbIn=%#lx cbOut=%#lx fFlags=%#lx\n",
2530 (long)pReqHdr->cbIn, (long)pReqHdr->cbOut, (long)pReqHdr->fFlags));
2531 VBOXDRV_IOCTL_RETURN(pSession, uIOCtl, pReqHdr, VERR_INVALID_PARAMETER, VINF_SUCCESS);
2532 return VERR_INVALID_PARAMETER;
2533 }
2534 if (RT_UNLIKELY(!RT_VALID_PTR(pSession)))
2535 {
2536 OSDBGPRINT(("vboxdrv: Invalid pSession value %p (ioctl=%p)\n", pSession, (void *)uIOCtl));
2537 VBOXDRV_IOCTL_RETURN(pSession, uIOCtl, pReqHdr, VERR_INVALID_PARAMETER, VINF_SUCCESS);
2538 return VERR_INVALID_PARAMETER;
2539 }
2540 if (RT_UNLIKELY(uIOCtl == SUP_IOCTL_COOKIE))
2541 {
2542 if (pReqHdr->u32Cookie != SUPCOOKIE_INITIAL_COOKIE)
2543 {
2544 OSDBGPRINT(("SUP_IOCTL_COOKIE: bad cookie %#lx\n", (long)pReqHdr->u32Cookie));
2545 VBOXDRV_IOCTL_RETURN(pSession, uIOCtl, pReqHdr, VERR_INVALID_PARAMETER, VINF_SUCCESS);
2546 return VERR_INVALID_PARAMETER;
2547 }
2548 }
2549 else if (RT_UNLIKELY( pReqHdr->u32Cookie != pDevExt->u32Cookie
2550 || pReqHdr->u32SessionCookie != pSession->u32Cookie))
2551 {
2552 OSDBGPRINT(("vboxdrv: bad cookie %#lx / %#lx.\n", (long)pReqHdr->u32Cookie, (long)pReqHdr->u32SessionCookie));
2553 VBOXDRV_IOCTL_RETURN(pSession, uIOCtl, pReqHdr, VERR_INVALID_PARAMETER, VINF_SUCCESS);
2554 return VERR_INVALID_PARAMETER;
2555 }
2556
2557 /*
2558 * Hand it to an inner function to avoid lots of unnecessary return tracepoints.
2559 */
2560 if (pSession->fUnrestricted)
2561 rc = supdrvIOCtlInnerUnrestricted(uIOCtl, pDevExt, pSession, pReqHdr);
2562 else
2563 rc = supdrvIOCtlInnerRestricted(uIOCtl, pDevExt, pSession, pReqHdr);
2564
2565 VBOXDRV_IOCTL_RETURN(pSession, uIOCtl, pReqHdr, pReqHdr->rc, rc);
2566 return rc;
2567}
2568
2569
2570/**
2571 * Inter-Driver Communication (IDC) worker.
2572 *
2573 * @returns VBox status code.
2574 * @retval VINF_SUCCESS on success.
2575 * @retval VERR_INVALID_PARAMETER if the request is invalid.
2576 * @retval VERR_NOT_SUPPORTED if the request isn't supported.
2577 *
2578 * @param uReq The request (function) code.
2579 * @param pDevExt Device extention.
2580 * @param pSession Session data.
2581 * @param pReqHdr The request header.
2582 */
2583int VBOXCALL supdrvIDC(uintptr_t uReq, PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPDRVIDCREQHDR pReqHdr)
2584{
2585 /*
2586 * The OS specific code has already validated the pSession
2587 * pointer, and the request size being greater or equal to
2588 * size of the header.
2589 *
2590 * So, just check that pSession is a kernel context session.
2591 */
2592 if (RT_UNLIKELY( pSession
2593 && pSession->R0Process != NIL_RTR0PROCESS))
2594 return VERR_INVALID_PARAMETER;
2595
2596/*
2597 * Validation macro.
2598 */
2599#define REQ_CHECK_IDC_SIZE(Name, cbExpect) \
2600 do { \
2601 if (RT_UNLIKELY(pReqHdr->cb != (cbExpect))) \
2602 { \
2603 OSDBGPRINT(( #Name ": Invalid input/output sizes. cb=%ld expected %ld.\n", \
2604 (long)pReqHdr->cb, (long)(cbExpect))); \
2605 return pReqHdr->rc = VERR_INVALID_PARAMETER; \
2606 } \
2607 } while (0)
2608
2609 switch (uReq)
2610 {
2611 case SUPDRV_IDC_REQ_CONNECT:
2612 {
2613 PSUPDRVIDCREQCONNECT pReq = (PSUPDRVIDCREQCONNECT)pReqHdr;
2614 REQ_CHECK_IDC_SIZE(SUPDRV_IDC_REQ_CONNECT, sizeof(*pReq));
2615
2616 /*
2617 * Validate the cookie and other input.
2618 */
2619 if (pReq->Hdr.pSession != NULL)
2620 {
2621 OSDBGPRINT(("SUPDRV_IDC_REQ_CONNECT: Hdr.pSession=%p expected NULL!\n", pReq->Hdr.pSession));
2622 return pReqHdr->rc = VERR_INVALID_PARAMETER;
2623 }
2624 if (pReq->u.In.u32MagicCookie != SUPDRVIDCREQ_CONNECT_MAGIC_COOKIE)
2625 {
2626 OSDBGPRINT(("SUPDRV_IDC_REQ_CONNECT: u32MagicCookie=%#x expected %#x!\n",
2627 (unsigned)pReq->u.In.u32MagicCookie, (unsigned)SUPDRVIDCREQ_CONNECT_MAGIC_COOKIE));
2628 return pReqHdr->rc = VERR_INVALID_PARAMETER;
2629 }
2630 if ( pReq->u.In.uMinVersion > pReq->u.In.uReqVersion
2631 || (pReq->u.In.uMinVersion & UINT32_C(0xffff0000)) != (pReq->u.In.uReqVersion & UINT32_C(0xffff0000)))
2632 {
2633 OSDBGPRINT(("SUPDRV_IDC_REQ_CONNECT: uMinVersion=%#x uMaxVersion=%#x doesn't match!\n",
2634 pReq->u.In.uMinVersion, pReq->u.In.uReqVersion));
2635 return pReqHdr->rc = VERR_INVALID_PARAMETER;
2636 }
2637 if (pSession != NULL)
2638 {
2639 OSDBGPRINT(("SUPDRV_IDC_REQ_CONNECT: pSession=%p expected NULL!\n", pSession));
2640 return pReqHdr->rc = VERR_INVALID_PARAMETER;
2641 }
2642
2643 /*
2644 * Match the version.
2645 * The current logic is very simple, match the major interface version.
2646 */
2647 if ( pReq->u.In.uMinVersion > SUPDRV_IDC_VERSION
2648 || (pReq->u.In.uMinVersion & 0xffff0000) != (SUPDRV_IDC_VERSION & 0xffff0000))
2649 {
2650 OSDBGPRINT(("SUPDRV_IDC_REQ_CONNECT: Version mismatch. Requested: %#x Min: %#x Current: %#x\n",
2651 pReq->u.In.uReqVersion, pReq->u.In.uMinVersion, (unsigned)SUPDRV_IDC_VERSION));
2652 pReq->u.Out.pSession = NULL;
2653 pReq->u.Out.uSessionVersion = 0xffffffff;
2654 pReq->u.Out.uDriverVersion = SUPDRV_IDC_VERSION;
2655 pReq->u.Out.uDriverRevision = VBOX_SVN_REV;
2656 pReq->Hdr.rc = VERR_VERSION_MISMATCH;
2657 return VINF_SUCCESS;
2658 }
2659
2660 pReq->u.Out.pSession = NULL;
2661 pReq->u.Out.uSessionVersion = SUPDRV_IDC_VERSION;
2662 pReq->u.Out.uDriverVersion = SUPDRV_IDC_VERSION;
2663 pReq->u.Out.uDriverRevision = VBOX_SVN_REV;
2664
2665 pReq->Hdr.rc = supdrvCreateSession(pDevExt, false /* fUser */, true /*fUnrestricted*/, &pSession);
2666 if (RT_FAILURE(pReq->Hdr.rc))
2667 {
2668 OSDBGPRINT(("SUPDRV_IDC_REQ_CONNECT: failed to create session, rc=%d\n", pReq->Hdr.rc));
2669 return VINF_SUCCESS;
2670 }
2671
2672 pReq->u.Out.pSession = pSession;
2673 pReq->Hdr.pSession = pSession;
2674
2675 return VINF_SUCCESS;
2676 }
2677
2678 case SUPDRV_IDC_REQ_DISCONNECT:
2679 {
2680 REQ_CHECK_IDC_SIZE(SUPDRV_IDC_REQ_DISCONNECT, sizeof(*pReqHdr));
2681
2682 supdrvSessionRelease(pSession);
2683 return pReqHdr->rc = VINF_SUCCESS;
2684 }
2685
2686 case SUPDRV_IDC_REQ_GET_SYMBOL:
2687 {
2688 PSUPDRVIDCREQGETSYM pReq = (PSUPDRVIDCREQGETSYM)pReqHdr;
2689 REQ_CHECK_IDC_SIZE(SUPDRV_IDC_REQ_GET_SYMBOL, sizeof(*pReq));
2690
2691 pReq->Hdr.rc = supdrvIDC_LdrGetSymbol(pDevExt, pSession, pReq);
2692 return VINF_SUCCESS;
2693 }
2694
2695 case SUPDRV_IDC_REQ_COMPONENT_REGISTER_FACTORY:
2696 {
2697 PSUPDRVIDCREQCOMPREGFACTORY pReq = (PSUPDRVIDCREQCOMPREGFACTORY)pReqHdr;
2698 REQ_CHECK_IDC_SIZE(SUPDRV_IDC_REQ_COMPONENT_REGISTER_FACTORY, sizeof(*pReq));
2699
2700 pReq->Hdr.rc = SUPR0ComponentRegisterFactory(pSession, pReq->u.In.pFactory);
2701 return VINF_SUCCESS;
2702 }
2703
2704 case SUPDRV_IDC_REQ_COMPONENT_DEREGISTER_FACTORY:
2705 {
2706 PSUPDRVIDCREQCOMPDEREGFACTORY pReq = (PSUPDRVIDCREQCOMPDEREGFACTORY)pReqHdr;
2707 REQ_CHECK_IDC_SIZE(SUPDRV_IDC_REQ_COMPONENT_DEREGISTER_FACTORY, sizeof(*pReq));
2708
2709 pReq->Hdr.rc = SUPR0ComponentDeregisterFactory(pSession, pReq->u.In.pFactory);
2710 return VINF_SUCCESS;
2711 }
2712
2713 default:
2714 Log(("Unknown IDC %#lx\n", (long)uReq));
2715 break;
2716 }
2717
2718#undef REQ_CHECK_IDC_SIZE
2719 return VERR_NOT_SUPPORTED;
2720}
2721
2722
2723/**
2724 * Register a object for reference counting.
2725 * The object is registered with one reference in the specified session.
2726 *
2727 * @returns Unique identifier on success (pointer).
2728 * All future reference must use this identifier.
2729 * @returns NULL on failure.
2730 * @param pSession The caller's session.
2731 * @param enmType The object type.
2732 * @param pfnDestructor The destructore function which will be called when the reference count reaches 0.
2733 * @param pvUser1 The first user argument.
2734 * @param pvUser2 The second user argument.
2735 */
2736SUPR0DECL(void *) SUPR0ObjRegister(PSUPDRVSESSION pSession, SUPDRVOBJTYPE enmType, PFNSUPDRVDESTRUCTOR pfnDestructor, void *pvUser1, void *pvUser2)
2737{
2738 PSUPDRVDEVEXT pDevExt = pSession->pDevExt;
2739 PSUPDRVOBJ pObj;
2740 PSUPDRVUSAGE pUsage;
2741
2742 /*
2743 * Validate the input.
2744 */
2745 AssertReturn(SUP_IS_SESSION_VALID(pSession), NULL);
2746 AssertReturn(enmType > SUPDRVOBJTYPE_INVALID && enmType < SUPDRVOBJTYPE_END, NULL);
2747 AssertPtrReturn(pfnDestructor, NULL);
2748
2749 /*
2750 * Allocate and initialize the object.
2751 */
2752 pObj = (PSUPDRVOBJ)RTMemAlloc(sizeof(*pObj));
2753 if (!pObj)
2754 return NULL;
2755 pObj->u32Magic = SUPDRVOBJ_MAGIC;
2756 pObj->enmType = enmType;
2757 pObj->pNext = NULL;
2758 pObj->cUsage = 1;
2759 pObj->pfnDestructor = pfnDestructor;
2760 pObj->pvUser1 = pvUser1;
2761 pObj->pvUser2 = pvUser2;
2762 pObj->CreatorUid = pSession->Uid;
2763 pObj->CreatorGid = pSession->Gid;
2764 pObj->CreatorProcess= pSession->Process;
2765 supdrvOSObjInitCreator(pObj, pSession);
2766
2767 /*
2768 * Allocate the usage record.
2769 * (We keep freed usage records around to simplify SUPR0ObjAddRefEx().)
2770 */
2771 RTSpinlockAcquire(pDevExt->Spinlock);
2772
2773 pUsage = pDevExt->pUsageFree;
2774 if (pUsage)
2775 pDevExt->pUsageFree = pUsage->pNext;
2776 else
2777 {
2778 RTSpinlockRelease(pDevExt->Spinlock);
2779 pUsage = (PSUPDRVUSAGE)RTMemAlloc(sizeof(*pUsage));
2780 if (!pUsage)
2781 {
2782 RTMemFree(pObj);
2783 return NULL;
2784 }
2785 RTSpinlockAcquire(pDevExt->Spinlock);
2786 }
2787
2788 /*
2789 * Insert the object and create the session usage record.
2790 */
2791 /* The object. */
2792 pObj->pNext = pDevExt->pObjs;
2793 pDevExt->pObjs = pObj;
2794
2795 /* The session record. */
2796 pUsage->cUsage = 1;
2797 pUsage->pObj = pObj;
2798 pUsage->pNext = pSession->pUsage;
2799 /* Log2(("SUPR0ObjRegister: pUsage=%p:{.pObj=%p, .pNext=%p}\n", pUsage, pUsage->pObj, pUsage->pNext)); */
2800 pSession->pUsage = pUsage;
2801
2802 RTSpinlockRelease(pDevExt->Spinlock);
2803
2804 Log(("SUPR0ObjRegister: returns %p (pvUser1=%p, pvUser=%p)\n", pObj, pvUser1, pvUser2));
2805 return pObj;
2806}
2807
2808
2809/**
2810 * Increment the reference counter for the object associating the reference
2811 * with the specified session.
2812 *
2813 * @returns IPRT status code.
2814 * @param pvObj The identifier returned by SUPR0ObjRegister().
2815 * @param pSession The session which is referencing the object.
2816 *
2817 * @remarks The caller should not own any spinlocks and must carefully protect
2818 * itself against potential race with the destructor so freed memory
2819 * isn't accessed here.
2820 */
2821SUPR0DECL(int) SUPR0ObjAddRef(void *pvObj, PSUPDRVSESSION pSession)
2822{
2823 return SUPR0ObjAddRefEx(pvObj, pSession, false /* fNoBlocking */);
2824}
2825
2826
2827/**
2828 * Increment the reference counter for the object associating the reference
2829 * with the specified session.
2830 *
2831 * @returns IPRT status code.
2832 * @retval VERR_TRY_AGAIN if fNoBlocking was set and a new usage record
2833 * couldn't be allocated. (If you see this you're not doing the right
2834 * thing and it won't ever work reliably.)
2835 *
2836 * @param pvObj The identifier returned by SUPR0ObjRegister().
2837 * @param pSession The session which is referencing the object.
2838 * @param fNoBlocking Set if it's not OK to block. Never try to make the
2839 * first reference to an object in a session with this
2840 * argument set.
2841 *
2842 * @remarks The caller should not own any spinlocks and must carefully protect
2843 * itself against potential race with the destructor so freed memory
2844 * isn't accessed here.
2845 */
2846SUPR0DECL(int) SUPR0ObjAddRefEx(void *pvObj, PSUPDRVSESSION pSession, bool fNoBlocking)
2847{
2848 PSUPDRVDEVEXT pDevExt = pSession->pDevExt;
2849 PSUPDRVOBJ pObj = (PSUPDRVOBJ)pvObj;
2850 int rc = VINF_SUCCESS;
2851 PSUPDRVUSAGE pUsagePre;
2852 PSUPDRVUSAGE pUsage;
2853
2854 /*
2855 * Validate the input.
2856 * Be ready for the destruction race (someone might be stuck in the
2857 * destructor waiting a lock we own).
2858 */
2859 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
2860 AssertPtrReturn(pObj, VERR_INVALID_POINTER);
2861 AssertMsgReturn(pObj->u32Magic == SUPDRVOBJ_MAGIC || pObj->u32Magic == SUPDRVOBJ_MAGIC_DEAD,
2862 ("Invalid pvObj=%p magic=%#x (expected %#x or %#x)\n", pvObj, pObj->u32Magic, SUPDRVOBJ_MAGIC, SUPDRVOBJ_MAGIC_DEAD),
2863 VERR_INVALID_PARAMETER);
2864
2865 RTSpinlockAcquire(pDevExt->Spinlock);
2866
2867 if (RT_UNLIKELY(pObj->u32Magic != SUPDRVOBJ_MAGIC))
2868 {
2869 RTSpinlockRelease(pDevExt->Spinlock);
2870
2871 AssertMsgFailed(("pvObj=%p magic=%#x\n", pvObj, pObj->u32Magic));
2872 return VERR_WRONG_ORDER;
2873 }
2874
2875 /*
2876 * Preallocate the usage record if we can.
2877 */
2878 pUsagePre = pDevExt->pUsageFree;
2879 if (pUsagePre)
2880 pDevExt->pUsageFree = pUsagePre->pNext;
2881 else if (!fNoBlocking)
2882 {
2883 RTSpinlockRelease(pDevExt->Spinlock);
2884 pUsagePre = (PSUPDRVUSAGE)RTMemAlloc(sizeof(*pUsagePre));
2885 if (!pUsagePre)
2886 return VERR_NO_MEMORY;
2887
2888 RTSpinlockAcquire(pDevExt->Spinlock);
2889 if (RT_UNLIKELY(pObj->u32Magic != SUPDRVOBJ_MAGIC))
2890 {
2891 RTSpinlockRelease(pDevExt->Spinlock);
2892
2893 AssertMsgFailed(("pvObj=%p magic=%#x\n", pvObj, pObj->u32Magic));
2894 return VERR_WRONG_ORDER;
2895 }
2896 }
2897
2898 /*
2899 * Reference the object.
2900 */
2901 pObj->cUsage++;
2902
2903 /*
2904 * Look for the session record.
2905 */
2906 for (pUsage = pSession->pUsage; pUsage; pUsage = pUsage->pNext)
2907 {
2908 /*Log(("SUPR0AddRef: pUsage=%p:{.pObj=%p, .pNext=%p}\n", pUsage, pUsage->pObj, pUsage->pNext));*/
2909 if (pUsage->pObj == pObj)
2910 break;
2911 }
2912 if (pUsage)
2913 pUsage->cUsage++;
2914 else if (pUsagePre)
2915 {
2916 /* create a new session record. */
2917 pUsagePre->cUsage = 1;
2918 pUsagePre->pObj = pObj;
2919 pUsagePre->pNext = pSession->pUsage;
2920 pSession->pUsage = pUsagePre;
2921 /*Log(("SUPR0AddRef: pUsagePre=%p:{.pObj=%p, .pNext=%p}\n", pUsagePre, pUsagePre->pObj, pUsagePre->pNext));*/
2922
2923 pUsagePre = NULL;
2924 }
2925 else
2926 {
2927 pObj->cUsage--;
2928 rc = VERR_TRY_AGAIN;
2929 }
2930
2931 /*
2932 * Put any unused usage record into the free list..
2933 */
2934 if (pUsagePre)
2935 {
2936 pUsagePre->pNext = pDevExt->pUsageFree;
2937 pDevExt->pUsageFree = pUsagePre;
2938 }
2939
2940 RTSpinlockRelease(pDevExt->Spinlock);
2941
2942 return rc;
2943}
2944
2945
2946/**
2947 * Decrement / destroy a reference counter record for an object.
2948 *
2949 * The object is uniquely identified by pfnDestructor+pvUser1+pvUser2.
2950 *
2951 * @returns IPRT status code.
2952 * @retval VINF_SUCCESS if not destroyed.
2953 * @retval VINF_OBJECT_DESTROYED if it's destroyed by this release call.
2954 * @retval VERR_INVALID_PARAMETER if the object isn't valid. Will assert in
2955 * string builds.
2956 *
2957 * @param pvObj The identifier returned by SUPR0ObjRegister().
2958 * @param pSession The session which is referencing the object.
2959 */
2960SUPR0DECL(int) SUPR0ObjRelease(void *pvObj, PSUPDRVSESSION pSession)
2961{
2962 PSUPDRVDEVEXT pDevExt = pSession->pDevExt;
2963 PSUPDRVOBJ pObj = (PSUPDRVOBJ)pvObj;
2964 int rc = VERR_INVALID_PARAMETER;
2965 PSUPDRVUSAGE pUsage;
2966 PSUPDRVUSAGE pUsagePrev;
2967
2968 /*
2969 * Validate the input.
2970 */
2971 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
2972 AssertMsgReturn(VALID_PTR(pObj)&& pObj->u32Magic == SUPDRVOBJ_MAGIC,
2973 ("Invalid pvObj=%p magic=%#x (expected %#x)\n", pvObj, pObj ? pObj->u32Magic : 0, SUPDRVOBJ_MAGIC),
2974 VERR_INVALID_PARAMETER);
2975
2976 /*
2977 * Acquire the spinlock and look for the usage record.
2978 */
2979 RTSpinlockAcquire(pDevExt->Spinlock);
2980
2981 for (pUsagePrev = NULL, pUsage = pSession->pUsage;
2982 pUsage;
2983 pUsagePrev = pUsage, pUsage = pUsage->pNext)
2984 {
2985 /*Log2(("SUPR0ObjRelease: pUsage=%p:{.pObj=%p, .pNext=%p}\n", pUsage, pUsage->pObj, pUsage->pNext));*/
2986 if (pUsage->pObj == pObj)
2987 {
2988 rc = VINF_SUCCESS;
2989 AssertMsg(pUsage->cUsage >= 1 && pObj->cUsage >= pUsage->cUsage, ("glob %d; sess %d\n", pObj->cUsage, pUsage->cUsage));
2990 if (pUsage->cUsage > 1)
2991 {
2992 pObj->cUsage--;
2993 pUsage->cUsage--;
2994 }
2995 else
2996 {
2997 /*
2998 * Free the session record.
2999 */
3000 if (pUsagePrev)
3001 pUsagePrev->pNext = pUsage->pNext;
3002 else
3003 pSession->pUsage = pUsage->pNext;
3004 pUsage->pNext = pDevExt->pUsageFree;
3005 pDevExt->pUsageFree = pUsage;
3006
3007 /* What about the object? */
3008 if (pObj->cUsage > 1)
3009 pObj->cUsage--;
3010 else
3011 {
3012 /*
3013 * Object is to be destroyed, unlink it.
3014 */
3015 pObj->u32Magic = SUPDRVOBJ_MAGIC_DEAD;
3016 rc = VINF_OBJECT_DESTROYED;
3017 if (pDevExt->pObjs == pObj)
3018 pDevExt->pObjs = pObj->pNext;
3019 else
3020 {
3021 PSUPDRVOBJ pObjPrev;
3022 for (pObjPrev = pDevExt->pObjs; pObjPrev; pObjPrev = pObjPrev->pNext)
3023 if (pObjPrev->pNext == pObj)
3024 {
3025 pObjPrev->pNext = pObj->pNext;
3026 break;
3027 }
3028 Assert(pObjPrev);
3029 }
3030 }
3031 }
3032 break;
3033 }
3034 }
3035
3036 RTSpinlockRelease(pDevExt->Spinlock);
3037
3038 /*
3039 * Call the destructor and free the object if required.
3040 */
3041 if (rc == VINF_OBJECT_DESTROYED)
3042 {
3043 Log(("SUPR0ObjRelease: destroying %p/%d (%p/%p) cpid=%RTproc pid=%RTproc dtor=%p\n",
3044 pObj, pObj->enmType, pObj->pvUser1, pObj->pvUser2, pObj->CreatorProcess, RTProcSelf(), pObj->pfnDestructor));
3045 if (pObj->pfnDestructor)
3046 pObj->pfnDestructor(pObj, pObj->pvUser1, pObj->pvUser2);
3047 RTMemFree(pObj);
3048 }
3049
3050 AssertMsg(pUsage, ("pvObj=%p\n", pvObj));
3051 return rc;
3052}
3053
3054
3055/**
3056 * Verifies that the current process can access the specified object.
3057 *
3058 * @returns The following IPRT status code:
3059 * @retval VINF_SUCCESS if access was granted.
3060 * @retval VERR_PERMISSION_DENIED if denied access.
3061 * @retval VERR_INVALID_PARAMETER if invalid parameter.
3062 *
3063 * @param pvObj The identifier returned by SUPR0ObjRegister().
3064 * @param pSession The session which wishes to access the object.
3065 * @param pszObjName Object string name. This is optional and depends on the object type.
3066 *
3067 * @remark The caller is responsible for making sure the object isn't removed while
3068 * we're inside this function. If uncertain about this, just call AddRef before calling us.
3069 */
3070SUPR0DECL(int) SUPR0ObjVerifyAccess(void *pvObj, PSUPDRVSESSION pSession, const char *pszObjName)
3071{
3072 PSUPDRVOBJ pObj = (PSUPDRVOBJ)pvObj;
3073 int rc;
3074
3075 /*
3076 * Validate the input.
3077 */
3078 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3079 AssertMsgReturn(VALID_PTR(pObj) && pObj->u32Magic == SUPDRVOBJ_MAGIC,
3080 ("Invalid pvObj=%p magic=%#x (exepcted %#x)\n", pvObj, pObj ? pObj->u32Magic : 0, SUPDRVOBJ_MAGIC),
3081 VERR_INVALID_PARAMETER);
3082
3083 /*
3084 * Check access. (returns true if a decision has been made.)
3085 */
3086 rc = VERR_INTERNAL_ERROR;
3087 if (supdrvOSObjCanAccess(pObj, pSession, pszObjName, &rc))
3088 return rc;
3089
3090 /*
3091 * Default policy is to allow the user to access his own
3092 * stuff but nothing else.
3093 */
3094 if (pObj->CreatorUid == pSession->Uid)
3095 return VINF_SUCCESS;
3096 return VERR_PERMISSION_DENIED;
3097}
3098
3099
3100/**
3101 * API for the VMMR0 module to get the SUPDRVSESSION::pSessionVM member.
3102 *
3103 * @returns The associated VM pointer.
3104 * @param pSession The session of the current thread.
3105 */
3106SUPR0DECL(PVM) SUPR0GetSessionVM(PSUPDRVSESSION pSession)
3107{
3108 AssertReturn(SUP_IS_SESSION_VALID(pSession), NULL);
3109 return pSession->pSessionVM;
3110}
3111
3112
3113/**
3114 * API for the VMMR0 module to get the SUPDRVSESSION::pSessionGVM member.
3115 *
3116 * @returns The associated GVM pointer.
3117 * @param pSession The session of the current thread.
3118 */
3119SUPR0DECL(PGVM) SUPR0GetSessionGVM(PSUPDRVSESSION pSession)
3120{
3121 AssertReturn(SUP_IS_SESSION_VALID(pSession), NULL);
3122 return pSession->pSessionGVM;
3123}
3124
3125
3126/**
3127 * API for the VMMR0 module to work the SUPDRVSESSION::pSessionVM member.
3128 *
3129 * This will fail if there is already a VM associated with the session and pVM
3130 * isn't NULL.
3131 *
3132 * @retval VINF_SUCCESS
3133 * @retval VERR_ALREADY_EXISTS if there already is a VM associated with the
3134 * session.
3135 * @retval VERR_INVALID_PARAMETER if only one of the parameters are NULL or if
3136 * the session is invalid.
3137 *
3138 * @param pSession The session of the current thread.
3139 * @param pGVM The GVM to associate with the session. Pass NULL to
3140 * dissassociate.
3141 * @param pVM The VM to associate with the session. Pass NULL to
3142 * dissassociate.
3143 */
3144SUPR0DECL(int) SUPR0SetSessionVM(PSUPDRVSESSION pSession, PGVM pGVM, PVM pVM)
3145{
3146 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3147 AssertReturn((pGVM != NULL) == (pVM != NULL), VERR_INVALID_PARAMETER);
3148
3149 RTSpinlockAcquire(pSession->pDevExt->Spinlock);
3150 if (pGVM)
3151 {
3152 if (!pSession->pSessionGVM)
3153 {
3154 pSession->pSessionGVM = pGVM;
3155 pSession->pSessionVM = pVM;
3156 pSession->pFastIoCtrlVM = NULL;
3157 }
3158 else
3159 {
3160 RTSpinlockRelease(pSession->pDevExt->Spinlock);
3161 SUPR0Printf("SUPR0SetSessionVM: Unable to associated GVM/VM %p/%p with session %p as it has %p/%p already!\n",
3162 pGVM, pVM, pSession, pSession->pSessionGVM, pSession->pSessionVM);
3163 return VERR_ALREADY_EXISTS;
3164 }
3165 }
3166 else
3167 {
3168 pSession->pSessionGVM = NULL;
3169 pSession->pSessionVM = NULL;
3170 pSession->pFastIoCtrlVM = NULL;
3171 }
3172 RTSpinlockRelease(pSession->pDevExt->Spinlock);
3173 return VINF_SUCCESS;
3174}
3175
3176
3177/**
3178 * Lock pages.
3179 *
3180 * @returns IPRT status code.
3181 * @param pSession Session to which the locked memory should be associated.
3182 * @param pvR3 Start of the memory range to lock.
3183 * This must be page aligned.
3184 * @param cPages Number of pages to lock.
3185 * @param paPages Where to put the physical addresses of locked memory.
3186 */
3187SUPR0DECL(int) SUPR0LockMem(PSUPDRVSESSION pSession, RTR3PTR pvR3, uint32_t cPages, PRTHCPHYS paPages)
3188{
3189 int rc;
3190 SUPDRVMEMREF Mem = { NIL_RTR0MEMOBJ, NIL_RTR0MEMOBJ, MEMREF_TYPE_UNUSED };
3191 const size_t cb = (size_t)cPages << PAGE_SHIFT;
3192 LogFlow(("SUPR0LockMem: pSession=%p pvR3=%p cPages=%d paPages=%p\n", pSession, (void *)pvR3, cPages, paPages));
3193
3194 /*
3195 * Verify input.
3196 */
3197 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3198 AssertPtrReturn(paPages, VERR_INVALID_PARAMETER);
3199 if ( RT_ALIGN_R3PT(pvR3, PAGE_SIZE, RTR3PTR) != pvR3
3200 || !pvR3)
3201 {
3202 Log(("pvR3 (%p) must be page aligned and not NULL!\n", (void *)pvR3));
3203 return VERR_INVALID_PARAMETER;
3204 }
3205
3206 /*
3207 * Let IPRT do the job.
3208 */
3209 Mem.eType = MEMREF_TYPE_LOCKED;
3210 rc = RTR0MemObjLockUser(&Mem.MemObj, pvR3, cb, RTMEM_PROT_READ | RTMEM_PROT_WRITE, NIL_RTR0PROCESS);
3211 if (RT_SUCCESS(rc))
3212 {
3213 uint32_t iPage = cPages;
3214 AssertMsg(RTR0MemObjAddressR3(Mem.MemObj) == pvR3, ("%p == %p\n", RTR0MemObjAddressR3(Mem.MemObj), pvR3));
3215 AssertMsg(RTR0MemObjSize(Mem.MemObj) == cb, ("%x == %x\n", RTR0MemObjSize(Mem.MemObj), cb));
3216
3217 while (iPage-- > 0)
3218 {
3219 paPages[iPage] = RTR0MemObjGetPagePhysAddr(Mem.MemObj, iPage);
3220 if (RT_UNLIKELY(paPages[iPage] == NIL_RTCCPHYS))
3221 {
3222 AssertMsgFailed(("iPage=%d\n", iPage));
3223 rc = VERR_INTERNAL_ERROR;
3224 break;
3225 }
3226 }
3227 if (RT_SUCCESS(rc))
3228 rc = supdrvMemAdd(&Mem, pSession);
3229 if (RT_FAILURE(rc))
3230 {
3231 int rc2 = RTR0MemObjFree(Mem.MemObj, false);
3232 AssertRC(rc2);
3233 }
3234 }
3235
3236 return rc;
3237}
3238
3239
3240/**
3241 * Unlocks the memory pointed to by pv.
3242 *
3243 * @returns IPRT status code.
3244 * @param pSession Session to which the memory was locked.
3245 * @param pvR3 Memory to unlock.
3246 */
3247SUPR0DECL(int) SUPR0UnlockMem(PSUPDRVSESSION pSession, RTR3PTR pvR3)
3248{
3249 LogFlow(("SUPR0UnlockMem: pSession=%p pvR3=%p\n", pSession, (void *)pvR3));
3250 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3251 return supdrvMemRelease(pSession, (RTHCUINTPTR)pvR3, MEMREF_TYPE_LOCKED);
3252}
3253
3254
3255/**
3256 * Allocates a chunk of page aligned memory with contiguous and fixed physical
3257 * backing.
3258 *
3259 * @returns IPRT status code.
3260 * @param pSession Session data.
3261 * @param cPages Number of pages to allocate.
3262 * @param ppvR0 Where to put the address of Ring-0 mapping the allocated memory.
3263 * @param ppvR3 Where to put the address of Ring-3 mapping the allocated memory.
3264 * @param pHCPhys Where to put the physical address of allocated memory.
3265 */
3266SUPR0DECL(int) SUPR0ContAlloc(PSUPDRVSESSION pSession, uint32_t cPages, PRTR0PTR ppvR0, PRTR3PTR ppvR3, PRTHCPHYS pHCPhys)
3267{
3268 int rc;
3269 SUPDRVMEMREF Mem = { NIL_RTR0MEMOBJ, NIL_RTR0MEMOBJ, MEMREF_TYPE_UNUSED };
3270 LogFlow(("SUPR0ContAlloc: pSession=%p cPages=%d ppvR0=%p ppvR3=%p pHCPhys=%p\n", pSession, cPages, ppvR0, ppvR3, pHCPhys));
3271
3272 /*
3273 * Validate input.
3274 */
3275 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3276 if (!ppvR3 || !ppvR0 || !pHCPhys)
3277 {
3278 Log(("Null pointer. All of these should be set: pSession=%p ppvR0=%p ppvR3=%p pHCPhys=%p\n",
3279 pSession, ppvR0, ppvR3, pHCPhys));
3280 return VERR_INVALID_PARAMETER;
3281
3282 }
3283 if (cPages < 1 || cPages >= 256)
3284 {
3285 Log(("Illegal request cPages=%d, must be greater than 0 and smaller than 256.\n", cPages));
3286 return VERR_PAGE_COUNT_OUT_OF_RANGE;
3287 }
3288
3289 /*
3290 * Let IPRT do the job.
3291 */
3292 rc = RTR0MemObjAllocCont(&Mem.MemObj, cPages << PAGE_SHIFT, true /* executable R0 mapping */);
3293 if (RT_SUCCESS(rc))
3294 {
3295 int rc2;
3296 rc = RTR0MemObjMapUser(&Mem.MapObjR3, Mem.MemObj, (RTR3PTR)-1, 0,
3297 RTMEM_PROT_EXEC | RTMEM_PROT_WRITE | RTMEM_PROT_READ, NIL_RTR0PROCESS);
3298 if (RT_SUCCESS(rc))
3299 {
3300 Mem.eType = MEMREF_TYPE_CONT;
3301 rc = supdrvMemAdd(&Mem, pSession);
3302 if (!rc)
3303 {
3304 *ppvR0 = RTR0MemObjAddress(Mem.MemObj);
3305 *ppvR3 = RTR0MemObjAddressR3(Mem.MapObjR3);
3306 *pHCPhys = RTR0MemObjGetPagePhysAddr(Mem.MemObj, 0);
3307 return 0;
3308 }
3309
3310 rc2 = RTR0MemObjFree(Mem.MapObjR3, false);
3311 AssertRC(rc2);
3312 }
3313 rc2 = RTR0MemObjFree(Mem.MemObj, false);
3314 AssertRC(rc2);
3315 }
3316
3317 return rc;
3318}
3319
3320
3321/**
3322 * Frees memory allocated using SUPR0ContAlloc().
3323 *
3324 * @returns IPRT status code.
3325 * @param pSession The session to which the memory was allocated.
3326 * @param uPtr Pointer to the memory (ring-3 or ring-0).
3327 */
3328SUPR0DECL(int) SUPR0ContFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr)
3329{
3330 LogFlow(("SUPR0ContFree: pSession=%p uPtr=%p\n", pSession, (void *)uPtr));
3331 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3332 return supdrvMemRelease(pSession, uPtr, MEMREF_TYPE_CONT);
3333}
3334
3335
3336/**
3337 * Allocates a chunk of page aligned memory with fixed physical backing below 4GB.
3338 *
3339 * The memory isn't zeroed.
3340 *
3341 * @returns IPRT status code.
3342 * @param pSession Session data.
3343 * @param cPages Number of pages to allocate.
3344 * @param ppvR0 Where to put the address of Ring-0 mapping of the allocated memory.
3345 * @param ppvR3 Where to put the address of Ring-3 mapping of the allocated memory.
3346 * @param paPages Where to put the physical addresses of allocated memory.
3347 */
3348SUPR0DECL(int) SUPR0LowAlloc(PSUPDRVSESSION pSession, uint32_t cPages, PRTR0PTR ppvR0, PRTR3PTR ppvR3, PRTHCPHYS paPages)
3349{
3350 unsigned iPage;
3351 int rc;
3352 SUPDRVMEMREF Mem = { NIL_RTR0MEMOBJ, NIL_RTR0MEMOBJ, MEMREF_TYPE_UNUSED };
3353 LogFlow(("SUPR0LowAlloc: pSession=%p cPages=%d ppvR3=%p ppvR0=%p paPages=%p\n", pSession, cPages, ppvR3, ppvR0, paPages));
3354
3355 /*
3356 * Validate input.
3357 */
3358 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3359 if (!ppvR3 || !ppvR0 || !paPages)
3360 {
3361 Log(("Null pointer. All of these should be set: pSession=%p ppvR3=%p ppvR0=%p paPages=%p\n",
3362 pSession, ppvR3, ppvR0, paPages));
3363 return VERR_INVALID_PARAMETER;
3364
3365 }
3366 if (cPages < 1 || cPages >= 256)
3367 {
3368 Log(("Illegal request cPages=%d, must be greater than 0 and smaller than 256.\n", cPages));
3369 return VERR_PAGE_COUNT_OUT_OF_RANGE;
3370 }
3371
3372 /*
3373 * Let IPRT do the work.
3374 */
3375 rc = RTR0MemObjAllocLow(&Mem.MemObj, cPages << PAGE_SHIFT, true /* executable ring-0 mapping */);
3376 if (RT_SUCCESS(rc))
3377 {
3378 int rc2;
3379 rc = RTR0MemObjMapUser(&Mem.MapObjR3, Mem.MemObj, (RTR3PTR)-1, 0,
3380 RTMEM_PROT_EXEC | RTMEM_PROT_WRITE | RTMEM_PROT_READ, NIL_RTR0PROCESS);
3381 if (RT_SUCCESS(rc))
3382 {
3383 Mem.eType = MEMREF_TYPE_LOW;
3384 rc = supdrvMemAdd(&Mem, pSession);
3385 if (!rc)
3386 {
3387 for (iPage = 0; iPage < cPages; iPage++)
3388 {
3389 paPages[iPage] = RTR0MemObjGetPagePhysAddr(Mem.MemObj, iPage);
3390 AssertMsg(!(paPages[iPage] & (PAGE_SIZE - 1)), ("iPage=%d Phys=%RHp\n", paPages[iPage]));
3391 }
3392 *ppvR0 = RTR0MemObjAddress(Mem.MemObj);
3393 *ppvR3 = RTR0MemObjAddressR3(Mem.MapObjR3);
3394 return 0;
3395 }
3396
3397 rc2 = RTR0MemObjFree(Mem.MapObjR3, false);
3398 AssertRC(rc2);
3399 }
3400
3401 rc2 = RTR0MemObjFree(Mem.MemObj, false);
3402 AssertRC(rc2);
3403 }
3404
3405 return rc;
3406}
3407
3408
3409/**
3410 * Frees memory allocated using SUPR0LowAlloc().
3411 *
3412 * @returns IPRT status code.
3413 * @param pSession The session to which the memory was allocated.
3414 * @param uPtr Pointer to the memory (ring-3 or ring-0).
3415 */
3416SUPR0DECL(int) SUPR0LowFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr)
3417{
3418 LogFlow(("SUPR0LowFree: pSession=%p uPtr=%p\n", pSession, (void *)uPtr));
3419 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3420 return supdrvMemRelease(pSession, uPtr, MEMREF_TYPE_LOW);
3421}
3422
3423
3424
3425/**
3426 * Allocates a chunk of memory with both R0 and R3 mappings.
3427 * The memory is fixed and it's possible to query the physical addresses using SUPR0MemGetPhys().
3428 *
3429 * @returns IPRT status code.
3430 * @param pSession The session to associated the allocation with.
3431 * @param cb Number of bytes to allocate.
3432 * @param ppvR0 Where to store the address of the Ring-0 mapping.
3433 * @param ppvR3 Where to store the address of the Ring-3 mapping.
3434 */
3435SUPR0DECL(int) SUPR0MemAlloc(PSUPDRVSESSION pSession, uint32_t cb, PRTR0PTR ppvR0, PRTR3PTR ppvR3)
3436{
3437 int rc;
3438 SUPDRVMEMREF Mem = { NIL_RTR0MEMOBJ, NIL_RTR0MEMOBJ, MEMREF_TYPE_UNUSED };
3439 LogFlow(("SUPR0MemAlloc: pSession=%p cb=%d ppvR0=%p ppvR3=%p\n", pSession, cb, ppvR0, ppvR3));
3440
3441 /*
3442 * Validate input.
3443 */
3444 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3445 AssertPtrReturn(ppvR0, VERR_INVALID_POINTER);
3446 AssertPtrReturn(ppvR3, VERR_INVALID_POINTER);
3447 if (cb < 1 || cb >= _4M)
3448 {
3449 Log(("Illegal request cb=%u; must be greater than 0 and smaller than 4MB.\n", cb));
3450 return VERR_INVALID_PARAMETER;
3451 }
3452
3453 /*
3454 * Let IPRT do the work.
3455 */
3456 rc = RTR0MemObjAllocPage(&Mem.MemObj, cb, true /* executable ring-0 mapping */);
3457 if (RT_SUCCESS(rc))
3458 {
3459 int rc2;
3460 rc = RTR0MemObjMapUser(&Mem.MapObjR3, Mem.MemObj, (RTR3PTR)-1, 0,
3461 RTMEM_PROT_EXEC | RTMEM_PROT_WRITE | RTMEM_PROT_READ, NIL_RTR0PROCESS);
3462 if (RT_SUCCESS(rc))
3463 {
3464 Mem.eType = MEMREF_TYPE_MEM;
3465 rc = supdrvMemAdd(&Mem, pSession);
3466 if (!rc)
3467 {
3468 *ppvR0 = RTR0MemObjAddress(Mem.MemObj);
3469 *ppvR3 = RTR0MemObjAddressR3(Mem.MapObjR3);
3470 return VINF_SUCCESS;
3471 }
3472
3473 rc2 = RTR0MemObjFree(Mem.MapObjR3, false);
3474 AssertRC(rc2);
3475 }
3476
3477 rc2 = RTR0MemObjFree(Mem.MemObj, false);
3478 AssertRC(rc2);
3479 }
3480
3481 return rc;
3482}
3483
3484
3485/**
3486 * Get the physical addresses of memory allocated using SUPR0MemAlloc().
3487 *
3488 * @returns IPRT status code.
3489 * @param pSession The session to which the memory was allocated.
3490 * @param uPtr The Ring-0 or Ring-3 address returned by SUPR0MemAlloc().
3491 * @param paPages Where to store the physical addresses.
3492 */
3493SUPR0DECL(int) SUPR0MemGetPhys(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr, PSUPPAGE paPages) /** @todo switch this bugger to RTHCPHYS */
3494{
3495 PSUPDRVBUNDLE pBundle;
3496 LogFlow(("SUPR0MemGetPhys: pSession=%p uPtr=%p paPages=%p\n", pSession, (void *)uPtr, paPages));
3497
3498 /*
3499 * Validate input.
3500 */
3501 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3502 AssertPtrReturn(paPages, VERR_INVALID_POINTER);
3503 AssertReturn(uPtr, VERR_INVALID_PARAMETER);
3504
3505 /*
3506 * Search for the address.
3507 */
3508 RTSpinlockAcquire(pSession->Spinlock);
3509 for (pBundle = &pSession->Bundle; pBundle; pBundle = pBundle->pNext)
3510 {
3511 if (pBundle->cUsed > 0)
3512 {
3513 unsigned i;
3514 for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
3515 {
3516 if ( pBundle->aMem[i].eType == MEMREF_TYPE_MEM
3517 && pBundle->aMem[i].MemObj != NIL_RTR0MEMOBJ
3518 && ( (RTHCUINTPTR)RTR0MemObjAddress(pBundle->aMem[i].MemObj) == uPtr
3519 || ( pBundle->aMem[i].MapObjR3 != NIL_RTR0MEMOBJ
3520 && RTR0MemObjAddressR3(pBundle->aMem[i].MapObjR3) == uPtr)
3521 )
3522 )
3523 {
3524 const size_t cPages = RTR0MemObjSize(pBundle->aMem[i].MemObj) >> PAGE_SHIFT;
3525 size_t iPage;
3526 for (iPage = 0; iPage < cPages; iPage++)
3527 {
3528 paPages[iPage].Phys = RTR0MemObjGetPagePhysAddr(pBundle->aMem[i].MemObj, iPage);
3529 paPages[iPage].uReserved = 0;
3530 }
3531 RTSpinlockRelease(pSession->Spinlock);
3532 return VINF_SUCCESS;
3533 }
3534 }
3535 }
3536 }
3537 RTSpinlockRelease(pSession->Spinlock);
3538 Log(("Failed to find %p!!!\n", (void *)uPtr));
3539 return VERR_INVALID_PARAMETER;
3540}
3541
3542
3543/**
3544 * Free memory allocated by SUPR0MemAlloc().
3545 *
3546 * @returns IPRT status code.
3547 * @param pSession The session owning the allocation.
3548 * @param uPtr The Ring-0 or Ring-3 address returned by SUPR0MemAlloc().
3549 */
3550SUPR0DECL(int) SUPR0MemFree(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr)
3551{
3552 LogFlow(("SUPR0MemFree: pSession=%p uPtr=%p\n", pSession, (void *)uPtr));
3553 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3554 return supdrvMemRelease(pSession, uPtr, MEMREF_TYPE_MEM);
3555}
3556
3557
3558/**
3559 * Allocates a chunk of memory with a kernel or/and a user mode mapping.
3560 *
3561 * The memory is fixed and it's possible to query the physical addresses using
3562 * SUPR0MemGetPhys().
3563 *
3564 * @returns IPRT status code.
3565 * @param pSession The session to associated the allocation with.
3566 * @param cPages The number of pages to allocate.
3567 * @param fFlags Flags, reserved for the future. Must be zero.
3568 * @param ppvR3 Where to store the address of the Ring-3 mapping.
3569 * NULL if no ring-3 mapping.
3570 * @param ppvR0 Where to store the address of the Ring-0 mapping.
3571 * NULL if no ring-0 mapping.
3572 * @param paPages Where to store the addresses of the pages. Optional.
3573 */
3574SUPR0DECL(int) SUPR0PageAllocEx(PSUPDRVSESSION pSession, uint32_t cPages, uint32_t fFlags, PRTR3PTR ppvR3, PRTR0PTR ppvR0, PRTHCPHYS paPages)
3575{
3576 int rc;
3577 SUPDRVMEMREF Mem = { NIL_RTR0MEMOBJ, NIL_RTR0MEMOBJ, MEMREF_TYPE_UNUSED };
3578 LogFlow(("SUPR0PageAlloc: pSession=%p cb=%d ppvR3=%p\n", pSession, cPages, ppvR3));
3579
3580 /*
3581 * Validate input. The allowed allocation size must be at least equal to the maximum guest VRAM size.
3582 */
3583 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3584 AssertPtrNullReturn(ppvR3, VERR_INVALID_POINTER);
3585 AssertPtrNullReturn(ppvR0, VERR_INVALID_POINTER);
3586 AssertReturn(ppvR3 || ppvR0, VERR_INVALID_PARAMETER);
3587 AssertReturn(!fFlags, VERR_INVALID_PARAMETER);
3588 if (cPages < 1 || cPages > VBOX_MAX_ALLOC_PAGE_COUNT)
3589 {
3590 Log(("SUPR0PageAlloc: Illegal request cb=%u; must be greater than 0 and smaller than %uMB (VBOX_MAX_ALLOC_PAGE_COUNT pages).\n", cPages, VBOX_MAX_ALLOC_PAGE_COUNT * (_1M / _4K)));
3591 return VERR_PAGE_COUNT_OUT_OF_RANGE;
3592 }
3593
3594 /*
3595 * Let IPRT do the work.
3596 */
3597 if (ppvR0)
3598 rc = RTR0MemObjAllocPage(&Mem.MemObj, (size_t)cPages * PAGE_SIZE, true /* fExecutable */);
3599 else
3600 rc = RTR0MemObjAllocPhysNC(&Mem.MemObj, (size_t)cPages * PAGE_SIZE, NIL_RTHCPHYS);
3601 if (RT_SUCCESS(rc))
3602 {
3603 int rc2;
3604 if (ppvR3)
3605 rc = RTR0MemObjMapUser(&Mem.MapObjR3, Mem.MemObj, (RTR3PTR)-1, 0,
3606 RTMEM_PROT_EXEC | RTMEM_PROT_WRITE | RTMEM_PROT_READ, NIL_RTR0PROCESS);
3607 else
3608 Mem.MapObjR3 = NIL_RTR0MEMOBJ;
3609 if (RT_SUCCESS(rc))
3610 {
3611 Mem.eType = MEMREF_TYPE_PAGE;
3612 rc = supdrvMemAdd(&Mem, pSession);
3613 if (!rc)
3614 {
3615 if (ppvR3)
3616 *ppvR3 = RTR0MemObjAddressR3(Mem.MapObjR3);
3617 if (ppvR0)
3618 *ppvR0 = RTR0MemObjAddress(Mem.MemObj);
3619 if (paPages)
3620 {
3621 uint32_t iPage = cPages;
3622 while (iPage-- > 0)
3623 {
3624 paPages[iPage] = RTR0MemObjGetPagePhysAddr(Mem.MapObjR3, iPage);
3625 Assert(paPages[iPage] != NIL_RTHCPHYS);
3626 }
3627 }
3628 return VINF_SUCCESS;
3629 }
3630
3631 rc2 = RTR0MemObjFree(Mem.MapObjR3, false);
3632 AssertRC(rc2);
3633 }
3634
3635 rc2 = RTR0MemObjFree(Mem.MemObj, false);
3636 AssertRC(rc2);
3637 }
3638 return rc;
3639}
3640
3641
3642/**
3643 * Maps a chunk of memory previously allocated by SUPR0PageAllocEx into kernel
3644 * space.
3645 *
3646 * @returns IPRT status code.
3647 * @param pSession The session to associated the allocation with.
3648 * @param pvR3 The ring-3 address returned by SUPR0PageAllocEx.
3649 * @param offSub Where to start mapping. Must be page aligned.
3650 * @param cbSub How much to map. Must be page aligned.
3651 * @param fFlags Flags, MBZ.
3652 * @param ppvR0 Where to return the address of the ring-0 mapping on
3653 * success.
3654 */
3655SUPR0DECL(int) SUPR0PageMapKernel(PSUPDRVSESSION pSession, RTR3PTR pvR3, uint32_t offSub, uint32_t cbSub,
3656 uint32_t fFlags, PRTR0PTR ppvR0)
3657{
3658 int rc;
3659 PSUPDRVBUNDLE pBundle;
3660 RTR0MEMOBJ hMemObj = NIL_RTR0MEMOBJ;
3661 LogFlow(("SUPR0PageMapKernel: pSession=%p pvR3=%p offSub=%#x cbSub=%#x\n", pSession, pvR3, offSub, cbSub));
3662
3663 /*
3664 * Validate input. The allowed allocation size must be at least equal to the maximum guest VRAM size.
3665 */
3666 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3667 AssertPtrNullReturn(ppvR0, VERR_INVALID_POINTER);
3668 AssertReturn(!fFlags, VERR_INVALID_PARAMETER);
3669 AssertReturn(!(offSub & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
3670 AssertReturn(!(cbSub & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
3671 AssertReturn(cbSub, VERR_INVALID_PARAMETER);
3672
3673 /*
3674 * Find the memory object.
3675 */
3676 RTSpinlockAcquire(pSession->Spinlock);
3677 for (pBundle = &pSession->Bundle; pBundle; pBundle = pBundle->pNext)
3678 {
3679 if (pBundle->cUsed > 0)
3680 {
3681 unsigned i;
3682 for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
3683 {
3684 if ( ( pBundle->aMem[i].eType == MEMREF_TYPE_PAGE
3685 && pBundle->aMem[i].MemObj != NIL_RTR0MEMOBJ
3686 && pBundle->aMem[i].MapObjR3 != NIL_RTR0MEMOBJ
3687 && RTR0MemObjAddressR3(pBundle->aMem[i].MapObjR3) == pvR3)
3688 || ( pBundle->aMem[i].eType == MEMREF_TYPE_LOCKED
3689 && pBundle->aMem[i].MemObj != NIL_RTR0MEMOBJ
3690 && pBundle->aMem[i].MapObjR3 == NIL_RTR0MEMOBJ
3691 && RTR0MemObjAddressR3(pBundle->aMem[i].MemObj) == pvR3))
3692 {
3693 hMemObj = pBundle->aMem[i].MemObj;
3694 break;
3695 }
3696 }
3697 }
3698 }
3699 RTSpinlockRelease(pSession->Spinlock);
3700
3701 rc = VERR_INVALID_PARAMETER;
3702 if (hMemObj != NIL_RTR0MEMOBJ)
3703 {
3704 /*
3705 * Do some further input validations before calling IPRT.
3706 * (Cleanup is done indirectly by telling RTR0MemObjFree to include mappings.)
3707 */
3708 size_t cbMemObj = RTR0MemObjSize(hMemObj);
3709 if ( offSub < cbMemObj
3710 && cbSub <= cbMemObj
3711 && offSub + cbSub <= cbMemObj)
3712 {
3713 RTR0MEMOBJ hMapObj;
3714 rc = RTR0MemObjMapKernelEx(&hMapObj, hMemObj, (void *)-1, 0,
3715 RTMEM_PROT_READ | RTMEM_PROT_WRITE, offSub, cbSub);
3716 if (RT_SUCCESS(rc))
3717 *ppvR0 = RTR0MemObjAddress(hMapObj);
3718 }
3719 else
3720 SUPR0Printf("SUPR0PageMapKernel: cbMemObj=%#x offSub=%#x cbSub=%#x\n", cbMemObj, offSub, cbSub);
3721
3722 }
3723 return rc;
3724}
3725
3726
3727/**
3728 * Changes the page level protection of one or more pages previously allocated
3729 * by SUPR0PageAllocEx.
3730 *
3731 * @returns IPRT status code.
3732 * @param pSession The session to associated the allocation with.
3733 * @param pvR3 The ring-3 address returned by SUPR0PageAllocEx.
3734 * NIL_RTR3PTR if the ring-3 mapping should be unaffected.
3735 * @param pvR0 The ring-0 address returned by SUPR0PageAllocEx.
3736 * NIL_RTR0PTR if the ring-0 mapping should be unaffected.
3737 * @param offSub Where to start changing. Must be page aligned.
3738 * @param cbSub How much to change. Must be page aligned.
3739 * @param fProt The new page level protection, see RTMEM_PROT_*.
3740 */
3741SUPR0DECL(int) SUPR0PageProtect(PSUPDRVSESSION pSession, RTR3PTR pvR3, RTR0PTR pvR0, uint32_t offSub, uint32_t cbSub, uint32_t fProt)
3742{
3743 int rc;
3744 PSUPDRVBUNDLE pBundle;
3745 RTR0MEMOBJ hMemObjR0 = NIL_RTR0MEMOBJ;
3746 RTR0MEMOBJ hMemObjR3 = NIL_RTR0MEMOBJ;
3747 LogFlow(("SUPR0PageProtect: pSession=%p pvR3=%p pvR0=%p offSub=%#x cbSub=%#x fProt-%#x\n", pSession, pvR3, pvR0, offSub, cbSub, fProt));
3748
3749 /*
3750 * Validate input. The allowed allocation size must be at least equal to the maximum guest VRAM size.
3751 */
3752 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3753 AssertReturn(!(fProt & ~(RTMEM_PROT_READ | RTMEM_PROT_WRITE | RTMEM_PROT_EXEC | RTMEM_PROT_NONE)), VERR_INVALID_PARAMETER);
3754 AssertReturn(!(offSub & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
3755 AssertReturn(!(cbSub & PAGE_OFFSET_MASK), VERR_INVALID_PARAMETER);
3756 AssertReturn(cbSub, VERR_INVALID_PARAMETER);
3757
3758 /*
3759 * Find the memory object.
3760 */
3761 RTSpinlockAcquire(pSession->Spinlock);
3762 for (pBundle = &pSession->Bundle; pBundle; pBundle = pBundle->pNext)
3763 {
3764 if (pBundle->cUsed > 0)
3765 {
3766 unsigned i;
3767 for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
3768 {
3769 if ( pBundle->aMem[i].eType == MEMREF_TYPE_PAGE
3770 && pBundle->aMem[i].MemObj != NIL_RTR0MEMOBJ
3771 && ( pBundle->aMem[i].MapObjR3 != NIL_RTR0MEMOBJ
3772 || pvR3 == NIL_RTR3PTR)
3773 && ( pvR0 == NIL_RTR0PTR
3774 || RTR0MemObjAddress(pBundle->aMem[i].MemObj) == pvR0)
3775 && ( pvR3 == NIL_RTR3PTR
3776 || RTR0MemObjAddressR3(pBundle->aMem[i].MapObjR3) == pvR3))
3777 {
3778 if (pvR0 != NIL_RTR0PTR)
3779 hMemObjR0 = pBundle->aMem[i].MemObj;
3780 if (pvR3 != NIL_RTR3PTR)
3781 hMemObjR3 = pBundle->aMem[i].MapObjR3;
3782 break;
3783 }
3784 }
3785 }
3786 }
3787 RTSpinlockRelease(pSession->Spinlock);
3788
3789 rc = VERR_INVALID_PARAMETER;
3790 if ( hMemObjR0 != NIL_RTR0MEMOBJ
3791 || hMemObjR3 != NIL_RTR0MEMOBJ)
3792 {
3793 /*
3794 * Do some further input validations before calling IPRT.
3795 */
3796 size_t cbMemObj = hMemObjR0 != NIL_RTR0PTR ? RTR0MemObjSize(hMemObjR0) : RTR0MemObjSize(hMemObjR3);
3797 if ( offSub < cbMemObj
3798 && cbSub <= cbMemObj
3799 && offSub + cbSub <= cbMemObj)
3800 {
3801 rc = VINF_SUCCESS;
3802 if (hMemObjR3 != NIL_RTR0PTR)
3803 rc = RTR0MemObjProtect(hMemObjR3, offSub, cbSub, fProt);
3804 if (hMemObjR0 != NIL_RTR0PTR && RT_SUCCESS(rc))
3805 rc = RTR0MemObjProtect(hMemObjR0, offSub, cbSub, fProt);
3806 }
3807 else
3808 SUPR0Printf("SUPR0PageMapKernel: cbMemObj=%#x offSub=%#x cbSub=%#x\n", cbMemObj, offSub, cbSub);
3809
3810 }
3811 return rc;
3812
3813}
3814
3815
3816/**
3817 * Free memory allocated by SUPR0PageAlloc() and SUPR0PageAllocEx().
3818 *
3819 * @returns IPRT status code.
3820 * @param pSession The session owning the allocation.
3821 * @param pvR3 The Ring-3 address returned by SUPR0PageAlloc() or
3822 * SUPR0PageAllocEx().
3823 */
3824SUPR0DECL(int) SUPR0PageFree(PSUPDRVSESSION pSession, RTR3PTR pvR3)
3825{
3826 LogFlow(("SUPR0PageFree: pSession=%p pvR3=%p\n", pSession, (void *)pvR3));
3827 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
3828 return supdrvMemRelease(pSession, (RTHCUINTPTR)pvR3, MEMREF_TYPE_PAGE);
3829}
3830
3831
3832/**
3833 * Reports a bad context, currenctly that means EFLAGS.AC is 0 instead of 1.
3834 *
3835 * @param pDevExt The device extension.
3836 * @param pszFile The source file where the caller detected the bad
3837 * context.
3838 * @param uLine The line number in @a pszFile.
3839 * @param pszExtra Optional additional message to give further hints.
3840 */
3841void VBOXCALL supdrvBadContext(PSUPDRVDEVEXT pDevExt, const char *pszFile, uint32_t uLine, const char *pszExtra)
3842{
3843 uint32_t cCalls;
3844
3845 /*
3846 * Shorten the filename before displaying the message.
3847 */
3848 for (;;)
3849 {
3850 const char *pszTmp = strchr(pszFile, '/');
3851 if (!pszTmp)
3852 pszTmp = strchr(pszFile, '\\');
3853 if (!pszTmp)
3854 break;
3855 pszFile = pszTmp + 1;
3856 }
3857 if (RT_VALID_PTR(pszExtra) && *pszExtra)
3858 SUPR0Printf("vboxdrv: Bad CPU context error at line %u in %s: %s\n", uLine, pszFile, pszExtra);
3859 else
3860 SUPR0Printf("vboxdrv: Bad CPU context error at line %u in %s!\n", uLine, pszFile);
3861
3862 /*
3863 * Record the incident so that we stand a chance of blocking I/O controls
3864 * before panicing the system.
3865 */
3866 cCalls = ASMAtomicIncU32(&pDevExt->cBadContextCalls);
3867 if (cCalls > UINT32_MAX - _1K)
3868 ASMAtomicWriteU32(&pDevExt->cBadContextCalls, UINT32_MAX - _1K);
3869}
3870
3871
3872/**
3873 * Reports a bad context, currenctly that means EFLAGS.AC is 0 instead of 1.
3874 *
3875 * @param pSession The session of the caller.
3876 * @param pszFile The source file where the caller detected the bad
3877 * context.
3878 * @param uLine The line number in @a pszFile.
3879 * @param pszExtra Optional additional message to give further hints.
3880 */
3881SUPR0DECL(void) SUPR0BadContext(PSUPDRVSESSION pSession, const char *pszFile, uint32_t uLine, const char *pszExtra)
3882{
3883 PSUPDRVDEVEXT pDevExt;
3884
3885 AssertReturnVoid(SUP_IS_SESSION_VALID(pSession));
3886 pDevExt = pSession->pDevExt;
3887
3888 supdrvBadContext(pDevExt, pszFile, uLine, pszExtra);
3889}
3890
3891
3892/**
3893 * Gets the paging mode of the current CPU.
3894 *
3895 * @returns Paging mode, SUPPAGEINGMODE_INVALID on error.
3896 */
3897SUPR0DECL(SUPPAGINGMODE) SUPR0GetPagingMode(void)
3898{
3899 SUPPAGINGMODE enmMode;
3900
3901 RTR0UINTREG cr0 = ASMGetCR0();
3902 if ((cr0 & (X86_CR0_PG | X86_CR0_PE)) != (X86_CR0_PG | X86_CR0_PE))
3903 enmMode = SUPPAGINGMODE_INVALID;
3904 else
3905 {
3906 RTR0UINTREG cr4 = ASMGetCR4();
3907 uint32_t fNXEPlusLMA = 0;
3908 if (cr4 & X86_CR4_PAE)
3909 {
3910 uint32_t fExtFeatures = ASMCpuId_EDX(0x80000001);
3911 if (fExtFeatures & (X86_CPUID_EXT_FEATURE_EDX_NX | X86_CPUID_EXT_FEATURE_EDX_LONG_MODE))
3912 {
3913 uint64_t efer = ASMRdMsr(MSR_K6_EFER);
3914 if ((fExtFeatures & X86_CPUID_EXT_FEATURE_EDX_NX) && (efer & MSR_K6_EFER_NXE))
3915 fNXEPlusLMA |= RT_BIT(0);
3916 if ((fExtFeatures & X86_CPUID_EXT_FEATURE_EDX_LONG_MODE) && (efer & MSR_K6_EFER_LMA))
3917 fNXEPlusLMA |= RT_BIT(1);
3918 }
3919 }
3920
3921 switch ((cr4 & (X86_CR4_PAE | X86_CR4_PGE)) | fNXEPlusLMA)
3922 {
3923 case 0:
3924 enmMode = SUPPAGINGMODE_32_BIT;
3925 break;
3926
3927 case X86_CR4_PGE:
3928 enmMode = SUPPAGINGMODE_32_BIT_GLOBAL;
3929 break;
3930
3931 case X86_CR4_PAE:
3932 enmMode = SUPPAGINGMODE_PAE;
3933 break;
3934
3935 case X86_CR4_PAE | RT_BIT(0):
3936 enmMode = SUPPAGINGMODE_PAE_NX;
3937 break;
3938
3939 case X86_CR4_PAE | X86_CR4_PGE:
3940 enmMode = SUPPAGINGMODE_PAE_GLOBAL;
3941 break;
3942
3943 case X86_CR4_PAE | X86_CR4_PGE | RT_BIT(0):
3944 enmMode = SUPPAGINGMODE_PAE_GLOBAL;
3945 break;
3946
3947 case RT_BIT(1) | X86_CR4_PAE:
3948 enmMode = SUPPAGINGMODE_AMD64;
3949 break;
3950
3951 case RT_BIT(1) | X86_CR4_PAE | RT_BIT(0):
3952 enmMode = SUPPAGINGMODE_AMD64_NX;
3953 break;
3954
3955 case RT_BIT(1) | X86_CR4_PAE | X86_CR4_PGE:
3956 enmMode = SUPPAGINGMODE_AMD64_GLOBAL;
3957 break;
3958
3959 case RT_BIT(1) | X86_CR4_PAE | X86_CR4_PGE | RT_BIT(0):
3960 enmMode = SUPPAGINGMODE_AMD64_GLOBAL_NX;
3961 break;
3962
3963 default:
3964 AssertMsgFailed(("Cannot happen! cr4=%#x fNXEPlusLMA=%d\n", cr4, fNXEPlusLMA));
3965 enmMode = SUPPAGINGMODE_INVALID;
3966 break;
3967 }
3968 }
3969 return enmMode;
3970}
3971
3972
3973/**
3974 * Change CR4 and take care of the kernel CR4 shadow if applicable.
3975 *
3976 * CR4 shadow handling is required for Linux >= 4.0. Calling this function
3977 * instead of ASMSetCR4() is only necessary for semi-permanent CR4 changes
3978 * for code with interrupts enabled.
3979 *
3980 * @returns the old CR4 value.
3981 *
3982 * @param fOrMask bits to be set in CR4.
3983 * @param fAndMask bits to be cleard in CR4.
3984 *
3985 * @remarks Must be called with preemption/interrupts disabled.
3986 */
3987SUPR0DECL(RTCCUINTREG) SUPR0ChangeCR4(RTCCUINTREG fOrMask, RTCCUINTREG fAndMask)
3988{
3989#ifdef RT_OS_LINUX
3990 return supdrvOSChangeCR4(fOrMask, fAndMask);
3991#else
3992 RTCCUINTREG uOld = ASMGetCR4();
3993 RTCCUINTREG uNew = (uOld & fAndMask) | fOrMask;
3994 if (uNew != uOld)
3995 ASMSetCR4(uNew);
3996 return uOld;
3997#endif
3998}
3999
4000
4001/**
4002 * Enables or disabled hardware virtualization extensions using native OS APIs.
4003 *
4004 * @returns VBox status code.
4005 * @retval VINF_SUCCESS on success.
4006 * @retval VERR_NOT_SUPPORTED if not supported by the native OS.
4007 *
4008 * @param fEnable Whether to enable or disable.
4009 */
4010SUPR0DECL(int) SUPR0EnableVTx(bool fEnable)
4011{
4012#ifdef RT_OS_DARWIN
4013 return supdrvOSEnableVTx(fEnable);
4014#else
4015 RT_NOREF1(fEnable);
4016 return VERR_NOT_SUPPORTED;
4017#endif
4018}
4019
4020
4021/**
4022 * Suspends hardware virtualization extensions using the native OS API.
4023 *
4024 * This is called prior to entering raw-mode context.
4025 *
4026 * @returns @c true if suspended, @c false if not.
4027 */
4028SUPR0DECL(bool) SUPR0SuspendVTxOnCpu(void)
4029{
4030#ifdef RT_OS_DARWIN
4031 return supdrvOSSuspendVTxOnCpu();
4032#else
4033 return false;
4034#endif
4035}
4036
4037
4038/**
4039 * Resumes hardware virtualization extensions using the native OS API.
4040 *
4041 * This is called after to entering raw-mode context.
4042 *
4043 * @param fSuspended The return value of SUPR0SuspendVTxOnCpu.
4044 */
4045SUPR0DECL(void) SUPR0ResumeVTxOnCpu(bool fSuspended)
4046{
4047#ifdef RT_OS_DARWIN
4048 supdrvOSResumeVTxOnCpu(fSuspended);
4049#else
4050 RT_NOREF1(fSuspended);
4051 Assert(!fSuspended);
4052#endif
4053}
4054
4055
4056SUPR0DECL(int) SUPR0GetCurrentGdtRw(RTHCUINTPTR *pGdtRw)
4057{
4058#ifdef RT_OS_LINUX
4059 return supdrvOSGetCurrentGdtRw(pGdtRw);
4060#else
4061 NOREF(pGdtRw);
4062 return VERR_NOT_IMPLEMENTED;
4063#endif
4064}
4065
4066
4067/**
4068 * Checks if raw-mode is usable on this system.
4069 *
4070 * The reasons why raw-mode isn't safe to use are host specific. For example on
4071 * Windows the Hyper-V root partition may perhapse not allow important bits in
4072 * CR4 to be changed, which would make it impossible to do a world switch.
4073 *
4074 * @returns VBox status code.
4075 */
4076SUPR0DECL(int) SUPR0GetRawModeUsability(void)
4077{
4078#ifdef RT_OS_WINDOWS
4079 return supdrvOSGetRawModeUsability();
4080#else
4081 return VINF_SUCCESS;
4082#endif
4083}
4084
4085
4086
4087/**
4088 * Checks if Intel VT-x feature is usable on this CPU.
4089 *
4090 * @returns VBox status code.
4091 * @param pfIsSmxModeAmbiguous Where to return whether the SMX mode causes
4092 * ambiguity that makes us unsure whether we
4093 * really can use VT-x or not.
4094 *
4095 * @remarks Must be called with preemption disabled.
4096 * The caller is also expected to check that the CPU is an Intel (or
4097 * VIA) CPU -and- that it supports VT-x. Otherwise, this function
4098 * might throw a \#GP fault as it tries to read/write MSRs that may not
4099 * be present!
4100 */
4101SUPR0DECL(int) SUPR0GetVmxUsability(bool *pfIsSmxModeAmbiguous)
4102{
4103 uint64_t fFeatMsr;
4104 bool fMaybeSmxMode;
4105 bool fMsrLocked;
4106 bool fSmxVmxAllowed;
4107 bool fVmxAllowed;
4108 bool fIsSmxModeAmbiguous;
4109 int rc;
4110
4111 Assert(!RTThreadPreemptIsEnabled(NIL_RTTHREAD));
4112
4113 fFeatMsr = ASMRdMsr(MSR_IA32_FEATURE_CONTROL);
4114 fMaybeSmxMode = RT_BOOL(ASMGetCR4() & X86_CR4_SMXE);
4115 fMsrLocked = RT_BOOL(fFeatMsr & MSR_IA32_FEATURE_CONTROL_LOCK);
4116 fSmxVmxAllowed = RT_BOOL(fFeatMsr & MSR_IA32_FEATURE_CONTROL_SMX_VMXON);
4117 fVmxAllowed = RT_BOOL(fFeatMsr & MSR_IA32_FEATURE_CONTROL_VMXON);
4118 fIsSmxModeAmbiguous = false;
4119 rc = VERR_INTERNAL_ERROR_5;
4120
4121 /* Check if the LOCK bit is set but excludes the required VMXON bit. */
4122 if (fMsrLocked)
4123 {
4124 if (fVmxAllowed && fSmxVmxAllowed)
4125 rc = VINF_SUCCESS;
4126 else if (!fVmxAllowed && !fSmxVmxAllowed)
4127 rc = VERR_VMX_MSR_ALL_VMX_DISABLED;
4128 else if (!fMaybeSmxMode)
4129 {
4130 if (fVmxAllowed)
4131 rc = VINF_SUCCESS;
4132 else
4133 rc = VERR_VMX_MSR_VMX_DISABLED;
4134 }
4135 else
4136 {
4137 /*
4138 * CR4.SMXE is set but this doesn't mean the CPU is necessarily in SMX mode. We shall assume
4139 * that it is -not- and that it is a stupid BIOS/OS setting CR4.SMXE for no good reason.
4140 * See @bugref{6873}.
4141 */
4142 Assert(fMaybeSmxMode == true);
4143 fIsSmxModeAmbiguous = true;
4144 rc = VINF_SUCCESS;
4145 }
4146 }
4147 else
4148 {
4149 /*
4150 * MSR is not yet locked; we can change it ourselves here. Once the lock bit is set,
4151 * this MSR can no longer be modified.
4152 *
4153 * Set both the VMX and SMX_VMX bits (if supported) as we can't determine SMX mode
4154 * accurately. See @bugref{6873}.
4155 *
4156 * We need to check for SMX hardware support here, before writing the MSR as
4157 * otherwise we will #GP fault on CPUs that do not support it. Callers do not check
4158 * for it.
4159 */
4160 uint32_t fFeaturesECX, uDummy;
4161#ifdef VBOX_STRICT
4162 /* Callers should have verified these at some point. */
4163 uint32_t uMaxId, uVendorEBX, uVendorECX, uVendorEDX;
4164 ASMCpuId(0, &uMaxId, &uVendorEBX, &uVendorECX, &uVendorEDX);
4165 Assert(ASMIsValidStdRange(uMaxId));
4166 Assert( ASMIsIntelCpuEx( uVendorEBX, uVendorECX, uVendorEDX)
4167 || ASMIsViaCentaurCpuEx(uVendorEBX, uVendorECX, uVendorEDX));
4168#endif
4169 ASMCpuId(1, &uDummy, &uDummy, &fFeaturesECX, &uDummy);
4170 bool fSmxVmxHwSupport = false;
4171 if ( (fFeaturesECX & X86_CPUID_FEATURE_ECX_VMX)
4172 && (fFeaturesECX & X86_CPUID_FEATURE_ECX_SMX))
4173 fSmxVmxHwSupport = true;
4174
4175 fFeatMsr |= MSR_IA32_FEATURE_CONTROL_LOCK
4176 | MSR_IA32_FEATURE_CONTROL_VMXON;
4177 if (fSmxVmxHwSupport)
4178 fFeatMsr |= MSR_IA32_FEATURE_CONTROL_SMX_VMXON;
4179
4180 /*
4181 * Commit.
4182 */
4183 ASMWrMsr(MSR_IA32_FEATURE_CONTROL, fFeatMsr);
4184
4185 /*
4186 * Verify.
4187 */
4188 fFeatMsr = ASMRdMsr(MSR_IA32_FEATURE_CONTROL);
4189 fMsrLocked = RT_BOOL(fFeatMsr & MSR_IA32_FEATURE_CONTROL_LOCK);
4190 if (fMsrLocked)
4191 {
4192 fSmxVmxAllowed = RT_BOOL(fFeatMsr & MSR_IA32_FEATURE_CONTROL_SMX_VMXON);
4193 fVmxAllowed = RT_BOOL(fFeatMsr & MSR_IA32_FEATURE_CONTROL_VMXON);
4194 if ( fVmxAllowed
4195 && ( !fSmxVmxHwSupport
4196 || fSmxVmxAllowed))
4197 rc = VINF_SUCCESS;
4198 else
4199 rc = !fSmxVmxHwSupport ? VERR_VMX_MSR_VMX_ENABLE_FAILED : VERR_VMX_MSR_SMX_VMX_ENABLE_FAILED;
4200 }
4201 else
4202 rc = VERR_VMX_MSR_LOCKING_FAILED;
4203 }
4204
4205 if (pfIsSmxModeAmbiguous)
4206 *pfIsSmxModeAmbiguous = fIsSmxModeAmbiguous;
4207
4208 return rc;
4209}
4210
4211
4212/**
4213 * Checks if AMD-V SVM feature is usable on this CPU.
4214 *
4215 * @returns VBox status code.
4216 * @param fInitSvm If usable, try to initialize SVM on this CPU.
4217 *
4218 * @remarks Must be called with preemption disabled.
4219 */
4220SUPR0DECL(int) SUPR0GetSvmUsability(bool fInitSvm)
4221{
4222 int rc;
4223 uint64_t fVmCr;
4224 uint64_t fEfer;
4225
4226 Assert(!RTThreadPreemptIsEnabled(NIL_RTTHREAD));
4227 fVmCr = ASMRdMsr(MSR_K8_VM_CR);
4228 if (!(fVmCr & MSR_K8_VM_CR_SVM_DISABLE))
4229 {
4230 rc = VINF_SUCCESS;
4231 if (fInitSvm)
4232 {
4233 /* Turn on SVM in the EFER MSR. */
4234 fEfer = ASMRdMsr(MSR_K6_EFER);
4235 if (fEfer & MSR_K6_EFER_SVME)
4236 rc = VERR_SVM_IN_USE;
4237 else
4238 {
4239 ASMWrMsr(MSR_K6_EFER, fEfer | MSR_K6_EFER_SVME);
4240
4241 /* Paranoia. */
4242 fEfer = ASMRdMsr(MSR_K6_EFER);
4243 if (fEfer & MSR_K6_EFER_SVME)
4244 {
4245 /* Restore previous value. */
4246 ASMWrMsr(MSR_K6_EFER, fEfer & ~MSR_K6_EFER_SVME);
4247 }
4248 else
4249 rc = VERR_SVM_ILLEGAL_EFER_MSR;
4250 }
4251 }
4252 }
4253 else
4254 rc = VERR_SVM_DISABLED;
4255 return rc;
4256}
4257
4258
4259/**
4260 * Queries the AMD-V and VT-x capabilities of the calling CPU.
4261 *
4262 * @returns VBox status code.
4263 * @retval VERR_VMX_NO_VMX
4264 * @retval VERR_VMX_MSR_ALL_VMX_DISABLED
4265 * @retval VERR_VMX_MSR_VMX_DISABLED
4266 * @retval VERR_VMX_MSR_LOCKING_FAILED
4267 * @retval VERR_VMX_MSR_VMX_ENABLE_FAILED
4268 * @retval VERR_VMX_MSR_SMX_VMX_ENABLE_FAILED
4269 * @retval VERR_SVM_NO_SVM
4270 * @retval VERR_SVM_DISABLED
4271 * @retval VERR_UNSUPPORTED_CPU if not identifiable as an AMD, Intel or VIA
4272 * (centaur) CPU.
4273 *
4274 * @param pfCaps Where to store the capabilities.
4275 */
4276int VBOXCALL supdrvQueryVTCapsInternal(uint32_t *pfCaps)
4277{
4278 int rc = VERR_UNSUPPORTED_CPU;
4279 bool fIsSmxModeAmbiguous = false;
4280 RTTHREADPREEMPTSTATE PreemptState = RTTHREADPREEMPTSTATE_INITIALIZER;
4281
4282 /*
4283 * Input validation.
4284 */
4285 AssertPtrReturn(pfCaps, VERR_INVALID_POINTER);
4286
4287 *pfCaps = 0;
4288 /* We may modify MSRs and re-read them, disable preemption so we make sure we don't migrate CPUs. */
4289 RTThreadPreemptDisable(&PreemptState);
4290 if (ASMHasCpuId())
4291 {
4292 uint32_t fFeaturesECX, fFeaturesEDX, uDummy;
4293 uint32_t uMaxId, uVendorEBX, uVendorECX, uVendorEDX;
4294
4295 ASMCpuId(0, &uMaxId, &uVendorEBX, &uVendorECX, &uVendorEDX);
4296 ASMCpuId(1, &uDummy, &uDummy, &fFeaturesECX, &fFeaturesEDX);
4297
4298 if ( ASMIsValidStdRange(uMaxId)
4299 && ( ASMIsIntelCpuEx( uVendorEBX, uVendorECX, uVendorEDX)
4300 || ASMIsViaCentaurCpuEx(uVendorEBX, uVendorECX, uVendorEDX) )
4301 )
4302 {
4303 if ( (fFeaturesECX & X86_CPUID_FEATURE_ECX_VMX)
4304 && (fFeaturesEDX & X86_CPUID_FEATURE_EDX_MSR)
4305 && (fFeaturesEDX & X86_CPUID_FEATURE_EDX_FXSR)
4306 )
4307 {
4308 rc = SUPR0GetVmxUsability(&fIsSmxModeAmbiguous);
4309 if (rc == VINF_SUCCESS)
4310 {
4311 VMXCAPABILITY vtCaps;
4312
4313 *pfCaps |= SUPVTCAPS_VT_X;
4314
4315 vtCaps.u = ASMRdMsr(MSR_IA32_VMX_PROCBASED_CTLS);
4316 if (vtCaps.n.allowed1 & VMX_VMCS_CTRL_PROC_EXEC_USE_SECONDARY_EXEC_CTRL)
4317 {
4318 vtCaps.u = ASMRdMsr(MSR_IA32_VMX_PROCBASED_CTLS2);
4319 if (vtCaps.n.allowed1 & VMX_VMCS_CTRL_PROC_EXEC2_EPT)
4320 *pfCaps |= SUPVTCAPS_NESTED_PAGING;
4321 if (vtCaps.n.allowed1 & VMX_VMCS_CTRL_PROC_EXEC2_UNRESTRICTED_GUEST)
4322 *pfCaps |= SUPVTCAPS_VTX_UNRESTRICTED_GUEST;
4323 }
4324 }
4325 }
4326 else
4327 rc = VERR_VMX_NO_VMX;
4328 }
4329 else if ( ASMIsAmdCpuEx(uVendorEBX, uVendorECX, uVendorEDX)
4330 && ASMIsValidStdRange(uMaxId))
4331 {
4332 uint32_t fExtFeaturesEcx, uExtMaxId;
4333 ASMCpuId(0x80000000, &uExtMaxId, &uDummy, &uDummy, &uDummy);
4334 ASMCpuId(0x80000001, &uDummy, &uDummy, &fExtFeaturesEcx, &uDummy);
4335
4336 /* Check if SVM is available. */
4337 if ( ASMIsValidExtRange(uExtMaxId)
4338 && uExtMaxId >= 0x8000000a
4339 && (fExtFeaturesEcx & X86_CPUID_AMD_FEATURE_ECX_SVM)
4340 && (fFeaturesEDX & X86_CPUID_FEATURE_EDX_MSR)
4341 && (fFeaturesEDX & X86_CPUID_FEATURE_EDX_FXSR)
4342 )
4343 {
4344 rc = SUPR0GetSvmUsability(false /* fInitSvm */);
4345 if (RT_SUCCESS(rc))
4346 {
4347 uint32_t fSvmFeatures;
4348 *pfCaps |= SUPVTCAPS_AMD_V;
4349
4350 /* Query AMD-V features. */
4351 ASMCpuId(0x8000000a, &uDummy, &uDummy, &uDummy, &fSvmFeatures);
4352 if (fSvmFeatures & X86_CPUID_SVM_FEATURE_EDX_NESTED_PAGING)
4353 *pfCaps |= SUPVTCAPS_NESTED_PAGING;
4354 }
4355 }
4356 else
4357 rc = VERR_SVM_NO_SVM;
4358 }
4359 }
4360
4361 RTThreadPreemptRestore(&PreemptState);
4362 if (fIsSmxModeAmbiguous)
4363 SUPR0Printf(("WARNING! CR4 hints SMX mode but your CPU is too secretive. Proceeding anyway... We wish you good luck!\n"));
4364 return rc;
4365}
4366
4367/**
4368 * Queries the AMD-V and VT-x capabilities of the calling CPU.
4369 *
4370 * @returns VBox status code.
4371 * @retval VERR_VMX_NO_VMX
4372 * @retval VERR_VMX_MSR_ALL_VMX_DISABLED
4373 * @retval VERR_VMX_MSR_VMX_DISABLED
4374 * @retval VERR_VMX_MSR_LOCKING_FAILED
4375 * @retval VERR_VMX_MSR_VMX_ENABLE_FAILED
4376 * @retval VERR_VMX_MSR_SMX_VMX_ENABLE_FAILED
4377 * @retval VERR_SVM_NO_SVM
4378 * @retval VERR_SVM_DISABLED
4379 * @retval VERR_UNSUPPORTED_CPU if not identifiable as an AMD, Intel or VIA
4380 * (centaur) CPU.
4381 *
4382 * @param pSession The session handle.
4383 * @param pfCaps Where to store the capabilities.
4384 */
4385SUPR0DECL(int) SUPR0QueryVTCaps(PSUPDRVSESSION pSession, uint32_t *pfCaps)
4386{
4387 /*
4388 * Input validation.
4389 */
4390 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
4391 AssertPtrReturn(pfCaps, VERR_INVALID_POINTER);
4392
4393 /*
4394 * Call common worker.
4395 */
4396 return supdrvQueryVTCapsInternal(pfCaps);
4397}
4398
4399
4400/**
4401 * Queries the CPU microcode revision.
4402 *
4403 * @returns VBox status code.
4404 * @retval VERR_UNSUPPORTED_CPU if not identifiable as a processor with
4405 * readable microcode rev.
4406 *
4407 * @param puRevision Where to store the microcode revision.
4408 */
4409int VBOXCALL supdrvQueryUcodeRev(uint32_t *puRevision)
4410{
4411 int rc = VERR_UNSUPPORTED_CPU;
4412 RTTHREADPREEMPTSTATE PreemptState = RTTHREADPREEMPTSTATE_INITIALIZER;
4413
4414 /*
4415 * Input validation.
4416 */
4417 AssertPtrReturn(puRevision, VERR_INVALID_POINTER);
4418
4419 *puRevision = 0;
4420
4421 /* Disable preemption so we make sure we don't migrate CPUs, just in case. */
4422 /* NB: We assume that there aren't mismatched microcode revs in the system. */
4423 RTThreadPreemptDisable(&PreemptState);
4424
4425 if (ASMHasCpuId())
4426 {
4427 uint32_t uDummy, uTFMSEAX;
4428 uint32_t uMaxId, uVendorEBX, uVendorECX, uVendorEDX;
4429
4430 ASMCpuId(0, &uMaxId, &uVendorEBX, &uVendorECX, &uVendorEDX);
4431 ASMCpuId(1, &uTFMSEAX, &uDummy, &uDummy, &uDummy);
4432
4433 if (ASMIsValidStdRange(uMaxId))
4434 {
4435 uint64_t uRevMsr;
4436 if (ASMIsIntelCpuEx(uVendorEBX, uVendorECX, uVendorEDX))
4437 {
4438 /* Architectural MSR available on Pentium Pro and later. */
4439 if (ASMGetCpuFamily(uTFMSEAX) >= 6)
4440 {
4441 /* Revision is in the high dword. */
4442 uRevMsr = ASMRdMsr(MSR_IA32_BIOS_SIGN_ID);
4443 *puRevision = RT_HIDWORD(uRevMsr);
4444 rc = VINF_SUCCESS;
4445 }
4446 }
4447 else if (ASMIsAmdCpuEx(uVendorEBX, uVendorECX, uVendorEDX))
4448 {
4449 /* Not well documented, but at least all AMD64 CPUs support this. */
4450 if (ASMGetCpuFamily(uTFMSEAX) >= 15)
4451 {
4452 /* Revision is in the low dword. */
4453 uRevMsr = ASMRdMsr(MSR_IA32_BIOS_SIGN_ID); /* Same MSR as Intel. */
4454 *puRevision = RT_LODWORD(uRevMsr);
4455 rc = VINF_SUCCESS;
4456 }
4457 }
4458 }
4459 }
4460
4461 RTThreadPreemptRestore(&PreemptState);
4462
4463 return rc;
4464}
4465
4466/**
4467 * Queries the CPU microcode revision.
4468 *
4469 * @returns VBox status code.
4470 * @retval VERR_UNSUPPORTED_CPU if not identifiable as a processor with
4471 * readable microcode rev.
4472 *
4473 * @param pSession The session handle.
4474 * @param puRevision Where to store the microcode revision.
4475 */
4476SUPR0DECL(int) SUPR0QueryUcodeRev(PSUPDRVSESSION pSession, uint32_t *puRevision)
4477{
4478 /*
4479 * Input validation.
4480 */
4481 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
4482 AssertPtrReturn(puRevision, VERR_INVALID_POINTER);
4483
4484 /*
4485 * Call common worker.
4486 */
4487 return supdrvQueryUcodeRev(puRevision);
4488}
4489
4490
4491/**
4492 * Register a component factory with the support driver.
4493 *
4494 * This is currently restricted to kernel sessions only.
4495 *
4496 * @returns VBox status code.
4497 * @retval VINF_SUCCESS on success.
4498 * @retval VERR_NO_MEMORY if we're out of memory.
4499 * @retval VERR_ALREADY_EXISTS if the factory has already been registered.
4500 * @retval VERR_ACCESS_DENIED if it isn't a kernel session.
4501 * @retval VERR_INVALID_PARAMETER on invalid parameter.
4502 * @retval VERR_INVALID_POINTER on invalid pointer parameter.
4503 *
4504 * @param pSession The SUPDRV session (must be a ring-0 session).
4505 * @param pFactory Pointer to the component factory registration structure.
4506 *
4507 * @remarks This interface is also available via SUPR0IdcComponentRegisterFactory.
4508 */
4509SUPR0DECL(int) SUPR0ComponentRegisterFactory(PSUPDRVSESSION pSession, PCSUPDRVFACTORY pFactory)
4510{
4511 PSUPDRVFACTORYREG pNewReg;
4512 const char *psz;
4513 int rc;
4514
4515 /*
4516 * Validate parameters.
4517 */
4518 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
4519 AssertReturn(pSession->R0Process == NIL_RTR0PROCESS, VERR_ACCESS_DENIED);
4520 AssertPtrReturn(pFactory, VERR_INVALID_POINTER);
4521 AssertPtrReturn(pFactory->pfnQueryFactoryInterface, VERR_INVALID_POINTER);
4522 psz = RTStrEnd(pFactory->szName, sizeof(pFactory->szName));
4523 AssertReturn(psz, VERR_INVALID_PARAMETER);
4524
4525 /*
4526 * Allocate and initialize a new registration structure.
4527 */
4528 pNewReg = (PSUPDRVFACTORYREG)RTMemAlloc(sizeof(SUPDRVFACTORYREG));
4529 if (pNewReg)
4530 {
4531 pNewReg->pNext = NULL;
4532 pNewReg->pFactory = pFactory;
4533 pNewReg->pSession = pSession;
4534 pNewReg->cchName = psz - &pFactory->szName[0];
4535
4536 /*
4537 * Add it to the tail of the list after checking for prior registration.
4538 */
4539 rc = RTSemFastMutexRequest(pSession->pDevExt->mtxComponentFactory);
4540 if (RT_SUCCESS(rc))
4541 {
4542 PSUPDRVFACTORYREG pPrev = NULL;
4543 PSUPDRVFACTORYREG pCur = pSession->pDevExt->pComponentFactoryHead;
4544 while (pCur && pCur->pFactory != pFactory)
4545 {
4546 pPrev = pCur;
4547 pCur = pCur->pNext;
4548 }
4549 if (!pCur)
4550 {
4551 if (pPrev)
4552 pPrev->pNext = pNewReg;
4553 else
4554 pSession->pDevExt->pComponentFactoryHead = pNewReg;
4555 rc = VINF_SUCCESS;
4556 }
4557 else
4558 rc = VERR_ALREADY_EXISTS;
4559
4560 RTSemFastMutexRelease(pSession->pDevExt->mtxComponentFactory);
4561 }
4562
4563 if (RT_FAILURE(rc))
4564 RTMemFree(pNewReg);
4565 }
4566 else
4567 rc = VERR_NO_MEMORY;
4568 return rc;
4569}
4570
4571
4572/**
4573 * Deregister a component factory.
4574 *
4575 * @returns VBox status code.
4576 * @retval VINF_SUCCESS on success.
4577 * @retval VERR_NOT_FOUND if the factory wasn't registered.
4578 * @retval VERR_ACCESS_DENIED if it isn't a kernel session.
4579 * @retval VERR_INVALID_PARAMETER on invalid parameter.
4580 * @retval VERR_INVALID_POINTER on invalid pointer parameter.
4581 *
4582 * @param pSession The SUPDRV session (must be a ring-0 session).
4583 * @param pFactory Pointer to the component factory registration structure
4584 * previously passed SUPR0ComponentRegisterFactory().
4585 *
4586 * @remarks This interface is also available via SUPR0IdcComponentDeregisterFactory.
4587 */
4588SUPR0DECL(int) SUPR0ComponentDeregisterFactory(PSUPDRVSESSION pSession, PCSUPDRVFACTORY pFactory)
4589{
4590 int rc;
4591
4592 /*
4593 * Validate parameters.
4594 */
4595 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
4596 AssertReturn(pSession->R0Process == NIL_RTR0PROCESS, VERR_ACCESS_DENIED);
4597 AssertPtrReturn(pFactory, VERR_INVALID_POINTER);
4598
4599 /*
4600 * Take the lock and look for the registration record.
4601 */
4602 rc = RTSemFastMutexRequest(pSession->pDevExt->mtxComponentFactory);
4603 if (RT_SUCCESS(rc))
4604 {
4605 PSUPDRVFACTORYREG pPrev = NULL;
4606 PSUPDRVFACTORYREG pCur = pSession->pDevExt->pComponentFactoryHead;
4607 while (pCur && pCur->pFactory != pFactory)
4608 {
4609 pPrev = pCur;
4610 pCur = pCur->pNext;
4611 }
4612 if (pCur)
4613 {
4614 if (!pPrev)
4615 pSession->pDevExt->pComponentFactoryHead = pCur->pNext;
4616 else
4617 pPrev->pNext = pCur->pNext;
4618
4619 pCur->pNext = NULL;
4620 pCur->pFactory = NULL;
4621 pCur->pSession = NULL;
4622 rc = VINF_SUCCESS;
4623 }
4624 else
4625 rc = VERR_NOT_FOUND;
4626
4627 RTSemFastMutexRelease(pSession->pDevExt->mtxComponentFactory);
4628
4629 RTMemFree(pCur);
4630 }
4631 return rc;
4632}
4633
4634
4635/**
4636 * Queries a component factory.
4637 *
4638 * @returns VBox status code.
4639 * @retval VERR_INVALID_PARAMETER on invalid parameter.
4640 * @retval VERR_INVALID_POINTER on invalid pointer parameter.
4641 * @retval VERR_SUPDRV_COMPONENT_NOT_FOUND if the component factory wasn't found.
4642 * @retval VERR_SUPDRV_INTERFACE_NOT_SUPPORTED if the interface wasn't supported.
4643 *
4644 * @param pSession The SUPDRV session.
4645 * @param pszName The name of the component factory.
4646 * @param pszInterfaceUuid The UUID of the factory interface (stringified).
4647 * @param ppvFactoryIf Where to store the factory interface.
4648 */
4649SUPR0DECL(int) SUPR0ComponentQueryFactory(PSUPDRVSESSION pSession, const char *pszName, const char *pszInterfaceUuid, void **ppvFactoryIf)
4650{
4651 const char *pszEnd;
4652 size_t cchName;
4653 int rc;
4654
4655 /*
4656 * Validate parameters.
4657 */
4658 AssertReturn(SUP_IS_SESSION_VALID(pSession), VERR_INVALID_PARAMETER);
4659
4660 AssertPtrReturn(pszName, VERR_INVALID_POINTER);
4661 pszEnd = RTStrEnd(pszName, RT_SIZEOFMEMB(SUPDRVFACTORY, szName));
4662 AssertReturn(pszEnd, VERR_INVALID_PARAMETER);
4663 cchName = pszEnd - pszName;
4664
4665 AssertPtrReturn(pszInterfaceUuid, VERR_INVALID_POINTER);
4666 pszEnd = RTStrEnd(pszInterfaceUuid, RTUUID_STR_LENGTH);
4667 AssertReturn(pszEnd, VERR_INVALID_PARAMETER);
4668
4669 AssertPtrReturn(ppvFactoryIf, VERR_INVALID_POINTER);
4670 *ppvFactoryIf = NULL;
4671
4672 /*
4673 * Take the lock and try all factories by this name.
4674 */
4675 rc = RTSemFastMutexRequest(pSession->pDevExt->mtxComponentFactory);
4676 if (RT_SUCCESS(rc))
4677 {
4678 PSUPDRVFACTORYREG pCur = pSession->pDevExt->pComponentFactoryHead;
4679 rc = VERR_SUPDRV_COMPONENT_NOT_FOUND;
4680 while (pCur)
4681 {
4682 if ( pCur->cchName == cchName
4683 && !memcmp(pCur->pFactory->szName, pszName, cchName))
4684 {
4685 void *pvFactory = pCur->pFactory->pfnQueryFactoryInterface(pCur->pFactory, pSession, pszInterfaceUuid);
4686 if (pvFactory)
4687 {
4688 *ppvFactoryIf = pvFactory;
4689 rc = VINF_SUCCESS;
4690 break;
4691 }
4692 rc = VERR_SUPDRV_INTERFACE_NOT_SUPPORTED;
4693 }
4694
4695 /* next */
4696 pCur = pCur->pNext;
4697 }
4698
4699 RTSemFastMutexRelease(pSession->pDevExt->mtxComponentFactory);
4700 }
4701 return rc;
4702}
4703
4704
4705/**
4706 * Adds a memory object to the session.
4707 *
4708 * @returns IPRT status code.
4709 * @param pMem Memory tracking structure containing the
4710 * information to track.
4711 * @param pSession The session.
4712 */
4713static int supdrvMemAdd(PSUPDRVMEMREF pMem, PSUPDRVSESSION pSession)
4714{
4715 PSUPDRVBUNDLE pBundle;
4716
4717 /*
4718 * Find free entry and record the allocation.
4719 */
4720 RTSpinlockAcquire(pSession->Spinlock);
4721 for (pBundle = &pSession->Bundle; pBundle; pBundle = pBundle->pNext)
4722 {
4723 if (pBundle->cUsed < RT_ELEMENTS(pBundle->aMem))
4724 {
4725 unsigned i;
4726 for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
4727 {
4728 if (pBundle->aMem[i].MemObj == NIL_RTR0MEMOBJ)
4729 {
4730 pBundle->cUsed++;
4731 pBundle->aMem[i] = *pMem;
4732 RTSpinlockRelease(pSession->Spinlock);
4733 return VINF_SUCCESS;
4734 }
4735 }
4736 AssertFailed(); /* !!this can't be happening!!! */
4737 }
4738 }
4739 RTSpinlockRelease(pSession->Spinlock);
4740
4741 /*
4742 * Need to allocate a new bundle.
4743 * Insert into the last entry in the bundle.
4744 */
4745 pBundle = (PSUPDRVBUNDLE)RTMemAllocZ(sizeof(*pBundle));
4746 if (!pBundle)
4747 return VERR_NO_MEMORY;
4748
4749 /* take last entry. */
4750 pBundle->cUsed++;
4751 pBundle->aMem[RT_ELEMENTS(pBundle->aMem) - 1] = *pMem;
4752
4753 /* insert into list. */
4754 RTSpinlockAcquire(pSession->Spinlock);
4755 pBundle->pNext = pSession->Bundle.pNext;
4756 pSession->Bundle.pNext = pBundle;
4757 RTSpinlockRelease(pSession->Spinlock);
4758
4759 return VINF_SUCCESS;
4760}
4761
4762
4763/**
4764 * Releases a memory object referenced by pointer and type.
4765 *
4766 * @returns IPRT status code.
4767 * @param pSession Session data.
4768 * @param uPtr Pointer to memory. This is matched against both the R0 and R3 addresses.
4769 * @param eType Memory type.
4770 */
4771static int supdrvMemRelease(PSUPDRVSESSION pSession, RTHCUINTPTR uPtr, SUPDRVMEMREFTYPE eType)
4772{
4773 PSUPDRVBUNDLE pBundle;
4774
4775 /*
4776 * Validate input.
4777 */
4778 if (!uPtr)
4779 {
4780 Log(("Illegal address %p\n", (void *)uPtr));
4781 return VERR_INVALID_PARAMETER;
4782 }
4783
4784 /*
4785 * Search for the address.
4786 */
4787 RTSpinlockAcquire(pSession->Spinlock);
4788 for (pBundle = &pSession->Bundle; pBundle; pBundle = pBundle->pNext)
4789 {
4790 if (pBundle->cUsed > 0)
4791 {
4792 unsigned i;
4793 for (i = 0; i < RT_ELEMENTS(pBundle->aMem); i++)
4794 {
4795 if ( pBundle->aMem[i].eType == eType
4796 && pBundle->aMem[i].MemObj != NIL_RTR0MEMOBJ
4797 && ( (RTHCUINTPTR)RTR0MemObjAddress(pBundle->aMem[i].MemObj) == uPtr
4798 || ( pBundle->aMem[i].MapObjR3 != NIL_RTR0MEMOBJ
4799 && RTR0MemObjAddressR3(pBundle->aMem[i].MapObjR3) == uPtr))
4800 )
4801 {
4802 /* Make a copy of it and release it outside the spinlock. */
4803 SUPDRVMEMREF Mem = pBundle->aMem[i];
4804 pBundle->aMem[i].eType = MEMREF_TYPE_UNUSED;
4805 pBundle->aMem[i].MemObj = NIL_RTR0MEMOBJ;
4806 pBundle->aMem[i].MapObjR3 = NIL_RTR0MEMOBJ;
4807 RTSpinlockRelease(pSession->Spinlock);
4808
4809 if (Mem.MapObjR3 != NIL_RTR0MEMOBJ)
4810 {
4811 int rc = RTR0MemObjFree(Mem.MapObjR3, false);
4812 AssertRC(rc); /** @todo figure out how to handle this. */
4813 }
4814 if (Mem.MemObj != NIL_RTR0MEMOBJ)
4815 {
4816 int rc = RTR0MemObjFree(Mem.MemObj, true /* fFreeMappings */);
4817 AssertRC(rc); /** @todo figure out how to handle this. */
4818 }
4819 return VINF_SUCCESS;
4820 }
4821 }
4822 }
4823 }
4824 RTSpinlockRelease(pSession->Spinlock);
4825 Log(("Failed to find %p!!! (eType=%d)\n", (void *)uPtr, eType));
4826 return VERR_INVALID_PARAMETER;
4827}
4828
4829
4830/**
4831 * Opens an image. If it's the first time it's opened the call must upload
4832 * the bits using the supdrvIOCtl_LdrLoad() / SUPDRV_IOCTL_LDR_LOAD function.
4833 *
4834 * This is the 1st step of the loading.
4835 *
4836 * @returns IPRT status code.
4837 * @param pDevExt Device globals.
4838 * @param pSession Session data.
4839 * @param pReq The open request.
4840 */
4841static int supdrvIOCtl_LdrOpen(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDROPEN pReq)
4842{
4843 int rc;
4844 PSUPDRVLDRIMAGE pImage;
4845 void *pv;
4846 size_t cchName = strlen(pReq->u.In.szName); /* (caller checked < 32). */
4847 SUPDRV_CHECK_SMAP_SETUP();
4848 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
4849 LogFlow(("supdrvIOCtl_LdrOpen: szName=%s cbImageWithTabs=%d\n", pReq->u.In.szName, pReq->u.In.cbImageWithTabs));
4850
4851 /*
4852 * Check if we got an instance of the image already.
4853 */
4854 supdrvLdrLock(pDevExt);
4855 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
4856 for (pImage = pDevExt->pLdrImages; pImage; pImage = pImage->pNext)
4857 {
4858 if ( pImage->szName[cchName] == '\0'
4859 && !memcmp(pImage->szName, pReq->u.In.szName, cchName))
4860 {
4861 if (RT_LIKELY(pImage->cUsage < UINT32_MAX / 2U))
4862 {
4863 /** @todo check cbImageBits and cbImageWithTabs here, if they differs that indicates that the images are different. */
4864 pImage->cUsage++;
4865 pReq->u.Out.pvImageBase = pImage->pvImage;
4866 pReq->u.Out.fNeedsLoading = pImage->uState == SUP_IOCTL_LDR_OPEN;
4867 pReq->u.Out.fNativeLoader = pImage->fNative;
4868 supdrvLdrAddUsage(pSession, pImage);
4869 supdrvLdrUnlock(pDevExt);
4870 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
4871 return VINF_SUCCESS;
4872 }
4873 supdrvLdrUnlock(pDevExt);
4874 Log(("supdrvIOCtl_LdrOpen: To many existing references to '%s'!\n", pReq->u.In.szName));
4875 return VERR_INTERNAL_ERROR_3; /** @todo add VERR_TOO_MANY_REFERENCES */
4876 }
4877 }
4878 /* (not found - add it!) */
4879
4880 /* If the loader interface is locked down, make userland fail early */
4881 if (pDevExt->fLdrLockedDown)
4882 {
4883 supdrvLdrUnlock(pDevExt);
4884 Log(("supdrvIOCtl_LdrOpen: Not adding '%s' to image list, loader interface is locked down!\n", pReq->u.In.szName));
4885 return VERR_PERMISSION_DENIED;
4886 }
4887
4888 /*
4889 * Allocate memory.
4890 */
4891 Assert(cchName < sizeof(pImage->szName));
4892 pv = RTMemAlloc(sizeof(SUPDRVLDRIMAGE));
4893 if (!pv)
4894 {
4895 supdrvLdrUnlock(pDevExt);
4896 Log(("supdrvIOCtl_LdrOpen: RTMemAlloc() failed\n"));
4897 return /*VERR_NO_MEMORY*/ VERR_INTERNAL_ERROR_2;
4898 }
4899 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
4900
4901 /*
4902 * Setup and link in the LDR stuff.
4903 */
4904 pImage = (PSUPDRVLDRIMAGE)pv;
4905 pImage->pvImage = NULL;
4906 pImage->pvImageAlloc = NULL;
4907 pImage->cbImageWithTabs = pReq->u.In.cbImageWithTabs;
4908 pImage->cbImageBits = pReq->u.In.cbImageBits;
4909 pImage->cSymbols = 0;
4910 pImage->paSymbols = NULL;
4911 pImage->pachStrTab = NULL;
4912 pImage->cbStrTab = 0;
4913 pImage->pfnModuleInit = NULL;
4914 pImage->pfnModuleTerm = NULL;
4915 pImage->pfnServiceReqHandler = NULL;
4916 pImage->uState = SUP_IOCTL_LDR_OPEN;
4917 pImage->cUsage = 1;
4918 pImage->pDevExt = pDevExt;
4919 memcpy(pImage->szName, pReq->u.In.szName, cchName + 1);
4920
4921 /*
4922 * Try load it using the native loader, if that isn't supported, fall back
4923 * on the older method.
4924 */
4925 pImage->fNative = true;
4926 rc = supdrvOSLdrOpen(pDevExt, pImage, pReq->u.In.szFilename);
4927 if (rc == VERR_NOT_SUPPORTED)
4928 {
4929 pImage->pvImageAlloc = RTMemExecAlloc(pImage->cbImageBits + 31);
4930 pImage->pvImage = RT_ALIGN_P(pImage->pvImageAlloc, 32);
4931 pImage->fNative = false;
4932 rc = pImage->pvImageAlloc ? VINF_SUCCESS : VERR_NO_EXEC_MEMORY;
4933 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
4934 }
4935 if (RT_FAILURE(rc))
4936 {
4937 supdrvLdrUnlock(pDevExt);
4938 RTMemFree(pImage);
4939 Log(("supdrvIOCtl_LdrOpen(%s): failed - %Rrc\n", pReq->u.In.szName, rc));
4940 return rc;
4941 }
4942 Assert(VALID_PTR(pImage->pvImage) || RT_FAILURE(rc));
4943
4944 /*
4945 * Link it.
4946 */
4947 pImage->pNext = pDevExt->pLdrImages;
4948 pDevExt->pLdrImages = pImage;
4949
4950 supdrvLdrAddUsage(pSession, pImage);
4951
4952 pReq->u.Out.pvImageBase = pImage->pvImage;
4953 pReq->u.Out.fNeedsLoading = true;
4954 pReq->u.Out.fNativeLoader = pImage->fNative;
4955 supdrvOSLdrNotifyOpened(pDevExt, pImage, pReq->u.In.szFilename);
4956
4957 supdrvLdrUnlock(pDevExt);
4958 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
4959 return VINF_SUCCESS;
4960}
4961
4962
4963/**
4964 * Worker that validates a pointer to an image entrypoint.
4965 *
4966 * @returns IPRT status code.
4967 * @param pDevExt The device globals.
4968 * @param pImage The loader image.
4969 * @param pv The pointer into the image.
4970 * @param fMayBeNull Whether it may be NULL.
4971 * @param pszWhat What is this entrypoint? (for logging)
4972 * @param pbImageBits The image bits prepared by ring-3.
4973 *
4974 * @remarks Will leave the lock on failure.
4975 */
4976static int supdrvLdrValidatePointer(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage, void *pv,
4977 bool fMayBeNull, const uint8_t *pbImageBits, const char *pszWhat)
4978{
4979 if (!fMayBeNull || pv)
4980 {
4981 if ((uintptr_t)pv - (uintptr_t)pImage->pvImage >= pImage->cbImageBits)
4982 {
4983 supdrvLdrUnlock(pDevExt);
4984 Log(("Out of range (%p LB %#x): %s=%p\n", pImage->pvImage, pImage->cbImageBits, pszWhat, pv));
4985 return VERR_INVALID_PARAMETER;
4986 }
4987
4988 if (pImage->fNative)
4989 {
4990 int rc = supdrvOSLdrValidatePointer(pDevExt, pImage, pv, pbImageBits);
4991 if (RT_FAILURE(rc))
4992 {
4993 supdrvLdrUnlock(pDevExt);
4994 Log(("Bad entry point address: %s=%p (rc=%Rrc)\n", pszWhat, pv, rc)); NOREF(pszWhat);
4995 return rc;
4996 }
4997 }
4998 }
4999 return VINF_SUCCESS;
5000}
5001
5002
5003/**
5004 * Formats a load error message.
5005 *
5006 * @returns @a rc
5007 * @param rc Return code.
5008 * @param pReq The request.
5009 * @param pszFormat The error message format string.
5010 * @param ... Argument to the format string.
5011 */
5012int VBOXCALL supdrvLdrLoadError(int rc, PSUPLDRLOAD pReq, const char *pszFormat, ...)
5013{
5014 va_list va;
5015 va_start(va, pszFormat);
5016 pReq->u.Out.uErrorMagic = SUPLDRLOAD_ERROR_MAGIC;
5017 RTStrPrintfV(pReq->u.Out.szError, sizeof(pReq->u.Out.szError), pszFormat, va);
5018 va_end(va);
5019 Log(("SUP_IOCTL_LDR_LOAD: %s [rc=%Rrc]\n", pReq->u.Out.szError, rc));
5020 return rc;
5021}
5022
5023
5024/**
5025 * Loads the image bits.
5026 *
5027 * This is the 2nd step of the loading.
5028 *
5029 * @returns IPRT status code.
5030 * @param pDevExt Device globals.
5031 * @param pSession Session data.
5032 * @param pReq The request.
5033 */
5034static int supdrvIOCtl_LdrLoad(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRLOAD pReq)
5035{
5036 PSUPDRVLDRUSAGE pUsage;
5037 PSUPDRVLDRIMAGE pImage;
5038 int rc;
5039 SUPDRV_CHECK_SMAP_SETUP();
5040 LogFlow(("supdrvIOCtl_LdrLoad: pvImageBase=%p cbImageWithBits=%d\n", pReq->u.In.pvImageBase, pReq->u.In.cbImageWithTabs));
5041 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
5042
5043 /*
5044 * Find the ldr image.
5045 */
5046 supdrvLdrLock(pDevExt);
5047 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
5048
5049 pUsage = pSession->pLdrUsage;
5050 while (pUsage && pUsage->pImage->pvImage != pReq->u.In.pvImageBase)
5051 pUsage = pUsage->pNext;
5052 if (!pUsage)
5053 {
5054 supdrvLdrUnlock(pDevExt);
5055 return supdrvLdrLoadError(VERR_INVALID_HANDLE, pReq, "Image not found");
5056 }
5057 pImage = pUsage->pImage;
5058
5059 /*
5060 * Validate input.
5061 */
5062 if ( pImage->cbImageWithTabs != pReq->u.In.cbImageWithTabs
5063 || pImage->cbImageBits != pReq->u.In.cbImageBits)
5064 {
5065 supdrvLdrUnlock(pDevExt);
5066 return supdrvLdrLoadError(VERR_INVALID_HANDLE, pReq, "Image size mismatch found: %d(prep) != %d(load) or %d != %d",
5067 pImage->cbImageWithTabs, pReq->u.In.cbImageWithTabs, pImage->cbImageBits, pReq->u.In.cbImageBits);
5068 }
5069
5070 if (pImage->uState != SUP_IOCTL_LDR_OPEN)
5071 {
5072 unsigned uState = pImage->uState;
5073 supdrvLdrUnlock(pDevExt);
5074 if (uState != SUP_IOCTL_LDR_LOAD)
5075 AssertMsgFailed(("SUP_IOCTL_LDR_LOAD: invalid image state %d (%#x)!\n", uState, uState));
5076 pReq->u.Out.uErrorMagic = 0;
5077 return VERR_ALREADY_LOADED;
5078 }
5079
5080 /* If the loader interface is locked down, don't load new images */
5081 if (pDevExt->fLdrLockedDown)
5082 {
5083 supdrvLdrUnlock(pDevExt);
5084 return supdrvLdrLoadError(VERR_PERMISSION_DENIED, pReq, "Loader is locked down");
5085 }
5086
5087 switch (pReq->u.In.eEPType)
5088 {
5089 case SUPLDRLOADEP_NOTHING:
5090 break;
5091
5092 case SUPLDRLOADEP_VMMR0:
5093 rc = supdrvLdrValidatePointer( pDevExt, pImage, pReq->u.In.EP.VMMR0.pvVMMR0, false, pReq->u.In.abImage, "pvVMMR0");
5094 if (RT_SUCCESS(rc))
5095 rc = supdrvLdrValidatePointer(pDevExt, pImage, pReq->u.In.EP.VMMR0.pvVMMR0EntryFast, false, pReq->u.In.abImage, "pvVMMR0EntryFast");
5096 if (RT_SUCCESS(rc))
5097 rc = supdrvLdrValidatePointer(pDevExt, pImage, pReq->u.In.EP.VMMR0.pvVMMR0EntryEx, false, pReq->u.In.abImage, "pvVMMR0EntryEx");
5098 if (RT_FAILURE(rc))
5099 return supdrvLdrLoadError(rc, pReq, "Invalid VMMR0 pointer");
5100 break;
5101
5102 case SUPLDRLOADEP_SERVICE:
5103 rc = supdrvLdrValidatePointer(pDevExt, pImage, pReq->u.In.EP.Service.pfnServiceReq, false, pReq->u.In.abImage, "pfnServiceReq");
5104 if (RT_FAILURE(rc))
5105 return supdrvLdrLoadError(rc, pReq, "Invalid pfnServiceReq pointer: %p", pReq->u.In.EP.Service.pfnServiceReq);
5106 if ( pReq->u.In.EP.Service.apvReserved[0] != NIL_RTR0PTR
5107 || pReq->u.In.EP.Service.apvReserved[1] != NIL_RTR0PTR
5108 || pReq->u.In.EP.Service.apvReserved[2] != NIL_RTR0PTR)
5109 {
5110 supdrvLdrUnlock(pDevExt);
5111 return supdrvLdrLoadError(VERR_INVALID_PARAMETER, pReq,
5112 "Out of range (%p LB %#x): apvReserved={%p,%p,%p} MBZ!",
5113 pImage->pvImage, pReq->u.In.cbImageWithTabs,
5114 pReq->u.In.EP.Service.apvReserved[0],
5115 pReq->u.In.EP.Service.apvReserved[1],
5116 pReq->u.In.EP.Service.apvReserved[2]);
5117 }
5118 break;
5119
5120 default:
5121 supdrvLdrUnlock(pDevExt);
5122 return supdrvLdrLoadError(VERR_INVALID_PARAMETER, pReq, "Invalid eEPType=%d", pReq->u.In.eEPType);
5123 }
5124
5125 rc = supdrvLdrValidatePointer(pDevExt, pImage, pReq->u.In.pfnModuleInit, true, pReq->u.In.abImage, "pfnModuleInit");
5126 if (RT_FAILURE(rc))
5127 return supdrvLdrLoadError(rc, pReq, "Invalid pfnModuleInit pointer: %p", pReq->u.In.pfnModuleInit);
5128 rc = supdrvLdrValidatePointer(pDevExt, pImage, pReq->u.In.pfnModuleTerm, true, pReq->u.In.abImage, "pfnModuleTerm");
5129 if (RT_FAILURE(rc))
5130 return supdrvLdrLoadError(rc, pReq, "Invalid pfnModuleTerm pointer: %p", pReq->u.In.pfnModuleTerm);
5131 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
5132
5133 /*
5134 * Allocate and copy the tables.
5135 * (No need to do try/except as this is a buffered request.)
5136 */
5137 pImage->cbStrTab = pReq->u.In.cbStrTab;
5138 if (pImage->cbStrTab)
5139 {
5140 pImage->pachStrTab = (char *)RTMemAlloc(pImage->cbStrTab);
5141 if (pImage->pachStrTab)
5142 memcpy(pImage->pachStrTab, &pReq->u.In.abImage[pReq->u.In.offStrTab], pImage->cbStrTab);
5143 else
5144 rc = supdrvLdrLoadError(VERR_NO_MEMORY, pReq, "Out of memory for string table: %#x", pImage->cbStrTab);
5145 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
5146 }
5147
5148 pImage->cSymbols = pReq->u.In.cSymbols;
5149 if (RT_SUCCESS(rc) && pImage->cSymbols)
5150 {
5151 size_t cbSymbols = pImage->cSymbols * sizeof(SUPLDRSYM);
5152 pImage->paSymbols = (PSUPLDRSYM)RTMemAlloc(cbSymbols);
5153 if (pImage->paSymbols)
5154 memcpy(pImage->paSymbols, &pReq->u.In.abImage[pReq->u.In.offSymbols], cbSymbols);
5155 else
5156 rc = supdrvLdrLoadError(VERR_NO_MEMORY, pReq, "Out of memory for symbol table: %#x", cbSymbols);
5157 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
5158 }
5159
5160 /*
5161 * Copy the bits / complete native loading.
5162 */
5163 if (RT_SUCCESS(rc))
5164 {
5165 pImage->uState = SUP_IOCTL_LDR_LOAD;
5166 pImage->pfnModuleInit = (PFNR0MODULEINIT)(uintptr_t)pReq->u.In.pfnModuleInit;
5167 pImage->pfnModuleTerm = (PFNR0MODULETERM)(uintptr_t)pReq->u.In.pfnModuleTerm;
5168
5169 if (pImage->fNative)
5170 rc = supdrvOSLdrLoad(pDevExt, pImage, pReq->u.In.abImage, pReq);
5171 else
5172 {
5173 memcpy(pImage->pvImage, &pReq->u.In.abImage[0], pImage->cbImageBits);
5174 Log(("vboxdrv: Loaded '%s' at %p\n", pImage->szName, pImage->pvImage));
5175 }
5176 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
5177 }
5178
5179 /*
5180 * Update any entry points.
5181 */
5182 if (RT_SUCCESS(rc))
5183 {
5184 switch (pReq->u.In.eEPType)
5185 {
5186 default:
5187 case SUPLDRLOADEP_NOTHING:
5188 rc = VINF_SUCCESS;
5189 break;
5190 case SUPLDRLOADEP_VMMR0:
5191 rc = supdrvLdrSetVMMR0EPs(pDevExt, pReq->u.In.EP.VMMR0.pvVMMR0,
5192 pReq->u.In.EP.VMMR0.pvVMMR0EntryFast, pReq->u.In.EP.VMMR0.pvVMMR0EntryEx);
5193 break;
5194 case SUPLDRLOADEP_SERVICE:
5195 pImage->pfnServiceReqHandler = (PFNSUPR0SERVICEREQHANDLER)(uintptr_t)pReq->u.In.EP.Service.pfnServiceReq;
5196 rc = VINF_SUCCESS;
5197 break;
5198 }
5199 }
5200
5201 /*
5202 * On success call the module initialization.
5203 */
5204 LogFlow(("supdrvIOCtl_LdrLoad: pfnModuleInit=%p\n", pImage->pfnModuleInit));
5205 if (RT_SUCCESS(rc) && pImage->pfnModuleInit)
5206 {
5207 Log(("supdrvIOCtl_LdrLoad: calling pfnModuleInit=%p\n", pImage->pfnModuleInit));
5208 pDevExt->pLdrInitImage = pImage;
5209 pDevExt->hLdrInitThread = RTThreadNativeSelf();
5210 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
5211 rc = pImage->pfnModuleInit(pImage);
5212 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
5213 pDevExt->pLdrInitImage = NULL;
5214 pDevExt->hLdrInitThread = NIL_RTNATIVETHREAD;
5215 if (RT_FAILURE(rc))
5216 {
5217 if (pDevExt->pvVMMR0 == pImage->pvImage)
5218 supdrvLdrUnsetVMMR0EPs(pDevExt);
5219 supdrvLdrLoadError(rc, pReq, "ModuleInit failed: %Rrc", rc);
5220 }
5221 }
5222 if (RT_SUCCESS(rc))
5223 {
5224 SUPR0Printf("vboxdrv: %RKv %s\n", pImage->pvImage, pImage->szName);
5225 pReq->u.Out.uErrorMagic = 0;
5226 pReq->u.Out.szError[0] = '\0';
5227 }
5228 else
5229 {
5230 /* Inform the tracing component in case ModuleInit registered TPs. */
5231 supdrvTracerModuleUnloading(pDevExt, pImage);
5232
5233 pImage->uState = SUP_IOCTL_LDR_OPEN;
5234 pImage->pfnModuleInit = NULL;
5235 pImage->pfnModuleTerm = NULL;
5236 pImage->pfnServiceReqHandler= NULL;
5237 pImage->cbStrTab = 0;
5238 RTMemFree(pImage->pachStrTab);
5239 pImage->pachStrTab = NULL;
5240 RTMemFree(pImage->paSymbols);
5241 pImage->paSymbols = NULL;
5242 pImage->cSymbols = 0;
5243 }
5244
5245 supdrvLdrUnlock(pDevExt);
5246 SUPDRV_CHECK_SMAP_CHECK(pDevExt, RT_NOTHING);
5247 return rc;
5248}
5249
5250
5251/**
5252 * Frees a previously loaded (prep'ed) image.
5253 *
5254 * @returns IPRT status code.
5255 * @param pDevExt Device globals.
5256 * @param pSession Session data.
5257 * @param pReq The request.
5258 */
5259static int supdrvIOCtl_LdrFree(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRFREE pReq)
5260{
5261 int rc;
5262 PSUPDRVLDRUSAGE pUsagePrev;
5263 PSUPDRVLDRUSAGE pUsage;
5264 PSUPDRVLDRIMAGE pImage;
5265 LogFlow(("supdrvIOCtl_LdrFree: pvImageBase=%p\n", pReq->u.In.pvImageBase));
5266
5267 /*
5268 * Find the ldr image.
5269 */
5270 supdrvLdrLock(pDevExt);
5271 pUsagePrev = NULL;
5272 pUsage = pSession->pLdrUsage;
5273 while (pUsage && pUsage->pImage->pvImage != pReq->u.In.pvImageBase)
5274 {
5275 pUsagePrev = pUsage;
5276 pUsage = pUsage->pNext;
5277 }
5278 if (!pUsage)
5279 {
5280 supdrvLdrUnlock(pDevExt);
5281 Log(("SUP_IOCTL_LDR_FREE: couldn't find image!\n"));
5282 return VERR_INVALID_HANDLE;
5283 }
5284
5285 /*
5286 * Check if we can remove anything.
5287 */
5288 rc = VINF_SUCCESS;
5289 pImage = pUsage->pImage;
5290 if (pImage->cUsage <= 1 || pUsage->cUsage <= 1)
5291 {
5292 /*
5293 * Check if there are any objects with destructors in the image, if
5294 * so leave it for the session cleanup routine so we get a chance to
5295 * clean things up in the right order and not leave them all dangling.
5296 */
5297 RTSpinlockAcquire(pDevExt->Spinlock);
5298 if (pImage->cUsage <= 1)
5299 {
5300 PSUPDRVOBJ pObj;
5301 for (pObj = pDevExt->pObjs; pObj; pObj = pObj->pNext)
5302 if (RT_UNLIKELY((uintptr_t)pObj->pfnDestructor - (uintptr_t)pImage->pvImage < pImage->cbImageBits))
5303 {
5304 rc = VERR_DANGLING_OBJECTS;
5305 break;
5306 }
5307 }
5308 else
5309 {
5310 PSUPDRVUSAGE pGenUsage;
5311 for (pGenUsage = pSession->pUsage; pGenUsage; pGenUsage = pGenUsage->pNext)
5312 if (RT_UNLIKELY((uintptr_t)pGenUsage->pObj->pfnDestructor - (uintptr_t)pImage->pvImage < pImage->cbImageBits))
5313 {
5314 rc = VERR_DANGLING_OBJECTS;
5315 break;
5316 }
5317 }
5318 RTSpinlockRelease(pDevExt->Spinlock);
5319 if (rc == VINF_SUCCESS)
5320 {
5321 /* unlink it */
5322 if (pUsagePrev)
5323 pUsagePrev->pNext = pUsage->pNext;
5324 else
5325 pSession->pLdrUsage = pUsage->pNext;
5326
5327 /* free it */
5328 pUsage->pImage = NULL;
5329 pUsage->pNext = NULL;
5330 RTMemFree(pUsage);
5331
5332 /*
5333 * Dereference the image.
5334 */
5335 if (pImage->cUsage <= 1)
5336 supdrvLdrFree(pDevExt, pImage);
5337 else
5338 pImage->cUsage--;
5339 }
5340 else
5341 {
5342 Log(("supdrvIOCtl_LdrFree: Dangling objects in %p/%s!\n", pImage->pvImage, pImage->szName));
5343 rc = VINF_SUCCESS; /** @todo BRANCH-2.1: remove this after branching. */
5344 }
5345 }
5346 else
5347 {
5348 /*
5349 * Dereference both image and usage.
5350 */
5351 pImage->cUsage--;
5352 pUsage->cUsage--;
5353 }
5354
5355 supdrvLdrUnlock(pDevExt);
5356 return rc;
5357}
5358
5359
5360/**
5361 * Lock down the image loader interface.
5362 *
5363 * @returns IPRT status code.
5364 * @param pDevExt Device globals.
5365 */
5366static int supdrvIOCtl_LdrLockDown(PSUPDRVDEVEXT pDevExt)
5367{
5368 LogFlow(("supdrvIOCtl_LdrLockDown:\n"));
5369
5370 supdrvLdrLock(pDevExt);
5371 if (!pDevExt->fLdrLockedDown)
5372 {
5373 pDevExt->fLdrLockedDown = true;
5374 Log(("supdrvIOCtl_LdrLockDown: Image loader interface locked down\n"));
5375 }
5376 supdrvLdrUnlock(pDevExt);
5377
5378 return VINF_SUCCESS;
5379}
5380
5381
5382/**
5383 * Gets the address of a symbol in an open image.
5384 *
5385 * @returns IPRT status code.
5386 * @param pDevExt Device globals.
5387 * @param pSession Session data.
5388 * @param pReq The request buffer.
5389 */
5390static int supdrvIOCtl_LdrGetSymbol(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPLDRGETSYMBOL pReq)
5391{
5392 PSUPDRVLDRIMAGE pImage;
5393 PSUPDRVLDRUSAGE pUsage;
5394 uint32_t i;
5395 PSUPLDRSYM paSyms;
5396 const char *pchStrings;
5397 const size_t cbSymbol = strlen(pReq->u.In.szSymbol) + 1;
5398 void *pvSymbol = NULL;
5399 int rc = VERR_SYMBOL_NOT_FOUND;
5400 Log3(("supdrvIOCtl_LdrGetSymbol: pvImageBase=%p szSymbol=\"%s\"\n", pReq->u.In.pvImageBase, pReq->u.In.szSymbol));
5401
5402 /*
5403 * Find the ldr image.
5404 */
5405 supdrvLdrLock(pDevExt);
5406 pUsage = pSession->pLdrUsage;
5407 while (pUsage && pUsage->pImage->pvImage != pReq->u.In.pvImageBase)
5408 pUsage = pUsage->pNext;
5409 if (!pUsage)
5410 {
5411 supdrvLdrUnlock(pDevExt);
5412 Log(("SUP_IOCTL_LDR_GET_SYMBOL: couldn't find image!\n"));
5413 return VERR_INVALID_HANDLE;
5414 }
5415 pImage = pUsage->pImage;
5416 if (pImage->uState != SUP_IOCTL_LDR_LOAD)
5417 {
5418 unsigned uState = pImage->uState;
5419 supdrvLdrUnlock(pDevExt);
5420 Log(("SUP_IOCTL_LDR_GET_SYMBOL: invalid image state %d (%#x)!\n", uState, uState)); NOREF(uState);
5421 return VERR_ALREADY_LOADED;
5422 }
5423
5424 /*
5425 * Search the symbol strings.
5426 *
5427 * Note! The int32_t is for native loading on solaris where the data
5428 * and text segments are in very different places.
5429 */
5430 pchStrings = pImage->pachStrTab;
5431 paSyms = pImage->paSymbols;
5432 for (i = 0; i < pImage->cSymbols; i++)
5433 {
5434 if ( paSyms[i].offName + cbSymbol <= pImage->cbStrTab
5435 && !memcmp(pchStrings + paSyms[i].offName, pReq->u.In.szSymbol, cbSymbol))
5436 {
5437 pvSymbol = (uint8_t *)pImage->pvImage + (int32_t)paSyms[i].offSymbol;
5438 rc = VINF_SUCCESS;
5439 break;
5440 }
5441 }
5442 supdrvLdrUnlock(pDevExt);
5443 pReq->u.Out.pvSymbol = pvSymbol;
5444 return rc;
5445}
5446
5447
5448/**
5449 * Gets the address of a symbol in an open image or the support driver.
5450 *
5451 * @returns VINF_SUCCESS on success.
5452 * @returns
5453 * @param pDevExt Device globals.
5454 * @param pSession Session data.
5455 * @param pReq The request buffer.
5456 */
5457static int supdrvIDC_LdrGetSymbol(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPDRVIDCREQGETSYM pReq)
5458{
5459 int rc = VINF_SUCCESS;
5460 const char *pszSymbol = pReq->u.In.pszSymbol;
5461 const char *pszModule = pReq->u.In.pszModule;
5462 size_t cbSymbol;
5463 char const *pszEnd;
5464 uint32_t i;
5465
5466 /*
5467 * Input validation.
5468 */
5469 AssertPtrReturn(pszSymbol, VERR_INVALID_POINTER);
5470 pszEnd = RTStrEnd(pszSymbol, 512);
5471 AssertReturn(pszEnd, VERR_INVALID_PARAMETER);
5472 cbSymbol = pszEnd - pszSymbol + 1;
5473
5474 if (pszModule)
5475 {
5476 AssertPtrReturn(pszModule, VERR_INVALID_POINTER);
5477 pszEnd = RTStrEnd(pszModule, 64);
5478 AssertReturn(pszEnd, VERR_INVALID_PARAMETER);
5479 }
5480 Log3(("supdrvIDC_LdrGetSymbol: pszModule=%p:{%s} pszSymbol=%p:{%s}\n", pszModule, pszModule, pszSymbol, pszSymbol));
5481
5482
5483 if ( !pszModule
5484 || !strcmp(pszModule, "SupDrv"))
5485 {
5486 /*
5487 * Search the support driver export table.
5488 */
5489 for (i = 0; i < RT_ELEMENTS(g_aFunctions); i++)
5490 if (!strcmp(g_aFunctions[i].szName, pszSymbol))
5491 {
5492 pReq->u.Out.pfnSymbol = (PFNRT)(uintptr_t)g_aFunctions[i].pfn;
5493 break;
5494 }
5495 }
5496 else
5497 {
5498 /*
5499 * Find the loader image.
5500 */
5501 PSUPDRVLDRIMAGE pImage;
5502
5503 supdrvLdrLock(pDevExt);
5504
5505 for (pImage = pDevExt->pLdrImages; pImage; pImage = pImage->pNext)
5506 if (!strcmp(pImage->szName, pszModule))
5507 break;
5508 if (pImage && pImage->uState == SUP_IOCTL_LDR_LOAD)
5509 {
5510 /*
5511 * Search the symbol strings.
5512 */
5513 const char *pchStrings = pImage->pachStrTab;
5514 PCSUPLDRSYM paSyms = pImage->paSymbols;
5515 for (i = 0; i < pImage->cSymbols; i++)
5516 {
5517 if ( paSyms[i].offName + cbSymbol <= pImage->cbStrTab
5518 && !memcmp(pchStrings + paSyms[i].offName, pszSymbol, cbSymbol))
5519 {
5520 /*
5521 * Found it! Calc the symbol address and add a reference to the module.
5522 */
5523 pReq->u.Out.pfnSymbol = (PFNRT)((uintptr_t)pImage->pvImage + (int32_t)paSyms[i].offSymbol);
5524 rc = supdrvLdrAddUsage(pSession, pImage);
5525 break;
5526 }
5527 }
5528 }
5529 else
5530 rc = pImage ? VERR_WRONG_ORDER : VERR_MODULE_NOT_FOUND;
5531
5532 supdrvLdrUnlock(pDevExt);
5533 }
5534 return rc;
5535}
5536
5537
5538/**
5539 * Updates the VMMR0 entry point pointers.
5540 *
5541 * @returns IPRT status code.
5542 * @param pDevExt Device globals.
5543 * @param pvVMMR0 VMMR0 image handle.
5544 * @param pvVMMR0EntryFast VMMR0EntryFast address.
5545 * @param pvVMMR0EntryEx VMMR0EntryEx address.
5546 * @remark Caller must own the loader mutex.
5547 */
5548static int supdrvLdrSetVMMR0EPs(PSUPDRVDEVEXT pDevExt, void *pvVMMR0, void *pvVMMR0EntryFast, void *pvVMMR0EntryEx)
5549{
5550 int rc = VINF_SUCCESS;
5551 LogFlow(("supdrvLdrSetR0EP pvVMMR0=%p pvVMMR0EntryFast=%p\n", pvVMMR0, pvVMMR0EntryFast));
5552
5553
5554 /*
5555 * Check if not yet set.
5556 */
5557 if (!pDevExt->pvVMMR0)
5558 {
5559 pDevExt->pvVMMR0 = pvVMMR0;
5560 *(void **)&pDevExt->pfnVMMR0EntryFast = pvVMMR0EntryFast;
5561 *(void **)&pDevExt->pfnVMMR0EntryEx = pvVMMR0EntryEx;
5562 ASMCompilerBarrier(); /* the above isn't nice, so be careful... */
5563 }
5564 else
5565 {
5566 /*
5567 * Return failure or success depending on whether the values match or not.
5568 */
5569 if ( pDevExt->pvVMMR0 != pvVMMR0
5570 || (uintptr_t)pDevExt->pfnVMMR0EntryFast != (uintptr_t)pvVMMR0EntryFast
5571 || (uintptr_t)pDevExt->pfnVMMR0EntryEx != (uintptr_t)pvVMMR0EntryEx)
5572 {
5573 AssertMsgFailed(("SUP_IOCTL_LDR_SETR0EP: Already set pointing to a different module!\n"));
5574 rc = VERR_INVALID_PARAMETER;
5575 }
5576 }
5577 return rc;
5578}
5579
5580
5581/**
5582 * Unsets the VMMR0 entry point installed by supdrvLdrSetR0EP.
5583 *
5584 * @param pDevExt Device globals.
5585 */
5586static void supdrvLdrUnsetVMMR0EPs(PSUPDRVDEVEXT pDevExt)
5587{
5588 pDevExt->pvVMMR0 = NULL;
5589 pDevExt->pfnVMMR0EntryFast = NULL;
5590 pDevExt->pfnVMMR0EntryEx = NULL;
5591}
5592
5593
5594/**
5595 * Adds a usage reference in the specified session of an image.
5596 *
5597 * Called while owning the loader semaphore.
5598 *
5599 * @returns VINF_SUCCESS on success and VERR_NO_MEMORY on failure.
5600 * @param pSession Session in question.
5601 * @param pImage Image which the session is using.
5602 */
5603static int supdrvLdrAddUsage(PSUPDRVSESSION pSession, PSUPDRVLDRIMAGE pImage)
5604{
5605 PSUPDRVLDRUSAGE pUsage;
5606 LogFlow(("supdrvLdrAddUsage: pImage=%p\n", pImage));
5607
5608 /*
5609 * Referenced it already?
5610 */
5611 pUsage = pSession->pLdrUsage;
5612 while (pUsage)
5613 {
5614 if (pUsage->pImage == pImage)
5615 {
5616 pUsage->cUsage++;
5617 return VINF_SUCCESS;
5618 }
5619 pUsage = pUsage->pNext;
5620 }
5621
5622 /*
5623 * Allocate new usage record.
5624 */
5625 pUsage = (PSUPDRVLDRUSAGE)RTMemAlloc(sizeof(*pUsage));
5626 AssertReturn(pUsage, /*VERR_NO_MEMORY*/ VERR_INTERNAL_ERROR_5);
5627 pUsage->cUsage = 1;
5628 pUsage->pImage = pImage;
5629 pUsage->pNext = pSession->pLdrUsage;
5630 pSession->pLdrUsage = pUsage;
5631 return VINF_SUCCESS;
5632}
5633
5634
5635/**
5636 * Frees a load image.
5637 *
5638 * @param pDevExt Pointer to device extension.
5639 * @param pImage Pointer to the image we're gonna free.
5640 * This image must exit!
5641 * @remark The caller MUST own SUPDRVDEVEXT::mtxLdr!
5642 */
5643static void supdrvLdrFree(PSUPDRVDEVEXT pDevExt, PSUPDRVLDRIMAGE pImage)
5644{
5645 PSUPDRVLDRIMAGE pImagePrev;
5646 LogFlow(("supdrvLdrFree: pImage=%p\n", pImage));
5647
5648 /*
5649 * Warn if we're releasing images while the image loader interface is
5650 * locked down -- we won't be able to reload them!
5651 */
5652 if (pDevExt->fLdrLockedDown)
5653 Log(("supdrvLdrFree: Warning: unloading '%s' image, while loader interface is locked down!\n", pImage->szName));
5654
5655 /* find it - arg. should've used doubly linked list. */
5656 Assert(pDevExt->pLdrImages);
5657 pImagePrev = NULL;
5658 if (pDevExt->pLdrImages != pImage)
5659 {
5660 pImagePrev = pDevExt->pLdrImages;
5661 while (pImagePrev->pNext != pImage)
5662 pImagePrev = pImagePrev->pNext;
5663 Assert(pImagePrev->pNext == pImage);
5664 }
5665
5666 /* unlink */
5667 if (pImagePrev)
5668 pImagePrev->pNext = pImage->pNext;
5669 else
5670 pDevExt->pLdrImages = pImage->pNext;
5671
5672 /* check if this is VMMR0.r0 unset its entry point pointers. */
5673 if (pDevExt->pvVMMR0 == pImage->pvImage)
5674 supdrvLdrUnsetVMMR0EPs(pDevExt);
5675
5676 /* check for objects with destructors in this image. (Shouldn't happen.) */
5677 if (pDevExt->pObjs)
5678 {
5679 unsigned cObjs = 0;
5680 PSUPDRVOBJ pObj;
5681 RTSpinlockAcquire(pDevExt->Spinlock);
5682 for (pObj = pDevExt->pObjs; pObj; pObj = pObj->pNext)
5683 if (RT_UNLIKELY((uintptr_t)pObj->pfnDestructor - (uintptr_t)pImage->pvImage < pImage->cbImageBits))
5684 {
5685 pObj->pfnDestructor = NULL;
5686 cObjs++;
5687 }
5688 RTSpinlockRelease(pDevExt->Spinlock);
5689 if (cObjs)
5690 OSDBGPRINT(("supdrvLdrFree: Image '%s' has %d dangling objects!\n", pImage->szName, cObjs));
5691 }
5692
5693 /* call termination function if fully loaded. */
5694 if ( pImage->pfnModuleTerm
5695 && pImage->uState == SUP_IOCTL_LDR_LOAD)
5696 {
5697 LogFlow(("supdrvIOCtl_LdrLoad: calling pfnModuleTerm=%p\n", pImage->pfnModuleTerm));
5698 pImage->pfnModuleTerm(pImage);
5699 }
5700
5701 /* Inform the tracing component. */
5702 supdrvTracerModuleUnloading(pDevExt, pImage);
5703
5704 /* Do native unload if appropriate, then inform the native code about the
5705 unloading (mainly for non-native loading case). */
5706 if (pImage->fNative)
5707 supdrvOSLdrUnload(pDevExt, pImage);
5708 supdrvOSLdrNotifyUnloaded(pDevExt, pImage);
5709
5710 /* free the image */
5711 pImage->cUsage = 0;
5712 pImage->pDevExt = NULL;
5713 pImage->pNext = NULL;
5714 pImage->uState = SUP_IOCTL_LDR_FREE;
5715 RTMemExecFree(pImage->pvImageAlloc, pImage->cbImageBits + 31);
5716 pImage->pvImageAlloc = NULL;
5717 RTMemFree(pImage->pachStrTab);
5718 pImage->pachStrTab = NULL;
5719 RTMemFree(pImage->paSymbols);
5720 pImage->paSymbols = NULL;
5721 RTMemFree(pImage);
5722}
5723
5724
5725/**
5726 * Acquires the loader lock.
5727 *
5728 * @returns IPRT status code.
5729 * @param pDevExt The device extension.
5730 */
5731DECLINLINE(int) supdrvLdrLock(PSUPDRVDEVEXT pDevExt)
5732{
5733#ifdef SUPDRV_USE_MUTEX_FOR_LDR
5734 int rc = RTSemMutexRequest(pDevExt->mtxLdr, RT_INDEFINITE_WAIT);
5735#else
5736 int rc = RTSemFastMutexRequest(pDevExt->mtxLdr);
5737#endif
5738 AssertRC(rc);
5739 return rc;
5740}
5741
5742
5743/**
5744 * Releases the loader lock.
5745 *
5746 * @returns IPRT status code.
5747 * @param pDevExt The device extension.
5748 */
5749DECLINLINE(int) supdrvLdrUnlock(PSUPDRVDEVEXT pDevExt)
5750{
5751#ifdef SUPDRV_USE_MUTEX_FOR_LDR
5752 return RTSemMutexRelease(pDevExt->mtxLdr);
5753#else
5754 return RTSemFastMutexRelease(pDevExt->mtxLdr);
5755#endif
5756}
5757
5758
5759/**
5760 * Implements the service call request.
5761 *
5762 * @returns VBox status code.
5763 * @param pDevExt The device extension.
5764 * @param pSession The calling session.
5765 * @param pReq The request packet, valid.
5766 */
5767static int supdrvIOCtl_CallServiceModule(PSUPDRVDEVEXT pDevExt, PSUPDRVSESSION pSession, PSUPCALLSERVICE pReq)
5768{
5769#if !defined(RT_OS_WINDOWS) || defined(RT_ARCH_AMD64) || defined(DEBUG)
5770 int rc;
5771
5772 /*
5773 * Find the module first in the module referenced by the calling session.
5774 */
5775 rc = supdrvLdrLock(pDevExt);
5776 if (RT_SUCCESS(rc))
5777 {
5778 PFNSUPR0SERVICEREQHANDLER pfnServiceReqHandler = NULL;
5779 PSUPDRVLDRUSAGE pUsage;
5780
5781 for (pUsage = pSession->pLdrUsage; pUsage; pUsage = pUsage->pNext)
5782 if ( pUsage->pImage->pfnServiceReqHandler
5783 && !strcmp(pUsage->pImage->szName, pReq->u.In.szName))
5784 {
5785 pfnServiceReqHandler = pUsage->pImage->pfnServiceReqHandler;
5786 break;
5787 }
5788 supdrvLdrUnlock(pDevExt);
5789
5790 if (pfnServiceReqHandler)
5791 {
5792 /*
5793 * Call it.
5794 */
5795 if (pReq->Hdr.cbIn == SUP_IOCTL_CALL_SERVICE_SIZE(0))
5796 rc = pfnServiceReqHandler(pSession, pReq->u.In.uOperation, pReq->u.In.u64Arg, NULL);
5797 else
5798 rc = pfnServiceReqHandler(pSession, pReq->u.In.uOperation, pReq->u.In.u64Arg, (PSUPR0SERVICEREQHDR)&pReq->abReqPkt[0]);
5799 }
5800 else
5801 rc = VERR_SUPDRV_SERVICE_NOT_FOUND;
5802 }
5803
5804 /* log it */
5805 if ( RT_FAILURE(rc)
5806 && rc != VERR_INTERRUPTED
5807 && rc != VERR_TIMEOUT)
5808 Log(("SUP_IOCTL_CALL_SERVICE: rc=%Rrc op=%u out=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
5809 rc, pReq->u.In.uOperation, pReq->Hdr.cbOut, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
5810 else
5811 Log4(("SUP_IOCTL_CALL_SERVICE: rc=%Rrc op=%u out=%u arg=%RX64 p/t=%RTproc/%RTthrd\n",
5812 rc, pReq->u.In.uOperation, pReq->Hdr.cbOut, pReq->u.In.u64Arg, RTProcSelf(), RTThreadNativeSelf()));
5813 return rc;
5814#else /* RT_OS_WINDOWS && !RT_ARCH_AMD64 && !DEBUG */
5815 RT_NOREF3(pDevExt, pSession, pReq);
5816 return VERR_NOT_IMPLEMENTED;
5817#endif /* RT_OS_WINDOWS && !RT_ARCH_AMD64 && !DEBUG */
5818}
5819
5820
5821/**
5822 * Implements the logger settings request.
5823 *
5824 * @returns VBox status code.
5825 * @param pReq The request.
5826 */
5827static int supdrvIOCtl_LoggerSettings(PSUPLOGGERSETTINGS pReq)
5828{
5829 const char *pszGroup = &pReq->u.In.szStrings[pReq->u.In.offGroups];
5830 const char *pszFlags = &pReq->u.In.szStrings[pReq->u.In.offFlags];
5831 const char *pszDest = &pReq->u.In.szStrings[pReq->u.In.offDestination];
5832 PRTLOGGER pLogger = NULL;
5833 int rc;
5834
5835 /*
5836 * Some further validation.
5837 */
5838 switch (pReq->u.In.fWhat)
5839 {
5840 case SUPLOGGERSETTINGS_WHAT_SETTINGS:
5841 case SUPLOGGERSETTINGS_WHAT_CREATE:
5842 break;
5843
5844 case SUPLOGGERSETTINGS_WHAT_DESTROY:
5845 if (*pszGroup || *pszFlags || *pszDest)
5846 return VERR_INVALID_PARAMETER;
5847 if (pReq->u.In.fWhich == SUPLOGGERSETTINGS_WHICH_RELEASE)
5848 return VERR_ACCESS_DENIED;
5849 break;
5850
5851 default:
5852 return VERR_INTERNAL_ERROR;
5853 }
5854
5855 /*
5856 * Get the logger.
5857 */
5858 switch (pReq->u.In.fWhich)
5859 {
5860 case SUPLOGGERSETTINGS_WHICH_DEBUG:
5861 pLogger = RTLogGetDefaultInstance();
5862 break;
5863
5864 case SUPLOGGERSETTINGS_WHICH_RELEASE:
5865 pLogger = RTLogRelGetDefaultInstance();
5866 break;
5867
5868 default:
5869 return VERR_INTERNAL_ERROR;
5870 }
5871
5872 /*
5873 * Do the job.
5874 */
5875 switch (pReq->u.In.fWhat)
5876 {
5877 case SUPLOGGERSETTINGS_WHAT_SETTINGS:
5878 if (pLogger)
5879 {
5880 rc = RTLogFlags(pLogger, pszFlags);
5881 if (RT_SUCCESS(rc))
5882 rc = RTLogGroupSettings(pLogger, pszGroup);
5883 NOREF(pszDest);
5884 }
5885 else
5886 rc = VERR_NOT_FOUND;
5887 break;
5888
5889 case SUPLOGGERSETTINGS_WHAT_CREATE:
5890 {
5891 if (pLogger)
5892 rc = VERR_ALREADY_EXISTS;
5893 else
5894 {
5895 static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
5896
5897 rc = RTLogCreate(&pLogger,
5898 0 /* fFlags */,
5899 pszGroup,
5900 pReq->u.In.fWhich == SUPLOGGERSETTINGS_WHICH_DEBUG
5901 ? "VBOX_LOG"
5902 : "VBOX_RELEASE_LOG",
5903 RT_ELEMENTS(s_apszGroups),
5904 s_apszGroups,
5905 RTLOGDEST_STDOUT | RTLOGDEST_DEBUGGER,
5906 NULL);
5907 if (RT_SUCCESS(rc))
5908 {
5909 rc = RTLogFlags(pLogger, pszFlags);
5910 NOREF(pszDest);
5911 if (RT_SUCCESS(rc))
5912 {
5913 switch (pReq->u.In.fWhich)
5914 {
5915 case SUPLOGGERSETTINGS_WHICH_DEBUG:
5916 pLogger = RTLogSetDefaultInstance(pLogger);
5917 break;
5918 case SUPLOGGERSETTINGS_WHICH_RELEASE:
5919 pLogger = RTLogRelSetDefaultInstance(pLogger);
5920 break;
5921 }
5922 }
5923 RTLogDestroy(pLogger);
5924 }
5925 }
5926 break;
5927 }
5928
5929 case SUPLOGGERSETTINGS_WHAT_DESTROY:
5930 switch (pReq->u.In.fWhich)
5931 {
5932 case SUPLOGGERSETTINGS_WHICH_DEBUG:
5933 pLogger = RTLogSetDefaultInstance(NULL);
5934 break;
5935 case SUPLOGGERSETTINGS_WHICH_RELEASE:
5936 pLogger = RTLogRelSetDefaultInstance(NULL);
5937 break;
5938 }
5939 rc = RTLogDestroy(pLogger);
5940 break;
5941
5942 default:
5943 {
5944 rc = VERR_INTERNAL_ERROR;
5945 break;
5946 }
5947 }
5948
5949 return rc;
5950}
5951
5952
5953/**
5954 * Implements the MSR prober operations.
5955 *
5956 * @returns VBox status code.
5957 * @param pDevExt The device extension.
5958 * @param pReq The request.
5959 */
5960static int supdrvIOCtl_MsrProber(PSUPDRVDEVEXT pDevExt, PSUPMSRPROBER pReq)
5961{
5962#ifdef SUPDRV_WITH_MSR_PROBER
5963 RTCPUID const idCpu = pReq->u.In.idCpu == UINT32_MAX ? NIL_RTCPUID : pReq->u.In.idCpu;
5964 int rc;
5965
5966 switch (pReq->u.In.enmOp)
5967 {
5968 case SUPMSRPROBEROP_READ:
5969 {
5970 uint64_t uValue;
5971 rc = supdrvOSMsrProberRead(pReq->u.In.uMsr, idCpu, &uValue);
5972 if (RT_SUCCESS(rc))
5973 {
5974 pReq->u.Out.uResults.Read.uValue = uValue;
5975 pReq->u.Out.uResults.Read.fGp = false;
5976 }
5977 else if (rc == VERR_ACCESS_DENIED)
5978 {
5979 pReq->u.Out.uResults.Read.uValue = 0;
5980 pReq->u.Out.uResults.Read.fGp = true;
5981 rc = VINF_SUCCESS;
5982 }
5983 break;
5984 }
5985
5986 case SUPMSRPROBEROP_WRITE:
5987 rc = supdrvOSMsrProberWrite(pReq->u.In.uMsr, idCpu, pReq->u.In.uArgs.Write.uToWrite);
5988 if (RT_SUCCESS(rc))
5989 pReq->u.Out.uResults.Write.fGp = false;
5990 else if (rc == VERR_ACCESS_DENIED)
5991 {
5992 pReq->u.Out.uResults.Write.fGp = true;
5993 rc = VINF_SUCCESS;
5994 }
5995 break;
5996
5997 case SUPMSRPROBEROP_MODIFY:
5998 case SUPMSRPROBEROP_MODIFY_FASTER:
5999 rc = supdrvOSMsrProberModify(idCpu, pReq);
6000 break;
6001
6002 default:
6003 return VERR_INVALID_FUNCTION;
6004 }
6005 RT_NOREF1(pDevExt);
6006 return rc;
6007#else
6008 RT_NOREF2(pDevExt, pReq);
6009 return VERR_NOT_IMPLEMENTED;
6010#endif
6011}
6012
6013
6014/**
6015 * Resume built-in keyboard on MacBook Air and Pro hosts.
6016 * If there is no built-in keyboard device, return success anyway.
6017 *
6018 * @returns 0 on Mac OS X platform, VERR_NOT_IMPLEMENTED on the other ones.
6019 */
6020static int supdrvIOCtl_ResumeSuspendedKbds(void)
6021{
6022#if defined(RT_OS_DARWIN)
6023 return supdrvDarwinResumeSuspendedKbds();
6024#else
6025 return VERR_NOT_IMPLEMENTED;
6026#endif
6027}
6028
Note: See TracBrowser for help on using the repository browser.

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