]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/basic/log.h
Merge pull request #32516 from YHNdnzj/core-cleanup
[thirdparty/systemd.git] / src / basic / log.h
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #pragma once
3
4 #include <stdarg.h>
5 #include <stdbool.h>
6 #include <stdlib.h>
7 #include <string.h>
8 #include <syslog.h>
9
10 #include "list.h"
11 #include "macro.h"
12 #include "ratelimit.h"
13 #include "stdio-util.h"
14
15 /* Some structures we reference but don't want to pull in headers for */
16 struct iovec;
17 struct signalfd_siginfo;
18
19 typedef enum LogTarget{
20 LOG_TARGET_CONSOLE,
21 LOG_TARGET_KMSG,
22 LOG_TARGET_JOURNAL,
23 LOG_TARGET_SYSLOG,
24 LOG_TARGET_CONSOLE_PREFIXED,
25 LOG_TARGET_JOURNAL_OR_KMSG,
26 LOG_TARGET_SYSLOG_OR_KMSG,
27 LOG_TARGET_AUTO, /* console if stderr is not journal, JOURNAL_OR_KMSG otherwise */
28 LOG_TARGET_NULL,
29 _LOG_TARGET_SINGLE_MAX = LOG_TARGET_SYSLOG + 1,
30 _LOG_TARGET_MAX = LOG_TARGET_NULL + 1,
31 _LOG_TARGET_INVALID = -EINVAL,
32 } LogTarget;
33
34 /* This log level disables logging completely. It can only be passed to log_set_max_level() and cannot be
35 * used as a regular log level. */
36 #define LOG_NULL (LOG_EMERG - 1)
37
38 /* Note to readers: << and >> have lower precedence (are evaluated earlier) than & and | */
39 #define SYNTHETIC_ERRNO(num) (1 << 30 | (num))
40 #define IS_SYNTHETIC_ERRNO(val) ((val) >> 30 & 1)
41 #define ERRNO_VALUE(val) (abs(val) & ~(1 << 30))
42
43 /* The callback function to be invoked when syntax warnings are seen
44 * in the unit files. */
45 typedef void (*log_syntax_callback_t)(const char *unit, int level, void *userdata);
46 void set_log_syntax_callback(log_syntax_callback_t cb, void *userdata);
47
48 static inline void clear_log_syntax_callback(dummy_t *dummy) {
49 set_log_syntax_callback(/* cb= */ NULL, /* userdata= */ NULL);
50 }
51
52 const char *log_target_to_string(LogTarget target) _const_;
53 LogTarget log_target_from_string(const char *s) _pure_;
54 void log_set_target(LogTarget target);
55 void log_set_target_and_open(LogTarget target);
56 int log_set_target_from_string(const char *e);
57 LogTarget log_get_target(void) _pure_;
58 void log_settle_target(void);
59
60 void log_set_max_level(int level);
61 int log_set_max_level_from_string(const char *e);
62 int log_get_max_level(void) _pure_;
63 int log_max_levels_to_string(int level, char **ret);
64
65 void log_set_facility(int facility);
66
67 void log_show_color(bool b);
68 bool log_get_show_color(void) _pure_;
69 void log_show_location(bool b);
70 bool log_get_show_location(void) _pure_;
71 void log_show_time(bool b);
72 bool log_get_show_time(void) _pure_;
73 void log_show_tid(bool b);
74 bool log_get_show_tid(void) _pure_;
75
76 int log_show_color_from_string(const char *e);
77 int log_show_location_from_string(const char *e);
78 int log_show_time_from_string(const char *e);
79 int log_show_tid_from_string(const char *e);
80
81 /* Functions below that open and close logs or configure logging based on the
82 * environment should not be called from library code — this is always a job
83 * for the application itself. */
84
85 assert_cc(STRLEN(__FILE__) > STRLEN(RELATIVE_SOURCE_PATH) + 1);
86 #define PROJECT_FILE (&__FILE__[STRLEN(RELATIVE_SOURCE_PATH) + 1])
87
88 bool stderr_is_journal(void);
89 int log_open(void);
90 void log_close(void);
91 void log_forget_fds(void);
92
93 void log_parse_environment_variables(void);
94 void log_parse_environment(void);
95
96 int log_dispatch_internal(
97 int level,
98 int error,
99 const char *file,
100 int line,
101 const char *func,
102 const char *object_field,
103 const char *object,
104 const char *extra,
105 const char *extra_field,
106 char *buffer);
107
108 int log_internal(
109 int level,
110 int error,
111 const char *file,
112 int line,
113 const char *func,
114 const char *format, ...) _printf_(6,7);
115
116 int log_internalv(
117 int level,
118 int error,
119 const char *file,
120 int line,
121 const char *func,
122 const char *format,
123 va_list ap) _printf_(6,0);
124
125 int log_object_internalv(
126 int level,
127 int error,
128 const char *file,
129 int line,
130 const char *func,
131 const char *object_field,
132 const char *object,
133 const char *extra_field,
134 const char *extra,
135 const char *format,
136 va_list ap) _printf_(10,0);
137
138 int log_object_internal(
139 int level,
140 int error,
141 const char *file,
142 int line,
143 const char *func,
144 const char *object_field,
145 const char *object,
146 const char *extra_field,
147 const char *extra,
148 const char *format, ...) _printf_(10,11);
149
150 int log_struct_internal(
151 int level,
152 int error,
153 const char *file,
154 int line,
155 const char *func,
156 const char *format, ...) _printf_(6,0) _sentinel_;
157
158 int log_oom_internal(
159 int level,
160 const char *file,
161 int line,
162 const char *func);
163
164 int log_format_iovec(
165 struct iovec *iovec,
166 size_t iovec_len,
167 size_t *n,
168 bool newline_separator,
169 int error,
170 const char *format,
171 va_list ap) _printf_(6, 0);
172
173 int log_struct_iovec_internal(
174 int level,
175 int error,
176 const char *file,
177 int line,
178 const char *func,
179 const struct iovec *input_iovec,
180 size_t n_input_iovec);
181
182 /* This modifies the buffer passed! */
183 int log_dump_internal(
184 int level,
185 int error,
186 const char *file,
187 int line,
188 const char *func,
189 char *buffer);
190
191 /* Logging for various assertions */
192 _noreturn_ void log_assert_failed(
193 const char *text,
194 const char *file,
195 int line,
196 const char *func);
197
198 _noreturn_ void log_assert_failed_unreachable(
199 const char *file,
200 int line,
201 const char *func);
202
203 void log_assert_failed_return(
204 const char *text,
205 const char *file,
206 int line,
207 const char *func);
208
209 #define log_dispatch(level, error, buffer) \
210 log_dispatch_internal(level, error, PROJECT_FILE, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer)
211
212 /* Logging with level */
213 #define log_full_errno_zerook(level, error, ...) \
214 ({ \
215 int _level = (level), _e = (error); \
216 _e = (log_get_max_level() >= LOG_PRI(_level)) \
217 ? log_internal(_level, _e, PROJECT_FILE, __LINE__, __func__, __VA_ARGS__) \
218 : -ERRNO_VALUE(_e); \
219 _e < 0 ? _e : -ESTRPIPE; \
220 })
221
222 #if BUILD_MODE_DEVELOPER && !defined(TEST_CODE)
223 # define ASSERT_NON_ZERO(x) assert((x) != 0)
224 #else
225 # define ASSERT_NON_ZERO(x)
226 #endif
227
228 #define log_full_errno(level, error, ...) \
229 ({ \
230 int _error = (error); \
231 ASSERT_NON_ZERO(_error); \
232 log_full_errno_zerook(level, _error, __VA_ARGS__); \
233 })
234
235 #define log_full(level, fmt, ...) \
236 ({ \
237 if (BUILD_MODE_DEVELOPER) \
238 assert(!strstr(fmt, "%m")); \
239 (void) log_full_errno_zerook(level, 0, fmt, ##__VA_ARGS__); \
240 })
241
242 int log_emergency_level(void);
243
244 /* Normal logging */
245 #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__)
246 #define log_info(...) log_full(LOG_INFO, __VA_ARGS__)
247 #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__)
248 #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__)
249 #define log_error(...) log_full(LOG_ERR, __VA_ARGS__)
250 #define log_emergency(...) log_full(log_emergency_level(), __VA_ARGS__)
251
252 /* Logging triggered by an errno-like error */
253 #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__)
254 #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__)
255 #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__)
256 #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__)
257 #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__)
258 #define log_emergency_errno(error, ...) log_full_errno(log_emergency_level(), error, __VA_ARGS__)
259
260 /* This logs at the specified level the first time it is called, and then
261 * logs at debug. If the specified level is debug, this logs only the first
262 * time it is called. */
263 #define log_once(level, ...) \
264 ({ \
265 if (ONCE) \
266 log_full(level, __VA_ARGS__); \
267 else if (LOG_PRI(level) != LOG_DEBUG) \
268 log_debug(__VA_ARGS__); \
269 })
270
271 #define log_once_errno(level, error, ...) \
272 ({ \
273 int _err = (error); \
274 if (ONCE) \
275 _err = log_full_errno(level, _err, __VA_ARGS__); \
276 else if (LOG_PRI(level) != LOG_DEBUG) \
277 _err = log_debug_errno(_err, __VA_ARGS__); \
278 else \
279 _err = -ERRNO_VALUE(_err); \
280 _err; \
281 })
282
283 #if LOG_TRACE
284 # define log_trace(...) log_debug(__VA_ARGS__)
285 # define log_trace_errno(...) log_debug_errno(__VA_ARGS__)
286 #else
287 # define log_trace(...) do {} while (0)
288 # define log_trace_errno(e, ...) (-ERRNO_VALUE(e))
289 #endif
290
291 /* Structured logging */
292 #define log_struct_errno(level, error, ...) \
293 log_struct_internal(level, error, PROJECT_FILE, __LINE__, __func__, __VA_ARGS__, NULL)
294 #define log_struct(level, ...) log_struct_errno(level, 0, __VA_ARGS__)
295
296 #define log_struct_iovec_errno(level, error, iovec, n_iovec) \
297 log_struct_iovec_internal(level, error, PROJECT_FILE, __LINE__, __func__, iovec, n_iovec)
298 #define log_struct_iovec(level, iovec, n_iovec) log_struct_iovec_errno(level, 0, iovec, n_iovec)
299
300 /* This modifies the buffer passed! */
301 #define log_dump(level, buffer) \
302 log_dump_internal(level, 0, PROJECT_FILE, __LINE__, __func__, buffer)
303
304 #define log_oom() log_oom_internal(LOG_ERR, PROJECT_FILE, __LINE__, __func__)
305 #define log_oom_debug() log_oom_internal(LOG_DEBUG, PROJECT_FILE, __LINE__, __func__)
306 #define log_oom_warning() log_oom_internal(LOG_WARNING, PROJECT_FILE, __LINE__, __func__)
307
308 bool log_on_console(void) _pure_;
309
310 /* Helper to wrap the main message in structured logging. The macro doesn't do much,
311 * except to provide visual grouping of the format string and its arguments. */
312 #if LOG_MESSAGE_VERIFICATION || defined(__COVERITY__)
313 /* Do a fake formatting of the message string to let the scanner verify the arguments against the format
314 * message. The variable will never be set to true, but we don't tell the compiler that :) */
315 extern bool _log_message_dummy;
316 # define LOG_MESSAGE(fmt, ...) "MESSAGE=%.0d" fmt, (_log_message_dummy && printf(fmt, ##__VA_ARGS__)), ##__VA_ARGS__
317 #else
318 # define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
319 #endif
320
321 void log_received_signal(int level, const struct signalfd_siginfo *si);
322
323 /* If turned on, any requests for a log target involving "syslog" will be implicitly upgraded to the equivalent journal target */
324 void log_set_upgrade_syslog_to_journal(bool b);
325
326 /* If turned on, and log_open() is called, we'll not use STDERR_FILENO for logging ever, but rather open /dev/console */
327 void log_set_always_reopen_console(bool b);
328
329 /* If turned on, we'll open the log stream implicitly if needed on each individual log call. This is normally not
330 * desired as we want to reuse our logging streams. It is useful however */
331 void log_set_open_when_needed(bool b);
332
333 /* 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
334 * stderr, the console or kmsg */
335 void log_set_prohibit_ipc(bool b);
336
337 void log_set_assert_return_is_critical(bool b);
338 bool log_get_assert_return_is_critical(void) _pure_;
339
340 int log_dup_console(void);
341
342 int log_syntax_internal(
343 const char *unit,
344 int level,
345 const char *config_file,
346 unsigned config_line,
347 int error,
348 const char *file,
349 int line,
350 const char *func,
351 const char *format, ...) _printf_(9, 10);
352
353 int log_syntax_invalid_utf8_internal(
354 const char *unit,
355 int level,
356 const char *config_file,
357 unsigned config_line,
358 const char *file,
359 int line,
360 const char *func,
361 const char *rvalue);
362
363 #define log_syntax(unit, level, config_file, config_line, error, ...) \
364 ({ \
365 int _level = (level), _e = (error); \
366 (log_get_max_level() >= LOG_PRI(_level)) \
367 ? log_syntax_internal(unit, _level, config_file, config_line, _e, PROJECT_FILE, __LINE__, __func__, __VA_ARGS__) \
368 : -ERRNO_VALUE(_e); \
369 })
370
371 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
372 ({ \
373 int _level = (level); \
374 (log_get_max_level() >= LOG_PRI(_level)) \
375 ? log_syntax_invalid_utf8_internal(unit, _level, config_file, config_line, PROJECT_FILE, __LINE__, __func__, rvalue) \
376 : -EINVAL; \
377 })
378
379 #define DEBUG_LOGGING _unlikely_(log_get_max_level() >= LOG_DEBUG)
380
381 void log_setup(void);
382
383 typedef struct LogRateLimit {
384 int error;
385 int level;
386 RateLimit ratelimit;
387 } LogRateLimit;
388
389 #define log_ratelimit_internal(_level, _error, _ratelimit, _file, _line, _func, _format, ...) \
390 ({ \
391 int _log_ratelimit_error = (_error); \
392 int _log_ratelimit_level = (_level); \
393 static LogRateLimit _log_ratelimit = { \
394 .ratelimit = (_ratelimit), \
395 }; \
396 unsigned _num_dropped_errors = ratelimit_num_dropped(&_log_ratelimit.ratelimit); \
397 if (_log_ratelimit_error != _log_ratelimit.error || _log_ratelimit_level != _log_ratelimit.level) { \
398 ratelimit_reset(&_log_ratelimit.ratelimit); \
399 _log_ratelimit.error = _log_ratelimit_error; \
400 _log_ratelimit.level = _log_ratelimit_level; \
401 } \
402 if (log_get_max_level() == LOG_DEBUG || ratelimit_below(&_log_ratelimit.ratelimit)) \
403 _log_ratelimit_error = _num_dropped_errors > 0 \
404 ? log_internal(_log_ratelimit_level, _log_ratelimit_error, _file, _line, _func, _format " (Dropped %u similar message(s))", ##__VA_ARGS__, _num_dropped_errors) \
405 : log_internal(_log_ratelimit_level, _log_ratelimit_error, _file, _line, _func, _format, ##__VA_ARGS__); \
406 _log_ratelimit_error; \
407 })
408
409 #define log_ratelimit_full_errno(level, error, _ratelimit, format, ...) \
410 ({ \
411 int _level = (level), _e = (error); \
412 _e = (log_get_max_level() >= LOG_PRI(_level)) \
413 ? log_ratelimit_internal(_level, _e, _ratelimit, PROJECT_FILE, __LINE__, __func__, format, ##__VA_ARGS__) \
414 : -ERRNO_VALUE(_e); \
415 _e < 0 ? _e : -ESTRPIPE; \
416 })
417
418 #define log_ratelimit_full(level, _ratelimit, format, ...) \
419 log_ratelimit_full_errno(level, 0, _ratelimit, format, ##__VA_ARGS__)
420
421 /* Normal logging */
422 #define log_ratelimit_info(...) log_ratelimit_full(LOG_INFO, __VA_ARGS__)
423 #define log_ratelimit_notice(...) log_ratelimit_full(LOG_NOTICE, __VA_ARGS__)
424 #define log_ratelimit_warning(...) log_ratelimit_full(LOG_WARNING, __VA_ARGS__)
425 #define log_ratelimit_error(...) log_ratelimit_full(LOG_ERR, __VA_ARGS__)
426 #define log_ratelimit_emergency(...) log_ratelimit_full(log_emergency_level(), __VA_ARGS__)
427
428 /* Logging triggered by an errno-like error */
429 #define log_ratelimit_info_errno(error, ...) log_ratelimit_full_errno(LOG_INFO, error, __VA_ARGS__)
430 #define log_ratelimit_notice_errno(error, ...) log_ratelimit_full_errno(LOG_NOTICE, error, __VA_ARGS__)
431 #define log_ratelimit_warning_errno(error, ...) log_ratelimit_full_errno(LOG_WARNING, error, __VA_ARGS__)
432 #define log_ratelimit_error_errno(error, ...) log_ratelimit_full_errno(LOG_ERR, error, __VA_ARGS__)
433 #define log_ratelimit_emergency_errno(error, ...) log_ratelimit_full_errno(log_emergency_level(), error, __VA_ARGS__)
434
435 const char *_log_set_prefix(const char *prefix, bool force);
436 static inline const char *_log_unset_prefixp(const char **p) {
437 assert(p);
438 _log_set_prefix(*p, true);
439 return NULL;
440 }
441
442 #define LOG_SET_PREFIX(prefix) \
443 _cleanup_(_log_unset_prefixp) _unused_ const char *CONCATENATE(_cleanup_log_unset_prefix_, UNIQ) = _log_set_prefix(prefix, false);
444
445 /*
446 * The log context allows attaching extra metadata to log messages written to the journal via log.h. We keep
447 * track of a thread local log context onto which we can push extra metadata fields that should be logged.
448 *
449 * LOG_CONTEXT_PUSH() will add the provided field to the log context and will remove it again when the
450 * current block ends. LOG_CONTEXT_PUSH_STRV() will do the same but for all fields in the given strv.
451 * LOG_CONTEXT_PUSHF() is like LOG_CONTEXT_PUSH() but takes a format string and arguments.
452 *
453 * Using the macros is as simple as putting them anywhere inside a block to add a field to all following log
454 * messages logged from inside that block.
455 *
456 * void myfunction(...) {
457 * ...
458 *
459 * LOG_CONTEXT_PUSHF("MYMETADATA=%s", "abc");
460 *
461 * // Every journal message logged will now have the MYMETADATA=abc
462 * // field included.
463 * }
464 *
465 * One special case to note is async code, where we use callbacks that are invoked to continue processing
466 * when some event occurs. For async code, there's usually an associated "userdata" struct containing all the
467 * information associated with the async operation. In this "userdata" struct, we can store a log context
468 * allocated with log_context_new() and freed with log_context_free(). We can then add and remove fields to
469 * the `fields` member of the log context object and all those fields will be logged along with each log
470 * message.
471 */
472
473 typedef struct LogContext LogContext;
474
475 bool log_context_enabled(void);
476
477 LogContext* log_context_new(const char *key, const char *value);
478 LogContext* log_context_new_strv(char **fields, bool owned);
479 LogContext* log_context_new_iov(struct iovec *input_iovec, size_t n_input_iovec, bool owned);
480
481 /* Same as log_context_new(), but frees the given fields strv/iovec on failure. */
482 LogContext* log_context_new_strv_consume(char **fields);
483 LogContext* log_context_new_iov_consume(struct iovec *input_iovec, size_t n_input_iovec);
484
485 LogContext *log_context_ref(LogContext *c);
486 LogContext *log_context_unref(LogContext *c);
487
488 DEFINE_TRIVIAL_CLEANUP_FUNC(LogContext*, log_context_unref);
489
490 /* Returns the number of attached log context objects. */
491 size_t log_context_num_contexts(void);
492 /* Returns the number of fields in all attached log contexts. */
493 size_t log_context_num_fields(void);
494
495 #define LOG_CONTEXT_PUSH(...) \
496 LOG_CONTEXT_PUSH_STRV(STRV_MAKE(__VA_ARGS__))
497
498 #define LOG_CONTEXT_PUSHF(...) \
499 LOG_CONTEXT_PUSH(snprintf_ok((char[LINE_MAX]) {}, LINE_MAX, __VA_ARGS__))
500
501 #define _LOG_CONTEXT_PUSH_KEY_VALUE(key, value, c) \
502 _unused_ _cleanup_(log_context_unrefp) LogContext *c = log_context_new(key, value);
503
504 #define LOG_CONTEXT_PUSH_KEY_VALUE(key, value) \
505 _LOG_CONTEXT_PUSH_KEY_VALUE(key, value, UNIQ_T(c, UNIQ))
506
507 #define _LOG_CONTEXT_PUSH_STRV(strv, c) \
508 _unused_ _cleanup_(log_context_unrefp) LogContext *c = log_context_new_strv(strv, /*owned=*/ false);
509
510 #define LOG_CONTEXT_PUSH_STRV(strv) \
511 _LOG_CONTEXT_PUSH_STRV(strv, UNIQ_T(c, UNIQ))
512
513 #define _LOG_CONTEXT_PUSH_IOV(input_iovec, n_input_iovec, c) \
514 _unused_ _cleanup_(log_context_unrefp) LogContext *c = log_context_new_iov(input_iovec, n_input_iovec, /*owned=*/ false);
515
516 #define LOG_CONTEXT_PUSH_IOV(input_iovec, n_input_iovec) \
517 _LOG_CONTEXT_PUSH_IOV(input_iovec, n_input_iovec, UNIQ_T(c, UNIQ))
518
519 /* LOG_CONTEXT_CONSUME_STR()/LOG_CONTEXT_CONSUME_STRV()/LOG_CONTEXT_CONSUME_IOV() are identical to
520 * LOG_CONTEXT_PUSH_STR()/LOG_CONTEXT_PUSH_STRV()/LOG_CONTEXT_PUSH_IOV() except they take ownership of the
521 * given str/strv argument.
522 */
523
524 #define _LOG_CONTEXT_CONSUME_STR(s, c, strv) \
525 _unused_ _cleanup_strv_free_ strv = strv_new(s); \
526 if (!strv) \
527 free(s); \
528 _unused_ _cleanup_(log_context_unrefp) LogContext *c = log_context_new_strv_consume(TAKE_PTR(strv))
529
530 #define LOG_CONTEXT_CONSUME_STR(s) \
531 _LOG_CONTEXT_CONSUME_STR(s, UNIQ_T(c, UNIQ), UNIQ_T(sv, UNIQ))
532
533 #define _LOG_CONTEXT_CONSUME_STRV(strv, c) \
534 _unused_ _cleanup_(log_context_unrefp) LogContext *c = log_context_new_strv_consume(strv);
535
536 #define LOG_CONTEXT_CONSUME_STRV(strv) \
537 _LOG_CONTEXT_CONSUME_STRV(strv, UNIQ_T(c, UNIQ))
538
539 #define _LOG_CONTEXT_CONSUME_IOV(input_iovec, n_input_iovec, c) \
540 _unused_ _cleanup_(log_context_unrefp) LogContext *c = log_context_new_iov_consume(input_iovec, n_input_iovec);
541
542 #define LOG_CONTEXT_CONSUME_IOV(input_iovec, n_input_iovec) \
543 _LOG_CONTEXT_CONSUME_IOV(input_iovec, n_input_iovec, UNIQ_T(c, UNIQ))