[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"

#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)               \
    VLOG_LEVEL(INFO, LOG_NOTICE)                \
    VLOG_LEVEL(DBG, LOG_DEBUG)
enum vlog_level {
#define VLOG_LEVEL(NAME, SYSLOG_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:%SZ}|%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 {
    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. */
};

/* 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 *const vlog_module_ptr_##MODULE;      \
        struct vlog_module *const 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 {
    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_ADAPTIVE_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);

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