1 /* SPDX-License-Identifier: LGPL-2.1+ */
11 /* Some structures we reference but don't want to pull in headers for */
13 struct signalfd_siginfo
;
15 typedef enum LogRealm
{
22 # define LOG_REALM LOG_REALM_SYSTEMD
25 typedef enum LogTarget
{
27 LOG_TARGET_CONSOLE_PREFIXED
,
30 LOG_TARGET_JOURNAL_OR_KMSG
,
32 LOG_TARGET_SYSLOG_OR_KMSG
,
33 LOG_TARGET_AUTO
, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */
36 _LOG_TARGET_INVALID
= -1
39 #define LOG_REALM_PLUS_LEVEL(realm, level) \
40 ((realm) << 10 | (level))
41 #define LOG_REALM_REMOVE_LEVEL(realm_level) \
44 void log_set_target(LogTarget target
);
45 void log_set_max_level_realm(LogRealm realm
, int level
);
46 #define log_set_max_level(level) \
47 log_set_max_level_realm(LOG_REALM, (level))
49 void log_set_facility(int facility
);
51 int log_set_target_from_string(const char *e
);
52 int log_set_max_level_from_string_realm(LogRealm realm
, const char *e
);
53 #define log_set_max_level_from_string(e) \
54 log_set_max_level_from_string_realm(LOG_REALM, (e))
56 void log_show_color(bool b
);
57 bool log_get_show_color(void) _pure_
;
58 void log_show_location(bool b
);
59 bool log_get_show_location(void) _pure_
;
61 int log_show_color_from_string(const char *e
);
62 int log_show_location_from_string(const char *e
);
64 LogTarget
log_get_target(void) _pure_
;
65 int log_get_max_level_realm(LogRealm realm
) _pure_
;
66 #define log_get_max_level() \
67 log_get_max_level_realm(LOG_REALM)
69 /* Functions below that open and close logs or configure logging based on the
70 * environment should not be called from library code — this is always a job
71 * for the application itself.
76 void log_forget_fds(void);
78 void log_parse_environment_realm(LogRealm realm
);
79 #define log_parse_environment() \
80 log_parse_environment_realm(LOG_REALM)
82 int log_dispatch_internal(
88 const char *object_field
,
91 const char *extra_field
,
94 int log_internal_realm(
100 const char *format
, ...) _printf_(6,7);
101 #define log_internal(level, ...) \
102 log_internal_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
104 int log_internalv_realm(
111 va_list ap
) _printf_(6,0);
112 #define log_internalv(level, ...) \
113 log_internalv_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
115 /* Realm is fixed to LOG_REALM_SYSTEMD for those */
116 int log_object_internal(
122 const char *object_field
,
124 const char *extra_field
,
126 const char *format
, ...) _printf_(10,11);
128 int log_struct_internal(
134 const char *format
, ...) _printf_(6,0) _sentinel_
;
136 int log_oom_internal(
142 int log_format_iovec(
146 bool newline_separator
,
149 va_list ap
) _printf_(6, 0);
151 int log_struct_iovec_internal(
157 const struct iovec
*input_iovec
,
158 size_t n_input_iovec
);
160 /* This modifies the buffer passed! */
161 int log_dump_internal(
169 /* Logging for various assertions */
170 _noreturn_
void log_assert_failed_realm(
176 #define log_assert_failed(text, ...) \
177 log_assert_failed_realm(LOG_REALM, (text), __VA_ARGS__)
179 _noreturn_
void log_assert_failed_unreachable_realm(
185 #define log_assert_failed_unreachable(text, ...) \
186 log_assert_failed_unreachable_realm(LOG_REALM, (text), __VA_ARGS__)
188 void log_assert_failed_return_realm(
194 #define log_assert_failed_return(text, ...) \
195 log_assert_failed_return_realm(LOG_REALM, (text), __VA_ARGS__)
197 #define log_dispatch(level, error, buffer) \
198 log_dispatch_internal(level, error, __FILE__, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer)
200 /* Logging with level */
201 #define log_full_errno_realm(realm, level, error, ...) \
203 int _level = (level), _e = (error), _realm = (realm); \
204 (log_get_max_level_realm(_realm) >= LOG_PRI(_level)) \
205 ? log_internal_realm(LOG_REALM_PLUS_LEVEL(_realm, _level), _e, \
206 __FILE__, __LINE__, __func__, __VA_ARGS__) \
210 #define log_full_errno(level, error, ...) \
211 log_full_errno_realm(LOG_REALM, (level), (error), __VA_ARGS__)
213 #define log_full(level, ...) log_full_errno((level), 0, __VA_ARGS__)
215 int log_emergency_level(void);
218 #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__)
219 #define log_info(...) log_full(LOG_INFO, __VA_ARGS__)
220 #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__)
221 #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__)
222 #define log_error(...) log_full(LOG_ERR, __VA_ARGS__)
223 #define log_emergency(...) log_full(log_emergency_level(), __VA_ARGS__)
225 /* Logging triggered by an errno-like error */
226 #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__)
227 #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__)
228 #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__)
229 #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__)
230 #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__)
231 #define log_emergency_errno(error, ...) log_full_errno(log_emergency_level(), error, __VA_ARGS__)
234 # define log_trace(...) log_debug(__VA_ARGS__)
236 # define log_trace(...) do {} while (0)
239 /* Structured logging */
240 #define log_struct_errno(level, error, ...) \
241 log_struct_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
242 error, __FILE__, __LINE__, __func__, __VA_ARGS__, NULL)
243 #define log_struct(level, ...) log_struct_errno(level, 0, __VA_ARGS__)
245 #define log_struct_iovec_errno(level, error, iovec, n_iovec) \
246 log_struct_iovec_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
247 error, __FILE__, __LINE__, __func__, iovec, n_iovec)
248 #define log_struct_iovec(level, iovec, n_iovec) log_struct_iovec_errno(level, 0, iovec, n_iovec)
250 /* This modifies the buffer passed! */
251 #define log_dump(level, buffer) \
252 log_dump_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
253 0, __FILE__, __LINE__, __func__, buffer)
255 #define log_oom() log_oom_internal(LOG_REALM, __FILE__, __LINE__, __func__)
257 bool log_on_console(void) _pure_
;
259 const char *log_target_to_string(LogTarget target
) _const_
;
260 LogTarget
log_target_from_string(const char *s
) _pure_
;
262 /* Helper to prepare various field for structured logging */
263 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
265 void log_received_signal(int level
, const struct signalfd_siginfo
*si
);
267 /* If turned on, any requests for a log target involving "syslog" will be implicitly upgraded to the equivalent journal target */
268 void log_set_upgrade_syslog_to_journal(bool b
);
270 /* If turned on, and log_open() is called, we'll not use STDERR_FILENO for logging ever, but rather open /dev/console */
271 void log_set_always_reopen_console(bool b
);
273 /* If turned on, we'll open the log stream implicitly if needed on each individual log call. This is normally not
274 * desired as we want to reuse our logging streams. It is useful however */
275 void log_set_open_when_needed(bool b
);
277 /* 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
278 * stderr, the console or kmsg */
279 void log_set_prohibit_ipc(bool b
);
281 int log_dup_console(void);
283 int log_syntax_internal(
286 const char *config_file
,
287 unsigned config_line
,
292 const char *format
, ...) _printf_(9, 10);
294 int log_syntax_invalid_utf8_internal(
297 const char *config_file
,
298 unsigned config_line
,
304 #define log_syntax(unit, level, config_file, config_line, error, ...) \
306 int _level = (level), _e = (error); \
307 (log_get_max_level() >= LOG_PRI(_level)) \
308 ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
312 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
314 int _level = (level); \
315 (log_get_max_level() >= LOG_PRI(_level)) \
316 ? log_syntax_invalid_utf8_internal(unit, _level, config_file, config_line, __FILE__, __LINE__, __func__, rvalue) \
320 #define DEBUG_LOGGING _unlikely_(log_get_max_level() >= LOG_DEBUG)