X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=include%2Fvlog.h;h=7582681a8797de0b3ce205854d2c925269a0e828;hb=b5bcab1b470dc597fa27c6698e33e23c948d1312;hp=93f13a1476fe53b715ca2cbba8c23f8d73de6913;hpb=981a0b3dd7cae0108af37fa77df65ab725b063ea;p=sliver-openvswitch.git diff --git a/include/vlog.h b/include/vlog.h index 93f13a147..7582681a8 100644 --- a/include/vlog.h +++ b/include/vlog.h @@ -1,28 +1,44 @@ -/* Copyright (C) 2007 Board of Trustees, Leland Stanford Jr. University. - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to - * deal in the Software without restriction, including without limitation the - * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or - * sell copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS - * IN THE SOFTWARE. +/* Copyright (c) 2008 The Board of Trustees of The Leland Stanford + * Junior University + * + * We are making the OpenFlow specification and associated documentation + * (Software) available for public use and benefit with the expectation + * that others will use, modify and enhance the Software and contribute + * those enhancements back to the community. However, since we would + * like to make the Software available for broadest use, with as few + * restrictions as possible permission is hereby granted, free of + * charge, to any person obtaining a copy of this Software to deal in + * the Software under the copyrights without restriction, including + * without limitation the rights to use, copy, modify, merge, publish, + * distribute, sublicense, and/or sell copies of the Software, and to + * permit persons to whom the Software is furnished to do so, subject to + * the following conditions: + * + * The above copyright notice and this permission notice shall be + * included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS + * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN + * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + * + * The name and trademarks of copyright holder(s) may NOT be used in + * advertising or publicity pertaining to the Software or any + * derivatives without specific, written prior permission. */ #ifndef VLOG_H #define VLOG_H 1 +#include +#include #include +#include +#include "util.h" /* Logging importance levels. */ enum vlog_level { @@ -47,27 +63,10 @@ enum vlog_facility { 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(controller) \ - VLOG_MODULE(ctlpath) \ - VLOG_MODULE(dpif) \ - VLOG_MODULE(dpctl) \ - VLOG_MODULE(fault) \ - VLOG_MODULE(flow) \ - VLOG_MODULE(netlink) \ - VLOG_MODULE(secchan) \ - 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 }; @@ -75,11 +74,42 @@ enum vlog_module { 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); 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_set_verbosity(const char *arg); /* Function for actual logging. */ @@ -87,15 +117,42 @@ 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 + * #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__) +/* 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_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__) + #endif /* vlog.h */