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