VirtualBox

source: vbox/trunk/include/VBox/stam.h@ 21217

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

include/VBox/*.h: Mark which components the header files relate to.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 38.3 KB
Line 
1/** @file
2 * STAM - Statistics Manager. (VMM)
3 */
4
5/*
6 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 *
25 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26 * Clara, CA 95054 USA or visit http://www.sun.com if you need
27 * additional information or have any questions.
28 */
29
30#ifndef ___VBox_stam_h
31#define ___VBox_stam_h
32
33#include <VBox/cdefs.h>
34#include <VBox/types.h>
35#include <iprt/stdarg.h>
36#ifdef _MSC_VER
37# if _MSC_VER >= 1400
38# include <intrin.h>
39# endif
40#endif
41
42RT_C_DECLS_BEGIN
43
44/** @defgroup grp_stam The Statistics Manager API
45 * @{
46 */
47
48#if defined(VBOX_WITHOUT_RELEASE_STATISTICS) && defined(VBOX_WITH_STATISTICS)
49# error "Both VBOX_WITHOUT_RELEASE_STATISTICS and VBOX_WITH_STATISTICS are defined! Make up your mind!"
50#endif
51
52
53/** @def STAM_GET_TS
54 * Gets the CPU timestamp counter.
55 *
56 * @param u64 The 64-bit variable which the timestamp shall be saved in.
57 */
58#ifdef __GNUC__
59# if defined(RT_ARCH_X86)
60 /* This produces optimal assembler code for x86 but does not work for AMD64 ('A' means 'either rax or rdx') */
61# define STAM_GET_TS(u64) __asm__ __volatile__ ("rdtsc\n\t" : "=A" (u64));
62# elif defined(RT_ARCH_AMD64)
63# define STAM_GET_TS(u64) \
64 do { uint64_t low; uint64_t high; \
65 __asm__ __volatile__ ("rdtsc\n\t" : "=a"(low), "=d"(high)); \
66 (u64) = ((high << 32) | low); \
67 } while (0)
68# endif
69#elif _MSC_VER >= 1400
70# pragma intrinsic(__rdtsc)
71# define STAM_GET_TS(u64) \
72 do { (u64) = __rdtsc(); } while (0)
73#else
74# define STAM_GET_TS(u64) \
75 do { \
76 uint64_t u64Tmp; \
77 __asm { \
78 __asm rdtsc \
79 __asm mov dword ptr [u64Tmp], eax \
80 __asm mov dword ptr [u64Tmp + 4], edx \
81 } \
82 (u64) = u64Tmp; \
83 } while (0)
84#endif
85
86
87/** @def STAM_REL_STATS
88 * Code for inclusion only when VBOX_WITH_STATISTICS is defined.
89 * @param code A code block enclosed in {}.
90 */
91#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
92# define STAM_REL_STATS(code) do code while(0)
93#else
94# define STAM_REL_STATS(code) do {} while(0)
95#endif
96/** @def STAM_STATS
97 * Code for inclusion only when VBOX_WITH_STATISTICS is defined.
98 * @param code A code block enclosed in {}.
99 */
100#ifdef VBOX_WITH_STATISTICS
101# define STAM_STATS(code) STAM_REL_STATS(code)
102#else
103# define STAM_STATS(code) do {} while(0)
104#endif
105
106
107/**
108 * Sample type.
109 */
110typedef enum STAMTYPE
111{
112 /** Invalid entry. */
113 STAMTYPE_INVALID = 0,
114 /** Generic counter. */
115 STAMTYPE_COUNTER,
116 /** Profiling of an function. */
117 STAMTYPE_PROFILE,
118 /** Profiling of an operation. */
119 STAMTYPE_PROFILE_ADV,
120 /** Ratio of A to B, uint32_t types. Not reset. */
121 STAMTYPE_RATIO_U32,
122 /** Ratio of A to B, uint32_t types. Reset both to 0. */
123 STAMTYPE_RATIO_U32_RESET,
124 /** Callback. */
125 STAMTYPE_CALLBACK,
126 /** Generic unsigned 8-bit value. Not reset. */
127 STAMTYPE_U8,
128 /** Generic unsigned 8-bit value. Reset to 0. */
129 STAMTYPE_U8_RESET,
130 /** Generic hexadecimal unsigned 8-bit value. Not reset. */
131 STAMTYPE_X8,
132 /** Generic hexadecimal unsigned 8-bit value. Reset to 0. */
133 STAMTYPE_X8_RESET,
134 /** Generic unsigned 16-bit value. Not reset. */
135 STAMTYPE_U16,
136 /** Generic unsigned 16-bit value. Reset to 0. */
137 STAMTYPE_U16_RESET,
138 /** Generic hexadecimal unsigned 16-bit value. Not reset. */
139 STAMTYPE_X16,
140 /** Generic hexadecimal unsigned 16-bit value. Reset to 0. */
141 STAMTYPE_X16_RESET,
142 /** Generic unsigned 32-bit value. Not reset. */
143 STAMTYPE_U32,
144 /** Generic unsigned 32-bit value. Reset to 0. */
145 STAMTYPE_U32_RESET,
146 /** Generic hexadecimal unsigned 32-bit value. Not reset. */
147 STAMTYPE_X32,
148 /** Generic hexadecimal unsigned 32-bit value. Reset to 0. */
149 STAMTYPE_X32_RESET,
150 /** Generic unsigned 64-bit value. Not reset. */
151 STAMTYPE_U64,
152 /** Generic unsigned 64-bit value. Reset to 0. */
153 STAMTYPE_U64_RESET,
154 /** Generic hexadecimal unsigned 64-bit value. Not reset. */
155 STAMTYPE_X64,
156 /** Generic hexadecimal unsigned 64-bit value. Reset to 0. */
157 STAMTYPE_X64_RESET,
158 /** The end (exclusive). */
159 STAMTYPE_END
160} STAMTYPE;
161
162/**
163 * Sample visibility type.
164 */
165typedef enum STAMVISIBILITY
166{
167 /** Invalid entry. */
168 STAMVISIBILITY_INVALID = 0,
169 /** Always visible. */
170 STAMVISIBILITY_ALWAYS,
171 /** Only visible when used (/hit). */
172 STAMVISIBILITY_USED,
173 /** Not visible in the GUI. */
174 STAMVISIBILITY_NOT_GUI,
175 /** The end (exclusive). */
176 STAMVISIBILITY_END
177} STAMVISIBILITY;
178
179/**
180 * Sample unit.
181 */
182typedef enum STAMUNIT
183{
184 /** Invalid entry .*/
185 STAMUNIT_INVALID = 0,
186 /** No unit. */
187 STAMUNIT_NONE,
188 /** Number of calls. */
189 STAMUNIT_CALLS,
190 /** Count of whatever. */
191 STAMUNIT_COUNT,
192 /** Count of bytes. */
193 STAMUNIT_BYTES,
194 /** Count of bytes. */
195 STAMUNIT_PAGES,
196 /** Error count. */
197 STAMUNIT_ERRORS,
198 /** Number of occurences. */
199 STAMUNIT_OCCURENCES,
200 /** Ticks. */
201 STAMUNIT_TICKS,
202 /** Ticks per call. */
203 STAMUNIT_TICKS_PER_CALL,
204 /** Ticks per occurence. */
205 STAMUNIT_TICKS_PER_OCCURENCE,
206 /** Ratio of good vs. bad. */
207 STAMUNIT_GOOD_BAD,
208 /** Megabytes. */
209 STAMUNIT_MEGABYTES,
210 /** Kilobytes. */
211 STAMUNIT_KILOBYTES,
212 /** Nano seconds. */
213 STAMUNIT_NS,
214 /** Nanoseconds per call. */
215 STAMUNIT_NS_PER_CALL,
216 /** Nanoseconds per call. */
217 STAMUNIT_NS_PER_OCCURENCE,
218 /** Percentage. */
219 STAMUNIT_PCT,
220 /** The end (exclusive). */
221 STAMUNIT_END
222} STAMUNIT;
223
224
225/** @def STAM_REL_U8_INC
226 * Increments a uint8_t sample by one.
227 *
228 * @param pCounter Pointer to the uint8_t variable to operate on.
229 */
230#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
231# define STAM_REL_U8_INC(pCounter) \
232 do { ++*(pCounter); } while (0)
233#else
234# define STAM_REL_U8_INC(pCounter) do { } while (0)
235#endif
236/** @def STAM_U8_INC
237 * Increments a uint8_t sample by one.
238 *
239 * @param pCounter Pointer to the uint8_t variable to operate on.
240 */
241#ifdef VBOX_WITH_STATISTICS
242# define STAM_U8_INC(pCounter) STAM_REL_U8_INC(pCounter)
243#else
244# define STAM_U8_INC(pCounter) do { } while (0)
245#endif
246
247
248/** @def STAM_REL_U8_DEC
249 * Decrements a uint8_t sample by one.
250 *
251 * @param pCounter Pointer to the uint8_t variable to operate on.
252 */
253#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
254# define STAM_REL_U8_DEC(pCounter) \
255 do { --*(pCounter); } while (0)
256#else
257# define STAM_REL_U8_DEC(pCounter) do { } while (0)
258#endif
259/** @def STAM_U8_DEC
260 * Decrements a uint8_t sample by one.
261 *
262 * @param pCounter Pointer to the uint8_t variable to operate on.
263 */
264#ifdef VBOX_WITH_STATISTICS
265# define STAM_U8_DEC(pCounter) STAM_REL_U8_DEC(pCounter)
266#else
267# define STAM_U8_DEC(pCounter) do { } while (0)
268#endif
269
270
271/** @def STAM_REL_U8_ADD
272 * Increments a uint8_t sample by a value.
273 *
274 * @param pCounter Pointer to the uint8_t variable to operate on.
275 * @param Addend The value to add.
276 */
277#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
278# define STAM_REL_U8_ADD(pCounter, Addend) \
279 do { *(pCounter) += (Addend); } while (0)
280#else
281# define STAM_REL_U8_ADD(pCounter, Addend) do { } while (0)
282#endif
283/** @def STAM_U8_ADD
284 * Increments a uint8_t sample by a value.
285 *
286 * @param pCounter Pointer to the uint8_t variable to operate on.
287 * @param Addend The value to add.
288 */
289#ifdef VBOX_WITH_STATISTICS
290# define STAM_U8_ADD(pCounter, Addend) STAM_REL_U8_ADD(pCounter, Addend
291#else
292# define STAM_U8_ADD(pCounter, Addend) do { } while (0)
293#endif
294
295
296/** @def STAM_REL_U16_INC
297 * Increments a uint16_t sample by one.
298 *
299 * @param pCounter Pointer to the uint16_t variable to operate on.
300 */
301#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
302# define STAM_REL_U16_INC(pCounter) \
303 do { ++*(pCounter); } while (0)
304#else
305# define STAM_REL_U16_INC(pCounter) do { } while (0)
306#endif
307/** @def STAM_U16_INC
308 * Increments a uint16_t sample by one.
309 *
310 * @param pCounter Pointer to the uint16_t variable to operate on.
311 */
312#ifdef VBOX_WITH_STATISTICS
313# define STAM_U16_INC(pCounter) STAM_REL_U16_INC(pCounter)
314#else
315# define STAM_U16_INC(pCounter) do { } while (0)
316#endif
317
318
319/** @def STAM_REL_U16_DEC
320 * Decrements a uint16_t sample by one.
321 *
322 * @param pCounter Pointer to the uint16_t variable to operate on.
323 */
324#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
325# define STAM_REL_U16_DEC(pCounter) \
326 do { --*(pCounter); } while (0)
327#else
328# define STAM_REL_U16_DEC(pCounter) do { } while (0)
329#endif
330/** @def STAM_U16_DEC
331 * Decrements a uint16_t sample by one.
332 *
333 * @param pCounter Pointer to the uint16_t variable to operate on.
334 */
335#ifdef VBOX_WITH_STATISTICS
336# define STAM_U16_DEC(pCounter) STAM_REL_U16_DEC(pCounter)
337#else
338# define STAM_U16_DEC(pCounter) do { } while (0)
339#endif
340
341
342/** @def STAM_REL_U16_INC
343 * Increments a uint16_t sample by a value.
344 *
345 * @param pCounter Pointer to the uint16_t variable to operate on.
346 * @param Addend The value to add.
347 */
348#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
349# define STAM_REL_U16_ADD(pCounter, Addend) \
350 do { *(pCounter) += (Addend); } while (0)
351#else
352# define STAM_REL_U16_ADD(pCounter, Addend) do { } while (0)
353#endif
354/** @def STAM_U16_INC
355 * Increments a uint16_t sample by a value.
356 *
357 * @param pCounter Pointer to the uint16_t variable to operate on.
358 * @param Addend The value to add.
359 */
360#ifdef VBOX_WITH_STATISTICS
361# define STAM_U16_ADD(pCounter, Addend) STAM_REL_U16_ADD(pCounter, Addend)
362#else
363# define STAM_U16_ADD(pCounter, Addend) do { } while (0)
364#endif
365
366
367/** @def STAM_REL_U32_INC
368 * Increments a uint32_t sample by one.
369 *
370 * @param pCounter Pointer to the uint32_t variable to operate on.
371 */
372#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
373# define STAM_REL_U32_INC(pCounter) \
374 do { ++*(pCounter); } while (0)
375#else
376# define STAM_REL_U32_INC(pCounter) do { } while (0)
377#endif
378/** @def STAM_U32_INC
379 * Increments a uint32_t sample by one.
380 *
381 * @param pCounter Pointer to the uint32_t variable to operate on.
382 */
383#ifdef VBOX_WITH_STATISTICS
384# define STAM_U32_INC(pCounter) STAM_REL_U32_INC(pCounter)
385#else
386# define STAM_U32_INC(pCounter) do { } while (0)
387#endif
388
389
390/** @def STAM_REL_U32_DEC
391 * Decrements a uint32_t sample by one.
392 *
393 * @param pCounter Pointer to the uint32_t variable to operate on.
394 */
395#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
396# define STAM_REL_U32_DEC(pCounter) \
397 do { --*(pCounter); } while (0)
398#else
399# define STAM_REL_U32_DEC(pCounter) do { } while (0)
400#endif
401/** @def STAM_U32_DEC
402 * Decrements a uint32_t sample by one.
403 *
404 * @param pCounter Pointer to the uint32_t variable to operate on.
405 */
406#ifdef VBOX_WITH_STATISTICS
407# define STAM_U32_DEC(pCounter) STAM_REL_U32_DEC(pCounter)
408#else
409# define STAM_U32_DEC(pCounter) do { } while (0)
410#endif
411
412
413/** @def STAM_REL_U32_ADD
414 * Increments a uint32_t sample by value.
415 *
416 * @param pCounter Pointer to the uint32_t variable to operate on.
417 * @param Addend The value to add.
418 */
419#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
420# define STAM_REL_U32_ADD(pCounter, Addend) \
421 do { *(pCounter) += (Addend); } while (0)
422#else
423# define STAM_REL_U32_ADD(pCounter, Addend) do { } while (0)
424#endif
425/** @def STAM_U32_ADD
426 * Increments a uint32_t sample by value.
427 *
428 * @param pCounter Pointer to the uint32_t variable to operate on.
429 * @param Addend The value to add.
430 */
431#ifdef VBOX_WITH_STATISTICS
432# define STAM_U32_ADD(pCounter, Addend) STAM_REL_U32_ADD(pCounter, Addend)
433#else
434# define STAM_U32_ADD(pCounter, Addend) do { } while (0)
435#endif
436
437
438/** @def STAM_REL_U64_INC
439 * Increments a uint64_t sample by one.
440 *
441 * @param pCounter Pointer to the uint64_t variable to operate on.
442 */
443#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
444# define STAM_REL_U64_INC(pCounter) \
445 do { ++*(pCounter); } while (0)
446#else
447# define STAM_REL_U64_INC(pCounter) do { } while (0)
448#endif
449/** @def STAM_U64_INC
450 * Increments a uint64_t sample by one.
451 *
452 * @param pCounter Pointer to the uint64_t variable to operate on.
453 */
454#ifdef VBOX_WITH_STATISTICS
455# define STAM_U64_INC(pCounter) STAM_REL_U64_INC(pCounter)
456#else
457# define STAM_U64_INC(pCounter) do { } while (0)
458#endif
459
460
461/** @def STAM_REL_U64_DEC
462 * Decrements a uint64_t sample by one.
463 *
464 * @param pCounter Pointer to the uint64_t variable to operate on.
465 */
466#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
467# define STAM_REL_U64_DEC(pCounter) \
468 do { --*(pCounter); } while (0)
469#else
470# define STAM_REL_U64_DEC(pCounter) do { } while (0)
471#endif
472/** @def STAM_U64_DEC
473 * Decrements a uint64_t sample by one.
474 *
475 * @param pCounter Pointer to the uint64_t variable to operate on.
476 */
477#ifdef VBOX_WITH_STATISTICS
478# define STAM_U64_DEC(pCounter) STAM_REL_U64_DEC(pCounter)
479#else
480# define STAM_U64_DEC(pCounter) do { } while (0)
481#endif
482
483
484/** @def STAM_REL_U64_ADD
485 * Increments a uint64_t sample by a value.
486 *
487 * @param pCounter Pointer to the uint64_t variable to operate on.
488 * @param Addend The value to add.
489 */
490#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
491# define STAM_REL_U64_ADD(pCounter, Addend) \
492 do { *(pCounter) += (Addend); } while (0)
493#else
494# define STAM_REL_U64_ADD(pCounter, Addend) do { } while (0)
495#endif
496/** @def STAM_U64_ADD
497 * Increments a uint64_t sample by a value.
498 *
499 * @param pCounter Pointer to the uint64_t variable to operate on.
500 * @param Addend The value to add.
501 */
502#ifdef VBOX_WITH_STATISTICS
503# define STAM_U64_ADD(pCounter, Addend) STAM_REL_U64_ADD(pCounter, Addend)
504#else
505# define STAM_U64_ADD(pCounter, Addend) do { } while (0)
506#endif
507
508
509/**
510 * Counter sample - STAMTYPE_COUNTER.
511 */
512typedef struct STAMCOUNTER
513{
514 /** The current count. */
515 volatile uint64_t c;
516} STAMCOUNTER;
517/** Pointer to a counter. */
518typedef STAMCOUNTER *PSTAMCOUNTER;
519/** Pointer to a const counter. */
520typedef const STAMCOUNTER *PCSTAMCOUNTER;
521
522
523/** @def STAM_REL_COUNTER_INC
524 * Increments a counter sample by one.
525 *
526 * @param pCounter Pointer to the STAMCOUNTER structure to operate on.
527 */
528#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
529# define STAM_REL_COUNTER_INC(pCounter) \
530 do { (pCounter)->c++; } while (0)
531#else
532# define STAM_REL_COUNTER_INC(pCounter) do { } while (0)
533#endif
534/** @def STAM_COUNTER_INC
535 * Increments a counter sample by one.
536 *
537 * @param pCounter Pointer to the STAMCOUNTER structure to operate on.
538 */
539#ifdef VBOX_WITH_STATISTICS
540# define STAM_COUNTER_INC(pCounter) STAM_REL_COUNTER_INC(pCounter)
541#else
542# define STAM_COUNTER_INC(pCounter) do { } while (0)
543#endif
544
545
546/** @def STAM_REL_COUNTER_DEC
547 * Decrements a counter sample by one.
548 *
549 * @param pCounter Pointer to the STAMCOUNTER structure to operate on.
550 */
551#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
552# define STAM_REL_COUNTER_DEC(pCounter) \
553 do { (pCounter)->c--; } while (0)
554#else
555# define STAM_REL_COUNTER_DEC(pCounter) do { } while (0)
556#endif
557/** @def STAM_COUNTER_DEC
558 * Decrements a counter sample by one.
559 *
560 * @param pCounter Pointer to the STAMCOUNTER structure to operate on.
561 */
562#ifdef VBOX_WITH_STATISTICS
563# define STAM_COUNTER_DEC(pCounter) STAM_REL_COUNTER_DEC(pCounter)
564#else
565# define STAM_COUNTER_DEC(pCounter) do { } while (0)
566#endif
567
568
569/** @def STAM_REL_COUNTER_ADD
570 * Increments a counter sample by a value.
571 *
572 * @param pCounter Pointer to the STAMCOUNTER structure to operate on.
573 * @param Addend The value to add to the counter.
574 */
575#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
576# define STAM_REL_COUNTER_ADD(pCounter, Addend) \
577 do { (pCounter)->c += (Addend); } while (0)
578#else
579# define STAM_REL_COUNTER_ADD(pCounter, Addend) do { } while (0)
580#endif
581/** @def STAM_COUNTER_ADD
582 * Increments a counter sample by a value.
583 *
584 * @param pCounter Pointer to the STAMCOUNTER structure to operate on.
585 * @param Addend The value to add to the counter.
586 */
587#ifdef VBOX_WITH_STATISTICS
588# define STAM_COUNTER_ADD(pCounter, Addend) STAM_REL_COUNTER_ADD(pCounter, Addend)
589#else
590# define STAM_COUNTER_ADD(pCounter, Addend) do { } while (0)
591#endif
592
593
594/** @def STAM_REL_COUNTER_RESET
595 * Resets the statistics sample.
596 */
597#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
598# define STAM_REL_COUNTER_RESET(pCounter) do { (pCounter)->c = 0; } while (0)
599#else
600# define STAM_REL_COUNTER_RESET(pCounter) do { } while (0)
601#endif
602/** @def STAM_COUNTER_RESET
603 * Resets the statistics sample.
604 */
605#ifndef VBOX_WITH_STATISTICS
606# define STAM_COUNTER_RESET(pCounter) STAM_REL_COUNTER_RESET(pCounter)
607#else
608# define STAM_COUNTER_RESET(pCounter) do { } while (0)
609#endif
610
611
612
613/**
614 * Profiling sample - STAMTYPE_PROFILE.
615 */
616typedef struct STAMPROFILE
617{
618 /** Number of periods. */
619 volatile uint64_t cPeriods;
620 /** Total count of ticks. */
621 volatile uint64_t cTicks;
622 /** Maximum tick count during a sampling. */
623 volatile uint64_t cTicksMax;
624 /** Minimum tick count during a sampling. */
625 volatile uint64_t cTicksMin;
626} STAMPROFILE;
627/** Pointer to a profile sample. */
628typedef STAMPROFILE *PSTAMPROFILE;
629/** Pointer to a const profile sample. */
630typedef const STAMPROFILE *PCSTAMPROFILE;
631
632
633/** @def STAM_REL_PROFILE_START
634 * Samples the start time of a profiling period.
635 *
636 * @param pProfile Pointer to the STAMPROFILE structure to operate on.
637 * @param Prefix Identifier prefix used to internal variables.
638 */
639#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
640# define STAM_REL_PROFILE_START(pProfile, Prefix) \
641 uint64_t Prefix##_tsStart; \
642 STAM_GET_TS(Prefix##_tsStart)
643#else
644# define STAM_REL_PROFILE_START(pProfile, Prefix) do { } while (0)
645#endif
646/** @def STAM_PROFILE_START
647 * Samples the start time of a profiling period.
648 *
649 * @param pProfile Pointer to the STAMPROFILE structure to operate on.
650 * @param Prefix Identifier prefix used to internal variables.
651 */
652#ifdef VBOX_WITH_STATISTICS
653# define STAM_PROFILE_START(pProfile, Prefix) STAM_REL_PROFILE_START(pProfile, Prefix)
654#else
655# define STAM_PROFILE_START(pProfile, Prefix) do { } while (0)
656#endif
657
658/** @def STAM_REL_PROFILE_STOP
659 * Samples the stop time of a profiling period and updates the sample.
660 *
661 * @param pProfile Pointer to the STAMPROFILE structure to operate on.
662 * @param Prefix Identifier prefix used to internal variables.
663 */
664#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
665# define STAM_REL_PROFILE_STOP(pProfile, Prefix) \
666 do { \
667 uint64_t Prefix##_cTicks; \
668 uint64_t Prefix##_tsStop; \
669 STAM_GET_TS(Prefix##_tsStop); \
670 Prefix##_cTicks = Prefix##_tsStop - Prefix##_tsStart; \
671 (pProfile)->cTicks += Prefix##_cTicks; \
672 (pProfile)->cPeriods++; \
673 if ((pProfile)->cTicksMax < Prefix##_cTicks) \
674 (pProfile)->cTicksMax = Prefix##_cTicks; \
675 if ((pProfile)->cTicksMin > Prefix##_cTicks) \
676 (pProfile)->cTicksMin = Prefix##_cTicks; \
677 } while (0)
678#else
679# define STAM_REL_PROFILE_STOP(pProfile, Prefix) do { } while (0)
680#endif
681/** @def STAM_PROFILE_STOP
682 * Samples the stop time of a profiling period and updates the sample.
683 *
684 * @param pProfile Pointer to the STAMPROFILE structure to operate on.
685 * @param Prefix Identifier prefix used to internal variables.
686 */
687#ifdef VBOX_WITH_STATISTICS
688# define STAM_PROFILE_STOP(pProfile, Prefix) STAM_REL_PROFILE_STOP(pProfile, Prefix)
689#else
690# define STAM_PROFILE_STOP(pProfile, Prefix) do { } while (0)
691#endif
692
693
694/** @def STAM_REL_PROFILE_STOP_EX
695 * Samples the stop time of a profiling period and updates both the sample
696 * and an attribution sample.
697 *
698 * @param pProfile Pointer to the STAMPROFILE structure to operate on.
699 * @param pProfile2 Pointer to the STAMPROFILE structure which this
700 * interval should be attributed to as well. This may be NULL.
701 * @param Prefix Identifier prefix used to internal variables.
702 */
703#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
704# define STAM_REL_PROFILE_STOP_EX(pProfile, pProfile2, Prefix) \
705 do { \
706 uint64_t Prefix##_cTicks; \
707 uint64_t Prefix##_tsStop; \
708 STAM_GET_TS(Prefix##_tsStop); \
709 Prefix##_cTicks = Prefix##_tsStop - Prefix##_tsStart; \
710 (pProfile)->cTicks += Prefix##_cTicks; \
711 (pProfile)->cPeriods++; \
712 if ((pProfile)->cTicksMax < Prefix##_cTicks) \
713 (pProfile)->cTicksMax = Prefix##_cTicks; \
714 if ((pProfile)->cTicksMin > Prefix##_cTicks) \
715 (pProfile)->cTicksMin = Prefix##_cTicks; \
716 \
717 if ((pProfile2)) \
718 { \
719 (pProfile2)->cTicks += Prefix##_cTicks; \
720 (pProfile2)->cPeriods++; \
721 if ((pProfile2)->cTicksMax < Prefix##_cTicks) \
722 (pProfile2)->cTicksMax = Prefix##_cTicks; \
723 if ((pProfile2)->cTicksMin > Prefix##_cTicks) \
724 (pProfile2)->cTicksMin = Prefix##_cTicks; \
725 } \
726 } while (0)
727#else
728# define STAM_REL_PROFILE_STOP_EX(pProfile, pProfile2, Prefix) do { } while (0)
729#endif
730/** @def STAM_PROFILE_STOP_EX
731 * Samples the stop time of a profiling period and updates both the sample
732 * and an attribution sample.
733 *
734 * @param pProfile Pointer to the STAMPROFILE structure to operate on.
735 * @param pProfile2 Pointer to the STAMPROFILE structure which this
736 * interval should be attributed to as well. This may be NULL.
737 * @param Prefix Identifier prefix used to internal variables.
738 */
739#ifdef VBOX_WITH_STATISTICS
740# define STAM_PROFILE_STOP_EX(pProfile, pProfile2, Prefix) STAM_REL_PROFILE_STOP_EX(pProfile, pProfile2, Prefix)
741#else
742# define STAM_PROFILE_STOP_EX(pProfile, pProfile2, Prefix) do { } while (0)
743#endif
744
745
746/**
747 * Advanced profiling sample - STAMTYPE_PROFILE_ADV.
748 *
749 * Identical to a STAMPROFILE sample, but the start timestamp
750 * is stored after the STAMPROFILE structure so the sampling
751 * can start and stop in different functions.
752 */
753typedef struct STAMPROFILEADV
754{
755 /** The STAMPROFILE core. */
756 STAMPROFILE Core;
757 /** The start timestamp. */
758 volatile uint64_t tsStart;
759} STAMPROFILEADV;
760/** Pointer to a advanced profile sample. */
761typedef STAMPROFILEADV *PSTAMPROFILEADV;
762/** Pointer to a const advanced profile sample. */
763typedef const STAMPROFILEADV *PCSTAMPROFILEADV;
764
765
766/** @def STAM_REL_PROFILE_ADV_START
767 * Samples the start time of a profiling period.
768 *
769 * @param pProfileAdv Pointer to the STAMPROFILEADV structure to operate on.
770 * @param Prefix Identifier prefix used to internal variables.
771 */
772#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
773# define STAM_REL_PROFILE_ADV_START(pProfileAdv, Prefix) \
774 STAM_GET_TS((pProfileAdv)->tsStart)
775#else
776# define STAM_REL_PROFILE_ADV_START(pProfileAdv, Prefix) do { } while (0)
777#endif
778/** @def STAM_PROFILE_ADV_START
779 * Samples the start time of a profiling period.
780 *
781 * @param pProfileAdv Pointer to the STAMPROFILEADV structure to operate on.
782 * @param Prefix Identifier prefix used to internal variables.
783 */
784#ifdef VBOX_WITH_STATISTICS
785# define STAM_PROFILE_ADV_START(pProfileAdv, Prefix) STAM_REL_PROFILE_ADV_START(pProfileAdv, Prefix)
786#else
787# define STAM_PROFILE_ADV_START(pProfileAdv, Prefix) do { } while (0)
788#endif
789
790
791/** @def STAM_REL_PROFILE_ADV_STOP
792 * Samples the stop time of a profiling period and updates the sample.
793 *
794 * @param pProfileAdv Pointer to the STAMPROFILEADV structure to operate on.
795 * @param Prefix Identifier prefix used to internal variables.
796 */
797#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
798# define STAM_REL_PROFILE_ADV_STOP(pProfileAdv, Prefix) \
799 do { \
800 uint64_t Prefix##_tsStop; \
801 STAM_GET_TS(Prefix##_tsStop); \
802 if ((pProfileAdv)->tsStart) \
803 { \
804 uint64_t Prefix##_cTicks = Prefix##_tsStop - (pProfileAdv)->tsStart; \
805 (pProfileAdv)->tsStart = 0; \
806 (pProfileAdv)->Core.cTicks += Prefix##_cTicks; \
807 (pProfileAdv)->Core.cPeriods++; \
808 if ((pProfileAdv)->Core.cTicksMax < Prefix##_cTicks) \
809 (pProfileAdv)->Core.cTicksMax = Prefix##_cTicks; \
810 if ((pProfileAdv)->Core.cTicksMin > Prefix##_cTicks) \
811 (pProfileAdv)->Core.cTicksMin = Prefix##_cTicks; \
812 } \
813 } while (0)
814#else
815# define STAM_REL_PROFILE_ADV_STOP(pProfileAdv, Prefix) do { } while (0)
816#endif
817/** @def STAM_PROFILE_ADV_STOP
818 * Samples the stop time of a profiling period and updates the sample.
819 *
820 * @param pProfileAdv Pointer to the STAMPROFILEADV structure to operate on.
821 * @param Prefix Identifier prefix used to internal variables.
822 */
823#ifdef VBOX_WITH_STATISTICS
824# define STAM_PROFILE_ADV_STOP(pProfileAdv, Prefix) STAM_REL_PROFILE_ADV_STOP(pProfileAdv, Prefix)
825#else
826# define STAM_PROFILE_ADV_STOP(pProfileAdv, Prefix) do { } while (0)
827#endif
828
829
830/** @def STAM_REL_PROFILE_ADV_SUSPEND
831 * Suspends the sampling for a while. This can be useful to exclude parts
832 * covered by other samples without screwing up the count, and average+min times.
833 *
834 * @param pProfileAdv Pointer to the STAMPROFILEADV structure to operate on.
835 * @param Prefix Identifier prefix used to internal variables. The prefix
836 * must match that of the resume one since it stores the
837 * suspend time in a stack variable.
838 */
839#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
840# define STAM_REL_PROFILE_ADV_SUSPEND(pProfileAdv, Prefix) \
841 uint64_t Prefix##_tsSuspend; \
842 STAM_GET_TS(Prefix##_tsSuspend)
843#else
844# define STAM_REL_PROFILE_ADV_SUSPEND(pProfileAdv, Prefix) do { } while (0)
845#endif
846/** @def STAM_PROFILE_ADV_SUSPEND
847 * Suspends the sampling for a while. This can be useful to exclude parts
848 * covered by other samples without screwing up the count, and average+min times.
849 *
850 * @param pProfileAdv Pointer to the STAMPROFILEADV structure to operate on.
851 * @param Prefix Identifier prefix used to internal variables. The prefix
852 * must match that of the resume one since it stores the
853 * suspend time in a stack variable.
854 */
855#ifdef VBOX_WITH_STATISTICS
856# define STAM_PROFILE_ADV_SUSPEND(pProfileAdv, Prefix) STAM_REL_PROFILE_ADV_SUSPEND(pProfileAdv, Prefix)
857#else
858# define STAM_PROFILE_ADV_SUSPEND(pProfileAdv, Prefix) do { } while (0)
859#endif
860
861
862/** @def STAM_REL_PROFILE_ADV_RESUME
863 * Counter to STAM_REL_PROFILE_ADV_SUSPEND.
864 *
865 * @param pProfileAdv Pointer to the STAMPROFILEADV structure to operate on.
866 * @param Prefix Identifier prefix used to internal variables. This must
867 * match the one used with the SUSPEND!
868 */
869#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
870# define STAM_REL_PROFILE_ADV_RESUME(pProfileAdv, Prefix) \
871 do { \
872 uint64_t Prefix##_tsNow; \
873 STAM_GET_TS(Prefix##_tsNow); \
874 (pProfileAdv)->tsStart += Prefix##_tsNow - Prefix##_tsSuspend; \
875 } while (0)
876#else
877# define STAM_REL_PROFILE_ADV_RESUME(pProfileAdv, Prefix) do { } while (0)
878#endif
879/** @def STAM_PROFILE_ADV_RESUME
880 * Counter to STAM_PROFILE_ADV_SUSPEND.
881 *
882 * @param pProfileAdv Pointer to the STAMPROFILEADV structure to operate on.
883 * @param Prefix Identifier prefix used to internal variables. This must
884 * match the one used with the SUSPEND!
885 */
886#ifdef VBOX_WITH_STATISTICS
887# define STAM_PROFILE_ADV_RESUME(pProfileAdv, Prefix) STAM_REL_PROFILE_ADV_RESUME(pProfileAdv, Prefix)
888#else
889# define STAM_PROFILE_ADV_RESUME(pProfileAdv, Prefix) do { } while (0)
890#endif
891
892
893/** @def STAM_REL_PROFILE_ADV_STOP_EX
894 * Samples the stop time of a profiling period and updates both the sample
895 * and an attribution sample.
896 *
897 * @param pProfileAdv Pointer to the STAMPROFILEADV structure to operate on.
898 * @param pProfile2 Pointer to the STAMPROFILE structure which this
899 * interval should be attributed to as well. This may be NULL.
900 * @param Prefix Identifier prefix used to internal variables.
901 */
902#ifndef VBOX_WITHOUT_RELEASE_STATISTICS
903# define STAM_REL_PROFILE_ADV_STOP_EX(pProfileAdv, pProfile2, Prefix) \
904 do { \
905 uint64_t Prefix##_tsStop; \
906 STAM_GET_TS(Prefix##_tsStop); \
907 if ((pProfileAdv)->tsStart) \
908 { \
909 uint64_t Prefix##_cTicks = Prefix##_tsStop - (pProfileAdv)->tsStart; \
910 (pProfileAdv)->tsStart = 0; \
911 (pProfileAdv)->Core.cTicks += Prefix##_cTicks; \
912 (pProfileAdv)->Core.cPeriods++; \
913 if ((pProfileAdv)->Core.cTicksMax < Prefix##_cTicks) \
914 (pProfileAdv)->Core.cTicksMax = Prefix##_cTicks; \
915 if ((pProfileAdv)->Core.cTicksMin > Prefix##_cTicks) \
916 (pProfileAdv)->Core.cTicksMin = Prefix##_cTicks; \
917 if ((pProfile2)) \
918 { \
919 (pProfile2)->cTicks += Prefix##_cTicks; \
920 (pProfile2)->cPeriods++; \
921 if ((pProfile2)->cTicksMax < Prefix##_cTicks) \
922 (pProfile2)->cTicksMax = Prefix##_cTicks; \
923 if ((pProfile2)->cTicksMin > Prefix##_cTicks) \
924 (pProfile2)->cTicksMin = Prefix##_cTicks; \
925 } \
926 } \
927 } while (0)
928#else
929# define STAM_REL_PROFILE_ADV_STOP_EX(pProfileAdv, pProfile2, Prefix) do { } while (0)
930#endif
931/** @def STAM_PROFILE_ADV_STOP_EX
932 * Samples the stop time of a profiling period and updates both the sample
933 * and an attribution sample.
934 *
935 * @param pProfileAdv Pointer to the STAMPROFILEADV structure to operate on.
936 * @param pProfile2 Pointer to the STAMPROFILE structure which this
937 * interval should be attributed to as well. This may be NULL.
938 * @param Prefix Identifier prefix used to internal variables.
939 */
940#ifdef VBOX_WITH_STATISTICS
941# define STAM_PROFILE_ADV_STOP_EX(pProfileAdv, pProfile2, Prefix) STAM_REL_PROFILE_ADV_STOP_EX(pProfileAdv, pProfile2, Prefix)
942#else
943# define STAM_PROFILE_ADV_STOP_EX(pProfileAdv, pProfile2, Prefix) do { } while (0)
944#endif
945
946
947/**
948 * Ratio of A to B, uint32_t types.
949 * @remark Use STAM_STATS or STAM_REL_STATS for modifying A & B values.
950 */
951typedef struct STAMRATIOU32
952{
953 /** Sample A. */
954 uint32_t volatile u32A;
955 /** Sample B. */
956 uint32_t volatile u32B;
957} STAMRATIOU32;
958/** Pointer to a uint32_t ratio. */
959typedef STAMRATIOU32 *PSTAMRATIOU32;
960/** Pointer to const a uint32_t ratio. */
961typedef const STAMRATIOU32 *PCSTAMRATIOU32;
962
963
964
965
966/** @defgroup grp_stam_r3 The STAM Host Context Ring 3 API
967 * @ingroup grp_stam
968 * @{
969 */
970
971VMMR3DECL(int) STAMR3InitUVM(PUVM pUVM);
972VMMR3DECL(void) STAMR3TermUVM(PUVM pUVM);
973VMMR3DECL(int) STAMR3RegisterU(PUVM pUVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
974 const char *pszName, STAMUNIT enmUnit, const char *pszDesc);
975VMMR3DECL(int) STAMR3Register(PVM pVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
976 const char *pszName, STAMUNIT enmUnit, const char *pszDesc);
977
978/** @def STAM_REL_REG
979 * Registers a statistics sample.
980 *
981 * @param pVM VM Handle.
982 * @param pvSample Pointer to the sample.
983 * @param enmType Sample type. This indicates what pvSample is pointing at.
984 * @param pszName Sample name. The name is on this form "/<component>/<sample>".
985 * Further nesting is possible.
986 * @param enmUnit Sample unit.
987 * @param pszDesc Sample description.
988 */
989#define STAM_REL_REG(pVM, pvSample, enmType, pszName, enmUnit, pszDesc) \
990 STAM_REL_STATS({ int rcStam = STAMR3Register(pVM, pvSample, enmType, STAMVISIBILITY_ALWAYS, pszName, enmUnit, pszDesc); \
991 AssertRC(rcStam); })
992/** @def STAM_REG
993 * Registers a statistics sample if statistics are enabled.
994 *
995 * @param pVM VM Handle.
996 * @param pvSample Pointer to the sample.
997 * @param enmType Sample type. This indicates what pvSample is pointing at.
998 * @param pszName Sample name. The name is on this form "/<component>/<sample>".
999 * Further nesting is possible.
1000 * @param enmUnit Sample unit.
1001 * @param pszDesc Sample description.
1002 */
1003#define STAM_REG(pVM, pvSample, enmType, pszName, enmUnit, pszDesc) \
1004 STAM_STATS({STAM_REL_REG(pVM, pvSample, enmType, pszName, enmUnit, pszDesc);})
1005
1006/** @def STAM_REL_REG_USED
1007 * Registers a statistics sample which only shows when used.
1008 *
1009 * @param pVM VM Handle.
1010 * @param pvSample Pointer to the sample.
1011 * @param enmType Sample type. This indicates what pvSample is pointing at.
1012 * @param pszName Sample name. The name is on this form "/<component>/<sample>".
1013 * Further nesting is possible.
1014 * @param enmUnit Sample unit.
1015 * @param pszDesc Sample description.
1016 */
1017#define STAM_REL_REG_USED(pVM, pvSample, enmType, pszName, enmUnit, pszDesc) \
1018 STAM_REL_STATS({ int rcStam = STAMR3Register(pVM, pvSample, enmType, STAMVISIBILITY_USED, pszName, enmUnit, pszDesc); \
1019 AssertRC(rcStam);})
1020/** @def STAM_REG_USED
1021 * Registers a statistics sample which only shows when used, if statistics are enabled.
1022 *
1023 * @param pVM VM Handle.
1024 * @param pvSample Pointer to the sample.
1025 * @param enmType Sample type. This indicates what pvSample is pointing at.
1026 * @param pszName Sample name. The name is on this form "/<component>/<sample>".
1027 * Further nesting is possible.
1028 * @param enmUnit Sample unit.
1029 * @param pszDesc Sample description.
1030 */
1031#define STAM_REG_USED(pVM, pvSample, enmType, pszName, enmUnit, pszDesc) \
1032 STAM_STATS({ STAM_REL_REG_USED(pVM, pvSample, enmType, pszName, enmUnit, pszDesc); })
1033
1034VMMR3DECL(int) STAMR3RegisterFU(PUVM pUVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1035 const char *pszDesc, const char *pszName, ...);
1036VMMR3DECL(int) STAMR3RegisterF(PVM pVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1037 const char *pszDesc, const char *pszName, ...);
1038VMMR3DECL(int) STAMR3RegisterVU(PUVM pUVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1039 const char *pszDesc, const char *pszName, va_list args);
1040VMMR3DECL(int) STAMR3RegisterV(PVM pVM, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1041 const char *pszDesc, const char *pszName, va_list args);
1042
1043/**
1044 * Resets the sample.
1045 * @param pVM The VM handle.
1046 * @param pvSample The sample registered using STAMR3RegisterCallback.
1047 */
1048typedef void FNSTAMR3CALLBACKRESET(PVM pVM, void *pvSample);
1049/** Pointer to a STAM sample reset callback. */
1050typedef FNSTAMR3CALLBACKRESET *PFNSTAMR3CALLBACKRESET;
1051
1052/**
1053 * Prints the sample into the buffer.
1054 *
1055 * @param pVM The VM handle.
1056 * @param pvSample The sample registered using STAMR3RegisterCallback.
1057 * @param pszBuf The buffer to print into.
1058 * @param cchBuf The size of the buffer.
1059 */
1060typedef void FNSTAMR3CALLBACKPRINT(PVM pVM, void *pvSample, char *pszBuf, size_t cchBuf);
1061/** Pointer to a STAM sample print callback. */
1062typedef FNSTAMR3CALLBACKPRINT *PFNSTAMR3CALLBACKPRINT;
1063
1064VMMR3DECL(int) STAMR3RegisterCallback(PVM pVM, void *pvSample, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1065 PFNSTAMR3CALLBACKRESET pfnReset, PFNSTAMR3CALLBACKPRINT pfnPrint,
1066 const char *pszDesc, const char *pszName, ...);
1067VMMR3DECL(int) STAMR3RegisterCallbackV(PVM pVM, void *pvSample, STAMVISIBILITY enmVisibility, STAMUNIT enmUnit,
1068 PFNSTAMR3CALLBACKRESET pfnReset, PFNSTAMR3CALLBACKPRINT pfnPrint,
1069 const char *pszDesc, const char *pszName, va_list args);
1070VMMR3DECL(int) STAMR3DeregisterU(PUVM pUVM, void *pvSample);
1071VMMR3DECL(int) STAMR3Deregister(PVM pVM, void *pvSample);
1072
1073/** @def STAM_REL_DEREG
1074 * Deregisters a statistics sample if statistics are enabled.
1075 *
1076 * @param pVM VM Handle.
1077 * @param pvSample Pointer to the sample.
1078 */
1079#define STAM_REL_DEREG(pVM, pvSample) \
1080 STAM_REL_STATS({ int rcStam = STAMR3Deregister(pVM, pvSample); AssertRC(rcStam); })
1081/** @def STAM_DEREG
1082 * Deregisters a statistics sample if statistics are enabled.
1083 *
1084 * @param pVM VM Handle.
1085 * @param pvSample Pointer to the sample.
1086 */
1087#define STAM_DEREG(pVM, pvSample) \
1088 STAM_STATS({ STAM_REL_DEREG(pVM, pvSample); })
1089
1090VMMR3DECL(int) STAMR3ResetU(PUVM pUVM, const char *pszPat);
1091VMMR3DECL(int) STAMR3Reset(PVM pVM, const char *pszPat);
1092VMMR3DECL(int) STAMR3SnapshotU(PUVM pUVM, const char *pszPat, char **ppszSnapshot, size_t *pcchSnapshot, bool fWithDesc);
1093VMMR3DECL(int) STAMR3Snapshot(PVM pVM, const char *pszPat, char **ppszSnapshot, size_t *pcchSnapshot, bool fWithDesc);
1094VMMR3DECL(int) STAMR3SnapshotFreeU(PUVM pUVM, char *pszSnapshot);
1095VMMR3DECL(int) STAMR3SnapshotFree(PVM pVM, char *pszSnapshot);
1096VMMR3DECL(int) STAMR3DumpU(PUVM pUVM, const char *pszPat);
1097VMMR3DECL(int) STAMR3Dump(PVM pVM, const char *pszPat);
1098VMMR3DECL(int) STAMR3DumpToReleaseLogU(PUVM pUVM, const char *pszPat);
1099VMMR3DECL(int) STAMR3DumpToReleaseLog(PVM pVM, const char *pszPat);
1100VMMR3DECL(int) STAMR3PrintU(PUVM pUVM, const char *pszPat);
1101VMMR3DECL(int) STAMR3Print(PVM pVM, const char *pszPat);
1102
1103/**
1104 * Callback function for STAMR3Enum().
1105 *
1106 * @returns non-zero to halt the enumeration.
1107 *
1108 * @param pszName The name of the sample.
1109 * @param enmType The type.
1110 * @param pvSample Pointer to the data. enmType indicates the format of this data.
1111 * @param enmUnit The unit.
1112 * @param enmVisibility The visibility.
1113 * @param pszDesc The description.
1114 * @param pvUser The pvUser argument given to STAMR3Enum().
1115 */
1116typedef DECLCALLBACK(int) FNSTAMR3ENUM(const char *pszName, STAMTYPE enmType, void *pvSample, STAMUNIT enmUnit,
1117 STAMVISIBILITY enmVisiblity, const char *pszDesc, void *pvUser);
1118/** Pointer to a FNSTAMR3ENUM(). */
1119typedef FNSTAMR3ENUM *PFNSTAMR3ENUM;
1120
1121VMMR3DECL(int) STAMR3EnumU(PUVM pUVM, const char *pszPat, PFNSTAMR3ENUM pfnEnum, void *pvUser);
1122VMMR3DECL(int) STAMR3Enum(PVM pVM, const char *pszPat, PFNSTAMR3ENUM pfnEnum, void *pvUser);
1123VMMR3DECL(const char *) STAMR3GetUnit(STAMUNIT enmUnit);
1124
1125/** @} */
1126
1127/** @} */
1128
1129RT_C_DECLS_END
1130
1131#endif
1132
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use