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 <syslog.h>
  25 #include <stdbool.h>
  26 #include <stdarg.h>
  27 #include <errno.h>
  28
  29 #include "macro.h"
  30
  31 typedef enum LogTarget{
  32         LOG_TARGET_CONSOLE,
  33         LOG_TARGET_KMSG,
  34         LOG_TARGET_JOURNAL,
  35         LOG_TARGET_JOURNAL_OR_KMSG,
  36         LOG_TARGET_SYSLOG,
  37         LOG_TARGET_SYSLOG_OR_KMSG,
  38         LOG_TARGET_AUTO, /* console if stderr is tty, JOURNAL_OR_KMSG otherwise */
  39         LOG_TARGET_SAFE, /* console if stderr is tty, KMSG otherwise */
  40         LOG_TARGET_NULL,
  41         _LOG_TARGET_MAX,
  42         _LOG_TARGET_INVALID = -1
  43 }  LogTarget;
  44
  45 void log_set_target(LogTarget target);
  46 void log_set_max_level(int level);
  47 void log_set_facility(int facility);
  48
  49 int log_set_target_from_string(const char *e);
  50 int log_set_max_level_from_string(const char *e);
  51
  52 void log_show_color(bool b);
  53 void log_show_location(bool b);
  54
  55 int log_show_color_from_string(const char *e);
  56 int log_show_location_from_string(const char *e);
  57
  58 LogTarget log_get_target(void);
  59 int log_get_max_level(void);
  60
  61 int log_open(void);
  62 void log_close(void);
  63 void log_forget_fds(void);
  64
  65 void log_close_syslog(void);
  66 void log_close_journal(void);
  67 void log_close_kmsg(void);
  68 void log_close_console(void);
  69
  70 void log_parse_environment(void);
  71
  72 int log_meta(
  73                 int level,
  74                 const char*file,
  75                 int line,
  76                 const char *func,
  77                 const char *format, ...) _printf_attr_(5,6);
  78
  79 int log_metav(
  80                 int level,
  81                 const char*file,
  82                 int line,
  83                 const char *func,
  84                 const char *format,
  85                 va_list ap);
  86
  87 int log_struct_internal(
  88                 int level,
  89                 const char *file,
  90                 int line,
  91                 const char *func,
  92                 const char *format, ...) _sentinel_;
  93
  94 int log_oom_internal(
  95                 const char *file,
  96                 int line,
  97                 const char *func);
  98
  99 /* This modifies the buffer passed! */
 100 int log_dump_internal(
 101                 int level,
 102                 const char*file,
 103                 int line,
 104                 const char *func,
 105                 char *buffer);
 106
 107 _noreturn_ void log_assert_failed(
 108                 const char *text,
 109                 const char *file,
 110                 int line,
 111                 const char *func);
 112
 113 _noreturn_ void log_assert_failed_unreachable(
 114                 const char *text,
 115                 const char *file,
 116                 int line,
 117                 const char *func);
 118
 119 #define log_full(level, ...) log_meta(level,   __FILE__, __LINE__, __func__, __VA_ARGS__)
 120
 121 #define log_debug(...)   log_meta(LOG_DEBUG,   __FILE__, __LINE__, __func__, __VA_ARGS__)
 122 #define log_info(...)    log_meta(LOG_INFO,    __FILE__, __LINE__, __func__, __VA_ARGS__)
 123 #define log_notice(...)  log_meta(LOG_NOTICE,  __FILE__, __LINE__, __func__, __VA_ARGS__)
 124 #define log_warning(...) log_meta(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
 125 #define log_error(...)   log_meta(LOG_ERR,     __FILE__, __LINE__, __func__, __VA_ARGS__)
 126
 127 #define log_struct(level, ...) log_struct_internal(level, __FILE__, __LINE__, __func__, __VA_ARGS__)
 128
 129 #define log_oom() log_oom_internal(__FILE__, __LINE__, __func__)
 130
 131 /* This modifies the buffer passed! */
 132 #define log_dump(level, buffer) log_dump_internal(level, __FILE__, __LINE__, __func__, buffer)
 133
 134 bool log_on_console(void);
 135
 136 const char *log_target_to_string(LogTarget target);
 137 LogTarget log_target_from_string(const char *s);
 138
 139 #define MESSAGE_ID(x) "MESSAGE_ID=" SD_ID128_FORMAT_STR, SD_ID128_FORMAT_VAL(x)