pintos-os.org Git - openvswitch/blob - lib/vlog.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   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:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  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
  27  * SOFTWARE.
  28  *
  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.
  32  */
  33
  34 #include "vlog.h"
  35 #include <assert.h>
  36 #include <errno.h>
  37 #include <stdarg.h>
  38 #include <stdlib.h>
  39 #include <string.h>
  40 #include <sys/ipc.h>
  41 #include <sys/shm.h>
  42 #include <syslog.h>
  43 #include <time.h>
  44 #include "dynamic-string.h"
  45 #include "util.h"
  46
  47 /* Name for each logging level. */
  48 static const char *level_names[VLL_N_LEVELS] = {
  49     [VLL_EMER] = "EMER",
  50     [VLL_ERR] = "ERR",
  51     [VLL_WARN] = "WARN",
  52     [VLL_DBG] = "DBG",
  53 };
  54
  55 /* Name for each logging facility. */
  56 static const char *facility_names[VLF_N_FACILITIES] = {
  57     [VLF_CONSOLE] = "console",
  58     [VLF_SYSLOG] = "syslog",
  59 };
  60
  61 /* Name for each logging module */
  62 static const char *module_names[VLM_N_MODULES] = {
  63 #define VLOG_MODULE(NAME) #NAME,
  64     VLOG_MODULES
  65 #undef VLOG_MODULES
  66 };
  67
  68 static int levels[VLM_N_MODULES][VLF_N_FACILITIES];
  69
  70 /* Searches the 'n_names' in 'names'.  Returns the index of a match for
  71  * 'target', or 'n_names' if no name matches. */
  72 static size_t
  73 search_name_array(const char *target, const char **names, size_t n_names)
  74 {
  75     size_t i;
  76
  77     for (i = 0; i < n_names; i++) {
  78         assert(names[i]);
  79         if (!strcasecmp(names[i], target)) {
  80             break;
  81         }
  82     }
  83     return i;
  84 }
  85
  86 /* Returns the name for logging level 'level'. */
  87 const char *
  88 vlog_get_level_name(enum vlog_level level)
  89 {
  90     assert(level < VLL_N_LEVELS);
  91     return level_names[level];
  92 }
  93
  94 /* Returns the logging level with the given 'name', or VLL_N_LEVELS if 'name'
  95  * is not the name of a logging level. */
  96 enum vlog_level
  97 vlog_get_level_val(const char *name)
  98 {
  99     return search_name_array(name, level_names, ARRAY_SIZE(level_names));
 100 }
 101
 102 /* Returns the name for logging facility 'facility'. */
 103 const char *
 104 vlog_get_facility_name(enum vlog_facility facility)
 105 {
 106     assert(facility < VLF_N_FACILITIES);
 107     return facility_names[facility];
 108 }
 109
 110 /* Returns the logging facility named 'name', or VLF_N_FACILITIES if 'name' is
 111  * not the name of a logging facility. */
 112 enum vlog_facility
 113 vlog_get_facility_val(const char *name)
 114 {
 115     return search_name_array(name, facility_names, ARRAY_SIZE(facility_names));
 116 }
 117
 118 /* Returns the name for logging module 'module'. */
 119 const char *vlog_get_module_name(enum vlog_module module)
 120 {
 121     assert(module < VLM_N_MODULES);
 122     return module_names[module];
 123 }
 124
 125 /* Returns the logging module named 'name', or VLM_N_MODULES if 'name' is not
 126  * the name of a logging module. */
 127 enum vlog_module
 128 vlog_get_module_val(const char *name)
 129 {
 130     return search_name_array(name, module_names, ARRAY_SIZE(module_names));
 131 }
 132
 133 /* Returns the current logging level for the given 'module' and 'facility'. */
 134 enum vlog_level
 135 vlog_get_level(enum vlog_module module, enum vlog_facility facility)
 136 {
 137     assert(module < VLM_N_MODULES);
 138     assert(facility < VLF_N_FACILITIES);
 139     return levels[module][facility];
 140 }
 141
 142 static void
 143 set_facility_level(enum vlog_facility facility, enum vlog_module module,
 144                    enum vlog_level level)
 145 {
 146     assert(facility >= 0 && facility < VLF_N_FACILITIES);
 147     assert(level < VLL_N_LEVELS);
 148
 149     if (module == VLM_ANY_MODULE) {
 150         for (module = 0; module < VLM_N_MODULES; module++) {
 151             levels[module][facility] = level;
 152         }
 153     } else {
 154         levels[module][facility] = level;
 155     }
 156 }
 157
 158 /* Sets the logging level for the given 'module' and 'facility' to 'level'. */
 159 void
 160 vlog_set_levels(enum vlog_module module, enum vlog_facility facility,
 161                 enum vlog_level level)
 162 {
 163     assert(facility < VLF_N_FACILITIES || facility == VLF_ANY_FACILITY);
 164     if (facility == VLF_ANY_FACILITY) {
 165         for (facility = 0; facility < VLF_N_FACILITIES; facility++) {
 166             set_facility_level(facility, module, level);
 167         }
 168     } else {
 169         set_facility_level(facility, module, level);
 170     }
 171 }
 172
 173 /* Set debugging levels:
 174  *
 175  *  mod:facility:level mod2:facility:level ...
 176  *
 177  * Return null if successful, otherwise an error message that the caller must
 178  * free().
 179  */
 180 char *
 181 vlog_set_levels_from_string(const char *s_)
 182 {
 183     char *save_ptr;
 184     char *s = xstrdup(s_);
 185     char *module, *level, *facility;
 186
 187     for (module = strtok_r(s, ": \t", &save_ptr); module != NULL;
 188          module = strtok_r(NULL, ": \t", &save_ptr)) {
 189         enum vlog_module e_module;
 190         enum vlog_level e_level;
 191         enum vlog_facility e_facility;
 192
 193         facility = strtok_r(NULL, ":", &save_ptr);
 194         level = strtok_r(NULL, ":", &save_ptr);
 195         if (level == NULL || facility == NULL) {
 196             free(s);
 197             return xstrdup("syntax error in level string");
 198         }
 199
 200         if (!strcmp(module, "ANY")) {
 201             e_module = VLM_ANY_MODULE;
 202         } else {
 203             e_module = vlog_get_module_val(module);
 204             if (e_module >= VLM_N_MODULES) {
 205                 char *msg = xasprintf("unknown module \"%s\"", module);
 206                 free(s);
 207                 return msg;
 208             }
 209         }
 210
 211         if (!strcmp(facility, "ANY")) {
 212             e_facility = VLF_ANY_FACILITY;
 213         } else {
 214             e_facility = vlog_get_facility_val(facility);
 215             if (e_facility >= VLF_N_FACILITIES) {
 216                 char *msg = xasprintf("unknown facility \"%s\"", facility);
 217                 free(s);
 218                 return msg;
 219             }
 220         }
 221
 222         e_level = vlog_get_level_val(level);
 223         if (e_level >= VLL_N_LEVELS) {
 224             char *msg = xasprintf("unknown level \"%s\"", level);
 225             free(s);
 226             return msg;
 227         }
 228
 229         vlog_set_levels(e_module, e_facility, e_level);
 230     }
 231     free(s);
 232     return NULL;
 233 }
 234
 235 /* If 'arg' is null, configure maximum verbosity.  Otherwise, sets
 236  * configuration according to 'arg' (see vlog_set_levels_from_string()). */
 237 void
 238 vlog_set_verbosity(const char *arg)
 239 {
 240     if (arg) {
 241         char *msg = vlog_set_levels_from_string(arg);
 242         if (msg) {
 243             fatal(0, "processing \"%s\": %s", arg, msg);
 244         }
 245     } else {
 246         vlog_set_levels(VLM_ANY_MODULE, VLF_CONSOLE, VLL_DBG);
 247     }
 248 }
 249
 250 /* Initializes the logging subsystem. */
 251 void
 252 vlog_init(void)
 253 {
 254     openlog(program_name, LOG_NDELAY, LOG_DAEMON);
 255     vlog_set_levels(VLM_ANY_MODULE, VLF_CONSOLE, VLL_WARN);
 256 }
 257
 258 /* Closes the logging subsystem. */
 259 void
 260 vlog_exit(void)
 261 {
 262     closelog();
 263 }
 264
 265 /* Print the current logging level for each module. */
 266 char *
 267 vlog_get_levels(void)
 268 {
 269     struct ds s = DS_EMPTY_INITIALIZER;
 270     enum vlog_module module;
 271
 272     ds_put_format(&s, "                 console    syslog\n");
 273     ds_put_format(&s, "                 -------    ------\n");
 274
 275     for (module = 0; module < VLM_N_MODULES; module++) {
 276         ds_put_format(&s, "%-16s  %4s       %4s\n",
 277            vlog_get_module_name(module),
 278            vlog_get_level_name(vlog_get_level(module, VLF_CONSOLE)),
 279            vlog_get_level_name(vlog_get_level(module, VLF_SYSLOG)));
 280     }
 281
 282     return ds_cstr(&s);
 283 }
 284
 285 /* Returns true if a log message emitted for the given 'module' and 'level'
 286  * would cause some log output, false if that module and level are completely
 287  * disabled. */
 288 bool
 289 vlog_is_enabled(enum vlog_module module, enum vlog_level level)
 290 {
 291     return (levels[module][VLF_CONSOLE] >= level
 292             || levels[module][VLF_SYSLOG] >= level);
 293 }
 294
 295 /* Writes 'message' to the log at the given 'level' and as coming from the
 296  * given 'module'.
 297  *
 298  * Guaranteed to preserve errno. */
 299 void
 300 vlog(enum vlog_module module, enum vlog_level level, const char *message, ...)
 301 {
 302     bool log_console = levels[module][VLF_CONSOLE] >= level;
 303     bool log_syslog = levels[module][VLF_SYSLOG] >= level;
 304     if (log_console || log_syslog) {
 305         int save_errno = errno;
 306         static int msg_num;
 307         const char *module_name = vlog_get_module_name(module);
 308         const char *level_name = vlog_get_level_name(level);
 309         time_t now;
 310         struct tm tm;
 311         va_list args;
 312         char s[1024];
 313         size_t len, time_len;
 314
 315         now = time(0);
 316         localtime_r(&now, &tm);
 317
 318         len = time_len = strftime(s, sizeof s, "%b %d %H:%M:%S|", &tm);
 319         len += sprintf(s + len, "%05d|%s|%s:",
 320                        ++msg_num, module_name, level_name);
 321         va_start(args, message);
 322         len += vsnprintf(s + len, sizeof s - len, message, args);
 323         va_end(args);
 324         if (len >= sizeof s) {
 325             len = sizeof s;
 326         }
 327         if (s[len - 1] == '\n') {
 328             s[len - 1] = '\0';
 329         }
 330
 331         if (log_console) {
 332             fprintf(stderr, "%s\n", s);
 333         }
 334
 335         if (log_syslog) {
 336             static const int syslog_levels[VLL_N_LEVELS] = {
 337                 [VLL_EMER] = LOG_EMERG,
 338                 [VLL_ERR] = LOG_ERR,
 339                 [VLL_WARN] = LOG_WARNING,
 340                 [VLL_DBG] = LOG_DEBUG,
 341             };
 342
 343             syslog(syslog_levels[level], "%s", s + time_len);
 344         }
 345         errno = save_errno;
 346     }
 347 }