lib/vlog.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   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 #include <limits.h>
  21 #include <stdarg.h>
  22 #include <stdbool.h>
  23 #include <time.h>
  24 #include "util.h"
  25
  26 #ifdef  __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 /* Logging importance levels.
  31  *
  32  * The following log levels, in descending order of importance, are enabled by
  33  * default:
  34  *
  35  *   - EMER: Not currently used.
  36  *
  37  *   - ERR: A high-level operation or a subsystem failed.  Attention is
  38  *     warranted.
  39  *
  40  *   - WARN: A low-level operation failed, but higher-level subsystems may be
  41  *     able to recover.
  42  *
  43  *   - INFO: Information that may be useful in retrospect when investigating
  44  *     a problem.
  45  *
  46  * The lowest log level is not enabled by default:
  47  *
  48  *   - DBG: Information useful only to someone with intricate knowledge of the
  49  *     system, or that would commonly cause too-voluminous log output.
  50  */
  51 #define VLOG_LEVELS                             \
  52     VLOG_LEVEL(EMER, LOG_ALERT)                 \
  53     VLOG_LEVEL(ERR, LOG_ERR)                    \
  54     VLOG_LEVEL(WARN, LOG_WARNING)               \
  55     VLOG_LEVEL(INFO, LOG_NOTICE)                \
  56     VLOG_LEVEL(DBG, LOG_DEBUG)
  57 enum vlog_level {
  58 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) VLL_##NAME,
  59     VLOG_LEVELS
  60 #undef VLOG_LEVEL
  61     VLL_N_LEVELS
  62 };
  63
  64 const char *vlog_get_level_name(enum vlog_level);
  65 enum vlog_level vlog_get_level_val(const char *name);
  66
  67 /* Facilities that we can log to. */
  68 #define VLOG_FACILITIES                                         \
  69     VLOG_FACILITY(SYSLOG, "%05N|%c|%p|%m")                      \
  70     VLOG_FACILITY(CONSOLE, "%d{%b %d %H:%M:%S}|%05N|%c|%p|%m")  \
  71     VLOG_FACILITY(FILE, "%d{%b %d %H:%M:%S}|%05N|%c|%p|%m")
  72 enum vlog_facility {
  73 #define VLOG_FACILITY(NAME, PATTERN) VLF_##NAME,
  74     VLOG_FACILITIES
  75 #undef VLOG_FACILITY
  76     VLF_N_FACILITIES,
  77     VLF_ANY_FACILITY = -1
  78 };
  79
  80 const char *vlog_get_facility_name(enum vlog_facility);
  81 enum vlog_facility vlog_get_facility_val(const char *name);
  82
  83 /* A log module. */
  84 struct vlog_module {
  85     const char *name;             /* User-visible name. */
  86     int levels[VLF_N_FACILITIES]; /* Minimum log level for each facility. */
  87     int min_level;                /* Minimum log level for any facility. */
  88 };
  89
  90 /* Creates and initializes a global instance of a module named MODULE. */
  91 #if USE_LINKER_SECTIONS
  92 #define VLOG_DEFINE_MODULE(MODULE)                                      \
  93         VLOG_DEFINE_MODULE__(MODULE)                                    \
  94         struct vlog_module *vlog_module_ptr_##MODULE                    \
  95             __attribute__((section("vlog_modules"))) = &VLM_##MODULE
  96 #else
  97 #define VLOG_DEFINE_MODULE(MODULE) extern struct vlog_module VLM_##MODULE
  98 #endif
  99
 100 const char *vlog_get_module_name(const struct vlog_module *);
 101 struct vlog_module *vlog_module_from_name(const char *name);
 102
 103 /* Rate-limiter for log messages. */
 104 struct vlog_rate_limit {
 105     /* Configuration settings. */
 106     unsigned int rate;          /* Tokens per second. */
 107     unsigned int burst;         /* Max cumulative tokens credit. */
 108
 109     /* Current status. */
 110     unsigned int tokens;        /* Current number of tokens. */
 111     time_t last_fill;           /* Last time tokens added. */
 112     time_t first_dropped;       /* Time first message was dropped. */
 113     unsigned int n_dropped;     /* Number of messages dropped. */
 114 };
 115
 116 /* Number of tokens to emit a message.  We add 'rate' tokens per second, which
 117  * is 60 times the unit used for 'rate', thus 60 tokens are required to emit
 118  * one message. */
 119 #define VLOG_MSG_TOKENS 60
 120
 121 /* Initializer for a struct vlog_rate_limit, to set up a maximum rate of RATE
 122  * messages per minute and a maximum burst size of BURST messages. */
 123 #define VLOG_RATE_LIMIT_INIT(RATE, BURST)                   \
 124         {                                                   \
 125             RATE,                           /* rate */      \
 126             (MIN(BURST, UINT_MAX / VLOG_MSG_TOKENS)         \
 127              * VLOG_MSG_TOKENS),            /* burst */     \
 128             0,                              /* tokens */    \
 129             0,                              /* last_fill */ \
 130             0,                              /* first_dropped */ \
 131             0,                              /* n_dropped */ \
 132         }
 133
 134 /* Configuring how each module logs messages. */
 135 enum vlog_level vlog_get_level(const struct vlog_module *, enum vlog_facility);
 136 void vlog_set_levels(struct vlog_module *,
 137                      enum vlog_facility, enum vlog_level);
 138 char *vlog_set_levels_from_string(const char *);
 139 char *vlog_get_levels(void);
 140 bool vlog_is_enabled(const struct vlog_module *, enum vlog_level);
 141 bool vlog_should_drop(const struct vlog_module *, enum vlog_level,
 142                       struct vlog_rate_limit *);
 143 void vlog_set_verbosity(const char *arg);
 144
 145 /* Configuring log facilities. */
 146 void vlog_set_pattern(enum vlog_facility, const char *pattern);
 147 const char *vlog_get_log_file(void);
 148 int vlog_set_log_file(const char *file_name);
 149 int vlog_reopen_log_file(void);
 150
 151 /* Function for actual logging. */
 152 void vlog_init(void);
 153 void vlog_exit(void);
 154 void vlog(const struct vlog_module *, enum vlog_level, const char *format, ...)
 155     __attribute__((format(printf, 3, 4)));
 156 void vlog_valist(const struct vlog_module *, enum vlog_level,
 157                  const char *, va_list)
 158     __attribute__((format(printf, 3, 0)));
 159 void vlog_rate_limit(const struct vlog_module *, enum vlog_level,
 160                      struct vlog_rate_limit *, const char *, ...)
 161     __attribute__((format(printf, 4, 5)));
 162
 163 /* Creates and initializes a global instance of a module named MODULE, and
 164  * defines a static variable named THIS_MODULE that points to it, for use with
 165  * the convenience macros below. */
 166 #define VLOG_DEFINE_THIS_MODULE(MODULE)                                 \
 167         VLOG_DEFINE_MODULE(MODULE);                                     \
 168         static struct vlog_module *const THIS_MODULE = &VLM_##MODULE
 169
 170 /* Convenience macros.  These assume that THIS_MODULE points to a "struct
 171  * vlog_module" for the current module, as set up by e.g. the
 172  * VLOG_DEFINE_MODULE macro above.
 173  *
 174  * Guaranteed to preserve errno.
 175  */
 176 #define VLOG_EMER(...) VLOG(VLL_EMER, __VA_ARGS__)
 177 #define VLOG_ERR(...) VLOG(VLL_ERR, __VA_ARGS__)
 178 #define VLOG_WARN(...) VLOG(VLL_WARN, __VA_ARGS__)
 179 #define VLOG_INFO(...) VLOG(VLL_INFO, __VA_ARGS__)
 180 #define VLOG_DBG(...) VLOG(VLL_DBG, __VA_ARGS__)
 181
 182 /* More convenience macros, for testing whether a given level is enabled in
 183  * THIS_MODULE.  When constructing a log message is expensive, this enables it
 184  * to be skipped. */
 185 #define VLOG_IS_EMER_ENABLED() true
 186 #define VLOG_IS_ERR_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_EMER)
 187 #define VLOG_IS_WARN_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_WARN)
 188 #define VLOG_IS_INFO_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_INFO)
 189 #define VLOG_IS_DBG_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_DBG)
 190
 191 /* Convenience macros for rate-limiting.
 192  * Guaranteed to preserve errno.
 193  */
 194 #define VLOG_ERR_RL(RL, ...) VLOG_RL(RL, VLL_ERR, __VA_ARGS__)
 195 #define VLOG_WARN_RL(RL, ...) VLOG_RL(RL, VLL_WARN, __VA_ARGS__)
 196 #define VLOG_INFO_RL(RL, ...) VLOG_RL(RL, VLL_INFO, __VA_ARGS__)
 197 #define VLOG_DBG_RL(RL, ...) VLOG_RL(RL, VLL_DBG, __VA_ARGS__)
 198
 199 #define VLOG_DROP_ERR(RL) vlog_should_drop(THIS_MODULE, VLL_ERR, RL)
 200 #define VLOG_DROP_WARN(RL) vlog_should_drop(THIS_MODULE, VLL_WARN, RL)
 201 #define VLOG_DROP_INFO(RL) vlog_should_drop(THIS_MODULE, VLL_INFO, RL)
 202 #define VLOG_DROP_DBG(RL) vlog_should_drop(THIS_MODULE, VLL_DBG, RL)
 203
 204 /* Macros for logging at most once per execution. */
 205 #define VLOG_ERR_ONCE(...) VLOG_ONCE(VLL_ERR, __VA_ARGS__)
 206 #define VLOG_WARN_ONCE(...) VLOG_ONCE(VLL_WARN, __VA_ARGS__)
 207 #define VLOG_INFO_ONCE(...) VLOG_ONCE(VLL_INFO, __VA_ARGS__)
 208 #define VLOG_DBG_ONCE(...) VLOG_ONCE(VLL_DBG, __VA_ARGS__)
 209
 210 /* Command line processing. */
 211 #define VLOG_OPTION_ENUMS OPT_LOG_FILE
 212 #define VLOG_LONG_OPTIONS                                   \
 213         {"verbose",     optional_argument, 0, 'v'},         \
 214         {"log-file",    optional_argument, 0, OPT_LOG_FILE}
 215 #define VLOG_OPTION_HANDLERS                    \
 216         case 'v':                               \
 217             vlog_set_verbosity(optarg);         \
 218             break;                              \
 219         case OPT_LOG_FILE:                      \
 220             vlog_set_log_file(optarg);          \
 221             break;
 222 void vlog_usage(void);
 223
 224 /* Implementation details. */
 225 #define VLOG(LEVEL, ...)                            \
 226     do {                                            \
 227         if (THIS_MODULE->min_level >= LEVEL) {      \
 228             vlog(THIS_MODULE, LEVEL, __VA_ARGS__);  \
 229         }                                           \
 230     } while (0)
 231 #define VLOG_RL(RL, LEVEL, ...)                                     \
 232     do {                                                            \
 233         if (THIS_MODULE->min_level >= LEVEL) {                      \
 234             vlog_rate_limit(THIS_MODULE, LEVEL, RL, __VA_ARGS__);   \
 235         }                                                           \
 236     } while (0)
 237 #define VLOG_ONCE(LEVEL, ...)                       \
 238     do {                                            \
 239         static bool already_logged;                 \
 240         if (!already_logged) {                      \
 241             already_logged = true;                  \
 242             vlog(THIS_MODULE, LEVEL, __VA_ARGS__);  \
 243         }                                           \
 244     } while (0)
 245
 246 #define VLOG_DEFINE_MODULE__(MODULE)                                    \
 247         struct vlog_module VLM_##MODULE =                               \
 248         {                                                               \
 249             #MODULE,                                      /* name */    \
 250             { [ 0 ... VLF_N_FACILITIES - 1] = VLL_INFO }, /* levels */  \
 251             VLL_INFO,                                     /* min_level */ \
 252         };
 253
 254 #ifdef  __cplusplus
 255 }
 256 #endif
 257
 258
 259 #endif /* vlog.h */