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 /* 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_fd = open(log_file_name, O_WRONLY | O_CREAT | O_APPEND, 0666);
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, ovs_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(log_fd, &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 /* Set debugging levels. Abort with an error message if 's' is invalid. */
420 vlog_set_levels_from_string_assert(const char *s)
422 char *error = vlog_set_levels_from_string(s);
424 ovs_fatal(0, "%s", error);
428 /* If 'arg' is null, configure maximum verbosity. Otherwise, sets
429 * configuration according to 'arg' (see vlog_set_levels_from_string()). */
431 vlog_set_verbosity(const char *arg)
434 char *msg = vlog_set_levels_from_string(arg);
436 ovs_fatal(0, "processing \"%s\": %s", arg, msg);
439 vlog_set_levels(NULL, VLF_ANY_FACILITY, VLL_DBG);
444 vlog_unixctl_set(struct unixctl_conn *conn, int argc, const char *argv[],
445 void *aux OVS_UNUSED)
449 for (i = 1; i < argc; i++) {
450 char *msg = vlog_set_levels_from_string(argv[i]);
452 unixctl_command_reply_error(conn, msg);
457 unixctl_command_reply(conn, NULL);
461 vlog_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
462 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
464 char *msg = vlog_get_levels();
465 unixctl_command_reply(conn, msg);
470 vlog_unixctl_reopen(struct unixctl_conn *conn, int argc OVS_UNUSED,
471 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
474 int error = vlog_reopen_log_file();
476 unixctl_command_reply_error(conn, ovs_strerror(errno));
478 unixctl_command_reply(conn, NULL);
481 unixctl_command_reply_error(conn, "Logging to file not configured");
486 set_all_rate_limits(bool enable)
488 struct vlog_module **mp;
490 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
491 (*mp)->honor_rate_limits = enable;
496 set_rate_limits(struct unixctl_conn *conn, int argc,
497 const char *argv[], bool enable)
502 for (i = 1; i < argc; i++) {
503 if (!strcasecmp(argv[i], "ANY")) {
504 set_all_rate_limits(enable);
506 struct vlog_module *module = vlog_module_from_name(argv[i]);
508 unixctl_command_reply_error(conn, "unknown module");
511 module->honor_rate_limits = enable;
515 set_all_rate_limits(enable);
517 unixctl_command_reply(conn, NULL);
521 vlog_enable_rate_limit(struct unixctl_conn *conn, int argc,
522 const char *argv[], void *aux OVS_UNUSED)
524 set_rate_limits(conn, argc, argv, true);
528 vlog_disable_rate_limit(struct unixctl_conn *conn, int argc,
529 const char *argv[], void *aux OVS_UNUSED)
531 set_rate_limits(conn, argc, argv, false);
534 /* Initializes the logging subsystem and registers its unixctl server
539 static char *program_name_copy;
547 /* openlog() is allowed to keep the pointer passed in, without making a
548 * copy. The daemonize code sometimes frees and replaces 'program_name',
549 * so make a private copy just for openlog(). (We keep a pointer to the
550 * private copy to suppress memory leak warnings in case openlog() does
551 * make its own copy.) */
552 program_name_copy = program_name ? xstrdup(program_name) : NULL;
553 openlog(program_name_copy, LOG_NDELAY, LOG_DAEMON);
557 char *s = xastrftime("%a, %d %b %Y %H:%M:%S", now, true);
558 VLOG_ERR("current time is negative: %s (%ld)", s, (long int) now);
562 unixctl_command_register(
563 "vlog/set", "{spec | PATTERN:facility:pattern}",
564 1, INT_MAX, vlog_unixctl_set, NULL);
565 unixctl_command_register("vlog/list", "", 0, 0, vlog_unixctl_list, NULL);
566 unixctl_command_register("vlog/enable-rate-limit", "[module]...",
567 0, INT_MAX, vlog_enable_rate_limit, NULL);
568 unixctl_command_register("vlog/disable-rate-limit", "[module]...",
569 0, INT_MAX, vlog_disable_rate_limit, NULL);
570 unixctl_command_register("vlog/reopen", "", 0, 0,
571 vlog_unixctl_reopen, NULL);
574 /* Print the current logging level for each module. */
576 vlog_get_levels(void)
578 struct ds s = DS_EMPTY_INITIALIZER;
579 struct vlog_module **mp;
580 struct svec lines = SVEC_EMPTY_INITIALIZER;
584 ds_put_format(&s, " console syslog file\n");
585 ds_put_format(&s, " ------- ------ ------\n");
587 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
591 ds_put_format(&line, "%-16s %4s %4s %4s",
592 vlog_get_module_name(*mp),
593 vlog_get_level_name(vlog_get_level(*mp, VLF_CONSOLE)),
594 vlog_get_level_name(vlog_get_level(*mp, VLF_SYSLOG)),
595 vlog_get_level_name(vlog_get_level(*mp, VLF_FILE)));
596 if (!(*mp)->honor_rate_limits) {
597 ds_put_cstr(&line, " (rate limiting disabled)");
599 ds_put_char(&line, '\n');
601 svec_add_nocopy(&lines, ds_steal_cstr(&line));
605 SVEC_FOR_EACH (i, line, &lines) {
606 ds_put_cstr(&s, line);
608 svec_destroy(&lines);
613 /* Returns true if a log message emitted for the given 'module' and 'level'
614 * would cause some log output, false if that module and level are completely
617 vlog_is_enabled(const struct vlog_module *module, enum vlog_level level)
619 return module->min_level >= level;
623 fetch_braces(const char *p, const char *def, char *out, size_t out_size)
626 size_t n = strcspn(p + 1, "}");
627 size_t n_copy = MIN(n, out_size - 1);
628 memcpy(out, p + 1, n_copy);
632 ovs_strlcpy(out, def, out_size);
638 format_log_message(const struct vlog_module *module, enum vlog_level level,
639 enum vlog_facility facility, unsigned int msg_num,
640 const char *message, va_list args_, struct ds *s)
647 for (p = facilities[facility].pattern; *p != '\0'; ) {
648 const char *subprogram_name;
649 enum { LEFT, RIGHT } justify = RIGHT;
651 size_t length, field, used;
654 ds_put_char(s, *p++);
668 while (isdigit((unsigned char)*p)) {
669 field = (field * 10) + (*p - '0');
676 ds_put_cstr(s, program_name);
679 p = fetch_braces(p, "", tmp, sizeof tmp);
680 ds_put_cstr(s, vlog_get_module_name(module));
683 p = fetch_braces(p, "%Y-%m-%d %H:%M:%S", tmp, sizeof tmp);
684 ds_put_strftime(s, tmp, time_wall(), false);
687 p = fetch_braces(p, "%Y-%m-%d %H:%M:%S", tmp, sizeof tmp);
688 ds_put_strftime(s, tmp, time_wall(), true);
691 /* Format user-supplied log message and trim trailing new-lines. */
693 va_copy(args, args_);
694 ds_put_format_valist(s, message, args);
696 while (s->length > length && s->string[s->length - 1] == '\n') {
701 ds_put_format(s, "%u", msg_num);
704 ds_put_char(s, '\n');
707 ds_put_cstr(s, vlog_get_level_name(level));
710 ds_put_format(s, "%ld", (long int) getpid());
713 ds_put_format(s, "%lld", time_msec() - time_boot_msec());
716 subprogram_name = get_subprogram_name();
717 ds_put_cstr(s, subprogram_name[0] ? subprogram_name : "main");
720 subprogram_name = get_subprogram_name();
721 if (subprogram_name[0]) {
722 ds_put_format(s, "(%s)", subprogram_name);
726 ds_put_char(s, p[-1]);
729 used = s->length - length;
731 size_t n_pad = field - used;
732 if (justify == RIGHT) {
733 ds_put_uninit(s, n_pad);
734 memmove(&s->string[length + n_pad], &s->string[length], used);
735 memset(&s->string[length], pad, n_pad);
737 ds_put_char_multiple(s, pad, n_pad);
743 /* Writes 'message' to the log at the given 'level' and as coming from the
746 * Guaranteed to preserve errno. */
748 vlog_valist(const struct vlog_module *module, enum vlog_level level,
749 const char *message, va_list args)
751 bool log_to_console = module->levels[VLF_CONSOLE] >= level;
752 bool log_to_syslog = module->levels[VLF_SYSLOG] >= level;
753 bool log_to_file = module->levels[VLF_FILE] >= level && log_fd >= 0;
754 if (log_to_console || log_to_syslog || log_to_file) {
755 int save_errno = errno;
756 static unsigned int msg_num;
762 ds_reserve(&s, 1024);
765 if (log_to_console) {
766 format_log_message(module, level, VLF_CONSOLE, msg_num,
768 ds_put_char(&s, '\n');
769 fputs(ds_cstr(&s), stderr);
773 int syslog_level = syslog_levels[level];
774 char *save_ptr = NULL;
777 format_log_message(module, level, VLF_SYSLOG, msg_num,
779 for (line = strtok_r(s.string, "\n", &save_ptr); line;
780 line = strtok_r(NULL, "\n", &save_ptr)) {
781 syslog(syslog_level, "%s", line);
786 format_log_message(module, level, VLF_FILE, msg_num,
788 ds_put_char(&s, '\n');
789 ignore(write(log_fd, s.string, s.length));
798 vlog(const struct vlog_module *module, enum vlog_level level,
799 const char *message, ...)
803 va_start(args, message);
804 vlog_valist(module, level, message, args);
808 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
809 * exit code. Always writes the message to stderr, even if the console
810 * facility is disabled.
812 * Choose this function instead of vlog_abort_valist() if the daemon monitoring
813 * facility shouldn't automatically restart the current daemon. */
815 vlog_fatal_valist(const struct vlog_module *module_,
816 const char *message, va_list args)
818 struct vlog_module *module = CONST_CAST(struct vlog_module *, module_);
820 /* Don't log this message to the console to avoid redundancy with the
821 * message written by the later ovs_fatal_valist(). */
822 module->levels[VLF_CONSOLE] = VLL_OFF;
824 vlog_valist(module, VLL_EMER, message, args);
825 ovs_fatal_valist(0, 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() if the daemon monitoring
833 * facility shouldn't automatically restart the current daemon. */
835 vlog_fatal(const struct vlog_module *module, const char *message, ...)
839 va_start(args, message);
840 vlog_fatal_valist(module, message, args);
844 /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always
845 * writes the message to stderr, even if the console facility is disabled.
847 * Choose this function instead of vlog_fatal_valist() if the daemon monitoring
848 * facility should automatically restart the current daemon. */
850 vlog_abort_valist(const struct vlog_module *module_,
851 const char *message, va_list args)
853 struct vlog_module *module = (struct vlog_module *) module_;
855 /* Don't log this message to the console to avoid redundancy with the
856 * message written by the later ovs_abort_valist(). */
857 module->levels[VLF_CONSOLE] = VLL_OFF;
859 vlog_valist(module, VLL_EMER, message, args);
860 ovs_abort_valist(0, message, args);
863 /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always
864 * writes the message to stderr, even if the console facility is disabled.
866 * Choose this function instead of vlog_fatal() if the daemon monitoring
867 * facility should automatically restart the current daemon. */
869 vlog_abort(const struct vlog_module *module, const char *message, ...)
873 va_start(args, message);
874 vlog_abort_valist(module, message, args);
879 vlog_should_drop(const struct vlog_module *module, enum vlog_level level,
880 struct vlog_rate_limit *rl)
882 if (!module->honor_rate_limits) {
886 if (!vlog_is_enabled(module, level)) {
890 xpthread_mutex_lock(&rl->mutex);
891 if (!token_bucket_withdraw(&rl->token_bucket, VLOG_MSG_TOKENS)) {
892 time_t now = time_now();
893 if (!rl->n_dropped) {
894 rl->first_dropped = now;
896 rl->last_dropped = now;
898 xpthread_mutex_unlock(&rl->mutex);
902 if (!rl->n_dropped) {
903 xpthread_mutex_unlock(&rl->mutex);
905 time_t now = time_now();
906 unsigned int n_dropped = rl->n_dropped;
907 unsigned int first_dropped_elapsed = now - rl->first_dropped;
908 unsigned int last_dropped_elapsed = now - rl->last_dropped;
910 xpthread_mutex_unlock(&rl->mutex);
913 "Dropped %u log messages in last %u seconds (most recently, "
914 "%u seconds ago) due to excessive rate",
915 n_dropped, first_dropped_elapsed, last_dropped_elapsed);
922 vlog_rate_limit(const struct vlog_module *module, enum vlog_level level,
923 struct vlog_rate_limit *rl, const char *message, ...)
925 if (!vlog_should_drop(module, level, rl)) {
928 va_start(args, message);
929 vlog_valist(module, level, message, args);
937 printf("\nLogging options:\n"
938 " -v, --verbose=[SPEC] set logging levels\n"
939 " -v, --verbose set maximum verbosity level\n"
940 " --log-file[=FILE] enable logging to specified FILE\n"
941 " (default: %s/%s.log)\n",
942 ovs_logdir(), program_name);