]>
Commit | Line | Data |
---|---|---|
53e1b683 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
c2f1db8f | 2 | #pragma once |
5899f3b7 | 3 | |
17a94911 | 4 | #include <stdarg.h> |
07630cea | 5 | #include <stdbool.h> |
6410074b | 6 | #include <stdlib.h> |
07630cea | 7 | #include <syslog.h> |
5899f3b7 | 8 | |
158350e8 | 9 | #include "macro.h" |
dccca82b LP |
10 | |
11 | /* Some structures we reference but don't want to pull in headers for */ | |
12 | struct iovec; | |
13 | struct signalfd_siginfo; | |
5899f3b7 | 14 | |
ff524019 ZJS |
15 | typedef enum LogRealm { |
16 | LOG_REALM_SYSTEMD, | |
17 | LOG_REALM_UDEV, | |
18 | _LOG_REALM_MAX, | |
19 | } LogRealm; | |
20 | ||
21 | #ifndef LOG_REALM | |
22 | # define LOG_REALM LOG_REALM_SYSTEMD | |
23 | #endif | |
24 | ||
16801e90 LP |
25 | typedef enum LogTarget{ |
26 | LOG_TARGET_CONSOLE, | |
aca83a53 | 27 | LOG_TARGET_CONSOLE_PREFIXED, |
16801e90 | 28 | LOG_TARGET_KMSG, |
5ba081b0 LP |
29 | LOG_TARGET_JOURNAL, |
30 | LOG_TARGET_JOURNAL_OR_KMSG, | |
843d2643 LP |
31 | LOG_TARGET_SYSLOG, |
32 | LOG_TARGET_SYSLOG_OR_KMSG, | |
5ba081b0 | 33 | LOG_TARGET_AUTO, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */ |
9fae33d2 | 34 | LOG_TARGET_NULL, |
16801e90 LP |
35 | _LOG_TARGET_MAX, |
36 | _LOG_TARGET_INVALID = -1 | |
ff524019 ZJS |
37 | } LogTarget; |
38 | ||
5dc881a3 | 39 | /* Note to readers: << and >> have lower precedence than & and | */ |
52d86690 ZJS |
40 | #define LOG_REALM_PLUS_LEVEL(realm, level) ((realm) << 10 | (level)) |
41 | #define LOG_REALM_REMOVE_LEVEL(realm_level) ((realm_level) >> 10) | |
42 | #define SYNTHETIC_ERRNO(num) (1 << 30 | (num)) | |
43 | #define IS_SYNTHETIC_ERRNO(val) ((val) >> 30 & 1) | |
44 | #define ERRNO_VALUE(val) (abs(val) & 255) | |
16801e90 LP |
45 | |
46 | void log_set_target(LogTarget target); | |
ff524019 ZJS |
47 | void log_set_max_level_realm(LogRealm realm, int level); |
48 | #define log_set_max_level(level) \ | |
49 | log_set_max_level_realm(LOG_REALM, (level)) | |
50 | ||
3eff4208 | 51 | void log_set_facility(int facility); |
16801e90 | 52 | |
34f0e866 | 53 | int log_set_target_from_string(const char *e); |
ff524019 ZJS |
54 | int log_set_max_level_from_string_realm(LogRealm realm, const char *e); |
55 | #define log_set_max_level_from_string(e) \ | |
56 | log_set_max_level_from_string_realm(LOG_REALM, (e)) | |
34f0e866 | 57 | |
bbe63281 | 58 | void log_show_color(bool b); |
b1e90ec5 | 59 | bool log_get_show_color(void) _pure_; |
bbe63281 | 60 | void log_show_location(bool b); |
b1e90ec5 | 61 | bool log_get_show_location(void) _pure_; |
bbe63281 LP |
62 | |
63 | int log_show_color_from_string(const char *e); | |
64 | int log_show_location_from_string(const char *e); | |
65 | ||
44a6b1b6 | 66 | LogTarget log_get_target(void) _pure_; |
ff524019 ZJS |
67 | int log_get_max_level_realm(LogRealm realm) _pure_; |
68 | #define log_get_max_level() \ | |
69 | log_get_max_level_realm(LOG_REALM) | |
1adf1049 | 70 | |
e3e42fc2 ZJS |
71 | /* Functions below that open and close logs or configure logging based on the |
72 | * environment should not be called from library code — this is always a job | |
73 | * for the application itself. | |
74 | */ | |
75 | ||
a0b15b41 ZJS |
76 | assert_cc(STRLEN(__FILE__) > STRLEN(RELATIVE_SOURCE_PATH) + 1) |
77 | #define PROJECT_FILE (__FILE__ + STRLEN(RELATIVE_SOURCE_PATH) + 1) | |
78 | ||
843d2643 | 79 | int log_open(void); |
871e5809 | 80 | void log_close(void); |
4d8a7798 | 81 | void log_forget_fds(void); |
843d2643 | 82 | |
ff524019 ZJS |
83 | void log_parse_environment_realm(LogRealm realm); |
84 | #define log_parse_environment() \ | |
85 | log_parse_environment_realm(LOG_REALM) | |
34f0e866 | 86 | |
93484b47 ZJS |
87 | int log_dispatch_internal( |
88 | int level, | |
89 | int error, | |
90 | const char *file, | |
91 | int line, | |
92 | const char *func, | |
93 | const char *object_field, | |
94 | const char *object, | |
95 | const char *extra, | |
96 | const char *extra_field, | |
97 | char *buffer); | |
98 | ||
ff524019 | 99 | int log_internal_realm( |
877d54e9 | 100 | int level, |
086891e5 | 101 | int error, |
79008bdd | 102 | const char *file, |
877d54e9 LP |
103 | int line, |
104 | const char *func, | |
086891e5 | 105 | const char *format, ...) _printf_(6,7); |
ff524019 ZJS |
106 | #define log_internal(level, ...) \ |
107 | log_internal_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__) | |
5899f3b7 | 108 | |
ff524019 | 109 | int log_internalv_realm( |
877d54e9 | 110 | int level, |
086891e5 | 111 | int error, |
79008bdd | 112 | const char *file, |
877d54e9 LP |
113 | int line, |
114 | const char *func, | |
115 | const char *format, | |
086891e5 | 116 | va_list ap) _printf_(6,0); |
ff524019 ZJS |
117 | #define log_internalv(level, ...) \ |
118 | log_internalv_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__) | |
877d54e9 | 119 | |
ff524019 | 120 | /* Realm is fixed to LOG_REALM_SYSTEMD for those */ |
f6d6d532 YW |
121 | int log_object_internalv( |
122 | int level, | |
123 | int error, | |
124 | const char *file, | |
125 | int line, | |
126 | const char *func, | |
127 | const char *object_field, | |
128 | const char *object, | |
129 | const char *extra_field, | |
130 | const char *extra, | |
131 | const char *format, | |
132 | va_list ap) _printf_(10,0); | |
133 | ||
79008bdd | 134 | int log_object_internal( |
fdf9f9bb | 135 | int level, |
086891e5 | 136 | int error, |
79008bdd | 137 | const char *file, |
fdf9f9bb ZJS |
138 | int line, |
139 | const char *func, | |
79008bdd | 140 | const char *object_field, |
fdf9f9bb | 141 | const char *object, |
4b58153d LP |
142 | const char *extra_field, |
143 | const char *extra, | |
144 | const char *format, ...) _printf_(10,11); | |
fdf9f9bb | 145 | |
877d54e9 LP |
146 | int log_struct_internal( |
147 | int level, | |
086891e5 | 148 | int error, |
877d54e9 LP |
149 | const char *file, |
150 | int line, | |
151 | const char *func, | |
086891e5 | 152 | const char *format, ...) _printf_(6,0) _sentinel_; |
877d54e9 LP |
153 | |
154 | int log_oom_internal( | |
ff524019 | 155 | LogRealm realm, |
877d54e9 LP |
156 | const char *file, |
157 | int line, | |
158 | const char *func); | |
185986c6 | 159 | |
8a03c9ef ZJS |
160 | int log_format_iovec( |
161 | struct iovec *iovec, | |
d3070fbd LP |
162 | size_t iovec_len, |
163 | size_t *n, | |
8a03c9ef ZJS |
164 | bool newline_separator, |
165 | int error, | |
166 | const char *format, | |
ba360bb0 | 167 | va_list ap) _printf_(6, 0); |
8a03c9ef | 168 | |
915b1d01 LP |
169 | int log_struct_iovec_internal( |
170 | int level, | |
171 | int error, | |
172 | const char *file, | |
173 | int line, | |
174 | const char *func, | |
dccca82b | 175 | const struct iovec *input_iovec, |
915b1d01 LP |
176 | size_t n_input_iovec); |
177 | ||
2149e37c LP |
178 | /* This modifies the buffer passed! */ |
179 | int log_dump_internal( | |
877d54e9 | 180 | int level, |
086891e5 | 181 | int error, |
79008bdd | 182 | const char *file, |
877d54e9 LP |
183 | int line, |
184 | const char *func, | |
185 | char *buffer); | |
186 | ||
086891e5 | 187 | /* Logging for various assertions */ |
848e863a | 188 | _noreturn_ void log_assert_failed_realm( |
ff524019 | 189 | LogRealm realm, |
877d54e9 LP |
190 | const char *text, |
191 | const char *file, | |
192 | int line, | |
193 | const char *func); | |
ff524019 ZJS |
194 | #define log_assert_failed(text, ...) \ |
195 | log_assert_failed_realm(LOG_REALM, (text), __VA_ARGS__) | |
877d54e9 | 196 | |
848e863a | 197 | _noreturn_ void log_assert_failed_unreachable_realm( |
ff524019 | 198 | LogRealm realm, |
877d54e9 LP |
199 | const char *text, |
200 | const char *file, | |
201 | int line, | |
202 | const char *func); | |
ff524019 ZJS |
203 | #define log_assert_failed_unreachable(text, ...) \ |
204 | log_assert_failed_unreachable_realm(LOG_REALM, (text), __VA_ARGS__) | |
80514f9c | 205 | |
ff524019 ZJS |
206 | void log_assert_failed_return_realm( |
207 | LogRealm realm, | |
80514f9c LP |
208 | const char *text, |
209 | const char *file, | |
210 | int line, | |
211 | const char *func); | |
ff524019 ZJS |
212 | #define log_assert_failed_return(text, ...) \ |
213 | log_assert_failed_return_realm(LOG_REALM, (text), __VA_ARGS__) | |
2149e37c | 214 | |
93484b47 | 215 | #define log_dispatch(level, error, buffer) \ |
62c6bbbc | 216 | log_dispatch_internal(level, error, PROJECT_FILE, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer) |
93484b47 | 217 | |
086891e5 | 218 | /* Logging with level */ |
ff524019 | 219 | #define log_full_errno_realm(realm, level, error, ...) \ |
1cfa9a4c | 220 | ({ \ |
c1e83af8 | 221 | int _level = (level), _e = (error), _realm = (realm); \ |
baaa35ad | 222 | (log_get_max_level_realm(_realm) >= LOG_PRI(_level)) \ |
c1e83af8 | 223 | ? log_internal_realm(LOG_REALM_PLUS_LEVEL(_realm, _level), _e, \ |
62c6bbbc | 224 | PROJECT_FILE, __LINE__, __func__, __VA_ARGS__) \ |
baaa35ad | 225 | : -ERRNO_VALUE(_e); \ |
bf371116 | 226 | }) |
87ff6b1c | 227 | |
ff524019 ZJS |
228 | #define log_full_errno(level, error, ...) \ |
229 | log_full_errno_realm(LOG_REALM, (level), (error), __VA_ARGS__) | |
230 | ||
231 | #define log_full(level, ...) log_full_errno((level), 0, __VA_ARGS__) | |
086891e5 | 232 | |
dccca82b LP |
233 | int log_emergency_level(void); |
234 | ||
086891e5 | 235 | /* Normal logging */ |
4104970e ZJS |
236 | #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__) |
237 | #define log_info(...) log_full(LOG_INFO, __VA_ARGS__) | |
238 | #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__) | |
239 | #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__) | |
240 | #define log_error(...) log_full(LOG_ERR, __VA_ARGS__) | |
dccca82b | 241 | #define log_emergency(...) log_full(log_emergency_level(), __VA_ARGS__) |
5899f3b7 | 242 | |
086891e5 LP |
243 | /* Logging triggered by an errno-like error */ |
244 | #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__) | |
245 | #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__) | |
246 | #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__) | |
247 | #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__) | |
248 | #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__) | |
dccca82b | 249 | #define log_emergency_errno(error, ...) log_full_errno(log_emergency_level(), error, __VA_ARGS__) |
086891e5 | 250 | |
cb41ff29 ZJS |
251 | #ifdef LOG_TRACE |
252 | # define log_trace(...) log_debug(__VA_ARGS__) | |
253 | #else | |
9ed794a3 | 254 | # define log_trace(...) do {} while (0) |
cb41ff29 ZJS |
255 | #endif |
256 | ||
086891e5 | 257 | /* Structured logging */ |
ff524019 ZJS |
258 | #define log_struct_errno(level, error, ...) \ |
259 | log_struct_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \ | |
62c6bbbc | 260 | error, PROJECT_FILE, __LINE__, __func__, __VA_ARGS__, NULL) |
ff524019 | 261 | #define log_struct(level, ...) log_struct_errno(level, 0, __VA_ARGS__) |
0d0f0c50 | 262 | |
915b1d01 LP |
263 | #define log_struct_iovec_errno(level, error, iovec, n_iovec) \ |
264 | log_struct_iovec_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \ | |
62c6bbbc | 265 | error, PROJECT_FILE, __LINE__, __func__, iovec, n_iovec) |
915b1d01 LP |
266 | #define log_struct_iovec(level, iovec, n_iovec) log_struct_iovec_errno(level, 0, iovec, n_iovec) |
267 | ||
2149e37c | 268 | /* This modifies the buffer passed! */ |
ff524019 ZJS |
269 | #define log_dump(level, buffer) \ |
270 | log_dump_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \ | |
62c6bbbc | 271 | 0, PROJECT_FILE, __LINE__, __func__, buffer) |
086891e5 | 272 | |
62c6bbbc | 273 | #define log_oom() log_oom_internal(LOG_REALM, PROJECT_FILE, __LINE__, __func__) |
2149e37c | 274 | |
44a6b1b6 | 275 | bool log_on_console(void) _pure_; |
81270860 | 276 | |
44a6b1b6 ZJS |
277 | const char *log_target_to_string(LogTarget target) _const_; |
278 | LogTarget log_target_from_string(const char *s) _pure_; | |
706911fb | 279 | |
2b044526 | 280 | /* Helper to prepare various field for structured logging */ |
e2cc6eca | 281 | #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__ |
4daf54a8 ZJS |
282 | |
283 | void log_received_signal(int level, const struct signalfd_siginfo *si); | |
c1dc6153 | 284 | |
6fdb8de4 | 285 | /* If turned on, any requests for a log target involving "syslog" will be implicitly upgraded to the equivalent journal target */ |
c1dc6153 | 286 | void log_set_upgrade_syslog_to_journal(bool b); |
7a3be263 LP |
287 | |
288 | /* If turned on, and log_open() is called, we'll not use STDERR_FILENO for logging ever, but rather open /dev/console */ | |
48a601fe | 289 | void log_set_always_reopen_console(bool b); |
7a3be263 LP |
290 | |
291 | /* If turned on, we'll open the log stream implicitly if needed on each individual log call. This is normally not | |
292 | * desired as we want to reuse our logging streams. It is useful however */ | |
16e4fd87 | 293 | void log_set_open_when_needed(bool b); |
158350e8 | 294 | |
adf47c91 LP |
295 | /* If turned on, then we'll never use IPC-based logging, i.e. never log to syslog or the journal. We'll only log to |
296 | * stderr, the console or kmsg */ | |
297 | void log_set_prohibit_ipc(bool b); | |
298 | ||
17cac366 LP |
299 | int log_dup_console(void); |
300 | ||
158350e8 LP |
301 | int log_syntax_internal( |
302 | const char *unit, | |
303 | int level, | |
304 | const char *config_file, | |
305 | unsigned config_line, | |
306 | int error, | |
307 | const char *file, | |
308 | int line, | |
309 | const char *func, | |
310 | const char *format, ...) _printf_(9, 10); | |
311 | ||
d04ce5a9 LP |
312 | int log_syntax_invalid_utf8_internal( |
313 | const char *unit, | |
314 | int level, | |
315 | const char *config_file, | |
316 | unsigned config_line, | |
317 | const char *file, | |
318 | int line, | |
319 | const char *func, | |
320 | const char *rvalue); | |
321 | ||
158350e8 LP |
322 | #define log_syntax(unit, level, config_file, config_line, error, ...) \ |
323 | ({ \ | |
324 | int _level = (level), _e = (error); \ | |
325 | (log_get_max_level() >= LOG_PRI(_level)) \ | |
62c6bbbc | 326 | ? log_syntax_internal(unit, _level, config_file, config_line, _e, PROJECT_FILE, __LINE__, __func__, __VA_ARGS__) \ |
ee96382f | 327 | : -ERRNO_VALUE(_e); \ |
158350e8 | 328 | }) |
0e05ee04 LP |
329 | |
330 | #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \ | |
331 | ({ \ | |
332 | int _level = (level); \ | |
d04ce5a9 | 333 | (log_get_max_level() >= LOG_PRI(_level)) \ |
62c6bbbc | 334 | ? log_syntax_invalid_utf8_internal(unit, _level, config_file, config_line, PROJECT_FILE, __LINE__, __func__, rvalue) \ |
d04ce5a9 | 335 | : -EINVAL; \ |
0e05ee04 | 336 | }) |
f1d34068 LP |
337 | |
338 | #define DEBUG_LOGGING _unlikely_(log_get_max_level() >= LOG_DEBUG) | |
6bf3c61c LP |
339 | |
340 | void log_setup_service(void); |