X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=lib%2Fvlog.h;h=3f40c297dbbe736197a9841e1316777d9a7ff841;hb=184b5de475ea6dcb91d4e89271303af04e75f7de;hp=a4e143c1b2dca64bd593a34859bff39fa416bd9f;hpb=5136364f41b74de00f86873a6f5be4c8a19cb5ad;p=openvswitch diff --git a/lib/vlog.h b/lib/vlog.h index a4e143c1..3f40c297 100644 --- a/lib/vlog.h +++ b/lib/vlog.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010 Nicira Networks. + * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,13 +21,34 @@ #include #include #include +#include "compiler.h" #include "util.h" #ifdef __cplusplus extern "C" { #endif -/* Logging importance levels. */ +/* Logging importance levels. + * + * The following log levels, in descending order of importance, are enabled by + * default: + * + * - EMER: Not currently used. + * + * - ERR: A high-level operation or a subsystem failed. Attention is + * warranted. + * + * - WARN: A low-level operation failed, but higher-level subsystems may be + * able to recover. + * + * - INFO: Information that may be useful in retrospect when investigating + * a problem. + * + * The lowest log level is not enabled by default: + * + * - DBG: Information useful only to someone with intricate knowledge of the + * system, or that would commonly cause too-voluminous log output. + */ #define VLOG_LEVELS \ VLOG_LEVEL(EMER, LOG_ALERT) \ VLOG_LEVEL(ERR, LOG_ERR) \ @@ -71,10 +92,11 @@ struct vlog_module { #if USE_LINKER_SECTIONS #define VLOG_DEFINE_MODULE(MODULE) \ VLOG_DEFINE_MODULE__(MODULE) \ + extern struct vlog_module *vlog_module_ptr_##MODULE; \ struct vlog_module *vlog_module_ptr_##MODULE \ - __attribute__((section("vlog_modules"))) = &VLM_##MODULE; + __attribute__((section("vlog_modules"))) = &VLM_##MODULE #else -#define VLOG_DEFINE_MODULE(MODULE) extern struct vlog_module VLM_##MODULE; +#define VLOG_DEFINE_MODULE(MODULE) extern struct vlog_module VLM_##MODULE #endif const char *vlog_get_module_name(const struct vlog_module *); @@ -128,24 +150,34 @@ const char *vlog_get_log_file(void); int vlog_set_log_file(const char *file_name); int vlog_reopen_log_file(void); -/* Function for actual logging. */ +/* Initialization. */ void vlog_init(void); void vlog_exit(void); + +/* Functions for actual logging. */ void vlog(const struct vlog_module *, enum vlog_level, const char *format, ...) - __attribute__((format(printf, 3, 4))); + PRINTF_FORMAT (3, 4); void vlog_valist(const struct vlog_module *, enum vlog_level, const char *, va_list) - __attribute__((format(printf, 3, 0))); + PRINTF_FORMAT (3, 0); + +void vlog_fatal(const struct vlog_module *, enum vlog_level, + const char *format, ...) + PRINTF_FORMAT (3, 4) NO_RETURN; +void vlog_fatal_valist(const struct vlog_module *, enum vlog_level, + const char *, va_list) + PRINTF_FORMAT (3, 0) NO_RETURN; + void vlog_rate_limit(const struct vlog_module *, enum vlog_level, struct vlog_rate_limit *, const char *, ...) - __attribute__((format(printf, 4, 5))); + PRINTF_FORMAT (4, 5); /* Creates and initializes a global instance of a module named MODULE, and * defines a static variable named THIS_MODULE that points to it, for use with * the convenience macros below. */ #define VLOG_DEFINE_THIS_MODULE(MODULE) \ - VLOG_DEFINE_MODULE(MODULE) \ - static struct vlog_module *const THIS_MODULE = &VLM_##MODULE; + VLOG_DEFINE_MODULE(MODULE); \ + static struct vlog_module *const THIS_MODULE = &VLM_##MODULE /* Convenience macros. These assume that THIS_MODULE points to a "struct * vlog_module" for the current module, as set up by e.g. the @@ -153,6 +185,7 @@ void vlog_rate_limit(const struct vlog_module *, enum vlog_level, * * Guaranteed to preserve errno. */ +#define VLOG_FATAL(...) vlog_fatal(THIS_MODULE, VLL_ERR, __VA_ARGS__) #define VLOG_EMER(...) VLOG(VLL_EMER, __VA_ARGS__) #define VLOG_ERR(...) VLOG(VLL_ERR, __VA_ARGS__) #define VLOG_WARN(...) VLOG(VLL_WARN, __VA_ARGS__) @@ -190,8 +223,8 @@ void vlog_rate_limit(const struct vlog_module *, enum vlog_level, /* Command line processing. */ #define VLOG_OPTION_ENUMS OPT_LOG_FILE #define VLOG_LONG_OPTIONS \ - {"verbose", optional_argument, 0, 'v'}, \ - {"log-file", optional_argument, 0, OPT_LOG_FILE} + {"verbose", optional_argument, NULL, 'v'}, \ + {"log-file", optional_argument, NULL, OPT_LOG_FILE} #define VLOG_OPTION_HANDLERS \ case 'v': \ vlog_set_verbosity(optarg); \ @@ -202,16 +235,18 @@ void vlog_rate_limit(const struct vlog_module *, enum vlog_level, void vlog_usage(void); /* Implementation details. */ -#define VLOG(LEVEL, ...) \ - do { \ - if (THIS_MODULE->min_level >= LEVEL) { \ - vlog(THIS_MODULE, LEVEL, __VA_ARGS__); \ - } \ +#define VLOG(LEVEL, ...) \ + do { \ + enum vlog_level level__ = LEVEL; \ + if (THIS_MODULE->min_level >= level__) { \ + vlog(THIS_MODULE, level__, __VA_ARGS__); \ + } \ } while (0) #define VLOG_RL(RL, LEVEL, ...) \ do { \ - if (THIS_MODULE->min_level >= LEVEL) { \ - vlog_rate_limit(THIS_MODULE, LEVEL, RL, __VA_ARGS__); \ + enum vlog_level level__ = LEVEL; \ + if (THIS_MODULE->min_level >= level__) { \ + vlog_rate_limit(THIS_MODULE, level__, RL, __VA_ARGS__); \ } \ } while (0) #define VLOG_ONCE(LEVEL, ...) \ @@ -224,6 +259,7 @@ void vlog_usage(void); } while (0) #define VLOG_DEFINE_MODULE__(MODULE) \ + extern struct vlog_module VLM_##MODULE; \ struct vlog_module VLM_##MODULE = \ { \ #MODULE, /* name */ \