1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
39 /* Logging importance levels. */
48 const char *vlog_get_level_name(enum vlog_level);
49 enum vlog_level vlog_get_level_val(const char *name);
51 /* Facilities that we can log to. */
59 const char *vlog_get_facility_name(enum vlog_facility);
60 enum vlog_facility vlog_get_facility_val(const char *name);
62 /* Modules that can emit log messages. */
63 #define VLOG_MODULES \
65 VLOG_MODULE(controller) \
66 VLOG_MODULE(ctlpath) \
68 VLOG_MODULE(datapath) \
70 VLOG_MODULE(dhcp_client) \
75 VLOG_MODULE(learning_switch) \
76 VLOG_MODULE(mac_learning) \
78 VLOG_MODULE(netlink) \
79 VLOG_MODULE(poll_loop) \
80 VLOG_MODULE(secchan) \
83 VLOG_MODULE(socket_util) \
84 VLOG_MODULE(vconn_netlink) \
85 VLOG_MODULE(vconn_tcp) \
86 VLOG_MODULE(vconn_ssl) \
90 /* VLM_ constant for each vlog module. */
92 #define VLOG_MODULE(NAME) VLM_##NAME,
99 const char *vlog_get_module_name(enum vlog_module);
100 enum vlog_module vlog_get_module_val(const char *name);
102 /* Configuring how each module logs messages. */
103 enum vlog_level vlog_get_level(enum vlog_module, enum vlog_facility);
104 void vlog_set_levels(enum vlog_module, enum vlog_facility, enum vlog_level);
105 char *vlog_set_levels_from_string(const char *);
106 char *vlog_get_levels(void);
107 bool vlog_is_enabled(enum vlog_module, enum vlog_level);
108 void vlog_set_verbosity(const char *arg);
110 /* Function for actual logging. */
111 void vlog_init(void);
112 void vlog_exit(void);
113 void vlog(enum vlog_module, enum vlog_level, const char *format, ...)
114 __attribute__((format(printf, 3, 4)));
116 /* Convenience macros. To use these, define THIS_MODULE as a macro that
117 * expands to the module used by the current source file, e.g.
119 * #define THIS_MODULE VLM_netlink
120 * Guaranteed to preserve errno.
122 #define VLOG_EMER(...) vlog(THIS_MODULE, VLL_EMER, __VA_ARGS__)
123 #define VLOG_ERR(...) vlog(THIS_MODULE, VLL_ERR, __VA_ARGS__)
124 #define VLOG_WARN(...) vlog(THIS_MODULE, VLL_WARN, __VA_ARGS__)
125 #define VLOG_DBG(...) vlog(THIS_MODULE, VLL_DBG, __VA_ARGS__)
127 /* More convenience macros, for testing whether a given level is enabled in
128 * THIS_MODULE. When constructing a log message is expensive, this enables it
130 #define VLOG_IS_EMER_ENABLED() true
131 #define VLOG_IS_ERR_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_EMER)
132 #define VLOG_IS_WARN_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_WARN)
133 #define VLOG_IS_DBG_ENABLED() vlog_is_enabled(THIS_MODULE, VLL_DBG)