X-Git-Url: http://git.cascardo.eti.br/?a=blobdiff_plain;ds=sidebyside;f=lib%2Fvlog.c;h=bbc6eb6f68f303417312224bb60556ad778eae74;hb=7c6401ca2b8c718e274a89928c4b602a1904342a;hp=0bd9bd135892b7d26d343f24cc327d02b0b2ad6d;hpb=cb22974d773942d66da42b700b8bca0db27a0920;p=cascardo%2Fovs.git diff --git a/lib/vlog.c b/lib/vlog.c index 0bd9bd135..bbc6eb6f6 100644 --- a/lib/vlog.c +++ b/lib/vlog.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc. + * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2015, 2016 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -15,7 +15,7 @@ */ #include -#include "vlog.h" +#include "openvswitch/vlog.h" #include #include #include @@ -28,81 +28,138 @@ #include #include #include +#include "async-append.h" +#include "coverage.h" #include "dirs.h" #include "dynamic-string.h" #include "ofpbuf.h" +#include "ovs-thread.h" #include "sat-math.h" +#include "socket-util.h" #include "svec.h" +#include "syslog-direct.h" +#include "syslog-libc.h" +#include "syslog-provider.h" #include "timeval.h" #include "unixctl.h" #include "util.h" -#include "worker.h" VLOG_DEFINE_THIS_MODULE(vlog); +/* ovs_assert() logs the assertion message, so using ovs_assert() in this + * source file could cause recursion. */ +#undef ovs_assert +#define ovs_assert use_assert_instead_of_ovs_assert_in_this_module + /* Name for each logging level. */ -static const char *level_names[VLL_N_LEVELS] = { -#define VLOG_LEVEL(NAME, SYSLOG_LEVEL) #NAME, +static const char *const level_names[VLL_N_LEVELS] = { +#define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424) #NAME, VLOG_LEVELS #undef VLOG_LEVEL }; /* Syslog value for each logging level. */ -static int syslog_levels[VLL_N_LEVELS] = { -#define VLOG_LEVEL(NAME, SYSLOG_LEVEL) SYSLOG_LEVEL, +static const int syslog_levels[VLL_N_LEVELS] = { +#define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424) SYSLOG_LEVEL, VLOG_LEVELS #undef VLOG_LEVEL }; -/* The log modules. */ -#if USE_LINKER_SECTIONS -extern struct vlog_module *__start_vlog_modules[]; -extern struct vlog_module *__stop_vlog_modules[]; -#define vlog_modules __start_vlog_modules -#define n_vlog_modules (__stop_vlog_modules - __start_vlog_modules) -#else -#define VLOG_MODULE VLOG_DEFINE_MODULE__ -#include "vlog-modules.def" -#undef VLOG_MODULE - -struct vlog_module *vlog_modules[] = { -#define VLOG_MODULE(NAME) &VLM_##NAME, -#include "vlog-modules.def" -#undef VLOG_MODULE -}; -#define n_vlog_modules ARRAY_SIZE(vlog_modules) -#endif - -/* Information about each facility. */ -struct facility { +/* RFC 5424 defines specific values for each syslog level. Normally LOG_* use + * the same values. Verify that in fact they're the same. If we get assertion + * failures here then we need to define a separate rfc5424_levels[] array. */ +#define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424) \ + BUILD_ASSERT_DECL(SYSLOG_LEVEL == RFC5424); +VLOG_LEVELS +#undef VLOG_LEVELS + +/* Similarly, RFC 5424 defines the local0 facility with the value ordinarily + * used for LOG_LOCAL0. */ +BUILD_ASSERT_DECL(LOG_LOCAL0 == (16 << 3)); + +/* Protects the 'pattern' in all "struct destination"s, so that a race between + * changing and reading the pattern does not cause an access to freed + * memory. */ +static struct ovs_rwlock pattern_rwlock = OVS_RWLOCK_INITIALIZER; + +/* Information about each destination. */ +struct destination { const char *name; /* Name. */ - char *pattern; /* Current pattern. */ + char *pattern OVS_GUARDED_BY(pattern_rwlock); /* Current pattern. */ bool default_pattern; /* Whether current pattern is the default. */ }; -static struct facility facilities[VLF_N_FACILITIES] = { -#define VLOG_FACILITY(NAME, PATTERN) {#NAME, PATTERN, true}, - VLOG_FACILITIES -#undef VLOG_FACILITY +static struct destination destinations[VLF_N_DESTINATIONS] = { +#define VLOG_DESTINATION(NAME, PATTERN) {#NAME, PATTERN, true}, + VLOG_DESTINATIONS +#undef VLOG_DESTINATION }; -/* VLF_FILE configuration. */ -static char *log_file_name; -static int log_fd = -1; +/* Sequence number for the message currently being composed. */ +DEFINE_STATIC_PER_THREAD_DATA(unsigned int, msg_num, 0); + +/* VLF_FILE configuration. + * + * All of the following is protected by 'log_file_mutex', which nests inside + * pattern_rwlock. */ +static struct ovs_mutex log_file_mutex OVS_ACQ_AFTER(pattern_rwlock) + = OVS_MUTEX_INITIALIZER; +static char *log_file_name OVS_GUARDED_BY(log_file_mutex) = NULL; +static int log_fd OVS_GUARDED_BY(log_file_mutex) = -1; +static struct async_append *log_writer OVS_GUARDED_BY(log_file_mutex); +static bool log_async OVS_GUARDED_BY(log_file_mutex); +static struct syslogger *syslogger = NULL; + +/* The log modules. */ +static struct ovs_list vlog_modules OVS_GUARDED_BY(log_file_mutex) + = OVS_LIST_INITIALIZER(&vlog_modules); -/* vlog initialized? */ -static bool vlog_inited; +/* Syslog export configuration. */ +static int syslog_fd OVS_GUARDED_BY(pattern_rwlock) = -1; + +/* Log facility configuration. */ +static atomic_int log_facility = ATOMIC_VAR_INIT(0); + +/* Facility name and its value. */ +struct vlog_facility { + char *name; /* Name. */ + unsigned int value; /* Facility associated with 'name'. */ +}; +static struct vlog_facility vlog_facilities[] = { + {"kern", LOG_KERN}, + {"user", LOG_USER}, + {"mail", LOG_MAIL}, + {"daemon", LOG_DAEMON}, + {"auth", LOG_AUTH}, + {"syslog", LOG_SYSLOG}, + {"lpr", LOG_LPR}, + {"news", LOG_NEWS}, + {"uucp", LOG_UUCP}, + {"clock", LOG_CRON}, + {"ftp", LOG_FTP}, + {"ntp", 12<<3}, + {"audit", 13<<3}, + {"alert", 14<<3}, + {"clock2", 15<<3}, + {"local0", LOG_LOCAL0}, + {"local1", LOG_LOCAL1}, + {"local2", LOG_LOCAL2}, + {"local3", LOG_LOCAL3}, + {"local4", LOG_LOCAL4}, + {"local5", LOG_LOCAL5}, + {"local6", LOG_LOCAL6}, + {"local7", LOG_LOCAL7} +}; +static bool vlog_facility_exists(const char* facility, int *value); static void format_log_message(const struct vlog_module *, enum vlog_level, - enum vlog_facility, unsigned int msg_num, + const char *pattern, const char *message, va_list, struct ds *) - PRINTF_FORMAT(5, 0); -static void vlog_write_file(struct ds *); -static void vlog_update_async_log_fd(void); + OVS_PRINTF_FORMAT(4, 0); /* Searches the 'n_names' in 'names'. Returns the index of a match for * 'target', or 'n_names' if no name matches. */ static size_t -search_name_array(const char *target, const char **names, size_t n_names) +search_name_array(const char *target, const char *const *names, size_t n_names) { size_t i; @@ -131,29 +188,37 @@ vlog_get_level_val(const char *name) return search_name_array(name, level_names, ARRAY_SIZE(level_names)); } -/* Returns the name for logging facility 'facility'. */ +/* Returns the name for logging destination 'destination'. */ const char * -vlog_get_facility_name(enum vlog_facility facility) +vlog_get_destination_name(enum vlog_destination destination) { - assert(facility < VLF_N_FACILITIES); - return facilities[facility].name; + assert(destination < VLF_N_DESTINATIONS); + return destinations[destination].name; } -/* Returns the logging facility named 'name', or VLF_N_FACILITIES if 'name' is - * not the name of a logging facility. */ -enum vlog_facility -vlog_get_facility_val(const char *name) +/* Returns the logging destination named 'name', or VLF_N_DESTINATIONS if + * 'name' is not the name of a logging destination. */ +enum vlog_destination +vlog_get_destination_val(const char *name) { size_t i; - for (i = 0; i < VLF_N_FACILITIES; i++) { - if (!strcasecmp(facilities[i].name, name)) { + for (i = 0; i < VLF_N_DESTINATIONS; i++) { + if (!strcasecmp(destinations[i].name, name)) { break; } } return i; } +void +vlog_insert_module(struct ovs_list *vlog) +{ + ovs_mutex_lock(&log_file_mutex); + list_insert(&vlog_modules, vlog); + ovs_mutex_unlock(&log_file_mutex); +} + /* Returns the name for logging module 'module'. */ const char * vlog_get_module_name(const struct vlog_module *module) @@ -166,33 +231,39 @@ vlog_get_module_name(const struct vlog_module *module) struct vlog_module * vlog_module_from_name(const char *name) { - struct vlog_module **mp; + struct vlog_module *mp; - for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) { - if (!strcasecmp(name, (*mp)->name)) { - return *mp; + ovs_mutex_lock(&log_file_mutex); + LIST_FOR_EACH (mp, list, &vlog_modules) { + if (!strcasecmp(name, mp->name)) { + ovs_mutex_unlock(&log_file_mutex); + return mp; } } + ovs_mutex_unlock(&log_file_mutex); + return NULL; } -/* Returns the current logging level for the given 'module' and 'facility'. */ +/* Returns the current logging level for the given 'module' and + * 'destination'. */ enum vlog_level -vlog_get_level(const struct vlog_module *module, enum vlog_facility facility) +vlog_get_level(const struct vlog_module *module, + enum vlog_destination destination) { - assert(facility < VLF_N_FACILITIES); - return module->levels[facility]; + assert(destination < VLF_N_DESTINATIONS); + return module->levels[destination]; } static void -update_min_level(struct vlog_module *module) +update_min_level(struct vlog_module *module) OVS_REQUIRES(&log_file_mutex) { - enum vlog_facility facility; + enum vlog_destination destination; module->min_level = VLL_OFF; - for (facility = 0; facility < VLF_N_FACILITIES; facility++) { - if (log_fd >= 0 || facility != VLF_FILE) { - enum vlog_level level = module->levels[facility]; + for (destination = 0; destination < VLF_N_DESTINATIONS; destination++) { + if (log_fd >= 0 || destination != VLF_FILE) { + enum vlog_level level = module->levels[destination]; if (level > module->min_level) { module->min_level = level; } @@ -201,125 +272,149 @@ update_min_level(struct vlog_module *module) } static void -set_facility_level(enum vlog_facility facility, struct vlog_module *module, - enum vlog_level level) +set_destination_level(enum vlog_destination destination, + struct vlog_module *module, enum vlog_level level) { - assert(facility >= 0 && facility < VLF_N_FACILITIES); + assert(destination >= 0 && destination < VLF_N_DESTINATIONS); assert(level < VLL_N_LEVELS); + ovs_mutex_lock(&log_file_mutex); if (!module) { - struct vlog_module **mp; - - for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) { - (*mp)->levels[facility] = level; - update_min_level(*mp); + struct vlog_module *mp; + LIST_FOR_EACH (mp, list, &vlog_modules) { + mp->levels[destination] = level; + update_min_level(mp); } } else { - module->levels[facility] = level; + module->levels[destination] = level; update_min_level(module); } + ovs_mutex_unlock(&log_file_mutex); } -/* Sets the logging level for the given 'module' and 'facility' to 'level'. A - * null 'module' or a 'facility' of VLF_ANY_FACILITY is treated as a wildcard - * across all modules or facilities, respectively. */ +/* Sets the logging level for the given 'module' and 'destination' to 'level'. + * A null 'module' or a 'destination' of VLF_ANY_DESTINATION is treated as a + * wildcard across all modules or destinations, respectively. */ void -vlog_set_levels(struct vlog_module *module, enum vlog_facility facility, +vlog_set_levels(struct vlog_module *module, enum vlog_destination destination, enum vlog_level level) { - assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY); - if (facility == VLF_ANY_FACILITY) { - for (facility = 0; facility < VLF_N_FACILITIES; facility++) { - set_facility_level(facility, module, level); + assert(destination < VLF_N_DESTINATIONS || + destination == VLF_ANY_DESTINATION); + if (destination == VLF_ANY_DESTINATION) { + for (destination = 0; destination < VLF_N_DESTINATIONS; + destination++) { + set_destination_level(destination, module, level); } } else { - set_facility_level(facility, module, level); + set_destination_level(destination, module, level); } } static void -do_set_pattern(enum vlog_facility facility, const char *pattern) +do_set_pattern(enum vlog_destination destination, const char *pattern) { - struct facility *f = &facilities[facility]; + struct destination *f = &destinations[destination]; + + ovs_rwlock_wrlock(&pattern_rwlock); if (!f->default_pattern) { free(f->pattern); } else { f->default_pattern = false; } f->pattern = xstrdup(pattern); + ovs_rwlock_unlock(&pattern_rwlock); } -/* Sets the pattern for the given 'facility' to 'pattern'. */ +/* Sets the pattern for the given 'destination' to 'pattern'. */ void -vlog_set_pattern(enum vlog_facility facility, const char *pattern) +vlog_set_pattern(enum vlog_destination destination, const char *pattern) { - assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY); - if (facility == VLF_ANY_FACILITY) { - for (facility = 0; facility < VLF_N_FACILITIES; facility++) { - do_set_pattern(facility, pattern); + assert(destination < VLF_N_DESTINATIONS || + destination == VLF_ANY_DESTINATION); + if (destination == VLF_ANY_DESTINATION) { + for (destination = 0; destination < VLF_N_DESTINATIONS; + destination++) { + do_set_pattern(destination, pattern); } } else { - do_set_pattern(facility, pattern); + do_set_pattern(destination, pattern); } } -/* Returns the name of the log file used by VLF_FILE, or a null pointer if no - * log file has been set. (A non-null return value does not assert that the - * named log file is in use: if vlog_set_log_file() or vlog_reopen_log_file() - * fails, it still sets the log file name.) */ -const char * -vlog_get_log_file(void) -{ - return log_file_name; -} - /* Sets the name of the log file used by VLF_FILE to 'file_name', or to the * default file name if 'file_name' is null. Returns 0 if successful, * otherwise a positive errno value. */ int vlog_set_log_file(const char *file_name) { - char *old_log_file_name; - struct vlog_module **mp; - int error; + char *new_log_file_name; + struct vlog_module *mp; + struct stat old_stat; + struct stat new_stat; + int new_log_fd; + bool same_file; + bool log_close; + + /* Open new log file. */ + new_log_file_name = (file_name + ? xstrdup(file_name) + : xasprintf("%s/%s.log", ovs_logdir(), program_name)); + new_log_fd = open(new_log_file_name, O_WRONLY | O_CREAT | O_APPEND, 0666); + if (new_log_fd < 0) { + VLOG_WARN("failed to open %s for logging: %s", + new_log_file_name, ovs_strerror(errno)); + free(new_log_file_name); + return errno; + } - /* Close old log file. */ - if (log_fd >= 0) { - VLOG_INFO("closing log file"); - close(log_fd); - log_fd = -1; + /* If the new log file is the same one we already have open, bail out. */ + ovs_mutex_lock(&log_file_mutex); + same_file = (log_fd >= 0 + && new_log_fd >= 0 + && !fstat(log_fd, &old_stat) + && !fstat(new_log_fd, &new_stat) + && old_stat.st_dev == new_stat.st_dev + && old_stat.st_ino == new_stat.st_ino); + ovs_mutex_unlock(&log_file_mutex); + if (same_file) { + close(new_log_fd); + free(new_log_file_name); + return 0; } - /* Update log file name and free old name. The ordering is important - * because 'file_name' might be 'log_file_name' or some suffix of it. */ - old_log_file_name = log_file_name; - log_file_name = (file_name - ? xstrdup(file_name) - : xasprintf("%s/%s.log", ovs_logdir(), program_name)); - free(old_log_file_name); - file_name = NULL; /* Might have been freed. */ + /* Log closing old log file (we can't log while holding log_file_mutex). */ + ovs_mutex_lock(&log_file_mutex); + log_close = log_fd >= 0; + ovs_mutex_unlock(&log_file_mutex); + if (log_close) { + VLOG_INFO("closing log file"); + } - /* Open new log file and update min_levels[] to reflect whether we actually - * have a log_file. */ - log_fd = open(log_file_name, O_WRONLY | O_CREAT | O_APPEND, 0666); + /* Close old log file, if any, and install new one. */ + ovs_mutex_lock(&log_file_mutex); if (log_fd >= 0) { - vlog_update_async_log_fd(); + free(log_file_name); + close(log_fd); + async_append_destroy(log_writer); } - for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) { - update_min_level(*mp); + + log_file_name = xstrdup(new_log_file_name); + log_fd = new_log_fd; + if (log_async) { + log_writer = async_append_create(new_log_fd); } - /* Log success or failure. */ - if (log_fd < 0) { - VLOG_WARN("failed to open %s for logging: %s", - log_file_name, strerror(errno)); - error = errno; - } else { - VLOG_INFO("opened log file %s", log_file_name); - error = 0; + LIST_FOR_EACH (mp, list, &vlog_modules) { + update_min_level(mp); } + ovs_mutex_unlock(&log_file_mutex); + + /* Log opening new log file (we can't log while holding log_file_mutex). */ + VLOG_INFO("opened log file %s", new_log_file_name); + free(new_log_file_name); - return error; + return 0; } /* Closes and then attempts to re-open the current log file. (This is useful @@ -328,26 +423,49 @@ vlog_set_log_file(const char *file_name) int vlog_reopen_log_file(void) { - struct stat old, new; + char *fn; - /* Skip re-opening if there's nothing to reopen. */ - if (!log_file_name) { + ovs_mutex_lock(&log_file_mutex); + fn = log_file_name ? xstrdup(log_file_name) : NULL; + ovs_mutex_unlock(&log_file_mutex); + + if (fn) { + int error = vlog_set_log_file(fn); + free(fn); + return error; + } else { return 0; } +} - /* Skip re-opening if it would be a no-op because the old and new files are - * the same. (This avoids writing "closing log file" followed immediately - * by "opened log file".) */ - if (log_fd >= 0 - && !fstat(log_fd, &old) - && !stat(log_file_name, &new) - && old.st_dev == new.st_dev - && old.st_ino == new.st_ino) { - return 0; +#ifndef _WIN32 +/* In case a log file exists, change its owner to new 'user' and 'group'. + * + * This is useful for handling cases where the --log-file option is + * specified ahead of the --user option. */ +void +vlog_change_owner_unix(uid_t user, gid_t group) +{ + struct ds err = DS_EMPTY_INITIALIZER; + int error; + + ovs_mutex_lock(&log_file_mutex); + error = log_file_name ? chown(log_file_name, user, group) : 0; + if (error) { + /* Build the error message. We can not call VLOG_FATAL directly + * here because VLOG_FATAL() will try again to to acquire + * 'log_file_mutex' lock, causing deadlock. + */ + ds_put_format(&err, "Failed to change %s ownership: %s.", + log_file_name, ovs_strerror(errno)); } + ovs_mutex_unlock(&log_file_mutex); - return vlog_set_log_file(log_file_name); + if (error) { + VLOG_FATAL("%s", ds_steal_cstr(&err)); + } } +#endif /* Set debugging levels. Returns null if successful, otherwise an error * message that the caller must free(). */ @@ -361,36 +479,44 @@ vlog_set_levels_from_string(const char *s_) word = strtok_r(s, " ,:\t", &save_ptr); if (word && !strcasecmp(word, "PATTERN")) { - enum vlog_facility facility; + enum vlog_destination destination; word = strtok_r(NULL, " ,:\t", &save_ptr); if (!word) { - msg = xstrdup("missing facility"); + msg = xstrdup("missing destination"); + goto exit; + } + + destination = (!strcasecmp(word, "ANY") + ? VLF_ANY_DESTINATION + : vlog_get_destination_val(word)); + if (destination == VLF_N_DESTINATIONS) { + msg = xasprintf("unknown destination \"%s\"", word); goto exit; } + vlog_set_pattern(destination, save_ptr); + } else if (word && !strcasecmp(word, "FACILITY")) { + int value; - facility = (!strcasecmp(word, "ANY") - ? VLF_ANY_FACILITY - : vlog_get_facility_val(word)); - if (facility == VLF_N_FACILITIES) { - msg = xasprintf("unknown facility \"%s\"", word); + if (!vlog_facility_exists(save_ptr, &value)) { + msg = xstrdup("invalid facility"); goto exit; } - vlog_set_pattern(facility, save_ptr); + atomic_store_explicit(&log_facility, value, memory_order_relaxed); } else { struct vlog_module *module = NULL; enum vlog_level level = VLL_N_LEVELS; - enum vlog_facility facility = VLF_N_FACILITIES; + enum vlog_destination destination = VLF_N_DESTINATIONS; for (; word != NULL; word = strtok_r(NULL, " ,:\t", &save_ptr)) { if (!strcasecmp(word, "ANY")) { continue; - } else if (vlog_get_facility_val(word) != VLF_N_FACILITIES) { - if (facility != VLF_N_FACILITIES) { - msg = xstrdup("cannot specify multiple facilities"); + } else if (vlog_get_destination_val(word) != VLF_N_DESTINATIONS) { + if (destination != VLF_N_DESTINATIONS) { + msg = xstrdup("cannot specify multiple destinations"); goto exit; } - facility = vlog_get_facility_val(word); + destination = vlog_get_destination_val(word); } else if (vlog_get_level_val(word) != VLL_N_LEVELS) { if (level != VLL_N_LEVELS) { msg = xstrdup("cannot specify multiple levels"); @@ -404,18 +530,19 @@ vlog_set_levels_from_string(const char *s_) } module = vlog_module_from_name(word); } else { - msg = xasprintf("no facility, level, or module \"%s\"", word); + msg = xasprintf("no destination, level, or module \"%s\"", + word); goto exit; } } - if (facility == VLF_N_FACILITIES) { - facility = VLF_ANY_FACILITY; + if (destination == VLF_N_DESTINATIONS) { + destination = VLF_ANY_DESTINATION; } if (level == VLL_N_LEVELS) { level = VLL_DBG; } - vlog_set_levels(module, facility, level); + vlog_set_levels(module, destination, level); } exit: @@ -423,6 +550,16 @@ exit: return msg; } +/* Set debugging levels. Abort with an error message if 's' is invalid. */ +void +vlog_set_levels_from_string_assert(const char *s) +{ + char *error = vlog_set_levels_from_string(s); + if (error) { + ovs_fatal(0, "%s", error); + } +} + /* If 'arg' is null, configure maximum verbosity. Otherwise, sets * configuration according to 'arg' (see vlog_set_levels_from_string()). */ void @@ -434,10 +571,60 @@ vlog_set_verbosity(const char *arg) ovs_fatal(0, "processing \"%s\": %s", arg, msg); } } else { - vlog_set_levels(NULL, VLF_ANY_FACILITY, VLL_DBG); + vlog_set_levels(NULL, VLF_ANY_DESTINATION, VLL_DBG); + } +} + +void +vlog_set_syslog_method(const char *method) +{ + if (syslogger) { + /* Set syslogger only, if one is not already set. This effectively + * means that only the first --syslog-method argument is honored. */ + return; + } + + if (!strcmp(method, "libc")) { + syslogger = syslog_libc_create(); + } else if (!strncmp(method, "udp:", 4) || !strncmp(method, "unix:", 5)) { + syslogger = syslog_direct_create(method); + } else { + ovs_fatal(0, "unsupported syslog method '%s'", method); } } +/* Set the vlog udp syslog target. */ +void +vlog_set_syslog_target(const char *target) +{ + int new_fd; + + inet_open_active(SOCK_DGRAM, target, 0, NULL, &new_fd, 0); + + ovs_rwlock_wrlock(&pattern_rwlock); + if (syslog_fd >= 0) { + close(syslog_fd); + } + syslog_fd = new_fd; + ovs_rwlock_unlock(&pattern_rwlock); +} + +/* Returns 'false' if 'facility' is not a valid string. If 'facility' + * is a valid string, sets 'value' with the integer value of 'facility' + * and returns 'true'. */ +static bool +vlog_facility_exists(const char* facility, int *value) +{ + size_t i; + for (i = 0; i < ARRAY_SIZE(vlog_facilities); i++) { + if (!strcasecmp(vlog_facilities[i].name, facility)) { + *value = vlog_facilities[i].value; + return true; + } + } + return false; +} + static void vlog_unixctl_set(struct unixctl_conn *conn, int argc, const char *argv[], void *aux OVS_UNUSED) @@ -464,14 +651,31 @@ vlog_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED, free(msg); } +static void +vlog_unixctl_list_pattern(struct unixctl_conn *conn, int argc OVS_UNUSED, + const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED) +{ + char *msg; + + msg = vlog_get_patterns(); + unixctl_command_reply(conn, msg); + free(msg); +} + static void vlog_unixctl_reopen(struct unixctl_conn *conn, int argc OVS_UNUSED, const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED) { - if (log_file_name) { + bool has_log_file; + + ovs_mutex_lock(&log_file_mutex); + has_log_file = log_file_name != NULL; + ovs_mutex_unlock(&log_file_mutex); + + if (has_log_file) { int error = vlog_reopen_log_file(); if (error) { - unixctl_command_reply_error(conn, strerror(errno)); + unixctl_command_reply_error(conn, ovs_strerror(errno)); } else { unixctl_command_reply(conn, NULL); } @@ -480,53 +684,152 @@ vlog_unixctl_reopen(struct unixctl_conn *conn, int argc OVS_UNUSED, } } +static void +vlog_unixctl_close(struct unixctl_conn *conn, int argc OVS_UNUSED, + const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED) +{ + ovs_mutex_lock(&log_file_mutex); + if (log_fd >= 0) { + close(log_fd); + log_fd = -1; + + async_append_destroy(log_writer); + log_writer = NULL; + + struct vlog_module *mp; + LIST_FOR_EACH (mp, list, &vlog_modules) { + update_min_level(mp); + } + } + ovs_mutex_unlock(&log_file_mutex); + + unixctl_command_reply(conn, NULL); +} + +static void +set_all_rate_limits(bool enable) +{ + struct vlog_module *mp; + + ovs_mutex_lock(&log_file_mutex); + LIST_FOR_EACH (mp, list, &vlog_modules) { + mp->honor_rate_limits = enable; + } + ovs_mutex_unlock(&log_file_mutex); +} + +static void +set_rate_limits(struct unixctl_conn *conn, int argc, + const char *argv[], bool enable) +{ + if (argc > 1) { + int i; + + for (i = 1; i < argc; i++) { + if (!strcasecmp(argv[i], "ANY")) { + set_all_rate_limits(enable); + } else { + struct vlog_module *module = vlog_module_from_name(argv[i]); + if (!module) { + unixctl_command_reply_error(conn, "unknown module"); + return; + } + module->honor_rate_limits = enable; + } + } + } else { + set_all_rate_limits(enable); + } + unixctl_command_reply(conn, NULL); +} + +static void +vlog_enable_rate_limit(struct unixctl_conn *conn, int argc, + const char *argv[], void *aux OVS_UNUSED) +{ + set_rate_limits(conn, argc, argv, true); +} + +static void +vlog_disable_rate_limit(struct unixctl_conn *conn, int argc, + const char *argv[], void *aux OVS_UNUSED) +{ + set_rate_limits(conn, argc, argv, false); +} + /* Initializes the logging subsystem and registers its unixctl server * commands. */ void vlog_init(void) { - static char *program_name_copy; - time_t now; - - if (vlog_inited) { - return; - } - vlog_inited = true; + static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER; + + if (ovsthread_once_start(&once)) { + long long int now; + int facility; + bool print_syslog_target_deprecation; + + /* Do initialization work that needs to be done before any logging + * occurs. We want to keep this really minimal because any attempt to + * log anything before calling ovsthread_once_done() will deadlock. */ + atomic_read_explicit(&log_facility, &facility, memory_order_relaxed); + if (!syslogger) { + syslogger = syslog_libc_create(); + } + syslogger->class->openlog(syslogger, facility ? facility : LOG_DAEMON); + ovsthread_once_done(&once); - /* openlog() is allowed to keep the pointer passed in, without making a - * copy. The daemonize code sometimes frees and replaces 'program_name', - * so make a private copy just for openlog(). (We keep a pointer to the - * private copy to suppress memory leak warnings in case openlog() does - * make its own copy.) */ - program_name_copy = program_name ? xstrdup(program_name) : NULL; - openlog(program_name_copy, LOG_NDELAY, LOG_DAEMON); + /* Now do anything that we want to happen only once but doesn't have to + * finish before we start logging. */ - now = time_wall(); - if (now < 0) { - struct tm tm; - char s[128]; + now = time_wall_msec(); + if (now < 0) { + char *s = xastrftime_msec("%a, %d %b %Y %H:%M:%S", now, true); + VLOG_ERR("current time is negative: %s (%lld)", s, now); + free(s); + } - gmtime_r(&now, &tm); - strftime(s, sizeof s, "%a, %d %b %Y %H:%M:%S", &tm); - VLOG_ERR("current time is negative: %s (%ld)", s, (long int) now); + unixctl_command_register( + "vlog/set", "{spec | PATTERN:destination:pattern}", + 1, INT_MAX, vlog_unixctl_set, NULL); + unixctl_command_register("vlog/list", "", 0, 0, vlog_unixctl_list, + NULL); + unixctl_command_register("vlog/list-pattern", "", 0, 0, + vlog_unixctl_list_pattern, NULL); + unixctl_command_register("vlog/enable-rate-limit", "[module]...", + 0, INT_MAX, vlog_enable_rate_limit, NULL); + unixctl_command_register("vlog/disable-rate-limit", "[module]...", + 0, INT_MAX, vlog_disable_rate_limit, NULL); + unixctl_command_register("vlog/reopen", "", 0, 0, + vlog_unixctl_reopen, NULL); + unixctl_command_register("vlog/close", "", 0, 0, + vlog_unixctl_close, NULL); + + ovs_rwlock_rdlock(&pattern_rwlock); + print_syslog_target_deprecation = syslog_fd >= 0; + ovs_rwlock_unlock(&pattern_rwlock); + + if (print_syslog_target_deprecation) { + VLOG_WARN("--syslog-target flag is deprecated, use " + "--syslog-method instead"); + } } - - unixctl_command_register( - "vlog/set", "{spec | PATTERN:facility:pattern}", - 1, INT_MAX, vlog_unixctl_set, NULL); - unixctl_command_register("vlog/list", "", 0, 0, vlog_unixctl_list, NULL); - unixctl_command_register("vlog/reopen", "", 0, 0, - vlog_unixctl_reopen, NULL); } -/* Closes the logging subsystem. */ +/* Enables VLF_FILE log output to be written asynchronously to disk. + * Asynchronous file writes avoid blocking the process in the case of a busy + * disk, but on the other hand they are less robust: there is a chance that the + * write will not make it to the log file if the process crashes soon after the + * log call. */ void -vlog_exit(void) +vlog_enable_async(void) { - if (vlog_inited) { - closelog(); - vlog_inited = false; + ovs_mutex_lock(&log_file_mutex); + log_async = true; + if (log_fd >= 0 && !log_writer) { + log_writer = async_append_create(log_fd); } + ovs_mutex_unlock(&log_file_mutex); } /* Print the current logging level for each module. */ @@ -534,7 +837,7 @@ char * vlog_get_levels(void) { struct ds s = DS_EMPTY_INITIALIZER; - struct vlog_module **mp; + struct vlog_module *mp; struct svec lines = SVEC_EMPTY_INITIALIZER; char *line; size_t i; @@ -542,14 +845,24 @@ vlog_get_levels(void) ds_put_format(&s, " console syslog file\n"); ds_put_format(&s, " ------- ------ ------\n"); - for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) { - line = xasprintf("%-16s %4s %4s %4s\n", - vlog_get_module_name(*mp), - vlog_get_level_name(vlog_get_level(*mp, VLF_CONSOLE)), - vlog_get_level_name(vlog_get_level(*mp, VLF_SYSLOG)), - vlog_get_level_name(vlog_get_level(*mp, VLF_FILE))); - svec_add_nocopy(&lines, line); + ovs_mutex_lock(&log_file_mutex); + LIST_FOR_EACH (mp, list, &vlog_modules) { + struct ds line; + + ds_init(&line); + ds_put_format(&line, "%-16s %4s %4s %4s", + vlog_get_module_name(mp), + vlog_get_level_name(vlog_get_level(mp, VLF_CONSOLE)), + vlog_get_level_name(vlog_get_level(mp, VLF_SYSLOG)), + vlog_get_level_name(vlog_get_level(mp, VLF_FILE))); + if (!mp->honor_rate_limits) { + ds_put_cstr(&line, " (rate limiting disabled)"); + } + ds_put_char(&line, '\n'); + + svec_add_nocopy(&lines, ds_steal_cstr(&line)); } + ovs_mutex_unlock(&log_file_mutex); svec_sort(&lines); SVEC_FOR_EACH (i, line, &lines) { @@ -560,6 +873,32 @@ vlog_get_levels(void) return ds_cstr(&s); } +/* Returns as a string current logging patterns for each destination. + * This string must be released by caller. */ +char * +vlog_get_patterns(void) +{ + struct ds ds = DS_EMPTY_INITIALIZER; + enum vlog_destination destination; + + ovs_rwlock_rdlock(&pattern_rwlock); + ds_put_format(&ds, " prefix format\n"); + ds_put_format(&ds, " ------ ------\n"); + + for (destination = 0; destination < VLF_N_DESTINATIONS; destination++) { + struct destination *f = &destinations[destination]; + const char *prefix = "none"; + + if (destination == VLF_SYSLOG && syslogger) { + prefix = syslog_get_prefix(syslogger); + } + ds_put_format(&ds, "%-7s %-32s %s\n", f->name, prefix, f->pattern); + } + ovs_rwlock_unlock(&pattern_rwlock); + + return ds_cstr(&ds); +} + /* Returns true if a log message emitted for the given 'module' and 'level' * would cause some log output, false if that module and level are completely * disabled. */ @@ -586,15 +925,17 @@ fetch_braces(const char *p, const char *def, char *out, size_t out_size) static void format_log_message(const struct vlog_module *module, enum vlog_level level, - enum vlog_facility facility, unsigned int msg_num, - const char *message, va_list args_, struct ds *s) + const char *pattern, const char *message, + va_list args_, struct ds *s) { char tmp[128]; va_list args; const char *p; + int facility; ds_clear(s); - for (p = facilities[facility].pattern; *p != '\0'; ) { + for (p = pattern; *p != '\0'; ) { + const char *subprogram_name; enum { LEFT, RIGHT } justify = RIGHT; int pad = '0'; size_t length, field, used; @@ -624,17 +965,28 @@ format_log_message(const struct vlog_module *module, enum vlog_level level, case 'A': ds_put_cstr(s, program_name); break; + case 'B': + atomic_read_explicit(&log_facility, &facility, + memory_order_relaxed); + facility = facility ? facility : LOG_LOCAL0; + ds_put_format(s, "%d", facility + syslog_levels[level]); + break; case 'c': p = fetch_braces(p, "", tmp, sizeof tmp); ds_put_cstr(s, vlog_get_module_name(module)); break; case 'd': - p = fetch_braces(p, "%Y-%m-%d %H:%M:%S", tmp, sizeof tmp); - ds_put_strftime(s, tmp, false); + p = fetch_braces(p, "%Y-%m-%d %H:%M:%S.###", tmp, sizeof tmp); + ds_put_strftime_msec(s, tmp, time_wall_msec(), false); break; case 'D': - p = fetch_braces(p, "%Y-%m-%d %H:%M:%S", tmp, sizeof tmp); - ds_put_strftime(s, tmp, true); + p = fetch_braces(p, "%Y-%m-%d %H:%M:%S.###", tmp, sizeof tmp); + ds_put_strftime_msec(s, tmp, time_wall_msec(), true); + break; + case 'E': + gethostname(tmp, sizeof tmp); + tmp[sizeof tmp - 1] = '\0'; + ds_put_cstr(s, tmp); break; case 'm': /* Format user-supplied log message and trim trailing new-lines. */ @@ -647,7 +999,7 @@ format_log_message(const struct vlog_module *module, enum vlog_level level, } break; case 'N': - ds_put_format(s, "%u", msg_num); + ds_put_format(s, "%u", *msg_num_get_unsafe()); break; case 'n': ds_put_char(s, '\n'); @@ -662,9 +1014,11 @@ format_log_message(const struct vlog_module *module, enum vlog_level level, ds_put_format(s, "%lld", time_msec() - time_boot_msec()); break; case 't': + subprogram_name = get_subprogram_name(); ds_put_cstr(s, subprogram_name[0] ? subprogram_name : "main"); break; case 'T': + subprogram_name = get_subprogram_name(); if (subprogram_name[0]) { ds_put_format(s, "(%s)", subprogram_name); } @@ -687,6 +1041,20 @@ format_log_message(const struct vlog_module *module, enum vlog_level level, } } +/* Exports the given 'syslog_message' to the configured udp syslog sink. */ +static void +send_to_syslog_fd(const char *s, size_t length) + OVS_REQ_RDLOCK(pattern_rwlock) +{ + static size_t max_length = SIZE_MAX; + size_t send_len = MIN(length, max_length); + + while (write(syslog_fd, s, send_len) < 0 && errno == EMSGSIZE) { + send_len -= send_len / 20; + max_length = send_len; + } +} + /* Writes 'message' to the log at the given 'level' and as coming from the * given 'module'. * @@ -697,21 +1065,26 @@ vlog_valist(const struct vlog_module *module, enum vlog_level level, { bool log_to_console = module->levels[VLF_CONSOLE] >= level; bool log_to_syslog = module->levels[VLF_SYSLOG] >= level; - bool log_to_file = module->levels[VLF_FILE] >= level && log_fd >= 0; + bool log_to_file; + + ovs_mutex_lock(&log_file_mutex); + log_to_file = module->levels[VLF_FILE] >= level && log_fd >= 0; + ovs_mutex_unlock(&log_file_mutex); if (log_to_console || log_to_syslog || log_to_file) { int save_errno = errno; - static unsigned int msg_num; struct ds s; vlog_init(); ds_init(&s); ds_reserve(&s, 1024); - msg_num++; + ++*msg_num_get(); + ovs_rwlock_rdlock(&pattern_rwlock); if (log_to_console) { - format_log_message(module, level, VLF_CONSOLE, msg_num, - message, args, &s); + format_log_message(module, level, + destinations[VLF_CONSOLE].pattern, message, + args, &s); ds_put_char(&s, '\n'); fputs(ds_cstr(&s), stderr); } @@ -720,21 +1093,45 @@ vlog_valist(const struct vlog_module *module, enum vlog_level level, int syslog_level = syslog_levels[level]; char *save_ptr = NULL; char *line; + int facility; - format_log_message(module, level, VLF_SYSLOG, msg_num, + format_log_message(module, level, destinations[VLF_SYSLOG].pattern, message, args, &s); for (line = strtok_r(s.string, "\n", &save_ptr); line; line = strtok_r(NULL, "\n", &save_ptr)) { - syslog(syslog_level, "%s", line); + atomic_read_explicit(&log_facility, &facility, + memory_order_relaxed); + syslogger->class->syslog(syslogger, syslog_level|facility, line); + } + + if (syslog_fd >= 0) { + format_log_message(module, level, + "<%B>1 %D{%Y-%m-%dT%H:%M:%S.###Z} " + "%E %A %P %c - \xef\xbb\xbf%m", + message, args, &s); + send_to_syslog_fd(ds_cstr(&s), s.length); } } if (log_to_file) { - format_log_message(module, level, VLF_FILE, msg_num, + format_log_message(module, level, destinations[VLF_FILE].pattern, message, args, &s); ds_put_char(&s, '\n'); - vlog_write_file(&s); + + ovs_mutex_lock(&log_file_mutex); + if (log_fd >= 0) { + if (log_writer) { + async_append_write(log_writer, s.string, s.length); + if (level == VLL_EMER) { + async_append_flush(log_writer); + } + } else { + ignore(write(log_fd, s.string, s.length)); + } + } + ovs_mutex_unlock(&log_file_mutex); } + ovs_rwlock_unlock(&pattern_rwlock); ds_destroy(&s); errno = save_errno; @@ -754,7 +1151,7 @@ vlog(const struct vlog_module *module, enum vlog_level level, /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure * exit code. Always writes the message to stderr, even if the console - * facility is disabled. + * destination is disabled. * * Choose this function instead of vlog_abort_valist() if the daemon monitoring * facility shouldn't automatically restart the current daemon. */ @@ -774,7 +1171,7 @@ vlog_fatal_valist(const struct vlog_module *module_, /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure * exit code. Always writes the message to stderr, even if the console - * facility is disabled. + * destination is disabled. * * Choose this function instead of vlog_abort() if the daemon monitoring * facility shouldn't automatically restart the current daemon. */ @@ -789,7 +1186,7 @@ vlog_fatal(const struct vlog_module *module, const char *message, ...) } /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always - * writes the message to stderr, even if the console facility is disabled. + * writes the message to stderr, even if the console destination is disabled. * * Choose this function instead of vlog_fatal_valist() if the daemon monitoring * facility should automatically restart the current daemon. */ @@ -808,7 +1205,7 @@ vlog_abort_valist(const struct vlog_module *module_, } /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always - * writes the message to stderr, even if the console facility is disabled. + * writes the message to stderr, even if the console destination is disabled. * * Choose this function instead of vlog_fatal() if the daemon monitoring * facility should automatically restart the current daemon. */ @@ -826,10 +1223,15 @@ bool vlog_should_drop(const struct vlog_module *module, enum vlog_level level, struct vlog_rate_limit *rl) { + if (!module->honor_rate_limits) { + return false; + } + if (!vlog_is_enabled(module, level)) { return true; } + ovs_mutex_lock(&rl->mutex); if (!token_bucket_withdraw(&rl->token_bucket, VLOG_MSG_TOKENS)) { time_t now = time_now(); if (!rl->n_dropped) { @@ -837,21 +1239,26 @@ vlog_should_drop(const struct vlog_module *module, enum vlog_level level, } rl->last_dropped = now; rl->n_dropped++; + ovs_mutex_unlock(&rl->mutex); return true; } - if (rl->n_dropped) { + if (!rl->n_dropped) { + ovs_mutex_unlock(&rl->mutex); + } else { time_t now = time_now(); + unsigned int n_dropped = rl->n_dropped; unsigned int first_dropped_elapsed = now - rl->first_dropped; unsigned int last_dropped_elapsed = now - rl->last_dropped; + rl->n_dropped = 0; + ovs_mutex_unlock(&rl->mutex); vlog(module, level, "Dropped %u log messages in last %u seconds (most recently, " "%u seconds ago) due to excessive rate", - rl->n_dropped, first_dropped_elapsed, last_dropped_elapsed); - - rl->n_dropped = 0; + n_dropped, first_dropped_elapsed, last_dropped_elapsed); } + return false; } @@ -871,53 +1278,14 @@ vlog_rate_limit(const struct vlog_module *module, enum vlog_level level, void vlog_usage(void) { - printf("\nLogging options:\n" - " -v, --verbose=[SPEC] set logging levels\n" - " -v, --verbose set maximum verbosity level\n" - " --log-file[=FILE] enable logging to specified FILE\n" - " (default: %s/%s.log)\n", + printf("\n\ +Logging options:\n\ + -vSPEC, --verbose=SPEC set logging levels\n\ + -v, --verbose set maximum verbosity level\n\ + --log-file[=FILE] enable logging to specified FILE\n\ + (default: %s/%s.log)\n\ + --syslog-method=(libc|unix:file|udp:ip:port)\n\ + specify how to send messages to syslog daemon\n\ + --syslog-target=HOST:PORT also send syslog msgs to HOST:PORT via UDP\n", ovs_logdir(), program_name); } - -static bool vlog_async_inited = false; - -static worker_request_func vlog_async_write_request_cb; - -static void -vlog_write_file(struct ds *s) -{ - if (worker_is_running()) { - worker_request(s->string, s->length, - &log_fd, vlog_async_inited ? 0 : 1, - vlog_async_write_request_cb, NULL, NULL); - vlog_async_inited = true; - } else { - ignore(write(log_fd, s->string, s->length)); - } -} - -static void -vlog_update_async_log_fd(void) -{ - if (worker_is_running()) { - worker_request(NULL, 0, &log_fd, 1, vlog_async_write_request_cb, - NULL, NULL); - vlog_async_inited = true; - } -} - -static void -vlog_async_write_request_cb(struct ofpbuf *request, - const int *fd, size_t n_fds) -{ - if (n_fds > 0) { - if (log_fd >= 0) { - close(log_fd); - } - log_fd = *fd; - } - - if (request->size > 0) { - ignore(write(log_fd, request->data, request->size)); - } -}