X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Flog.h;h=2c9e8f9cfb6fcf4df45c9fba382107943f15337d;hp=0c3bcf9bfb62c5596e4c7c4c8107782c9b70ef8b;hb=3e818921e959b654fe072fc7419f1b7f89007b21;hpb=cbeb1227a16f62975115e1e9216ccf2724bfd046 diff --git a/include/yaz/log.h b/include/yaz/log.h index 0c3bcf9..2c9e8f9 100644 --- a/include/yaz/log.h +++ b/include/yaz/log.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 1995-2000, Index Data. + * Copyright (c) 1995-2004, Index Data. * * Permission to use, copy, modify, distribute, and sell this software and * its documentation, in whole or in part, for any purpose, is hereby granted, @@ -23,78 +23,12 @@ * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. * - * $Log: log.h,v $ - * Revision 1.4 2000-09-04 08:58:15 adam - * Added prefix yaz_ for most logging utility functions. - * - * Revision 1.3 2000/06/09 13:51:01 ian - * Added LOG_APP for logging application (Rather than code) events that might - * be useful when creating usage reports. - * - * Revision 1.2 2000/02/28 11:20:06 adam - * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL. - * - * Revision 1.1 1999/11/30 13:47:11 adam - * Improved installation. Moved header files to include/yaz. - * - * Revision 1.15 1999/08/27 09:40:32 adam - * Renamed logf function to yaz_log. Removed VC++ project files. - * - * Revision 1.14 1998/10/28 10:26:59 adam - * New functions log_init_file, log_init_level, log_init_prefix. - * - * Revision 1.13 1998/10/13 16:11:11 adam - * Added printf-format check for logf when using GNUC. - * - * Revision 1.12 1997/09/04 07:59:02 adam - * Added include of xmalloc.h. - * - * Revision 1.11 1997/09/01 08:49:48 adam - * New windows NT/95 port using MSV5.0. To export DLL functions the - * YAZ_EXPORT modifier was added. Defined in yconfig.h. - * - * Revision 1.10 1997/05/14 06:53:40 adam - * C++ support. - * - * Revision 1.9 1997/05/01 15:06:42 adam - * Added log_mask_str_x routine. - * - * Revision 1.8 1996/05/01 12:45:00 quinn - * *** empty log message *** - * - * Revision 1.7 1996/02/05 12:24:26 adam - * Implemented log_event_{start,end}-functions. - * - * Revision 1.6 1995/10/10 16:27:06 quinn - * *** empty log message *** - * - * Revision 1.5 1995/09/29 17:12:03 quinn - * Smallish - * - * Revision 1.4 1995/09/27 15:02:47 quinn - * Modified function heads & prototypes. - * - * Revision 1.3 1995/06/19 12:38:25 quinn - * Reorganized include-files. Added small features. - * - * Revision 1.2 1995/05/16 08:50:31 quinn - * License, documentation, and memory fixes - * - * Revision 1.1 1995/03/30 09:39:41 quinn - * Moved .h files to include directory - * - * Revision 1.4 1994/09/28 13:07:22 adam - * Added log_mask_str. - * - * Revision 1.3 1994/08/18 08:18:45 quinn - * Added prefix to log_init. - * - * Revision 1.2 1994/08/17 14:27:46 quinn - * added LOG_ERRNO - * - * Revision 1.1 1994/08/17 13:22:52 quinn - * First version - * + * $Id: log.h,v 1.31 2004-12-20 15:52:53 heikki Exp $ + */ + +/** + * \file log.h + * \brief The old, deprecated header for log.c */ #ifndef LOG_H @@ -102,43 +36,141 @@ #include #include -#include YAZ_BEGIN_CDECL -#define LOG_FATAL 0x0001 -#define LOG_DEBUG 0x0002 -#define LOG_WARN 0x0004 -#define LOG_LOG 0x0008 -#define LOG_ERRNO 0x0010 /* append strerror to message */ -#define LOG_FILE 0x0020 -#define LOG_APP 0x0040 /* For application level events such as new-connection */ +#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 LOG_ALL 0xffff +#define YLOG_ALL (0xffff&~YLOG_MALLOC&~YLOG_NOTIME) -#define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN) +#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 */ -#define logf yaz_log +/** + * 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_EXPORT void yaz_log_init_file (const char *fname); -YAZ_EXPORT void yaz_log_init_level (int level); -YAZ_EXPORT void yaz_log_init_prefix (const char *prefix); +/** 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_EXPORT int yaz_log_mask_str (const char *str); -YAZ_EXPORT int yaz_log_mask_str_x (const char *str, int level); + +/** + * 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), +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), +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 + */ +#define LOG_FATAL YLOG_FATAL +#define LOG_DEBUG YLOG_DEBUG +#define LOG_WARN YLOG_WARN +#define LOG_LOG YLOG_LOG /* Deprecated, use the modern dynamic log levels*/ +#define LOG_ERRNO YLOG_ERRNO +#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 0x00000200 /* Deprecated - no YLOG_ equivalent */ +#define LOG_APP3 0x00000400 /* Deprecated - no YLOG_ equivalent */ +#define LOG_FLUSH YLOG_FLUSH + +#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