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 #if 0 /// UNNEEDED by elogind
77 void log_forget_fds(void);
80 void log_parse_environment_realm(LogRealm realm);
81 #define log_parse_environment() \
82 log_parse_environment_realm(LOG_REALM)
84 int log_dispatch_internal(
90 const char *object_field,
93 const char *extra_field,
96 int log_internal_realm(
102 const char *format, ...) _printf_(6,7);
103 #define log_internal(level, ...) \
104 log_internal_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
106 int log_internalv_realm(
113 va_list ap) _printf_(6,0);
114 #define log_internalv(level, ...) \
115 log_internalv_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
117 /* Realm is fixed to LOG_REALM_SYSTEMD for those */
118 int log_object_internal(
124 const char *object_field,
126 const char *extra_field,
128 const char *format, ...) _printf_(10,11);
130 int log_struct_internal(
136 const char *format, ...) _printf_(6,0) _sentinel_;
138 int log_oom_internal(
144 int log_format_iovec(
148 bool newline_separator,
151 va_list ap) _printf_(6, 0);
153 int log_struct_iovec_internal(
159 const struct iovec *input_iovec,
160 size_t n_input_iovec);
162 /* This modifies the buffer passed! */
163 int log_dump_internal(
171 /* Logging for various assertions */
172 _noreturn_ void log_assert_failed_realm(
178 #define log_assert_failed(text, ...) \
179 log_assert_failed_realm(LOG_REALM, (text), __VA_ARGS__)
181 _noreturn_ void log_assert_failed_unreachable_realm(
187 #define log_assert_failed_unreachable(text, ...) \
188 log_assert_failed_unreachable_realm(LOG_REALM, (text), __VA_ARGS__)
190 void log_assert_failed_return_realm(
196 #define log_assert_failed_return(text, ...) \
197 log_assert_failed_return_realm(LOG_REALM, (text), __VA_ARGS__)
199 #define log_dispatch(level, error, buffer) \
200 log_dispatch_internal(level, error, __FILE__, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer)
202 /* Logging with level */
203 #define log_full_errno_realm(realm, level, error, ...) \
205 int _level = (level), _e = (error), _realm = (realm); \
206 (log_get_max_level_realm(_realm) >= LOG_PRI(_level)) \
207 ? log_internal_realm(LOG_REALM_PLUS_LEVEL(_realm, _level), _e, \
208 __FILE__, __LINE__, __func__, __VA_ARGS__) \
212 #define log_full_errno(level, error, ...) \
213 log_full_errno_realm(LOG_REALM, (level), (error), __VA_ARGS__)
215 #define log_full(level, ...) log_full_errno((level), 0, __VA_ARGS__)
217 int log_emergency_level(void);
220 #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__)
221 #define log_info(...) log_full(LOG_INFO, __VA_ARGS__)
222 #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__)
223 #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__)
224 #define log_error(...) log_full(LOG_ERR, __VA_ARGS__)
225 #define log_emergency(...) log_full(log_emergency_level(), __VA_ARGS__)
227 /* Logging triggered by an errno-like error */
228 #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__)
229 #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__)
230 #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__)
231 #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__)
232 #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__)
233 #define log_emergency_errno(error, ...) log_full_errno(log_emergency_level(), error, __VA_ARGS__)
236 # define log_trace(...) log_debug(__VA_ARGS__)
238 # define log_trace(...) do {} while (0)
241 #if ENABLE_DEBUG_ELOGIND
242 # define log_debug_elogind(...) log_debug(__VA_ARGS__);usleep(25*USEC_PER_MSEC)
244 # define log_debug_elogind(...) do {} while (0)
245 #endif // ENABLE_DEBUG_ELOGIND
246 /* Structured logging */
247 #define log_struct_errno(level, error, ...) \
248 log_struct_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
249 error, __FILE__, __LINE__, __func__, __VA_ARGS__)
250 error, __FILE__, __LINE__, __func__, __VA_ARGS__, NULL)
251 #define log_struct(level, ...) log_struct_errno(level, 0, __VA_ARGS__)
253 #define log_struct_iovec_errno(level, error, iovec, n_iovec) \
254 log_struct_iovec_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
255 error, __FILE__, __LINE__, __func__, iovec, n_iovec)
256 #define log_struct_iovec(level, iovec, n_iovec) log_struct_iovec_errno(level, 0, iovec, n_iovec)
258 /* This modifies the buffer passed! */
259 #define log_dump(level, buffer) \
260 log_dump_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
261 0, __FILE__, __LINE__, __func__, buffer)
263 #define log_oom() log_oom_internal(LOG_REALM, __FILE__, __LINE__, __func__)
265 bool log_on_console(void) _pure_;
267 const char *log_target_to_string(LogTarget target) _const_;
268 LogTarget log_target_from_string(const char *s) _pure_;
270 /* Helper to prepare various field for structured logging */
271 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
273 #if 0 /// UNNEEDED by elogind
274 void log_received_signal(int level, const struct signalfd_siginfo *si);
276 /* If turned on, any requests for a log target involving "syslog" will be implicitly upgraded to the equivalent journal target */
277 void log_set_upgrade_syslog_to_journal(bool b);
279 /* If turned on, and log_open() is called, we'll not use STDERR_FILENO for logging ever, but rather open /dev/console */
280 void log_set_always_reopen_console(bool b);
283 /* If turned on, we'll open the log stream implicitly if needed on each individual log call. This is normally not
284 * desired as we want to reuse our logging streams. It is useful however */
285 void log_set_open_when_needed(bool b);
287 /* 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
288 * stderr, the console or kmsg */
289 void log_set_prohibit_ipc(bool b);
291 int log_dup_console(void);
293 int log_syntax_internal(
296 const char *config_file,
297 unsigned config_line,
302 const char *format, ...) _printf_(9, 10);
304 int log_syntax_invalid_utf8_internal(
307 const char *config_file,
308 unsigned config_line,
314 #define log_syntax(unit, level, config_file, config_line, error, ...) \
316 int _level = (level), _e = (error); \
317 (log_get_max_level() >= LOG_PRI(_level)) \
318 ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
322 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
324 int _level = (level); \
325 (log_get_max_level() >= LOG_PRI(_level)) \
326 ? log_syntax_invalid_utf8_internal(unit, _level, config_file, config_line, __FILE__, __LINE__, __func__, rvalue) \
330 #define DEBUG_LOGGING _unlikely_(log_get_max_level() >= LOG_DEBUG)