VirtualBox

source: vbox/trunk/src/VBox/VMM/DBGFOS.cpp@ 24912

Last change on this file since 24912 was 23015, checked in by vboxsync, 15 years ago

VMM,Main,Devices,VBoxBFE: VMReqCallVoid[U] -> VMR3ReqCallVoidWait. Retired the two old APIs.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 13.7 KB
Line 
1/* $Id: DBGFOS.cpp 23015 2009-09-14 17:00:11Z vboxsync $ */
2/** @file
3 * DBGF - Debugger Facility, Guest OS Diggers.
4 */
5
6/*
7 * Copyright (C) 2008 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/*******************************************************************************
24* Header Files *
25*******************************************************************************/
26#define LOG_GROUP LOG_GROUP_DBGF
27#include <VBox/dbgf.h>
28#include <VBox/mm.h>
29#include "DBGFInternal.h"
30#include <VBox/vm.h>
31#include <VBox/err.h>
32#include <VBox/log.h>
33
34#include <iprt/assert.h>
35#include <iprt/thread.h>
36#include <iprt/param.h>
37
38
39/*******************************************************************************
40* Defined Constants And Macros *
41*******************************************************************************/
42#define DBGF_OS_READ_LOCK(pVM) do { } while (0)
43#define DBGF_OS_READ_UNLOCK(pVM) do { } while (0)
44
45#define DBGF_OS_WRITE_LOCK(pVM) do { } while (0)
46#define DBGF_OS_WRITE_UNLOCK(pVM) do { } while (0)
47
48
49/**
50 * Internal cleanup routine called by DBGFR3Term().
51 *
52 * @param pVM Pointer to the shared VM structure.
53 */
54void dbgfR3OSTerm(PVM pVM)
55{
56 /*
57 * Terminate the current one.
58 */
59 if (pVM->dbgf.s.pCurOS)
60 {
61 pVM->dbgf.s.pCurOS->pReg->pfnTerm(pVM, pVM->dbgf.s.pCurOS->abData);
62 pVM->dbgf.s.pCurOS = NULL;
63 }
64
65 /*
66 * Destroy all the instances.
67 */
68 while (pVM->dbgf.s.pOSHead)
69 {
70 PDBGFOS pOS = pVM->dbgf.s.pOSHead;
71 pVM->dbgf.s.pOSHead = pOS->pNext;
72 if (pOS->pReg->pfnDestruct)
73 pOS->pReg->pfnDestruct(pVM, pOS->abData);
74 MMR3HeapFree(pOS);
75 }
76}
77
78
79/**
80 * EMT worker function for DBGFR3OSRegister.
81 *
82 * @returns VBox status code.
83 * @param pVM Pointer to the shared VM structure.
84 * @param pReg The registration structure.
85 */
86static DECLCALLBACK(int) dbgfR3OSRegister(PVM pVM, PDBGFOSREG pReg)
87{
88 /* more validations. */
89 DBGF_OS_READ_LOCK(pVM);
90 PDBGFOS pOS;
91 for (pOS = pVM->dbgf.s.pOSHead; pOS; pOS = pOS->pNext)
92 if (!strcmp(pOS->pReg->szName, pReg->szName))
93 {
94 DBGF_OS_READ_UNLOCK(pVM);
95 Log(("dbgfR3OSRegister: %s -> VERR_ALREADY_LOADED\n", pReg->szName));
96 return VERR_ALREADY_LOADED;
97 }
98
99 /*
100 * Allocate a new structure, call the constructor and link it into the list.
101 */
102 pOS = (PDBGFOS)MMR3HeapAllocZ(pVM, MM_TAG_DBGF_OS, RT_OFFSETOF(DBGFOS, abData[pReg->cbData]));
103 AssertReturn(pOS, VERR_NO_MEMORY);
104 pOS->pReg = pReg;
105
106 int rc = pOS->pReg->pfnConstruct(pVM, pOS->abData);
107 if (RT_SUCCESS(rc))
108 {
109 DBGF_OS_WRITE_LOCK(pVM);
110 pOS->pNext = pVM->dbgf.s.pOSHead;
111 pVM->dbgf.s.pOSHead = pOS;
112 DBGF_OS_WRITE_UNLOCK(pVM);
113 }
114 else
115 {
116 if (pOS->pReg->pfnDestruct)
117 pOS->pReg->pfnDestruct(pVM, pOS->abData);
118 MMR3HeapFree(pOS);
119 }
120
121 return VINF_SUCCESS;
122}
123
124
125/**
126 * Registers a guest OS digger.
127 *
128 * This will instantiate an instance of the digger and add it
129 * to the list for us in the next call to DBGFR3OSDetect().
130 *
131 * @returns VBox status code.
132 * @param pVM Pointer to the shared VM structure.
133 * @param pReg The registration structure.
134 * @thread Any.
135 */
136VMMR3DECL(int) DBGFR3OSRegister(PVM pVM, PCDBGFOSREG pReg)
137{
138 /*
139 * Validate intput.
140 */
141 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
142
143 AssertPtrReturn(pReg, VERR_INVALID_POINTER);
144 AssertReturn(pReg->u32Magic == DBGFOSREG_MAGIC, VERR_INVALID_MAGIC);
145 AssertReturn(pReg->u32EndMagic == DBGFOSREG_MAGIC, VERR_INVALID_MAGIC);
146 AssertReturn(!pReg->fFlags, VERR_INVALID_PARAMETER);
147 AssertReturn(pReg->cbData < _2G, VERR_INVALID_PARAMETER);
148 AssertReturn(pReg->szName[0], VERR_INVALID_NAME);
149 AssertReturn(memchr(&pReg->szName[0], '\0', sizeof(pReg->szName)), VERR_INVALID_NAME);
150 AssertPtrReturn(pReg->pfnConstruct, VERR_INVALID_POINTER);
151 AssertPtrNullReturn(pReg->pfnDestruct, VERR_INVALID_POINTER);
152 AssertPtrReturn(pReg->pfnProbe, VERR_INVALID_POINTER);
153 AssertPtrReturn(pReg->pfnInit, VERR_INVALID_POINTER);
154 AssertPtrReturn(pReg->pfnRefresh, VERR_INVALID_POINTER);
155 AssertPtrReturn(pReg->pfnTerm, VERR_INVALID_POINTER);
156 AssertPtrReturn(pReg->pfnQueryVersion, VERR_INVALID_POINTER);
157 AssertPtrReturn(pReg->pfnQueryInterface, VERR_INVALID_POINTER);
158
159 /*
160 * Pass it on to EMT(0).
161 */
162 return VMR3ReqCallWaitU(pVM->pUVM, 0 /*idDstCpu*/, (PFNRT)dbgfR3OSRegister, 2, pVM, pReg);
163}
164
165
166/**
167 * EMT worker function for DBGFR3OSDeregister.
168 *
169 * @returns VBox status code.
170 * @param pVM Pointer to the shared VM structure.
171 * @param pReg The registration structure.
172 */
173static DECLCALLBACK(int) dbgfR3OSDeregister(PVM pVM, PDBGFOSREG pReg)
174{
175 /*
176 * Unlink it.
177 */
178 bool fWasCurOS = false;
179 PDBGFOS pOSPrev = NULL;
180 PDBGFOS pOS;
181 DBGF_OS_WRITE_LOCK(pVM);
182 for (pOS = pVM->dbgf.s.pOSHead; pOS; pOSPrev = pOS, pOS = pOS->pNext)
183 if (pOS->pReg == pReg)
184 {
185 if (pOSPrev)
186 pOSPrev->pNext = pOS->pNext;
187 else
188 pVM->dbgf.s.pOSHead = pOS->pNext;
189 if (pVM->dbgf.s.pCurOS == pOS)
190 {
191 pVM->dbgf.s.pCurOS = NULL;
192 fWasCurOS = true;
193 }
194 break;
195 }
196 DBGF_OS_WRITE_UNLOCK(pVM);
197 if (!pOS)
198 {
199 Log(("DBGFR3OSDeregister: %s -> VERR_NOT_FOUND\n", pReg->szName));
200 return VERR_NOT_FOUND;
201 }
202
203 /*
204 * Terminate it if it was the current OS, then invoke the
205 * destructor and clean up.
206 */
207 if (fWasCurOS)
208 pOS->pReg->pfnTerm(pVM, pOS->abData);
209 if (pOS->pReg->pfnDestruct)
210 pOS->pReg->pfnDestruct(pVM, pOS->abData);
211 MMR3HeapFree(pOS);
212
213 return VINF_SUCCESS;
214}
215
216
217/**
218 * Deregisters a guest OS digger previously registered by DBGFR3OSRegister.
219 *
220 * @returns VBox status code.
221 *
222 * @param pVM Pointer to the shared VM structure.
223 * @param pReg The registration structure.
224 * @thread Any.
225 */
226VMMR3DECL(int) DBGFR3OSDeregister(PVM pVM, PCDBGFOSREG pReg)
227{
228 /*
229 * Validate input.
230 */
231 VM_ASSERT_VALID_EXT_RETURN(pVM, VERR_INVALID_VM_HANDLE);
232 AssertPtrReturn(pReg, VERR_INVALID_POINTER);
233 AssertReturn(pReg->u32Magic == DBGFOSREG_MAGIC, VERR_INVALID_MAGIC);
234 AssertReturn(pReg->u32EndMagic == DBGFOSREG_MAGIC, VERR_INVALID_MAGIC);
235 AssertReturn(memchr(&pReg->szName[0], '\0', sizeof(pReg->szName)), VERR_INVALID_NAME);
236
237 DBGF_OS_READ_LOCK(pVM);
238 PDBGFOS pOS;
239 for (pOS = pVM->dbgf.s.pOSHead; pOS; pOS = pOS->pNext)
240 if (pOS->pReg == pReg)
241 break;
242 DBGF_OS_READ_LOCK(pVM);
243
244 if (!pOS)
245 {
246 Log(("DBGFR3OSDeregister: %s -> VERR_NOT_FOUND\n", pReg->szName));
247 return VERR_NOT_FOUND;
248 }
249
250 /*
251 * Pass it on to EMT(0).
252 */
253 return VMR3ReqCallWaitU(pVM->pUVM, 0 /*idDstCpu*/, (PFNRT)dbgfR3OSDeregister, 2, pVM, pReg);
254}
255
256
257/**
258 * EMT worker function for DBGFR3OSDetect.
259 *
260 * @returns VBox status code.
261 * @retval VINF_SUCCESS if successfully detected.
262 * @retval VINF_DBGF_OS_NOT_DETCTED if we cannot figure it out.
263 *
264 * @param pVM Pointer to the shared VM structure.
265 * @param pszName Where to store the OS name. Empty string if not detected.
266 * @param cchName Size of the buffer.
267 */
268static DECLCALLBACK(int) dbgfR3OSDetect(PVM pVM, char *pszName, size_t cchName)
269{
270 /*
271 * Cycle thru the detection routines.
272 */
273 PDBGFOS const pOldOS = pVM->dbgf.s.pCurOS;
274 pVM->dbgf.s.pCurOS = NULL;
275
276 for (PDBGFOS pNewOS = pVM->dbgf.s.pOSHead; pNewOS; pNewOS = pNewOS->pNext)
277 if (pNewOS->pReg->pfnProbe(pVM, pNewOS->abData))
278 {
279 int rc;
280 pVM->dbgf.s.pCurOS = pNewOS;
281 if (pOldOS == pNewOS)
282 rc = pNewOS->pReg->pfnRefresh(pVM, pNewOS->abData);
283 else
284 {
285 if (pOldOS)
286 pOldOS->pReg->pfnTerm(pVM, pNewOS->abData);
287 rc = pNewOS->pReg->pfnInit(pVM, pNewOS->abData);
288 }
289 if (pszName && cchName)
290 strncat(pszName, pNewOS->pReg->szName, cchName);
291 return rc;
292 }
293
294 /* not found */
295 if (pOldOS)
296 pOldOS->pReg->pfnTerm(pVM, pOldOS->abData);
297 return VINF_DBGF_OS_NOT_DETCTED;
298}
299
300
301/**
302 * Detectes the guest OS and try dig out symbols and useful stuff.
303 *
304 * When called the 2nd time, symbols will be updated that if the OS
305 * is the same.
306 *
307 * @returns VBox status code.
308 * @retval VINF_SUCCESS if successfully detected.
309 * @retval VINF_DBGF_OS_NOT_DETCTED if we cannot figure it out.
310 *
311 * @param pVM Pointer to the shared VM structure.
312 * @param pszName Where to store the OS name. Empty string if not detected.
313 * @param cchName Size of the buffer.
314 * @thread Any.
315 */
316VMMR3DECL(int) DBGFR3OSDetect(PVM pVM, char *pszName, size_t cchName)
317{
318 AssertPtrNullReturn(pszName, VERR_INVALID_POINTER);
319 if (pszName && cchName)
320 *pszName = '\0';
321
322 /*
323 * Pass it on to EMT(0).
324 */
325 return VMR3ReqCallWaitU(pVM->pUVM, 0 /*idDstCpu*/, (PFNRT)dbgfR3OSDetect, 3, pVM, pszName, cchName);
326}
327
328
329/**
330 * EMT worker function for DBGFR3OSQueryNameAndVersion
331 *
332 * @returns VBox status code.
333 * @param pVM Pointer to the shared VM structure.
334 * @param pszName Where to store the OS name. Optional.
335 * @param cchName The size of the name buffer.
336 * @param pszVersion Where to store the version string. Optional.
337 * @param cchVersion The size of the version buffer.
338 */
339static DECLCALLBACK(int) dbgfR3OSQueryNameAndVersion(PVM pVM, char *pszName, size_t cchName, char *pszVersion, size_t cchVersion)
340{
341 /*
342 * Any known OS?
343 */
344 if (pVM->dbgf.s.pCurOS)
345 {
346 int rc = VINF_SUCCESS;
347 if (pszName && cchName)
348 {
349 size_t cch = strlen(pVM->dbgf.s.pCurOS->pReg->szName);
350 if (cchName > cch)
351 memcpy(pszName, pVM->dbgf.s.pCurOS->pReg->szName, cch + 1);
352 else
353 {
354 memcpy(pszName, pVM->dbgf.s.pCurOS->pReg->szName, cchName - 1);
355 pszName[cchName - 1] = '\0';
356 rc = VINF_BUFFER_OVERFLOW;
357 }
358 }
359
360 if (pszVersion && cchVersion)
361 {
362 int rc2 = pVM->dbgf.s.pCurOS->pReg->pfnQueryVersion(pVM, pVM->dbgf.s.pCurOS->abData, pszVersion, cchVersion);
363 if (RT_FAILURE(rc2) || rc == VINF_SUCCESS)
364 rc = rc2;
365 }
366 return rc;
367 }
368
369 return VERR_DBGF_OS_NOT_DETCTED;
370}
371
372
373/**
374 * Queries the name and/or version string for the guest OS.
375 *
376 * It goes without saying that this querying is done using the current
377 * guest OS digger and not additions or user configuration.
378 *
379 * @returns VBox status code.
380 * @param pVM Pointer to the shared VM structure.
381 * @param pszName Where to store the OS name. Optional.
382 * @param cchName The size of the name buffer.
383 * @param pszVersion Where to store the version string. Optional.
384 * @param cchVersion The size of the version buffer.
385 * @thread Any.
386 */
387VMMR3DECL(int) DBGFR3OSQueryNameAndVersion(PVM pVM, char *pszName, size_t cchName, char *pszVersion, size_t cchVersion)
388{
389 AssertPtrNullReturn(pszName, VERR_INVALID_POINTER);
390 AssertPtrNullReturn(pszVersion, VERR_INVALID_POINTER);
391
392 /*
393 * Initialize the output up front.
394 */
395 if (pszName && cchName)
396 *pszName = '\0';
397 if (pszVersion && cchVersion)
398 *pszVersion = '\0';
399
400 /*
401 * Pass it on to EMT(0).
402 */
403 return VMR3ReqCallWaitU(pVM->pUVM, 0 /*idDstCpu*/,
404 (PFNRT)dbgfR3OSQueryNameAndVersion, 5, pVM, pszName, cchName, pszVersion, cchVersion);
405}
406
407
408/**
409 * EMT worker for DBGFR3OSQueryInterface.
410 *
411 * @param pVM Pointer to the shared VM structure.
412 * @param enmIf The interface identifier.
413 * @param ppvIf Where to store the interface pointer on success.
414 */
415static DECLCALLBACK(void) dbgfR3OSQueryInterface(PVM pVM, DBGFOSINTERFACE enmIf, void **ppvIf)
416{
417 if (pVM->dbgf.s.pCurOS)
418 {
419 *ppvIf = pVM->dbgf.s.pCurOS->pReg->pfnQueryInterface(pVM, pVM->dbgf.s.pCurOS->abData, enmIf);
420 if (*ppvIf)
421 {
422 /** @todo Create EMT wrapper for the returned interface once we've defined one...
423 * Just keep a list of wrapper together with the OS instance. */
424 }
425 }
426 else
427 *ppvIf = NULL;
428}
429
430
431/**
432 * Query an optional digger interface.
433 *
434 * @returns Pointer to the digger interface on success, NULL if the interfaces isn't
435 * available or no active guest OS digger.
436 * @param pVM Pointer to the shared VM structure.
437 * @param enmIf The interface identifier.
438 * @thread Any.
439 */
440VMMR3DECL(void *) DBGFR3OSQueryInterface(PVM pVM, DBGFOSINTERFACE enmIf)
441{
442 AssertMsgReturn(enmIf > DBGFOSINTERFACE_INVALID && enmIf < DBGFOSINTERFACE_END, ("%d\n", enmIf), NULL);
443
444 /*
445 * Pass it on to an EMT.
446 */
447 void *pvIf = NULL;
448 VMR3ReqCallVoidWait(pVM, VMCPUID_ANY, (PFNRT)dbgfR3OSQueryInterface, 3, pVM, enmIf, &pvIf);
449 return pvIf;
450}
451
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use