2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2015 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.
18 #include "openvswitch/vlog.h"
27 #include <sys/types.h>
31 #include "async-append.h"
34 #include "dynamic-string.h"
36 #include "ovs-thread.h"
38 #include "socket-util.h"
40 #include "syslog-direct.h"
41 #include "syslog-libc.h"
42 #include "syslog-provider.h"
47 VLOG_DEFINE_THIS_MODULE(vlog);
49 /* ovs_assert() logs the assertion message, so using ovs_assert() in this
50 * source file could cause recursion. */
52 #define ovs_assert use_assert_instead_of_ovs_assert_in_this_module
54 /* Name for each logging level. */
55 static const char *const level_names[VLL_N_LEVELS] = {
56 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424) #NAME,
61 /* Syslog value for each logging level. */
62 static const int syslog_levels[VLL_N_LEVELS] = {
63 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424) SYSLOG_LEVEL,
68 /* RFC 5424 defines specific values for each syslog level. Normally LOG_* use
69 * the same values. Verify that in fact they're the same. If we get assertion
70 * failures here then we need to define a separate rfc5424_levels[] array. */
71 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424) \
72 BUILD_ASSERT_DECL(SYSLOG_LEVEL == RFC5424);
76 /* Similarly, RFC 5424 defines the local0 facility with the value ordinarily
77 * used for LOG_LOCAL0. */
78 BUILD_ASSERT_DECL(LOG_LOCAL0 == (16 << 3));
80 /* The log modules. */
81 struct ovs_list vlog_modules = OVS_LIST_INITIALIZER(&vlog_modules);
83 /* Protects the 'pattern' in all "struct destination"s, so that a race between
84 * changing and reading the pattern does not cause an access to freed
86 static struct ovs_rwlock pattern_rwlock = OVS_RWLOCK_INITIALIZER;
88 /* Information about each destination. */
90 const char *name; /* Name. */
91 char *pattern OVS_GUARDED_BY(pattern_rwlock); /* Current pattern. */
92 bool default_pattern; /* Whether current pattern is the default. */
94 static struct destination destinations[VLF_N_DESTINATIONS] = {
95 #define VLOG_DESTINATION(NAME, PATTERN) {#NAME, PATTERN, true},
97 #undef VLOG_DESTINATION
100 /* Sequence number for the message currently being composed. */
101 DEFINE_STATIC_PER_THREAD_DATA(unsigned int, msg_num, 0);
103 /* VLF_FILE configuration.
105 * All of the following is protected by 'log_file_mutex', which nests inside
107 static struct ovs_mutex log_file_mutex = OVS_MUTEX_INITIALIZER;
108 static char *log_file_name OVS_GUARDED_BY(log_file_mutex) = NULL;
109 static int log_fd OVS_GUARDED_BY(log_file_mutex) = -1;
110 static struct async_append *log_writer OVS_GUARDED_BY(log_file_mutex);
111 static bool log_async OVS_GUARDED_BY(log_file_mutex);
112 static struct syslogger *syslogger = NULL;
114 /* Syslog export configuration. */
115 static int syslog_fd OVS_GUARDED_BY(pattern_rwlock) = -1;
117 /* Log facility configuration. */
118 static atomic_int log_facility = ATOMIC_VAR_INIT(0);
120 /* Facility name and its value. */
121 struct vlog_facility {
122 char *name; /* Name. */
123 unsigned int value; /* Facility associated with 'name'. */
125 static struct vlog_facility vlog_facilities[] = {
129 {"daemon", LOG_DAEMON},
131 {"syslog", LOG_SYSLOG},
141 {"local0", LOG_LOCAL0},
142 {"local1", LOG_LOCAL1},
143 {"local2", LOG_LOCAL2},
144 {"local3", LOG_LOCAL3},
145 {"local4", LOG_LOCAL4},
146 {"local5", LOG_LOCAL5},
147 {"local6", LOG_LOCAL6},
148 {"local7", LOG_LOCAL7}
150 static bool vlog_facility_exists(const char* facility, int *value);
152 static void format_log_message(const struct vlog_module *, enum vlog_level,
154 const char *message, va_list, struct ds *)
155 OVS_PRINTF_FORMAT(4, 0);
157 /* Searches the 'n_names' in 'names'. Returns the index of a match for
158 * 'target', or 'n_names' if no name matches. */
160 search_name_array(const char *target, const char *const *names, size_t n_names)
164 for (i = 0; i < n_names; i++) {
166 if (!strcasecmp(names[i], target)) {
173 /* Returns the name for logging level 'level'. */
175 vlog_get_level_name(enum vlog_level level)
177 assert(level < VLL_N_LEVELS);
178 return level_names[level];
181 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
182 * is not the name of a logging level. */
184 vlog_get_level_val(const char *name)
186 return search_name_array(name, level_names, ARRAY_SIZE(level_names));
189 /* Returns the name for logging destination 'destination'. */
191 vlog_get_destination_name(enum vlog_destination destination)
193 assert(destination < VLF_N_DESTINATIONS);
194 return destinations[destination].name;
197 /* Returns the logging destination named 'name', or VLF_N_DESTINATIONS if
198 * 'name' is not the name of a logging destination. */
199 enum vlog_destination
200 vlog_get_destination_val(const char *name)
204 for (i = 0; i < VLF_N_DESTINATIONS; i++) {
205 if (!strcasecmp(destinations[i].name, name)) {
212 void vlog_insert_module(struct ovs_list *vlog)
214 list_insert(&vlog_modules, vlog);
217 /* Returns the name for logging module 'module'. */
219 vlog_get_module_name(const struct vlog_module *module)
224 /* Returns the logging module named 'name', or NULL if 'name' is not the name
225 * of a logging module. */
227 vlog_module_from_name(const char *name)
229 struct vlog_module *mp;
231 LIST_FOR_EACH (mp, list, &vlog_modules) {
232 if (!strcasecmp(name, mp->name)) {
240 /* Returns the current logging level for the given 'module' and
243 vlog_get_level(const struct vlog_module *module,
244 enum vlog_destination destination)
246 assert(destination < VLF_N_DESTINATIONS);
247 return module->levels[destination];
251 update_min_level(struct vlog_module *module) OVS_REQUIRES(&log_file_mutex)
253 enum vlog_destination destination;
255 module->min_level = VLL_OFF;
256 for (destination = 0; destination < VLF_N_DESTINATIONS; destination++) {
257 if (log_fd >= 0 || destination != VLF_FILE) {
258 enum vlog_level level = module->levels[destination];
259 if (level > module->min_level) {
260 module->min_level = level;
267 set_destination_level(enum vlog_destination destination,
268 struct vlog_module *module, enum vlog_level level)
270 assert(destination >= 0 && destination < VLF_N_DESTINATIONS);
271 assert(level < VLL_N_LEVELS);
273 ovs_mutex_lock(&log_file_mutex);
275 struct vlog_module *mp;
276 LIST_FOR_EACH (mp, list, &vlog_modules) {
277 mp->levels[destination] = level;
278 update_min_level(mp);
281 module->levels[destination] = level;
282 update_min_level(module);
284 ovs_mutex_unlock(&log_file_mutex);
287 /* Sets the logging level for the given 'module' and 'destination' to 'level'.
288 * A null 'module' or a 'destination' of VLF_ANY_DESTINATION is treated as a
289 * wildcard across all modules or destinations, respectively. */
291 vlog_set_levels(struct vlog_module *module, enum vlog_destination destination,
292 enum vlog_level level)
294 assert(destination < VLF_N_DESTINATIONS ||
295 destination == VLF_ANY_DESTINATION);
296 if (destination == VLF_ANY_DESTINATION) {
297 for (destination = 0; destination < VLF_N_DESTINATIONS;
299 set_destination_level(destination, module, level);
302 set_destination_level(destination, module, level);
307 do_set_pattern(enum vlog_destination destination, const char *pattern)
309 struct destination *f = &destinations[destination];
311 ovs_rwlock_wrlock(&pattern_rwlock);
312 if (!f->default_pattern) {
315 f->default_pattern = false;
317 f->pattern = xstrdup(pattern);
318 ovs_rwlock_unlock(&pattern_rwlock);
321 /* Sets the pattern for the given 'destination' to 'pattern'. */
323 vlog_set_pattern(enum vlog_destination destination, const char *pattern)
325 assert(destination < VLF_N_DESTINATIONS ||
326 destination == VLF_ANY_DESTINATION);
327 if (destination == VLF_ANY_DESTINATION) {
328 for (destination = 0; destination < VLF_N_DESTINATIONS;
330 do_set_pattern(destination, pattern);
333 do_set_pattern(destination, pattern);
337 /* Sets the name of the log file used by VLF_FILE to 'file_name', or to the
338 * default file name if 'file_name' is null. Returns 0 if successful,
339 * otherwise a positive errno value. */
341 vlog_set_log_file(const char *file_name)
343 char *new_log_file_name;
344 struct vlog_module *mp;
345 struct stat old_stat;
346 struct stat new_stat;
351 /* Open new log file. */
352 new_log_file_name = (file_name
354 : xasprintf("%s/%s.log", ovs_logdir(), program_name));
355 new_log_fd = open(new_log_file_name, O_WRONLY | O_CREAT | O_APPEND, 0666);
356 if (new_log_fd < 0) {
357 VLOG_WARN("failed to open %s for logging: %s",
358 new_log_file_name, ovs_strerror(errno));
359 free(new_log_file_name);
363 /* If the new log file is the same one we already have open, bail out. */
364 ovs_mutex_lock(&log_file_mutex);
365 same_file = (log_fd >= 0
367 && !fstat(log_fd, &old_stat)
368 && !fstat(new_log_fd, &new_stat)
369 && old_stat.st_dev == new_stat.st_dev
370 && old_stat.st_ino == new_stat.st_ino);
371 ovs_mutex_unlock(&log_file_mutex);
374 free(new_log_file_name);
378 /* Log closing old log file (we can't log while holding log_file_mutex). */
379 ovs_mutex_lock(&log_file_mutex);
380 log_close = log_fd >= 0;
381 ovs_mutex_unlock(&log_file_mutex);
383 VLOG_INFO("closing log file");
386 /* Close old log file, if any, and install new one. */
387 ovs_mutex_lock(&log_file_mutex);
391 async_append_destroy(log_writer);
394 log_file_name = xstrdup(new_log_file_name);
397 log_writer = async_append_create(new_log_fd);
400 LIST_FOR_EACH (mp, list, &vlog_modules) {
401 update_min_level(mp);
403 ovs_mutex_unlock(&log_file_mutex);
405 /* Log opening new log file (we can't log while holding log_file_mutex). */
406 VLOG_INFO("opened log file %s", new_log_file_name);
407 free(new_log_file_name);
412 /* Closes and then attempts to re-open the current log file. (This is useful
413 * just after log rotation, to ensure that the new log file starts being used.)
414 * Returns 0 if successful, otherwise a positive errno value. */
416 vlog_reopen_log_file(void)
420 ovs_mutex_lock(&log_file_mutex);
421 fn = log_file_name ? xstrdup(log_file_name) : NULL;
422 ovs_mutex_unlock(&log_file_mutex);
425 int error = vlog_set_log_file(fn);
434 /* In case a log file exists, change its owner to new 'user' and 'group'.
436 * This is useful for handling cases where the --log-file option is
437 * specified ahead of the --user option. */
439 vlog_change_owner_unix(uid_t user, gid_t group)
441 struct ds err = DS_EMPTY_INITIALIZER;
444 ovs_mutex_lock(&log_file_mutex);
445 error = log_file_name ? chown(log_file_name, user, group) : 0;
447 /* Build the error message. We can not call VLOG_FATAL directly
448 * here because VLOG_FATAL() will try again to to acquire
449 * 'log_file_mutex' lock, causing deadlock.
451 ds_put_format(&err, "Failed to change %s ownership: %s.",
452 log_file_name, ovs_strerror(errno));
454 ovs_mutex_unlock(&log_file_mutex);
457 VLOG_FATAL("%s", ds_steal_cstr(&err));
462 /* Set debugging levels. Returns null if successful, otherwise an error
463 * message that the caller must free(). */
465 vlog_set_levels_from_string(const char *s_)
467 char *s = xstrdup(s_);
468 char *save_ptr = NULL;
472 word = strtok_r(s, " ,:\t", &save_ptr);
473 if (word && !strcasecmp(word, "PATTERN")) {
474 enum vlog_destination destination;
476 word = strtok_r(NULL, " ,:\t", &save_ptr);
478 msg = xstrdup("missing destination");
482 destination = (!strcasecmp(word, "ANY")
483 ? VLF_ANY_DESTINATION
484 : vlog_get_destination_val(word));
485 if (destination == VLF_N_DESTINATIONS) {
486 msg = xasprintf("unknown destination \"%s\"", word);
489 vlog_set_pattern(destination, save_ptr);
490 } else if (word && !strcasecmp(word, "FACILITY")) {
493 if (!vlog_facility_exists(save_ptr, &value)) {
494 msg = xstrdup("invalid facility");
497 atomic_store_explicit(&log_facility, value, memory_order_relaxed);
499 struct vlog_module *module = NULL;
500 enum vlog_level level = VLL_N_LEVELS;
501 enum vlog_destination destination = VLF_N_DESTINATIONS;
503 for (; word != NULL; word = strtok_r(NULL, " ,:\t", &save_ptr)) {
504 if (!strcasecmp(word, "ANY")) {
506 } else if (vlog_get_destination_val(word) != VLF_N_DESTINATIONS) {
507 if (destination != VLF_N_DESTINATIONS) {
508 msg = xstrdup("cannot specify multiple destinations");
511 destination = vlog_get_destination_val(word);
512 } else if (vlog_get_level_val(word) != VLL_N_LEVELS) {
513 if (level != VLL_N_LEVELS) {
514 msg = xstrdup("cannot specify multiple levels");
517 level = vlog_get_level_val(word);
518 } else if (vlog_module_from_name(word)) {
520 msg = xstrdup("cannot specify multiple modules");
523 module = vlog_module_from_name(word);
525 msg = xasprintf("no destination, level, or module \"%s\"",
531 if (destination == VLF_N_DESTINATIONS) {
532 destination = VLF_ANY_DESTINATION;
534 if (level == VLL_N_LEVELS) {
537 vlog_set_levels(module, destination, level);
545 /* Set debugging levels. Abort with an error message if 's' is invalid. */
547 vlog_set_levels_from_string_assert(const char *s)
549 char *error = vlog_set_levels_from_string(s);
551 ovs_fatal(0, "%s", error);
555 /* If 'arg' is null, configure maximum verbosity. Otherwise, sets
556 * configuration according to 'arg' (see vlog_set_levels_from_string()). */
558 vlog_set_verbosity(const char *arg)
561 char *msg = vlog_set_levels_from_string(arg);
563 ovs_fatal(0, "processing \"%s\": %s", arg, msg);
566 vlog_set_levels(NULL, VLF_ANY_DESTINATION, VLL_DBG);
571 vlog_set_syslog_method(const char *method)
574 /* Set syslogger only, if one is not already set. This effectively
575 * means that only the first --syslog-method argument is honored. */
579 if (!strcmp(method, "libc")) {
580 syslogger = syslog_libc_create();
581 } else if (!strncmp(method, "udp:", 4) || !strncmp(method, "unix:", 5)) {
582 syslogger = syslog_direct_create(method);
584 ovs_fatal(0, "unsupported syslog method '%s'", method);
588 /* Set the vlog udp syslog target. */
590 vlog_set_syslog_target(const char *target)
594 inet_open_active(SOCK_DGRAM, target, 0, NULL, &new_fd, 0);
596 ovs_rwlock_wrlock(&pattern_rwlock);
597 if (syslog_fd >= 0) {
601 ovs_rwlock_unlock(&pattern_rwlock);
604 /* Returns 'false' if 'facility' is not a valid string. If 'facility'
605 * is a valid string, sets 'value' with the integer value of 'facility'
606 * and returns 'true'. */
608 vlog_facility_exists(const char* facility, int *value)
611 for (i = 0; i < ARRAY_SIZE(vlog_facilities); i++) {
612 if (!strcasecmp(vlog_facilities[i].name, facility)) {
613 *value = vlog_facilities[i].value;
621 vlog_unixctl_set(struct unixctl_conn *conn, int argc, const char *argv[],
622 void *aux OVS_UNUSED)
626 for (i = 1; i < argc; i++) {
627 char *msg = vlog_set_levels_from_string(argv[i]);
629 unixctl_command_reply_error(conn, msg);
634 unixctl_command_reply(conn, NULL);
638 vlog_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
639 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
641 char *msg = vlog_get_levels();
642 unixctl_command_reply(conn, msg);
647 vlog_unixctl_list_pattern(struct unixctl_conn *conn, int argc OVS_UNUSED,
648 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
652 msg = vlog_get_patterns();
653 unixctl_command_reply(conn, msg);
658 vlog_unixctl_reopen(struct unixctl_conn *conn, int argc OVS_UNUSED,
659 const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
663 ovs_mutex_lock(&log_file_mutex);
664 has_log_file = log_file_name != NULL;
665 ovs_mutex_unlock(&log_file_mutex);
668 int error = vlog_reopen_log_file();
670 unixctl_command_reply_error(conn, ovs_strerror(errno));
672 unixctl_command_reply(conn, NULL);
675 unixctl_command_reply_error(conn, "Logging to file not configured");
680 set_all_rate_limits(bool enable)
682 struct vlog_module *mp;
684 LIST_FOR_EACH (mp, list, &vlog_modules) {
685 mp->honor_rate_limits = enable;
690 set_rate_limits(struct unixctl_conn *conn, int argc,
691 const char *argv[], bool enable)
696 for (i = 1; i < argc; i++) {
697 if (!strcasecmp(argv[i], "ANY")) {
698 set_all_rate_limits(enable);
700 struct vlog_module *module = vlog_module_from_name(argv[i]);
702 unixctl_command_reply_error(conn, "unknown module");
705 module->honor_rate_limits = enable;
709 set_all_rate_limits(enable);
711 unixctl_command_reply(conn, NULL);
715 vlog_enable_rate_limit(struct unixctl_conn *conn, int argc,
716 const char *argv[], void *aux OVS_UNUSED)
718 set_rate_limits(conn, argc, argv, true);
722 vlog_disable_rate_limit(struct unixctl_conn *conn, int argc,
723 const char *argv[], void *aux OVS_UNUSED)
725 set_rate_limits(conn, argc, argv, false);
728 /* Initializes the logging subsystem and registers its unixctl server
733 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
735 if (ovsthread_once_start(&once)) {
738 bool print_syslog_target_deprecation;
740 /* Do initialization work that needs to be done before any logging
741 * occurs. We want to keep this really minimal because any attempt to
742 * log anything before calling ovsthread_once_done() will deadlock. */
743 atomic_read_explicit(&log_facility, &facility, memory_order_relaxed);
745 syslogger = syslog_libc_create();
747 syslogger->class->openlog(syslogger, facility ? facility : LOG_DAEMON);
748 ovsthread_once_done(&once);
750 /* Now do anything that we want to happen only once but doesn't have to
751 * finish before we start logging. */
753 now = time_wall_msec();
755 char *s = xastrftime_msec("%a, %d %b %Y %H:%M:%S", now, true);
756 VLOG_ERR("current time is negative: %s (%lld)", s, now);
760 unixctl_command_register(
761 "vlog/set", "{spec | PATTERN:destination:pattern}",
762 1, INT_MAX, vlog_unixctl_set, NULL);
763 unixctl_command_register("vlog/list", "", 0, 0, vlog_unixctl_list,
765 unixctl_command_register("vlog/list-pattern", "", 0, 0,
766 vlog_unixctl_list_pattern, NULL);
767 unixctl_command_register("vlog/enable-rate-limit", "[module]...",
768 0, INT_MAX, vlog_enable_rate_limit, NULL);
769 unixctl_command_register("vlog/disable-rate-limit", "[module]...",
770 0, INT_MAX, vlog_disable_rate_limit, NULL);
771 unixctl_command_register("vlog/reopen", "", 0, 0,
772 vlog_unixctl_reopen, NULL);
774 ovs_rwlock_rdlock(&pattern_rwlock);
775 print_syslog_target_deprecation = syslog_fd >= 0;
776 ovs_rwlock_unlock(&pattern_rwlock);
778 if (print_syslog_target_deprecation) {
779 VLOG_WARN("--syslog-target flag is deprecated, use "
780 "--syslog-method instead");
785 /* Enables VLF_FILE log output to be written asynchronously to disk.
786 * Asynchronous file writes avoid blocking the process in the case of a busy
787 * disk, but on the other hand they are less robust: there is a chance that the
788 * write will not make it to the log file if the process crashes soon after the
791 vlog_enable_async(void)
793 ovs_mutex_lock(&log_file_mutex);
795 if (log_fd >= 0 && !log_writer) {
796 log_writer = async_append_create(log_fd);
798 ovs_mutex_unlock(&log_file_mutex);
801 /* Print the current logging level for each module. */
803 vlog_get_levels(void)
805 struct ds s = DS_EMPTY_INITIALIZER;
806 struct vlog_module *mp;
807 struct svec lines = SVEC_EMPTY_INITIALIZER;
811 ds_put_format(&s, " console syslog file\n");
812 ds_put_format(&s, " ------- ------ ------\n");
814 LIST_FOR_EACH (mp, list, &vlog_modules) {
818 ds_put_format(&line, "%-16s %4s %4s %4s",
819 vlog_get_module_name(mp),
820 vlog_get_level_name(vlog_get_level(mp, VLF_CONSOLE)),
821 vlog_get_level_name(vlog_get_level(mp, VLF_SYSLOG)),
822 vlog_get_level_name(vlog_get_level(mp, VLF_FILE)));
823 if (!mp->honor_rate_limits) {
824 ds_put_cstr(&line, " (rate limiting disabled)");
826 ds_put_char(&line, '\n');
828 svec_add_nocopy(&lines, ds_steal_cstr(&line));
832 SVEC_FOR_EACH (i, line, &lines) {
833 ds_put_cstr(&s, line);
835 svec_destroy(&lines);
840 /* Returns as a string current logging patterns for each destination.
841 * This string must be released by caller. */
843 vlog_get_patterns(void)
845 struct ds ds = DS_EMPTY_INITIALIZER;
846 enum vlog_destination destination;
848 ovs_rwlock_rdlock(&pattern_rwlock);
849 ds_put_format(&ds, " prefix format\n");
850 ds_put_format(&ds, " ------ ------\n");
852 for (destination = 0; destination < VLF_N_DESTINATIONS; destination++) {
853 struct destination *f = &destinations[destination];
854 const char *prefix = "none";
856 if (destination == VLF_SYSLOG && syslogger) {
857 prefix = syslog_get_prefix(syslogger);
859 ds_put_format(&ds, "%-7s %-32s %s\n", f->name, prefix, f->pattern);
861 ovs_rwlock_unlock(&pattern_rwlock);
866 /* Returns true if a log message emitted for the given 'module' and 'level'
867 * would cause some log output, false if that module and level are completely
870 vlog_is_enabled(const struct vlog_module *module, enum vlog_level level)
872 return module->min_level >= level;
876 fetch_braces(const char *p, const char *def, char *out, size_t out_size)
879 size_t n = strcspn(p + 1, "}");
880 size_t n_copy = MIN(n, out_size - 1);
881 memcpy(out, p + 1, n_copy);
885 ovs_strlcpy(out, def, out_size);
891 format_log_message(const struct vlog_module *module, enum vlog_level level,
892 const char *pattern, const char *message,
893 va_list args_, struct ds *s)
901 for (p = pattern; *p != '\0'; ) {
902 const char *subprogram_name;
903 enum { LEFT, RIGHT } justify = RIGHT;
905 size_t length, field, used;
908 ds_put_char(s, *p++);
922 while (isdigit((unsigned char)*p)) {
923 field = (field * 10) + (*p - '0');
930 ds_put_cstr(s, program_name);
933 atomic_read_explicit(&log_facility, &facility,
934 memory_order_relaxed);
935 facility = facility ? facility : LOG_LOCAL0;
936 ds_put_format(s, "%d", facility + syslog_levels[level]);
939 p = fetch_braces(p, "", tmp, sizeof tmp);
940 ds_put_cstr(s, vlog_get_module_name(module));
943 p = fetch_braces(p, "%Y-%m-%d %H:%M:%S.###", tmp, sizeof tmp);
944 ds_put_strftime_msec(s, tmp, time_wall_msec(), false);
947 p = fetch_braces(p, "%Y-%m-%d %H:%M:%S.###", tmp, sizeof tmp);
948 ds_put_strftime_msec(s, tmp, time_wall_msec(), true);
951 gethostname(tmp, sizeof tmp);
952 tmp[sizeof tmp - 1] = '\0';
956 /* Format user-supplied log message and trim trailing new-lines. */
958 va_copy(args, args_);
959 ds_put_format_valist(s, message, args);
961 while (s->length > length && s->string[s->length - 1] == '\n') {
966 ds_put_format(s, "%u", *msg_num_get_unsafe());
969 ds_put_char(s, '\n');
972 ds_put_cstr(s, vlog_get_level_name(level));
975 ds_put_format(s, "%ld", (long int) getpid());
978 ds_put_format(s, "%lld", time_msec() - time_boot_msec());
981 subprogram_name = get_subprogram_name();
982 ds_put_cstr(s, subprogram_name[0] ? subprogram_name : "main");
985 subprogram_name = get_subprogram_name();
986 if (subprogram_name[0]) {
987 ds_put_format(s, "(%s)", subprogram_name);
991 ds_put_char(s, p[-1]);
994 used = s->length - length;
996 size_t n_pad = field - used;
997 if (justify == RIGHT) {
998 ds_put_uninit(s, n_pad);
999 memmove(&s->string[length + n_pad], &s->string[length], used);
1000 memset(&s->string[length], pad, n_pad);
1002 ds_put_char_multiple(s, pad, n_pad);
1008 /* Exports the given 'syslog_message' to the configured udp syslog sink. */
1010 send_to_syslog_fd(const char *s, size_t length)
1011 OVS_REQ_RDLOCK(pattern_rwlock)
1013 static size_t max_length = SIZE_MAX;
1014 size_t send_len = MIN(length, max_length);
1016 while (write(syslog_fd, s, send_len) < 0 && errno == EMSGSIZE) {
1017 send_len -= send_len / 20;
1018 max_length = send_len;
1022 /* Writes 'message' to the log at the given 'level' and as coming from the
1025 * Guaranteed to preserve errno. */
1027 vlog_valist(const struct vlog_module *module, enum vlog_level level,
1028 const char *message, va_list args)
1030 bool log_to_console = module->levels[VLF_CONSOLE] >= level;
1031 bool log_to_syslog = module->levels[VLF_SYSLOG] >= level;
1034 ovs_mutex_lock(&log_file_mutex);
1035 log_to_file = module->levels[VLF_FILE] >= level && log_fd >= 0;
1036 ovs_mutex_unlock(&log_file_mutex);
1037 if (log_to_console || log_to_syslog || log_to_file) {
1038 int save_errno = errno;
1044 ds_reserve(&s, 1024);
1047 ovs_rwlock_rdlock(&pattern_rwlock);
1048 if (log_to_console) {
1049 format_log_message(module, level,
1050 destinations[VLF_CONSOLE].pattern, message,
1052 ds_put_char(&s, '\n');
1053 fputs(ds_cstr(&s), stderr);
1056 if (log_to_syslog) {
1057 int syslog_level = syslog_levels[level];
1058 char *save_ptr = NULL;
1062 format_log_message(module, level, destinations[VLF_SYSLOG].pattern,
1064 for (line = strtok_r(s.string, "\n", &save_ptr); line;
1065 line = strtok_r(NULL, "\n", &save_ptr)) {
1066 atomic_read_explicit(&log_facility, &facility,
1067 memory_order_relaxed);
1068 syslogger->class->syslog(syslogger, syslog_level|facility, line);
1071 if (syslog_fd >= 0) {
1072 format_log_message(module, level,
1073 "<%B>1 %D{%Y-%m-%dT%H:%M:%S.###Z} "
1074 "%E %A %P %c - \xef\xbb\xbf%m",
1076 send_to_syslog_fd(ds_cstr(&s), s.length);
1081 format_log_message(module, level, destinations[VLF_FILE].pattern,
1083 ds_put_char(&s, '\n');
1085 ovs_mutex_lock(&log_file_mutex);
1088 async_append_write(log_writer, s.string, s.length);
1089 if (level == VLL_EMER) {
1090 async_append_flush(log_writer);
1093 ignore(write(log_fd, s.string, s.length));
1096 ovs_mutex_unlock(&log_file_mutex);
1098 ovs_rwlock_unlock(&pattern_rwlock);
1106 vlog(const struct vlog_module *module, enum vlog_level level,
1107 const char *message, ...)
1111 va_start(args, message);
1112 vlog_valist(module, level, message, args);
1116 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
1117 * exit code. Always writes the message to stderr, even if the console
1118 * destination is disabled.
1120 * Choose this function instead of vlog_abort_valist() if the daemon monitoring
1121 * facility shouldn't automatically restart the current daemon. */
1123 vlog_fatal_valist(const struct vlog_module *module_,
1124 const char *message, va_list args)
1126 struct vlog_module *module = CONST_CAST(struct vlog_module *, module_);
1128 /* Don't log this message to the console to avoid redundancy with the
1129 * message written by the later ovs_fatal_valist(). */
1130 module->levels[VLF_CONSOLE] = VLL_OFF;
1132 vlog_valist(module, VLL_EMER, message, args);
1133 ovs_fatal_valist(0, message, args);
1136 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
1137 * exit code. Always writes the message to stderr, even if the console
1138 * destination is disabled.
1140 * Choose this function instead of vlog_abort() if the daemon monitoring
1141 * facility shouldn't automatically restart the current daemon. */
1143 vlog_fatal(const struct vlog_module *module, const char *message, ...)
1147 va_start(args, message);
1148 vlog_fatal_valist(module, message, args);
1152 /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always
1153 * writes the message to stderr, even if the console destination is disabled.
1155 * Choose this function instead of vlog_fatal_valist() if the daemon monitoring
1156 * facility should automatically restart the current daemon. */
1158 vlog_abort_valist(const struct vlog_module *module_,
1159 const char *message, va_list args)
1161 struct vlog_module *module = (struct vlog_module *) module_;
1163 /* Don't log this message to the console to avoid redundancy with the
1164 * message written by the later ovs_abort_valist(). */
1165 module->levels[VLF_CONSOLE] = VLL_OFF;
1167 vlog_valist(module, VLL_EMER, message, args);
1168 ovs_abort_valist(0, message, args);
1171 /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always
1172 * writes the message to stderr, even if the console destination is disabled.
1174 * Choose this function instead of vlog_fatal() if the daemon monitoring
1175 * facility should automatically restart the current daemon. */
1177 vlog_abort(const struct vlog_module *module, const char *message, ...)
1181 va_start(args, message);
1182 vlog_abort_valist(module, message, args);
1187 vlog_should_drop(const struct vlog_module *module, enum vlog_level level,
1188 struct vlog_rate_limit *rl)
1190 if (!module->honor_rate_limits) {
1194 if (!vlog_is_enabled(module, level)) {
1198 ovs_mutex_lock(&rl->mutex);
1199 if (!token_bucket_withdraw(&rl->token_bucket, VLOG_MSG_TOKENS)) {
1200 time_t now = time_now();
1201 if (!rl->n_dropped) {
1202 rl->first_dropped = now;
1204 rl->last_dropped = now;
1206 ovs_mutex_unlock(&rl->mutex);
1210 if (!rl->n_dropped) {
1211 ovs_mutex_unlock(&rl->mutex);
1213 time_t now = time_now();
1214 unsigned int n_dropped = rl->n_dropped;
1215 unsigned int first_dropped_elapsed = now - rl->first_dropped;
1216 unsigned int last_dropped_elapsed = now - rl->last_dropped;
1218 ovs_mutex_unlock(&rl->mutex);
1221 "Dropped %u log messages in last %u seconds (most recently, "
1222 "%u seconds ago) due to excessive rate",
1223 n_dropped, first_dropped_elapsed, last_dropped_elapsed);
1230 vlog_rate_limit(const struct vlog_module *module, enum vlog_level level,
1231 struct vlog_rate_limit *rl, const char *message, ...)
1233 if (!vlog_should_drop(module, level, rl)) {
1236 va_start(args, message);
1237 vlog_valist(module, level, message, args);
1247 -vSPEC, --verbose=SPEC set logging levels\n\
1248 -v, --verbose set maximum verbosity level\n\
1249 --log-file[=FILE] enable logging to specified FILE\n\
1250 (default: %s/%s.log)\n\
1251 --syslog-method=(libc|unix:file|udp:ip:port)\n\
1252 specify how to send messages to syslog daemon\n\
1253 --syslog-target=HOST:PORT also send syslog msgs to HOST:PORT via UDP\n",
1254 ovs_logdir(), program_name);