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_dispatch_internal(
  81                 int level,
  82                 int error,
  83                 const char *file,
  84                 int line,
  85                 const char *func,
  86                 const char *object_field,
  87                 const char *object,
  88                 const char *extra,
  89                 const char *extra_field,
  90                 char *buffer);
  91
  92 int log_internal(
  93                 int level,
  94                 int error,
  95                 const char *file,
  96                 int line,
  97                 const char *func,
  98                 const char *format, ...) _printf_(6,7);
  99
 100 int log_internalv(
 101                 int level,
 102                 int error,
 103                 const char *file,
 104                 int line,
 105                 const char *func,
 106                 const char *format,
 107                 va_list ap) _printf_(6,0);
 108
 109 int log_object_internal(
 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, ...) _printf_(10,11);
 120
 121 int log_object_internalv(
 122                 int level,
 123                 int error,
 124                 const char *file,
 125                 int line,
 126                 const char *func,
 127                 const char *object_field,
 128                 const char *object,
 129                 const char *extra_field,
 130                 const char *extra,
 131                 const char *format,
 132                 va_list ap) _printf_(10,0);
 133
 134 int log_struct_internal(
 135                 int level,
 136                 int error,
 137                 const char *file,
 138                 int line,
 139                 const char *func,
 140                 const char *format, ...) _printf_(6,0) _sentinel_;
 141
 142 int log_oom_internal(
 143                 const char *file,
 144                 int line,
 145                 const char *func);
 146
 147 int log_format_iovec(
 148                 struct iovec *iovec,
 149                 unsigned iovec_len,
 150                 unsigned *n,
 151                 bool newline_separator,
 152                 int error,
 153                 const char *format,
 154                 va_list ap) _printf_(6, 0);
 155
 156 /* This modifies the buffer passed! */
 157 int log_dump_internal(
 158                 int level,
 159                 int error,
 160                 const char *file,
 161                 int line,
 162                 const char *func,
 163                 char *buffer);
 164
 165 /* Logging for various assertions */
 166 noreturn void log_assert_failed(
 167                 const char *text,
 168                 const char *file,
 169                 int line,
 170                 const char *func);
 171
 172 noreturn void log_assert_failed_unreachable(
 173                 const char *text,
 174                 const char *file,
 175                 int line,
 176                 const char *func);
 177
 178 void log_assert_failed_return(
 179                 const char *text,
 180                 const char *file,
 181                 int line,
 182                 const char *func);
 183
 184 #define log_dispatch(level, error, buffer)                              \
 185         log_dispatch_internal(level, error, __FILE__, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer)
 186
 187 /* Logging with level */
 188 #define log_full_errno(level, error, ...)                               \
 189         ({                                                              \
 190                 int _level = (level), _e = (error);                     \
 191                 (log_get_max_level() >= LOG_PRI(_level))                \
 192                         ? log_internal(_level, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
 193                         : -abs(_e);                                     \
 194         })
 195
 196 #define log_full(level, ...) log_full_errno(level, 0, __VA_ARGS__)
 197
 198 /* Normal logging */
 199 #define log_debug(...)     log_full(LOG_DEBUG,   __VA_ARGS__)
 200 #define log_info(...)      log_full(LOG_INFO,    __VA_ARGS__)
 201 #define log_notice(...)    log_full(LOG_NOTICE,  __VA_ARGS__)
 202 #define log_warning(...)   log_full(LOG_WARNING, __VA_ARGS__)
 203 #define log_error(...)     log_full(LOG_ERR,     __VA_ARGS__)
 204 #define log_emergency(...) log_full(getpid() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
 205
 206 /* Logging triggered by an errno-like error */
 207 #define log_debug_errno(error, ...)     log_full_errno(LOG_DEBUG,   error, __VA_ARGS__)
 208 #define log_info_errno(error, ...)      log_full_errno(LOG_INFO,    error, __VA_ARGS__)
 209 #define log_notice_errno(error, ...)    log_full_errno(LOG_NOTICE,  error, __VA_ARGS__)
 210 #define log_warning_errno(error, ...)   log_full_errno(LOG_WARNING, error, __VA_ARGS__)
 211 #define log_error_errno(error, ...)     log_full_errno(LOG_ERR,     error, __VA_ARGS__)
 212 #define log_emergency_errno(error, ...) log_full_errno(getpid() == 1 ? LOG_EMERG : LOG_ERR, error, __VA_ARGS__)
 213
 214 #ifdef LOG_TRACE
 215 #  define log_trace(...) log_debug(__VA_ARGS__)
 216 #else
 217 #  define log_trace(...) do {} while (0)
 218 #endif
 219
 220 #ifdef ENABLE_DEBUG_ELOGIND
 221 #  define log_debug_elogind(...) log_debug(__VA_ARGS__);usleep(25*USEC_PER_MSEC)
 222 #else
 223 #  define log_debug_elogind(...) do {} while (0)
 224 #endif // ENABLE_DEBUG_ELOGIND
 225 /* Structured logging */
 226 #define log_struct(level, ...) log_struct_internal(level, 0, __FILE__, __LINE__, __func__, __VA_ARGS__)
 227 #define log_struct_errno(level, error, ...) log_struct_internal(level, error, __FILE__, __LINE__, __func__, __VA_ARGS__)
 228
 229 /* This modifies the buffer passed! */
 230 #define log_dump(level, buffer) log_dump_internal(level, 0, __FILE__, __LINE__, __func__, buffer)
 231
 232 #define log_oom() log_oom_internal(__FILE__, __LINE__, __func__)
 233
 234 bool log_on_console(void) _pure_;
 235
 236 const char *log_target_to_string(LogTarget target) _const_;
 237 LogTarget log_target_from_string(const char *s) _pure_;
 238
 239 /* Helper to prepare various field for structured logging */
 240 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
 241
 242 #if 0 /// UNNEEDED by elogind
 243 void log_received_signal(int level, const struct signalfd_siginfo *si);
 244
 245 void log_set_upgrade_syslog_to_journal(bool b);
 246 void log_set_always_reopen_console(bool b);
 247 #endif // 0
 248
 249 int log_syntax_internal(
 250                 const char *unit,
 251                 int level,
 252                 const char *config_file,
 253                 unsigned config_line,
 254                 int error,
 255                 const char *file,
 256                 int line,
 257                 const char *func,
 258                 const char *format, ...) _printf_(9, 10);
 259
 260 #define log_syntax(unit, level, config_file, config_line, error, ...)   \
 261         ({                                                              \
 262                 int _level = (level), _e = (error);                     \
 263                 (log_get_max_level() >= LOG_PRI(_level))                \
 264                         ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
 265                         : -abs(_e);                                     \
 266         })
 267
 268 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
 269         ({                                                              \
 270                 int _level = (level);                                   \
 271                 if (log_get_max_level() >= LOG_PRI(_level)) {           \
 272                         _cleanup_free_ char *_p = NULL;                 \
 273                         _p = utf8_escape_invalid(rvalue);               \
 274                         log_syntax_internal(unit, _level, config_file, config_line, 0, __FILE__, __LINE__, __func__, \
 275                                             "String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \
 276                 }                                                       \
 277         })