1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 #include <sys/signalfd.h>
35 typedef enum LogTarget{
37 LOG_TARGET_CONSOLE_PREFIXED,
39 /// elogind does not support logging to systemd-journald
42 LOG_TARGET_JOURNAL_OR_KMSG,
45 LOG_TARGET_SYSLOG_OR_KMSG,
46 LOG_TARGET_AUTO, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */
47 LOG_TARGET_SAFE, /* console if stderr is tty, KMSG otherwise */
50 _LOG_TARGET_INVALID = -1
53 void log_set_target(LogTarget target);
54 void log_set_max_level(int level);
55 void log_set_facility(int facility);
57 int log_set_target_from_string(const char *e);
58 int log_set_max_level_from_string(const char *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(void) _pure_;
73 // UNNEEDED void log_forget_fds(void);
75 void log_close_syslog(void);
76 // UNNEEDED void log_close_journal(void);
77 void log_close_kmsg(void);
78 void log_close_console(void);
80 void log_parse_environment(void);
88 const char *format, ...) _printf_(6,7);
97 va_list ap) _printf_(6,0);
99 int log_object_internal(
105 const char *object_field,
107 const char *format, ...) _printf_(8,9);
109 int log_object_internalv(
115 const char *object_field,
118 va_list ap) _printf_(8,0);
120 int log_struct_internal(
126 const char *format, ...) _printf_(6,0) _sentinel_;
128 int log_oom_internal(
133 /* This modifies the buffer passed! */
134 int log_dump_internal(
142 /* Logging for various assertions */
143 noreturn void log_assert_failed(
149 noreturn void log_assert_failed_unreachable(
155 void log_assert_failed_return(
161 /* Logging with level */
162 #define log_full_errno(level, error, ...) \
164 int _level = (level), _e = (error); \
165 (log_get_max_level() >= LOG_PRI(_level)) \
166 ? log_internal(_level, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
170 #define log_full(level, ...) log_full_errno(level, 0, __VA_ARGS__)
173 #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__)
174 #define log_info(...) log_full(LOG_INFO, __VA_ARGS__)
175 #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__)
176 #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__)
177 #define log_error(...) log_full(LOG_ERR, __VA_ARGS__)
178 #define log_emergency(...) log_full(getpid() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
180 /* Logging triggered by an errno-like error */
181 #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__)
182 #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__)
183 #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__)
184 #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__)
185 #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__)
186 #define log_emergency_errno(error, ...) log_full_errno(getpid() == 1 ? LOG_EMERG : LOG_ERR, error, __VA_ARGS__)
189 # define log_trace(...) log_debug(__VA_ARGS__)
191 # define log_trace(...) do {} while(0)
194 #ifdef ENABLE_DEBUG_ELOGIND
195 # define log_debug_elogind(...) log_debug(__VA_ARGS__);usleep(25*USEC_PER_MSEC)
197 # define log_debug_elogind(...) do {} while(0)
198 #endif // ENABLE_DEBUG_ELOGIND
200 /* Structured logging */
201 #define log_struct(level, ...) log_struct_internal(level, 0, __FILE__, __LINE__, __func__, __VA_ARGS__)
202 #define log_struct_errno(level, error, ...) log_struct_internal(level, error, __FILE__, __LINE__, __func__, __VA_ARGS__)
204 /* This modifies the buffer passed! */
205 #define log_dump(level, buffer) log_dump_internal(level, 0, __FILE__, __LINE__, __func__, buffer)
207 #define log_oom() log_oom_internal(__FILE__, __LINE__, __func__)
209 bool log_on_console(void) _pure_;
211 const char *log_target_to_string(LogTarget target) _const_;
212 LogTarget log_target_from_string(const char *s) _pure_;
214 /* Helpers to prepare various fields for structured logging */
215 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
216 #define LOG_MESSAGE_ID(x) "MESSAGE_ID=" SD_ID128_FORMAT_STR, SD_ID128_FORMAT_VAL(x)
218 // UNNEEDED void log_received_signal(int level, const struct signalfd_siginfo *si);
220 // UNNEEDED void log_set_upgrade_syslog_to_journal(bool b);
222 int log_syntax_internal(
225 const char *config_file,
226 unsigned config_line,
231 const char *format, ...) _printf_(9, 10);
233 #define log_syntax(unit, level, config_file, config_line, error, ...) \
235 int _level = (level), _e = (error); \
236 (log_get_max_level() >= LOG_PRI(_level)) \
237 ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
241 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
243 int _level = (level); \
244 if (log_get_max_level() >= LOG_PRI(_level)) { \
245 _cleanup_free_ char *_p = NULL; \
246 _p = utf8_escape_invalid(rvalue); \
247 log_syntax_internal(unit, _level, config_file, config_line, 0, __FILE__, __LINE__, __func__, \
248 "String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \