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