2 * Copyright (c) 2008, 2009 Nicira Networks.
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.
25 #include <sys/types.h>
30 #include "dynamic-string.h"
36 #define THIS_MODULE VLM_vlog
38 /* Name for each logging level. */
39 static const char *level_names[VLL_N_LEVELS] = {
40 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) #NAME,
45 /* Syslog value for each logging level. */
46 static int syslog_levels[VLL_N_LEVELS] = {
47 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) SYSLOG_LEVEL,
52 /* Name for each logging module */
53 static const char *module_names[VLM_N_MODULES] = {
54 #define VLOG_MODULE(NAME) #NAME,
55 #include "vlog-modules.def"
59 /* Information about each facility. */
61 const char *name; /* Name. */
62 char *pattern; /* Current pattern. */
63 bool default_pattern; /* Whether current pattern is the default. */
65 static struct facility facilities[VLF_N_FACILITIES] = {
66 #define VLOG_FACILITY(NAME, PATTERN) {#NAME, PATTERN, true},
71 /* Current log levels. */
72 static int levels[VLM_N_MODULES][VLF_N_FACILITIES];
74 /* For fast checking whether we're logging anything for a given module and
76 enum vlog_level min_vlog_levels[VLM_N_MODULES];
78 /* Time at which vlog was initialized, in milliseconds. */
79 static long long int boot_time;
81 /* VLF_FILE configuration. */
82 static char *log_file_name;
83 static FILE *log_file;
85 static void format_log_message(enum vlog_module, enum vlog_level,
86 enum vlog_facility, unsigned int msg_num,
87 const char *message, va_list, struct ds *)
90 /* Searches the 'n_names' in 'names'. Returns the index of a match for
91 * 'target', or 'n_names' if no name matches. */
93 search_name_array(const char *target, const char **names, size_t n_names)
97 for (i = 0; i < n_names; i++) {
99 if (!strcasecmp(names[i], target)) {
106 /* Returns the name for logging level 'level'. */
108 vlog_get_level_name(enum vlog_level level)
110 assert(level < VLL_N_LEVELS);
111 return level_names[level];
114 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
115 * is not the name of a logging level. */
117 vlog_get_level_val(const char *name)
119 return search_name_array(name, level_names, ARRAY_SIZE(level_names));
122 /* Returns the name for logging facility 'facility'. */
124 vlog_get_facility_name(enum vlog_facility facility)
126 assert(facility < VLF_N_FACILITIES);
127 return facilities[facility].name;
130 /* Returns the logging facility named 'name', or VLF_N_FACILITIES if 'name' is
131 * not the name of a logging facility. */
133 vlog_get_facility_val(const char *name)
137 for (i = 0; i < VLF_N_FACILITIES; i++) {
138 if (!strcasecmp(facilities[i].name, name)) {
145 /* Returns the name for logging module 'module'. */
146 const char *vlog_get_module_name(enum vlog_module module)
148 assert(module < VLM_N_MODULES);
149 return module_names[module];
152 /* Returns the logging module named 'name', or VLM_N_MODULES if 'name' is not
153 * the name of a logging module. */
155 vlog_get_module_val(const char *name)
157 return search_name_array(name, module_names, ARRAY_SIZE(module_names));
160 /* Returns the current logging level for the given 'module' and 'facility'. */
162 vlog_get_level(enum vlog_module module, enum vlog_facility facility)
164 assert(module < VLM_N_MODULES);
165 assert(facility < VLF_N_FACILITIES);
166 return levels[module][facility];
170 update_min_level(enum vlog_module module)
172 enum vlog_level min_level = VLL_EMER;
173 enum vlog_facility facility;
175 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
176 if (log_file || facility != VLF_FILE) {
177 min_level = MAX(min_level, levels[module][facility]);
180 min_vlog_levels[module] = min_level;
184 set_facility_level(enum vlog_facility facility, enum vlog_module module,
185 enum vlog_level level)
187 assert(facility >= 0 && facility < VLF_N_FACILITIES);
188 assert(level < VLL_N_LEVELS);
190 if (module == VLM_ANY_MODULE) {
191 for (module = 0; module < VLM_N_MODULES; module++) {
192 levels[module][facility] = level;
193 update_min_level(module);
196 levels[module][facility] = level;
197 update_min_level(module);
201 /* Sets the logging level for the given 'module' and 'facility' to 'level'. */
203 vlog_set_levels(enum vlog_module module, enum vlog_facility facility,
204 enum vlog_level level)
206 assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
207 if (facility == VLF_ANY_FACILITY) {
208 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
209 set_facility_level(facility, module, level);
212 set_facility_level(facility, module, level);
217 do_set_pattern(enum vlog_facility facility, const char *pattern)
219 struct facility *f = &facilities[facility];
220 if (!f->default_pattern) {
223 f->default_pattern = false;
225 f->pattern = xstrdup(pattern);
228 /* Sets the pattern for the given 'facility' to 'pattern'. */
230 vlog_set_pattern(enum vlog_facility facility, const char *pattern)
232 assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
233 if (facility == VLF_ANY_FACILITY) {
234 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
235 do_set_pattern(facility, pattern);
238 do_set_pattern(facility, pattern);
242 /* Returns the name of the log file used by VLF_FILE, or a null pointer if no
243 * log file has been set. (A non-null return value does not assert that the
244 * named log file is in use: if vlog_set_log_file() or vlog_reopen_log_file()
245 * fails, it still sets the log file name.) */
247 vlog_get_log_file(void)
249 return log_file_name;
252 /* Sets the name of the log file used by VLF_FILE to 'file_name', or to the
253 * default file name if 'file_name' is null. Returns 0 if successful,
254 * otherwise a positive errno value. */
256 vlog_set_log_file(const char *file_name)
258 char *old_log_file_name;
259 enum vlog_module module;
262 /* Close old log file. */
264 VLOG_INFO("closing log file");
269 /* Update log file name and free old name. The ordering is important
270 * because 'file_name' might be 'log_file_name' or some suffix of it. */
271 old_log_file_name = log_file_name;
272 log_file_name = (file_name
274 : xasprintf("%s/%s.log", ovs_logdir, program_name));
275 free(old_log_file_name);
276 file_name = NULL; /* Might have been freed. */
278 /* Open new log file and update min_levels[] to reflect whether we actually
279 * have a log_file. */
280 log_file = fopen(log_file_name, "a");
281 for (module = 0; module < VLM_N_MODULES; module++) {
282 update_min_level(module);
285 /* Log success or failure. */
287 VLOG_WARN("failed to open %s for logging: %s",
288 log_file_name, strerror(errno));
291 VLOG_INFO("opened log file %s", log_file_name);
298 /* Closes and then attempts to re-open the current log file. (This is useful
299 * just after log rotation, to ensure that the new log file starts being used.)
300 * Returns 0 if successful, otherwise a positive errno value. */
302 vlog_reopen_log_file(void)
304 return log_file_name ? vlog_set_log_file(log_file_name) : 0;
307 /* Set debugging levels:
309 * mod[:facility[:level]] mod2[:facility[:level]] ...
311 * Return null if successful, otherwise an error message that the caller must
315 vlog_set_levels_from_string(const char *s_)
317 char *save_ptr = NULL;
318 char *s = xstrdup(s_);
319 char *module, *facility;
321 for (module = strtok_r(s, ": \t", &save_ptr); module != NULL;
322 module = strtok_r(NULL, ": \t", &save_ptr)) {
323 enum vlog_module e_module;
324 enum vlog_facility e_facility;
326 facility = strtok_r(NULL, ":", &save_ptr);
328 if (!facility || !strcmp(facility, "ANY")) {
329 e_facility = VLF_ANY_FACILITY;
331 e_facility = vlog_get_facility_val(facility);
332 if (e_facility >= VLF_N_FACILITIES) {
333 char *msg = xasprintf("unknown facility \"%s\"", facility);
339 if (!strcmp(module, "PATTERN")) {
340 vlog_set_pattern(e_facility, save_ptr);
344 enum vlog_level e_level;
346 if (!strcmp(module, "ANY")) {
347 e_module = VLM_ANY_MODULE;
349 e_module = vlog_get_module_val(module);
350 if (e_module >= VLM_N_MODULES) {
351 char *msg = xasprintf("unknown module \"%s\"", module);
357 level = strtok_r(NULL, ":", &save_ptr);
358 e_level = level ? vlog_get_level_val(level) : VLL_DBG;
359 if (e_level >= VLL_N_LEVELS) {
360 char *msg = xasprintf("unknown level \"%s\"", level);
365 vlog_set_levels(e_module, e_facility, e_level);
372 /* If 'arg' is null, configure maximum verbosity. Otherwise, sets
373 * configuration according to 'arg' (see vlog_set_levels_from_string()). */
375 vlog_set_verbosity(const char *arg)
378 char *msg = vlog_set_levels_from_string(arg);
380 ovs_fatal(0, "processing \"%s\": %s", arg, msg);
383 vlog_set_levels(VLM_ANY_MODULE, VLF_ANY_FACILITY, VLL_DBG);
388 vlog_unixctl_set(struct unixctl_conn *conn, const char *args)
390 char *msg = vlog_set_levels_from_string(args);
391 unixctl_command_reply(conn, msg ? 501 : 202, msg);
396 vlog_unixctl_list(struct unixctl_conn *conn, const char *args UNUSED)
398 char *msg = vlog_get_levels();
399 unixctl_command_reply(conn, 200, msg);
404 vlog_unixctl_reopen(struct unixctl_conn *conn, const char *args UNUSED)
407 int error = vlog_reopen_log_file();
409 unixctl_command_reply(conn, 503, strerror(errno));
411 unixctl_command_reply(conn, 202, NULL);
414 unixctl_command_reply(conn, 403, "Logging to file not configured");
418 /* Initializes the logging subsystem. */
424 openlog(program_name, LOG_NDELAY, LOG_DAEMON);
425 vlog_set_levels(VLM_ANY_MODULE, VLF_ANY_FACILITY, VLL_INFO);
427 boot_time = time_msec();
433 localtime_r(&now, &tm);
434 strftime(s, sizeof s, "%a, %d %b %Y %H:%M:%S %z", &tm);
435 VLOG_ERR("current time is negative: %s (%ld)", s, (long int) now);
438 unixctl_command_register("vlog/set", vlog_unixctl_set);
439 unixctl_command_register("vlog/list", vlog_unixctl_list);
440 unixctl_command_register("vlog/reopen", vlog_unixctl_reopen);
443 /* Closes the logging subsystem. */
450 /* Print the current logging level for each module. */
452 vlog_get_levels(void)
454 struct ds s = DS_EMPTY_INITIALIZER;
455 enum vlog_module module;
457 ds_put_format(&s, " console syslog file\n");
458 ds_put_format(&s, " ------- ------ ------\n");
460 for (module = 0; module < VLM_N_MODULES; module++) {
461 ds_put_format(&s, "%-16s %4s %4s %4s\n",
462 vlog_get_module_name(module),
463 vlog_get_level_name(vlog_get_level(module, VLF_CONSOLE)),
464 vlog_get_level_name(vlog_get_level(module, VLF_SYSLOG)),
465 vlog_get_level_name(vlog_get_level(module, VLF_FILE)));
471 /* Returns true if a log message emitted for the given 'module' and 'level'
472 * would cause some log output, false if that module and level are completely
475 vlog_is_enabled(enum vlog_module module, enum vlog_level level)
477 return min_vlog_levels[module] >= level;
481 fetch_braces(const char *p, const char *def, char *out, size_t out_size)
484 size_t n = strcspn(p + 1, "}");
485 size_t n_copy = MIN(n, out_size - 1);
486 memcpy(out, p + 1, n_copy);
490 ovs_strlcpy(out, def, out_size);
496 format_log_message(enum vlog_module module, enum vlog_level level,
497 enum vlog_facility facility, unsigned int msg_num,
498 const char *message, va_list args_, struct ds *s)
505 for (p = facilities[facility].pattern; *p != '\0'; ) {
506 enum { LEFT, RIGHT } justify = RIGHT;
508 size_t length, field, used;
511 ds_put_char(s, *p++);
525 while (isdigit((unsigned char)*p)) {
526 field = (field * 10) + (*p - '0');
533 ds_put_cstr(s, program_name);
536 p = fetch_braces(p, "", tmp, sizeof tmp);
537 ds_put_cstr(s, vlog_get_module_name(module));
540 p = fetch_braces(p, "%Y-%m-%d %H:%M:%S", tmp, sizeof tmp);
541 ds_put_strftime(s, tmp, NULL);
544 /* Format user-supplied log message and trim trailing new-lines. */
546 va_copy(args, args_);
547 ds_put_format_valist(s, message, args);
549 while (s->length > length && s->string[s->length - 1] == '\n') {
554 ds_put_format(s, "%u", msg_num);
557 ds_put_char(s, '\n');
560 ds_put_cstr(s, vlog_get_level_name(level));
563 ds_put_format(s, "%ld", (long int) getpid());
566 ds_put_format(s, "%lld", time_msec() - boot_time);
569 ds_put_char(s, p[-1]);
572 used = s->length - length;
574 size_t n_pad = field - used;
575 if (justify == RIGHT) {
576 ds_put_uninit(s, n_pad);
577 memmove(&s->string[length + n_pad], &s->string[length], used);
578 memset(&s->string[length], pad, n_pad);
580 ds_put_char_multiple(s, pad, n_pad);
586 /* Writes 'message' to the log at the given 'level' and as coming from the
589 * Guaranteed to preserve errno. */
591 vlog_valist(enum vlog_module module, enum vlog_level level,
592 const char *message, va_list args)
594 bool log_to_console = levels[module][VLF_CONSOLE] >= level;
595 bool log_to_syslog = levels[module][VLF_SYSLOG] >= level;
596 bool log_to_file = levels[module][VLF_FILE] >= level && log_file;
597 if (log_to_console || log_to_syslog || log_to_file) {
598 int save_errno = errno;
599 static unsigned int msg_num;
603 ds_reserve(&s, 1024);
606 if (log_to_console) {
607 format_log_message(module, level, VLF_CONSOLE, msg_num,
609 ds_put_char(&s, '\n');
610 fputs(ds_cstr(&s), stderr);
614 int syslog_level = syslog_levels[level];
615 char *save_ptr = NULL;
618 format_log_message(module, level, VLF_SYSLOG, msg_num,
620 for (line = strtok_r(s.string, "\n", &save_ptr); line;
621 line = strtok_r(NULL, "\n", &save_ptr)) {
622 syslog(syslog_level, "%s", line);
627 format_log_message(module, level, VLF_FILE, msg_num,
629 ds_put_char(&s, '\n');
630 fputs(ds_cstr(&s), log_file);
640 vlog(enum vlog_module module, enum vlog_level level, const char *message, ...)
644 va_start(args, message);
645 vlog_valist(module, level, message, args);
650 vlog_should_drop(enum vlog_module module, enum vlog_level level,
651 struct vlog_rate_limit *rl)
653 if (!vlog_is_enabled(module, level)) {
657 if (rl->tokens < VLOG_MSG_TOKENS) {
658 time_t now = time_now();
659 if (rl->last_fill > now) {
660 /* Last filled in the future? Time must have gone backward, or
661 * 'rl' has not been used before. */
662 rl->tokens = rl->burst;
663 } else if (rl->last_fill < now) {
664 unsigned int add = sat_mul(rl->rate, now - rl->last_fill);
665 unsigned int tokens = sat_add(rl->tokens, add);
666 rl->tokens = MIN(tokens, rl->burst);
669 if (rl->tokens < VLOG_MSG_TOKENS) {
670 if (!rl->n_dropped) {
671 rl->first_dropped = now;
677 rl->tokens -= VLOG_MSG_TOKENS;
681 "Dropped %u log messages in last %u seconds "
682 "due to excessive rate",
683 rl->n_dropped, (unsigned int) (time_now() - rl->first_dropped));
690 vlog_rate_limit(enum vlog_module module, enum vlog_level level,
691 struct vlog_rate_limit *rl, const char *message, ...)
693 if (!vlog_should_drop(module, level, rl)) {
696 va_start(args, message);
697 vlog_valist(module, level, message, args);
705 printf("\nLogging options:\n"
706 " -v, --verbose=MODULE[:FACILITY[:LEVEL]] set logging levels\n"
707 " -v, --verbose set maximum verbosity level\n"
708 " --log-file[=FILE] enable logging to specified FILE\n"
709 " (default: %s/%s.log)\n",
710 ovs_logdir, program_name);