2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
34 #include "ovs-thread.h"
36 #include "token-bucket.h"
43 /* Logging severity levels.
45 * ovs-appctl(8) defines each of the log levels. */
47 VLOG_LEVEL(OFF, LOG_ALERT, 1) \
48 VLOG_LEVEL(EMER, LOG_ALERT, 1) \
49 VLOG_LEVEL(ERR, LOG_ERR, 3) \
50 VLOG_LEVEL(WARN, LOG_WARNING, 4) \
51 VLOG_LEVEL(INFO, LOG_NOTICE, 5) \
52 VLOG_LEVEL(DBG, LOG_DEBUG, 7)
54 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424_LEVEL) VLL_##NAME,
60 const char *vlog_get_level_name(enum vlog_level);
61 enum vlog_level vlog_get_level_val(const char *name);
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:%S.###Z}|%05N|%c%T|%p|%m")
69 #define VLOG_FACILITY(NAME, PATTERN) VLF_##NAME,
76 const char *vlog_get_facility_name(enum vlog_facility);
77 enum vlog_facility vlog_get_facility_val(const char *name);
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. */
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
95 #define VLOG_DEFINE_MODULE(MODULE) extern struct vlog_module VLM_##MODULE
98 const char *vlog_get_module_name(const struct vlog_module *);
99 struct vlog_module *vlog_module_from_name(const char *name);
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 struct ovs_mutex mutex; /* Mutual exclusion for rate limit. */
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)
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) \
118 TOKEN_BUCKET_INIT(RATE, SAT_MUL(BURST, VLOG_MSG_TOKENS)), \
119 0, /* first_dropped */ \
120 0, /* last_dropped */ \
122 OVS_MUTEX_INITIALIZER /* mutex */ \
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);
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);
142 /* Configure syslog target. */
143 void vlog_set_syslog_target(const char *target);
145 /* Initialization. */
146 void vlog_init(void);
147 void vlog_enable_async(void);
149 /* Functions for actual logging. */
150 void vlog(const struct vlog_module *, enum vlog_level, const char *format, ...)
151 PRINTF_FORMAT (3, 4);
152 void vlog_valist(const struct vlog_module *, enum vlog_level,
153 const char *, va_list)
154 PRINTF_FORMAT (3, 0);
156 void vlog_fatal(const struct vlog_module *, const char *format, ...)
157 PRINTF_FORMAT (2, 3) NO_RETURN;
158 void vlog_fatal_valist(const struct vlog_module *, const char *format, va_list)
159 PRINTF_FORMAT (2, 0) NO_RETURN;
161 void vlog_abort(const struct vlog_module *, const char *format, ...)
162 PRINTF_FORMAT (2, 3) NO_RETURN;
163 void vlog_abort_valist(const struct vlog_module *, const char *format, va_list)
164 PRINTF_FORMAT (2, 0) NO_RETURN;
166 void vlog_rate_limit(const struct vlog_module *, enum vlog_level,
167 struct vlog_rate_limit *, const char *, ...)
168 PRINTF_FORMAT (4, 5);
170 /* Creates and initializes a global instance of a module named MODULE, and
171 * defines a static variable named THIS_MODULE that points to it, for use with
172 * the convenience macros below. */
173 #define VLOG_DEFINE_THIS_MODULE(MODULE) \
174 VLOG_DEFINE_MODULE(MODULE); \
175 static struct vlog_module *const THIS_MODULE = &VLM_##MODULE
177 /* Convenience macros. These assume that THIS_MODULE points to a "struct
178 * vlog_module" for the current module, as set up by e.g. the
179 * VLOG_DEFINE_MODULE macro above.
181 * Guaranteed to preserve errno.
183 #define VLOG_FATAL(...) vlog_fatal(THIS_MODULE, __VA_ARGS__)
184 #define VLOG_ABORT(...) vlog_abort(THIS_MODULE, __VA_ARGS__)
185 #define VLOG_EMER(...) VLOG(VLL_EMER, __VA_ARGS__)
186 #define VLOG_ERR(...) VLOG(VLL_ERR, __VA_ARGS__)
187 #define VLOG_WARN(...) VLOG(VLL_WARN, __VA_ARGS__)
188 #define VLOG_INFO(...) VLOG(VLL_INFO, __VA_ARGS__)
189 #define VLOG_DBG(...) VLOG(VLL_DBG, __VA_ARGS__)
191 /* More convenience macros, for testing whether a given level is enabled in
192 * THIS_MODULE. When constructing a log message is expensive, this enables it
194 #define VLOG_IS_ERR_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_ERR)
195 #define VLOG_IS_WARN_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_WARN)
196 #define VLOG_IS_INFO_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_INFO)
197 #define VLOG_IS_DBG_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_DBG)
199 /* Convenience macros for rate-limiting.
200 * Guaranteed to preserve errno.
202 #define VLOG_ERR_RL(RL, ...) VLOG_RL(RL, VLL_ERR, __VA_ARGS__)
203 #define VLOG_WARN_RL(RL, ...) VLOG_RL(RL, VLL_WARN, __VA_ARGS__)
204 #define VLOG_INFO_RL(RL, ...) VLOG_RL(RL, VLL_INFO, __VA_ARGS__)
205 #define VLOG_DBG_RL(RL, ...) VLOG_RL(RL, VLL_DBG, __VA_ARGS__)
207 #define VLOG_DROP_ERR(RL) vlog_should_drop(THIS_MODULE, VLL_ERR, RL)
208 #define VLOG_DROP_WARN(RL) vlog_should_drop(THIS_MODULE, VLL_WARN, RL)
209 #define VLOG_DROP_INFO(RL) vlog_should_drop(THIS_MODULE, VLL_INFO, RL)
210 #define VLOG_DROP_DBG(RL) vlog_should_drop(THIS_MODULE, VLL_DBG, RL)
212 /* Macros for logging at most once per execution. */
213 #define VLOG_ERR_ONCE(...) VLOG_ONCE(VLL_ERR, __VA_ARGS__)
214 #define VLOG_WARN_ONCE(...) VLOG_ONCE(VLL_WARN, __VA_ARGS__)
215 #define VLOG_INFO_ONCE(...) VLOG_ONCE(VLL_INFO, __VA_ARGS__)
216 #define VLOG_DBG_ONCE(...) VLOG_ONCE(VLL_DBG, __VA_ARGS__)
218 /* Command line processing. */
219 #define VLOG_OPTION_ENUMS \
223 #define VLOG_LONG_OPTIONS \
224 {"verbose", optional_argument, NULL, 'v'}, \
225 {"log-file", optional_argument, NULL, OPT_LOG_FILE}, \
226 {"syslog-target", optional_argument, NULL, OPT_SYSLOG_TARGET}
228 #define VLOG_OPTION_HANDLERS \
230 vlog_set_verbosity(optarg); \
233 vlog_set_log_file(optarg); \
235 case OPT_SYSLOG_TARGET: \
236 vlog_set_syslog_target(optarg); \
239 void vlog_usage(void);
241 /* Implementation details. */
242 #define VLOG(LEVEL, ...) \
244 enum vlog_level level__ = LEVEL; \
245 if (THIS_MODULE->min_level >= level__) { \
246 vlog(THIS_MODULE, level__, __VA_ARGS__); \
249 #define VLOG_RL(RL, LEVEL, ...) \
251 enum vlog_level level__ = LEVEL; \
252 if (THIS_MODULE->min_level >= level__) { \
253 vlog_rate_limit(THIS_MODULE, level__, RL, __VA_ARGS__); \
256 #define VLOG_ONCE(LEVEL, ...) \
258 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER; \
259 if (ovsthread_once_start(&once)) { \
260 vlog(THIS_MODULE, LEVEL, __VA_ARGS__); \
261 ovsthread_once_done(&once); \
265 #define VLOG_DEFINE_MODULE__(MODULE) \
266 extern struct vlog_module VLM_##MODULE; \
267 struct vlog_module VLM_##MODULE = \
269 #MODULE, /* name */ \
270 { [ 0 ... VLF_N_FACILITIES - 1] = VLL_INFO }, /* levels */ \
271 VLL_INFO, /* min_level */ \
272 true /* honor_rate_limits */ \