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 void log_forget_fds(void);
  70
  71 void log_close_syslog(void);
  72 void log_close_journal(void);
  73 void log_close_kmsg(void);
  74 void log_close_console(void);
  75
  76 void log_parse_environment(void);
  77
  78 int log_internal(
  79                 int level,
  80                 int error,
  81                 const char *file,
  82                 int line,
  83                 const char *func,
  84                 const char *format, ...) _printf_(6,7);
  85
  86 int log_internalv(
  87                 int level,
  88                 int error,
  89                 const char *file,
  90                 int line,
  91                 const char *func,
  92                 const char *format,
  93                 va_list ap) _printf_(6,0);
  94
  95 int log_object_internal(
  96                 int level,
  97                 int error,
  98                 const char *file,
  99                 int line,
 100                 const char *func,
 101                 const char *object_field,
 102                 const char *object,
 103                 const char *format, ...) _printf_(8,9);
 104
 105 int log_object_internalv(
 106                 int level,
 107                 int error,
 108                 const char*file,
 109                 int line,
 110                 const char *func,
 111                 const char *object_field,
 112                 const char *object,
 113                 const char *format,
 114                 va_list ap) _printf_(8,0);
 115
 116 int log_struct_internal(
 117                 int level,
 118                 int error,
 119                 const char *file,
 120                 int line,
 121                 const char *func,
 122                 const char *format, ...) _printf_(6,0) _sentinel_;
 123
 124 int log_oom_internal(
 125                 const char *file,
 126                 int line,
 127                 const char *func);
 128
 129 int log_format_iovec(
 130                 struct iovec *iovec,
 131                 unsigned iovec_len,
 132                 unsigned *n,
 133                 bool newline_separator,
 134                 int error,
 135                 const char *format,
 136                 va_list ap);
 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 /* Structured logging */
 200 #define log_struct(level, ...) log_struct_internal(level, 0, __FILE__, __LINE__, __func__, __VA_ARGS__)
 201 #define log_struct_errno(level, error, ...) log_struct_internal(level, error, __FILE__, __LINE__, __func__, __VA_ARGS__)
 202
 203 /* This modifies the buffer passed! */
 204 #define log_dump(level, buffer) log_dump_internal(level, 0, __FILE__, __LINE__, __func__, buffer)
 205
 206 #define log_oom() log_oom_internal(__FILE__, __LINE__, __func__)
 207
 208 bool log_on_console(void) _pure_;
 209
 210 const char *log_target_to_string(LogTarget target) _const_;
 211 LogTarget log_target_from_string(const char *s) _pure_;
 212
 213 /* Helpers to prepare various fields for structured logging */
 214 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
 215 #define LOG_MESSAGE_ID(x) "MESSAGE_ID=" SD_ID128_FORMAT_STR, SD_ID128_FORMAT_VAL(x)
 216
 217 void log_received_signal(int level, const struct signalfd_siginfo *si);
 218
 219 void log_set_upgrade_syslog_to_journal(bool b);
 220
 221 int log_syntax_internal(
 222                 const char *unit,
 223                 int level,
 224                 const char *config_file,
 225                 unsigned config_line,
 226                 int error,
 227                 const char *file,
 228                 int line,
 229                 const char *func,
 230                 const char *format, ...) _printf_(9, 10);
 231
 232 #define log_syntax(unit, level, config_file, config_line, error, ...)   \
 233         ({                                                              \
 234                 int _level = (level), _e = (error);                     \
 235                 (log_get_max_level() >= LOG_PRI(_level))                \
 236                         ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
 237                         : -abs(_e);                                     \
 238         })
 239
 240 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
 241         ({                                                              \
 242                 int _level = (level);                                   \
 243                 if (log_get_max_level() >= LOG_PRI(_level)) {           \
 244                         _cleanup_free_ char *_p = NULL;                 \
 245                         _p = utf8_escape_invalid(rvalue);               \
 246                         log_syntax_internal(unit, _level, config_file, config_line, 0, __FILE__, __LINE__, __func__, \
 247                                             "String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \
 248                 }                                                       \
 249         })