3 * $Id: track.h,v 1.5 1999/12/10 23:42:04 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.5 1999/12/10 23:42:04 mdw
34 * Change header file guard names.
36 * Revision 1.4 1999/10/22 22:40:25 mdw
37 * Change naming slightly. Still not documented, though.
39 * Revision 1.3 1999/05/06 19:51:36 mdw
40 * Reformatted the LGPL notice a little bit.
42 * Revision 1.2 1999/05/05 18:50:31 mdw
43 * Change licensing conditions to LGPL.
45 * Revision 1.1.1.1 1998/06/17 23:44:42 mdw
46 * Initial version of mLib
59 /*----- Options and conventions -------------------------------------------*
61 * The following macros affect the tracking system:
63 * @TRACK_ENABLE@: Enable tracking of memory allocations
64 * @TRACK_BLAME@: Register my context blocks in allocations
66 * The reason there are two switches is simple. It's often the case that a
67 * library routine allocates memory for its client. Therefore, whether we
68 * want to record the library or the client depends on how much we trust
69 * the two pieces of software. Setting @TRACK_ENABLE@ and @TRACK_BLAME@
70 * suggests that the current source file might leak memory, so we want its
71 * context markers in the list. Setting @TRACK_ENABLE@ but not
72 * @TRACK_BLAME@ suggests that we trust this code, but not the code which
73 * calls it, so we want to preserve the caller's context markers.
78 /*----- Type definitions --------------------------------------------------*/
80 /* --- A context buffer --- */
82 typedef struct track_ctx {
83 struct track_ctx *next;
87 /*----- Functions provided ------------------------------------------------*/
89 /* --- @track_level@ --- *
91 * Arguments: @unsigned int l@ = tracing level for allocation messages
95 * Use: Sets the trace level for allocation messages.
98 extern void track_level(unsigned int /*l*/);
100 /* --- @track_push@ --- *
102 * Arguments: @track_ctx *ctx@ = context holder to push
106 * Use: Pushes the given context block onto the stack.
109 extern void track_push(track_ctx */*ctx*/);
111 /* --- @track_pop@ --- *
113 * Arguments: @track_ctx *ctx@ = context holder to pop
117 * Use: Removes the given context block from the stack.
120 extern void track_pop(track_ctx */*ctx*/);
122 /* --- @track_malloc@ --- *
124 * Arguments: @size_t sz@ = size requested
126 * Returns: Pointer to allocated space, or null
128 * Use: Allocates memory, and tracks how much is allocated.
131 extern void *track_malloc(size_t /*sz*/);
133 /* --- @track_free@ --- *
135 * Arguments: @void *p@ = pointer to an allocated block
139 * Use: Frees memory, and tracks how much is still allocated.
142 extern void track_free(void */*p*/);
144 /* --- @track_realloc@ --- *
146 * Arguments: @void *p@ = pointer to an allocated block
147 * @size_t sz@ = how big it wants to be
149 * Returns: Pointer to the new block.
151 * Use: Reallocates a block, tracking how much memory is still
155 extern void *track_realloc(void */*p*/, size_t /*sz*/);
157 /* --- @track_used@ --- *
161 * Returns: A count of how much memory is used currently.
163 * Use: Returns the amount of memory which the @track_@-functions
164 * above have counted as being currently allocated.
167 extern unsigned long track_used(void);
169 /* --- @track_list@ --- *
171 * Arguments: @unsigned int l@ = trace level to use
175 * Use: Traces a dump of the currently known blocks. Combined with
176 * a verbose dump of allocations and deallocations, and a
177 * good idea of which blocks were allocated where, this can
178 * be useful for locating memory leaks. It's not exactly a
182 extern void track_list(unsigned int l);
184 /*----- Macro wrappers ----------------------------------------------------*/
186 /* --- If tracking is to be done, set it up --- */
190 # define malloc(sz) track_malloc(sz)
192 # define free(p) track_free(p)
194 # define realloc(p, sz) track_realloc(p, sz)
197 /* --- Provide a context for doing track-related things --- */
205 /* --- Handle contexts --- */
207 #if defined(TRACK_ENABLE) && defined(TRACK_BLAME)
208 # define TRACK_NCTX(name, string) track_ctx name = { 0, string }
209 # define TRACK_NPUSH(name) track_push(name)
210 # define TRACK_NPOP(name) track_pop(name)
211 # define TRACK_CTX(string) TRACK_NCTX(__track_ctx, string)
212 # define TRACK_PUSH TRACK_NPUSH(__track_ctx)
213 # define TRACK_POP TRACK_NPOP(__track_ctx)
215 # define TRACK_NCTX(name, string)
216 # define TRACK_NPUSH(name) ((void)0)
217 # define TRACK_NPOP(name) ((void)0)
218 # define TRACK_CTX(string)
219 # define TRACK_PUSH ((void)0)
220 # define TRACK_POP ((void)0)
223 /*----- That's all, folks -------------------------------------------------*/