2009-11-02 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / src / debug.h
1 /* debug.h - interface to debugging functions
2    Copyright (C) 2002, 2004, 2005, 2007 g10 Code GmbH
3  
4    This file is part of GPGME.
5
6    GPGME is free software; you can redistribute it and/or modify it
7    under the terms of the GNU Lesser General Public License as
8    published by the Free Software Foundation; either version 2.1 of
9    the License, or (at your option) any later version.
10    
11    GPGME is distributed in the hope that it will be useful, but
12    WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15    
16    You should have received a copy of the GNU Lesser General Public
17    License along with this program; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
19    02111-1307, USA.  */
20
21 #ifndef DEBUG_H
22 #define DEBUG_H
23
24 #include <string.h>
25 #ifdef HAVE_STDINT_H
26 #include <stdint.h>
27 #endif
28
29 /* Indirect stringification, requires __STDC__ to work.  */
30 #define STRINGIFY(v) #v
31 #define XSTRINGIFY(v) STRINGIFY(v)
32
33 \f
34 /* The debug levels.  */
35
36 #define DEBUG_INIT      1
37 #define DEBUG_GLOBAL    2
38 #define DEBUG_CTX       3
39 #define DEBUG_ENGINE    4
40 #define DEBUG_DATA      5
41 #define DEBUG_ASSUAN    6
42 #define DEBUG_SYSIO     7
43
44 \f
45 /* Remove path components from filenames (i.e. __FILE__) for cleaner
46    logs. */
47 static inline const char *_gpgme_debug_srcname (const char *file)
48                                                 GPGME_GCC_A_PURE;
49
50 static inline const char *
51 _gpgme_debug_srcname (const char *file)
52 {
53   const char *s = strrchr (file, '/');
54   return s? s+1:file;
55 }
56
57 /* Called early to initialize the logging.  */
58 void _gpgme_debug_subsystem_init (void);
59
60 /* Log the formatted string FORMAT at debug level LEVEL or higher.  */
61 void _gpgme_debug (int level, const char *format, ...);
62
63 /* Start a new debug line in *LINE, logged at level LEVEL or higher,
64    and starting with the formatted string FORMAT.  */
65 void _gpgme_debug_begin (void **helper, int level, const char *format, ...);
66
67 /* Add the formatted string FORMAT to the debug line *LINE.  */
68 void _gpgme_debug_add (void **helper, const char *format, ...);
69
70 /* Finish construction of *LINE and send it to the debug output
71    stream.  */
72 void _gpgme_debug_end (void **helper);
73
74 void _gpgme_debug_buffer (int lvl, const char *const fmt,
75                           const char *const func, const char *const tagname,
76                           const void *const tag, const char *const buffer,
77                           size_t len);
78
79 \f
80 /* Trace support.  */
81
82 /* FIXME: For now.  */
83 #define _gpgme_debug_trace() 1
84
85 #define _TRACE(lvl, name, tag)                                  \
86   int _gpgme_trace_level = lvl;                                 \
87   const char *const _gpgme_trace_func = name;                   \
88   const char *const _gpgme_trace_tagname = STRINGIFY (tag);     \
89   void *_gpgme_trace_tag = (void *) (uintptr_t) tag
90
91 #define TRACE_BEG(lvl, name, tag)                          \
92   _TRACE (lvl, name, tag);                                 \
93   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: enter\n", \
94                 _gpgme_trace_tagname, _gpgme_trace_tag,   \
95                 _gpgme_trace_func), 0
96 #define TRACE_BEG0(lvl, name, tag, fmt)                                 \
97   _TRACE (lvl, name, tag);                                              \
98   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: enter: " fmt "\n",     \
99                 _gpgme_trace_tagname, _gpgme_trace_tag,         \
100                 _gpgme_trace_func), 0
101 #define TRACE_BEG1(lvl, name, tag, fmt, arg1)                           \
102   _TRACE (lvl, name, tag);                                              \
103   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: enter: " fmt "\n",     \
104                 _gpgme_trace_tagname, _gpgme_trace_tag,         \
105                 _gpgme_trace_func, arg1), 0
106 #define TRACE_BEG2(lvl, name, tag, fmt, arg1, arg2)                 \
107   _TRACE (lvl, name, tag);                                          \
108   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: enter: " fmt "\n", \
109                 _gpgme_trace_tagname, _gpgme_trace_tag,     \
110                 _gpgme_trace_func, arg1, arg2), 0
111 #define TRACE_BEG3(lvl, name, tag, fmt, arg1, arg2, arg3)           \
112   _TRACE (lvl, name, tag);                                          \
113   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: enter: " fmt "\n", \
114                 _gpgme_trace_tagname, _gpgme_trace_tag,     \
115                 _gpgme_trace_func, arg1, arg2, arg3), 0
116 #define TRACE_BEG4(lvl, name, tag, fmt, arg1, arg2, arg3, arg4)     \
117   _TRACE (lvl, name, tag);                                          \
118   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: enter: " fmt "\n", \
119                 _gpgme_trace_tagname, _gpgme_trace_tag,     \
120                 _gpgme_trace_func, arg1, arg2, arg3, arg4), 0
121 #define TRACE_BEG5(lvl, name, tag, fmt, arg1, arg2, arg3, arg4, arg5) \
122   _TRACE (lvl, name, tag);                                          \
123   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: enter: " fmt "\n", \
124                 _gpgme_trace_tagname, _gpgme_trace_tag,     \
125                 _gpgme_trace_func, arg1, arg2, arg3, arg4, arg5), 0
126 #define TRACE_BEG7(lvl, name, tag, fmt, arg1, arg2, arg3, arg4,     \
127                    arg5, arg6, arg7)                                \
128   _TRACE (lvl, name, tag);                                          \
129   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: enter: " fmt "\n", \
130                 _gpgme_trace_tagname, _gpgme_trace_tag,     \
131                 _gpgme_trace_func, arg1, arg2, arg3, arg4, arg5,            \
132                 arg6, arg7), 0
133 #define TRACE_BEG8(lvl, name, tag, fmt, arg1, arg2, arg3, arg4,     \
134                    arg5, arg6, arg7, arg8)                          \
135   _TRACE (lvl, name, tag);                                          \
136   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: enter: " fmt "\n", \
137                 _gpgme_trace_tagname, _gpgme_trace_tag,     \
138                 _gpgme_trace_func, arg1, arg2, arg3, arg4, arg5,            \
139                 arg6, arg7, arg8), 0
140
141 #define TRACE(lvl, name, tag)                                           \
142   _gpgme_debug (lvl, "[%s=%p] %s: call\n",                              \
143                 STRINGIFY (tag), (void *) (uintptr_t) tag, name), 0
144 #define TRACE0(lvl, name, tag, fmt)                                     \
145   _gpgme_debug (lvl, "[%s=%p] %s: call: " fmt "\n",                     \
146                 STRINGIFY (tag), (void *) (uintptr_t) tag, name), 0
147 #define TRACE1(lvl, name, tag, fmt, arg1)                              \
148   _gpgme_debug (lvl, "[%s=%p] %s: call: " fmt "\n",                    \
149                 STRINGIFY (tag), (void *) (uintptr_t) tag, name, arg1), 0
150 #define TRACE2(lvl, name, tag, fmt, arg1, arg2)                        \
151   _gpgme_debug (lvl, "[%s=%p] %s: call: " fmt "\n",                    \
152                 STRINGIFY (tag), (void *) (uintptr_t) tag, name, arg1, \
153                 arg2), 0
154 #define TRACE3(lvl, name, tag, fmt, arg1, arg2, arg3)                  \
155   _gpgme_debug (lvl, "[%s=%p] %s: call: " fmt "\n",                    \
156                 STRINGIFY (tag), (void *) (uintptr_t) tag, name, arg1, \
157                 arg2, arg3), 0
158 #define TRACE6(lvl, name, tag, fmt, arg1, arg2, arg3, arg4, arg5, arg6) \
159   _gpgme_debug (lvl, "[%s=%p] %s: call: " fmt "\n",                     \
160                 STRINGIFY (tag), (void *) (uintptr_t) tag, name, arg1,  \
161                 arg2, arg3, arg4, arg5, arg6), 0
162
163 #define TRACE_ERR(err)                                                  \
164   err == 0 ? (TRACE_SUC ()) :                                           \
165     (_gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: error: %s <%s>\n",  \
166                    _gpgme_trace_tagname, _gpgme_trace_tag,              \
167                    _gpgme_trace_func, gpgme_strerror (err),             \
168                    gpgme_strsource (err)), (err))
169 /* The cast to void suppresses GCC warnings.  */
170 #define TRACE_SYSRES(res)                                               \
171   res >= 0 ? ((void) (TRACE_SUC1 ("result=%i", res)), (res)) :          \
172     (_gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: error: %s\n",       \
173                    _gpgme_trace_tagname, _gpgme_trace_tag,              \
174                    _gpgme_trace_func, strerror (errno)), (res))
175 #define TRACE_SYSERR(res)                                               \
176   res == 0 ? ((void) (TRACE_SUC1 ("result=%i", res)), (res)) :          \
177     (_gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: error: %s\n",       \
178                    _gpgme_trace_tagname, _gpgme_trace_tag,              \
179                    _gpgme_trace_func, strerror (res)), (res))
180
181 #define TRACE_SUC()                                              \
182   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: leave\n",       \
183                 _gpgme_trace_tagname, _gpgme_trace_tag,  \
184                 _gpgme_trace_func), 0
185 #define TRACE_SUC0(fmt)                                                 \
186   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: leave: " fmt "\n",     \
187                 _gpgme_trace_tagname, _gpgme_trace_tag,         \
188                 _gpgme_trace_func), 0
189 #define TRACE_SUC1(fmt, arg1)                                           \
190   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: leave: " fmt "\n",     \
191                 _gpgme_trace_tagname, _gpgme_trace_tag,         \
192                 _gpgme_trace_func, arg1), 0
193 #define TRACE_SUC2(fmt, arg1, arg2)                                     \
194   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: leave: " fmt "\n",     \
195                 _gpgme_trace_tagname, _gpgme_trace_tag,         \
196                 _gpgme_trace_func, arg1, arg2), 0
197 #define TRACE_SUC5(fmt, arg1, arg2, arg3, arg4, arg5)                   \
198   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: leave: " fmt "\n",     \
199                 _gpgme_trace_tagname, _gpgme_trace_tag,         \
200                 _gpgme_trace_func, arg1, arg2, arg3, arg4, arg5), 0
201
202 #define TRACE_LOG(fmt)                                                  \
203   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: check: " fmt "\n",     \
204                 _gpgme_trace_tagname, _gpgme_trace_tag,         \
205                 _gpgme_trace_func), 0
206 #define TRACE_LOG1(fmt, arg1)                                           \
207   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: check: " fmt "\n",     \
208                 _gpgme_trace_tagname, _gpgme_trace_tag,         \
209                 _gpgme_trace_func, arg1), 0
210 #define TRACE_LOG2(fmt, arg1, arg2)                                 \
211   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: check: " fmt "\n", \
212                 _gpgme_trace_tagname, _gpgme_trace_tag,     \
213                 _gpgme_trace_func, arg1, arg2), 0
214 #define TRACE_LOG3(fmt, arg1, arg2, arg3)                           \
215   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: check: " fmt "\n", \
216                 _gpgme_trace_tagname, _gpgme_trace_tag,     \
217                 _gpgme_trace_func, arg1, arg2, arg3), 0
218 #define TRACE_LOG4(fmt, arg1, arg2, arg3, arg4)                     \
219   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: check: " fmt "\n", \
220                 _gpgme_trace_tagname, _gpgme_trace_tag,     \
221                 _gpgme_trace_func, arg1, arg2, arg3, arg4), 0
222 #define TRACE_LOG5(fmt, arg1, arg2, arg3, arg4, arg5)               \
223   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: check: " fmt "\n", \
224                 _gpgme_trace_tagname, _gpgme_trace_tag,     \
225                 _gpgme_trace_func, arg1, arg2, arg3, arg4, arg5), 0
226 #define TRACE_LOG6(fmt, arg1, arg2, arg3, arg4, arg5, arg6)         \
227   _gpgme_debug (_gpgme_trace_level, "[%s=%p] %s: check: " fmt "\n", \
228                 _gpgme_trace_tagname, _gpgme_trace_tag,     \
229                 _gpgme_trace_func, arg1, arg2, arg3, arg4, arg5,            \
230                 arg6), 0
231
232 #define TRACE_LOGBUF(buf, len)                                          \
233   _gpgme_debug_buffer (_gpgme_trace_level, "[%s=%p] %s: check: %s",     \
234                        _gpgme_trace_tagname, _gpgme_trace_tag,          \
235                        _gpgme_trace_func, buf, len)
236
237 #define TRACE_SEQ(hlp,fmt)                                              \
238   _gpgme_debug_begin (&(hlp), _gpgme_trace_level,                       \
239                       "[%s=%p] %s: check: " fmt,                        \
240                       _gpgme_trace_tagname, _gpgme_trace_tag,           \
241                       _gpgme_trace_func)
242 #define TRACE_ADD0(hlp,fmt) \
243   _gpgme_debug_add (&(hlp), fmt)
244 #define TRACE_ADD1(hlp,fmt,a) \
245   _gpgme_debug_add (&(hlp), fmt, (a))
246 #define TRACE_ADD2(hlp,fmt,a,b) \
247   _gpgme_debug_add (&(hlp), fmt, (a), (b))
248 #define TRACE_ADD3(hlp,fmt,a,b,c) \
249   _gpgme_debug_add (&(hlp), fmt, (a), (b), (c))
250 #define TRACE_END(hlp,fmt) \
251   _gpgme_debug_add (&(hlp), fmt); \
252   _gpgme_debug_end (&(hlp))
253 #define TRACE_ENABLED(hlp) (!!(hlp))
254
255 #endif  /* DEBUG_H */