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>
29 #include <sys/socket.h>
36 typedef enum LogTarget{
38 LOG_TARGET_CONSOLE_PREFIXED,
40 #if 0 /// 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 #if 0 /// UNNEEDED by elogind
74 void log_forget_fds(void);
76 void log_close_syslog(void);
77 #if 0 /// UNNEEDED by elogind
78 void log_close_journal(void);
80 void log_close_kmsg(void);
81 void log_close_console(void);
83 void log_parse_environment(void);
91 const char *format, ...) _printf_(6,7);
100 va_list ap) _printf_(6,0);
102 int log_object_internal(
108 const char *object_field,
110 const char *format, ...) _printf_(8,9);
112 int log_object_internalv(
118 const char *object_field,
121 va_list ap) _printf_(8,0);
123 int log_struct_internal(
129 const char *format, ...) _printf_(6,0) _sentinel_;
131 int log_oom_internal(
136 int log_format_iovec(
140 bool newline_separator,
145 /* This modifies the buffer passed! */
146 int log_dump_internal(
154 /* Logging for various assertions */
155 noreturn void log_assert_failed(
161 noreturn void log_assert_failed_unreachable(
167 void log_assert_failed_return(
173 /* Logging with level */
174 #define log_full_errno(level, error, ...) \
176 int _level = (level), _e = (error); \
177 (log_get_max_level() >= LOG_PRI(_level)) \
178 ? log_internal(_level, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
182 #define log_full(level, ...) log_full_errno(level, 0, __VA_ARGS__)
185 #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__)
186 #define log_info(...) log_full(LOG_INFO, __VA_ARGS__)
187 #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__)
188 #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__)
189 #define log_error(...) log_full(LOG_ERR, __VA_ARGS__)
190 #define log_emergency(...) log_full(getpid() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
192 /* Logging triggered by an errno-like error */
193 #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__)
194 #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__)
195 #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__)
196 #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__)
197 #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__)
198 #define log_emergency_errno(error, ...) log_full_errno(getpid() == 1 ? LOG_EMERG : LOG_ERR, error, __VA_ARGS__)
201 # define log_trace(...) log_debug(__VA_ARGS__)
203 # define log_trace(...) do {} while(0)
206 #ifdef ENABLE_DEBUG_ELOGIND
207 # define log_debug_elogind(...) log_debug(__VA_ARGS__);usleep(25*USEC_PER_MSEC)
209 # define log_debug_elogind(...) do {} while(0)
210 #endif // ENABLE_DEBUG_ELOGIND
212 /* Structured logging */
213 #define log_struct(level, ...) log_struct_internal(level, 0, __FILE__, __LINE__, __func__, __VA_ARGS__)
214 #define log_struct_errno(level, error, ...) log_struct_internal(level, error, __FILE__, __LINE__, __func__, __VA_ARGS__)
216 /* This modifies the buffer passed! */
217 #define log_dump(level, buffer) log_dump_internal(level, 0, __FILE__, __LINE__, __func__, buffer)
219 #define log_oom() log_oom_internal(__FILE__, __LINE__, __func__)
221 bool log_on_console(void) _pure_;
223 const char *log_target_to_string(LogTarget target) _const_;
224 LogTarget log_target_from_string(const char *s) _pure_;
226 /* Helpers to prepare various fields for structured logging */
227 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
228 #define LOG_MESSAGE_ID(x) "MESSAGE_ID=" SD_ID128_FORMAT_STR, SD_ID128_FORMAT_VAL(x)
230 #if 0 /// UNNEEDED by elogind
231 void log_received_signal(int level, const struct signalfd_siginfo *si);
233 void log_set_upgrade_syslog_to_journal(bool b);
236 int log_syntax_internal(
239 const char *config_file,
240 unsigned config_line,
245 const char *format, ...) _printf_(9, 10);
247 #define log_syntax(unit, level, config_file, config_line, error, ...) \
249 int _level = (level), _e = (error); \
250 (log_get_max_level() >= LOG_PRI(_level)) \
251 ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
255 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
257 int _level = (level); \
258 if (log_get_max_level() >= LOG_PRI(_level)) { \
259 _cleanup_free_ char *_p = NULL; \
260 _p = utf8_escape_invalid(rvalue); \
261 log_syntax_internal(unit, _level, config_file, config_line, 0, __FILE__, __LINE__, __func__, \
262 "String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \