src/basic/log.h

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