VirtualBox

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

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

UVM updates
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 54.8 KB
Line 
1/* $Id: GVMMR0.cpp 13751 2008-11-03 14:53:11Z 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 if ( pReq->cCPUs == 0
473 || pReq->cCPUs > VMCPU_MAX_CPU_COUNT)
474 return VERR_INVALID_PARAMETER;
475
476 /*
477 * Execute it.
478 */
479 PVM pVM;
480 pReq->pVMR0 = NULL;
481 pReq->pVMR3 = NIL_RTR3PTR;
482 int rc = GVMMR0CreateVM(pReq->pSession, pReq->cCPUs, &pVM);
483 if (RT_SUCCESS(rc))
484 {
485 pReq->pVMR0 = pVM;
486 pReq->pVMR3 = pVM->pVMR3;
487 }
488 return rc;
489}
490
491
492/**
493 * Allocates the VM structure and registers it with GVM.
494 *
495 * The caller will become the VM owner and there by the EMT.
496 *
497 * @returns VBox status code.
498 * @param pSession The support driver session.
499 * @param cCPUs Number of virtual CPUs for the new VM.
500 * @param ppVM Where to store the pointer to the VM structure.
501 *
502 * @thread EMT.
503 */
504GVMMR0DECL(int) GVMMR0CreateVM(PSUPDRVSESSION pSession, uint32_t cCPUs, PVM *ppVM)
505{
506 LogFlow(("GVMMR0CreateVM: pSession=%p\n", pSession));
507 PGVMM pGVMM;
508 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
509
510 AssertPtrReturn(ppVM, VERR_INVALID_POINTER);
511 *ppVM = NULL;
512
513 RTNATIVETHREAD hEMT = RTThreadNativeSelf();
514 AssertReturn(hEMT != NIL_RTNATIVETHREAD, VERR_INTERNAL_ERROR);
515
516 /*
517 * The whole allocation process is protected by the lock.
518 */
519 int rc = gvmmR0CreateDestroyLock(pGVMM);
520 AssertRCReturn(rc, rc);
521
522 /*
523 * Allocate a handle first so we don't waste resources unnecessarily.
524 */
525 uint16_t iHandle = pGVMM->iFreeHead;
526 if (iHandle)
527 {
528 PGVMHANDLE pHandle = &pGVMM->aHandles[iHandle];
529
530 /* consistency checks, a bit paranoid as always. */
531 if ( !pHandle->pVM
532 && !pHandle->pGVM
533 && !pHandle->pvObj
534 && pHandle->iSelf == iHandle)
535 {
536 pHandle->pvObj = SUPR0ObjRegister(pSession, SUPDRVOBJTYPE_VM, gvmmR0HandleObjDestructor, pGVMM, pHandle);
537 if (pHandle->pvObj)
538 {
539 /*
540 * Move the handle from the free to used list and perform permission checks.
541 */
542 rc = gvmmR0UsedLock(pGVMM);
543 AssertRC(rc);
544
545 pGVMM->iFreeHead = pHandle->iNext;
546 pHandle->iNext = pGVMM->iUsedHead;
547 pGVMM->iUsedHead = iHandle;
548 pGVMM->cVMs++;
549
550 pHandle->pVM = NULL;
551 pHandle->pGVM = NULL;
552 pHandle->pSession = pSession;
553 pHandle->hEMT = NIL_RTNATIVETHREAD;
554
555 gvmmR0UsedUnlock(pGVMM);
556
557 rc = SUPR0ObjVerifyAccess(pHandle->pvObj, pSession, NULL);
558 if (RT_SUCCESS(rc))
559 {
560 /*
561 * Allocate the global VM structure (GVM) and initialize it.
562 */
563 PGVM pGVM = (PGVM)RTMemAllocZ(sizeof(*pGVM));
564 if (pGVM)
565 {
566 pGVM->u32Magic = GVM_MAGIC;
567 pGVM->hSelf = iHandle;
568 pGVM->hEMT = NIL_RTNATIVETHREAD;
569 pGVM->pVM = NULL;
570
571 gvmmR0InitPerVMData(pGVM);
572 /* GMMR0InitPerVMData(pGVM); - later */
573
574 /*
575 * Allocate the shared VM structure and associated page array.
576 */
577 const size_t cbVM = RT_OFFSETOF(VM, aCpu[cCPUs]);
578 const size_t cPages = RT_ALIGN(cbVM, PAGE_SIZE) >> PAGE_SHIFT;
579 rc = RTR0MemObjAllocLow(&pGVM->gvmm.s.VMMemObj, cPages << PAGE_SHIFT, false /* fExecutable */);
580 if (RT_SUCCESS(rc))
581 {
582 PVM pVM = (PVM)RTR0MemObjAddress(pGVM->gvmm.s.VMMemObj); AssertPtr(pVM);
583 memset(pVM, 0, cPages << PAGE_SHIFT);
584 pVM->enmVMState = VMSTATE_CREATING;
585 pVM->pVMR0 = pVM;
586 pVM->pSession = pSession;
587 pVM->hSelf = iHandle;
588 pVM->cbSelf = cbVM;
589
590 rc = RTR0MemObjAllocPage(&pGVM->gvmm.s.VMPagesMemObj, cPages * sizeof(SUPPAGE), false /* fExecutable */);
591 if (RT_SUCCESS(rc))
592 {
593 PSUPPAGE paPages = (PSUPPAGE)RTR0MemObjAddress(pGVM->gvmm.s.VMPagesMemObj); AssertPtr(paPages);
594 for (size_t iPage = 0; iPage < cPages; iPage++)
595 {
596 paPages[iPage].uReserved = 0;
597 paPages[iPage].Phys = RTR0MemObjGetPagePhysAddr(pGVM->gvmm.s.VMMemObj, iPage);
598 Assert(paPages[iPage].Phys != NIL_RTHCPHYS);
599 }
600
601 /*
602 * Map them into ring-3.
603 */
604 rc = RTR0MemObjMapUser(&pGVM->gvmm.s.VMMapObj, pGVM->gvmm.s.VMMemObj, (RTR3PTR)-1, 0,
605 RTMEM_PROT_READ | RTMEM_PROT_WRITE, NIL_RTR0PROCESS);
606 if (RT_SUCCESS(rc))
607 {
608 pVM->pVMR3 = RTR0MemObjAddressR3(pGVM->gvmm.s.VMMapObj);
609 AssertPtr((void *)pVM->pVMR3);
610
611 /** Initialize all the VM pointers. */
612 for (unsigned i=0;i<cCPUs;i++)
613 {
614 pVM->aCpu[i].pVMR0 = pVM;
615 pVM->aCpu[i].pVMR3 = pVM->pVMR3;
616 }
617
618 rc = RTR0MemObjMapUser(&pGVM->gvmm.s.VMPagesMapObj, pGVM->gvmm.s.VMPagesMemObj, (RTR3PTR)-1, 0,
619 RTMEM_PROT_READ | RTMEM_PROT_WRITE, NIL_RTR0PROCESS);
620 if (RT_SUCCESS(rc))
621 {
622 pVM->paVMPagesR3 = RTR0MemObjAddressR3(pGVM->gvmm.s.VMPagesMapObj);
623 AssertPtr((void *)pVM->paVMPagesR3);
624
625 /* complete the handle - take the UsedLock sem just to be careful. */
626 rc = gvmmR0UsedLock(pGVMM);
627 AssertRC(rc);
628
629 pHandle->pVM = pVM;
630 pHandle->pGVM = pGVM;
631 pHandle->hEMT = hEMT;
632 pGVM->pVM = pVM;
633 pGVM->hEMT = hEMT;
634
635 gvmmR0UsedUnlock(pGVMM);
636 gvmmR0CreateDestroyUnlock(pGVMM);
637
638 *ppVM = pVM;
639 Log(("GVMMR0CreateVM: pVM=%p pVMR3=%p pGVM=%p hGVM=%d\n", pVM, pVM->pVMR3, pGVM, iHandle));
640 return VINF_SUCCESS;
641 }
642
643 RTR0MemObjFree(pGVM->gvmm.s.VMMapObj, false /* fFreeMappings */);
644 pGVM->gvmm.s.VMMapObj = NIL_RTR0MEMOBJ;
645 }
646 RTR0MemObjFree(pGVM->gvmm.s.VMPagesMemObj, false /* fFreeMappings */);
647 pGVM->gvmm.s.VMPagesMemObj = NIL_RTR0MEMOBJ;
648 }
649 RTR0MemObjFree(pGVM->gvmm.s.VMMemObj, false /* fFreeMappings */);
650 pGVM->gvmm.s.VMMemObj = NIL_RTR0MEMOBJ;
651 }
652 }
653 }
654 /* else: The user wasn't permitted to create this VM. */
655
656 /*
657 * The handle will be freed by gvmmR0HandleObjDestructor as we release the
658 * object reference here. A little extra mess because of non-recursive lock.
659 */
660 void *pvObj = pHandle->pvObj;
661 pHandle->pvObj = NULL;
662 gvmmR0CreateDestroyUnlock(pGVMM);
663
664 SUPR0ObjRelease(pvObj, pSession);
665
666 SUPR0Printf("GVMMR0CreateVM: failed, rc=%d\n", rc);
667 return rc;
668 }
669
670 rc = VERR_NO_MEMORY;
671 }
672 else
673 rc = VERR_INTERNAL_ERROR;
674 }
675 else
676 rc = VERR_GVM_TOO_MANY_VMS;
677
678 gvmmR0CreateDestroyUnlock(pGVMM);
679 return rc;
680}
681
682
683/**
684 * Initializes the per VM data belonging to GVMM.
685 *
686 * @param pGVM Pointer to the global VM structure.
687 */
688static void gvmmR0InitPerVMData(PGVM pGVM)
689{
690 AssertCompile(RT_SIZEOFMEMB(GVM,gvmm.s) <= RT_SIZEOFMEMB(GVM,gvmm.padding));
691 Assert(RT_SIZEOFMEMB(GVM,gvmm.s) <= RT_SIZEOFMEMB(GVM,gvmm.padding));
692 pGVM->gvmm.s.VMMemObj = NIL_RTR0MEMOBJ;
693 pGVM->gvmm.s.VMMapObj = NIL_RTR0MEMOBJ;
694 pGVM->gvmm.s.VMPagesMemObj = NIL_RTR0MEMOBJ;
695 pGVM->gvmm.s.VMPagesMapObj = NIL_RTR0MEMOBJ;
696 pGVM->gvmm.s.HaltEventMulti = NIL_RTSEMEVENTMULTI;
697}
698
699
700/**
701 * Does the VM initialization.
702 *
703 * @returns VBox status code.
704 * @param pVM Pointer to the shared VM structure.
705 */
706GVMMR0DECL(int) GVMMR0InitVM(PVM pVM)
707{
708 LogFlow(("GVMMR0InitVM: pVM=%p\n", pVM));
709
710 /*
711 * Validate the VM structure, state and handle.
712 */
713 PGVM pGVM;
714 PGVMM pGVMM;
715 int rc = gvmmR0ByVMAndEMT(pVM, &pGVM, &pGVMM);
716 if (RT_SUCCESS(rc))
717 {
718 if (pGVM->gvmm.s.HaltEventMulti == NIL_RTSEMEVENTMULTI)
719 {
720 rc = RTSemEventMultiCreate(&pGVM->gvmm.s.HaltEventMulti);
721 if (RT_FAILURE(rc))
722 pGVM->gvmm.s.HaltEventMulti = NIL_RTSEMEVENTMULTI;
723 }
724 else
725 rc = VERR_WRONG_ORDER;
726 }
727
728 LogFlow(("GVMMR0InitVM: returns %Rrc\n", rc));
729 return rc;
730}
731
732
733/**
734 * Destroys the VM, freeing all associated resources (the ring-0 ones anyway).
735 *
736 * This is call from the vmR3DestroyFinalBit and from a error path in VMR3Create,
737 * and the caller is not the EMT thread, unfortunately. For security reasons, it
738 * would've been nice if the caller was actually the EMT thread or that we somehow
739 * could've associated the calling thread with the VM up front.
740 *
741 * @returns VBox status code.
742 * @param pVM Where to store the pointer to the VM structure.
743 *
744 * @thread EMT if it's associated with the VM, otherwise any thread.
745 */
746GVMMR0DECL(int) GVMMR0DestroyVM(PVM pVM)
747{
748 LogFlow(("GVMMR0DestroyVM: pVM=%p\n", pVM));
749 PGVMM pGVMM;
750 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
751
752
753 /*
754 * Validate the VM structure, state and caller.
755 */
756 AssertPtrReturn(pVM, VERR_INVALID_POINTER);
757 AssertReturn(!((uintptr_t)pVM & PAGE_OFFSET_MASK), VERR_INVALID_POINTER);
758 AssertMsgReturn(pVM->enmVMState >= VMSTATE_CREATING && pVM->enmVMState <= VMSTATE_TERMINATED, ("%d\n", pVM->enmVMState), VERR_WRONG_ORDER);
759
760 uint32_t hGVM = pVM->hSelf;
761 AssertReturn(hGVM != NIL_GVM_HANDLE, VERR_INVALID_HANDLE);
762 AssertReturn(hGVM < RT_ELEMENTS(pGVMM->aHandles), VERR_INVALID_HANDLE);
763
764 PGVMHANDLE pHandle = &pGVMM->aHandles[hGVM];
765 AssertReturn(pHandle->pVM == pVM, VERR_NOT_OWNER);
766
767 RTNATIVETHREAD hSelf = RTThreadNativeSelf();
768 AssertReturn(pHandle->hEMT == hSelf || pHandle->hEMT == NIL_RTNATIVETHREAD, VERR_NOT_OWNER);
769
770 /*
771 * Lookup the handle and destroy the object.
772 * Since the lock isn't recursive and we'll have to leave it before dereferencing the
773 * object, we take some precautions against racing callers just in case...
774 */
775 int rc = gvmmR0CreateDestroyLock(pGVMM);
776 AssertRC(rc);
777
778 /* be careful here because we might theoretically be racing someone else cleaning up. */
779 if ( pHandle->pVM == pVM
780 && ( pHandle->hEMT == hSelf
781 || pHandle->hEMT == NIL_RTNATIVETHREAD)
782 && VALID_PTR(pHandle->pvObj)
783 && VALID_PTR(pHandle->pSession)
784 && VALID_PTR(pHandle->pGVM)
785 && pHandle->pGVM->u32Magic == GVM_MAGIC)
786 {
787 void *pvObj = pHandle->pvObj;
788 pHandle->pvObj = NULL;
789 gvmmR0CreateDestroyUnlock(pGVMM);
790
791 SUPR0ObjRelease(pvObj, pHandle->pSession);
792 }
793 else
794 {
795 SUPR0Printf("GVMMR0DestroyVM: pHandle=%p:{.pVM=%p, hEMT=%p, .pvObj=%p} pVM=%p hSelf=%p\n",
796 pHandle, pHandle->pVM, pHandle->hEMT, pHandle->pvObj, pVM, hSelf);
797 gvmmR0CreateDestroyUnlock(pGVMM);
798 rc = VERR_INTERNAL_ERROR;
799 }
800
801 return rc;
802}
803
804
805/**
806 * Handle destructor.
807 *
808 * @param pvGVMM The GVM instance pointer.
809 * @param pvHandle The handle pointer.
810 */
811static DECLCALLBACK(void) gvmmR0HandleObjDestructor(void *pvObj, void *pvGVMM, void *pvHandle)
812{
813 LogFlow(("gvmmR0HandleObjDestructor: %p %p %p\n", pvObj, pvGVMM, pvHandle));
814
815 /*
816 * Some quick, paranoid, input validation.
817 */
818 PGVMHANDLE pHandle = (PGVMHANDLE)pvHandle;
819 AssertPtr(pHandle);
820 PGVMM pGVMM = (PGVMM)pvGVMM;
821 Assert(pGVMM == g_pGVMM);
822 const uint16_t iHandle = pHandle - &pGVMM->aHandles[0];
823 if ( !iHandle
824 || iHandle >= RT_ELEMENTS(pGVMM->aHandles)
825 || iHandle != pHandle->iSelf)
826 {
827 SUPR0Printf("GVM: handle %d is out of range or corrupt (iSelf=%d)!\n", iHandle, pHandle->iSelf);
828 return;
829 }
830
831 int rc = gvmmR0CreateDestroyLock(pGVMM);
832 AssertRC(rc);
833 rc = gvmmR0UsedLock(pGVMM);
834 AssertRC(rc);
835
836 /*
837 * This is a tad slow but a doubly linked list is too much hazzle.
838 */
839 if (RT_UNLIKELY(pHandle->iNext >= RT_ELEMENTS(pGVMM->aHandles)))
840 {
841 SUPR0Printf("GVM: used list index %d is out of range!\n", pHandle->iNext);
842 gvmmR0UsedUnlock(pGVMM);
843 gvmmR0CreateDestroyUnlock(pGVMM);
844 return;
845 }
846
847 if (pGVMM->iUsedHead == iHandle)
848 pGVMM->iUsedHead = pHandle->iNext;
849 else
850 {
851 uint16_t iPrev = pGVMM->iUsedHead;
852 int c = RT_ELEMENTS(pGVMM->aHandles) + 2;
853 while (iPrev)
854 {
855 if (RT_UNLIKELY(iPrev >= RT_ELEMENTS(pGVMM->aHandles)))
856 {
857 SUPR0Printf("GVM: used list index %d is out of range!\n");
858 gvmmR0UsedUnlock(pGVMM);
859 gvmmR0CreateDestroyUnlock(pGVMM);
860 return;
861 }
862 if (RT_UNLIKELY(c-- <= 0))
863 {
864 iPrev = 0;
865 break;
866 }
867
868 if (pGVMM->aHandles[iPrev].iNext == iHandle)
869 break;
870 iPrev = pGVMM->aHandles[iPrev].iNext;
871 }
872 if (!iPrev)
873 {
874 SUPR0Printf("GVM: can't find the handle previous previous of %d!\n", pHandle->iSelf);
875 gvmmR0UsedUnlock(pGVMM);
876 gvmmR0CreateDestroyUnlock(pGVMM);
877 return;
878 }
879
880 Assert(pGVMM->aHandles[iPrev].iNext == iHandle);
881 pGVMM->aHandles[iPrev].iNext = pHandle->iNext;
882 }
883 pHandle->iNext = 0;
884 pGVMM->cVMs--;
885
886 gvmmR0UsedUnlock(pGVMM);
887
888 /*
889 * Do the global cleanup round.
890 */
891 PGVM pGVM = pHandle->pGVM;
892 if ( VALID_PTR(pGVM)
893 && pGVM->u32Magic == GVM_MAGIC)
894 {
895 /// @todo GMMR0CleanupVM(pGVM);
896
897 /*
898 * Do the GVMM cleanup - must be done last.
899 */
900 /* The VM and VM pages mappings/allocations. */
901 if (pGVM->gvmm.s.VMPagesMapObj != NIL_RTR0MEMOBJ)
902 {
903 rc = RTR0MemObjFree(pGVM->gvmm.s.VMPagesMapObj, false /* fFreeMappings */); AssertRC(rc);
904 pGVM->gvmm.s.VMPagesMapObj = NIL_RTR0MEMOBJ;
905 }
906
907 if (pGVM->gvmm.s.VMMapObj != NIL_RTR0MEMOBJ)
908 {
909 rc = RTR0MemObjFree(pGVM->gvmm.s.VMMapObj, false /* fFreeMappings */); AssertRC(rc);
910 pGVM->gvmm.s.VMMapObj = NIL_RTR0MEMOBJ;
911 }
912
913 if (pGVM->gvmm.s.VMPagesMemObj != NIL_RTR0MEMOBJ)
914 {
915 rc = RTR0MemObjFree(pGVM->gvmm.s.VMPagesMemObj, false /* fFreeMappings */); AssertRC(rc);
916 pGVM->gvmm.s.VMPagesMemObj = NIL_RTR0MEMOBJ;
917 }
918
919 if (pGVM->gvmm.s.VMMemObj != NIL_RTR0MEMOBJ)
920 {
921 rc = RTR0MemObjFree(pGVM->gvmm.s.VMMemObj, false /* fFreeMappings */); AssertRC(rc);
922 pGVM->gvmm.s.VMMemObj = NIL_RTR0MEMOBJ;
923 }
924
925 if (pGVM->gvmm.s.HaltEventMulti != NIL_RTSEMEVENTMULTI)
926 {
927 rc = RTSemEventMultiDestroy(pGVM->gvmm.s.HaltEventMulti); AssertRC(rc);
928 pGVM->gvmm.s.HaltEventMulti = NIL_RTSEMEVENTMULTI;
929 }
930
931 /* the GVM structure itself. */
932 pGVM->u32Magic++;
933 RTMemFree(pGVM);
934 }
935 /* else: GVMMR0CreateVM cleanup. */
936
937 /*
938 * Free the handle.
939 * Reacquire the UsedLock here to since we're updating handle fields.
940 */
941 rc = gvmmR0UsedLock(pGVMM);
942 AssertRC(rc);
943
944 pHandle->iNext = pGVMM->iFreeHead;
945 pGVMM->iFreeHead = iHandle;
946 ASMAtomicXchgPtr((void * volatile *)&pHandle->pGVM, NULL);
947 ASMAtomicXchgPtr((void * volatile *)&pHandle->pVM, NULL);
948 ASMAtomicXchgPtr((void * volatile *)&pHandle->pvObj, NULL);
949 ASMAtomicXchgPtr((void * volatile *)&pHandle->pSession, NULL);
950 ASMAtomicXchgSize(&pHandle->hEMT, NIL_RTNATIVETHREAD);
951
952 gvmmR0UsedUnlock(pGVMM);
953 gvmmR0CreateDestroyUnlock(pGVMM);
954 LogFlow(("gvmmR0HandleObjDestructor: returns\n"));
955}
956
957
958/**
959 * Lookup a GVM structure by its handle.
960 *
961 * @returns The GVM pointer on success, NULL on failure.
962 * @param hGVM The global VM handle. Asserts on bad handle.
963 */
964GVMMR0DECL(PGVM) GVMMR0ByHandle(uint32_t hGVM)
965{
966 PGVMM pGVMM;
967 GVMM_GET_VALID_INSTANCE(pGVMM, NULL);
968
969 /*
970 * Validate.
971 */
972 AssertReturn(hGVM != NIL_GVM_HANDLE, NULL);
973 AssertReturn(hGVM < RT_ELEMENTS(pGVMM->aHandles), NULL);
974
975 /*
976 * Look it up.
977 */
978 PGVMHANDLE pHandle = &pGVMM->aHandles[hGVM];
979 AssertPtrReturn(pHandle->pVM, NULL);
980 AssertPtrReturn(pHandle->pvObj, NULL);
981 PGVM pGVM = pHandle->pGVM;
982 AssertPtrReturn(pGVM, NULL);
983 AssertReturn(pGVM->pVM == pHandle->pVM, NULL);
984
985 return pHandle->pGVM;
986}
987
988
989/**
990 * Lookup a GVM structure by the shared VM structure.
991 *
992 * @returns VBox status code.
993 * @param pVM The shared VM structure (the ring-0 mapping).
994 * @param ppGVM Where to store the GVM pointer.
995 * @param ppGVMM Where to store the pointer to the GVMM instance data.
996 * @param fTakeUsedLock Whether to take the used lock or not.
997 * Be very careful if not taking the lock as it's possible that
998 * the VM will disappear then.
999 *
1000 * @remark This will not assert on an invalid pVM but try return sliently.
1001 */
1002static int gvmmR0ByVM(PVM pVM, PGVM *ppGVM, PGVMM *ppGVMM, bool fTakeUsedLock)
1003{
1004 PGVMM pGVMM;
1005 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
1006
1007 /*
1008 * Validate.
1009 */
1010 if (RT_UNLIKELY( !VALID_PTR(pVM)
1011 || ((uintptr_t)pVM & PAGE_OFFSET_MASK)))
1012 return VERR_INVALID_POINTER;
1013 if (RT_UNLIKELY( pVM->enmVMState < VMSTATE_CREATING
1014 || pVM->enmVMState >= VMSTATE_TERMINATED))
1015 return VERR_INVALID_POINTER;
1016
1017 uint16_t hGVM = pVM->hSelf;
1018 if (RT_UNLIKELY( hGVM == NIL_GVM_HANDLE
1019 || hGVM >= RT_ELEMENTS(pGVMM->aHandles)))
1020 return VERR_INVALID_HANDLE;
1021
1022 /*
1023 * Look it up.
1024 */
1025 PGVMHANDLE pHandle = &pGVMM->aHandles[hGVM];
1026 PGVM pGVM;
1027 if (fTakeUsedLock)
1028 {
1029 int rc = gvmmR0UsedLock(pGVMM);
1030 AssertRCReturn(rc, rc);
1031
1032 pGVM = pHandle->pGVM;
1033 if (RT_UNLIKELY( pHandle->pVM != pVM
1034 || !VALID_PTR(pHandle->pvObj)
1035 || !VALID_PTR(pGVM)
1036 || pGVM->pVM != pVM))
1037 {
1038 gvmmR0UsedUnlock(pGVMM);
1039 return VERR_INVALID_HANDLE;
1040 }
1041 }
1042 else
1043 {
1044 if (RT_UNLIKELY(pHandle->pVM != pVM))
1045 return VERR_INVALID_HANDLE;
1046 if (RT_UNLIKELY(!VALID_PTR(pHandle->pvObj)))
1047 return VERR_INVALID_HANDLE;
1048
1049 pGVM = pHandle->pGVM;
1050 if (RT_UNLIKELY(!VALID_PTR(pGVM)))
1051 return VERR_INVALID_HANDLE;
1052 if (RT_UNLIKELY(pGVM->pVM != pVM))
1053 return VERR_INVALID_HANDLE;
1054 }
1055
1056 *ppGVM = pGVM;
1057 *ppGVMM = pGVMM;
1058 return VINF_SUCCESS;
1059}
1060
1061
1062/**
1063 * Lookup a GVM structure by the shared VM structure.
1064 *
1065 * @returns The GVM pointer on success, NULL on failure.
1066 * @param pVM The shared VM structure (the ring-0 mapping).
1067 *
1068 * @remark This will not take the 'used'-lock because it doesn't do
1069 * nesting and this function will be used from under the lock.
1070 */
1071GVMMR0DECL(PGVM) GVMMR0ByVM(PVM pVM)
1072{
1073 PGVMM pGVMM;
1074 PGVM pGVM;
1075 int rc = gvmmR0ByVM(pVM, &pGVM, &pGVMM, false /* fTakeUsedLock */);
1076 if (RT_SUCCESS(rc))
1077 return pGVM;
1078 AssertRC(rc);
1079 return NULL;
1080}
1081
1082
1083/**
1084 * Lookup a GVM structure by the shared VM structure
1085 * and ensuring that the caller is the EMT thread.
1086 *
1087 * @returns VBox status code.
1088 * @param pVM The shared VM structure (the ring-0 mapping).
1089 * @param ppGVM Where to store the GVM pointer.
1090 * @param ppGVMM Where to store the pointer to the GVMM instance data.
1091 * @thread EMT
1092 *
1093 * @remark This will assert in failure paths.
1094 */
1095static int gvmmR0ByVMAndEMT(PVM pVM, PGVM *ppGVM, PGVMM *ppGVMM)
1096{
1097 PGVMM pGVMM;
1098 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
1099
1100 /*
1101 * Validate.
1102 */
1103 AssertPtrReturn(pVM, VERR_INVALID_POINTER);
1104 AssertReturn(!((uintptr_t)pVM & PAGE_OFFSET_MASK), VERR_INVALID_POINTER);
1105
1106 uint16_t hGVM = pVM->hSelf;
1107 AssertReturn(hGVM != NIL_GVM_HANDLE, VERR_INVALID_HANDLE);
1108 AssertReturn(hGVM < RT_ELEMENTS(pGVMM->aHandles), VERR_INVALID_HANDLE);
1109
1110 /*
1111 * Look it up.
1112 */
1113 PGVMHANDLE pHandle = &pGVMM->aHandles[hGVM];
1114 RTNATIVETHREAD hAllegedEMT = RTThreadNativeSelf();
1115 AssertMsgReturn(pHandle->hEMT == hAllegedEMT, ("hEMT %x hAllegedEMT %x\n", pHandle->hEMT, hAllegedEMT), VERR_NOT_OWNER);
1116 AssertReturn(pHandle->pVM == pVM, VERR_NOT_OWNER);
1117 AssertPtrReturn(pHandle->pvObj, VERR_INTERNAL_ERROR);
1118
1119 PGVM pGVM = pHandle->pGVM;
1120 AssertPtrReturn(pGVM, VERR_INTERNAL_ERROR);
1121 AssertReturn(pGVM->pVM == pVM, VERR_INTERNAL_ERROR);
1122 AssertReturn(pGVM->hEMT == hAllegedEMT, VERR_INTERNAL_ERROR);
1123
1124 *ppGVM = pGVM;
1125 *ppGVMM = pGVMM;
1126 return VINF_SUCCESS;
1127}
1128
1129
1130/**
1131 * Lookup a GVM structure by the shared VM structure
1132 * and ensuring that the caller is the EMT thread.
1133 *
1134 * @returns VBox status code.
1135 * @param pVM The shared VM structure (the ring-0 mapping).
1136 * @param ppGVM Where to store the GVM pointer.
1137 * @thread EMT
1138 */
1139GVMMR0DECL(int) GVMMR0ByVMAndEMT(PVM pVM, PGVM *ppGVM)
1140{
1141 AssertPtrReturn(ppGVM, VERR_INVALID_POINTER);
1142 PGVMM pGVMM;
1143 return gvmmR0ByVMAndEMT(pVM, ppGVM, &pGVMM);
1144}
1145
1146
1147/**
1148 * Lookup a VM by its global handle.
1149 *
1150 * @returns The VM handle on success, NULL on failure.
1151 * @param hGVM The global VM handle. Asserts on bad handle.
1152 */
1153GVMMR0DECL(PVM) GVMMR0GetVMByHandle(uint32_t hGVM)
1154{
1155 PGVM pGVM = GVMMR0ByHandle(hGVM);
1156 return pGVM ? pGVM->pVM : NULL;
1157}
1158
1159
1160/**
1161 * Looks up the VM belonging to the specified EMT thread.
1162 *
1163 * This is used by the assertion machinery in VMMR0.cpp to avoid causing
1164 * unnecessary kernel panics when the EMT thread hits an assertion. The
1165 * call may or not be an EMT thread.
1166 *
1167 * @returns The VM handle on success, NULL on failure.
1168 * @param hEMT The native thread handle of the EMT.
1169 * NIL_RTNATIVETHREAD means the current thread
1170 */
1171GVMMR0DECL(PVM) GVMMR0GetVMByEMT(RTNATIVETHREAD hEMT)
1172{
1173 /*
1174 * No Assertions here as we're usually called in a AssertMsgN or
1175 * RTAssert* context.
1176 */
1177 PGVMM pGVMM = g_pGVMM;
1178 if ( !VALID_PTR(pGVMM)
1179 || pGVMM->u32Magic != GVMM_MAGIC)
1180 return NULL;
1181
1182 if (hEMT == NIL_RTNATIVETHREAD)
1183 hEMT = RTThreadNativeSelf();
1184
1185 /*
1186 * Search the handles in a linear fashion as we don't dare take the lock (assert).
1187 */
1188 for (unsigned i = 1; i < RT_ELEMENTS(pGVMM->aHandles); i++)
1189 if ( pGVMM->aHandles[i].hEMT == hEMT
1190 && pGVMM->aHandles[i].iSelf == i
1191 && VALID_PTR(pGVMM->aHandles[i].pvObj)
1192 && VALID_PTR(pGVMM->aHandles[i].pVM))
1193 return pGVMM->aHandles[i].pVM;
1194
1195 return NULL;
1196}
1197
1198
1199/**
1200 * This is will wake up expired and soon-to-be expired VMs.
1201 *
1202 * @returns Number of VMs that has been woken up.
1203 * @param pGVMM Pointer to the GVMM instance data.
1204 * @param u64Now The current time.
1205 */
1206static unsigned gvmmR0SchedDoWakeUps(PGVMM pGVMM, uint64_t u64Now)
1207{
1208 /*
1209 * The first pass will wake up VMs which has actually expired
1210 * and look for VMs that should be woken up in the 2nd and 3rd passes.
1211 */
1212 unsigned cWoken = 0;
1213 unsigned cHalted = 0;
1214 unsigned cTodo2nd = 0;
1215 unsigned cTodo3rd = 0;
1216 for (unsigned i = pGVMM->iUsedHead, cGuard = 0;
1217 i != NIL_GVM_HANDLE && i < RT_ELEMENTS(pGVMM->aHandles);
1218 i = pGVMM->aHandles[i].iNext)
1219 {
1220 PGVM pCurGVM = pGVMM->aHandles[i].pGVM;
1221 if ( VALID_PTR(pCurGVM)
1222 && pCurGVM->u32Magic == GVM_MAGIC)
1223 {
1224 uint64_t u64 = pCurGVM->gvmm.s.u64HaltExpire;
1225 if (u64)
1226 {
1227 if (u64 <= u64Now)
1228 {
1229 if (ASMAtomicXchgU64(&pCurGVM->gvmm.s.u64HaltExpire, 0))
1230 {
1231 int rc = RTSemEventMultiSignal(pCurGVM->gvmm.s.HaltEventMulti);
1232 AssertRC(rc);
1233 cWoken++;
1234 }
1235 }
1236 else
1237 {
1238 cHalted++;
1239 if (u64 <= u64Now + pGVMM->nsEarlyWakeUp1)
1240 cTodo2nd++;
1241 else if (u64 <= u64Now + pGVMM->nsEarlyWakeUp2)
1242 cTodo3rd++;
1243 }
1244 }
1245 }
1246 AssertLogRelBreak(cGuard++ < RT_ELEMENTS(pGVMM->aHandles));
1247 }
1248
1249 if (cTodo2nd)
1250 {
1251 for (unsigned i = pGVMM->iUsedHead, cGuard = 0;
1252 i != NIL_GVM_HANDLE && i < RT_ELEMENTS(pGVMM->aHandles);
1253 i = pGVMM->aHandles[i].iNext)
1254 {
1255 PGVM pCurGVM = pGVMM->aHandles[i].pGVM;
1256 if ( VALID_PTR(pCurGVM)
1257 && pCurGVM->u32Magic == GVM_MAGIC
1258 && pCurGVM->gvmm.s.u64HaltExpire
1259 && pCurGVM->gvmm.s.u64HaltExpire <= u64Now + pGVMM->nsEarlyWakeUp1)
1260 {
1261 if (ASMAtomicXchgU64(&pCurGVM->gvmm.s.u64HaltExpire, 0))
1262 {
1263 int rc = RTSemEventMultiSignal(pCurGVM->gvmm.s.HaltEventMulti);
1264 AssertRC(rc);
1265 cWoken++;
1266 }
1267 }
1268 AssertLogRelBreak(cGuard++ < RT_ELEMENTS(pGVMM->aHandles));
1269 }
1270 }
1271
1272 if (cTodo3rd)
1273 {
1274 for (unsigned i = pGVMM->iUsedHead, cGuard = 0;
1275 i != NIL_GVM_HANDLE && i < RT_ELEMENTS(pGVMM->aHandles);
1276 i = pGVMM->aHandles[i].iNext)
1277 {
1278 PGVM pCurGVM = pGVMM->aHandles[i].pGVM;
1279 if ( VALID_PTR(pCurGVM)
1280 && pCurGVM->u32Magic == GVM_MAGIC
1281 && pCurGVM->gvmm.s.u64HaltExpire
1282 && pCurGVM->gvmm.s.u64HaltExpire <= u64Now + pGVMM->nsEarlyWakeUp2)
1283 {
1284 if (ASMAtomicXchgU64(&pCurGVM->gvmm.s.u64HaltExpire, 0))
1285 {
1286 int rc = RTSemEventMultiSignal(pCurGVM->gvmm.s.HaltEventMulti);
1287 AssertRC(rc);
1288 cWoken++;
1289 }
1290 }
1291 AssertLogRelBreak(cGuard++ < RT_ELEMENTS(pGVMM->aHandles));
1292 }
1293 }
1294
1295 return cWoken;
1296}
1297
1298
1299/**
1300 * Halt the EMT thread.
1301 *
1302 * @returns VINF_SUCCESS normal wakeup (timeout or kicked by other thread).
1303 * VERR_INTERRUPTED if a signal was scheduled for the thread.
1304 * @param pVM Pointer to the shared VM structure.
1305 * @param u64ExpireGipTime The time for the sleep to expire expressed as GIP time.
1306 * @thread EMT.
1307 */
1308GVMMR0DECL(int) GVMMR0SchedHalt(PVM pVM, uint64_t u64ExpireGipTime)
1309{
1310 LogFlow(("GVMMR0SchedHalt: pVM=%p\n", pVM));
1311
1312 /*
1313 * Validate the VM structure, state and handle.
1314 */
1315 PGVMM pGVMM;
1316 PGVM pGVM;
1317 int rc = gvmmR0ByVMAndEMT(pVM, &pGVM, &pGVMM);
1318 if (RT_FAILURE(rc))
1319 return rc;
1320 pGVM->gvmm.s.StatsSched.cHaltCalls++;
1321
1322 Assert(!pGVM->gvmm.s.u64HaltExpire);
1323
1324 /*
1325 * Take the UsedList semaphore, get the current time
1326 * and check if anyone needs waking up.
1327 * Interrupts must NOT be disabled at this point because we ask for GIP time!
1328 */
1329 rc = gvmmR0UsedLock(pGVMM);
1330 AssertRC(rc);
1331
1332 pGVM->gvmm.s.iCpuEmt = ASMGetApicId();
1333
1334 Assert(ASMGetFlags() & X86_EFL_IF);
1335 const uint64_t u64Now = RTTimeNanoTS(); /* (GIP time) */
1336 pGVM->gvmm.s.StatsSched.cHaltWakeUps += gvmmR0SchedDoWakeUps(pGVMM, u64Now);
1337
1338 /*
1339 * Go to sleep if we must...
1340 */
1341 if ( u64Now < u64ExpireGipTime
1342 && u64ExpireGipTime - u64Now > (pGVMM->cVMs > pGVMM->cVMsMeansCompany
1343 ? pGVMM->nsMinSleepCompany
1344 : pGVMM->nsMinSleepAlone))
1345 {
1346 pGVM->gvmm.s.StatsSched.cHaltBlocking++;
1347 ASMAtomicXchgU64(&pGVM->gvmm.s.u64HaltExpire, u64ExpireGipTime);
1348 gvmmR0UsedUnlock(pGVMM);
1349
1350 uint32_t cMillies = (u64ExpireGipTime - u64Now) / 1000000;
1351 rc = RTSemEventMultiWaitNoResume(pGVM->gvmm.s.HaltEventMulti, cMillies ? cMillies : 1);
1352 ASMAtomicXchgU64(&pGVM->gvmm.s.u64HaltExpire, 0);
1353 if (rc == VERR_TIMEOUT)
1354 {
1355 pGVM->gvmm.s.StatsSched.cHaltTimeouts++;
1356 rc = VINF_SUCCESS;
1357 }
1358 }
1359 else
1360 {
1361 pGVM->gvmm.s.StatsSched.cHaltNotBlocking++;
1362 gvmmR0UsedUnlock(pGVMM);
1363 }
1364
1365 /* Make sure false wake up calls (gvmmR0SchedDoWakeUps) cause us to spin. */
1366 RTSemEventMultiReset(pGVM->gvmm.s.HaltEventMulti);
1367
1368 return rc;
1369}
1370
1371
1372/**
1373 * Wakes up the halted EMT thread so it can service a pending request.
1374 *
1375 * @returns VINF_SUCCESS if not yielded.
1376 * VINF_GVM_NOT_BLOCKED if the EMT thread wasn't blocked.
1377 * @param pVM Pointer to the shared VM structure.
1378 * @thread Any but EMT.
1379 */
1380GVMMR0DECL(int) GVMMR0SchedWakeUp(PVM pVM)
1381{
1382 /*
1383 * Validate input and take the UsedLock.
1384 */
1385 PGVM pGVM;
1386 PGVMM pGVMM;
1387 int rc = gvmmR0ByVM(pVM, &pGVM, &pGVMM, true /* fTakeUsedLock */);
1388 if (RT_SUCCESS(rc))
1389 {
1390 pGVM->gvmm.s.StatsSched.cWakeUpCalls++;
1391
1392 /*
1393 * Signal the semaphore regardless of whether it's current blocked on it.
1394 *
1395 * The reason for this is that there is absolutely no way we can be 100%
1396 * certain that it isn't *about* go to go to sleep on it and just got
1397 * delayed a bit en route. So, we will always signal the semaphore when
1398 * the it is flagged as halted in the VMM.
1399 */
1400 if (pGVM->gvmm.s.u64HaltExpire)
1401 {
1402 rc = VINF_SUCCESS;
1403 ASMAtomicXchgU64(&pGVM->gvmm.s.u64HaltExpire, 0);
1404 }
1405 else
1406 {
1407 rc = VINF_GVM_NOT_BLOCKED;
1408 pGVM->gvmm.s.StatsSched.cWakeUpNotHalted++;
1409 }
1410
1411 int rc2 = RTSemEventMultiSignal(pGVM->gvmm.s.HaltEventMulti);
1412 AssertRC(rc2);
1413
1414 /*
1415 * While we're here, do a round of scheduling.
1416 */
1417 Assert(ASMGetFlags() & X86_EFL_IF);
1418 const uint64_t u64Now = RTTimeNanoTS(); /* (GIP time) */
1419 pGVM->gvmm.s.StatsSched.cWakeUpWakeUps += gvmmR0SchedDoWakeUps(pGVMM, u64Now);
1420
1421
1422 rc2 = gvmmR0UsedUnlock(pGVMM);
1423 AssertRC(rc2);
1424 }
1425
1426 LogFlow(("GVMMR0SchedWakeUp: returns %Rrc\n", rc));
1427 return rc;
1428}
1429
1430
1431/**
1432 * Poll the schedule to see if someone else should get a chance to run.
1433 *
1434 * This is a bit hackish and will not work too well if the machine is
1435 * under heavy load from non-VM processes.
1436 *
1437 * @returns VINF_SUCCESS if not yielded.
1438 * VINF_GVM_YIELDED if an attempt to switch to a different VM task was made.
1439 * @param pVM Pointer to the shared VM structure.
1440 * @param u64ExpireGipTime The time for the sleep to expire expressed as GIP time.
1441 * @param fYield Whether to yield or not.
1442 * This is for when we're spinning in the halt loop.
1443 * @thread EMT.
1444 */
1445GVMMR0DECL(int) GVMMR0SchedPoll(PVM pVM, bool fYield)
1446{
1447 /*
1448 * Validate input.
1449 */
1450 PGVM pGVM;
1451 PGVMM pGVMM;
1452 int rc = gvmmR0ByVMAndEMT(pVM, &pGVM, &pGVMM);
1453 if (RT_SUCCESS(rc))
1454 {
1455 rc = gvmmR0UsedLock(pGVMM);
1456 AssertRC(rc);
1457 pGVM->gvmm.s.StatsSched.cPollCalls++;
1458
1459 Assert(ASMGetFlags() & X86_EFL_IF);
1460 const uint64_t u64Now = RTTimeNanoTS(); /* (GIP time) */
1461
1462 if (!fYield)
1463 pGVM->gvmm.s.StatsSched.cPollWakeUps += gvmmR0SchedDoWakeUps(pGVMM, u64Now);
1464 else
1465 {
1466 /** @todo implement this... */
1467 rc = VERR_NOT_IMPLEMENTED;
1468 }
1469
1470 gvmmR0UsedUnlock(pGVMM);
1471 }
1472
1473 LogFlow(("GVMMR0SchedWakeUp: returns %Rrc\n", rc));
1474 return rc;
1475}
1476
1477
1478
1479/**
1480 * Retrieves the GVMM statistics visible to the caller.
1481 *
1482 * @returns VBox status code.
1483 *
1484 * @param pStats Where to put the statistics.
1485 * @param pSession The current session.
1486 * @param pVM The VM to obtain statistics for. Optional.
1487 */
1488GVMMR0DECL(int) GVMMR0QueryStatistics(PGVMMSTATS pStats, PSUPDRVSESSION pSession, PVM pVM)
1489{
1490 LogFlow(("GVMMR0QueryStatistics: pStats=%p pSession=%p pVM=%p\n", pStats, pSession, pVM));
1491
1492 /*
1493 * Validate input.
1494 */
1495 AssertPtrReturn(pSession, VERR_INVALID_POINTER);
1496 AssertPtrReturn(pStats, VERR_INVALID_POINTER);
1497 pStats->cVMs = 0; /* (crash before taking the sem...) */
1498
1499 /*
1500 * Take the lock and get the VM statistics.
1501 */
1502 PGVMM pGVMM;
1503 if (pVM)
1504 {
1505 PGVM pGVM;
1506 int rc = gvmmR0ByVM(pVM, &pGVM, &pGVMM, true /*fTakeUsedLock*/);
1507 if (RT_FAILURE(rc))
1508 return rc;
1509 pStats->SchedVM = pGVM->gvmm.s.StatsSched;
1510 }
1511 else
1512 {
1513 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
1514 memset(&pStats->SchedVM, 0, sizeof(pStats->SchedVM));
1515
1516 int rc = gvmmR0UsedLock(pGVMM);
1517 AssertRCReturn(rc, rc);
1518 }
1519
1520 /*
1521 * Enumerate the VMs and add the ones visibile to the statistics.
1522 */
1523 pStats->cVMs = 0;
1524 memset(&pStats->SchedSum, 0, sizeof(pStats->SchedSum));
1525
1526 for (unsigned i = pGVMM->iUsedHead;
1527 i != NIL_GVM_HANDLE && i < RT_ELEMENTS(pGVMM->aHandles);
1528 i = pGVMM->aHandles[i].iNext)
1529 {
1530 PGVM pGVM = pGVMM->aHandles[i].pGVM;
1531 void *pvObj = pGVMM->aHandles[i].pvObj;
1532 if ( VALID_PTR(pvObj)
1533 && VALID_PTR(pGVM)
1534 && pGVM->u32Magic == GVM_MAGIC
1535 && RT_SUCCESS(SUPR0ObjVerifyAccess(pvObj, pSession, NULL)))
1536 {
1537 pStats->cVMs++;
1538
1539 pStats->SchedSum.cHaltCalls += pGVM->gvmm.s.StatsSched.cHaltCalls;
1540 pStats->SchedSum.cHaltBlocking += pGVM->gvmm.s.StatsSched.cHaltBlocking;
1541 pStats->SchedSum.cHaltTimeouts += pGVM->gvmm.s.StatsSched.cHaltTimeouts;
1542 pStats->SchedSum.cHaltNotBlocking += pGVM->gvmm.s.StatsSched.cHaltNotBlocking;
1543 pStats->SchedSum.cHaltWakeUps += pGVM->gvmm.s.StatsSched.cHaltWakeUps;
1544
1545 pStats->SchedSum.cWakeUpCalls += pGVM->gvmm.s.StatsSched.cWakeUpCalls;
1546 pStats->SchedSum.cWakeUpNotHalted += pGVM->gvmm.s.StatsSched.cWakeUpNotHalted;
1547 pStats->SchedSum.cWakeUpWakeUps += pGVM->gvmm.s.StatsSched.cWakeUpWakeUps;
1548
1549 pStats->SchedSum.cPollCalls += pGVM->gvmm.s.StatsSched.cPollCalls;
1550 pStats->SchedSum.cPollHalts += pGVM->gvmm.s.StatsSched.cPollHalts;
1551 pStats->SchedSum.cPollWakeUps += pGVM->gvmm.s.StatsSched.cPollWakeUps;
1552 }
1553 }
1554
1555 gvmmR0UsedUnlock(pGVMM);
1556
1557 return VINF_SUCCESS;
1558}
1559
1560
1561/**
1562 * VMMR0 request wrapper for GVMMR0QueryStatistics.
1563 *
1564 * @returns see GVMMR0QueryStatistics.
1565 * @param pVM Pointer to the shared VM structure. Optional.
1566 * @param pReq The request packet.
1567 */
1568GVMMR0DECL(int) GVMMR0QueryStatisticsReq(PVM pVM, PGVMMQUERYSTATISTICSSREQ pReq)
1569{
1570 /*
1571 * Validate input and pass it on.
1572 */
1573 AssertPtrReturn(pReq, VERR_INVALID_POINTER);
1574 AssertMsgReturn(pReq->Hdr.cbReq == sizeof(*pReq), ("%#x != %#x\n", pReq->Hdr.cbReq, sizeof(*pReq)), VERR_INVALID_PARAMETER);
1575
1576 return GVMMR0QueryStatistics(&pReq->Stats, pReq->pSession, pVM);
1577}
1578
1579
1580/**
1581 * Resets the specified GVMM statistics.
1582 *
1583 * @returns VBox status code.
1584 *
1585 * @param pStats Which statistics to reset, that is, non-zero fields indicates which to reset.
1586 * @param pSession The current session.
1587 * @param pVM The VM to reset statistics for. Optional.
1588 */
1589GVMMR0DECL(int) GVMMR0ResetStatistics(PCGVMMSTATS pStats, PSUPDRVSESSION pSession, PVM pVM)
1590{
1591 LogFlow(("GVMMR0ResetStatistics: pStats=%p pSession=%p pVM=%p\n", pStats, pSession, pVM));
1592
1593 /*
1594 * Validate input.
1595 */
1596 AssertPtrReturn(pSession, VERR_INVALID_POINTER);
1597 AssertPtrReturn(pStats, VERR_INVALID_POINTER);
1598
1599 /*
1600 * Take the lock and get the VM statistics.
1601 */
1602 PGVMM pGVMM;
1603 if (pVM)
1604 {
1605 PGVM pGVM;
1606 int rc = gvmmR0ByVM(pVM, &pGVM, &pGVMM, true /*fTakeUsedLock*/);
1607 if (RT_FAILURE(rc))
1608 return rc;
1609# define MAYBE_RESET_FIELD(field) \
1610 do { if (pStats->SchedVM. field ) { pGVM->gvmm.s.StatsSched. field = 0; } } while (0)
1611 MAYBE_RESET_FIELD(cHaltCalls);
1612 MAYBE_RESET_FIELD(cHaltBlocking);
1613 MAYBE_RESET_FIELD(cHaltTimeouts);
1614 MAYBE_RESET_FIELD(cHaltNotBlocking);
1615 MAYBE_RESET_FIELD(cHaltWakeUps);
1616 MAYBE_RESET_FIELD(cWakeUpCalls);
1617 MAYBE_RESET_FIELD(cWakeUpNotHalted);
1618 MAYBE_RESET_FIELD(cWakeUpWakeUps);
1619 MAYBE_RESET_FIELD(cPollCalls);
1620 MAYBE_RESET_FIELD(cPollHalts);
1621 MAYBE_RESET_FIELD(cPollWakeUps);
1622# undef MAYBE_RESET_FIELD
1623 }
1624 else
1625 {
1626 GVMM_GET_VALID_INSTANCE(pGVMM, VERR_INTERNAL_ERROR);
1627
1628 int rc = gvmmR0UsedLock(pGVMM);
1629 AssertRCReturn(rc, rc);
1630 }
1631
1632 /*
1633 * Enumerate the VMs and add the ones visibile to the statistics.
1634 */
1635 if (ASMMemIsAll8(&pStats->SchedSum, sizeof(pStats->SchedSum), 0))
1636 {
1637 for (unsigned i = pGVMM->iUsedHead;
1638 i != NIL_GVM_HANDLE && i < RT_ELEMENTS(pGVMM->aHandles);
1639 i = pGVMM->aHandles[i].iNext)
1640 {
1641 PGVM pGVM = pGVMM->aHandles[i].pGVM;
1642 void *pvObj = pGVMM->aHandles[i].pvObj;
1643 if ( VALID_PTR(pvObj)
1644 && VALID_PTR(pGVM)
1645 && pGVM->u32Magic == GVM_MAGIC
1646 && RT_SUCCESS(SUPR0ObjVerifyAccess(pvObj, pSession, NULL)))
1647 {
1648# define MAYBE_RESET_FIELD(field) \
1649 do { if (pStats->SchedSum. field ) { pGVM->gvmm.s.StatsSched. field = 0; } } while (0)
1650 MAYBE_RESET_FIELD(cHaltCalls);
1651 MAYBE_RESET_FIELD(cHaltBlocking);
1652 MAYBE_RESET_FIELD(cHaltTimeouts);
1653 MAYBE_RESET_FIELD(cHaltNotBlocking);
1654 MAYBE_RESET_FIELD(cHaltWakeUps);
1655 MAYBE_RESET_FIELD(cWakeUpCalls);
1656 MAYBE_RESET_FIELD(cWakeUpNotHalted);
1657 MAYBE_RESET_FIELD(cWakeUpWakeUps);
1658 MAYBE_RESET_FIELD(cPollCalls);
1659 MAYBE_RESET_FIELD(cPollHalts);
1660 MAYBE_RESET_FIELD(cPollWakeUps);
1661# undef MAYBE_RESET_FIELD
1662 }
1663 }
1664 }
1665
1666 gvmmR0UsedUnlock(pGVMM);
1667
1668 return VINF_SUCCESS;
1669}
1670
1671
1672/**
1673 * VMMR0 request wrapper for GVMMR0ResetStatistics.
1674 *
1675 * @returns see GVMMR0ResetStatistics.
1676 * @param pVM Pointer to the shared VM structure. Optional.
1677 * @param pReq The request packet.
1678 */
1679GVMMR0DECL(int) GVMMR0ResetStatisticsReq(PVM pVM, PGVMMRESETSTATISTICSSREQ pReq)
1680{
1681 /*
1682 * Validate input and pass it on.
1683 */
1684 AssertPtrReturn(pReq, VERR_INVALID_POINTER);
1685 AssertMsgReturn(pReq->Hdr.cbReq == sizeof(*pReq), ("%#x != %#x\n", pReq->Hdr.cbReq, sizeof(*pReq)), VERR_INVALID_PARAMETER);
1686
1687 return GVMMR0ResetStatistics(&pReq->Stats, pReq->pSession, pVM);
1688}
1689
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