log.h@ 11270

Last change on this file since 11270 was 10646, checked in by vboxsync, 16 years ago
Made RTLogDestroy ignore NULL logger.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 53.5 KB

Line
1	/** @file
2	* IPRT - Logging.
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 ___iprt_log_h
31	#define ___iprt_log_h
32
33	#include <iprt/cdefs.h>
34	#include <iprt/types.h>
35	#include <iprt/stdarg.h>
36
37	__BEGIN_DECLS
38
39	/** @defgroup grp_rt_log RTLog - Logging
40	* @ingroup grp_rt
41	* @{
42	*/
43
44	/**
45	* IPRT Logging Groups.
46	* (Remember to update RT_LOGGROUP_NAMES!)
47	*
48	* @remark It should be pretty obvious, but just to have
49	* mentioned it, the values are sorted alphabetically (using the
50	* english alphabet) except for _DEFAULT which is always first.
51	*
52	* If anyone might be wondering what the alphabet looks like:
53	* 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
54	*/
55	typedef enum RTLOGGROUP
56	{
57	/** Default logging group. */
58	RTLOGGROUP_DEFAULT,
59	RTLOGGROUP_DIR,
60	RTLOGGROUP_FILE,
61	RTLOGGROUP_FS,
62	RTLOGGROUP_LDR,
63	RTLOGGROUP_PATH,
64	RTLOGGROUP_PROCESS,
65	RTLOGGROUP_THREAD,
66	RTLOGGROUP_TIME,
67	RTLOGGROUP_TIMER,
68	RTLOGGROUP_ZIP = 31,
69	RTLOGGROUP_FIRST_USER = 32
70	} RTLOGGROUP;
71
72	/** @def RT_LOGGROUP_NAMES
73	* IPRT Logging group names.
74	*
75	* Must correspond 100% to RTLOGGROUP!
76	* Don't forget commas!
77	*
78	* @remark It should be pretty obvious, but just to have
79	* mentioned it, the values are sorted alphabetically (using the
80	* english alphabet) except for _DEFAULT which is always first.
81	*
82	* If anyone might be wondering what the alphabet looks like:
83	* 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
84	*/
85	#define RT_LOGGROUP_NAMES \
86	"DEFAULT", \
87	"RT_DIR", \
88	"RT_FILE", \
89	"RT_FS", \
90	"RT_LDR", \
91	"RT_PATH", \
92	"RT_PROCESS", \
93	"RT_THREAD", \
94	"RT_TIME", \
95	"RT_TIMER", \
96	"RT_10", \
97	"RT_11", \
98	"RT_12", \
99	"RT_13", \
100	"RT_14", \
101	"RT_15", \
102	"RT_16", \
103	"RT_17", \
104	"RT_18", \
105	"RT_19", \
106	"RT_20", \
107	"RT_21", \
108	"RT_22", \
109	"RT_23", \
110	"RT_24", \
111	"RT_25", \
112	"RT_26", \
113	"RT_27", \
114	"RT_28", \
115	"RT_29", \
116	"RT_30", \
117	"RT_ZIP" \
118
119
120	/** @def LOG_GROUP
121	* Active logging group.
122	*/
123	#ifndef LOG_GROUP
124	# define LOG_GROUP RTLOGGROUP_DEFAULT
125	#endif
126
127	/** @def LOG_INSTANCE
128	* Active logging instance.
129	*/
130	#ifndef LOG_INSTANCE
131	# define LOG_INSTANCE NULL
132	#endif
133
134	/** @def LOG_REL_INSTANCE
135	* Active release logging instance.
136	*/
137	#ifndef LOG_REL_INSTANCE
138	# define LOG_REL_INSTANCE NULL
139	#endif
140
141	/** @def LOG_FN_FMT
142	* You can use this to specify you desired way of printing __PRETTY_FUNCTION__
143	* if you dislike the default one.
144	*/
145	#ifndef LOG_FN_FMT
146	# define LOG_FN_FMT "%Rfn"
147	#endif
148
149	/** Logger structure. */
150	#ifdef IN_GC
151	typedef struct RTLOGGERRC RTLOGGER;
152	#else
153	typedef struct RTLOGGER RTLOGGER;
154	#endif
155	/** Pointer to logger structure. */
156	typedef RTLOGGER *PRTLOGGER;
157	/** Pointer to const logger structure. */
158	typedef const RTLOGGER *PCRTLOGGER;
159
160
161	/** Guest context logger structure. */
162	typedef struct RTLOGGERRC RTLOGGERRC;
163	/** Pointer to guest context logger structure. */
164	typedef RTLOGGERRC *PRTLOGGERRC;
165	/** Pointer to const guest context logger structure. */
166	typedef const RTLOGGERRC *PCRTLOGGERRC;
167
168
169	/**
170	* Logger function.
171	*
172	* @param pszFormat Format string.
173	* @param ... Optional arguments as specified in the format string.
174	*/
175	typedef DECLCALLBACK(void) FNRTLOGGER(const char *pszFormat, ...);
176	/** Pointer to logger function. */
177	typedef FNRTLOGGER *PFNRTLOGGER;
178
179	/**
180	* Flush function.
181	*
182	* @param pLogger Pointer to the logger instance which is to be flushed.
183	*/
184	typedef DECLCALLBACK(void) FNRTLOGFLUSH(PRTLOGGER pLogger);
185	/** Pointer to logger function. */
186	typedef FNRTLOGFLUSH *PFNRTLOGFLUSH;
187
188	/**
189	* Flush function.
190	*
191	* @param pLogger Pointer to the logger instance which is to be flushed.
192	*/
193	typedef DECLCALLBACK(void) FNRTLOGFLUSHGC(PRTLOGGERRC pLogger);
194	/** Pointer to logger function. */
195	typedef RCPTRTYPE(FNRTLOGFLUSHGC *) PFNRTLOGFLUSHGC;
196
197
198	/**
199	* Logger instance structure for GC.
200	*/
201	struct RTLOGGERRC
202	{
203	/** Pointer to temporary scratch buffer.
204	* This is used to format the log messages. */
205	char achScratch[16384];
206	/** Current scratch buffer position. */
207	RTUINT offScratch;
208	/** This is set if a prefix is pending. */
209	RTUINT fPendingPrefix;
210	/** Pointer to the logger function.
211	* This is actually pointer to a wrapper which will push a pointer to the
212	* instance pointer onto the stack before jumping to the real logger function.
213	* A very unfortunate hack to work around the missing variadic macro support in C++. */
214	RCPTRTYPE(PFNRTLOGGER) pfnLogger;
215	/** Pointer to the flush function. */
216	PFNRTLOGFLUSHGC pfnFlush;
217	/** Magic number (RTLOGGERRC_MAGIC). */
218	uint32_t u32Magic;
219	/** Logger instance flags - RTLOGFLAGS. */
220	RTUINT fFlags;
221	/** Number of groups in the afGroups member. */
222	RTUINT cGroups;
223	/** Group flags array - RTLOGGRPFLAGS.
224	* This member have variable length and may extend way beyond
225	* the declared size of 1 entry. */
226	RTUINT afGroups[1];
227	};
228
229	/** RTLOGGERRC::u32Magic value. (John Rogers Searle) */
230	#define RTLOGGERRC_MAGIC 0x19320731
231
232
233
234	#ifndef IN_GC
235	/**
236	* Logger instance structure.
237	*/
238	struct RTLOGGER
239	{
240	/** Pointer to temporary scratch buffer.
241	* This is used to format the log messages. */
242	char achScratch[16384];
243	/** Current scratch buffer position. */
244	RTUINT offScratch;
245	/** This is set if a prefix is pending. */
246	RTUINT fPendingPrefix;
247	/** Pointer to the logger function.
248	* This is actually pointer to a wrapper which will push a pointer to the
249	* instance pointer onto the stack before jumping to the real logger function.
250	* A very unfortunate hack to work around the missing variadic macro support in C++.
251	* (The memory is (not R0) allocated using RTMemExecAlloc().) */
252	PFNRTLOGGER pfnLogger;
253	/** Pointer to the flush function. */
254	PFNRTLOGFLUSH pfnFlush;
255	/** Mutex. */
256	RTSEMFASTMUTEX MutexSem;
257	/** Magic number. */
258	uint32_t u32Magic;
259	/** Logger instance flags - RTLOGFLAGS. */
260	RTUINT fFlags;
261	/** Destination flags - RTLOGDEST. */
262	RTUINT fDestFlags;
263	/** Handle to log file (if open). */
264	RTFILE File;
265	/** Pointer to filename.
266	* (The memory is allocated in the smae block as RTLOGGER.) */
267	char *pszFilename;
268	/** Pointer to the group name array.
269	* (The data is readonly and provided by the user.) */
270	const char * const *papszGroups;
271	/** The max number of groups that there is room for in afGroups and papszGroups.
272	* Used by RTLogCopyGroupAndFlags(). */
273	RTUINT cMaxGroups;
274	/** Number of groups in the afGroups and papszGroups members. */
275	RTUINT cGroups;
276	/** Group flags array - RTLOGGRPFLAGS.
277	* This member have variable length and may extend way beyond
278	* the declared size of 1 entry. */
279	RTUINT afGroups[1];
280	};
281
282	/** RTLOGGER::u32Magic value. (Avram Noam Chomsky) */
283	#define RTLOGGER_MAGIC 0x19281207
284
285	#endif
286
287
288	/**
289	* Logger flags.
290	*/
291	typedef enum RTLOGFLAGS
292	{
293	/** The logger instance is disabled for normal output. */
294	RTLOGFLAGS_DISABLED = 0x00000001,
295	/** The logger instance is using buffered output. */
296	RTLOGFLAGS_BUFFERED = 0x00000002,
297	/** The logger instance expands LF to CR/LF. */
298	RTLOGFLAGS_USECRLF = 0x00000010,
299	/** Show relative timestamps with PREFIX_TSC and PREFIX_TS */
300	RTLOGFLAGS_REL_TS = 0x00000020,
301	/** Show decimal timestamps with PREFIX_TSC and PREFIX_TS */
302	RTLOGFLAGS_DECIMAL_TS = 0x00000040,
303	/** New lines should be prefixed with the write and read lock counts. */
304	RTLOGFLAGS_PREFIX_LOCK_COUNTS = 0x00008000,
305	/** New lines should be prefixed with the CPU id (ApicID on intel/amd). */
306	RTLOGFLAGS_PREFIX_CPUID = 0x00010000,
307	/** New lines should be prefixed with the native process id. */
308	RTLOGFLAGS_PREFIX_PID = 0x00020000,
309	/** New lines should be prefixed with group flag number causing the output. */
310	RTLOGFLAGS_PREFIX_FLAG_NO = 0x00040000,
311	/** New lines should be prefixed with group flag name causing the output. */
312	RTLOGFLAGS_PREFIX_FLAG = 0x00080000,
313	/** New lines should be prefixed with group number. */
314	RTLOGFLAGS_PREFIX_GROUP_NO = 0x00100000,
315	/** New lines should be prefixed with group name. */
316	RTLOGFLAGS_PREFIX_GROUP = 0x00200000,
317	/** New lines should be prefixed with the native thread id. */
318	RTLOGFLAGS_PREFIX_TID = 0x00400000,
319	/** New lines should be prefixed with thread name. */
320	RTLOGFLAGS_PREFIX_THREAD = 0x00800000,
321	/** New lines should be prefixed with formatted timestamp since program start. */
322	RTLOGFLAGS_PREFIX_TIME_PROG = 0x04000000,
323	/** New lines should be prefixed with formatted timestamp (UCT). */
324	RTLOGFLAGS_PREFIX_TIME = 0x08000000,
325	/** New lines should be prefixed with milliseconds since program start. */
326	RTLOGFLAGS_PREFIX_MS_PROG = 0x10000000,
327	/** New lines should be prefixed with timestamp. */
328	RTLOGFLAGS_PREFIX_TSC = 0x20000000,
329	/** New lines should be prefixed with timestamp. */
330	RTLOGFLAGS_PREFIX_TS = 0x40000000,
331	/** The prefix mask. */
332	RTLOGFLAGS_PREFIX_MASK = 0x7cff8000
333	} RTLOGFLAGS;
334
335	/**
336	* Logger per group flags.
337	*/
338	typedef enum RTLOGGRPFLAGS
339	{
340	/** Enabled. */
341	RTLOGGRPFLAGS_ENABLED = 0x00000001,
342	/** Level 1 logging. */
343	RTLOGGRPFLAGS_LEVEL_1 = 0x00000002,
344	/** Level 2 logging. */
345	RTLOGGRPFLAGS_LEVEL_2 = 0x00000004,
346	/** Level 3 logging. */
347	RTLOGGRPFLAGS_LEVEL_3 = 0x00000008,
348	/** Level 4 logging. */
349	RTLOGGRPFLAGS_LEVEL_4 = 0x00000010,
350	/** Level 5 logging. */
351	RTLOGGRPFLAGS_LEVEL_5 = 0x00000020,
352	/** Level 6 logging. */
353	RTLOGGRPFLAGS_LEVEL_6 = 0x00000040,
354	/** Flow logging. */
355	RTLOGGRPFLAGS_FLOW = 0x00000080,
356
357	/** Lelik logging. */
358	RTLOGGRPFLAGS_LELIK = 0x00000100,
359	/** Michael logging. */
360	RTLOGGRPFLAGS_MICHAEL = 0x00000200,
361	/** dmik logging. */
362	RTLOGGRPFLAGS_DMIK = 0x00000400,
363	/** sunlover logging. */
364	RTLOGGRPFLAGS_SUNLOVER = 0x00000800,
365	/** Achim logging. */
366	RTLOGGRPFLAGS_ACHIM = 0x00001000,
367	/** Sander logging. */
368	RTLOGGRPFLAGS_SANDER = 0x00002000,
369	/** Klaus logging. */
370	RTLOGGRPFLAGS_KLAUS = 0x00004000,
371	/** Frank logging. */
372	RTLOGGRPFLAGS_FRANK = 0x00008000,
373	/** bird logging. */
374	RTLOGGRPFLAGS_BIRD = 0x00010000,
375	/** NoName logging. */
376	RTLOGGRPFLAGS_NONAME = 0x00020000
377	} RTLOGGRPFLAGS;
378
379	/**
380	* Logger destination type.
381	*/
382	typedef enum RTLOGDEST
383	{
384	/** Log to file. */
385	RTLOGDEST_FILE = 0x00000001,
386	/** Log to stdout. */
387	RTLOGDEST_STDOUT = 0x00000002,
388	/** Log to stderr. */
389	RTLOGDEST_STDERR = 0x00000004,
390	/** Log to debugger (win32 only). */
391	RTLOGDEST_DEBUGGER = 0x00000008,
392	/** Log to com port. */
393	RTLOGDEST_COM = 0x00000010,
394	/** Just a dummy flag to be used when no other flag applies. */
395	RTLOGDEST_DUMMY = 0x20000000,
396	/** Log to a user defined output stream. */
397	RTLOGDEST_USER = 0x40000000
398	} RTLOGDEST;
399
400
401	RTDECL(void) RTLogPrintfEx(void pvInstance, unsigned fFlags, unsigned iGroup, const char pszFormat, ...);
402
403
404	/*
405	* Determin whether logging is enabled and forcefully normalize the indicators.
406	*/
407	#if (defined(DEBUG) \|\| defined(LOG_ENABLED)) && !defined(LOG_DISABLED)
408	# undef LOG_DISABLED
409	# undef LOG_ENABLED
410	# define LOG_ENABLED
411	#else
412	# undef LOG_ENABLED
413	# undef LOG_DISABLED
414	# define LOG_DISABLED
415	#endif
416
417
418	/** @def LOG_USE_C99
419	* Governs the use of variadic macros.
420	*/
421	#ifndef LOG_USE_C99
422	# if defined(RT_ARCH_AMD64)
423	# define LOG_USE_C99
424	# endif
425	#endif
426
427
428	/** @def LogIt
429	* Write to specific logger if group enabled.
430	*/
431	#ifdef LOG_ENABLED
432	# if defined(LOG_USE_C99)
433	# define _LogRemoveParentheseis(...) __VA_ARGS__
434	# define _LogIt(pvInst, fFlags, iGroup, ...) RTLogLoggerEx((PRTLOGGER)pvInst, fFlags, iGroup, __VA_ARGS__)
435	# define LogIt(pvInst, fFlags, iGroup, fmtargs) _LogIt(pvInst, fFlags, iGroup, _LogRemoveParentheseis fmtargs)
436	# define _LogItAlways(pvInst, fFlags, iGroup, ...) RTLogLoggerEx((PRTLOGGER)pvInst, fFlags, ~0U, __VA_ARGS__)
437	# define LogItAlways(pvInst, fFlags, iGroup, fmtargs) _LogItAlways(pvInst, fFlags, iGroup, _LogRemoveParentheseis fmtargs)
438	/** @todo invent a flag or something for skipping the group check so we can pass iGroup. LogItAlways. */
439	# else
440	# define LogIt(pvInst, fFlags, iGroup, fmtargs) \
441	do \
442	{ \
443	register PRTLOGGER LogIt_pLogger = (PRTLOGGER)(pvInst) ? (PRTLOGGER)(pvInst) : RTLogDefaultInstance(); \
444	if (LogIt_pLogger) \
445	{ \
446	register unsigned LogIt_fFlags = LogIt_pLogger->afGroups[(unsigned)(iGroup) < LogIt_pLogger->cGroups ? (unsigned)(iGroup) : 0]; \
447	if ((LogIt_fFlags & ((fFlags) \| RTLOGGRPFLAGS_ENABLED)) == ((fFlags) \| RTLOGGRPFLAGS_ENABLED)) \
448	LogIt_pLogger->pfnLogger fmtargs; \
449	} \
450	} while (0)
451	# define LogItAlways(pvInst, fFlags, iGroup, fmtargs) \
452	do \
453	{ \
454	register PRTLOGGER LogIt_pLogger = (PRTLOGGER)(pvInst) ? (PRTLOGGER)(pvInst) : RTLogDefaultInstance(); \
455	if (LogIt_pLogger) \
456	LogIt_pLogger->pfnLogger fmtargs; \
457	} while (0)
458	# endif
459	#else
460	# define LogIt(pvInst, fFlags, iGroup, fmtargs) do { } while (0)
461	# define LogItAlways(pvInst, fFlags, iGroup, fmtargs) do { } while (0)
462	# if defined(LOG_USE_C99)
463	# define _LogRemoveParentheseis(...) __VA_ARGS__
464	# define _LogIt(pvInst, fFlags, iGroup, ...) do { } while (0)
465	# define _LogItAlways(pvInst, fFlags, iGroup, ...) do { } while (0)
466	# endif
467	#endif
468
469
470	/** @def Log
471	* Level 1 logging that works regardless of the group settings.
472	*/
473	#define LogAlways(a) LogItAlways(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
474
475	/** @def Log
476	* Level 1 logging.
477	*/
478	#define Log(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
479
480	/** @def Log2
481	* Level 2 logging.
482	*/
483	#define Log2(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a)
484
485	/** @def Log3
486	* Level 3 logging.
487	*/
488	#define Log3(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a)
489
490	/** @def Log4
491	* Level 4 logging.
492	*/
493	#define Log4(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a)
494
495	/** @def Log5
496	* Level 5 logging.
497	*/
498	#define Log5(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a)
499
500	/** @def Log6
501	* Level 6 logging.
502	*/
503	#define Log6(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a)
504
505	/** @def LogFlow
506	* Logging of execution flow.
507	*/
508	#define LogFlow(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, a)
509
510	/** @def LogLelik
511	* lelik logging.
512	*/
513	#define LogLelik(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LELIK, LOG_GROUP, a)
514
515
516	/** @def LogMichael
517	* michael logging.
518	*/
519	#define LogMichael(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_MICHAEL, LOG_GROUP, a)
520
521	/** @def LogDmik
522	* dmik logging.
523	*/
524	#define LogDmik(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_DMIK, LOG_GROUP, a)
525
526	/** @def LogSunlover
527	* sunlover logging.
528	*/
529	#define LogSunlover(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_SUNLOVER, LOG_GROUP, a)
530
531	/** @def LogAchim
532	* Achim logging.
533	*/
534	#define LogAchim(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_ACHIM, LOG_GROUP, a)
535
536	/** @def LogSander
537	* Sander logging.
538	*/
539	#define LogSander(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_SANDER, LOG_GROUP, a)
540
541	/** @def LogKlaus
542	* klaus logging.
543	*/
544	#define LogKlaus(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_KLAUS, LOG_GROUP, a)
545
546	/** @def LogFrank
547	* frank logging.
548	*/
549	#define LogFrank(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FRANK, LOG_GROUP, a)
550
551	/** @def LogBird
552	* bird logging.
553	*/
554	#define LogBird(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_BIRD, LOG_GROUP, a)
555
556	/** @def LogNoName
557	* NoName logging.
558	*/
559	#define LogNoName(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_NONAME, LOG_GROUP, a)
560
561
562	/** @def LogWarning
563	* The same as Log(), but prepents a <tt>"WARNING! "</tt> string to the message.
564	*
565	* @param a Custom log message in format <tt>("string\n" [, args])</tt>.
566	*/
567	#if defined(LOG_USE_C99)
568	# define LogWarning(a) \
569	_LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "WARNING! %M", _LogRemoveParentheseis a )
570	#else
571	# define LogWarning(a) \
572	do { Log(("WARNING! ")); Log(a); } while (0)
573	#endif
574
575	/** @def LogTrace
576	* Macro to trace the execution flow: logs the file name, line number and
577	* function name. Can be easily searched for in log files using the
578	* ">>>>>" pattern (prepended to the beginning of each line).
579	*/
580	#define LogTrace() \
581	LogFlow((">>>>> %s (%d): " LOG_FN_FMT "\n", __FILE__, __LINE__, __PRETTY_FUNCTION__))
582
583	/** @def LogTraceMsg
584	* The same as LogTrace but logs a custom log message right after the trace line.
585	*
586	* @param a Custom log message in format <tt>("string\n" [, args])</tt>.
587	*/
588	#ifdef LOG_USE_C99
589	# define LogTraceMsg(a) \
590	_LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, ">>>>> %s (%d): %M" LOG_FN_FMT, __FILE__, __LINE__, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
591	#else
592	# define LogTraceMsg(a) \
593	do { LogFlow((">>>>> %s (%d): " LOG_FN_FMT, __FILE__, __LINE__, __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
594	#endif
595
596	/** @def LogFunc
597	* Level 1 logging inside C/C++ functions.
598	*
599	* Prepends the given log message with the function name followed by a
600	* semicolon and space.
601	*
602	* @param a Log message in format <tt>("string\n" [, args])</tt>.
603	*/
604	#ifdef LOG_USE_C99
605	# define LogFunc(a) \
606	_LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
607	#else
608	# define LogFunc(a) \
609	do { Log((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log(a); } while (0)
610	#endif
611
612	/** @def LogThisFunc
613	* The same as LogFunc but for class functions (methods): the resulting log
614	* line is additionally prepended with a hex value of \|this\| pointer.
615	*
616	* @param a Log message in format <tt>("string\n" [, args])</tt>.
617	*/
618	#ifdef LOG_USE_C99
619	# define LogThisFunc(a) \
620	_LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
621	#else
622	# define LogThisFunc(a) \
623	do { Log(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log(a); } while (0)
624	#endif
625
626	/** @def LogFlowFunc
627	* Macro to log the execution flow inside C/C++ functions.
628	*
629	* Prepends the given log message with the function name followed by
630	* a semicolon and space.
631	*
632	* @param a Log message in format <tt>("string\n" [, args])</tt>.
633	*/
634	#ifdef LOG_USE_C99
635	# define LogFlowFunc(a) \
636	_LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
637	#else
638	# define LogFlowFunc(a) \
639	do { LogFlow((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
640	#endif
641
642	/** @def LogWarningFunc
643	* The same as LogWarning(), but prepents the log message with the function name.
644	*
645	* @param a Log message in format <tt>("string\n" [, args])</tt>.
646	*/
647	#ifdef LOG_USE_C99
648	# define LogWarningFunc(a) \
649	_LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": WARNING! %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
650	#else
651	# define LogWarningFunc(a) \
652	do { Log((LOG_FN_FMT ": WARNING! ", __PRETTY_FUNCTION__)); Log(a); } while (0)
653	#endif
654
655	/** @def LogFlowThisFunc
656	* The same as LogFlowFunc but for class functions (methods): the resulting log
657	* line is additionally prepended with a hex value of \|this\| pointer.
658	*
659	* @param a Log message in format <tt>("string\n" [, args])</tt>.
660	*/
661	#ifdef LOG_USE_C99
662	# define LogFlowThisFunc(a) \
663	_LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
664	#else
665	# define LogFlowThisFunc(a) \
666	do { LogFlow(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
667	#endif
668
669	/** @def LogWarningThisFunc
670	* The same as LogWarningFunc() but for class functions (methods): the resulting
671	* log line is additionally prepended with a hex value of \|this\| pointer.
672	*
673	* @param a Log message in format <tt>("string\n" [, args])</tt>.
674	*/
675	#ifdef LOG_USE_C99
676	# define LogWarningThisFunc(a) \
677	_LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": WARNING! %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
678	#else
679	# define LogWarningThisFunc(a) \
680	do { Log(("{%p} " LOG_FN_FMT ": WARNING! ", this, __PRETTY_FUNCTION__)); Log(a); } while (0)
681	#endif
682
683	/** Shortcut to \|LogFlowFunc ("ENTER\n")\|, marks the beginnig of the function. */
684	#define LogFlowFuncEnter() LogFlowFunc(("ENTER\n"))
685
686	/** Shortcut to \|LogFlowFunc ("LEAVE\n")\|, marks the end of the function. */
687	#define LogFlowFuncLeave() LogFlowFunc(("LEAVE\n"))
688
689	/** Shortcut to \|LogFlowThisFunc ("ENTER\n")\|, marks the beginnig of the function. */
690	#define LogFlowThisFuncEnter() LogFlowThisFunc(("ENTER\n"))
691
692	/** Shortcut to \|LogFlowThisFunc ("LEAVE\n")\|, marks the end of the function. */
693	#define LogFlowThisFuncLeave() LogFlowThisFunc(("LEAVE\n"))
694
695	/** @def LogObjRefCnt
696	* Helper macro to print the current reference count of the given COM object
697	* to the log file.
698	*
699	* @param pObj Pointer to the object in question (must be a pointer to an
700	* IUnknown subclass or simply define COM-style AddRef() and
701	* Release() methods)
702	*
703	* @note Use it only for temporary debugging. It leaves dummy code even if
704	* logging is disabled.
705	*/
706	#define LogObjRefCnt(pObj) \
707	do { \
708	int refc = (pObj)->AddRef(); \
709	LogFlow((#pObj "{%p}.refCnt=%d\n", (pObj), refc - 1)); \
710	(pObj)->Release(); \
711	} while (0)
712
713
714	/** @def LogIsItEnabled
715	* Checks whether the specified logging group is enabled or not.
716	*/
717	#ifdef LOG_ENABLED
718	# define LogIsItEnabled(pvInst, fFlags, iGroup) \
719	LogIsItEnabledInternal((pvInst), (unsigned)(iGroup), (unsigned)(fFlags))
720	#else
721	# define LogIsItEnabled(pvInst, fFlags, iGroup) (false)
722	#endif
723
724	/** @def LogIsEnabled
725	* Checks whether level 1 logging is enabled.
726	*/
727	#define LogIsEnabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP)
728
729	/** @def LogIs2Enabled
730	* Checks whether level 2 logging is enabled.
731	*/
732	#define LogIs2Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP)
733
734	/** @def LogIs3Enabled
735	* Checks whether level 3 logging is enabled.
736	*/
737	#define LogIs3Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP)
738
739	/** @def LogIs4Enabled
740	* Checks whether level 4 logging is enabled.
741	*/
742	#define LogIs4Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP)
743
744	/** @def LogIs5Enabled
745	* Checks whether level 5 logging is enabled.
746	*/
747	#define LogIs5Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP)
748
749	/** @def LogIs6Enabled
750	* Checks whether level 6 logging is enabled.
751	*/
752	#define LogIs6Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP)
753
754	/** @def LogIsFlowEnabled
755	* Checks whether execution flow logging is enabled.
756	*/
757	#define LogIsFlowEnabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP)
758
759
760	#ifdef DOXYGEN_RUNNING
761	# define LOG_DISABLED
762	# define LOG_ENABLED
763	# define LOG_ENABLE_FLOW
764	#endif
765
766	/** @def LOG_DISABLED
767	* Use this compile time define to disable all logging macros. It can
768	* be overriden for each of the logging macros by the LOG_ENABLE*
769	* compile time defines.
770	*/
771
772	/** @def LOG_ENABLED
773	* Use this compile time define to enable logging when not in debug mode
774	* or LOG_DISABLED is set.
775	* This will enabled Log() only.
776	*/
777
778	/** @def LOG_ENABLE_FLOW
779	* Use this compile time define to enable flow logging when not in
780	* debug mode or LOG_DISABLED is defined.
781	* This will enable LogFlow() only.
782	*/
783
784
785
786	/** @name Release Logging
787	* @{
788	*/
789
790	/** @def LogIt
791	* Write to specific logger if group enabled.
792	*/
793	#if defined(LOG_USE_C99)
794	# define _LogRelRemoveParentheseis(...) __VA_ARGS__
795	# define _LogRelIt(pvInst, fFlags, iGroup, ...) RTLogLoggerEx((PRTLOGGER)pvInst, fFlags, iGroup, __VA_ARGS__)
796	# define LogRelIt(pvInst, fFlags, iGroup, fmtargs) \
797	do \
798	{ \
799	PRTLOGGER LogRelIt_pLogger = (PRTLOGGER)(pvInst) ? (PRTLOGGER)(pvInst) : RTLogRelDefaultInstance(); \
800	if (LogRelIt_pLogger) \
801	_LogRelIt(LogRelIt_pLogger, fFlags, iGroup, _LogRelRemoveParentheseis fmtargs); \
802	LogIt(LOG_INSTANCE, fFlags, iGroup, fmtargs); \
803	} while (0)
804	#else
805	# define LogRelIt(pvInst, fFlags, iGroup, fmtargs) \
806	do \
807	{ \
808	PRTLOGGER LogRelIt_pLogger = (PRTLOGGER)(pvInst) ? (PRTLOGGER)(pvInst) : RTLogRelDefaultInstance(); \
809	if (LogRelIt_pLogger) \
810	{ \
811	unsigned LogIt_fFlags = LogRelIt_pLogger->afGroups[(unsigned)(iGroup) < LogRelIt_pLogger->cGroups ? (unsigned)(iGroup) : 0]; \
812	if ((LogIt_fFlags & ((fFlags) \| RTLOGGRPFLAGS_ENABLED)) == ((fFlags) \| RTLOGGRPFLAGS_ENABLED)) \
813	LogRelIt_pLogger->pfnLogger fmtargs; \
814	} \
815	LogIt(LOG_INSTANCE, fFlags, iGroup, fmtargs); \
816	} while (0)
817	#endif
818
819
820	/** @def LogRel
821	* Level 1 logging.
822	*/
823	#define LogRel(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
824
825	/** @def LogRel2
826	* Level 2 logging.
827	*/
828	#define LogRel2(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a)
829
830	/** @def LogRel3
831	* Level 3 logging.
832	*/
833	#define LogRel3(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a)
834
835	/** @def LogRel4
836	* Level 4 logging.
837	*/
838	#define LogRel4(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a)
839
840	/** @def LogRel5
841	* Level 5 logging.
842	*/
843	#define LogRel5(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a)
844
845	/** @def LogRel6
846	* Level 6 logging.
847	*/
848	#define LogRel6(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a)
849
850	/** @def LogRelFlow
851	* Logging of execution flow.
852	*/
853	#define LogRelFlow(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, a)
854
855	/** @def LogRelFunc
856	* Release logging. Prepends the given log message with the function name
857	* followed by a semicolon and space.
858	*/
859	#define LogRelFunc(a) \
860	do { LogRel((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogRel(a); } while (0)
861
862	/** @def LogRelThisFunc
863	* The same as LogRelFunc but for class functions (methods): the resulting log
864	* line is additionally prepended with a hex value of \|this\| pointer.
865	*/
866	#define LogRelThisFunc(a) \
867	do { LogRel(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); LogRel(a); } while (0)
868
869	/** @def LogRelLelik
870	* lelik logging.
871	*/
872	#define LogRelLelik(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LELIK, LOG_GROUP, a)
873
874	/** @def LogRelMichael
875	* michael logging.
876	*/
877	#define LogRelMichael(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_MICHAEL, LOG_GROUP, a)
878
879	/** @def LogRelDmik
880	* dmik logging.
881	*/
882	#define LogRelDmik(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_DMIK, LOG_GROUP, a)
883
884	/** @def LogRelSunlover
885	* sunlover logging.
886	*/
887	#define LogRelSunlover(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_SUNLOVER, LOG_GROUP, a)
888
889	/** @def LogRelAchim
890	* Achim logging.
891	*/
892	#define LogRelAchim(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_ACHIM, LOG_GROUP, a)
893
894	/** @def LogRelSander
895	* Sander logging.
896	*/
897	#define LogRelSander(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_SANDER, LOG_GROUP, a)
898
899	/** @def LogRelKlaus
900	* klaus logging.
901	*/
902	#define LogRelKlaus(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_KLAUS, LOG_GROUP, a)
903
904	/** @def LogRelFrank
905	* frank logging.
906	*/
907	#define LogRelFrank(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FRANK, LOG_GROUP, a)
908
909	/** @def LogRelBird
910	* bird logging.
911	*/
912	#define LogRelBird(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_BIRD, LOG_GROUP, a)
913
914	/** @def LogRelNoName
915	* NoName logging.
916	*/
917	#define LogRelNoName(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_NONAME, LOG_GROUP, a)
918
919
920	/** @def LogRelIsItEnabled
921	* Checks whether the specified logging group is enabled or not.
922	*/
923	#define LogRelIsItEnabled(pvInst, fFlags, iGroup) \
924	LogRelIsItEnabledInternal((pvInst), (unsigned)(iGroup), (unsigned)(fFlags))
925
926	/** @def LogRelIsEnabled
927	* Checks whether level 1 logging is enabled.
928	*/
929	#define LogRelIsEnabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP)
930
931	/** @def LogRelIs2Enabled
932	* Checks whether level 2 logging is enabled.
933	*/
934	#define LogRelIs2Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP)
935
936	/** @def LogRelIs3Enabled
937	* Checks whether level 3 logging is enabled.
938	*/
939	#define LogRelIs3Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP)
940
941	/** @def LogRelIs4Enabled
942	* Checks whether level 4 logging is enabled.
943	*/
944	#define LogRelIs4Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP)
945
946	/** @def LogRelIs5Enabled
947	* Checks whether level 5 logging is enabled.
948	*/
949	#define LogRelIs5Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP)
950
951	/** @def LogRelIs6Enabled
952	* Checks whether level 6 logging is enabled.
953	*/
954	#define LogRelIs6Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP)
955
956	/** @def LogRelIsFlowEnabled
957	* Checks whether execution flow logging is enabled.
958	*/
959	#define LogRelIsFlowEnabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP)
960
961
962	#ifndef IN_GC
963	/**
964	* Sets the default release logger instance.
965	*
966	* @returns The old default instance.
967	* @param pLogger The new default release logger instance.
968	*/
969	RTDECL(PRTLOGGER) RTLogRelSetDefaultInstance(PRTLOGGER pLogger);
970	#endif /* !IN_GC */
971
972	/**
973	* Gets the default release logger instance.
974	*
975	* @returns Pointer to default release logger instance.
976	* @returns NULL if no default release logger instance available.
977	*/
978	RTDECL(PRTLOGGER) RTLogRelDefaultInstance(void);
979
980	/** Internal worker function.
981	* Don't call directly, use the LogRelIsItEnabled macro!
982	*/
983	DECLINLINE(bool) LogRelIsItEnabledInternal(void *pvInst, unsigned iGroup, unsigned fFlags)
984	{
985	register PRTLOGGER pLogger = (PRTLOGGER)pvInst ? (PRTLOGGER)pvInst : RTLogRelDefaultInstance();
986	if (pLogger)
987	{
988	register unsigned fGrpFlags = pLogger->afGroups[(unsigned)iGroup < pLogger->cGroups ? (unsigned)iGroup : 0];
989	if ((fGrpFlags & (fFlags \| RTLOGGRPFLAGS_ENABLED)) == (fFlags \| RTLOGGRPFLAGS_ENABLED))
990	return true;
991	}
992	return false;
993	}
994
995	/**
996	* Write to a logger instance, defaulting to the release one.
997	*
998	* This function will check whether the instance, group and flags makes up a
999	* logging kind which is currently enabled before writing anything to the log.
1000	*
1001	* @param pLogger Pointer to logger instance.
1002	* @param fFlags The logging flags.
1003	* @param iGroup The group.
1004	* The value ~0U is reserved for compatability with RTLogLogger[V] and is
1005	* only for internal usage!
1006	* @param pszFormat Format string.
1007	* @param ... Format arguments.
1008	* @remark This is a worker function for LogRelIt.
1009	*/
1010	RTDECL(void) RTLogRelLogger(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...);
1011
1012	/**
1013	* Write to a logger instance, defaulting to the release one.
1014	*
1015	* This function will check whether the instance, group and flags makes up a
1016	* logging kind which is currently enabled before writing anything to the log.
1017	*
1018	* @param pLogger Pointer to logger instance. If NULL the default release instance is attempted.
1019	* @param fFlags The logging flags.
1020	* @param iGroup The group.
1021	* The value ~0U is reserved for compatability with RTLogLogger[V] and is
1022	* only for internal usage!
1023	* @param pszFormat Format string.
1024	* @param args Format arguments.
1025	*/
1026	RTDECL(void) RTLogRelLoggerV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args);
1027
1028	/**
1029	* printf like function for writing to the default release log.
1030	*
1031	* @param pszFormat Printf like format string.
1032	* @param ... Optional arguments as specified in pszFormat.
1033	*
1034	* @remark The API doesn't support formatting of floating point numbers at the moment.
1035	*/
1036	RTDECL(void) RTLogRelPrintf(const char *pszFormat, ...);
1037
1038	/**
1039	* vprintf like function for writing to the default release log.
1040	*
1041	* @param pszFormat Printf like format string.
1042	* @param args Optional arguments as specified in pszFormat.
1043	*
1044	* @remark The API doesn't support formatting of floating point numbers at the moment.
1045	*/
1046	RTDECL(void) RTLogRelPrintfV(const char *pszFormat, va_list args);
1047
1048
1049	/** @} */
1050
1051
1052
1053	/** @name COM port logging
1054	* {
1055	*/
1056
1057	#ifdef DOXYGEN_RUNNING
1058	# define LOG_TO_COM
1059	# define LOG_NO_COM
1060	#endif
1061
1062	/** @def LOG_TO_COM
1063	* Redirects the normal loging macros to the serial versions.
1064	*/
1065
1066	/** @def LOG_NO_COM
1067	* Disables all LogCom* macros.
1068	*/
1069
1070	/** @def LogCom
1071	* Generic logging to serial port.
1072	*/
1073	#if defined(LOG_ENABLED) && !defined(LOG_NO_COM)
1074	# define LogCom(a) RTLogComPrintf a
1075	#else
1076	# define LogCom(a) do { } while (0)
1077	#endif
1078
1079	/** @def LogComFlow
1080	* Logging to serial port of execution flow.
1081	*/
1082	#if defined(LOG_ENABLED) && defined(LOG_ENABLE_FLOW) && !defined(LOG_NO_COM)
1083	# define LogComFlow(a) RTLogComPrintf a
1084	#else
1085	# define LogComFlow(a) do { } while (0)
1086	#endif
1087
1088	#ifdef LOG_TO_COM
1089	# undef Log
1090	# define Log(a) LogCom(a)
1091	# undef LogFlow
1092	# define LogFlow(a) LogComFlow(a)
1093	#endif
1094
1095	/** @} */
1096
1097
1098	/** @name Backdoor Logging
1099	* @{
1100	*/
1101
1102	#ifdef DOXYGEN_RUNNING
1103	# define LOG_TO_BACKDOOR
1104	# define LOG_NO_BACKDOOR
1105	#endif
1106
1107	/** @def LOG_TO_BACKDOOR
1108	* Redirects the normal logging macros to the backdoor versions.
1109	*/
1110
1111	/** @def LOG_NO_BACKDOOR
1112	* Disables all LogBackdoor* macros.
1113	*/
1114
1115	/** @def LogBackdoor
1116	* Generic logging to the VBox backdoor via port I/O.
1117	*/
1118	#if defined(LOG_ENABLED) && !defined(LOG_NO_BACKDOOR)
1119	# define LogBackdoor(a) RTLogBackdoorPrintf a
1120	#else
1121	# define LogBackdoor(a) do { } while (0)
1122	#endif
1123
1124	/** @def LogBackdoorFlow
1125	* Logging of execution flow messages to the backdoor I/O port.
1126	*/
1127	#if defined(LOG_ENABLED) && !defined(LOG_NO_BACKDOOR)
1128	# define LogBackdoorFlow(a) RTLogBackdoorPrintf a
1129	#else
1130	# define LogBackdoorFlow(a) do { } while (0)
1131	#endif
1132
1133	/** @def LogRelBackdoor
1134	* Release logging to the VBox backdoor via port I/O.
1135	*/
1136	#if !defined(LOG_NO_BACKDOOR)
1137	# define LogRelBackdoor(a) RTLogBackdoorPrintf a
1138	#else
1139	# define LogRelBackdoor(a) do { } while (0)
1140	#endif
1141
1142	#ifdef LOG_TO_BACKDOOR
1143	# undef Log
1144	# define Log(a) LogBackdoor(a)
1145	# undef LogFlow
1146	# define LogFlow(a) LogBackdoorFlow(a)
1147	# undef LogRel
1148	# define LogRel(a) LogRelBackdoor(a)
1149	#endif
1150
1151	/** @} */
1152
1153
1154
1155	/**
1156	* Gets the default logger instance.
1157	*
1158	* @returns Pointer to default logger instance.
1159	* @returns NULL if no default logger instance available.
1160	*/
1161	RTDECL(PRTLOGGER) RTLogDefaultInstance(void);
1162
1163	#ifndef IN_GC
1164	/**
1165	* Sets the default logger instance.
1166	*
1167	* @returns The old default instance.
1168	* @param pLogger The new default logger instance.
1169	*/
1170	RTDECL(PRTLOGGER) RTLogSetDefaultInstance(PRTLOGGER pLogger);
1171	#endif /* !IN_GC */
1172
1173	#ifdef IN_RING0
1174	/**
1175	* Changes the default logger instance for the current thread.
1176	*
1177	* @returns IPRT status code.
1178	* @param pLogger The logger instance. Pass NULL for deregistration.
1179	* @param uKey Associated key for cleanup purposes. If pLogger is NULL,
1180	* all instances with this key will be deregistered. So in
1181	* order to only deregister the instance associated with the
1182	* current thread use 0.
1183	*/
1184	RTDECL(int) RTLogSetDefaultInstanceThread(PRTLOGGER pLogger, uintptr_t uKey);
1185	#endif /* IN_RING0 */
1186
1187
1188	#ifdef LOG_ENABLED
1189	/** Internal worker function.
1190	* Don't call directly, use the LogIsItEnabled macro!
1191	*/
1192	DECLINLINE(bool) LogIsItEnabledInternal(void *pvInst, unsigned iGroup, unsigned fFlags)
1193	{
1194	register PRTLOGGER pLogger = (PRTLOGGER)pvInst ? (PRTLOGGER)pvInst : RTLogDefaultInstance();
1195	if (pLogger)
1196	{
1197	register unsigned fGrpFlags = pLogger->afGroups[(unsigned)iGroup < pLogger->cGroups ? (unsigned)iGroup : 0];
1198	if ((fGrpFlags & (fFlags \| RTLOGGRPFLAGS_ENABLED)) == (fFlags \| RTLOGGRPFLAGS_ENABLED))
1199	return true;
1200	}
1201	return false;
1202	}
1203	#endif
1204
1205
1206	#ifndef IN_GC
1207	/**
1208	* Creates the default logger instance for a iprt users.
1209	*
1210	* Any user of the logging features will need to implement
1211	* this or use the generic dummy.
1212	*
1213	* @returns Pointer to the logger instance.
1214	*/
1215	RTDECL(PRTLOGGER) RTLogDefaultInit(void);
1216
1217	/**
1218	* Create a logger instance.
1219	*
1220	* @returns iprt status code.
1221	*
1222	* @param ppLogger Where to store the logger instance.
1223	* @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
1224	* @param pszGroupSettings The initial group settings.
1225	* @param pszEnvVarBase Base name for the environment variables for this instance.
1226	* @param cGroups Number of groups in the array.
1227	* @param papszGroups Pointer to array of groups. This must stick around for the life of the
1228	* logger instance.
1229	* @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified.
1230	* @param pszFilenameFmt Log filename format string. Standard RTStrFormat().
1231	* @param ... Format arguments.
1232	*/
1233	RTDECL(int) RTLogCreate(PRTLOGGER ppLogger, RTUINT fFlags, const char pszGroupSettings,
1234	const char pszEnvVarBase, unsigned cGroups, const char const * papszGroups,
1235	RTUINT fDestFlags, const char *pszFilenameFmt, ...);
1236
1237	/**
1238	* Create a logger instance.
1239	*
1240	* @returns iprt status code.
1241	*
1242	* @param ppLogger Where to store the logger instance.
1243	* @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
1244	* @param pszGroupSettings The initial group settings.
1245	* @param pszEnvVarBase Base name for the environment variables for this instance.
1246	* @param cGroups Number of groups in the array.
1247	* @param papszGroups Pointer to array of groups. This must stick around for the life of the
1248	* logger instance.
1249	* @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified.
1250	* @param pszErrorMsg A buffer which is filled with an error message if something fails. May be NULL.
1251	* @param cchErrorMsg The size of the error message buffer.
1252	* @param pszFilenameFmt Log filename format string. Standard RTStrFormat().
1253	* @param ... Format arguments.
1254	*/
1255	RTDECL(int) RTLogCreateEx(PRTLOGGER ppLogger, RTUINT fFlags, const char pszGroupSettings,
1256	const char pszEnvVarBase, unsigned cGroups, const char const * papszGroups,
1257	RTUINT fDestFlags, char pszErrorMsg, size_t cchErrorMsg, const char pszFilenameFmt, ...);
1258
1259	/**
1260	* Create a logger instance.
1261	*
1262	* @returns iprt status code.
1263	*
1264	* @param ppLogger Where to store the logger instance.
1265	* @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
1266	* @param pszGroupSettings The initial group settings.
1267	* @param pszEnvVarBase Base name for the environment variables for this instance.
1268	* @param cGroups Number of groups in the array.
1269	* @param papszGroups Pointer to array of groups. This must stick around for the life of the
1270	* logger instance.
1271	* @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified.
1272	* @param pszErrorMsg A buffer which is filled with an error message if something fails. May be NULL.
1273	* @param cchErrorMsg The size of the error message buffer.
1274	* @param pszFilenameFmt Log filename format string. Standard RTStrFormat().
1275	* @param args Format arguments.
1276	*/
1277	RTDECL(int) RTLogCreateExV(PRTLOGGER ppLogger, RTUINT fFlags, const char pszGroupSettings,
1278	const char pszEnvVarBase, unsigned cGroups, const char const * papszGroups,
1279	RTUINT fDestFlags, char pszErrorMsg, size_t cchErrorMsg, const char pszFilenameFmt, va_list args);
1280
1281	/**
1282	* Create a logger instance for singled threaded ring-0 usage.
1283	*
1284	* @returns iprt status code.
1285	*
1286	* @param pLogger Where to create the logger instance.
1287	* @param cbLogger The amount of memory available for the logger instance.
1288	* @param pfnLogger Pointer to logger wrapper function for the clone.
1289	* @param pfnFlush Pointer to flush function for the clone.
1290	* @param fFlags Logger instance flags for the clone, a combination of the RTLOGFLAGS_* values.
1291	* @param fDestFlags The destination flags.
1292	*/
1293	RTDECL(int) RTLogCreateForR0(PRTLOGGER pLogger, size_t cbLogger, PFNRTLOGGER pfnLogger, PFNRTLOGFLUSH pfnFlush, RTUINT fFlags, RTUINT fDestFlags);
1294
1295	/**
1296	* Destroys a logger instance.
1297	*
1298	* The instance is flushed and all output destinations closed (where applicable).
1299	*
1300	* @returns iprt status code.
1301	* @param pLogger The logger instance which close destroyed. NULL is fine.
1302	*/
1303	RTDECL(int) RTLogDestroy(PRTLOGGER pLogger);
1304
1305	/**
1306	* Create a logger instance clone for RC usage.
1307	*
1308	* @returns iprt status code.
1309	*
1310	* @param pLogger The logger instance to be cloned.
1311	* @param pLoggerGC Where to create the GC logger instance.
1312	* @param cbLoggerGC Amount of memory allocated to for the GC logger instance clone.
1313	* @param pfnLoggerGCPtr Pointer to logger wrapper function for this instance (GC Ptr).
1314	* @param pfnFlushGCPtr Pointer to flush function (GC Ptr).
1315	* @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
1316	*/
1317	RTDECL(int) RTLogCloneRC(PRTLOGGER pLogger, PRTLOGGERRC pLoggerGC, size_t cbLoggerGC,
1318	RTRCPTR pfnLoggerGCPtr, RTRCPTR pfnFlushGCPtr, RTUINT fFlags);
1319
1320	/**
1321	* Flushes a GC logger instance to a HC logger.
1322	*
1323	* @returns iprt status code.
1324	* @param pLogger The HC logger instance to flush pLoggerGC to.
1325	* If NULL the default logger is used.
1326	* @param pLoggerGC The GC logger instance to flush.
1327	*/
1328	RTDECL(void) RTLogFlushGC(PRTLOGGER pLogger, PRTLOGGERRC pLoggerGC);
1329
1330	/**
1331	* Flushes the buffer in one logger instance onto another logger.
1332	*
1333	* @returns iprt status code.
1334	*
1335	* @param pSrcLogger The logger instance to flush.
1336	* @param pDstLogger The logger instance to flush onto.
1337	* If NULL the default logger will be used.
1338	*/
1339	RTDECL(void) RTLogFlushToLogger(PRTLOGGER pSrcLogger, PRTLOGGER pDstLogger);
1340
1341	/**
1342	* Copies the group settings and flags from logger instance to another.
1343	*
1344	* @returns IPRT status code.
1345	* @param pDstLogger The destination logger instance.
1346	* @param pSrcLogger The source logger instance. If NULL the default one is used.
1347	* @param fFlagsOr OR mask for the flags.
1348	* @param fFlagsAnd AND mask for the flags.
1349	*/
1350	RTDECL(int) RTLogCopyGroupsAndFlags(PRTLOGGER pDstLogger, PCRTLOGGER pSrcLogger, unsigned fFlagsOr, unsigned fFlagsAnd);
1351
1352	/**
1353	* Updates the group settings for the logger instance using the specified
1354	* specification string.
1355	*
1356	* @returns iprt status code.
1357	* Failures can safely be ignored.
1358	* @param pLogger Logger instance (NULL for default logger).
1359	* @param pszVar Value to parse.
1360	*/
1361	RTDECL(int) RTLogGroupSettings(PRTLOGGER pLogger, const char *pszVar);
1362	#endif /* !IN_GC */
1363
1364	/**
1365	* Updates the flags for the logger instance using the specified
1366	* specification string.
1367	*
1368	* @returns iprt status code.
1369	* Failures can safely be ignored.
1370	* @param pLogger Logger instance (NULL for default logger).
1371	* @param pszVar Value to parse.
1372	*/
1373	RTDECL(int) RTLogFlags(PRTLOGGER pLogger, const char *pszVar);
1374
1375	/**
1376	* Flushes the specified logger.
1377	*
1378	* @param pLogger The logger instance to flush.
1379	* If NULL the default instance is used. The default instance
1380	* will not be initialized by this call.
1381	*/
1382	RTDECL(void) RTLogFlush(PRTLOGGER pLogger);
1383
1384	/**
1385	* Write to a logger instance.
1386	*
1387	* @param pLogger Pointer to logger instance.
1388	* @param pvCallerRet Ignored.
1389	* @param pszFormat Format string.
1390	* @param ... Format arguments.
1391	*/
1392	RTDECL(void) RTLogLogger(PRTLOGGER pLogger, void pvCallerRet, const char pszFormat, ...);
1393
1394	/**
1395	* Write to a logger instance.
1396	*
1397	* @param pLogger Pointer to logger instance.
1398	* @param pszFormat Format string.
1399	* @param args Format arguments.
1400	*/
1401	RTDECL(void) RTLogLoggerV(PRTLOGGER pLogger, const char *pszFormat, va_list args);
1402
1403	/**
1404	* Write to a logger instance.
1405	*
1406	* This function will check whether the instance, group and flags makes up a
1407	* logging kind which is currently enabled before writing anything to the log.
1408	*
1409	* @param pLogger Pointer to logger instance. If NULL the default logger instance will be attempted.
1410	* @param fFlags The logging flags.
1411	* @param iGroup The group.
1412	* The value ~0U is reserved for compatability with RTLogLogger[V] and is
1413	* only for internal usage!
1414	* @param pszFormat Format string.
1415	* @param ... Format arguments.
1416	* @remark This is a worker function of LogIt.
1417	*/
1418	RTDECL(void) RTLogLoggerEx(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...);
1419
1420	/**
1421	* Write to a logger instance.
1422	*
1423	* This function will check whether the instance, group and flags makes up a
1424	* logging kind which is currently enabled before writing anything to the log.
1425	*
1426	* @param pLogger Pointer to logger instance. If NULL the default logger instance will be attempted.
1427	* @param fFlags The logging flags.
1428	* @param iGroup The group.
1429	* The value ~0U is reserved for compatability with RTLogLogger[V] and is
1430	* only for internal usage!
1431	* @param pszFormat Format string.
1432	* @param args Format arguments.
1433	*/
1434	RTDECL(void) RTLogLoggerExV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args);
1435
1436	/**
1437	* printf like function for writing to the default log.
1438	*
1439	* @param pszFormat Printf like format string.
1440	* @param ... Optional arguments as specified in pszFormat.
1441	*
1442	* @remark The API doesn't support formatting of floating point numbers at the moment.
1443	*/
1444	RTDECL(void) RTLogPrintf(const char *pszFormat, ...);
1445
1446	/**
1447	* vprintf like function for writing to the default log.
1448	*
1449	* @param pszFormat Printf like format string.
1450	* @param args Optional arguments as specified in pszFormat.
1451	*
1452	* @remark The API doesn't support formatting of floating point numbers at the moment.
1453	*/
1454	RTDECL(void) RTLogPrintfV(const char *pszFormat, va_list args);
1455
1456
1457	#ifndef DECLARED_FNRTSTROUTPUT /* duplicated in iprt/string.h */
1458	#define DECLARED_FNRTSTROUTPUT
1459	/**
1460	* Output callback.
1461	*
1462	* @returns number of bytes written.
1463	* @param pvArg User argument.
1464	* @param pachChars Pointer to an array of utf-8 characters.
1465	* @param cbChars Number of bytes in the character array pointed to by pachChars.
1466	*/
1467	typedef DECLCALLBACK(size_t) FNRTSTROUTPUT(void pvArg, const char pachChars, size_t cbChars);
1468	/** Pointer to callback function. */
1469	typedef FNRTSTROUTPUT *PFNRTSTROUTPUT;
1470	#endif
1471
1472	/**
1473	* Partial vsprintf worker implementation.
1474	*
1475	* @returns number of bytes formatted.
1476	* @param pfnOutput Output worker.
1477	* Called in two ways. Normally with a string an it's length.
1478	* For termination, it's called with NULL for string, 0 for length.
1479	* @param pvArg Argument to output worker.
1480	* @param pszFormat Format string.
1481	* @param args Argument list.
1482	*/
1483	RTDECL(size_t) RTLogFormatV(PFNRTSTROUTPUT pfnOutput, void pvArg, const char pszFormat, va_list args);
1484
1485	/**
1486	* Write log buffer to COM port.
1487	*
1488	* @param pach Pointer to the buffer to write.
1489	* @param cb Number of bytes to write.
1490	*/
1491	RTDECL(void) RTLogWriteCom(const char *pach, size_t cb);
1492
1493	/**
1494	* Prints a formatted string to the serial port used for logging.
1495	*
1496	* @returns Number of bytes written.
1497	* @param pszFormat Format string.
1498	* @param ... Optional arguments specified in the format string.
1499	*/
1500	RTDECL(size_t) RTLogComPrintf(const char *pszFormat, ...);
1501
1502	/**
1503	* Prints a formatted string to the serial port used for logging.
1504	*
1505	* @returns Number of bytes written.
1506	* @param pszFormat Format string.
1507	* @param args Optional arguments specified in the format string.
1508	*/
1509	RTDECL(size_t) RTLogComPrintfV(const char *pszFormat, va_list args);
1510
1511
1512	#if 0 /* not implemented yet */
1513
1514	/** Indicates that the semaphores shall be used to notify the other
1515	* part about buffer changes. */
1516	#define LOGHOOKBUFFER_FLAGS_SEMAPHORED 1
1517
1518	/**
1519	* Log Hook Buffer.
1520	* Use to commuicate between the logger and a log consumer.
1521	*/
1522	typedef struct RTLOGHOOKBUFFER
1523	{
1524	/** Write pointer. */
1525	volatile void *pvWrite;
1526	/** Read pointer. */
1527	volatile void *pvRead;
1528	/** Buffer start. */
1529	void *pvStart;
1530	/** Buffer end (exclusive). */
1531	void *pvEnd;
1532	/** Signaling semaphore used by the writer to wait on a full buffer.
1533	* Only used when indicated in flags. */
1534	void *pvSemWriter;
1535	/** Signaling semaphore used by the read to wait on an empty buffer.
1536	* Only used when indicated in flags. */
1537	void *pvSemReader;
1538	/** Buffer flags. Current reserved and set to zero. */
1539	volatile unsigned fFlags;
1540	} RTLOGHOOKBUFFER;
1541	/** Pointer to a log hook buffer. */
1542	typedef RTLOGHOOKBUFFER *PRTLOGHOOKBUFFER;
1543
1544
1545	/**
1546	* Register a logging hook.
1547	*
1548	* This type of logging hooks are expecting different threads acting
1549	* producer and consumer. They share a circular buffer which have two
1550	* pointers one for each end. When the buffer is full there are two
1551	* alternatives (indicated by a buffer flag), either wait for the
1552	* consumer to get it's job done, or to write a generic message saying
1553	* buffer overflow.
1554	*
1555	* Since the waiting would need a signal semaphore, we'll skip that for now.
1556	*
1557	* @returns iprt status code.
1558	* @param pBuffer Pointer to a logger hook buffer.
1559	*/
1560	RTDECL(int) RTLogRegisterHook(PRTLOGGER pLogger, PRTLOGHOOKBUFFER pBuffer);
1561
1562	/**
1563	* Deregister a logging hook registerd with RTLogRegisterHook().
1564	*
1565	* @returns iprt status code.
1566	* @param pBuffer Pointer to a logger hook buffer.
1567	*/
1568	RTDECL(int) RTLogDeregisterHook(PRTLOGGER pLogger, PRTLOGHOOKBUFFER pBuffer);
1569
1570	#endif /* not implemented yet */
1571
1572
1573
1574	/**
1575	* Write log buffer to a debugger (RTLOGDEST_DEBUGGER).
1576	*
1577	* @param pach What to write.
1578	* @param cb How much to write.
1579	* @remark When linking statically, this function can be replaced by defining your own.
1580	*/
1581	RTDECL(void) RTLogWriteDebugger(const char *pach, size_t cb);
1582
1583	/**
1584	* Write log buffer to a user defined output stream (RTLOGDEST_USER).
1585	*
1586	* @param pach What to write.
1587	* @param cb How much to write.
1588	* @remark When linking statically, this function can be replaced by defining your own.
1589	*/
1590	RTDECL(void) RTLogWriteUser(const char *pach, size_t cb);
1591
1592	/**
1593	* Write log buffer to stdout (RTLOGDEST_STDOUT).
1594	*
1595	* @param pach What to write.
1596	* @param cb How much to write.
1597	* @remark When linking statically, this function can be replaced by defining your own.
1598	*/
1599	RTDECL(void) RTLogWriteStdOut(const char *pach, size_t cb);
1600
1601	/**
1602	* Write log buffer to stdout (RTLOGDEST_STDERR).
1603	*
1604	* @param pach What to write.
1605	* @param cb How much to write.
1606	* @remark When linking statically, this function can be replaced by defining your own.
1607	*/
1608	RTDECL(void) RTLogWriteStdErr(const char *pach, size_t cb);
1609
1610	#ifdef VBOX
1611
1612	/**
1613	* Prints a formatted string to the backdoor port.
1614	*
1615	* @returns Number of bytes written.
1616	* @param pszFormat Format string.
1617	* @param ... Optional arguments specified in the format string.
1618	*/
1619	RTDECL(size_t) RTLogBackdoorPrintf(const char *pszFormat, ...);
1620
1621	/**
1622	* Prints a formatted string to the backdoor port.
1623	*
1624	* @returns Number of bytes written.
1625	* @param pszFormat Format string.
1626	* @param args Optional arguments specified in the format string.
1627	*/
1628	RTDECL(size_t) RTLogBackdoorPrintfV(const char *pszFormat, va_list args);
1629
1630	#endif /* VBOX */
1631
1632	__END_DECLS
1633
1634	/** @} */
1635
1636	#endif
1637

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

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

Download in other formats: