Trace the use of GPG_ERR_INV_ENGINE.
[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 #include "gpgme.h"  /* Required for gpgme_error stuff.  */
30
31
32 /* Indirect stringification, requires __STDC__ to work.  */
33 #define STRINGIFY(v) #v
34 #define XSTRINGIFY(v) STRINGIFY(v)
35
36 \f
37 /* The debug levels.  */
38
39 #define DEBUG_INIT      1
40 #define DEBUG_GLOBAL    2
41 #define DEBUG_CTX       3
42 #define DEBUG_ENGINE    4
43 #define DEBUG_DATA      5
44 #define DEBUG_ASSUAN    6
45 #define DEBUG_SYSIO     7
46
47 \f
48 /* Remove path components from filenames (i.e. __FILE__) for cleaner
49    logs. */
50 static inline const char *_gpgme_debug_srcname (const char *file)
51                                                 GPGME_GCC_A_PURE;
52
53 static inline const char *
54 _gpgme_debug_srcname (const char *file)
55 {
56   const char *s = strrchr (file, '/');
57   return s? s+1:file;
58 }
59
60 /* Initialization helper function; see debug.c.  */
61 int _gpgme_debug_set_debug_envvar (const char *value);
62
63 /* Called early to initialize the logging.  */
64 void _gpgme_debug_subsystem_init (void);
65
66 /* Log the formatted string FORMAT at debug level LEVEL or higher.  */
67 void _gpgme_debug (int level, const char *format, ...);
68
69 /* Start a new debug line in *LINE, logged at level LEVEL or higher,
70    and starting with the formatted string FORMAT.  */
71 void _gpgme_debug_begin (void **helper, int level, const char *format, ...);
72
73 /* Add the formatted string FORMAT to the debug line *LINE.  */
74 void _gpgme_debug_add (void **helper, const char *format, ...);
75
76 /* Finish construction of *LINE and send it to the debug output
77    stream.  */
78 void _gpgme_debug_end (void **helper);
79
80 void _gpgme_debug_buffer (int lvl, const char *const fmt,
81                           const char *const func, const char *const buffer,
82                           size_t len);
83
84 void _gpgme_debug_frame_begin (void);
85 void _gpgme_debug_frame_end (void);
86
87 static inline gpgme_error_t
88 _gpgme_trace_gpgme_error (gpgme_error_t err, const char *file, int line)
89 {
90   _gpgme_debug (DEBUG_ENGINE, "%s:%d: returning error: %s\n",
91                 _gpgme_debug_srcname (file), line, gpgme_strerror (err));
92   return err;
93 }
94
95 \f
96 /* Trace support.  */
97
98 /* FIXME: For now.  */
99 #define _gpgme_debug_trace() 1
100
101 #define _TRACE(lvl, name, tag)                                  \
102   int _gpgme_trace_level = lvl;                                 \
103   const char *const _gpgme_trace_func = name;                   \
104   const char *const _gpgme_trace_tagname = STRINGIFY (tag);     \
105   void *_gpgme_trace_tag = (void *) (uintptr_t) tag; \
106   _gpgme_debug_frame_begin ()
107
108 #define TRACE_BEG(lvl, name, tag)                          \
109   _TRACE (lvl, name, tag);                                 \
110   _gpgme_debug (_gpgme_trace_level, "%s: enter: %s=%p\n", \
111                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag), 0
112 #define TRACE_BEG0(lvl, name, tag, fmt)                                 \
113   _TRACE (lvl, name, tag);                                              \
114   _gpgme_debug (_gpgme_trace_level, "%s: enter: %s=%p, " fmt "\n",      \
115                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag), 0
116 #define TRACE_BEG1(lvl, name, tag, fmt, arg1)                           \
117   _TRACE (lvl, name, tag);                                              \
118   _gpgme_debug (_gpgme_trace_level, "%s: enter: %s=%p, " fmt "\n",      \
119                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
120                 arg1), 0
121 #define TRACE_BEG2(lvl, name, tag, fmt, arg1, arg2)                 \
122   _TRACE (lvl, name, tag);                                          \
123   _gpgme_debug (_gpgme_trace_level, "%s: enter: %s=%p, " fmt "\n", \
124                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
125                 arg1, arg2), 0
126 #define TRACE_BEG3(lvl, name, tag, fmt, arg1, arg2, arg3)           \
127   _TRACE (lvl, name, tag);                                          \
128   _gpgme_debug (_gpgme_trace_level, "%s: enter: %s=%p, " fmt "\n", \
129                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
130                 arg1, arg2, arg3), 0
131 #define TRACE_BEG4(lvl, name, tag, fmt, arg1, arg2, arg3, arg4)     \
132   _TRACE (lvl, name, tag);                                          \
133   _gpgme_debug (_gpgme_trace_level, "%s: enter: %s=%p, " fmt "\n", \
134                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
135                 arg1, arg2, arg3, arg4), 0
136 #define TRACE_BEG5(lvl, name, tag, fmt, arg1, arg2, arg3, arg4, arg5) \
137   _TRACE (lvl, name, tag);                                          \
138   _gpgme_debug (_gpgme_trace_level, "%s: enter: %s=%p, " fmt "\n", \
139                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
140                 arg1, arg2, arg3, arg4, arg5), 0
141 #define TRACE_BEG7(lvl, name, tag, fmt, arg1, arg2, arg3, arg4,     \
142                    arg5, arg6, arg7)                                \
143   _TRACE (lvl, name, tag);                                          \
144   _gpgme_debug (_gpgme_trace_level, "%s: enter: %s=%p, " fmt "\n", \
145                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
146                 arg1, arg2, arg3, arg4, arg5,       \
147                 arg6, arg7), 0
148 #define TRACE_BEG8(lvl, name, tag, fmt, arg1, arg2, arg3, arg4,     \
149                    arg5, arg6, arg7, arg8)                          \
150   _TRACE (lvl, name, tag);                                          \
151   _gpgme_debug (_gpgme_trace_level, "%s: enter: %s=%p, " fmt "\n", \
152                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
153                 arg1, arg2, arg3, arg4, arg5,       \
154                 arg6, arg7, arg8), 0
155
156 #define TRACE(lvl, name, tag)                                           \
157   _gpgme_debug_frame_begin (),                                          \
158   _gpgme_debug (lvl, "%s: call: %s=%p\n",                               \
159                 name, STRINGIFY (tag), (void *) (uintptr_t) tag),       \
160   _gpgme_debug_frame_end (), 0
161 #define TRACE0(lvl, name, tag, fmt)                                     \
162   _gpgme_debug_frame_begin (),                                          \
163   _gpgme_debug (lvl, "%s: call: %s=%p, " fmt "\n",                      \
164                 name, STRINGIFY (tag), (void *) (uintptr_t) tag),       \
165   _gpgme_debug_frame_end (), 0
166 #define TRACE1(lvl, name, tag, fmt, arg1)                              \
167   _gpgme_debug_frame_begin (),                                          \
168   _gpgme_debug (lvl, "%s: call: %s=%p, " fmt "\n",                     \
169                 name, STRINGIFY (tag), (void *) (uintptr_t) tag, arg1), \
170   _gpgme_debug_frame_end (), 0
171 #define TRACE2(lvl, name, tag, fmt, arg1, arg2)                        \
172   _gpgme_debug_frame_begin (),                                          \
173   _gpgme_debug (lvl, "%s: call: %s=%p, " fmt "\n",                     \
174                 name, STRINGIFY (tag), (void *) (uintptr_t) tag, arg1, \
175                 arg2), _gpgme_debug_frame_end (), 0
176 #define TRACE3(lvl, name, tag, fmt, arg1, arg2, arg3)                  \
177   _gpgme_debug_frame_begin (),                                          \
178   _gpgme_debug (lvl, "%s: call: %s=%p, " fmt "\n",                     \
179                 name, STRINGIFY (tag), (void *) (uintptr_t) tag, arg1, \
180                 arg2, arg3), _gpgme_debug_frame_end (), 0
181 #define TRACE6(lvl, name, tag, fmt, arg1, arg2, arg3, arg4, arg5, arg6) \
182   _gpgme_debug_frame_begin (),                                          \
183   _gpgme_debug (lvl, "%s: call: %s=%p, " fmt "\n",                      \
184                 name, STRINGIFY (tag), (void *) (uintptr_t) tag, arg1, \
185                 arg2, arg3, arg4, arg5, arg6),                         \
186   _gpgme_debug_frame_end (), 0
187
188 #define TRACE_ERR(err)                                                  \
189   err == 0 ? (TRACE_SUC ()) :                                           \
190     (_gpgme_debug (_gpgme_trace_level, "%s: error: %s <%s>\n",          \
191                    _gpgme_trace_func, gpgme_strerror (err),             \
192                    gpgme_strsource (err)), _gpgme_debug_frame_end (), (err))
193 /* The cast to void suppresses GCC warnings.  */
194 #define TRACE_SYSRES(res)                                               \
195   res >= 0 ? ((void) (TRACE_SUC1 ("result=%i", res)), (res)) :          \
196     (_gpgme_debug (_gpgme_trace_level, "%s: error: %s\n",       \
197                    _gpgme_trace_func, strerror (errno)), _gpgme_debug_frame_end (), (res))
198 #define TRACE_SYSERR(res)                                               \
199   res == 0 ? ((void) (TRACE_SUC1 ("result=%i", res)), (res)) :          \
200     (_gpgme_debug (_gpgme_trace_level, "%s: error: %s\n",               \
201                    _gpgme_trace_func, strerror (res)),                  \
202      _gpgme_debug_frame_end (), (res))
203
204 #define TRACE_SUC()                                              \
205   _gpgme_debug (_gpgme_trace_level, "%s: leave\n",       \
206                 _gpgme_trace_func), _gpgme_debug_frame_end (), 0
207 #define TRACE_SUC0(fmt)                                                 \
208   _gpgme_debug (_gpgme_trace_level, "%s: leave: " fmt "\n",     \
209                 _gpgme_trace_func), _gpgme_debug_frame_end (), 0
210 #define TRACE_SUC1(fmt, arg1)                                           \
211   _gpgme_debug (_gpgme_trace_level, "%s: leave: " fmt "\n",     \
212                 _gpgme_trace_func, arg1), _gpgme_debug_frame_end (), 0
213 #define TRACE_SUC2(fmt, arg1, arg2)                                     \
214   _gpgme_debug (_gpgme_trace_level, "%s: leave: " fmt "\n",     \
215                 _gpgme_trace_func, arg1, arg2), _gpgme_debug_frame_end (), 0
216 #define TRACE_SUC5(fmt, arg1, arg2, arg3, arg4, arg5)                   \
217   _gpgme_debug (_gpgme_trace_level, "%s: leave: " fmt "\n",     \
218                 _gpgme_trace_func, arg1, arg2, arg3, arg4, arg5), \
219     _gpgme_debug_frame_end (), 0
220 #define TRACE_SUC6(fmt, arg1, arg2, arg3, arg4, arg5, arg6)     \
221   _gpgme_debug (_gpgme_trace_level, "%s: leave: " fmt "\n",     \
222                 _gpgme_trace_func, arg1, arg2, arg3, arg4, arg5, arg6), \
223     _gpgme_debug_frame_end (), 0
224
225 #define TRACE_LOG(fmt)                                                  \
226   _gpgme_debug (_gpgme_trace_level, "%s: check: %s=%p, " fmt "\n",      \
227                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag), 0
228 #define TRACE_LOG1(fmt, arg1)                                           \
229   _gpgme_debug (_gpgme_trace_level, "%s: check: %s=%p, " fmt "\n",      \
230                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
231                 arg1), 0
232 #define TRACE_LOG2(fmt, arg1, arg2)                                 \
233   _gpgme_debug (_gpgme_trace_level, "%s: check: %s=%p, " fmt "\n", \
234                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
235                 arg1, arg2), 0
236 #define TRACE_LOG3(fmt, arg1, arg2, arg3)                           \
237   _gpgme_debug (_gpgme_trace_level, "%s: check: %s=%p, " fmt "\n", \
238                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
239                 arg1, arg2, arg3), 0
240 #define TRACE_LOG4(fmt, arg1, arg2, arg3, arg4)                     \
241   _gpgme_debug (_gpgme_trace_level, "%s: check: %s=%p, " fmt "\n", \
242                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
243                 arg1, arg2, arg3, arg4), 0
244 #define TRACE_LOG5(fmt, arg1, arg2, arg3, arg4, arg5)               \
245   _gpgme_debug (_gpgme_trace_level, "%s: check: %s=%p, " fmt "\n", \
246                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
247                 arg1, arg2, arg3, arg4, arg5), 0
248 #define TRACE_LOG6(fmt, arg1, arg2, arg3, arg4, arg5, arg6)         \
249   _gpgme_debug (_gpgme_trace_level, "%s: check: %s=%p, " fmt "\n", \
250                 _gpgme_trace_func, _gpgme_trace_tagname, _gpgme_trace_tag, \
251                 arg1, arg2, arg3, arg4, arg5,       \
252                 arg6), 0
253
254 #define TRACE_LOGBUF(buf, len)                                  \
255   _gpgme_debug_buffer (_gpgme_trace_level, "%s: check: %s",     \
256                        _gpgme_trace_func, buf, len)
257
258 #define TRACE_SEQ(hlp,fmt)                                              \
259   _gpgme_debug_begin (&(hlp), _gpgme_trace_level,                       \
260                       "%s: check: %s=%p, " fmt, _gpgme_trace_func,      \
261                       _gpgme_trace_tagname, _gpgme_trace_tag)
262 #define TRACE_ADD0(hlp,fmt) \
263   _gpgme_debug_add (&(hlp), fmt)
264 #define TRACE_ADD1(hlp,fmt,a) \
265   _gpgme_debug_add (&(hlp), fmt, (a))
266 #define TRACE_ADD2(hlp,fmt,a,b) \
267   _gpgme_debug_add (&(hlp), fmt, (a), (b))
268 #define TRACE_ADD3(hlp,fmt,a,b,c) \
269   _gpgme_debug_add (&(hlp), fmt, (a), (b), (c))
270 #define TRACE_END(hlp,fmt) \
271   _gpgme_debug_add (&(hlp), fmt); \
272   _gpgme_debug_end (&(hlp))
273 #define TRACE_ENABLED(hlp) (!!(hlp))
274
275 /* And finally a simple macro to trace the location of an error code.
276    This macro is independent of the other trace macros and may be used
277    without any preconditions.  */
278 #define trace_gpg_error(e) \
279   _gpgme_trace_gpgme_error (gpg_error (e), __FILE__, __LINE__)
280
281
282 #endif  /* DEBUG_H */