1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/*
* log.h - Simple logging framework.
*
* Copyright 2003 Jonathan McDowell <noodles@earth.li>
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc., 51
* Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef __LOG_H__
#define __LOG_H__
#include <assert.h>
#define log_assert(expr) \
if (!(expr)) { \
logthing(LOGTHING_CRITICAL, \
"Assertion %s failed in %s, line %d", \
#expr, \
__FILE__, \
__LINE__); \
} \
assert(expr)
/*
* loglevels - levels of severity for a log entry
*
* These provide various different levels of severity for a log entry. In
* acesending order they are:
*
* LOGTHING_TRACE
* LOGTHING_DEBUG
* LOGTHING_INFO
* LOGTHING_NOTICE
* LOGTHING_ERROR
* LOGTHING_SERIOUS
* LOGTHING_CRITICAL
*
* By default the log threshold is set to LOGTHING_NOTICE, meaning
* anything with a lower priority won't be output.
*/
typedef enum {
LOGTHING_TRACE = 0,
LOGTHING_DEBUG = 1,
LOGTHING_INFO = 2,
LOGTHING_NOTICE = 3,
LOGTHING_ERROR = 4,
LOGTHING_SERIOUS = 5,
LOGTHING_CRITICAL = 6
} loglevels;
/*
* initlogthing - initialize the logging module
* @appname: The application name to use in the log.
* @filename: The filename to log to. NULL means stderr.
*
* This function sets up the logging module ready to log. The appname is
* written as part of every log entry and the filename is the file we
* should log to. If the appname is NULL then none is written. If the
* filename is NULL all output is sent to stderr.
*/
int initlogthing(const char *appname, const char *filename);
/*
* cleanuplogthing - clean up the logging module
*
* This function cleans up the logging module after use.
*/
void cleanuplogthing(void);
/*
* setlogthreshold - set the threshold for log output
* @loglevel: The minimum log level we should output
*
* Sets the threshold for log output; anything logged with a log level
* lower than this will be silently dropped. Returns the old log threshold
* value.
*/
loglevels setlogthreshold(loglevels loglevel);
/*
* logthing - output a log entry
* @loglevel: The level of the log.
* @format: A format string, followed by any parameters required.
*
* This function outputs a log entry. A leading time/date stamp and a
* trailing newline are automatically added. The loglevel is compared to
* the current log threshold and if equal or above the log entry is
* output. The format parameter is of the same nature as that used in
* printf.
*/
int logthing(loglevels loglevel, const char *format, ...);
#endif /* __LOG_H__ */
|
