Add a massive set of changes for converting to use the ast_debug() macro.
[asterisk/asterisk.git] / main / threadstorage.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Kevin P. Fleming <kpfleming@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Debugging support for thread-local-storage objects
22  *
23  * \author Kevin P. Fleming <kpfleming@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 #if defined(DEBUG_THREADLOCALS)
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <string.h>
35
36 #include "asterisk/logger.h"
37 #include "asterisk/strings.h"
38 #include "asterisk/utils.h"
39 #include "asterisk/threadstorage.h"
40 #include "asterisk/linkedlists.h"
41 #include "asterisk/cli.h"
42
43 struct tls_object {
44         void *key;
45         size_t size;
46         const char *file;
47         const char *function;
48         unsigned int line;
49         pthread_t thread;
50         AST_LIST_ENTRY(tls_object) entry;
51 };
52
53 static AST_RWLIST_HEAD_STATIC(tls_objects, tls_object);
54
55 void __ast_threadstorage_object_add(void *key, size_t len, const char *file, const char *function, unsigned int line)
56 {
57         struct tls_object *to;
58
59         if (!(to = ast_calloc(sizeof(*to), 1)))
60                 return;
61
62         to->key = key;
63         to->size = len;
64         to->file = file;
65         to->function = function;
66         to->line = line;
67         to->thread = pthread_self();
68
69         AST_RWLIST_WRLOCK(&tls_objects);
70         AST_LIST_INSERT_TAIL(&tls_objects, to, entry);
71         AST_RWLIST_UNLOCK(&tls_objects);
72 }
73
74 void __ast_threadstorage_object_remove(void *key)
75 {
76         struct tls_object *to;
77
78         AST_RWLIST_WRLOCK(&tls_objects);
79         AST_LIST_TRAVERSE_SAFE_BEGIN(&tls_objects, to, entry) {
80                 if (to->key == key) {
81                         AST_LIST_REMOVE_CURRENT(&tls_objects, entry);
82                         break;
83                 }
84         }
85         AST_LIST_TRAVERSE_SAFE_END;
86         AST_RWLIST_UNLOCK(&tls_objects);
87         if (to)
88                 ast_free(to);
89 }
90
91 void __ast_threadstorage_object_replace(void *key_old, void *key_new, size_t len)
92 {
93         struct tls_object *to;
94
95         AST_RWLIST_WRLOCK(&tls_objects);
96         AST_LIST_TRAVERSE_SAFE_BEGIN(&tls_objects, to, entry) {
97                 if (to->key == key_old) {
98                         to->key = key_new;
99                         to->size = len;
100                         break;
101                 }
102         }
103         AST_LIST_TRAVERSE_SAFE_END;
104         AST_RWLIST_UNLOCK(&tls_objects);
105 }
106
107 static int handle_show_allocations(int fd, int argc, char *argv[])
108 {
109         char *fn = NULL;
110         size_t len = 0;
111         unsigned int count = 0;
112         struct tls_object *to;
113
114         if (argc > 3)
115                 fn = argv[3];
116
117         AST_RWLIST_RDLOCK(&tls_objects);
118
119         AST_LIST_TRAVERSE(&tls_objects, to, entry) {
120                 if (fn && strcasecmp(to->file, fn))
121                         continue;
122
123                 ast_cli(fd, "%10d bytes allocated in %20s at line %5d of %25s (thread %p)\n",
124                         (int) to->size, to->function, to->line, to->file, (void *) to->thread);
125                 len += to->size;
126                 count++;
127         }
128
129         AST_RWLIST_UNLOCK(&tls_objects);
130
131         ast_cli(fd, "%10d bytes allocated in %d allocation%s\n", (int) len, count, count > 1 ? "s" : "");
132         
133         return RESULT_SUCCESS;
134 }
135
136 static int handle_show_summary(int fd, int argc, char *argv[])
137 {
138         char *fn = NULL;
139         size_t len = 0;
140         unsigned int count = 0;
141         struct tls_object *to;
142         struct file {
143                 const char *name;
144                 size_t len;
145                 unsigned int count;
146                 AST_LIST_ENTRY(file) entry;
147         } *file;
148         AST_LIST_HEAD_NOLOCK_STATIC(file_summary, file);
149
150         if (argc > 3)
151                 fn = argv[3];
152
153         AST_RWLIST_RDLOCK(&tls_objects);
154
155         AST_LIST_TRAVERSE(&tls_objects, to, entry) {
156                 if (fn && strcasecmp(to->file, fn))
157                         continue;
158
159                 AST_LIST_TRAVERSE(&file_summary, file, entry) {
160                         if ((!fn && (file->name == to->file)) || (fn && (file->name == to->function)))
161                                 break;
162                 }
163
164                 if (!file) {
165                         file = alloca(sizeof(*file));
166                         memset(file, 0, sizeof(*file));
167                         file->name = fn ? to->function : to->file;
168                         AST_LIST_INSERT_TAIL(&file_summary, file, entry);
169                 }
170
171                 file->len += to->size;
172                 file->count++;
173         }
174
175         AST_RWLIST_UNLOCK(&tls_objects);
176         
177         AST_LIST_TRAVERSE(&file_summary, file, entry) {
178                 len += file->len;
179                 count += file->count;
180                 if (fn) {
181                         ast_cli(fd, "%10d bytes in %d allocation%ss in function %s\n",
182                                 (int) file->len, file->count, file->count > 1 ? "s" : "", file->name);
183                 } else {
184                         ast_cli(fd, "%10d bytes in %d allocation%s in file %s\n",
185                                 (int) file->len, file->count, file->count > 1 ? "s" : "", file->name);
186                 }
187         }
188
189         ast_cli(fd, "%10d bytes allocated in %d allocation%s\n", (int) len, count, count > 1 ? "s" : "");
190         
191         return RESULT_SUCCESS;
192 }
193
194 static struct ast_cli_entry cli[] = {
195         {
196                 .cmda = { "threadstorage", "show", "allocations", NULL },
197                 .handler = handle_show_allocations,
198                 .summary = "Display outstanding thread local storage allocations",
199                 .usage =
200                 "Usage: threadstorage show allocations [<file>]\n"
201                 "       Dumps a list of all thread-specific memory allocations,\n"
202                 "optionally limited to those from a specific file\n",
203         },
204         {
205                 .cmda = { "threadstorage", "show", "summary", NULL },
206                 .handler = handle_show_summary,
207                 .summary = "Summarize outstanding memory allocations",
208                 .usage =
209                 "Usage: threadstorage show summary [<file>]\n"
210                 "       Summarizes thread-specific memory allocations by file, or optionally\n"
211                 "by function, if a file is specified\n",
212         },
213 };
214
215 void threadstorage_init(void)
216 {
217         ast_cli_register_multiple(cli, sizeof(cli) / sizeof(cli[0]));
218 }
219
220 #else /* !defined(DEBUG_THREADLOCALS) */
221
222 void threadstorage_init(void)
223 {
224 }
225
226 #endif /* !defined(DEBUG_THREADLOCALS) */
227