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 #if 0 /// UNNEEDED by elogind
  98 void log_forget_fds(void);
  99 #endif // 0
 100
 101 void log_close_syslog(void);
 102 void log_close_journal(void);
 103 void log_close_kmsg(void);
 104 void log_close_console(void);
 105
 106 void log_parse_environment_realm(LogRealm realm);
 107 #define log_parse_environment() \
 108         log_parse_environment_realm(LOG_REALM)
 109
 110 int log_dispatch_internal(
 111                 int level,
 112                 int error,
 113                 const char *file,
 114                 int line,
 115                 const char *func,
 116                 const char *object_field,
 117                 const char *object,
 118                 const char *extra,
 119                 const char *extra_field,
 120                 char *buffer);
 121
 122 int log_internal_realm(
 123                 int level,
 124                 int error,
 125                 const char *file,
 126                 int line,
 127                 const char *func,
 128                 const char *format, ...) _printf_(6,7);
 129 #define log_internal(level, ...) \
 130         log_internal_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
 131
 132 int log_internalv_realm(
 133                 int level,
 134                 int error,
 135                 const char *file,
 136                 int line,
 137                 const char *func,
 138                 const char *format,
 139                 va_list ap) _printf_(6,0);
 140 #define log_internalv(level, ...) \
 141         log_internalv_realm(LOG_REALM_PLUS_LEVEL(LOG_REALM, (level)), __VA_ARGS__)
 142
 143 /* Realm is fixed to LOG_REALM_SYSTEMD for those */
 144 int log_object_internal(
 145                 int level,
 146                 int error,
 147                 const char *file,
 148                 int line,
 149                 const char *func,
 150                 const char *object_field,
 151                 const char *object,
 152                 const char *extra_field,
 153                 const char *extra,
 154                 const char *format, ...) _printf_(10,11);
 155
 156 int log_object_internalv(
 157                 int level,
 158                 int error,
 159                 const char *file,
 160                 int line,
 161                 const char *func,
 162                 const char *object_field,
 163                 const char *object,
 164                 const char *extra_field,
 165                 const char *extra,
 166                 const char *format,
 167                 va_list ap) _printf_(10,0);
 168
 169 int log_struct_internal(
 170                 int level,
 171                 int error,
 172                 const char *file,
 173                 int line,
 174                 const char *func,
 175                 const char *format, ...) _printf_(6,0) _sentinel_;
 176
 177 int log_oom_internal(
 178                 LogRealm realm,
 179                 const char *file,
 180                 int line,
 181                 const char *func);
 182
 183 int log_format_iovec(
 184                 struct iovec *iovec,
 185                 size_t iovec_len,
 186                 size_t *n,
 187                 bool newline_separator,
 188                 int error,
 189                 const char *format,
 190                 va_list ap) _printf_(6, 0);
 191
 192 int log_struct_iovec_internal(
 193                 int level,
 194                 int error,
 195                 const char *file,
 196                 int line,
 197                 const char *func,
 198                 const struct iovec input_iovec[],
 199                 size_t n_input_iovec);
 200
 201 /* This modifies the buffer passed! */
 202 int log_dump_internal(
 203                 int level,
 204                 int error,
 205                 const char *file,
 206                 int line,
 207                 const char *func,
 208                 char *buffer);
 209
 210 /* Logging for various assertions */
 211 noreturn void log_assert_failed_realm(
 212                 LogRealm realm,
 213                 const char *text,
 214                 const char *file,
 215                 int line,
 216                 const char *func);
 217 #define log_assert_failed(text, ...) \
 218         log_assert_failed_realm(LOG_REALM, (text), __VA_ARGS__)
 219
 220 noreturn void log_assert_failed_unreachable_realm(
 221                 LogRealm realm,
 222                 const char *text,
 223                 const char *file,
 224                 int line,
 225                 const char *func);
 226 #define log_assert_failed_unreachable(text, ...) \
 227         log_assert_failed_unreachable_realm(LOG_REALM, (text), __VA_ARGS__)
 228
 229 void log_assert_failed_return_realm(
 230                 LogRealm realm,
 231                 const char *text,
 232                 const char *file,
 233                 int line,
 234                 const char *func);
 235 #define log_assert_failed_return(text, ...) \
 236         log_assert_failed_return_realm(LOG_REALM, (text), __VA_ARGS__)
 237
 238 #define log_dispatch(level, error, buffer)                              \
 239         log_dispatch_internal(level, error, __FILE__, __LINE__, __func__, NULL, NULL, NULL, NULL, buffer)
 240
 241 /* Logging with level */
 242 #define log_full_errno_realm(realm, level, error, ...)                  \
 243         ({                                                              \
 244                 int _level = (level), _e = (error);                     \
 245                 (log_get_max_level_realm((realm)) >= LOG_PRI(_level))   \
 246                         ? log_internal_realm(LOG_REALM_PLUS_LEVEL((realm), _level), _e, \
 247                                              __FILE__, __LINE__, __func__, __VA_ARGS__) \
 248                         : -abs(_e);                                     \
 249         })
 250
 251 #define log_full_errno(level, error, ...)                               \
 252         log_full_errno_realm(LOG_REALM, (level), (error), __VA_ARGS__)
 253
 254 #define log_full(level, ...) log_full_errno((level), 0, __VA_ARGS__)
 255
 256 /* Normal logging */
 257 #define log_debug(...)     log_full(LOG_DEBUG,   __VA_ARGS__)
 258 #define log_info(...)      log_full(LOG_INFO,    __VA_ARGS__)
 259 #define log_notice(...)    log_full(LOG_NOTICE,  __VA_ARGS__)
 260 #define log_warning(...)   log_full(LOG_WARNING, __VA_ARGS__)
 261 #define log_error(...)     log_full(LOG_ERR,     __VA_ARGS__)
 262 #define log_emergency(...) log_full(getpid_cached() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
 263
 264 /* Logging triggered by an errno-like error */
 265 #define log_debug_errno(error, ...)     log_full_errno(LOG_DEBUG,   error, __VA_ARGS__)
 266 #define log_info_errno(error, ...)      log_full_errno(LOG_INFO,    error, __VA_ARGS__)
 267 #define log_notice_errno(error, ...)    log_full_errno(LOG_NOTICE,  error, __VA_ARGS__)
 268 #define log_warning_errno(error, ...)   log_full_errno(LOG_WARNING, error, __VA_ARGS__)
 269 #define log_error_errno(error, ...)     log_full_errno(LOG_ERR,     error, __VA_ARGS__)
 270 #define log_emergency_errno(error, ...) log_full_errno(getpid_cached() == 1 ? LOG_EMERG : LOG_ERR, error, __VA_ARGS__)
 271
 272 #ifdef LOG_TRACE
 273 #  define log_trace(...) log_debug(__VA_ARGS__)
 274 #else
 275 #  define log_trace(...) do {} while (0)
 276 #endif
 277
 278 #ifdef ENABLE_DEBUG_ELOGIND
 279 #  define log_debug_elogind(...) log_debug(__VA_ARGS__);usleep(25*USEC_PER_MSEC)
 280 #else
 281 #  define log_debug_elogind(...) do {} while (0)
 282 #endif // ENABLE_DEBUG_ELOGIND
 283 /* Structured logging */
 284 #define log_struct_errno(level, error, ...) \
 285         log_struct_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 286                             error, __FILE__, __LINE__, __func__, __VA_ARGS__)
 287 #define log_struct(level, ...) log_struct_errno(level, 0, __VA_ARGS__)
 288
 289 #define log_struct_iovec_errno(level, error, iovec, n_iovec)            \
 290         log_struct_iovec_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 291                                   error, __FILE__, __LINE__, __func__, iovec, n_iovec)
 292 #define log_struct_iovec(level, iovec, n_iovec) log_struct_iovec_errno(level, 0, iovec, n_iovec)
 293
 294 /* This modifies the buffer passed! */
 295 #define log_dump(level, buffer) \
 296         log_dump_internal(LOG_REALM_PLUS_LEVEL(LOG_REALM, level), \
 297                           0, __FILE__, __LINE__, __func__, buffer)
 298
 299 #define log_oom() log_oom_internal(LOG_REALM, __FILE__, __LINE__, __func__)
 300
 301 bool log_on_console(void) _pure_;
 302
 303 const char *log_target_to_string(LogTarget target) _const_;
 304 LogTarget log_target_from_string(const char *s) _pure_;
 305
 306 /* Helper to prepare various field for structured logging */
 307 #define LOG_MESSAGE(fmt, ...) "MESSAGE=" fmt, ##__VA_ARGS__
 308
 309 #if 0 /// UNNEEDED by elogind
 310 void log_received_signal(int level, const struct signalfd_siginfo *si);
 311
 312 void log_set_upgrade_syslog_to_journal(bool b);
 313 void log_set_always_reopen_console(bool b);
 314 #endif // 0
 315 void log_set_open_when_needed(bool b);
 316
 317 int log_syntax_internal(
 318                 const char *unit,
 319                 int level,
 320                 const char *config_file,
 321                 unsigned config_line,
 322                 int error,
 323                 const char *file,
 324                 int line,
 325                 const char *func,
 326                 const char *format, ...) _printf_(9, 10);
 327
 328 #define log_syntax(unit, level, config_file, config_line, error, ...)   \
 329         ({                                                              \
 330                 int _level = (level), _e = (error);                     \
 331                 (log_get_max_level() >= LOG_PRI(_level))                \
 332                         ? log_syntax_internal(unit, _level, config_file, config_line, _e, __FILE__, __LINE__, __func__, __VA_ARGS__) \
 333                         : -abs(_e);                                     \
 334         })
 335
 336 #define log_syntax_invalid_utf8(unit, level, config_file, config_line, rvalue) \
 337         ({                                                              \
 338                 int _level = (level);                                   \
 339                 if (log_get_max_level() >= LOG_PRI(_level)) {           \
 340                         _cleanup_free_ char *_p = NULL;                 \
 341                         _p = utf8_escape_invalid(rvalue);               \
 342                         log_syntax_internal(unit, _level, config_file, config_line, 0, __FILE__, __LINE__, __func__, \
 343                                             "String is not UTF-8 clean, ignoring assignment: %s", strna(_p)); \
 344                 }                                                       \
 345         })