Write to memory management log
[asterisk/asterisk.git] / astmm.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Channel Variables
5  * 
6  * Copyright (C) 2002, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14
15
16 #ifdef __AST_DEBUG_MALLOC
17
18 #include <malloc.h>
19 #include <stdio.h>
20 #include <string.h>
21 #include <pthread.h>
22 #include <time.h>
23 #include <asterisk/cli.h>
24 #include <asterisk/logger.h>
25 #include <asterisk/options.h>
26
27 #define SOME_PRIME 563
28
29 #define FUNC_CALLOC             1
30 #define FUNC_MALLOC             2
31 #define FUNC_REALLOC    3
32 #define FUNC_STRDUP             4
33 #define FUNC_STRNDUP    5
34
35 /* Undefine all our macros */
36 #undef malloc
37 #undef calloc
38 #undef realloc
39 #undef strdup
40 #undef strndup
41 #undef free
42
43 static FILE *mmlog;
44
45 static struct ast_region {
46         struct ast_region *next;
47         char file[40];
48         char func[40];
49         int lineno;
50         int which;
51         size_t len;
52         unsigned char data[0];
53 } *regions[SOME_PRIME];
54
55 #define HASH(a) \
56         (((unsigned long)(a)) % SOME_PRIME)
57         
58 static pthread_mutex_t reglock = PTHREAD_MUTEX_INITIALIZER;
59
60 static inline void *__ast_alloc_region(size_t size, int which, const char *file, int lineno, const char *func)
61 {
62         struct ast_region *reg;
63         void *ptr=NULL;
64         int hash;
65         reg = malloc(size + sizeof(struct ast_region));
66         pthread_mutex_lock(&reglock);
67         if (reg) {
68                 strncpy(reg->file, file, sizeof(reg->file) - 1);
69                 reg->file[sizeof(reg->file) - 1] = '\0';
70                 strncpy(reg->func, func, sizeof(reg->func) - 1);
71                 reg->func[sizeof(reg->func) - 1] = '\0';
72                 reg->lineno = lineno;
73                 reg->len = size;
74                 reg->which = which;
75                 ptr = reg->data;
76                 hash = HASH(ptr);
77                 reg->next = regions[hash];
78                 regions[hash] = reg;
79         }
80         pthread_mutex_unlock(&reglock);
81         if (!reg) {
82                 fprintf(stderr, "Out of memory :(\n");
83                 if (mmlog)
84                         fprintf(stderr, "%ld - Out of memory\n", time(NULL));
85         }
86         return ptr;
87 }
88
89 static inline size_t __ast_sizeof_region(void *ptr)
90 {
91         int hash = HASH(ptr);
92         struct ast_region *reg;
93         size_t len = 0;
94         
95         pthread_mutex_lock(&reglock);
96         reg = regions[hash];
97         while(reg) {
98                 if (reg->data == ptr) {
99                         len = reg->len;
100                         break;
101                 }
102                 reg = reg->next;
103         }
104         pthread_mutex_unlock(&reglock);
105         return len;
106 }
107
108 static void __ast_free_region(void *ptr, const char *file, int lineno, const char *func)
109 {
110         int hash = HASH(ptr);
111         struct ast_region *reg, *prev = NULL;
112         pthread_mutex_lock(&reglock);
113         reg = regions[hash];
114         while(reg) {
115                 if (reg->data == ptr) {
116                         if (prev)
117                                 prev->next = reg->next;
118                         else
119                                 regions[hash] = reg->next;
120
121                         break;
122                 }
123                 prev = reg;
124                 reg = reg->next;
125         }
126         pthread_mutex_unlock(&reglock);
127         if (reg) {
128                 free(reg);
129         } else {
130                 fprintf(stderr, "WARNING: Freeing unused memory at %p, in %s of %s, line %d\n",
131                         ptr, func, file, lineno);
132                 if (mmlog)
133                         fprintf(mmlog, "%ld - WARNING: Freeing unused memory at %p, in %s of %s, line %d\n", time(NULL),
134                         ptr, func, file, lineno);
135         }
136 }
137
138 void *__ast_calloc(size_t nmemb, size_t size, const char *file, int lineno, const char *func) 
139 {
140         void *ptr;
141         ptr = __ast_alloc_region(size * nmemb, FUNC_CALLOC, file, lineno, func);
142         if (ptr) 
143                 memset(ptr, 0, size * nmemb);
144         return ptr;
145 }
146
147 void *__ast_malloc(size_t size, const char *file, int lineno, const char *func) 
148 {
149         return __ast_alloc_region(size, FUNC_MALLOC, file, lineno, func);
150 }
151
152 void __ast_free(void *ptr, const char *file, int lineno, const char *func) 
153 {
154         __ast_free_region(ptr, file, lineno, func);
155 }
156
157 void *__ast_realloc(void *ptr, size_t size, const char *file, int lineno, const char *func) 
158 {
159         void *tmp;
160         size_t len=0;
161         if (ptr) {
162                 len = __ast_sizeof_region(ptr);
163                 if (!len) {
164                         fprintf(stderr, "WARNING: Realloc of unalloced memory at %p, in %s of %s, line %d\n",
165                                 ptr, func, file, lineno);
166                         if (mmlog)
167                                 fprintf(mmlog, "%ld - WARNING: Realloc of unalloced memory at %p, in %s of %s, line %d\n",
168                                         time(NULL), ptr, func, file, lineno);
169                         return NULL;
170                 }
171         }
172         tmp = __ast_alloc_region(size, FUNC_REALLOC, file, lineno, func);
173         if (tmp) {
174                 if (len > size)
175                         len = size;
176                 if (ptr) {
177                         memcpy(tmp, ptr, len);
178                         __ast_free_region(ptr, file, lineno, func);
179                 }
180         }
181         return tmp;
182 }
183
184 char *__ast_strdup(const char *s, const char *file, int lineno, const char *func) 
185 {
186         size_t len;
187         void *ptr;
188         if (!s)
189                 return NULL;
190         len = strlen(s) + 1;
191         ptr = __ast_alloc_region(len, FUNC_STRDUP, file, lineno, func);
192         if (ptr)
193                 strcpy(ptr, s);
194         return ptr;
195 }
196
197 char *__ast_strndup(const char *s, size_t n, const char *file, int lineno, const char *func) 
198 {
199         size_t len;
200         void *ptr;
201         if (!s)
202                 return NULL;
203         len = strlen(s) + 1;
204         if (len > n)
205                 len = n;
206         ptr = __ast_alloc_region(len, FUNC_STRDUP, file, lineno, func);
207         if (ptr)
208                 strcpy(ptr, s);
209         return ptr;
210 }
211
212 static int handle_show_memory(int fd, int argc, char *argv[])
213 {
214         char *fn = NULL;
215         int x;
216         struct ast_region *reg;
217         unsigned int len=0;
218         int count = 0;
219         if (argc >3) 
220                 fn = argv[3];
221
222         /* try to lock applications list ... */
223         pthread_mutex_lock(&reglock);
224
225         for (x=0;x<SOME_PRIME;x++) {
226                 reg = regions[x];
227                 while(reg) {
228                         if (!fn || !strcasecmp(fn, reg->file)) {
229                                 ast_cli(fd, "%10d bytes allocated in %20s at line %5d of %s\n", reg->len, reg->func, reg->lineno, reg->file);
230                                 len += reg->len;
231                                 count++;
232                         }
233                         reg = reg->next;
234                 }
235         }
236         ast_cli(fd, "%d bytes allocated %d units total\n", len, count);
237         pthread_mutex_unlock(&reglock);
238         return RESULT_SUCCESS;
239 }
240
241 struct file_summary {
242         char fn[80];
243         int len;
244         int count;
245         struct file_summary *next;
246 };
247
248 static int handle_show_memory_summary(int fd, int argc, char *argv[])
249 {
250         char *fn = NULL;
251         int x;
252         struct ast_region *reg;
253         unsigned int len=0;
254         int count = 0;
255         struct file_summary *list = NULL, *cur;
256         
257         if (argc >3) 
258                 fn = argv[3];
259
260         /* try to lock applications list ... */
261         pthread_mutex_lock(&reglock);
262
263         for (x=0;x<SOME_PRIME;x++) {
264                 reg = regions[x];
265                 while(reg) {
266                         if (!fn || !strcasecmp(fn, reg->file)) {
267                                 cur = list;
268                                 while(cur) {
269                                         if ((!fn && !strcmp(cur->fn, reg->file)) || (fn && !strcmp(cur->fn, reg->func)))
270                                                 break;
271                                         cur = cur->next;
272                                 }
273                                 if (!cur) {
274                                         cur = alloca(sizeof(struct file_summary));
275                                         memset(cur, 0, sizeof(struct file_summary));
276                                         strncpy(cur->fn, fn ? reg->func : reg->file, sizeof(cur->fn) - 1);
277                                         cur->next = list;
278                                         list = cur;
279                                 }
280                                 cur->len += reg->len;
281                                 cur->count++;
282                         }
283                         reg = reg->next;
284                 }
285         }
286         pthread_mutex_unlock(&reglock);
287         
288         /* Dump the whole list */
289         while(list) {
290                 cur = list;
291                 len += list->len;
292                 count += list->count;
293                 if (fn)
294                         ast_cli(fd, "%10d bytes in %5d allocations in function '%s' of '%s'\n", list->len, list->count, list->fn, fn);
295                 else
296                         ast_cli(fd, "%10d bytes in %5d allocations in file '%s'\n", list->len, list->count, list->fn);
297                 list = list->next;
298 #if 0
299                 free(cur);
300 #endif          
301         }
302         ast_cli(fd, "%d bytes allocated %d units total\n", len, count);
303         return RESULT_SUCCESS;
304 }
305
306 static char show_memory_help[] = 
307 "Usage: show memory allocations [<file>]\n"
308 "       Dumps a list of all segments of allocated memory, optionally\n"
309 "limited to those from a specific file\n";
310
311 static char show_memory_summary_help[] = 
312 "Usage: show memory summary [<file>]\n"
313 "       Summarizes heap memory allocations by file, or optionally\n"
314 "by function, if a file is specified\n";
315
316 static struct ast_cli_entry show_memory_allocations_cli = 
317         { { "show", "memory", "allocations", NULL }, 
318         handle_show_memory, "Display outstanding memory allocations",
319         show_memory_help };
320
321 static struct ast_cli_entry show_memory_summary_cli = 
322         { { "show", "memory", "summary", NULL }, 
323         handle_show_memory_summary, "Summarize outstanding memory allocations",
324         show_memory_summary_help };
325
326
327 void __ast_mm_init(void)
328 {
329         ast_cli_register(&show_memory_allocations_cli);
330         ast_cli_register(&show_memory_summary_cli);
331         mmlog = fopen("/var/log/asterisk/mmlog", "a+");
332         if (option_verbose)
333                 ast_verbose("Asterisk Malloc Debugger Started (see /var/log/mmlog)\n");
334         if (mmlog)
335                 fprintf(mmlog, "%ld - New session\n", time(NULL));
336 }
337
338 #endif