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