src/basic/log.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2010 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <stdarg.h>
  24 #include <stdbool.h>
  25 #include <stdlib.h>
  26 #include <syslog.h>
  27
  28 #include "macro.h"
  29
  30 /* Some structures we reference but don't want to pull in headers for */
  31 struct iovec;
  32 struct signalfd_siginfo;
  33
  34 typedef enum LogRealm {
  35         LOG_REALM_SYSTEMD,
  36         LOG_REALM_UDEV,
  37         _LOG_REALM_MAX,
  38 } LogRealm;
  39
  40 #ifndef LOG_REALM
  41 #  define LOG_REALM LOG_REALM_SYSTEMD
  42 #endif
  43
  44 typedef enum LogTarget{
  45         LOG_TARGET_CONSOLE,
  46         LOG_TARGET_CONSOLE_PREFIXED,
  47         LOG_TARGET_KMSG,
  48         LOG_TARGET_JOURNAL,
  49         LOG_TARGET_JOURNAL_OR_KMSG,
  50         LOG_TARGET_SYSLOG,
  51         LOG_TARGET_SYSLOG_OR_KMSG,
  52         LOG_TARGET_AUTO, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */
  53         LOG_TARGET_SAFE, /* console if stderr is tty, KMSG otherwise */
  54         LOG_TARGET_NULL,
  55         _LOG_TARGET_MAX,
  56         _LOG_TARGET_INVALID = -1
  57 } LogTarget;
  58
  59 #define LOG_REALM_PLUS_LEVEL(realm, level)      \
  60         ((realm) << 10 | (level))
  61 #define LOG_REALM_REMOVE_LEVEL(realm_level)     \
  62         ((realm_level >> 10))
  63
  64 void log_set_target(LogTarget target);
  65 void log_set_max_level_realm(LogRealm realm, int level);
  66 #define log_set_max_level(level)                \
  67         log_set_max_level_realm(LOG_REALM, (level))
  68
  69 void log_set_facility(int facility);
  70
  71 int log_set_target_from_string(const char *e);
  72 int log_set_max_level_from_string_realm(LogRealm realm, const char *e);
  73 #define log_set_max_level_from_string(e)        \
  74         log_set_max_level_from_string_realm(LOG_REALM, (e))
  75
  76 void log_show_color(bool b);
  77 bool log_get_show_color(void) _pure_;
  78 void log_show_location(bool b);
  79 bool log_get_show_location(void) _pure_;
  80
  81 int log_show_color_from_string(const char *e);
  82 int log_show_location_from_string(const char *e);
  83
  84 LogTarget log_get_target(void) _pure_;
  85 int log_get_max_level_realm(LogRealm realm) _pure_;
  86 #define log_get_max_level()                     \
  87         log_get_max_level_realm(LOG_REALM)
  88
  89 /* Functions below that open and close logs or configure logging based on the
  90  * environment should not be called from library code — this is always a job
  91  * for the application itself.
  92  */
  93
  94 int log_open(void);
  95 void log_close(void);
  96 void log_forget_fds(void);
  97
  98 void log_close_syslog(void);
  99 void log_close_journal(void);
 100 void log_close_kmsg(void);
 101 void log_close_console(void);
 102
 103 void log_parse_environment_realm(LogRealm realm);
 104 #define log_parse_environment() \
 105         log_parse_environment_realm(LOG_REALM)
 106
 107 int log_dispatch_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,
 116                 const char *extra_field,
 117                 char *buffer);
 118
 119 int log_internal_realm(
 120                 int level,
 121                 int error,
 122                 const char *file,
 123                 int line,
 124                 const char *func,
 125                 const char *format, ...) _printf_(6,7);
 126 #define log_internal(level, ...) \
 127         log_internal_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
 128
 129 int log_internalv_realm(
 130                 int level,
 131                 int error,
 132                 const char *file,
 133                 int line,
 134                 const char *func,
 135                 const char *format,
 136                 va_list ap) _printf_(6,0);
 137 #define log_internalv(level, ...) \
 138         log_internalv_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
 139
 140 /* Realm is fixed to LOG_REALM_SYSTEMD for those */
 141 int log_object_internal(
 142                 int level,
 143                 int error,
 144                 const char *file,
 145                 int line,
 146                 const char *func,
 147                 const char *object_field,
 148                 const char *object,
 149                 const char *extra_field,
 150                 const char *extra,
 151                 const char *format, ...) _printf_(10,11);
 152
 153 int log_object_internalv(
 154                 int level,
 155                 int error,
 156                 const char *file,
 157                 int line,
 158                 const char *func,
 159                 const char *object_field,
 160                 const char *object,
 161                 const char *extra_field,
 162                 const char *extra,
 163                 const char *format,
 164                 va_list ap) _printf_(10,0);
 165
 166 int log_struct_internal(
 167                 int level,
 168                 int error,
 169                 const char *file,
 170                 int line,
 171                 const char *func,
 172                 const char *format, ...) _printf_(6,0) _sentinel_;
 173
 174 int log_oom_internal(
 175                 LogRealm realm,
 176                 const char *file,
 177                 int line,
 178                 const char *func);
 179
 180 int log_format_iovec(
 181                 struct iovec *iovec,
 182                 size_t iovec_len,
 183                 size_t *n,
 184                 bool newline_separator,
 185                 int error,
 186                 const char *format,
 187                 va_list ap) _printf_(6, 0);
 188
 189 int log_struct_iovec_internal(
 190                 int level,
 191                 int error,
 192                 const char *file,
 193                 int line,
 194                 const char *func,
 195                 const struct iovec *input_iovec,
 196                 size_t n_input_iovec);
 197
 198 /* This modifies the buffer passed! */
 199 int log_dump_internal(
 200                 int level,
 201                 int error,
 202                 const char *file,
 203                 int line,
 204                 const char *func,
 205                 char *buffer);
 206
 207 /* Logging for various assertions */
 208 noreturn void log_assert_failed_realm(
 209                 LogRealm realm,
 210                 const char *text,
 211                 const char *file,
 212                 int line,
 213                 const char *func);
 214 #define log_assert_failed(text, ...) \
 215         log_assert_failed_realm(LOG_REALM, (text), __VA_ARGS__)
 216
 217 noreturn void log_assert_failed_unreachable_realm(
 218                 LogRealm realm,
 219                 const char *text,
 220                 const char *file,
 221                 int line,
 222                 const char *func);
 223 #define log_assert_failed_unreachable(text, ...) \
 224         log_assert_failed_unreachable_realm(LOG_REALM, (text), __VA_ARGS__)
 225
 226 void log_assert_failed_return_realm(
 227                 LogRealm realm,
 228                 const char *text,
 229                 const char *file,
 230                 int line,
 231                 const char *func);
 232 #define log_assert_failed_return(text, ...) \
 233         log_assert_failed_return_realm(LOG_REALM, (text), __VA_ARGS__)
 234
 235 #define log_dispatch(level, error, buffer)                              \
 236         log_dispatch_internal(level, error, __FILE__, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer)
 237
 238 /* Logging with level */
 239 #define log_full_errno_realm(realm, level, error, ...)                  \
 240         ({                                                              \
 241                 int _level = (level), _e = (error), _realm = (realm);   \
 242                 (log_get_max_level_realm(_realm) >= LOG_PRI(_level))   \
 243                         ? log_internal_realm(LOG_REALM_PLUS_LEVEL(_realm, _level), _e, \
 244                                              __FILE__, __LINE__, __func__, __VA_ARGS__) \
 245                         : -abs(_e);                                     \
 246         })
 247
 248 #define log_full_errno(level, error, ...)                               \
 249         log_full_errno_realm(LOG_REALM, (level), (error), __VA_ARGS__)
 250
 251 #define log_full(level, ...) log_full_errno((level), 0, __VA_ARGS__)
 252
 253 int log_emergency_level(void);
 254
 255 /* Normal logging */
 256 #define log_debug(...)     log_full(LOG_DEBUG,   __VA_ARGS__)
 257 #define log_info(...)      log_full(LOG_INFO,    __VA_ARGS__)
 258 #define log_notice(...)    log_full(LOG_NOTICE,  __VA_ARGS__)
 259 #define log_warning(...)   log_full(LOG_WARNING, __VA_ARGS__)
 260 #define log_error(...)     log_full(LOG_ERR,     __VA_ARGS__)
 261 #define log_emergency(...) log_full(log_emergency_level(), __VA_ARGS__)
 262
 263 /* Logging triggered by an errno-like error */
 264 #define log_debug_errno(error, ...)     log_full_errno(LOG_DEBUG,   error, __VA_ARGS__)
 265 #define log_info_errno(error, ...)      log_full_errno(LOG_INFO,    error, __VA_ARGS__)
 266 #define log_notice_errno(error, ...)    log_full_errno(LOG_NOTICE,  error, __VA_ARGS__)
 267 #define log_warning_errno(error, ...)   log_full_errno(LOG_WARNING, error, __VA_ARGS__)
 268 #define log_error_errno(error, ...)     log_full_errno(LOG_ERR,     error, __VA_ARGS__)
 269 #define log_emergency_errno(error, ...) log_full_errno(log_emergency_level(), error, __VA_ARGS__)
 270
 271 #ifdef LOG_TRACE
 272 #  define log_trace(...) log_debug(__VA_ARGS__)
 273 #else
 274 #  define log_trace(...) do {} while (0)
 275 #endif
 276
 277 /* Structured logging */
 278 #define log_struct_errno(level, error, ...) \
 279         log_struct_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 280                             error, __FILE__, __LINE__, __func__, __VA_ARGS__)
 281 #define log_struct(level, ...) log_struct_errno(level, 0, __VA_ARGS__)
 282
 283 #define log_struct_iovec_errno(level, error, iovec, n_iovec)            \
 284         log_struct_iovec_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 285                                   error, __FILE__, __LINE__, __func__, iovec, n_iovec)
 286 #define log_struct_iovec(level, iovec, n_iovec) log_struct_iovec_errno(level, 0, iovec, n_iovec)
 287
 288 /* This modifies the buffer passed! */
 289 #define log_dump(level, buffer) \
 290         log_dump_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 291                           0, __FILE__, __LINE__, __func__, buffer)
 292
 293 #define log_oom() log_oom_internal(LOG_REALM, __FILE__, __LINE__, __func__)
 294
 295 bool log_on_console(void) _pure_;
 296
 297 const char *log_target_to_string(LogTarget target) _const_;
 298 LogTarget log_target_from_string(const char *s) _pure_;
 299
 300 /* Helper to prepare various field for structured logging */
 301 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
 302
 303 void log_received_signal(int level, const struct signalfd_siginfo *si);
 304
 305 /* If turned on, any requests for a log target involving "syslog" will be implicitly upgraded to the equivalent journal target */
 306 void log_set_upgrade_syslog_to_journal(bool b);
 307 void log_set_always_reopen_console(bool b);
 308 void log_set_open_when_needed(bool b);
 309
 310 int log_syntax_internal(
 311                 const char *unit,
 312                 int level,
 313                 const char *config_file,
 314                 unsigned config_line,
 315                 int error,
 316                 const char *file,
 317                 int line,
 318                 const char *func,
 319                 const char *format, ...) _printf_(9, 10);
 320
 321 int log_syntax_invalid_utf8_internal(
 322                 const char *unit,
 323                 int level,
 324                 const char *config_file,
 325                 unsigned config_line,
 326                 const char *file,
 327                 int line,
 328                 const char *func,
 329                 const char *rvalue);
 330
 331 #define log_syntax(unit, level, config_file, config_line, error, ...)   \
 332         ({                                                              \
 333                 int _level = (level), _e = (error);                     \
 334                 (log_get_max_level() >= LOG_PRI(_level))                \
 335                         ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
 336                         : -abs(_e);                                     \
 337         })
 338
 339 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
 340         ({                                                              \
 341                 int _level = (level);                                   \
 342                 (log_get_max_level() >= LOG_PRI(_level))                \
 343                         ? log_syntax_invalid_utf8_internal(unit, _level, config_file, config_line, __FILE__, __LINE__, __func__, rvalue) \
 344                         : -EINVAL;                                      \
 345         })
 346
 347 #define DEBUG_LOGGING _unlikely_(log_get_max_level() >= LOG_DEBUG)