1 /* SPDX-License-Identifier: LGPL-2.1+ */
5 This file is part of systemd.
7 Copyright 2010 Lennart Poettering
17 /* Some structures we reference but don't want to pull in headers for */
19 struct signalfd_siginfo
;
21 typedef enum LogRealm
{
28 # define LOG_REALM LOG_REALM_SYSTEMD
31 typedef enum LogTarget
{
33 LOG_TARGET_CONSOLE_PREFIXED
,
36 LOG_TARGET_JOURNAL_OR_KMSG
,
38 LOG_TARGET_SYSLOG_OR_KMSG
,
39 LOG_TARGET_AUTO
, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */
42 _LOG_TARGET_INVALID
= -1
45 #define LOG_REALM_PLUS_LEVEL(realm, level) \
46 ((realm) << 10 | (level))
47 #define LOG_REALM_REMOVE_LEVEL(realm_level) \
50 void log_set_target(LogTarget target
);
51 void log_set_max_level_realm(LogRealm realm
, int level
);
52 #define log_set_max_level(level) \
53 log_set_max_level_realm(LOG_REALM, (level))
55 void log_set_facility(int facility
);
57 int log_set_target_from_string(const char *e
);
58 int log_set_max_level_from_string_realm(LogRealm realm
, const char *e
);
59 #define log_set_max_level_from_string(e) \
60 log_set_max_level_from_string_realm(LOG_REALM, (e))
62 void log_show_color(bool b
);
63 bool log_get_show_color(void) _pure_
;
64 void log_show_location(bool b
);
65 bool log_get_show_location(void) _pure_
;
67 int log_show_color_from_string(const char *e
);
68 int log_show_location_from_string(const char *e
);
70 LogTarget
log_get_target(void) _pure_
;
71 int log_get_max_level_realm(LogRealm realm
) _pure_
;
72 #define log_get_max_level() \
73 log_get_max_level_realm(LOG_REALM)
75 /* Functions below that open and close logs or configure logging based on the
76 * environment should not be called from library code — this is always a job
77 * for the application itself.
82 void log_forget_fds(void);
84 void log_parse_environment_realm(LogRealm realm
);
85 #define log_parse_environment() \
86 log_parse_environment_realm(LOG_REALM)
88 int log_dispatch_internal(
94 const char *object_field
,
97 const char *extra_field
,
100 int log_internal_realm(
106 const char *format
, ...) _printf_(6,7);
107 #define log_internal(level, ...) \
108 log_internal_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
110 int log_internalv_realm(
117 va_list ap
) _printf_(6,0);
118 #define log_internalv(level, ...) \
119 log_internalv_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
121 /* Realm is fixed to LOG_REALM_SYSTEMD for those */
122 int log_object_internal(
128 const char *object_field
,
130 const char *extra_field
,
132 const char *format
, ...) _printf_(10,11);
134 int log_struct_internal(
140 const char *format
, ...) _printf_(6,0) _sentinel_
;
142 int log_oom_internal(
148 int log_format_iovec(
152 bool newline_separator
,
155 va_list ap
) _printf_(6, 0);
157 int log_struct_iovec_internal(
163 const struct iovec
*input_iovec
,
164 size_t n_input_iovec
);
166 /* This modifies the buffer passed! */
167 int log_dump_internal(
175 /* Logging for various assertions */
176 _noreturn_
void log_assert_failed_realm(
182 #define log_assert_failed(text, ...) \
183 log_assert_failed_realm(LOG_REALM, (text), __VA_ARGS__)
185 _noreturn_
void log_assert_failed_unreachable_realm(
191 #define log_assert_failed_unreachable(text, ...) \
192 log_assert_failed_unreachable_realm(LOG_REALM, (text), __VA_ARGS__)
194 void log_assert_failed_return_realm(
200 #define log_assert_failed_return(text, ...) \
201 log_assert_failed_return_realm(LOG_REALM, (text), __VA_ARGS__)
203 #define log_dispatch(level, error, buffer) \
204 log_dispatch_internal(level, error, __FILE__, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer)
206 /* Logging with level */
207 #define log_full_errno_realm(realm, level, error, ...) \
209 int _level = (level), _e = (error), _realm = (realm); \
210 (log_get_max_level_realm(_realm) >= LOG_PRI(_level)) \
211 ? log_internal_realm(LOG_REALM_PLUS_LEVEL(_realm, _level), _e, \
212 __FILE__, __LINE__, __func__, __VA_ARGS__) \
216 #define log_full_errno(level, error, ...) \
217 log_full_errno_realm(LOG_REALM, (level), (error), __VA_ARGS__)
219 #define log_full(level, ...) log_full_errno((level), 0, __VA_ARGS__)
221 int log_emergency_level(void);
224 #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__)
225 #define log_info(...) log_full(LOG_INFO, __VA_ARGS__)
226 #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__)
227 #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__)
228 #define log_error(...) log_full(LOG_ERR, __VA_ARGS__)
229 #define log_emergency(...) log_full(log_emergency_level(), __VA_ARGS__)
231 /* Logging triggered by an errno-like error */
232 #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__)
233 #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__)
234 #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__)
235 #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__)
236 #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__)
237 #define log_emergency_errno(error, ...) log_full_errno(log_emergency_level(), error, __VA_ARGS__)
240 # define log_trace(...) log_debug(__VA_ARGS__)
242 # define log_trace(...) do {} while (0)
245 /* Structured logging */
246 #define log_struct_errno(level, error, ...) \
247 log_struct_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
248 error, __FILE__, __LINE__, __func__, __VA_ARGS__)
249 #define log_struct(level, ...) log_struct_errno(level, 0, __VA_ARGS__)
251 #define log_struct_iovec_errno(level, error, iovec, n_iovec) \
252 log_struct_iovec_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
253 error, __FILE__, __LINE__, __func__, iovec, n_iovec)
254 #define log_struct_iovec(level, iovec, n_iovec) log_struct_iovec_errno(level, 0, iovec, n_iovec)
256 /* This modifies the buffer passed! */
257 #define log_dump(level, buffer) \
258 log_dump_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
259 0, __FILE__, __LINE__, __func__, buffer)
261 #define log_oom() log_oom_internal(LOG_REALM, __FILE__, __LINE__, __func__)
263 bool log_on_console(void) _pure_
;
265 const char *log_target_to_string(LogTarget target
) _const_
;
266 LogTarget
log_target_from_string(const char *s
) _pure_
;
268 /* Helper to prepare various field for structured logging */
269 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
271 void log_received_signal(int level
, const struct signalfd_siginfo
*si
);
273 /* If turned on, any requests for a log target involving "syslog" will be implicitly upgraded to the equivalent journal target */
274 void log_set_upgrade_syslog_to_journal(bool b
);
276 /* If turned on, and log_open() is called, we'll not use STDERR_FILENO for logging ever, but rather open /dev/console */
277 void log_set_always_reopen_console(bool b
);
279 /* If turned on, we'll open the log stream implicitly if needed on each individual log call. This is normally not
280 * desired as we want to reuse our logging streams. It is useful however */
281 void log_set_open_when_needed(bool b
);
283 /* 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
284 * stderr, the console or kmsg */
285 void log_set_prohibit_ipc(bool b
);
287 int log_syntax_internal(
290 const char *config_file
,
291 unsigned config_line
,
296 const char *format
, ...) _printf_(9, 10);
298 int log_syntax_invalid_utf8_internal(
301 const char *config_file
,
302 unsigned config_line
,
308 #define log_syntax(unit, level, config_file, config_line, error, ...) \
310 int _level = (level), _e = (error); \
311 (log_get_max_level() >= LOG_PRI(_level)) \
312 ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
316 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
318 int _level = (level); \
319 (log_get_max_level() >= LOG_PRI(_level)) \
320 ? log_syntax_invalid_utf8_internal(unit, _level, config_file, config_line, __FILE__, __LINE__, __func__, rvalue) \
324 #define DEBUG_LOGGING _unlikely_(log_get_max_level() >= LOG_DEBUG)