include/vlog.h

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #ifndef VLOG_H
  35 #define VLOG_H 1
  36
  37 #include <limits.h>
  38 #include <stdarg.h>
  39 #include <stdbool.h>
  40 #include <time.h>
  41 #include "util.h"
  42
  43 /* Logging importance levels. */
  44 enum vlog_level {
  45     VLL_EMER,
  46     VLL_ERR,
  47     VLL_WARN,
  48     VLL_DBG,
  49     VLL_N_LEVELS
  50 };
  51
  52 const char *vlog_get_level_name(enum vlog_level);
  53 enum vlog_level vlog_get_level_val(const char *name);
  54
  55 /* Facilities that we can log to. */
  56 enum vlog_facility {
  57     VLF_SYSLOG,
  58     VLF_CONSOLE,
  59     VLF_N_FACILITIES,
  60     VLF_ANY_FACILITY = -1
  61 };
  62
  63 const char *vlog_get_facility_name(enum vlog_facility);
  64 enum vlog_facility vlog_get_facility_val(const char *name);
  65
  66 /* VLM_ constant for each vlog module. */
  67 enum vlog_module {
  68 #define VLOG_MODULE(NAME) VLM_##NAME,
  69 #include "vlog-modules.def"
  70     VLM_N_MODULES,
  71     VLM_ANY_MODULE = -1
  72 };
  73
  74 const char *vlog_get_module_name(enum vlog_module);
  75 enum vlog_module vlog_get_module_val(const char *name);
  76
  77 /* Rate-limiter for log messages. */
  78 struct vlog_rate_limit {
  79     /* Configuration settings. */
  80     unsigned int rate;          /* Tokens per second. */
  81     unsigned int burst;         /* Max cumulative tokens credit. */
  82
  83     /* Current status. */
  84     unsigned int tokens;        /* Current number of tokens. */
  85     time_t last_fill;           /* Last time tokens added. */
  86     time_t first_dropped;       /* Time first message was dropped. */
  87     unsigned int n_dropped;     /* Number of messages dropped. */
  88 };
  89
  90 /* Number of tokens to emit a message.  We add 'rate' token per second, which
  91  * is 60 times the unit used for 'rate', thus 60 tokens are required to emit
  92  * one message. */
  93 #define VLOG_MSG_TOKENS 60
  94
  95 /* Initializer for a struct vlog_rate_limit, to set up a maximum rate of RATE
  96  * messages per minute and a maximum burst size of BURST messages. */
  97 #define VLOG_RATE_LIMIT_INIT(RATE, BURST)                   \
  98         {                                                   \
  99             RATE,                           /* rate */      \
 100             (MIN(BURST, UINT_MAX / VLOG_MSG_TOKENS)         \
 101              * VLOG_MSG_TOKENS),            /* burst */     \
 102             0,                              /* tokens */    \
 103             0,                              /* last_fill */ \
 104             0,                              /* n_dropped */ \
 105         }
 106
 107 /* Configuring how each module logs messages. */
 108 enum vlog_level vlog_get_level(enum vlog_module, enum vlog_facility);
 109 void vlog_set_levels(enum vlog_module, enum vlog_facility, enum vlog_level);
 110 char *vlog_set_levels_from_string(const char *);
 111 char *vlog_get_levels(void);
 112 bool vlog_is_enabled(enum vlog_module, enum vlog_level);
 113 void vlog_set_verbosity(const char *arg);
 114
 115 /* Function for actual logging. */
 116 void vlog_init(void);
 117 void vlog_exit(void);
 118 void vlog(enum vlog_module, enum vlog_level, const char *format, ...)
 119     __attribute__((format(printf, 3, 4)));
 120 void vlog_valist(enum vlog_module, enum vlog_level, const char *, va_list)
 121     __attribute__((format(printf, 3, 0)));
 122 void vlog_rate_limit(enum vlog_module, enum vlog_level,
 123                      struct vlog_rate_limit *, const char *, ...)
 124     __attribute__((format(printf, 4, 5)));
 125
 126 /* Convenience macros.  To use these, define THIS_MODULE as a macro that
 127  * expands to the module used by the current source file, e.g.
 128  *      #include "vlog.h"
 129  *      #define THIS_MODULE VLM_netlink
 130  * Guaranteed to preserve errno.
 131  */
 132 #define VLOG_EMER(...) vlog(THIS_MODULE, VLL_EMER, __VA_ARGS__)
 133 #define VLOG_ERR(...) vlog(THIS_MODULE, VLL_ERR, __VA_ARGS__)
 134 #define VLOG_WARN(...) vlog(THIS_MODULE, VLL_WARN, __VA_ARGS__)
 135 #define VLOG_DBG(...) vlog(THIS_MODULE, VLL_DBG, __VA_ARGS__)
 136
 137 /* More convenience macros, for testing whether a given level is enabled in
 138  * THIS_MODULE.  When constructing a log message is expensive, this enables it
 139  * to be skipped. */
 140 #define VLOG_IS_EMER_ENABLED() true
 141 #define VLOG_IS_ERR_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_EMER)
 142 #define VLOG_IS_WARN_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_WARN)
 143 #define VLOG_IS_DBG_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_DBG)
 144
 145 /* Convenience macros.  To use these, define THIS_MODULE as a macro that
 146  * expands to the module used by the current source file, e.g.
 147  *      #include "vlog.h"
 148  *      #define THIS_MODULE VLM_netlink
 149  * Guaranteed to preserve errno.
 150  */
 151 #define VLOG_ERR_RL(RL, ...) \
 152         vlog_rate_limit(THIS_MODULE, VLL_ERR, RL, __VA_ARGS__)
 153 #define VLOG_WARN_RL(RL, ...) \
 154         vlog_rate_limit(THIS_MODULE, VLL_WARN, RL, __VA_ARGS__)
 155 #define VLOG_DBG_RL(RL, ...) \
 156         vlog_rate_limit(THIS_MODULE, VLL_DBG, RL, __VA_ARGS__)
 157
 158 #endif /* vlog.h */