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>
31 #include "async-append.h"
34 #include "dynamic-string.h"
36 #include "ovs-thread.h"
43 VLOG_DEFINE_THIS_MODULE(vlog);
45 COVERAGE_DEFINE(vlog_recursive);
47 /* ovs_assert() logs the assertion message, so using ovs_assert() in this
48 * source file could cause recursion. */
50 #define ovs_assert use_assert_instead_of_ovs_assert_in_this_module
52 /* Name for each logging level. */
53 static const char *const level_names[VLL_N_LEVELS] = {
54 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) #NAME,
59 /* Syslog value for each logging level. */
60 static const int syslog_levels[VLL_N_LEVELS] = {
61 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) SYSLOG_LEVEL,
66 /* The log modules. */
67 #if USE_LINKER_SECTIONS
68 extern struct vlog_module *__start_vlog_modules[];
69 extern struct vlog_module *__stop_vlog_modules[];
70 #define vlog_modules __start_vlog_modules
71 #define n_vlog_modules (__stop_vlog_modules - __start_vlog_modules)
73 #define VLOG_MODULE VLOG_DEFINE_MODULE__
74 #include "vlog-modules.def"
77 extern struct vlog_module *vlog_modules[];
78 struct vlog_module *vlog_modules[] = {
79 #define VLOG_MODULE(NAME) &VLM_##NAME,
80 #include "vlog-modules.def"
83 #define n_vlog_modules ARRAY_SIZE(vlog_modules)
86 /* Protects the 'pattern' in all "struct facility"s, so that a race between
87 * changing and reading the pattern does not cause an access to freed
89 static struct ovs_rwlock pattern_rwlock = OVS_RWLOCK_INITIALIZER;
91 /* Information about each facility. */
93 const char *name; /* Name. */
94 char *pattern OVS_GUARDED_BY(pattern_rwlock); /* Current pattern. */
95 bool default_pattern; /* Whether current pattern is the default. */
97 static struct facility facilities[VLF_N_FACILITIES] = {
98 #define VLOG_FACILITY(NAME, PATTERN) {#NAME, PATTERN, true},
103 /* Sequence number for the message currently being composed. */
104 DEFINE_STATIC_PER_THREAD_DATA(unsigned int, msg_num, 0);
106 /* VLF_FILE configuration.
108 * All of the following is protected by 'log_file_mutex', which nests inside
110 static struct ovs_mutex log_file_mutex = OVS_MUTEX_INITIALIZER;
111 static char *log_file_name OVS_GUARDED_BY(log_file_mutex);
112 static int log_fd OVS_GUARDED_BY(log_file_mutex) = -1;
113 static struct async_append *log_writer OVS_GUARDED_BY(log_file_mutex);
114 static bool log_async OVS_GUARDED_BY(log_file_mutex);
116 static void format_log_message(const struct vlog_module *, enum vlog_level,
118 const char *message, va_list, struct ds *)
119 PRINTF_FORMAT(4, 0) OVS_REQ_RDLOCK(&pattern_rwlock);
121 /* Searches the 'n_names' in 'names'. Returns the index of a match for
122 * 'target', or 'n_names' if no name matches. */
124 search_name_array(const char *target, const char *const *names, size_t n_names)
128 for (i = 0; i < n_names; i++) {
130 if (!strcasecmp(names[i], target)) {
137 /* Returns the name for logging level 'level'. */
139 vlog_get_level_name(enum vlog_level level)
141 assert(level < VLL_N_LEVELS);
142 return level_names[level];
145 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
146 * is not the name of a logging level. */
148 vlog_get_level_val(const char *name)
150 return search_name_array(name, level_names, ARRAY_SIZE(level_names));
153 /* Returns the name for logging facility 'facility'. */
155 vlog_get_facility_name(enum vlog_facility facility)
157 assert(facility < VLF_N_FACILITIES);
158 return facilities[facility].name;
161 /* Returns the logging facility named 'name', or VLF_N_FACILITIES if 'name' is
162 * not the name of a logging facility. */
164 vlog_get_facility_val(const char *name)
168 for (i = 0; i < VLF_N_FACILITIES; i++) {
169 if (!strcasecmp(facilities[i].name, name)) {
176 /* Returns the name for logging module 'module'. */
178 vlog_get_module_name(const struct vlog_module *module)
183 /* Returns the logging module named 'name', or NULL if 'name' is not the name
184 * of a logging module. */
186 vlog_module_from_name(const char *name)
188 struct vlog_module **mp;
190 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
191 if (!strcasecmp(name, (*mp)->name)) {
198 /* Returns the current logging level for the given 'module' and 'facility'. */
200 vlog_get_level(const struct vlog_module *module, enum vlog_facility facility)
202 assert(facility < VLF_N_FACILITIES);
203 return module->levels[facility];
207 update_min_level(struct vlog_module *module) OVS_REQUIRES(&log_file_mutex)
209 enum vlog_facility facility;
211 module->min_level = VLL_OFF;
212 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
213 if (log_fd >= 0 || facility != VLF_FILE) {
214 enum vlog_level level = module->levels[facility];
215 if (level > module->min_level) {
216 module->min_level = level;
223 set_facility_level(enum vlog_facility facility, struct vlog_module *module,
224 enum vlog_level level)
226 assert(facility >= 0 && facility < VLF_N_FACILITIES);
227 assert(level < VLL_N_LEVELS);
229 ovs_mutex_lock(&log_file_mutex);
231 struct vlog_module **mp;
233 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
234 (*mp)->levels[facility] = level;
235 update_min_level(*mp);
238 module->levels[facility] = level;
239 update_min_level(module);
241 ovs_mutex_unlock(&log_file_mutex);
244 /* Sets the logging level for the given 'module' and 'facility' to 'level'. A
245 * null 'module' or a 'facility' of VLF_ANY_FACILITY is treated as a wildcard
246 * across all modules or facilities, respectively. */
248 vlog_set_levels(struct vlog_module *module, enum vlog_facility facility,
249 enum vlog_level level)
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 set_facility_level(facility, module, level);
257 set_facility_level(facility, module, level);
262 do_set_pattern(enum vlog_facility facility, const char *pattern)
264 struct facility *f = &facilities[facility];
266 ovs_rwlock_wrlock(&pattern_rwlock);
267 if (!f->default_pattern) {
270 f->default_pattern = false;
272 f->pattern = xstrdup(pattern);
273 ovs_rwlock_unlock(&pattern_rwlock);
276 /* Sets the pattern for the given 'facility' to 'pattern'. */
278 vlog_set_pattern(enum vlog_facility facility, const char *pattern)
280 assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
281 if (facility == VLF_ANY_FACILITY) {
282 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
283 do_set_pattern(facility, pattern);
286 do_set_pattern(facility, pattern);
290 /* Sets the name of the log file used by VLF_FILE to 'file_name', or to the
291 * default file name if 'file_name' is null. Returns 0 if successful,
292 * otherwise a positive errno value. */
294 vlog_set_log_file(const char *file_name)
296 char *new_log_file_name;
297 struct vlog_module **mp;
298 struct stat old_stat;
299 struct stat new_stat;
304 /* Open new log file. */
305 new_log_file_name = (file_name
307 : xasprintf("%s/%s.log", ovs_logdir(), program_name));
308 new_log_fd = open(new_log_file_name, O_WRONLY | O_CREAT | O_APPEND, 0666);
309 if (new_log_fd < 0) {
310 VLOG_WARN("failed to open %s for logging: %s",
311 new_log_file_name, ovs_strerror(errno));
312 free(new_log_file_name);
316 /* If the new log file is the same one we already have open, bail out. */
317 ovs_mutex_lock(&log_file_mutex);
318 same_file = (log_fd >= 0
320 && !fstat(log_fd, &old_stat)
321 && !fstat(new_log_fd, &new_stat)
322 && old_stat.st_dev == new_stat.st_dev
323 && old_stat.st_ino == new_stat.st_ino);
324 ovs_mutex_unlock(&log_file_mutex);
327 free(new_log_file_name);
331 /* Log closing old log file (we can't log while holding log_file_mutex). */
332 ovs_mutex_lock(&log_file_mutex);
333 log_close = log_fd >= 0;
334 ovs_mutex_unlock(&log_file_mutex);
336 VLOG_INFO("closing log file");
339 /* Close old log file, if any, and install new one. */
340 ovs_mutex_lock(&log_file_mutex);
344 async_append_destroy(log_writer);
347 log_file_name = xstrdup(new_log_file_name);
350 log_writer = async_append_create(new_log_fd);
353 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
354 update_min_level(*mp);
356 ovs_mutex_unlock(&log_file_mutex);
358 /* Log opening new log file (we can't log while holding log_file_mutex). */
359 VLOG_INFO("opened log file %s", new_log_file_name);
360 free(new_log_file_name);
365 /* Closes and then attempts to re-open the current log file. (This is useful
366 * just after log rotation, to ensure that the new log file starts being used.)
367 * Returns 0 if successful, otherwise a positive errno value. */
369 vlog_reopen_log_file(void)
373 ovs_mutex_lock(&log_file_mutex);
374 fn = log_file_name ? xstrdup(log_file_name) : NULL;
375 ovs_mutex_unlock(&log_file_mutex);
378 int error = vlog_set_log_file(fn);
386 /* Set debugging levels. Returns null if successful, otherwise an error
387 * message that the caller must free(). */
389 vlog_set_levels_from_string(const char *s_)
391 char *s = xstrdup(s_);
392 char *save_ptr = NULL;
396 word = strtok_r(s, " ,:\t", &save_ptr);
397 if (word && !strcasecmp(word, "PATTERN")) {
398 enum vlog_facility facility;
400 word = strtok_r(NULL, " ,:\t", &save_ptr);
402 msg = xstrdup("missing facility");
406 facility = (!strcasecmp(word, "ANY")
408 : vlog_get_facility_val(word));
409 if (facility == VLF_N_FACILITIES) {
410 msg = xasprintf("unknown facility \"%s\"", word);
413 vlog_set_pattern(facility, save_ptr);
415 struct vlog_module *module = NULL;
416 enum vlog_level level = VLL_N_LEVELS;
417 enum vlog_facility facility = VLF_N_FACILITIES;
419 for (; word != NULL; word = strtok_r(NULL, " ,:\t", &save_ptr)) {
420 if (!strcasecmp(word, "ANY")) {
422 } else if (vlog_get_facility_val(word) != VLF_N_FACILITIES) {
423 if (facility != VLF_N_FACILITIES) {
424 msg = xstrdup("cannot specify multiple facilities");
427 facility = vlog_get_facility_val(word);
428 } else if (vlog_get_level_val(word) != VLL_N_LEVELS) {
429 if (level != VLL_N_LEVELS) {
430 msg = xstrdup("cannot specify multiple levels");
433 level = vlog_get_level_val(word);
434 } else if (vlog_module_from_name(word)) {
436 msg = xstrdup("cannot specify multiple modules");
439 module = vlog_module_from_name(word);
441 msg = xasprintf("no facility, level, or module \"%s\"", word);
446 if (facility == VLF_N_FACILITIES) {
447 facility = VLF_ANY_FACILITY;
449 if (level == VLL_N_LEVELS) {
452 vlog_set_levels(module, facility, level);
460 /* Set debugging levels. Abort with an error message if 's' is invalid. */
462 vlog_set_levels_from_string_assert(const char *s)
464 char *error = vlog_set_levels_from_string(s);
466 ovs_fatal(0, "%s", error);
470 /* If 'arg' is null, configure maximum verbosity. Otherwise, sets
471 * configuration according to 'arg' (see vlog_set_levels_from_string()). */
473 vlog_set_verbosity(const char *arg)
476 char *msg = vlog_set_levels_from_string(arg);
478 ovs_fatal(0, "processing \"%s\": %s", arg, msg);
481 vlog_set_levels(NULL, VLF_ANY_FACILITY, VLL_DBG);
486 vlog_unixctl_set(struct unixctl_conn *conn, int argc, const char *argv[],
487 void *aux OVS_UNUSED)
491 for (i = 1; i < argc; i++) {
492 char *msg = vlog_set_levels_from_string(argv[i]);
494 unixctl_command_reply_error(conn, msg);
499 unixctl_command_reply(conn, NULL);
503 vlog_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
504 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
506 char *msg = vlog_get_levels();
507 unixctl_command_reply(conn, msg);
512 vlog_unixctl_reopen(struct unixctl_conn *conn, int argc OVS_UNUSED,
513 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
517 ovs_mutex_lock(&log_file_mutex);
518 has_log_file = log_file_name != NULL;
519 ovs_mutex_unlock(&log_file_mutex);
522 int error = vlog_reopen_log_file();
524 unixctl_command_reply_error(conn, ovs_strerror(errno));
526 unixctl_command_reply(conn, NULL);
529 unixctl_command_reply_error(conn, "Logging to file not configured");
534 set_all_rate_limits(bool enable)
536 struct vlog_module **mp;
538 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
539 (*mp)->honor_rate_limits = enable;
544 set_rate_limits(struct unixctl_conn *conn, int argc,
545 const char *argv[], bool enable)
550 for (i = 1; i < argc; i++) {
551 if (!strcasecmp(argv[i], "ANY")) {
552 set_all_rate_limits(enable);
554 struct vlog_module *module = vlog_module_from_name(argv[i]);
556 unixctl_command_reply_error(conn, "unknown module");
559 module->honor_rate_limits = enable;
563 set_all_rate_limits(enable);
565 unixctl_command_reply(conn, NULL);
569 vlog_enable_rate_limit(struct unixctl_conn *conn, int argc,
570 const char *argv[], void *aux OVS_UNUSED)
572 set_rate_limits(conn, argc, argv, true);
576 vlog_disable_rate_limit(struct unixctl_conn *conn, int argc,
577 const char *argv[], void *aux OVS_UNUSED)
579 set_rate_limits(conn, argc, argv, false);
585 static char *program_name_copy;
588 /* openlog() is allowed to keep the pointer passed in, without making a
589 * copy. The daemonize code sometimes frees and replaces 'program_name',
590 * so make a private copy just for openlog(). (We keep a pointer to the
591 * private copy to suppress memory leak warnings in case openlog() does
592 * make its own copy.) */
593 program_name_copy = program_name ? xstrdup(program_name) : NULL;
594 openlog(program_name_copy, LOG_NDELAY, LOG_DAEMON);
596 now = time_wall_msec();
598 char *s = xastrftime_msec("%a, %d %b %Y %H:%M:%S", now, true);
599 VLOG_ERR("current time is negative: %s (%lld)", s, now);
603 unixctl_command_register(
604 "vlog/set", "{spec | PATTERN:facility:pattern}",
605 1, INT_MAX, vlog_unixctl_set, NULL);
606 unixctl_command_register("vlog/list", "", 0, 0, vlog_unixctl_list, NULL);
607 unixctl_command_register("vlog/enable-rate-limit", "[module]...",
608 0, INT_MAX, vlog_enable_rate_limit, NULL);
609 unixctl_command_register("vlog/disable-rate-limit", "[module]...",
610 0, INT_MAX, vlog_disable_rate_limit, NULL);
611 unixctl_command_register("vlog/reopen", "", 0, 0,
612 vlog_unixctl_reopen, NULL);
615 /* Initializes the logging subsystem and registers its unixctl server
620 static pthread_once_t once = PTHREAD_ONCE_INIT;
621 pthread_once(&once, vlog_init__);
624 /* Enables VLF_FILE log output to be written asynchronously to disk.
625 * Asynchronous file writes avoid blocking the process in the case of a busy
626 * disk, but on the other hand they are less robust: there is a chance that the
627 * write will not make it to the log file if the process crashes soon after the
630 vlog_enable_async(void)
632 ovs_mutex_lock(&log_file_mutex);
634 if (log_fd >= 0 && !log_writer) {
635 log_writer = async_append_create(log_fd);
637 ovs_mutex_unlock(&log_file_mutex);
640 /* Print the current logging level for each module. */
642 vlog_get_levels(void)
644 struct ds s = DS_EMPTY_INITIALIZER;
645 struct vlog_module **mp;
646 struct svec lines = SVEC_EMPTY_INITIALIZER;
650 ds_put_format(&s, " console syslog file\n");
651 ds_put_format(&s, " ------- ------ ------\n");
653 for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
657 ds_put_format(&line, "%-16s %4s %4s %4s",
658 vlog_get_module_name(*mp),
659 vlog_get_level_name(vlog_get_level(*mp, VLF_CONSOLE)),
660 vlog_get_level_name(vlog_get_level(*mp, VLF_SYSLOG)),
661 vlog_get_level_name(vlog_get_level(*mp, VLF_FILE)));
662 if (!(*mp)->honor_rate_limits) {
663 ds_put_cstr(&line, " (rate limiting disabled)");
665 ds_put_char(&line, '\n');
667 svec_add_nocopy(&lines, ds_steal_cstr(&line));
671 SVEC_FOR_EACH (i, line, &lines) {
672 ds_put_cstr(&s, line);
674 svec_destroy(&lines);
679 /* Returns true if a log message emitted for the given 'module' and 'level'
680 * would cause some log output, false if that module and level are completely
683 vlog_is_enabled(const struct vlog_module *module, enum vlog_level level)
685 return module->min_level >= level;
689 fetch_braces(const char *p, const char *def, char *out, size_t out_size)
692 size_t n = strcspn(p + 1, "}");
693 size_t n_copy = MIN(n, out_size - 1);
694 memcpy(out, p + 1, n_copy);
698 ovs_strlcpy(out, def, out_size);
704 format_log_message(const struct vlog_module *module, enum vlog_level level,
705 enum vlog_facility facility,
706 const char *message, va_list args_, struct ds *s)
713 for (p = facilities[facility].pattern; *p != '\0'; ) {
714 const char *subprogram_name;
715 enum { LEFT, RIGHT } justify = RIGHT;
717 size_t length, field, used;
720 ds_put_char(s, *p++);
734 while (isdigit((unsigned char)*p)) {
735 field = (field * 10) + (*p - '0');
742 ds_put_cstr(s, program_name);
745 p = fetch_braces(p, "", tmp, sizeof tmp);
746 ds_put_cstr(s, vlog_get_module_name(module));
749 p = fetch_braces(p, "%Y-%m-%d %H:%M:%S.###", tmp, sizeof tmp);
750 ds_put_strftime_msec(s, tmp, time_wall_msec(), false);
753 p = fetch_braces(p, "%Y-%m-%d %H:%M:%S.###", tmp, sizeof tmp);
754 ds_put_strftime_msec(s, tmp, time_wall_msec(), true);
757 /* Format user-supplied log message and trim trailing new-lines. */
759 va_copy(args, args_);
760 ds_put_format_valist(s, message, args);
762 while (s->length > length && s->string[s->length - 1] == '\n') {
767 ds_put_format(s, "%u", *msg_num_get_unsafe());
770 ds_put_char(s, '\n');
773 ds_put_cstr(s, vlog_get_level_name(level));
776 ds_put_format(s, "%ld", (long int) getpid());
779 ds_put_format(s, "%lld", time_msec() - time_boot_msec());
782 subprogram_name = get_subprogram_name();
783 ds_put_cstr(s, subprogram_name[0] ? subprogram_name : "main");
786 subprogram_name = get_subprogram_name();
787 if (subprogram_name[0]) {
788 ds_put_format(s, "(%s)", subprogram_name);
792 ds_put_char(s, p[-1]);
795 used = s->length - length;
797 size_t n_pad = field - used;
798 if (justify == RIGHT) {
799 ds_put_uninit(s, n_pad);
800 memmove(&s->string[length + n_pad], &s->string[length], used);
801 memset(&s->string[length], pad, n_pad);
803 ds_put_char_multiple(s, pad, n_pad);
809 /* Writes 'message' to the log at the given 'level' and as coming from the
812 * Guaranteed to preserve errno. */
814 vlog_valist(const struct vlog_module *module, enum vlog_level level,
815 const char *message, va_list args)
817 bool log_to_console = module->levels[VLF_CONSOLE] >= level;
818 bool log_to_syslog = module->levels[VLF_SYSLOG] >= level;
821 ovs_mutex_lock(&log_file_mutex);
822 log_to_file = module->levels[VLF_FILE] >= level && log_fd >= 0;
823 ovs_mutex_unlock(&log_file_mutex);
824 if (log_to_console || log_to_syslog || log_to_file) {
825 int save_errno = errno;
831 ds_reserve(&s, 1024);
834 ovs_rwlock_rdlock(&pattern_rwlock);
835 if (log_to_console) {
836 format_log_message(module, level, VLF_CONSOLE, message, args, &s);
837 ds_put_char(&s, '\n');
838 fputs(ds_cstr(&s), stderr);
842 int syslog_level = syslog_levels[level];
843 char *save_ptr = NULL;
846 format_log_message(module, level, VLF_SYSLOG, message, args, &s);
847 for (line = strtok_r(s.string, "\n", &save_ptr); line;
848 line = strtok_r(NULL, "\n", &save_ptr)) {
849 syslog(syslog_level, "%s", line);
854 format_log_message(module, level, VLF_FILE, message, args, &s);
855 ds_put_char(&s, '\n');
857 ovs_mutex_lock(&log_file_mutex);
860 async_append_write(log_writer, s.string, s.length);
861 if (level == VLL_EMER) {
862 async_append_flush(log_writer);
865 ignore(write(log_fd, s.string, s.length));
868 ovs_mutex_unlock(&log_file_mutex);
870 ovs_rwlock_unlock(&pattern_rwlock);
878 vlog(const struct vlog_module *module, enum vlog_level level,
879 const char *message, ...)
883 va_start(args, message);
884 vlog_valist(module, level, message, args);
888 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
889 * exit code. Always writes the message to stderr, even if the console
890 * facility is disabled.
892 * Choose this function instead of vlog_abort_valist() if the daemon monitoring
893 * facility shouldn't automatically restart the current daemon. */
895 vlog_fatal_valist(const struct vlog_module *module_,
896 const char *message, va_list args)
898 struct vlog_module *module = CONST_CAST(struct vlog_module *, module_);
900 /* Don't log this message to the console to avoid redundancy with the
901 * message written by the later ovs_fatal_valist(). */
902 module->levels[VLF_CONSOLE] = VLL_OFF;
904 vlog_valist(module, VLL_EMER, message, args);
905 ovs_fatal_valist(0, message, args);
908 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
909 * exit code. Always writes the message to stderr, even if the console
910 * facility is disabled.
912 * Choose this function instead of vlog_abort() if the daemon monitoring
913 * facility shouldn't automatically restart the current daemon. */
915 vlog_fatal(const struct vlog_module *module, const char *message, ...)
919 va_start(args, message);
920 vlog_fatal_valist(module, message, args);
924 /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always
925 * writes the message to stderr, even if the console facility is disabled.
927 * Choose this function instead of vlog_fatal_valist() if the daemon monitoring
928 * facility should automatically restart the current daemon. */
930 vlog_abort_valist(const struct vlog_module *module_,
931 const char *message, va_list args)
933 struct vlog_module *module = (struct vlog_module *) module_;
935 /* Don't log this message to the console to avoid redundancy with the
936 * message written by the later ovs_abort_valist(). */
937 module->levels[VLF_CONSOLE] = VLL_OFF;
939 vlog_valist(module, VLL_EMER, message, args);
940 ovs_abort_valist(0, message, args);
943 /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always
944 * writes the message to stderr, even if the console facility is disabled.
946 * Choose this function instead of vlog_fatal() if the daemon monitoring
947 * facility should automatically restart the current daemon. */
949 vlog_abort(const struct vlog_module *module, const char *message, ...)
953 va_start(args, message);
954 vlog_abort_valist(module, message, args);
959 vlog_should_drop(const struct vlog_module *module, enum vlog_level level,
960 struct vlog_rate_limit *rl)
962 if (!module->honor_rate_limits) {
966 if (!vlog_is_enabled(module, level)) {
970 ovs_mutex_lock(&rl->mutex);
971 if (!token_bucket_withdraw(&rl->token_bucket, VLOG_MSG_TOKENS)) {
972 time_t now = time_now();
973 if (!rl->n_dropped) {
974 rl->first_dropped = now;
976 rl->last_dropped = now;
978 ovs_mutex_unlock(&rl->mutex);
982 if (!rl->n_dropped) {
983 ovs_mutex_unlock(&rl->mutex);
985 time_t now = time_now();
986 unsigned int n_dropped = rl->n_dropped;
987 unsigned int first_dropped_elapsed = now - rl->first_dropped;
988 unsigned int last_dropped_elapsed = now - rl->last_dropped;
990 ovs_mutex_unlock(&rl->mutex);
993 "Dropped %u log messages in last %u seconds (most recently, "
994 "%u seconds ago) due to excessive rate",
995 n_dropped, first_dropped_elapsed, last_dropped_elapsed);
1002 vlog_rate_limit(const struct vlog_module *module, enum vlog_level level,
1003 struct vlog_rate_limit *rl, const char *message, ...)
1005 if (!vlog_should_drop(module, level, rl)) {
1008 va_start(args, message);
1009 vlog_valist(module, level, message, args);
1017 printf("\nLogging options:\n"
1018 " -v, --verbose=[SPEC] set logging levels\n"
1019 " -v, --verbose set maximum verbosity level\n"
1020 " --log-file[=FILE] enable logging to specified FILE\n"
1021 " (default: %s/%s.log)\n",
1022 ovs_logdir(), program_name);