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 <sys/types.h>
  29 #include <unistd.h>
  30 #include <errno.h>
  31
  32 #include "macro.h"
  33 #include "sd-id128.h"
  34
  35 typedef enum LogTarget{
  36         LOG_TARGET_CONSOLE,
  37         LOG_TARGET_KMSG,
  38         LOG_TARGET_JOURNAL,
  39         LOG_TARGET_JOURNAL_OR_KMSG,
  40         LOG_TARGET_SYSLOG,
  41         LOG_TARGET_SYSLOG_OR_KMSG,
  42         LOG_TARGET_AUTO, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */
  43         LOG_TARGET_SAFE, /* console if stderr is tty, KMSG otherwise */
  44         LOG_TARGET_NULL,
  45         _LOG_TARGET_MAX,
  46         _LOG_TARGET_INVALID = -1
  47 }  LogTarget;
  48
  49 void log_set_target(LogTarget target);
  50 void log_set_max_level(int level);
  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(const char *e);
  55
  56 void log_show_color(bool b);
  57 bool log_get_show_color(void) _pure_;
  58 void log_show_location(bool b);
  59 bool log_get_show_location(void) _pure_;
  60
  61 int log_show_color_from_string(const char *e);
  62 int log_show_location_from_string(const char *e);
  63
  64 LogTarget log_get_target(void) _pure_;
  65 int log_get_max_level(void) _pure_;
  66
  67 int log_open(void);
  68 void log_close(void);
  69 void log_forget_fds(void);
  70
  71 void log_close_syslog(void);
  72 void log_close_journal(void);
  73 void log_close_kmsg(void);
  74 void log_close_console(void);
  75
  76 void log_parse_environment(void);
  77
  78 int log_meta(
  79                 int level,
  80                 const char*file,
  81                 int line,
  82                 const char *func,
  83                 const char *format, ...) _printf_(5,6);
  84
  85 int log_metav(
  86                 int level,
  87                 const char*file,
  88                 int line,
  89                 const char *func,
  90                 const char *format,
  91                 va_list ap) _printf_(5,0);
  92
  93 int log_meta_object(
  94                 int level,
  95                 const char*file,
  96                 int line,
  97                 const char *func,
  98                 const char *object_name,
  99                 const char *object,
 100                 const char *format, ...) _printf_(7,8);
 101
 102 int log_metav_object(
 103                 int level,
 104                 const char*file,
 105                 int line,
 106                 const char *func,
 107                 const char *object_name,
 108                 const char *object,
 109                 const char *format,
 110                 va_list ap) _printf_(7,0);
 111
 112 int log_struct_internal(
 113                 int level,
 114                 const char *file,
 115                 int line,
 116                 const char *func,
 117                 const char *format, ...) _printf_(5,0) _sentinel_;
 118
 119 int log_oom_internal(
 120                 const char *file,
 121                 int line,
 122                 const char *func);
 123
 124 /* This modifies the buffer passed! */
 125 int log_dump_internal(
 126                 int level,
 127                 const char*file,
 128                 int line,
 129                 const char *func,
 130                 char *buffer);
 131
 132 noreturn void log_assert_failed(
 133                 const char *text,
 134                 const char *file,
 135                 int line,
 136                 const char *func);
 137
 138 noreturn void log_assert_failed_unreachable(
 139                 const char *text,
 140                 const char *file,
 141                 int line,
 142                 const char *func);
 143
 144 void log_assert_failed_return(
 145                 const char *text,
 146                 const char *file,
 147                 int line,
 148                 const char *func);
 149
 150 #define log_full(level, ...) \
 151 do { \
 152         if (log_get_max_level() >= (level)) \
 153                 log_meta((level), __FILE__, __LINE__, __func__, __VA_ARGS__); \
 154 } while (0)
 155
 156 #define log_debug(...)     log_full(LOG_DEBUG,   __VA_ARGS__)
 157 #define log_info(...)      log_full(LOG_INFO,    __VA_ARGS__)
 158 #define log_notice(...)    log_full(LOG_NOTICE,  __VA_ARGS__)
 159 #define log_warning(...)   log_full(LOG_WARNING, __VA_ARGS__)
 160 #define log_error(...)     log_full(LOG_ERR,     __VA_ARGS__)
 161 #define log_emergency(...) log_full(getpid() == 1 ? LOG_EMERG : LOG_ERR, __VA_ARGS__)
 162
 163 #ifdef LOG_TRACE
 164 #  define log_trace(...) log_debug(__VA_ARGS__)
 165 #else
 166 #  define log_trace(...) do {} while(0)
 167 #endif
 168
 169 #define log_struct(level, ...) log_struct_internal(level, __FILE__, __LINE__, __func__, __VA_ARGS__)
 170
 171 #define log_oom() log_oom_internal(__FILE__, __LINE__, __func__)
 172
 173 /* This modifies the buffer passed! */
 174 #define log_dump(level, buffer) log_dump_internal(level, __FILE__, __LINE__, __func__, buffer)
 175
 176 bool log_on_console(void) _pure_;
 177
 178 const char *log_target_to_string(LogTarget target) _const_;
 179 LogTarget log_target_from_string(const char *s) _pure_;
 180
 181 #define MESSAGE_ID(x) "MESSAGE_ID=" SD_ID128_FORMAT_STR, SD_ID128_FORMAT_VAL(x)
 182
 183 void log_received_signal(int level, const struct signalfd_siginfo *si);
 184
 185 void log_set_upgrade_syslog_to_journal(bool b);