2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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.
26 #include <sys/types.h>
31 #include "dynamic-string.h"
38 VLOG_DEFINE_THIS_MODULE(vlog);
40 /* Name for each logging level. */
41 static const char *level_names[VLL_N_LEVELS] = {
42 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) #NAME,
47 /* Syslog value for each logging level. */
48 static int syslog_levels[VLL_N_LEVELS] = {
49 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) SYSLOG_LEVEL,
54 /* The log modules. */
55 #if USE_LINKER_SECTIONS
56 extern struct vlog_module *__start_vlog_modules[];
57 extern struct vlog_module *__stop_vlog_modules[];
58 #define vlog_modules __start_vlog_modules
59 #define n_vlog_modules (__stop_vlog_modules - __start_vlog_modules)
61 #define VLOG_MODULE VLOG_DEFINE_MODULE__
62 #include "vlog-modules.def"
65 struct vlog_module *vlog_modules[] = {
66 #define VLOG_MODULE(NAME) &VLM_##NAME,
67 #include "vlog-modules.def"
70 #define n_vlog_modules ARRAY_SIZE(vlog_modules)
73 /* Information about each facility. */
75 const char *name; /* Name. */
76 char *pattern; /* Current pattern. */
77 bool default_pattern; /* Whether current pattern is the default. */
79 static struct facility facilities[VLF_N_FACILITIES] = {
80 #define VLOG_FACILITY(NAME, PATTERN) {#NAME, PATTERN, true},
85 /* VLF_FILE configuration. */
86 static char *log_file_name;
87 static FILE *log_file;
89 /* vlog initialized? */
90 static bool vlog_inited;
92 static void format_log_message(const struct vlog_module *, enum vlog_level,
93 enum vlog_facility, unsigned int msg_num,
94 const char *message, va_list, struct ds *)
97 /* Searches the 'n_names' in 'names'. Returns the index of a match for
98 * 'target', or 'n_names' if no name matches. */
100 search_name_array(const char *target, const char **names, size_t n_names)
104 for (i = 0; i < n_names; i++) {
106 if (!strcasecmp(names[i], target)) {
113 /* Returns the name for logging level 'level'. */
115 vlog_get_level_name(enum vlog_level level)
117 assert(level < VLL_N_LEVELS);
118 return level_names[level];
121 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
122 * is not the name of a logging level. */
124 vlog_get_level_val(const char *name)
126 return search_name_array(name, level_names, ARRAY_SIZE(level_names));
129 /* Returns the name for logging facility 'facility'. */
131 vlog_get_facility_name(enum vlog_facility facility)
133 assert(facility < VLF_N_FACILITIES);
134 return facilities[facility].name;
137 /* Returns the logging facility named 'name', or VLF_N_FACILITIES if 'name' is
138 * not the name of a logging facility. */
140 vlog_get_facility_val(const char *name)
144 for (i = 0; i < VLF_N_FACILITIES; i++) {
145 if (!strcasecmp(facilities[i].name, name)) {
152 /* Returns the name for logging module 'module'. */
154 vlog_get_module_name(const struct vlog_module *module)
159 /* Returns the logging module named 'name', or NULL if 'name' is not the name
160 * of a logging module. */
162 vlog_module_from_name(const char *name)
164 struct vlog_module **mp;
166 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
167 if (!strcasecmp(name, (*mp)->name)) {
174 /* Returns the current logging level for the given 'module' and 'facility'. */
176 vlog_get_level(const struct vlog_module *module, enum vlog_facility facility)
178 assert(facility < VLF_N_FACILITIES);
179 return module->levels[facility];
183 update_min_level(struct vlog_module *module)
185 enum vlog_facility facility;
187 module->min_level = VLL_OFF;
188 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
189 if (log_file || facility != VLF_FILE) {
190 enum vlog_level level = module->levels[facility];
191 if (level > module->min_level) {
192 module->min_level = level;
199 set_facility_level(enum vlog_facility facility, struct vlog_module *module,
200 enum vlog_level level)
202 assert(facility >= 0 && facility < VLF_N_FACILITIES);
203 assert(level < VLL_N_LEVELS);
206 struct vlog_module **mp;
208 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
209 (*mp)->levels[facility] = level;
210 update_min_level(*mp);
213 module->levels[facility] = level;
214 update_min_level(module);
218 /* Sets the logging level for the given 'module' and 'facility' to 'level'. A
219 * null 'module' or a 'facility' of VLF_ANY_FACILITY is treated as a wildcard
220 * across all modules or facilities, respectively. */
222 vlog_set_levels(struct vlog_module *module, enum vlog_facility facility,
223 enum vlog_level level)
225 assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
226 if (facility == VLF_ANY_FACILITY) {
227 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
228 set_facility_level(facility, module, level);
231 set_facility_level(facility, module, level);
236 do_set_pattern(enum vlog_facility facility, const char *pattern)
238 struct facility *f = &facilities[facility];
239 if (!f->default_pattern) {
242 f->default_pattern = false;
244 f->pattern = xstrdup(pattern);
247 /* Sets the pattern for the given 'facility' to 'pattern'. */
249 vlog_set_pattern(enum vlog_facility facility, const char *pattern)
251 assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
252 if (facility == VLF_ANY_FACILITY) {
253 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
254 do_set_pattern(facility, pattern);
257 do_set_pattern(facility, pattern);
261 /* Returns the name of the log file used by VLF_FILE, or a null pointer if no
262 * log file has been set. (A non-null return value does not assert that the
263 * named log file is in use: if vlog_set_log_file() or vlog_reopen_log_file()
264 * fails, it still sets the log file name.) */
266 vlog_get_log_file(void)
268 return log_file_name;
271 /* Sets the name of the log file used by VLF_FILE to 'file_name', or to the
272 * default file name if 'file_name' is null. Returns 0 if successful,
273 * otherwise a positive errno value. */
275 vlog_set_log_file(const char *file_name)
277 char *old_log_file_name;
278 struct vlog_module **mp;
281 /* Close old log file. */
283 VLOG_INFO("closing log file");
288 /* Update log file name and free old name. The ordering is important
289 * because 'file_name' might be 'log_file_name' or some suffix of it. */
290 old_log_file_name = log_file_name;
291 log_file_name = (file_name
293 : xasprintf("%s/%s.log", ovs_logdir(), program_name));
294 free(old_log_file_name);
295 file_name = NULL; /* Might have been freed. */
297 /* Open new log file and update min_levels[] to reflect whether we actually
298 * have a log_file. */
299 log_file = fopen(log_file_name, "a");
300 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
301 update_min_level(*mp);
304 /* Log success or failure. */
306 VLOG_WARN("failed to open %s for logging: %s",
307 log_file_name, strerror(errno));
310 VLOG_INFO("opened log file %s", log_file_name);
317 /* Closes and then attempts to re-open the current log file. (This is useful
318 * just after log rotation, to ensure that the new log file starts being used.)
319 * Returns 0 if successful, otherwise a positive errno value. */
321 vlog_reopen_log_file(void)
323 struct stat old, new;
325 /* Skip re-opening if there's nothing to reopen. */
326 if (!log_file_name) {
330 /* Skip re-opening if it would be a no-op because the old and new files are
331 * the same. (This avoids writing "closing log file" followed immediately
332 * by "opened log file".) */
334 && !fstat(fileno(log_file), &old)
335 && !stat(log_file_name, &new)
336 && old.st_dev == new.st_dev
337 && old.st_ino == new.st_ino) {
341 return vlog_set_log_file(log_file_name);
344 /* Set debugging levels. Returns null if successful, otherwise an error
345 * message that the caller must free(). */
347 vlog_set_levels_from_string(const char *s_)
349 char *s = xstrdup(s_);
350 char *save_ptr = NULL;
354 word = strtok_r(s, " ,:\t", &save_ptr);
355 if (word && !strcasecmp(word, "PATTERN")) {
356 enum vlog_facility facility;
358 word = strtok_r(NULL, " ,:\t", &save_ptr);
360 msg = xstrdup("missing facility");
364 facility = (!strcasecmp(word, "ANY")
366 : vlog_get_facility_val(word));
367 if (facility == VLF_N_FACILITIES) {
368 msg = xasprintf("unknown facility \"%s\"", word);
371 vlog_set_pattern(facility, save_ptr);
373 struct vlog_module *module = NULL;
374 enum vlog_level level = VLL_N_LEVELS;
375 enum vlog_facility facility = VLF_N_FACILITIES;
377 for (; word != NULL; word = strtok_r(NULL, " ,:\t", &save_ptr)) {
378 if (!strcasecmp(word, "ANY")) {
380 } else if (vlog_get_facility_val(word) != VLF_N_FACILITIES) {
381 if (facility != VLF_N_FACILITIES) {
382 msg = xstrdup("cannot specify multiple facilities");
385 facility = vlog_get_facility_val(word);
386 } else if (vlog_get_level_val(word) != VLL_N_LEVELS) {
387 if (level != VLL_N_LEVELS) {
388 msg = xstrdup("cannot specify multiple levels");
391 level = vlog_get_level_val(word);
392 } else if (vlog_module_from_name(word)) {
394 msg = xstrdup("cannot specify multiple modules");
397 module = vlog_module_from_name(word);
399 msg = xasprintf("no facility, level, or module \"%s\"", word);
404 if (facility == VLF_N_FACILITIES) {
405 facility = VLF_ANY_FACILITY;
407 if (level == VLL_N_LEVELS) {
410 vlog_set_levels(module, facility, level);
418 /* If 'arg' is null, configure maximum verbosity. Otherwise, sets
419 * configuration according to 'arg' (see vlog_set_levels_from_string()). */
421 vlog_set_verbosity(const char *arg)
424 char *msg = vlog_set_levels_from_string(arg);
426 ovs_fatal(0, "processing \"%s\": %s", arg, msg);
429 vlog_set_levels(NULL, VLF_ANY_FACILITY, VLL_DBG);
434 vlog_unixctl_set(struct unixctl_conn *conn, int argc, const char *argv[],
435 void *aux OVS_UNUSED)
439 for (i = 1; i < argc; i++) {
440 char *msg = vlog_set_levels_from_string(argv[i]);
442 unixctl_command_reply_error(conn, msg);
447 unixctl_command_reply(conn, NULL);
451 vlog_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
452 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
454 char *msg = vlog_get_levels();
455 unixctl_command_reply(conn, msg);
460 vlog_unixctl_reopen(struct unixctl_conn *conn, int argc OVS_UNUSED,
461 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
464 int error = vlog_reopen_log_file();
466 unixctl_command_reply_error(conn, strerror(errno));
468 unixctl_command_reply(conn, NULL);
471 unixctl_command_reply_error(conn, "Logging to file not configured");
475 /* Initializes the logging subsystem and registers its unixctl server
480 static char *program_name_copy;
488 /* openlog() is allowed to keep the pointer passed in, without making a
489 * copy. The daemonize code sometimes frees and replaces 'program_name',
490 * so make a private copy just for openlog(). (We keep a pointer to the
491 * private copy to suppress memory leak warnings in case openlog() does
492 * make its own copy.) */
493 program_name_copy = program_name ? xstrdup(program_name) : NULL;
494 openlog(program_name_copy, LOG_NDELAY, LOG_DAEMON);
502 strftime(s, sizeof s, "%a, %d %b %Y %H:%M:%S", &tm);
503 VLOG_ERR("current time is negative: %s (%ld)", s, (long int) now);
506 unixctl_command_register(
507 "vlog/set", "{spec | PATTERN:facility:pattern}",
508 1, INT_MAX, vlog_unixctl_set, NULL);
509 unixctl_command_register("vlog/list", "", 0, 0, vlog_unixctl_list, NULL);
510 unixctl_command_register("vlog/reopen", "", 0, 0,
511 vlog_unixctl_reopen, NULL);
514 /* Closes the logging subsystem. */
524 /* Print the current logging level for each module. */
526 vlog_get_levels(void)
528 struct ds s = DS_EMPTY_INITIALIZER;
529 struct vlog_module **mp;
530 struct svec lines = SVEC_EMPTY_INITIALIZER;
534 ds_put_format(&s, " console syslog file\n");
535 ds_put_format(&s, " ------- ------ ------\n");
537 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
538 line = xasprintf("%-16s %4s %4s %4s\n",
539 vlog_get_module_name(*mp),
540 vlog_get_level_name(vlog_get_level(*mp, VLF_CONSOLE)),
541 vlog_get_level_name(vlog_get_level(*mp, VLF_SYSLOG)),
542 vlog_get_level_name(vlog_get_level(*mp, VLF_FILE)));
543 svec_add_nocopy(&lines, line);
547 SVEC_FOR_EACH (i, line, &lines) {
548 ds_put_cstr(&s, line);
550 svec_destroy(&lines);
555 /* Returns true if a log message emitted for the given 'module' and 'level'
556 * would cause some log output, false if that module and level are completely
559 vlog_is_enabled(const struct vlog_module *module, enum vlog_level level)
561 return module->min_level >= level;
565 fetch_braces(const char *p, const char *def, char *out, size_t out_size)
568 size_t n = strcspn(p + 1, "}");
569 size_t n_copy = MIN(n, out_size - 1);
570 memcpy(out, p + 1, n_copy);
574 ovs_strlcpy(out, def, out_size);
580 format_log_message(const struct vlog_module *module, enum vlog_level level,
581 enum vlog_facility facility, unsigned int msg_num,
582 const char *message, va_list args_, struct ds *s)
589 for (p = facilities[facility].pattern; *p != '\0'; ) {
590 enum { LEFT, RIGHT } justify = RIGHT;
592 size_t length, field, used;
595 ds_put_char(s, *p++);
609 while (isdigit((unsigned char)*p)) {
610 field = (field * 10) + (*p - '0');
617 ds_put_cstr(s, program_name);
620 p = fetch_braces(p, "", tmp, sizeof tmp);
621 ds_put_cstr(s, vlog_get_module_name(module));
624 p = fetch_braces(p, "%Y-%m-%d %H:%M:%S", tmp, sizeof tmp);
625 ds_put_strftime(s, tmp, false);
628 p = fetch_braces(p, "%Y-%m-%d %H:%M:%S", tmp, sizeof tmp);
629 ds_put_strftime(s, tmp, true);
632 /* Format user-supplied log message and trim trailing new-lines. */
634 va_copy(args, args_);
635 ds_put_format_valist(s, message, args);
637 while (s->length > length && s->string[s->length - 1] == '\n') {
642 ds_put_format(s, "%u", msg_num);
645 ds_put_char(s, '\n');
648 ds_put_cstr(s, vlog_get_level_name(level));
651 ds_put_format(s, "%ld", (long int) getpid());
654 ds_put_format(s, "%lld", time_msec() - time_boot_msec());
657 ds_put_char(s, p[-1]);
660 used = s->length - length;
662 size_t n_pad = field - used;
663 if (justify == RIGHT) {
664 ds_put_uninit(s, n_pad);
665 memmove(&s->string[length + n_pad], &s->string[length], used);
666 memset(&s->string[length], pad, n_pad);
668 ds_put_char_multiple(s, pad, n_pad);
674 /* Writes 'message' to the log at the given 'level' and as coming from the
677 * Guaranteed to preserve errno. */
679 vlog_valist(const struct vlog_module *module, enum vlog_level level,
680 const char *message, va_list args)
682 bool log_to_console = module->levels[VLF_CONSOLE] >= level;
683 bool log_to_syslog = module->levels[VLF_SYSLOG] >= level;
684 bool log_to_file = module->levels[VLF_FILE] >= level && log_file;
685 if (log_to_console || log_to_syslog || log_to_file) {
686 int save_errno = errno;
687 static unsigned int msg_num;
693 ds_reserve(&s, 1024);
696 if (log_to_console) {
697 format_log_message(module, level, VLF_CONSOLE, msg_num,
699 ds_put_char(&s, '\n');
700 fputs(ds_cstr(&s), stderr);
704 int syslog_level = syslog_levels[level];
705 char *save_ptr = NULL;
708 format_log_message(module, level, VLF_SYSLOG, msg_num,
710 for (line = strtok_r(s.string, "\n", &save_ptr); line;
711 line = strtok_r(NULL, "\n", &save_ptr)) {
712 syslog(syslog_level, "%s", line);
717 format_log_message(module, level, VLF_FILE, msg_num,
719 ds_put_char(&s, '\n');
720 fputs(ds_cstr(&s), log_file);
730 vlog(const struct vlog_module *module, enum vlog_level level,
731 const char *message, ...)
735 va_start(args, message);
736 vlog_valist(module, level, message, args);
741 vlog_fatal_valist(const struct vlog_module *module_,
742 const char *message, va_list args)
744 struct vlog_module *module = (struct vlog_module *) module_;
746 /* Don't log this message to the console to avoid redundancy with the
747 * message written by the later ovs_fatal_valist(). */
748 module->levels[VLF_CONSOLE] = VLL_OFF;
750 vlog_valist(module, VLL_EMER, message, args);
751 ovs_fatal_valist(0, message, args);
755 vlog_fatal(const struct vlog_module *module, const char *message, ...)
759 va_start(args, message);
760 vlog_fatal_valist(module, message, args);
765 vlog_should_drop(const struct vlog_module *module, enum vlog_level level,
766 struct vlog_rate_limit *rl)
768 if (!vlog_is_enabled(module, level)) {
772 if (!token_bucket_withdraw(&rl->token_bucket, VLOG_MSG_TOKENS)) {
773 time_t now = time_now();
774 if (!rl->n_dropped) {
775 rl->first_dropped = now;
777 rl->last_dropped = now;
783 time_t now = time_now();
784 unsigned int first_dropped_elapsed = now - rl->first_dropped;
785 unsigned int last_dropped_elapsed = now - rl->last_dropped;
788 "Dropped %u log messages in last %u seconds (most recently, "
789 "%u seconds ago) due to excessive rate",
790 rl->n_dropped, first_dropped_elapsed, last_dropped_elapsed);
798 vlog_rate_limit(const struct vlog_module *module, enum vlog_level level,
799 struct vlog_rate_limit *rl, const char *message, ...)
801 if (!vlog_should_drop(module, level, rl)) {
804 va_start(args, message);
805 vlog_valist(module, level, message, args);
813 printf("\nLogging options:\n"
814 " -v, --verbose=[SPEC] set logging levels\n"
815 " -v, --verbose set maximum verbosity level\n"
816 " --log-file[=FILE] enable logging to specified FILE\n"
817 " (default: %s/%s.log)\n",
818 ovs_logdir(), program_name);