X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=lib%2Fvlog.h;h=9570b0ef332730002031cd1a5a64ea7f1fa54bc5;hb=ad4c35fe2dd8edaab6331667021b6b8410abde90;hp=d98855a07e372795ead341f43be2e368e5afe4c7;hpb=a14bc59fb8f27db193d74662dc9c5cb8237177ef;p=openvswitch diff --git a/lib/vlog.h b/lib/vlog.h index d98855a0..9570b0ef 100644 --- a/lib/vlog.h +++ b/lib/vlog.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009 Nicira Networks. + * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,10 +21,20 @@ #include #include #include +#include "compiler.h" +#include "sat-math.h" +#include "token-bucket.h" #include "util.h" -/* Logging importance levels. */ +#ifdef __cplusplus +extern "C" { +#endif + +/* Logging severity levels. + * + * ovs-appctl(8) defines each of the log levels. */ #define VLOG_LEVELS \ + VLOG_LEVEL(OFF, LOG_ALERT) \ VLOG_LEVEL(EMER, LOG_ALERT) \ VLOG_LEVEL(ERR, LOG_ERR) \ VLOG_LEVEL(WARN, LOG_WARNING) \ @@ -41,10 +51,10 @@ const char *vlog_get_level_name(enum vlog_level); enum vlog_level vlog_get_level_val(const char *name); /* Facilities that we can log to. */ -#define VLOG_FACILITIES \ - VLOG_FACILITY(SYSLOG, "%05N|%c|%p|%m") \ - VLOG_FACILITY(CONSOLE, "%d{%b %d %H:%M:%S}|%05N|%c|%p|%m") \ - VLOG_FACILITY(FILE, "%d{%b %d %H:%M:%S}|%05N|%c|%p|%m") +#define VLOG_FACILITIES \ + VLOG_FACILITY(SYSLOG, "%05N|%c%T|%p|%m") \ + VLOG_FACILITY(CONSOLE, "%D{%Y-%m-%dT%H:%M:%SZ}|%05N|%c%T|%p|%m") \ + VLOG_FACILITY(FILE, "%D{%Y-%m-%dT%H:%M:%SZ}|%05N|%c%T|%p|%m") enum vlog_facility { #define VLOG_FACILITY(NAME, PATTERN) VLF_##NAME, VLOG_FACILITIES @@ -56,55 +66,57 @@ enum vlog_facility { const char *vlog_get_facility_name(enum vlog_facility); enum vlog_facility vlog_get_facility_val(const char *name); -/* VLM_ constant for each vlog module. */ -enum vlog_module { -#define VLOG_MODULE(NAME) VLM_##NAME, -#include "vlog-modules.def" - VLM_N_MODULES, - VLM_ANY_MODULE = -1 +/* A log module. */ +struct vlog_module { + const char *name; /* User-visible name. */ + int levels[VLF_N_FACILITIES]; /* Minimum log level for each facility. */ + int min_level; /* Minimum log level for any facility. */ }; -const char *vlog_get_module_name(enum vlog_module); -enum vlog_module vlog_get_module_val(const char *name); +/* Creates and initializes a global instance of a module named MODULE. */ +#if USE_LINKER_SECTIONS +#define VLOG_DEFINE_MODULE(MODULE) \ + VLOG_DEFINE_MODULE__(MODULE) \ + extern struct vlog_module *vlog_module_ptr_##MODULE; \ + struct vlog_module *vlog_module_ptr_##MODULE \ + __attribute__((section("vlog_modules"))) = &VLM_##MODULE +#else +#define VLOG_DEFINE_MODULE(MODULE) extern struct vlog_module VLM_##MODULE +#endif + +const char *vlog_get_module_name(const struct vlog_module *); +struct vlog_module *vlog_module_from_name(const char *name); /* Rate-limiter for log messages. */ struct vlog_rate_limit { - /* Configuration settings. */ - unsigned int rate; /* Tokens per second. */ - unsigned int burst; /* Max cumulative tokens credit. */ - - /* Current status. */ - unsigned int tokens; /* Current number of tokens. */ - time_t last_fill; /* Last time tokens added. */ + struct token_bucket token_bucket; time_t first_dropped; /* Time first message was dropped. */ + time_t last_dropped; /* Time of most recent message drop. */ unsigned int n_dropped; /* Number of messages dropped. */ }; -/* Number of tokens to emit a message. We add 'rate' tokens per second, which - * is 60 times the unit used for 'rate', thus 60 tokens are required to emit - * one message. */ -#define VLOG_MSG_TOKENS 60 +/* Number of tokens to emit a message. We add 'rate' tokens per millisecond, + * thus 60,000 tokens are required to emit one message per minute. */ +#define VLOG_MSG_TOKENS (60 * 1000) /* Initializer for a struct vlog_rate_limit, to set up a maximum rate of RATE * messages per minute and a maximum burst size of BURST messages. */ -#define VLOG_RATE_LIMIT_INIT(RATE, BURST) \ - { \ - RATE, /* rate */ \ - (MIN(BURST, UINT_MAX / VLOG_MSG_TOKENS) \ - * VLOG_MSG_TOKENS), /* burst */ \ - 0, /* tokens */ \ - 0, /* last_fill */ \ - 0, /* first_dropped */ \ - 0, /* n_dropped */ \ +#define VLOG_RATE_LIMIT_INIT(RATE, BURST) \ + { \ + TOKEN_BUCKET_INIT(RATE, SAT_MUL(BURST, VLOG_MSG_TOKENS)), \ + 0, /* first_dropped */ \ + 0, /* last_dropped */ \ + 0, /* n_dropped */ \ } /* Configuring how each module logs messages. */ -enum vlog_level vlog_get_level(enum vlog_module, enum vlog_facility); -void vlog_set_levels(enum vlog_module, enum vlog_facility, enum vlog_level); +enum vlog_level vlog_get_level(const struct vlog_module *, enum vlog_facility); +void vlog_set_levels(struct vlog_module *, + enum vlog_facility, enum vlog_level); char *vlog_set_levels_from_string(const char *); char *vlog_get_levels(void); -bool vlog_is_enabled(enum vlog_module, enum vlog_level); -bool vlog_should_drop(enum vlog_module, enum vlog_level, +bool vlog_is_enabled(const struct vlog_module *, enum vlog_level); +bool vlog_should_drop(const struct vlog_module *, enum vlog_level, struct vlog_rate_limit *); void vlog_set_verbosity(const char *arg); @@ -114,23 +126,46 @@ const char *vlog_get_log_file(void); int vlog_set_log_file(const char *file_name); int vlog_reopen_log_file(void); -/* Function for actual logging. */ +/* Initialization. */ void vlog_init(void); void vlog_exit(void); -void vlog(enum vlog_module, enum vlog_level, const char *format, ...) - __attribute__((format(printf, 3, 4))); -void vlog_valist(enum vlog_module, enum vlog_level, const char *, va_list) - __attribute__((format(printf, 3, 0))); -void vlog_rate_limit(enum vlog_module, enum vlog_level, - struct vlog_rate_limit *, const char *, ...) - __attribute__((format(printf, 4, 5))); -/* Convenience macros. To use these, define THIS_MODULE as a macro that - * expands to the module used by the current source file, e.g. - * #include "vlog.h" - * #define THIS_MODULE VLM_netlink +/* Functions for actual logging. */ +void vlog(const struct vlog_module *, enum vlog_level, const char *format, ...) + PRINTF_FORMAT (3, 4); +void vlog_valist(const struct vlog_module *, enum vlog_level, + const char *, va_list) + PRINTF_FORMAT (3, 0); + +void vlog_fatal(const struct vlog_module *, const char *format, ...) + PRINTF_FORMAT (2, 3) NO_RETURN; +void vlog_fatal_valist(const struct vlog_module *, const char *format, va_list) + PRINTF_FORMAT (2, 0) NO_RETURN; + +void vlog_abort(const struct vlog_module *, const char *format, ...) + PRINTF_FORMAT (2, 3) NO_RETURN; +void vlog_abort_valist(const struct vlog_module *, const char *format, va_list) + PRINTF_FORMAT (2, 0) NO_RETURN; + +void vlog_rate_limit(const struct vlog_module *, enum vlog_level, + struct vlog_rate_limit *, const char *, ...) + PRINTF_FORMAT (4, 5); + +/* Creates and initializes a global instance of a module named MODULE, and + * defines a static variable named THIS_MODULE that points to it, for use with + * the convenience macros below. */ +#define VLOG_DEFINE_THIS_MODULE(MODULE) \ + VLOG_DEFINE_MODULE(MODULE); \ + static struct vlog_module *const THIS_MODULE = &VLM_##MODULE + +/* Convenience macros. These assume that THIS_MODULE points to a "struct + * vlog_module" for the current module, as set up by e.g. the + * VLOG_DEFINE_MODULE macro above. + * * Guaranteed to preserve errno. */ +#define VLOG_FATAL(...) vlog_fatal(THIS_MODULE, __VA_ARGS__) +#define VLOG_ABORT(...) vlog_abort(THIS_MODULE, __VA_ARGS__) #define VLOG_EMER(...) VLOG(VLL_EMER, __VA_ARGS__) #define VLOG_ERR(...) VLOG(VLL_ERR, __VA_ARGS__) #define VLOG_WARN(...) VLOG(VLL_WARN, __VA_ARGS__) @@ -140,8 +175,7 @@ void vlog_rate_limit(enum vlog_module, enum vlog_level, /* More convenience macros, for testing whether a given level is enabled in * THIS_MODULE. When constructing a log message is expensive, this enables it * to be skipped. */ -#define VLOG_IS_EMER_ENABLED() true -#define VLOG_IS_ERR_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_EMER) +#define VLOG_IS_ERR_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_ERR) #define VLOG_IS_WARN_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_WARN) #define VLOG_IS_INFO_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_INFO) #define VLOG_IS_DBG_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_DBG) @@ -159,11 +193,17 @@ void vlog_rate_limit(enum vlog_module, enum vlog_level, #define VLOG_DROP_INFO(RL) vlog_should_drop(THIS_MODULE, VLL_INFO, RL) #define VLOG_DROP_DBG(RL) vlog_should_drop(THIS_MODULE, VLL_DBG, RL) +/* Macros for logging at most once per execution. */ +#define VLOG_ERR_ONCE(...) VLOG_ONCE(VLL_ERR, __VA_ARGS__) +#define VLOG_WARN_ONCE(...) VLOG_ONCE(VLL_WARN, __VA_ARGS__) +#define VLOG_INFO_ONCE(...) VLOG_ONCE(VLL_INFO, __VA_ARGS__) +#define VLOG_DBG_ONCE(...) VLOG_ONCE(VLL_DBG, __VA_ARGS__) + /* Command line processing. */ #define VLOG_OPTION_ENUMS OPT_LOG_FILE #define VLOG_LONG_OPTIONS \ - {"verbose", optional_argument, 0, 'v'}, \ - {"log-file", optional_argument, 0, OPT_LOG_FILE} + {"verbose", optional_argument, NULL, 'v'}, \ + {"log-file", optional_argument, NULL, OPT_LOG_FILE} #define VLOG_OPTION_HANDLERS \ case 'v': \ vlog_set_verbosity(optarg); \ @@ -176,17 +216,39 @@ void vlog_usage(void); /* Implementation details. */ #define VLOG(LEVEL, ...) \ do { \ - if (min_vlog_levels[THIS_MODULE] >= LEVEL) { \ - vlog(THIS_MODULE, LEVEL, __VA_ARGS__); \ + enum vlog_level level__ = LEVEL; \ + if (THIS_MODULE->min_level >= level__) { \ + vlog(THIS_MODULE, level__, __VA_ARGS__); \ } \ } while (0) #define VLOG_RL(RL, LEVEL, ...) \ do { \ - if (min_vlog_levels[THIS_MODULE] >= LEVEL) { \ - vlog_rate_limit(THIS_MODULE, LEVEL, RL, __VA_ARGS__); \ + enum vlog_level level__ = LEVEL; \ + if (THIS_MODULE->min_level >= level__) { \ + vlog_rate_limit(THIS_MODULE, level__, RL, __VA_ARGS__); \ } \ } while (0) -extern enum vlog_level min_vlog_levels[VLM_N_MODULES]; +#define VLOG_ONCE(LEVEL, ...) \ + do { \ + static bool already_logged; \ + if (!already_logged) { \ + already_logged = true; \ + vlog(THIS_MODULE, LEVEL, __VA_ARGS__); \ + } \ + } while (0) + +#define VLOG_DEFINE_MODULE__(MODULE) \ + extern struct vlog_module VLM_##MODULE; \ + struct vlog_module VLM_##MODULE = \ + { \ + #MODULE, /* name */ \ + { [ 0 ... VLF_N_FACILITIES - 1] = VLL_INFO }, /* levels */ \ + VLL_INFO, /* min_level */ \ + }; + +#ifdef __cplusplus +} +#endif #endif /* vlog.h */