lib/vlog.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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 "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 "svec.h"
  39 #include "timeval.h"
  40 #include "unixctl.h"
  41 #include "util.h"
  42
  43 VLOG_DEFINE_THIS_MODULE(vlog);
  44
  45 /* ovs_assert() logs the assertion message, so using ovs_assert() in this
  46  * source file could cause recursion. */
  47 #undef ovs_assert
  48 #define ovs_assert use_assert_instead_of_ovs_assert_in_this_module
  49
  50 /* Name for each logging level. */
  51 static const char *const level_names[VLL_N_LEVELS] = {
  52 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) #NAME,
  53     VLOG_LEVELS
  54 #undef VLOG_LEVEL
  55 };
  56
  57 /* Syslog value for each logging level. */
  58 static const int syslog_levels[VLL_N_LEVELS] = {
  59 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL) SYSLOG_LEVEL,
  60     VLOG_LEVELS
  61 #undef VLOG_LEVEL
  62 };
  63
  64 /* The log modules. */
  65 #if USE_LINKER_SECTIONS
  66 extern struct vlog_module *__start_vlog_modules[];
  67 extern struct vlog_module *__stop_vlog_modules[];
  68 #define vlog_modules __start_vlog_modules
  69 #define n_vlog_modules (__stop_vlog_modules - __start_vlog_modules)
  70 #else
  71 #define VLOG_MODULE VLOG_DEFINE_MODULE__
  72 #include "vlog-modules.def"
  73 #undef VLOG_MODULE
  74
  75 extern struct vlog_module *vlog_modules[];
  76 struct vlog_module *vlog_modules[] = {
  77 #define VLOG_MODULE(NAME) &VLM_##NAME,
  78 #include "vlog-modules.def"
  79 #undef VLOG_MODULE
  80 };
  81 #define n_vlog_modules ARRAY_SIZE(vlog_modules)
  82 #endif
  83
  84 /* Protects the 'pattern' in all "struct facility"s, so that a race between
  85  * changing and reading the pattern does not cause an access to freed
  86  * memory. */
  87 static struct ovs_rwlock pattern_rwlock = OVS_RWLOCK_INITIALIZER;
  88
  89 /* Information about each facility. */
  90 struct facility {
  91     const char *name;           /* Name. */
  92     char *pattern OVS_GUARDED_BY(pattern_rwlock); /* Current pattern. */
  93     bool default_pattern;       /* Whether current pattern is the default. */
  94 };
  95 static struct facility facilities[VLF_N_FACILITIES] = {
  96 #define VLOG_FACILITY(NAME, PATTERN) {#NAME, PATTERN, true},
  97     VLOG_FACILITIES
  98 #undef VLOG_FACILITY
  99 };
 100
 101 /* Sequence number for the message currently being composed. */
 102 DEFINE_STATIC_PER_THREAD_DATA(unsigned int, msg_num, 0);
 103
 104 /* VLF_FILE configuration.
 105  *
 106  * All of the following is protected by 'log_file_mutex', which nests inside
 107  * pattern_rwlock. */
 108 static struct ovs_mutex log_file_mutex = OVS_MUTEX_INITIALIZER;
 109 static char *log_file_name OVS_GUARDED_BY(log_file_mutex);
 110 static int log_fd OVS_GUARDED_BY(log_file_mutex) = -1;
 111 static struct async_append *log_writer OVS_GUARDED_BY(log_file_mutex);
 112 static bool log_async OVS_GUARDED_BY(log_file_mutex);
 113
 114 static void format_log_message(const struct vlog_module *, enum vlog_level,
 115                                enum vlog_facility,
 116                                const char *message, va_list, struct ds *)
 117     PRINTF_FORMAT(4, 0) OVS_REQ_RDLOCK(&pattern_rwlock);
 118
 119 /* Searches the 'n_names' in 'names'.  Returns the index of a match for
 120  * 'target', or 'n_names' if no name matches. */
 121 static size_t
 122 search_name_array(const char *target, const char *const *names, size_t n_names)
 123 {
 124     size_t i;
 125
 126     for (i = 0; i < n_names; i++) {
 127         assert(names[i]);
 128         if (!strcasecmp(names[i], target)) {
 129             break;
 130         }
 131     }
 132     return i;
 133 }
 134
 135 /* Returns the name for logging level 'level'. */
 136 const char *
 137 vlog_get_level_name(enum vlog_level level)
 138 {
 139     assert(level < VLL_N_LEVELS);
 140     return level_names[level];
 141 }
 142
 143 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
 144  * is not the name of a logging level. */
 145 enum vlog_level
 146 vlog_get_level_val(const char *name)
 147 {
 148     return search_name_array(name, level_names, ARRAY_SIZE(level_names));
 149 }
 150
 151 /* Returns the name for logging facility 'facility'. */
 152 const char *
 153 vlog_get_facility_name(enum vlog_facility facility)
 154 {
 155     assert(facility < VLF_N_FACILITIES);
 156     return facilities[facility].name;
 157 }
 158
 159 /* Returns the logging facility named 'name', or VLF_N_FACILITIES if 'name' is
 160  * not the name of a logging facility. */
 161 enum vlog_facility
 162 vlog_get_facility_val(const char *name)
 163 {
 164     size_t i;
 165
 166     for (i = 0; i < VLF_N_FACILITIES; i++) {
 167         if (!strcasecmp(facilities[i].name, name)) {
 168             break;
 169         }
 170     }
 171     return i;
 172 }
 173
 174 /* Returns the name for logging module 'module'. */
 175 const char *
 176 vlog_get_module_name(const struct vlog_module *module)
 177 {
 178     return module->name;
 179 }
 180
 181 /* Returns the logging module named 'name', or NULL if 'name' is not the name
 182  * of a logging module. */
 183 struct vlog_module *
 184 vlog_module_from_name(const char *name)
 185 {
 186     struct vlog_module **mp;
 187
 188     for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
 189         if (!strcasecmp(name, (*mp)->name)) {
 190             return *mp;
 191         }
 192     }
 193     return NULL;
 194 }
 195
 196 /* Returns the current logging level for the given 'module' and 'facility'. */
 197 enum vlog_level
 198 vlog_get_level(const struct vlog_module *module, enum vlog_facility facility)
 199 {
 200     assert(facility < VLF_N_FACILITIES);
 201     return module->levels[facility];
 202 }
 203
 204 static void
 205 update_min_level(struct vlog_module *module) OVS_REQUIRES(&log_file_mutex)
 206 {
 207     enum vlog_facility facility;
 208
 209     module->min_level = VLL_OFF;
 210     for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
 211         if (log_fd >= 0 || facility != VLF_FILE) {
 212             enum vlog_level level = module->levels[facility];
 213             if (level > module->min_level) {
 214                 module->min_level = level;
 215             }
 216         }
 217     }
 218 }
 219
 220 static void
 221 set_facility_level(enum vlog_facility facility, struct vlog_module *module,
 222                    enum vlog_level level)
 223 {
 224     assert(facility >= 0 && facility < VLF_N_FACILITIES);
 225     assert(level < VLL_N_LEVELS);
 226
 227     ovs_mutex_lock(&log_file_mutex);
 228     if (!module) {
 229         struct vlog_module **mp;
 230
 231         for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
 232             (*mp)->levels[facility] = level;
 233             update_min_level(*mp);
 234         }
 235     } else {
 236         module->levels[facility] = level;
 237         update_min_level(module);
 238     }
 239     ovs_mutex_unlock(&log_file_mutex);
 240 }
 241
 242 /* Sets the logging level for the given 'module' and 'facility' to 'level'.  A
 243  * null 'module' or a 'facility' of VLF_ANY_FACILITY is treated as a wildcard
 244  * across all modules or facilities, respectively. */
 245 void
 246 vlog_set_levels(struct vlog_module *module, enum vlog_facility facility,
 247                 enum vlog_level level)
 248 {
 249     assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
 250     if (facility == VLF_ANY_FACILITY) {
 251         for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
 252             set_facility_level(facility, module, level);
 253         }
 254     } else {
 255         set_facility_level(facility, module, level);
 256     }
 257 }
 258
 259 static void
 260 do_set_pattern(enum vlog_facility facility, const char *pattern)
 261 {
 262     struct facility *f = &facilities[facility];
 263
 264     ovs_rwlock_wrlock(&pattern_rwlock);
 265     if (!f->default_pattern) {
 266         free(f->pattern);
 267     } else {
 268         f->default_pattern = false;
 269     }
 270     f->pattern = xstrdup(pattern);
 271     ovs_rwlock_unlock(&pattern_rwlock);
 272 }
 273
 274 /* Sets the pattern for the given 'facility' to 'pattern'. */
 275 void
 276 vlog_set_pattern(enum vlog_facility facility, const char *pattern)
 277 {
 278     assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
 279     if (facility == VLF_ANY_FACILITY) {
 280         for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
 281             do_set_pattern(facility, pattern);
 282         }
 283     } else {
 284         do_set_pattern(facility, pattern);
 285     }
 286 }
 287
 288 /* Sets the name of the log file used by VLF_FILE to 'file_name', or to the
 289  * default file name if 'file_name' is null.  Returns 0 if successful,
 290  * otherwise a positive errno value. */
 291 int
 292 vlog_set_log_file(const char *file_name)
 293 {
 294     char *new_log_file_name;
 295     struct vlog_module **mp;
 296     struct stat old_stat;
 297     struct stat new_stat;
 298     int new_log_fd;
 299     bool same_file;
 300     bool log_close;
 301
 302     /* Open new log file. */
 303     new_log_file_name = (file_name
 304                          ? xstrdup(file_name)
 305                          : xasprintf("%s/%s.log", ovs_logdir(), program_name));
 306     new_log_fd = open(new_log_file_name, O_WRONLY | O_CREAT | O_APPEND, 0666);
 307     if (new_log_fd < 0) {
 308         VLOG_WARN("failed to open %s for logging: %s",
 309                   new_log_file_name, ovs_strerror(errno));
 310         free(new_log_file_name);
 311         return errno;
 312     }
 313
 314     /* If the new log file is the same one we already have open, bail out. */
 315     ovs_mutex_lock(&log_file_mutex);
 316     same_file = (log_fd >= 0
 317                  && new_log_fd >= 0
 318                  && !fstat(log_fd, &old_stat)
 319                  && !fstat(new_log_fd, &new_stat)
 320                  && old_stat.st_dev == new_stat.st_dev
 321                  && old_stat.st_ino == new_stat.st_ino);
 322     ovs_mutex_unlock(&log_file_mutex);
 323     if (same_file) {
 324         close(new_log_fd);
 325         free(new_log_file_name);
 326         return 0;
 327     }
 328
 329     /* Log closing old log file (we can't log while holding log_file_mutex). */
 330     ovs_mutex_lock(&log_file_mutex);
 331     log_close = log_fd >= 0;
 332     ovs_mutex_unlock(&log_file_mutex);
 333     if (log_close) {
 334         VLOG_INFO("closing log file");
 335     }
 336
 337     /* Close old log file, if any, and install new one. */
 338     ovs_mutex_lock(&log_file_mutex);
 339     if (log_fd >= 0) {
 340         free(log_file_name);
 341         close(log_fd);
 342         async_append_destroy(log_writer);
 343     }
 344
 345     log_file_name = xstrdup(new_log_file_name);
 346     log_fd = new_log_fd;
 347     if (log_async) {
 348         log_writer = async_append_create(new_log_fd);
 349     }
 350
 351     for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
 352         update_min_level(*mp);
 353     }
 354     ovs_mutex_unlock(&log_file_mutex);
 355
 356     /* Log opening new log file (we can't log while holding log_file_mutex). */
 357     VLOG_INFO("opened log file %s", new_log_file_name);
 358     free(new_log_file_name);
 359
 360     return 0;
 361 }
 362
 363 /* Closes and then attempts to re-open the current log file.  (This is useful
 364  * just after log rotation, to ensure that the new log file starts being used.)
 365  * Returns 0 if successful, otherwise a positive errno value. */
 366 int
 367 vlog_reopen_log_file(void)
 368 {
 369     char *fn;
 370
 371     ovs_mutex_lock(&log_file_mutex);
 372     fn = log_file_name ? xstrdup(log_file_name) : NULL;
 373     ovs_mutex_unlock(&log_file_mutex);
 374
 375     if (fn) {
 376         int error = vlog_set_log_file(fn);
 377         free(fn);
 378         return error;
 379     } else {
 380         return 0;
 381     }
 382 }
 383
 384 /* Set debugging levels.  Returns null if successful, otherwise an error
 385  * message that the caller must free(). */
 386 char *
 387 vlog_set_levels_from_string(const char *s_)
 388 {
 389     char *s = xstrdup(s_);
 390     char *save_ptr = NULL;
 391     char *msg = NULL;
 392     char *word;
 393
 394     word = strtok_r(s, " ,:\t", &save_ptr);
 395     if (word && !strcasecmp(word, "PATTERN")) {
 396         enum vlog_facility facility;
 397
 398         word = strtok_r(NULL, " ,:\t", &save_ptr);
 399         if (!word) {
 400             msg = xstrdup("missing facility");
 401             goto exit;
 402         }
 403
 404         facility = (!strcasecmp(word, "ANY")
 405                     ? VLF_ANY_FACILITY
 406                     : vlog_get_facility_val(word));
 407         if (facility == VLF_N_FACILITIES) {
 408             msg = xasprintf("unknown facility \"%s\"", word);
 409             goto exit;
 410         }
 411         vlog_set_pattern(facility, save_ptr);
 412     } else {
 413         struct vlog_module *module = NULL;
 414         enum vlog_level level = VLL_N_LEVELS;
 415         enum vlog_facility facility = VLF_N_FACILITIES;
 416
 417         for (; word != NULL; word = strtok_r(NULL, " ,:\t", &save_ptr)) {
 418             if (!strcasecmp(word, "ANY")) {
 419                 continue;
 420             } else if (vlog_get_facility_val(word) != VLF_N_FACILITIES) {
 421                 if (facility != VLF_N_FACILITIES) {
 422                     msg = xstrdup("cannot specify multiple facilities");
 423                     goto exit;
 424                 }
 425                 facility = vlog_get_facility_val(word);
 426             } else if (vlog_get_level_val(word) != VLL_N_LEVELS) {
 427                 if (level != VLL_N_LEVELS) {
 428                     msg = xstrdup("cannot specify multiple levels");
 429                     goto exit;
 430                 }
 431                 level = vlog_get_level_val(word);
 432             } else if (vlog_module_from_name(word)) {
 433                 if (module) {
 434                     msg = xstrdup("cannot specify multiple modules");
 435                     goto exit;
 436                 }
 437                 module = vlog_module_from_name(word);
 438             } else {
 439                 msg = xasprintf("no facility, level, or module \"%s\"", word);
 440                 goto exit;
 441             }
 442         }
 443
 444         if (facility == VLF_N_FACILITIES) {
 445             facility = VLF_ANY_FACILITY;
 446         }
 447         if (level == VLL_N_LEVELS) {
 448             level = VLL_DBG;
 449         }
 450         vlog_set_levels(module, facility, level);
 451     }
 452
 453 exit:
 454     free(s);
 455     return msg;
 456 }
 457
 458 /* Set debugging levels.  Abort with an error message if 's' is invalid. */
 459 void
 460 vlog_set_levels_from_string_assert(const char *s)
 461 {
 462     char *error = vlog_set_levels_from_string(s);
 463     if (error) {
 464         ovs_fatal(0, "%s", error);
 465     }
 466 }
 467
 468 /* If 'arg' is null, configure maximum verbosity.  Otherwise, sets
 469  * configuration according to 'arg' (see vlog_set_levels_from_string()). */
 470 void
 471 vlog_set_verbosity(const char *arg)
 472 {
 473     if (arg) {
 474         char *msg = vlog_set_levels_from_string(arg);
 475         if (msg) {
 476             ovs_fatal(0, "processing \"%s\": %s", arg, msg);
 477         }
 478     } else {
 479         vlog_set_levels(NULL, VLF_ANY_FACILITY, VLL_DBG);
 480     }
 481 }
 482
 483 static void
 484 vlog_unixctl_set(struct unixctl_conn *conn, int argc, const char *argv[],
 485                  void *aux OVS_UNUSED)
 486 {
 487     int i;
 488
 489     for (i = 1; i < argc; i++) {
 490         char *msg = vlog_set_levels_from_string(argv[i]);
 491         if (msg) {
 492             unixctl_command_reply_error(conn, msg);
 493             free(msg);
 494             return;
 495         }
 496     }
 497     unixctl_command_reply(conn, NULL);
 498 }
 499
 500 static void
 501 vlog_unixctl_list(struct unixctl_conn *conn, int argc OVS_UNUSED,
 502                   const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
 503 {
 504     char *msg = vlog_get_levels();
 505     unixctl_command_reply(conn, msg);
 506     free(msg);
 507 }
 508
 509 static void
 510 vlog_unixctl_reopen(struct unixctl_conn *conn, int argc OVS_UNUSED,
 511                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
 512 {
 513     bool has_log_file;
 514
 515     ovs_mutex_lock(&log_file_mutex);
 516     has_log_file = log_file_name != NULL;
 517     ovs_mutex_unlock(&log_file_mutex);
 518
 519     if (has_log_file) {
 520         int error = vlog_reopen_log_file();
 521         if (error) {
 522             unixctl_command_reply_error(conn, ovs_strerror(errno));
 523         } else {
 524             unixctl_command_reply(conn, NULL);
 525         }
 526     } else {
 527         unixctl_command_reply_error(conn, "Logging to file not configured");
 528     }
 529 }
 530
 531 static void
 532 set_all_rate_limits(bool enable)
 533 {
 534     struct vlog_module **mp;
 535
 536     for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
 537         (*mp)->honor_rate_limits = enable;
 538     }
 539 }
 540
 541 static void
 542 set_rate_limits(struct unixctl_conn *conn, int argc,
 543                 const char *argv[], bool enable)
 544 {
 545     if (argc > 1) {
 546         int i;
 547
 548         for (i = 1; i < argc; i++) {
 549             if (!strcasecmp(argv[i], "ANY")) {
 550                 set_all_rate_limits(enable);
 551             } else {
 552                 struct vlog_module *module = vlog_module_from_name(argv[i]);
 553                 if (!module) {
 554                     unixctl_command_reply_error(conn, "unknown module");
 555                     return;
 556                 }
 557                 module->honor_rate_limits = enable;
 558             }
 559         }
 560     } else {
 561         set_all_rate_limits(enable);
 562     }
 563     unixctl_command_reply(conn, NULL);
 564 }
 565
 566 static void
 567 vlog_enable_rate_limit(struct unixctl_conn *conn, int argc,
 568                        const char *argv[], void *aux OVS_UNUSED)
 569 {
 570     set_rate_limits(conn, argc, argv, true);
 571 }
 572
 573 static void
 574 vlog_disable_rate_limit(struct unixctl_conn *conn, int argc,
 575                        const char *argv[], void *aux OVS_UNUSED)
 576 {
 577     set_rate_limits(conn, argc, argv, false);
 578 }
 579
 580 static void
 581 vlog_init__(void)
 582 {
 583     static char *program_name_copy;
 584     long long int now;
 585
 586     /* openlog() is allowed to keep the pointer passed in, without making a
 587      * copy.  The daemonize code sometimes frees and replaces 'program_name',
 588      * so make a private copy just for openlog().  (We keep a pointer to the
 589      * private copy to suppress memory leak warnings in case openlog() does
 590      * make its own copy.) */
 591     program_name_copy = program_name ? xstrdup(program_name) : NULL;
 592     openlog(program_name_copy, LOG_NDELAY, LOG_DAEMON);
 593
 594     now = time_wall_msec();
 595     if (now < 0) {
 596         char *s = xastrftime_msec("%a, %d %b %Y %H:%M:%S", now, true);
 597         VLOG_ERR("current time is negative: %s (%lld)", s, now);
 598         free(s);
 599     }
 600
 601     unixctl_command_register(
 602         "vlog/set", "{spec | PATTERN:facility:pattern}",
 603         1, INT_MAX, vlog_unixctl_set, NULL);
 604     unixctl_command_register("vlog/list", "", 0, 0, vlog_unixctl_list, NULL);
 605     unixctl_command_register("vlog/enable-rate-limit", "[module]...",
 606                              0, INT_MAX, vlog_enable_rate_limit, NULL);
 607     unixctl_command_register("vlog/disable-rate-limit", "[module]...",
 608                              0, INT_MAX, vlog_disable_rate_limit, NULL);
 609     unixctl_command_register("vlog/reopen", "", 0, 0,
 610                              vlog_unixctl_reopen, NULL);
 611 }
 612
 613 /* Initializes the logging subsystem and registers its unixctl server
 614  * commands. */
 615 void
 616 vlog_init(void)
 617 {
 618     static pthread_once_t once = PTHREAD_ONCE_INIT;
 619     pthread_once(&once, vlog_init__);
 620 }
 621
 622 /* Enables VLF_FILE log output to be written asynchronously to disk.
 623  * Asynchronous file writes avoid blocking the process in the case of a busy
 624  * disk, but on the other hand they are less robust: there is a chance that the
 625  * write will not make it to the log file if the process crashes soon after the
 626  * log call. */
 627 void
 628 vlog_enable_async(void)
 629 {
 630     ovs_mutex_lock(&log_file_mutex);
 631     log_async = true;
 632     if (log_fd >= 0 && !log_writer) {
 633         log_writer = async_append_create(log_fd);
 634     }
 635     ovs_mutex_unlock(&log_file_mutex);
 636 }
 637
 638 /* Print the current logging level for each module. */
 639 char *
 640 vlog_get_levels(void)
 641 {
 642     struct ds s = DS_EMPTY_INITIALIZER;
 643     struct vlog_module **mp;
 644     struct svec lines = SVEC_EMPTY_INITIALIZER;
 645     char *line;
 646     size_t i;
 647
 648     ds_put_format(&s, "                 console    syslog    file\n");
 649     ds_put_format(&s, "                 -------    ------    ------\n");
 650
 651     for (mp = vlog_modules; mp < &vlog_modules[n_vlog_modules]; mp++) {
 652         struct ds line;
 653
 654         ds_init(&line);
 655         ds_put_format(&line, "%-16s  %4s       %4s       %4s",
 656                       vlog_get_module_name(*mp),
 657                       vlog_get_level_name(vlog_get_level(*mp, VLF_CONSOLE)),
 658                       vlog_get_level_name(vlog_get_level(*mp, VLF_SYSLOG)),
 659                       vlog_get_level_name(vlog_get_level(*mp, VLF_FILE)));
 660         if (!(*mp)->honor_rate_limits) {
 661             ds_put_cstr(&line, "    (rate limiting disabled)");
 662         }
 663         ds_put_char(&line, '\n');
 664
 665         svec_add_nocopy(&lines, ds_steal_cstr(&line));
 666     }
 667
 668     svec_sort(&lines);
 669     SVEC_FOR_EACH (i, line, &lines) {
 670         ds_put_cstr(&s, line);
 671     }
 672     svec_destroy(&lines);
 673
 674     return ds_cstr(&s);
 675 }
 676
 677 /* Returns true if a log message emitted for the given 'module' and 'level'
 678  * would cause some log output, false if that module and level are completely
 679  * disabled. */
 680 bool
 681 vlog_is_enabled(const struct vlog_module *module, enum vlog_level level)
 682 {
 683     return module->min_level >= level;
 684 }
 685
 686 static const char *
 687 fetch_braces(const char *p, const char *def, char *out, size_t out_size)
 688 {
 689     if (*p == '{') {
 690         size_t n = strcspn(p + 1, "}");
 691         size_t n_copy = MIN(n, out_size - 1);
 692         memcpy(out, p + 1, n_copy);
 693         out[n_copy] = '\0';
 694         p += n + 2;
 695     } else {
 696         ovs_strlcpy(out, def, out_size);
 697     }
 698     return p;
 699 }
 700
 701 static void
 702 format_log_message(const struct vlog_module *module, enum vlog_level level,
 703                    enum vlog_facility facility,
 704                    const char *message, va_list args_, struct ds *s)
 705 {
 706     char tmp[128];
 707     va_list args;
 708     const char *p;
 709
 710     ds_clear(s);
 711     for (p = facilities[facility].pattern; *p != '\0'; ) {
 712         const char *subprogram_name;
 713         enum { LEFT, RIGHT } justify = RIGHT;
 714         int pad = '0';
 715         size_t length, field, used;
 716
 717         if (*p != '%') {
 718             ds_put_char(s, *p++);
 719             continue;
 720         }
 721
 722         p++;
 723         if (*p == '-') {
 724             justify = LEFT;
 725             p++;
 726         }
 727         if (*p == '0') {
 728             pad = '0';
 729             p++;
 730         }
 731         field = 0;
 732         while (isdigit((unsigned char)*p)) {
 733             field = (field * 10) + (*p - '0');
 734             p++;
 735         }
 736
 737         length = s->length;
 738         switch (*p++) {
 739         case 'A':
 740             ds_put_cstr(s, program_name);
 741             break;
 742         case 'c':
 743             p = fetch_braces(p, "", tmp, sizeof tmp);
 744             ds_put_cstr(s, vlog_get_module_name(module));
 745             break;
 746         case 'd':
 747             p = fetch_braces(p, "%Y-%m-%d %H:%M:%S.###", tmp, sizeof tmp);
 748             ds_put_strftime_msec(s, tmp, time_wall_msec(), false);
 749             break;
 750         case 'D':
 751             p = fetch_braces(p, "%Y-%m-%d %H:%M:%S.###", tmp, sizeof tmp);
 752             ds_put_strftime_msec(s, tmp, time_wall_msec(), true);
 753             break;
 754         case 'm':
 755             /* Format user-supplied log message and trim trailing new-lines. */
 756             length = s->length;
 757             va_copy(args, args_);
 758             ds_put_format_valist(s, message, args);
 759             va_end(args);
 760             while (s->length > length && s->string[s->length - 1] == '\n') {
 761                 s->length--;
 762             }
 763             break;
 764         case 'N':
 765             ds_put_format(s, "%u", *msg_num_get_unsafe());
 766             break;
 767         case 'n':
 768             ds_put_char(s, '\n');
 769             break;
 770         case 'p':
 771             ds_put_cstr(s, vlog_get_level_name(level));
 772             break;
 773         case 'P':
 774             ds_put_format(s, "%ld", (long int) getpid());
 775             break;
 776         case 'r':
 777             ds_put_format(s, "%lld", time_msec() - time_boot_msec());
 778             break;
 779         case 't':
 780             subprogram_name = get_subprogram_name();
 781             ds_put_cstr(s, subprogram_name[0] ? subprogram_name : "main");
 782             break;
 783         case 'T':
 784             subprogram_name = get_subprogram_name();
 785             if (subprogram_name[0]) {
 786                 ds_put_format(s, "(%s)", subprogram_name);
 787             }
 788             break;
 789         default:
 790             ds_put_char(s, p[-1]);
 791             break;
 792         }
 793         used = s->length - length;
 794         if (used < field) {
 795             size_t n_pad = field - used;
 796             if (justify == RIGHT) {
 797                 ds_put_uninit(s, n_pad);
 798                 memmove(&s->string[length + n_pad], &s->string[length], used);
 799                 memset(&s->string[length], pad, n_pad);
 800             } else {
 801                 ds_put_char_multiple(s, pad, n_pad);
 802             }
 803         }
 804     }
 805 }
 806
 807 /* Writes 'message' to the log at the given 'level' and as coming from the
 808  * given 'module'.
 809  *
 810  * Guaranteed to preserve errno. */
 811 void
 812 vlog_valist(const struct vlog_module *module, enum vlog_level level,
 813             const char *message, va_list args)
 814 {
 815     bool log_to_console = module->levels[VLF_CONSOLE] >= level;
 816     bool log_to_syslog = module->levels[VLF_SYSLOG] >= level;
 817     bool log_to_file;
 818
 819     ovs_mutex_lock(&log_file_mutex);
 820     log_to_file = module->levels[VLF_FILE] >= level && log_fd >= 0;
 821     ovs_mutex_unlock(&log_file_mutex);
 822     if (log_to_console || log_to_syslog || log_to_file) {
 823         int save_errno = errno;
 824         struct ds s;
 825
 826         vlog_init();
 827
 828         ds_init(&s);
 829         ds_reserve(&s, 1024);
 830         ++*msg_num_get();
 831
 832         ovs_rwlock_rdlock(&pattern_rwlock);
 833         if (log_to_console) {
 834             format_log_message(module, level, VLF_CONSOLE, message, args, &s);
 835             ds_put_char(&s, '\n');
 836             fputs(ds_cstr(&s), stderr);
 837         }
 838
 839         if (log_to_syslog) {
 840             int syslog_level = syslog_levels[level];
 841             char *save_ptr = NULL;
 842             char *line;
 843
 844             format_log_message(module, level, VLF_SYSLOG, message, args, &s);
 845             for (line = strtok_r(s.string, "\n", &save_ptr); line;
 846                  line = strtok_r(NULL, "\n", &save_ptr)) {
 847                 syslog(syslog_level, "%s", line);
 848             }
 849         }
 850
 851         if (log_to_file) {
 852             format_log_message(module, level, VLF_FILE, message, args, &s);
 853             ds_put_char(&s, '\n');
 854
 855             ovs_mutex_lock(&log_file_mutex);
 856             if (log_fd >= 0) {
 857                 if (log_writer) {
 858                     async_append_write(log_writer, s.string, s.length);
 859                     if (level == VLL_EMER) {
 860                         async_append_flush(log_writer);
 861                     }
 862                 } else {
 863                     ignore(write(log_fd, s.string, s.length));
 864                 }
 865             }
 866             ovs_mutex_unlock(&log_file_mutex);
 867         }
 868         ovs_rwlock_unlock(&pattern_rwlock);
 869
 870         ds_destroy(&s);
 871         errno = save_errno;
 872     }
 873 }
 874
 875 void
 876 vlog(const struct vlog_module *module, enum vlog_level level,
 877      const char *message, ...)
 878 {
 879     va_list args;
 880
 881     va_start(args, message);
 882     vlog_valist(module, level, message, args);
 883     va_end(args);
 884 }
 885
 886 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
 887  * exit code.  Always writes the message to stderr, even if the console
 888  * facility is disabled.
 889  *
 890  * Choose this function instead of vlog_abort_valist() if the daemon monitoring
 891  * facility shouldn't automatically restart the current daemon.  */
 892 void
 893 vlog_fatal_valist(const struct vlog_module *module_,
 894                   const char *message, va_list args)
 895 {
 896     struct vlog_module *module = CONST_CAST(struct vlog_module *, module_);
 897
 898     /* Don't log this message to the console to avoid redundancy with the
 899      * message written by the later ovs_fatal_valist(). */
 900     module->levels[VLF_CONSOLE] = VLL_OFF;
 901
 902     vlog_valist(module, VLL_EMER, message, args);
 903     ovs_fatal_valist(0, message, args);
 904 }
 905
 906 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
 907  * exit code.  Always writes the message to stderr, even if the console
 908  * facility is disabled.
 909  *
 910  * Choose this function instead of vlog_abort() if the daemon monitoring
 911  * facility shouldn't automatically restart the current daemon.  */
 912 void
 913 vlog_fatal(const struct vlog_module *module, const char *message, ...)
 914 {
 915     va_list args;
 916
 917     va_start(args, message);
 918     vlog_fatal_valist(module, message, args);
 919     va_end(args);
 920 }
 921
 922 /* Logs 'message' to 'module' at maximum verbosity, then calls abort().  Always
 923  * writes the message to stderr, even if the console facility is disabled.
 924  *
 925  * Choose this function instead of vlog_fatal_valist() if the daemon monitoring
 926  * facility should automatically restart the current daemon.  */
 927 void
 928 vlog_abort_valist(const struct vlog_module *module_,
 929                   const char *message, va_list args)
 930 {
 931     struct vlog_module *module = (struct vlog_module *) module_;
 932
 933     /* Don't log this message to the console to avoid redundancy with the
 934      * message written by the later ovs_abort_valist(). */
 935     module->levels[VLF_CONSOLE] = VLL_OFF;
 936
 937     vlog_valist(module, VLL_EMER, message, args);
 938     ovs_abort_valist(0, message, args);
 939 }
 940
 941 /* Logs 'message' to 'module' at maximum verbosity, then calls abort().  Always
 942  * writes the message to stderr, even if the console facility is disabled.
 943  *
 944  * Choose this function instead of vlog_fatal() if the daemon monitoring
 945  * facility should automatically restart the current daemon.  */
 946 void
 947 vlog_abort(const struct vlog_module *module, const char *message, ...)
 948 {
 949     va_list args;
 950
 951     va_start(args, message);
 952     vlog_abort_valist(module, message, args);
 953     va_end(args);
 954 }
 955
 956 bool
 957 vlog_should_drop(const struct vlog_module *module, enum vlog_level level,
 958                  struct vlog_rate_limit *rl)
 959 {
 960     if (!module->honor_rate_limits) {
 961         return false;
 962     }
 963
 964     if (!vlog_is_enabled(module, level)) {
 965         return true;
 966     }
 967
 968     ovs_mutex_lock(&rl->mutex);
 969     if (!token_bucket_withdraw(&rl->token_bucket, VLOG_MSG_TOKENS)) {
 970         time_t now = time_now();
 971         if (!rl->n_dropped) {
 972             rl->first_dropped = now;
 973         }
 974         rl->last_dropped = now;
 975         rl->n_dropped++;
 976         ovs_mutex_unlock(&rl->mutex);
 977         return true;
 978     }
 979
 980     if (!rl->n_dropped) {
 981         ovs_mutex_unlock(&rl->mutex);
 982     } else {
 983         time_t now = time_now();
 984         unsigned int n_dropped = rl->n_dropped;
 985         unsigned int first_dropped_elapsed = now - rl->first_dropped;
 986         unsigned int last_dropped_elapsed = now - rl->last_dropped;
 987         rl->n_dropped = 0;
 988         ovs_mutex_unlock(&rl->mutex);
 989
 990         vlog(module, level,
 991              "Dropped %u log messages in last %u seconds (most recently, "
 992              "%u seconds ago) due to excessive rate",
 993              n_dropped, first_dropped_elapsed, last_dropped_elapsed);
 994     }
 995
 996     return false;
 997 }
 998
 999 void
1000 vlog_rate_limit(const struct vlog_module *module, enum vlog_level level,
1001                 struct vlog_rate_limit *rl, const char *message, ...)
1002 {
1003     if (!vlog_should_drop(module, level, rl)) {
1004         va_list args;
1005
1006         va_start(args, message);
1007         vlog_valist(module, level, message, args);
1008         va_end(args);
1009     }
1010 }
1011
1012 void
1013 vlog_usage(void)
1014 {
1015     printf("\nLogging options:\n"
1016            "  -v, --verbose=[SPEC]    set logging levels\n"
1017            "  -v, --verbose           set maximum verbosity level\n"
1018            "  --log-file[=FILE]       enable logging to specified FILE\n"
1019            "                          (default: %s/%s.log)\n",
1020            ovs_logdir(), program_name);
1021 }