3 * $Id: track.h,v 1.6 2004/04/08 01:36:13 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,
39 /*----- Options and conventions -------------------------------------------*
41 * The following macros affect the tracking system:
43 * @TRACK_ENABLE@: Enable tracking of memory allocations
44 * @TRACK_BLAME@: Register my context blocks in allocations
46 * The reason there are two switches is simple. It's often the case that a
47 * library routine allocates memory for its client. Therefore, whether we
48 * want to record the library or the client depends on how much we trust
49 * the two pieces of software. Setting @TRACK_ENABLE@ and @TRACK_BLAME@
50 * suggests that the current source file might leak memory, so we want its
51 * context markers in the list. Setting @TRACK_ENABLE@ but not
52 * @TRACK_BLAME@ suggests that we trust this code, but not the code which
53 * calls it, so we want to preserve the caller's context markers.
58 /*----- Type definitions --------------------------------------------------*/
60 /* --- A context buffer --- */
62 typedef struct track_ctx {
63 struct track_ctx *next;
67 /*----- Functions provided ------------------------------------------------*/
69 /* --- @track_level@ --- *
71 * Arguments: @unsigned int l@ = tracing level for allocation messages
75 * Use: Sets the trace level for allocation messages.
78 extern void track_level(unsigned int /*l*/);
80 /* --- @track_push@ --- *
82 * Arguments: @track_ctx *ctx@ = context holder to push
86 * Use: Pushes the given context block onto the stack.
89 extern void track_push(track_ctx */*ctx*/);
91 /* --- @track_pop@ --- *
93 * Arguments: @track_ctx *ctx@ = context holder to pop
97 * Use: Removes the given context block from the stack.
100 extern void track_pop(track_ctx */*ctx*/);
102 /* --- @track_malloc@ --- *
104 * Arguments: @size_t sz@ = size requested
106 * Returns: Pointer to allocated space, or null
108 * Use: Allocates memory, and tracks how much is allocated.
111 extern void *track_malloc(size_t /*sz*/);
113 /* --- @track_free@ --- *
115 * Arguments: @void *p@ = pointer to an allocated block
119 * Use: Frees memory, and tracks how much is still allocated.
122 extern void track_free(void */*p*/);
124 /* --- @track_realloc@ --- *
126 * Arguments: @void *p@ = pointer to an allocated block
127 * @size_t sz@ = how big it wants to be
129 * Returns: Pointer to the new block.
131 * Use: Reallocates a block, tracking how much memory is still
135 extern void *track_realloc(void */*p*/, size_t /*sz*/);
137 /* --- @track_used@ --- *
141 * Returns: A count of how much memory is used currently.
143 * Use: Returns the amount of memory which the @track_@-functions
144 * above have counted as being currently allocated.
147 extern unsigned long track_used(void);
149 /* --- @track_list@ --- *
151 * Arguments: @unsigned int l@ = trace level to use
155 * Use: Traces a dump of the currently known blocks. Combined with
156 * a verbose dump of allocations and deallocations, and a
157 * good idea of which blocks were allocated where, this can
158 * be useful for locating memory leaks. It's not exactly a
162 extern void track_list(unsigned int l);
164 /*----- Macro wrappers ----------------------------------------------------*/
166 /* --- If tracking is to be done, set it up --- */
170 # define malloc(sz) track_malloc(sz)
172 # define free(p) track_free(p)
174 # define realloc(p, sz) track_realloc(p, sz)
177 /* --- Provide a context for doing track-related things --- */
185 /* --- Handle contexts --- */
187 #if defined(TRACK_ENABLE) && defined(TRACK_BLAME)
188 # define TRACK_NCTX(name, string) track_ctx name = { 0, string }
189 # define TRACK_NPUSH(name) track_push(name)
190 # define TRACK_NPOP(name) track_pop(name)
191 # define TRACK_CTX(string) TRACK_NCTX(__track_ctx, string)
192 # define TRACK_PUSH TRACK_NPUSH(__track_ctx)
193 # define TRACK_POP TRACK_NPOP(__track_ctx)
195 # define TRACK_NCTX(name, string)
196 # define TRACK_NPUSH(name) ((void)0)
197 # define TRACK_NPOP(name) ((void)0)
198 # define TRACK_CTX(string)
199 # define TRACK_PUSH ((void)0)
200 # define TRACK_POP ((void)0)
203 /*----- That's all, folks -------------------------------------------------*/