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