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 <stdbool.h>
  25 #include <stdarg.h>
  26 #include <stdlib.h>
  27 #include <syslog.h>
  28 #include <sys/signalfd.h>
  29 #include <errno.h>
  30
  31 #include "sd-id128.h"
  32 #include "macro.h"
  33
  34 typedef enum LogTarget{
  35         LOG_TARGET_CONSOLE,
  36         LOG_TARGET_CONSOLE_PREFIXED,
  37         LOG_TARGET_KMSG,
  38 /// elogind does not support logging to systemd-journald
  39 #if 0
  40         LOG_TARGET_JOURNAL,
  41         LOG_TARGET_JOURNAL_OR_KMSG,
  42 #endif // 0
  43         LOG_TARGET_SYSLOG,
  44         LOG_TARGET_SYSLOG_OR_KMSG,
  45         LOG_TARGET_AUTO, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */
  46         LOG_TARGET_SAFE, /* console if stderr is tty, KMSG otherwise */
  47         LOG_TARGET_NULL,
  48         _LOG_TARGET_MAX,
  49         _LOG_TARGET_INVALID = -1
  50 }  LogTarget;
  51
  52 void log_set_target(LogTarget target);
  53 void log_set_max_level(int level);
  54 void log_set_facility(int facility);
  55
  56 int log_set_target_from_string(const char *e);
  57 int log_set_max_level_from_string(const char *e);
  58
  59 void log_show_color(bool b);
  60 bool log_get_show_color(void) _pure_;
  61 void log_show_location(bool b);
  62 bool log_get_show_location(void) _pure_;
  63
  64 int log_show_color_from_string(const char *e);
  65 int log_show_location_from_string(const char *e);
  66
  67 LogTarget log_get_target(void) _pure_;
  68 int log_get_max_level(void) _pure_;
  69
  70 int log_open(void);
  71 void log_close(void);
  72 // UNNEEDED void log_forget_fds(void);
  73
  74 void log_close_syslog(void);
  75 // UNNEEDED void log_close_journal(void);
  76 void log_close_kmsg(void);
  77 void log_close_console(void);
  78
  79 void log_parse_environment(void);
  80
  81 int log_internal(
  82                 int level,
  83                 int error,
  84                 const char *file,
  85                 int line,
  86                 const char *func,
  87                 const char *format, ...) _printf_(6,7);
  88
  89 int log_internalv(
  90                 int level,
  91                 int error,
  92                 const char *file,
  93                 int line,
  94                 const char *func,
  95                 const char *format,
  96                 va_list ap) _printf_(6,0);
  97
  98 int log_object_internal(
  99                 int level,
 100                 int error,
 101                 const char *file,
 102                 int line,
 103                 const char *func,
 104                 const char *object_field,
 105                 const char *object,
 106                 const char *format, ...) _printf_(8,9);
 107
 108 int log_object_internalv(
 109                 int level,
 110                 int error,
 111                 const char*file,
 112                 int line,
 113                 const char *func,
 114                 const char *object_field,
 115                 const char *object,
 116                 const char *format,
 117                 va_list ap) _printf_(8,0);
 118
 119 int log_struct_internal(
 120                 int level,
 121                 int error,
 122                 const char *file,
 123                 int line,
 124                 const char *func,
 125                 const char *format, ...) _printf_(6,0) _sentinel_;
 126
 127 int log_oom_internal(
 128                 const char *file,
 129                 int line,
 130                 const char *func);
 131
 132 /* This modifies the buffer passed! */
 133 int log_dump_internal(
 134                 int level,
 135                 int error,
 136                 const char *file,
 137                 int line,
 138                 const char *func,
 139                 char *buffer);
 140
 141 /* Logging for various assertions */
 142 noreturn void log_assert_failed(
 143                 const char *text,
 144                 const char *file,
 145                 int line,
 146                 const char *func);
 147
 148 noreturn void log_assert_failed_unreachable(
 149                 const char *text,
 150                 const char *file,
 151                 int line,
 152                 const char *func);
 153
 154 void log_assert_failed_return(
 155                 const char *text,
 156                 const char *file,
 157                 int line,
 158                 const char *func);
 159
 160 /* Logging with level */
 161 #define log_full_errno(level, error, ...)                               \
 162         ({                                                              \
 163                 int _level = (level), _e = (error);                     \
 164                 (log_get_max_level() >= LOG_PRI(_level))                \
 165                         ? log_internal(_level, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
 166                         : -abs(_e);                                     \
 167         })
 168
 169 #define log_full(level, ...) log_full_errno(level, 0, __VA_ARGS__)
 170
 171 /* Normal logging */
 172 #define log_debug(...)     log_full(LOG_DEBUG,   __VA_ARGS__)
 173 #define log_info(...)      log_full(LOG_INFO,    __VA_ARGS__)
 174 #define log_notice(...)    log_full(LOG_NOTICE,  __VA_ARGS__)
 175 #define log_warning(...)   log_full(LOG_WARNING, __VA_ARGS__)
 176 #define log_error(...)     log_full(LOG_ERR,     __VA_ARGS__)
 177 #define log_emergency(...) log_full(getpid() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
 178
 179 /* Logging triggered by an errno-like error */
 180 #define log_debug_errno(error, ...)     log_full_errno(LOG_DEBUG,   error, __VA_ARGS__)
 181 #define log_info_errno(error, ...)      log_full_errno(LOG_INFO,    error, __VA_ARGS__)
 182 #define log_notice_errno(error, ...)    log_full_errno(LOG_NOTICE,  error, __VA_ARGS__)
 183 #define log_warning_errno(error, ...)   log_full_errno(LOG_WARNING, error, __VA_ARGS__)
 184 #define log_error_errno(error, ...)     log_full_errno(LOG_ERR,     error, __VA_ARGS__)
 185 #define log_emergency_errno(error, ...) log_full_errno(getpid() == 1 ? LOG_EMERG : LOG_ERR, error, __VA_ARGS__)
 186
 187 #ifdef LOG_TRACE
 188 #  define log_trace(...) log_debug(__VA_ARGS__)
 189 #else
 190 #  define log_trace(...) do {} while(0)
 191 #endif
 192
 193 #ifdef ENABLE_DEBUG_ELOGIND
 194 #  define log_debug_elogind(...) log_debug(__VA_ARGS__);usleep(25*USEC_PER_MSEC)
 195 #else
 196 #  define log_debug_elogind(...) do {} while(0)
 197 #endif // ENABLE_DEBUG_ELOGIND
 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 // UNNEEDED void log_received_signal(int level, const struct signalfd_siginfo *si);
 218
 219 // UNNEEDED 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         })