Fix a linkage error related to the lock backtrace support
[asterisk/asterisk.git] / utils / check_expr.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@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 #include "asterisk.h"
20 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
21
22 #include "asterisk/ast_expr.h"
23
24 #define AST_API_MODULE 1
25 #include "asterisk/inline_api.h"
26
27 #define AST_API_MODULE 1
28 #include "asterisk/lock.h"
29
30 #include "asterisk/strings.h"
31
32 /* I included this from utils.c, so as not to have everything in that .c
33    file included */
34 /*!
35  * core handler for dynamic strings.
36  * This is not meant to be called directly, but rather through the
37  * various wrapper macros
38  *      ast_str_set(...)
39  *      ast_str_append(...)
40  *      ast_str_set_va(...)
41  *      ast_str_append_va(...)
42  */
43 int __attribute__((format (printf, 4, 0))) __ast_str_helper(struct ast_str **buf, size_t max_len,
44         int append, const char *fmt, va_list ap)
45 {
46         int res, need;
47         int offset = (append && (*buf)->len) ? (*buf)->used : 0;
48
49         if (max_len < 0)
50                 max_len = (*buf)->len;  /* don't exceed the allocated space */
51         /*
52          * Ask vsnprintf how much space we need. Remember that vsnprintf
53          * does not count the final '\0' so we must add 1.
54          */
55         res = vsnprintf((*buf)->str + offset, (*buf)->len - offset, fmt, ap);
56
57         need = res + offset + 1;
58         /*
59          * If there is not enough space and we are below the max length,
60          * reallocate the buffer and return a message telling to retry.
61          */
62         if (need > (*buf)->len && (max_len == 0 || (*buf)->len < max_len) ) {
63                 if (max_len && max_len < need)  /* truncate as needed */
64                         need = max_len;
65                 else if (max_len == 0)  /* if unbounded, give more room for next time */
66                         need += 16 + need/4;
67                 if (ast_str_make_space(buf, need)) {
68                         return AST_DYNSTR_BUILD_FAILED;
69                 }
70                 (*buf)->str[offset] = '\0';     /* Truncate the partial write. */
71
72                 /* va_end() and va_start() must be done before calling
73                  * vsnprintf() again. */
74                 return AST_DYNSTR_BUILD_RETRY;
75         }
76         /* update space used, keep in mind the truncation */
77         (*buf)->used = (res + offset > (*buf)->len) ? (*buf)->len : res + offset;
78
79         return res;
80 }
81 #ifndef DEBUG_THREADS
82 enum ast_lock_type {
83                 AST_MUTEX,
84                 AST_RDLOCK,
85                 AST_WRLOCK,
86 };
87 #endif
88 #if !defined(LOW_MEMORY)
89 #ifdef HAVE_BKTR
90 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
91                         int line_num, const char *func, const char *lock_name, void *lock_addr, struct ast_bt *bt);
92 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
93                         int line_num, const char *func, const char *lock_name, void *lock_addr, struct ast_bt *bt)
94 {
95     /* not a lot to do in a standalone w/o threading! */
96 }
97
98 void ast_remove_lock_info(void *lock_addr, struct ast_bt *bt);
99 void ast_remove_lock_info(void *lock_addr, struct ast_bt *bt)
100 {
101     /* not a lot to do in a standalone w/o threading! */
102 }
103 #else
104 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
105                         int line_num, const char *func, const char *lock_name, void *lock_addr);
106 void ast_store_lock_info(enum ast_lock_type type, const char *filename,
107                         int line_num, const char *func, const char *lock_name, void *lock_addr)
108 {
109     /* not a lot to do in a standalone w/o threading! */
110 }
111
112 void ast_remove_lock_info(void *lock_addr);
113 void ast_remove_lock_info(void *lock_addr)
114 {
115     /* not a lot to do in a standalone w/o threading! */
116 }
117 #endif /* HAVE_BKTR */
118
119 void ast_mark_lock_acquired(void *);
120 void ast_mark_lock_acquired(void *foo)
121 {
122     /* not a lot to do in a standalone w/o threading! */
123 }
124 #endif
125
126 int ast_bt_get_addresses(struct ast_bt *bt);
127 int ast_bt_get_addresses(struct ast_bt *bt)
128 {
129         /* Suck it, you stupid utils directory! */
130         return 0;
131 }
132
133 static int global_lineno = 1;
134 static int global_expr_count=0;
135 static int global_expr_max_size=0;
136 static int global_expr_tot_size=0;
137 static int global_warn_count=0;
138 static int global_OK_count=0;
139
140 struct varz
141 {
142         char varname[100]; /* a really ultra-simple, space-wasting linked list of var=val data */
143         char varval[1000]; /* if any varname is bigger than 100 chars, or val greater than 1000, then **CRASH** */
144         struct varz *next;
145 };
146
147 struct varz *global_varlist;
148
149 /* Our own version of ast_log, since the expr parser uses it. */
150
151 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...) __attribute__ ((format (printf,5,6)));
152
153 void ast_log(int level, const char *file, int line, const char *function, const char *fmt, ...)
154 {
155         va_list vars;
156         va_start(vars,fmt);
157         
158         printf("LOG: lev:%d file:%s  line:%d func: %s  ",
159                    level, file, line, function);
160         vprintf(fmt, vars);
161         fflush(stdout);
162         va_end(vars);
163 }
164 //void ast_register_file_version(const char *file, const char *version);
165 //void ast_unregister_file_version(const char *file);
166
167 char *find_var(const char *varname);
168 void set_var(const char *varname, const char *varval);
169 unsigned int check_expr(char* buffer, char* error_report);
170 int check_eval(char *buffer, char *error_report);
171 void parse_file(const char *fname);
172
173 void ast_register_file_version(const char *file, const char *version);  
174 void ast_register_file_version(const char *file, const char *version) { }
175 #if !defined(LOW_MEMORY)
176 int ast_add_profile(const char *x, uint64_t scale) { return 0;} 
177 #endif
178 int ast_atomic_fetchadd_int_slow(volatile int *p, int v)
179 {
180         int ret;
181         ret = *p;
182         *p += v;
183         return ret;
184 }
185
186 void ast_unregister_file_version(const char *file);
187 void ast_unregister_file_version(const char *file)
188 {
189 }
190
191 char *find_var(const char *varname) /* the list should be pretty short, if there's any list at all */
192 {
193         struct varz *t;
194         for (t= global_varlist; t; t = t->next) {
195                 if (!strcmp(t->varname, varname)) {
196                         return t->varval;
197                 }
198         }
199         return 0;
200 }
201
202 void set_var(const char *varname, const char *varval);
203
204 void set_var(const char *varname, const char *varval)
205 {
206         struct varz *t = (struct varz*)calloc(1,sizeof(struct varz));
207         if (!t)
208                 return;
209         strcpy(t->varname, varname);
210         strcpy(t->varval, varval);
211         t->next = global_varlist;
212         global_varlist = t;
213 }
214
215 unsigned int check_expr(char* buffer, char* error_report)
216 {
217         char* cp;
218         unsigned int warn_found = 0;
219
220         error_report[0] = 0;
221         
222         for (cp = buffer; *cp; ++cp)
223         {
224                 switch (*cp)
225                 {
226                         case '"':
227                                 /* skip to the other end */
228                                 while (*(++cp) && *cp != '"') ;
229
230                                 if (*cp == 0)
231                                 {
232                                         fprintf(stderr,
233                                                 "Trouble? Unterminated double quote found at line %d\n",
234                                                 global_lineno);
235                                 }
236                                 break;
237                                 
238                         case '>':
239                         case '<':
240                         case '!':
241                                 if (   (*(cp + 1) == '=')
242                                         && ( ( (cp > buffer) && (*(cp - 1) != ' ') ) || (*(cp + 2) != ' ') ) )
243                                 {
244                                         char msg[200];
245                                         snprintf(msg,
246                                                 sizeof(msg),
247                                                 "WARNING: line %d: '%c%c' operator not separated by spaces. This may lead to confusion. You may wish to use double quotes to quote the grouping it is in. Please check!\n",
248                                                 global_lineno, *cp, *(cp + 1));
249                                         strcat(error_report, msg);
250                                         ++global_warn_count;
251                                         ++warn_found;
252                                 }
253                                 break;
254                                 
255                         case '|':
256                         case '&':
257                         case '=':
258                         case '+':
259                         case '-':
260                         case '*':
261                         case '/':
262                         case '%':
263                         case '?':
264                         case ':':
265                                 if ( ( (cp > buffer) && (*(cp - 1) != ' ') ) || (*(cp + 1) != ' ') )
266                                 {
267                                         char msg[200];
268                                         snprintf(msg,
269                                                 sizeof(msg),
270                                                 "WARNING: line %d: '%c' operator not separated by spaces. This may lead to confusion. You may wish to use double quotes to quote the grouping it is in. Please check!\n",
271                                                 global_lineno, *cp );
272                                         strcat(error_report, msg);
273                                         ++global_warn_count;
274                                         ++warn_found;
275                                 }
276                                 break;
277                 }
278         }
279
280         return warn_found;
281 }
282
283 int check_eval(char *buffer, char *error_report);
284
285 struct ast_custom_function *ast_custom_function_find(const char *name);
286
287 struct ast_custom_function *ast_custom_function_find(const char *name)
288 {
289         return 0;
290 }
291
292 int check_eval(char *buffer, char *error_report)
293 {
294         char *cp, *ep;
295         char s[4096];
296         char evalbuf[80000];
297         int result;
298
299         error_report[0] = 0;
300         ep = evalbuf;
301
302         for (cp=buffer;*cp;cp++) {
303                 if (*cp == '$' && *(cp+1) == '{') {
304                         int brack_lev = 1;
305                         char *xp= cp+2;
306                         
307                         while (*xp) {
308                                 if (*xp == '{')
309                                         brack_lev++;
310                                 else if (*xp == '}')
311                                         brack_lev--;
312                                 
313                                 if (brack_lev == 0)
314                                         break;
315                                 xp++;
316                         }
317                         if (*xp == '}') {
318                                 char varname[200];
319                                 char *val;
320                                 
321                                 strncpy(varname,cp+2, xp-cp-2);
322                                 varname[xp-cp-2] = 0;
323                                 cp = xp;
324                                 val = find_var(varname);
325                                 if (val) {
326                                         char *z = val;
327                                         while (*z)
328                                                 *ep++ = *z++;
329                                 }
330                                 else {
331                                         *ep++ = '5';  /* why not */
332                                         *ep++ = '5';
333                                         *ep++ = '5';
334                                 }
335                         }
336                         else {
337                                 printf("Unterminated variable reference at line %d\n", global_lineno);
338                                 *ep++ = *cp;
339                         }
340                 }
341                 else if (*cp == '\\') {
342                         /* braindead simple elim of backslash */
343                         cp++;
344                         *ep++ = *cp;
345                 }
346                 else
347                         *ep++ = *cp;
348         }
349         *ep++ = 0;
350
351         /* now, run the test */
352         result = ast_expr(evalbuf, s, sizeof(s),NULL);
353         if (result) {
354                 sprintf(error_report,"line %d, evaluation of $[ %s ] result: %s\n", global_lineno, evalbuf, s);
355                 return 1;
356         } else {
357                 sprintf(error_report,"line %d, evaluation of $[ %s ] result: ****SYNTAX ERROR****\n", global_lineno, evalbuf);
358                 return 1;
359         }
360 }
361
362
363 void parse_file(const char *fname);
364
365 void parse_file(const char *fname)
366 {
367         FILE *f = fopen(fname,"r");
368         FILE *l = fopen("expr2_log","w");
369         int c1;
370         char last_char= 0;
371         char buffer[30000]; /* I sure hope no expr gets this big! */
372         
373         if (!f) {
374                 fprintf(stderr,"Couldn't open %s for reading... need an extensions.conf file to parse!\n",fname);
375                 exit(20);
376         }
377         if (!l) {
378                 fprintf(stderr,"Couldn't open 'expr2_log' file for writing... please fix and re-run!\n");
379                 exit(21);
380         }
381         
382         global_lineno = 1;
383         
384         while ((c1 = fgetc(f)) != EOF) {
385                 if (c1 == '\n')
386                         global_lineno++;
387                 else if (c1 == '[') {
388                         if (last_char == '$') {
389                                 /* bingo, an expr */
390                                 int bracklev = 1;
391                                 int bufcount = 0;
392                                 int retval;
393                                 char error_report[30000];
394                                 
395                                 while ((c1 = fgetc(f)) != EOF) {
396                                         if (c1 == '[')
397                                                 bracklev++;
398                                         else if (c1 == ']')
399                                                 bracklev--;
400                                         if (c1 == '\n') {
401                                                 fprintf(l, "ERROR-- A newline in an expression? Weird! ...at line %d\n", global_lineno);
402                                                 fclose(f);
403                                                 fclose(l);
404                                                 printf("--- ERROR --- A newline in the middle of an expression at line %d!\n", global_lineno);
405                                         }
406                                         
407                                         if (bracklev == 0)
408                                                 break;
409                                         buffer[bufcount++] = c1;
410                                 }
411                                 if (c1 == EOF) {
412                                         fprintf(l, "ERROR-- End of File Reached in the middle of an Expr at line %d\n", global_lineno);
413                                         fclose(f);
414                                         fclose(l);
415                                         printf("--- ERROR --- EOF reached in middle of an expression at line %d!\n", global_lineno);
416                                         exit(22);
417                                 }
418                                 
419                                 buffer[bufcount] = 0;
420                                 /* update stats */
421                                 global_expr_tot_size += bufcount;
422                                 global_expr_count++;
423                                 if (bufcount > global_expr_max_size)
424                                         global_expr_max_size = bufcount;
425                                 
426                                 retval = check_expr(buffer, error_report); /* check_expr should bump the warning counter */
427                                 if (retval != 0) {
428                                         /* print error report */
429                                         printf("Warning(s) at line %d, expression: $[%s]; see expr2_log file for details\n", 
430                                                    global_lineno, buffer);
431                                         fprintf(l, "%s", error_report);
432                                 }
433                                 else {
434                                         printf("OK -- $[%s] at line %d\n", buffer, global_lineno);
435                                         global_OK_count++;
436                                 }
437                                 error_report[0] = 0;
438                                 retval = check_eval(buffer, error_report);
439                                 fprintf(l, "%s", error_report);
440                         }
441                 }
442                 last_char = c1;
443         }
444         printf("Summary:\n  Expressions detected: %d\n  Expressions OK:  %d\n  Total # Warnings:   %d\n  Longest Expr:   %d chars\n  Ave expr len:  %d chars\n",
445                    global_expr_count,
446                    global_OK_count,
447                    global_warn_count,
448                    global_expr_max_size,
449                    (global_expr_count) ? global_expr_tot_size/global_expr_count : 0);
450         
451         fclose(f);
452         fclose(l);
453 }
454
455
456 int main(int argc,char **argv)
457 {
458         int argc1;
459         char *eq;
460         
461         if (argc < 2) {
462                 printf("check_expr -- a program to look thru extensions.conf files for $[...] expressions,\n");
463                 printf("              and run them thru the parser, looking for problems\n");
464                 printf("Hey-- give me a path to an extensions.conf file!\n");
465                 printf(" You can also follow the file path with a series of variable decls,\n");
466                 printf("     of the form, varname=value, each separated from the next by spaces.\n");
467                 printf("     (this might allow you to avoid division by zero messages, check that math\n");
468                 printf("      is being done correctly, etc.)\n");
469                 printf(" Note that messages about operators not being surrounded by spaces is merely to alert\n");
470                 printf("  you to possible problems where you might be expecting those operators as part of a string.\n");
471         printf("  (to include operators in a string, wrap with double quotes!)\n");
472                 
473                 exit(19);
474         }
475         global_varlist = 0;
476         for (argc1=2;argc1 < argc; argc1++) {
477                 if ((eq = strchr(argv[argc1],'='))) {
478                         *eq = 0;
479                         set_var(argv[argc1],eq+1);
480                 }
481         }
482
483         /* parse command args for x=y and set varz */
484         
485         parse_file(argv[1]);
486         return 0;
487 }