2007-07-17 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / 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
26 /* Indirect stringification, requires __STDC__ to work.  */
27 #define STRINGIFY(v) #v
28 #define XSTRINGIFY(v) STRINGIFY(v)
29
30 \f
31 /* The debug levels.  */
32
33 #define DEBUG_INIT      1
34 #define DEBUG_CTX       2
35 #define DEBUG_ENGINE    3
36 #define DEBUG_DATA      4
37 #define DEBUG_ASSUAN    5
38 #define DEBUG_SYSIO     6
39
40 \f
41 /* Remove path components from filenames (i.e. __FILE__) for cleaner
42    logs. */
43 static inline const char *_gpgme_debug_srcname (const char *file)
44                                                 GPGME_GCC_A_PURE;
45
46 static inline const char *
47 _gpgme_debug_srcname (const char *file)
48 {
49   const char *s = strrchr (file, '/');
50   return s? s+1:file;
51 }
52
53 /* Log the formatted string FORMAT at debug level LEVEL or higher.  */
54 void _gpgme_debug (int level, const char *format, ...);
55
56 /* Start a new debug line in *LINE, logged at level LEVEL or higher,
57    and starting with the formatted string FORMAT.  */
58 void _gpgme_debug_begin (void **helper, int level, const char *format, ...);
59
60 /* Add the formatted string FORMAT to the debug line *LINE.  */
61 void _gpgme_debug_add (void **helper, const char *format, ...);
62
63 /* Finish construction of *LINE and send it to the debug output
64    stream.  */
65 void _gpgme_debug_end (void **helper);
66
67 void _gpgme_debug_buffer (int lvl, const char *const fmt,
68                           const char *const func, const char *const tagname,
69                           void *tag, const char *const buffer, size_t len);
70
71 \f
72 /* Trace support.  */
73
74 /* FIXME: For now.  */
75 #define _gpgme_debug_trace() 1
76
77 #define _TRACE(lvl, name, tag)                                  \
78   int _gpgme_trace_level = lvl;                                 \
79   const char *const _gpgme_trace_func = name;                   \
80   const char *const _gpgme_trace_tagname = STRINGIFY (tag);     \
81   void *_gpgme_trace_tag = (void *) tag
82
83 #define TRACE_BEG(lvl, name, tag)                          \
84   _TRACE (lvl, name, tag);                                 \
85   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): enter\n", \
86                 _gpgme_trace_func, _gpgme_trace_tagname,   \
87                 _gpgme_trace_tag), 0
88 #define TRACE_BEG0(lvl, name, tag, fmt)                                 \
89   _TRACE (lvl, name, tag);                                              \
90   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): enter: " fmt "\n",   \
91                 _gpgme_trace_func, _gpgme_trace_tagname,                \
92                 _gpgme_trace_tag), 0
93 #define TRACE_BEG1(lvl, name, tag, fmt, arg1)                           \
94   _TRACE (lvl, name, tag);                                              \
95   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): enter: " fmt "\n",   \
96                 _gpgme_trace_func, _gpgme_trace_tagname,                \
97                 _gpgme_trace_tag, arg1), 0
98 #define TRACE_BEG2(lvl, name, tag, fmt, arg1, arg2)                 \
99   _TRACE (lvl, name, tag);                                          \
100   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): enter: " fmt "\n", \
101                 _gpgme_trace_func, _gpgme_trace_tagname,            \
102                 _gpgme_trace_tag, arg1, arg2), 0
103 #define TRACE_BEG3(lvl, name, tag, fmt, arg1, arg2, arg3)           \
104   _TRACE (lvl, name, tag);                                          \
105   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): enter: " fmt "\n", \
106                 _gpgme_trace_func, _gpgme_trace_tagname,            \
107                 _gpgme_trace_tag, arg1, arg2, arg3), 0
108 #define TRACE_BEG4(lvl, name, tag, fmt, arg1, arg2, arg3, arg4)     \
109   _TRACE (lvl, name, tag);                                          \
110   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): enter: " fmt "\n", \
111                 _gpgme_trace_func, _gpgme_trace_tagname,            \
112                 _gpgme_trace_tag, arg1, arg2, arg3, arg4), 0
113
114 #define TRACE(lvl, name, tag)                                           \
115   _gpgme_debug (lvl, "%s (%s=0x%x): call\n",                            \
116                 name, STRINGIFY (tag), (void *) tag), 0
117 #define TRACE0(lvl, name, tag, fmt)                                     \
118   _gpgme_debug (lvl, "%s (%s=0x%x): call: " fmt "\n",                   \
119                 name, STRINGIFY (tag), (void *) tag), 0
120 #define TRACE1(lvl, name, tag, fmt, arg1)                              \
121   _gpgme_debug (lvl, "%s (%s=0x%x): call: " fmt "\n",                  \
122                 name, STRINGIFY (tag), (void *) tag, arg1), 0
123 #define TRACE2(lvl, name, tag, fmt, arg1, arg2)                        \
124   _gpgme_debug (lvl, "%s (%s=0x%x): call: " fmt "\n",                  \
125                 name, STRINGIFY (tag), (void *) tag, arg1, arg2), 0
126 #define TRACE3(lvl, name, tag, fmt, arg1, arg2, arg3)                  \
127   _gpgme_debug (lvl, "%s (%s=0x%x): call: " fmt "\n",                  \
128                 name, STRINGIFY (tag), (void *) tag, arg1, arg2,       \
129                 arg3), 0
130 #define TRACE6(lvl, name, tag, fmt, arg1, arg2, arg3, arg4, arg5, arg6) \
131   _gpgme_debug (lvl, "%s (%s=0x%x): call: " fmt "\n",                   \
132                 name, STRINGIFY (tag), (void *) tag, arg1, arg2, arg3,  \
133                 arg4, arg5, arg6), 0
134
135 #define TRACE_ERR(err)                                                  \
136   err == 0 ? (TRACE_SUC ()) :                                           \
137     (_gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): error: %s <%s>\n",        \
138                    _gpgme_trace_func, _gpgme_trace_tagname,             \
139                    _gpgme_trace_tag, gpgme_strerror (err),              \
140                    gpgme_strsource (err)), (err))
141 /* The cast to void suppresses GCC warnings.  */
142 #define TRACE_SYSRES(res)                                               \
143   res >= 0 ? ((void) (TRACE_SUC1 ("result=%i", res)), (res)) :          \
144     (_gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): error: %s\n",     \
145                    _gpgme_trace_func, _gpgme_trace_tagname,             \
146                    _gpgme_trace_tag, strerror (errno)), (res))
147 #define TRACE_SYSERR(res)                                               \
148   res == 0 ? ((void) (TRACE_SUC1 ("result=%i", res)), (res)) :          \
149     (_gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): error: %s\n",     \
150                    _gpgme_trace_func, _gpgme_trace_tagname,             \
151                    _gpgme_trace_tag, strerror (res)), (res))
152
153 #define TRACE_SUC()                                              \
154   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): leave\n",       \
155                 _gpgme_trace_func, _gpgme_trace_tagname,         \
156                 _gpgme_trace_tag), 0
157 #define TRACE_SUC0(fmt)                                                 \
158   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): leave: " fmt "\n",   \
159                 _gpgme_trace_func, _gpgme_trace_tagname,                \
160                 _gpgme_trace_tag), 0
161 #define TRACE_SUC1(fmt, arg1)                                           \
162   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): leave: " fmt "\n",   \
163                 _gpgme_trace_func, _gpgme_trace_tagname,                \
164                 _gpgme_trace_tag, arg1), 0
165 #define TRACE_SUC2(fmt, arg1, arg2)                                     \
166   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): leave: " fmt "\n",   \
167                 _gpgme_trace_func, _gpgme_trace_tagname,                \
168                 _gpgme_trace_tag, arg1, arg2), 0
169 #define TRACE_SUC5(fmt, arg1, arg2, arg3, arg4, arg5)                   \
170   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): leave: " fmt "\n",   \
171                 _gpgme_trace_func, _gpgme_trace_tagname,                \
172                 _gpgme_trace_tag, arg1, arg2, arg3, arg4, arg5), 0
173
174 #define TRACE_LOG(fmt)                                                  \
175   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): check: " fmt "\n",   \
176                 _gpgme_trace_func, _gpgme_trace_tagname,                \
177                 _gpgme_trace_tag), 0
178 #define TRACE_LOG1(fmt, arg1)                                           \
179   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): check: " fmt "\n",   \
180                 _gpgme_trace_func, _gpgme_trace_tagname,                \
181                 _gpgme_trace_tag, arg1), 0
182 #define TRACE_LOG2(fmt, arg1, arg2)                                 \
183   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): check: " fmt "\n", \
184                 _gpgme_trace_func, _gpgme_trace_tagname,            \
185                 _gpgme_trace_tag, arg1, arg2), 0
186 #define TRACE_LOG3(fmt, arg1, arg2, arg3)                           \
187   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): check: " fmt "\n", \
188                 _gpgme_trace_func, _gpgme_trace_tagname,            \
189                 _gpgme_trace_tag, arg1, arg2, arg3), 0
190 #define TRACE_LOG4(fmt, arg1, arg2, arg3, arg4)                     \
191   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): check: " fmt "\n", \
192                 _gpgme_trace_func, _gpgme_trace_tagname,            \
193                 _gpgme_trace_tag, arg1, arg2, arg3, arg4), 0
194 #define TRACE_LOG6(fmt, arg1, arg2, arg3, arg4, arg5, arg6)         \
195   _gpgme_debug (_gpgme_trace_level, "%s (%s=0x%x): check: " fmt "\n", \
196                 _gpgme_trace_func, _gpgme_trace_tagname,            \
197                 _gpgme_trace_tag, arg1, arg2, arg3, arg4, arg5,     \
198                 arg6), 0
199
200 #define TRACE_LOGBUF(buf, len)                                          \
201   _gpgme_debug_buffer (_gpgme_trace_level, "%s (%s=0x%x): check: %s",   \
202                        _gpgme_trace_func, _gpgme_trace_tagname,         \
203                        _gpgme_trace_tag, buf, len)
204
205 #define TRACE_SEQ(hlp,fmt)                                              \
206   _gpgme_debug_begin (&(hlp), _gpgme_trace_level,                       \
207                       "%s (%s=0x%x): check: " fmt,                      \
208                       _gpgme_trace_func, _gpgme_trace_tagname,          \
209                       _gpgme_trace_tag)
210 #define TRACE_ADD0(hlp,fmt) \
211   _gpgme_debug_add (&(hlp), fmt)
212 #define TRACE_ADD1(hlp,fmt,a) \
213   _gpgme_debug_add (&(hlp), fmt, (a))
214 #define TRACE_ADD2(hlp,fmt,a,b) \
215   _gpgme_debug_add (&(hlp), fmt, (a), (b))
216 #define TRACE_ADD3(hlp,fmt,a,b,c) \
217   _gpgme_debug_add (&(hlp), fmt, (a), (b), (c))
218 #define TRACE_END(hlp,fmt) \
219   _gpgme_debug_add (&(hlp), fmt); \
220   _gpgme_debug_end (&(hlp))
221 #define TRACE_ENABLED(hlp) (!!(hlp))
222
223 #endif  /* DEBUG_H */