]>
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_; |
c5673ed0 DS |
62 | void log_show_time(bool b); |
63 | bool log_get_show_time(void) _pure_; | |
bbe63281 LP |
64 | |
65 | int log_show_color_from_string(const char *e); | |
66 | int log_show_location_from_string(const char *e); | |
c5673ed0 | 67 | int log_show_time_from_string(const char *e); |
bbe63281 | 68 | |
44a6b1b6 | 69 | LogTarget log_get_target(void) _pure_; |
ff524019 ZJS |
70 | int log_get_max_level_realm(LogRealm realm) _pure_; |
71 | #define log_get_max_level() \ | |
72 | log_get_max_level_realm(LOG_REALM) | |
1adf1049 | 73 | |
e3e42fc2 ZJS |
74 | /* Functions below that open and close logs or configure logging based on the |
75 | * environment should not be called from library code — this is always a job | |
76 | * for the application itself. | |
77 | */ | |
78 | ||
ab1a1ba5 | 79 | assert_cc(STRLEN(__FILE__) > STRLEN(RELATIVE_SOURCE_PATH) + 1); |
f455f863 | 80 | #define PROJECT_FILE (&__FILE__[STRLEN(RELATIVE_SOURCE_PATH) + 1]) |
a0b15b41 | 81 | |
843d2643 | 82 | int log_open(void); |
871e5809 | 83 | void log_close(void); |
4d8a7798 | 84 | void log_forget_fds(void); |
843d2643 | 85 | |
ff524019 | 86 | void log_parse_environment_realm(LogRealm realm); |
41d1f469 | 87 | void log_parse_environment_cli_realm(LogRealm realm); |
ff524019 ZJS |
88 | #define log_parse_environment() \ |
89 | log_parse_environment_realm(LOG_REALM) | |
41d1f469 FB |
90 | #define log_parse_environment_cli() \ |
91 | log_parse_environment_cli_realm(LOG_REALM) | |
34f0e866 | 92 | |
93484b47 ZJS |
93 | int log_dispatch_internal( |
94 | int level, | |
95 | int error, | |
96 | const char *file, | |
97 | int line, | |
98 | const char *func, | |
99 | const char *object_field, | |
100 | const char *object, | |
101 | const char *extra, | |
102 | const char *extra_field, | |
103 | char *buffer); | |
104 | ||
ff524019 | 105 | int log_internal_realm( |
877d54e9 | 106 | int level, |
086891e5 | 107 | int error, |
79008bdd | 108 | const char *file, |
877d54e9 LP |
109 | int line, |
110 | const char *func, | |
086891e5 | 111 | const char *format, ...) _printf_(6,7); |
ff524019 ZJS |
112 | #define log_internal(level, ...) \ |
113 | log_internal_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__) | |
5899f3b7 | 114 | |
ff524019 | 115 | int log_internalv_realm( |
877d54e9 | 116 | int level, |
086891e5 | 117 | int error, |
79008bdd | 118 | const char *file, |
877d54e9 LP |
119 | int line, |
120 | const char *func, | |
121 | const char *format, | |
086891e5 | 122 | va_list ap) _printf_(6,0); |
ff524019 ZJS |
123 | #define log_internalv(level, ...) \ |
124 | log_internalv_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__) | |
877d54e9 | 125 | |
ff524019 | 126 | /* Realm is fixed to LOG_REALM_SYSTEMD for those */ |
f6d6d532 YW |
127 | int log_object_internalv( |
128 | int level, | |
129 | int error, | |
130 | const char *file, | |
131 | int line, | |
132 | const char *func, | |
133 | const char *object_field, | |
134 | const char *object, | |
135 | const char *extra_field, | |
136 | const char *extra, | |
137 | const char *format, | |
138 | va_list ap) _printf_(10,0); | |
139 | ||
79008bdd | 140 | int log_object_internal( |
fdf9f9bb | 141 | int level, |
086891e5 | 142 | int error, |
79008bdd | 143 | const char *file, |
fdf9f9bb ZJS |
144 | int line, |
145 | const char *func, | |
79008bdd | 146 | const char *object_field, |
fdf9f9bb | 147 | const char *object, |
4b58153d LP |
148 | const char *extra_field, |
149 | const char *extra, | |
150 | const char *format, ...) _printf_(10,11); | |
fdf9f9bb | 151 | |
877d54e9 LP |
152 | int log_struct_internal( |
153 | int level, | |
086891e5 | 154 | int error, |
877d54e9 LP |
155 | const char *file, |
156 | int line, | |
157 | const char *func, | |
086891e5 | 158 | const char *format, ...) _printf_(6,0) _sentinel_; |
877d54e9 LP |
159 | |
160 | int log_oom_internal( | |
ff524019 | 161 | LogRealm realm, |
877d54e9 LP |
162 | const char *file, |
163 | int line, | |
164 | const char *func); | |
185986c6 | 165 | |
8a03c9ef ZJS |
166 | int log_format_iovec( |
167 | struct iovec *iovec, | |
d3070fbd LP |
168 | size_t iovec_len, |
169 | size_t *n, | |
8a03c9ef ZJS |
170 | bool newline_separator, |
171 | int error, | |
172 | const char *format, | |
ba360bb0 | 173 | va_list ap) _printf_(6, 0); |
8a03c9ef | 174 | |
915b1d01 LP |
175 | int log_struct_iovec_internal( |
176 | int level, | |
177 | int error, | |
178 | const char *file, | |
179 | int line, | |
180 | const char *func, | |
dccca82b | 181 | const struct iovec *input_iovec, |
915b1d01 LP |
182 | size_t n_input_iovec); |
183 | ||
2149e37c LP |
184 | /* This modifies the buffer passed! */ |
185 | int log_dump_internal( | |
877d54e9 | 186 | int level, |
086891e5 | 187 | int error, |
79008bdd | 188 | const char *file, |
877d54e9 LP |
189 | int line, |
190 | const char *func, | |
191 | char *buffer); | |
192 | ||
086891e5 | 193 | /* Logging for various assertions */ |
848e863a | 194 | _noreturn_ void log_assert_failed_realm( |
ff524019 | 195 | LogRealm realm, |
877d54e9 LP |
196 | const char *text, |
197 | const char *file, | |
198 | int line, | |
199 | const char *func); | |
ff524019 ZJS |
200 | #define log_assert_failed(text, ...) \ |
201 | log_assert_failed_realm(LOG_REALM, (text), __VA_ARGS__) | |
877d54e9 | 202 | |
848e863a | 203 | _noreturn_ void log_assert_failed_unreachable_realm( |
ff524019 | 204 | LogRealm realm, |
877d54e9 LP |
205 | const char *text, |
206 | const char *file, | |
207 | int line, | |
208 | const char *func); | |
ff524019 ZJS |
209 | #define log_assert_failed_unreachable(text, ...) \ |
210 | log_assert_failed_unreachable_realm(LOG_REALM, (text), __VA_ARGS__) | |
80514f9c | 211 | |
ff524019 ZJS |
212 | void log_assert_failed_return_realm( |
213 | LogRealm realm, | |
80514f9c LP |
214 | const char *text, |
215 | const char *file, | |
216 | int line, | |
217 | const char *func); | |
ff524019 ZJS |
218 | #define log_assert_failed_return(text, ...) \ |
219 | log_assert_failed_return_realm(LOG_REALM, (text), __VA_ARGS__) | |
2149e37c | 220 | |
93484b47 | 221 | #define log_dispatch(level, error, buffer) \ |
62c6bbbc | 222 | log_dispatch_internal(level, error, PROJECT_FILE, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer) |
93484b47 | 223 | |
086891e5 | 224 | /* Logging with level */ |
ff524019 | 225 | #define log_full_errno_realm(realm, level, error, ...) \ |
1cfa9a4c | 226 | ({ \ |
c1e83af8 | 227 | int _level = (level), _e = (error), _realm = (realm); \ |
baaa35ad | 228 | (log_get_max_level_realm(_realm) >= LOG_PRI(_level)) \ |
c1e83af8 | 229 | ? log_internal_realm(LOG_REALM_PLUS_LEVEL(_realm, _level), _e, \ |
62c6bbbc | 230 | PROJECT_FILE, __LINE__, __func__, __VA_ARGS__) \ |
baaa35ad | 231 | : -ERRNO_VALUE(_e); \ |
bf371116 | 232 | }) |
87ff6b1c | 233 | |
ff524019 ZJS |
234 | #define log_full_errno(level, error, ...) \ |
235 | log_full_errno_realm(LOG_REALM, (level), (error), __VA_ARGS__) | |
236 | ||
237 | #define log_full(level, ...) log_full_errno((level), 0, __VA_ARGS__) | |
086891e5 | 238 | |
dccca82b LP |
239 | int log_emergency_level(void); |
240 | ||
086891e5 | 241 | /* Normal logging */ |
4104970e ZJS |
242 | #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__) |
243 | #define log_info(...) log_full(LOG_INFO, __VA_ARGS__) | |
244 | #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__) | |
245 | #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__) | |
246 | #define log_error(...) log_full(LOG_ERR, __VA_ARGS__) | |
dccca82b | 247 | #define log_emergency(...) log_full(log_emergency_level(), __VA_ARGS__) |
5899f3b7 | 248 | |
086891e5 LP |
249 | /* Logging triggered by an errno-like error */ |
250 | #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__) | |
251 | #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__) | |
252 | #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__) | |
253 | #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__) | |
254 | #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__) | |
dccca82b | 255 | #define log_emergency_errno(error, ...) log_full_errno(log_emergency_level(), error, __VA_ARGS__) |
086891e5 | 256 | |
cb41ff29 ZJS |
257 | #ifdef LOG_TRACE |
258 | # define log_trace(...) log_debug(__VA_ARGS__) | |
259 | #else | |
9ed794a3 | 260 | # define log_trace(...) do {} while (0) |
cb41ff29 ZJS |
261 | #endif |
262 | ||
086891e5 | 263 | /* Structured logging */ |
ff524019 ZJS |
264 | #define log_struct_errno(level, error, ...) \ |
265 | log_struct_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \ | |
62c6bbbc | 266 | error, PROJECT_FILE, __LINE__, __func__, __VA_ARGS__, NULL) |
ff524019 | 267 | #define log_struct(level, ...) log_struct_errno(level, 0, __VA_ARGS__) |
0d0f0c50 | 268 | |
915b1d01 LP |
269 | #define log_struct_iovec_errno(level, error, iovec, n_iovec) \ |
270 | log_struct_iovec_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \ | |
62c6bbbc | 271 | error, PROJECT_FILE, __LINE__, __func__, iovec, n_iovec) |
915b1d01 LP |
272 | #define log_struct_iovec(level, iovec, n_iovec) log_struct_iovec_errno(level, 0, iovec, n_iovec) |
273 | ||
2149e37c | 274 | /* This modifies the buffer passed! */ |
ff524019 ZJS |
275 | #define log_dump(level, buffer) \ |
276 | log_dump_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \ | |
62c6bbbc | 277 | 0, PROJECT_FILE, __LINE__, __func__, buffer) |
086891e5 | 278 | |
62c6bbbc | 279 | #define log_oom() log_oom_internal(LOG_REALM, PROJECT_FILE, __LINE__, __func__) |
2149e37c | 280 | |
44a6b1b6 | 281 | bool log_on_console(void) _pure_; |
81270860 | 282 | |
44a6b1b6 ZJS |
283 | const char *log_target_to_string(LogTarget target) _const_; |
284 | LogTarget log_target_from_string(const char *s) _pure_; | |
706911fb | 285 | |
2b044526 | 286 | /* Helper to prepare various field for structured logging */ |
e2cc6eca | 287 | #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__ |
4daf54a8 ZJS |
288 | |
289 | void log_received_signal(int level, const struct signalfd_siginfo *si); | |
c1dc6153 | 290 | |
6fdb8de4 | 291 | /* If turned on, any requests for a log target involving "syslog" will be implicitly upgraded to the equivalent journal target */ |
c1dc6153 | 292 | void log_set_upgrade_syslog_to_journal(bool b); |
7a3be263 LP |
293 | |
294 | /* If turned on, and log_open() is called, we'll not use STDERR_FILENO for logging ever, but rather open /dev/console */ | |
48a601fe | 295 | void log_set_always_reopen_console(bool b); |
7a3be263 LP |
296 | |
297 | /* If turned on, we'll open the log stream implicitly if needed on each individual log call. This is normally not | |
298 | * desired as we want to reuse our logging streams. It is useful however */ | |
16e4fd87 | 299 | void log_set_open_when_needed(bool b); |
158350e8 | 300 | |
adf47c91 LP |
301 | /* 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 |
302 | * stderr, the console or kmsg */ | |
303 | void log_set_prohibit_ipc(bool b); | |
304 | ||
17cac366 LP |
305 | int log_dup_console(void); |
306 | ||
158350e8 LP |
307 | int log_syntax_internal( |
308 | const char *unit, | |
309 | int level, | |
310 | const char *config_file, | |
311 | unsigned config_line, | |
312 | int error, | |
313 | const char *file, | |
314 | int line, | |
315 | const char *func, | |
316 | const char *format, ...) _printf_(9, 10); | |
317 | ||
d04ce5a9 LP |
318 | int log_syntax_invalid_utf8_internal( |
319 | const char *unit, | |
320 | int level, | |
321 | const char *config_file, | |
322 | unsigned config_line, | |
323 | const char *file, | |
324 | int line, | |
325 | const char *func, | |
326 | const char *rvalue); | |
327 | ||
158350e8 LP |
328 | #define log_syntax(unit, level, config_file, config_line, error, ...) \ |
329 | ({ \ | |
330 | int _level = (level), _e = (error); \ | |
331 | (log_get_max_level() >= LOG_PRI(_level)) \ | |
62c6bbbc | 332 | ? log_syntax_internal(unit, _level, config_file, config_line, _e, PROJECT_FILE, __LINE__, __func__, __VA_ARGS__) \ |
ee96382f | 333 | : -ERRNO_VALUE(_e); \ |
158350e8 | 334 | }) |
0e05ee04 LP |
335 | |
336 | #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \ | |
337 | ({ \ | |
338 | int _level = (level); \ | |
d04ce5a9 | 339 | (log_get_max_level() >= LOG_PRI(_level)) \ |
62c6bbbc | 340 | ? log_syntax_invalid_utf8_internal(unit, _level, config_file, config_line, PROJECT_FILE, __LINE__, __func__, rvalue) \ |
d04ce5a9 | 341 | : -EINVAL; \ |
0e05ee04 | 342 | }) |
f1d34068 LP |
343 | |
344 | #define DEBUG_LOGGING _unlikely_(log_get_max_level() >= LOG_DEBUG) | |
6bf3c61c LP |
345 | |
346 | void log_setup_service(void); | |
41d1f469 | 347 | void log_setup_cli(void); |