X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Flog.h;h=2c9e8f9cfb6fcf4df45c9fba382107943f15337d;hp=a7bd8bf39df6a3f65dbb041eaad162c2a4139e94;hb=3e818921e959b654fe072fc7419f1b7f89007b21;hpb=3b96525a40981e162b959f3e842e0ff20e314320 diff --git a/include/yaz/log.h b/include/yaz/log.h index a7bd8bf..2c9e8f9 100644 --- a/include/yaz/log.h +++ b/include/yaz/log.h @@ -23,7 +23,7 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Id: log.h,v 1.20 2004-11-18 15:18:13 heikki Exp $ + * $Id: log.h,v 1.31 2004-12-20 15:52:53 heikki Exp $ */ /** @@ -34,15 +34,116 @@ #ifndef LOG_H #define LOG_H -#include -#warning "use of log.h is deprecated, use logf.h instead" - #include #include -#include YAZ_BEGIN_CDECL +#define YLOG_FATAL 0x00000001 +#define YLOG_DEBUG 0x00000002 +#define YLOG_WARN 0x00000004 +#define YLOG_LOG 0x00000008 +#define YLOG_ERRNO 0x00000010 /* append strerror to message */ +/*#define YLOG_FILE 0x00000020 */ +/*#define YLOG_APP 0x00000040 */ + /* Application level events (new-connection) */ +#define YLOG_MALLOC 0x00000080 /* debugging mallocs */ +#define YLOG_NOTIME 0x00000100 /* do not output date and time */ +/* #define YLOG_APP2 0x00000200 */ + /* Application-level events, such as api calls */ +/* #define YLOG_APP3 0x00000400 */ + /* For more application-level events */ +#define YLOG_FLUSH 0x00000800 /* Flush log after every write (DEBUG does too) */ +#define YLOG_LOGLVL 0x00001000 /* log when modules query log levels */ + /* this has to be a hard-coded bit, not to loop*/ + +#define YLOG_ALL (0xffff&~YLOG_MALLOC&~YLOG_NOTIME) + +#define YLOG_DEFAULT_LEVEL \ + (YLOG_FATAL | YLOG_ERRNO | YLOG_LOG | YLOG_WARN | YLOG_FLUSH) +/* not having flush here confuses Solaris users, who won't see any logs until + * (and if) the program exits normally */ + +#define YLOG_LAST_BIT YLOG_LOGLVL /* the last bit used for regular log bits */ + /* the rest are for dynamic modules */ + + +/** + * yaz_log_init is a shorthand for initializing the log level and prefixes */ +YAZ_EXPORT void yaz_log_init(int level, const char *prefix, const char *name); + +/** yaz_log_init_file sets the file name used for yaz_log */ +YAZ_EXPORT void yaz_log_init_file(const char *fname); + +/** yaz_log_init_level sets the logging level. Use an OR of the bits above */ +YAZ_EXPORT void yaz_log_init_level(int level); + +/** yaz_log_init_prefix sets the log prefix */ +YAZ_EXPORT void yaz_log_init_prefix(const char *prefix); + +/** yaz_log_init_prefix2 sets an optional second prefix */ +YAZ_EXPORT void yaz_log_init_prefix2(const char *prefix); + +/** + * yaz_log_time_format sets the format of the timestamp. See man 3 strftime + * Calling with "old" sets to the old format "11:55:06-02/11" + * Calling with NULL or "" sets to the new format "20041102-115719" + * If not called at all, the old format is used, for backward compatibility + */ +YAZ_EXPORT void yaz_log_time_format(const char *fmt); + +/** + * yaz_log_init_max_size sets the max size for a log file. + * zero means no limit. Negative means built-in limit (1GB) + */ +YAZ_EXPORT void yaz_log_init_max_size(int mx); + +/** + * yaz_log writes an entry in the log. Defaults to stderr if not initialized + * to a file with yaz_log_init_file. The level must match the level set via + * yaz_log_init_level, optionally defined via yaz_log_mask_str. */ +YAZ_EXPORT void yaz_log(int level, const char *fmt, ...) +#ifdef __GNUC__ + __attribute__ ((format (printf, 2, 3))) +#endif + ; + +/** + * yaz_log_mask_str converts a comma-separated list of log levels to a bit + * mask. Starts from default level, and adds bits as specified, unless 'none' + * is specified, which clears the list. If a name matches the name of a + * YLOG_BIT above, that one is set. Otherwise a new value is picked, and given + * to that name, to be found with yaz_log_module_level */ +YAZ_EXPORT int yaz_log_mask_str(const char *str); + +/** yaz_log_mask_str_x is like yaz_log_mask_str, but with a given start value*/ +YAZ_EXPORT int yaz_log_mask_str_x(const char *str, int level); + + +/** + * yaz_log_module_level returns a log level mask corresponding to the module + * name. If that had been specified on the -v arguments (that is, passed to + * yaz_log_mask_str), then a non-zero mask is returned. If not, we get a + * zero. This can later be used in yaz_log for the level argument + */ +YAZ_EXPORT int yaz_log_module_level(const char *name); + +/** yaz_log_file returns the file handle for yaz_log. */ +YAZ_EXPORT FILE *yaz_log_file(void); + +YAZ_EXPORT void log_event_start(void (*func)(int level, const char *msg, void *info), + void *info); +YAZ_EXPORT void log_event_end(void (*func)(int level, const char *msg, void *info), + void *info); + +YAZ_EXPORT void yaz_log_reopen(void); + +#if YAZ_USE_NEW_LOG + +#else + +#include + /* The old LOG_ bit names are here for compatibility only. They may * conflict with bits defined in syslog.h, or other places. 'LOG' * really is not such a good name. YLOG must be more unique @@ -52,19 +153,24 @@ YAZ_BEGIN_CDECL #define LOG_WARN YLOG_WARN #define LOG_LOG YLOG_LOG /* Deprecated, use the modern dynamic log levels*/ #define LOG_ERRNO YLOG_ERRNO - /* LOG_FILE discontinued */ -#define LOG_APP YLOG_APP /* Deprecated */ - /* LOG_MALLOC discontinued */ +#define LOG_FILE 0x00000020 /* Deprecated - no YLOG_ equivalent */ +#define LOG_APP 0x00000040 /* Deprecated - no YLOG_ equivalent */ +#define LOG_MALLOC YLOG_MALLOC /* deprecated */ #define LOG_NOTIME YLOG_NOTIME /* do not output date and time */ -#define LOG_APP2 YLOG_APP2 /* deprecated */ -#define LOG_APP3 YLOG_APP3 /* deprecated */ +#define LOG_APP2 0x00000200 /* Deprecated - no YLOG_ equivalent */ +#define LOG_APP3 0x00000400 /* Deprecated - no YLOG_ equivalent */ #define LOG_FLUSH YLOG_FLUSH - /* LOG_LOGLVL so new that nobody should be using it. */ #define LOG_ALL YLOG_ALL #define LOG_DEFAULT_LEVEL YLOG_DEFAULT_LEVEL +/* logf is deprecated, as it conflicts with a math function */ +#define logf yaz_log + +#endif /* if YAZ_USE_NEW_LOG */ + +YAZ_END_CDECL #endif