4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
26 #include <sys/signalfd.h>
27 #include <sys/socket.h>
34 typedef enum LogTarget
{
36 LOG_TARGET_CONSOLE_PREFIXED
,
39 LOG_TARGET_JOURNAL_OR_KMSG
,
41 LOG_TARGET_SYSLOG_OR_KMSG
,
42 LOG_TARGET_AUTO
, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */
43 LOG_TARGET_SAFE
, /* console if stderr is tty, KMSG otherwise */
46 _LOG_TARGET_INVALID
= -1
49 void log_set_target(LogTarget target
);
50 void log_set_max_level(int level
);
51 void log_set_facility(int facility
);
53 int log_set_target_from_string(const char *e
);
54 int log_set_max_level_from_string(const char *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(void) _pure_
;
69 void log_forget_fds(void);
71 void log_close_syslog(void);
72 void log_close_journal(void);
73 void log_close_kmsg(void);
74 void log_close_console(void);
76 void log_parse_environment(void);
78 int log_dispatch_internal(
84 const char *object_field
,
87 const char *extra_field
,
96 const char *format
, ...) _printf_(6,7);
105 va_list ap
) _printf_(6,0);
107 int log_object_internal(
113 const char *object_field
,
115 const char *extra_field
,
117 const char *format
, ...) _printf_(10,11);
119 int log_object_internalv(
125 const char *object_field
,
127 const char *extra_field
,
130 va_list ap
) _printf_(10,0);
132 int log_struct_internal(
138 const char *format
, ...) _printf_(6,0) _sentinel_
;
140 int log_oom_internal(
145 int log_format_iovec(
149 bool newline_separator
,
152 va_list ap
) _printf_(6, 0);
154 /* This modifies the buffer passed! */
155 int log_dump_internal(
163 /* Logging for various assertions */
164 noreturn
void log_assert_failed(
170 noreturn
void log_assert_failed_unreachable(
176 void log_assert_failed_return(
182 #define log_dispatch(level, error, buffer) \
183 log_dispatch_internal(level, error, __FILE__, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer)
185 /* Logging with level */
186 #define log_full_errno(level, error, ...) \
188 int _level = (level), _e = (error); \
189 (log_get_max_level() >= LOG_PRI(_level)) \
190 ? log_internal(_level, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
194 #define log_full(level, ...) log_full_errno(level, 0, __VA_ARGS__)
197 #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__)
198 #define log_info(...) log_full(LOG_INFO, __VA_ARGS__)
199 #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__)
200 #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__)
201 #define log_error(...) log_full(LOG_ERR, __VA_ARGS__)
202 #define log_emergency(...) log_full(getpid() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
204 /* Logging triggered by an errno-like error */
205 #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__)
206 #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__)
207 #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__)
208 #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__)
209 #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__)
210 #define log_emergency_errno(error, ...) log_full_errno(getpid() == 1 ? LOG_EMERG : LOG_ERR, error, __VA_ARGS__)
213 # define log_trace(...) log_debug(__VA_ARGS__)
215 # define log_trace(...) do {} while (0)
218 /* Structured logging */
219 #define log_struct(level, ...) log_struct_internal(level, 0, __FILE__, __LINE__, __func__, __VA_ARGS__)
220 #define log_struct_errno(level, error, ...) log_struct_internal(level, error, __FILE__, __LINE__, __func__, __VA_ARGS__)
222 /* This modifies the buffer passed! */
223 #define log_dump(level, buffer) log_dump_internal(level, 0, __FILE__, __LINE__, __func__, buffer)
225 #define log_oom() log_oom_internal(__FILE__, __LINE__, __func__)
227 bool log_on_console(void) _pure_
;
229 const char *log_target_to_string(LogTarget target
) _const_
;
230 LogTarget
log_target_from_string(const char *s
) _pure_
;
232 /* Helper to prepare various field for structured logging */
233 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
235 void log_received_signal(int level
, const struct signalfd_siginfo
*si
);
237 void log_set_upgrade_syslog_to_journal(bool b
);
238 void log_set_always_reopen_console(bool b
);
240 int log_syntax_internal(
243 const char *config_file
,
244 unsigned config_line
,
249 const char *format
, ...) _printf_(9, 10);
251 #define log_syntax(unit, level, config_file, config_line, error, ...) \
253 int _level = (level), _e = (error); \
254 (log_get_max_level() >= LOG_PRI(_level)) \
255 ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
259 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
261 int _level = (level); \
262 if (log_get_max_level() >= LOG_PRI(_level)) { \
263 _cleanup_free_ char *_p = NULL; \
264 _p = utf8_escape_invalid(rvalue); \
265 log_syntax_internal(unit, _level, config_file, config_line, 0, __FILE__, __LINE__, __func__, \
266 "String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \