[mirror_ovs.git] / lib / vlog.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef VLOG_H
#define VLOG_H 1

/* Logging.
 *
 *
 * Thread-safety
 * =============
 *
 * Fully thread safe.
 */

#include <limits.h>
#include <stdarg.h>
#include <stdbool.h>
#include <time.h>
#include "compiler.h"
#include "ovs-thread.h"
#include "sat-math.h"
#include "token-bucket.h"
#include "util.h"
#include "list.h"

#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,   1)            \
    VLOG_LEVEL(EMER, LOG_ALERT,   1)            \
    VLOG_LEVEL(ERR,  LOG_ERR,     3)            \
    VLOG_LEVEL(WARN, LOG_WARNING, 4)            \
    VLOG_LEVEL(INFO, LOG_NOTICE,  5)            \
    VLOG_LEVEL(DBG,  LOG_DEBUG,   7)
enum vlog_level {
#define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424_LEVEL) VLL_##NAME,
    VLOG_LEVELS
#undef VLOG_LEVEL
    VLL_N_LEVELS
};

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, "ovs|%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:%S.###Z}|%05N|%c%T|%p|%m")
enum vlog_facility {
#define VLOG_FACILITY(NAME, PATTERN) VLF_##NAME,
    VLOG_FACILITIES
#undef VLOG_FACILITY
    VLF_N_FACILITIES,
    VLF_ANY_FACILITY = -1
};

const char *vlog_get_facility_name(enum vlog_facility);
enum vlog_facility vlog_get_facility_val(const char *name);

/* A log module. */
struct vlog_module {
    struct list list;
    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. */
    bool honor_rate_limits;       /* Set false to ignore rate limits. */
};

/* Global list of all logging modules */
extern struct list vlog_modules;

/* Creates and initializes a global instance of a module named MODULE. */
#define VLOG_DEFINE_MODULE(MODULE)                                      \
        VLOG_DEFINE_MODULE__(MODULE)                                    \
        OVS_CONSTRUCTOR(init_##MODULE) {                                \
                list_insert(&vlog_modules, &VLM_##MODULE.list);         \
        }                                                               \

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 {
    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. */
    struct ovs_mutex mutex;     /* Mutual exclusion for rate limit. */
};

/* 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)                               \
        {                                                               \
            TOKEN_BUCKET_INIT(RATE, SAT_MUL(BURST, VLOG_MSG_TOKENS)),   \
            0,                              /* first_dropped */         \
            0,                              /* last_dropped */          \
            0,                              /* n_dropped */             \
            OVS_MUTEX_INITIALIZER           /* mutex */                 \
        }

/* Configuring how each module logs messages. */
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 *) WARN_UNUSED_RESULT;
void vlog_set_levels_from_string_assert(const char *);
char *vlog_get_levels(void);
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);

/* Configuring log facilities. */
void vlog_set_pattern(enum vlog_facility, const char *pattern);
int vlog_set_log_file(const char *file_name);
int vlog_reopen_log_file(void);

/* Configure syslog target. */
void vlog_set_syslog_target(const char *target);

/* Initialization. */
void vlog_init(void);
void vlog_enable_async(void);

/* 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__)
#define VLOG_INFO(...) VLOG(VLL_INFO, __VA_ARGS__)
#define VLOG_DBG(...) VLOG(VLL_DBG, __VA_ARGS__)

/* 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_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)

/* Convenience macros for rate-limiting.
 * Guaranteed to preserve errno.
 */
#define VLOG_ERR_RL(RL, ...) VLOG_RL(RL, VLL_ERR, __VA_ARGS__)
#define VLOG_WARN_RL(RL, ...) VLOG_RL(RL, VLL_WARN, __VA_ARGS__)
#define VLOG_INFO_RL(RL, ...) VLOG_RL(RL, VLL_INFO, __VA_ARGS__)
#define VLOG_DBG_RL(RL, ...) VLOG_RL(RL, VLL_DBG, __VA_ARGS__)

#define VLOG_DROP_ERR(RL) vlog_should_drop(THIS_MODULE, VLL_ERR, RL)
#define VLOG_DROP_WARN(RL) vlog_should_drop(THIS_MODULE, VLL_WARN, RL)
#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,                           \
        OPT_SYSLOG_TARGET

