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.
27 #include <sys/types.h>
33 #include "dynamic-string.h"
41 VLOG_DEFINE_THIS_MODULE(vlog);
43 COVERAGE_DEFINE(vlog_recursive);
45 /* ovs_assert() logs the assertion message, so using ovs_assert() in this
46 * source file could cause recursion. */
48 #define ovs_assert use_assert_instead_of_ovs_assert_in_this_module
50 /* Name for each logging level. */
51 static const char *const level_names[VLL_N_LEVELS] = {
52 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) #NAME,
57 /* Syslog value for each logging level. */
58 static const int syslog_levels[VLL_N_LEVELS] = {
59 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) SYSLOG_LEVEL,
64 /* The log modules. */
65 #if USE_LINKER_SECTIONS
66 extern struct vlog_module *__start_vlog_modules[];
67 extern struct vlog_module *__stop_vlog_modules[];
68 #define vlog_modules __start_vlog_modules
69 #define n_vlog_modules (__stop_vlog_modules - __start_vlog_modules)
71 #define VLOG_MODULE VLOG_DEFINE_MODULE__
72 #include "vlog-modules.def"
75 struct vlog_module *vlog_modules[] = {
76 #define VLOG_MODULE(NAME) &VLM_##NAME,
77 #include "vlog-modules.def"
80 #define n_vlog_modules ARRAY_SIZE(vlog_modules)
83 /* Information about each facility. */
85 const char *name; /* Name. */
86 char *pattern; /* Current pattern. */
87 bool default_pattern; /* Whether current pattern is the default. */
89 static struct facility facilities[VLF_N_FACILITIES] = {
90 #define VLOG_FACILITY(NAME, PATTERN) {#NAME, PATTERN, true},
95 /* VLF_FILE configuration. */
96 static char *log_file_name;
97 static int log_fd = -1;
99 /* vlog initialized? */
100 static bool vlog_inited;
102 static void format_log_message(const struct vlog_module *, enum vlog_level,
103 enum vlog_facility, unsigned int msg_num,
104 const char *message, va_list, struct ds *)
107 /* Searches the 'n_names' in 'names'. Returns the index of a match for
108 * 'target', or 'n_names' if no name matches. */
110 search_name_array(const char *target, const char *const *names, size_t n_names)
114 for (i = 0; i < n_names; i++) {
116 if (!strcasecmp(names[i], target)) {
123 /* Returns the name for logging level 'level'. */
125 vlog_get_level_name(enum vlog_level level)
127 assert(level < VLL_N_LEVELS);
128 return level_names[level];
131 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
132 * is not the name of a logging level. */
134 vlog_get_level_val(const char *name)
136 return search_name_array(name, level_names, ARRAY_SIZE(level_names));
139 /* Returns the name for logging facility 'facility'. */
141 vlog_get_facility_name(enum vlog_facility facility)
143 assert(facility < VLF_N_FACILITIES);
144 return facilities[facility].name;
147 /* Returns the logging facility named 'name', or VLF_N_FACILITIES if 'name' is
148 * not the name of a logging facility. */
150 vlog_get_facility_val(const char *name)
154 for (i = 0; i < VLF_N_FACILITIES; i++) {
155 if (!strcasecmp(facilities[i].name, name)) {
162 /* Returns the name for logging module 'module'. */
164 vlog_get_module_name(const struct vlog_module *module)
169 /* Returns the logging module named 'name', or NULL if 'name' is not the name
170 * of a logging module. */
172 vlog_module_from_name(const char *name)
174 struct vlog_module **mp;
176 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
177 if (!strcasecmp(name, (*mp)->name)) {
184 /* Returns the current logging level for the given 'module' and 'facility'. */
186 vlog_get_level(const struct vlog_module *module, enum vlog_facility facility)
188 assert(facility < VLF_N_FACILITIES);
189 return module->levels[facility];
193 update_min_level(struct vlog_module *module)
195 enum vlog_facility facility;
197 module->min_level = VLL_OFF;
198 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
199 if (log_fd >= 0 || facility != VLF_FILE) {
200 enum vlog_level level = module->levels[facility];
201 if (level > module->min_level) {
202 module->min_level = level;
209 set_facility_level(enum vlog_facility facility, struct vlog_module *module,
210 enum vlog_level level)
212 assert(facility >= 0 && facility < VLF_N_FACILITIES);
213 assert(level < VLL_N_LEVELS);
216 struct vlog_module **mp;
218 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
219 (*mp)->levels[facility] = level;
220 update_min_level(*mp);
223 module->levels[facility] = level;
224 update_min_level(module);
228 /* Sets the logging level for the given 'module' and 'facility' to 'level'. A
229 * null 'module' or a 'facility' of VLF_ANY_FACILITY is treated as a wildcard
230 * across all modules or facilities, respectively. */
232 vlog_set_levels(struct vlog_module *module, enum vlog_facility facility,
233 enum vlog_level level)
235 assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
236 if (facility == VLF_ANY_FACILITY) {
237 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
238 set_facility_level(facility, module, level);
241 set_facility_level(facility, module, level);
246 do_set_pattern(enum vlog_facility facility, const char *pattern)
248 struct facility *f = &facilities[facility];
249 if (!f->default_pattern) {
252 f->default_pattern = false;
254 f->pattern = xstrdup(pattern);
257 /* Sets the pattern for the given 'facility' to 'pattern'. */
259 vlog_set_pattern(enum vlog_facility facility, const char *pattern)
261 assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
262 if (facility == VLF_ANY_FACILITY) {
263 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
264 do_set_pattern(facility, pattern);
267 do_set_pattern(facility, pattern);
271 /* Returns the name of the log file used by VLF_FILE, or a null pointer if no
272 * log file has been set. (A non-null return value does not assert that the
273 * named log file is in use: if vlog_set_log_file() or vlog_reopen_log_file()
274 * fails, it still sets the log file name.) */
276 vlog_get_log_file(void)
278 return log_file_name;
281 /* Sets the name of the log file used by VLF_FILE to 'file_name', or to the
282 * default file name if 'file_name' is null. Returns 0 if successful,
283 * otherwise a positive errno value. */
285 vlog_set_log_file(const char *file_name)
287 char *old_log_file_name;
288 struct vlog_module **mp;
291 /* Close old log file. */
293 VLOG_INFO("closing log file");
298 /* Update log file name and free old name. The ordering is important
299 * because 'file_name' might be 'log_file_name' or some suffix of it. */
300 old_log_file_name = log_file_name;
301 log_file_name = (file_name
303 : xasprintf("%s/%s.log", ovs_logdir(), program_name));
304 free(old_log_file_name);
305 file_name = NULL; /* Might have been freed. */
307 /* Open new log file and update min_levels[] to reflect whether we actually
308 * have a log_file. */
309 log_fd = open(log_file_name, O_WRONLY | O_CREAT | O_APPEND, 0666);
310 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
311 update_min_level(*mp);
314 /* Log success or failure. */
316 VLOG_WARN("failed to open %s for logging: %s",
317 log_file_name, ovs_strerror(errno));
320 VLOG_INFO("opened log file %s", log_file_name);
327 /* Closes and then attempts to re-open the current log file. (This is useful
328 * just after log rotation, to ensure that the new log file starts being used.)
329 * Returns 0 if successful, otherwise a positive errno value. */
331 vlog_reopen_log_file(void)
333 struct stat old, new;
335 /* Skip re-opening if there's nothing to reopen. */
336 if (!log_file_name) {
340 /* Skip re-opening if it would be a no-op because the old and new files are
341 * the same. (This avoids writing "closing log file" followed immediately
342 * by "opened log file".) */
344 && !fstat(log_fd, &old)
345 && !stat(log_file_name, &new)
346 && old.st_dev == new.st_dev
347 && old.st_ino == new.st_ino) {
351 return vlog_set_log_file(log_file_name);
354 /* Set debugging levels. Returns null if successful, otherwise an error
355 * message that the caller must free(). */
357 vlog_set_levels_from_string(const char *s_)
359 char *s = xstrdup(s_);
360 char *save_ptr = NULL;
364 word = strtok_r(s, " ,:\t", &save_ptr);
365 if (word && !strcasecmp(word, "PATTERN")) {
366 enum vlog_facility facility;
368 word = strtok_r(NULL, " ,:\t", &save_ptr);
370 msg = xstrdup("missing facility");
374 facility = (!strcasecmp(word, "ANY")
376 : vlog_get_facility_val(word));
377 if (facility == VLF_N_FACILITIES) {
378 msg = xasprintf("unknown facility \"%s\"", word);
381 vlog_set_pattern(facility, save_ptr);
383 struct vlog_module *module = NULL;
384 enum vlog_level level = VLL_N_LEVELS;
385 enum vlog_facility facility = VLF_N_FACILITIES;
387 for (; word != NULL; word = strtok_r(NULL, " ,:\t", &save_ptr)) {
388 if (!strcasecmp(word, "ANY")) {
390 } else if (vlog_get_facility_val(word) != VLF_N_FACILITIES) {
391 if (facility != VLF_N_FACILITIES) {
392 msg = xstrdup("cannot specify multiple facilities");
395 facility = vlog_get_facility_val(word);
396 } else if (vlog_get_level_val(word) != VLL_N_LEVELS) {
397 if (level != VLL_N_LEVELS) {
398 msg = xstrdup("cannot specify multiple levels");
401 level = vlog_get_level_val(word);
402 } else if (vlog_module_from_name(word)) {
404 msg = xstrdup("cannot specify multiple modules");
407 module = vlog_module_from_name(word);
409 msg = xasprintf("no facility, level, or module \"%s\"", word);
414 if (facility == VLF_N_FACILITIES) {
415 facility = VLF_ANY_FACILITY;
417 if (level == VLL_N_LEVELS) {
420 vlog_set_levels(module, facility, level);
428 /* Set debugging levels. Abort with an error message if 's' is invalid. */
430 vlog_set_levels_from_string_assert(const char *s)
432 char *error = vlog_set_levels_from_string(s);
434 ovs_fatal(0, "%s", error);
438 /* If 'arg' is null, configure maximum verbosity. Otherwise, sets
439 * configuration according to 'arg' (see vlog_set_levels_from_string()). */
441 vlog_set_verbosity(const char *arg)
444 char *msg = vlog_set_levels_from_string(arg);
446 ovs_fatal(0, "processing \"%s\": %s", arg, msg);
449 vlog_set_levels(NULL, VLF_ANY_FACILITY, VLL_DBG);
454 vlog_unixctl_set(struct unixctl_conn *conn, int argc, const char *argv[],
455 void *aux OVS_UNUSED)
459 for (i = 1; i < argc; i++) {
460 char *msg = vlog_set_levels_from_string(argv[i]);
462 unixctl_command_reply_error(conn, msg);
467 unixctl_command_reply(conn, NULL);
471 vlog_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
472 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
474 char *msg = vlog_get_levels();
475 unixctl_command_reply(conn, msg);
480 vlog_unixctl_reopen(struct unixctl_conn *conn, int argc OVS_UNUSED,
481 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
484 int error = vlog_reopen_log_file();
486 unixctl_command_reply_error(conn, ovs_strerror(errno));
488 unixctl_command_reply(conn, NULL);
491 unixctl_command_reply_error(conn, "Logging to file not configured");
496 set_all_rate_limits(bool enable)
498 struct vlog_module **mp;
500 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
501 (*mp)->honor_rate_limits = enable;
506 set_rate_limits(struct unixctl_conn *conn, int argc,
507 const char *argv[], bool enable)
512 for (i = 1; i < argc; i++) {
513 if (!strcasecmp(argv[i], "ANY")) {
514 set_all_rate_limits(enable);
516 struct vlog_module *module = vlog_module_from_name(argv[i]);
518 unixctl_command_reply_error(conn, "unknown module");
521 module->honor_rate_limits = enable;
525 set_all_rate_limits(enable);
527 unixctl_command_reply(conn, NULL);
531 vlog_enable_rate_limit(struct unixctl_conn *conn, int argc,
532 const char *argv[], void *aux OVS_UNUSED)
534 set_rate_limits(conn, argc, argv, true);
538 vlog_disable_rate_limit(struct unixctl_conn *conn, int argc,
539 const char *argv[], void *aux OVS_UNUSED)
541 set_rate_limits(conn, argc, argv, false);
544 /* Initializes the logging subsystem and registers its unixctl server
549 static char *program_name_copy;
557 /* openlog() is allowed to keep the pointer passed in, without making a
558 * copy. The daemonize code sometimes frees and replaces 'program_name',
559 * so make a private copy just for openlog(). (We keep a pointer to the
560 * private copy to suppress memory leak warnings in case openlog() does
561 * make its own copy.) */
562 program_name_copy = program_name ? xstrdup(program_name) : NULL;
563 openlog(program_name_copy, LOG_NDELAY, LOG_DAEMON);
567 char *s = xastrftime("%a, %d %b %Y %H:%M:%S", now, true);
568 VLOG_ERR("current time is negative: %s (%ld)", s, (long int) now);
572 unixctl_command_register(
573 "vlog/set", "{spec | PATTERN:facility:pattern}",
574 1, INT_MAX, vlog_unixctl_set, NULL);
575 unixctl_command_register("vlog/list", "", 0, 0, vlog_unixctl_list, NULL);
576 unixctl_command_register("vlog/enable-rate-limit", "[module]...",
577 0, INT_MAX, vlog_enable_rate_limit, NULL);
578 unixctl_command_register("vlog/disable-rate-limit", "[module]...",
579 0, INT_MAX, vlog_disable_rate_limit, NULL);
580 unixctl_command_register("vlog/reopen", "", 0, 0,
581 vlog_unixctl_reopen, NULL);
584 /* Closes the logging subsystem. */
594 /* Print the current logging level for each module. */
596 vlog_get_levels(void)
598 struct ds s = DS_EMPTY_INITIALIZER;
599 struct vlog_module **mp;
600 struct svec lines = SVEC_EMPTY_INITIALIZER;
604 ds_put_format(&s, " console syslog file\n");
605 ds_put_format(&s, " ------- ------ ------\n");
607 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
611 ds_put_format(&line, "%-16s %4s %4s %4s",
612 vlog_get_module_name(*mp),
613 vlog_get_level_name(vlog_get_level(*mp, VLF_CONSOLE)),
614 vlog_get_level_name(vlog_get_level(*mp, VLF_SYSLOG)),
615 vlog_get_level_name(vlog_get_level(*mp, VLF_FILE)));
616 if (!(*mp)->honor_rate_limits) {
617 ds_put_cstr(&line, " (rate limiting disabled)");
619 ds_put_char(&line, '\n');
621 svec_add_nocopy(&lines, ds_steal_cstr(&line));
625 SVEC_FOR_EACH (i, line, &lines) {
626 ds_put_cstr(&s, line);
628 svec_destroy(&lines);
633 /* Returns true if a log message emitted for the given 'module' and 'level'
634 * would cause some log output, false if that module and level are completely
637 vlog_is_enabled(const struct vlog_module *module, enum vlog_level level)
639 return module->min_level >= level;
643 fetch_braces(const char *p, const char *def, char *out, size_t out_size)
646 size_t n = strcspn(p + 1, "}");
647 size_t n_copy = MIN(n, out_size - 1);
648 memcpy(out, p + 1, n_copy);
652 ovs_strlcpy(out, def, out_size);
658 format_log_message(const struct vlog_module *module, enum vlog_level level,
659 enum vlog_facility facility, unsigned int msg_num,
660 const char *message, va_list args_, struct ds *s)
667 for (p = facilities[facility].pattern; *p != '\0'; ) {
668 const char *subprogram_name;
669 enum { LEFT, RIGHT } justify = RIGHT;
671 size_t length, field, used;
674 ds_put_char(s, *p++);
688 while (isdigit((unsigned char)*p)) {
689 field = (field * 10) + (*p - '0');
696 ds_put_cstr(s, program_name);
699 p = fetch_braces(p, "", tmp, sizeof tmp);
700 ds_put_cstr(s, vlog_get_module_name(module));
703 p = fetch_braces(p, "%Y-%m-%d %H:%M:%S", tmp, sizeof tmp);
704 ds_put_strftime(s, tmp, time_wall(), false);
707 p = fetch_braces(p, "%Y-%m-%d %H:%M:%S", tmp, sizeof tmp);
708 ds_put_strftime(s, tmp, time_wall(), true);
711 /* Format user-supplied log message and trim trailing new-lines. */
713 va_copy(args, args_);
714 ds_put_format_valist(s, message, args);
716 while (s->length > length && s->string[s->length - 1] == '\n') {
721 ds_put_format(s, "%u", msg_num);
724 ds_put_char(s, '\n');
727 ds_put_cstr(s, vlog_get_level_name(level));
730 ds_put_format(s, "%ld", (long int) getpid());
733 ds_put_format(s, "%lld", time_msec() - time_boot_msec());
736 subprogram_name = get_subprogram_name();
737 ds_put_cstr(s, subprogram_name[0] ? subprogram_name : "main");
740 subprogram_name = get_subprogram_name();
741 if (subprogram_name[0]) {
742 ds_put_format(s, "(%s)", subprogram_name);
746 ds_put_char(s, p[-1]);
749 used = s->length - length;
751 size_t n_pad = field - used;
752 if (justify == RIGHT) {
753 ds_put_uninit(s, n_pad);
754 memmove(&s->string[length + n_pad], &s->string[length], used);
755 memset(&s->string[length], pad, n_pad);
757 ds_put_char_multiple(s, pad, n_pad);
763 /* Writes 'message' to the log at the given 'level' and as coming from the
766 * Guaranteed to preserve errno. */
768 vlog_valist(const struct vlog_module *module, enum vlog_level level,
769 const char *message, va_list args)
771 bool log_to_console = module->levels[VLF_CONSOLE] >= level;
772 bool log_to_syslog = module->levels[VLF_SYSLOG] >= level;
773 bool log_to_file = module->levels[VLF_FILE] >= level && log_fd >= 0;
774 if (log_to_console || log_to_syslog || log_to_file) {
775 int save_errno = errno;
776 static unsigned int msg_num;
782 ds_reserve(&s, 1024);
785 if (log_to_console) {
786 format_log_message(module, level, VLF_CONSOLE, msg_num,
788 ds_put_char(&s, '\n');
789 fputs(ds_cstr(&s), stderr);
793 int syslog_level = syslog_levels[level];
794 char *save_ptr = NULL;
797 format_log_message(module, level, VLF_SYSLOG, msg_num,
799 for (line = strtok_r(s.string, "\n", &save_ptr); line;
800 line = strtok_r(NULL, "\n", &save_ptr)) {
801 syslog(syslog_level, "%s", line);
806 format_log_message(module, level, VLF_FILE, msg_num,
808 ds_put_char(&s, '\n');
809 ignore(write(log_fd, s.string, s.length));
818 vlog(const struct vlog_module *module, enum vlog_level level,
819 const char *message, ...)
823 va_start(args, message);
824 vlog_valist(module, level, message, args);
828 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
829 * exit code. Always writes the message to stderr, even if the console
830 * facility is disabled.
832 * Choose this function instead of vlog_abort_valist() if the daemon monitoring
833 * facility shouldn't automatically restart the current daemon. */
835 vlog_fatal_valist(const struct vlog_module *module_,
836 const char *message, va_list args)
838 struct vlog_module *module = CONST_CAST(struct vlog_module *, module_);
840 /* Don't log this message to the console to avoid redundancy with the
841 * message written by the later ovs_fatal_valist(). */
842 module->levels[VLF_CONSOLE] = VLL_OFF;
844 vlog_valist(module, VLL_EMER, message, args);
845 ovs_fatal_valist(0, message, args);
848 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
849 * exit code. Always writes the message to stderr, even if the console
850 * facility is disabled.
852 * Choose this function instead of vlog_abort() if the daemon monitoring
853 * facility shouldn't automatically restart the current daemon. */
855 vlog_fatal(const struct vlog_module *module, const char *message, ...)
859 va_start(args, message);
860 vlog_fatal_valist(module, message, args);
864 /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always
865 * writes the message to stderr, even if the console facility is disabled.
867 * Choose this function instead of vlog_fatal_valist() if the daemon monitoring
868 * facility should automatically restart the current daemon. */
870 vlog_abort_valist(const struct vlog_module *module_,
871 const char *message, va_list args)
873 struct vlog_module *module = (struct vlog_module *) module_;
875 /* Don't log this message to the console to avoid redundancy with the
876 * message written by the later ovs_abort_valist(). */
877 module->levels[VLF_CONSOLE] = VLL_OFF;
879 vlog_valist(module, VLL_EMER, message, args);
880 ovs_abort_valist(0, message, args);
883 /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always
884 * writes the message to stderr, even if the console facility is disabled.
886 * Choose this function instead of vlog_fatal() if the daemon monitoring
887 * facility should automatically restart the current daemon. */
889 vlog_abort(const struct vlog_module *module, const char *message, ...)
893 va_start(args, message);
894 vlog_abort_valist(module, message, args);
899 vlog_should_drop(const struct vlog_module *module, enum vlog_level level,
900 struct vlog_rate_limit *rl)
902 if (!module->honor_rate_limits) {
906 if (!vlog_is_enabled(module, level)) {
910 xpthread_mutex_lock(&rl->mutex);
911 if (!token_bucket_withdraw(&rl->token_bucket, VLOG_MSG_TOKENS)) {
912 time_t now = time_now();
913 if (!rl->n_dropped) {
914 rl->first_dropped = now;
916 rl->last_dropped = now;
918 xpthread_mutex_unlock(&rl->mutex);
922 if (!rl->n_dropped) {
923 xpthread_mutex_unlock(&rl->mutex);
925 time_t now = time_now();
926 unsigned int n_dropped = rl->n_dropped;
927 unsigned int first_dropped_elapsed = now - rl->first_dropped;
928 unsigned int last_dropped_elapsed = now - rl->last_dropped;
930 xpthread_mutex_unlock(&rl->mutex);
933 "Dropped %u log messages in last %u seconds (most recently, "
934 "%u seconds ago) due to excessive rate",
935 n_dropped, first_dropped_elapsed, last_dropped_elapsed);
942 vlog_rate_limit(const struct vlog_module *module, enum vlog_level level,
943 struct vlog_rate_limit *rl, const char *message, ...)
945 if (!vlog_should_drop(module, level, rl)) {
948 va_start(args, message);
949 vlog_valist(module, level, message, args);
957 printf("\nLogging options:\n"
958 " -v, --verbose=[SPEC] set logging levels\n"
959 " -v, --verbose set maximum verbosity level\n"
960 " --log-file[=FILE] enable logging to specified FILE\n"
961 " (default: %s/%s.log)\n",
962 ovs_logdir(), program_name);