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 #if 0 /// UNNEEDED by elogind
70 void log_forget_fds(void);
73 void log_close_syslog(void);
74 void log_close_journal(void);
75 void log_close_kmsg(void);
76 void log_close_console(void);
78 void log_parse_environment(void);
86 const char *format, ...) _printf_(6,7);
95 va_list ap) _printf_(6,0);
97 int log_object_internal(
103 const char *object_field,
105 const char *format, ...) _printf_(8,9);
107 int log_object_internalv(
113 const char *object_field,
116 va_list ap) _printf_(8,0);
118 int log_struct_internal(
124 const char *format, ...) _printf_(6,0) _sentinel_;
126 int log_oom_internal(
131 int log_format_iovec(
135 bool newline_separator,
140 /* This modifies the buffer passed! */
141 int log_dump_internal(
149 /* Logging for various assertions */
150 noreturn void log_assert_failed(
156 noreturn void log_assert_failed_unreachable(
162 void log_assert_failed_return(
168 /* Logging with level */
169 #define log_full_errno(level, error, ...) \
171 int _level = (level), _e = (error); \
172 (log_get_max_level() >= LOG_PRI(_level)) \
173 ? log_internal(_level, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
177 #define log_full(level, ...) log_full_errno(level, 0, __VA_ARGS__)
180 #define log_debug(...) log_full(LOG_DEBUG, __VA_ARGS__)
181 #define log_info(...) log_full(LOG_INFO, __VA_ARGS__)
182 #define log_notice(...) log_full(LOG_NOTICE, __VA_ARGS__)
183 #define log_warning(...) log_full(LOG_WARNING, __VA_ARGS__)
184 #define log_error(...) log_full(LOG_ERR, __VA_ARGS__)
185 #define log_emergency(...) log_full(getpid() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
187 /* Logging triggered by an errno-like error */
188 #define log_debug_errno(error, ...) log_full_errno(LOG_DEBUG, error, __VA_ARGS__)
189 #define log_info_errno(error, ...) log_full_errno(LOG_INFO, error, __VA_ARGS__)
190 #define log_notice_errno(error, ...) log_full_errno(LOG_NOTICE, error, __VA_ARGS__)
191 #define log_warning_errno(error, ...) log_full_errno(LOG_WARNING, error, __VA_ARGS__)
192 #define log_error_errno(error, ...) log_full_errno(LOG_ERR, error, __VA_ARGS__)
193 #define log_emergency_errno(error, ...) log_full_errno(getpid() == 1 ? LOG_EMERG : LOG_ERR, error, __VA_ARGS__)
196 # define log_trace(...) log_debug(__VA_ARGS__)
198 # define log_trace(...) do {} while (0)
201 #ifdef ENABLE_DEBUG_ELOGIND
202 # define log_debug_elogind(...) log_debug(__VA_ARGS__);usleep(25*USEC_PER_MSEC)
204 # define log_debug_elogind(...) do {} while (0)
205 #endif // ENABLE_DEBUG_ELOGIND
207 /* Structured logging */
208 #define log_struct(level, ...) log_struct_internal(level, 0, __FILE__, __LINE__, __func__, __VA_ARGS__)
209 #define log_struct_errno(level, error, ...) log_struct_internal(level, error, __FILE__, __LINE__, __func__, __VA_ARGS__)
211 /* This modifies the buffer passed! */
212 #define log_dump(level, buffer) log_dump_internal(level, 0, __FILE__, __LINE__, __func__, buffer)
214 #define log_oom() log_oom_internal(__FILE__, __LINE__, __func__)
216 bool log_on_console(void) _pure_;
218 const char *log_target_to_string(LogTarget target) _const_;
219 LogTarget log_target_from_string(const char *s) _pure_;
221 /* Helpers to prepare various fields for structured logging */
222 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
223 #define LOG_MESSAGE_ID(x) "MESSAGE_ID=" SD_ID128_FORMAT_STR, SD_ID128_FORMAT_VAL(x)
225 #if 0 /// UNNEEDED by elogind
226 void log_received_signal(int level, const struct signalfd_siginfo *si);
228 void log_set_upgrade_syslog_to_journal(bool b);
231 int log_syntax_internal(
234 const char *config_file,
235 unsigned config_line,
240 const char *format, ...) _printf_(9, 10);
242 #define log_syntax(unit, level, config_file, config_line, error, ...) \
244 int _level = (level), _e = (error); \
245 (log_get_max_level() >= LOG_PRI(_level)) \
246 ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
250 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
252 int _level = (level); \
253 if (log_get_max_level() >= LOG_PRI(_level)) { \
254 _cleanup_free_ char *_p = NULL; \
255 _p = utf8_escape_invalid(rvalue); \
256 log_syntax_internal(unit, _level, config_file, config_line, 0, __FILE__, __LINE__, __func__, \
257 "String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \