stam.h@ 26003

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

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: