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.
44 #include "dynamic-string.h"
47 #define THIS_MODULE VLM_vlog
49 /* Name for each logging level. */
50 static const char *level_names[VLL_N_LEVELS] = {
57 /* Name for each logging facility. */
58 static const char *facility_names[VLF_N_FACILITIES] = {
59 [VLF_CONSOLE] = "console",
60 [VLF_SYSLOG] = "syslog",
63 /* Name for each logging module */
64 static const char *module_names[VLM_N_MODULES] = {
65 #define VLOG_MODULE(NAME) #NAME,
70 static int levels[VLM_N_MODULES][VLF_N_FACILITIES];
72 /* Searches the 'n_names' in 'names'. Returns the index of a match for
73 * 'target', or 'n_names' if no name matches. */
75 search_name_array(const char *target, const char **names, size_t n_names)
79 for (i = 0; i < n_names; i++) {
81 if (!strcasecmp(names[i], target)) {
88 /* Returns the name for logging level 'level'. */
90 vlog_get_level_name(enum vlog_level level)
92 assert(level < VLL_N_LEVELS);
93 return level_names[level];
96 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
97 * is not the name of a logging level. */
99 vlog_get_level_val(const char *name)
101 return search_name_array(name, level_names, ARRAY_SIZE(level_names));
104 /* Returns the name for logging facility 'facility'. */
106 vlog_get_facility_name(enum vlog_facility facility)
108 assert(facility < VLF_N_FACILITIES);
109 return facility_names[facility];
112 /* Returns the logging facility named 'name', or VLF_N_FACILITIES if 'name' is
113 * not the name of a logging facility. */
115 vlog_get_facility_val(const char *name)
117 return search_name_array(name, facility_names, ARRAY_SIZE(facility_names));
120 /* Returns the name for logging module 'module'. */
121 const char *vlog_get_module_name(enum vlog_module module)
123 assert(module < VLM_N_MODULES);
124 return module_names[module];
127 /* Returns the logging module named 'name', or VLM_N_MODULES if 'name' is not
128 * the name of a logging module. */
130 vlog_get_module_val(const char *name)
132 return search_name_array(name, module_names, ARRAY_SIZE(module_names));
135 /* Returns the current logging level for the given 'module' and 'facility'. */
137 vlog_get_level(enum vlog_module module, enum vlog_facility facility)
139 assert(module < VLM_N_MODULES);
140 assert(facility < VLF_N_FACILITIES);
141 return levels[module][facility];
145 set_facility_level(enum vlog_facility facility, enum vlog_module module,
146 enum vlog_level level)
148 assert(facility >= 0 && facility < VLF_N_FACILITIES);
149 assert(level < VLL_N_LEVELS);
151 if (module == VLM_ANY_MODULE) {
152 for (module = 0; module < VLM_N_MODULES; module++) {
153 levels[module][facility] = level;
156 levels[module][facility] = level;
160 /* Sets the logging level for the given 'module' and 'facility' to 'level'. */
162 vlog_set_levels(enum vlog_module module, enum vlog_facility facility,
163 enum vlog_level level)
165 assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
166 if (facility == VLF_ANY_FACILITY) {
167 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
168 set_facility_level(facility, module, level);
171 set_facility_level(facility, module, level);
175 /* Set debugging levels:
177 * mod[:facility[:level]] mod2[:facility[:level]] ...
179 * Return null if successful, otherwise an error message that the caller must
183 vlog_set_levels_from_string(const char *s_)
186 char *s = xstrdup(s_);
187 char *module, *level, *facility;
189 for (module = strtok_r(s, ": \t", &save_ptr); module != NULL;
190 module = strtok_r(NULL, ": \t", &save_ptr)) {
191 enum vlog_module e_module;
192 enum vlog_level e_level;
193 enum vlog_facility e_facility;
195 facility = strtok_r(NULL, ":", &save_ptr);
196 level = strtok_r(NULL, ":", &save_ptr);
198 if (!strcmp(module, "ANY")) {
199 e_module = VLM_ANY_MODULE;
201 e_module = vlog_get_module_val(module);
202 if (e_module >= VLM_N_MODULES) {
203 char *msg = xasprintf("unknown module \"%s\"", module);
209 if (!facility || !strcmp(facility, "ANY")) {
210 e_facility = VLF_ANY_FACILITY;
212 e_facility = vlog_get_facility_val(facility);
213 if (e_facility >= VLF_N_FACILITIES) {
214 char *msg = xasprintf("unknown facility \"%s\"", facility);
220 e_level = level ? vlog_get_level_val(level) : VLL_DBG;
221 if (e_level >= VLL_N_LEVELS) {
222 char *msg = xasprintf("unknown level \"%s\"", level);
227 vlog_set_levels(e_module, e_facility, e_level);
233 /* If 'arg' is null, configure maximum verbosity. Otherwise, sets
234 * configuration according to 'arg' (see vlog_set_levels_from_string()). */
236 vlog_set_verbosity(const char *arg)
239 char *msg = vlog_set_levels_from_string(arg);
241 fatal(0, "processing \"%s\": %s", arg, msg);
244 vlog_set_levels(VLM_ANY_MODULE, VLF_ANY_FACILITY, VLL_DBG);
248 /* Initializes the logging subsystem. */
254 openlog(program_name, LOG_NDELAY, LOG_DAEMON);
255 vlog_set_levels(VLM_ANY_MODULE, VLF_ANY_FACILITY, VLL_WARN);
262 localtime_r(&now, &tm);
263 strftime(s, sizeof s, "%a, %d %b %Y %H:%M:%S %z", &tm);
264 VLOG_ERR("current time is negative: %s (%ld)", s, (long int) now);
268 /* Closes the logging subsystem. */
275 /* Print the current logging level for each module. */
277 vlog_get_levels(void)
279 struct ds s = DS_EMPTY_INITIALIZER;
280 enum vlog_module module;
282 ds_put_format(&s, " console syslog\n");
283 ds_put_format(&s, " ------- ------\n");
285 for (module = 0; module < VLM_N_MODULES; module++) {
286 ds_put_format(&s, "%-16s %4s %4s\n",
287 vlog_get_module_name(module),
288 vlog_get_level_name(vlog_get_level(module, VLF_CONSOLE)),
289 vlog_get_level_name(vlog_get_level(module, VLF_SYSLOG)));
295 /* Returns true if a log message emitted for the given 'module' and 'level'
296 * would cause some log output, false if that module and level are completely
299 vlog_is_enabled(enum vlog_module module, enum vlog_level level)
301 return (levels[module][VLF_CONSOLE] >= level
302 || levels[module][VLF_SYSLOG] >= level);
305 /* Writes 'message' to the log at the given 'level' and as coming from the
308 * Guaranteed to preserve errno. */
310 vlog(enum vlog_module module, enum vlog_level level, const char *message, ...)
312 bool log_console = levels[module][VLF_CONSOLE] >= level;
313 bool log_syslog = levels[module][VLF_SYSLOG] >= level;
314 if (log_console || log_syslog) {
315 int save_errno = errno;
317 const char *module_name = vlog_get_module_name(module);
318 const char *level_name = vlog_get_level_name(level);
323 size_t len, time_len;
326 localtime_r(&now, &tm);
328 len = time_len = strftime(s, sizeof s, "%b %d %H:%M:%S|", &tm);
329 len += sprintf(s + len, "%05d|%s|%s:",
330 ++msg_num, module_name, level_name);
331 va_start(args, message);
332 len += vsnprintf(s + len, sizeof s - len, message, args);
334 if (len >= sizeof s) {
337 if (s[len - 1] == '\n') {
342 fprintf(stderr, "%s\n", s);
346 static const int syslog_levels[VLL_N_LEVELS] = {
347 [VLL_EMER] = LOG_EMERG,
349 [VLL_WARN] = LOG_WARNING,
350 [VLL_DBG] = LOG_DEBUG,
353 syslog(syslog_levels[level], "%s", s + time_len);