#ifndef VLOG_H
#define VLOG_H 1
+#include <limits.h>
+#include <stdarg.h>
#include <stdbool.h>
+#include <time.h>
+#include "util.h"
/* Logging importance levels. */
+#define VLOG_LEVELS \
+ VLOG_LEVEL(EMER, LOG_ALERT) \
+ VLOG_LEVEL(ERR, LOG_ERR) \
+ VLOG_LEVEL(WARN, LOG_WARNING) \
+ VLOG_LEVEL(DBG, LOG_DEBUG)
enum vlog_level {
- VLL_EMER,
- VLL_ERR,
- VLL_WARN,
- VLL_DBG,
+#define VLOG_LEVEL(NAME, SYSLOG_LEVEL) VLL_##NAME,
+ VLOG_LEVELS
+#undef VLOG_LEVEL
VLL_N_LEVELS
};
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")
enum vlog_facility {
- VLF_SYSLOG,
- VLF_CONSOLE,
+#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);
-/* Modules that can emit log messages. */
-#define VLOG_MODULES \
- VLOG_MODULE(chain) \
- VLOG_MODULE(controller) \
- VLOG_MODULE(ctlpath) \
- VLOG_MODULE(daemon) \
- VLOG_MODULE(datapath) \
- VLOG_MODULE(dpif) \
- VLOG_MODULE(dpctl) \
- VLOG_MODULE(fault) \
- VLOG_MODULE(flow) \
- VLOG_MODULE(learning_switch) \
- VLOG_MODULE(mac_learning) \
- VLOG_MODULE(netdev) \
- VLOG_MODULE(netlink) \
- VLOG_MODULE(poll_loop) \
- VLOG_MODULE(secchan) \
- VLOG_MODULE(rconn) \
- VLOG_MODULE(switch) \
- VLOG_MODULE(socket_util) \
- VLOG_MODULE(vconn_netlink) \
- VLOG_MODULE(vconn_tcp) \
- VLOG_MODULE(vconn_ssl) \
- VLOG_MODULE(vconn) \
-
/* VLM_ constant for each vlog module. */
enum vlog_module {
#define VLOG_MODULE(NAME) VLM_##NAME,
- VLOG_MODULES
-#undef VLOG_MODULE
+#include "vlog-modules.def"
VLM_N_MODULES,
VLM_ANY_MODULE = -1
};
const char *vlog_get_module_name(enum vlog_module);
enum vlog_module vlog_get_module_val(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. */
+ time_t first_dropped; /* Time first message was dropped. */
+ unsigned int n_dropped; /* Number of messages dropped. */
+};
+
+/* Number of tokens to emit a message. We add 'rate' token 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
+
+/* 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, /* 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);
+void vlog_set_pattern(enum vlog_facility, const char *pattern);
char *vlog_set_levels_from_string(const char *);
char *vlog_get_levels(void);
bool vlog_is_enabled(enum vlog_module, enum vlog_level);
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.
* #define THIS_MODULE VLM_netlink
* Guaranteed to preserve errno.
*/
-#define VLOG_EMER(...) vlog(THIS_MODULE, VLL_EMER, __VA_ARGS__)
-#define VLOG_ERR(...) vlog(THIS_MODULE, VLL_ERR, __VA_ARGS__)
-#define VLOG_WARN(...) vlog(THIS_MODULE, VLL_WARN, __VA_ARGS__)
-#define VLOG_DBG(...) vlog(THIS_MODULE, VLL_DBG, __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_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
#define VLOG_IS_WARN_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_WARN)
#define VLOG_IS_DBG_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_DBG)
+/* 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
+ * Guaranteed to preserve errno.
+ */
+#define VLOG_ERR_RL(RL, ...) \
+ vlog_rate_limit(THIS_MODULE, VLL_ERR, RL, __VA_ARGS__)
+#define VLOG_WARN_RL(RL, ...) \
+ vlog_rate_limit(THIS_MODULE, VLL_WARN, RL, __VA_ARGS__)
+#define VLOG_DBG_RL(RL, ...) \
+ vlog_rate_limit(THIS_MODULE, VLL_DBG, RL, __VA_ARGS__)
+
+/* Implementation details. */
+#define VLOG(LEVEL, ...) \
+ do { \
+ if (min_vlog_levels[THIS_MODULE] >= LEVEL) { \
+ vlog(THIS_MODULE, LEVEL, __VA_ARGS__); \
+ } \
+ } while (0)
+extern enum vlog_level min_vlog_levels[VLM_N_MODULES];
+
#endif /* vlog.h */