/*
- * Copyright (c) 2008, 2009, 2010 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <stdbool.h>
#include <time.h>
#include "util.h"
-
+
#ifdef __cplusplus
extern "C" {
#endif
-/* Logging importance levels. */
+/* Logging importance levels.
+ *
+ * The following log levels, in descending order of importance, are enabled by
+ * default:
+ *
+ * - EMER: Not currently used.
+ *
+ * - ERR: A high-level operation or a subsystem failed. Attention is
+ * warranted.
+ *
+ * - WARN: A low-level operation failed, but higher-level subsystems may be
+ * able to recover.
+ *
+ * - INFO: Information that may be useful in retrospect when investigating
+ * a problem.
+ *
+ * The lowest log level is not enabled by default:
+ *
+ * - DBG: Information useful only to someone with intricate knowledge of the
+ * system, or that would commonly cause too-voluminous log output.
+ */
#define VLOG_LEVELS \
VLOG_LEVEL(EMER, LOG_ALERT) \
VLOG_LEVEL(ERR, LOG_ERR) \
#define VLOG_DEFINE_MODULE(MODULE) \
VLOG_DEFINE_MODULE__(MODULE) \
struct vlog_module *vlog_module_ptr_##MODULE \
- __attribute__((section("vlog_modules"))) = &VLM_##MODULE;
+ __attribute__((section("vlog_modules"))) = &VLM_##MODULE
#else
-#define VLOG_DEFINE_MODULE(MODULE) extern struct vlog_module VLM_##MODULE;
+#define VLOG_DEFINE_MODULE(MODULE) extern struct vlog_module VLM_##MODULE
#endif
const char *vlog_get_module_name(const struct vlog_module *);
* 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;
+ 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
#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 \
vlog_rate_limit(THIS_MODULE, LEVEL, RL, __VA_ARGS__); \
} \
} while (0)
+#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) \
struct vlog_module VLM_##MODULE = \
{ \