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