VirtualBox

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

Last change on this file since 19944 was 19730, checked in by vboxsync, 16 years ago

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette