1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
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:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
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
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.
45 #include "dynamic-string.h"
50 #define THIS_MODULE VLM_vlog
52 /* Name for each logging level. */
53 static const char *level_names[VLL_N_LEVELS] = {
60 /* Name for each logging facility. */
61 static const char *facility_names[VLF_N_FACILITIES] = {
62 [VLF_CONSOLE] = "console",
63 [VLF_SYSLOG] = "syslog",
66 /* Name for each logging module */
67 static const char *module_names[VLM_N_MODULES] = {
68 #define VLOG_MODULE(NAME) #NAME,
69 #include "vlog-modules.def"
72 static int levels[VLM_N_MODULES][VLF_N_FACILITIES];
74 /* Searches the 'n_names' in 'names'. Returns the index of a match for
75 * 'target', or 'n_names' if no name matches. */
77 search_name_array(const char *target, const char **names, size_t n_names)
81 for (i = 0; i < n_names; i++) {
83 if (!strcasecmp(names[i], target)) {
90 /* Returns the name for logging level 'level'. */
92 vlog_get_level_name(enum vlog_level level)
94 assert(level < VLL_N_LEVELS);
95 return level_names[level];
98 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
99 * is not the name of a logging level. */
101 vlog_get_level_val(const char *name)
103 return search_name_array(name, level_names, ARRAY_SIZE(level_names));
106 /* Returns the name for logging facility 'facility'. */
108 vlog_get_facility_name(enum vlog_facility facility)
110 assert(facility < VLF_N_FACILITIES);
111 return facility_names[facility];
114 /* Returns the logging facility named 'name', or VLF_N_FACILITIES if 'name' is
115 * not the name of a logging facility. */
117 vlog_get_facility_val(const char *name)
119 return search_name_array(name, facility_names, ARRAY_SIZE(facility_names));
122 /* Returns the name for logging module 'module'. */
123 const char *vlog_get_module_name(enum vlog_module module)
125 assert(module < VLM_N_MODULES);
126 return module_names[module];
129 /* Returns the logging module named 'name', or VLM_N_MODULES if 'name' is not
130 * the name of a logging module. */
132 vlog_get_module_val(const char *name)
134 return search_name_array(name, module_names, ARRAY_SIZE(module_names));
137 /* Returns the current logging level for the given 'module' and 'facility'. */
139 vlog_get_level(enum vlog_module module, enum vlog_facility facility)
141 assert(module < VLM_N_MODULES);
142 assert(facility < VLF_N_FACILITIES);
143 return levels[module][facility];
147 set_facility_level(enum vlog_facility facility, enum vlog_module module,
148 enum vlog_level level)
150 assert(facility >= 0 && facility < VLF_N_FACILITIES);
151 assert(level < VLL_N_LEVELS);
153 if (module == VLM_ANY_MODULE) {
154 for (module = 0; module < VLM_N_MODULES; module++) {
155 levels[module][facility] = level;
158 levels[module][facility] = level;
162 /* Sets the logging level for the given 'module' and 'facility' to 'level'. */
164 vlog_set_levels(enum vlog_module module, enum vlog_facility facility,
165 enum vlog_level level)
167 assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
168 if (facility == VLF_ANY_FACILITY) {
169 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
170 set_facility_level(facility, module, level);
173 set_facility_level(facility, module, level);
177 /* Set debugging levels:
179 * mod[:facility[:level]] mod2[:facility[:level]] ...
181 * Return null if successful, otherwise an error message that the caller must
185 vlog_set_levels_from_string(const char *s_)
188 char *s = xstrdup(s_);
189 char *module, *level, *facility;
191 for (module = strtok_r(s, ": \t", &save_ptr); module != NULL;
192 module = strtok_r(NULL, ": \t", &save_ptr)) {
193 enum vlog_module e_module;
194 enum vlog_level e_level;
195 enum vlog_facility e_facility;
197 facility = strtok_r(NULL, ":", &save_ptr);
198 level = strtok_r(NULL, ":", &save_ptr);
200 if (!strcmp(module, "ANY")) {
201 e_module = VLM_ANY_MODULE;
203 e_module = vlog_get_module_val(module);
204 if (e_module >= VLM_N_MODULES) {
205 char *msg = xasprintf("unknown module \"%s\"", module);
211 if (!facility || !strcmp(facility, "ANY")) {
212 e_facility = VLF_ANY_FACILITY;
214 e_facility = vlog_get_facility_val(facility);
215 if (e_facility >= VLF_N_FACILITIES) {
216 char *msg = xasprintf("unknown facility \"%s\"", facility);
222 e_level = level ? vlog_get_level_val(level) : VLL_DBG;
223 if (e_level >= VLL_N_LEVELS) {
224 char *msg = xasprintf("unknown level \"%s\"", level);
229 vlog_set_levels(e_module, e_facility, e_level);
235 /* If 'arg' is null, configure maximum verbosity. Otherwise, sets
236 * configuration according to 'arg' (see vlog_set_levels_from_string()). */
238 vlog_set_verbosity(const char *arg)
241 char *msg = vlog_set_levels_from_string(arg);
243 fatal(0, "processing \"%s\": %s", arg, msg);
246 vlog_set_levels(VLM_ANY_MODULE, VLF_ANY_FACILITY, VLL_DBG);
250 /* Initializes the logging subsystem. */
256 openlog(program_name, LOG_NDELAY, LOG_DAEMON);
257 vlog_set_levels(VLM_ANY_MODULE, VLF_ANY_FACILITY, VLL_WARN);
264 localtime_r(&now, &tm);
265 strftime(s, sizeof s, "%a, %d %b %Y %H:%M:%S %z", &tm);
266 VLOG_ERR("current time is negative: %s (%ld)", s, (long int) now);
270 /* Closes the logging subsystem. */
277 /* Print the current logging level for each module. */
279 vlog_get_levels(void)
281 struct ds s = DS_EMPTY_INITIALIZER;
282 enum vlog_module module;
284 ds_put_format(&s, " console syslog\n");
285 ds_put_format(&s, " ------- ------\n");
287 for (module = 0; module < VLM_N_MODULES; module++) {
288 ds_put_format(&s, "%-16s %4s %4s\n",
289 vlog_get_module_name(module),
290 vlog_get_level_name(vlog_get_level(module, VLF_CONSOLE)),
291 vlog_get_level_name(vlog_get_level(module, VLF_SYSLOG)));
297 /* Returns true if a log message emitted for the given 'module' and 'level'
298 * would cause some log output, false if that module and level are completely
301 vlog_is_enabled(enum vlog_module module, enum vlog_level level)
303 return (levels[module][VLF_CONSOLE] >= level
304 || levels[module][VLF_SYSLOG] >= level);
307 /* Writes 'message' to the log at the given 'level' and as coming from the
310 * Guaranteed to preserve errno. */
312 vlog_valist(enum vlog_module module, enum vlog_level level,
313 const char *message, va_list args)
315 bool log_console = levels[module][VLF_CONSOLE] >= level;
316 bool log_syslog = levels[module][VLF_SYSLOG] >= level;
317 if (log_console || log_syslog) {
318 int save_errno = errno;
320 const char *module_name = vlog_get_module_name(module);
321 const char *level_name = vlog_get_level_name(level);
328 localtime_r(&now, &tm);
330 /* Compose log message. */
332 ds_reserve(&s, 1024);
333 ds_put_strftime(&s, "%b %d %H:%M:%S|", &tm);
335 ds_put_format(&s, "%05d|%s|%s:", ++msg_num, module_name, level_name);
336 ds_put_format_valist(&s, message, args);
340 fprintf(stderr, "%s\n", s.string);
344 static const int syslog_levels[VLL_N_LEVELS] = {
345 [VLL_EMER] = LOG_ALERT,
347 [VLL_WARN] = LOG_WARNING,
348 [VLL_DBG] = LOG_DEBUG,
350 char *save_ptr = NULL;
353 for (line = strtok_r(&s.string[time_len], "\n", &save_ptr); line;
354 line = strtok_r(NULL, "\n", &save_ptr)) {
355 syslog(syslog_levels[level], "%s", line);
365 vlog(enum vlog_module module, enum vlog_level level, const char *message, ...)
369 va_start(args, message);
370 vlog_valist(module, level, message, args);
375 vlog_rate_limit(enum vlog_module module, enum vlog_level level,
376 struct vlog_rate_limit *rl, const char *message, ...)
380 if (!vlog_is_enabled(module, level)) {
384 if (rl->tokens < VLOG_MSG_TOKENS) {
385 time_t now = time_now();
386 if (rl->last_fill > now) {
387 /* Last filled in the future? Time must have gone backward, or
388 * 'rl' has not been used before. */
389 rl->tokens = rl->burst;
390 } else if (rl->last_fill < now) {
391 unsigned int add = sat_mul(rl->rate, now - rl->last_fill);
392 unsigned int tokens = sat_add(rl->tokens, add);
393 rl->tokens = MIN(tokens, rl->burst);
396 if (rl->tokens < VLOG_MSG_TOKENS) {
397 if (!rl->n_dropped) {
398 rl->first_dropped = now;
404 rl->tokens -= VLOG_MSG_TOKENS;
406 va_start(args, message);
407 vlog_valist(module, level, message, args);
412 "Dropped %u messages in last %u seconds due to excessive rate",
413 rl->n_dropped, (unsigned int) (time_now() - rl->first_dropped));