VirtualBox

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

Last change on this file since 66573 was 66551, checked in by vboxsync, 8 years ago

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

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