2 * Copyright (C) 1995-2005, Index Data ApS
4 * Permission to use, copy, modify, distribute, and sell this software and
5 * its documentation, in whole or in part, for any purpose, is hereby granted,
8 * 1. This copyright and permission notice appear in all copies of the
9 * software and its documentation. Notices of copyright or attribution
10 * which appear at the beginning of any file must remain unchanged.
12 * 2. The name of Index Data or the individual authors may not be used to
13 * endorse or promote products derived from this software without specific
14 * prior written permission.
16 * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19 * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20 * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22 * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
26 * $Id: log.h,v 1.32 2005-01-15 19:47:09 adam Exp $
31 * \brief The old, deprecated header for log.c
38 #include <yaz/yconfig.h>
42 #define YLOG_FATAL 0x00000001
43 #define YLOG_DEBUG 0x00000002
44 #define YLOG_WARN 0x00000004
45 #define YLOG_LOG 0x00000008
46 #define YLOG_ERRNO 0x00000010 /* append strerror to message */
47 /*#define YLOG_FILE 0x00000020 */
48 /*#define YLOG_APP 0x00000040 */
49 /* Application level events (new-connection) */
50 #define YLOG_MALLOC 0x00000080 /* debugging mallocs */
51 #define YLOG_NOTIME 0x00000100 /* do not output date and time */
52 /* #define YLOG_APP2 0x00000200 */
53 /* Application-level events, such as api calls */
54 /* #define YLOG_APP3 0x00000400 */
55 /* For more application-level events */
56 #define YLOG_FLUSH 0x00000800 /* Flush log after every write (DEBUG does too) */
57 #define YLOG_LOGLVL 0x00001000 /* log when modules query log levels */
58 /* this has to be a hard-coded bit, not to loop*/
60 #define YLOG_ALL (0xffff&~YLOG_MALLOC&~YLOG_NOTIME)
62 #define YLOG_DEFAULT_LEVEL \
63 (YLOG_FATAL | YLOG_ERRNO | YLOG_LOG | YLOG_WARN | YLOG_FLUSH)
64 /* not having flush here confuses Solaris users, who won't see any logs until
65 * (and if) the program exits normally */
67 #define YLOG_LAST_BIT YLOG_LOGLVL /* the last bit used for regular log bits */
68 /* the rest are for dynamic modules */
72 * yaz_log_init is a shorthand for initializing the log level and prefixes */
73 YAZ_EXPORT void yaz_log_init(int level, const char *prefix, const char *name);
75 /** yaz_log_init_file sets the file name used for yaz_log */
76 YAZ_EXPORT void yaz_log_init_file(const char *fname);
78 /** yaz_log_init_level sets the logging level. Use an OR of the bits above */
79 YAZ_EXPORT void yaz_log_init_level(int level);
81 /** yaz_log_init_prefix sets the log prefix */
82 YAZ_EXPORT void yaz_log_init_prefix(const char *prefix);
84 /** yaz_log_init_prefix2 sets an optional second prefix */
85 YAZ_EXPORT void yaz_log_init_prefix2(const char *prefix);
88 * yaz_log_time_format sets the format of the timestamp. See man 3 strftime
89 * Calling with "old" sets to the old format "11:55:06-02/11"
90 * Calling with NULL or "" sets to the new format "20041102-115719"
91 * If not called at all, the old format is used, for backward compatibility
93 YAZ_EXPORT void yaz_log_time_format(const char *fmt);
96 * yaz_log_init_max_size sets the max size for a log file.
97 * zero means no limit. Negative means built-in limit (1GB)
99 YAZ_EXPORT void yaz_log_init_max_size(int mx);
102 * yaz_log writes an entry in the log. Defaults to stderr if not initialized
103 * to a file with yaz_log_init_file. The level must match the level set via
104 * yaz_log_init_level, optionally defined via yaz_log_mask_str. */
105 YAZ_EXPORT void yaz_log(int level, const char *fmt, ...)
107 __attribute__ ((format (printf, 2, 3)))
112 * yaz_log_mask_str converts a comma-separated list of log levels to a bit
113 * mask. Starts from default level, and adds bits as specified, unless 'none'
114 * is specified, which clears the list. If a name matches the name of a
115 * YLOG_BIT above, that one is set. Otherwise a new value is picked, and given
116 * to that name, to be found with yaz_log_module_level */
117 YAZ_EXPORT int yaz_log_mask_str(const char *str);
119 /** yaz_log_mask_str_x is like yaz_log_mask_str, but with a given start value*/
120 YAZ_EXPORT int yaz_log_mask_str_x(const char *str, int level);
124 * yaz_log_module_level returns a log level mask corresponding to the module
125 * name. If that had been specified on the -v arguments (that is, passed to
126 * yaz_log_mask_str), then a non-zero mask is returned. If not, we get a
127 * zero. This can later be used in yaz_log for the level argument
129 YAZ_EXPORT int yaz_log_module_level(const char *name);
131 /** yaz_log_file returns the file handle for yaz_log. */
132 YAZ_EXPORT FILE *yaz_log_file(void);
134 YAZ_EXPORT void log_event_start(void (*func)(int level, const char *msg, void *info),
136 YAZ_EXPORT void log_event_end(void (*func)(int level, const char *msg, void *info),
139 YAZ_EXPORT void yaz_log_reopen(void);
145 #include <yaz/xmalloc.h>
147 /* The old LOG_ bit names are here for compatibility only. They may
148 * conflict with bits defined in syslog.h, or other places. 'LOG'
149 * really is not such a good name. YLOG must be more unique
151 #define LOG_FATAL YLOG_FATAL
152 #define LOG_DEBUG YLOG_DEBUG
153 #define LOG_WARN YLOG_WARN
154 #define LOG_LOG YLOG_LOG /* Deprecated, use the modern dynamic log levels*/
155 #define LOG_ERRNO YLOG_ERRNO
156 #define LOG_FILE 0x00000020 /* Deprecated - no YLOG_ equivalent */
157 #define LOG_APP 0x00000040 /* Deprecated - no YLOG_ equivalent */
158 #define LOG_MALLOC YLOG_MALLOC /* deprecated */
159 #define LOG_NOTIME YLOG_NOTIME /* do not output date and time */
160 #define LOG_APP2 0x00000200 /* Deprecated - no YLOG_ equivalent */
161 #define LOG_APP3 0x00000400 /* Deprecated - no YLOG_ equivalent */
162 #define LOG_FLUSH YLOG_FLUSH
164 #define LOG_ALL YLOG_ALL
166 #define LOG_DEFAULT_LEVEL YLOG_DEFAULT_LEVEL
169 /* logf is deprecated, as it conflicts with a math function */
172 #endif /* if YAZ_USE_NEW_LOG */