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