VirtualBox

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

Last change on this file since 34575 was 33540, checked in by vboxsync, 14 years ago

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