lib/vlog.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef VLOG_H
  18 #define VLOG_H 1
  19
  20 /* Logging.
  21  *
  22  *
  23  * Thread-safety
  24  * =============
  25  *
  26  * Fully thread safe.
  27  */
  28
  29 #include <limits.h>
  30 #include <stdarg.h>
  31 #include <stdbool.h>
  32 #include <time.h>
  33 #include "compiler.h"
  34 #include "ovs-thread.h"
  35 #include "sat-math.h"
  36 #include "token-bucket.h"
  37 #include "util.h"
  38
  39 #ifdef  __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /* Logging severity levels.
  44  *
  45  * ovs-appctl(8) defines each of the log levels. */
  46 #define VLOG_LEVELS                             \
  47     VLOG_LEVEL(OFF, LOG_ALERT)                  \
  48     VLOG_LEVEL(EMER, LOG_ALERT)                 \
  49     VLOG_LEVEL(ERR, LOG_ERR)                    \
  50     VLOG_LEVEL(WARN, LOG_WARNING)               \
  51     VLOG_LEVEL(INFO, LOG_NOTICE)                \
  52     VLOG_LEVEL(DBG, LOG_DEBUG)
  53 enum vlog_level {
  54 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) VLL_##NAME,
  55     VLOG_LEVELS
  56 #undef VLOG_LEVEL
  57     VLL_N_LEVELS
  58 };
  59
  60 const char *vlog_get_level_name(enum vlog_level);
  61 enum vlog_level vlog_get_level_val(const char *name);
  62
  63 /* Facilities that we can log to. */
  64 #define VLOG_FACILITIES                                                 \
  65     VLOG_FACILITY(SYSLOG, "ovs|%05N|%c%T|%p|%m")                            \
  66     VLOG_FACILITY(CONSOLE, "%D{%Y-%m-%dT%H:%M:%SZ}|%05N|%c%T|%p|%m")    \
  67     VLOG_FACILITY(FILE, "%D{%Y-%m-%dT%H:%M:%SZ}|%05N|%c%T|%p|%m")
  68 enum vlog_facility {
  69 #define VLOG_FACILITY(NAME, PATTERN) VLF_##NAME,
  70     VLOG_FACILITIES
  71 #undef VLOG_FACILITY
  72     VLF_N_FACILITIES,
  73     VLF_ANY_FACILITY = -1
  74 };
  75
  76 const char *vlog_get_facility_name(enum vlog_facility);
  77 enum vlog_facility vlog_get_facility_val(const char *name);
  78
  79 /* A log module. */
  80 struct vlog_module {
  81     const char *name;             /* User-visible name. */
  82     int levels[VLF_N_FACILITIES]; /* Minimum log level for each facility. */
  83     int min_level;                /* Minimum log level for any facility. */
  84     bool honor_rate_limits;       /* Set false to ignore rate limits. */
  85 };
  86
  87 /* Creates and initializes a global instance of a module named MODULE. */
  88 #if USE_LINKER_SECTIONS
  89 #define VLOG_DEFINE_MODULE(MODULE)                                      \
  90         VLOG_DEFINE_MODULE__(MODULE)                                    \
  91         extern struct vlog_module *const vlog_module_ptr_##MODULE;      \
  92         struct vlog_module *const vlog_module_ptr_##MODULE              \
  93             __attribute__((section("vlog_modules"))) = &VLM_##MODULE
  94 #else
  95 #define VLOG_DEFINE_MODULE(MODULE) extern struct vlog_module VLM_##MODULE
  96 #endif
  97
  98 const char *vlog_get_module_name(const struct vlog_module *);
  99 struct vlog_module *vlog_module_from_name(const char *name);
 100
 101 /* Rate-limiter for log messages. */
 102 struct vlog_rate_limit {
 103     struct token_bucket token_bucket;
 104     time_t first_dropped;       /* Time first message was dropped. */
 105     time_t last_dropped;        /* Time of most recent message drop. */
 106     unsigned int n_dropped;     /* Number of messages dropped. */
 107     pthread_mutex_t mutex;      /* Mutual exclusion for rate limit. */
 108 };
 109
 110 /* Number of tokens to emit a message.  We add 'rate' tokens per millisecond,
 111  * thus 60,000 tokens are required to emit one message per minute. */
 112 #define VLOG_MSG_TOKENS (60 * 1000)
 113
 114 /* Initializer for a struct vlog_rate_limit, to set up a maximum rate of RATE
 115  * messages per minute and a maximum burst size of BURST messages. */
 116 #define VLOG_RATE_LIMIT_INIT(RATE, BURST)                               \
 117         {                                                               \
 118             TOKEN_BUCKET_INIT(RATE, SAT_MUL(BURST, VLOG_MSG_TOKENS)),   \
 119             0,                              /* first_dropped */         \
 120             0,                              /* last_dropped */          \
 121             0,                              /* n_dropped */             \
 122             PTHREAD_ADAPTIVE_MUTEX_INITIALIZER /* mutex */              \
 123         }
 124
 125 /* Configuring how each module logs messages. */
 126 enum vlog_level vlog_get_level(const struct vlog_module *, enum vlog_facility);
 127 void vlog_set_levels(struct vlog_module *,
 128                      enum vlog_facility, enum vlog_level);
 129 char *vlog_set_levels_from_string(const char *) WARN_UNUSED_RESULT;
 130 void vlog_set_levels_from_string_assert(const char *);
 131 char *vlog_get_levels(void);
 132 bool vlog_is_enabled(const struct vlog_module *, enum vlog_level);
 133 bool vlog_should_drop(const struct vlog_module *, enum vlog_level,
 134                       struct vlog_rate_limit *);
 135 void vlog_set_verbosity(const char *arg);
 136
 137 /* Configuring log facilities. */
 138 void vlog_set_pattern(enum vlog_facility, const char *pattern);
 139 int vlog_set_log_file(const char *file_name);
 140 int vlog_reopen_log_file(void);
 141
 142 /* Initialization. */
 143 void vlog_init(void);
 144
 145 /* Functions for actual logging. */
 146 void vlog(const struct vlog_module *, enum vlog_level, const char *format, ...)
 147     PRINTF_FORMAT (3, 4);
 148 void vlog_valist(const struct vlog_module *, enum vlog_level,
 149                  const char *, va_list)
 150     PRINTF_FORMAT (3, 0);
 151
 152 void vlog_fatal(const struct vlog_module *, const char *format, ...)
 153     PRINTF_FORMAT (2, 3) NO_RETURN;
 154 void vlog_fatal_valist(const struct vlog_module *, const char *format, va_list)
 155     PRINTF_FORMAT (2, 0) NO_RETURN;
 156
 157 void vlog_abort(const struct vlog_module *, const char *format, ...)
 158     PRINTF_FORMAT (2, 3) NO_RETURN;
 159 void vlog_abort_valist(const struct vlog_module *, const char *format, va_list)
 160     PRINTF_FORMAT (2, 0) NO_RETURN;
 161
 162 void vlog_rate_limit(const struct vlog_module *, enum vlog_level,
 163                      struct vlog_rate_limit *, const char *, ...)
 164     PRINTF_FORMAT (4, 5);
 165
 166 /* Creates and initializes a global instance of a module named MODULE, and
 167  * defines a static variable named THIS_MODULE that points to it, for use with
 168  * the convenience macros below. */
 169 #define VLOG_DEFINE_THIS_MODULE(MODULE)                                 \
 170         VLOG_DEFINE_MODULE(MODULE);                                     \
 171         static struct vlog_module *const THIS_MODULE = &VLM_##MODULE
 172
 173 /* Convenience macros.  These assume that THIS_MODULE points to a "struct
 174  * vlog_module" for the current module, as set up by e.g. the
 175  * VLOG_DEFINE_MODULE macro above.
 176  *
 177  * Guaranteed to preserve errno.
 178  */
 179 #define VLOG_FATAL(...) vlog_fatal(THIS_MODULE, __VA_ARGS__)
 180 #define VLOG_ABORT(...) vlog_abort(THIS_MODULE, __VA_ARGS__)
 181 #define VLOG_EMER(...) VLOG(VLL_EMER, __VA_ARGS__)
 182 #define VLOG_ERR(...) VLOG(VLL_ERR, __VA_ARGS__)
 183 #define VLOG_WARN(...) VLOG(VLL_WARN, __VA_ARGS__)
 184 #define VLOG_INFO(...) VLOG(VLL_INFO, __VA_ARGS__)
 185 #define VLOG_DBG(...) VLOG(VLL_DBG, __VA_ARGS__)
 186
 187 /* More convenience macros, for testing whether a given level is enabled in
 188  * THIS_MODULE.  When constructing a log message is expensive, this enables it
 189  * to be skipped. */
 190 #define VLOG_IS_ERR_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_ERR)
 191 #define VLOG_IS_WARN_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_WARN)
 192 #define VLOG_IS_INFO_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_INFO)
 193 #define VLOG_IS_DBG_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_DBG)
 194
 195 /* Convenience macros for rate-limiting.
 196  * Guaranteed to preserve errno.
 197  */
 198 #define VLOG_ERR_RL(RL, ...) VLOG_RL(RL, VLL_ERR, __VA_ARGS__)
 199 #define VLOG_WARN_RL(RL, ...) VLOG_RL(RL, VLL_WARN, __VA_ARGS__)
 200 #define VLOG_INFO_RL(RL, ...) VLOG_RL(RL, VLL_INFO, __VA_ARGS__)
 201 #define VLOG_DBG_RL(RL, ...) VLOG_RL(RL, VLL_DBG, __VA_ARGS__)
 202
 203 #define VLOG_DROP_ERR(RL) vlog_should_drop(THIS_MODULE, VLL_ERR, RL)
 204 #define VLOG_DROP_WARN(RL) vlog_should_drop(THIS_MODULE, VLL_WARN, RL)
 205 #define VLOG_DROP_INFO(RL) vlog_should_drop(THIS_MODULE, VLL_INFO, RL)
 206 #define VLOG_DROP_DBG(RL) vlog_should_drop(THIS_MODULE, VLL_DBG, RL)
 207
 208 /* Macros for logging at most once per execution. */
 209 #define VLOG_ERR_ONCE(...) VLOG_ONCE(VLL_ERR, __VA_ARGS__)
 210 #define VLOG_WARN_ONCE(...) VLOG_ONCE(VLL_WARN, __VA_ARGS__)
 211 #define VLOG_INFO_ONCE(...) VLOG_ONCE(VLL_INFO, __VA_ARGS__)
 212 #define VLOG_DBG_ONCE(...) VLOG_ONCE(VLL_DBG, __VA_ARGS__)
 213
 214 /* Command line processing. */
 215 #define VLOG_OPTION_ENUMS OPT_LOG_FILE
 216 #define VLOG_LONG_OPTIONS                                   \
 217         {"verbose",     optional_argument, NULL, 'v'},         \
 218         {"log-file",    optional_argument, NULL, OPT_LOG_FILE}
 219 #define VLOG_OPTION_HANDLERS                    \
 220         case 'v':                               \
 221             vlog_set_verbosity(optarg);         \
 222             break;                              \
 223         case OPT_LOG_FILE:                      \
 224             vlog_set_log_file(optarg);          \
 225             break;
 226 void vlog_usage(void);
 227
 228 /* Implementation details. */
 229 #define VLOG(LEVEL, ...)                                \
 230     do {                                                \
 231         enum vlog_level level__ = LEVEL;                \
 232         if (THIS_MODULE->min_level >= level__) {        \
 233             vlog(THIS_MODULE, level__, __VA_ARGS__);    \
 234         }                                               \
 235     } while (0)
 236 #define VLOG_RL(RL, LEVEL, ...)                                     \
 237     do {                                                            \
 238         enum vlog_level level__ = LEVEL;                            \
 239         if (THIS_MODULE->min_level >= level__) {                    \
 240             vlog_rate_limit(THIS_MODULE, level__, RL, __VA_ARGS__); \
 241         }                                                           \
 242     } while (0)
 243 #define VLOG_ONCE(LEVEL, ...)                                           \
 244     do {                                                                \
 245         static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER; \
 246         if (ovsthread_once_start(&once)) {                              \
 247             vlog(THIS_MODULE, LEVEL, __VA_ARGS__);                      \
 248             ovsthread_once_done(&once);                                 \
 249         }                                                               \
 250     } while (0)
 251
 252 #define VLOG_DEFINE_MODULE__(MODULE)                                    \
 253         extern struct vlog_module VLM_##MODULE;                         \
 254         struct vlog_module VLM_##MODULE =                               \
 255         {                                                               \
 256             #MODULE,                                        /* name */  \
 257             { [ 0 ... VLF_N_FACILITIES - 1] = VLL_INFO }, /* levels */  \
 258             VLL_INFO,                                  /* min_level */  \
 259             true                               /* honor_rate_limits */  \
 260         };
 261
 262 #ifdef  __cplusplus
 263 }
 264 #endif
 265
 266
 267 #endif /* vlog.h */