2 * UCW Library -- Logging
4 * (c) 1997--2009 Martin Mares <mj@ucw.cz>
5 * (c) 2008 Tomas Gavenciak <gavento@ucw.cz>
7 * This software may be freely distributed and used according to the terms
8 * of the GNU Lesser General Public License.
14 #include "ucw/clists.h"
16 /*** === Messages and streams ***/
19 * Inside the logging system, a log message is always represented by this structure.
22 char *m; // The formatted message itself, ending with \n\0
23 int m_len; // Length without the \0
24 struct tm *tm; // Current time
25 uns flags; // Category and other flags as passed to msg()
26 char *raw_msg; // Unformatted parts
32 * Each stream is represented by an instance of this structure.
35 char *name; // Optional name, allocated by the user (or constructor)
36 int regnum; // Stream number, already encoded by LS_SET_STRNUM(); -1 if closed
37 uns levels; // Bitmask of accepted severity levels (default: all)
38 uns msgfmt; // Formatting flags (LSFMT_xxx)
39 uns use_count; // Number of references to the stream
40 uns stream_flags; // Various other flags (LSFLAG_xxx)
41 int (*filter)(struct log_stream* ls, struct log_msg *m); // Filter function, return non-zero to discard the message
42 clist substreams; // Pass the message to these streams (simple_list of pointers)
43 int (*handler)(struct log_stream *ls, struct log_msg *m); // Called to commit the message, return 0 for success, errno on error
44 void (*close)(struct log_stream* ls); // Called upon log_close_stream()
45 // Private data of the handler follow
49 * Formatting flags specifying the format of the message passed to the handler.
52 LSFMT_LEVEL = 1, // severity level (one letter) */
53 LSFMT_TIME = 2, // date and time (YYYY-mm-dd HH:MM:SS) */
54 LSFMT_USEC = 4, // also micro-seconds */
55 LSFMT_TITLE = 8, // program title (log_title) */
56 LSFMT_PID = 16, // program PID (log_pid) */
57 LSFMT_LOGNAME = 32, // name of the log_stream */
60 #define LSFMT_DEFAULT (LSFMT_LEVEL | LSFMT_TIME | LSFMT_TITLE | LSFMT_PID) /** Default format **/
63 * General stream flags.
66 LSFLAG_ERR_IS_FATAL = 1, // When a logging error occurs, die() immediately
67 LSFLAG_ERR_REPORTED = 2, // A logging error has been already reported on this stream
70 // Return the letter associated with a given severity level
71 #define LS_LEVEL_LETTER(level) ("DIiWwEe!###"[( level )])
76 * The @flags parameter of msg() is divided to several groups of bits (from the LSB):
77 * message severity level (`L_xxx`), destination stream, message type [currently unused]
78 * and control bits (e.g., `L_SIGHANDLER`).
81 enum ls_flagbits { // Bit widths of groups
88 enum ls_flagpos { // Bit positions of groups
90 LS_STRNUM_POS = LS_LEVEL_POS + LS_LEVEL_BITS,
91 LS_TYPE_POS = LS_STRNUM_POS + LS_STRNUM_BITS,
92 LS_CTRL_POS = LS_TYPE_POS + LS_TYPE_BITS,
95 enum ls_flagmasks { // Bit masks of groups
96 LS_LEVEL_MASK = ((1 << LS_LEVEL_BITS) - 1) << LS_LEVEL_POS,
97 LS_STRNUM_MASK = ((1 << LS_STRNUM_BITS) - 1) << LS_STRNUM_POS,
98 LS_TYPE_MASK = ((1 << LS_TYPE_BITS) - 1) << LS_TYPE_POS,
99 LS_CTRL_MASK = ((1 << LS_CTRL_BITS) - 1) << LS_CTRL_POS,
102 // "Get" macros (break flags to parts)
103 #define LS_GET_LEVEL(flags) (((flags) & LS_LEVEL_MASK) >> LS_LEVEL_POS) /** Extract severity level **/
104 #define LS_GET_STRNUM(flags) (((flags) & LS_STRNUM_MASK) >> LS_STRNUM_POS) /** Extract stream number **/
105 #define LS_GET_TYPE(flags) (((flags) & LS_TYPE_MASK) >> LS_TYPE_POS) /** Extract message type **/
106 #define LS_GET_CTRL(flags) (((flags) & LS_CTRL_MASK) >> LS_CTRL_POS) /** Extract control bits **/
108 // "Set" macros (parts to flags)
109 #define LS_SET_LEVEL(level) ((level) << LS_LEVEL_POS) /** Convert severity level to flags **/
110 #define LS_SET_STRNUM(strnum) ((strnum) << LS_STRNUM_POS) /** Convert stream number to flags **/
111 #define LS_SET_TYPE(type) ((type) << LS_TYPE_POS) /** Convert message type to flags **/
112 #define LS_SET_CTRL(ctrl) ((ctrl) << LS_CTRL_POS) /** Convert control bits to flags **/
114 /*** === Operations on streams ***/
117 * Allocate a new log stream with no handler and an empty substream list.
118 * Since struct log_stream is followed by private data, @size bytes of memory are allocated
119 * for the whole structure. See below for functions creating specific stream types.
121 struct log_stream *log_new_stream(size_t size);
124 * Decrement the use count of a stream. If it becomes zero, close the stream,
125 * free its memory, and unlink all its substreams.
127 int log_close_stream(struct log_stream *ls);
130 * Get a new reference on an existing stream. For convenience, the return value is
131 * equal to the argument @ls.
133 static inline struct log_stream *log_ref_stream(struct log_stream *ls)
140 * Link a substream to a stream. The substream gains a reference, preventing
141 * it from being freed until it is unlinked.
143 void log_add_substream(struct log_stream *where, struct log_stream *what);
146 * Unlink all occurrences of a substream @what from stream @where. Each
147 * occurrence loses a reference. If @what is NULL, all substreams are unlinked.
148 * Returns the number of unlinked substreams.
150 int log_rm_substream(struct log_stream *where, struct log_stream *what);
153 * Set formatting flags of a given stream and all its substreams. The flags are
154 * AND'ed with @mask and OR'ed with @data.
156 void log_set_format(struct log_stream *ls, uns mask, uns data);
159 * Find a stream by its registration number (in the format of logging flags).
160 * Returns NULL if there is no such stream.
162 struct log_stream *log_stream_by_flags(uns flags);
164 /** Return a pointer to the default stream (stream #0). **/
165 static inline struct log_stream *log_default_stream(void)
167 return log_stream_by_flags(0);
171 * Close all open streams, un-initialize the module, free all memory and
172 * reset the logging mechanism to use stderr only.
174 void log_close_all(void);
177 * === Logging to files
179 * All log files are open in append mode, which guarantees atomicity of write()
180 * even in multi-threaded programs.
183 struct log_stream *log_new_file(const char *path); /** Create a stream bound to a log file. **/
184 struct log_stream *log_new_fd(int fd); /** Create a stream bound to a file descriptor. **/
187 * When a time-based name of the log file changes, the logger switches to a new
188 * log file automatically. This can be sometimes inconvenient, so you can use
189 * this function to disable the automatic switches. The calls to this function
192 void log_switch_disable(void);
193 void log_switch_enable(void); /** Negate the effect of log_switch_disable(). **/
194 int log_switch(void); /** Switch log files manually. **/
197 * === Logging to syslog
199 * This log stream uses the libc interface to the system logging daemon (`syslogd`).
200 * This interface has several limitations:
202 * * Syslog are poorer than our scheme, so they are translated with a slight
203 * loss of information (most importantly, the distinction between local and
204 * remote messages is lost). If you are interested in details, search the
205 * source for syslog_level().
206 * * Syslog options (especially logging of PID with each message) must be fixed
207 * during initialization of the logger
208 * * Syslog provides its own formatting, so we turn off all formatting flags
209 * of the LibUCW logger. You can override this manually by setting the @msgfmt
210 * field of the log stream, but the result won't be nice.
211 * * Syslog does not support timestamps with sub-second precision.
215 * Create a log stream for logging to a selected syslog facility.
216 * The @options are passed to openlog(). (Beware, due to limitations of the
217 * syslog interface in libc, the @options are shared for all syslog streams
218 * and they are applied when the first stream is created.)
220 struct log_stream *log_new_syslog(const char *facility, int options);
223 * Verify that a facility of the given name exists. Return 1 if it does, 0 otherwise.
225 int log_syslog_facility_exists(const char *facility);
228 * === Configuring log streams
230 * If you use the LibUCW mechanism for parsing config files, you can let your
231 * user configure arbitrary log streams in the Logging section of the config file
232 * (see examples in the default config file). LibUCW automatically verifies that
233 * the configuration is consistent (this is performed in the commit hook of the
234 * config section), but it opens the streams only upon request. The following
235 * functions can be used to control that.
238 /** Open a log stream configured under the specified name and increase its use count. **/
239 struct log_stream *log_new_configured(const char *name);
241 /** Open a log stream configured under the specified name and use it as the default destination. **/
242 void log_configured(const char *name);
245 * Verify that a stream called @name was configured. If it wasn't, return an error
246 * message. This is intended to be used in configuration commit hooks.
248 char *log_check_configured(const char *name);