• 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 
24 #include <stdarg.h>
25 #include <stdlib.h>
26 
27 #include <pulsecore/macro.h>
28 #include <pulse/gccmacro.h>
29 
30 /* A simple logging subsystem */
31 
32 /* Where to log to */
33 typedef enum pa_log_target_type {
34     PA_LOG_STDERR,      /* default */
35     PA_LOG_SYSLOG,
36 #ifdef HAVE_SYSTEMD_JOURNAL
37     PA_LOG_JOURNAL,     /* systemd journal */
38 #endif
39     PA_LOG_NULL,        /* to /dev/null */
40     PA_LOG_FILE,        /* to a user specified file */
41     PA_LOG_NEWFILE,     /* with an automatic suffix to avoid overwriting anything */
42 } pa_log_target_type_t;
43 
44 typedef enum pa_log_level {
45     PA_LOG_ERROR  = 0,    /* Error messages */
46     PA_LOG_WARN   = 1,    /* Warning messages */
47     PA_LOG_NOTICE = 2,    /* Notice messages */
48     PA_LOG_INFO   = 3,    /* Info messages */
49     PA_LOG_DEBUG  = 4,    /* Debug messages */
50     PA_LOG_LEVEL_MAX
51 } pa_log_level_t;
52 
53 typedef enum pa_log_flags {
54     PA_LOG_COLORS      = 0x01, /* Show colorful output */
55     PA_LOG_PRINT_TIME  = 0x02, /* Show time */
56     PA_LOG_PRINT_FILE  = 0x04, /* Show source file */
57     PA_LOG_PRINT_META  = 0x08, /* Show extended location information */
58     PA_LOG_PRINT_LEVEL = 0x10, /* Show log level prefix */
59 } pa_log_flags_t;
60 
61 typedef enum pa_log_merge {
62     PA_LOG_SET,
63     PA_LOG_UNSET,
64     PA_LOG_RESET
65 } pa_log_merge_t;
66 
67 typedef struct {
68     pa_log_target_type_t type;
69     char *file;
70 } pa_log_target;
71 
72 /* Set an identification for the current daemon. Used when logging to syslog. */
73 void pa_log_set_ident(const char *p);
74 
75 /* Set a log target. */
76 int pa_log_set_target(pa_log_target *t);
77 
78 /* Maximal log level */
79 void pa_log_set_level(pa_log_level_t l);
80 
81 /* Set flags */
82 void pa_log_set_flags(pa_log_flags_t flags, pa_log_merge_t merge);
83 
84 /* Enable backtrace */
85 void pa_log_set_show_backtrace(unsigned nlevels);
86 
87 /* Skip the first backtrace frames */
88 void pa_log_set_skip_backtrace(unsigned nlevels);
89 
90 void pa_log_level_meta(
91         pa_log_level_t level,
92         const char*file,
93         int line,
94         const char *func,
95         const char *format, ...) PA_GCC_PRINTF_ATTR(5,6);
96 
97 void pa_log_levelv_meta(
98         pa_log_level_t level,
99         const char*file,
100         int line,
101         const char *func,
102         const char *format,
103         va_list ap);
104 
105 void pa_log_level(
106         pa_log_level_t level,
107         const char *format, ...) PA_GCC_PRINTF_ATTR(2,3);
108 
109 void pa_log_levelv(
110         pa_log_level_t level,
111         const char *format,
112         va_list ap);
113 
114 pa_log_target *pa_log_target_new(pa_log_target_type_t type, const char *file);
115 
116 void pa_log_target_free(pa_log_target *t);
117 
118 pa_log_target *pa_log_parse_target(const char *string);
119 
120 char *pa_log_target_to_string(const pa_log_target *t);
121 
122 #if __STDC_VERSION__ >= 199901L
123 
124 /* ISO varargs available */
125 
126 #define pa_log_debug(...)  pa_log_level_meta(PA_LOG_DEBUG,  __FILE__, __LINE__, __func__, __VA_ARGS__)
127 #define pa_log_info(...)   pa_log_level_meta(PA_LOG_INFO,   __FILE__, __LINE__, __func__, __VA_ARGS__)
128 #define pa_log_notice(...) pa_log_level_meta(PA_LOG_NOTICE, __FILE__, __LINE__, __func__, __VA_ARGS__)
129 #define pa_log_warn(...)   pa_log_level_meta(PA_LOG_WARN,   __FILE__, __LINE__, __func__, __VA_ARGS__)
130 #define pa_log_error(...)  pa_log_level_meta(PA_LOG_ERROR,  __FILE__, __LINE__, __func__, __VA_ARGS__)
131 #define pa_logl(level, ...)  pa_log_level_meta(level,  __FILE__, __LINE__, __func__, __VA_ARGS__)
132 
133 #else
134 
135 #define LOG_FUNC(suffix, level) \
136 PA_GCC_UNUSED static void pa_log_##suffix(const char *format, ...) { \
137     va_list ap; \
138     va_start(ap, format); \
139     pa_log_levelv_meta(level, NULL, 0, NULL, format, ap); \
140     va_end(ap); \
141 }
142 
143 LOG_FUNC(debug, PA_LOG_DEBUG)
144 LOG_FUNC(info, PA_LOG_INFO)
145 LOG_FUNC(notice, PA_LOG_NOTICE)
146 LOG_FUNC(warn, PA_LOG_WARN)
147 LOG_FUNC(error, PA_LOG_ERROR)
148 
149 #endif
150 
151 #define pa_log pa_log_error
152 
153 bool pa_log_ratelimit(pa_log_level_t level);
154 
155 #endif
156