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         LOG_TARGET_JOURNAL,
  39         LOG_TARGET_JOURNAL_OR_KMSG,
  40         LOG_TARGET_SYSLOG,
  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 */
  44         LOG_TARGET_NULL,
  45         _LOG_TARGET_MAX,
  46         _LOG_TARGET_INVALID = -1
  47 }  LogTarget;
  48
  49 void log_set_target(LogTarget target);
  50 void log_set_max_level(int level);
  51 void log_set_facility(int facility);
  52
  53 int log_set_target_from_string(const char *e);
  54 int log_set_max_level_from_string(const char *e);
  55
  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_;
  60
  61 int log_show_color_from_string(const char *e);
  62 int log_show_location_from_string(const char *e);
  63
  64 LogTarget log_get_target(void) _pure_;
  65 int log_get_max_level(void) _pure_;
  66
  67 int log_open(void);
  68 void log_close(void);
  69 #if 0 /// UNNEEDED by elogind
  70 void log_forget_fds(void);
  71 #endif // 0
  72
  73 void log_close_syslog(void);
  74 void log_close_journal(void);
  75 void log_close_kmsg(void);
  76 void log_close_console(void);
  77
  78 void log_parse_environment(void);
  79
  80 int log_internal(
  81                 int level,
  82                 int error,
  83                 const char *file,
  84                 int line,
  85                 const char *func,
  86                 const char *format, ...) _printf_(6,7);
  87
  88 int log_internalv(
  89                 int level,
  90                 int error,
  91                 const char *file,
  92                 int line,
  93                 const char *func,
  94                 const char *format,
  95                 va_list ap) _printf_(6,0);
  96
  97 int log_object_internal(
  98                 int level,
  99                 int error,
 100                 const char *file,
 101                 int line,
 102                 const char *func,
 103                 const char *object_field,
 104                 const char *object,
 105                 const char *extra_field,
 106                 const char *extra,
 107                 const char *format, ...) _printf_(10,11);
 108
 109 int log_object_internalv(
 110                 int level,
 111                 int error,
 112                 const char *file,
 113                 int line,
 114                 const char *func,
 115                 const char *object_field,
 116                 const char *object,
 117                 const char *extra_field,
 118                 const char *extra,
 119                 const char *format,
 120                 va_list ap) _printf_(10,0);
 121
 122 int log_struct_internal(
 123                 int level,
 124                 int error,
 125                 const char *file,
 126                 int line,
 127                 const char *func,
 128                 const char *format, ...) _printf_(6,0) _sentinel_;
 129
 130 int log_oom_internal(
 131                 const char *file,
 132                 int line,
 133                 const char *func);
 134
 135 int log_format_iovec(
 136                 struct iovec *iovec,
 137                 unsigned iovec_len,
 138                 unsigned *n,
 139                 bool newline_separator,
 140                 int error,
 141                 const char *format,
 142                 va_list ap) _printf_(6, 0);
 143
 144 /* This modifies the buffer passed! */
 145 int log_dump_internal(
 146                 int level,
 147                 int error,
 148                 const char *file,
 149                 int line,
 150                 const char *func,
 151                 char *buffer);
 152
 153 /* Logging for various assertions */
 154 noreturn void log_assert_failed(
 155                 const char *text,
 156                 const char *file,
 157                 int line,
 158                 const char *func);
 159
 160 noreturn void log_assert_failed_unreachable(
 161                 const char *text,
 162                 const char *file,
 163                 int line,
 164                 const char *func);
 165
 166 void log_assert_failed_return(
 167                 const char *text,
 168                 const char *file,
 169                 int line,
 170                 const char *func);
 171
 172 /* Logging with level */
 173 #define log_full_errno(level, error, ...)                               \
 174         ({                                                              \
 175                 int _level = (level), _e = (error);                     \
 176                 (log_get_max_level() >= LOG_PRI(_level))                \
 177                         ? log_internal(_level, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
 178                         : -abs(_e);                                     \
 179         })
 180
 181 #define log_full(level, ...) log_full_errno(level, 0, __VA_ARGS__)
 182
 183 /* Normal logging */
 184 #define log_debug(...)     log_full(LOG_DEBUG,   __VA_ARGS__)
 185 #define log_info(...)      log_full(LOG_INFO,    __VA_ARGS__)
 186 #define log_notice(...)    log_full(LOG_NOTICE,  __VA_ARGS__)
 187 #define log_warning(...)   log_full(LOG_WARNING, __VA_ARGS__)
 188 #define log_error(...)     log_full(LOG_ERR,     __VA_ARGS__)
 189 #define log_emergency(...) log_full(getpid() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
 190
 191 /* Logging triggered by an errno-like error */
 192 #define log_debug_errno(error, ...)     log_full_errno(LOG_DEBUG,   error, __VA_ARGS__)
 193 #define log_info_errno(error, ...)      log_full_errno(LOG_INFO,    error, __VA_ARGS__)
 194 #define log_notice_errno(error, ...)    log_full_errno(LOG_NOTICE,  error, __VA_ARGS__)
 195 #define log_warning_errno(error, ...)   log_full_errno(LOG_WARNING, error, __VA_ARGS__)
 196 #define log_error_errno(error, ...)     log_full_errno(LOG_ERR,     error, __VA_ARGS__)
 197 #define log_emergency_errno(error, ...) log_full_errno(getpid() == 1 ? LOG_EMERG : LOG_ERR, error, __VA_ARGS__)
 198
 199 #ifdef LOG_TRACE
 200 #  define log_trace(...) log_debug(__VA_ARGS__)
 201 #else
 202 #  define log_trace(...) do {} while (0)
 203 #endif
 204
 205 #ifdef ENABLE_DEBUG_ELOGIND
 206 #  define log_debug_elogind(...) log_debug(__VA_ARGS__);usleep(25*USEC_PER_MSEC)
 207 #else
 208 #  define log_debug_elogind(...) do {} while (0)
 209 #endif // ENABLE_DEBUG_ELOGIND
 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 /* Helper to prepare various field for structured logging */
 225 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
 226
 227 #if 0 /// UNNEEDED by elogind
 228 void log_received_signal(int level, const struct signalfd_siginfo *si);
 229
 230 void log_set_upgrade_syslog_to_journal(bool b);
 231 void log_set_always_reopen_console(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         })