VirtualBox

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

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

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