mark this revision as merged manually
[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 #include "asterisk.h"
43 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
44
45 #include <pthread.h>
46 #include <sys/stat.h>
47 #include <signal.h>
48 #include <errno.h>
49 #include "asterisk/lock.h"
50 #include "asterisk/hashtab.h"
51 #include "asterisk/channel.h"
52 #include "asterisk/utils.h"
53 #include "asterisk/module.h"
54
55 struct rc_hist
56 {
57         char *desc;
58         struct rc_hist *next;
59 };
60
61 struct rc_obj /* short for refcounted object */
62 {
63         unsigned int addr;
64         unsigned int count;  /* this plus addr makes each entry unique, starts at 1 */
65         int last_count; /* count 1 objects will record how many other objects had the same addr */
66         int destroy_count;
67         int total_refcount;
68         struct rc_hist *hist;
69         struct rc_hist *last;
70 };
71
72 static unsigned int hashtab_hash_rc(const void *obj)
73 {
74         const struct rc_obj *rc = obj;
75         return rc->addr + rc->count; /* it's addr will make a FINE hash */
76 }
77
78 static int hashtab_compare_rc(const void *a, const void *b)
79 {
80         const struct rc_obj *rca = a;
81         const struct rc_obj *rcb = b;
82         if (rca->addr == rcb->addr && rca->count == rcb->count)
83                 return 0;
84         else
85                 return 1;
86 }
87
88
89 static struct rc_obj *alloc_obj(unsigned int addr, unsigned int count)
90 {
91         struct rc_obj *x = calloc(1,sizeof(struct rc_obj));
92         x->addr = addr;
93         x->count = count;
94         x->last_count = 1;
95         x->total_refcount = 1;
96         return x;
97 }
98
99 static void add_to_hist(char *buffer, struct rc_obj *obj)
100 {
101         struct rc_hist *y = calloc(1,sizeof(struct rc_hist));
102         y->desc = strdup(buffer);
103         if (obj->last) {
104                 obj->last->next = y;
105                 obj->last = y;
106         } else {
107                 obj->hist = obj->last = y;
108         }
109 }
110
111
112
113 int main(int argc,char **argv)
114 {
115         char linebuffer[300];
116         FILE *ifile = fopen("/tmp/refs", "r");
117         char *t;
118         unsigned int un;
119         struct rc_obj *curr_obj, *count1_obj;
120         struct rc_obj lookup;
121         struct ast_hashtab_iter *it;
122         struct ast_hashtab *objhash;
123         
124         if (!ifile) {
125                 printf("Sorry, Cannot open /tmp/refs!\n");
126                 exit(10);
127         }
128         
129         objhash = ast_hashtab_create(9000, hashtab_compare_rc, ast_hashtab_resize_java, ast_hashtab_newsize_java, hashtab_hash_rc, 1);
130         
131         while (fgets(linebuffer, sizeof(linebuffer), ifile)) {
132                 /* collect data about the entry */
133                 un = strtoul(linebuffer, &t, 16);
134                 lookup.addr = un;
135                 lookup.count = 1;
136
137                 count1_obj = ast_hashtab_lookup(objhash, &lookup);
138                 
139                 if (count1_obj) {
140                         /* there IS a count1 obj, so let's see which one we REALLY want */
141                         if (*(t+1) == '=') {
142                                 /* start a new object! */
143                                 curr_obj = alloc_obj(un, ++count1_obj->last_count);
144                                 /* put it in the hashtable */
145                                 ast_hashtab_insert_safe(objhash, curr_obj);
146                         } else {
147                                 if (count1_obj->last_count > 1) {
148                                         lookup.count = count1_obj->last_count;
149                                         curr_obj = ast_hashtab_lookup(objhash, &lookup);
150                                 } else {
151                                         curr_obj = count1_obj;
152                                 }
153                                 
154                         }
155
156                 } else {
157                         /* NO obj at ALL? -- better make one! */
158                         if (*(t+1) != '=') {
159                                 printf("BAD: object %x appears without previous allocation marker!\n", count1_obj->addr);
160                         }
161                         curr_obj = count1_obj = alloc_obj(un, 1);
162                         /* put it in the hashtable */
163                         ast_hashtab_insert_safe(objhash, curr_obj);
164                         
165                 }
166                 
167                 if (*(t+1) == '+' || *(t+1) == '-' ) {
168                         curr_obj->total_refcount += strtol(t+1, NULL, 10);
169                 } else if (*(t+1) == '*') {
170                         curr_obj->destroy_count++;
171                 }
172                 
173                 add_to_hist(linebuffer, curr_obj);
174         }
175         fclose(ifile);
176         
177         /* traverse the objects and check for problems */
178         it = ast_hashtab_start_traversal(objhash);
179         while ((curr_obj = ast_hashtab_next(it))) {
180                 if (curr_obj->total_refcount != 0 || curr_obj->destroy_count != 1) {
181                         struct rc_hist *h;
182                         if (curr_obj->total_refcount != 0)
183                                 printf("Problem: net Refcount not zero for object %x\n", curr_obj->addr);
184                         if (curr_obj->destroy_count > 1 )
185                                 printf("Problem: Object %x destroyed more than once!\n", curr_obj->addr);
186                         printf("Object %x history:\n", curr_obj->addr);
187                         for(h=curr_obj->hist;h;h=h->next) {
188                                 printf("   %s", h->desc);
189                         }
190                         printf("==============\n");
191                 }
192         }
193         ast_hashtab_end_traversal(it);
194         return 0;
195 }
196
197
198 /* stub routines to satisfy linking with asterisk subcomponents */
199
200 #ifndef LOW_MEMORY
201 int  ast_add_profile(const char *x, uint64_t scale)
202 {
203         return 0;
204 }
205 #endif
206
207 int ast_loader_register(int (*updater)(void))
208 {
209         return 1;
210 }
211
212 int ast_loader_unregister(int (*updater)(void))
213 {
214         return 1;
215 }
216 void ast_module_register(const struct ast_module_info *x)
217 {
218 }
219
220 void ast_module_unregister(const struct ast_module_info *x)
221 {
222 }
223
224 #ifndef LOW_MEMORY
225 void ast_register_file_version(const char *file, const char *version)
226 {
227 }
228
229 void ast_unregister_file_version(const char *file)
230 {
231
232 }
233
234 #undef ast_mark
235
236 int64_t ast_mark(int x, int start1_stop0)
237 {
238         return 0;
239 }
240 #endif
241
242 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...)
243 {
244         va_list vars;
245         va_start(vars,fmt);
246         printf("LOG: lev:%d file:%s  line:%d func: %s  ",
247                    level, file, line, function);
248         vprintf(fmt, vars);
249         fflush(stdout);
250         va_end(vars);
251 }
252
253 void __ast_verbose(const char *file, int line, const char *func, const char *fmt, ...)
254 {
255         va_list vars;
256         va_start(vars,fmt);
257
258         printf("VERBOSE: ");
259         vprintf(fmt, vars);
260         fflush(stdout);
261         va_end(vars);
262 }
263
264 void ast_register_thread(char *name)
265 {
266
267 }
268
269 void ast_unregister_thread(void *id)
270 {
271 }
272 #ifdef HAVE_BKTR
273 struct ast_bt *ast_bt_create(void);
274 struct ast_bt *ast_bt_create(void) 
275 {
276         return NULL;
277 }
278
279 int ast_bt_get_addresses(struct ast_bt *bt);
280 int ast_bt_get_addresses(struct ast_bt *bt)
281 {
282         return 0;
283 }
284
285 void *ast_bt_destroy(struct ast_bt *bt);
286 void *ast_bt_destroy(struct ast_bt *bt)
287 {
288         return NULL;
289 }
290 #endif