#define VLOG_LONG_OPTIONS                                               \
        {"verbose",       optional_argument, NULL, 'v'},                \
        {"log-file",      optional_argument, NULL, OPT_LOG_FILE},       \
        {"syslog-target", optional_argument, NULL, OPT_SYSLOG_TARGET}

#define VLOG_OPTION_HANDLERS                    \
        case 'v':                               \
            vlog_set_verbosity(optarg);         \
            break;                              \
        case OPT_LOG_FILE:                      \
            vlog_set_log_file(optarg);          \
            break;                              \
        case OPT_SYSLOG_TARGET:                 \
            vlog_set_syslog_target(optarg);     \
            break;

void vlog_usage(void);

/* Implementation details. */
#define VLOG(LEVEL, ...)                                \
    do {                                                \
        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 {                                                            \
        enum vlog_level level__ = LEVEL;                            \
        if (THIS_MODULE->min_level >= level__) {                    \
            vlog_rate_limit(THIS_MODULE, level__, RL, __VA_ARGS__); \
        }                                                           \
    } while (0)
#define VLOG_ONCE(LEVEL, ...)                                           \
    do {                                                                \
        static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER; \
        if (ovsthread_once_start(&once)) {                              \
            vlog(THIS_MODULE, LEVEL, __VA_ARGS__);                      \
            ovsthread_once_done(&once);                                 \
        }                                                               \
    } while (0)

#define VLOG_DEFINE_MODULE__(MODULE)                                    \
        extern struct vlog_module VLM_##MODULE;                         \
        struct vlog_module VLM_##MODULE =                               \
        {                                                               \
            LIST_INITIALIZER(&VLM_##MODULE.list),                       \
            #MODULE,                                        /* name */  \
            { [ 0 ... VLF_N_FACILITIES - 1] = VLL_INFO }, /* levels */  \
            VLL_INFO,                                  /* min_level */  \
            true                               /* honor_rate_limits */  \
        };

#ifdef  __cplusplus
}
#endif


#endif /* vlog.h */
Commit	Line	Data
064af421	1	/*
316bd0f8	2	* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
064af421	3	*
a14bc59f BP	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:
064af421	7	*
a14bc59f BP	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.
064af421 BP	15	*/
	16
	17	#ifndef VLOG_H
	18	#define VLOG_H 1
	19
81d6495f BP	20	/* Logging.
	21	*
	22	*
	23	* Thread-safety
	24	* =============
	25	*
	26	* Fully thread safe.
	27	*/
	28
064af421 BP	29	#include <limits.h>
	30	#include <stdarg.h>
	31	#include <stdbool.h>
	32	#include <time.h>
1c5a216a	33	#include "compiler.h"
fda28014	34	#include "ovs-thread.h"
648f4f1f BP	35	#include "sat-math.h"
648f4f1f BP	36	#include "token-bucket.h"
064af421	37	#include "util.h"
86e504e1	38	#include "list.h"
d295e8e9	39
f4ade105 JG	40	#ifdef __cplusplus
	41	extern "C" {
	42	#endif
064af421	43
c1a543a8	44	/* Logging severity levels.
c7981f8c	45	*
7d110e96	46	* ovs-appctl(8) defines each of the log levels. */
064af421	47	#define VLOG_LEVELS \
afc9f547 HM	48	VLOG_LEVEL(OFF, LOG_ALERT, 1) \
	49	VLOG_LEVEL(EMER, LOG_ALERT, 1) \
	50	VLOG_LEVEL(ERR, LOG_ERR, 3) \
	51	VLOG_LEVEL(WARN, LOG_WARNING, 4) \
	52	VLOG_LEVEL(INFO, LOG_NOTICE, 5) \
	53	VLOG_LEVEL(DBG, LOG_DEBUG, 7)
064af421	54	enum vlog_level {
afc9f547	55	#define VLOG_LEVEL(NAME, SYSLOG_LEVEL, RFC5424_LEVEL) VLL_##NAME,
064af421 BP	56	VLOG_LEVELS
	57	#undef VLOG_LEVEL
	58	VLL_N_LEVELS
	59	};
	60
	61	const char *vlog_get_level_name(enum vlog_level);
	62	enum vlog_level vlog_get_level_val(const char *name);
	63
	64	/* Facilities that we can log to. */
781dee08	65	#define VLOG_FACILITIES \
afc9f547	66	VLOG_FACILITY(SYSLOG, "ovs\|%05N\|%c%T\|%p\|%m") \
781dee08	67	VLOG_FACILITY(CONSOLE, "%D{%Y-%m-%dT%H:%M:%SZ}\|%05N\|%c%T\|%p\|%m") \
2b31d8e7	68	VLOG_FACILITY(FILE, "%D{%Y-%m-%dT%H:%M:%S.###Z}\|%05N\|%c%T\|%p\|%m")
064af421 BP	69	enum vlog_facility {
	70	#define VLOG_FACILITY(NAME, PATTERN) VLF_##NAME,
	71	VLOG_FACILITIES
	72	#undef VLOG_FACILITY
	73	VLF_N_FACILITIES,
	74	VLF_ANY_FACILITY = -1
	75	};
	76
	77	const char *vlog_get_facility_name(enum vlog_facility);
	78	enum vlog_facility vlog_get_facility_val(const char *name);
	79
480ce8ab BP	80	/* A log module. */
480ce8ab BP	81	struct vlog_module {
86e504e1	82	struct list list;
480ce8ab BP	83	const char name; / User-visible name. */
	84	int levels[VLF_N_FACILITIES]; /* Minimum log level for each facility. */
	85	int min_level; /* Minimum log level for any facility. */
93161ce9	86	bool honor_rate_limits; /* Set false to ignore rate limits. */
064af421 BP	87	};
064af421 BP	88
86e504e1 HS	89	/* Global list of all logging modules */
	90	extern struct list vlog_modules;
	91
480ce8ab	92	/* Creates and initializes a global instance of a module named MODULE. */
480ce8ab BP	93	#define VLOG_DEFINE_MODULE(MODULE) \
480ce8ab BP	94	VLOG_DEFINE_MODULE__(MODULE) \
86e504e1 HS	95	OVS_CONSTRUCTOR(init_##MODULE) { \
	96	list_insert(&vlog_modules, &VLM_##MODULE.list); \
	97	} \
480ce8ab BP	98
	99	const char vlog_get_module_name(const struct vlog_module );
	100	struct vlog_module vlog_module_from_name(const char name);
064af421 BP	101
	102	/* Rate-limiter for log messages. */
	103	struct vlog_rate_limit {
648f4f1f	104	struct token_bucket token_bucket;
064af421	105	time_t first_dropped; /* Time first message was dropped. */
e2eed6a7	106	time_t last_dropped; /* Time of most recent message drop. */
064af421	107	unsigned int n_dropped; /* Number of messages dropped. */
97be1538	108	struct ovs_mutex mutex; /* Mutual exclusion for rate limit. */
064af421 BP	109	};
064af421 BP	110
648f4f1f BP	111	/* Number of tokens to emit a message. We add 'rate' tokens per millisecond,
	112	* thus 60,000 tokens are required to emit one message per minute. */
	113	#define VLOG_MSG_TOKENS (60 * 1000)
064af421 BP	114
	115	/* Initializer for a struct vlog_rate_limit, to set up a maximum rate of RATE
	116	* messages per minute and a maximum burst size of BURST messages. */
648f4f1f BP	117	#define VLOG_RATE_LIMIT_INIT(RATE, BURST) \
	118	{ \
	119	TOKEN_BUCKET_INIT(RATE, SAT_MUL(BURST, VLOG_MSG_TOKENS)), \
	120	0, /* first_dropped */ \
	121	0, /* last_dropped */ \
	122	0, /* n_dropped */ \
834d6caf	123	OVS_MUTEX_INITIALIZER /* mutex */ \
064af421 BP	124	}
	125
	126	/* Configuring how each module logs messages. */
480ce8ab BP	127	enum vlog_level vlog_get_level(const struct vlog_module *, enum vlog_facility);
	128	void vlog_set_levels(struct vlog_module *,
	129	enum vlog_facility, enum vlog_level);
316bd0f8 BP	130	char vlog_set_levels_from_string(const char ) WARN_UNUSED_RESULT;
316bd0f8 BP	131	void vlog_set_levels_from_string_assert(const char *);
064af421	132	char *vlog_get_levels(void);
480ce8ab BP	133	bool vlog_is_enabled(const struct vlog_module *, enum vlog_level);
480ce8ab BP	134	bool vlog_should_drop(const struct vlog_module *, enum vlog_level,
064af421 BP	135	struct vlog_rate_limit *);
	136	void vlog_set_verbosity(const char *arg);
	137
	138	/* Configuring log facilities. */
	139	void vlog_set_pattern(enum vlog_facility, const char *pattern);
064af421 BP	140	int vlog_set_log_file(const char *file_name);
	141	int vlog_reopen_log_file(void);
	142
afc9f547 HM	143	/* Configure syslog target. */
	144	void vlog_set_syslog_target(const char *target);
	145
279c9e03	146	/* Initialization. */
064af421	147	void vlog_init(void);
888e0cf4	148	void vlog_enable_async(void);
279c9e03 BP	149
279c9e03 BP	150	/* Functions for actual logging. */
480ce8ab	151	void vlog(const struct vlog_module , enum vlog_level, const char format, ...)
1c5a216a	152	PRINTF_FORMAT (3, 4);
480ce8ab BP	153	void vlog_valist(const struct vlog_module *, enum vlog_level,
480ce8ab BP	154	const char *, va_list)
1c5a216a	155	PRINTF_FORMAT (3, 0);
279c9e03	156
c1a543a8 BP	157	void vlog_fatal(const struct vlog_module , const char format, ...)
	158	PRINTF_FORMAT (2, 3) NO_RETURN;
	159	void vlog_fatal_valist(const struct vlog_module , const char format, va_list)
	160	PRINTF_FORMAT (2, 0) NO_RETURN;
279c9e03	161
d41d4b71 BP	162	void vlog_abort(const struct vlog_module , const char format, ...)
	163	PRINTF_FORMAT (2, 3) NO_RETURN;
	164	void vlog_abort_valist(const struct vlog_module , const char format, va_list)
	165	PRINTF_FORMAT (2, 0) NO_RETURN;
	166
480ce8ab	167	void vlog_rate_limit(const struct vlog_module *, enum vlog_level,
064af421	168	struct vlog_rate_limit , const char , ...)
1c5a216a	169	PRINTF_FORMAT (4, 5);
064af421	170
480ce8ab BP	171	/* Creates and initializes a global instance of a module named MODULE, and
	172	* defines a static variable named THIS_MODULE that points to it, for use with
	173	* the convenience macros below. */
	174	#define VLOG_DEFINE_THIS_MODULE(MODULE) \
d98e6007 BP	175	VLOG_DEFINE_MODULE(MODULE); \
d98e6007 BP	176	static struct vlog_module *const THIS_MODULE = &VLM_##MODULE
5136ce49	177
480ce8ab BP	178	/* Convenience macros. These assume that THIS_MODULE points to a "struct
	179	* vlog_module" for the current module, as set up by e.g. the
	180	* VLOG_DEFINE_MODULE macro above.
5136ce49	181	*
064af421 BP	182	* Guaranteed to preserve errno.
064af421 BP	183	*/
c1a543a8	184	#define VLOG_FATAL(...) vlog_fatal(THIS_MODULE, __VA_ARGS__)
d41d4b71	185	#define VLOG_ABORT(...) vlog_abort(THIS_MODULE, __VA_ARGS__)
064af421 BP	186	#define VLOG_EMER(...) VLOG(VLL_EMER, __VA_ARGS__)
	187	#define VLOG_ERR(...) VLOG(VLL_ERR, __VA_ARGS__)
	188	#define VLOG_WARN(...) VLOG(VLL_WARN, __VA_ARGS__)
	189	#define VLOG_INFO(...) VLOG(VLL_INFO, __VA_ARGS__)
	190	#define VLOG_DBG(...) VLOG(VLL_DBG, __VA_ARGS__)
	191
	192	/* More convenience macros, for testing whether a given level is enabled in
	193	* THIS_MODULE. When constructing a log message is expensive, this enables it
	194	* to be skipped. */
8a3d2fef	195	#define VLOG_IS_ERR_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_ERR)
064af421 BP	196	#define VLOG_IS_WARN_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_WARN)
	197	#define VLOG_IS_INFO_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_INFO)
	198	#define VLOG_IS_DBG_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_DBG)
	199
	200	/* Convenience macros for rate-limiting.
	201	* Guaranteed to preserve errno.
	202	*/
	203	#define VLOG_ERR_RL(RL, ...) VLOG_RL(RL, VLL_ERR, __VA_ARGS__)
	204	#define VLOG_WARN_RL(RL, ...) VLOG_RL(RL, VLL_WARN, __VA_ARGS__)
	205	#define VLOG_INFO_RL(RL, ...) VLOG_RL(RL, VLL_INFO, __VA_ARGS__)
	206	#define VLOG_DBG_RL(RL, ...) VLOG_RL(RL, VLL_DBG, __VA_ARGS__)
	207
	208	#define VLOG_DROP_ERR(RL) vlog_should_drop(THIS_MODULE, VLL_ERR, RL)
	209	#define VLOG_DROP_WARN(RL) vlog_should_drop(THIS_MODULE, VLL_WARN, RL)
	210	#define VLOG_DROP_INFO(RL) vlog_should_drop(THIS_MODULE, VLL_INFO, RL)
	211	#define VLOG_DROP_DBG(RL) vlog_should_drop(THIS_MODULE, VLL_DBG, RL)
	212
5136364f BP	213	/* Macros for logging at most once per execution. */
	214	#define VLOG_ERR_ONCE(...) VLOG_ONCE(VLL_ERR, __VA_ARGS__)
	215	#define VLOG_WARN_ONCE(...) VLOG_ONCE(VLL_WARN, __VA_ARGS__)
	216	#define VLOG_INFO_ONCE(...) VLOG_ONCE(VLL_INFO, __VA_ARGS__)
	217	#define VLOG_DBG_ONCE(...) VLOG_ONCE(VLL_DBG, __VA_ARGS__)
	218
064af421	219	/* Command line processing. */
afc9f547 HM	220	#define VLOG_OPTION_ENUMS \
	221	OPT_LOG_FILE, \
	222	OPT_SYSLOG_TARGET
	223
	224	#define VLOG_LONG_OPTIONS \
	225	{"verbose", optional_argument, NULL, 'v'}, \
	226	{"log-file", optional_argument, NULL, OPT_LOG_FILE}, \
	227	{"syslog-target", optional_argument, NULL, OPT_SYSLOG_TARGET}
	228
064af421 BP	229	#define VLOG_OPTION_HANDLERS \
	230	case 'v': \
	231	vlog_set_verbosity(optarg); \
	232	break; \
	233	case OPT_LOG_FILE: \
	234	vlog_set_log_file(optarg); \
afc9f547 HM	235	break; \
	236	case OPT_SYSLOG_TARGET: \
	237	vlog_set_syslog_target(optarg); \
064af421	238	break;
afc9f547	239
064af421 BP	240	void vlog_usage(void);
	241
	242	/* Implementation details. */
45704b24 BP	243	#define VLOG(LEVEL, ...) \
	244	do { \
	245	enum vlog_level level__ = LEVEL; \
	246	if (THIS_MODULE->min_level >= level__) { \
	247	vlog(THIS_MODULE, level__, __VA_ARGS__); \
	248	} \
064af421 BP	249	} while (0)
	250	#define VLOG_RL(RL, LEVEL, ...) \
	251	do { \
45704b24 BP	252	enum vlog_level level__ = LEVEL; \
	253	if (THIS_MODULE->min_level >= level__) { \
	254	vlog_rate_limit(THIS_MODULE, level__, RL, __VA_ARGS__); \
064af421 BP	255	} \
064af421 BP	256	} while (0)
f1de299e BP	257	#define VLOG_ONCE(LEVEL, ...) \
	258	do { \
	259	static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER; \
	260	if (ovsthread_once_start(&once)) { \
	261	vlog(THIS_MODULE, LEVEL, __VA_ARGS__); \
	262	ovsthread_once_done(&once); \
	263	} \
5136364f BP	264	} while (0)
5136364f BP	265
480ce8ab	266	#define VLOG_DEFINE_MODULE__(MODULE) \
f4070db7	267	extern struct vlog_module VLM_##MODULE; \
480ce8ab BP	268	struct vlog_module VLM_##MODULE = \
480ce8ab BP	269	{ \
86e504e1	270	LIST_INITIALIZER(&VLM_##MODULE.list), \
93161ce9	271	#MODULE, /* name */ \
480ce8ab	272	{ [ 0 ... VLF_N_FACILITIES - 1] = VLL_INFO }, /* levels */ \
93161ce9 BP	273	VLL_INFO, /* min_level */ \
93161ce9 BP	274	true /* honor_rate_limits */ \
480ce8ab BP	275	};
480ce8ab BP	276
f4ade105 JG	277	#ifdef __cplusplus
	278	}
	279	#endif
064af421 BP	280
	281
	282	#endif /* vlog.h */