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