3 * $Id: trace.c,v 1.3 1999/05/06 19:51:35 mdw Exp $
5 * Tracing functions for debugging
7 * (c) 1998 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of the mLib utilities library.
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.
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.
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,
30 /*----- Revision history --------------------------------------------------*
33 * Revision 1.3 1999/05/06 19:51:35 mdw
34 * Reformatted the LGPL notice a little bit.
36 * Revision 1.2 1999/05/05 18:50:31 mdw
37 * Change licensing conditions to LGPL.
39 * Revision 1.1.1.1 1998/06/17 23:44:42 mdw
40 * Initial version of mLib
44 /*----- Header files ------------------------------------------------------*/
46 /* --- ANSI headers --- */
54 /* --- Local headers --- */
59 /*----- Private state information -----------------------------------------*/
61 static FILE *trace__fp
= 0; /* Where does debugging go? */
62 static unsigned int trace__lvl
= 0; /* How much tracing gets done? */
64 /*----- Functions provided ------------------------------------------------*/
68 * Arguments: @unsigned int l@ = trace level for output
69 * @const char *f@ = a @printf@-style format string
70 * @...@ = other arguments
74 * Use: Reports a message to the trace output.
77 void trace(unsigned int l
, const char *f
, ...)
80 if ((l
& tracing()) == 0)
83 fprintf(trace__fp
, "*** %s: ", QUIS
);
84 vfprintf(trace__fp
, f
, ap
);
86 putc('\n', trace__fp
);
90 /* --- @trace_block@ --- *
92 * Arguments: @unsigned int l@ = trace level for output
93 * @const char *s@ = some header string to write
94 * @const void *b@ = pointer to a block of memory to dump
95 * @size_t sz@ = size of the block of memory
99 * Use: Dumps the contents of a block to the trace output.
102 void trace_block(unsigned int l
, const char *s
, const void *b
, size_t sz
)
104 const unsigned char *p
= b
;
109 /* --- Skip if the trace level is too high --- */
111 if ((l
& tracing()) == 0)
114 /* --- Now start work --- */
116 fprintf(trace__fp
, "*** %s: %s\n", QUIS
, s
);
119 fprintf(trace__fp
, "*** %s: %08lx : ", QUIS
, o
);
120 for (i
= 0; i
< 8; i
++) {
122 fprintf(trace__fp
, "%02x ", p
[i
]);
124 fputs("** ", trace__fp
);
126 fputs(": ", trace__fp
);
127 for (i
= 0; i
< 8; i
++) {
129 fputc(isprint(p
[i
]) ? p
[i
] : '.', trace__fp
);
131 fputc('*', trace__fp
);
133 fputc('\n', trace__fp
);
134 c
= (sz
>= 8) ?
8 : sz
;
135 sz
-= c
, p
+= c
, o
+= c
;
140 /* --- @trace_on@ --- *
142 * Arguments: @FILE *fp@ = a file to trace on
143 * @unsigned int l@ = trace level to set
147 * Use: Enables tracing to a file.
150 void trace_on(FILE *fp
, unsigned int l
)
157 /* --- @trace_setLevel@ --- *
159 * Arguments: @unsigned int l@ = trace level to set
163 * Use: Sets the tracing level.
166 void trace_setLevel(unsigned int l
)
171 /* --- @tracing@ --- *
175 * Returns: Zero if not tracing, tracing level if tracing.
177 * Use: Informs the caller whether tracing is enabled.
180 unsigned int tracing(void)
182 return (trace__fp ? trace__lvl
: 0u);
185 /*----- That's all, folks -------------------------------------------------*/