2009-10-26 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                           void *tag, const char *const buffer, size_t len);
77
78 \f
79 /* Trace support.  */
80
81 /* FIXME: For now.  */
82 #define _gpgme_debug_trace() 1
83
84 #define _TRACE(lvl, name, tag)                                  \
85   int _gpgme_trace_level = lvl;                                 \
86   const char *const _gpgme_trace_func = name;                   \
87   const char *const _gpgme_trace_tagname = STRINGIFY (tag);     \
88   void *_gpgme_trace_tag = (void *) (uintptr_t) tag
89
90 #define TRACE_BEG(lvl, name, tag)                          \
91   _TRACE (lvl, name, tag);                                 \
92   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): enter\n", \
93                 _gpgme_trace_func, _gpgme_trace_tagname,   \
94                 _gpgme_trace_tag), 0
95 #define TRACE_BEG0(lvl, name, tag, fmt)                                 \
96   _TRACE (lvl, name, tag);                                              \
97   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): enter: " fmt "\n",     \
98                 _gpgme_trace_func, _gpgme_trace_tagname,                \
99                 _gpgme_trace_tag), 0
100 #define TRACE_BEG1(lvl, name, tag, fmt, arg1)                           \
101   _TRACE (lvl, name, tag);                                              \
102   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): enter: " fmt "\n",     \
103                 _gpgme_trace_func, _gpgme_trace_tagname,                \
104                 _gpgme_trace_tag, arg1), 0
105 #define TRACE_BEG2(lvl, name, tag, fmt, arg1, arg2)                 \
106   _TRACE (lvl, name, tag);                                          \
107   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): enter: " fmt "\n", \
108                 _gpgme_trace_func, _gpgme_trace_tagname,            \
109                 _gpgme_trace_tag, arg1, arg2), 0
110 #define TRACE_BEG3(lvl, name, tag, fmt, arg1, arg2, arg3)           \
111   _TRACE (lvl, name, tag);                                          \
112   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): enter: " fmt "\n", \
113                 _gpgme_trace_func, _gpgme_trace_tagname,            \
114                 _gpgme_trace_tag, arg1, arg2, arg3), 0
115 #define TRACE_BEG4(lvl, name, tag, fmt, arg1, arg2, arg3, arg4)     \
116   _TRACE (lvl, name, tag);                                          \
117   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): enter: " fmt "\n", \
118                 _gpgme_trace_func, _gpgme_trace_tagname,            \
119                 _gpgme_trace_tag, arg1, arg2, arg3, arg4), 0
120
121 #define TRACE(lvl, name, tag)                                           \
122   _gpgme_debug (lvl, "%s (%s=%p): call\n",                              \
123                 name, STRINGIFY (tag), (void *) (uintptr_t) tag), 0
124 #define TRACE0(lvl, name, tag, fmt)                                     \
125   _gpgme_debug (lvl, "%s (%s=%p): call: " fmt "\n",                     \
126                 name, STRINGIFY (tag), (void *) (uintptr_t) tag), 0
127 #define TRACE1(lvl, name, tag, fmt, arg1)                              \
128   _gpgme_debug (lvl, "%s (%s=%p): call: " fmt "\n",                    \
129                 name, STRINGIFY (tag), (void *) (uintptr_t) tag, arg1), 0
130 #define TRACE2(lvl, name, tag, fmt, arg1, arg2)                        \
131   _gpgme_debug (lvl, "%s (%s=%p): call: " fmt "\n",                    \
132                 name, STRINGIFY (tag), (void *) (uintptr_t) tag, arg1, \
133                 arg2), 0
134 #define TRACE3(lvl, name, tag, fmt, arg1, arg2, arg3)                  \
135   _gpgme_debug (lvl, "%s (%s=%p): call: " fmt "\n",                    \
136                 name, STRINGIFY (tag), (void *) (uintptr_t) tag, arg1, \
137                 arg2, arg3), 0
138 #define TRACE6(lvl, name, tag, fmt, arg1, arg2, arg3, arg4, arg5, arg6) \
139   _gpgme_debug (lvl, "%s (%s=%p): call: " fmt "\n",                     \
140                 name, STRINGIFY (tag), (void *) (uintptr_t) tag, arg1,  \
141                 arg2, arg3, arg4, arg5, arg6), 0
142
143 #define TRACE_ERR(err)                                                  \
144   err == 0 ? (TRACE_SUC ()) :                                           \
145     (_gpgme_debug (_gpgme_trace_level, "%s (%s=%p): error: %s <%s>\n",  \
146                    _gpgme_trace_func, _gpgme_trace_tagname,             \
147                    _gpgme_trace_tag, gpgme_strerror (err),              \
148                    gpgme_strsource (err)), (err))
149 /* The cast to void suppresses GCC warnings.  */
150 #define TRACE_SYSRES(res)                                               \
151   res >= 0 ? ((void) (TRACE_SUC1 ("result=%i", res)), (res)) :          \
152     (_gpgme_debug (_gpgme_trace_level, "%s (%s=%p): error: %s\n",       \
153                    _gpgme_trace_func, _gpgme_trace_tagname,             \
154                    _gpgme_trace_tag, strerror (errno)), (res))
155 #define TRACE_SYSERR(res)                                               \
156   res == 0 ? ((void) (TRACE_SUC1 ("result=%i", res)), (res)) :          \
157     (_gpgme_debug (_gpgme_trace_level, "%s (%s=%p): error: %s\n",       \
158                    _gpgme_trace_func, _gpgme_trace_tagname,             \
159                    _gpgme_trace_tag, strerror (res)), (res))
160
161 #define TRACE_SUC()                                              \
162   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): leave\n",       \
163                 _gpgme_trace_func, _gpgme_trace_tagname,         \
164                 _gpgme_trace_tag), 0
165 #define TRACE_SUC0(fmt)                                                 \
166   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): leave: " fmt "\n",     \
167                 _gpgme_trace_func, _gpgme_trace_tagname,                \
168                 _gpgme_trace_tag), 0
169 #define TRACE_SUC1(fmt, arg1)                                           \
170   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): leave: " fmt "\n",     \
171                 _gpgme_trace_func, _gpgme_trace_tagname,                \
172                 _gpgme_trace_tag, arg1), 0
173 #define TRACE_SUC2(fmt, arg1, arg2)                                     \
174   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): leave: " fmt "\n",     \
175                 _gpgme_trace_func, _gpgme_trace_tagname,                \
176                 _gpgme_trace_tag, arg1, arg2), 0
177 #define TRACE_SUC5(fmt, arg1, arg2, arg3, arg4, arg5)                   \
178   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): leave: " fmt "\n",     \
179                 _gpgme_trace_func, _gpgme_trace_tagname,                \
180                 _gpgme_trace_tag, arg1, arg2, arg3, arg4, arg5), 0
181
182 #define TRACE_LOG(fmt)                                                  \
183   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): check: " fmt "\n",     \
184                 _gpgme_trace_func, _gpgme_trace_tagname,                \
185                 _gpgme_trace_tag), 0
186 #define TRACE_LOG1(fmt, arg1)                                           \
187   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): check: " fmt "\n",     \
188                 _gpgme_trace_func, _gpgme_trace_tagname,                \
189                 _gpgme_trace_tag, arg1), 0
190 #define TRACE_LOG2(fmt, arg1, arg2)                                 \
191   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): check: " fmt "\n", \
192                 _gpgme_trace_func, _gpgme_trace_tagname,            \
193                 _gpgme_trace_tag, arg1, arg2), 0
194 #define TRACE_LOG3(fmt, arg1, arg2, arg3)                           \
195   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): check: " fmt "\n", \
196                 _gpgme_trace_func, _gpgme_trace_tagname,            \
197                 _gpgme_trace_tag, arg1, arg2, arg3), 0
198 #define TRACE_LOG4(fmt, arg1, arg2, arg3, arg4)                     \
199   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): check: " fmt "\n", \
200                 _gpgme_trace_func, _gpgme_trace_tagname,            \
201                 _gpgme_trace_tag, arg1, arg2, arg3, arg4), 0
202 #define TRACE_LOG6(fmt, arg1, arg2, arg3, arg4, arg5, arg6)         \
203   _gpgme_debug (_gpgme_trace_level, "%s (%s=%p): check: " fmt "\n", \
204                 _gpgme_trace_func, _gpgme_trace_tagname,            \
205                 _gpgme_trace_tag, arg1, arg2, arg3, arg4, arg5,     \
206                 arg6), 0
207
208 #define TRACE_LOGBUF(buf, len)                                          \
209   _gpgme_debug_buffer (_gpgme_trace_level, "%s (%s=%p): check: %s",     \
210                        _gpgme_trace_func, _gpgme_trace_tagname,         \
211                        _gpgme_trace_tag, buf, len)
212
213 #define TRACE_SEQ(hlp,fmt)                                              \
214   _gpgme_debug_begin (&(hlp), _gpgme_trace_level,                       \
215                       "%s (%s=%p): check: " fmt,                        \
216                       _gpgme_trace_func, _gpgme_trace_tagname,          \
217                       _gpgme_trace_tag)
218 #define TRACE_ADD0(hlp,fmt) \
219   _gpgme_debug_add (&(hlp), fmt)
220 #define TRACE_ADD1(hlp,fmt,a) \
221   _gpgme_debug_add (&(hlp), fmt, (a))
222 #define TRACE_ADD2(hlp,fmt,a,b) \
223   _gpgme_debug_add (&(hlp), fmt, (a), (b))
224 #define TRACE_ADD3(hlp,fmt,a,b,c) \
225   _gpgme_debug_add (&(hlp), fmt, (a), (b), (c))
226 #define TRACE_END(hlp,fmt) \
227   _gpgme_debug_add (&(hlp), fmt); \
228   _gpgme_debug_end (&(hlp))
229 #define TRACE_ENABLED(hlp) (!!(hlp))
230
231 #endif  /* DEBUG_H */