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