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);
84 const char *format
, ...) _printf_(6,7);
93 va_list ap
) _printf_(6,0);
95 int log_object_internal(
101 const char *object_field
,
103 const char *extra_field
,
105 const char *format
, ...) _printf_(10,11);
107 int log_object_internalv(
113 const char *object_field
,
115 const char *extra_field
,
118 va_list ap
) _printf_(9,0);
120 int log_struct_internal(
126 const char *format
, ...) _printf_(6,0) _sentinel_
;
128 int log_oom_internal(
133 int log_format_iovec(
137 bool newline_separator
,
142 /* This modifies the buffer passed! */
143 int log_dump_internal(
151 /* Logging for various assertions */
152 noreturn
void log_assert_failed(
158 noreturn
void log_assert_failed_unreachable(
164 void log_assert_failed_return(
170 /* Logging with level */
171 #define log_full_errno(level, error, ...) \
173 int _level = (level), _e = (error); \
174 (log_get_max_level() >= LOG_PRI(_level)) \
175 ? log_internal(_level, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
179 #define log_full(level, ...) log_full_errno(level, 0, __VA_ARGS__)
182 #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__)
183 #define log_info(...) log_full(LOG_INFO, __VA_ARGS__)
184 #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__)
185 #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__)
186 #define log_error(...) log_full(LOG_ERR, __VA_ARGS__)
187 #define log_emergency(...) log_full(getpid() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
189 /* Logging triggered by an errno-like error */
190 #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__)
191 #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__)
192 #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__)
193 #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__)
194 #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__)
195 #define log_emergency_errno(error, ...) log_full_errno(getpid() == 1 ? LOG_EMERG : LOG_ERR, error, __VA_ARGS__)
198 # define log_trace(...) log_debug(__VA_ARGS__)
200 # define log_trace(...) do {} while (0)
203 /* Structured logging */
204 #define log_struct(level, ...) log_struct_internal(level, 0, __FILE__, __LINE__, __func__, __VA_ARGS__)
205 #define log_struct_errno(level, error, ...) log_struct_internal(level, error, __FILE__, __LINE__, __func__, __VA_ARGS__)
207 /* This modifies the buffer passed! */
208 #define log_dump(level, buffer) log_dump_internal(level, 0, __FILE__, __LINE__, __func__, buffer)
210 #define log_oom() log_oom_internal(__FILE__, __LINE__, __func__)
212 bool log_on_console(void) _pure_
;
214 const char *log_target_to_string(LogTarget target
) _const_
;
215 LogTarget
log_target_from_string(const char *s
) _pure_
;
217 /* Helpers to prepare various fields for structured logging */
218 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
219 #define LOG_MESSAGE_ID(x) "MESSAGE_ID=" SD_ID128_FORMAT_STR, SD_ID128_FORMAT_VAL(x)
221 void log_received_signal(int level
, const struct signalfd_siginfo
*si
);
223 void log_set_upgrade_syslog_to_journal(bool b
);
225 int log_syntax_internal(
228 const char *config_file
,
229 unsigned config_line
,
234 const char *format
, ...) _printf_(9, 10);
236 #define log_syntax(unit, level, config_file, config_line, error, ...) \
238 int _level = (level), _e = (error); \
239 (log_get_max_level() >= LOG_PRI(_level)) \
240 ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
244 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
246 int _level = (level); \
247 if (log_get_max_level() >= LOG_PRI(_level)) { \
248 _cleanup_free_ char *_p = NULL; \
249 _p = utf8_escape_invalid(rvalue); \
250 log_syntax_internal(unit, _level, config_file, config_line, 0, __FILE__, __LINE__, __func__, \
251 "String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \