log.h@ 57974

Last change on this file since 57974 was 57974, checked in by vboxsync, 9 years ago
IPRT: Some more doxygen fixes.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 85.9 KB

Line
1	/** @file
2	* IPRT - Logging.
3	*/
4
5	/*
6	* Copyright (C) 2006-2015 Oracle Corporation
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
26	#ifndef ___iprt_log_h
27	#define ___iprt_log_h
28
29	#include <iprt/cdefs.h>
30	#include <iprt/types.h>
31	#include <iprt/stdarg.h>
32
33	RT_C_DECLS_BEGIN
34
35	/** @defgroup grp_rt_log RTLog - Logging
36	* @ingroup grp_rt
37	* @{
38	*/
39
40	/**
41	* IPRT Logging Groups.
42	* (Remember to update RT_LOGGROUP_NAMES!)
43	*
44	* @remark It should be pretty obvious, but just to have
45	* mentioned it, the values are sorted alphabetically (using the
46	* english alphabet) except for _DEFAULT which is always first.
47	*
48	* If anyone might be wondering what the alphabet looks like:
49	* a b c d e f g h i j k l m n o p q r s t u v w x y z
50	*/
51	typedef enum RTLOGGROUP
52	{
53	/** Default logging group. */
54	RTLOGGROUP_DEFAULT,
55	RTLOGGROUP_CRYPTO,
56	RTLOGGROUP_DBG,
57	RTLOGGROUP_DBG_DWARF,
58	RTLOGGROUP_DIR,
59	RTLOGGROUP_FILE,
60	RTLOGGROUP_FS,
61	RTLOGGROUP_HTTP,
62	RTLOGGROUP_LDR,
63	RTLOGGROUP_PATH,
64	RTLOGGROUP_PROCESS,
65	RTLOGGROUP_SYMLINK,
66	RTLOGGROUP_THREAD,
67	RTLOGGROUP_TIME,
68	RTLOGGROUP_TIMER,
69	RTLOGGROUP_ZIP = 31,
70	RTLOGGROUP_FIRST_USER = 32
71	} RTLOGGROUP;
72
73	/** @def RT_LOGGROUP_NAMES
74	* IPRT Logging group names.
75	*
76	* Must correspond 100% to RTLOGGROUP!
77	* Don't forget commas!
78	*
79	* @remark It should be pretty obvious, but just to have
80	* mentioned it, the values are sorted alphabetically (using the
81	* english alphabet) except for _DEFAULT which is always first.
82	*
83	* If anyone might be wondering what the alphabet looks like:
84	* a b c d e f g h i j k l m n o p q r s t u v w x y z
85	*/
86	#define RT_LOGGROUP_NAMES \
87	"DEFAULT", \
88	"RT_CRYPTO", \
89	"RT_DBG", \
90	"RT_DBG_DWARF", \
91	"RT_DIR", \
92	"RT_FILE", \
93	"RT_FS", \
94	"RT_HTTP", \
95	"RT_LDR", \
96	"RT_PATH", \
97	"RT_PROCESS", \
98	"RT_SYMLINK", \
99	"RT_THREAD", \
100	"RT_TIME", \
101	"RT_TIMER", \
102	"RT_15", \
103	"RT_16", \
104	"RT_17", \
105	"RT_18", \
106	"RT_19", \
107	"RT_20", \
108	"RT_21", \
109	"RT_22", \
110	"RT_23", \
111	"RT_24", \
112	"RT_25", \
113	"RT_26", \
114	"RT_27", \
115	"RT_28", \
116	"RT_29", \
117	"RT_30", \
118	"RT_ZIP" \
119
120
121	/** @def LOG_GROUP
122	* Active logging group.
123	*/
124	#ifndef LOG_GROUP
125	# define LOG_GROUP RTLOGGROUP_DEFAULT
126	#endif
127
128	/** @def LOG_FN_FMT
129	* You can use this to specify you desired way of printing __PRETTY_FUNCTION__
130	* if you dislike the default one.
131	*/
132	#ifndef LOG_FN_FMT
133	# define LOG_FN_FMT "%Rfn"
134	#endif
135
136	#ifdef LOG_INSTANCE
137	# error "LOG_INSTANCE is no longer supported."
138	#endif
139	#ifdef LOG_REL_INSTANCE
140	# error "LOG_REL_INSTANCE is no longer supported."
141	#endif
142
143	/** Logger structure. */
144	#ifdef IN_RC
145	typedef struct RTLOGGERRC RTLOGGER;
146	#else
147	typedef struct RTLOGGER RTLOGGER;
148	#endif
149	/** Pointer to logger structure. */
150	typedef RTLOGGER *PRTLOGGER;
151	/** Pointer to const logger structure. */
152	typedef const RTLOGGER *PCRTLOGGER;
153
154
155	/** Guest context logger structure. */
156	typedef struct RTLOGGERRC RTLOGGERRC;
157	/** Pointer to guest context logger structure. */
158	typedef RTLOGGERRC *PRTLOGGERRC;
159	/** Pointer to const guest context logger structure. */
160	typedef const RTLOGGERRC *PCRTLOGGERRC;
161
162
163	/**
164	* Logger phase.
165	*
166	* Used for signalling the log header/footer callback what to do.
167	*/
168	typedef enum RTLOGPHASE
169	{
170	/** Begin of the logging. */
171	RTLOGPHASE_BEGIN = 0,
172	/** End of the logging. */
173	RTLOGPHASE_END,
174	/** Before rotating the log file. */
175	RTLOGPHASE_PREROTATE,
176	/** After rotating the log file. */
177	RTLOGPHASE_POSTROTATE,
178	/** 32-bit type blow up hack. */
179	RTLOGPHASE_32BIT_HACK = 0x7fffffff
180	} RTLOGPHASE;
181
182
183	/**
184	* Logger function.
185	*
186	* @param pszFormat Format string.
187	* @param ... Optional arguments as specified in the format string.
188	*/
189	typedef DECLCALLBACK(void) FNRTLOGGER(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
190	/** Pointer to logger function. */
191	typedef FNRTLOGGER *PFNRTLOGGER;
192
193	/**
194	* Flush function.
195	*
196	* @param pLogger Pointer to the logger instance which is to be flushed.
197	*/
198	typedef DECLCALLBACK(void) FNRTLOGFLUSH(PRTLOGGER pLogger);
199	/** Pointer to flush function. */
200	typedef FNRTLOGFLUSH *PFNRTLOGFLUSH;
201
202	/**
203	* Flush function.
204	*
205	* @param pLogger Pointer to the logger instance which is to be flushed.
206	*/
207	typedef DECLCALLBACK(void) FNRTLOGFLUSHGC(PRTLOGGERRC pLogger);
208	/** Pointer to logger function. */
209	typedef RCPTRTYPE(FNRTLOGFLUSHGC *) PFNRTLOGFLUSHGC;
210
211	/**
212	* Header/footer message callback.
213	*
214	* @param pLogger Pointer to the logger instance.
215	* @param pszFormat Format string.
216	* @param ... Optional arguments specified in the format string.
217	*/
218	typedef DECLCALLBACK(void) FNRTLOGPHASEMSG(PRTLOGGER pLogger, const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(2, 3);
219	/** Pointer to header/footer message callback function. */
220	typedef FNRTLOGPHASEMSG *PFNRTLOGPHASEMSG;
221
222	/**
223	* Log file header/footer callback.
224	*
225	* @param pLogger Pointer to the logger instance.
226	* @param enmLogPhase Indicates at what time the callback is invoked.
227	* @param pfnLogPhaseMsg Callback for writing the header/footer (RTLogPrintf
228	* and others are out of bounds).
229	*/
230	typedef DECLCALLBACK(void) FNRTLOGPHASE(PRTLOGGER pLogger, RTLOGPHASE enmLogPhase, PFNRTLOGPHASEMSG pfnLogPhaseMsg);
231	/** Pointer to log header/footer callback function. */
232	typedef FNRTLOGPHASE *PFNRTLOGPHASE;
233
234	/**
235	* Custom log prefix callback.
236	*
237	*
238	* @returns The number of chars written.
239	*
240	* @param pLogger Pointer to the logger instance.
241	* @param pchBuf Output buffer pointer.
242	* No need to terminate the output.
243	* @param cchBuf The size of the output buffer.
244	* @param pvUser The user argument.
245	*/
246	typedef DECLCALLBACK(size_t) FNRTLOGPREFIX(PRTLOGGER pLogger, char pchBuf, size_t cchBuf, void pvUser);
247	/** Pointer to prefix callback function. */
248	typedef FNRTLOGPREFIX *PFNRTLOGPREFIX;
249
250
251
252	/**
253	* Logger instance structure for raw-mode context (RC).
254	*/
255	struct RTLOGGERRC
256	{
257	/** Pointer to temporary scratch buffer.
258	* This is used to format the log messages. */
259	char achScratch[32768];
260	/** Current scratch buffer position. */
261	uint32_t offScratch;
262	/** This is set if a prefix is pending. */
263	bool fPendingPrefix;
264	bool afAlignment[3];
265	/** Pointer to the logger function.
266	* This is actually pointer to a wrapper which will push a pointer to the
267	* instance pointer onto the stack before jumping to the real logger function.
268	* A very unfortunate hack to work around the missing variadic macro support in C++. */
269	RCPTRTYPE(PFNRTLOGGER) pfnLogger;
270	/** Pointer to the flush function. */
271	PFNRTLOGFLUSHGC pfnFlush;
272	/** Magic number (RTLOGGERRC_MAGIC). */
273	uint32_t u32Magic;
274	/** Logger instance flags - RTLOGFLAGS. */
275	uint32_t fFlags;
276	/** Number of groups in the afGroups member. */
277	uint32_t cGroups;
278	/** Group flags array - RTLOGGRPFLAGS.
279	* This member have variable length and may extend way beyond
280	* the declared size of 1 entry. */
281	uint32_t afGroups[1];
282	};
283
284	/** RTLOGGERRC::u32Magic value. (John Rogers Searle) */
285	#define RTLOGGERRC_MAGIC 0x19320731
286
287
288
289	#ifndef IN_RC
290
291	/** Pointer to internal logger bits. */
292	typedef struct RTLOGGERINTERNAL *PRTLOGGERINTERNAL;
293
294	/**
295	* Logger instance structure.
296	*/
297	struct RTLOGGER
298	{
299	/** Pointer to temporary scratch buffer.
300	* This is used to format the log messages. */
301	char achScratch[49152];
302	/** Current scratch buffer position. */
303	uint32_t offScratch;
304	/** Magic number. */
305	uint32_t u32Magic;
306	/** Logger instance flags - RTLOGFLAGS. */
307	uint32_t fFlags;
308	/** Destination flags - RTLOGDEST. */
309	uint32_t fDestFlags;
310	/** Pointer to the internal bits of the logger.
311	* (The memory is allocated in the same block as RTLOGGER.) */
312	PRTLOGGERINTERNAL pInt;
313	/** Pointer to the logger function (used in non-C99 mode only).
314	*
315	* This is actually pointer to a wrapper which will push a pointer to the
316	* instance pointer onto the stack before jumping to the real logger function.
317	* A very unfortunate hack to work around the missing variadic macro
318	* support in older C++/C standards. (The memory is allocated using
319	* RTMemExecAlloc(), except for agnostic R0 code.) */
320	PFNRTLOGGER pfnLogger;
321	/** Number of groups in the afGroups and papszGroups members. */
322	uint32_t cGroups;
323	/** Group flags array - RTLOGGRPFLAGS.
324	* This member have variable length and may extend way beyond
325	* the declared size of 1 entry. */
326	uint32_t afGroups[1];
327	};
328
329	/** RTLOGGER::u32Magic value. (Avram Noam Chomsky) */
330	# define RTLOGGER_MAGIC UINT32_C(0x19281207)
331
332	#endif /* !IN_RC */
333
334
335	/**
336	* Logger flags.
337	*/
338	typedef enum RTLOGFLAGS
339	{
340	/** The logger instance is disabled for normal output. */
341	RTLOGFLAGS_DISABLED = 0x00000001,
342	/** The logger instance is using buffered output. */
343	RTLOGFLAGS_BUFFERED = 0x00000002,
344	/** The logger instance expands LF to CR/LF. */
345	RTLOGFLAGS_USECRLF = 0x00000010,
346	/** Append to the log destination where applicable. */
347	RTLOGFLAGS_APPEND = 0x00000020,
348	/** Show relative timestamps with PREFIX_TSC and PREFIX_TS */
349	RTLOGFLAGS_REL_TS = 0x00000040,
350	/** Show decimal timestamps with PREFIX_TSC and PREFIX_TS */
351	RTLOGFLAGS_DECIMAL_TS = 0x00000080,
352	/** Open the file in write through mode. */
353	RTLOGFLAGS_WRITE_THROUGH = 0x00000100,
354	/** Flush the file to disk when flushing the buffer. */
355	RTLOGFLAGS_FLUSH = 0x00000200,
356	/** Restrict the number of log entries per group. */
357	RTLOGFLAGS_RESTRICT_GROUPS = 0x00000400,
358	/** New lines should be prefixed with the write and read lock counts. */
359	RTLOGFLAGS_PREFIX_LOCK_COUNTS = 0x00008000,
360	/** New lines should be prefixed with the CPU id (ApicID on intel/amd). */
361	RTLOGFLAGS_PREFIX_CPUID = 0x00010000,
362	/** New lines should be prefixed with the native process id. */
363	RTLOGFLAGS_PREFIX_PID = 0x00020000,
364	/** New lines should be prefixed with group flag number causing the output. */
365	RTLOGFLAGS_PREFIX_FLAG_NO = 0x00040000,
366	/** New lines should be prefixed with group flag name causing the output. */
367	RTLOGFLAGS_PREFIX_FLAG = 0x00080000,
368	/** New lines should be prefixed with group number. */
369	RTLOGFLAGS_PREFIX_GROUP_NO = 0x00100000,
370	/** New lines should be prefixed with group name. */
371	RTLOGFLAGS_PREFIX_GROUP = 0x00200000,
372	/** New lines should be prefixed with the native thread id. */
373	RTLOGFLAGS_PREFIX_TID = 0x00400000,
374	/** New lines should be prefixed with thread name. */
375	RTLOGFLAGS_PREFIX_THREAD = 0x00800000,
376	/** New lines should be prefixed with data from a custom callback. */
377	RTLOGFLAGS_PREFIX_CUSTOM = 0x01000000,
378	/** New lines should be prefixed with formatted timestamp since program start. */
379	RTLOGFLAGS_PREFIX_TIME_PROG = 0x04000000,
380	/** New lines should be prefixed with formatted timestamp (UCT). */
381	RTLOGFLAGS_PREFIX_TIME = 0x08000000,
382	/** New lines should be prefixed with milliseconds since program start. */
383	RTLOGFLAGS_PREFIX_MS_PROG = 0x10000000,
384	/** New lines should be prefixed with timestamp. */
385	RTLOGFLAGS_PREFIX_TSC = 0x20000000,
386	/** New lines should be prefixed with timestamp. */
387	RTLOGFLAGS_PREFIX_TS = 0x40000000,
388	/** The prefix mask. */
389	RTLOGFLAGS_PREFIX_MASK = 0x7dff8000
390	} RTLOGFLAGS;
391
392	/**
393	* Logger per group flags.
394	*
395	* @remarks We only use the lower 16 bits here. We'll be combining it with the
396	* group number in a few places.
397	*/
398	typedef enum RTLOGGRPFLAGS
399	{
400	/** Enabled. */
401	RTLOGGRPFLAGS_ENABLED = 0x0001,
402	/** Flow logging. */
403	RTLOGGRPFLAGS_FLOW = 0x0002,
404	/** Warnings logging. */
405	RTLOGGRPFLAGS_WARN = 0x0004,
406	/* 0x0008 for later. */
407	/** Level 1 logging. */
408	RTLOGGRPFLAGS_LEVEL_1 = 0x0010,
409	/** Level 2 logging. */
410	RTLOGGRPFLAGS_LEVEL_2 = 0x0020,
411	/** Level 3 logging. */
412	RTLOGGRPFLAGS_LEVEL_3 = 0x0040,
413	/** Level 4 logging. */
414	RTLOGGRPFLAGS_LEVEL_4 = 0x0080,
415	/** Level 5 logging. */
416	RTLOGGRPFLAGS_LEVEL_5 = 0x0100,
417	/** Level 6 logging. */
418	RTLOGGRPFLAGS_LEVEL_6 = 0x0200,
419	/** Level 7 logging. */
420	RTLOGGRPFLAGS_LEVEL_7 = 0x0400,
421	/** Level 8 logging. */
422	RTLOGGRPFLAGS_LEVEL_8 = 0x0800,
423	/** Level 9 logging. */
424	RTLOGGRPFLAGS_LEVEL_9 = 0x1000,
425	/** Level 10 logging. */
426	RTLOGGRPFLAGS_LEVEL_10 = 0x2000,
427	/** Level 11 logging. */
428	RTLOGGRPFLAGS_LEVEL_11 = 0x4000,
429	/** Level 12 logging. */
430	RTLOGGRPFLAGS_LEVEL_12 = 0x8000,
431
432	/** Restrict the number of log entries. */
433	RTLOGGRPFLAGS_RESTRICT = 0x40000000,
434	/** Blow up the type. */
435	RTLOGGRPFLAGS_32BIT_HACK = 0x7fffffff
436	} RTLOGGRPFLAGS;
437
438	/**
439	* Logger destination type.
440	*/
441	typedef enum RTLOGDEST
442	{
443	/** Log to file. */
444	RTLOGDEST_FILE = 0x00000001,
445	/** Log to stdout. */
446	RTLOGDEST_STDOUT = 0x00000002,
447	/** Log to stderr. */
448	RTLOGDEST_STDERR = 0x00000004,
449	/** Log to debugger (win32 only). */
450	RTLOGDEST_DEBUGGER = 0x00000008,
451	/** Log to com port. */
452	RTLOGDEST_COM = 0x00000010,
453	/** Log a memory ring buffer. */
454	RTLOGDEST_RINGBUF = 0x00000020,
455	/** Just a dummy flag to be used when no other flag applies. */
456	RTLOGDEST_DUMMY = 0x20000000,
457	/** Log to a user defined output stream. */
458	RTLOGDEST_USER = 0x40000000
459	} RTLOGDEST;
460
461
462	RTDECL(void) RTLogPrintfEx(void *pvInstance, unsigned fFlags, unsigned iGroup,
463	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(4, 5);
464
465
466	#ifdef DOXYGEN_RUNNING
467	# define LOG_DISABLED
468	# define LOG_ENABLED
469	# define LOG_ENABLE_FLOW
470	#endif
471
472	/** @def LOG_DISABLED
473	* Use this compile time define to disable all logging macros. It can
474	* be overridden for each of the logging macros by the LOG_ENABLE*
475	* compile time defines.
476	*/
477
478	/** @def LOG_ENABLED
479	* Use this compile time define to enable logging when not in debug mode
480	* or LOG_DISABLED is set.
481	* This will enabled Log() only.
482	*/
483
484	/** @def LOG_ENABLE_FLOW
485	* Use this compile time define to enable flow logging when not in
486	* debug mode or LOG_DISABLED is defined.
487	* This will enable LogFlow() only.
488	*/
489
490	/*
491	* Determine whether logging is enabled and forcefully normalize the indicators.
492	*/
493	#if (defined(DEBUG) \|\| defined(LOG_ENABLED)) && !defined(LOG_DISABLED)
494	# undef LOG_DISABLED
495	# undef LOG_ENABLED
496	# define LOG_ENABLED
497	#else
498	# undef LOG_ENABLED
499	# undef LOG_DISABLED
500	# define LOG_DISABLED
501	#endif
502
503
504	/** @def LOG_USE_C99
505	* Governs the use of variadic macros.
506	*/
507	#ifndef LOG_USE_C99
508	# if defined(RT_ARCH_AMD64) \|\| defined(RT_OS_DARWIN) \|\| defined(RT_ARCH_SPARC) \|\| defined(RT_ARCH_SPARC64)
509	# define LOG_USE_C99
510	# endif
511	#endif
512
513
514	/** @name Macros for checking whether a log level is enabled.
515	* @{ */
516	/** @def LogIsItEnabled
517	* Checks whether the specified logging group is enabled or not.
518	*/
519	#ifdef LOG_ENABLED
520	# define LogIsItEnabled(a_fFlags, a_iGroup) ( RTLogDefaultInstanceEx(RT_MAKE_U32(a_fFlags, a_iGroup)) != NULL )
521	#else
522	# define LogIsItEnabled(a_fFlags, a_iGroup) (false)
523	#endif
524
525	/** @def LogIsEnabled
526	* Checks whether level 1 logging is enabled.
527	*/
528	#define LogIsEnabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP)
529
530	/** @def LogIs2Enabled
531	* Checks whether level 2 logging is enabled.
532	*/
533	#define LogIs2Enabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP)
534
535	/** @def LogIs3Enabled
536	* Checks whether level 3 logging is enabled.
537	*/
538	#define LogIs3Enabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP)
539
540	/** @def LogIs4Enabled
541	* Checks whether level 4 logging is enabled.
542	*/
543	#define LogIs4Enabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP)
544
545	/** @def LogIs5Enabled
546	* Checks whether level 5 logging is enabled.
547	*/
548	#define LogIs5Enabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP)
549
550	/** @def LogIs6Enabled
551	* Checks whether level 6 logging is enabled.
552	*/
553	#define LogIs6Enabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP)
554
555	/** @def LogIs7Enabled
556	* Checks whether level 7 logging is enabled.
557	*/
558	#define LogIs7Enabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_7, LOG_GROUP)
559
560	/** @def LogIs8Enabled
561	* Checks whether level 8 logging is enabled.
562	*/
563	#define LogIs8Enabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_8, LOG_GROUP)
564
565	/** @def LogIs9Enabled
566	* Checks whether level 9 logging is enabled.
567	*/
568	#define LogIs9Enabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_9, LOG_GROUP)
569
570	/** @def LogIs10Enabled
571	* Checks whether level 10 logging is enabled.
572	*/
573	#define LogIs10Enabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_10, LOG_GROUP)
574
575	/** @def LogIs11Enabled
576	* Checks whether level 11 logging is enabled.
577	*/
578	#define LogIs11Enabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_11, LOG_GROUP)
579
580	/** @def LogIs12Enabled
581	* Checks whether level 12 logging is enabled.
582	*/
583	#define LogIs12Enabled() LogIsItEnabled(RTLOGGRPFLAGS_LEVEL_12, LOG_GROUP)
584
585	/** @def LogIsFlowEnabled
586	* Checks whether execution flow logging is enabled.
587	*/
588	#define LogIsFlowEnabled() LogIsItEnabled(RTLOGGRPFLAGS_FLOW, LOG_GROUP)
589
590	/** @def LogIsWarnEnabled
591	* Checks whether execution flow logging is enabled.
592	*/
593	#define LogIsWarnEnabled() LogIsItEnabled(RTLOGGRPFLAGS_WARN, LOG_GROUP)
594	/** @} */
595
596
597	/** @def LogIt
598	* Write to specific logger if group enabled.
599	*/
600	#ifdef LOG_ENABLED
601	# if defined(LOG_USE_C99)
602	# define _LogRemoveParentheseis(...) __VA_ARGS__
603	# define _LogIt(a_fFlags, a_iGroup, ...) \
604	do \
605	{ \
606	register PRTLOGGER LogIt_pLogger = RTLogDefaultInstanceEx(RT_MAKE_U32(a_fFlags, a_iGroup)); \
607	if (RT_LIKELY(!LogIt_pLogger)) \
608	{ /* likely */ } \
609	else \
610	RTLogLoggerEx(LogIt_pLogger, a_fFlags, a_iGroup, __VA_ARGS__); \
611	} while (0)
612	# define LogIt(a_fFlags, a_iGroup, fmtargs) _LogIt(a_fFlags, a_iGroup, _LogRemoveParentheseis fmtargs)
613	# define _LogItAlways(a_fFlags, a_iGroup, ...) RTLogLoggerEx(NULL, a_fFlags, UINT32_MAX, __VA_ARGS__)
614	# define LogItAlways(a_fFlags, a_iGroup, fmtargs) _LogItAlways(a_fFlags, a_iGroup, _LogRemoveParentheseis fmtargs)
615	/** @todo invent a flag or something for skipping the group check so we can pass iGroup. LogItAlways. */
616	# else
617	# define LogIt(a_fFlags, a_iGroup, fmtargs) \
618	do \
619	{ \
620	register PRTLOGGER LogIt_pLogger = RTLogDefaultInstanceEx(RT_MAKE_U32(a_fFlags, a_iGroup)); \
621	if (RT_LIKELY(!LogIt_pLogger)) \
622	{ /* likely */ } \
623	else \
624	{ \
625	LogIt_pLogger->pfnLogger fmtargs; \
626	} \
627	} while (0)
628	# define LogItAlways(a_fFlags, a_iGroup, fmtargs) \
629	do \
630	{ \
631	register PRTLOGGER LogIt_pLogger = RTLogDefaultInstanceEx(RT_MAKE_U32(0, UINT16_MAX)); \
632	if (LogIt_pLogger) \
633	LogIt_pLogger->pfnLogger fmtargs; \
634	} while (0)
635	# endif
636	#else
637	# define LogIt(a_fFlags, a_iGroup, fmtargs) do { } while (0)
638	# define LogItAlways(a_fFlags, a_iGroup, fmtargs) do { } while (0)
639	# if defined(LOG_USE_C99)
640	# define _LogRemoveParentheseis(...) __VA_ARGS__
641	# define _LogIt(a_fFlags, a_iGroup, ...) do { } while (0)
642	# define _LogItAlways(a_fFlags, a_iGroup, ...) do { } while (0)
643	# endif
644	#endif
645
646
647	/** @name Basic logging macros
648	* @{ */
649	/** @def Log
650	* Level 1 logging that works regardless of the group settings.
651	*/
652	#define LogAlways(a) LogItAlways(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
653
654	/** @def Log
655	* Level 1 logging.
656	*/
657	#define Log(a) LogIt(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
658
659	/** @def Log2
660	* Level 2 logging.
661	*/
662	#define Log2(a) LogIt(RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a)
663
664	/** @def Log3
665	* Level 3 logging.
666	*/
667	#define Log3(a) LogIt(RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a)
668
669	/** @def Log4
670	* Level 4 logging.
671	*/
672	#define Log4(a) LogIt(RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a)
673
674	/** @def Log5
675	* Level 5 logging.
676	*/
677	#define Log5(a) LogIt(RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a)
678
679	/** @def Log6
680	* Level 6 logging.
681	*/
682	#define Log6(a) LogIt(RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a)
683
684	/** @def Log7
685	* Level 7 logging.
686	*/
687	#define Log7(a) LogIt(RTLOGGRPFLAGS_LEVEL_7, LOG_GROUP, a)
688
689	/** @def Log8
690	* Level 8 logging.
691	*/
692	#define Log8(a) LogIt(RTLOGGRPFLAGS_LEVEL_8, LOG_GROUP, a)
693
694	/** @def Log9
695	* Level 9 logging.
696	*/
697	#define Log9(a) LogIt(RTLOGGRPFLAGS_LEVEL_9, LOG_GROUP, a)
698
699	/** @def Log10
700	* Level 10 logging.
701	*/
702	#define Log10(a) LogIt(RTLOGGRPFLAGS_LEVEL_10, LOG_GROUP, a)
703
704	/** @def Log11
705	* Level 11 logging.
706	*/
707	#define Log11(a) LogIt(RTLOGGRPFLAGS_LEVEL_11, LOG_GROUP, a)
708
709	/** @def Log12
710	* Level 12 logging.
711	*/
712	#define Log12(a) LogIt(RTLOGGRPFLAGS_LEVEL_12, LOG_GROUP, a)
713
714	/** @def LogFlow
715	* Logging of execution flow.
716	*/
717	#define LogFlow(a) LogIt(RTLOGGRPFLAGS_FLOW, LOG_GROUP, a)
718
719	/** @def LogWarn
720	* Logging of warnings.
721	*/
722	#define LogWarn(a) LogIt(RTLOGGRPFLAGS_WARN, LOG_GROUP, a)
723	/** @} */
724
725
726	/** @name Logging macros prefixing the current function name.
727	* @{ */
728	/** @def LogFunc
729	* Level 1 logging inside C/C++ functions.
730	*
731	* Prepends the given log message with the function name followed by a
732	* semicolon and space.
733	*
734	* @param a Log message in format <tt>("string\n" [, args])</tt>.
735	*/
736	#ifdef LOG_USE_C99
737	# define LogFunc(a) _LogIt(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
738	#else
739	# define LogFunc(a) do { Log((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log(a); } while (0)
740	#endif
741
742	/** @def Log2Func
743	* Level 2 logging inside C/C++ functions.
744	*
745	* Prepends the given log message with the function name followed by a
746	* semicolon and space.
747	*
748	* @param a Log message in format <tt>("string\n" [, args])</tt>.
749	*/
750	#ifdef LOG_USE_C99
751	# define Log2Func(a) _LogIt(RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
752	#else
753	# define Log2Func(a) do { Log2((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log2(a); } while (0)
754	#endif
755
756	/** @def Log3Func
757	* Level 3 logging inside C/C++ functions.
758	*
759	* Prepends the given log message with the function name followed by a
760	* semicolon and space.
761	*
762	* @param a Log message in format <tt>("string\n" [, args])</tt>.
763	*/
764	#ifdef LOG_USE_C99
765	# define Log3Func(a) _LogIt(RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
766	#else
767	# define Log3Func(a) do { Log3((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log3(a); } while (0)
768	#endif
769
770	/** @def Log4Func
771	* Level 4 logging inside C/C++ functions.
772	*
773	* Prepends the given log message with the function name followed by a
774	* semicolon and space.
775	*
776	* @param a Log message in format <tt>("string\n" [, args])</tt>.
777	*/
778	#ifdef LOG_USE_C99
779	# define Log4Func(a) _LogIt(RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
780	#else
781	# define Log4Func(a) do { Log4((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log4(a); } while (0)
782	#endif
783
784	/** @def Log5Func
785	* Level 5 logging inside C/C++ functions.
786	*
787	* Prepends the given log message with the function name followed by a
788	* semicolon and space.
789	*
790	* @param a Log message in format <tt>("string\n" [, args])</tt>.
791	*/
792	#ifdef LOG_USE_C99
793	# define Log5Func(a) _LogIt(RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
794	#else
795	# define Log5Func(a) do { Log5((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log5(a); } while (0)
796	#endif
797
798	/** @def Log6Func
799	* Level 6 logging inside C/C++ functions.
800	*
801	* Prepends the given log message with the function name followed by a
802	* semicolon and space.
803	*
804	* @param a Log message in format <tt>("string\n" [, args])</tt>.
805	*/
806	#ifdef LOG_USE_C99
807	# define Log6Func(a) _LogIt(RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
808	#else
809	# define Log6Func(a) do { Log6((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log6(a); } while (0)
810	#endif
811
812	/** @def Log7Func
813	* Level 7 logging inside C/C++ functions.
814	*
815	* Prepends the given log message with the function name followed by a
816	* semicolon and space.
817	*
818	* @param a Log message in format <tt>("string\n" [, args])</tt>.
819	*/
820	#ifdef LOG_USE_C99
821	# define Log7Func(a) _LogIt(RTLOGGRPFLAGS_LEVEL_7, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
822	#else
823	# define Log7Func(a) do { Log7((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log7(a); } while (0)
824	#endif
825
826	/** @def Log8Func
827	* Level 8 logging inside C/C++ functions.
828	*
829	* Prepends the given log message with the function name followed by a
830	* semicolon and space.
831	*
832	* @param a Log message in format <tt>("string\n" [, args])</tt>.
833	*/
834	#ifdef LOG_USE_C99
835	# define Log8Func(a) _LogIt(RTLOGGRPFLAGS_LEVEL_8, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
836	#else
837	# define Log8Func(a) do { Log8((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log8(a); } while (0)
838	#endif
839
840	/** @def Log9Func
841	* Level 9 logging inside C/C++ functions.
842	*
843	* Prepends the given log message with the function name followed by a
844	* semicolon and space.
845	*
846	* @param a Log message in format <tt>("string\n" [, args])</tt>.
847	*/
848	#ifdef LOG_USE_C99
849	# define Log9Func(a) _LogIt(RTLOGGRPFLAGS_LEVEL_9, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
850	#else
851	# define Log9Func(a) do { Log9((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log9(a); } while (0)
852	#endif
853
854	/** @def Log10Func
855	* Level 10 logging inside C/C++ functions.
856	*
857	* Prepends the given log message with the function name followed by a
858	* semicolon and space.
859	*
860	* @param a Log message in format <tt>("string\n" [, args])</tt>.
861	*/
862	#ifdef LOG_USE_C99
863	# define Log10Func(a) _LogIt(RTLOGGRPFLAGS_LEVEL_10, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
864	#else
865	# define Log10Func(a) do { Log10((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log10(a); } while (0)
866	#endif
867
868	/** @def Log11Func
869	* Level 11 logging inside C/C++ functions.
870	*
871	* Prepends the given log message with the function name followed by a
872	* semicolon and space.
873	*
874	* @param a Log message in format <tt>("string\n" [, args])</tt>.
875	*/
876	#ifdef LOG_USE_C99
877	# define Log11Func(a) _LogIt(RTLOGGRPFLAGS_LEVEL_11, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
878	#else
879	# define Log11Func(a) do { Log11((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log11(a); } while (0)
880	#endif
881
882	/** @def Log12Func
883	* Level 12 logging inside C/C++ functions.
884	*
885	* Prepends the given log message with the function name followed by a
886	* semicolon and space.
887	*
888	* @param a Log message in format <tt>("string\n" [, args])</tt>.
889	*/
890	#ifdef LOG_USE_C99
891	# define Log12Func(a) _LogIt(RTLOGGRPFLAGS_LEVEL_12, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
892	#else
893	# define Log12Func(a) do { Log12((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log12(a); } while (0)
894	#endif
895
896	/** @def LogFlowFunc
897	* Macro to log the execution flow inside C/C++ functions.
898	*
899	* Prepends the given log message with the function name followed by
900	* a semicolon and space.
901	*
902	* @param a Log message in format <tt>("string\n" [, args])</tt>.
903	*/
904	#ifdef LOG_USE_C99
905	# define LogFlowFunc(a) \
906	_LogIt(RTLOGGRPFLAGS_FLOW, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
907	#else
908	# define LogFlowFunc(a) \
909	do { LogFlow((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
910	#endif
911
912	/** @def LogWarnFunc
913	* Macro to log a warning inside C/C++ functions.
914	*
915	* Prepends the given log message with the function name followed by
916	* a semicolon and space.
917	*
918	* @param a Log message in format <tt>("string\n" [, args])</tt>.
919	*/
920	#ifdef LOG_USE_C99
921	# define LogWarnFunc(a) \
922	_LogIt(RTLOGGRPFLAGS_WARN, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
923	#else
924	# define LogWarnFunc(a) \
925	do { LogFlow((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
926	#endif
927	/** @} */
928
929
930	/** @name Logging macros prefixing the this pointer value and method name.
931	* @{ */
932
933	/** @def LogThisFunc
934	* Level 1 logging inside a C++ non-static method, with object pointer and
935	* method name prefixed to the given message.
936	* @param a Log message in format <tt>("string\n" [, args])</tt>.
937	*/
938	#ifdef LOG_USE_C99
939	# define LogThisFunc(a) \
940	_LogIt(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
941	#else
942	# define LogThisFunc(a) do { Log(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log(a); } while (0)
943	#endif
944
945	/** @def Log2ThisFunc
946	* Level 2 logging inside a C++ non-static method, with object pointer and
947	* method name prefixed to the given message.
948	* @param a Log message in format <tt>("string\n" [, args])</tt>.
949	*/
950	#ifdef LOG_USE_C99
951	# define Log2ThisFunc(a) \
952	_LogIt(RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
953	#else
954	# define Log2ThisFunc(a) do { Log2(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log2(a); } while (0)
955	#endif
956
957	/** @def Log3ThisFunc
958	* Level 3 logging inside a C++ non-static method, with object pointer and
959	* method name prefixed to the given message.
960	* @param a Log message in format <tt>("string\n" [, args])</tt>.
961	*/
962	#ifdef LOG_USE_C99
963	# define Log3ThisFunc(a) \
964	_LogIt(RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
965	#else
966	# define Log3ThisFunc(a) do { Log3(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log3(a); } while (0)
967	#endif
968
969	/** @def Log4ThisFunc
970	* Level 4 logging inside a C++ non-static method, with object pointer and
971	* method name prefixed to the given message.
972	* @param a Log message in format <tt>("string\n" [, args])</tt>.
973	*/
974	#ifdef LOG_USE_C99
975	# define Log4ThisFunc(a) \
976	_LogIt(RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
977	#else
978	# define Log4ThisFunc(a) do { Log4(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log4(a); } while (0)
979	#endif
980
981	/** @def Log5ThisFunc
982	* Level 5 logging inside a C++ non-static method, with object pointer and
983	* method name prefixed to the given message.
984	* @param a Log message in format <tt>("string\n" [, args])</tt>.
985	*/
986	#ifdef LOG_USE_C99
987	# define Log5ThisFunc(a) \
988	_LogIt(RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
989	#else
990	# define Log5ThisFunc(a) do { Log5(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log5(a); } while (0)
991	#endif
992
993	/** @def Log6ThisFunc
994	* Level 6 logging inside a C++ non-static method, with object pointer and
995	* method name prefixed to the given message.
996	* @param a Log message in format <tt>("string\n" [, args])</tt>.
997	*/
998	#ifdef LOG_USE_C99
999	# define Log6ThisFunc(a) \
1000	_LogIt(RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1001	#else
1002	# define Log6ThisFunc(a) do { Log6(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log6(a); } while (0)
1003	#endif
1004
1005	/** @def Log7ThisFunc
1006	* Level 7 logging inside a C++ non-static method, with object pointer and
1007	* method name prefixed to the given message.
1008	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1009	*/
1010	#ifdef LOG_USE_C99
1011	# define Log7ThisFunc(a) \
1012	_LogIt(RTLOGGRPFLAGS_LEVEL_7, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1013	#else
1014	# define Log7ThisFunc(a) do { Log7(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log7(a); } while (0)
1015	#endif
1016
1017	/** @def Log8ThisFunc
1018	* Level 8 logging inside a C++ non-static method, with object pointer and
1019	* method name prefixed to the given message.
1020	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1021	*/
1022	#ifdef LOG_USE_C99
1023	# define Log8ThisFunc(a) \
1024	_LogIt(RTLOGGRPFLAGS_LEVEL_8, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1025	#else
1026	# define Log8ThisFunc(a) do { Log8(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log8(a); } while (0)
1027	#endif
1028
1029	/** @def Log9ThisFunc
1030	* Level 9 logging inside a C++ non-static method, with object pointer and
1031	* method name prefixed to the given message.
1032	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1033	*/
1034	#ifdef LOG_USE_C99
1035	# define Log9ThisFunc(a) \
1036	_LogIt(RTLOGGRPFLAGS_LEVEL_9, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1037	#else
1038	# define Log9ThisFunc(a) do { Log9(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log9(a); } while (0)
1039	#endif
1040
1041	/** @def Log10ThisFunc
1042	* Level 10 logging inside a C++ non-static method, with object pointer and
1043	* method name prefixed to the given message.
1044	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1045	*/
1046	#ifdef LOG_USE_C99
1047	# define Log10ThisFunc(a) \
1048	_LogIt(RTLOGGRPFLAGS_LEVEL_10, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1049	#else
1050	# define Log10ThisFunc(a) do { Log10(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log10(a); } while (0)
1051	#endif
1052
1053	/** @def Log11ThisFunc
1054	* Level 11 logging inside a C++ non-static method, with object pointer and
1055	* method name prefixed to the given message.
1056	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1057	*/
1058	#ifdef LOG_USE_C99
1059	# define Log11ThisFunc(a) \
1060	_LogIt(RTLOGGRPFLAGS_LEVEL_11, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1061	#else
1062	# define Log11ThisFunc(a) do { Log11(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log11(a); } while (0)
1063	#endif
1064
1065	/** @def Log12ThisFunc
1066	* Level 12 logging inside a C++ non-static method, with object pointer and
1067	* method name prefixed to the given message.
1068	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1069	*/
1070	#ifdef LOG_USE_C99
1071	# define Log12ThisFunc(a) \
1072	_LogIt(RTLOGGRPFLAGS_LEVEL_12, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1073	#else
1074	# define Log12ThisFunc(a) do { Log12(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log12(a); } while (0)
1075	#endif
1076
1077	/** @def LogFlowThisFunc
1078	* Flow level logging inside a C++ non-static method, with object pointer and
1079	* method name prefixed to the given message.
1080	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1081	*/
1082	#ifdef LOG_USE_C99
1083	# define LogFlowThisFunc(a) \
1084	_LogIt(RTLOGGRPFLAGS_FLOW, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1085	#else
1086	# define LogFlowThisFunc(a) do { LogFlow(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
1087	#endif
1088
1089	/** @def LogWarnThisFunc
1090	* Warning level logging inside a C++ non-static method, with object pointer and
1091	* method name prefixed to the given message.
1092	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1093	*/
1094	#ifdef LOG_USE_C99
1095	# define LogWarnThisFunc(a) \
1096	_LogIt(RTLOGGRPFLAGS_WARN, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1097	#else
1098	# define LogWarnThisFunc(a) do { LogWarn(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); LogWarn(a); } while (0)
1099	#endif
1100	/** @} */
1101
1102
1103	/** @name Misc Logging Macros
1104	* @{ */
1105
1106	/** @def Log1Warning
1107	* The same as Log(), but prepents a <tt>"WARNING! "</tt> string to the message.
1108	*
1109	* @param a Custom log message in format <tt>("string\n" [, args])</tt>.
1110	*/
1111	#if defined(LOG_USE_C99)
1112	# define Log1Warning(a) _LogIt(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "WARNING! %M", _LogRemoveParentheseis a )
1113	#else
1114	# define Log1Warning(a) do { Log(("WARNING! ")); Log(a); } while (0)
1115	#endif
1116
1117	/** @def Log1WarningFunc
1118	* The same as LogWarning(), but prepents the log message with the function name.
1119	*
1120	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1121	*/
1122	#ifdef LOG_USE_C99
1123	# define Log1WarningFunc(a) \
1124	_LogIt(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": WARNING! %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1125	#else
1126	# define Log1WarningFunc(a) \
1127	do { Log((LOG_FN_FMT ": WARNING! ", __PRETTY_FUNCTION__)); Log(a); } while (0)
1128	#endif
1129
1130	/** @def Log1WarningThisFunc
1131	* The same as LogWarningFunc() but for class functions (methods): the resulting
1132	* log line is additionally prepended with a hex value of \|this\| pointer.
1133	*
1134	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1135	*/
1136	#ifdef LOG_USE_C99
1137	# define Log1WarningThisFunc(a) \
1138	_LogIt(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": WARNING! %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1139	#else
1140	# define Log1WarningThisFunc(a) \
1141	do { Log(("{%p} " LOG_FN_FMT ": WARNING! ", this, __PRETTY_FUNCTION__)); Log(a); } while (0)
1142	#endif
1143
1144
1145	/** Shortcut to \|LogFlowFunc ("ENTER\n")\|, marks the beginnig of the function. */
1146	#define LogFlowFuncEnter() LogFlowFunc(("ENTER\n"))
1147
1148	/** Shortcut to \|LogFlowFunc ("LEAVE\n")\|, marks the end of the function. */
1149	#define LogFlowFuncLeave() LogFlowFunc(("LEAVE\n"))
1150
1151	/** Shortcut to \|LogFlowFunc ("LEAVE: %Rrc\n")\|, marks the end of the function. */
1152	#define LogFlowFuncLeaveRC(rc) LogFlowFunc(("LEAVE: %Rrc\n", (rc)))
1153
1154	/** Shortcut to \|LogFlowThisFunc ("ENTER\n")\|, marks the beginnig of the function. */
1155	#define LogFlowThisFuncEnter() LogFlowThisFunc(("ENTER\n"))
1156
1157	/** Shortcut to \|LogFlowThisFunc ("LEAVE\n")\|, marks the end of the function. */
1158	#define LogFlowThisFuncLeave() LogFlowThisFunc(("LEAVE\n"))
1159
1160
1161	/** @def LogObjRefCnt
1162	* Helper macro to print the current reference count of the given COM object
1163	* to the log file.
1164	*
1165	* @param pObj Pointer to the object in question (must be a pointer to an
1166	* IUnknown subclass or simply define COM-style AddRef() and
1167	* Release() methods)
1168	*/
1169	#define LogObjRefCnt(pObj) \
1170	do { \
1171	if (LogIsFlowEnabled()) \
1172	{ \
1173	int cRefsForLog = (pObj)->AddRef(); \
1174	LogFlow((#pObj "{%p}.refCnt=%d\n", (pObj), cRefsForLog - 1)); \
1175	(pObj)->Release(); \
1176	} \
1177	} while (0)
1178	/** @} */
1179
1180
1181
1182	/** @name Passing Function Call Position When Logging.
1183	*
1184	* This is a little bit ugly as we have to omit the comma before the
1185	* position parameters so that we don't inccur any overhead in non-logging
1186	* builds (!defined(LOG_ENABLED).
1187	*
1188	* @{ */
1189	/** Source position for passing to a function call. */
1190	#ifdef LOG_ENABLED
1191	# define RTLOG_COMMA_SRC_POS , __FILE__, __LINE__, __PRETTY_FUNCTION__
1192	#else
1193	# define RTLOG_COMMA_SRC_POS RT_NOTHING
1194	#endif
1195	/** Source position declaration. */
1196	#ifdef LOG_ENABLED
1197	# define RTLOG_COMMA_SRC_POS_DECL , const char pszFile, unsigned iLine, const char pszFunction
1198	#else
1199	# define RTLOG_COMMA_SRC_POS_DECL RT_NOTHING
1200	#endif
1201	/** Source position arguments. */
1202	#ifdef LOG_ENABLED
1203	# define RTLOG_COMMA_SRC_POS_ARGS , pszFile, iLine, pszFunction
1204	#else
1205	# define RTLOG_COMMA_SRC_POS_ARGS RT_NOTHING
1206	#endif
1207	/** Applies NOREF() to the source position arguments. */
1208	#ifdef LOG_ENABLED
1209	# define RTLOG_SRC_POS_NOREF() do { NOREF(pszFile); NOREF(iLine); NOREF(pszFunction); } while (0)
1210	#else
1211	# define RTLOG_SRC_POS_NOREF() do { } while (0)
1212	#endif
1213	/** @} */
1214
1215
1216
1217	/** @name Release Logging
1218	* @{
1219	*/
1220
1221	#ifdef DOXYGEN_RUNNING
1222	# define RTLOG_REL_DISABLED
1223	# define RTLOG_REL_ENABLED
1224	#endif
1225
1226	/** @def RTLOG_REL_DISABLED
1227	* Use this compile time define to disable all release logging
1228	* macros.
1229	*/
1230
1231	/** @def RTLOG_REL_ENABLED
1232	* Use this compile time define to override RTLOG_REL_DISABLE.
1233	*/
1234
1235	/*
1236	* Determine whether release logging is enabled and forcefully normalize the indicators.
1237	*/
1238	#if !defined(RTLOG_REL_DISABLED) \|\| defined(RTLOG_REL_ENABLED)
1239	# undef RTLOG_REL_DISABLED
1240	# undef RTLOG_REL_ENABLED
1241	# define RTLOG_REL_ENABLED
1242	#else
1243	# undef RTLOG_REL_ENABLED
1244	# undef RTLOG_REL_DISABLED
1245	# define RTLOG_REL_DISABLED
1246	#endif
1247
1248	/** @name Macros for checking whether a release log level is enabled.
1249	* @{ */
1250	/** @def LogRelIsItEnabled
1251	* Checks whether the specified release logging group is enabled or not.
1252	*/
1253	#define LogRelIsItEnabled(a_fFlags, a_iGroup) ( RTLogRelGetDefaultInstanceEx(RT_MAKE_U32(a_fFlags, a_iGroup)) != NULL )
1254
1255	/** @def LogRelIsEnabled
1256	* Checks whether level 1 release logging is enabled.
1257	*/
1258	#define LogRelIsEnabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP)
1259
1260	/** @def LogRelIs2Enabled
1261	* Checks whether level 2 release logging is enabled.
1262	*/
1263	#define LogRelIs2Enabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP)
1264
1265	/** @def LogRelIs3Enabled
1266	* Checks whether level 3 release logging is enabled.
1267	*/
1268	#define LogRelIs3Enabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP)
1269
1270	/** @def LogRelIs4Enabled
1271	* Checks whether level 4 release logging is enabled.
1272	*/
1273	#define LogRelIs4Enabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP)
1274
1275	/** @def LogRelIs5Enabled
1276	* Checks whether level 5 release logging is enabled.
1277	*/
1278	#define LogRelIs5Enabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP)
1279
1280	/** @def LogRelIs6Enabled
1281	* Checks whether level 6 release logging is enabled.
1282	*/
1283	#define LogRelIs6Enabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP)
1284
1285	/** @def LogRelIs7Enabled
1286	* Checks whether level 7 release logging is enabled.
1287	*/
1288	#define LogRelIs7Enabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_7, LOG_GROUP)
1289
1290	/** @def LogRelIs8Enabled
1291	* Checks whether level 8 release logging is enabled.
1292	*/
1293	#define LogRelIs8Enabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_8, LOG_GROUP)
1294
1295	/** @def LogRelIs2Enabled
1296	* Checks whether level 9 release logging is enabled.
1297	*/
1298	#define LogRelIs9Enabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_9, LOG_GROUP)
1299
1300	/** @def LogRelIs10Enabled
1301	* Checks whether level 10 release logging is enabled.
1302	*/
1303	#define LogRelIs10Enabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_10, LOG_GROUP)
1304
1305	/** @def LogRelIs11Enabled
1306	* Checks whether level 10 release logging is enabled.
1307	*/
1308	#define LogRelIs11Enabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_11, LOG_GROUP)
1309
1310	/** @def LogRelIs12Enabled
1311	* Checks whether level 12 release logging is enabled.
1312	*/
1313	#define LogRelIs12Enabled() LogRelIsItEnabled(RTLOGGRPFLAGS_LEVEL_12, LOG_GROUP)
1314
1315	/** @def LogRelIsFlowEnabled
1316	* Checks whether execution flow release logging is enabled.
1317	*/
1318	#define LogRelIsFlowEnabled() LogRelIsItEnabled(RTLOGGRPFLAGS_FLOW, LOG_GROUP)
1319
1320	/** @def LogRelIsWarnEnabled
1321	* Checks whether warning level release logging is enabled.
1322	*/
1323	#define LogRelIsWarnEnabled() LogRelIsItEnabled(RTLOGGRPFLAGS_FLOW, LOG_GROUP)
1324	/** @} */
1325
1326
1327	/** @def LogRelIt
1328	* Write to specific logger if group enabled.
1329	*/
1330	/** @def LogRelItLikely
1331	* Write to specific logger if group enabled, assuming it likely it is enabled.
1332	*/
1333	/** @def LogRelMaxIt
1334	* Write to specific logger if group enabled and at less than a_cMax messages
1335	* have hit the log. Uses a static variable to count.
1336	*/
1337	#ifdef RTLOG_REL_ENABLED
1338	# if defined(LOG_USE_C99)
1339	# define _LogRelRemoveParentheseis(...) __VA_ARGS__
1340	# define _LogRelIt(a_fFlags, a_iGroup, ...) \
1341	do \
1342	{ \
1343	PRTLOGGER LogRelIt_pLogger = RTLogRelGetDefaultInstanceEx(RT_MAKE_U32(a_fFlags, a_iGroup)); \
1344	if (RT_LIKELY(!LogRelIt_pLogger)) \
1345	{ /* likely */ } \
1346	else \
1347	RTLogLoggerEx(LogRelIt_pLogger, a_fFlags, a_iGroup, __VA_ARGS__); \
1348	_LogIt(a_fFlags, a_iGroup, __VA_ARGS__); \
1349	} while (0)
1350	# define LogRelIt(a_fFlags, a_iGroup, fmtargs) \
1351	_LogRelIt(a_fFlags, a_iGroup, _LogRelRemoveParentheseis fmtargs)
1352	# define _LogRelItLikely(a_fFlags, a_iGroup, ...) \
1353	do \
1354	{ \
1355	PRTLOGGER LogRelIt_pLogger = RTLogRelGetDefaultInstanceEx(RT_MAKE_U32(a_fFlags, a_iGroup)); \
1356	if (LogRelIt_pLogger) \
1357	RTLogLoggerEx(LogRelIt_pLogger, a_fFlags, a_iGroup, __VA_ARGS__); \
1358	_LogIt(a_fFlags, a_iGroup, __VA_ARGS__); \
1359	} while (0)
1360	# define LogRelItLikely(a_fFlags, a_iGroup, fmtargs) \
1361	_LogRelItLikely(a_fFlags, a_iGroup, _LogRelRemoveParentheseis fmtargs)
1362	# define _LogRelMaxIt(a_cMax, a_fFlags, a_iGroup, ...) \
1363	do \
1364	{ \
1365	PRTLOGGER LogRelIt_pLogger = RTLogRelGetDefaultInstanceEx(RT_MAKE_U32(a_fFlags, a_iGroup)); \
1366	if (LogRelIt_pLogger) \
1367	{ \
1368	static uint32_t s_LogRelMaxIt_cLogged = 0; \
1369	if (s_LogRelMaxIt_cLogged < (a_cMax)) \
1370	{ \
1371	s_LogRelMaxIt_cLogged++; \
1372	RTLogLoggerEx(LogRelIt_pLogger, a_fFlags, a_iGroup, __VA_ARGS__); \
1373	} \
1374	} \
1375	_LogIt(a_fFlags, a_iGroup, __VA_ARGS__); \
1376	} while (0)
1377	# define LogRelMaxIt(a_cMax, a_fFlags, a_iGroup, fmtargs) \
1378	_LogRelMaxIt(a_cMax, a_fFlags, a_iGroup, _LogRelRemoveParentheseis fmtargs)
1379	# else
1380	# define LogRelItLikely(a_fFlags, a_iGroup, fmtargs) \
1381	do \
1382	{ \
1383	PRTLOGGER LogRelIt_pLogger = RTLogRelGetDefaultInstanceEx(RT_MAKE_U32(a_fFlags, a_iGroup)); \
1384	if (LogRelIt_pLogger) \
1385	{ \
1386	LogRelIt_pLogger->pfnLogger fmtargs; \
1387	} \
1388	LogIt(a_fFlags, a_iGroup, fmtargs); \
1389	} while (0)
1390	# define LogRelIt(a_fFlags, a_iGroup, fmtargs) \
1391	do \
1392	{ \
1393	PRTLOGGER LogRelIt_pLogger = RTLogRelGetDefaultInstanceEx(RT_MAKE_U32(a_fFlags, a_iGroup)); \
1394	if (RT_LIKELY(!LogRelIt_pLogger)) \
1395	{ /* likely */ } \
1396	else \
1397	{ \
1398	LogRelIt_pLogger->pfnLogger fmtargs; \
1399	} \
1400	LogIt(a_fFlags, a_iGroup, fmtargs); \
1401	} while (0)
1402	# define LogRelMaxIt(a_cMax, a_fFlags, a_iGroup, fmtargs) \
1403	do \
1404	{ \
1405	PRTLOGGER LogRelIt_pLogger = RTLogRelGetDefaultInstanceEx(RT_MAKE_U32(a_fFlags, a_iGroup)); \
1406	if (LogRelIt_pLogger) \
1407	{ \
1408	static uint32_t s_LogRelMaxIt_cLogged = 0; \
1409	if (s_LogRelMaxIt_cLogged < (a_cMax)) \
1410	{ \
1411	s_LogRelMaxIt_cLogged++; \
1412	LogRelIt_pLogger->pfnLogger fmtargs; \
1413	} \
1414	} \
1415	LogIt(a_fFlags, a_iGroup, fmtargs); \
1416	} while (0)
1417	# endif
1418	#else /* !RTLOG_REL_ENABLED */
1419	# define LogRelIt(a_fFlags, a_iGroup, fmtargs) do { } while (0)
1420	# define LogRelItLikely(a_fFlags, a_iGroup, fmtargs) do { } while (0)
1421	# define LogRelMaxIt(a_cMax, a_fFlags, a_iGroup, fmtargs) do { } while (0)
1422	# if defined(LOG_USE_C99)
1423	# define _LogRelRemoveParentheseis(...) __VA_ARGS__
1424	# define _LogRelIt(a_fFlags, a_iGroup, ...) do { } while (0)
1425	# define _LogRelItLikely(a_fFlags, a_iGroup, ...) do { } while (0)
1426	# define _LogRelMaxIt(a_cMax, a_fFlags, a_iGroup, ...) do { } while (0)
1427	# endif
1428	#endif /* !RTLOG_REL_ENABLED */
1429
1430
1431	/** @name Basic release logging macros
1432	* @{ */
1433	/** @def LogRel
1434	* Level 1 release logging.
1435	*/
1436	#define LogRel(a) LogRelItLikely(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
1437
1438	/** @def LogRel2
1439	* Level 2 release logging.
1440	*/
1441	#define LogRel2(a) LogRelIt(RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a)
1442
1443	/** @def LogRel3
1444	* Level 3 release logging.
1445	*/
1446	#define LogRel3(a) LogRelIt(RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a)
1447
1448	/** @def LogRel4
1449	* Level 4 release logging.
1450	*/
1451	#define LogRel4(a) LogRelIt(RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a)
1452
1453	/** @def LogRel5
1454	* Level 5 release logging.
1455	*/
1456	#define LogRel5(a) LogRelIt(RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a)
1457
1458	/** @def LogRel6
1459	* Level 6 release logging.
1460	*/
1461	#define LogRel6(a) LogRelIt(RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a)
1462
1463	/** @def LogRel7
1464	* Level 7 release logging.
1465	*/
1466	#define LogRel7(a) LogRelIt(RTLOGGRPFLAGS_LEVEL_7, LOG_GROUP, a)
1467
1468	/** @def LogRel8
1469	* Level 8 release logging.
1470	*/
1471	#define LogRel8(a) LogRelIt(RTLOGGRPFLAGS_LEVEL_8, LOG_GROUP, a)
1472
1473	/** @def LogRel9
1474	* Level 9 release logging.
1475	*/
1476	#define LogRel9(a) LogRelIt(RTLOGGRPFLAGS_LEVEL_9, LOG_GROUP, a)
1477
1478	/** @def LogRel10
1479	* Level 10 release logging.
1480	*/
1481	#define LogRel10(a) LogRelIt(RTLOGGRPFLAGS_LEVEL_10, LOG_GROUP, a)
1482
1483	/** @def LogRel11
1484	* Level 11 release logging.
1485	*/
1486	#define LogRel11(a) LogRelIt(RTLOGGRPFLAGS_LEVEL_11, LOG_GROUP, a)
1487
1488	/** @def LogRel12
1489	* Level 12 release logging.
1490	*/
1491	#define LogRel12(a) LogRelIt(RTLOGGRPFLAGS_LEVEL_12, LOG_GROUP, a)
1492
1493	/** @def LogRelFlow
1494	* Logging of execution flow.
1495	*/
1496	#define LogRelFlow(a) LogRelIt(RTLOGGRPFLAGS_FLOW, LOG_GROUP, a)
1497
1498	/** @def LogRelWarn
1499	* Warning level release logging.
1500	*/
1501	#define LogRelWarn(a) LogRelIt(RTLOGGRPFLAGS_WARN, LOG_GROUP, a)
1502	/** @} */
1503
1504
1505
1506	/** @name Basic release logging macros with local max
1507	* @{ */
1508	/** @def LogRelMax
1509	* Level 1 release logging with a max number of log entries.
1510	*/
1511	#define LogRelMax(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
1512
1513	/** @def LogRelMax2
1514	* Level 2 release logging with a max number of log entries.
1515	*/
1516	#define LogRelMax2(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a)
1517
1518	/** @def LogRelMax3
1519	* Level 3 release logging with a max number of log entries.
1520	*/
1521	#define LogRelMax3(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a)
1522
1523	/** @def LogRelMax4
1524	* Level 4 release logging with a max number of log entries.
1525	*/
1526	#define LogRelMax4(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a)
1527
1528	/** @def LogRelMax5
1529	* Level 5 release logging with a max number of log entries.
1530	*/
1531	#define LogRelMax5(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a)
1532
1533	/** @def LogRelMax6
1534	* Level 6 release logging with a max number of log entries.
1535	*/
1536	#define LogRelMax6(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a)
1537
1538	/** @def LogRelMax7
1539	* Level 7 release logging with a max number of log entries.
1540	*/
1541	#define LogRelMax7(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_7, LOG_GROUP, a)
1542
1543	/** @def LogRelMax8
1544	* Level 8 release logging with a max number of log entries.
1545	*/
1546	#define LogRelMax8(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_8, LOG_GROUP, a)
1547
1548	/** @def LogRelMax9
1549	* Level 9 release logging with a max number of log entries.
1550	*/
1551	#define LogRelMax9(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_9, LOG_GROUP, a)
1552
1553	/** @def LogRelMax10
1554	* Level 10 release logging with a max number of log entries.
1555	*/
1556	#define LogRelMax10(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_10, LOG_GROUP, a)
1557
1558	/** @def LogRelMax11
1559	* Level 11 release logging with a max number of log entries.
1560	*/
1561	#define LogRelMax11(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_11, LOG_GROUP, a)
1562
1563	/** @def LogRelMax12
1564	* Level 12 release logging with a max number of log entries.
1565	*/
1566	#define LogRelMax12(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_12, LOG_GROUP, a)
1567
1568	/** @def LogRelFlow
1569	* Logging of execution flow with a max number of log entries.
1570	*/
1571	#define LogRelMaxFlow(a_cMax, a) LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_FLOW, LOG_GROUP, a)
1572	/** @} */
1573
1574
1575	/** @name Release logging macros prefixing the current function name.
1576	* @{ */
1577
1578	/** @def LogRelFunc
1579	* Release logging. Prepends the given log message with the function name
1580	* followed by a semicolon and space.
1581	*/
1582	#ifdef LOG_USE_C99
1583	# define LogRelFunc(a) \
1584	_LogRelItLikely(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": %M", RT_GCC_EXTENSION __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1585	#else
1586	# define LogRelFunc(a) do { LogRel((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogRel(a); } while (0)
1587	#endif
1588
1589	/** @def LogRelFlowFunc
1590	* Release logging. Macro to log the execution flow inside C/C++ functions.
1591	*
1592	* Prepends the given log message with the function name followed by
1593	* a semicolon and space.
1594	*
1595	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1596	*/
1597	#ifdef LOG_USE_C99
1598	# define LogRelFlowFunc(a) _LogRelIt(RTLOGGRPFLAGS_FLOW, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1599	#else
1600	# define LogRelFlowFunc(a) do { LogRelFlow((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogRelFlow(a); } while (0)
1601	#endif
1602
1603	/** @def LogRelMaxFunc
1604	* Release logging. Prepends the given log message with the function name
1605	* followed by a semicolon and space.
1606	*/
1607	#ifdef LOG_USE_C99
1608	# define LogRelMaxFunc(a_cMax, a) \
1609	_LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1610	#else
1611	# define LogRelMaxFunc(a_cMax, a) \
1612	do { LogRelMax(a_cMax, (LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogRelMax(a_cMax, a); } while (0)
1613	#endif
1614
1615	/** @def LogRelMaxFlowFunc
1616	* Release logging. Macro to log the execution flow inside C/C++ functions.
1617	*
1618	* Prepends the given log message with the function name followed by
1619	* a semicolon and space.
1620	*
1621	* @param a_cMax Max number of times this should hit the log.
1622	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1623	*/
1624	#ifdef LOG_USE_C99
1625	# define LogRelMaxFlowFunc(a_cMax, a) \
1626	_LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_FLOW, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1627	#else
1628	# define LogRelMaxFlowFunc(a_cMax, a) \
1629	do { LogRelMaxFlow(a_cMax, (LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogRelFlow(a_cMax, a); } while (0)
1630	#endif
1631
1632	/** @} */
1633
1634
1635	/** @name Release Logging macros prefixing the this pointer value and method name.
1636	* @{ */
1637
1638	/** @def LogRelThisFunc
1639	* The same as LogRelFunc but for class functions (methods): the resulting log
1640	* line is additionally prepended with a hex value of \|this\| pointer.
1641	*/
1642	#ifdef LOG_USE_C99
1643	# define LogRelThisFunc(a) \
1644	_LogRelItLikely(RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1645	#else
1646	# define LogRelThisFunc(a) \
1647	do { LogRel(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); LogRel(a); } while (0)
1648	#endif
1649
1650	/** @def LogRelMaxThisFunc
1651	* The same as LogRelFunc but for class functions (methods): the resulting log
1652	* line is additionally prepended with a hex value of \|this\| pointer.
1653	* @param a_cMax Max number of times this should hit the log.
1654	* @param a Log message in format <tt>("string\n" [, args])</tt>.
1655	*/
1656	#ifdef LOG_USE_C99
1657	# define LogRelMaxThisFunc(a_cMax, a) \
1658	_LogRelMaxIt(a_cMax, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
1659	#else
1660	# define LogRelMaxThisFunc(a_cMax, a) \
1661	do { LogRelMax(a_cMax, ("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); LogRelMax(a_cMax, a); } while (0)
1662	#endif
1663
1664	/** @} */
1665
1666
1667	#ifndef IN_RC
1668	/**
1669	* Sets the default release logger instance.
1670	*
1671	* @returns The old default instance.
1672	* @param pLogger The new default release logger instance.
1673	*/
1674	RTDECL(PRTLOGGER) RTLogRelSetDefaultInstance(PRTLOGGER pLogger);
1675	#endif /* !IN_RC */
1676
1677	/**
1678	* Gets the default release logger instance.
1679	*
1680	* @returns Pointer to default release logger instance if availble, otherwise NULL.
1681	*/
1682	RTDECL(PRTLOGGER) RTLogRelGetDefaultInstance(void);
1683
1684	/**
1685	* Gets the default release logger instance.
1686	*
1687	* @returns Pointer to default release logger instance if availble, otherwise NULL.
1688	* @param fFlagsAndGroup The flags in the lower 16 bits, the group number in
1689	* the high 16 bits.
1690	*/
1691	RTDECL(PRTLOGGER) RTLogRelGetDefaultInstanceEx(uint32_t fFlagsAndGroup);
1692
1693	/**
1694	* Write to a logger instance, defaulting to the release one.
1695	*
1696	* This function will check whether the instance, group and flags makes up a
1697	* logging kind which is currently enabled before writing anything to the log.
1698	*
1699	* @param pLogger Pointer to logger instance.
1700	* @param fFlags The logging flags.
1701	* @param iGroup The group.
1702	* The value ~0U is reserved for compatibility with RTLogLogger[V] and is
1703	* only for internal usage!
1704	* @param pszFormat Format string.
1705	* @param ... Format arguments.
1706	* @remark This is a worker function for LogRelIt.
1707	*/
1708	RTDECL(void) RTLogRelLogger(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup,
1709	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(4, 5);
1710
1711	/**
1712	* Write to a logger instance, defaulting to the release one.
1713	*
1714	* This function will check whether the instance, group and flags makes up a
1715	* logging kind which is currently enabled before writing anything to the log.
1716	*
1717	* @param pLogger Pointer to logger instance. If NULL the default release instance is attempted.
1718	* @param fFlags The logging flags.
1719	* @param iGroup The group.
1720	* The value ~0U is reserved for compatibility with RTLogLogger[V] and is
1721	* only for internal usage!
1722	* @param pszFormat Format string.
1723	* @param args Format arguments.
1724	*/
1725	RTDECL(void) RTLogRelLoggerV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup,
1726	const char *pszFormat, va_list args) RT_IPRT_FORMAT_ATTR(4, 0);
1727
1728	/**
1729	* printf like function for writing to the default release log.
1730	*
1731	* @param pszFormat Printf like format string.
1732	* @param ... Optional arguments as specified in pszFormat.
1733	*
1734	* @remark The API doesn't support formatting of floating point numbers at the moment.
1735	*/
1736	RTDECL(void) RTLogRelPrintf(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
1737
1738	/**
1739	* vprintf like function for writing to the default release log.
1740	*
1741	* @param pszFormat Printf like format string.
1742	* @param args Optional arguments as specified in pszFormat.
1743	*
1744	* @remark The API doesn't support formatting of floating point numbers at the moment.
1745	*/
1746	RTDECL(void) RTLogRelPrintfV(const char *pszFormat, va_list args) RT_IPRT_FORMAT_ATTR(1, 0);
1747
1748	/**
1749	* Changes the buffering setting of the default release logger.
1750	*
1751	* This can be used for optimizing longish logging sequences.
1752	*
1753	* @returns The old state.
1754	* @param fBuffered The new state.
1755	*/
1756	RTDECL(bool) RTLogRelSetBuffering(bool fBuffered);
1757
1758	/** @} */
1759
1760
1761
1762	/** @name COM port logging
1763	* {
1764	*/
1765
1766	#ifdef DOXYGEN_RUNNING
1767	# define LOG_TO_COM
1768	# define LOG_NO_COM
1769	#endif
1770
1771	/** @def LOG_TO_COM
1772	* Redirects the normal logging macros to the serial versions.
1773	*/
1774
1775	/** @def LOG_NO_COM
1776	* Disables all LogCom* macros.
1777	*/
1778
1779	/** @def LogCom
1780	* Generic logging to serial port.
1781	*/
1782	#if defined(LOG_ENABLED) && !defined(LOG_NO_COM)
1783	# define LogCom(a) RTLogComPrintf a
1784	#else
1785	# define LogCom(a) do { } while (0)
1786	#endif
1787
1788	/** @def LogComFlow
1789	* Logging to serial port of execution flow.
1790	*/
1791	#if defined(LOG_ENABLED) && defined(LOG_ENABLE_FLOW) && !defined(LOG_NO_COM)
1792	# define LogComFlow(a) RTLogComPrintf a
1793	#else
1794	# define LogComFlow(a) do { } while (0)
1795	#endif
1796
1797	#ifdef LOG_TO_COM
1798	# undef Log
1799	# define Log(a) LogCom(a)
1800	# undef LogFlow
1801	# define LogFlow(a) LogComFlow(a)
1802	#endif
1803
1804	/** @} */
1805
1806
1807	/** @name Backdoor Logging
1808	* @{
1809	*/
1810
1811	#ifdef DOXYGEN_RUNNING
1812	# define LOG_TO_BACKDOOR
1813	# define LOG_NO_BACKDOOR
1814	#endif
1815
1816	/** @def LOG_TO_BACKDOOR
1817	* Redirects the normal logging macros to the backdoor versions.
1818	*/
1819
1820	/** @def LOG_NO_BACKDOOR
1821	* Disables all LogBackdoor* macros.
1822	*/
1823
1824	/** @def LogBackdoor
1825	* Generic logging to the VBox backdoor via port I/O.
1826	*/
1827	#if defined(LOG_ENABLED) && !defined(LOG_NO_BACKDOOR)
1828	# define LogBackdoor(a) RTLogBackdoorPrintf a
1829	#else
1830	# define LogBackdoor(a) do { } while (0)
1831	#endif
1832
1833	/** @def LogBackdoorFlow
1834	* Logging of execution flow messages to the backdoor I/O port.
1835	*/
1836	#if defined(LOG_ENABLED) && !defined(LOG_NO_BACKDOOR)
1837	# define LogBackdoorFlow(a) RTLogBackdoorPrintf a
1838	#else
1839	# define LogBackdoorFlow(a) do { } while (0)
1840	#endif
1841
1842	/** @def LogRelBackdoor
1843	* Release logging to the VBox backdoor via port I/O.
1844	*/
1845	#if !defined(LOG_NO_BACKDOOR)
1846	# define LogRelBackdoor(a) RTLogBackdoorPrintf a
1847	#else
1848	# define LogRelBackdoor(a) do { } while (0)
1849	#endif
1850
1851	#ifdef LOG_TO_BACKDOOR
1852	# undef Log
1853	# define Log(a) LogBackdoor(a)
1854	# undef LogFlow
1855	# define LogFlow(a) LogBackdoorFlow(a)
1856	# undef LogRel
1857	# define LogRel(a) LogRelBackdoor(a)
1858	# if defined(LOG_USE_C99)
1859	# undef _LogIt
1860	# define _LogIt(a_fFlags, a_iGroup, ...) LogBackdoor((__VA_ARGS__))
1861	# endif
1862	#endif
1863
1864	/** @} */
1865
1866
1867
1868	/**
1869	* Gets the default logger instance, creating it if necessary.
1870	*
1871	* @returns Pointer to default logger instance if availble, otherwise NULL.
1872	*/
1873	RTDECL(PRTLOGGER) RTLogDefaultInstance(void);
1874
1875	/**
1876	* Gets the logger instance if enabled, creating it if necessary.
1877	*
1878	* @returns Pointer to default logger instance, if group has the specified
1879	* flags enabled. Otherwise NULL is returned.
1880	* @param fFlagsAndGroup The flags in the lower 16 bits, the group number in
1881	* the high 16 bits.
1882	*/
1883	RTDECL(PRTLOGGER) RTLogDefaultInstanceEx(uint32_t fFlagsAndGroup);
1884
1885	/**
1886	* Gets the default logger instance.
1887	*
1888	* @returns Pointer to default logger instance if availble, otherwise NULL.
1889	*/
1890	RTDECL(PRTLOGGER) RTLogGetDefaultInstance(void);
1891
1892	/**
1893	* Gets the default logger instance if enabled.
1894	*
1895	* @returns Pointer to default logger instance, if group has the specified
1896	* flags enabled. Otherwise NULL is returned.
1897	* @param fFlagsAndGroup The flags in the lower 16 bits, the group number in
1898	* the high 16 bits.
1899	*/
1900	RTDECL(PRTLOGGER) RTLogGetDefaultInstanceEx(uint32_t fFlagsAndGroup);
1901
1902	#ifndef IN_RC
1903	/**
1904	* Sets the default logger instance.
1905	*
1906	* @returns The old default instance.
1907	* @param pLogger The new default logger instance.
1908	*/
1909	RTDECL(PRTLOGGER) RTLogSetDefaultInstance(PRTLOGGER pLogger);
1910	#endif /* !IN_RC */
1911
1912	#ifdef IN_RING0
1913	/**
1914	* Changes the default logger instance for the current thread.
1915	*
1916	* @returns IPRT status code.
1917	* @param pLogger The logger instance. Pass NULL for deregistration.
1918	* @param uKey Associated key for cleanup purposes. If pLogger is NULL,
1919	* all instances with this key will be deregistered. So in
1920	* order to only deregister the instance associated with the
1921	* current thread use 0.
1922	*/
1923	RTDECL(int) RTLogSetDefaultInstanceThread(PRTLOGGER pLogger, uintptr_t uKey);
1924	#endif /* IN_RING0 */
1925
1926
1927	#ifndef IN_RC
1928	/**
1929	* Creates the default logger instance for a iprt users.
1930	*
1931	* Any user of the logging features will need to implement
1932	* this or use the generic dummy.
1933	*
1934	* @returns Pointer to the logger instance.
1935	*/
1936	RTDECL(PRTLOGGER) RTLogDefaultInit(void);
1937
1938	/**
1939	* Create a logger instance.
1940	*
1941	* @returns iprt status code.
1942	*
1943	* @param ppLogger Where to store the logger instance.
1944	* @param fFlags Logger instance flags, a combination of the
1945	* RTLOGFLAGS_* values.
1946	* @param pszGroupSettings The initial group settings.
1947	* @param pszEnvVarBase Base name for the environment variables for
1948	* this instance.
1949	* @param cGroups Number of groups in the array.
1950	* @param papszGroups Pointer to array of groups. This must stick
1951	* around for the life of the logger instance.
1952	* @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed
1953	* if pszFilenameFmt specified.
1954	* @param pszFilenameFmt Log filename format string. Standard
1955	* RTStrFormat().
1956	* @param ... Format arguments.
1957	*/
1958	RTDECL(int) RTLogCreate(PRTLOGGER ppLogger, uint32_t fFlags, const char pszGroupSettings,
1959	const char pszEnvVarBase, unsigned cGroups, const char const * papszGroups,
1960	uint32_t fDestFlags, const char *pszFilenameFmt, ...) RT_IPRT_FORMAT_ATTR_MAYBE_NULL(8, 9);
1961
1962	/**
1963	* Create a logger instance.
1964	*
1965	* @returns iprt status code.
1966	*
1967	* @param ppLogger Where to store the logger instance.
1968	* @param fFlags Logger instance flags, a combination of the
1969	* RTLOGFLAGS_* values.
1970	* @param pszGroupSettings The initial group settings.
1971	* @param pszEnvVarBase Base name for the environment variables for
1972	* this instance.
1973	* @param cGroups Number of groups in the array.
1974	* @param papszGroups Pointer to array of groups. This must stick
1975	* around for the life of the logger instance.
1976	* @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed
1977	* if pszFilenameFmt specified.
1978	* @param pfnPhase Callback function for starting logging and for
1979	* ending or starting a new file for log history
1980	* rotation. NULL is OK.
1981	* @param cHistory Number of old log files to keep when performing
1982	* log history rotation. 0 means no history.
1983	* @param cbHistoryFileMax Maximum size of log file when performing
1984	* history rotation. 0 means no size limit.
1985	* @param cSecsHistoryTimeSlot Maximum time interval per log file when
1986	* performing history rotation, in seconds.
1987	* 0 means time limit.
1988	* @param pszErrorMsg A buffer which is filled with an error message if something fails. May be NULL.
1989	* @param cchErrorMsg The size of the error message buffer.
1990	* @param pszFilenameFmt Log filename format string. Standard RTStrFormat().
1991	* @param ... Format arguments.
1992	*/
1993	RTDECL(int) RTLogCreateEx(PRTLOGGER ppLogger, uint32_t fFlags, const char pszGroupSettings,
1994	const char pszEnvVarBase, unsigned cGroups, const char const * papszGroups,
1995	uint32_t fDestFlags, PFNRTLOGPHASE pfnPhase, uint32_t cHistory,
1996	uint64_t cbHistoryFileMax, uint32_t cSecsHistoryTimeSlot, char *pszErrorMsg, size_t cchErrorMsg,
1997	const char *pszFilenameFmt, ...) RT_IPRT_FORMAT_ATTR_MAYBE_NULL(14, 15);
1998
1999	/**
2000	* Create a logger instance.
2001	*
2002	* @returns iprt status code.
2003	*
2004	* @param ppLogger Where to store the logger instance.
2005	* @param fFlags Logger instance flags, a combination of the
2006	* RTLOGFLAGS_* values.
2007	* @param pszGroupSettings The initial group settings.
2008	* @param pszEnvVarBase Base name for the environment variables for
2009	* this instance.
2010	* @param cGroups Number of groups in the array.
2011	* @param papszGroups Pointer to array of groups. This must stick
2012	* around for the life of the logger instance.
2013	* @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed
2014	* if pszFilenameFmt specified.
2015	* @param pfnPhase Callback function for starting logging and for
2016	* ending or starting a new file for log history
2017	* rotation.
2018	* @param cHistory Number of old log files to keep when performing
2019	* log history rotation. 0 means no history.
2020	* @param cbHistoryFileMax Maximum size of log file when performing
2021	* history rotation. 0 means no size limit.
2022	* @param cSecsHistoryTimeSlot Maximum time interval per log file when
2023	* performing history rotation, in seconds.
2024	* 0 means no time limit.
2025	* @param pszErrorMsg A buffer which is filled with an error message
2026	* if something fails. May be NULL.
2027	* @param cchErrorMsg The size of the error message buffer.
2028	* @param pszFilenameFmt Log filename format string. Standard
2029	* RTStrFormat().
2030	* @param args Format arguments.
2031	*/
2032	RTDECL(int) RTLogCreateExV(PRTLOGGER ppLogger, uint32_t fFlags, const char pszGroupSettings,
2033	const char pszEnvVarBase, unsigned cGroups, const char const * papszGroups,
2034	uint32_t fDestFlags, PFNRTLOGPHASE pfnPhase, uint32_t cHistory,
2035	uint64_t cbHistoryFileMax, uint32_t cSecsHistoryTimeSlot, char *pszErrorMsg, size_t cchErrorMsg,
2036	const char *pszFilenameFmt, va_list args) RT_IPRT_FORMAT_ATTR_MAYBE_NULL(14, 0);
2037
2038	/**
2039	* Create a logger instance for singled threaded ring-0 usage.
2040	*
2041	* @returns iprt status code.
2042	*
2043	* @param pLogger Where to create the logger instance.
2044	* @param cbLogger The amount of memory available for the logger instance.
2045	* @param pLoggerR0Ptr The ring-0 address corresponding to @a pLogger.
2046	* @param pfnLoggerR0Ptr Pointer to logger wrapper function.
2047	* @param pfnFlushR0Ptr Pointer to flush function.
2048	* @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
2049	* @param fDestFlags The destination flags.
2050	*/
2051	RTDECL(int) RTLogCreateForR0(PRTLOGGER pLogger, size_t cbLogger,
2052	RTR0PTR pLoggerR0Ptr, RTR0PTR pfnLoggerR0Ptr, RTR0PTR pfnFlushR0Ptr,
2053	uint32_t fFlags, uint32_t fDestFlags);
2054
2055	/**
2056	* Calculates the minimum size of a ring-0 logger instance.
2057	*
2058	* @returns The minimum size.
2059	* @param cGroups The number of groups.
2060	* @param fFlags Relevant flags.
2061	*/
2062	RTDECL(size_t) RTLogCalcSizeForR0(uint32_t cGroups, uint32_t fFlags);
2063
2064	/**
2065	* Destroys a logger instance.
2066	*
2067	* The instance is flushed and all output destinations closed (where applicable).
2068	*
2069	* @returns iprt status code.
2070	* @param pLogger The logger instance which close destroyed. NULL is fine.
2071	*/
2072	RTDECL(int) RTLogDestroy(PRTLOGGER pLogger);
2073
2074	/**
2075	* Create a logger instance clone for RC usage.
2076	*
2077	* @returns iprt status code.
2078	*
2079	* @param pLogger The logger instance to be cloned.
2080	* @param pLoggerRC Where to create the RC logger instance.
2081	* @param cbLoggerRC Amount of memory allocated to for the RC logger
2082	* instance clone.
2083	* @param pfnLoggerRCPtr Pointer to logger wrapper function for this
2084	* instance (RC Ptr).
2085	* @param pfnFlushRCPtr Pointer to flush function (RC Ptr).
2086	* @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
2087	*/
2088	RTDECL(int) RTLogCloneRC(PRTLOGGER pLogger, PRTLOGGERRC pLoggerRC, size_t cbLoggerRC,
2089	RTRCPTR pfnLoggerRCPtr, RTRCPTR pfnFlushRCPtr, uint32_t fFlags);
2090
2091	/**
2092	* Flushes a RC logger instance to a R3 logger.
2093	*
2094	* @returns iprt status code.
2095	* @param pLogger The R3 logger instance to flush pLoggerRC to. If NULL
2096	* the default logger is used.
2097	* @param pLoggerRC The RC logger instance to flush.
2098	*/
2099	RTDECL(void) RTLogFlushRC(PRTLOGGER pLogger, PRTLOGGERRC pLoggerRC);
2100
2101	/**
2102	* Flushes the buffer in one logger instance onto another logger.
2103	*
2104	* @returns iprt status code.
2105	*
2106	* @param pSrcLogger The logger instance to flush.
2107	* @param pDstLogger The logger instance to flush onto.
2108	* If NULL the default logger will be used.
2109	*/
2110	RTDECL(void) RTLogFlushToLogger(PRTLOGGER pSrcLogger, PRTLOGGER pDstLogger);
2111
2112	/**
2113	* Flushes a R0 logger instance to a R3 logger.
2114	*
2115	* @returns iprt status code.
2116	* @param pLogger The R3 logger instance to flush pLoggerR0 to. If NULL
2117	* the default logger is used.
2118	* @param pLoggerR0 The R0 logger instance to flush.
2119	*/
2120	RTDECL(void) RTLogFlushR0(PRTLOGGER pLogger, PRTLOGGER pLoggerR0);
2121
2122	/**
2123	* Sets the custom prefix callback.
2124	*
2125	* @returns IPRT status code.
2126	* @param pLogger The logger instance.
2127	* @param pfnCallback The callback.
2128	* @param pvUser The user argument for the callback.
2129	* */
2130	RTDECL(int) RTLogSetCustomPrefixCallback(PRTLOGGER pLogger, PFNRTLOGPREFIX pfnCallback, void *pvUser);
2131
2132	/**
2133	* Same as RTLogSetCustomPrefixCallback for loggers created by
2134	* RTLogCreateForR0.
2135	*
2136	* @returns IPRT status code.
2137	* @param pLogger The logger instance.
2138	* @param pLoggerR0Ptr The ring-0 address corresponding to @a pLogger.
2139	* @param pfnCallbackR0Ptr The callback.
2140	* @param pvUserR0Ptr The user argument for the callback.
2141	* */
2142	RTDECL(int) RTLogSetCustomPrefixCallbackForR0(PRTLOGGER pLogger, RTR0PTR pLoggerR0Ptr,
2143	RTR0PTR pfnCallbackR0Ptr, RTR0PTR pvUserR0Ptr);
2144
2145	/**
2146	* Copies the group settings and flags from logger instance to another.
2147	*
2148	* @returns IPRT status code.
2149	* @param pDstLogger The destination logger instance.
2150	* @param pDstLoggerR0Ptr The ring-0 address corresponding to @a pDstLogger.
2151	* @param pSrcLogger The source logger instance. If NULL the default one is used.
2152	* @param fFlagsOr OR mask for the flags.
2153	* @param fFlagsAnd AND mask for the flags.
2154	*/
2155	RTDECL(int) RTLogCopyGroupsAndFlagsForR0(PRTLOGGER pDstLogger, RTR0PTR pDstLoggerR0Ptr,
2156	PCRTLOGGER pSrcLogger, uint32_t fFlagsOr, uint32_t fFlagsAnd);
2157
2158	/**
2159	* Get the current log group settings as a string.
2160	*
2161	* @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
2162	* @param pLogger Logger instance (NULL for default logger).
2163	* @param pszBuf The output buffer.
2164	* @param cchBuf The size of the output buffer. Must be greater
2165	* than zero.
2166	*/
2167	RTDECL(int) RTLogGetGroupSettings(PRTLOGGER pLogger, char *pszBuf, size_t cchBuf);
2168
2169	/**
2170	* Updates the group settings for the logger instance using the specified
2171	* specification string.
2172	*
2173	* @returns iprt status code.
2174	* Failures can safely be ignored.
2175	* @param pLogger Logger instance (NULL for default logger).
2176	* @param pszValue Value to parse.
2177	*/
2178	RTDECL(int) RTLogGroupSettings(PRTLOGGER pLogger, const char *pszValue);
2179	#endif /* !IN_RC */
2180
2181	/**
2182	* Updates the flags for the logger instance using the specified
2183	* specification string.
2184	*
2185	* @returns iprt status code.
2186	* Failures can safely be ignored.
2187	* @param pLogger Logger instance (NULL for default logger).
2188	* @param pszValue Value to parse.
2189	*/
2190	RTDECL(int) RTLogFlags(PRTLOGGER pLogger, const char *pszValue);
2191
2192	/**
2193	* Changes the buffering setting of the specified logger.
2194	*
2195	* This can be used for optimizing longish logging sequences.
2196	*
2197	* @returns The old state.
2198	* @param pLogger The logger instance (NULL is an alias for the
2199	* default logger).
2200	* @param fBuffered The new state.
2201	*/
2202	RTDECL(bool) RTLogSetBuffering(PRTLOGGER pLogger, bool fBuffered);
2203
2204	/**
2205	* Sets the max number of entries per group.
2206	*
2207	* @returns Old restriction.
2208	*
2209	* @param pLogger The logger instance (NULL is an alias for the
2210	* default logger).
2211	* @param cMaxEntriesPerGroup The max number of entries per group.
2212	*
2213	* @remarks Lowering the limit of an active logger may quietly mute groups.
2214	* Raising it may reactive already muted groups.
2215	*/
2216	RTDECL(uint32_t) RTLogSetGroupLimit(PRTLOGGER pLogger, uint32_t cMaxEntriesPerGroup);
2217
2218	#ifndef IN_RC
2219	/**
2220	* Get the current log flags as a string.
2221	*
2222	* @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
2223	* @param pLogger Logger instance (NULL for default logger).
2224	* @param pszBuf The output buffer.
2225	* @param cchBuf The size of the output buffer. Must be greater
2226	* than zero.
2227	*/
2228	RTDECL(int) RTLogGetFlags(PRTLOGGER pLogger, char *pszBuf, size_t cchBuf);
2229
2230	/**
2231	* Updates the logger destination using the specified string.
2232	*
2233	* @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
2234	* @param pLogger Logger instance (NULL for default logger).
2235	* @param pszValue The value to parse.
2236	*/
2237	RTDECL(int) RTLogDestinations(PRTLOGGER pLogger, char const *pszValue);
2238
2239	/**
2240	* Get the current log destinations as a string.
2241	*
2242	* @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
2243	* @param pLogger Logger instance (NULL for default logger).
2244	* @param pszBuf The output buffer.
2245	* @param cchBuf The size of the output buffer. Must be greater
2246	* than 0.
2247	*/
2248	RTDECL(int) RTLogGetDestinations(PRTLOGGER pLogger, char *pszBuf, size_t cchBuf);
2249	#endif /* !IN_RC */
2250
2251	/**
2252	* Flushes the specified logger.
2253	*
2254	* @param pLogger The logger instance to flush.
2255	* If NULL the default instance is used. The default instance
2256	* will not be initialized by this call.
2257	*/
2258	RTDECL(void) RTLogFlush(PRTLOGGER pLogger);
2259
2260	/**
2261	* Write to a logger instance.
2262	*
2263	* @param pLogger Pointer to logger instance.
2264	* @param pvCallerRet Ignored.
2265	* @param pszFormat Format string.
2266	* @param ... Format arguments.
2267	*/
2268	RTDECL(void) RTLogLogger(PRTLOGGER pLogger, void pvCallerRet, const char pszFormat, ...) RT_IPRT_FORMAT_ATTR(3, 4);
2269
2270	/**
2271	* Write to a logger instance.
2272	*
2273	* @param pLogger Pointer to logger instance.
2274	* @param pszFormat Format string.
2275	* @param args Format arguments.
2276	*/
2277	RTDECL(void) RTLogLoggerV(PRTLOGGER pLogger, const char *pszFormat, va_list args) RT_IPRT_FORMAT_ATTR(3, 0);
2278
2279	/**
2280	* Write to a logger instance.
2281	*
2282	* This function will check whether the instance, group and flags makes up a
2283	* logging kind which is currently enabled before writing anything to the log.
2284	*
2285	* @param pLogger Pointer to logger instance. If NULL the default logger instance will be attempted.
2286	* @param fFlags The logging flags.
2287	* @param iGroup The group.
2288	* The value ~0U is reserved for compatibility with RTLogLogger[V] and is
2289	* only for internal usage!
2290	* @param pszFormat Format string.
2291	* @param ... Format arguments.
2292	* @remark This is a worker function of LogIt.
2293	*/
2294	RTDECL(void) RTLogLoggerEx(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup,
2295	const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(4, 5);
2296
2297	/**
2298	* Write to a logger instance.
2299	*
2300	* This function will check whether the instance, group and flags makes up a
2301	* logging kind which is currently enabled before writing anything to the log.
2302	*
2303	* @param pLogger Pointer to logger instance. If NULL the default logger instance will be attempted.
2304	* @param fFlags The logging flags.
2305	* @param iGroup The group.
2306	* The value ~0U is reserved for compatibility with RTLogLogger[V] and is
2307	* only for internal usage!
2308	* @param pszFormat Format string.
2309	* @param args Format arguments.
2310	*/
2311	RTDECL(void) RTLogLoggerExV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup,
2312	const char *pszFormat, va_list args) RT_IPRT_FORMAT_ATTR(4, 0);
2313
2314	/**
2315	* printf like function for writing to the default log.
2316	*
2317	* @param pszFormat Printf like format string.
2318	* @param ... Optional arguments as specified in pszFormat.
2319	*
2320	* @remark The API doesn't support formatting of floating point numbers at the moment.
2321	*/
2322	RTDECL(void) RTLogPrintf(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
2323
2324	/**
2325	* vprintf like function for writing to the default log.
2326	*
2327	* @param pszFormat Printf like format string.
2328	* @param va Optional arguments as specified in pszFormat.
2329	*
2330	* @remark The API doesn't support formatting of floating point numbers at the moment.
2331	*/
2332	RTDECL(void) RTLogPrintfV(const char *pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(1, 0);
2333
2334	/**
2335	* Dumper vprintf-like function outputting to a logger.
2336	*
2337	* @param pvUser Pointer to the logger instance to use, NULL for
2338	* default instance.
2339	* @param pszFormat Format string.
2340	* @param va Format arguments.
2341	*/
2342	RTDECL(void) RTLogDumpPrintfV(void pvUser, const char pszFormat, va_list va) RT_IPRT_FORMAT_ATTR(2, 0);
2343
2344
2345	#ifndef DECLARED_FNRTSTROUTPUT /* duplicated in iprt/string.h */
2346	#define DECLARED_FNRTSTROUTPUT
2347	/**
2348	* Output callback.
2349	*
2350	* @returns number of bytes written.
2351	* @param pvArg User argument.
2352	* @param pachChars Pointer to an array of utf-8 characters.
2353	* @param cbChars Number of bytes in the character array pointed to by pachChars.
2354	*/
2355	typedef DECLCALLBACK(size_t) FNRTSTROUTPUT(void pvArg, const char pachChars, size_t cbChars);
2356	/** Pointer to callback function. */
2357	typedef FNRTSTROUTPUT *PFNRTSTROUTPUT;
2358	#endif
2359
2360	/**
2361	* Partial vsprintf worker implementation.
2362	*
2363	* @returns number of bytes formatted.
2364	* @param pfnOutput Output worker.
2365	* Called in two ways. Normally with a string an it's length.
2366	* For termination, it's called with NULL for string, 0 for length.
2367	* @param pvArg Argument to output worker.
2368	* @param pszFormat Format string.
2369	* @param args Argument list.
2370	*/
2371	RTDECL(size_t) RTLogFormatV(PFNRTSTROUTPUT pfnOutput, void pvArg, const char pszFormat, va_list args) RT_IPRT_FORMAT_ATTR(3, 0);
2372
2373	/**
2374	* Write log buffer to COM port.
2375	*
2376	* @param pach Pointer to the buffer to write.
2377	* @param cb Number of bytes to write.
2378	*/
2379	RTDECL(void) RTLogWriteCom(const char *pach, size_t cb);
2380
2381	/**
2382	* Prints a formatted string to the serial port used for logging.
2383	*
2384	* @returns Number of bytes written.
2385	* @param pszFormat Format string.
2386	* @param ... Optional arguments specified in the format string.
2387	*/
2388	RTDECL(size_t) RTLogComPrintf(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
2389
2390	/**
2391	* Prints a formatted string to the serial port used for logging.
2392	*
2393	* @returns Number of bytes written.
2394	* @param pszFormat Format string.
2395	* @param args Optional arguments specified in the format string.
2396	*/
2397	RTDECL(size_t) RTLogComPrintfV(const char *pszFormat, va_list args) RT_IPRT_FORMAT_ATTR(1, 0);
2398
2399
2400	#if 0 /* not implemented yet */
2401
2402	/** Indicates that the semaphores shall be used to notify the other
2403	* part about buffer changes. */
2404	#define LOGHOOKBUFFER_FLAGS_SEMAPHORED 1
2405
2406	/**
2407	* Log Hook Buffer.
2408	* Use to communicate between the logger and a log consumer.
2409	*/
2410	typedef struct RTLOGHOOKBUFFER
2411	{
2412	/** Write pointer. */
2413	volatile void *pvWrite;
2414	/** Read pointer. */
2415	volatile void *pvRead;
2416	/** Buffer start. */
2417	void *pvStart;
2418	/** Buffer end (exclusive). */
2419	void *pvEnd;
2420	/** Signaling semaphore used by the writer to wait on a full buffer.
2421	* Only used when indicated in flags. */
2422	void *pvSemWriter;
2423	/** Signaling semaphore used by the read to wait on an empty buffer.
2424	* Only used when indicated in flags. */
2425	void *pvSemReader;
2426	/** Buffer flags. Current reserved and set to zero. */
2427	volatile unsigned fFlags;
2428	} RTLOGHOOKBUFFER;
2429	/** Pointer to a log hook buffer. */
2430	typedef RTLOGHOOKBUFFER *PRTLOGHOOKBUFFER;
2431
2432
2433	/**
2434	* Register a logging hook.
2435	*
2436	* This type of logging hooks are expecting different threads acting
2437	* producer and consumer. They share a circular buffer which have two
2438	* pointers one for each end. When the buffer is full there are two
2439	* alternatives (indicated by a buffer flag), either wait for the
2440	* consumer to get it's job done, or to write a generic message saying
2441	* buffer overflow.
2442	*
2443	* Since the waiting would need a signal semaphore, we'll skip that for now.
2444	*
2445	* @returns iprt status code.
2446	* @param pBuffer Pointer to a logger hook buffer.
2447	*/
2448	RTDECL(int) RTLogRegisterHook(PRTLOGGER pLogger, PRTLOGHOOKBUFFER pBuffer);
2449
2450	/**
2451	* Deregister a logging hook registered with RTLogRegisterHook().
2452	*
2453	* @returns iprt status code.
2454	* @param pBuffer Pointer to a logger hook buffer.
2455	*/
2456	RTDECL(int) RTLogDeregisterHook(PRTLOGGER pLogger, PRTLOGHOOKBUFFER pBuffer);
2457
2458	#endif /* not implemented yet */
2459
2460
2461
2462	/**
2463	* Write log buffer to a debugger (RTLOGDEST_DEBUGGER).
2464	*
2465	* @param pach What to write.
2466	* @param cb How much to write.
2467	* @remark When linking statically, this function can be replaced by defining your own.
2468	*/
2469	RTDECL(void) RTLogWriteDebugger(const char *pach, size_t cb);
2470
2471	/**
2472	* Write log buffer to a user defined output stream (RTLOGDEST_USER).
2473	*
2474	* @param pach What to write.
2475	* @param cb How much to write.
2476	* @remark When linking statically, this function can be replaced by defining your own.
2477	*/
2478	RTDECL(void) RTLogWriteUser(const char *pach, size_t cb);
2479
2480	/**
2481	* Write log buffer to stdout (RTLOGDEST_STDOUT).
2482	*
2483	* @param pach What to write.
2484	* @param cb How much to write.
2485	* @remark When linking statically, this function can be replaced by defining your own.
2486	*/
2487	RTDECL(void) RTLogWriteStdOut(const char *pach, size_t cb);
2488
2489	/**
2490	* Write log buffer to stdout (RTLOGDEST_STDERR).
2491	*
2492	* @param pach What to write.
2493	* @param cb How much to write.
2494	* @remark When linking statically, this function can be replaced by defining your own.
2495	*/
2496	RTDECL(void) RTLogWriteStdErr(const char *pach, size_t cb);
2497
2498	#ifdef VBOX
2499
2500	/**
2501	* Prints a formatted string to the backdoor port.
2502	*
2503	* @returns Number of bytes written.
2504	* @param pszFormat Format string.
2505	* @param ... Optional arguments specified in the format string.
2506	*/
2507	RTDECL(size_t) RTLogBackdoorPrintf(const char *pszFormat, ...) RT_IPRT_FORMAT_ATTR(1, 2);
2508
2509	/**
2510	* Prints a formatted string to the backdoor port.
2511	*
2512	* @returns Number of bytes written.
2513	* @param pszFormat Format string.
2514	* @param args Optional arguments specified in the format string.
2515	*/
2516	RTDECL(size_t) RTLogBackdoorPrintfV(const char *pszFormat, va_list args) RT_IPRT_FORMAT_ATTR(1, 0);
2517
2518	#endif /* VBOX */
2519
2520	RT_C_DECLS_END
2521
2522	/** @} */
2523
2524	#endif
2525

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

source: vbox/trunk/include/iprt/log.h@ 57974

Download in other formats: