lib/vlog.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2015 Nicira, Inc.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #include <config.h>
  18 #include "openvswitch/vlog.h"
  19 #include <assert.h>
  20 #include <ctype.h>
  21 #include <errno.h>
  22 #include <fcntl.h>
  23 #include <stdarg.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <sys/stat.h>
  27 #include <sys/types.h>
  28 #include <syslog.h>
  29 #include <time.h>
  30 #include <unistd.h>
  31 #include "async-append.h"
  32 #include "coverage.h"
  33 #include "dirs.h"
  34 #include "dynamic-string.h"
  35 #include "ofpbuf.h"
  36 #include "ovs-thread.h"
  37 #include "sat-math.h"
  38 #include "socket-util.h"
  39 #include "svec.h"
  40 #include "syslog-direct.h"
  41 #include "syslog-libc.h"
  42 #include "syslog-provider.h"
  43 #include "timeval.h"
  44 #include "unixctl.h"
  45 #include "util.h"
  46
  47 VLOG_DEFINE_THIS_MODULE(vlog);
  48
  49 /* ovs_assert() logs the assertion message, so using ovs_assert() in this
  50  * source file could cause recursion. */
  51 #undef ovs_assert
  52 #define ovs_assert use_assert_instead_of_ovs_assert_in_this_module
  53
  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,
  57     VLOG_LEVELS
  58 #undef VLOG_LEVEL
  59 };
  60
  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,
  64     VLOG_LEVELS
  65 #undef VLOG_LEVEL
  66 };
  67
  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);
  73 VLOG_LEVELS
  74 #undef VLOG_LEVELS
  75
  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));
  79
  80 /* The log modules. */
  81 struct ovs_list vlog_modules = OVS_LIST_INITIALIZER(&vlog_modules);
  82
  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
  85  * memory. */
  86 static struct ovs_rwlock pattern_rwlock = OVS_RWLOCK_INITIALIZER;
  87
  88 /* Information about each destination. */
  89 struct 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. */
  93 };
  94 static struct destination destinations[VLF_N_DESTINATIONS] = {
  95 #define VLOG_DESTINATION(NAME, PATTERN) {#NAME, PATTERN, true},
  96     VLOG_DESTINATIONS
  97 #undef VLOG_DESTINATION
  98 };
  99
 100 /* Sequence number for the message currently being composed. */
 101 DEFINE_STATIC_PER_THREAD_DATA(unsigned int, msg_num, 0);
 102
 103 /* VLF_FILE configuration.
 104  *
 105  * All of the following is protected by 'log_file_mutex', which nests inside
 106  * pattern_rwlock. */
 107 static struct ovs_mutex log_file_mutex = OVS_MUTEX_INITIALIZER;
 108 static char *log_file_name = NULL OVS_GUARDED_BY(log_file_mutex);
 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;
 113
 114 /* Syslog export configuration. */
 115 static int syslog_fd OVS_GUARDED_BY(pattern_rwlock) = -1;
 116
 117 /* Log facility configuration. */
 118 static atomic_int log_facility = ATOMIC_VAR_INIT(0);
 119
 120 /* Facility name and its value. */
 121 struct vlog_facility {
 122     char *name;           /* Name. */
 123     unsigned int value;   /* Facility associated with 'name'. */
 124 };
 125 static struct vlog_facility vlog_facilities[] = {
 126     {"kern", LOG_KERN},
 127     {"user", LOG_USER},
 128     {"mail", LOG_MAIL},
 129     {"daemon", LOG_DAEMON},
 130     {"auth", LOG_AUTH},
 131     {"syslog", LOG_SYSLOG},
 132     {"lpr", LOG_LPR},
 133     {"news", LOG_NEWS},
 134     {"uucp", LOG_UUCP},
 135     {"clock", LOG_CRON},
 136     {"ftp", LOG_FTP},
 137     {"ntp", 12<<3},
 138     {"audit", 13<<3},
 139     {"alert", 14<<3},
 140     {"clock2", 15<<3},
 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}
 149 };
 150 static bool vlog_facility_exists(const char* facility, int *value);
 151
 152 static void format_log_message(const struct vlog_module *, enum vlog_level,
 153                                const char *pattern,
 154                                const char *message, va_list, struct ds *)
 155     OVS_PRINTF_FORMAT(4, 0);
 156
 157 /* Searches the 'n_names' in 'names'.  Returns the index of a match for
 158  * 'target', or 'n_names' if no name matches. */
 159 static size_t
 160 search_name_array(const char *target, const char *const *names, size_t n_names)
 161 {
 162     size_t i;
 163
 164     for (i = 0; i < n_names; i++) {
 165         assert(names[i]);
 166         if (!strcasecmp(names[i], target)) {
 167             break;
 168         }
 169     }
 170     return i;
 171 }
 172
 173 /* Returns the name for logging level 'level'. */
 174 const char *
 175 vlog_get_level_name(enum vlog_level level)
 176 {
 177     assert(level < VLL_N_LEVELS);
 178     return level_names[level];
 179 }
 180
 181 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
 182  * is not the name of a logging level. */
 183 enum vlog_level
 184 vlog_get_level_val(const char *name)
 185 {
 186     return search_name_array(name, level_names, ARRAY_SIZE(level_names));
 187 }
 188
 189 /* Returns the name for logging destination 'destination'. */
 190 const char *
 191 vlog_get_destination_name(enum vlog_destination destination)
 192 {
 193     assert(destination < VLF_N_DESTINATIONS);
 194     return destinations[destination].name;
 195 }
 196
 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)
 201 {
 202     size_t i;
 203
 204     for (i = 0; i < VLF_N_DESTINATIONS; i++) {
 205         if (!strcasecmp(destinations[i].name, name)) {
 206             break;
 207         }
 208     }
 209     return i;
 210 }
 211
 212 void vlog_insert_module(struct ovs_list *vlog)
 213 {
 214     list_insert(&vlog_modules, vlog);
 215 }
 216
 217 /* Returns the name for logging module 'module'. */
 218 const char *
 219 vlog_get_module_name(const struct vlog_module *module)
 220 {
 221     return module->name;
 222 }
 223
 224 /* Returns the logging module named 'name', or NULL if 'name' is not the name
 225  * of a logging module. */
 226 struct vlog_module *
 227 vlog_module_from_name(const char *name)
 228 {
 229     struct vlog_module *mp;
 230
 231     LIST_FOR_EACH (mp, list, &vlog_modules) {
 232         if (!strcasecmp(name, mp->name)) {
 233             return mp;
 234         }
 235     }
 236
 237     return NULL;
 238 }
 239
 240 /* Returns the current logging level for the given 'module' and
 241  * 'destination'. */
 242 enum vlog_level
 243 vlog_get_level(const struct vlog_module *module,
 244                enum vlog_destination destination)
 245 {
 246     assert(destination < VLF_N_DESTINATIONS);
 247     return module->levels[destination];
 248 }
 249
 250 static void
 251 update_min_level(struct vlog_module *module) OVS_REQUIRES(&log_file_mutex)
 252 {
 253     enum vlog_destination destination;
 254
 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;
 261             }
 262         }
 263     }
 264 }
 265
 266 static void
 267 set_destination_level(enum vlog_destination destination,
 268                       struct vlog_module *module, enum vlog_level level)
 269 {
 270     assert(destination >= 0 && destination < VLF_N_DESTINATIONS);
 271     assert(level < VLL_N_LEVELS);
 272
 273     ovs_mutex_lock(&log_file_mutex);
 274     if (!module) {
 275         struct vlog_module *mp;
 276         LIST_FOR_EACH (mp, list, &vlog_modules) {
 277             mp->levels[destination] = level;
 278             update_min_level(mp);
 279         }
 280     } else {
 281         module->levels[destination] = level;
 282         update_min_level(module);
 283     }
 284     ovs_mutex_unlock(&log_file_mutex);
 285 }
 286
 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. */
 290 void
 291 vlog_set_levels(struct vlog_module *module, enum vlog_destination destination,
 292                 enum vlog_level level)
 293 {
 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;
 298              destination++) {
 299             set_destination_level(destination, module, level);
 300         }
 301     } else {
 302         set_destination_level(destination, module, level);
 303     }
 304 }
 305
 306 static void
 307 do_set_pattern(enum vlog_destination destination, const char *pattern)
 308 {
 309     struct destination *f = &destinations[destination];
 310
 311     ovs_rwlock_wrlock(&pattern_rwlock);
 312     if (!f->default_pattern) {
 313         free(f->pattern);
 314     } else {
 315         f->default_pattern = false;
 316     }
 317     f->pattern = xstrdup(pattern);
 318     ovs_rwlock_unlock(&pattern_rwlock);
 319 }
 320
 321 /* Sets the pattern for the given 'destination' to 'pattern'. */
 322 void
 323 vlog_set_pattern(enum vlog_destination destination, const char *pattern)
 324 {
 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;
 329              destination++) {
 330             do_set_pattern(destination, pattern);
 331         }
 332     } else {
 333         do_set_pattern(destination, pattern);
 334     }
 335 }
 336
 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. */
 340 int
 341 vlog_set_log_file(const char *file_name)
 342 {
 343     char *new_log_file_name;
 344     struct vlog_module *mp;
 345     struct stat old_stat;
 346     struct stat new_stat;
 347     int new_log_fd;
 348     bool same_file;
 349     bool log_close;
 350
 351     /* Open new log file. */
 352     new_log_file_name = (file_name
 353                          ? xstrdup(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);
 360         return errno;
 361     }
 362
 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
 366                  && new_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);
 372     if (same_file) {
 373         close(new_log_fd);
 374         free(new_log_file_name);
 375         return 0;
 376     }
 377
 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);
 382     if (log_close) {
 383         VLOG_INFO("closing log file");
 384     }
 385
 386     /* Close old log file, if any, and install new one. */
 387     ovs_mutex_lock(&log_file_mutex);
 388     if (log_fd >= 0) {
 389         free(log_file_name);
 390         close(log_fd);
 391         async_append_destroy(log_writer);
 392     }
 393
 394     log_file_name = xstrdup(new_log_file_name);
 395     log_fd = new_log_fd;
 396     if (log_async) {
 397         log_writer = async_append_create(new_log_fd);
 398     }
 399
 400     LIST_FOR_EACH (mp, list, &vlog_modules) {
 401         update_min_level(mp);
 402     }
 403     ovs_mutex_unlock(&log_file_mutex);
 404
 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);
 408
 409     return 0;
 410 }
 411
 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. */
 415 int
 416 vlog_reopen_log_file(void)
 417 {
 418     char *fn;
 419
 420     ovs_mutex_lock(&log_file_mutex);
 421     fn = log_file_name ? xstrdup(log_file_name) : NULL;
 422     ovs_mutex_unlock(&log_file_mutex);
 423
 424     if (fn) {
 425         int error = vlog_set_log_file(fn);
 426         free(fn);
 427         return error;
 428     } else {
 429         return 0;
 430     }
 431 }
 432
 433 /* In case a log file exists, change its owner to new 'user' and 'group'.
 434  *
 435  * This is useful for handling cases where the --log-file option is
 436  * specified ahead of the --user option.  */
 437 void
 438 vlog_change_owner(uid_t user, gid_t group)
 439 {
 440     if (!log_file_name) {
 441         return;
 442     }
 443
 444     ovs_mutex_lock(&log_file_mutex);
 445     int error = chown(log_file_name, user, group);
 446     ovs_mutex_unlock(&log_file_mutex);
 447
 448     if (error) {
 449         VLOG_FATAL("Failed to change %s ownership: %s.",
 450                    log_file_name, ovs_strerror(errno));
 451     }
 452 }
 453
 454 /* Set debugging levels.  Returns null if successful, otherwise an error
 455  * message that the caller must free(). */
 456 char *
 457 vlog_set_levels_from_string(const char *s_)
 458 {
 459     char *s = xstrdup(s_);
 460     char *save_ptr = NULL;
 461     char *msg = NULL;
 462     char *word;
 463
 464     word = strtok_r(s, " ,:\t", &save_ptr);
 465     if (word && !strcasecmp(word, "PATTERN")) {
 466         enum vlog_destination destination;
 467
 468         word = strtok_r(NULL, " ,:\t", &save_ptr);
 469         if (!word) {
 470             msg = xstrdup("missing destination");
 471             goto exit;
 472         }
 473
 474         destination = (!strcasecmp(word, "ANY")
 475                        ? VLF_ANY_DESTINATION
 476                        : vlog_get_destination_val(word));
 477         if (destination == VLF_N_DESTINATIONS) {
 478             msg = xasprintf("unknown destination \"%s\"", word);
 479             goto exit;
 480         }
 481         vlog_set_pattern(destination, save_ptr);
 482     } else if (word && !strcasecmp(word, "FACILITY")) {
 483         int value;
 484
 485         if (!vlog_facility_exists(save_ptr, &value)) {
 486             msg = xstrdup("invalid facility");
 487             goto exit;
 488         }
 489         atomic_store_explicit(&log_facility, value, memory_order_relaxed);
 490     } else {
 491         struct vlog_module *module = NULL;
 492         enum vlog_level level = VLL_N_LEVELS;
 493         enum vlog_destination destination = VLF_N_DESTINATIONS;
 494
 495         for (; word != NULL; word = strtok_r(NULL, " ,:\t", &save_ptr)) {
 496             if (!strcasecmp(word, "ANY")) {
 497                 continue;
 498             } else if (vlog_get_destination_val(word) != VLF_N_DESTINATIONS) {
 499                 if (destination != VLF_N_DESTINATIONS) {
 500                     msg = xstrdup("cannot specify multiple destinations");
 501                     goto exit;
 502                 }
 503                 destination = vlog_get_destination_val(word);
 504             } else if (vlog_get_level_val(word) != VLL_N_LEVELS) {
 505                 if (level != VLL_N_LEVELS) {
 506                     msg = xstrdup("cannot specify multiple levels");
 507                     goto exit;
 508                 }
 509                 level = vlog_get_level_val(word);
 510             } else if (vlog_module_from_name(word)) {
 511                 if (module) {
 512                     msg = xstrdup("cannot specify multiple modules");
 513                     goto exit;
 514                 }
 515                 module = vlog_module_from_name(word);
 516             } else {
 517                 msg = xasprintf("no destination, level, or module \"%s\"",
 518                                 word);
 519                 goto exit;
 520             }
 521         }
 522
 523         if (destination == VLF_N_DESTINATIONS) {
 524             destination = VLF_ANY_DESTINATION;
 525         }
 526         if (level == VLL_N_LEVELS) {
 527             level = VLL_DBG;
 528         }
 529         vlog_set_levels(module, destination, level);
 530     }
 531
 532 exit:
 533     free(s);
 534     return msg;
 535 }
 536
 537 /* Set debugging levels.  Abort with an error message if 's' is invalid. */
 538 void
 539 vlog_set_levels_from_string_assert(const char *s)
 540 {
 541     char *error = vlog_set_levels_from_string(s);
 542     if (error) {
 543         ovs_fatal(0, "%s", error);
 544     }
 545 }
 546
 547 /* If 'arg' is null, configure maximum verbosity.  Otherwise, sets
 548  * configuration according to 'arg' (see vlog_set_levels_from_string()). */
 549 void
 550 vlog_set_verbosity(const char *arg)
 551 {
 552     if (arg) {
 553         char *msg = vlog_set_levels_from_string(arg);
 554         if (msg) {
 555             ovs_fatal(0, "processing \"%s\": %s", arg, msg);
 556         }
 557     } else {
 558         vlog_set_levels(NULL, VLF_ANY_DESTINATION, VLL_DBG);
 559     }
 560 }
 561
 562 void
 563 vlog_set_syslog_method(const char *method)
 564 {
 565     if (syslogger) {
 566         /* Set syslogger only, if one is not already set.  This effectively
 567          * means that only the first --syslog-method argument is honored. */
 568         return;
 569     }
 570
 571     if (!strcmp(method, "libc")) {
 572         syslogger = syslog_libc_create();
 573     } else if (!strncmp(method, "udp:", 4) || !strncmp(method, "unix:", 5)) {
 574         syslogger = syslog_direct_create(method);
 575     } else {
 576         ovs_fatal(0, "unsupported syslog method '%s'", method);
 577     }
 578 }
 579
 580 /* Set the vlog udp syslog target. */
 581 void
 582 vlog_set_syslog_target(const char *target)
 583 {
 584     int new_fd;
 585
 586     inet_open_active(SOCK_DGRAM, target, 0, NULL, &new_fd, 0);
 587
 588     ovs_rwlock_wrlock(&pattern_rwlock);
 589     if (syslog_fd >= 0) {
 590         close(syslog_fd);
 591     }
 592     syslog_fd = new_fd;
 593     ovs_rwlock_unlock(&pattern_rwlock);
 594 }
 595
 596 /* Returns 'false' if 'facility' is not a valid string. If 'facility'
 597  * is a valid string, sets 'value' with the integer value of 'facility'
 598  * and returns 'true'. */
 599 static bool
 600 vlog_facility_exists(const char* facility, int *value)
 601 {
 602     size_t i;
 603     for (i = 0; i < ARRAY_SIZE(vlog_facilities); i++) {
 604         if (!strcasecmp(vlog_facilities[i].name, facility)) {
 605             *value = vlog_facilities[i].value;
 606             return true;
 607         }
 608     }
 609     return false;
 610 }
 611
 612 static void
 613 vlog_unixctl_set(struct unixctl_conn *conn, int argc, const char *argv[],
 614                  void *aux OVS_UNUSED)
 615 {
 616     int i;
 617
 618     for (i = 1; i < argc; i++) {
 619         char *msg = vlog_set_levels_from_string(argv[i]);
 620         if (msg) {
 621             unixctl_command_reply_error(conn, msg);
 622             free(msg);
 623             return;
 624         }
 625     }
 626     unixctl_command_reply(conn, NULL);
 627 }
 628
 629 static void
 630 vlog_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
 631                   const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
 632 {
 633     char *msg = vlog_get_levels();
 634     unixctl_command_reply(conn, msg);
 635     free(msg);
 636 }
 637
 638 static void
 639 vlog_unixctl_list_pattern(struct unixctl_conn *conn, int argc OVS_UNUSED,
 640                           const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
 641 {
 642     char *msg;
 643
 644     msg = vlog_get_patterns();
 645     unixctl_command_reply(conn, msg);
 646     free(msg);
 647 }
 648
 649 static void
 650 vlog_unixctl_reopen(struct unixctl_conn *conn, int argc OVS_UNUSED,
 651                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
 652 {
 653     bool has_log_file;
 654
 655     ovs_mutex_lock(&log_file_mutex);
 656     has_log_file = log_file_name != NULL;
 657     ovs_mutex_unlock(&log_file_mutex);
 658
 659     if (has_log_file) {
 660         int error = vlog_reopen_log_file();
 661         if (error) {
 662             unixctl_command_reply_error(conn, ovs_strerror(errno));
 663         } else {
 664             unixctl_command_reply(conn, NULL);
 665         }
 666     } else {
 667         unixctl_command_reply_error(conn, "Logging to file not configured");
 668     }
 669 }
 670
 671 static void
 672 set_all_rate_limits(bool enable)
 673 {
 674     struct vlog_module *mp;
 675
 676     LIST_FOR_EACH (mp, list, &vlog_modules) {
 677         mp->honor_rate_limits = enable;
 678     }
 679 }
 680
 681 static void
 682 set_rate_limits(struct unixctl_conn *conn, int argc,
 683                 const char *argv[], bool enable)
 684 {
 685     if (argc > 1) {
 686         int i;
 687
 688         for (i = 1; i < argc; i++) {
 689             if (!strcasecmp(argv[i], "ANY")) {
 690                 set_all_rate_limits(enable);
 691             } else {
 692                 struct vlog_module *module = vlog_module_from_name(argv[i]);
 693                 if (!module) {
 694                     unixctl_command_reply_error(conn, "unknown module");
 695                     return;
 696                 }
 697                 module->honor_rate_limits = enable;
 698             }
 699         }
 700     } else {
 701         set_all_rate_limits(enable);
 702     }
 703     unixctl_command_reply(conn, NULL);
 704 }
 705
 706 static void
 707 vlog_enable_rate_limit(struct unixctl_conn *conn, int argc,
 708                        const char *argv[], void *aux OVS_UNUSED)
 709 {
 710     set_rate_limits(conn, argc, argv, true);
 711 }
 712
 713 static void
 714 vlog_disable_rate_limit(struct unixctl_conn *conn, int argc,
 715                        const char *argv[], void *aux OVS_UNUSED)
 716 {
 717     set_rate_limits(conn, argc, argv, false);
 718 }
 719
 720 /* Initializes the logging subsystem and registers its unixctl server
 721  * commands. */
 722 void
 723 vlog_init(void)
 724 {
 725     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 726
 727     if (ovsthread_once_start(&once)) {
 728         long long int now;
 729         int facility;
 730         bool print_syslog_target_deprecation;
 731
 732         /* Do initialization work that needs to be done before any logging
 733          * occurs.  We want to keep this really minimal because any attempt to
 734          * log anything before calling ovsthread_once_done() will deadlock. */
 735         atomic_read_explicit(&log_facility, &facility, memory_order_relaxed);
 736         if (!syslogger) {
 737             syslogger = syslog_libc_create();
 738         }
 739         syslogger->class->openlog(syslogger, facility ? facility : LOG_DAEMON);
 740         ovsthread_once_done(&once);
 741
 742         /* Now do anything that we want to happen only once but doesn't have to
 743          * finish before we start logging. */
 744
 745         now = time_wall_msec();
 746         if (now < 0) {
 747             char *s = xastrftime_msec("%a, %d %b %Y %H:%M:%S", now, true);
 748             VLOG_ERR("current time is negative: %s (%lld)", s, now);
 749             free(s);
 750         }
 751
 752         unixctl_command_register(
 753             "vlog/set", "{spec | PATTERN:destination:pattern}",
 754             1, INT_MAX, vlog_unixctl_set, NULL);
 755         unixctl_command_register("vlog/list", "", 0, 0, vlog_unixctl_list,
 756                                  NULL);
 757         unixctl_command_register("vlog/list-pattern", "", 0, 0,
 758                                  vlog_unixctl_list_pattern, NULL);
 759         unixctl_command_register("vlog/enable-rate-limit", "[module]...",
 760                                  0, INT_MAX, vlog_enable_rate_limit, NULL);
 761         unixctl_command_register("vlog/disable-rate-limit", "[module]...",
 762                                  0, INT_MAX, vlog_disable_rate_limit, NULL);
 763         unixctl_command_register("vlog/reopen", "", 0, 0,
 764                                  vlog_unixctl_reopen, NULL);
 765
 766         ovs_rwlock_rdlock(&pattern_rwlock);
 767         print_syslog_target_deprecation = syslog_fd >= 0;
 768         ovs_rwlock_unlock(&pattern_rwlock);
 769
 770         if (print_syslog_target_deprecation) {
 771             VLOG_WARN("--syslog-target flag is deprecated, use "
 772                       "--syslog-method instead");
 773         }
 774     }
 775 }
 776
 777 /* Enables VLF_FILE log output to be written asynchronously to disk.
 778  * Asynchronous file writes avoid blocking the process in the case of a busy
 779  * disk, but on the other hand they are less robust: there is a chance that the
 780  * write will not make it to the log file if the process crashes soon after the
 781  * log call. */
 782 void
 783 vlog_enable_async(void)
 784 {
 785     ovs_mutex_lock(&log_file_mutex);
 786     log_async = true;
 787     if (log_fd >= 0 && !log_writer) {
 788         log_writer = async_append_create(log_fd);
 789     }
 790     ovs_mutex_unlock(&log_file_mutex);
 791 }
 792
 793 /* Print the current logging level for each module. */
 794 char *
 795 vlog_get_levels(void)
 796 {
 797     struct ds s = DS_EMPTY_INITIALIZER;
 798     struct vlog_module *mp;
 799     struct svec lines = SVEC_EMPTY_INITIALIZER;
 800     char *line;
 801     size_t i;
 802
 803     ds_put_format(&s, "                 console    syslog    file\n");
 804     ds_put_format(&s, "                 -------    ------    ------\n");
 805
 806     LIST_FOR_EACH (mp, list, &vlog_modules) {
 807         struct ds line;
 808
 809         ds_init(&line);
 810         ds_put_format(&line, "%-16s  %4s       %4s       %4s",
 811                       vlog_get_module_name(mp),
 812                       vlog_get_level_name(vlog_get_level(mp, VLF_CONSOLE)),
 813                       vlog_get_level_name(vlog_get_level(mp, VLF_SYSLOG)),
 814                       vlog_get_level_name(vlog_get_level(mp, VLF_FILE)));
 815         if (!mp->honor_rate_limits) {
 816             ds_put_cstr(&line, "    (rate limiting disabled)");
 817         }
 818         ds_put_char(&line, '\n');
 819
 820         svec_add_nocopy(&lines, ds_steal_cstr(&line));
 821     }
 822
 823     svec_sort(&lines);
 824     SVEC_FOR_EACH (i, line, &lines) {
 825         ds_put_cstr(&s, line);
 826     }
 827     svec_destroy(&lines);
 828
 829     return ds_cstr(&s);
 830 }
 831
 832 /* Returns as a string current logging patterns for each destination.
 833  * This string must be released by caller. */
 834 char *
 835 vlog_get_patterns(void)
 836 {
 837     struct ds ds = DS_EMPTY_INITIALIZER;
 838     enum vlog_destination destination;
 839
 840     ovs_rwlock_rdlock(&pattern_rwlock);
 841     ds_put_format(&ds, "         prefix                            format\n");
 842     ds_put_format(&ds, "         ------                            ------\n");
 843
 844     for (destination = 0; destination < VLF_N_DESTINATIONS; destination++) {
 845         struct destination *f = &destinations[destination];
 846         const char *prefix = "none";
 847
 848         if (destination == VLF_SYSLOG && syslogger) {
 849             prefix = syslog_get_prefix(syslogger);
 850         }
 851         ds_put_format(&ds, "%-7s  %-32s  %s\n", f->name, prefix, f->pattern);
 852     }
 853     ovs_rwlock_unlock(&pattern_rwlock);
 854
 855     return ds_cstr(&ds);
 856 }
 857
 858 /* Returns true if a log message emitted for the given 'module' and 'level'
 859  * would cause some log output, false if that module and level are completely
 860  * disabled. */
 861 bool
 862 vlog_is_enabled(const struct vlog_module *module, enum vlog_level level)
 863 {
 864     return module->min_level >= level;
 865 }
 866
 867 static const char *
 868 fetch_braces(const char *p, const char *def, char *out, size_t out_size)
 869 {
 870     if (*p == '{') {
 871         size_t n = strcspn(p + 1, "}");
 872         size_t n_copy = MIN(n, out_size - 1);
 873         memcpy(out, p + 1, n_copy);
 874         out[n_copy] = '\0';
 875         p += n + 2;
 876     } else {
 877         ovs_strlcpy(out, def, out_size);
 878     }
 879     return p;
 880 }
 881
 882 static void
 883 format_log_message(const struct vlog_module *module, enum vlog_level level,
 884                    const char *pattern, const char *message,
 885                    va_list args_, struct ds *s)
 886 {
 887     char tmp[128];
 888     va_list args;
 889     const char *p;
 890     int facility;
 891
 892     ds_clear(s);
 893     for (p = pattern; *p != '\0'; ) {
 894         const char *subprogram_name;
 895         enum { LEFT, RIGHT } justify = RIGHT;
 896         int pad = '0';
 897         size_t length, field, used;
 898
 899         if (*p != '%') {
 900             ds_put_char(s, *p++);
 901             continue;
 902         }
 903
 904         p++;
 905         if (*p == '-') {
 906             justify = LEFT;
 907             p++;
 908         }
 909         if (*p == '0') {
 910             pad = '0';
 911             p++;
 912         }
 913         field = 0;
 914         while (isdigit((unsigned char)*p)) {
 915             field = (field * 10) + (*p - '0');
 916             p++;
 917         }
 918
 919         length = s->length;
 920         switch (*p++) {
 921         case 'A':
 922             ds_put_cstr(s, program_name);
 923             break;
 924         case 'B':
 925             atomic_read_explicit(&log_facility, &facility,
 926                                  memory_order_relaxed);
 927             facility = facility ? facility : LOG_LOCAL0;
 928             ds_put_format(s, "%d", facility + syslog_levels[level]);
 929             break;
 930         case 'c':
 931             p = fetch_braces(p, "", tmp, sizeof tmp);
 932             ds_put_cstr(s, vlog_get_module_name(module));
 933             break;
 934         case 'd':
 935             p = fetch_braces(p, "%Y-%m-%d %H:%M:%S.###", tmp, sizeof tmp);
 936             ds_put_strftime_msec(s, tmp, time_wall_msec(), false);
 937             break;
 938         case 'D':
 939             p = fetch_braces(p, "%Y-%m-%d %H:%M:%S.###", tmp, sizeof tmp);
 940             ds_put_strftime_msec(s, tmp, time_wall_msec(), true);
 941             break;
 942         case 'E':
 943             gethostname(tmp, sizeof tmp);
 944             tmp[sizeof tmp - 1] = '\0';
 945             ds_put_cstr(s, tmp);
 946             break;
 947         case 'm':
 948             /* Format user-supplied log message and trim trailing new-lines. */
 949             length = s->length;
 950             va_copy(args, args_);
 951             ds_put_format_valist(s, message, args);
 952             va_end(args);
 953             while (s->length > length && s->string[s->length - 1] == '\n') {
 954                 s->length--;
 955             }
 956             break;
 957         case 'N':
 958             ds_put_format(s, "%u", *msg_num_get_unsafe());
 959             break;
 960         case 'n':
 961             ds_put_char(s, '\n');
 962             break;
 963         case 'p':
 964             ds_put_cstr(s, vlog_get_level_name(level));
 965             break;
 966         case 'P':
 967             ds_put_format(s, "%ld", (long int) getpid());
 968             break;
 969         case 'r':
 970             ds_put_format(s, "%lld", time_msec() - time_boot_msec());
 971             break;
 972         case 't':
 973             subprogram_name = get_subprogram_name();
 974             ds_put_cstr(s, subprogram_name[0] ? subprogram_name : "main");
 975             break;
 976         case 'T':
 977             subprogram_name = get_subprogram_name();
 978             if (subprogram_name[0]) {
 979                 ds_put_format(s, "(%s)", subprogram_name);
 980             }
 981             break;
 982         default:
 983             ds_put_char(s, p[-1]);
 984             break;
 985         }
 986         used = s->length - length;
 987         if (used < field) {
 988             size_t n_pad = field - used;
 989             if (justify == RIGHT) {
 990                 ds_put_uninit(s, n_pad);
 991                 memmove(&s->string[length + n_pad], &s->string[length], used);
 992                 memset(&s->string[length], pad, n_pad);
 993             } else {
 994                 ds_put_char_multiple(s, pad, n_pad);
 995             }
 996         }
 997     }
 998 }
 999
1000 /* Exports the given 'syslog_message' to the configured udp syslog sink. */
1001 static void
1002 send_to_syslog_fd(const char *s, size_t length)
1003     OVS_REQ_RDLOCK(pattern_rwlock)
1004 {
1005     static size_t max_length = SIZE_MAX;
1006     size_t send_len = MIN(length, max_length);
1007
1008     while (write(syslog_fd, s, send_len) < 0 && errno == EMSGSIZE) {
1009         send_len -= send_len / 20;
1010         max_length = send_len;
1011     }
1012 }
1013
1014 /* Writes 'message' to the log at the given 'level' and as coming from the
1015  * given 'module'.
1016  *
1017  * Guaranteed to preserve errno. */
1018 void
1019 vlog_valist(const struct vlog_module *module, enum vlog_level level,
1020             const char *message, va_list args)
1021 {
1022     bool log_to_console = module->levels[VLF_CONSOLE] >= level;
1023     bool log_to_syslog = module->levels[VLF_SYSLOG] >= level;
1024     bool log_to_file;
1025
1026     ovs_mutex_lock(&log_file_mutex);
1027     log_to_file = module->levels[VLF_FILE] >= level && log_fd >= 0;
1028     ovs_mutex_unlock(&log_file_mutex);
1029     if (log_to_console || log_to_syslog || log_to_file) {
1030         int save_errno = errno;
1031         struct ds s;
1032
1033         vlog_init();
1034
1035         ds_init(&s);
1036         ds_reserve(&s, 1024);
1037         ++*msg_num_get();
1038
1039         ovs_rwlock_rdlock(&pattern_rwlock);
1040         if (log_to_console) {
1041             format_log_message(module, level,
1042                                destinations[VLF_CONSOLE].pattern, message,
1043                                args, &s);
1044             ds_put_char(&s, '\n');
1045             fputs(ds_cstr(&s), stderr);
1046         }
1047
1048         if (log_to_syslog) {
1049             int syslog_level = syslog_levels[level];
1050             char *save_ptr = NULL;
1051             char *line;
1052             int facility;
1053
1054             format_log_message(module, level, destinations[VLF_SYSLOG].pattern,
1055                                message, args, &s);
1056             for (line = strtok_r(s.string, "\n", &save_ptr); line;
1057                  line = strtok_r(NULL, "\n", &save_ptr)) {
1058                 atomic_read_explicit(&log_facility, &facility,
1059                                      memory_order_relaxed);
1060                 syslogger->class->syslog(syslogger, syslog_level|facility, line);
1061             }
1062
1063             if (syslog_fd >= 0) {
1064                 format_log_message(module, level,
1065                                    "<%B>1 %D{%Y-%m-%dT%H:%M:%S.###Z} "
1066                                    "%E %A %P %c - \xef\xbb\xbf%m",
1067                                    message, args, &s);
1068                 send_to_syslog_fd(ds_cstr(&s), s.length);
1069             }
1070         }
1071
1072         if (log_to_file) {
1073             format_log_message(module, level, destinations[VLF_FILE].pattern,
1074                                message, args, &s);
1075             ds_put_char(&s, '\n');
1076
1077             ovs_mutex_lock(&log_file_mutex);
1078             if (log_fd >= 0) {
1079                 if (log_writer) {
1080                     async_append_write(log_writer, s.string, s.length);
1081                     if (level == VLL_EMER) {
1082                         async_append_flush(log_writer);
1083                     }
1084                 } else {
1085                     ignore(write(log_fd, s.string, s.length));
1086                 }
1087             }
1088             ovs_mutex_unlock(&log_file_mutex);
1089         }
1090         ovs_rwlock_unlock(&pattern_rwlock);
1091
1092         ds_destroy(&s);
1093         errno = save_errno;
1094     }
1095 }
1096
1097 void
1098 vlog(const struct vlog_module *module, enum vlog_level level,
1099      const char *message, ...)
1100 {
1101     va_list args;
1102
1103     va_start(args, message);
1104     vlog_valist(module, level, message, args);
1105     va_end(args);
1106 }
1107
1108 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
1109  * exit code.  Always writes the message to stderr, even if the console
1110  * destination is disabled.
1111  *
1112  * Choose this function instead of vlog_abort_valist() if the daemon monitoring
1113  * facility shouldn't automatically restart the current daemon.  */
1114 void
1115 vlog_fatal_valist(const struct vlog_module *module_,
1116                   const char *message, va_list args)
1117 {
1118     struct vlog_module *module = CONST_CAST(struct vlog_module *, module_);
1119
1120     /* Don't log this message to the console to avoid redundancy with the
1121      * message written by the later ovs_fatal_valist(). */
1122     module->levels[VLF_CONSOLE] = VLL_OFF;
1123
1124     vlog_valist(module, VLL_EMER, message, args);
1125     ovs_fatal_valist(0, message, args);
1126 }
1127
1128 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
1129  * exit code.  Always writes the message to stderr, even if the console
1130  * destination is disabled.
1131  *
1132  * Choose this function instead of vlog_abort() if the daemon monitoring
1133  * facility shouldn't automatically restart the current daemon.  */
1134 void
1135 vlog_fatal(const struct vlog_module *module, const char *message, ...)
1136 {
1137     va_list args;
1138
1139     va_start(args, message);
1140     vlog_fatal_valist(module, message, args);
1141     va_end(args);
1142 }
1143
1144 /* Logs 'message' to 'module' at maximum verbosity, then calls abort().  Always
1145  * writes the message to stderr, even if the console destination is disabled.
1146  *
1147  * Choose this function instead of vlog_fatal_valist() if the daemon monitoring
1148  * facility should automatically restart the current daemon.  */
1149 void
1150 vlog_abort_valist(const struct vlog_module *module_,
1151                   const char *message, va_list args)
1152 {
1153     struct vlog_module *module = (struct vlog_module *) module_;
1154
1155     /* Don't log this message to the console to avoid redundancy with the
1156      * message written by the later ovs_abort_valist(). */
1157     module->levels[VLF_CONSOLE] = VLL_OFF;
1158
1159     vlog_valist(module, VLL_EMER, message, args);
1160     ovs_abort_valist(0, message, args);
1161 }
1162
1163 /* Logs 'message' to 'module' at maximum verbosity, then calls abort().  Always
1164  * writes the message to stderr, even if the console destination is disabled.
1165  *
1166  * Choose this function instead of vlog_fatal() if the daemon monitoring
1167  * facility should automatically restart the current daemon.  */
1168 void
1169 vlog_abort(const struct vlog_module *module, const char *message, ...)
1170 {
1171     va_list args;
1172
1173     va_start(args, message);
1174     vlog_abort_valist(module, message, args);
1175     va_end(args);
1176 }
1177
1178 bool
1179 vlog_should_drop(const struct vlog_module *module, enum vlog_level level,
1180                  struct vlog_rate_limit *rl)
1181 {
1182     if (!module->honor_rate_limits) {
1183         return false;
1184     }
1185
1186     if (!vlog_is_enabled(module, level)) {
1187         return true;
1188     }
1189
1190     ovs_mutex_lock(&rl->mutex);
1191     if (!token_bucket_withdraw(&rl->token_bucket, VLOG_MSG_TOKENS)) {
1192         time_t now = time_now();
1193         if (!rl->n_dropped) {
1194             rl->first_dropped = now;
1195         }
1196         rl->last_dropped = now;
1197         rl->n_dropped++;
1198         ovs_mutex_unlock(&rl->mutex);
1199         return true;
1200     }
1201
1202     if (!rl->n_dropped) {
1203         ovs_mutex_unlock(&rl->mutex);
1204     } else {
1205         time_t now = time_now();
1206         unsigned int n_dropped = rl->n_dropped;
1207         unsigned int first_dropped_elapsed = now - rl->first_dropped;
1208         unsigned int last_dropped_elapsed = now - rl->last_dropped;
1209         rl->n_dropped = 0;
1210         ovs_mutex_unlock(&rl->mutex);
1211
1212         vlog(module, level,
1213              "Dropped %u log messages in last %u seconds (most recently, "
1214              "%u seconds ago) due to excessive rate",
1215              n_dropped, first_dropped_elapsed, last_dropped_elapsed);
1216     }
1217
1218     return false;
1219 }
1220
1221 void
1222 vlog_rate_limit(const struct vlog_module *module, enum vlog_level level,
1223                 struct vlog_rate_limit *rl, const char *message, ...)
1224 {
1225     if (!vlog_should_drop(module, level, rl)) {
1226         va_list args;
1227
1228         va_start(args, message);
1229         vlog_valist(module, level, message, args);
1230         va_end(args);
1231     }
1232 }
1233
1234 void
1235 vlog_usage(void)
1236 {
1237     printf("\n\
1238 Logging options:\n\
1239   -vSPEC, --verbose=SPEC   set logging levels\n\
1240   -v, --verbose            set maximum verbosity level\n\
1241   --log-file[=FILE]        enable logging to specified FILE\n\
1242                            (default: %s/%s.log)\n\
1243   --syslog-method=(libc|unix:file|udp:ip:port)\n\
1244                            specify how to send messages to syslog daemon\n\
1245   --syslog-target=HOST:PORT  also send syslog msgs to HOST:PORT via UDP\n",
1246            ovs_logdir(), program_name);
1247 }