src/pulsecore/log.h

   1 #ifndef foologhfoo
   2 #define foologhfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
   9
  10   PulseAudio is free software; you can redistribute it and/or modify
  11   it under the terms of the GNU Lesser General Public License as published
  12   by the Free Software Foundation; either version 2.1 of the License,
  13   or (at your option) any later version.
  14
  15   PulseAudio 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   General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with PulseAudio; if not, write to the Free Software
  22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  23   USA.
  24 ***/
  25
  26 #include <stdarg.h>
  27 #include <stdlib.h>
  28
  29 #include <pulsecore/macro.h>
  30 #include <pulse/gccmacro.h>
  31
  32 /* A simple logging subsystem */
  33
  34 /* Where to log to */
  35 typedef enum pa_log_target {
  36     PA_LOG_STDERR,  /* default */
  37     PA_LOG_SYSLOG,
  38     PA_LOG_NULL,    /* to /dev/null */
  39     PA_LOG_FD,      /* to a file descriptor, e.g. a char device */
  40     PA_LOG_TARGET_MAX
  41 } pa_log_target_t;
  42
  43 typedef enum pa_log_level {
  44     PA_LOG_ERROR  = 0,    /* Error messages */
  45     PA_LOG_WARN   = 1,    /* Warning messages */
  46     PA_LOG_NOTICE = 2,    /* Notice messages */
  47     PA_LOG_INFO   = 3,    /* Info messages */
  48     PA_LOG_DEBUG  = 4,    /* debug message */
  49     PA_LOG_LEVEL_MAX
  50 } pa_log_level_t;
  51
  52 typedef enum pa_log_flags {
  53     PA_LOG_COLORS      = 0x01, /* Show colorful output */
  54     PA_LOG_PRINT_TIME  = 0x02, /* Show time */
  55     PA_LOG_PRINT_FILE  = 0x04, /* Show source file */
  56     PA_LOG_PRINT_META  = 0x08, /* Show extended locaton information */
  57     PA_LOG_PRINT_LEVEL = 0x10, /* Show log level prefix */
  58 } pa_log_flags_t;
  59
  60 typedef enum pa_log_merge {
  61     PA_LOG_SET,
  62     PA_LOG_UNSET,
  63     PA_LOG_RESET
  64 } pa_log_merge_t;
  65
  66 /* Set an identification for the current daemon. Used when logging to syslog. */
  67 void pa_log_set_ident(const char *p);
  68
  69 /* Set a log target. */
  70 void pa_log_set_target(pa_log_target_t t);
  71
  72 /* Maximal log level */
  73 void pa_log_set_level(pa_log_level_t l);
  74
  75 /* Set flags */
  76 void pa_log_set_flags(pa_log_flags_t flags, pa_log_merge_t merge);
  77
  78 /* Set the file descriptor of the logging device.
  79    Daemon conf is in charge of opening this device */
  80 void pa_log_set_fd(int fd);
  81
  82 /* Enable backtrace */
  83 void pa_log_set_show_backtrace(unsigned nlevels);
  84
  85 /* Skip the first backtrace frames */
  86 void pa_log_set_skip_backtrace(unsigned nlevels);
  87
  88 void pa_log_level_meta(
  89         pa_log_level_t level,
  90         const char*file,
  91         int line,
  92         const char *func,
  93         const char *format, ...) PA_GCC_PRINTF_ATTR(5,6);
  94
  95 void pa_log_levelv_meta(
  96         pa_log_level_t level,
  97         const char*file,
  98         int line,
  99         const char *func,
 100         const char *format,
 101         va_list ap);
 102
 103 void pa_log_level(
 104         pa_log_level_t level,
 105         const char *format, ...) PA_GCC_PRINTF_ATTR(2,3);
 106
 107 void pa_log_levelv(
 108         pa_log_level_t level,
 109         const char *format,
 110         va_list ap);
 111
 112 #if __STDC_VERSION__ >= 199901L
 113
 114 /* ISO varargs available */
 115
 116 #define pa_log_debug(...)  pa_log_level_meta(PA_LOG_DEBUG,  __FILE__, __LINE__, __func__, __VA_ARGS__)
 117 #define pa_log_info(...)   pa_log_level_meta(PA_LOG_INFO,   __FILE__, __LINE__, __func__, __VA_ARGS__)
 118 #define pa_log_notice(...) pa_log_level_meta(PA_LOG_NOTICE, __FILE__, __LINE__, __func__, __VA_ARGS__)
 119 #define pa_log_warn(...)   pa_log_level_meta(PA_LOG_WARN,   __FILE__, __LINE__, __func__, __VA_ARGS__)
 120 #define pa_log_error(...)  pa_log_level_meta(PA_LOG_ERROR,  __FILE__, __LINE__, __func__, __VA_ARGS__)
 121 #define pa_logl(level, ...)  pa_log_level_meta(level,  __FILE__, __LINE__, __func__, __VA_ARGS__)
 122
 123 #else
 124
 125 #define LOG_FUNC(suffix, level) \
 126 PA_GCC_UNUSED static void pa_log_##suffix(const char *format, ...) { \
 127     va_list ap; \
 128     va_start(ap, format); \
 129     pa_log_levelv_meta(level, NULL, 0, NULL, format, ap); \
 130     va_end(ap); \
 131 }
 132
 133 LOG_FUNC(debug, PA_LOG_DEBUG)
 134 LOG_FUNC(info, PA_LOG_INFO)
 135 LOG_FUNC(notice, PA_LOG_NOTICE)
 136 LOG_FUNC(warn, PA_LOG_WARN)
 137 LOG_FUNC(error, PA_LOG_ERROR)
 138
 139 #endif
 140
 141 #define pa_log pa_log_error
 142
 143 pa_bool_t pa_log_ratelimit(pa_log_level_t level);
 144
 145 #endif