src/basic/log.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 #include <stdarg.h>
   5 #include <stdbool.h>
   6 #include <stdlib.h>
   7 #include <syslog.h>
   8
   9 #include "macro.h"
  10
  11 /* Some structures we reference but don't want to pull in headers for */
  12 struct iovec;
  13 struct signalfd_siginfo;
  14
  15 typedef enum LogRealm {
  16         LOG_REALM_SYSTEMD,
  17         LOG_REALM_UDEV,
  18         _LOG_REALM_MAX,
  19 } LogRealm;
  20
  21 #ifndef LOG_REALM
  22 #  define LOG_REALM LOG_REALM_SYSTEMD
  23 #endif
  24
  25 typedef enum LogTarget{
  26         LOG_TARGET_CONSOLE,
  27         LOG_TARGET_CONSOLE_PREFIXED,
  28         LOG_TARGET_KMSG,
  29         LOG_TARGET_JOURNAL,
  30         LOG_TARGET_JOURNAL_OR_KMSG,
  31         LOG_TARGET_SYSLOG,
  32         LOG_TARGET_SYSLOG_OR_KMSG,
  33         LOG_TARGET_AUTO, /* console if stderr is not journal, JOURNAL_OR_KMSG otherwise */
  34         LOG_TARGET_NULL,
  35         _LOG_TARGET_MAX,
  36         _LOG_TARGET_INVALID = -1
  37 } LogTarget;
  38
  39 /* Note to readers: << and >> have lower precedence than & and | */
  40 #define LOG_REALM_PLUS_LEVEL(realm, level)  ((realm) << 10 | (level))
  41 #define LOG_REALM_REMOVE_LEVEL(realm_level) ((realm_level) >> 10)
  42 #define SYNTHETIC_ERRNO(num)                (1 << 30 | (num))
  43 #define IS_SYNTHETIC_ERRNO(val)             ((val) >> 30 & 1)
  44 #define ERRNO_VALUE(val)                    (abs(val) & 255)
  45
  46 void log_set_target(LogTarget target);
  47 void log_set_max_level_realm(LogRealm realm, int level);
  48 #define log_set_max_level(level)                \
  49         log_set_max_level_realm(LOG_REALM, (level))
  50
  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_realm(LogRealm realm, const char *e);
  55 #define log_set_max_level_from_string(e)        \
  56         log_set_max_level_from_string_realm(LOG_REALM, (e))
  57
  58 void log_show_color(bool b);
  59 bool log_get_show_color(void) _pure_;
  60 void log_show_location(bool b);
  61 bool log_get_show_location(void) _pure_;
  62 void log_show_time(bool b);
  63 bool log_get_show_time(void) _pure_;
  64 void log_show_tid(bool b);
  65 bool log_get_show_tid(void) _pure_;
  66
  67 int log_show_color_from_string(const char *e);
  68 int log_show_location_from_string(const char *e);
  69 int log_show_time_from_string(const char *e);
  70 int log_show_tid_from_string(const char *e);
  71
  72 LogTarget log_get_target(void) _pure_;
  73 int log_get_max_level_realm(LogRealm realm) _pure_;
  74 #define log_get_max_level()                     \
  75         log_get_max_level_realm(LOG_REALM)
  76
  77 /* Functions below that open and close logs or configure logging based on the
  78  * environment should not be called from library code — this is always a job
  79  * for the application itself.
  80  */
  81
  82 assert_cc(STRLEN(__FILE__) > STRLEN(RELATIVE_SOURCE_PATH) + 1);
  83 #define PROJECT_FILE (&__FILE__[STRLEN(RELATIVE_SOURCE_PATH) + 1])
  84
  85 int log_open(void);
  86 void log_close(void);
  87 void log_forget_fds(void);
  88
  89 void log_parse_environment_realm(LogRealm realm);
  90 void log_parse_environment_cli_realm(LogRealm realm);
  91 #define log_parse_environment() \
  92         log_parse_environment_realm(LOG_REALM)
  93 #define log_parse_environment_cli() \
  94         log_parse_environment_cli_realm(LOG_REALM)
  95
  96 int log_dispatch_internal(
  97                 int level,
  98                 int error,
  99                 const char *file,
 100                 int line,
 101                 const char *func,
 102                 const char *object_field,
 103                 const char *object,
 104                 const char *extra,
 105                 const char *extra_field,
 106                 char *buffer);
 107
 108 int log_internal_realm(
 109                 int level,
 110                 int error,
 111                 const char *file,
 112                 int line,
 113                 const char *func,
 114                 const char *format, ...) _printf_(6,7);
 115 #define log_internal(level, ...) \
 116         log_internal_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
 117
 118 int log_internalv_realm(
 119                 int level,
 120                 int error,
 121                 const char *file,
 122                 int line,
 123                 const char *func,
 124                 const char *format,
 125                 va_list ap) _printf_(6,0);
 126 #define log_internalv(level, ...) \
 127         log_internalv_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
 128
 129 /* Realm is fixed to LOG_REALM_SYSTEMD for those */
 130 int log_object_internalv(
 131                 int level,
 132                 int error,
 133                 const char *file,
 134                 int line,
 135                 const char *func,
 136                 const char *object_field,
 137                 const char *object,
 138                 const char *extra_field,
 139                 const char *extra,
 140                 const char *format,
 141                 va_list ap) _printf_(10,0);
 142
 143 int log_object_internal(
 144                 int level,
 145                 int error,
 146                 const char *file,
 147                 int line,
 148                 const char *func,
 149                 const char *object_field,
 150                 const char *object,
 151                 const char *extra_field,
 152                 const char *extra,
 153                 const char *format, ...) _printf_(10,11);
 154
 155 int log_struct_internal(
 156                 int level,
 157                 int error,
 158                 const char *file,
 159                 int line,
 160                 const char *func,
 161                 const char *format, ...) _printf_(6,0) _sentinel_;
 162
 163 int log_oom_internal(
 164                 LogRealm realm,
 165                 const char *file,
 166                 int line,
 167                 const char *func);
 168
 169 int log_format_iovec(
 170                 struct iovec *iovec,
 171                 size_t iovec_len,
 172                 size_t *n,
 173                 bool newline_separator,
 174                 int error,
 175                 const char *format,
 176                 va_list ap) _printf_(6, 0);
 177
 178 int log_struct_iovec_internal(
 179                 int level,
 180                 int error,
 181                 const char *file,
 182                 int line,
 183                 const char *func,
 184                 const struct iovec *input_iovec,
 185                 size_t n_input_iovec);
 186
 187 /* This modifies the buffer passed! */
 188 int log_dump_internal(
 189                 int level,
 190                 int error,
 191                 const char *file,
 192                 int line,
 193                 const char *func,
 194                 char *buffer);
 195
 196 /* Logging for various assertions */
 197 _noreturn_ void log_assert_failed_realm(
 198                 LogRealm realm,
 199                 const char *text,
 200                 const char *file,
 201                 int line,
 202                 const char *func);
 203 #define log_assert_failed(text, ...) \
 204         log_assert_failed_realm(LOG_REALM, (text), __VA_ARGS__)
 205
 206 _noreturn_ void log_assert_failed_unreachable_realm(
 207                 LogRealm realm,
 208                 const char *text,
 209                 const char *file,
 210                 int line,
 211                 const char *func);
 212 #define log_assert_failed_unreachable(text, ...) \
 213         log_assert_failed_unreachable_realm(LOG_REALM, (text), __VA_ARGS__)
 214
 215 void log_assert_failed_return_realm(
 216                 LogRealm realm,
 217                 const char *text,
 218                 const char *file,
 219                 int line,
 220                 const char *func);
 221 #define log_assert_failed_return(text, ...) \
 222         log_assert_failed_return_realm(LOG_REALM, (text), __VA_ARGS__)
 223
 224 #define log_dispatch(level, error, buffer)                              \
 225         log_dispatch_internal(level, error, PROJECT_FILE, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer)
 226
 227 /* Logging with level */
 228 #define log_full_errno_realm(realm, level, error, ...)                  \
 229         ({                                                              \
 230                 int _level = (level), _e = (error), _realm = (realm);   \
 231                 (log_get_max_level_realm(_realm) >= LOG_PRI(_level))    \
 232                         ? log_internal_realm(LOG_REALM_PLUS_LEVEL(_realm, _level), _e, \
 233                                              PROJECT_FILE, __LINE__, __func__, __VA_ARGS__) \
 234                         : -ERRNO_VALUE(_e);                             \
 235         })
 236
 237 #define log_full_errno(level, error, ...)                               \
 238         log_full_errno_realm(LOG_REALM, (level), (error), __VA_ARGS__)
 239
 240 #define log_full(level, ...) (void) log_full_errno((level), 0, __VA_ARGS__)
 241
 242 int log_emergency_level(void);
 243
 244 /* Normal logging */
 245 #define log_debug(...)     log_full_errno(LOG_DEBUG, 0, __VA_ARGS__)
 246 #define log_info(...)      log_full(LOG_INFO,    __VA_ARGS__)
 247 #define log_notice(...)    log_full(LOG_NOTICE,  __VA_ARGS__)
 248 #define log_warning(...)   log_full(LOG_WARNING, __VA_ARGS__)
 249 #define log_error(...)     log_full(LOG_ERR,     __VA_ARGS__)
 250 #define log_emergency(...) log_full(log_emergency_level(), __VA_ARGS__)
 251
 252 /* Logging triggered by an errno-like error */
 253 #define log_debug_errno(error, ...)     log_full_errno(LOG_DEBUG,   error, __VA_ARGS__)
 254 #define log_info_errno(error, ...)      log_full_errno(LOG_INFO,    error, __VA_ARGS__)
 255 #define log_notice_errno(error, ...)    log_full_errno(LOG_NOTICE,  error, __VA_ARGS__)
 256 #define log_warning_errno(error, ...)   log_full_errno(LOG_WARNING, error, __VA_ARGS__)
 257 #define log_error_errno(error, ...)     log_full_errno(LOG_ERR,     error, __VA_ARGS__)
 258 #define log_emergency_errno(error, ...) log_full_errno(log_emergency_level(), error, __VA_ARGS__)
 259
 260 #ifdef LOG_TRACE
 261 #  define log_trace(...) log_debug(__VA_ARGS__)
 262 #else
 263 #  define log_trace(...) do {} while (0)
 264 #endif
 265
 266 /* Structured logging */
 267 #define log_struct_errno(level, error, ...) \
 268         log_struct_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 269                             error, PROJECT_FILE, __LINE__, __func__, __VA_ARGS__, NULL)
 270 #define log_struct(level, ...) log_struct_errno(level, 0, __VA_ARGS__)
 271
 272 #define log_struct_iovec_errno(level, error, iovec, n_iovec)            \
 273         log_struct_iovec_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 274                                   error, PROJECT_FILE, __LINE__, __func__, iovec, n_iovec)
 275 #define log_struct_iovec(level, iovec, n_iovec) log_struct_iovec_errno(level, 0, iovec, n_iovec)
 276
 277 /* This modifies the buffer passed! */
 278 #define log_dump(level, buffer) \
 279         log_dump_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 280                           0, PROJECT_FILE, __LINE__, __func__, buffer)
 281
 282 #define log_oom() log_oom_internal(LOG_REALM, PROJECT_FILE, __LINE__, __func__)
 283
 284 bool log_on_console(void) _pure_;
 285
 286 const char *log_target_to_string(LogTarget target) _const_;
 287 LogTarget log_target_from_string(const char *s) _pure_;
 288
 289 /* Helper to prepare various field for structured logging */
 290 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
 291
 292 void log_received_signal(int level, const struct signalfd_siginfo *si);
 293
 294 /* If turned on, any requests for a log target involving "syslog" will be implicitly upgraded to the equivalent journal target */
 295 void log_set_upgrade_syslog_to_journal(bool b);
 296
 297 /* If turned on, and log_open() is called, we'll not use STDERR_FILENO for logging ever, but rather open /dev/console */
 298 void log_set_always_reopen_console(bool b);
 299
 300 /* If turned on, we'll open the log stream implicitly if needed on each individual log call. This is normally not
 301  * desired as we want to reuse our logging streams. It is useful however  */
 302 void log_set_open_when_needed(bool b);
 303
 304 /* If turned on, then we'll never use IPC-based logging, i.e. never log to syslog or the journal. We'll only log to
 305  * stderr, the console or kmsg */
 306 void log_set_prohibit_ipc(bool b);
 307
 308 int log_dup_console(void);
 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, PROJECT_FILE, __LINE__, __func__, __VA_ARGS__) \
 336                         : -ERRNO_VALUE(_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, PROJECT_FILE, __LINE__, __func__, rvalue) \
 344                         : -EINVAL;                                      \
 345         })
 346
 347 #define DEBUG_LOGGING _unlikely_(log_get_max_level() >= LOG_DEBUG)
 348
 349 void log_setup_service(void);
 350 void log_setup_cli(void);