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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/*
COMMON TRACE
Common header file for tracing.
Copyright (C) Dmitri Pal <dpal@redhat.com> 2009
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
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 Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef COMMON_TRACE_H
#define COMMON_TRACE_H
#ifdef TRACE_LEVEL
#define HAVE_TRACE
#include <stdio.h>
/* The trace level is a bit mask */
#define TRACE_FLOW 0x0000001 /* - trace messages that are entry exit into functions */
#define TRACE_ERROR 0x0000002 /* - trace messages that are errors */
#define TRACE_INFO 0x0000004 /* - trace things that are informational */
#ifdef TRACE_HOME /* Define this in the module that contains main */
unsigned trace_level = TRACE_LEVEL;
#else
extern unsigned trace_level;
#endif /* TRACE_HOME */
#endif /* TRACE_LEVEL */
#ifdef HAVE_TRACE
/* Tracing strings */
#define TRACE_STRING(level, msg, str) \
do { \
if (level & trace_level) { \
printf("[DEBUG] %40s (%4d) %s%s %s\n", \
__FILE__, __LINE__, \
(level == TRACE_ERROR) ? "ERROR-> " : "", \
(msg != NULL) ? msg : "MISSING MESSAGE", \
(str != NULL) ? str : "(null)"); \
} \
} while(0)
/* Tracing unsigned numbers */
#define TRACE_NUMBER(level, msg, num) \
do { \
if (level & trace_level) { \
printf("[DEBUG] %40s (%4d) %s%s %lu\n", \
__FILE__, __LINE__, \
(level == TRACE_ERROR) ? "ERROR-> " : "", \
(msg != NULL) ? msg : "MISSING MESSAGE", \
(unsigned long int)(num)); \
} \
} while(0)
/* Tracing signed numbers */
#define TRACE_SNUMBER(level, msg, num) \
do { \
if (level & trace_level) { \
printf("[DEBUG] %40s (%4d) %s%s %ld\n", \
__FILE__, __LINE__, \
(level == TRACE_ERROR) ? "ERROR-> " : "", \
(msg != NULL) ? msg : "MISSING MESSAGE", \
(long int)(num)); \
} \
} while(0)
/* Tracing long numbers */
#define TRACE_LNUMBER(level, msg, num) \
do { \
if (level & trace_level) { \
printf("[DEBUG] %40s (%4d) %s%s %llu\n", \
__FILE__, __LINE__, \
(level == TRACE_ERROR) ? "ERROR-> " : "", \
(msg != NULL) ? msg : "MISSING MESSAGE", \
(unsigned long long int)(num)); \
} \
} while(0)
/* Tracing signed long numbers */
#define TRACE_SLNUMBER(level, msg, num) \
do { \
if (level & trace_level) { \
printf("[DEBUG] %40s (%4d) %s%s %lld\n", \
__FILE__, __LINE__, \
(level == TRACE_ERROR) ? "ERROR-> " : "", \
(msg != NULL) ? msg : "MISSING MESSAGE", \
(long long int)(num)); \
} \
} while(0)
/* Tracing doubles */
#define TRACE_DOUBLE(level, msg, num) \
do { \
if (level & trace_level) { \
printf("[DEBUG] %40s (%4d) %s%s %e\n", \
__FILE__, __LINE__, \
(level == TRACE_ERROR) ? "ERROR-> " : "", \
(msg != NULL) ? msg : "MISSING MESSAGE", \
(double)(num)); \
} \
} while(0)
#define TRACE_RETURN(flow, val) \
do { \
char mstr[200]; \
sprintf(mstr, "%s returning:", __FUNCTION__); \
flow(mstr, val); \
} while(0)
/* Assertion */
#define TRACE_ASSERT(expression) expression ? : printf("ASSERTION FAILED\n")
#else /* HAVE_TRACE */
/* Noop in case the tracing is disabled */
#define TRACE_STRING(level, msg, str)
#define TRACE_NUMBER(level, msg, num)
#define TRACE_SNUMBER(level, msg, num)
#define TRACE_LNUMBER(level, msg, num)
#define TRACE_SLNUMBER(level, msg, num)
#define TRACE_DOUBLE(level, msg, num)
#define TRACE_RETURN(flow, val)
#define TRACE_ASSERT(expression)
#endif /* HAVE_TRACE */
/* Convenience wrappers for strings */
#define TRACE_FLOW_STRING(msg, str) TRACE_STRING(TRACE_FLOW, msg, str)
#define TRACE_ERROR_STRING(msg, str) TRACE_STRING(TRACE_ERROR, msg, str)
#define TRACE_INFO_STRING(msg, str) TRACE_STRING(TRACE_INFO, msg, str)
/* Convenience wrappers for unsigned numbers */
#define TRACE_FLOW_NUMBER(msg, num) TRACE_NUMBER(TRACE_FLOW, msg, num)
#define TRACE_ERROR_NUMBER(msg, num) TRACE_NUMBER(TRACE_ERROR, msg, num)
#define TRACE_INFO_NUMBER(msg, num) TRACE_NUMBER(TRACE_INFO, msg, num)
/* Convenience wrappers for signed numbers */
#define TRACE_FLOW_SNUMBER(msg, num) TRACE_SNUMBER(TRACE_FLOW, msg, num)
#define TRACE_ERROR_SNUMBER(msg, num) TRACE_SNUMBER(TRACE_ERROR, msg, num)
#define TRACE_INFO_SNUMBER(msg, num) TRACE_SNUMBER(TRACE_INFO, msg, num)
/* Convenience wrappers for 64-bit long unsigned numbers */
#define TRACE_FLOW_LNUMBER(msg, num) TRACE_LNUMBER(TRACE_FLOW, msg, num)
#define TRACE_ERROR_LNUMBER(msg, num) TRACE_LNUMBER(TRACE_ERROR, msg, num)
#define TRACE_INFO_LNUMBER(msg, num) TRACE_LNUMBER(TRACE_INFO, msg, num)
/* Convenience wrappers for 64-bit long signed numbers */
#define TRACE_FLOW_SLNUMBER(msg, num) TRACE_SLNUMBER(TRACE_FLOW, msg, num)
#define TRACE_ERROR_SLNUMBER(msg, num) TRACE_SLNUMBER(TRACE_ERROR, msg, num)
#define TRACE_INFO_SLNUMBER(msg, num) TRACE_SLNUMBER(TRACE_INFO, msg, num)
/* Convenience wrappers for numbers */
#define TRACE_FLOW_DOUBLE(msg, num) TRACE_DOUBLE(TRACE_FLOW, msg, num)
#define TRACE_ERROR_DOUBLE(msg, num) TRACE_DOUBLE(TRACE_ERROR, msg, num)
#define TRACE_INFO_DOUBLE(msg, num) TRACE_DOUBLE(TRACE_INFO, msg, num)
/* Some other nice wrappers for function entry and exit */
#define TRACE_FLOW_ENTRY() TRACE_FLOW_STRING(__FUNCTION__, "Entry")
#define TRACE_FLOW_EXIT() TRACE_FLOW_STRING(__FUNCTION__, "Exit")
#define TRACE_FLOW_RETURN(val) TRACE_RETURN(TRACE_FLOW_NUMBER, val)
#endif /* COMMON_TRACE_H */
|
