1 /* SPDX-License-Identifier: LGPL-2.1+ */
5 Copyright 2010 Lennart Poettering
15 /* Some structures we reference but don't want to pull in headers for */
17 struct signalfd_siginfo
;
19 typedef enum LogRealm
{
26 # define LOG_REALM LOG_REALM_SYSTEMD
29 typedef enum LogTarget
{
31 LOG_TARGET_CONSOLE_PREFIXED
,
34 LOG_TARGET_JOURNAL_OR_KMSG
,
36 LOG_TARGET_SYSLOG_OR_KMSG
,
37 LOG_TARGET_AUTO
, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */
40 _LOG_TARGET_INVALID
= -1
43 #define LOG_REALM_PLUS_LEVEL(realm, level) \
44 ((realm) << 10 | (level))
45 #define LOG_REALM_REMOVE_LEVEL(realm_level) \
48 void log_set_target(LogTarget target
);
49 void log_set_max_level_realm(LogRealm realm
, int level
);
50 #define log_set_max_level(level) \
51 log_set_max_level_realm(LOG_REALM, (level))
53 void log_set_facility(int facility
);
55 int log_set_target_from_string(const char *e
);
56 int log_set_max_level_from_string_realm(LogRealm realm
, const char *e
);
57 #define log_set_max_level_from_string(e) \
58 log_set_max_level_from_string_realm(LOG_REALM, (e))
60 void log_show_color(bool b
);
61 bool log_get_show_color(void) _pure_
;
62 void log_show_location(bool b
);
63 bool log_get_show_location(void) _pure_
;
65 int log_show_color_from_string(const char *e
);
66 int log_show_location_from_string(const char *e
);
68 LogTarget
log_get_target(void) _pure_
;
69 int log_get_max_level_realm(LogRealm realm
) _pure_
;
70 #define log_get_max_level() \
71 log_get_max_level_realm(LOG_REALM)
73 /* Functions below that open and close logs or configure logging based on the
74 * environment should not be called from library code — this is always a job
75 * for the application itself.
80 void log_forget_fds(void);
82 void log_parse_environment_realm(LogRealm realm
);
83 #define log_parse_environment() \
84 log_parse_environment_realm(LOG_REALM)
86 int log_dispatch_internal(
92 const char *object_field
,
95 const char *extra_field
,
98 int log_internal_realm(
104 const char *format
, ...) _printf_(6,7);
105 #define log_internal(level, ...) \
106 log_internal_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
108 int log_internalv_realm(
115 va_list ap
) _printf_(6,0);
116 #define log_internalv(level, ...) \
117 log_internalv_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
119 /* Realm is fixed to LOG_REALM_SYSTEMD for those */
120 int log_object_internal(
126 const char *object_field
,
128 const char *extra_field
,
130 const char *format
, ...) _printf_(10,11);
132 int log_struct_internal(
138 const char *format
, ...) _printf_(6,0) _sentinel_
;
140 int log_oom_internal(
146 int log_format_iovec(
150 bool newline_separator
,
153 va_list ap
) _printf_(6, 0);
155 int log_struct_iovec_internal(
161 const struct iovec
*input_iovec
,
162 size_t n_input_iovec
);
164 /* This modifies the buffer passed! */
165 int log_dump_internal(
173 /* Logging for various assertions */
174 _noreturn_
void log_assert_failed_realm(
180 #define log_assert_failed(text, ...) \
181 log_assert_failed_realm(LOG_REALM, (text), __VA_ARGS__)
183 _noreturn_
void log_assert_failed_unreachable_realm(
189 #define log_assert_failed_unreachable(text, ...) \
190 log_assert_failed_unreachable_realm(LOG_REALM, (text), __VA_ARGS__)
192 void log_assert_failed_return_realm(
198 #define log_assert_failed_return(text, ...) \
199 log_assert_failed_return_realm(LOG_REALM, (text), __VA_ARGS__)
201 #define log_dispatch(level, error, buffer) \
202 log_dispatch_internal(level, error, __FILE__, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer)
204 /* Logging with level */
205 #define log_full_errno_realm(realm, level, error, ...) \
207 int _level = (level), _e = (error), _realm = (realm); \
208 (log_get_max_level_realm(_realm) >= LOG_PRI(_level)) \
209 ? log_internal_realm(LOG_REALM_PLUS_LEVEL(_realm, _level), _e, \
210 __FILE__, __LINE__, __func__, __VA_ARGS__) \
214 #define log_full_errno(level, error, ...) \
215 log_full_errno_realm(LOG_REALM, (level), (error), __VA_ARGS__)
217 #define log_full(level, ...) log_full_errno((level), 0, __VA_ARGS__)
219 int log_emergency_level(void);
222 #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__)
223 #define log_info(...) log_full(LOG_INFO, __VA_ARGS__)
224 #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__)
225 #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__)
226 #define log_error(...) log_full(LOG_ERR, __VA_ARGS__)
227 #define log_emergency(...) log_full(log_emergency_level(), __VA_ARGS__)
229 /* Logging triggered by an errno-like error */
230 #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__)
231 #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__)
232 #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__)
233 #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__)
234 #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__)
235 #define log_emergency_errno(error, ...) log_full_errno(log_emergency_level(), error, __VA_ARGS__)
238 # define log_trace(...) log_debug(__VA_ARGS__)
240 # define log_trace(...) do {} while (0)
243 /* Structured logging */
244 #define log_struct_errno(level, error, ...) \
245 log_struct_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
246 error, __FILE__, __LINE__, __func__, __VA_ARGS__, NULL)
247 #define log_struct(level, ...) log_struct_errno(level, 0, __VA_ARGS__)
249 #define log_struct_iovec_errno(level, error, iovec, n_iovec) \
250 log_struct_iovec_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
251 error, __FILE__, __LINE__, __func__, iovec, n_iovec)
252 #define log_struct_iovec(level, iovec, n_iovec) log_struct_iovec_errno(level, 0, iovec, n_iovec)
254 /* This modifies the buffer passed! */
255 #define log_dump(level, buffer) \
256 log_dump_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
257 0, __FILE__, __LINE__, __func__, buffer)
259 #define log_oom() log_oom_internal(LOG_REALM, __FILE__, __LINE__, __func__)
261 bool log_on_console(void) _pure_
;
263 const char *log_target_to_string(LogTarget target
) _const_
;
264 LogTarget
log_target_from_string(const char *s
) _pure_
;
266 /* Helper to prepare various field for structured logging */
267 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
269 void log_received_signal(int level
, const struct signalfd_siginfo
*si
);
271 /* If turned on, any requests for a log target involving "syslog" will be implicitly upgraded to the equivalent journal target */
272 void log_set_upgrade_syslog_to_journal(bool b
);
274 /* If turned on, and log_open() is called, we'll not use STDERR_FILENO for logging ever, but rather open /dev/console */
275 void log_set_always_reopen_console(bool b
);
277 /* If turned on, we'll open the log stream implicitly if needed on each individual log call. This is normally not
278 * desired as we want to reuse our logging streams. It is useful however */
279 void log_set_open_when_needed(bool b
);
281 /* 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
282 * stderr, the console or kmsg */
283 void log_set_prohibit_ipc(bool b
);
285 int log_dup_console(void);
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)