Enable macros in 1.8 to find the next highest "h" extension in a context, like in...
[asterisk/asterisk.git] / utils / refcounter.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2008, Steve Murphy
5  *
6  * Steve Murphy <murf@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 /*! \file
19  *
20  *  \brief A program to read in the /tmp/refs file generated
21  *         by astobj2 code when the REF_DEBUG macro is defined.
22  *         It will read in the file line by line, and
23  *         sort the data out by object, and check to see
24  *         if the refcounts balance to zero, and the object
25  *         was destroyed just once. Any problems that are 
26  *         found are reported to stdout and the objects
27  *         ref count history is printed out. If all is well,
28  *         this program reads in the /tmp/refs file and 
29  *         generates no output. No news is good news.
30  *  The contents of the /tmp/refs file looks like this:
31  *
32 0x84fd718 -1   astobj2.c:926:cd_cb_debug (deref object via container destroy) [@1]
33 0x84fd718 =1   chan_sip.c:19760:build_user (allocate a user struct)
34 0x84fd718 +1   chan_sip.c:21558:reload_config (link user into users table) [@1]
35 0x84fd718 -1   chan_sip.c:2376:unref_user (Unref the result of build_user. Now, the table link is the only one left.) [@2]
36 0x84fd718 **call destructor** astobj2.c:926:cd_cb_debug (deref object via container destroy)
37  *
38  *
39  *  \author Steve Murphy <murf@digium.com>
40  */
41
42 /*** MODULEINFO
43         <support_level>extended</support_level>
44  ***/
45
46 #include "asterisk.h"
47 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
48
49 #include <pthread.h>
50 #include <sys/stat.h>
51 #include <signal.h>
52 #include <errno.h>
53 #include "asterisk/lock.h"
54 #include "asterisk/hashtab.h"
55 #include "asterisk/channel.h"
56 #include "asterisk/utils.h"
57 #include "asterisk/module.h"
58
59 struct rc_hist
60 {
61         char *desc;
62         struct rc_hist *next;
63 };
64
65 struct rc_obj /* short for refcounted object */
66 {
67         unsigned int addr;
68         unsigned int count;  /* this plus addr makes each entry unique, starts at 1 */
69         int last_count; /* count 1 objects will record how many other objects had the same addr */
70         int destroy_count;
71         int total_refcount;
72         struct rc_hist *hist;
73         struct rc_hist *last;
74 };
75
76 void pbx_substitute_variables_helper_full(struct ast_channel *c, struct varshead *headp, const char *cp1, char *cp2, int cp2_size, size_t *used);
77 void pbx_substitute_variables_helper_full(struct ast_channel *c, struct varshead *headp, const char *cp1, char *cp2, int cp2_size, size_t *used)
78 {
79 }
80
81 static unsigned int hashtab_hash_rc(const void *obj)
82 {
83         const struct rc_obj *rc = obj;
84         return rc->addr + rc->count; /* it's addr will make a FINE hash */
85 }
86
87 static int hashtab_compare_rc(const void *a, const void *b)
88 {
89         const struct rc_obj *rca = a;
90         const struct rc_obj *rcb = b;
91         if (rca->addr == rcb->addr && rca->count == rcb->count)
92                 return 0;
93         else
94                 return 1;
95 }
96
97
98 static struct rc_obj *alloc_obj(unsigned int addr, unsigned int count)
99 {
100         struct rc_obj *x = calloc(1,sizeof(struct rc_obj));
101         x->addr = addr;
102         x->count = count;
103         x->last_count = 1;
104         x->total_refcount = 1;
105         return x;
106 }
107
108 static void add_to_hist(char *buffer, struct rc_obj *obj)
109 {
110         struct rc_hist *y = calloc(1,sizeof(struct rc_hist));
111         y->desc = strdup(buffer);
112         if (obj->last) {
113                 obj->last->next = y;
114                 obj->last = y;
115         } else {
116                 obj->hist = obj->last = y;
117         }
118 }
119
120
121
122 int main(int argc,char **argv)
123 {
124         char linebuffer[300];
125         FILE *ifile = fopen("/tmp/refs", "r");
126         char *t;
127         unsigned int un;
128         struct rc_obj *curr_obj, *count1_obj;
129         struct rc_obj lookup;
130         struct ast_hashtab_iter *it;
131         struct ast_hashtab *objhash;
132         
133         if (!ifile) {
134                 printf("Sorry, Cannot open /tmp/refs!\n");
135                 exit(10);
136         }
137         
138         objhash = ast_hashtab_create(9000, hashtab_compare_rc, ast_hashtab_resize_java, ast_hashtab_newsize_java, hashtab_hash_rc, 1);
139         
140         while (fgets(linebuffer, sizeof(linebuffer), ifile)) {
141                 /* collect data about the entry */
142                 un = strtoul(linebuffer, &t, 16);
143                 lookup.addr = un;
144                 lookup.count = 1;
145
146                 count1_obj = ast_hashtab_lookup(objhash, &lookup);
147                 
148                 if (count1_obj) {
149                         /* there IS a count1 obj, so let's see which one we REALLY want */
150                         if (*(t+1) == '=') {
151                                 /* start a new object! */
152                                 curr_obj = alloc_obj(un, ++count1_obj->last_count);
153                                 /* put it in the hashtable */
154                                 ast_hashtab_insert_safe(objhash, curr_obj);
155                         } else {
156                                 if (count1_obj->last_count > 1) {
157                                         lookup.count = count1_obj->last_count;
158                                         curr_obj = ast_hashtab_lookup(objhash, &lookup);
159                                 } else {
160                                         curr_obj = count1_obj;
161                                 }
162                                 
163                         }
164
165                 } else {
166                         /* NO obj at ALL? -- better make one! */
167                         if (*(t+1) != '=') {
168                                 printf("BAD: object %x appears without previous allocation marker!\n", un);
169                         }
170                         curr_obj = count1_obj = alloc_obj(un, 1);
171                         /* put it in the hashtable */
172                         ast_hashtab_insert_safe(objhash, curr_obj);
173                         
174                 }
175                 
176                 if (*(t+1) == '+' || *(t+1) == '-' ) {
177                         curr_obj->total_refcount += strtol(t+1, NULL, 10);
178                 } else if (*(t+1) == '*') {
179                         curr_obj->destroy_count++;
180                 }
181                 
182                 add_to_hist(linebuffer, curr_obj);
183         }
184         fclose(ifile);
185         
186         /* traverse the objects and check for problems */
187         it = ast_hashtab_start_traversal(objhash);
188         while ((curr_obj = ast_hashtab_next(it))) {
189                 if (curr_obj->total_refcount != 0 || curr_obj->destroy_count != 1) {
190                         struct rc_hist *h;
191                         if (curr_obj->total_refcount != 0)
192                                 printf("Problem: net Refcount not zero for object %x\n", curr_obj->addr);
193                         if (curr_obj->destroy_count > 1 )
194                                 printf("Problem: Object %x destroyed more than once!\n", curr_obj->addr);
195                         printf("Object %x history:\n", curr_obj->addr);
196                         for(h=curr_obj->hist;h;h=h->next) {
197                                 printf("   %s", h->desc);
198                         }
199                         printf("==============\n");
200                 }
201         }
202         ast_hashtab_end_traversal(it);
203         return 0;
204 }
205
206
207 /* stub routines to satisfy linking with asterisk subcomponents */
208
209 #ifndef LOW_MEMORY
210 int  ast_add_profile(const char *x, uint64_t scale)
211 {
212         return 0;
213 }
214 #endif
215
216 int ast_loader_register(int (*updater)(void))
217 {
218         return 1;
219 }
220
221 int ast_loader_unregister(int (*updater)(void))
222 {
223         return 1;
224 }
225 void ast_module_register(const struct ast_module_info *x)
226 {
227 }
228
229 void ast_module_unregister(const struct ast_module_info *x)
230 {
231 }
232
233 #ifndef LOW_MEMORY
234 void ast_register_file_version(const char *file, const char *version)
235 {
236 }
237
238 void ast_unregister_file_version(const char *file)
239 {
240
241 }
242
243 #undef ast_mark
244
245 int64_t ast_mark(int x, int start1_stop0)
246 {
247         return 0;
248 }
249 #endif
250
251 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...)
252 {
253         va_list vars;
254         va_start(vars,fmt);
255         printf("LOG: lev:%d file:%s  line:%d func: %s  ",
256                    level, file, line, function);
257         vprintf(fmt, vars);
258         fflush(stdout);
259         va_end(vars);
260 }
261
262 void __ast_verbose(const char *file, int line, const char *func, int level, const char *fmt, ...)
263 {
264         va_list vars;
265         va_start(vars,fmt);
266
267         printf("VERBOSE: ");
268         vprintf(fmt, vars);
269         fflush(stdout);
270         va_end(vars);
271 }
272
273 void ast_register_thread(char *name)
274 {
275
276 }
277
278 void ast_unregister_thread(void *id)
279 {
280 }
281 #ifdef HAVE_BKTR
282 struct ast_bt *ast_bt_create(void);
283 struct ast_bt *ast_bt_create(void) 
284 {
285         return NULL;
286 }
287
288 int ast_bt_get_addresses(struct ast_bt *bt);
289 int ast_bt_get_addresses(struct ast_bt *bt)
290 {
291         return 0;
292 }
293
294 char **ast_bt_get_symbols(void **addresses, size_t num_frames);
295 char **ast_bt_get_symbols(void **addresses, size_t num_frames)
296 {
297         char **foo = calloc(num_frames, sizeof(char *) + 1);
298         if (foo) {
299                 int i;
300                 for (i = 0; i < num_frames; i++) {
301                         foo[i] = (char *) foo + sizeof(char *) * num_frames;
302                 }
303         }
304         return foo;
305 }
306
307 void *ast_bt_destroy(struct ast_bt *bt);
308 void *ast_bt_destroy(struct ast_bt *bt)
309 {
310         return NULL;
311 }
312 #endif