VirtualBox

source: vbox/trunk/src/VBox/VMM/STAM.cpp@ 19707

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

GVMM: Count EMTs instead of VMs to determin if we've got company or not. (scheduling)
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 68.2 KB
Line 
1/* $Id: STAM.cpp 19707 2009-05-14 17:36:11Z vboxsync $ */
2/** @file
3 * STAM - The Statistics Manager.
4 */
5
6/*
7 * Copyright (C) 2006-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/** @page pg_stam STAM - The Statistics Manager
23 *
24 * The purpose for the statistics manager is to present the rest of the system
25 * with a somewhat uniform way of accessing VMM statistics. STAM sports a
26 * couple of different APIs for accessing them: STAMR3EnumU, STAMR3SnapshotU,
27 * STAMR3DumpU, STAMR3DumpToReleaseLogU and the debugger. Main is exposing the
28 * XML based one, STAMR3SnapshotU.
29 *
30 * The rest of the VMM together with the devices and drivers registers their
31 * statistics with STAM giving them a name. The name is hierarchical, the
32 * components separated by slashes ('/') and must start with a slash.
33 *
34 * Each item registered with STAM - also, half incorrectly, called a sample -
35 * has a type, unit, visibility, data pointer and description associated with it
36 * in addition to the name (described above). The type tells STAM what kind of
37 * structure the pointer is pointing to. The visibility allows unused
38 * statistics from cluttering the output or showing up in the GUI. All the bits
39 * together makes STAM able to present the items in a sensible way to the user.
40 * Some types also allows STAM to reset the data, which is very convenient when
41 * digging into specific operations and such.
42 *
43 * PS. The VirtualBox Debugger GUI has a viewer for inspecting the statistics
44 * STAM provides. You will also find statistics in the release and debug logs.
45 * And as mentioned in the introduction, the debugger console features a couple
46 * of command: .stats and .statsreset.
47 *
48 * @see grp_stam
49 */
50
51/*******************************************************************************
52* Header Files *
53*******************************************************************************/
54#define LOG_GROUP LOG_GROUP_STAM
55#include <VBox/stam.h>
56#include "STAMInternal.h"
57#include <VBox/vm.h>
58#include <VBox/uvm.h>
59#include <VBox/err.h>
60#include <VBox/dbg.h>
61#include <VBox/log.h>
62
63#include <iprt/assert.h>
64#include <iprt/asm.h>
65#include <iprt/alloc.h>
66#include <iprt/stream.h>
67#include <iprt/string.h>
68
69
70/*******************************************************************************
71* Structures and Typedefs *
72*******************************************************************************/
73/**
74 * Argument structure for stamR3PrintOne().
75 */
76typedef struct STAMR3PRINTONEARGS
77{
78 PVM pVM;
79 void *pvArg;
80 DECLCALLBACKMEMBER(void, pfnPrintf)(struct STAMR3PRINTONEARGS *pvArg, const char *pszFormat, ...);
81} STAMR3PRINTONEARGS, *PSTAMR3PRINTONEARGS;
82
83
84/**
85 * Argument structure to stamR3EnumOne().
86 */
87typedef struct STAMR3ENUMONEARGS
88{
89 PVM pVM;
90 PFNSTAMR3ENUM pfnEnum;
91 void *pvUser;
92} STAMR3ENUMONEARGS, *PSTAMR3ENUMONEARGS;
93
94
95/**
96 * The snapshot status structure.
97 * Argument package passed to stamR3SnapshotOne, stamR3SnapshotPrintf and stamR3SnapshotOutput.
98 */
99typedef struct STAMR3SNAPSHOTONE
100{
101 /** Pointer to the buffer start. */
102 char *pszStart;
103 /** Pointer to the buffer end. */
104 char *pszEnd;
105 /** Pointer to the current buffer position. */
106 char *psz;
107 /** The VM handle. */
108 PVM pVM;
109 /** The number of bytes allocated. */
110 size_t cbAllocated;
111 /** The status code. */
112 int rc;
113 /** Whether to include the description strings. */
114 bool fWithDesc;
115} STAMR3SNAPSHOTONE, *PSTAMR3SNAPSHOTONE;
116
117
118/**
119 * Init record for a ring-0 statistic sample.
120 */
121typedef struct STAMR0SAMPLE
122{
123 /** The GVMMSTATS structure offset of the variable. */
124 unsigned offVar;
125 /** The type. */
126 STAMTYPE enmType;
127 /** The unit. */
128 STAMUNIT enmUnit;
129 /** The name. */
130 const char *pszName;
131 /** The description. */
132 const char *pszDesc;
133} STAMR0SAMPLE;
134
135
136/*******************************************************************************
137* Internal Functions *
138*******************************************************************************/
139static int stamR3RegisterU(PUVM pUVM, void *pvSample, PFNSTAMR3CALLBACKRESET pfnReset, PFNSTAMR3CALLBACKPRINT pfnPrint,
140 STAMTYPE enmType, STAMVISIBILITY enmVisibility, const char *pszName, STAMUNIT enmUnit, const char *pszDesc);
141static int stamR3ResetOne(PSTAMDESC pDesc, void *pvArg);
142static DECLCALLBACK(void) stamR3EnumLogPrintf(PSTAMR3PRINTONEARGS pvArg, const char *pszFormat, ...);
143static DECLCALLBACK(void) stamR3EnumRelLogPrintf(PSTAMR3PRINTONEARGS pvArg, const char *pszFormat, ...);
144static DECLCALLBACK(void) stamR3EnumPrintf(PSTAMR3PRINTONEARGS pvArg, const char *pszFormat, ...);
145static int stamR3SnapshotOne(PSTAMDESC pDesc, void *pvArg);
146static int stamR3SnapshotPrintf(PSTAMR3SNAPSHOTONE pThis, const char *pszFormat, ...);
147static int stamR3PrintOne(PSTAMDESC pDesc, void *pvArg);
148static int stamR3EnumOne(PSTAMDESC pDesc, void *pvArg);
149static bool stamR3MultiMatch(const char * const *papszExpressions, unsigned cExpressions, unsigned *piExpression, const char *pszName);
150static char ** stamR3SplitPattern(const char *pszPat, unsigned *pcExpressions, char **ppszCopy);
151static int stamR3EnumU(PUVM pUVM, const char *pszPat, bool fUpdateRing0, int (pfnCallback)(PSTAMDESC pDesc, void *pvArg), void *pvArg);
152static void stamR3Ring0StatsRegisterU(PUVM pUVM);
153static void stamR3Ring0StatsUpdateU(PUVM pUVM, const char *pszPat);
154static void stamR3Ring0StatsUpdateMultiU(PUVM pUVM, const char * const *papszExpressions, unsigned cExpressions);
155
156#ifdef VBOX_WITH_DEBUGGER
157static DECLCALLBACK(int) stamR3CmdStats(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PVM pVM, PCDBGCVAR paArgs, unsigned cArgs, PDBGCVAR pResult);
158static DECLCALLBACK(void) stamR3EnumDbgfPrintf(PSTAMR3PRINTONEARGS pArgs, const char *pszFormat, ...);
159static DECLCALLBACK(int) stamR3CmdStatsReset(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PVM pVM, PCDBGCVAR paArgs, unsigned cArgs, PDBGCVAR pResult);
160#endif
161
162
163/*******************************************************************************
164* Global Variables *
165*******************************************************************************/
166#ifdef VBOX_WITH_DEBUGGER
167/** Pattern argument. */
168static const DBGCVARDESC g_aArgPat[] =
169{
170 /* cTimesMin, cTimesMax, enmCategory, fFlags, pszName, pszDescription */
171 { 0, 1, DBGCVAR_CAT_STRING, 0, "pattern", "Which samples the command shall be applied to. Use '*' as wildcard. Use ';' to separate expression." }
172};
173
174/** Command descriptors. */
175static const DBGCCMD g_aCmds[] =
176{
177 /* pszCmd, cArgsMin, cArgsMax, paArgDesc, cArgDescs, pResultDesc, fFlags, pfnHandler pszSyntax, ....pszDescription */
178 { "stats", 0, 1, &g_aArgPat[0], RT_ELEMENTS(g_aArgPat), NULL, 0, stamR3CmdStats, "[pattern]", "Display statistics." },
179 { "statsreset", 0, 1, &g_aArgPat[0], RT_ELEMENTS(g_aArgPat), NULL, 0, stamR3CmdStatsReset,"[pattern]", "Resets statistics." }
180};
181#endif
182
183
184/**
185 * The GVMM mapping records.
186 */
187static const STAMR0SAMPLE g_aGVMMStats[] =
188{
189 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cHaltCalls), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/HaltCalls", "The number of calls to GVMMR0SchedHalt." },
190 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cHaltBlocking), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/HaltBlocking", "The number of times we did go to sleep in GVMMR0SchedHalt." },
191 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cHaltTimeouts), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/HaltTimeouts", "The number of times we timed out in GVMMR0SchedHalt." },
192 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cHaltNotBlocking), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/HaltNotBlocking", "The number of times we didn't go to sleep in GVMMR0SchedHalt." },
193 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cHaltWakeUps), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/HaltWakeUps", "The number of wake ups done during GVMMR0SchedHalt." },
194 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cWakeUpCalls), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/WakeUpCalls", "The number of calls to GVMMR0WakeUp." },
195 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cWakeUpNotHalted), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/WakeUpNotHalted", "The number of times the EMT thread wasn't actually halted when GVMMR0WakeUp was called." },
196 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cWakeUpWakeUps), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/WakeUpWakeUps", "The number of wake ups done during GVMMR0WakeUp (not counting the explicit one)." },
197 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cPokeCalls), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/PokeCalls", "The number of calls to GVMMR0Poke." },
198 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cPokeNotBusy), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/PokeNotBusy", "The number of times the EMT thread wasn't actually busy when GVMMR0Poke was called." },
199 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cPollCalls), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/PollCalls", "The number of calls to GVMMR0SchedPoll." },
200 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cPollHalts), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/PollHalts", "The number of times the EMT has halted in a GVMMR0SchedPoll call." },
201 { RT_UOFFSETOF(GVMMSTATS, SchedVM.cPollWakeUps), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/VM/PollWakeUps", "The number of wake ups done during GVMMR0SchedPoll." },
202
203 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cHaltCalls), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/HaltCalls", "The number of calls to GVMMR0SchedHalt." },
204 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cHaltBlocking), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/HaltBlocking", "The number of times we did go to sleep in GVMMR0SchedHalt." },
205 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cHaltTimeouts), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/HaltTimeouts", "The number of times we timed out in GVMMR0SchedHalt." },
206 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cHaltNotBlocking), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/HaltNotBlocking", "The number of times we didn't go to sleep in GVMMR0SchedHalt." },
207 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cHaltWakeUps), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/HaltWakeUps", "The number of wake ups done during GVMMR0SchedHalt." },
208 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cWakeUpCalls), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/WakeUpCalls", "The number of calls to GVMMR0WakeUp." },
209 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cWakeUpNotHalted), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/WakeUpNotHalted", "The number of times the EMT thread wasn't actually halted when GVMMR0WakeUp was called." },
210 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cWakeUpWakeUps), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/WakeUpWakeUps", "The number of wake ups done during GVMMR0WakeUp (not counting the explicit one)." },
211 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cPokeCalls), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/PokeCalls", "The number of calls to GVMMR0Poke." },
212 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cPokeNotBusy), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/PokeNotBusy", "The number of times the EMT thread wasn't actually busy when GVMMR0Poke was called." },
213 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cPollCalls), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/PollCalls", "The number of calls to GVMMR0SchedPoll." },
214 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cPollHalts), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/PollHalts", "The number of times the EMT has halted in a GVMMR0SchedPoll call." },
215 { RT_UOFFSETOF(GVMMSTATS, SchedSum.cPollWakeUps), STAMTYPE_U64_RESET, STAMUNIT_CALLS, "/GVMM/Sum/PollWakeUps", "The number of wake ups done during GVMMR0SchedPoll." },
216
217 { RT_UOFFSETOF(GVMMSTATS, cVMs), STAMTYPE_U32, STAMUNIT_CALLS, "/GVMM/VMs", "The number of VMs accessible to the caller." },
218 { RT_UOFFSETOF(GVMMSTATS, cEMTs), STAMTYPE_U32, STAMUNIT_CALLS, "/GVMM/EMTs", "The number of emulation threads." },
219};
220
221
222/**
223 * Initializes the STAM.
224 *
225 * @returns VBox status code.
226 * @param pVM The VM to operate on.
227 */
228VMMR3DECL(int) STAMR3InitUVM(PUVM pUVM)
229{
230 LogFlow(("STAMR3Init\n"));
231
232 /*
233 * Assert alignment and sizes.
234 */
235 AssertCompile(sizeof(pUVM->stam.s) <= sizeof(pUVM->stam.padding));
236 AssertRelease(sizeof(pUVM->stam.s) <= sizeof(pUVM->stam.padding));
237
238 /*
239 * Setup any fixed pointers and offsets.
240 */
241 int rc = RTSemRWCreate(&pUVM->stam.s.RWSem);
242 AssertRCReturn(rc, rc);
243
244 /*
245 * Register the ring-0 statistics (GVMM/GMM).
246 */
247 stamR3Ring0StatsRegisterU(pUVM);
248
249#ifdef VBOX_WITH_DEBUGGER
250 /*
251 * Register debugger commands.
252 */
253 static bool fRegisteredCmds = false;
254 if (!fRegisteredCmds)
255 {
256 int rc = DBGCRegisterCommands(&g_aCmds[0], RT_ELEMENTS(g_aCmds));
257 if (RT_SUCCESS(rc))
258 fRegisteredCmds = true;
259 }
260#endif
261
262 return VINF_SUCCESS;
263}
264
265
266/**
267 * Terminates the STAM.
268 *
269 * @param pUVM Pointer to the user mode VM structure.
270 */
271VMMR3DECL(void) STAMR3TermUVM(PUVM pUVM)
272{
273 /*
274 * Free used memory and the RWLock.
275 */
276 PSTAMDESC pCur = pUVM->stam.s.pHead;
277 while (pCur)
278 {
279 void *pvFree = pCur;
280 pCur = pCur->pNext;
281 RTMemFree(pvFree);
282 }
283 pUVM->stam.s.pHead = NULL;
284
285 Assert(pUVM->stam.s.RWSem != NIL_RTSEMRW);
286 RTSemRWDestroy(pUVM->stam.s.RWSem);
287 pUVM->stam.s.RWSem = NIL_RTSEMRW;
288}
289
290
291/**
292 * Registers a sample with the statistics mamanger.
293 *
294 * Statistics are maintained on a per VM basis and is normally registered
295 * during the VM init stage, but there is nothing preventing you from
296 * register them at runtime.
297 *
298 * Use STAMR3Deregister() to deregister statistics at runtime, however do
299 * not bother calling at termination time.
300 *
301 * It is not possible to register the same sample twice.
302 *
303 * @returns VBox status.
304 * @param pUVM Pointer to the user mode VM structure.
305 * @param pvSample Pointer to the sample.
306 * @param enmType Sample type. This indicates what pvSample is pointing at.
307 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
308 * @param pszName Sample name. The name is on this form "/<component>/<sample>".
309 * Further nesting is possible.
310 * @param enmUnit Sample unit.
311 * @param pszDesc Sample description.
312 */
313VMMR3DECL(int) STAMR3RegisterU(PUVM pUVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
314{
315 AssertReturn(enmType != STAMTYPE_CALLBACK, VERR_INVALID_PARAMETER);
316 return stamR3RegisterU(pUVM, pvSample, NULL, NULL, enmType, enmVisibility, pszName, enmUnit, pszDesc);
317}
318
319
320/**
321 * Registers a sample with the statistics mamanger.
322 *
323 * Statistics are maintained on a per VM basis and is normally registered
324 * during the VM init stage, but there is nothing preventing you from
325 * register them at runtime.
326 *
327 * Use STAMR3Deregister() to deregister statistics at runtime, however do
328 * not bother calling at termination time.
329 *
330 * It is not possible to register the same sample twice.
331 *
332 * @returns VBox status.
333 * @param pVM The VM handle.
334 * @param pvSample Pointer to the sample.
335 * @param enmType Sample type. This indicates what pvSample is pointing at.
336 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
337 * @param pszName Sample name. The name is on this form "/<component>/<sample>".
338 * Further nesting is possible.
339 * @param enmUnit Sample unit.
340 * @param pszDesc Sample description.
341 */
342VMMR3DECL(int) STAMR3Register(PVM pVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
343{
344 AssertReturn(enmType != STAMTYPE_CALLBACK, VERR_INVALID_PARAMETER);
345 return stamR3RegisterU(pVM->pUVM, pvSample, NULL, NULL, enmType, enmVisibility, pszName, enmUnit, pszDesc);
346}
347
348
349/**
350 * Same as STAMR3RegisterU except that the name is specified in a
351 * RTStrPrintf like fashion.
352 *
353 * @returns VBox status.
354 * @param pUVM Pointer to the user mode VM structure.
355 * @param pvSample Pointer to the sample.
356 * @param enmType Sample type. This indicates what pvSample is pointing at.
357 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
358 * @param enmUnit Sample unit.
359 * @param pszDesc Sample description.
360 * @param pszName The sample name format string.
361 * @param ... Arguments to the format string.
362 */
363VMMR3DECL(int) STAMR3RegisterFU(PUVM pUVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
364 const char *pszDesc, const char *pszName, ...)
365{
366 va_list args;
367 va_start(args, pszName);
368 int rc = STAMR3RegisterVU(pUVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
369 va_end(args);
370 return rc;
371}
372
373
374/**
375 * Same as STAMR3Register except that the name is specified in a
376 * RTStrPrintf like fashion.
377 *
378 * @returns VBox status.
379 * @param pVM The VM handle.
380 * @param pvSample Pointer to the sample.
381 * @param enmType Sample type. This indicates what pvSample is pointing at.
382 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
383 * @param enmUnit Sample unit.
384 * @param pszDesc Sample description.
385 * @param pszName The sample name format string.
386 * @param ... Arguments to the format string.
387 */
388VMMR3DECL(int) STAMR3RegisterF(PVM pVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
389 const char *pszDesc, const char *pszName, ...)
390{
391 va_list args;
392 va_start(args, pszName);
393 int rc = STAMR3RegisterVU(pVM->pUVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
394 va_end(args);
395 return rc;
396}
397
398
399/**
400 * Same as STAMR3Register except that the name is specified in a
401 * RTStrPrintfV like fashion.
402 *
403 * @returns VBox status.
404 * @param pVM The VM handle.
405 * @param pvSample Pointer to the sample.
406 * @param enmType Sample type. This indicates what pvSample is pointing at.
407 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
408 * @param enmUnit Sample unit.
409 * @param pszDesc Sample description.
410 * @param pszName The sample name format string.
411 * @param args Arguments to the format string.
412 */
413VMMR3DECL(int) STAMR3RegisterVU(PUVM pUVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
414 const char *pszDesc, const char *pszName, va_list args)
415{
416 AssertReturn(enmType != STAMTYPE_CALLBACK, VERR_INVALID_PARAMETER);
417
418 char *pszFormattedName;
419 RTStrAPrintfV(&pszFormattedName, pszName, args);
420 if (!pszFormattedName)
421 return VERR_NO_MEMORY;
422
423 int rc = STAMR3RegisterU(pUVM, pvSample, enmType, enmVisibility, pszFormattedName, enmUnit, pszDesc);
424 RTStrFree(pszFormattedName);
425 return rc;
426}
427
428
429/**
430 * Same as STAMR3Register except that the name is specified in a
431 * RTStrPrintfV like fashion.
432 *
433 * @returns VBox status.
434 * @param pVM The VM handle.
435 * @param pvSample Pointer to the sample.
436 * @param enmType Sample type. This indicates what pvSample is pointing at.
437 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
438 * @param enmUnit Sample unit.
439 * @param pszDesc Sample description.
440 * @param pszName The sample name format string.
441 * @param args Arguments to the format string.
442 */
443VMMR3DECL(int) STAMR3RegisterV(PVM pVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
444 const char *pszDesc, const char *pszName, va_list args)
445{
446 return STAMR3RegisterVU(pVM->pUVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, args);
447}
448
449
450/**
451 * Similar to STAMR3Register except for the two callbacks, the implied type (STAMTYPE_CALLBACK),
452 * and name given in an RTStrPrintf like fashion.
453 *
454 * @returns VBox status.
455 * @param pVM The VM handle.
456 * @param pvSample Pointer to the sample.
457 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
458 * @param enmUnit Sample unit.
459 * @param pfnReset Callback for resetting the sample. NULL should be used if the sample can't be reset.
460 * @param pfnPrint Print the sample.
461 * @param pszDesc Sample description.
462 * @param pszName The sample name format string.
463 * @param ... Arguments to the format string.
464 * @remark There is currently no device or driver variant of this API. Add one if it should become necessary!
465 */
466VMMR3DECL(int) STAMR3RegisterCallback(PVM pVM, void *pvSample, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
467 PFNSTAMR3CALLBACKRESET pfnReset, PFNSTAMR3CALLBACKPRINT pfnPrint,
468 const char *pszDesc, const char *pszName, ...)
469{
470 va_list args;
471 va_start(args, pszName);
472 int rc = STAMR3RegisterCallbackV(pVM, pvSample, enmVisibility, enmUnit, pfnReset, pfnPrint, pszDesc, pszName, args);
473 va_end(args);
474 return rc;
475}
476
477
478/**
479 * Same as STAMR3RegisterCallback() except for the ellipsis which is a va_list here.
480 *
481 * @returns VBox status.
482 * @param pVM The VM handle.
483 * @param pvSample Pointer to the sample.
484 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
485 * @param enmUnit Sample unit.
486 * @param pfnReset Callback for resetting the sample. NULL should be used if the sample can't be reset.
487 * @param pfnPrint Print the sample.
488 * @param pszDesc Sample description.
489 * @param pszName The sample name format string.
490 * @param args Arguments to the format string.
491 * @remark There is currently no device or driver variant of this API. Add one if it should become necessary!
492 */
493VMMR3DECL(int) STAMR3RegisterCallbackV(PVM pVM, void *pvSample, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
494 PFNSTAMR3CALLBACKRESET pfnReset, PFNSTAMR3CALLBACKPRINT pfnPrint,
495 const char *pszDesc, const char *pszName, va_list args)
496{
497 char *pszFormattedName;
498 RTStrAPrintfV(&pszFormattedName, pszName, args);
499 if (!pszFormattedName)
500 return VERR_NO_MEMORY;
501
502 int rc = stamR3RegisterU(pVM->pUVM, pvSample, pfnReset, pfnPrint, STAMTYPE_CALLBACK, enmVisibility, pszFormattedName, enmUnit, pszDesc);
503 RTStrFree(pszFormattedName);
504 return rc;
505}
506
507
508/**
509 * Divide the strings into sub-strings using '/' as delimiter
510 * and then compare them in strcmp fashion.
511 *
512 * @returns Difference.
513 * @retval 0 if equal.
514 * @retval < 0 if psz1 is less than psz2.
515 * @retval > 0 if psz1 greater than psz2.
516 *
517 * @param psz1 The first string.
518 * @param psz2 The second string.
519 */
520static int stamR3SlashCompare(const char *psz1, const char *psz2)
521{
522 for (;;)
523 {
524 unsigned int ch1 = *psz1++;
525 unsigned int ch2 = *psz2++;
526 if (ch1 != ch2)
527 {
528 /* slash is end-of-sub-string, so it trumps everything but '\0'. */
529 if (ch1 == '/')
530 return ch2 ? -1 : 1;
531 if (ch2 == '/')
532 return ch1 ? 1 : -1;
533 return ch1 - ch2;
534 }
535
536 /* done? */
537 if (ch1 == '\0')
538 return 0;
539 }
540}
541
542
543/**
544 * Internal worker for the different register calls.
545 *
546 * @returns VBox status.
547 * @param pUVM Pointer to the user mode VM structure.
548 * @param pvSample Pointer to the sample.
549 * @param pfnReset Callback for resetting the sample. NULL should be used if the sample can't be reset.
550 * @param pfnPrint Print the sample.
551 * @param enmType Sample type. This indicates what pvSample is pointing at.
552 * @param enmVisibility Visibility type specifying whether unused statistics should be visible or not.
553 * @param enmUnit Sample unit.
554 * @param pszDesc Sample description.
555 * @param pszName The sample name format string.
556 * @param args Arguments to the format string.
557 * @remark There is currently no device or driver variant of this API. Add one if it should become necessary!
558 */
559static int stamR3RegisterU(PUVM pUVM, void *pvSample, PFNSTAMR3CALLBACKRESET pfnReset, PFNSTAMR3CALLBACKPRINT pfnPrint,
560 STAMTYPE enmType, STAMVISIBILITY enmVisibility, const char *pszName, STAMUNIT enmUnit, const char *pszDesc)
561{
562 STAM_LOCK_WR(pUVM);
563
564 /*
565 * Check if exists.
566 */
567 PSTAMDESC pPrev = NULL;
568 PSTAMDESC pCur = pUVM->stam.s.pHead;
569 while (pCur)
570 {
571 int iDiff = strcmp(pCur->pszName, pszName);
572 /* passed it */
573 if (iDiff > 0)
574 break;
575 /* found it. */
576 if (!iDiff)
577 {
578 STAM_UNLOCK_WR(pUVM);
579 AssertMsgFailed(("Duplicate sample name: %s\n", pszName));
580 return VERR_ALREADY_EXISTS;
581 }
582
583 /* next */
584 pPrev = pCur;
585 pCur = pCur->pNext;
586 }
587
588 /*
589 * Check that the name doesn't screw up sorting order when taking
590 * slashes into account. The QT4 GUI makes some assumptions.
591 * Problematic chars are: !"#$%&'()*+,-.
592 */
593 Assert(pszName[0] == '/');
594 if (pPrev)
595 Assert(stamR3SlashCompare(pPrev->pszName, pszName) < 0);
596 if (pCur)
597 Assert(stamR3SlashCompare(pCur->pszName, pszName) > 0);
598
599 /*
600 * Create a new node and insert it at the current location.
601 */
602 int rc;
603 size_t cchName = strlen(pszName) + 1;
604 size_t cchDesc = pszDesc ? strlen(pszDesc) + 1 : 0;
605 PSTAMDESC pNew = (PSTAMDESC)RTMemAlloc(sizeof(*pNew) + cchName + cchDesc);
606 if (pNew)
607 {
608 pNew->pszName = (char *)memcpy((char *)(pNew + 1), pszName, cchName);
609 pNew->enmType = enmType;
610 pNew->enmVisibility = enmVisibility;
611 if (enmType != STAMTYPE_CALLBACK)
612 pNew->u.pv = pvSample;
613 else
614 {
615 pNew->u.Callback.pvSample = pvSample;
616 pNew->u.Callback.pfnReset = pfnReset;
617 pNew->u.Callback.pfnPrint = pfnPrint;
618 }
619 pNew->enmUnit = enmUnit;
620 pNew->pszDesc = NULL;
621 if (pszDesc)
622 pNew->pszDesc = (char *)memcpy((char *)(pNew + 1) + cchName, pszDesc, cchDesc);
623
624 pNew->pNext = pCur;
625 if (pPrev)
626 pPrev->pNext = pNew;
627 else
628 pUVM->stam.s.pHead = pNew;
629
630 stamR3ResetOne(pNew, pUVM->pVM);
631 rc = VINF_SUCCESS;
632 }
633 else
634 rc = VERR_NO_MEMORY;
635
636 STAM_UNLOCK_WR(pUVM);
637 return rc;
638}
639
640
641/**
642 * Deregisters a sample previously registered by STAR3Register().
643 *
644 * This is intended used for devices which can be unplugged and for
645 * temporary samples.
646 *
647 * @returns VBox status.
648 * @param pUVM Pointer to the user mode VM structure.
649 * @param pvSample Pointer to the sample registered with STAMR3Register().
650 */
651VMMR3DECL(int) STAMR3DeregisterU(PUVM pUVM, void *pvSample)
652{
653 STAM_LOCK_WR(pUVM);
654
655 /*
656 * Search for it.
657 */
658 int rc = VERR_INVALID_HANDLE;
659 PSTAMDESC pPrev = NULL;
660 PSTAMDESC pCur = pUVM->stam.s.pHead;
661 while (pCur)
662 {
663 if (pCur->u.pv == pvSample)
664 {
665 void *pvFree = pCur;
666 pCur = pCur->pNext;
667 if (pPrev)
668 pPrev->pNext = pCur;
669 else
670 pUVM->stam.s.pHead = pCur;
671
672 RTMemFree(pvFree);
673 rc = VINF_SUCCESS;
674 continue;
675 }
676
677 /* next */
678 pPrev = pCur;
679 pCur = pCur->pNext;
680 }
681
682 STAM_UNLOCK_WR(pUVM);
683 return rc;
684}
685
686
687/**
688 * Deregisters a sample previously registered by STAR3Register().
689 *
690 * This is intended used for devices which can be unplugged and for
691 * temporary samples.
692 *
693 * @returns VBox status.
694 * @param pVM The VM handle.
695 * @param pvSample Pointer to the sample registered with STAMR3Register().
696 */
697VMMR3DECL(int) STAMR3Deregister(PVM pVM, void *pvSample)
698{
699 return STAMR3DeregisterU(pVM->pUVM, pvSample);
700}
701
702
703/**
704 * Resets statistics for the specified VM.
705 * It's possible to select a subset of the samples.
706 *
707 * @returns VBox status. (Basically, it cannot fail.)
708 * @param pVM The VM handle.
709 * @param pszPat The name matching pattern. See somewhere_where_this_is_described_in_detail.
710 * If NULL all samples are reset.
711 * @remarks Don't confuse this with the other 'XYZR3Reset' methods, it's not called at VM reset.
712 */
713VMMR3DECL(int) STAMR3ResetU(PUVM pUVM, const char *pszPat)
714{
715 int rc = VINF_SUCCESS;
716
717 /* ring-0 */
718 GVMMRESETSTATISTICSSREQ GVMMReq;
719 //GMMRESETSTATISTICSSREQ GMMReq;
720 bool fGVMMMatched = !pszPat || !*pszPat;
721 //bool fGMMMatched = fGVMMMatched;
722 if (fGVMMMatched)
723 memset(&GVMMReq.Stats, 0xff, sizeof(GVMMReq.Stats));
724 else
725 {
726 char *pszCopy;
727 unsigned cExpressions;
728 char **papszExpressions = stamR3SplitPattern(pszPat, &cExpressions, &pszCopy);
729 if (!papszExpressions)
730 return VERR_NO_MEMORY;
731
732 /* GVMM */
733 memset(&GVMMReq.Stats, 0, sizeof(GVMMReq.Stats));
734 for (unsigned i = 0; i < RT_ELEMENTS(g_aGVMMStats); i++)
735 if (stamR3MultiMatch(papszExpressions, cExpressions, NULL, g_aGVMMStats[i].pszName))
736 {
737 *((uint8_t *)&GVMMReq.Stats + g_aGVMMStats[i].offVar) = 0xff;
738 fGVMMMatched = true;
739 }
740
741 /* GMM */
742// memset(&GMMReq.Stats, 0, sizeof(GMMReq.Stats));
743// for (unsigned i = 0; i < RT_ELEMENTS(g_aGMMStats); i++)
744// if (stamR3MultiMatch(papszExpressions, cExpressions, NULL, g_aGMMStats[i].pszName))
745// {
746// *((uint8_t *)&GMMReq.Stats + g_aGMMStats[i].offVar) = 0xff;
747// fGMMMatched = true;
748// }
749
750 RTMemTmpFree(papszExpressions);
751 RTStrFree(pszCopy);
752 }
753
754 STAM_LOCK_WR(pUVM);
755 if (fGVMMMatched)
756 {
757 PVM pVM = pUVM->pVM;
758 GVMMReq.Hdr.cbReq = sizeof(GVMMReq);
759 GVMMReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
760 GVMMReq.pSession = pVM->pSession;
761 rc = SUPCallVMMR0Ex(pVM->pVMR0, NIL_VMCPUID, VMMR0_DO_GVMM_RESET_STATISTICS, 0, &GVMMReq.Hdr);
762 }
763
764// if (fGMMMatched)
765// {
766// PVM pVM = pUVM->pVM;
767// GMMReq.Hdr.cbReq = sizeof(Req);
768// GMMReq.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
769// GMMReq.pSession = pVM->pSession;
770// rc = SUPCallVMMR0Ex(pVM->pVMR0, VMMR0_DO_GMM_RESET_STATISTICS, 0, &Req.Hdr);
771// }
772
773 /* and the reset */
774 stamR3EnumU(pUVM, pszPat, false /* fUpdateRing0 */, stamR3ResetOne, pUVM->pVM);
775
776 STAM_UNLOCK_WR(pUVM);
777 return rc;
778}
779
780/**
781 * Resets statistics for the specified VM.
782 * It's possible to select a subset of the samples.
783 *
784 * @returns VBox status. (Basically, it cannot fail.)
785 * @param pVM The VM handle.
786 * @param pszPat The name matching pattern. See somewhere_where_this_is_described_in_detail.
787 * If NULL all samples are reset.
788 * @remarks Don't confuse this with the other 'XYZR3Reset' methods, it's not called at VM reset.
789 */
790VMMR3DECL(int) STAMR3Reset(PVM pVM, const char *pszPat)
791{
792 return STAMR3ResetU(pVM->pUVM, pszPat);
793}
794
795
796/**
797 * Resets one statistics sample.
798 * Callback for stamR3EnumU().
799 *
800 * @returns VINF_SUCCESS
801 * @param pDesc Pointer to the current descriptor.
802 * @param pvArg User argument - The VM handle.
803 */
804static int stamR3ResetOne(PSTAMDESC pDesc, void *pvArg)
805{
806 switch (pDesc->enmType)
807 {
808 case STAMTYPE_COUNTER:
809 ASMAtomicXchgU64(&pDesc->u.pCounter->c, 0);
810 break;
811
812 case STAMTYPE_PROFILE:
813 case STAMTYPE_PROFILE_ADV:
814 ASMAtomicXchgU64(&pDesc->u.pProfile->cPeriods, 0);
815 ASMAtomicXchgU64(&pDesc->u.pProfile->cTicks, 0);
816 ASMAtomicXchgU64(&pDesc->u.pProfile->cTicksMax, 0);
817 ASMAtomicXchgU64(&pDesc->u.pProfile->cTicksMin, ~0);
818 break;
819
820 case STAMTYPE_RATIO_U32_RESET:
821 ASMAtomicXchgU32(&pDesc->u.pRatioU32->u32A, 0);
822 ASMAtomicXchgU32(&pDesc->u.pRatioU32->u32B, 0);
823 break;
824
825 case STAMTYPE_CALLBACK:
826 if (pDesc->u.Callback.pfnReset)
827 pDesc->u.Callback.pfnReset((PVM)pvArg, pDesc->u.Callback.pvSample);
828 break;
829
830 case STAMTYPE_U8_RESET:
831 case STAMTYPE_X8_RESET:
832 ASMAtomicXchgU8(pDesc->u.pu8, 0);
833 break;
834
835 case STAMTYPE_U16_RESET:
836 case STAMTYPE_X16_RESET:
837 ASMAtomicXchgU16(pDesc->u.pu16, 0);
838 break;
839
840 case STAMTYPE_U32_RESET:
841 case STAMTYPE_X32_RESET:
842 ASMAtomicXchgU32(pDesc->u.pu32, 0);
843 break;
844
845 case STAMTYPE_U64_RESET:
846 case STAMTYPE_X64_RESET:
847 ASMAtomicXchgU64(pDesc->u.pu64, 0);
848 break;
849
850 /* These are custom and will not be touched. */
851 case STAMTYPE_U8:
852 case STAMTYPE_X8:
853 case STAMTYPE_U16:
854 case STAMTYPE_X16:
855 case STAMTYPE_U32:
856 case STAMTYPE_X32:
857 case STAMTYPE_U64:
858 case STAMTYPE_X64:
859 case STAMTYPE_RATIO_U32:
860 break;
861
862 default:
863 AssertMsgFailed(("enmType=%d\n", pDesc->enmType));
864 break;
865 }
866 NOREF(pvArg);
867 return VINF_SUCCESS;
868}
869
870
871/**
872 * Get a snapshot of the statistics.
873 * It's possible to select a subset of the samples.
874 *
875 * @returns VBox status. (Basically, it cannot fail.)
876 * @param pUVM Pointer to the user mode VM structure.
877 * @param pszPat The name matching pattern. See somewhere_where_this_is_described_in_detail.
878 * If NULL all samples are reset.
879 * @param fWithDesc Whether to include the descriptions.
880 * @param ppszSnapshot Where to store the pointer to the snapshot data.
881 * The format of the snapshot should be XML, but that will have to be discussed
882 * when this function is implemented.
883 * The returned pointer must be freed by calling STAMR3SnapshotFree().
884 * @param pcchSnapshot Where to store the size of the snapshot data. (Excluding the trailing '\0')
885 */
886VMMR3DECL(int) STAMR3SnapshotU(PUVM pUVM, const char *pszPat, char **ppszSnapshot, size_t *pcchSnapshot, bool fWithDesc)
887{
888 STAMR3SNAPSHOTONE State = { NULL, NULL, NULL, pUVM->pVM, 0, VINF_SUCCESS, fWithDesc };
889
890 /*
891 * Write the XML header.
892 */
893 /** @todo Make this proper & valid XML. */
894 stamR3SnapshotPrintf(&State, "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n");
895
896 /*
897 * Write the content.
898 */
899 stamR3SnapshotPrintf(&State, "<Statistics>\n");
900 STAM_LOCK_RD(pUVM);
901 int rc = stamR3EnumU(pUVM, pszPat, true /* fUpdateRing0 */, stamR3SnapshotOne, &State);
902 STAM_UNLOCK_RD(pUVM);
903 stamR3SnapshotPrintf(&State, "</Statistics>\n");
904
905 if (RT_SUCCESS(rc))
906 rc = State.rc;
907 else
908 {
909 RTMemFree(State.pszStart);
910 State.pszStart = State.pszEnd = State.psz = NULL;
911 State.cbAllocated = 0;
912 }
913
914 /*
915 * Done.
916 */
917 *ppszSnapshot = State.pszStart;
918 if (pcchSnapshot)
919 *pcchSnapshot = State.psz - State.pszStart;
920 return rc;
921}
922
923
924/**
925 * Get a snapshot of the statistics.
926 * It's possible to select a subset of the samples.
927 *
928 * @returns VBox status. (Basically, it cannot fail.)
929 * @param pVM The VM handle.
930 * @param pszPat The name matching pattern. See somewhere_where_this_is_described_in_detail.
931 * If NULL all samples are reset.
932 * @param fWithDesc Whether to include the descriptions.
933 * @param ppszSnapshot Where to store the pointer to the snapshot data.
934 * The format of the snapshot should be XML, but that will have to be discussed
935 * when this function is implemented.
936 * The returned pointer must be freed by calling STAMR3SnapshotFree().
937 * @param pcchSnapshot Where to store the size of the snapshot data. (Excluding the trailing '\0')
938 */
939VMMR3DECL(int) STAMR3Snapshot(PVM pVM, const char *pszPat, char **ppszSnapshot, size_t *pcchSnapshot, bool fWithDesc)
940{
941 return STAMR3SnapshotU(pVM->pUVM, pszPat, ppszSnapshot, pcchSnapshot, fWithDesc);
942}
943
944
945/**
946 * stamR3EnumU callback employed by STAMR3Snapshot.
947 *
948 * @returns VBox status code, but it's interpreted as 0 == success / !0 == failure by enmR3Enum.
949 * @param pDesc The sample.
950 * @param pvArg The snapshot status structure.
951 */
952static int stamR3SnapshotOne(PSTAMDESC pDesc, void *pvArg)
953{
954 PSTAMR3SNAPSHOTONE pThis = (PSTAMR3SNAPSHOTONE)pvArg;
955
956 switch (pDesc->enmType)
957 {
958 case STAMTYPE_COUNTER:
959 if (pDesc->enmVisibility == STAMVISIBILITY_USED && pDesc->u.pCounter->c == 0)
960 return VINF_SUCCESS;
961 stamR3SnapshotPrintf(pThis, "<Counter c=\"%lld\"", pDesc->u.pCounter->c);
962 break;
963
964 case STAMTYPE_PROFILE:
965 case STAMTYPE_PROFILE_ADV:
966 if (pDesc->enmVisibility == STAMVISIBILITY_USED && pDesc->u.pProfile->cPeriods == 0)
967 return VINF_SUCCESS;
968 stamR3SnapshotPrintf(pThis, "<Profile cPeriods=\"%lld\" cTicks=\"%lld\" cTicksMin=\"%lld\" cTicksMax=\"%lld\"",
969 pDesc->u.pProfile->cPeriods, pDesc->u.pProfile->cTicks, pDesc->u.pProfile->cTicksMin,
970 pDesc->u.pProfile->cTicksMax);
971 break;
972
973 case STAMTYPE_RATIO_U32:
974 case STAMTYPE_RATIO_U32_RESET:
975 if (pDesc->enmVisibility == STAMVISIBILITY_USED && !pDesc->u.pRatioU32->u32A && !pDesc->u.pRatioU32->u32B)
976 return VINF_SUCCESS;
977 stamR3SnapshotPrintf(pThis, "<Ratio32 u32A=\"%lld\" u32B=\"%lld\"",
978 pDesc->u.pRatioU32->u32A, pDesc->u.pRatioU32->u32B);
979 break;
980
981 case STAMTYPE_CALLBACK:
982 {
983 char szBuf[512];
984 pDesc->u.Callback.pfnPrint(pThis->pVM, pDesc->u.Callback.pvSample, szBuf, sizeof(szBuf));
985 stamR3SnapshotPrintf(pThis, "<Callback val=\"%s\"", szBuf);
986 break;
987 }
988
989 case STAMTYPE_U8:
990 case STAMTYPE_U8_RESET:
991 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu8 == 0)
992 return VINF_SUCCESS;
993 stamR3SnapshotPrintf(pThis, "<U8 val=\"%u\"", *pDesc->u.pu8);
994 break;
995
996 case STAMTYPE_X8:
997 case STAMTYPE_X8_RESET:
998 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu8 == 0)
999 return VINF_SUCCESS;
1000 stamR3SnapshotPrintf(pThis, "<X8 val=\"%#x\"", *pDesc->u.pu8);
1001 break;
1002
1003 case STAMTYPE_U16:
1004 case STAMTYPE_U16_RESET:
1005 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu16 == 0)
1006 return VINF_SUCCESS;
1007 stamR3SnapshotPrintf(pThis, "<U16 val=\"%u\"", *pDesc->u.pu16);
1008 break;
1009
1010 case STAMTYPE_X16:
1011 case STAMTYPE_X16_RESET:
1012 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu16 == 0)
1013 return VINF_SUCCESS;
1014 stamR3SnapshotPrintf(pThis, "<X16 val=\"%#x\"", *pDesc->u.pu16);
1015 break;
1016
1017 case STAMTYPE_U32:
1018 case STAMTYPE_U32_RESET:
1019 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu32 == 0)
1020 return VINF_SUCCESS;
1021 stamR3SnapshotPrintf(pThis, "<U32 val=\"%u\"", *pDesc->u.pu32);
1022 break;
1023
1024 case STAMTYPE_X32:
1025 case STAMTYPE_X32_RESET:
1026 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu32 == 0)
1027 return VINF_SUCCESS;
1028 stamR3SnapshotPrintf(pThis, "<X32 val=\"%#x\"", *pDesc->u.pu32);
1029 break;
1030
1031 case STAMTYPE_U64:
1032 case STAMTYPE_U64_RESET:
1033 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu64 == 0)
1034 return VINF_SUCCESS;
1035 stamR3SnapshotPrintf(pThis, "<U64 val=\"%llu\"", *pDesc->u.pu64);
1036 break;
1037
1038 case STAMTYPE_X64:
1039 case STAMTYPE_X64_RESET:
1040 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu64 == 0)
1041 return VINF_SUCCESS;
1042 stamR3SnapshotPrintf(pThis, "<X64 val=\"%#llx\"", *pDesc->u.pu64);
1043 break;
1044
1045 default:
1046 AssertMsgFailed(("%d\n", pDesc->enmType));
1047 return 0;
1048 }
1049
1050 stamR3SnapshotPrintf(pThis, " unit=\"%s\"", STAMR3GetUnit(pDesc->enmUnit));
1051
1052 switch (pDesc->enmVisibility)
1053 {
1054 default:
1055 case STAMVISIBILITY_ALWAYS:
1056 break;
1057 case STAMVISIBILITY_USED:
1058 stamR3SnapshotPrintf(pThis, " vis=\"used\"");
1059 break;
1060 case STAMVISIBILITY_NOT_GUI:
1061 stamR3SnapshotPrintf(pThis, " vis=\"not-gui\"");
1062 break;
1063 }
1064
1065 stamR3SnapshotPrintf(pThis, " name=\"%s\"", pDesc->pszName);
1066
1067 if (pThis->fWithDesc && pDesc->pszDesc)
1068 {
1069 /*
1070 * The description is a bit tricky as it may include chars that
1071 * xml requires to be escaped.
1072 */
1073 const char *pszBadChar = strpbrk(pDesc->pszDesc, "&<>\"'");
1074 if (!pszBadChar)
1075 return stamR3SnapshotPrintf(pThis, " desc=\"%s\"/>\n", pDesc->pszDesc);
1076
1077 stamR3SnapshotPrintf(pThis, " desc=\"");
1078 const char *pszCur = pDesc->pszDesc;
1079 do
1080 {
1081 stamR3SnapshotPrintf(pThis, "%.*s", pszBadChar - pszCur, pszCur);
1082 switch (*pszBadChar)
1083 {
1084 case '&': stamR3SnapshotPrintf(pThis, "&amp;"); break;
1085 case '<': stamR3SnapshotPrintf(pThis, "&lt;"); break;
1086 case '>': stamR3SnapshotPrintf(pThis, "&gt;"); break;
1087 case '"': stamR3SnapshotPrintf(pThis, "&quot;"); break;
1088 case '\'': stamR3SnapshotPrintf(pThis, "&apos;"); break;
1089 default: AssertMsgFailed(("%c", *pszBadChar)); break;
1090 }
1091 pszCur = pszBadChar + 1;
1092 pszBadChar = strpbrk(pszCur, "&<>\"'");
1093 } while (pszBadChar);
1094 return stamR3SnapshotPrintf(pThis, "%s\"/>\n", pszCur);
1095 }
1096 return stamR3SnapshotPrintf(pThis, "/>\n");
1097}
1098
1099
1100/**
1101 * Output callback for stamR3SnapshotPrintf.
1102 *
1103 * @returns number of bytes written.
1104 * @param pvArg The snapshot status structure.
1105 * @param pach Pointer to an array of characters (bytes).
1106 * @param cch The number or chars (bytes) to write from the array.
1107 */
1108static DECLCALLBACK(size_t) stamR3SnapshotOutput(void *pvArg, const char *pach, size_t cch)
1109{
1110 PSTAMR3SNAPSHOTONE pThis = (PSTAMR3SNAPSHOTONE)pvArg;
1111
1112 /*
1113 * Make sure we've got space for it.
1114 */
1115 if (RT_UNLIKELY((uintptr_t)pThis->pszEnd - (uintptr_t)pThis->psz < cch + 1))
1116 {
1117 if (RT_FAILURE(pThis->rc))
1118 return 0;
1119
1120 size_t cbNewSize = pThis->cbAllocated;
1121 if (cbNewSize > cch)
1122 cbNewSize *= 2;
1123 else
1124 cbNewSize += RT_ALIGN(cch + 1, 0x1000);
1125 char *pszNew = (char *)RTMemRealloc(pThis->pszStart, cbNewSize);
1126 if (!pszNew)
1127 {
1128 /*
1129 * Free up immediately, out-of-memory is bad news and this
1130 * isn't an important allocations / API.
1131 */
1132 pThis->rc = VERR_NO_MEMORY;
1133 RTMemFree(pThis->pszStart);
1134 pThis->pszStart = pThis->pszEnd = pThis->psz = NULL;
1135 pThis->cbAllocated = 0;
1136 return 0;
1137 }
1138
1139 pThis->psz = pszNew + (pThis->psz - pThis->pszStart);
1140 pThis->pszStart = pszNew;
1141 pThis->pszEnd = pszNew + cbNewSize;
1142 pThis->cbAllocated = cbNewSize;
1143 }
1144
1145 /*
1146 * Copy the chars to the buffer and terminate it.
1147 */
1148 memcpy(pThis->psz, pach, cch);
1149 pThis->psz += cch;
1150 *pThis->psz = '\0';
1151 return cch;
1152}
1153
1154
1155/**
1156 * Wrapper around RTStrFormatV for use by the snapshot API.
1157 *
1158 * @returns VBox status code.
1159 * @param pThis The snapshot status structure.
1160 * @param pszFormat The format string.
1161 * @param ... Optional arguments.
1162 */
1163static int stamR3SnapshotPrintf(PSTAMR3SNAPSHOTONE pThis, const char *pszFormat, ...)
1164{
1165 va_list va;
1166 va_start(va, pszFormat);
1167 RTStrFormatV(stamR3SnapshotOutput, pThis, NULL, NULL, pszFormat, va);
1168 va_end(va);
1169 return pThis->rc;
1170}
1171
1172
1173/**
1174 * Releases a statistics snapshot returned by STAMR3Snapshot().
1175 *
1176 * @returns VBox status.
1177 * @param pUVM Pointer to the user mode VM structure.
1178 * @param pszSnapshot The snapshot data pointer returned by STAMR3Snapshot().
1179 * NULL is allowed.
1180 */
1181VMMR3DECL(int) STAMR3SnapshotFreeU(PUVM pUVM, char *pszSnapshot)
1182{
1183 if (!pszSnapshot)
1184 RTMemFree(pszSnapshot);
1185 return VINF_SUCCESS;
1186}
1187
1188
1189/**
1190 * Releases a statistics snapshot returned by STAMR3Snapshot().
1191 *
1192 * @returns VBox status.
1193 * @param pVM The VM handle.
1194 * @param pszSnapshot The snapshot data pointer returned by STAMR3Snapshot().
1195 * NULL is allowed.
1196 */
1197VMMR3DECL(int) STAMR3SnapshotFree(PVM pVM, char *pszSnapshot)
1198{
1199 return STAMR3SnapshotFreeU(pVM->pUVM, pszSnapshot);
1200}
1201
1202
1203/**
1204 * Dumps the selected statistics to the log.
1205 *
1206 * @returns VBox status.
1207 * @param pUVM Pointer to the user mode VM structure.
1208 * @param pszPat The name matching pattern. See somewhere_where_this_is_described_in_detail.
1209 * If NULL all samples are written to the log.
1210 */
1211VMMR3DECL(int) STAMR3DumpU(PUVM pUVM, const char *pszPat)
1212{
1213 STAMR3PRINTONEARGS Args;
1214 Args.pVM = pUVM->pVM;
1215 Args.pvArg = NULL;
1216 Args.pfnPrintf = stamR3EnumLogPrintf;
1217
1218 STAM_LOCK_RD(pUVM);
1219 stamR3EnumU(pUVM, pszPat, true /* fUpdateRing0 */, stamR3PrintOne, &Args);
1220 STAM_UNLOCK_RD(pUVM);
1221 return VINF_SUCCESS;
1222}
1223
1224
1225/**
1226 * Dumps the selected statistics to the log.
1227 *
1228 * @returns VBox status.
1229 * @param pVM The VM handle.
1230 * @param pszPat The name matching pattern. See somewhere_where_this_is_described_in_detail.
1231 * If NULL all samples are written to the log.
1232 */
1233VMMR3DECL(int) STAMR3Dump(PVM pVM, const char *pszPat)
1234{
1235 return STAMR3DumpU(pVM->pUVM, pszPat);
1236}
1237
1238
1239/**
1240 * Prints to the log.
1241 *
1242 * @param pArgs Pointer to the print one argument structure.
1243 * @param pszFormat Format string.
1244 * @param ... Format arguments.
1245 */
1246static DECLCALLBACK(void) stamR3EnumLogPrintf(PSTAMR3PRINTONEARGS pArgs, const char *pszFormat, ...)
1247{
1248 va_list va;
1249 va_start(va, pszFormat);
1250 RTLogPrintfV(pszFormat, va);
1251 va_end(va);
1252 NOREF(pArgs);
1253}
1254
1255
1256/**
1257 * Dumps the selected statistics to the release log.
1258 *
1259 * @returns VBox status.
1260 * @param pUVM Pointer to the user mode VM structure.
1261 * @param pszPat The name matching pattern. See somewhere_where_this_is_described_in_detail.
1262 * If NULL all samples are written to the log.
1263 */
1264VMMR3DECL(int) STAMR3DumpToReleaseLogU(PUVM pUVM, const char *pszPat)
1265{
1266 STAMR3PRINTONEARGS Args;
1267 Args.pVM = pUVM->pVM;
1268 Args.pvArg = NULL;
1269 Args.pfnPrintf = stamR3EnumRelLogPrintf;
1270
1271 STAM_LOCK_RD(pUVM);
1272 stamR3EnumU(pUVM, pszPat, true /* fUpdateRing0 */, stamR3PrintOne, &Args);
1273 STAM_UNLOCK_RD(pUVM);
1274 return VINF_SUCCESS;
1275}
1276
1277
1278/**
1279 * Dumps the selected statistics to the release log.
1280 *
1281 * @returns VBox status.
1282 * @param pVM The VM handle.
1283 * @param pszPat The name matching pattern. See somewhere_where_this_is_described_in_detail.
1284 * If NULL all samples are written to the log.
1285 */
1286VMMR3DECL(int) STAMR3DumpToReleaseLog(PVM pVM, const char *pszPat)
1287{
1288 return STAMR3DumpToReleaseLogU(pVM->pUVM, pszPat);
1289}
1290
1291
1292/**
1293 * Prints to the release log.
1294 *
1295 * @param pArgs Pointer to the print one argument structure.
1296 * @param pszFormat Format string.
1297 * @param ... Format arguments.
1298 */
1299static DECLCALLBACK(void) stamR3EnumRelLogPrintf(PSTAMR3PRINTONEARGS pArgs, const char *pszFormat, ...)
1300{
1301 va_list va;
1302 va_start(va, pszFormat);
1303 RTLogRelPrintfV(pszFormat, va);
1304 va_end(va);
1305 NOREF(pArgs);
1306}
1307
1308
1309/**
1310 * Prints the selected statistics to standard out.
1311 *
1312 * @returns VBox status.
1313 * @param pVM The VM handle.
1314 * @param pszPat The name matching pattern. See somewhere_where_this_is_described_in_detail.
1315 * If NULL all samples are reset.
1316 */
1317VMMR3DECL(int) STAMR3PrintU(PUVM pUVM, const char *pszPat)
1318{
1319 STAMR3PRINTONEARGS Args;
1320 Args.pVM = pUVM->pVM;
1321 Args.pvArg = NULL;
1322 Args.pfnPrintf = stamR3EnumPrintf;
1323
1324 STAM_LOCK_RD(pUVM);
1325 stamR3EnumU(pUVM, pszPat, true /* fUpdateRing0 */, stamR3PrintOne, &Args);
1326 STAM_UNLOCK_RD(pUVM);
1327 return VINF_SUCCESS;
1328}
1329
1330
1331/**
1332 * Prints the selected statistics to standard out.
1333 *
1334 * @returns VBox status.
1335 * @param pVM The VM handle.
1336 * @param pszPat The name matching pattern. See somewhere_where_this_is_described_in_detail.
1337 * If NULL all samples are reset.
1338 */
1339VMMR3DECL(int) STAMR3Print(PVM pVM, const char *pszPat)
1340{
1341 return STAMR3PrintU(pVM->pUVM, pszPat);
1342}
1343
1344
1345/**
1346 * Prints to stdout.
1347 *
1348 * @param pArgs Pointer to the print one argument structure.
1349 * @param pszFormat Format string.
1350 * @param ... Format arguments.
1351 */
1352static DECLCALLBACK(void) stamR3EnumPrintf(PSTAMR3PRINTONEARGS pArgs, const char *pszFormat, ...)
1353{
1354 va_list va;
1355 va_start(va, pszFormat);
1356 RTPrintfV(pszFormat, va);
1357 va_end(va);
1358 NOREF(pArgs);
1359}
1360
1361
1362/**
1363 * Prints one sample.
1364 * Callback for stamR3EnumU().
1365 *
1366 * @returns VINF_SUCCESS
1367 * @param pDesc Pointer to the current descriptor.
1368 * @param pvArg User argument - STAMR3PRINTONEARGS.
1369 */
1370static int stamR3PrintOne(PSTAMDESC pDesc, void *pvArg)
1371{
1372 PSTAMR3PRINTONEARGS pArgs = (PSTAMR3PRINTONEARGS)pvArg;
1373
1374 switch (pDesc->enmType)
1375 {
1376 case STAMTYPE_COUNTER:
1377 if (pDesc->enmVisibility == STAMVISIBILITY_USED && pDesc->u.pCounter->c == 0)
1378 return VINF_SUCCESS;
1379
1380 pArgs->pfnPrintf(pArgs, "%-32s %8llu %s\n", pDesc->pszName, pDesc->u.pCounter->c, STAMR3GetUnit(pDesc->enmUnit));
1381 break;
1382
1383 case STAMTYPE_PROFILE:
1384 case STAMTYPE_PROFILE_ADV:
1385 {
1386 if (pDesc->enmVisibility == STAMVISIBILITY_USED && pDesc->u.pProfile->cPeriods == 0)
1387 return VINF_SUCCESS;
1388
1389 uint64_t u64 = pDesc->u.pProfile->cPeriods ? pDesc->u.pProfile->cPeriods : 1;
1390 pArgs->pfnPrintf(pArgs, "%-32s %8llu %s (%12llu ticks, %7llu times, max %9llu, min %7lld)\n", pDesc->pszName,
1391 pDesc->u.pProfile->cTicks / u64, STAMR3GetUnit(pDesc->enmUnit),
1392 pDesc->u.pProfile->cTicks, pDesc->u.pProfile->cPeriods, pDesc->u.pProfile->cTicksMax, pDesc->u.pProfile->cTicksMin);
1393 break;
1394 }
1395
1396 case STAMTYPE_RATIO_U32:
1397 case STAMTYPE_RATIO_U32_RESET:
1398 if (pDesc->enmVisibility == STAMVISIBILITY_USED && !pDesc->u.pRatioU32->u32A && !pDesc->u.pRatioU32->u32B)
1399 return VINF_SUCCESS;
1400 pArgs->pfnPrintf(pArgs, "%-32s %8u:%-8u %s\n", pDesc->pszName,
1401 pDesc->u.pRatioU32->u32A, pDesc->u.pRatioU32->u32B, STAMR3GetUnit(pDesc->enmUnit));
1402 break;
1403
1404 case STAMTYPE_CALLBACK:
1405 {
1406 char szBuf[512];
1407 pDesc->u.Callback.pfnPrint(pArgs->pVM, pDesc->u.Callback.pvSample, szBuf, sizeof(szBuf));
1408 pArgs->pfnPrintf(pArgs, "%-32s %s %s\n", pDesc->pszName, szBuf, STAMR3GetUnit(pDesc->enmUnit));
1409 break;
1410 }
1411
1412 case STAMTYPE_U8:
1413 case STAMTYPE_U8_RESET:
1414 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu8 == 0)
1415 return VINF_SUCCESS;
1416 pArgs->pfnPrintf(pArgs, "%-32s %8u %s\n", pDesc->pszName, *pDesc->u.pu8, STAMR3GetUnit(pDesc->enmUnit));
1417 break;
1418
1419 case STAMTYPE_X8:
1420 case STAMTYPE_X8_RESET:
1421 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu8 == 0)
1422 return VINF_SUCCESS;
1423 pArgs->pfnPrintf(pArgs, "%-32s %8x %s\n", pDesc->pszName, *pDesc->u.pu8, STAMR3GetUnit(pDesc->enmUnit));
1424 break;
1425
1426 case STAMTYPE_U16:
1427 case STAMTYPE_U16_RESET:
1428 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu16 == 0)
1429 return VINF_SUCCESS;
1430 pArgs->pfnPrintf(pArgs, "%-32s %8u %s\n", pDesc->pszName, *pDesc->u.pu16, STAMR3GetUnit(pDesc->enmUnit));
1431 break;
1432
1433 case STAMTYPE_X16:
1434 case STAMTYPE_X16_RESET:
1435 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu16 == 0)
1436 return VINF_SUCCESS;
1437 pArgs->pfnPrintf(pArgs, "%-32s %8x %s\n", pDesc->pszName, *pDesc->u.pu16, STAMR3GetUnit(pDesc->enmUnit));
1438 break;
1439
1440 case STAMTYPE_U32:
1441 case STAMTYPE_U32_RESET:
1442 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu32 == 0)
1443 return VINF_SUCCESS;
1444 pArgs->pfnPrintf(pArgs, "%-32s %8u %s\n", pDesc->pszName, *pDesc->u.pu32, STAMR3GetUnit(pDesc->enmUnit));
1445 break;
1446
1447 case STAMTYPE_X32:
1448 case STAMTYPE_X32_RESET:
1449 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu32 == 0)
1450 return VINF_SUCCESS;
1451 pArgs->pfnPrintf(pArgs, "%-32s %8x %s\n", pDesc->pszName, *pDesc->u.pu32, STAMR3GetUnit(pDesc->enmUnit));
1452 break;
1453
1454 case STAMTYPE_U64:
1455 case STAMTYPE_U64_RESET:
1456 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu64 == 0)
1457 return VINF_SUCCESS;
1458 pArgs->pfnPrintf(pArgs, "%-32s %8llu %s\n", pDesc->pszName, *pDesc->u.pu64, STAMR3GetUnit(pDesc->enmUnit));
1459 break;
1460
1461 case STAMTYPE_X64:
1462 case STAMTYPE_X64_RESET:
1463 if (pDesc->enmVisibility == STAMVISIBILITY_USED && *pDesc->u.pu64 == 0)
1464 return VINF_SUCCESS;
1465 pArgs->pfnPrintf(pArgs, "%-32s %8llx %s\n", pDesc->pszName, *pDesc->u.pu64, STAMR3GetUnit(pDesc->enmUnit));
1466 break;
1467
1468 default:
1469 AssertMsgFailed(("enmType=%d\n", pDesc->enmType));
1470 break;
1471 }
1472 NOREF(pvArg);
1473 return VINF_SUCCESS;
1474}
1475
1476
1477/**
1478 * Enumerate the statistics by the means of a callback function.
1479 *
1480 * @returns Whatever the callback returns.
1481 *
1482 * @param pUVM Pointer to the user mode VM structure.
1483 * @param pszPat The pattern to match samples.
1484 * @param pfnEnum The callback function.
1485 * @param pvUser The pvUser argument of the callback function.
1486 */
1487VMMR3DECL(int) STAMR3EnumU(PUVM pUVM, const char *pszPat, PFNSTAMR3ENUM pfnEnum, void *pvUser)
1488{
1489 STAMR3ENUMONEARGS Args;
1490 Args.pVM = pUVM->pVM;
1491 Args.pfnEnum = pfnEnum;
1492 Args.pvUser = pvUser;
1493
1494 STAM_LOCK_RD(pUVM);
1495 int rc = stamR3EnumU(pUVM, pszPat, true /* fUpdateRing0 */, stamR3EnumOne, &Args);
1496 STAM_UNLOCK_RD(pUVM);
1497 return rc;
1498}
1499
1500
1501/**
1502 * Enumerate the statistics by the means of a callback function.
1503 *
1504 * @returns Whatever the callback returns.
1505 *
1506 * @param pVM The VM handle.
1507 * @param pszPat The pattern to match samples.
1508 * @param pfnEnum The callback function.
1509 * @param pvUser The pvUser argument of the callback function.
1510 */
1511VMMR3DECL(int) STAMR3Enum(PVM pVM, const char *pszPat, PFNSTAMR3ENUM pfnEnum, void *pvUser)
1512{
1513 return STAMR3EnumU(pVM->pUVM, pszPat, pfnEnum, pvUser);
1514}
1515
1516
1517/**
1518 * Callback function for STARTR3Enum().
1519 *
1520 * @returns whatever the callback returns.
1521 * @param pDesc Pointer to the current descriptor.
1522 * @param pvArg Points to a STAMR3ENUMONEARGS structure.
1523 */
1524static int stamR3EnumOne(PSTAMDESC pDesc, void *pvArg)
1525{
1526 PSTAMR3ENUMONEARGS pArgs = (PSTAMR3ENUMONEARGS)pvArg;
1527 int rc;
1528 if (pDesc->enmType == STAMTYPE_CALLBACK)
1529 {
1530 /* Give the enumerator something useful. */
1531 char szBuf[512];
1532 pDesc->u.Callback.pfnPrint(pArgs->pVM, pDesc->u.Callback.pvSample, szBuf, sizeof(szBuf));
1533 rc = pArgs->pfnEnum(pDesc->pszName, pDesc->enmType, szBuf, pDesc->enmUnit,
1534 pDesc->enmVisibility, pDesc->pszDesc, pArgs->pvUser);
1535 }
1536 else
1537 rc = pArgs->pfnEnum(pDesc->pszName, pDesc->enmType, pDesc->u.pv, pDesc->enmUnit,
1538 pDesc->enmVisibility, pDesc->pszDesc, pArgs->pvUser);
1539 return rc;
1540}
1541
1542
1543/**
1544 * Match a name against an array of patterns.
1545 *
1546 * @returns true if it matches, false if it doesn't match.
1547 * @param papszExpressions The array of pattern expressions.
1548 * @param cExpressions The number of array entries.
1549 * @param piExpression Where to read/store the current skip index. Optional.
1550 * @param pszName The name to match.
1551 */
1552static bool stamR3MultiMatch(const char * const *papszExpressions, unsigned cExpressions,
1553 unsigned *piExpression, const char *pszName)
1554{
1555 for (unsigned i = piExpression ? *piExpression : 0; i < cExpressions; i++)
1556 {
1557 const char *pszPat = papszExpressions[i];
1558 if (RTStrSimplePatternMatch(pszPat, pszName))
1559 {
1560 /* later:
1561 if (piExpression && i > *piExpression)
1562 {
1563 check if we can skip some expressions
1564 }*/
1565 return true;
1566 }
1567 }
1568 return false;
1569}
1570
1571
1572/**
1573 * Splits a multi pattern into single ones.
1574 *
1575 * @returns Pointer to an array of single patterns. Free it with RTMemTmpFree.
1576 * @param pszPat The pattern to split.
1577 * @param pcExpressions The number of array elements.
1578 * @param pszCopy The pattern copy to free using RTStrFree.
1579 */
1580static char **stamR3SplitPattern(const char *pszPat, unsigned *pcExpressions, char **ppszCopy)
1581{
1582 Assert(pszPat && *pszPat);
1583
1584 char *pszCopy = RTStrDup(pszPat);
1585 if (!pszCopy)
1586 return NULL;
1587
1588 /* count them & allocate array. */
1589 char *psz = pszCopy;
1590 unsigned cExpressions = 1;
1591 while ((psz = strchr(psz, '|')) != NULL)
1592 cExpressions++, psz++;
1593
1594 char **papszExpressions = (char **)RTMemTmpAllocZ((cExpressions + 1) * sizeof(char *));
1595 if (!papszExpressions)
1596 {
1597 RTStrFree(pszCopy);
1598 return NULL;
1599 }
1600
1601 /* split */
1602 psz = pszCopy;
1603 for (unsigned i = 0;;)
1604 {
1605 papszExpressions[i] = psz;
1606 if (++i >= cExpressions)
1607 break;
1608 psz = strchr(psz, '|');
1609 *psz++ = '\0';
1610 }
1611
1612 /* sort the array, putting '*' last. */
1613 /** @todo sort it... */
1614
1615 *pcExpressions = cExpressions;
1616 *ppszCopy = pszCopy;
1617 return papszExpressions;
1618}
1619
1620
1621/**
1622 * Enumerates the nodes selected by a pattern or all nodes if no pattern
1623 * is specified.
1624 *
1625 * The call must own at least a read lock to the STAM data.
1626 *
1627 * @returns The rc from the callback.
1628 * @param pUVM Pointer to the user mode VM structure.
1629 * @param pszPat Pattern.
1630 * @param fUpdateRing0 Update the ring-0 .
1631 * @param pfnCallback Callback function which shall be called for matching nodes.
1632 * If it returns anything but VINF_SUCCESS the enumeration is
1633 * terminated and the status code returned to the caller.
1634 * @param pvArg User parameter for the callback.
1635 */
1636static int stamR3EnumU(PUVM pUVM, const char *pszPat, bool fUpdateRing0, int (*pfnCallback)(PSTAMDESC pDesc, void *pvArg), void *pvArg)
1637{
1638 int rc = VINF_SUCCESS;
1639
1640 /*
1641 * All
1642 */
1643 if (!pszPat || !*pszPat || !strcmp(pszPat, "*"))
1644 {
1645 if (fUpdateRing0)
1646 stamR3Ring0StatsUpdateU(pUVM, "*");
1647
1648 PSTAMDESC pCur = pUVM->stam.s.pHead;
1649 while (pCur)
1650 {
1651 rc = pfnCallback(pCur, pvArg);
1652 if (rc)
1653 break;
1654
1655 /* next */
1656 pCur = pCur->pNext;
1657 }
1658 }
1659
1660 /*
1661 * Single expression pattern.
1662 */
1663 else if (!strchr(pszPat, '|'))
1664 {
1665 if (fUpdateRing0)
1666 stamR3Ring0StatsUpdateU(pUVM, pszPat);
1667
1668 /** @todo This needs to be optimized since the GUI is using this path for the VM info dialog.
1669 * Note that it's doing exact matching. Organizing the samples in a tree would speed up thing
1670 * no end (at least for debug and profile builds). */
1671 for (PSTAMDESC pCur = pUVM->stam.s.pHead; pCur; pCur = pCur->pNext)
1672 if (RTStrSimplePatternMatch(pszPat, pCur->pszName))
1673 {
1674 rc = pfnCallback(pCur, pvArg);
1675 if (rc)
1676 break;
1677 }
1678 }
1679
1680 /*
1681 * Multi expression pattern.
1682 */
1683 else
1684 {
1685 /*
1686 * Split up the pattern first.
1687 */
1688 char *pszCopy;
1689 unsigned cExpressions;
1690 char **papszExpressions = stamR3SplitPattern(pszPat, &cExpressions, &pszCopy);
1691 if (!papszExpressions)
1692 return VERR_NO_MEMORY;
1693
1694 /*
1695 * Perform the enumeration.
1696 */
1697 if (fUpdateRing0)
1698 stamR3Ring0StatsUpdateMultiU(pUVM, papszExpressions, cExpressions);
1699
1700 unsigned iExpression = 0;
1701 for (PSTAMDESC pCur = pUVM->stam.s.pHead; pCur; pCur = pCur->pNext)
1702 if (stamR3MultiMatch(papszExpressions, cExpressions, &iExpression, pCur->pszName))
1703 {
1704 rc = pfnCallback(pCur, pvArg);
1705 if (rc)
1706 break;
1707 }
1708
1709 RTMemTmpFree(papszExpressions);
1710 RTStrFree(pszCopy);
1711 }
1712
1713 return rc;
1714}
1715
1716
1717/**
1718 * Registers the ring-0 statistics.
1719 *
1720 * @param pUVM Pointer to the user mode VM structure.
1721 */
1722static void stamR3Ring0StatsRegisterU(PUVM pUVM)
1723{
1724 /* GVMM */
1725 for (unsigned i = 0; i < RT_ELEMENTS(g_aGVMMStats); i++)
1726 stamR3RegisterU(pUVM, (uint8_t *)&pUVM->stam.s.GVMMStats + g_aGVMMStats[i].offVar, NULL, NULL,
1727 g_aGVMMStats[i].enmType, STAMVISIBILITY_ALWAYS, g_aGVMMStats[i].pszName,
1728 g_aGVMMStats[i].enmUnit, g_aGVMMStats[i].pszDesc);
1729}
1730
1731
1732/**
1733 * Updates the ring-0 statistics (the copy).
1734 *
1735 * @param pUVM Pointer to the user mode VM structure.
1736 * @param pszPat The pattern.
1737 */
1738static void stamR3Ring0StatsUpdateU(PUVM pUVM, const char *pszPat)
1739{
1740 stamR3Ring0StatsUpdateMultiU(pUVM, &pszPat, 1);
1741}
1742
1743
1744/**
1745 * Updates the ring-0 statistics.
1746 *
1747 * The ring-0 statistics aren't directly addressable from ring-3 and
1748 * must be copied when needed.
1749 *
1750 * @param pUVM Pointer to the user mode VM structure.
1751 * @param pszPat The pattern (for knowing when to skip).
1752 */
1753static void stamR3Ring0StatsUpdateMultiU(PUVM pUVM, const char * const *papszExpressions, unsigned cExpressions)
1754{
1755 PVM pVM = pUVM->pVM;
1756 if (!pVM || !pVM->pSession)
1757 return;
1758
1759 /* GVMM */
1760 bool fUpdate = false;
1761 for (unsigned i = 0; i < RT_ELEMENTS(g_aGVMMStats); i++)
1762 if (stamR3MultiMatch(papszExpressions, cExpressions, NULL, g_aGVMMStats[i].pszName))
1763 {
1764 fUpdate = true;
1765 break;
1766 }
1767 if (fUpdate)
1768 {
1769 GVMMQUERYSTATISTICSSREQ Req;
1770 Req.Hdr.cbReq = sizeof(Req);
1771 Req.Hdr.u32Magic = SUPVMMR0REQHDR_MAGIC;
1772 Req.pSession = pVM->pSession;
1773 int rc = SUPCallVMMR0Ex(pVM->pVMR0, NIL_VMCPUID, VMMR0_DO_GVMM_QUERY_STATISTICS, 0, &Req.Hdr);
1774 if (RT_SUCCESS(rc))
1775 pUVM->stam.s.GVMMStats = Req.Stats;
1776 }
1777}
1778
1779
1780/**
1781 * Get the unit string.
1782 *
1783 * @returns Pointer to read only unit string.
1784 * @param enmUnit The unit.
1785 */
1786VMMR3DECL(const char *) STAMR3GetUnit(STAMUNIT enmUnit)
1787{
1788 switch (enmUnit)
1789 {
1790 case STAMUNIT_NONE: return "";
1791 case STAMUNIT_CALLS: return "calls";
1792 case STAMUNIT_COUNT: return "count";
1793 case STAMUNIT_BYTES: return "bytes";
1794 case STAMUNIT_PAGES: return "pages";
1795 case STAMUNIT_ERRORS: return "errors";
1796 case STAMUNIT_OCCURENCES: return "times";
1797 case STAMUNIT_TICKS_PER_CALL: return "ticks/call";
1798 case STAMUNIT_TICKS_PER_OCCURENCE: return "ticks/time";
1799 case STAMUNIT_GOOD_BAD: return "good:bad";
1800 case STAMUNIT_MEGABYTES: return "megabytes";
1801 case STAMUNIT_KILOBYTES: return "kilobytes";
1802 case STAMUNIT_NS: return "ns";
1803 case STAMUNIT_NS_PER_CALL: return "ns/call";
1804 case STAMUNIT_NS_PER_OCCURENCE: return "ns/time";
1805 case STAMUNIT_PCT: return "%";
1806
1807 default:
1808 AssertMsgFailed(("Unknown unit %d\n", enmUnit));
1809 return "(?unit?)";
1810 }
1811}
1812
1813#ifdef VBOX_WITH_DEBUGGER
1814
1815/**
1816 * The '.stats' command.
1817 *
1818 * @returns VBox status.
1819 * @param pCmd Pointer to the command descriptor (as registered).
1820 * @param pCmdHlp Pointer to command helper functions.
1821 * @param pVM Pointer to the current VM (if any).
1822 * @param paArgs Pointer to (readonly) array of arguments.
1823 * @param cArgs Number of arguments in the array.
1824 */
1825static DECLCALLBACK(int) stamR3CmdStats(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PVM pVM, PCDBGCVAR paArgs, unsigned cArgs, PDBGCVAR pResult)
1826{
1827 /*
1828 * Validate input.
1829 */
1830 if (!pVM)
1831 return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "error: The command requires VM to be selected.\n");
1832 PUVM pUVM = pVM->pUVM;
1833 if (!pUVM->stam.s.pHead)
1834 return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "Sorry, no statistics present.\n");
1835
1836 /*
1837 * Do the printing.
1838 */
1839 STAMR3PRINTONEARGS Args;
1840 Args.pVM = pVM;
1841 Args.pvArg = pCmdHlp;
1842 Args.pfnPrintf = stamR3EnumDbgfPrintf;
1843
1844 STAM_LOCK_RD(pUVM);
1845 int rc = stamR3EnumU(pUVM, cArgs ? paArgs[0].u.pszString : NULL, true /* fUpdateRing0 */, stamR3PrintOne, &Args);
1846 STAM_UNLOCK_RD(pUVM);
1847
1848 return rc;
1849}
1850
1851
1852/**
1853 * Display one sample in the debugger.
1854 *
1855 * @param pArgs Pointer to the print one argument structure.
1856 * @param pszFormat Format string.
1857 * @param ... Format arguments.
1858 */
1859static DECLCALLBACK(void) stamR3EnumDbgfPrintf(PSTAMR3PRINTONEARGS pArgs, const char *pszFormat, ...)
1860{
1861 PDBGCCMDHLP pCmdHlp = (PDBGCCMDHLP)pArgs->pvArg;
1862
1863 va_list va;
1864 va_start(va, pszFormat);
1865 pCmdHlp->pfnPrintfV(pCmdHlp, NULL, pszFormat, va);
1866 va_end(va);
1867 NOREF(pArgs);
1868}
1869
1870
1871/**
1872 * The '.statsreset' command.
1873 *
1874 * @returns VBox status.
1875 * @param pCmd Pointer to the command descriptor (as registered).
1876 * @param pCmdHlp Pointer to command helper functions.
1877 * @param pVM Pointer to the current VM (if any).
1878 * @param paArgs Pointer to (readonly) array of arguments.
1879 * @param cArgs Number of arguments in the array.
1880 */
1881static DECLCALLBACK(int) stamR3CmdStatsReset(PCDBGCCMD pCmd, PDBGCCMDHLP pCmdHlp, PVM pVM, PCDBGCVAR paArgs, unsigned cArgs, PDBGCVAR pResult)
1882{
1883 /*
1884 * Validate input.
1885 */
1886 if (!pVM)
1887 return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "error: The command requires VM to be selected.\n");
1888 PUVM pUVM = pVM->pUVM;
1889 if (!pUVM->stam.s.pHead)
1890 return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "Sorry, no statistics present.\n");
1891
1892 /*
1893 * Execute reset.
1894 */
1895 int rc = STAMR3ResetU(pUVM, cArgs ? paArgs[0].u.pszString : NULL);
1896 if (RT_SUCCESS(rc))
1897 return pCmdHlp->pfnPrintf(pCmdHlp, NULL, "info: Statistics reset.\n");
1898
1899 return pCmdHlp->pfnVBoxError(pCmdHlp, rc, "Restting statistics.\n");
1900}
1901
1902#endif /* VBOX_WITH_DEBUGGER */
1903
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