src/basic/log.h

   1 #pragma once
   2
   3 /***
   4   This file is part of systemd.
   5
   6   Copyright 2010 Lennart Poettering
   7
   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.
  12
  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.
  17
  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/>.
  20 ***/
  21
  22 #include <errno.h>
  23 #include <stdarg.h>
  24 #include <stdbool.h>
  25 #include <stdlib.h>
  26 #include <sys/signalfd.h>
  27 #include <sys/socket.h>
  28 #include <syslog.h>
  29
  30 #include "sd-id128.h"
  31
  32 #include "macro.h"
  33
  34 typedef enum LogTarget{
  35         LOG_TARGET_CONSOLE,
  36         LOG_TARGET_CONSOLE_PREFIXED,
  37         LOG_TARGET_KMSG,
  38 #if 0 /// elogind does not support logging to systemd-journald
  39         LOG_TARGET_JOURNAL,
  40         LOG_TARGET_JOURNAL_OR_KMSG,
  41 #endif // 0
  42         LOG_TARGET_SYSLOG,
  43         LOG_TARGET_SYSLOG_OR_KMSG,
  44         LOG_TARGET_AUTO, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */
  45         LOG_TARGET_SAFE, /* console if stderr is tty, KMSG otherwise */
  46         LOG_TARGET_NULL,
  47         _LOG_TARGET_MAX,
  48         _LOG_TARGET_INVALID = -1
  49 }  LogTarget;
  50
  51 void log_set_target(LogTarget target);
  52 void log_set_max_level(int level);
  53 void log_set_facility(int facility);
  54
  55 int log_set_target_from_string(const char *e);
  56 int log_set_max_level_from_string(const char *e);
  57
  58 void log_show_color(bool b);
  59 bool log_get_show_color(void) _pure_;
  60 void log_show_location(bool b);
  61 bool log_get_show_location(void) _pure_;
  62
  63 int log_show_color_from_string(const char *e);
  64 int log_show_location_from_string(const char *e);
  65
  66 LogTarget log_get_target(void) _pure_;
  67 int log_get_max_level(void) _pure_;
  68
  69 int log_open(void);
  70 void log_close(void);
  71 #if 0 /// UNNEEDED by elogind
  72 void log_forget_fds(void);
  73 #endif // 0
  74 void log_close_syslog(void);
  75 #if 0 /// UNNEEDED by elogind
  76 void log_close_journal(void);
  77 #endif // 0
  78 void log_close_kmsg(void);
  79 void log_close_console(void);
  80
  81 void log_parse_environment(void);
  82
  83 int log_internal(
  84                 int level,
  85                 int error,
  86                 const char *file,
  87                 int line,
  88                 const char *func,
  89                 const char *format, ...) _printf_(6,7);
  90
  91 int log_internalv(
  92                 int level,
  93                 int error,
  94                 const char *file,
  95                 int line,
  96                 const char *func,
  97                 const char *format,
  98                 va_list ap) _printf_(6,0);
  99
 100 int log_object_internal(
 101                 int level,
 102                 int error,
 103                 const char *file,
 104                 int line,
 105                 const char *func,
 106                 const char *object_field,
 107                 const char *object,
 108                 const char *format, ...) _printf_(8,9);
 109
 110 int log_object_internalv(
 111                 int level,
 112                 int error,
 113                 const char*file,
 114                 int line,
 115                 const char *func,
 116                 const char *object_field,
 117                 const char *object,
 118                 const char *format,
 119                 va_list ap) _printf_(8,0);
 120
 121 int log_struct_internal(
 122                 int level,
 123                 int error,
 124                 const char *file,
 125                 int line,
 126                 const char *func,
 127                 const char *format, ...) _printf_(6,0) _sentinel_;
 128
 129 int log_oom_internal(
 130                 const char *file,
 131                 int line,
 132                 const char *func);
 133
 134 int log_format_iovec(
 135                 struct iovec *iovec,
 136                 unsigned iovec_len,
 137                 unsigned *n,
 138                 bool newline_separator,
 139                 int error,
 140                 const char *format,
 141                 va_list ap);
 142
 143 /* This modifies the buffer passed! */
 144 int log_dump_internal(
 145                 int level,
 146                 int error,
 147                 const char *file,
 148                 int line,
 149                 const char *func,
 150                 char *buffer);
 151
 152 /* Logging for various assertions */
 153 noreturn void log_assert_failed(
 154                 const char *text,
 155                 const char *file,
 156                 int line,
 157                 const char *func);
 158
 159 noreturn void log_assert_failed_unreachable(
 160                 const char *text,
 161                 const char *file,
 162                 int line,
 163                 const char *func);
 164
 165 void log_assert_failed_return(
 166                 const char *text,
 167                 const char *file,
 168                 int line,
 169                 const char *func);
 170
 171 /* Logging with level */
 172 #define log_full_errno(level, error, ...)                               \
 173         ({                                                              \
 174                 int _level = (level), _e = (error);                     \
 175                 (log_get_max_level() >= LOG_PRI(_level))                \
 176                         ? log_internal(_level, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
 177                         : -abs(_e);                                     \
 178         })
 179
 180 #define log_full(level, ...) log_full_errno(level, 0, __VA_ARGS__)
 181
 182 /* Normal logging */
 183 #define log_debug(...)     log_full(LOG_DEBUG,   __VA_ARGS__)
 184 #define log_info(...)      log_full(LOG_INFO,    __VA_ARGS__)
 185 #define log_notice(...)    log_full(LOG_NOTICE,  __VA_ARGS__)
 186 #define log_warning(...)   log_full(LOG_WARNING, __VA_ARGS__)
 187 #define log_error(...)     log_full(LOG_ERR,     __VA_ARGS__)
 188 #define log_emergency(...) log_full(getpid() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
 189
 190 /* Logging triggered by an errno-like error */
 191 #define log_debug_errno(error, ...)     log_full_errno(LOG_DEBUG,   error, __VA_ARGS__)
 192 #define log_info_errno(error, ...)      log_full_errno(LOG_INFO,    error, __VA_ARGS__)
 193 #define log_notice_errno(error, ...)    log_full_errno(LOG_NOTICE,  error, __VA_ARGS__)
 194 #define log_warning_errno(error, ...)   log_full_errno(LOG_WARNING, error, __VA_ARGS__)
 195 #define log_error_errno(error, ...)     log_full_errno(LOG_ERR,     error, __VA_ARGS__)
 196 #define log_emergency_errno(error, ...) log_full_errno(getpid() == 1 ? LOG_EMERG : LOG_ERR, error, __VA_ARGS__)
 197
 198 #ifdef LOG_TRACE
 199 #  define log_trace(...) log_debug(__VA_ARGS__)
 200 #else
 201 #  define log_trace(...) do {} while(0)
 202 #endif
 203
 204 #ifdef ENABLE_DEBUG_ELOGIND
 205 #  define log_debug_elogind(...) log_debug(__VA_ARGS__);usleep(25*USEC_PER_MSEC)
 206 #else
 207 #  define log_debug_elogind(...) do {} while(0)
 208 #endif // ENABLE_DEBUG_ELOGIND
 209
 210 /* Structured logging */
 211 #define log_struct(level, ...) log_struct_internal(level, 0, __FILE__, __LINE__, __func__, __VA_ARGS__)
 212 #define log_struct_errno(level, error, ...) log_struct_internal(level, error, __FILE__, __LINE__, __func__, __VA_ARGS__)
 213
 214 /* This modifies the buffer passed! */
 215 #define log_dump(level, buffer) log_dump_internal(level, 0, __FILE__, __LINE__, __func__, buffer)
 216
 217 #define log_oom() log_oom_internal(__FILE__, __LINE__, __func__)
 218
 219 bool log_on_console(void) _pure_;
 220
 221 const char *log_target_to_string(LogTarget target) _const_;
 222 LogTarget log_target_from_string(const char *s) _pure_;
 223
 224 /* Helpers to prepare various fields for structured logging */
 225 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
 226 #define LOG_MESSAGE_ID(x) "MESSAGE_ID=" SD_ID128_FORMAT_STR, SD_ID128_FORMAT_VAL(x)
 227
 228 #if 0 /// UNNEEDED by elogind
 229 void log_received_signal(int level, const struct signalfd_siginfo *si);
 230
 231 void log_set_upgrade_syslog_to_journal(bool b);
 232 #endif // 0
 233
 234 int log_syntax_internal(
 235                 const char *unit,
 236                 int level,
 237                 const char *config_file,
 238                 unsigned config_line,
 239                 int error,
 240                 const char *file,
 241                 int line,
 242                 const char *func,
 243                 const char *format, ...) _printf_(9, 10);
 244
 245 #define log_syntax(unit, level, config_file, config_line, error, ...)   \
 246         ({                                                              \
 247                 int _level = (level), _e = (error);                     \
 248                 (log_get_max_level() >= LOG_PRI(_level))                \
 249                         ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
 250                         : -abs(_e);                                     \
 251         })
 252
 253 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
 254         ({                                                              \
 255                 int _level = (level);                                   \
 256                 if (log_get_max_level() >= LOG_PRI(_level)) {           \
 257                         _cleanup_free_ char *_p = NULL;                 \
 258                         _p = utf8_escape_invalid(rvalue);               \
 259                         log_syntax_internal(unit, _level, config_file, config_line, 0, __FILE__, __LINE__, __func__, \
 260                                             "String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \
 261                 }                                                       \
 262         })