• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 #ifndef foologhfoo
2 #define foologhfoo
3 
4 /***
5   This file is part of PulseAudio.
6 
7   Copyright 2004-2006 Lennart Poettering
8   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 
10   PulseAudio is free software; you can redistribute it and/or modify
11   it under the terms of the GNU Lesser General Public License as published
12   by the Free Software Foundation; either version 2.1 of the License,
13   or (at your option) any later version.
14 
15   PulseAudio is distributed in the hope that it will be useful, but
16   WITHOUT ANY WARRANTY; without even the implied warranty of
17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18   General Public License for more details.
19 
20   You should have received a copy of the GNU Lesser General Public License
21   along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
22 ***/
23 #ifndef LOG_H
24 #define LOG_H
25 #include <stdarg.h>
26 #include <stdlib.h>
27 
28 #include <pulsecore/macro.h>
29 #include <pulse/gccmacro.h>
30 #include "log/audio_log.h"
31 
32 /* A simple logging subsystem */
33 
34 /* Where to log to */
35 typedef enum pa_log_target_type {
36     PA_LOG_STDERR,      /* default */
37     PA_LOG_SYSLOG,
38 #ifdef HAVE_SYSTEMD_JOURNAL
39     PA_LOG_JOURNAL,     /* systemd journal */
40 #endif
41     PA_LOG_NULL,        /* to /dev/null */
42     PA_LOG_FILE,        /* to a user specified file */
43     PA_LOG_NEWFILE,     /* with an automatic suffix to avoid overwriting anything */
44 } pa_log_target_type_t;
45 
46 typedef enum pa_log_level {
47     PA_LOG_ERROR  = 0,    /* Error messages */
48     PA_LOG_WARN   = 1,    /* Warning messages */
49     PA_LOG_NOTICE = 2,    /* Notice messages */
50     PA_LOG_INFO   = 3,    /* Info messages */
51     PA_LOG_DEBUG  = 4,    /* Debug messages */
52     PA_LOG_LEVEL_MAX
53 } pa_log_level_t;
54 
55 typedef enum pa_log_flags {
56     PA_LOG_COLORS      = 0x01, /* Show colorful output */
57     PA_LOG_PRINT_TIME  = 0x02, /* Show time */
58     PA_LOG_PRINT_FILE  = 0x04, /* Show source file */
59     PA_LOG_PRINT_META  = 0x08, /* Show extended location information */
60     PA_LOG_PRINT_LEVEL = 0x10, /* Show log level prefix */
61 } pa_log_flags_t;
62 
63 typedef enum pa_log_merge {
64     PA_LOG_SET,
65     PA_LOG_UNSET,
66     PA_LOG_RESET
67 } pa_log_merge_t;
68 
69 typedef struct {
70     pa_log_target_type_t type;
71     char *file;
72 } pa_log_target;
73 
74 /* Set an identification for the current daemon. Used when logging to syslog. */
75 void pa_log_set_ident(const char *p);
76 
77 /* Set a log target. */
78 int pa_log_set_target(pa_log_target *t);
79 
80 /* Maximal log level */
81 void pa_log_set_level(pa_log_level_t l);
82 
83 /* Set flags */
84 void pa_log_set_flags(pa_log_flags_t flags, pa_log_merge_t merge);
85 
86 /* Enable backtrace */
87 void pa_log_set_show_backtrace(unsigned nlevels);
88 
89 /* Skip the first backtrace frames */
90 void pa_log_set_skip_backtrace(unsigned nlevels);
91 
92 void pa_log_level_meta(
93         pa_log_level_t level,
94         const char*file,
95         int line,
96         const char *func,
97         const char *format, ...) PA_GCC_PRINTF_ATTR(5,6);
98 
99 void pa_log_levelv_meta(
100         pa_log_level_t level,
101         const char*file,
102         int line,
103         const char *func,
104         const char *format,
105         va_list ap);
106 
107 void pa_log_level(
108         pa_log_level_t level,
109         const char *format, ...) PA_GCC_PRINTF_ATTR(2,3);
110 
111 void pa_log_levelv(
112         pa_log_level_t level,
113         const char *format,
114         va_list ap);
115 
116 void PrintCallStackInfo();
117 
118 pa_log_target *pa_log_target_new(pa_log_target_type_t type, const char *file);
119 
120 void pa_log_target_free(pa_log_target *t);
121 
122 pa_log_target *pa_log_parse_target(const char *string);
123 
124 char *pa_log_target_to_string(const pa_log_target *t);
125 
126 #if __STDC_VERSION__ >= 199901L
127 
128 /* ISO varargs available */
129 
130 #define pa_log_debug(...)  pa_log_level_meta(PA_LOG_DEBUG,  __FILE__, __LINE__, __func__, __VA_ARGS__)
131 #define pa_log_info(...)   pa_log_level_meta(PA_LOG_INFO,   __FILE__, __LINE__, __func__, __VA_ARGS__)
132 #define pa_log_notice(...) pa_log_level_meta(PA_LOG_NOTICE, __FILE__, __LINE__, __func__, __VA_ARGS__)
133 #define pa_log_warn(...)   pa_log_level_meta(PA_LOG_WARN,   __FILE__, __LINE__, __func__, __VA_ARGS__)
134 #define pa_log_error(...)  pa_log_level_meta(PA_LOG_ERROR,  __FILE__, __LINE__, __func__, __VA_ARGS__)
135 #define pa_logl(level, ...)  pa_log_level_meta(level,  __FILE__, __LINE__, __func__, __VA_ARGS__)
136 
137 #else
138 
139 #define LOG_FUNC(suffix, level) \
140 PA_GCC_UNUSED static void pa_log_##suffix(const char *format, ...) { \
141     va_list ap; \
142     va_start(ap, format); \
143     pa_log_levelv_meta(level, NULL, 0, NULL, format, ap); \
144     va_end(ap); \
145 }
146 
147 LOG_FUNC(debug, PA_LOG_DEBUG)
148 LOG_FUNC(info, PA_LOG_INFO)
149 LOG_FUNC(notice, PA_LOG_NOTICE)
150 LOG_FUNC(warn, PA_LOG_WARN)
151 LOG_FUNC(error, PA_LOG_ERROR)
152 
153 #endif
154 
155 #define pa_log pa_log_error
156 
157 bool pa_log_ratelimit(pa_log_level_t level);
158 
159 #endif
160 #endif