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.
45 #include "dynamic-string.h"
48 #define THIS_MODULE VLM_vlog
50 /* Name for each logging level. */
51 static const char *level_names[VLL_N_LEVELS] = {
58 /* Name for each logging facility. */
59 static const char *facility_names[VLF_N_FACILITIES] = {
60 [VLF_CONSOLE] = "console",
61 [VLF_SYSLOG] = "syslog",
64 /* Name for each logging module */
65 static const char *module_names[VLM_N_MODULES] = {
66 #define VLOG_MODULE(NAME) #NAME,
71 static int levels[VLM_N_MODULES][VLF_N_FACILITIES];
73 /* Searches the 'n_names' in 'names'. Returns the index of a match for
74 * 'target', or 'n_names' if no name matches. */
76 search_name_array(const char *target, const char **names, size_t n_names)
80 for (i = 0; i < n_names; i++) {
82 if (!strcasecmp(names[i], target)) {
89 /* Returns the name for logging level 'level'. */
91 vlog_get_level_name(enum vlog_level level)
93 assert(level < VLL_N_LEVELS);
94 return level_names[level];
97 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
98 * is not the name of a logging level. */
100 vlog_get_level_val(const char *name)
102 return search_name_array(name, level_names, ARRAY_SIZE(level_names));
105 /* Returns the name for logging facility 'facility'. */
107 vlog_get_facility_name(enum vlog_facility facility)
109 assert(facility < VLF_N_FACILITIES);
110 return facility_names[facility];
113 /* Returns the logging facility named 'name', or VLF_N_FACILITIES if 'name' is
114 * not the name of a logging facility. */
116 vlog_get_facility_val(const char *name)
118 return search_name_array(name, facility_names, ARRAY_SIZE(facility_names));
121 /* Returns the name for logging module 'module'. */
122 const char *vlog_get_module_name(enum vlog_module module)
124 assert(module < VLM_N_MODULES);
125 return module_names[module];
128 /* Returns the logging module named 'name', or VLM_N_MODULES if 'name' is not
129 * the name of a logging module. */
131 vlog_get_module_val(const char *name)
133 return search_name_array(name, module_names, ARRAY_SIZE(module_names));
136 /* Returns the current logging level for the given 'module' and 'facility'. */
138 vlog_get_level(enum vlog_module module, enum vlog_facility facility)
140 assert(module < VLM_N_MODULES);
141 assert(facility < VLF_N_FACILITIES);
142 return levels[module][facility];
146 set_facility_level(enum vlog_facility facility, enum vlog_module module,
147 enum vlog_level level)
149 assert(facility >= 0 && facility < VLF_N_FACILITIES);
150 assert(level < VLL_N_LEVELS);
152 if (module == VLM_ANY_MODULE) {
153 for (module = 0; module < VLM_N_MODULES; module++) {
154 levels[module][facility] = level;
157 levels[module][facility] = level;
161 /* Sets the logging level for the given 'module' and 'facility' to 'level'. */
163 vlog_set_levels(enum vlog_module module, enum vlog_facility facility,
164 enum vlog_level level)
166 assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
167 if (facility == VLF_ANY_FACILITY) {
168 for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
169 set_facility_level(facility, module, level);
172 set_facility_level(facility, module, level);
176 /* Set debugging levels:
178 * mod[:facility[:level]] mod2[:facility[:level]] ...
180 * Return null if successful, otherwise an error message that the caller must
184 vlog_set_levels_from_string(const char *s_)
187 char *s = xstrdup(s_);
188 char *module, *level, *facility;
190 for (module = strtok_r(s, ": \t", &save_ptr); module != NULL;
191 module = strtok_r(NULL, ": \t", &save_ptr)) {
192 enum vlog_module e_module;
193 enum vlog_level e_level;
194 enum vlog_facility e_facility;
196 facility = strtok_r(NULL, ":", &save_ptr);
197 level = strtok_r(NULL, ":", &save_ptr);
199 if (!strcmp(module, "ANY")) {
200 e_module = VLM_ANY_MODULE;
202 e_module = vlog_get_module_val(module);
203 if (e_module >= VLM_N_MODULES) {
204 char *msg = xasprintf("unknown module \"%s\"", module);
210 if (!facility || !strcmp(facility, "ANY")) {
211 e_facility = VLF_ANY_FACILITY;
213 e_facility = vlog_get_facility_val(facility);
214 if (e_facility >= VLF_N_FACILITIES) {
215 char *msg = xasprintf("unknown facility \"%s\"", facility);
221 e_level = level ? vlog_get_level_val(level) : VLL_DBG;
222 if (e_level >= VLL_N_LEVELS) {
223 char *msg = xasprintf("unknown level \"%s\"", level);
228 vlog_set_levels(e_module, e_facility, e_level);
234 /* If 'arg' is null, configure maximum verbosity. Otherwise, sets
235 * configuration according to 'arg' (see vlog_set_levels_from_string()). */
237 vlog_set_verbosity(const char *arg)
240 char *msg = vlog_set_levels_from_string(arg);
242 fatal(0, "processing \"%s\": %s", arg, msg);
245 vlog_set_levels(VLM_ANY_MODULE, VLF_ANY_FACILITY, VLL_DBG);
249 /* Initializes the logging subsystem. */
255 openlog(program_name, LOG_NDELAY, LOG_DAEMON);
256 vlog_set_levels(VLM_ANY_MODULE, VLF_ANY_FACILITY, VLL_WARN);
263 localtime_r(&now, &tm);
264 strftime(s, sizeof s, "%a, %d %b %Y %H:%M:%S %z", &tm);
265 VLOG_ERR("current time is negative: %s (%ld)", s, (long int) now);
269 /* Closes the logging subsystem. */
276 /* Print the current logging level for each module. */
278 vlog_get_levels(void)
280 struct ds s = DS_EMPTY_INITIALIZER;
281 enum vlog_module module;
283 ds_put_format(&s, " console syslog\n");
284 ds_put_format(&s, " ------- ------\n");
286 for (module = 0; module < VLM_N_MODULES; module++) {
287 ds_put_format(&s, "%-16s %4s %4s\n",
288 vlog_get_module_name(module),
289 vlog_get_level_name(vlog_get_level(module, VLF_CONSOLE)),
290 vlog_get_level_name(vlog_get_level(module, VLF_SYSLOG)));
296 /* Returns true if a log message emitted for the given 'module' and 'level'
297 * would cause some log output, false if that module and level are completely
300 vlog_is_enabled(enum vlog_module module, enum vlog_level level)
302 return (levels[module][VLF_CONSOLE] >= level
303 || levels[module][VLF_SYSLOG] >= level);
306 /* Writes 'message' to the log at the given 'level' and as coming from the
309 * Guaranteed to preserve errno. */
311 vlog(enum vlog_module module, enum vlog_level level, const char *message, ...)
313 bool log_console = levels[module][VLF_CONSOLE] >= level;
314 bool log_syslog = levels[module][VLF_SYSLOG] >= level;
315 if (log_console || log_syslog) {
316 int save_errno = errno;
318 const char *module_name = vlog_get_module_name(module);
319 const char *level_name = vlog_get_level_name(level);
324 size_t len, time_len;
327 localtime_r(&now, &tm);
329 len = time_len = strftime(s, sizeof s, "%b %d %H:%M:%S|", &tm);
330 len += sprintf(s + len, "%05d|%s|%s:",
331 ++msg_num, module_name, level_name);
332 va_start(args, message);
333 len += vsnprintf(s + len, sizeof s - len, message, args);
335 if (len >= sizeof s) {
338 if (s[len - 1] == '\n') {
343 fprintf(stderr, "%s\n", s);
347 static const int syslog_levels[VLL_N_LEVELS] = {
348 [VLL_EMER] = LOG_ALERT,
350 [VLL_WARN] = LOG_WARNING,
351 [VLL_DBG] = LOG_DEBUG,
353 char *line, *save_ptr;
355 for (line = strtok_r(s + time_len, "\n", &save_ptr); line != NULL;
356 line = strtok_r(NULL, "\n", &save_ptr)) {
357 syslog(syslog_levels[level], "%s", line);