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