1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2010 Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * \brief Logging utility
37 #include <yaz/yconfig.h>
41 /** \brief log level: fatal */
42 #define YLOG_FATAL 0x00000001
43 /** \brief log level: debugging */
44 #define YLOG_DEBUG 0x00000002
45 /** \brief log level: warning */
46 #define YLOG_WARN 0x00000004
47 /** \brief log level: log (regular) */
48 #define YLOG_LOG 0x00000008
49 /** \brief log level: append system error message */
50 #define YLOG_ERRNO 0x00000010
51 /** \brief log level: application */
52 #define YLOG_APP 0x00000040
53 /** \brief log level: malloc debug */
54 #define YLOG_MALLOC 0x00000080
55 /** \brief log level: do not output date and time */
56 #define YLOG_NOTIME 0x00000100
57 /** \brief log level: application 2 */
58 #define YLOG_APP2 0x00000200
59 /** \brief log level: application 3 */
60 #define YLOG_APP3 0x00000400
61 /** \brief log level: flush */
62 #define YLOG_FLUSH 0x00000800
63 /** \brief dynamic log level start */
64 #define YLOG_LOGLVL 0x00001000 /* log when modules query log levels */
65 /* this has to be a hard-coded bit, not to loop*/
67 #define YLOG_ALL (0xffff&~YLOG_MALLOC&~YLOG_NOTIME)
69 /** \brief default log level */
70 #define YLOG_DEFAULT_LEVEL \
71 (YLOG_FATAL | YLOG_ERRNO | YLOG_LOG | YLOG_WARN | YLOG_FLUSH)
72 /* not having flush here confuses Solaris users, who won't see any logs until
73 * (and if) the program exits normally */
75 /** \brief last bit for regular log bits . Rest are dynamic */
76 #define YLOG_LAST_BIT YLOG_LOGLVL
78 /** \brief sets level, prefix and filename for logging
79 \param level log level
80 \param prefix log message prefix
83 If fname is NULL, the filename logging is not changed.
85 YAZ_EXPORT void yaz_log_init(int level, const char *prefix, const char *fname);
87 /** \brief sets log file
90 A filename of NULL makes the log to be completely disabled.
91 A filename which is the empty string ("") makes the system
92 log to stderr (which is also the default). Otherwise the
93 filename given is used.
95 YAZ_EXPORT void yaz_log_init_file(const char *fname);
97 /** \brief sets log level
98 \param level (combination of YLOG_..)
100 YAZ_EXPORT void yaz_log_init_level(int level);
102 /** \brief sets log message prefix
103 \param prefix log message prefix
105 YAZ_EXPORT void yaz_log_init_prefix(const char *prefix);
107 /** \brief sets second log message prefix
108 \param prefix log message prefix
110 YAZ_EXPORT void yaz_log_init_prefix2(const char *prefix);
112 /** \brief sets time format for log mesages
113 \param fmt format (strftime)
115 Sets the format of the timestamp. See man 3 strftime.
116 Calling with "old" sets to the old format "11:55:06-02/11"
117 Calling with NULL or "" sets to the new format "20041102-115719"
118 If not called at all, the old format is used, for backward compatibility
120 YAZ_EXPORT void yaz_log_time_format(const char *fmt);
122 /** \brief sets limit in bytes for size for log file
123 \param mx size in bytes
125 Sets the max size for a log file. Zero means no limit.
126 Negative means built-in limit (1GB)
128 YAZ_EXPORT void yaz_log_init_max_size(int mx);
130 /** \brief Writes log message
131 \param level log level mask
132 \param fmt format string ala printf
134 Writes an entry in the log. Defaults to stderr if not initialized or
135 to a file with yaz_log_init_file(). The level must match the level set
136 via yaz_log_init_level(), optionally defined via yaz_log_mask_str().
138 YAZ_EXPORT void yaz_log(int level, const char *fmt, ...)
140 __attribute__ ((format (printf, 2, 3)))
144 /** \brief converts log level string to log level (integer)
145 \param str log level string
146 \return log level mask
148 yaz_log_mask_str() converts a comma-separated list of log levels to a
149 bit mask. Starts from default level, and adds bits as specified,
150 unless 'none' is specified, which clears the list. If a name matches
151 the name of a YLOG_BIT above, that one is set. Otherwise a new value is
152 picked, and given to that name, to be found with yaz_log_module_level()
154 YAZ_EXPORT int yaz_log_mask_str(const char *str);
156 /** \brief converts log level string to log level with "start" level
157 \param str log level string
158 \param level initialing log level
159 \return log level mask
161 yaz_log_mask_str_x() is like yaz_log_mask_str(), but with a given start
164 YAZ_EXPORT int yaz_log_mask_str_x(const char *str, int level);
166 /** \brief returns level for module
167 \param name module name
168 \returns log level for module
170 yaz_log_module_level() returns a log level mask corresponding to the
171 module name. If that had been specified on the -v arguments (that is
172 passed to yaz_log_mask_str()), then a non-zero mask is returned. If
173 not, we get a zero. This can later be used in yaz_log for the level
176 YAZ_EXPORT int yaz_log_module_level(const char *name);
178 /** \brief returns FILE handle for log or NULL if no file is in use
179 \retval FILE FILE handle in use (possibly stderr)
180 \retval NULL log is currently not written to a file
182 YAZ_EXPORT FILE *yaz_log_file(void);
184 /** \brief sets custom log handler
185 \param func custom log handler
186 \param info custom pointer to be passed to func handler
188 Allows log output to be captured to something else.. The
189 func parameter takes a log level, a message + custom pointer
191 YAZ_EXPORT void yaz_log_set_handler(void (*func)(int, const char *,
192 void *), void *info);
194 /** \brief reopen current log file (unless disabled or stderr)
196 YAZ_EXPORT void yaz_log_reopen(void);
198 /** \brief Truncate the log file */
199 YAZ_EXPORT void yaz_log_trunc(void);
201 /** \brief installs hook to be called before each log msg
202 \param func function to be called
203 \param info user data to be passed to function
205 YAZ_EXPORT void log_event_start(void (*func)(int level, const char *msg,
206 void *info), void *info);
208 /** \brief installs hook to be called after each log msg
209 \param func function to be called
210 \param info user data to be passed to function
212 YAZ_EXPORT void log_event_end(void (*func)(int level, const char *msg,
213 void *info), void *info);
215 /** \brief Makes Libxml2 and Libxslt log errors through yaz_log
216 \param prefix prefix to use for log messages (may be 0)
217 \param log_level log level to use for Libxml2/Libxslt messages
219 YAZ_EXPORT void yaz_log_xml_errors(const char *prefix, int log_level);
227 * c-file-style: "Stroustrup"
228 * indent-tabs-mode: nil
230 * vim: shiftwidth=4 tabstop=8 expandtab