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 #include "process-util.h"
  34
  35 typedef enum LogRealm {
  36         LOG_REALM_SYSTEMD,
  37         LOG_REALM_UDEV,
  38         _LOG_REALM_MAX,
  39 } LogRealm;
  40
  41 #ifndef LOG_REALM
  42 #  define LOG_REALM LOG_REALM_SYSTEMD
  43 #endif
  44
  45 typedef enum LogTarget{
  46         LOG_TARGET_CONSOLE,
  47         LOG_TARGET_CONSOLE_PREFIXED,
  48         LOG_TARGET_KMSG,
  49         LOG_TARGET_JOURNAL,
  50         LOG_TARGET_JOURNAL_OR_KMSG,
  51         LOG_TARGET_SYSLOG,
  52         LOG_TARGET_SYSLOG_OR_KMSG,
  53         LOG_TARGET_AUTO, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */
  54         LOG_TARGET_SAFE, /* console if stderr is tty, KMSG otherwise */
  55         LOG_TARGET_NULL,
  56         _LOG_TARGET_MAX,
  57         _LOG_TARGET_INVALID = -1
  58 } LogTarget;
  59
  60 #define LOG_REALM_PLUS_LEVEL(realm, level)      \
  61         ((realm) << 10 | (level))
  62 #define LOG_REALM_REMOVE_LEVEL(realm_level)     \
  63         ((realm_level >> 10))
  64
  65 void log_set_target(LogTarget target);
  66 void log_set_max_level_realm(LogRealm realm, int level);
  67 #define log_set_max_level(level)                \
  68         log_set_max_level_realm(LOG_REALM, (level))
  69
  70 void log_set_facility(int facility);
  71
  72 int log_set_target_from_string(const char *e);
  73 int log_set_max_level_from_string_realm(LogRealm realm, const char *e);
  74 #define log_set_max_level_from_string(e)        \
  75         log_set_max_level_from_string_realm(LOG_REALM, (e))
  76
  77 void log_show_color(bool b);
  78 bool log_get_show_color(void) _pure_;
  79 void log_show_location(bool b);
  80 bool log_get_show_location(void) _pure_;
  81
  82 int log_show_color_from_string(const char *e);
  83 int log_show_location_from_string(const char *e);
  84
  85 LogTarget log_get_target(void) _pure_;
  86 int log_get_max_level_realm(LogRealm realm) _pure_;
  87 #define log_get_max_level()                     \
  88         log_get_max_level_realm(LOG_REALM)
  89
  90 /* Functions below that open and close logs or configure logging based on the
  91  * environment should not be called from library code — this is always a job
  92  * for the application itself.
  93  */
  94
  95 int log_open(void);
  96 void log_close(void);
  97 void log_forget_fds(void);
  98
  99 void log_close_syslog(void);
 100 void log_close_journal(void);
 101 void log_close_kmsg(void);
 102 void log_close_console(void);
 103
 104 void log_parse_environment_realm(LogRealm realm);
 105 #define log_parse_environment() \
 106         log_parse_environment_realm(LOG_REALM)
 107
 108 int log_dispatch_internal(
 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 *extra,
 117                 const char *extra_field,
 118                 char *buffer);
 119
 120 int log_internal_realm(
 121                 int level,
 122                 int error,
 123                 const char *file,
 124                 int line,
 125                 const char *func,
 126                 const char *format, ...) _printf_(6,7);
 127 #define log_internal(level, ...) \
 128         log_internal_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
 129
 130 int log_internalv_realm(
 131                 int level,
 132                 int error,
 133                 const char *file,
 134                 int line,
 135                 const char *func,
 136                 const char *format,
 137                 va_list ap) _printf_(6,0);
 138 #define log_internalv(level, ...) \
 139         log_internalv_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
 140
 141 /* Realm is fixed to LOG_REALM_SYSTEMD for those */
 142 int log_object_internal(
 143                 int level,
 144                 int error,
 145                 const char *file,
 146                 int line,
 147                 const char *func,
 148                 const char *object_field,
 149                 const char *object,
 150                 const char *extra_field,
 151                 const char *extra,
 152                 const char *format, ...) _printf_(10,11);
 153
 154 int log_object_internalv(
 155                 int level,
 156                 int error,
 157                 const char *file,
 158                 int line,
 159                 const char *func,
 160                 const char *object_field,
 161                 const char *object,
 162                 const char *extra_field,
 163                 const char *extra,
 164                 const char *format,
 165                 va_list ap) _printf_(10,0);
 166
 167 int log_struct_internal(
 168                 int level,
 169                 int error,
 170                 const char *file,
 171                 int line,
 172                 const char *func,
 173                 const char *format, ...) _printf_(6,0) _sentinel_;
 174
 175 int log_oom_internal(
 176                 LogRealm realm,
 177                 const char *file,
 178                 int line,
 179                 const char *func);
 180
 181 int log_format_iovec(
 182                 struct iovec *iovec,
 183                 unsigned iovec_len,
 184                 unsigned *n,
 185                 bool newline_separator,
 186                 int error,
 187                 const char *format,
 188                 va_list ap) _printf_(6, 0);
 189
 190 int log_struct_iovec_internal(
 191                 int level,
 192                 int error,
 193                 const char *file,
 194                 int line,
 195                 const char *func,
 196                 const struct iovec input_iovec[],
 197                 size_t n_input_iovec);
 198
 199 /* This modifies the buffer passed! */
 200 int log_dump_internal(
 201                 int level,
 202                 int error,
 203                 const char *file,
 204                 int line,
 205                 const char *func,
 206                 char *buffer);
 207
 208 /* Logging for various assertions */
 209 noreturn void log_assert_failed_realm(
 210                 LogRealm realm,
 211                 const char *text,
 212                 const char *file,
 213                 int line,
 214                 const char *func);
 215 #define log_assert_failed(text, ...) \
 216         log_assert_failed_realm(LOG_REALM, (text), __VA_ARGS__)
 217
 218 noreturn void log_assert_failed_unreachable_realm(
 219                 LogRealm realm,
 220                 const char *text,
 221                 const char *file,
 222                 int line,
 223                 const char *func);
 224 #define log_assert_failed_unreachable(text, ...) \
 225         log_assert_failed_unreachable_realm(LOG_REALM, (text), __VA_ARGS__)
 226
 227 void log_assert_failed_return_realm(
 228                 LogRealm realm,
 229                 const char *text,
 230                 const char *file,
 231                 int line,
 232                 const char *func);
 233 #define log_assert_failed_return(text, ...) \
 234         log_assert_failed_return_realm(LOG_REALM, (text), __VA_ARGS__)
 235
 236 #define log_dispatch(level, error, buffer)                              \
 237         log_dispatch_internal(level, error, __FILE__, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer)
 238
 239 /* Logging with level */
 240 #define log_full_errno_realm(realm, level, error, ...)                  \
 241         ({                                                              \
 242                 int _level = (level), _e = (error);                     \
 243                 (log_get_max_level_realm((realm)) >= LOG_PRI(_level))   \
 244                         ? log_internal_realm(LOG_REALM_PLUS_LEVEL((realm), _level), _e, \
 245                                              __FILE__, __LINE__, __func__, __VA_ARGS__) \
 246                         : -abs(_e);                                     \
 247         })
 248
 249 #define log_full_errno(level, error, ...)                               \
 250         log_full_errno_realm(LOG_REALM, (level), (error), __VA_ARGS__)
 251
 252 #define log_full(level, ...) log_full_errno((level), 0, __VA_ARGS__)
 253
 254 /* Normal logging */
 255 #define log_debug(...)     log_full(LOG_DEBUG,   __VA_ARGS__)
 256 #define log_info(...)      log_full(LOG_INFO,    __VA_ARGS__)
 257 #define log_notice(...)    log_full(LOG_NOTICE,  __VA_ARGS__)
 258 #define log_warning(...)   log_full(LOG_WARNING, __VA_ARGS__)
 259 #define log_error(...)     log_full(LOG_ERR,     __VA_ARGS__)
 260 #define log_emergency(...) log_full(getpid_cached() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
 261
 262 /* Logging triggered by an errno-like error */
 263 #define log_debug_errno(error, ...)     log_full_errno(LOG_DEBUG,   error, __VA_ARGS__)
 264 #define log_info_errno(error, ...)      log_full_errno(LOG_INFO,    error, __VA_ARGS__)
 265 #define log_notice_errno(error, ...)    log_full_errno(LOG_NOTICE,  error, __VA_ARGS__)
 266 #define log_warning_errno(error, ...)   log_full_errno(LOG_WARNING, error, __VA_ARGS__)
 267 #define log_error_errno(error, ...)     log_full_errno(LOG_ERR,     error, __VA_ARGS__)
 268 #define log_emergency_errno(error, ...) log_full_errno(getpid_cached() == 1 ? LOG_EMERG : LOG_ERR, error, __VA_ARGS__)
 269
 270 #ifdef LOG_TRACE
 271 #  define log_trace(...) log_debug(__VA_ARGS__)
 272 #else
 273 #  define log_trace(...) do {} while (0)
 274 #endif
 275
 276 /* Structured logging */
 277 #define log_struct_errno(level, error, ...) \
 278         log_struct_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 279                             error, __FILE__, __LINE__, __func__, __VA_ARGS__)
 280 #define log_struct(level, ...) log_struct_errno(level, 0, __VA_ARGS__)
 281
 282 #define log_struct_iovec_errno(level, error, iovec, n_iovec)            \
 283         log_struct_iovec_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 284                                   error, __FILE__, __LINE__, __func__, iovec, n_iovec)
 285 #define log_struct_iovec(level, iovec, n_iovec) log_struct_iovec_errno(level, 0, iovec, n_iovec)
 286
 287 /* This modifies the buffer passed! */
 288 #define log_dump(level, buffer) \
 289         log_dump_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 290                           0, __FILE__, __LINE__, __func__, buffer)
 291
 292 #define log_oom() log_oom_internal(LOG_REALM, __FILE__, __LINE__, __func__)
 293
 294 bool log_on_console(void) _pure_;
 295
 296 const char *log_target_to_string(LogTarget target) _const_;
 297 LogTarget log_target_from_string(const char *s) _pure_;
 298
 299 /* Helper to prepare various field for structured logging */
 300 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
 301
 302 void log_received_signal(int level, const struct signalfd_siginfo *si);
 303
 304 void log_set_upgrade_syslog_to_journal(bool b);
 305 void log_set_always_reopen_console(bool b);
 306
 307 int log_syntax_internal(
 308                 const char *unit,
 309                 int level,
 310                 const char *config_file,
 311                 unsigned config_line,
 312                 int error,
 313                 const char *file,
 314                 int line,
 315                 const char *func,
 316                 const char *format, ...) _printf_(9, 10);
 317
 318 #define log_syntax(unit, level, config_file, config_line, error, ...)   \
 319         ({                                                              \
 320                 int _level = (level), _e = (error);                     \
 321                 (log_get_max_level() >= LOG_PRI(_level))                \
 322                         ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
 323                         : -abs(_e);                                     \
 324         })
 325
 326 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
 327         ({                                                              \
 328                 int _level = (level);                                   \
 329                 if (log_get_max_level() >= LOG_PRI(_level)) {           \
 330                         _cleanup_free_ char *_p = NULL;                 \
 331                         _p = utf8_escape_invalid(rvalue);               \
 332                         log_syntax_internal(unit, _level, config_file, config_line, 0, __FILE__, __LINE__, __func__, \
 333                                             "String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \
 334                 }                                                       \
 335         })