2 * Copyright (C) 2006 Dan Carpenter.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see http://www.gnu.org/copyleft/gpl.txt
19 * Miscellaneous helper functions.
26 #include "smatch_extra.h"
30 char *alloc_string(const char *str
)
36 tmp
= malloc(strlen(str
) + 1);
41 void free_string(char *str
)
46 void remove_parens(char *str
)
51 while (*src
!= '\0') {
52 if (*src
== '(' || *src
== ')') {
61 struct smatch_state
*alloc_state_num(int num
)
63 struct smatch_state
*state
;
64 static char buff
[256];
66 state
= __alloc_smatch_state(0);
67 snprintf(buff
, 255, "%d", num
);
69 state
->name
= alloc_string(buff
);
70 state
->data
= INT_PTR(num
);
74 struct smatch_state
*alloc_state_str(const char *name
)
76 struct smatch_state
*state
;
78 state
= __alloc_smatch_state(0);
79 state
->name
= alloc_string(name
);
83 void append(char *dest
, const char *data
, int buff_len
)
85 strncat(dest
, data
, buff_len
- strlen(dest
) - 1);
89 * If you have "foo(a, b, 1);" then use
90 * get_argument_from_call_expr(expr, 0) to return the expression for
91 * a. Yes, it does start counting from 0.
93 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
96 struct expression
*expr
;
102 FOR_EACH_PTR(args
, expr
) {
106 } END_FOR_EACH_PTR(expr
);
110 static struct expression
*get_array_expr(struct expression
*expr
)
114 if (expr
->type
!= EXPR_BINOP
|| expr
->op
!= '+')
117 type
= get_type(expr
->left
);
118 if (!type
|| type
->type
!= SYM_ARRAY
)
123 static void __get_variable_from_expr(struct symbol
**sym_ptr
, char *buf
,
124 struct expression
*expr
, int len
,
125 int *complicated
, int no_parens
)
127 switch (expr
->type
) {
129 struct expression
*deref
;
135 struct expression
*unop
= strip_expr(deref
->unop
);
137 if (unop
->type
== EXPR_PREOP
&& unop
->op
== '&') {
142 if (!is_pointer(deref
))
147 __get_variable_from_expr(sym_ptr
, buf
, deref
, len
, complicated
, no_parens
);
150 append(buf
, "->", len
);
152 append(buf
, ".", len
);
155 append(buf
, expr
->member
->name
, len
);
157 append(buf
, "unknown_member", len
);
162 if (expr
->symbol_name
)
163 append(buf
, expr
->symbol_name
->name
, len
);
167 *sym_ptr
= expr
->symbol
;
173 if (get_expression_statement(expr
)) {
178 if (expr
->op
== '(') {
180 append(buf
, "(", len
);
181 } else if (expr
->op
!= '*' || !get_array_expr(expr
->unop
)) {
182 tmp
= show_special(expr
->op
);
183 append(buf
, tmp
, len
);
185 __get_variable_from_expr(sym_ptr
, buf
, expr
->unop
,
186 len
, complicated
, no_parens
);
188 if (expr
->op
== '(' && !no_parens
)
189 append(buf
, ")", len
);
191 if (expr
->op
== SPECIAL_DECREMENT
||
192 expr
->op
== SPECIAL_INCREMENT
)
200 __get_variable_from_expr(sym_ptr
, buf
, expr
->unop
,
201 len
, complicated
, no_parens
);
202 tmp
= show_special(expr
->op
);
203 append(buf
, tmp
, len
);
205 if (expr
->op
== SPECIAL_DECREMENT
|| expr
->op
== SPECIAL_INCREMENT
)
209 case EXPR_ASSIGNMENT
:
214 struct expression
*array_expr
;
217 array_expr
= get_array_expr(expr
);
219 __get_variable_from_expr(sym_ptr
, buf
, array_expr
, len
, complicated
, no_parens
);
220 append(buf
, "[", len
);
222 __get_variable_from_expr(sym_ptr
, buf
, expr
->left
, len
, complicated
, no_parens
);
223 snprintf(tmp
, sizeof(tmp
), " %s ", show_special(expr
->op
));
224 append(buf
, tmp
, len
);
226 __get_variable_from_expr(NULL
, buf
, expr
->right
, len
, complicated
, no_parens
);
228 append(buf
, "]", len
);
235 snprintf(tmp
, 25, "%lld", expr
->value
);
236 append(buf
, tmp
, len
);
240 append(buf
, "\"", len
);
242 append(buf
, expr
->string
->data
, len
);
243 append(buf
, "\"", len
);
246 struct expression
*tmp
;
250 __get_variable_from_expr(NULL
, buf
, expr
->fn
, len
, complicated
, no_parens
);
251 append(buf
, "(", len
);
253 FOR_EACH_PTR(expr
->args
, tmp
) {
255 append(buf
, ", ", len
);
256 __get_variable_from_expr(NULL
, buf
, tmp
, len
, complicated
, no_parens
);
257 } END_FOR_EACH_PTR(tmp
);
258 append(buf
, ")", len
);
262 case EXPR_FORCE_CAST
:
263 __get_variable_from_expr(sym_ptr
, buf
,
264 expr
->cast_expression
, len
,
265 complicated
, no_parens
);
271 if (expr
->cast_type
&& get_base_type(expr
->cast_type
)) {
272 size
= type_bytes(get_base_type(expr
->cast_type
));
273 snprintf(tmp
, 25, "%d", size
);
274 append(buf
, tmp
, len
);
278 case EXPR_IDENTIFIER
:
280 if (expr
->expr_ident
)
281 append(buf
, expr
->expr_ident
->name
, len
);
285 //printf("unknown type = %d\n", expr->type);
291 * This is returns a stylized "c looking" representation of the
294 * It uses the same buffer every time so you have to save the result
295 * yourself if you want to keep it.
299 char *expr_to_str_sym(struct expression
*expr
, struct symbol
**sym_ptr
)
301 static char var_name
[VAR_LEN
];
310 __get_variable_from_expr(sym_ptr
, var_name
, expr
, sizeof(var_name
),
313 return alloc_string(var_name
);
318 char *expr_to_str(struct expression
*expr
)
320 return expr_to_str_sym(expr
, NULL
);
324 * get_variable_from_expr_simple() only returns simple variables.
325 * If it's a complicated variable like a->foo[x] instead of just 'a->foo'
326 * then it returns NULL.
328 char *expr_to_var_sym(struct expression
*expr
,
329 struct symbol
**sym_ptr
)
331 static char var_name
[VAR_LEN
];
340 expr
= strip_expr(expr
);
341 __get_variable_from_expr(sym_ptr
, var_name
, expr
, sizeof(var_name
),
349 return alloc_string(var_name
);
352 char *expr_to_var(struct expression
*expr
)
354 return expr_to_var_sym(expr
, NULL
);
357 struct symbol
*expr_to_sym(struct expression
*expr
)
362 name
= expr_to_var_sym(expr
, &sym
);
367 int get_complication_score(struct expression
*expr
)
371 expr
= strip_expr(expr
);
374 * Don't forget to keep get_complication_score() and store_all_links()
379 switch (expr
->type
) {
384 score
+= get_complication_score(expr
->left
);
385 score
+= get_complication_score(expr
->right
);
388 if (is_local_variable(expr
))
393 return score
+ get_complication_score(expr
->unop
);
396 return score
+ get_complication_score(expr
->deref
);
404 char *expr_to_chunk_helper(struct expression
*expr
, struct symbol
**sym
, struct var_sym_list
**vsl
)
415 expr
= strip_parens(expr
);
419 name
= expr_to_var_sym(expr
, &tmp
);
424 *vsl
= expr_to_vsl(expr
);
429 score
= get_complication_score(expr
);
430 if (score
<= 0 || score
> 2)
434 *vsl
= expr_to_vsl(expr
);
439 return expr_to_str(expr
);
442 char *expr_to_known_chunk_sym(struct expression
*expr
, struct symbol
**sym
)
444 return expr_to_chunk_helper(expr
, sym
, NULL
);
447 char *expr_to_chunk_sym_vsl(struct expression
*expr
, struct symbol
**sym
, struct var_sym_list
**vsl
)
449 return expr_to_chunk_helper(expr
, sym
, vsl
);
452 int sym_name_is(const char *name
, struct expression
*expr
)
456 if (expr
->type
!= EXPR_SYMBOL
)
458 if (!strcmp(expr
->symbol_name
->name
, name
))
463 int is_zero(struct expression
*expr
)
467 if (get_value(expr
, &sval
) && sval
.value
== 0)
472 int is_array(struct expression
*expr
)
476 expr
= strip_expr(expr
);
480 if (expr
->type
== EXPR_PREOP
&& expr
->op
== '*') {
481 expr
= strip_expr(expr
->unop
);
482 if (expr
->type
== EXPR_BINOP
&& expr
->op
== '+')
486 if (expr
->type
!= EXPR_BINOP
|| expr
->op
!= '+')
489 type
= get_type(expr
->left
);
490 if (!type
|| type
->type
!= SYM_ARRAY
)
496 struct expression
*get_array_base(struct expression
*expr
)
500 expr
= strip_expr(expr
);
501 if (expr
->type
== EXPR_PREOP
&& expr
->op
== '*')
502 expr
= strip_expr(expr
->unop
);
503 if (expr
->type
!= EXPR_BINOP
|| expr
->op
!= '+')
505 return strip_parens(expr
->left
);
508 struct expression
*get_array_offset(struct expression
*expr
)
512 expr
= strip_expr(expr
);
513 if (expr
->type
== EXPR_PREOP
&& expr
->op
== '*')
514 expr
= strip_expr(expr
->unop
);
515 if (expr
->type
!= EXPR_BINOP
|| expr
->op
!= '+')
517 return strip_parens(expr
->right
);
520 const char *show_state(struct smatch_state
*state
)
527 struct statement
*get_expression_statement(struct expression
*expr
)
529 /* What are those things called? if (({....; ret;})) { ...*/
531 if (expr
->type
!= EXPR_PREOP
)
535 if (expr
->unop
->type
!= EXPR_STATEMENT
)
537 if (expr
->unop
->statement
->type
!= STMT_COMPOUND
)
539 return expr
->unop
->statement
;
542 struct expression
*strip_parens(struct expression
*expr
)
547 if (expr
->type
== EXPR_PREOP
) {
548 if (expr
->op
== '(' && expr
->unop
->type
== EXPR_STATEMENT
&&
549 expr
->unop
->statement
->type
== STMT_COMPOUND
)
552 return strip_parens(expr
->unop
);
557 struct expression
*strip_expr(struct expression
*expr
)
562 switch (expr
->type
) {
563 case EXPR_FORCE_CAST
:
565 return strip_expr(expr
->cast_expression
);
567 struct expression
*unop
;
569 if (expr
->op
== '(' && expr
->unop
->type
== EXPR_STATEMENT
&&
570 expr
->unop
->statement
->type
== STMT_COMPOUND
)
573 unop
= strip_expr(expr
->unop
);
575 if (expr
->op
== '*' &&
576 unop
->type
== EXPR_PREOP
&& unop
->op
== '&') {
577 struct symbol
*type
= get_type(unop
->unop
);
579 if (type
&& type
->type
== SYM_ARRAY
)
581 return strip_expr(unop
->unop
);
589 case EXPR_CONDITIONAL
:
590 if (known_condition_true(expr
->conditional
)) {
592 return strip_expr(expr
->cond_true
);
593 return strip_expr(expr
->conditional
);
595 if (known_condition_false(expr
->conditional
))
596 return strip_expr(expr
->cond_false
);
599 if (sym_name_is("__builtin_expect", expr
->fn
)) {
600 expr
= get_argument_from_call_expr(expr
->args
, 0);
601 return strip_expr(expr
);
608 static void delete_state_tracker(struct tracker
*t
)
610 delete_state(t
->owner
, t
->name
, t
->sym
);
614 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
)
618 t
= alloc_tracker(my_id
, name
, sym
);
619 add_scope_hook((scope_hook
*)&delete_state_tracker
, t
);
622 int is_error_return(struct expression
*expr
)
624 struct symbol
*cur_func
= cur_func_sym
;
629 if (cur_func
->type
!= SYM_NODE
)
631 cur_func
= get_base_type(cur_func
);
632 if (cur_func
->type
!= SYM_FN
)
634 cur_func
= get_base_type(cur_func
);
635 if (cur_func
== &void_ctype
)
637 if (!get_implied_value(expr
, &sval
))
641 if (cur_func
->type
== SYM_PTR
&& sval
.value
== 0)
646 int getting_address(void)
648 struct expression
*tmp
;
652 FOR_EACH_PTR_REVERSE(big_expression_stack
, tmp
) {
655 if (tmp
->type
== EXPR_PREOP
&& tmp
->op
== '(')
657 if (tmp
->op
== '.' && !dot_ops
++)
662 } END_FOR_EACH_PTR_REVERSE(tmp
);
666 char *get_member_name(struct expression
*expr
)
671 expr
= strip_expr(expr
);
672 if (expr
->type
!= EXPR_DEREF
)
677 sym
= get_type(expr
->deref
);
680 if (sym
->type
== SYM_UNION
) {
681 sym
= expr_to_sym(expr
->deref
);
682 sym
= get_real_base_type(sym
);
683 if (sym
&& sym
->type
== SYM_PTR
)
684 sym
= get_real_base_type(sym
);
685 if (!sym
|| !sym
->ident
) {
686 snprintf(buf
, sizeof(buf
), "(union hack)->%s", expr
->member
->name
);
687 return alloc_string(buf
);
692 snprintf(buf
, sizeof(buf
), "(struct %s)->%s", sym
->ident
->name
, expr
->member
->name
);
693 return alloc_string(buf
);
696 int cmp_pos(struct position pos1
, struct position pos2
)
698 /* the stream position is ... */
699 if (pos1
.stream
> pos2
.stream
)
701 if (pos1
.stream
< pos2
.stream
)
704 if (pos1
.line
< pos2
.line
)
706 if (pos1
.line
> pos2
.line
)
709 if (pos1
.pos
< pos2
.pos
)
711 if (pos1
.pos
> pos2
.pos
)
717 int positions_eq(struct position pos1
, struct position pos2
)
719 if (pos1
.line
!= pos2
.line
)
721 if (pos1
.pos
!= pos2
.pos
)
723 if (pos1
.stream
!= pos2
.stream
)
728 struct statement
*get_current_statement(void)
730 struct statement
*prev
, *tmp
;
732 prev
= last_ptr_list((struct ptr_list
*)big_statement_stack
);
734 if (!prev
|| !get_macro_name(prev
->pos
))
737 FOR_EACH_PTR_REVERSE(big_statement_stack
, tmp
) {
738 if (positions_eq(tmp
->pos
, prev
->pos
))
740 if (prev
->pos
.line
> tmp
->pos
.line
)
743 } END_FOR_EACH_PTR_REVERSE(tmp
);
747 struct statement
*get_prev_statement(void)
749 struct statement
*tmp
;
753 FOR_EACH_PTR_REVERSE(big_statement_stack
, tmp
) {
756 } END_FOR_EACH_PTR_REVERSE(tmp
);
760 int get_param_num_from_sym(struct symbol
*sym
)
769 FOR_EACH_PTR(cur_func_sym
->ctype
.base_type
->arguments
, tmp
) {
773 } END_FOR_EACH_PTR(tmp
);
777 int get_param_num(struct expression
*expr
)
784 name
= expr_to_var_sym(expr
, &sym
);
788 return get_param_num_from_sym(sym
);
791 int ms_since(struct timeval
*start
)
796 gettimeofday(&end
, NULL
);
797 diff
= (end
.tv_sec
- start
->tv_sec
) * 1000.0;
798 diff
+= (end
.tv_usec
- start
->tv_usec
) / 1000.0;
802 int parent_is_gone_var_sym(const char *name
, struct symbol
*sym
)
807 if (parent_is_null_var_sym(name
, sym
) ||
808 parent_is_free_var_sym(name
, sym
))
813 int parent_is_gone(struct expression
*expr
)
819 expr
= strip_expr(expr
);
820 var
= expr_to_var_sym(expr
, &sym
);
823 ret
= parent_is_gone_var_sym(var
, sym
);
829 int invert_op(int op
)
840 case SPECIAL_LEFTSHIFT
:
841 return SPECIAL_RIGHTSHIFT
;
842 case SPECIAL_RIGHTSHIFT
:
843 return SPECIAL_LEFTSHIFT
;
848 int expr_equiv(struct expression
*one
, struct expression
*two
)
850 struct symbol
*one_sym
, *two_sym
;
851 char *one_name
= NULL
;
852 char *two_name
= NULL
;
857 if (one
->type
!= two
->type
)
860 one_name
= expr_to_str_sym(one
, &one_sym
);
861 if (!one_name
|| !one_sym
)
863 two_name
= expr_to_str_sym(two
, &two_sym
);
864 if (!two_name
|| !two_sym
)
866 if (one_sym
!= two_sym
)
868 if (strcmp(one_name
, two_name
) == 0)
871 free_string(one_name
);
872 free_string(two_name
);