2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "openvswitch/vlog.h"
27 #include <sys/types.h>
31 #include "async-append.h"
34 #include "dynamic-string.h"
36 #include "ovs-thread.h"
38 #include "socket-util.h"
40 #include "syslog-direct.h"
41 #include "syslog-libc.h"
42 #include "syslog-provider.h"
47 VLOG_DEFINE_THIS_MODULE(vlog
);
49 /* ovs_assert() logs the assertion message, so using ovs_assert() in this
50 * source file could cause recursion. */
52 #define ovs_assert use_assert_instead_of_ovs_assert_in_this_module
54 /* Name for each logging level. */
55 static const char *const level_names
[VLL_N_LEVELS
] = {
56 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424) #NAME,
61 /* Syslog value for each logging level. */
62 static const int syslog_levels
[VLL_N_LEVELS
] = {
63 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424) SYSLOG_LEVEL,
68 /* RFC 5424 defines specific values for each syslog level. Normally LOG_* use
69 * the same values. Verify that in fact they're the same. If we get assertion
70 * failures here then we need to define a separate rfc5424_levels[] array. */
71 #define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424) \
72 BUILD_ASSERT_DECL(SYSLOG_LEVEL == RFC5424);
76 /* Similarly, RFC 5424 defines the local0 facility with the value ordinarily
77 * used for LOG_LOCAL0. */
78 BUILD_ASSERT_DECL(LOG_LOCAL0
== (16 << 3));
80 /* The log modules. */
81 struct ovs_list vlog_modules
= OVS_LIST_INITIALIZER(&vlog_modules
);
83 /* Protects the 'pattern' in all "struct destination"s, so that a race between
84 * changing and reading the pattern does not cause an access to freed
86 static struct ovs_rwlock pattern_rwlock
= OVS_RWLOCK_INITIALIZER
;
88 /* Information about each destination. */
90 const char *name
; /* Name. */
91 char *pattern
OVS_GUARDED_BY(pattern_rwlock
); /* Current pattern. */
92 bool default_pattern
; /* Whether current pattern is the default. */
94 static struct destination destinations
[VLF_N_DESTINATIONS
] = {
95 #define VLOG_DESTINATION(NAME, PATTERN) {#NAME, PATTERN, true},
97 #undef VLOG_DESTINATION
100 /* Sequence number for the message currently being composed. */
101 DEFINE_STATIC_PER_THREAD_DATA(unsigned int, msg_num
, 0);
103 /* VLF_FILE configuration.
105 * All of the following is protected by 'log_file_mutex', which nests inside
107 static struct ovs_mutex log_file_mutex
= OVS_MUTEX_INITIALIZER
;
108 static char *log_file_name
OVS_GUARDED_BY(log_file_mutex
);
109 static int log_fd
OVS_GUARDED_BY(log_file_mutex
) = -1;
110 static struct async_append
*log_writer
OVS_GUARDED_BY(log_file_mutex
);
111 static bool log_async
OVS_GUARDED_BY(log_file_mutex
);
112 static struct syslogger
*syslogger
= NULL
;
114 /* Syslog export configuration. */
115 static int syslog_fd
OVS_GUARDED_BY(pattern_rwlock
) = -1;
117 /* Log facility configuration. */
118 static atomic_int log_facility
= ATOMIC_VAR_INIT(0);
120 /* Facility name and its value. */
121 struct vlog_facility
{
122 char *name
; /* Name. */
123 unsigned int value
; /* Facility associated with 'name'. */
125 static struct vlog_facility vlog_facilities
[] = {
129 {"daemon", LOG_DAEMON
},
131 {"syslog", LOG_SYSLOG
},
141 {"local0", LOG_LOCAL0
},
142 {"local1", LOG_LOCAL1
},
143 {"local2", LOG_LOCAL2
},
144 {"local3", LOG_LOCAL3
},
145 {"local4", LOG_LOCAL4
},
146 {"local5", LOG_LOCAL5
},
147 {"local6", LOG_LOCAL6
},
148 {"local7", LOG_LOCAL7
}
150 static bool vlog_facility_exists(const char* facility
, int *value
);
152 static void format_log_message(const struct vlog_module
*, enum vlog_level
,
154 const char *message
, va_list, struct ds
*)
155 OVS_PRINTF_FORMAT(4, 0);
157 /* Searches the 'n_names' in 'names'. Returns the index of a match for
158 * 'target', or 'n_names' if no name matches. */
160 search_name_array(const char *target
, const char *const *names
, size_t n_names
)
164 for (i
= 0; i
< n_names
; i
++) {
166 if (!strcasecmp(names
[i
], target
)) {
173 /* Returns the name for logging level 'level'. */
175 vlog_get_level_name(enum vlog_level level
)
177 assert(level
< VLL_N_LEVELS
);
178 return level_names
[level
];
181 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
182 * is not the name of a logging level. */
184 vlog_get_level_val(const char *name
)
186 return search_name_array(name
, level_names
, ARRAY_SIZE(level_names
));
189 /* Returns the name for logging destination 'destination'. */
191 vlog_get_destination_name(enum vlog_destination destination
)
193 assert(destination
< VLF_N_DESTINATIONS
);
194 return destinations
[destination
].name
;
197 /* Returns the logging destination named 'name', or VLF_N_DESTINATIONS if
198 * 'name' is not the name of a logging destination. */
199 enum vlog_destination
200 vlog_get_destination_val(const char *name
)
204 for (i
= 0; i
< VLF_N_DESTINATIONS
; i
++) {
205 if (!strcasecmp(destinations
[i
].name
, name
)) {
212 void vlog_insert_module(struct ovs_list
*vlog
)
214 list_insert(&vlog_modules
, vlog
);
217 /* Returns the name for logging module 'module'. */
219 vlog_get_module_name(const struct vlog_module
*module
)
224 /* Returns the logging module named 'name', or NULL if 'name' is not the name
225 * of a logging module. */
227 vlog_module_from_name(const char *name
)
229 struct vlog_module
*mp
;
231 LIST_FOR_EACH (mp
, list
, &vlog_modules
) {
232 if (!strcasecmp(name
, mp
->name
)) {
240 /* Returns the current logging level for the given 'module' and
243 vlog_get_level(const struct vlog_module
*module
,
244 enum vlog_destination destination
)
246 assert(destination
< VLF_N_DESTINATIONS
);
247 return module
->levels
[destination
];
251 update_min_level(struct vlog_module
*module
) OVS_REQUIRES(&log_file_mutex
)
253 enum vlog_destination destination
;
255 module
->min_level
= VLL_OFF
;
256 for (destination
= 0; destination
< VLF_N_DESTINATIONS
; destination
++) {
257 if (log_fd
>= 0 || destination
!= VLF_FILE
) {
258 enum vlog_level level
= module
->levels
[destination
];
259 if (level
> module
->min_level
) {
260 module
->min_level
= level
;
267 set_destination_level(enum vlog_destination destination
,
268 struct vlog_module
*module
, enum vlog_level level
)
270 assert(destination
>= 0 && destination
< VLF_N_DESTINATIONS
);
271 assert(level
< VLL_N_LEVELS
);
273 ovs_mutex_lock(&log_file_mutex
);
275 struct vlog_module
*mp
;
276 LIST_FOR_EACH (mp
, list
, &vlog_modules
) {
277 mp
->levels
[destination
] = level
;
278 update_min_level(mp
);
281 module
->levels
[destination
] = level
;
282 update_min_level(module
);
284 ovs_mutex_unlock(&log_file_mutex
);
287 /* Sets the logging level for the given 'module' and 'destination' to 'level'.
288 * A null 'module' or a 'destination' of VLF_ANY_DESTINATION is treated as a
289 * wildcard across all modules or destinations, respectively. */
291 vlog_set_levels(struct vlog_module
*module
, enum vlog_destination destination
,
292 enum vlog_level level
)
294 assert(destination
< VLF_N_DESTINATIONS
||
295 destination
== VLF_ANY_DESTINATION
);
296 if (destination
== VLF_ANY_DESTINATION
) {
297 for (destination
= 0; destination
< VLF_N_DESTINATIONS
;
299 set_destination_level(destination
, module
, level
);
302 set_destination_level(destination
, module
, level
);
307 do_set_pattern(enum vlog_destination destination
, const char *pattern
)
309 struct destination
*f
= &destinations
[destination
];
311 ovs_rwlock_wrlock(&pattern_rwlock
);
312 if (!f
->default_pattern
) {
315 f
->default_pattern
= false;
317 f
->pattern
= xstrdup(pattern
);
318 ovs_rwlock_unlock(&pattern_rwlock
);
321 /* Sets the pattern for the given 'destination' to 'pattern'. */
323 vlog_set_pattern(enum vlog_destination destination
, const char *pattern
)
325 assert(destination
< VLF_N_DESTINATIONS
||
326 destination
== VLF_ANY_DESTINATION
);
327 if (destination
== VLF_ANY_DESTINATION
) {
328 for (destination
= 0; destination
< VLF_N_DESTINATIONS
;
330 do_set_pattern(destination
, pattern
);
333 do_set_pattern(destination
, pattern
);
337 /* Sets the name of the log file used by VLF_FILE to 'file_name', or to the
338 * default file name if 'file_name' is null. Returns 0 if successful,
339 * otherwise a positive errno value. */
341 vlog_set_log_file(const char *file_name
)
343 char *new_log_file_name
;
344 struct vlog_module
*mp
;
345 struct stat old_stat
;
346 struct stat new_stat
;
351 /* Open new log file. */
352 new_log_file_name
= (file_name
354 : xasprintf("%s/%s.log", ovs_logdir(), program_name
));
355 new_log_fd
= open(new_log_file_name
, O_WRONLY
| O_CREAT
| O_APPEND
, 0666);
356 if (new_log_fd
< 0) {
357 VLOG_WARN("failed to open %s for logging: %s",
358 new_log_file_name
, ovs_strerror(errno
));
359 free(new_log_file_name
);
363 /* If the new log file is the same one we already have open, bail out. */
364 ovs_mutex_lock(&log_file_mutex
);
365 same_file
= (log_fd
>= 0
367 && !fstat(log_fd
, &old_stat
)
368 && !fstat(new_log_fd
, &new_stat
)
369 && old_stat
.st_dev
== new_stat
.st_dev
370 && old_stat
.st_ino
== new_stat
.st_ino
);
371 ovs_mutex_unlock(&log_file_mutex
);
374 free(new_log_file_name
);
378 /* Log closing old log file (we can't log while holding log_file_mutex). */
379 ovs_mutex_lock(&log_file_mutex
);
380 log_close
= log_fd
>= 0;
381 ovs_mutex_unlock(&log_file_mutex
);
383 VLOG_INFO("closing log file");
386 /* Close old log file, if any, and install new one. */
387 ovs_mutex_lock(&log_file_mutex
);
391 async_append_destroy(log_writer
);
394 log_file_name
= xstrdup(new_log_file_name
);
397 log_writer
= async_append_create(new_log_fd
);
400 LIST_FOR_EACH (mp
, list
, &vlog_modules
) {
401 update_min_level(mp
);
403 ovs_mutex_unlock(&log_file_mutex
);
405 /* Log opening new log file (we can't log while holding log_file_mutex). */
406 VLOG_INFO("opened log file %s", new_log_file_name
);
407 free(new_log_file_name
);
412 /* Closes and then attempts to re-open the current log file. (This is useful
413 * just after log rotation, to ensure that the new log file starts being used.)
414 * Returns 0 if successful, otherwise a positive errno value. */
416 vlog_reopen_log_file(void)
420 ovs_mutex_lock(&log_file_mutex
);
421 fn
= log_file_name
? xstrdup(log_file_name
) : NULL
;
422 ovs_mutex_unlock(&log_file_mutex
);
425 int error
= vlog_set_log_file(fn
);
433 /* Set debugging levels. Returns null if successful, otherwise an error
434 * message that the caller must free(). */
436 vlog_set_levels_from_string(const char *s_
)
438 char *s
= xstrdup(s_
);
439 char *save_ptr
= NULL
;
443 word
= strtok_r(s
, " ,:\t", &save_ptr
);
444 if (word
&& !strcasecmp(word
, "PATTERN")) {
445 enum vlog_destination destination
;
447 word
= strtok_r(NULL
, " ,:\t", &save_ptr
);
449 msg
= xstrdup("missing destination");
453 destination
= (!strcasecmp(word
, "ANY")
454 ? VLF_ANY_DESTINATION
455 : vlog_get_destination_val(word
));
456 if (destination
== VLF_N_DESTINATIONS
) {
457 msg
= xasprintf("unknown destination \"%s\"", word
);
460 vlog_set_pattern(destination
, save_ptr
);
461 } else if (word
&& !strcasecmp(word
, "FACILITY")) {
464 if (!vlog_facility_exists(save_ptr
, &value
)) {
465 msg
= xstrdup("invalid facility");
468 atomic_store_explicit(&log_facility
, value
, memory_order_relaxed
);
470 struct vlog_module
*module
= NULL
;
471 enum vlog_level level
= VLL_N_LEVELS
;
472 enum vlog_destination destination
= VLF_N_DESTINATIONS
;
474 for (; word
!= NULL
; word
= strtok_r(NULL
, " ,:\t", &save_ptr
)) {
475 if (!strcasecmp(word
, "ANY")) {
477 } else if (vlog_get_destination_val(word
) != VLF_N_DESTINATIONS
) {
478 if (destination
!= VLF_N_DESTINATIONS
) {
479 msg
= xstrdup("cannot specify multiple destinations");
482 destination
= vlog_get_destination_val(word
);
483 } else if (vlog_get_level_val(word
) != VLL_N_LEVELS
) {
484 if (level
!= VLL_N_LEVELS
) {
485 msg
= xstrdup("cannot specify multiple levels");
488 level
= vlog_get_level_val(word
);
489 } else if (vlog_module_from_name(word
)) {
491 msg
= xstrdup("cannot specify multiple modules");
494 module
= vlog_module_from_name(word
);
496 msg
= xasprintf("no destination, level, or module \"%s\"",
502 if (destination
== VLF_N_DESTINATIONS
) {
503 destination
= VLF_ANY_DESTINATION
;
505 if (level
== VLL_N_LEVELS
) {
508 vlog_set_levels(module
, destination
, level
);
516 /* Set debugging levels. Abort with an error message if 's' is invalid. */
518 vlog_set_levels_from_string_assert(const char *s
)
520 char *error
= vlog_set_levels_from_string(s
);
522 ovs_fatal(0, "%s", error
);
526 /* If 'arg' is null, configure maximum verbosity. Otherwise, sets
527 * configuration according to 'arg' (see vlog_set_levels_from_string()). */
529 vlog_set_verbosity(const char *arg
)
532 char *msg
= vlog_set_levels_from_string(arg
);
534 ovs_fatal(0, "processing \"%s\": %s", arg
, msg
);
537 vlog_set_levels(NULL
, VLF_ANY_DESTINATION
, VLL_DBG
);
542 vlog_set_syslog_method(const char *method
)
545 /* Set syslogger only, if one is not already set. This effectively
546 * means that only the first --syslog-method argument is honored. */
550 if (!strcmp(method
, "libc")) {
551 syslogger
= syslog_libc_create();
552 } else if (!strncmp(method
, "udp:", 4) || !strncmp(method
, "unix:", 5)) {
553 syslogger
= syslog_direct_create(method
);
555 ovs_fatal(0, "unsupported syslog method '%s'", method
);
559 /* Set the vlog udp syslog target. */
561 vlog_set_syslog_target(const char *target
)
565 inet_open_active(SOCK_DGRAM
, target
, 0, NULL
, &new_fd
, 0);
567 ovs_rwlock_wrlock(&pattern_rwlock
);
568 if (syslog_fd
>= 0) {
572 ovs_rwlock_unlock(&pattern_rwlock
);
575 /* Returns 'false' if 'facility' is not a valid string. If 'facility'
576 * is a valid string, sets 'value' with the integer value of 'facility'
577 * and returns 'true'. */
579 vlog_facility_exists(const char* facility
, int *value
)
582 for (i
= 0; i
< ARRAY_SIZE(vlog_facilities
); i
++) {
583 if (!strcasecmp(vlog_facilities
[i
].name
, facility
)) {
584 *value
= vlog_facilities
[i
].value
;
592 vlog_unixctl_set(struct unixctl_conn
*conn
, int argc
, const char *argv
[],
593 void *aux OVS_UNUSED
)
597 for (i
= 1; i
< argc
; i
++) {
598 char *msg
= vlog_set_levels_from_string(argv
[i
]);
600 unixctl_command_reply_error(conn
, msg
);
605 unixctl_command_reply(conn
, NULL
);
609 vlog_unixctl_list(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
610 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
612 char *msg
= vlog_get_levels();
613 unixctl_command_reply(conn
, msg
);
618 vlog_unixctl_list_pattern(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
619 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
623 msg
= vlog_get_patterns();
624 unixctl_command_reply(conn
, msg
);
629 vlog_unixctl_reopen(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
630 const char *argv
[] OVS_UNUSED
, void *aux OVS_UNUSED
)
634 ovs_mutex_lock(&log_file_mutex
);
635 has_log_file
= log_file_name
!= NULL
;
636 ovs_mutex_unlock(&log_file_mutex
);
639 int error
= vlog_reopen_log_file();
641 unixctl_command_reply_error(conn
, ovs_strerror(errno
));
643 unixctl_command_reply(conn
, NULL
);
646 unixctl_command_reply_error(conn
, "Logging to file not configured");
651 set_all_rate_limits(bool enable
)
653 struct vlog_module
*mp
;
655 LIST_FOR_EACH (mp
, list
, &vlog_modules
) {
656 mp
->honor_rate_limits
= enable
;
661 set_rate_limits(struct unixctl_conn
*conn
, int argc
,
662 const char *argv
[], bool enable
)
667 for (i
= 1; i
< argc
; i
++) {
668 if (!strcasecmp(argv
[i
], "ANY")) {
669 set_all_rate_limits(enable
);
671 struct vlog_module
*module
= vlog_module_from_name(argv
[i
]);
673 unixctl_command_reply_error(conn
, "unknown module");
676 module
->honor_rate_limits
= enable
;
680 set_all_rate_limits(enable
);
682 unixctl_command_reply(conn
, NULL
);
686 vlog_enable_rate_limit(struct unixctl_conn
*conn
, int argc
,
687 const char *argv
[], void *aux OVS_UNUSED
)
689 set_rate_limits(conn
, argc
, argv
, true);
693 vlog_disable_rate_limit(struct unixctl_conn
*conn
, int argc
,
694 const char *argv
[], void *aux OVS_UNUSED
)
696 set_rate_limits(conn
, argc
, argv
, false);
699 /* Initializes the logging subsystem and registers its unixctl server
704 static struct ovsthread_once once
= OVSTHREAD_ONCE_INITIALIZER
;
706 if (ovsthread_once_start(&once
)) {
710 /* Do initialization work that needs to be done before any logging
711 * occurs. We want to keep this really minimal because any attempt to
712 * log anything before calling ovsthread_once_done() will deadlock. */
713 atomic_read_explicit(&log_facility
, &facility
, memory_order_relaxed
);
715 syslogger
= syslog_libc_create();
717 syslogger
->class->openlog(syslogger
, facility
? facility
: LOG_DAEMON
);
718 ovsthread_once_done(&once
);
720 /* Now do anything that we want to happen only once but doesn't have to
721 * finish before we start logging. */
723 now
= time_wall_msec();
725 char *s
= xastrftime_msec("%a, %d %b %Y %H:%M:%S", now
, true);
726 VLOG_ERR("current time is negative: %s (%lld)", s
, now
);
730 unixctl_command_register(
731 "vlog/set", "{spec | PATTERN:destination:pattern}",
732 1, INT_MAX
, vlog_unixctl_set
, NULL
);
733 unixctl_command_register("vlog/list", "", 0, 0, vlog_unixctl_list
,
735 unixctl_command_register("vlog/list-pattern", "", 0, 0,
736 vlog_unixctl_list_pattern
, NULL
);
737 unixctl_command_register("vlog/enable-rate-limit", "[module]...",
738 0, INT_MAX
, vlog_enable_rate_limit
, NULL
);
739 unixctl_command_register("vlog/disable-rate-limit", "[module]...",
740 0, INT_MAX
, vlog_disable_rate_limit
, NULL
);
741 unixctl_command_register("vlog/reopen", "", 0, 0,
742 vlog_unixctl_reopen
, NULL
);
746 /* Enables VLF_FILE log output to be written asynchronously to disk.
747 * Asynchronous file writes avoid blocking the process in the case of a busy
748 * disk, but on the other hand they are less robust: there is a chance that the
749 * write will not make it to the log file if the process crashes soon after the
752 vlog_enable_async(void)
754 ovs_mutex_lock(&log_file_mutex
);
756 if (log_fd
>= 0 && !log_writer
) {
757 log_writer
= async_append_create(log_fd
);
759 ovs_mutex_unlock(&log_file_mutex
);
762 /* Print the current logging level for each module. */
764 vlog_get_levels(void)
766 struct ds s
= DS_EMPTY_INITIALIZER
;
767 struct vlog_module
*mp
;
768 struct svec lines
= SVEC_EMPTY_INITIALIZER
;
772 ds_put_format(&s
, " console syslog file\n");
773 ds_put_format(&s
, " ------- ------ ------\n");
775 LIST_FOR_EACH (mp
, list
, &vlog_modules
) {
779 ds_put_format(&line
, "%-16s %4s %4s %4s",
780 vlog_get_module_name(mp
),
781 vlog_get_level_name(vlog_get_level(mp
, VLF_CONSOLE
)),
782 vlog_get_level_name(vlog_get_level(mp
, VLF_SYSLOG
)),
783 vlog_get_level_name(vlog_get_level(mp
, VLF_FILE
)));
784 if (!mp
->honor_rate_limits
) {
785 ds_put_cstr(&line
, " (rate limiting disabled)");
787 ds_put_char(&line
, '\n');
789 svec_add_nocopy(&lines
, ds_steal_cstr(&line
));
793 SVEC_FOR_EACH (i
, line
, &lines
) {
794 ds_put_cstr(&s
, line
);
796 svec_destroy(&lines
);
801 /* Returns as a string current logging patterns for each destination.
802 * This string must be released by caller. */
804 vlog_get_patterns(void)
806 struct ds ds
= DS_EMPTY_INITIALIZER
;
807 enum vlog_destination destination
;
809 ovs_rwlock_rdlock(&pattern_rwlock
);
810 ds_put_format(&ds
, " prefix format\n");
811 ds_put_format(&ds
, " ------ ------\n");
813 for (destination
= 0; destination
< VLF_N_DESTINATIONS
; destination
++) {
814 struct destination
*f
= &destinations
[destination
];;
815 const char *prefix
= "none";
817 if (destination
== VLF_SYSLOG
&& syslogger
) {
818 prefix
= syslog_get_prefix(syslogger
);
820 ds_put_format(&ds
, "%-7s %-32s %s\n", f
->name
, prefix
, f
->pattern
);
822 ovs_rwlock_unlock(&pattern_rwlock
);
827 /* Returns true if a log message emitted for the given 'module' and 'level'
828 * would cause some log output, false if that module and level are completely
831 vlog_is_enabled(const struct vlog_module
*module
, enum vlog_level level
)
833 return module
->min_level
>= level
;
837 fetch_braces(const char *p
, const char *def
, char *out
, size_t out_size
)
840 size_t n
= strcspn(p
+ 1, "}");
841 size_t n_copy
= MIN(n
, out_size
- 1);
842 memcpy(out
, p
+ 1, n_copy
);
846 ovs_strlcpy(out
, def
, out_size
);
852 format_log_message(const struct vlog_module
*module
, enum vlog_level level
,
853 const char *pattern
, const char *message
,
854 va_list args_
, struct ds
*s
)
862 for (p
= pattern
; *p
!= '\0'; ) {
863 const char *subprogram_name
;
864 enum { LEFT
, RIGHT
} justify
= RIGHT
;
866 size_t length
, field
, used
;
869 ds_put_char(s
, *p
++);
883 while (isdigit((unsigned char)*p
)) {
884 field
= (field
* 10) + (*p
- '0');
891 ds_put_cstr(s
, program_name
);
894 atomic_read_explicit(&log_facility
, &facility
,
895 memory_order_relaxed
);
896 facility
= facility
? facility
: LOG_LOCAL0
;
897 ds_put_format(s
, "%d", facility
+ syslog_levels
[level
]);
900 p
= fetch_braces(p
, "", tmp
, sizeof tmp
);
901 ds_put_cstr(s
, vlog_get_module_name(module
));
904 p
= fetch_braces(p
, "%Y-%m-%d %H:%M:%S.###", tmp
, sizeof tmp
);
905 ds_put_strftime_msec(s
, tmp
, time_wall_msec(), false);
908 p
= fetch_braces(p
, "%Y-%m-%d %H:%M:%S.###", tmp
, sizeof tmp
);
909 ds_put_strftime_msec(s
, tmp
, time_wall_msec(), true);
912 gethostname(tmp
, sizeof tmp
);
913 tmp
[sizeof tmp
- 1] = '\0';
917 /* Format user-supplied log message and trim trailing new-lines. */
919 va_copy(args
, args_
);
920 ds_put_format_valist(s
, message
, args
);
922 while (s
->length
> length
&& s
->string
[s
->length
- 1] == '\n') {
927 ds_put_format(s
, "%u", *msg_num_get_unsafe());
930 ds_put_char(s
, '\n');
933 ds_put_cstr(s
, vlog_get_level_name(level
));
936 ds_put_format(s
, "%ld", (long int) getpid());
939 ds_put_format(s
, "%lld", time_msec() - time_boot_msec());
942 subprogram_name
= get_subprogram_name();
943 ds_put_cstr(s
, subprogram_name
[0] ? subprogram_name
: "main");
946 subprogram_name
= get_subprogram_name();
947 if (subprogram_name
[0]) {
948 ds_put_format(s
, "(%s)", subprogram_name
);
952 ds_put_char(s
, p
[-1]);
955 used
= s
->length
- length
;
957 size_t n_pad
= field
- used
;
958 if (justify
== RIGHT
) {
959 ds_put_uninit(s
, n_pad
);
960 memmove(&s
->string
[length
+ n_pad
], &s
->string
[length
], used
);
961 memset(&s
->string
[length
], pad
, n_pad
);
963 ds_put_char_multiple(s
, pad
, n_pad
);
969 /* Exports the given 'syslog_message' to the configured udp syslog sink. */
971 send_to_syslog_fd(const char *s
, size_t length
)
972 OVS_REQ_RDLOCK(pattern_rwlock
)
974 static size_t max_length
= SIZE_MAX
;
975 size_t send_len
= MIN(length
, max_length
);
977 while (write(syslog_fd
, s
, send_len
) < 0 && errno
== EMSGSIZE
) {
978 send_len
-= send_len
/ 20;
979 max_length
= send_len
;
983 /* Writes 'message' to the log at the given 'level' and as coming from the
986 * Guaranteed to preserve errno. */
988 vlog_valist(const struct vlog_module
*module
, enum vlog_level level
,
989 const char *message
, va_list args
)
991 bool log_to_console
= module
->levels
[VLF_CONSOLE
] >= level
;
992 bool log_to_syslog
= module
->levels
[VLF_SYSLOG
] >= level
;
995 ovs_mutex_lock(&log_file_mutex
);
996 log_to_file
= module
->levels
[VLF_FILE
] >= level
&& log_fd
>= 0;
997 ovs_mutex_unlock(&log_file_mutex
);
998 if (log_to_console
|| log_to_syslog
|| log_to_file
) {
999 int save_errno
= errno
;
1005 ds_reserve(&s
, 1024);
1008 ovs_rwlock_rdlock(&pattern_rwlock
);
1009 if (log_to_console
) {
1010 format_log_message(module
, level
,
1011 destinations
[VLF_CONSOLE
].pattern
, message
,
1013 ds_put_char(&s
, '\n');
1014 fputs(ds_cstr(&s
), stderr
);
1017 if (log_to_syslog
) {
1018 int syslog_level
= syslog_levels
[level
];
1019 char *save_ptr
= NULL
;
1023 format_log_message(module
, level
, destinations
[VLF_SYSLOG
].pattern
,
1025 for (line
= strtok_r(s
.string
, "\n", &save_ptr
); line
;
1026 line
= strtok_r(NULL
, "\n", &save_ptr
)) {
1027 atomic_read_explicit(&log_facility
, &facility
,
1028 memory_order_relaxed
);
1029 syslogger
->class->syslog(syslogger
, syslog_level
|facility
, line
);
1032 if (syslog_fd
>= 0) {
1033 format_log_message(module
, level
,
1034 "<%B>1 %D{%Y-%m-%dT%H:%M:%S.###Z} "
1035 "%E %A %P %c - \xef\xbb\xbf%m",
1037 send_to_syslog_fd(ds_cstr(&s
), s
.length
);
1042 format_log_message(module
, level
, destinations
[VLF_FILE
].pattern
,
1044 ds_put_char(&s
, '\n');
1046 ovs_mutex_lock(&log_file_mutex
);
1049 async_append_write(log_writer
, s
.string
, s
.length
);
1050 if (level
== VLL_EMER
) {
1051 async_append_flush(log_writer
);
1054 ignore(write(log_fd
, s
.string
, s
.length
));
1057 ovs_mutex_unlock(&log_file_mutex
);
1059 ovs_rwlock_unlock(&pattern_rwlock
);
1067 vlog(const struct vlog_module
*module
, enum vlog_level level
,
1068 const char *message
, ...)
1072 va_start(args
, message
);
1073 vlog_valist(module
, level
, message
, args
);
1077 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
1078 * exit code. Always writes the message to stderr, even if the console
1079 * destination is disabled.
1081 * Choose this function instead of vlog_abort_valist() if the daemon monitoring
1082 * facility shouldn't automatically restart the current daemon. */
1084 vlog_fatal_valist(const struct vlog_module
*module_
,
1085 const char *message
, va_list args
)
1087 struct vlog_module
*module
= CONST_CAST(struct vlog_module
*, module_
);
1089 /* Don't log this message to the console to avoid redundancy with the
1090 * message written by the later ovs_fatal_valist(). */
1091 module
->levels
[VLF_CONSOLE
] = VLL_OFF
;
1093 vlog_valist(module
, VLL_EMER
, message
, args
);
1094 ovs_fatal_valist(0, message
, args
);
1097 /* Logs 'message' to 'module' at maximum verbosity, then exits with a failure
1098 * exit code. Always writes the message to stderr, even if the console
1099 * destination is disabled.
1101 * Choose this function instead of vlog_abort() if the daemon monitoring
1102 * facility shouldn't automatically restart the current daemon. */
1104 vlog_fatal(const struct vlog_module
*module
, const char *message
, ...)
1108 va_start(args
, message
);
1109 vlog_fatal_valist(module
, message
, args
);
1113 /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always
1114 * writes the message to stderr, even if the console destination is disabled.
1116 * Choose this function instead of vlog_fatal_valist() if the daemon monitoring
1117 * facility should automatically restart the current daemon. */
1119 vlog_abort_valist(const struct vlog_module
*module_
,
1120 const char *message
, va_list args
)
1122 struct vlog_module
*module
= (struct vlog_module
*) module_
;
1124 /* Don't log this message to the console to avoid redundancy with the
1125 * message written by the later ovs_abort_valist(). */
1126 module
->levels
[VLF_CONSOLE
] = VLL_OFF
;
1128 vlog_valist(module
, VLL_EMER
, message
, args
);
1129 ovs_abort_valist(0, message
, args
);
1132 /* Logs 'message' to 'module' at maximum verbosity, then calls abort(). Always
1133 * writes the message to stderr, even if the console destination is disabled.
1135 * Choose this function instead of vlog_fatal() if the daemon monitoring
1136 * facility should automatically restart the current daemon. */
1138 vlog_abort(const struct vlog_module
*module
, const char *message
, ...)
1142 va_start(args
, message
);
1143 vlog_abort_valist(module
, message
, args
);
1148 vlog_should_drop(const struct vlog_module
*module
, enum vlog_level level
,
1149 struct vlog_rate_limit
*rl
)
1151 if (!module
->honor_rate_limits
) {
1155 if (!vlog_is_enabled(module
, level
)) {
1159 ovs_mutex_lock(&rl
->mutex
);
1160 if (!token_bucket_withdraw(&rl
->token_bucket
, VLOG_MSG_TOKENS
)) {
1161 time_t now
= time_now();
1162 if (!rl
->n_dropped
) {
1163 rl
->first_dropped
= now
;
1165 rl
->last_dropped
= now
;
1167 ovs_mutex_unlock(&rl
->mutex
);
1171 if (!rl
->n_dropped
) {
1172 ovs_mutex_unlock(&rl
->mutex
);
1174 time_t now
= time_now();
1175 unsigned int n_dropped
= rl
->n_dropped
;
1176 unsigned int first_dropped_elapsed
= now
- rl
->first_dropped
;
1177 unsigned int last_dropped_elapsed
= now
- rl
->last_dropped
;
1179 ovs_mutex_unlock(&rl
->mutex
);
1182 "Dropped %u log messages in last %u seconds (most recently, "
1183 "%u seconds ago) due to excessive rate",
1184 n_dropped
, first_dropped_elapsed
, last_dropped_elapsed
);
1191 vlog_rate_limit(const struct vlog_module
*module
, enum vlog_level level
,
1192 struct vlog_rate_limit
*rl
, const char *message
, ...)
1194 if (!vlog_should_drop(module
, level
, rl
)) {
1197 va_start(args
, message
);
1198 vlog_valist(module
, level
, message
, args
);
1208 -vSPEC, --verbose=SPEC set logging levels\n\
1209 -v, --verbose set maximum verbosity level\n\
1210 --log-file[=FILE] enable logging to specified FILE\n\
1211 (default: %s/%s.log)\n\
1212 --syslog-method=(libc|unix:file|udp:ip:port)\n\
1213 specify how to send messages to syslog daemon\n\
1214 --syslog-target=HOST:PORT also send syslog msgs to HOST:PORT via UDP\n",
1215 ovs_logdir(), program_name
);