xref: /netbsd-src/sys/dev/raidframe/rf_debugMem.h (revision bada23909e740596d0a3785a73bd3583a9807fb8)
1 /*	$NetBSD: rf_debugMem.h,v 1.4 1999/02/05 00:06:08 oster Exp $	*/
2 /*
3  * Copyright (c) 1995 Carnegie-Mellon University.
4  * All rights reserved.
5  *
6  * Author: Daniel Stodolsky, Mark Holland
7  *
8  * Permission to use, copy, modify and distribute this software and
9  * its documentation is hereby granted, provided that both the copyright
10  * notice and this permission notice appear in all copies of the
11  * software, derivative works or modified versions, and any portions
12  * thereof, and that both notices appear in supporting documentation.
13  *
14  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
15  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND
16  * FOR ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
17  *
18  * Carnegie Mellon requests users of this software to return to
19  *
20  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
21  *  School of Computer Science
22  *  Carnegie Mellon University
23  *  Pittsburgh PA 15213-3890
24  *
25  * any improvements or extensions that they make and grant Carnegie the
26  * rights to redistribute these changes.
27  */
28 
29 /*
30  * rf_debugMem.h -- memory leak debugging module
31  *
32  * IMPORTANT:  if you put the lock/unlock mutex stuff back in here, you
33  *             need to take it out of the routines in debugMem.c
34  *
35  */
36 
37 #ifndef _RF__RF_DEBUGMEM_H_
38 #define _RF__RF_DEBUGMEM_H_
39 
40 #include "rf_archs.h"
41 #include "rf_alloclist.h"
42 #include "rf_options.h"
43 
44 #ifndef _KERNEL
45 
46 #ifndef __NetBSD__
47 void   *malloc(), *calloc();
48 #endif
49 RF_DECLARE_EXTERN_MUTEX(rf_debug_mem_mutex)
50 /*
51  * redzone malloc, calloc, and free allocate an extra 16 bytes on each
52  * malloc/calloc call to allow tracking of overflows on free.
53  */
54 
55 #if RF_MEMORY_REDZONES > 0
56 #define rf_redzone_malloc(_p_,_size_)     _p_ = rf_real_redzone_malloc(_size_)
57 #define rf_redzone_calloc(_p_,_n_,_size_) _p_ = rf_real_redzone_calloc(_n_,_size_)
58 #define rf_redzone_free(_p_)              rf_real_redzone_free(_p_, __LINE__, __FILE__)
59 #else				/* RF_MEMORY_REDZONES > 0 */
60 #define rf_redzone_malloc(_p_,_size_)        _p_ = malloc(_size_)
61 #define rf_redzone_calloc(_p_,_nel_,_size_)  _p_ = calloc(_nel_,_size_)
62 #define rf_redzone_free(_ptr_)             free(_ptr_)
63 #endif				/* RF_MEMORY_REDZONES > 0 */
64 
65 #define RF_Malloc(_p_, _size_, _cast_) { \
66       _p_ = _cast_ rf_real_Malloc(_size_, __LINE__, __FILE__); \
67 }
68 
69 #define RF_MallocAndAdd(_p_, _size_, _cast_, _alist_) { \
70       _p_ = _cast_ rf_real_MallocAndAdd(_size_, _alist_, __LINE__, __FILE__); \
71 }
72 
73 #define RF_Calloc(_p_, _nel_, _elsz_, _cast_) { \
74       _p_ = _cast_ rf_real_Calloc(_nel_, _elsz_, __LINE__, __FILE__); \
75 }
76 
77 #define RF_CallocAndAdd(_p_, _nel_, _elsz_, _cast_, _alist_) { \
78       _p_ = _cast_ rf_real_CallocAndAdd(_nel_, _elsz_, _alist_, __LINE__, __FILE__); \
79 }
80 
81 #define RF_Free(__p_, _sz_) { \
82       rf_real_Free(__p_, _sz_, __LINE__, __FILE__); \
83 }
84 
85 #else				/* KERNEL */
86 
87 #include <sys/types.h>
88 typedef u_int32_t U32;
89 #include <sys/malloc.h>
90 
91 
92 
93 #define RF_Malloc(_p_, _size_, _cast_)                                      \
94   {                                                                      \
95      _p_ = _cast_ malloc((u_long)_size_, M_RAIDFRAME, M_WAITOK); \
96      bzero((char *)_p_, _size_); \
97      if (rf_memDebug) rf_record_malloc(_p_, _size_, __LINE__, __FILE__);       \
98   }
99 
100 #define RF_MallocAndAdd(__p_, __size_, __cast_, __alist_)                   \
101   {                                                                      \
102      RF_Malloc(__p_, __size_, __cast_);                                     \
103      if (__alist_) rf_AddToAllocList(__alist_, __p_, __size_);              \
104   }
105 
106 #define RF_Calloc(_p_, _nel_, _elsz_, _cast_)                               \
107   {                                                                      \
108      RF_Malloc( _p_, (_nel_) * (_elsz_), _cast_);                           \
109      bzero( (_p_), (_nel_) * (_elsz_) );                                 \
110    }
111 
112 #define RF_CallocAndAdd(__p,__nel,__elsz,__cast,__alist)                     \
113   {                                                                       \
114      RF_Calloc(__p, __nel, __elsz, __cast);                                  \
115      if (__alist) rf_AddToAllocList(__alist, __p, (__nel)*(__elsz));         \
116   }
117 
118 #define RF_Free(_p_, _sz_)                                                   \
119   {                                                                       \
120 	free((void *)(_p_), M_RAIDFRAME);                                      \
121     if (rf_memDebug) rf_unrecord_malloc(_p_, (U32) (_sz_));                     \
122   }
123 
124 #endif				/* _KERNEL */
125 
126 #ifndef _KERNEL
127 void   *rf_real_redzone_malloc(int size);
128 void   *rf_real_redzone_calloc(int n, int size);
129 void    rf_real_redzone_free(char *p, int line, char *filen);
130 char   *rf_real_Malloc(int size, int line, char *file);
131 char   *rf_real_Calloc(int nel, int elsz, int line, char *file);
132 void    rf_real_Free(void *p, int sz, int line, char *file);
133 void    rf_validate_mh_table(void);
134 #if RF_UTILITY == 0
135 char   *rf_real_MallocAndAdd(int size, RF_AllocListElem_t * alist, int line, char *file);
136 char   *rf_real_CallocAndAdd(int nel, int elsz, RF_AllocListElem_t * alist, int line, char *file);
137 #endif				/* RF_UTILITY == 0 */
138 #endif				/* !KERNEL */
139 
140 void    rf_record_malloc(void *p, int size, int line, char *filen);
141 void    rf_unrecord_malloc(void *p, int sz);
142 void    rf_print_unfreed(void);
143 int     rf_ConfigureDebugMem(RF_ShutdownList_t ** listp);
144 void    rf_ReportMaxMem(void);
145 
146 #endif				/* !_RF__RF_DEBUGMEM_H_ */
147