chiark / gitweb /
Add global unihash table; use universal hashing instead of CRC.
[mLib] / trace.c
1 /* -*-c-*-
2  *
3  * $Id: trace.c,v 1.7 2002/01/13 13:34:32 mdw Exp $
4  *
5  * Tracing functions for debugging
6  *
7  * (c) 1998 Straylight/Edgeware
8  */
9
10 /*----- Licensing notice --------------------------------------------------* 
11  *
12  * This file is part of the mLib utilities library.
13  *
14  * mLib is free software; you can redistribute it and/or modify
15  * it under the terms of the GNU Library General Public License as
16  * published by the Free Software Foundation; either version 2 of the
17  * License, or (at your option) any later version.
18  * 
19  * mLib is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU Library General Public License for more details.
23  * 
24  * You should have received a copy of the GNU Library General Public
25  * License along with mLib; if not, write to the Free
26  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
27  * MA 02111-1307, USA.
28  */
29
30 /*----- Revision history --------------------------------------------------*
31  *
32  * $Log: trace.c,v $
33  * Revision 1.7  2002/01/13 13:34:32  mdw
34  * Track @dstr_vputf@ interface change.
35  *
36  * Revision 1.6  2001/02/03 16:23:55  mdw
37  * New custom trace output interface.
38  *
39  * Revision 1.5  1999/10/22 22:39:52  mdw
40  * New documented interface for tracing.
41  *
42  * Revision 1.4  1999/05/19 20:27:11  mdw
43  * Change naming to match newer mLib conventions.
44  *
45  * Revision 1.3  1999/05/06 19:51:35  mdw
46  * Reformatted the LGPL notice a little bit.
47  *
48  * Revision 1.2  1999/05/05 18:50:31  mdw
49  * Change licensing conditions to LGPL.
50  *
51  * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
52  * Initial version of mLib
53  *
54  */
55
56 /*----- Header files ------------------------------------------------------*/
57
58 /* --- ANSI headers --- */
59
60 #include <ctype.h>
61 #include <stdarg.h>
62 #include <stdio.h>
63 #include <stdlib.h>
64 #include <string.h>
65
66 /* --- Local headers --- */
67
68 #include "dstr.h"
69 #include "quis.h"
70 #include "trace.h"
71
72 /*----- Private state information -----------------------------------------*/
73
74 static void (*tracefunc)(const char *buf, size_t sz, void *v) = 0;
75 static void *tracearg;
76 static unsigned tracelvl = 0;           /* How much tracing gets done? */
77
78 /*----- Functions provided ------------------------------------------------*/
79
80 /* --- @t_file@ --- *
81  *
82  * Arguments:   @const char *buf@ = buffer to print
83  *              @size_t sz@ = buffer size
84  *              @void *v@ = file handle
85  *
86  * Returns:     ---
87  *
88  * Use:         Dumps tracing information to a file.
89  */
90
91 static void t_file(const char *buf, size_t sz, void *v)
92 {
93   FILE *fp = v;
94   fprintf(fp, "+ %s: ", QUIS);
95   fwrite(buf, 1, sz, fp);
96   fputc('\n', fp);
97 }
98
99 /* --- @trace@ --- *
100  *
101  * Arguments:   @unsigned l@ = trace level for output
102  *              @const char *f@ = a @printf@-style format string
103  *              @...@ = other arguments
104  *
105  * Returns:     ---
106  *
107  * Use:         Reports a message to the trace output.
108  */
109
110 void trace(unsigned l, const char *f, ...)
111 {
112   va_list ap;
113   dstr d = DSTR_INIT;
114   if ((l & tracing()) == 0)
115     return;
116   va_start(ap, f);
117   dstr_vputf(&d, f, &ap);
118   va_end(ap);
119   tracefunc(d.buf, d.len, tracearg);
120   dstr_destroy(&d);
121 }
122
123 /* --- @trace_block@ --- *
124  *
125  * Arguments:   @unsigned l@ = trace level for output
126  *              @const char *s@ = some header string to write
127  *              @const void *b@ = pointer to a block of memory to dump
128  *              @size_t sz@ = size of the block of memory
129  *
130  * Returns:     ---
131  *
132  * Use:         Dumps the contents of a block to the trace output.
133  */
134
135 void trace_block(unsigned l, const char *s, const void *b, size_t sz)
136 {
137   const unsigned char *p = b;
138   size_t i;
139   unsigned long o = 0;
140   dstr d = DSTR_INIT;
141   size_t c;
142
143   /* --- Skip if the trace level is too high --- */
144
145   if ((l & tracing()) == 0)
146     return;
147
148   /* --- Now start work --- */
149
150   tracefunc(s, strlen(s), tracearg);
151   while (sz) {
152     dstr_reset(&d);
153     dstr_putf(&d, "   %08lx : ", o);
154     for (i = 0; i < 8; i++) {
155       if (i < sz)
156         dstr_putf(&d, "%02x ", p[i]);
157       else
158         dstr_puts(&d, "** ");
159     }
160     dstr_puts(&d, ": ");
161     for (i = 0; i < 8; i++) {
162       if (i < sz)
163         dstr_putc(&d, isprint(p[i]) ? p[i] : '.');
164       else
165         dstr_putc(&d, '*');
166     }
167     dstr_putz(&d);
168     tracefunc(d.buf, d.len, tracearg);
169     c = (sz >= 8) ? 8 : sz;
170     sz -= c, p += c, o += c;
171   }
172   dstr_destroy(&d);
173 }
174
175 /* --- @trace_on@ --- *
176  *
177  * Arguments:   @FILE *fp@ = a file to trace on
178  *              @unsigned l@ = trace level to set
179  *
180  * Returns:     ---
181  *
182  * Use:         Enables tracing to a file.
183  */
184
185 void trace_on(FILE *fp, unsigned l)
186 {
187   tracefunc = t_file;
188   tracearg = fp;
189   if (!tracelvl)
190     tracelvl = l;
191 }
192
193 /* --- @trace_custom@ --- *
194  *
195  * Arguments:   @void (*func)(const char *buf, size_t sz, void *v)@ =
196  *                      output function
197  *              @void *v@ = magic handle to give to function
198  *
199  * Returns:     ---
200  *
201  * Use:         Sets up a custom trace handler.
202  */
203
204 void trace_custom(void (*func)(const char */*buf*/,
205                                size_t /*sz*/, void */*v*/),
206                   void *v)
207 {
208   tracefunc = func;
209   tracearg = v;
210 }
211
212 /* --- @trace_level@ --- *
213  *
214  * Arguments:   @unsigned l@ = trace level to set
215  *
216  * Returns:     ---
217  *
218  * Use:         Sets the tracing level.
219  */
220
221 void trace_level(unsigned l)
222 {
223   tracelvl = l;
224 }
225
226 /* --- @tracing@ --- *
227  *
228  * Arguments:   ---
229  *
230  * Returns:     Zero if not tracing, tracing level if tracing.
231  *
232  * Use:         Informs the caller whether tracing is enabled.
233  */
234
235 unsigned tracing(void)
236 {
237   return (tracefunc ? tracelvl : 0u);
238 }
239
240 /*----- That's all, folks -------------------------------------------------*/