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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set et sw=2 ts=2: */
/***************************************************************************
* debug.h
*
* Thu Nov 1 13:38:47 CET 2012
* Copyright 2012 Bent Bisballe Nyeng
* deva@aasimon.org
****************************************************************************/
/*
* This file is part of Debug Module.
*
* Debug Module 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; either version 2 of the License, or
* (at your option) any later version.
*
* Debug Module 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 Debug Module; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/
#ifndef __DEBUG_MODULE_DEBUG_H__
#define __DEBUG_MODULE_DEBUG_H__
enum DBG_FLAG {
// Features
#ifdef WITH_DBG_THREAD
DBG_FLAG_USE_THREAD = 0x00000001,
#endif
#ifdef WITH_DBG_MUTEX
DBG_FLAG_USE_MUTEX = 0x00000002,
#endif
#ifdef WITH_DBG_FILTER
DBG_FLAG_USE_FILTER = 0x00000004,
#endif
// Outputs
DBG_FLAG_OUTPUT_TO_STDOUT = 0x00010000,
DBG_FLAG_OUTPUT_TO_STDERR = 0x00020000,
DBG_FLAG_OUTPUT_TO_FD = 0x00040000,
DBG_FLAG_OUTPUT_TO_FILE = 0x00080000,
#ifdef WITH_DBG_SYSLOG
DBG_FLAG_OUTPUT_TO_SYSLOG = 0x000f0000,
#endif
// Default value of flags
DBG_FLAG_DEFAULT = DBG_FLAG_OUTPUT_TO_STDOUT, // Output to stdout
};
enum DBG_OPTION {
/**
* No more options / last option. This is used
* to terminate the VARARGs list.
*/
DBG_OPTION_END,
/**
* const char* argument containing a filename which will be used for log
* output. To be used with the DBG_FLAG_OUTPUT_TO_FILE flag.
*/
DBG_OPTION_FILENAME,
/**
* Integer argument describing a file descriptor which will be used for log
* output. To be used with the DBG_FLAG_OUTPUT_TO_FD flag.
*/
DBG_OPTION_FD,
/**
* Host and port to use when logging on an external server.
* Host is a const char* argument, port is an integer.
* To be used with the DBG_FLAG_USE_SYSLOG flag.
* Linux: If DBG_OPTION_SYSLOG_HOST is not supplied, the local syslog will be
* used.
* Windows: If DBG_OPTION_SYSLOG_HOST is not supplied an error will be
* returned by debug_init.
* If DBG_OPTION_SYSLOG_PORT is not supplied, the default syslogd port will
* be used (port 514).
*/
#ifdef WITH_DBG_SYSLOG
DBG_OPTION_SYSLOG_HOST,
DBG_OPTION_SYSLOG_PORT,
#endif
/**
* Filter option. Argument is a const char *.
* fmt := [set[,set]*]*
* set := [+-]channel
* | class[+-]channel
* | [+-]all
*/
#ifdef WITH_DBG_FILTER
DBG_OPTION_FILTER,
#endif
};
typedef enum {
DBG_STATUS_OK = 0,
DBG_STATUS_UNKNOWN_OPTION,
DBG_STATUS_ERROR,
} dbg_status_t;
/**
* @param flags combination of DBG_FLAG values
* @param ... list of options (type-value pairs,
* terminated with DBG_OPTION_END).
* @return 0 on success, 1 on error.
*/
dbg_status_t dbg_init(unsigned int flags, ...);
void dbg_close();
/**
* Example of usage (use mutex protected calls, send output to file):
*
* dbg_status_t status;
* status = debug_init(DBG_FLAG_OUTPUT_TO_FILE | DBG_FLAG_USE_MUTEX,
* DBG_OPTION_FILENAME, "/tmp/my.log",
DBG_OPTION_END);
* if(status != DBG_STATUS_OK) exit(1);
* INFO(example, "We are up and running\n");
* dbg_close();
*/
/**
* Example of usage (simply outputs to stdout):
*
* INFO(example, "We are up and running\n");
*/
enum __debug_class
{
__class_fixme = 0,
__class_err = 1,
__class_warn = 2,
__class_info = 3,
__class_debug = 4
};
int __debug(const char *func, const int line, enum __debug_class cl,
const char *ch, const char *fmt, ...)
__attribute__((format (printf,5,6)));
#define __DEBUG_PRINT(cl, ch, fmt...) \
do { __debug(__func__, __LINE__, cl, ch, fmt); } while(0)
#define __DEBUG(cl, ch, fmt...) \
__DEBUG_PRINT(__class##cl, #ch, fmt)
#define ERR(ch, fmt...) __DEBUG(_err, ch, fmt)
#define WARN(ch, fmt...) __DEBUG(_warn, ch, fmt)
#define INFO(ch, fmt...) __DEBUG(_info, ch, fmt)
#define DEBUG(ch, fmt...) __DEBUG(_debug, ch, fmt)
#endif/*__DEBUG_MODULE_DEBUG_H__*/
|
