VirtualBox

source: vbox/trunk/src/VBox/VMM/VMMR0/GVMMR0.cpp@ 13542

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

VBox-doc.c,VMM: doxygen links
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 54.4 KB
Line 
1/* $Id: GVMMR0.cpp 13001 2008-10-06 11:06:14Z vboxsync $ */
2/** @file
3 * GVMM - Global VM Manager.
4 */
5
6/*
7 * Copyright (C) 2007 Sun Microsystems, Inc.
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
18 * Clara, CA 95054 USA or visit http://www.sun.com if you need
19 * additional information or have any questions.
20 */
21
22
23/** @page pg_gvmm GVMM - The Global VM Manager
24 *
25 * The Global VM Manager lives in ring-0. It's main function at the moment
26 * is to manage a list of all running VMs, keep a ring-0 only structure (GVM)
27 * for each of them, and assign them unique identifiers (so GMM can track
28 * page owners). The idea for the future is to add an idle priority kernel
29 * thread that can take care of tasks like page sharing.
30 *
31 * The GVMM will create a ring-0 object for each VM when it's registered,
32 * this is both for session cleanup purposes and for having a point where
33 * it's possible to implement usage polices later (in SUPR0ObjRegister).
34 */
35
36
37/*******************************************************************************
38* Header Files *
39*******************************************************************************/
40#define LOG_GROUP LOG_GROUP_GVMM
41#include <VBox/gvmm.h>
42#include "GVMMR0Internal.h"
43#include <VBox/gvm.h>
44#include <VBox/vm.h>
45#include <VBox/err.h>
46#include <iprt/alloc.h>
47#include <iprt/semaphore.h>
48#include <iprt/time.h>
49#include <VBox/log.h>
50#include <iprt/thread.h>
51#include <iprt/param.h>
52#include <iprt/string.h>
53#include <iprt/assert.h>
54#include <iprt/mem.h>
55#include <iprt/memobj.h>
56
57
58/*******************************************************************************
59* Structures and Typedefs *
60*******************************************************************************/
61
62/**
63 * Global VM handle.
64 */
65typedef struct GVMHANDLE
66{
67 /** The index of the next handle in the list (free or used). (0 is nil.) */
68 uint16_t volatile iNext;
69 /** Our own index / handle value. */
70 uint16_t iSelf;
71 /** The pointer to the ring-0 only (aka global) VM structure. */
72 PGVM pGVM;
73 /** The ring-0 mapping of the shared VM instance data. */
74 PVM pVM;
75 /** The virtual machine object. */
76 void *pvObj;
77 /** The session this VM is associated with. */
78 PSUPDRVSESSION pSession;
79 /** The ring-0 handle of the EMT thread.
80 * This is used for assertions and similar cases where we need to find the VM handle. */
81 RTNATIVETHREAD hEMT;
82} GVMHANDLE;
83/** Pointer to a global VM handle. */
84typedef GVMHANDLE *PGVMHANDLE;
85
86/**
87 * The GVMM instance data.
88 */
89typedef struct GVMM
90{
91 /** Eyecatcher / magic. */
92 uint32_t u32Magic;
93 /** The index of the head of the free handle chain. (0 is nil.) */
94 uint16_t volatile iFreeHead;
95 /** The index of the head of the active handle chain. (0 is nil.) */
96 uint16_t volatile iUsedHead;
97 /** The number of VMs. */
98 uint16_t volatile cVMs;
99// /** The number of halted EMT threads. */
100// uint16_t volatile cHaltedEMTs;
101 /** The lock used to serialize VM creation, destruction and associated events that
102 * isn't performance critical. Owners may acquire the list lock. */
103 RTSEMFASTMUTEX CreateDestroyLock;
104 /** The lock used to serialize used list updates and accesses.
105 * This indirectly includes scheduling since the scheduler will have to walk the
106 * used list to examin running VMs. Owners may not acquire any other locks. */
107 RTSEMFASTMUTEX UsedLock;
108 /** The handle array.
109 * The size of this array defines the maximum number of currently running VMs.
110 * The first entry is unused as it represents the NIL handle. */
111 GVMHANDLE aHandles[128];
112
113 /** @gcfgm{/GVMM/cVMsMeansCompany, 32-bit, 0, UINT32_MAX, 1}
114 * The number of VMs that means we no longer consider ourselves alone on a CPU/Core.
115 */
116 uint32_t cVMsMeansCompany;
117 /** @gcfgm{/GVMM/MinSleepAlone,32-bit, 0, 100000000, 750000, ns}
118 * The minimum sleep time for when we're alone, in nano seconds.
119 */
120 uint32_t nsMinSleepAlone;
121 /** @gcfgm{/GVMM/MinSleepCompany,32-bit,0, 100000000, 15000, ns}
122 * The minimum sleep time for when we've got company, in nano seconds.
123 */
124 uint32_t nsMinSleepCompany;
125 /** @gcfgm{/GVMM/EarlyWakeUp1, 32-bit, 0, 100000000, 25000, ns}
126 * The limit for the first round of early wakeups, given in nano seconds.
127 */
128 uint32_t nsEarlyWakeUp1;
129 /** @gcfgm{/GVMM/EarlyWakeUp2, 32-bit, 0, 100000000, 50000, ns}
130 * The limit for the second round of early wakeups, given in nano seconds.
131 */
132 uint32_t nsEarlyWakeUp2;
133} GVMM;
134/** Pointer to the GVMM instance data. */
135typedef GVMM *PGVMM;
136
137/** The GVMM::u32Magic value (Charlie Haden). */
138#define GVMM_MAGIC 0x19370806
139
140
141
142/*******************************************************************************
143* Global Variables *
144*******************************************************************************/
145/** Pointer to the GVMM instance data.
146 * (Just my general dislike for global variables.) */
147static PGVMM g_pGVMM = NULL;
148
149/** Macro for obtaining and validating the g_pGVMM pointer.
150 * On failure it will return from the invoking function with the specified return value.
151 *
152 * @param pGVMM The name of the pGVMM variable.
153 * @param rc The return value on failure. Use VERR_INTERNAL_ERROR for
154 * VBox status codes.
155 */
156#define GVMM_GET_VALID_INSTANCE(pGVMM, rc) \
157 do { \
158 (pGVMM) = g_pGVMM;\
159 AssertPtrReturn((pGVMM), (rc)); \
160 AssertMsgReturn((pGVMM)->u32Magic == GVMM_MAGIC, ("%p - %#x\n", (pGVMM), (pGVMM)->u32Magic), (rc)); \
161 } while (0)
162
163/** Macro for obtaining and validating the g_pGVMM pointer, void function variant.
164 * On failure it will return from the invoking function.
165 *
166 * @param pGVMM The name of the pGVMM variable.
167 */
168#define GVMM_GET_VALID_INSTANCE_VOID(pGVMM) \
169 do { \
170 (pGVMM) = g_pGVMM;\
171 AssertPtrReturnVoid((pGVMM)); \
172 AssertMsgReturnVoid((pGVMM)->u32Magic == GVMM_MAGIC, ("%p - %#x\n", (pGVMM), (pGVMM)->u32Magic)); \
173 } while (0)
174
175
176/*******************************************************************************
177* Internal Functions *
178*******************************************************************************/
179static void gvmmR0InitPerVMData(PGVM pGVM);
180static DECLCALLBACK(void) gvmmR0HandleObjDestructor(void *pvObj, void *pvGVMM, void *pvHandle);
181static int gvmmR0ByVM(PVM pVM, PGVM *ppGVM, PGVMM *ppGVMM, bool fTakeUsedLock);
182static int gvmmR0ByVMAndEMT(PVM pVM, PGVM *ppGVM, PGVMM *ppGVMM);
183
184
185/**
186 * Initializes the GVMM.
187 *
188 * This is called while owninng the loader sempahore (see supdrvIOCtl_LdrLoad()).
189 *
190 * @returns VBox status code.
191 */
192GVMMR0DECL(int) GVMMR0Init(void)
193{
194 LogFlow(("GVMMR0Init:\n"));
195
196 /*
197 * Allocate and initialize the instance data.
198 */
199 PGVMM pGVMM = (PGVMM)RTMemAllocZ(sizeof(*pGVMM));
200 if (!pGVMM)
201 return VERR_NO_MEMORY;
202 int rc = RTSemFastMutexCreate(&pGVMM->CreateDestroyLock);
203 if (RT_SUCCESS(rc))
204 {
205 rc = RTSemFastMutexCreate(&pGVMM->UsedLock);
206 if (RT_SUCCESS(rc))
207 {
208 pGVMM->u32Magic = GVMM_MAGIC;
209 pGVMM->iUsedHead = 0;
210 pGVMM->iFreeHead = 1;
211
212 /* the nil handle */
213 pGVMM->aHandles[0].iSelf = 0;
214 pGVMM->aHandles[0].iNext = 0;
215
216 /* the tail */
217 unsigned i = RT_ELEMENTS(pGVMM->aHandles) - 1;
218 pGVMM->aHandles[i].iSelf = i;
219 pGVMM->aHandles[i].iNext = 0; /* nil */
220
221 /* the rest */
222 while (i-- > 1)
223 {
224 pGVMM->aHandles[i].iSelf = i;
225 pGVMM->aHandles[i].iNext = i + 1;
226 }
227
228 /* The default configuration values. */
229 pGVMM->cVMsMeansCompany = 1; /** @todo should be adjusted to relative to the cpu count or something... */
230 pGVMM->nsMinSleepAlone = 750000 /* ns (0.750 ms) */; /** @todo this should be adjusted to be 75% (or something) of the scheduler granularity... */
231 pGVMM->nsMinSleepCompany = 15000 /* ns (0.015 ms) */;
232 pGVMM->nsEarlyWakeUp1 = 25000 /* ns (0.025 ms) */;
233 pGVMM->nsEarlyWakeUp2 = 50000 /* ns (0.050 ms) */;
234
235 g_pGVMM = pGVMM;
236 LogFlow(("GVMMR0Init: pGVMM=%p\n", pGVMM));
237 return VINF_SUCCESS;
238 }
239
240 RTSemFastMutexDestroy(pGVMM->CreateDestroyLock);
241 }
242
243 RTMemFree(pGVMM);
244 return rc;
245}
246
247
248/**
249 * Terminates the GVM.
250 *
251 * This is called while owning the loader semaphore (see supdrvLdrFree()).
252 * And unless something is wrong, there should be absolutely no VMs
253 * registered at this point.
254 */
255GVMMR0DECL(void) GVMMR0Term(void)
256{
257 LogFlow(("GVMMR0Term:\n"));
258
259 PGVMM pGVMM = g_pGVMM;
260 g_pGVMM = NULL;
261 if (RT_UNLIKELY(!VALID_PTR(pGVMM)))
262 {
263 SUPR0Printf("GVMMR0Term: pGVMM=%p\n", pGVMM);
264 return;
265 }
266
267 pGVMM->u32Magic++;
268
269 RTSemFastMutexDestroy(pGVMM->UsedLock);
270 pGVMM->UsedLock = NIL_RTSEMFASTMUTEX;
271 RTSemFastMutexDestroy(pGVMM->CreateDestroyLock);
272 pGVMM->CreateDestroyLock = NIL_RTSEMFASTMUTEX;
273
274 pGVMM->iFreeHead = 0;
275 if (pGVMM->iUsedHead)
276 {
277 SUPR0Printf("GVMMR0Term: iUsedHead=%#x! (cVMs=%#x)\n", pGVMM->iUsedHead, pGVMM->cVMs);
278 pGVMM->iUsedHead = 0;
279 }
280
281 RTMemFree(pGVMM);
282}
283
284
285/**
286 * A quick hack for setting global config values.
287 *
288 * @returns VBox status code.
289 *
290 * @param pSession The session handle. Used for authentication.
291 * @param pszName The variable name.
292 * @param u64Value The new value.
293 */
294GVMMR0DECL(int) GVMMR0SetConfig(PSUPDRVSESSION pSession, const char *pszName, uint64_t u64Value)
295{
296 /*
297 * Validate input.
298 */
299 PGVMM pGVMM;
300 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
301 AssertPtrReturn(pSession, VERR_INVALID_HANDLE);
302 AssertPtrReturn(pszName, VERR_INVALID_POINTER);
303
304 /*
305 * String switch time!
306 */
307 if (strncmp(pszName, "/GVMM/", sizeof("/GVMM/") - 1))
308 return VERR_CFGM_VALUE_NOT_FOUND; /* borrow status codes from CFGM... */
309 int rc = VINF_SUCCESS;
310 pszName += sizeof("/GVMM/") - 1;
311 if (!strcmp(pszName, "cVMsMeansCompany"))
312 {
313 if (u64Value <= UINT32_MAX)
314 pGVMM->cVMsMeansCompany = u64Value;
315 else
316 rc = VERR_OUT_OF_RANGE;
317 }
318 else if (!strcmp(pszName, "MinSleepAlone"))
319 {
320 if (u64Value <= 100000000)
321 pGVMM->nsMinSleepAlone = u64Value;
322 else
323 rc = VERR_OUT_OF_RANGE;
324 }
325 else if (!strcmp(pszName, "MinSleepCompany"))
326 {
327 if (u64Value <= 100000000)
328 pGVMM->nsMinSleepCompany = u64Value;
329 else
330 rc = VERR_OUT_OF_RANGE;
331 }
332 else if (!strcmp(pszName, "EarlyWakeUp1"))
333 {
334 if (u64Value <= 100000000)
335 pGVMM->nsEarlyWakeUp1 = u64Value;
336 else
337 rc = VERR_OUT_OF_RANGE;
338 }
339 else if (!strcmp(pszName, "EarlyWakeUp2"))
340 {
341 if (u64Value <= 100000000)
342 pGVMM->nsEarlyWakeUp2 = u64Value;
343 else
344 rc = VERR_OUT_OF_RANGE;
345 }
346 else
347 rc = VERR_CFGM_VALUE_NOT_FOUND;
348 return rc;
349}
350
351
352/**
353 * A quick hack for getting global config values.
354 *
355 * @returns VBox status code.
356 *
357 * @param pSession The session handle. Used for authentication.
358 * @param pszName The variable name.
359 * @param u64Value The new value.
360 */
361GVMMR0DECL(int) GVMMR0QueryConfig(PSUPDRVSESSION pSession, const char *pszName, uint64_t *pu64Value)
362{
363 /*
364 * Validate input.
365 */
366 PGVMM pGVMM;
367 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
368 AssertPtrReturn(pSession, VERR_INVALID_HANDLE);
369 AssertPtrReturn(pszName, VERR_INVALID_POINTER);
370 AssertPtrReturn(pu64Value, VERR_INVALID_POINTER);
371
372 /*
373 * String switch time!
374 */
375 if (strncmp(pszName, "/GVMM/", sizeof("/GVMM/") - 1))
376 return VERR_CFGM_VALUE_NOT_FOUND; /* borrow status codes from CFGM... */
377 int rc = VINF_SUCCESS;
378 pszName += sizeof("/GVMM/") - 1;
379 if (!strcmp(pszName, "cVMsMeansCompany"))
380 *pu64Value = pGVMM->cVMsMeansCompany;
381 else if (!strcmp(pszName, "MinSleepAlone"))
382 *pu64Value = pGVMM->nsMinSleepAlone;
383 else if (!strcmp(pszName, "MinSleepCompany"))
384 *pu64Value = pGVMM->nsMinSleepCompany;
385 else if (!strcmp(pszName, "EarlyWakeUp1"))
386 *pu64Value = pGVMM->nsEarlyWakeUp1;
387 else if (!strcmp(pszName, "EarlyWakeUp2"))
388 *pu64Value = pGVMM->nsEarlyWakeUp2;
389 else
390 rc = VERR_CFGM_VALUE_NOT_FOUND;
391 return rc;
392}
393
394
395/**
396 * Try acquire the 'used' lock.
397 *
398 * @returns IPRT status code, see RTSemFastMutexRequest.
399 * @param pGVMM The GVMM instance data.
400 */
401DECLINLINE(int) gvmmR0UsedLock(PGVMM pGVMM)
402{
403 LogFlow(("++gvmmR0UsedLock(%p)\n", pGVMM));
404 int rc = RTSemFastMutexRequest(pGVMM->UsedLock);
405 LogFlow(("gvmmR0UsedLock(%p)->%Rrc\n", pGVMM, rc));
406 return rc;
407}
408
409
410/**
411 * Release the 'used' lock.
412 *
413 * @returns IPRT status code, see RTSemFastMutexRelease.
414 * @param pGVMM The GVMM instance data.
415 */
416DECLINLINE(int) gvmmR0UsedUnlock(PGVMM pGVMM)
417{
418 LogFlow(("--gvmmR0UsedUnlock(%p)\n", pGVMM));
419 int rc = RTSemFastMutexRelease(pGVMM->UsedLock);
420 AssertRC(rc);
421 return rc;
422}
423
424
425/**
426 * Try acquire the 'create & destroy' lock.
427 *
428 * @returns IPRT status code, see RTSemFastMutexRequest.
429 * @param pGVMM The GVMM instance data.
430 */
431DECLINLINE(int) gvmmR0CreateDestroyLock(PGVMM pGVMM)
432{
433 LogFlow(("++gvmmR0CreateDestroyLock(%p)\n", pGVMM));
434 int rc = RTSemFastMutexRequest(pGVMM->CreateDestroyLock);
435 LogFlow(("gvmmR0CreateDestroyLock(%p)->%Rrc\n", pGVMM, rc));
436 return rc;
437}
438
439
440/**
441 * Release the 'create & destroy' lock.
442 *
443 * @returns IPRT status code, see RTSemFastMutexRequest.
444 * @param pGVMM The GVMM instance data.
445 */
446DECLINLINE(int) gvmmR0CreateDestroyUnlock(PGVMM pGVMM)
447{
448 LogFlow(("--gvmmR0CreateDestroyUnlock(%p)\n", pGVMM));
449 int rc = RTSemFastMutexRelease(pGVMM->CreateDestroyLock);
450 AssertRC(rc);
451 return rc;
452}
453
454
455/**
456 * Request wrapper for the GVMMR0CreateVM API.
457 *
458 * @returns VBox status code.
459 * @param pReq The request buffer.
460 */
461GVMMR0DECL(int) GVMMR0CreateVMReq(PGVMMCREATEVMREQ pReq)
462{
463 /*
464 * Validate the request.
465 */
466 if (!VALID_PTR(pReq))
467 return VERR_INVALID_POINTER;
468 if (pReq->Hdr.cbReq != sizeof(*pReq))
469 return VERR_INVALID_PARAMETER;
470 if (!VALID_PTR(pReq->pSession))
471 return VERR_INVALID_POINTER;
472
473 /*
474 * Execute it.
475 */
476 PVM pVM;
477 pReq->pVMR0 = NULL;
478 pReq->pVMR3 = NIL_RTR3PTR;
479 int rc = GVMMR0CreateVM(pReq->pSession, &pVM);
480 if (RT_SUCCESS(rc))
481 {
482 pReq->pVMR0 = pVM;
483 pReq->pVMR3 = pVM->pVMR3;
484 }
485 return rc;
486}
487
488
489/**
490 * Allocates the VM structure and registers it with GVM.
491 *
492 * The caller will become the VM owner and there by the EMT.
493 *
494 * @returns VBox status code.
495 * @param pSession The support driver session.
496 * @param ppVM Where to store the pointer to the VM structure.
497 *
498 * @thread EMT.
499 */
500GVMMR0DECL(int) GVMMR0CreateVM(PSUPDRVSESSION pSession, PVM *ppVM)
501{
502 LogFlow(("GVMMR0CreateVM: pSession=%p\n", pSession));
503 PGVMM pGVMM;
504 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
505
506 AssertPtrReturn(ppVM, VERR_INVALID_POINTER);
507 *ppVM = NULL;
508
509 RTNATIVETHREAD hEMT = RTThreadNativeSelf();
510 AssertReturn(hEMT != NIL_RTNATIVETHREAD, VERR_INTERNAL_ERROR);
511
512 /*
513 * The whole allocation process is protected by the lock.
514 */
515 int rc = gvmmR0CreateDestroyLock(pGVMM);
516 AssertRCReturn(rc, rc);
517
518 /*
519 * Allocate a handle first so we don't waste resources unnecessarily.
520 */
521 uint16_t iHandle = pGVMM->iFreeHead;
522 if (iHandle)
523 {
524 PGVMHANDLE pHandle = &pGVMM->aHandles[iHandle];
525
526 /* consistency checks, a bit paranoid as always. */
527 if ( !pHandle->pVM
528 && !pHandle->pGVM
529 && !pHandle->pvObj
530 && pHandle->iSelf == iHandle)
531 {
532 pHandle->pvObj = SUPR0ObjRegister(pSession, SUPDRVOBJTYPE_VM, gvmmR0HandleObjDestructor, pGVMM, pHandle);
533 if (pHandle->pvObj)
534 {
535 /*
536 * Move the handle from the free to used list and perform permission checks.
537 */
538 rc = gvmmR0UsedLock(pGVMM);
539 AssertRC(rc);
540
541 pGVMM->iFreeHead = pHandle->iNext;
542 pHandle->iNext = pGVMM->iUsedHead;
543 pGVMM->iUsedHead = iHandle;
544 pGVMM->cVMs++;
545
546 pHandle->pVM = NULL;
547 pHandle->pGVM = NULL;
548 pHandle->pSession = pSession;
549 pHandle->hEMT = NIL_RTNATIVETHREAD;
550
551 gvmmR0UsedUnlock(pGVMM);
552
553 rc = SUPR0ObjVerifyAccess(pHandle->pvObj, pSession, NULL);
554 if (RT_SUCCESS(rc))
555 {
556 /*
557 * Allocate the global VM structure (GVM) and initialize it.
558 */
559 PGVM pGVM = (PGVM)RTMemAllocZ(sizeof(*pGVM));
560 if (pGVM)
561 {
562 pGVM->u32Magic = GVM_MAGIC;
563 pGVM->hSelf = iHandle;
564 pGVM->hEMT = NIL_RTNATIVETHREAD;
565 pGVM->pVM = NULL;
566
567 gvmmR0InitPerVMData(pGVM);
568 /* GMMR0InitPerVMData(pGVM); - later */
569
570 /*
571 * Allocate the shared VM structure and associated page array.
572 */
573 const size_t cPages = RT_ALIGN(sizeof(VM), PAGE_SIZE) >> PAGE_SHIFT;
574 rc = RTR0MemObjAllocLow(&pGVM->gvmm.s.VMMemObj, cPages << PAGE_SHIFT, false /* fExecutable */);
575 if (RT_SUCCESS(rc))
576 {
577 PVM pVM = (PVM)RTR0MemObjAddress(pGVM->gvmm.s.VMMemObj); AssertPtr(pVM);
578 memset(pVM, 0, cPages << PAGE_SHIFT);
579 pVM->enmVMState = VMSTATE_CREATING;
580 pVM->pVMR0 = pVM;
581 pVM->pSession = pSession;
582 pVM->hSelf = iHandle;
583
584 rc = RTR0MemObjAllocPage(&pGVM->gvmm.s.VMPagesMemObj, cPages * sizeof(SUPPAGE), false /* fExecutable */);
585 if (RT_SUCCESS(rc))
586 {
587 PSUPPAGE paPages = (PSUPPAGE)RTR0MemObjAddress(pGVM->gvmm.s.VMPagesMemObj); AssertPtr(paPages);
588 for (size_t iPage = 0; iPage < cPages; iPage++)
589 {
590 paPages[iPage].uReserved = 0;
591 paPages[iPage].Phys = RTR0MemObjGetPagePhysAddr(pGVM->gvmm.s.VMMemObj, iPage);
592 Assert(paPages[iPage].Phys != NIL_RTHCPHYS);
593 }
594
595 /*
596 * Map them into ring-3.
597 */
598 rc = RTR0MemObjMapUser(&pGVM->gvmm.s.VMMapObj, pGVM->gvmm.s.VMMemObj, (RTR3PTR)-1, 0,
599 RTMEM_PROT_READ | RTMEM_PROT_WRITE, NIL_RTR0PROCESS);
600 if (RT_SUCCESS(rc))
601 {
602 pVM->pVMR3 = RTR0MemObjAddressR3(pGVM->gvmm.s.VMMapObj);
603 AssertPtr((void *)pVM->pVMR3);
604
605 /** @todo SMP - need to get the cpu count and initialize all the VM pointers. */
606 pVM->aCpus[0].pVMR0 = pVM;
607 pVM->aCpus[0].pVMR3 = pVM->pVMR3;
608
609 rc = RTR0MemObjMapUser(&pGVM->gvmm.s.VMPagesMapObj, pGVM->gvmm.s.VMPagesMemObj, (RTR3PTR)-1, 0,
610 RTMEM_PROT_READ | RTMEM_PROT_WRITE, NIL_RTR0PROCESS);
611 if (RT_SUCCESS(rc))
612 {
613 pVM->paVMPagesR3 = RTR0MemObjAddressR3(pGVM->gvmm.s.VMPagesMapObj);
614 AssertPtr((void *)pVM->paVMPagesR3);
615
616 /* complete the handle - take the UsedLock sem just to be careful. */
617 rc = gvmmR0UsedLock(pGVMM);
618 AssertRC(rc);
619
620 pHandle->pVM = pVM;
621 pHandle->pGVM = pGVM;
622 pHandle->hEMT = hEMT;
623 pGVM->pVM = pVM;
624 pGVM->hEMT = hEMT;
625
626 gvmmR0UsedUnlock(pGVMM);
627 gvmmR0CreateDestroyUnlock(pGVMM);
628
629 *ppVM = pVM;
630 Log(("GVMMR0CreateVM: pVM=%p pVMR3=%p pGVM=%p hGVM=%d\n", pVM, pVM->pVMR3, pGVM, iHandle));
631 return VINF_SUCCESS;
632 }
633
634 RTR0MemObjFree(pGVM->gvmm.s.VMMapObj, false /* fFreeMappings */);
635 pGVM->gvmm.s.VMMapObj = NIL_RTR0MEMOBJ;
636 }
637 RTR0MemObjFree(pGVM->gvmm.s.VMPagesMemObj, false /* fFreeMappings */);
638 pGVM->gvmm.s.VMPagesMemObj = NIL_RTR0MEMOBJ;
639 }
640 RTR0MemObjFree(pGVM->gvmm.s.VMMemObj, false /* fFreeMappings */);
641 pGVM->gvmm.s.VMMemObj = NIL_RTR0MEMOBJ;
642 }
643 }
644 }
645 /* else: The user wasn't permitted to create this VM. */
646
647 /*
648 * The handle will be freed by gvmmR0HandleObjDestructor as we release the
649 * object reference here. A little extra mess because of non-recursive lock.
650 */
651 void *pvObj = pHandle->pvObj;
652 pHandle->pvObj = NULL;
653 gvmmR0CreateDestroyUnlock(pGVMM);
654
655 SUPR0ObjRelease(pvObj, pSession);
656
657 SUPR0Printf("GVMMR0CreateVM: failed, rc=%d\n", rc);
658 return rc;
659 }
660
661 rc = VERR_NO_MEMORY;
662 }
663 else
664 rc = VERR_INTERNAL_ERROR;
665 }
666 else
667 rc = VERR_GVM_TOO_MANY_VMS;
668
669 gvmmR0CreateDestroyUnlock(pGVMM);
670 return rc;
671}
672
673
674/**
675 * Initializes the per VM data belonging to GVMM.
676 *
677 * @param pGVM Pointer to the global VM structure.
678 */
679static void gvmmR0InitPerVMData(PGVM pGVM)
680{
681 AssertCompile(RT_SIZEOFMEMB(GVM,gvmm.s) <= RT_SIZEOFMEMB(GVM,gvmm.padding));
682 Assert(RT_SIZEOFMEMB(GVM,gvmm.s) <= RT_SIZEOFMEMB(GVM,gvmm.padding));
683 pGVM->gvmm.s.VMMemObj = NIL_RTR0MEMOBJ;
684 pGVM->gvmm.s.VMMapObj = NIL_RTR0MEMOBJ;
685 pGVM->gvmm.s.VMPagesMemObj = NIL_RTR0MEMOBJ;
686 pGVM->gvmm.s.VMPagesMapObj = NIL_RTR0MEMOBJ;
687 pGVM->gvmm.s.HaltEventMulti = NIL_RTSEMEVENTMULTI;
688}
689
690
691/**
692 * Does the VM initialization.
693 *
694 * @returns VBox status code.
695 * @param pVM Pointer to the shared VM structure.
696 */
697GVMMR0DECL(int) GVMMR0InitVM(PVM pVM)
698{
699 LogFlow(("GVMMR0InitVM: pVM=%p\n", pVM));
700
701 /*
702 * Validate the VM structure, state and handle.
703 */
704 PGVM pGVM;
705 PGVMM pGVMM;
706 int rc = gvmmR0ByVMAndEMT(pVM, &pGVM, &pGVMM);
707 if (RT_SUCCESS(rc))
708 {
709 if (pGVM->gvmm.s.HaltEventMulti == NIL_RTSEMEVENTMULTI)
710 {
711 rc = RTSemEventMultiCreate(&pGVM->gvmm.s.HaltEventMulti);
712 if (RT_FAILURE(rc))
713 pGVM->gvmm.s.HaltEventMulti = NIL_RTSEMEVENTMULTI;
714 }
715 else
716 rc = VERR_WRONG_ORDER;
717 }
718
719 LogFlow(("GVMMR0InitVM: returns %Rrc\n", rc));
720 return rc;
721}
722
723
724/**
725 * Destroys the VM, freeing all associated resources (the ring-0 ones anyway).
726 *
727 * This is call from the vmR3DestroyFinalBit and from a error path in VMR3Create,
728 * and the caller is not the EMT thread, unfortunately. For security reasons, it
729 * would've been nice if the caller was actually the EMT thread or that we somehow
730 * could've associated the calling thread with the VM up front.
731 *
732 * @returns VBox status code.
733 * @param pVM Where to store the pointer to the VM structure.
734 *
735 * @thread EMT if it's associated with the VM, otherwise any thread.
736 */
737GVMMR0DECL(int) GVMMR0DestroyVM(PVM pVM)
738{
739 LogFlow(("GVMMR0DestroyVM: pVM=%p\n", pVM));
740 PGVMM pGVMM;
741 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
742
743
744 /*
745 * Validate the VM structure, state and caller.
746 */
747 AssertPtrReturn(pVM, VERR_INVALID_POINTER);
748 AssertReturn(!((uintptr_t)pVM & PAGE_OFFSET_MASK), VERR_INVALID_POINTER);
749 AssertMsgReturn(pVM->enmVMState >= VMSTATE_CREATING && pVM->enmVMState <= VMSTATE_TERMINATED, ("%d\n", pVM->enmVMState), VERR_WRONG_ORDER);
750
751 uint32_t hGVM = pVM->hSelf;
752 AssertReturn(hGVM != NIL_GVM_HANDLE, VERR_INVALID_HANDLE);
753 AssertReturn(hGVM < RT_ELEMENTS(pGVMM->aHandles), VERR_INVALID_HANDLE);
754
755 PGVMHANDLE pHandle = &pGVMM->aHandles[hGVM];
756 AssertReturn(pHandle->pVM == pVM, VERR_NOT_OWNER);
757
758 RTNATIVETHREAD hSelf = RTThreadNativeSelf();
759 AssertReturn(pHandle->hEMT == hSelf || pHandle->hEMT == NIL_RTNATIVETHREAD, VERR_NOT_OWNER);
760
761 /*
762 * Lookup the handle and destroy the object.
763 * Since the lock isn't recursive and we'll have to leave it before dereferencing the
764 * object, we take some precautions against racing callers just in case...
765 */
766 int rc = gvmmR0CreateDestroyLock(pGVMM);
767 AssertRC(rc);
768
769 /* be careful here because we might theoretically be racing someone else cleaning up. */
770 if ( pHandle->pVM == pVM
771 && ( pHandle->hEMT == hSelf
772 || pHandle->hEMT == NIL_RTNATIVETHREAD)
773 && VALID_PTR(pHandle->pvObj)
774 && VALID_PTR(pHandle->pSession)
775 && VALID_PTR(pHandle->pGVM)
776 && pHandle->pGVM->u32Magic == GVM_MAGIC)
777 {
778 void *pvObj = pHandle->pvObj;
779 pHandle->pvObj = NULL;
780 gvmmR0CreateDestroyUnlock(pGVMM);
781
782 SUPR0ObjRelease(pvObj, pHandle->pSession);
783 }
784 else
785 {
786 SUPR0Printf("GVMMR0DestroyVM: pHandle=%p:{.pVM=%p, hEMT=%p, .pvObj=%p} pVM=%p hSelf=%p\n",
787 pHandle, pHandle->pVM, pHandle->hEMT, pHandle->pvObj, pVM, hSelf);
788 gvmmR0CreateDestroyUnlock(pGVMM);
789 rc = VERR_INTERNAL_ERROR;
790 }
791
792 return rc;
793}
794
795
796/**
797 * Handle destructor.
798 *
799 * @param pvGVMM The GVM instance pointer.
800 * @param pvHandle The handle pointer.
801 */
802static DECLCALLBACK(void) gvmmR0HandleObjDestructor(void *pvObj, void *pvGVMM, void *pvHandle)
803{
804 LogFlow(("gvmmR0HandleObjDestructor: %p %p %p\n", pvObj, pvGVMM, pvHandle));
805
806 /*
807 * Some quick, paranoid, input validation.
808 */
809 PGVMHANDLE pHandle = (PGVMHANDLE)pvHandle;
810 AssertPtr(pHandle);
811 PGVMM pGVMM = (PGVMM)pvGVMM;
812 Assert(pGVMM == g_pGVMM);
813 const uint16_t iHandle = pHandle - &pGVMM->aHandles[0];
814 if ( !iHandle
815 || iHandle >= RT_ELEMENTS(pGVMM->aHandles)
816 || iHandle != pHandle->iSelf)
817 {
818 SUPR0Printf("GVM: handle %d is out of range or corrupt (iSelf=%d)!\n", iHandle, pHandle->iSelf);
819 return;
820 }
821
822 int rc = gvmmR0CreateDestroyLock(pGVMM);
823 AssertRC(rc);
824 rc = gvmmR0UsedLock(pGVMM);
825 AssertRC(rc);
826
827 /*
828 * This is a tad slow but a doubly linked list is too much hazzle.
829 */
830 if (RT_UNLIKELY(pHandle->iNext >= RT_ELEMENTS(pGVMM->aHandles)))
831 {
832 SUPR0Printf("GVM: used list index %d is out of range!\n", pHandle->iNext);
833 gvmmR0UsedUnlock(pGVMM);
834 gvmmR0CreateDestroyUnlock(pGVMM);
835 return;
836 }
837
838 if (pGVMM->iUsedHead == iHandle)
839 pGVMM->iUsedHead = pHandle->iNext;
840 else
841 {
842 uint16_t iPrev = pGVMM->iUsedHead;
843 int c = RT_ELEMENTS(pGVMM->aHandles) + 2;
844 while (iPrev)
845 {
846 if (RT_UNLIKELY(iPrev >= RT_ELEMENTS(pGVMM->aHandles)))
847 {
848 SUPR0Printf("GVM: used list index %d is out of range!\n");
849 gvmmR0UsedUnlock(pGVMM);
850 gvmmR0CreateDestroyUnlock(pGVMM);
851 return;
852 }
853 if (RT_UNLIKELY(c-- <= 0))
854 {
855 iPrev = 0;
856 break;
857 }
858
859 if (pGVMM->aHandles[iPrev].iNext == iHandle)
860 break;
861 iPrev = pGVMM->aHandles[iPrev].iNext;
862 }
863 if (!iPrev)
864 {
865 SUPR0Printf("GVM: can't find the handle previous previous of %d!\n", pHandle->iSelf);
866 gvmmR0UsedUnlock(pGVMM);
867 gvmmR0CreateDestroyUnlock(pGVMM);
868 return;
869 }
870
871 Assert(pGVMM->aHandles[iPrev].iNext == iHandle);
872 pGVMM->aHandles[iPrev].iNext = pHandle->iNext;
873 }
874 pHandle->iNext = 0;
875 pGVMM->cVMs--;
876
877 gvmmR0UsedUnlock(pGVMM);
878
879 /*
880 * Do the global cleanup round.
881 */
882 PGVM pGVM = pHandle->pGVM;
883 if ( VALID_PTR(pGVM)
884 && pGVM->u32Magic == GVM_MAGIC)
885 {
886 /// @todo GMMR0CleanupVM(pGVM);
887
888 /*
889 * Do the GVMM cleanup - must be done last.
890 */
891 /* The VM and VM pages mappings/allocations. */
892 if (pGVM->gvmm.s.VMPagesMapObj != NIL_RTR0MEMOBJ)
893 {
894 rc = RTR0MemObjFree(pGVM->gvmm.s.VMPagesMapObj, false /* fFreeMappings */); AssertRC(rc);
895 pGVM->gvmm.s.VMPagesMapObj = NIL_RTR0MEMOBJ;
896 }
897
898 if (pGVM->gvmm.s.VMMapObj != NIL_RTR0MEMOBJ)
899 {
900 rc = RTR0MemObjFree(pGVM->gvmm.s.VMMapObj, false /* fFreeMappings */); AssertRC(rc);
901 pGVM->gvmm.s.VMMapObj = NIL_RTR0MEMOBJ;
902 }
903
904 if (pGVM->gvmm.s.VMPagesMemObj != NIL_RTR0MEMOBJ)
905 {
906 rc = RTR0MemObjFree(pGVM->gvmm.s.VMPagesMemObj, false /* fFreeMappings */); AssertRC(rc);
907 pGVM->gvmm.s.VMPagesMemObj = NIL_RTR0MEMOBJ;
908 }
909
910 if (pGVM->gvmm.s.VMMemObj != NIL_RTR0MEMOBJ)
911 {
912 rc = RTR0MemObjFree(pGVM->gvmm.s.VMMemObj, false /* fFreeMappings */); AssertRC(rc);
913 pGVM->gvmm.s.VMMemObj = NIL_RTR0MEMOBJ;
914 }
915
916 if (pGVM->gvmm.s.HaltEventMulti != NIL_RTSEMEVENTMULTI)
917 {
918 rc = RTSemEventMultiDestroy(pGVM->gvmm.s.HaltEventMulti); AssertRC(rc);
919 pGVM->gvmm.s.HaltEventMulti = NIL_RTSEMEVENTMULTI;
920 }
921
922 /* the GVM structure itself. */
923 pGVM->u32Magic++;
924 RTMemFree(pGVM);
925 }
926 /* else: GVMMR0CreateVM cleanup. */
927
928 /*
929 * Free the handle.
930 * Reacquire the UsedLock here to since we're updating handle fields.
931 */
932 rc = gvmmR0UsedLock(pGVMM);
933 AssertRC(rc);
934
935 pHandle->iNext = pGVMM->iFreeHead;
936 pGVMM->iFreeHead = iHandle;
937 ASMAtomicXchgPtr((void * volatile *)&pHandle->pGVM, NULL);
938 ASMAtomicXchgPtr((void * volatile *)&pHandle->pVM, NULL);
939 ASMAtomicXchgPtr((void * volatile *)&pHandle->pvObj, NULL);
940 ASMAtomicXchgPtr((void * volatile *)&pHandle->pSession, NULL);
941 ASMAtomicXchgSize(&pHandle->hEMT, NIL_RTNATIVETHREAD);
942
943 gvmmR0UsedUnlock(pGVMM);
944 gvmmR0CreateDestroyUnlock(pGVMM);
945 LogFlow(("gvmmR0HandleObjDestructor: returns\n"));
946}
947
948
949/**
950 * Lookup a GVM structure by its handle.
951 *
952 * @returns The GVM pointer on success, NULL on failure.
953 * @param hGVM The global VM handle. Asserts on bad handle.
954 */
955GVMMR0DECL(PGVM) GVMMR0ByHandle(uint32_t hGVM)
956{
957 PGVMM pGVMM;
958 GVMM_GET_VALID_INSTANCE(pGVMM, NULL);
959
960 /*
961 * Validate.
962 */
963 AssertReturn(hGVM != NIL_GVM_HANDLE, NULL);
964 AssertReturn(hGVM < RT_ELEMENTS(pGVMM->aHandles), NULL);
965
966 /*
967 * Look it up.
968 */
969 PGVMHANDLE pHandle = &pGVMM->aHandles[hGVM];
970 AssertPtrReturn(pHandle->pVM, NULL);
971 AssertPtrReturn(pHandle->pvObj, NULL);
972 PGVM pGVM = pHandle->pGVM;
973 AssertPtrReturn(pGVM, NULL);
974 AssertReturn(pGVM->pVM == pHandle->pVM, NULL);
975
976 return pHandle->pGVM;
977}
978
979
980/**
981 * Lookup a GVM structure by the shared VM structure.
982 *
983 * @returns VBox status code.
984 * @param pVM The shared VM structure (the ring-0 mapping).
985 * @param ppGVM Where to store the GVM pointer.
986 * @param ppGVMM Where to store the pointer to the GVMM instance data.
987 * @param fTakeUsedLock Whether to take the used lock or not.
988 * Be very careful if not taking the lock as it's possible that
989 * the VM will disappear then.
990 *
991 * @remark This will not assert on an invalid pVM but try return sliently.
992 */
993static int gvmmR0ByVM(PVM pVM, PGVM *ppGVM, PGVMM *ppGVMM, bool fTakeUsedLock)
994{
995 PGVMM pGVMM;
996 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
997
998 /*
999 * Validate.
1000 */
1001 if (RT_UNLIKELY( !VALID_PTR(pVM)
1002 || ((uintptr_t)pVM & PAGE_OFFSET_MASK)))
1003 return VERR_INVALID_POINTER;
1004 if (RT_UNLIKELY( pVM->enmVMState < VMSTATE_CREATING
1005 || pVM->enmVMState >= VMSTATE_TERMINATED))
1006 return VERR_INVALID_POINTER;
1007
1008 uint16_t hGVM = pVM->hSelf;
1009 if (RT_UNLIKELY( hGVM == NIL_GVM_HANDLE
1010 || hGVM >= RT_ELEMENTS(pGVMM->aHandles)))
1011 return VERR_INVALID_HANDLE;
1012
1013 /*
1014 * Look it up.
1015 */
1016 PGVMHANDLE pHandle = &pGVMM->aHandles[hGVM];
1017 PGVM pGVM;
1018 if (fTakeUsedLock)
1019 {
1020 int rc = gvmmR0UsedLock(pGVMM);
1021 AssertRCReturn(rc, rc);
1022
1023 pGVM = pHandle->pGVM;
1024 if (RT_UNLIKELY( pHandle->pVM != pVM
1025 || !VALID_PTR(pHandle->pvObj)
1026 || !VALID_PTR(pGVM)
1027 || pGVM->pVM != pVM))
1028 {
1029 gvmmR0UsedUnlock(pGVMM);
1030 return VERR_INVALID_HANDLE;
1031 }
1032 }
1033 else
1034 {
1035 if (RT_UNLIKELY(pHandle->pVM != pVM))
1036 return VERR_INVALID_HANDLE;
1037 if (RT_UNLIKELY(!VALID_PTR(pHandle->pvObj)))
1038 return VERR_INVALID_HANDLE;
1039
1040 pGVM = pHandle->pGVM;
1041 if (RT_UNLIKELY(!VALID_PTR(pGVM)))
1042 return VERR_INVALID_HANDLE;
1043 if (RT_UNLIKELY(pGVM->pVM != pVM))
1044 return VERR_INVALID_HANDLE;
1045 }
1046
1047 *ppGVM = pGVM;
1048 *ppGVMM = pGVMM;
1049 return VINF_SUCCESS;
1050}
1051
1052
1053/**
1054 * Lookup a GVM structure by the shared VM structure.
1055 *
1056 * @returns The GVM pointer on success, NULL on failure.
1057 * @param pVM The shared VM structure (the ring-0 mapping).
1058 *
1059 * @remark This will not take the 'used'-lock because it doesn't do
1060 * nesting and this function will be used from under the lock.
1061 */
1062GVMMR0DECL(PGVM) GVMMR0ByVM(PVM pVM)
1063{
1064 PGVMM pGVMM;
1065 PGVM pGVM;
1066 int rc = gvmmR0ByVM(pVM, &pGVM, &pGVMM, false /* fTakeUsedLock */);
1067 if (RT_SUCCESS(rc))
1068 return pGVM;
1069 AssertRC(rc);
1070 return NULL;
1071}
1072
1073
1074/**
1075 * Lookup a GVM structure by the shared VM structure
1076 * and ensuring that the caller is the EMT thread.
1077 *
1078 * @returns VBox status code.
1079 * @param pVM The shared VM structure (the ring-0 mapping).
1080 * @param ppGVM Where to store the GVM pointer.
1081 * @param ppGVMM Where to store the pointer to the GVMM instance data.
1082 * @thread EMT
1083 *
1084 * @remark This will assert in failure paths.
1085 */
1086static int gvmmR0ByVMAndEMT(PVM pVM, PGVM *ppGVM, PGVMM *ppGVMM)
1087{
1088 PGVMM pGVMM;
1089 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
1090
1091 /*
1092 * Validate.
1093 */
1094 AssertPtrReturn(pVM, VERR_INVALID_POINTER);
1095 AssertReturn(!((uintptr_t)pVM & PAGE_OFFSET_MASK), VERR_INVALID_POINTER);
1096
1097 uint16_t hGVM = pVM->hSelf;
1098 AssertReturn(hGVM != NIL_GVM_HANDLE, VERR_INVALID_HANDLE);
1099 AssertReturn(hGVM < RT_ELEMENTS(pGVMM->aHandles), VERR_INVALID_HANDLE);
1100
1101 /*
1102 * Look it up.
1103 */
1104 PGVMHANDLE pHandle = &pGVMM->aHandles[hGVM];
1105 RTNATIVETHREAD hAllegedEMT = RTThreadNativeSelf();
1106 AssertMsgReturn(pHandle->hEMT == hAllegedEMT, ("hEMT %x hAllegedEMT %x\n", pHandle->hEMT, hAllegedEMT), VERR_NOT_OWNER);
1107 AssertReturn(pHandle->pVM == pVM, VERR_NOT_OWNER);
1108 AssertPtrReturn(pHandle->pvObj, VERR_INTERNAL_ERROR);
1109
1110 PGVM pGVM = pHandle->pGVM;
1111 AssertPtrReturn(pGVM, VERR_INTERNAL_ERROR);
1112 AssertReturn(pGVM->pVM == pVM, VERR_INTERNAL_ERROR);
1113 AssertReturn(pGVM->hEMT == hAllegedEMT, VERR_INTERNAL_ERROR);
1114
1115 *ppGVM = pGVM;
1116 *ppGVMM = pGVMM;
1117 return VINF_SUCCESS;
1118}
1119
1120
1121/**
1122 * Lookup a GVM structure by the shared VM structure
1123 * and ensuring that the caller is the EMT thread.
1124 *
1125 * @returns VBox status code.
1126 * @param pVM The shared VM structure (the ring-0 mapping).
1127 * @param ppGVM Where to store the GVM pointer.
1128 * @thread EMT
1129 */
1130GVMMR0DECL(int) GVMMR0ByVMAndEMT(PVM pVM, PGVM *ppGVM)
1131{
1132 AssertPtrReturn(ppGVM, VERR_INVALID_POINTER);
1133 PGVMM pGVMM;
1134 return gvmmR0ByVMAndEMT(pVM, ppGVM, &pGVMM);
1135}
1136
1137
1138/**
1139 * Lookup a VM by its global handle.
1140 *
1141 * @returns The VM handle on success, NULL on failure.
1142 * @param hGVM The global VM handle. Asserts on bad handle.
1143 */
1144GVMMR0DECL(PVM) GVMMR0GetVMByHandle(uint32_t hGVM)
1145{
1146 PGVM pGVM = GVMMR0ByHandle(hGVM);
1147 return pGVM ? pGVM->pVM : NULL;
1148}
1149
1150
1151/**
1152 * Looks up the VM belonging to the specified EMT thread.
1153 *
1154 * This is used by the assertion machinery in VMMR0.cpp to avoid causing
1155 * unnecessary kernel panics when the EMT thread hits an assertion. The
1156 * call may or not be an EMT thread.
1157 *
1158 * @returns The VM handle on success, NULL on failure.
1159 * @param hEMT The native thread handle of the EMT.
1160 * NIL_RTNATIVETHREAD means the current thread
1161 */
1162GVMMR0DECL(PVM) GVMMR0GetVMByEMT(RTNATIVETHREAD hEMT)
1163{
1164 /*
1165 * No Assertions here as we're usually called in a AssertMsgN or
1166 * RTAssert* context.
1167 */
1168 PGVMM pGVMM = g_pGVMM;
1169 if ( !VALID_PTR(pGVMM)
1170 || pGVMM->u32Magic != GVMM_MAGIC)
1171 return NULL;
1172
1173 if (hEMT == NIL_RTNATIVETHREAD)
1174 hEMT = RTThreadNativeSelf();
1175
1176 /*
1177 * Search the handles in a linear fashion as we don't dare take the lock (assert).
1178 */
1179 for (unsigned i = 1; i < RT_ELEMENTS(pGVMM->aHandles); i++)
1180 if ( pGVMM->aHandles[i].hEMT == hEMT
1181 && pGVMM->aHandles[i].iSelf == i
1182 && VALID_PTR(pGVMM->aHandles[i].pvObj)
1183 && VALID_PTR(pGVMM->aHandles[i].pVM))
1184 return pGVMM->aHandles[i].pVM;
1185
1186 return NULL;
1187}
1188
1189
1190/**
1191 * This is will wake up expired and soon-to-be expired VMs.
1192 *
1193 * @returns Number of VMs that has been woken up.
1194 * @param pGVMM Pointer to the GVMM instance data.
1195 * @param u64Now The current time.
1196 */
1197static unsigned gvmmR0SchedDoWakeUps(PGVMM pGVMM, uint64_t u64Now)
1198{
1199 /*
1200 * The first pass will wake up VMs which has actually expired
1201 * and look for VMs that should be woken up in the 2nd and 3rd passes.
1202 */
1203 unsigned cWoken = 0;
1204 unsigned cHalted = 0;
1205 unsigned cTodo2nd = 0;
1206 unsigned cTodo3rd = 0;
1207 for (unsigned i = pGVMM->iUsedHead, cGuard = 0;
1208 i != NIL_GVM_HANDLE && i < RT_ELEMENTS(pGVMM->aHandles);
1209 i = pGVMM->aHandles[i].iNext)
1210 {
1211 PGVM pCurGVM = pGVMM->aHandles[i].pGVM;
1212 if ( VALID_PTR(pCurGVM)
1213 && pCurGVM->u32Magic == GVM_MAGIC)
1214 {
1215 uint64_t u64 = pCurGVM->gvmm.s.u64HaltExpire;
1216 if (u64)
1217 {
1218 if (u64 <= u64Now)
1219 {
1220 if (ASMAtomicXchgU64(&pCurGVM->gvmm.s.u64HaltExpire, 0))
1221 {
1222 int rc = RTSemEventMultiSignal(pCurGVM->gvmm.s.HaltEventMulti);
1223 AssertRC(rc);
1224 cWoken++;
1225 }
1226 }
1227 else
1228 {
1229 cHalted++;
1230 if (u64 <= u64Now + pGVMM->nsEarlyWakeUp1)
1231 cTodo2nd++;
1232 else if (u64 <= u64Now + pGVMM->nsEarlyWakeUp2)
1233 cTodo3rd++;
1234 }
1235 }
1236 }
1237 AssertLogRelBreak(cGuard++ < RT_ELEMENTS(pGVMM->aHandles));
1238 }
1239
1240 if (cTodo2nd)
1241 {
1242 for (unsigned i = pGVMM->iUsedHead, cGuard = 0;
1243 i != NIL_GVM_HANDLE && i < RT_ELEMENTS(pGVMM->aHandles);
1244 i = pGVMM->aHandles[i].iNext)
1245 {
1246 PGVM pCurGVM = pGVMM->aHandles[i].pGVM;
1247 if ( VALID_PTR(pCurGVM)
1248 && pCurGVM->u32Magic == GVM_MAGIC
1249 && pCurGVM->gvmm.s.u64HaltExpire
1250 && pCurGVM->gvmm.s.u64HaltExpire <= u64Now + pGVMM->nsEarlyWakeUp1)
1251 {
1252 if (ASMAtomicXchgU64(&pCurGVM->gvmm.s.u64HaltExpire, 0))
1253 {
1254 int rc = RTSemEventMultiSignal(pCurGVM->gvmm.s.HaltEventMulti);
1255 AssertRC(rc);
1256 cWoken++;
1257 }
1258 }
1259 AssertLogRelBreak(cGuard++ < RT_ELEMENTS(pGVMM->aHandles));
1260 }
1261 }
1262
1263 if (cTodo3rd)
1264 {
1265 for (unsigned i = pGVMM->iUsedHead, cGuard = 0;
1266 i != NIL_GVM_HANDLE && i < RT_ELEMENTS(pGVMM->aHandles);
1267 i = pGVMM->aHandles[i].iNext)
1268 {
1269 PGVM pCurGVM = pGVMM->aHandles[i].pGVM;
1270 if ( VALID_PTR(pCurGVM)
1271 && pCurGVM->u32Magic == GVM_MAGIC
1272 && pCurGVM->gvmm.s.u64HaltExpire
1273 && pCurGVM->gvmm.s.u64HaltExpire <= u64Now + pGVMM->nsEarlyWakeUp2)
1274 {
1275 if (ASMAtomicXchgU64(&pCurGVM->gvmm.s.u64HaltExpire, 0))
1276 {
1277 int rc = RTSemEventMultiSignal(pCurGVM->gvmm.s.HaltEventMulti);
1278 AssertRC(rc);
1279 cWoken++;
1280 }
1281 }
1282 AssertLogRelBreak(cGuard++ < RT_ELEMENTS(pGVMM->aHandles));
1283 }
1284 }
1285
1286 return cWoken;
1287}
1288
1289
1290/**
1291 * Halt the EMT thread.
1292 *
1293 * @returns VINF_SUCCESS normal wakeup (timeout or kicked by other thread).
1294 * VERR_INTERRUPTED if a signal was scheduled for the thread.
1295 * @param pVM Pointer to the shared VM structure.
1296 * @param u64ExpireGipTime The time for the sleep to expire expressed as GIP time.
1297 * @thread EMT.
1298 */
1299GVMMR0DECL(int) GVMMR0SchedHalt(PVM pVM, uint64_t u64ExpireGipTime)
1300{
1301 LogFlow(("GVMMR0SchedHalt: pVM=%p\n", pVM));
1302
1303 /*
1304 * Validate the VM structure, state and handle.
1305 */
1306 PGVMM pGVMM;
1307 PGVM pGVM;
1308 int rc = gvmmR0ByVMAndEMT(pVM, &pGVM, &pGVMM);
1309 if (RT_FAILURE(rc))
1310 return rc;
1311 pGVM->gvmm.s.StatsSched.cHaltCalls++;
1312
1313 Assert(!pGVM->gvmm.s.u64HaltExpire);
1314
1315 /*
1316 * Take the UsedList semaphore, get the current time
1317 * and check if anyone needs waking up.
1318 * Interrupts must NOT be disabled at this point because we ask for GIP time!
1319 */
1320 rc = gvmmR0UsedLock(pGVMM);
1321 AssertRC(rc);
1322
1323 pGVM->gvmm.s.iCpuEmt = ASMGetApicId();
1324
1325 Assert(ASMGetFlags() & X86_EFL_IF);
1326 const uint64_t u64Now = RTTimeNanoTS(); /* (GIP time) */
1327 pGVM->gvmm.s.StatsSched.cHaltWakeUps += gvmmR0SchedDoWakeUps(pGVMM, u64Now);
1328
1329 /*
1330 * Go to sleep if we must...
1331 */
1332 if ( u64Now < u64ExpireGipTime
1333 && u64ExpireGipTime - u64Now > (pGVMM->cVMs > pGVMM->cVMsMeansCompany
1334 ? pGVMM->nsMinSleepCompany
1335 : pGVMM->nsMinSleepAlone))
1336 {
1337 pGVM->gvmm.s.StatsSched.cHaltBlocking++;
1338 ASMAtomicXchgU64(&pGVM->gvmm.s.u64HaltExpire, u64ExpireGipTime);
1339 gvmmR0UsedUnlock(pGVMM);
1340
1341 uint32_t cMillies = (u64ExpireGipTime - u64Now) / 1000000;
1342 rc = RTSemEventMultiWaitNoResume(pGVM->gvmm.s.HaltEventMulti, cMillies ? cMillies : 1);
1343 ASMAtomicXchgU64(&pGVM->gvmm.s.u64HaltExpire, 0);
1344 if (rc == VERR_TIMEOUT)
1345 {
1346 pGVM->gvmm.s.StatsSched.cHaltTimeouts++;
1347 rc = VINF_SUCCESS;
1348 }
1349 }
1350 else
1351 {
1352 pGVM->gvmm.s.StatsSched.cHaltNotBlocking++;
1353 gvmmR0UsedUnlock(pGVMM);
1354 }
1355
1356 /* Make sure false wake up calls (gvmmR0SchedDoWakeUps) cause us to spin. */
1357 RTSemEventMultiReset(pGVM->gvmm.s.HaltEventMulti);
1358
1359 return rc;
1360}
1361
1362
1363/**
1364 * Wakes up the halted EMT thread so it can service a pending request.
1365 *
1366 * @returns VINF_SUCCESS if not yielded.
1367 * VINF_GVM_NOT_BLOCKED if the EMT thread wasn't blocked.
1368 * @param pVM Pointer to the shared VM structure.
1369 * @thread Any but EMT.
1370 */
1371GVMMR0DECL(int) GVMMR0SchedWakeUp(PVM pVM)
1372{
1373 /*
1374 * Validate input and take the UsedLock.
1375 */
1376 PGVM pGVM;
1377 PGVMM pGVMM;
1378 int rc = gvmmR0ByVM(pVM, &pGVM, &pGVMM, true /* fTakeUsedLock */);
1379 if (RT_SUCCESS(rc))
1380 {
1381 pGVM->gvmm.s.StatsSched.cWakeUpCalls++;
1382
1383 /*
1384 * Signal the semaphore regardless of whether it's current blocked on it.
1385 *
1386 * The reason for this is that there is absolutely no way we can be 100%
1387 * certain that it isn't *about* go to go to sleep on it and just got
1388 * delayed a bit en route. So, we will always signal the semaphore when
1389 * the it is flagged as halted in the VMM.
1390 */
1391 if (pGVM->gvmm.s.u64HaltExpire)
1392 {
1393 rc = VINF_SUCCESS;
1394 ASMAtomicXchgU64(&pGVM->gvmm.s.u64HaltExpire, 0);
1395 }
1396 else
1397 {
1398 rc = VINF_GVM_NOT_BLOCKED;
1399 pGVM->gvmm.s.StatsSched.cWakeUpNotHalted++;
1400 }
1401
1402 int rc2 = RTSemEventMultiSignal(pGVM->gvmm.s.HaltEventMulti);
1403 AssertRC(rc2);
1404
1405 /*
1406 * While we're here, do a round of scheduling.
1407 */
1408 Assert(ASMGetFlags() & X86_EFL_IF);
1409 const uint64_t u64Now = RTTimeNanoTS(); /* (GIP time) */
1410 pGVM->gvmm.s.StatsSched.cWakeUpWakeUps += gvmmR0SchedDoWakeUps(pGVMM, u64Now);
1411
1412
1413 rc2 = gvmmR0UsedUnlock(pGVMM);
1414 AssertRC(rc2);
1415 }
1416
1417 LogFlow(("GVMMR0SchedWakeUp: returns %Rrc\n", rc));
1418 return rc;
1419}
1420
1421
1422/**
1423 * Poll the schedule to see if someone else should get a chance to run.
1424 *
1425 * This is a bit hackish and will not work too well if the machine is
1426 * under heavy load from non-VM processes.
1427 *
1428 * @returns VINF_SUCCESS if not yielded.
1429 * VINF_GVM_YIELDED if an attempt to switch to a different VM task was made.
1430 * @param pVM Pointer to the shared VM structure.
1431 * @param u64ExpireGipTime The time for the sleep to expire expressed as GIP time.
1432 * @param fYield Whether to yield or not.
1433 * This is for when we're spinning in the halt loop.
1434 * @thread EMT.
1435 */
1436GVMMR0DECL(int) GVMMR0SchedPoll(PVM pVM, bool fYield)
1437{
1438 /*
1439 * Validate input.
1440 */
1441 PGVM pGVM;
1442 PGVMM pGVMM;
1443 int rc = gvmmR0ByVMAndEMT(pVM, &pGVM, &pGVMM);
1444 if (RT_SUCCESS(rc))
1445 {
1446 rc = gvmmR0UsedLock(pGVMM);
1447 AssertRC(rc);
1448 pGVM->gvmm.s.StatsSched.cPollCalls++;
1449
1450 Assert(ASMGetFlags() & X86_EFL_IF);
1451 const uint64_t u64Now = RTTimeNanoTS(); /* (GIP time) */
1452
1453 if (!fYield)
1454 pGVM->gvmm.s.StatsSched.cPollWakeUps += gvmmR0SchedDoWakeUps(pGVMM, u64Now);
1455 else
1456 {
1457 /** @todo implement this... */
1458 rc = VERR_NOT_IMPLEMENTED;
1459 }
1460
1461 gvmmR0UsedUnlock(pGVMM);
1462 }
1463
1464 LogFlow(("GVMMR0SchedWakeUp: returns %Rrc\n", rc));
1465 return rc;
1466}
1467
1468
1469
1470/**
1471 * Retrieves the GVMM statistics visible to the caller.
1472 *
1473 * @returns VBox status code.
1474 *
1475 * @param pStats Where to put the statistics.
1476 * @param pSession The current session.
1477 * @param pVM The VM to obtain statistics for. Optional.
1478 */
1479GVMMR0DECL(int) GVMMR0QueryStatistics(PGVMMSTATS pStats, PSUPDRVSESSION pSession, PVM pVM)
1480{
1481 LogFlow(("GVMMR0QueryStatistics: pStats=%p pSession=%p pVM=%p\n", pStats, pSession, pVM));
1482
1483 /*
1484 * Validate input.
1485 */
1486 AssertPtrReturn(pSession, VERR_INVALID_POINTER);
1487 AssertPtrReturn(pStats, VERR_INVALID_POINTER);
1488 pStats->cVMs = 0; /* (crash before taking the sem...) */
1489
1490 /*
1491 * Take the lock and get the VM statistics.
1492 */
1493 PGVMM pGVMM;
1494 if (pVM)
1495 {
1496 PGVM pGVM;
1497 int rc = gvmmR0ByVM(pVM, &pGVM, &pGVMM, true /*fTakeUsedLock*/);
1498 if (RT_FAILURE(rc))
1499 return rc;
1500 pStats->SchedVM = pGVM->gvmm.s.StatsSched;
1501 }
1502 else
1503 {
1504 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
1505 memset(&pStats->SchedVM, 0, sizeof(pStats->SchedVM));
1506
1507 int rc = gvmmR0UsedLock(pGVMM);
1508 AssertRCReturn(rc, rc);
1509 }
1510
1511 /*
1512 * Enumerate the VMs and add the ones visibile to the statistics.
1513 */
1514 pStats->cVMs = 0;
1515 memset(&pStats->SchedSum, 0, sizeof(pStats->SchedSum));
1516
1517 for (unsigned i = pGVMM->iUsedHead;
1518 i != NIL_GVM_HANDLE && i < RT_ELEMENTS(pGVMM->aHandles);
1519 i = pGVMM->aHandles[i].iNext)
1520 {
1521 PGVM pGVM = pGVMM->aHandles[i].pGVM;
1522 void *pvObj = pGVMM->aHandles[i].pvObj;
1523 if ( VALID_PTR(pvObj)
1524 && VALID_PTR(pGVM)
1525 && pGVM->u32Magic == GVM_MAGIC
1526 && RT_SUCCESS(SUPR0ObjVerifyAccess(pvObj, pSession, NULL)))
1527 {
1528 pStats->cVMs++;
1529
1530 pStats->SchedSum.cHaltCalls += pGVM->gvmm.s.StatsSched.cHaltCalls;
1531 pStats->SchedSum.cHaltBlocking += pGVM->gvmm.s.StatsSched.cHaltBlocking;
1532 pStats->SchedSum.cHaltTimeouts += pGVM->gvmm.s.StatsSched.cHaltTimeouts;
1533 pStats->SchedSum.cHaltNotBlocking += pGVM->gvmm.s.StatsSched.cHaltNotBlocking;
1534 pStats->SchedSum.cHaltWakeUps += pGVM->gvmm.s.StatsSched.cHaltWakeUps;
1535
1536 pStats->SchedSum.cWakeUpCalls += pGVM->gvmm.s.StatsSched.cWakeUpCalls;
1537 pStats->SchedSum.cWakeUpNotHalted += pGVM->gvmm.s.StatsSched.cWakeUpNotHalted;
1538 pStats->SchedSum.cWakeUpWakeUps += pGVM->gvmm.s.StatsSched.cWakeUpWakeUps;
1539
1540 pStats->SchedSum.cPollCalls += pGVM->gvmm.s.StatsSched.cPollCalls;
1541 pStats->SchedSum.cPollHalts += pGVM->gvmm.s.StatsSched.cPollHalts;
1542 pStats->SchedSum.cPollWakeUps += pGVM->gvmm.s.StatsSched.cPollWakeUps;
1543 }
1544 }
1545
1546 gvmmR0UsedUnlock(pGVMM);
1547
1548 return VINF_SUCCESS;
1549}
1550
1551
1552/**
1553 * VMMR0 request wrapper for GVMMR0QueryStatistics.
1554 *
1555 * @returns see GVMMR0QueryStatistics.
1556 * @param pVM Pointer to the shared VM structure. Optional.
1557 * @param pReq The request packet.
1558 */
1559GVMMR0DECL(int) GVMMR0QueryStatisticsReq(PVM pVM, PGVMMQUERYSTATISTICSSREQ pReq)
1560{
1561 /*
1562 * Validate input and pass it on.
1563 */
1564 AssertPtrReturn(pReq, VERR_INVALID_POINTER);
1565 AssertMsgReturn(pReq->Hdr.cbReq == sizeof(*pReq), ("%#x != %#x\n", pReq->Hdr.cbReq, sizeof(*pReq)), VERR_INVALID_PARAMETER);
1566
1567 return GVMMR0QueryStatistics(&pReq->Stats, pReq->pSession, pVM);
1568}
1569
1570
1571/**
1572 * Resets the specified GVMM statistics.
1573 *
1574 * @returns VBox status code.
1575 *
1576 * @param pStats Which statistics to reset, that is, non-zero fields indicates which to reset.
1577 * @param pSession The current session.
1578 * @param pVM The VM to reset statistics for. Optional.
1579 */
1580GVMMR0DECL(int) GVMMR0ResetStatistics(PCGVMMSTATS pStats, PSUPDRVSESSION pSession, PVM pVM)
1581{
1582 LogFlow(("GVMMR0ResetStatistics: pStats=%p pSession=%p pVM=%p\n", pStats, pSession, pVM));
1583
1584 /*
1585 * Validate input.
1586 */
1587 AssertPtrReturn(pSession, VERR_INVALID_POINTER);
1588 AssertPtrReturn(pStats, VERR_INVALID_POINTER);
1589
1590 /*
1591 * Take the lock and get the VM statistics.
1592 */
1593 PGVMM pGVMM;
1594 if (pVM)
1595 {
1596 PGVM pGVM;
1597 int rc = gvmmR0ByVM(pVM, &pGVM, &pGVMM, true /*fTakeUsedLock*/);
1598 if (RT_FAILURE(rc))
1599 return rc;
1600# define MAYBE_RESET_FIELD(field) \
1601 do { if (pStats->SchedVM. field ) { pGVM->gvmm.s.StatsSched. field = 0; } } while (0)
1602 MAYBE_RESET_FIELD(cHaltCalls);
1603 MAYBE_RESET_FIELD(cHaltBlocking);
1604 MAYBE_RESET_FIELD(cHaltTimeouts);
1605 MAYBE_RESET_FIELD(cHaltNotBlocking);
1606 MAYBE_RESET_FIELD(cHaltWakeUps);
1607 MAYBE_RESET_FIELD(cWakeUpCalls);
1608 MAYBE_RESET_FIELD(cWakeUpNotHalted);
1609 MAYBE_RESET_FIELD(cWakeUpWakeUps);
1610 MAYBE_RESET_FIELD(cPollCalls);
1611 MAYBE_RESET_FIELD(cPollHalts);
1612 MAYBE_RESET_FIELD(cPollWakeUps);
1613# undef MAYBE_RESET_FIELD
1614 }
1615 else
1616 {
1617 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
1618
1619 int rc = gvmmR0UsedLock(pGVMM);
1620 AssertRCReturn(rc, rc);
1621 }
1622
1623 /*
1624 * Enumerate the VMs and add the ones visibile to the statistics.
1625 */
1626 if (ASMMemIsAll8(&pStats->SchedSum, sizeof(pStats->SchedSum), 0))
1627 {
1628 for (unsigned i = pGVMM->iUsedHead;
1629 i != NIL_GVM_HANDLE && i < RT_ELEMENTS(pGVMM->aHandles);
1630 i = pGVMM->aHandles[i].iNext)
1631 {
1632 PGVM pGVM = pGVMM->aHandles[i].pGVM;
1633 void *pvObj = pGVMM->aHandles[i].pvObj;
1634 if ( VALID_PTR(pvObj)
1635 && VALID_PTR(pGVM)
1636 && pGVM->u32Magic == GVM_MAGIC
1637 && RT_SUCCESS(SUPR0ObjVerifyAccess(pvObj, pSession, NULL)))
1638 {
1639# define MAYBE_RESET_FIELD(field) \
1640 do { if (pStats->SchedSum. field ) { pGVM->gvmm.s.StatsSched. field = 0; } } while (0)
1641 MAYBE_RESET_FIELD(cHaltCalls);
1642 MAYBE_RESET_FIELD(cHaltBlocking);
1643 MAYBE_RESET_FIELD(cHaltTimeouts);
1644 MAYBE_RESET_FIELD(cHaltNotBlocking);
1645 MAYBE_RESET_FIELD(cHaltWakeUps);
1646 MAYBE_RESET_FIELD(cWakeUpCalls);
1647 MAYBE_RESET_FIELD(cWakeUpNotHalted);
1648 MAYBE_RESET_FIELD(cWakeUpWakeUps);
1649 MAYBE_RESET_FIELD(cPollCalls);
1650 MAYBE_RESET_FIELD(cPollHalts);
1651 MAYBE_RESET_FIELD(cPollWakeUps);
1652# undef MAYBE_RESET_FIELD
1653 }
1654 }
1655 }
1656
1657 gvmmR0UsedUnlock(pGVMM);
1658
1659 return VINF_SUCCESS;
1660}
1661
1662
1663/**
1664 * VMMR0 request wrapper for GVMMR0ResetStatistics.
1665 *
1666 * @returns see GVMMR0ResetStatistics.
1667 * @param pVM Pointer to the shared VM structure. Optional.
1668 * @param pReq The request packet.
1669 */
1670GVMMR0DECL(int) GVMMR0ResetStatisticsReq(PVM pVM, PGVMMRESETSTATISTICSSREQ pReq)
1671{
1672 /*
1673 * Validate input and pass it on.
1674 */
1675 AssertPtrReturn(pReq, VERR_INVALID_POINTER);
1676 AssertMsgReturn(pReq->Hdr.cbReq == sizeof(*pReq), ("%#x != %#x\n", pReq->Hdr.cbReq, sizeof(*pReq)), VERR_INVALID_PARAMETER);
1677
1678 return GVMMR0ResetStatistics(&pReq->Stats, pReq->pSession, pVM);
1679}
1680
Note: See TracBrowser for help on using the repository browser.

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