db: always split the return values if we're not using --info
[smatch.git] / smatch_extra.c
blob79ea0dcb2ba3814ddee10b733dc709156591b8a3
1 /*
2 * sparse/smatch_extra.c
4 * Copyright (C) 2008 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
8 */
11 * smatch_extra.c is supposed to track the value of every variable.
15 #include <stdlib.h>
16 #include <errno.h>
17 #ifndef __USE_ISOC99
18 #define __USE_ISOC99
19 #endif
20 #include <limits.h>
21 #include "parse.h"
22 #include "smatch.h"
23 #include "smatch_slist.h"
24 #include "smatch_extra.h"
26 static int my_id;
28 struct string_list *__ignored_macros = NULL;
29 static int in_warn_on_macro()
31 struct statement *stmt;
32 char *tmp;
33 char *macro;
35 stmt = get_current_statement();
36 macro = get_macro_name(stmt->pos);
37 if (!macro)
38 return 0;
40 FOR_EACH_PTR(__ignored_macros, tmp) {
41 if (!strcmp(tmp, macro))
42 return 1;
43 } END_FOR_EACH_PTR(tmp);
44 return 0;
47 typedef void (mod_hook)(const char *name, struct symbol *sym, struct smatch_state *state);
48 DECLARE_PTR_LIST(void_fn_list, mod_hook *);
49 static struct void_fn_list *extra_mod_hooks;
50 void add_extra_mod_hook(mod_hook *fn)
52 mod_hook **p = malloc(sizeof(mod_hook *));
53 *p = fn;
54 add_ptr_list(&extra_mod_hooks, p);
57 void call_extra_mod_hooks(const char *name, struct symbol *sym, struct smatch_state *state)
59 mod_hook **fn;
61 FOR_EACH_PTR(extra_mod_hooks, fn) {
62 (*fn)(name, sym, state);
63 } END_FOR_EACH_PTR(fn);
66 struct sm_state *set_extra_mod(const char *name, struct symbol *sym, struct smatch_state *state)
68 if (in_warn_on_macro())
69 return NULL;
70 remove_from_equiv(name, sym);
71 call_extra_mod_hooks(name, sym, state);
72 return set_state(SMATCH_EXTRA, name, sym, state);
75 struct sm_state *set_extra_expr_mod(struct expression *expr, struct smatch_state *state)
77 struct symbol *sym;
78 char *name;
79 struct sm_state *ret = NULL;
81 expr = strip_expr(expr);
82 name = expr_to_var_sym(expr, &sym);
83 if (!name || !sym)
84 goto free;
85 ret = set_extra_mod(name, sym, state);
86 free:
87 free_string(name);
88 return ret;
91 void set_extra_nomod(const char *name, struct symbol *sym, struct smatch_state *state)
93 struct relation *rel;
94 struct smatch_state *orig_state;
96 orig_state = get_state(SMATCH_EXTRA, name, sym);
98 if (!estate_related(orig_state)) {
99 set_state(SMATCH_EXTRA, name, sym, state);
100 return;
103 set_related(state, estate_related(orig_state));
104 FOR_EACH_PTR(estate_related(orig_state), rel) {
105 if (option_debug_related)
106 sm_msg("updating related %s to %s", rel->name, state->name);
107 set_state(SMATCH_EXTRA, rel->name, rel->sym, state);
108 } END_FOR_EACH_PTR(rel);
112 * This is for return_implies_state() hooks which modify a SMATCH_EXTRA state
114 void set_extra_expr_nomod(struct expression *expr, struct smatch_state *state)
116 char *name;
117 struct symbol *sym;
119 name = expr_to_var_sym(expr, &sym);
120 if (!name || !sym)
121 goto free;
122 set_extra_nomod(name, sym, state);
123 free:
124 free_string(name);
128 static void set_extra_true_false(const char *name, struct symbol *sym,
129 struct smatch_state *true_state,
130 struct smatch_state *false_state)
132 struct relation *rel;
133 struct smatch_state *orig_state;
135 if (in_warn_on_macro())
136 return;
138 orig_state = get_state(SMATCH_EXTRA, name, sym);
140 if (!estate_related(orig_state)) {
141 set_true_false_states(SMATCH_EXTRA, name, sym, true_state, false_state);
142 return;
145 if (true_state)
146 set_related(true_state, estate_related(orig_state));
147 if (false_state)
148 set_related(false_state, estate_related(orig_state));
150 FOR_EACH_PTR(estate_related(orig_state), rel) {
151 set_true_false_states(SMATCH_EXTRA, rel->name, rel->sym,
152 true_state, false_state);
153 } END_FOR_EACH_PTR(rel);
156 static void set_extra_expr_true_false(struct expression *expr,
157 struct smatch_state *true_state,
158 struct smatch_state *false_state)
160 char *name;
161 struct symbol *sym;
163 expr = strip_expr(expr);
164 name = expr_to_var_sym(expr, &sym);
165 if (!name || !sym)
166 goto free;
167 set_extra_true_false(name, sym, true_state, false_state);
168 free:
169 free_string(name);
172 static struct sm_state *handle_canonical_while_count_down(struct statement *loop)
174 struct expression *iter_var;
175 struct expression *condition;
176 struct sm_state *sm;
177 struct smatch_state *estate;
178 sval_t start;
180 condition = strip_expr(loop->iterator_pre_condition);
181 if (!condition)
182 return NULL;
183 if (condition->type != EXPR_PREOP && condition->type != EXPR_POSTOP)
184 return NULL;
185 if (condition->op != SPECIAL_DECREMENT)
186 return NULL;
188 iter_var = condition->unop;
189 sm = get_sm_state_expr(SMATCH_EXTRA, iter_var);
190 if (!sm)
191 return NULL;
192 if (sval_cmp_val(estate_min(sm->state), 0) < 0)
193 return NULL;
194 start = estate_max(sm->state);
195 if (sval_cmp_val(start, 0) <= 0)
196 return NULL;
197 if (!sval_is_max(start))
198 start.value--;
200 if (condition->type == EXPR_PREOP) {
201 estate = alloc_estate_range(sval_type_val(start.type, 1), start);
202 if (estate_has_hard_max(sm->state))
203 estate_set_hard_max(estate);
204 set_extra_expr_mod(iter_var, estate);
206 if (condition->type == EXPR_POSTOP) {
207 estate = alloc_estate_range(sval_type_val(start.type, 0), start);
208 if (estate_has_hard_max(sm->state))
209 estate_set_hard_max(estate);
210 set_extra_expr_mod(iter_var, estate);
212 return get_sm_state_expr(SMATCH_EXTRA, iter_var);
215 static struct sm_state *handle_canonical_for_inc(struct expression *iter_expr,
216 struct expression *condition)
218 struct expression *iter_var;
219 struct sm_state *sm;
220 struct smatch_state *estate;
221 sval_t start, end, dummy;
223 iter_var = iter_expr->unop;
224 sm = get_sm_state_expr(SMATCH_EXTRA, iter_var);
225 if (!sm)
226 return NULL;
227 if (!estate_get_single_value(sm->state, &start))
228 return NULL;
229 if (get_implied_max(condition->right, &end))
230 end = sval_cast(get_type(iter_var), end);
231 else
232 end = sval_type_max(get_type(iter_var));
234 if (get_sm_state_expr(SMATCH_EXTRA, condition->left) != sm)
235 return NULL;
237 switch (condition->op) {
238 case SPECIAL_NOTEQUAL:
239 case '<':
240 if (!sval_is_min(end))
241 end.value--;
242 break;
243 case SPECIAL_LTE:
244 break;
245 default:
246 return NULL;
248 if (sval_cmp(end, start) < 0)
249 return NULL;
250 estate = alloc_estate_range(start, end);
251 if (get_hard_max(condition->right, &dummy))
252 estate_set_hard_max(estate);
253 set_extra_expr_mod(iter_var, estate);
254 return get_sm_state_expr(SMATCH_EXTRA, iter_var);
257 static struct sm_state *handle_canonical_for_dec(struct expression *iter_expr,
258 struct expression *condition)
260 struct expression *iter_var;
261 struct sm_state *sm;
262 struct smatch_state *estate;
263 sval_t start, end;
265 iter_var = iter_expr->unop;
266 sm = get_sm_state_expr(SMATCH_EXTRA, iter_var);
267 if (!sm)
268 return NULL;
269 if (!estate_get_single_value(sm->state, &start))
270 return NULL;
271 if (!get_implied_min(condition->right, &end))
272 end = sval_type_min(get_type(iter_var));
273 if (get_sm_state_expr(SMATCH_EXTRA, condition->left) != sm)
274 return NULL;
276 switch (condition->op) {
277 case SPECIAL_NOTEQUAL:
278 case '>':
279 if (!sval_is_min(end) && !sval_is_max(end))
280 end.value++;
281 break;
282 case SPECIAL_GTE:
283 break;
284 default:
285 return NULL;
287 if (sval_cmp(end, start) > 0)
288 return NULL;
289 estate = alloc_estate_range(end, start);
290 estate_set_hard_max(estate);
291 set_extra_expr_mod(iter_var, estate);
292 return get_sm_state_expr(SMATCH_EXTRA, iter_var);
295 static struct sm_state *handle_canonical_for_loops(struct statement *loop)
297 struct expression *iter_expr;
298 struct expression *condition;
300 if (!loop->iterator_post_statement)
301 return NULL;
302 if (loop->iterator_post_statement->type != STMT_EXPRESSION)
303 return NULL;
304 iter_expr = loop->iterator_post_statement->expression;
305 if (!loop->iterator_pre_condition)
306 return NULL;
307 if (loop->iterator_pre_condition->type != EXPR_COMPARE)
308 return NULL;
309 condition = loop->iterator_pre_condition;
311 if (iter_expr->op == SPECIAL_INCREMENT)
312 return handle_canonical_for_inc(iter_expr, condition);
313 if (iter_expr->op == SPECIAL_DECREMENT)
314 return handle_canonical_for_dec(iter_expr, condition);
315 return NULL;
318 struct sm_state *__extra_handle_canonical_loops(struct statement *loop, struct state_list **slist)
320 struct sm_state *ret;
322 __push_fake_cur_slist();
323 if (!loop->iterator_post_statement)
324 ret = handle_canonical_while_count_down(loop);
325 else
326 ret = handle_canonical_for_loops(loop);
327 *slist = __pop_fake_cur_slist();
328 return ret;
331 int __iterator_unchanged(struct sm_state *sm)
333 if (!sm)
334 return 0;
335 if (get_sm_state(my_id, sm->name, sm->sym) == sm)
336 return 1;
337 return 0;
340 static void while_count_down_after(struct sm_state *sm, struct expression *condition)
342 sval_t after_value;
344 /* paranoid checking. prolly not needed */
345 condition = strip_expr(condition);
346 if (!condition)
347 return;
348 if (condition->type != EXPR_PREOP && condition->type != EXPR_POSTOP)
349 return;
350 if (condition->op != SPECIAL_DECREMENT)
351 return;
352 after_value = estate_min(sm->state);
353 after_value.value--;
354 set_extra_mod(sm->name, sm->sym, alloc_estate_sval(after_value));
357 void __extra_pre_loop_hook_after(struct sm_state *sm,
358 struct statement *iterator,
359 struct expression *condition)
361 struct expression *iter_expr;
362 sval_t limit;
363 struct smatch_state *state;
365 if (!iterator) {
366 while_count_down_after(sm, condition);
367 return;
370 iter_expr = iterator->expression;
372 if (condition->type != EXPR_COMPARE)
373 return;
374 if (iter_expr->op == SPECIAL_INCREMENT) {
375 limit = sval_binop(estate_max(sm->state), '+',
376 sval_type_val(estate_type(sm->state), 1));
377 } else {
378 limit = sval_binop(estate_min(sm->state), '-',
379 sval_type_val(estate_type(sm->state), 1));
381 if (!estate_has_hard_max(sm->state) && !__has_breaks()) {
382 if (iter_expr->op == SPECIAL_INCREMENT)
383 state = alloc_estate_range(estate_min(sm->state), limit);
384 else
385 state = alloc_estate_range(limit, estate_max(sm->state));
386 } else {
387 state = alloc_estate_sval(limit);
389 if (!estate_has_hard_max(sm->state))
390 estate_clear_hard_max(state);
391 set_extra_mod(sm->name, sm->sym, state);
394 static struct state_list *unmatched_slist;
395 static struct smatch_state *unmatched_state(struct sm_state *sm)
397 struct smatch_state *state;
399 if (unmatched_slist) {
400 state = get_state_slist(unmatched_slist, SMATCH_EXTRA, sm->name, sm->sym);
401 if (state)
402 return state;
404 return alloc_estate_whole(estate_type(sm->state));
407 static void clear_the_pointed_at(struct expression *expr, struct state_list *slist)
409 char *name;
410 struct symbol *sym;
411 struct sm_state *tmp;
413 name = expr_to_var_sym(expr, &sym);
414 if (!name || !sym)
415 goto free;
417 FOR_EACH_PTR(slist, tmp) {
418 if (tmp->name[0] != '*')
419 continue;
420 if (tmp->sym != sym)
421 continue;
422 if (strcmp(tmp->name + 1, name) != 0)
423 continue;
424 set_extra_mod(tmp->name, tmp->sym, alloc_estate_whole(estate_type(tmp->state)));
425 } END_FOR_EACH_PTR(tmp);
427 free:
428 free_string(name);
431 static void match_function_call(struct expression *expr)
433 struct expression *arg;
434 struct expression *tmp;
435 struct state_list *slist;
437 slist = get_all_states(SMATCH_EXTRA);
439 FOR_EACH_PTR(expr->args, arg) {
440 tmp = strip_expr(arg);
441 if (tmp->type == EXPR_PREOP && tmp->op == '&')
442 set_extra_expr_mod(tmp->unop, alloc_estate_whole(get_type(tmp->unop)));
443 else
444 clear_the_pointed_at(tmp, slist);
445 } END_FOR_EACH_PTR(arg);
447 free_slist(&slist);
450 static int types_equiv_or_pointer(struct symbol *one, struct symbol *two)
452 if (!one || !two)
453 return 0;
454 if (one->type == SYM_PTR && two->type == SYM_PTR)
455 return 1;
456 return types_equiv(one, two);
459 static void match_vanilla_assign(struct expression *left, struct expression *right)
461 struct range_list *rl = NULL;
462 struct symbol *right_sym;
463 struct symbol *left_type;
464 struct symbol *right_type;
465 char *right_name = NULL;
466 struct symbol *sym;
467 char *name;
468 sval_t tmp;
469 struct smatch_state *state;
471 name = expr_to_var_sym(left, &sym);
472 if (!name)
473 return;
475 left_type = get_type(left);
476 right_type = get_type(right);
478 right_name = expr_to_var_sym(right, &right_sym);
479 if (right_name && right_sym &&
480 types_equiv_or_pointer(left_type, right_type)) {
481 set_equiv(left, right);
482 goto free;
485 if (get_implied_rl(right, &rl)) {
486 rl = cast_rl(left_type, rl);
487 state = alloc_estate_rl(rl);
488 if (get_hard_max(right, &tmp))
489 estate_set_hard_max(state);
490 } else {
491 rl = alloc_whole_rl(right_type);
492 rl = cast_rl(left_type, rl);
493 state = alloc_estate_rl(rl);
495 set_extra_mod(name, sym, state);
496 free:
497 free_string(right_name);
500 static int op_remove_assign(int op)
502 switch (op) {
503 case SPECIAL_ADD_ASSIGN:
504 return '+';
505 case SPECIAL_SUB_ASSIGN:
506 return '-';
507 case SPECIAL_MUL_ASSIGN:
508 return '*';
509 case SPECIAL_DIV_ASSIGN:
510 return '/';
511 case SPECIAL_MOD_ASSIGN:
512 return '%';
513 case SPECIAL_AND_ASSIGN:
514 return '&';
515 case SPECIAL_OR_ASSIGN:
516 return '|';
517 case SPECIAL_XOR_ASSIGN:
518 return '^';
519 case SPECIAL_SHL_ASSIGN:
520 return SPECIAL_LEFTSHIFT;
521 case SPECIAL_SHR_ASSIGN:
522 return SPECIAL_RIGHTSHIFT;
523 default:
524 return op;
528 static void match_assign(struct expression *expr)
530 struct range_list *rl = NULL;
531 struct expression *left;
532 struct expression *right;
533 struct expression *binop_expr;
534 struct symbol *left_type;
535 struct symbol *right_type;
536 struct symbol *sym;
537 char *name;
538 sval_t left_min, left_max;
539 sval_t right_min, right_max;
540 sval_t res_min, res_max;
542 left = strip_expr(expr->left);
544 right = strip_expr(expr->right);
545 while (right->type == EXPR_ASSIGNMENT && right->op == '=')
546 right = strip_expr(right->left);
548 if (is_condition(expr->right))
549 return; /* handled in smatch_condition.c */
550 if (expr->op == '=' && right->type == EXPR_CALL)
551 return; /* handled in smatch_function_hooks.c */
552 if (expr->op == '=') {
553 match_vanilla_assign(left, right);
554 return;
557 name = expr_to_var_sym(left, &sym);
558 if (!name)
559 return;
561 left_type = get_type(left);
562 right_type = get_type(right);
564 res_min = sval_type_min(right_type);
565 res_max = sval_type_max(right_type);
567 switch (expr->op) {
568 case SPECIAL_ADD_ASSIGN:
569 get_absolute_max(left, &left_max);
570 get_absolute_max(right, &right_max);
571 if (sval_binop_overflows(left_max, '+', right_max))
572 break;
573 if (get_implied_min(left, &left_min) &&
574 !sval_is_negative_min(left_min) &&
575 get_implied_min(right, &right_min) &&
576 !sval_is_negative_min(right_min)) {
577 res_min = sval_binop(left_min, '+', right_min);
578 res_min = sval_cast(right_type, res_min);
580 if (inside_loop()) /* we are assuming loops don't lead to wrapping */
581 break;
582 res_max = sval_binop(left_max, '+', right_max);
583 res_max = sval_cast(right_type, res_max);
584 break;
585 case SPECIAL_SUB_ASSIGN:
586 if (get_implied_max(left, &left_max) &&
587 !sval_is_max(left_max) &&
588 get_implied_min(right, &right_min) &&
589 !sval_is_min(right_min)) {
590 res_max = sval_binop(left_max, '-', right_min);
591 res_max = sval_cast(right_type, res_max);
593 if (inside_loop())
594 break;
595 if (get_implied_min(left, &left_min) &&
596 !sval_is_min(left_min) &&
597 get_implied_max(right, &right_max) &&
598 !sval_is_max(right_max)) {
599 res_min = sval_binop(left_min, '-', right_max);
600 res_min = sval_cast(right_type, res_min);
602 break;
603 case SPECIAL_AND_ASSIGN:
604 case SPECIAL_MOD_ASSIGN:
605 binop_expr = binop_expression(expr->left,
606 op_remove_assign(expr->op),
607 expr->right);
608 if (get_implied_rl(binop_expr, &rl)) {
609 rl = cast_rl(left_type, rl);
610 set_extra_mod(name, sym, alloc_estate_rl(rl));
611 goto free;
614 rl = cast_rl(left_type, alloc_rl(res_min, res_max));
615 set_extra_mod(name, sym, alloc_estate_rl(rl));
616 free:
617 free_string(name);
620 static void reset_struct_members(struct sm_state *sm)
622 if (!estate_rl(sm->state))
623 return;
624 set_extra_mod(sm->name, sm->sym, alloc_estate_whole(estate_type(sm->state)));
627 static struct smatch_state *increment_state(struct smatch_state *state)
629 sval_t min = estate_min(state);
630 sval_t max = estate_max(state);
632 if (!estate_rl(state))
633 return NULL;
635 if (inside_loop())
636 max = sval_type_max(max.type);
638 if (!sval_is_min(min) && !sval_is_max(min))
639 min.value++;
640 if (!sval_is_min(max) && !sval_is_max(max))
641 max.value++;
642 return alloc_estate_range(min, max);
645 static struct smatch_state *decrement_state(struct smatch_state *state)
647 sval_t min = estate_min(state);
648 sval_t max = estate_max(state);
650 if (!estate_rl(state))
651 return NULL;
653 if (inside_loop())
654 min = sval_type_min(min.type);
656 if (!sval_is_min(min) && !sval_is_max(min))
657 min.value--;
658 if (!sval_is_min(max) && !sval_is_max(max))
659 max.value--;
660 return alloc_estate_range(min, max);
663 static void unop_expr(struct expression *expr)
665 struct smatch_state *state;
667 if (expr->smatch_flags & Handled)
668 return;
670 switch (expr->op) {
671 case SPECIAL_INCREMENT:
672 state = get_state_expr(SMATCH_EXTRA, expr->unop);
673 state = increment_state(state);
674 if (!state)
675 state = alloc_estate_whole(get_type(expr));
676 set_extra_expr_mod(expr->unop, state);
677 break;
678 case SPECIAL_DECREMENT:
679 state = get_state_expr(SMATCH_EXTRA, expr->unop);
680 state = decrement_state(state);
681 if (!state)
682 state = alloc_estate_whole(get_type(expr));
683 set_extra_expr_mod(expr->unop, state);
684 break;
685 default:
686 return;
690 static void asm_expr(struct statement *stmt)
693 struct expression *expr;
694 struct symbol *type;
695 int state = 0;
697 FOR_EACH_PTR(stmt->asm_outputs, expr) {
698 switch (state) {
699 case 0: /* identifier */
700 case 1: /* constraint */
701 state++;
702 continue;
703 case 2: /* expression */
704 state = 0;
705 type = get_type(strip_expr(expr));
706 set_extra_expr_mod(expr, alloc_estate_whole(type));
707 continue;
709 } END_FOR_EACH_PTR(expr);
712 static void delete_state_tracker(struct tracker *t)
714 remove_from_equiv(t->name, t->sym);
715 delete_state(t->owner, t->name, t->sym);
718 static void scoped_state_extra(const char *name, struct symbol *sym)
720 struct tracker *t;
722 t = alloc_tracker(SMATCH_EXTRA, name, sym);
723 add_scope_hook((scope_hook *)&delete_state_tracker, t);
726 static void match_declarations(struct symbol *sym)
728 const char *name;
730 if (sym->ident) {
731 name = sym->ident->name;
732 if (!sym->initializer) {
733 set_state(SMATCH_EXTRA, name, sym, alloc_estate_whole(get_real_base_type(sym)));
734 scoped_state_extra(name, sym);
739 static void check_dereference(struct expression *expr)
741 set_extra_expr_nomod(expr, alloc_estate_range(valid_ptr_min_sval, valid_ptr_max_sval));
744 static void match_dereferences(struct expression *expr)
746 if (expr->type != EXPR_PREOP)
747 return;
748 check_dereference(expr->unop);
751 static void match_pointer_as_array(struct expression *expr)
753 if (!is_array(expr))
754 return;
755 check_dereference(expr->unop->left);
758 static void set_param_dereferenced(struct expression *arg, char *unused)
760 check_dereference(arg);
763 static void match_function_def(struct symbol *sym)
765 struct symbol *arg;
767 FOR_EACH_PTR(sym->ctype.base_type->arguments, arg) {
768 if (!arg->ident)
769 continue;
770 set_state(my_id, arg->ident->name, arg, alloc_estate_whole(get_real_base_type(arg)));
771 } END_FOR_EACH_PTR(arg);
774 static int match_func_comparison(struct expression *expr)
776 struct expression *left = strip_expr(expr->left);
777 struct expression *right = strip_expr(expr->right);
778 sval_t sval;
780 if (left->type == EXPR_CALL) {
781 if (!get_implied_value(right, &sval))
782 return 1;
783 function_comparison(expr->op, left, sval, 1);
784 return 1;
787 if (right->type == EXPR_CALL) {
788 if (!get_implied_value(left, &sval))
789 return 1;
790 function_comparison(expr->op, right, sval, 0);
791 return 1;
794 return 0;
797 static sval_t add_one(sval_t sval)
799 sval.value++;
800 return sval;
803 static sval_t sub_one(sval_t sval)
805 sval.value--;
806 return sval;
809 static void match_comparison(struct expression *expr)
811 struct expression *left = strip_expr(expr->left);
812 struct expression *right = strip_expr(expr->right);
813 struct symbol *type;
814 struct range_list *left_orig;
815 struct range_list *left_true;
816 struct range_list *left_false;
817 struct range_list *right_orig;
818 struct range_list *right_true;
819 struct range_list *right_false;
820 struct smatch_state *left_true_state;
821 struct smatch_state *left_false_state;
822 struct smatch_state *right_true_state;
823 struct smatch_state *right_false_state;
824 sval_t min, max, dummy;
825 int left_postop = 0;
826 int right_postop = 0;
828 if (match_func_comparison(expr))
829 return;
831 if (left->op == SPECIAL_INCREMENT || left->op == SPECIAL_DECREMENT) {
832 if (left->type == EXPR_POSTOP) {
833 left->smatch_flags |= Handled;
834 left_postop = left->op;
836 left = strip_expr(left->unop);
838 while (left->type == EXPR_ASSIGNMENT)
839 left = strip_expr(left->left);
841 if (right->op == SPECIAL_INCREMENT || right->op == SPECIAL_DECREMENT) {
842 if (right->type == EXPR_POSTOP) {
843 right->smatch_flags |= Handled;
844 right_postop = right->op;
846 right = strip_expr(right->unop);
849 type = get_type(expr);
850 if (!type)
851 type = &llong_ctype;
853 if (get_implied_rl(left, &left_orig)) {
854 left_orig = cast_rl(type, left_orig);
855 } else {
856 min = sval_type_min(get_type(left));
857 max = sval_type_max(get_type(left));
858 left_orig = cast_rl(type, alloc_rl(min, max));
861 if (get_implied_rl(right, &right_orig)) {
862 right_orig = cast_rl(type, right_orig);
863 } else {
864 min = sval_type_min(get_type(right));
865 max = sval_type_max(get_type(right));
866 right_orig = cast_rl(type, alloc_rl(min, max));
868 min = sval_type_min(type);
869 max = sval_type_max(type);
871 left_true = clone_rl(left_orig);
872 left_false = clone_rl(left_orig);
873 right_true = clone_rl(right_orig);
874 right_false = clone_rl(right_orig);
876 switch (expr->op) {
877 case '<':
878 case SPECIAL_UNSIGNED_LT:
879 left_true = remove_range(left_orig, rl_max(right_orig), max);
880 if (!sval_is_min(rl_min(right_orig))) {
881 left_false = remove_range(left_orig, min, sub_one(rl_min(right_orig)));
884 right_true = remove_range(right_orig, min, rl_min(left_orig));
885 if (!sval_is_max(rl_max(left_orig)))
886 right_false = remove_range(right_orig, add_one(rl_max(left_orig)), max);
887 break;
888 case SPECIAL_UNSIGNED_LTE:
889 case SPECIAL_LTE:
890 if (!sval_is_max(rl_max(right_orig)))
891 left_true = remove_range(left_orig, add_one(rl_max(right_orig)), max);
892 left_false = remove_range(left_orig, min, rl_min(right_orig));
894 if (!sval_is_min(rl_min(left_orig)))
895 right_true = remove_range(right_orig, min, sub_one(rl_min(left_orig)));
896 right_false = remove_range(right_orig, rl_max(left_orig), max);
898 if (sval_cmp(rl_min(left_orig), rl_min(right_orig)) == 0)
899 left_false = remove_range(left_false, rl_min(left_orig), rl_min(left_orig));
900 if (sval_cmp(rl_max(left_orig), rl_max(right_orig)) == 0)
901 right_false = remove_range(right_false, rl_max(left_orig), rl_max(left_orig));
902 break;
903 case SPECIAL_EQUAL:
904 if (!sval_is_max(rl_max(right_orig))) {
905 left_true = remove_range(left_true, add_one(rl_max(right_orig)), max);
907 if (!sval_is_min(rl_min(right_orig))) {
908 left_true = remove_range(left_true, min, sub_one(rl_min(right_orig)));
910 if (sval_cmp(rl_min(right_orig), rl_max(right_orig)) == 0)
911 left_false = remove_range(left_orig, rl_min(right_orig), rl_min(right_orig));
913 if (!sval_is_max(rl_max(left_orig)))
914 right_true = remove_range(right_true, add_one(rl_max(left_orig)), max);
915 if (!sval_is_min(rl_min(left_orig)))
916 right_true = remove_range(right_true, min, sub_one(rl_min(left_orig)));
917 if (sval_cmp(rl_min(left_orig), rl_max(left_orig)) == 0)
918 right_false = remove_range(right_orig, rl_min(left_orig), rl_min(left_orig));
919 break;
920 case SPECIAL_UNSIGNED_GTE:
921 case SPECIAL_GTE:
922 if (!sval_is_min(rl_min(right_orig)))
923 left_true = remove_range(left_orig, min, sub_one(rl_min(right_orig)));
924 left_false = remove_range(left_orig, rl_max(right_orig), max);
926 if (!sval_is_max(rl_max(left_orig)))
927 right_true = remove_range(right_orig, add_one(rl_max(left_orig)), max);
928 right_false = remove_range(right_orig, min, rl_min(left_orig));
930 if (sval_cmp(rl_min(left_orig), rl_min(right_orig)) == 0)
931 right_false = remove_range(right_false, rl_min(left_orig), rl_min(left_orig));
932 if (sval_cmp(rl_max(left_orig), rl_max(right_orig)) == 0)
933 left_false = remove_range(left_false, rl_max(left_orig), rl_max(left_orig));
934 break;
935 case '>':
936 case SPECIAL_UNSIGNED_GT:
937 left_true = remove_range(left_orig, min, rl_min(right_orig));
938 if (!sval_is_max(rl_max(right_orig)))
939 left_false = remove_range(left_orig, add_one(rl_max(right_orig)), max);
941 right_true = remove_range(right_orig, rl_max(left_orig), max);
942 if (!sval_is_min(rl_min(left_orig)))
943 right_false = remove_range(right_orig, min, sub_one(rl_min(left_orig)));
944 break;
945 case SPECIAL_NOTEQUAL:
946 if (!sval_is_max(rl_max(right_orig)))
947 left_false = remove_range(left_false, add_one(rl_max(right_orig)), max);
948 if (!sval_is_min(rl_min(right_orig)))
949 left_false = remove_range(left_false, min, sub_one(rl_min(right_orig)));
950 if (sval_cmp(rl_min(right_orig), rl_max(right_orig)) == 0)
951 left_true = remove_range(left_orig, rl_min(right_orig), rl_min(right_orig));
953 if (!sval_is_max(rl_max(left_orig)))
954 right_false = remove_range(right_false, add_one(rl_max(left_orig)), max);
955 if (!sval_is_min(rl_min(left_orig)))
956 right_false = remove_range(right_false, min, sub_one(rl_min(left_orig)));
957 if (sval_cmp(rl_min(left_orig), rl_max(left_orig)) == 0)
958 right_true = remove_range(right_orig, rl_min(left_orig), rl_min(left_orig));
959 break;
960 default:
961 return;
964 left_true = rl_truncate_cast(get_type(left), left_true);
965 left_false = rl_truncate_cast(get_type(left), left_false);
966 right_true = rl_truncate_cast(get_type(right), right_true);
967 right_false = rl_truncate_cast(get_type(right), right_false);
969 left_true_state = alloc_estate_rl(left_true);
970 left_false_state = alloc_estate_rl(left_false);
971 right_true_state = alloc_estate_rl(right_true);
972 right_false_state = alloc_estate_rl(right_false);
974 switch (expr->op) {
975 case '<':
976 case SPECIAL_UNSIGNED_LT:
977 case SPECIAL_UNSIGNED_LTE:
978 case SPECIAL_LTE:
979 if (get_hard_max(right, &dummy))
980 estate_set_hard_max(left_true_state);
981 if (get_hard_max(left, &dummy))
982 estate_set_hard_max(right_false_state);
983 break;
984 case '>':
985 case SPECIAL_UNSIGNED_GT:
986 case SPECIAL_UNSIGNED_GTE:
987 case SPECIAL_GTE:
988 if (get_hard_max(left, &dummy))
989 estate_set_hard_max(right_true_state);
990 if (get_hard_max(right, &dummy))
991 estate_set_hard_max(left_false_state);
992 break;
995 if (get_hard_max(left, &dummy)) {
996 estate_set_hard_max(left_true_state);
997 estate_set_hard_max(left_false_state);
999 if (get_hard_max(right, &dummy)) {
1000 estate_set_hard_max(right_true_state);
1001 estate_set_hard_max(right_false_state);
1004 if (left_postop == SPECIAL_INCREMENT) {
1005 left_true_state = increment_state(left_true_state);
1006 left_false_state = increment_state(left_false_state);
1008 if (left_postop == SPECIAL_DECREMENT) {
1009 left_true_state = decrement_state(left_true_state);
1010 left_false_state = decrement_state(left_false_state);
1012 if (right_postop == SPECIAL_INCREMENT) {
1013 right_true_state = increment_state(right_true_state);
1014 right_false_state = increment_state(right_false_state);
1016 if (right_postop == SPECIAL_DECREMENT) {
1017 right_true_state = decrement_state(right_true_state);
1018 right_false_state = decrement_state(right_false_state);
1021 set_extra_expr_true_false(left, left_true_state, left_false_state);
1022 set_extra_expr_true_false(right, right_true_state, right_false_state);
1025 /* this is actually hooked from smatch_implied.c... it's hacky, yes */
1026 void __extra_match_condition(struct expression *expr)
1028 struct symbol *sym;
1029 char *name;
1030 struct smatch_state *pre_state;
1031 struct smatch_state *true_state;
1032 struct smatch_state *false_state;
1034 expr = strip_expr(expr);
1035 switch (expr->type) {
1036 case EXPR_CALL:
1037 function_comparison(SPECIAL_NOTEQUAL, expr, ll_to_sval(0), 1);
1038 return;
1039 case EXPR_PREOP:
1040 case EXPR_SYMBOL:
1041 case EXPR_DEREF: {
1042 sval_t zero;
1044 zero = sval_blank(expr);
1045 zero.value = 0;
1047 name = expr_to_var_sym(expr, &sym);
1048 if (!name)
1049 return;
1050 pre_state = get_state(my_id, name, sym);
1051 true_state = estate_filter_sval(pre_state, zero);
1052 if (possibly_true(expr, SPECIAL_EQUAL, zero_expr()))
1053 false_state = alloc_estate_sval(zero);
1054 else
1055 false_state = alloc_estate_empty();
1056 set_extra_true_false(name, sym, true_state, false_state);
1057 free_string(name);
1058 return;
1060 case EXPR_COMPARE:
1061 match_comparison(expr);
1062 return;
1063 case EXPR_ASSIGNMENT:
1064 __extra_match_condition(expr->left);
1065 return;
1069 /* returns 1 if it is not possible for expr to be value, otherwise returns 0 */
1070 int implied_not_equal(struct expression *expr, long long val)
1072 return !possibly_false(expr, SPECIAL_NOTEQUAL, value_expr(val));
1075 static void struct_member_callback(struct expression *call, int param, char *printed_name, struct smatch_state *state)
1077 if (estate_is_whole(state))
1078 return;
1079 sql_insert_caller_info(call, PARAM_VALUE, param, printed_name, state->name);
1082 static void db_limited_before(void)
1084 unmatched_slist = clone_slist(__get_cur_slist());
1087 static void db_limited_after(void)
1089 free_slist(&unmatched_slist);
1092 static void db_param_limit_filter(struct expression *expr, int param, char *key, char *value)
1094 struct expression *arg;
1095 char *name;
1096 struct symbol *sym;
1097 struct sm_state *sm;
1098 struct symbol *type;
1099 struct range_list *rl;
1100 struct range_list *limit;
1101 struct range_list *new;
1103 while (expr->type == EXPR_ASSIGNMENT)
1104 expr = strip_expr(expr->right);
1105 if (expr->type != EXPR_CALL)
1106 return;
1108 arg = get_argument_from_call_expr(expr->args, param);
1109 if (!arg)
1110 return;
1112 name = get_variable_from_key(arg, key, &sym);
1113 if (!name || !sym)
1114 goto free;
1116 sm = get_sm_state(SMATCH_EXTRA, name, sym);
1117 type = get_member_type_from_key(arg, key);
1118 if (sm)
1119 rl = estate_rl(sm->state);
1120 else
1121 rl = alloc_whole_rl(type);
1123 str_to_rl(type, value, &limit);
1124 new = rl_intersection(rl, limit);
1126 /* We want to preserve the implications here */
1127 if (sm && rl_equiv(estate_rl(sm->state), new))
1128 __set_sm(sm);
1129 else
1130 set_extra_nomod(name, sym, alloc_estate_rl(new));
1132 free:
1133 free_string(name);
1136 static void db_param_add(struct expression *expr, int param, char *key, char *value)
1138 struct expression *arg;
1139 char *name;
1140 struct symbol *sym;
1141 struct symbol *type;
1142 struct smatch_state *state;
1143 struct range_list *added = NULL;
1144 struct range_list *new;
1146 while (expr->type == EXPR_ASSIGNMENT)
1147 expr = strip_expr(expr->right);
1148 if (expr->type != EXPR_CALL)
1149 return;
1151 arg = get_argument_from_call_expr(expr->args, param);
1152 if (!arg)
1153 return;
1154 name = get_variable_from_key(arg, key, &sym);
1155 if (!name || !sym)
1156 goto free;
1158 type = get_member_type_from_key(arg, key);
1159 state = get_state(SMATCH_EXTRA, name, sym);
1160 if (state) {
1161 str_to_rl(type, value, &added);
1162 new = rl_union(estate_rl(state), added);
1163 } else {
1164 new = alloc_whole_rl(type);
1167 set_extra_mod(name, sym, alloc_estate_rl(new));
1168 free:
1169 free_string(name);
1172 static void db_returned_states_param(struct expression *expr, int param, char *key, char *value)
1174 struct expression *arg;
1175 struct symbol *type;
1176 struct range_list *rl;
1177 char member_name[256];
1178 char *name;
1179 struct symbol *sym;
1181 while (expr->type == EXPR_ASSIGNMENT)
1182 expr = strip_expr(expr->right);
1183 if (expr->type != EXPR_CALL)
1184 return;
1185 arg = get_argument_from_call_expr(expr->args, param);
1186 arg = strip_expr(arg);
1187 if (!arg)
1188 return;
1190 if (strcmp(key, "*$$") == 0) {
1191 struct symbol *sym;
1192 char buf[256];
1193 char *name;
1195 if (arg->type == EXPR_PREOP && arg->op == '&') {
1196 arg = strip_expr(arg->unop);
1197 name = expr_to_var_sym(arg, &sym);
1198 } else {
1199 char *tmp = expr_to_var_sym(arg, &sym);
1201 if (!tmp)
1202 return;
1203 snprintf(buf, sizeof(buf), "*%s", tmp);
1204 name = alloc_string(buf);
1205 free_string(tmp);
1207 if (!name || !sym) {
1208 free_string(name);
1209 return;
1211 type = get_type(arg);
1212 str_to_rl(type, value, &rl);
1213 set_extra_mod(name, sym, alloc_estate_rl(rl));
1214 free_string(name);
1215 return;
1218 if (arg->type == EXPR_PREOP && arg->op == '&') {
1219 arg = strip_expr(arg->unop);
1220 name = expr_to_var_sym(arg, &sym);
1221 if (!name || !sym)
1222 goto free;
1223 snprintf(member_name, sizeof(member_name), "%s.%s", name, key + 4);
1224 } else {
1225 name = expr_to_var_sym(arg, &sym);
1226 if (!name || !sym)
1227 goto free;
1228 snprintf(member_name, sizeof(member_name), "%s%s", name, key + 2);
1230 type = get_member_type_from_key(arg, key);
1231 if (!type)
1232 goto free;
1233 str_to_rl(type, value, &rl);
1234 set_extra_mod(member_name, sym, alloc_estate_rl(rl));
1235 free:
1236 free_string(name);
1239 static void db_returned_member_info(struct expression *expr, int param, char *key, char *value)
1241 struct symbol *type;
1242 struct symbol *sym;
1243 char *name;
1244 char member_name[256];
1245 struct range_list *rl;
1247 if (expr->type != EXPR_ASSIGNMENT)
1248 return;
1250 name = expr_to_var_sym(expr->left, &sym);
1251 if (!name || !sym)
1252 goto free;
1253 snprintf(member_name, sizeof(member_name), "%s%s", name, key + 2);
1254 type = get_member_type_from_key(expr->left, key);
1255 if (!type)
1256 return;
1257 str_to_rl(type, value, &rl);
1258 set_extra_mod(member_name, sym, alloc_estate_rl(rl));
1260 free:
1261 free_string(name);
1264 static void returned_member_callback(int return_id, char *return_ranges, char *printed_name, struct smatch_state *state)
1266 if (estate_is_whole(state))
1267 return;
1269 sql_insert_return_states(return_id, return_ranges, RETURN_VALUE, -1,
1270 printed_name, state->name);
1273 static void match_call_info(struct expression *expr)
1275 struct range_list *rl = NULL;
1276 struct expression *arg;
1277 struct symbol *type;
1278 int i = 0;
1280 FOR_EACH_PTR(expr->args, arg) {
1281 type = get_arg_type(expr->fn, i);
1283 if (get_implied_rl(arg, &rl))
1284 rl = cast_rl(type, rl);
1285 else
1286 rl = cast_rl(type, alloc_whole_rl(get_type(arg)));
1288 sql_insert_caller_info(expr, PARAM_VALUE, i, "$$", show_rl(rl));
1289 i++;
1290 } END_FOR_EACH_PTR(arg);
1293 static void set_param_value(const char *name, struct symbol *sym, char *key, char *value)
1295 struct range_list *rl = NULL;
1296 struct smatch_state *state;
1297 struct symbol *type;
1298 char fullname[256];
1300 if (strcmp(key, "*$$") == 0)
1301 snprintf(fullname, sizeof(fullname), "*%s", name);
1302 else if (strncmp(key, "$$", 2) == 0)
1303 snprintf(fullname, 256, "%s%s", name, key + 2);
1304 else
1305 return;
1307 type = get_member_type_from_key(symbol_expression(sym), key);
1308 str_to_rl(type, value, &rl);
1309 state = alloc_estate_rl(rl);
1310 set_state(SMATCH_EXTRA, fullname, sym, state);
1313 void register_smatch_extra(int id)
1315 my_id = id;
1317 add_merge_hook(my_id, &merge_estates);
1318 add_unmatched_state_hook(my_id, &unmatched_state);
1319 add_hook(&match_function_def, FUNC_DEF_HOOK);
1320 add_hook(&match_declarations, DECLARATION_HOOK);
1321 add_definition_db_callback(set_param_value, PARAM_VALUE);
1322 add_db_return_states_callback(RETURN_VALUE, &db_returned_member_info);
1323 add_db_return_states_callback(PARAM_VALUE, &db_returned_states_param);
1324 add_db_return_states_before(&db_limited_before);
1325 add_db_return_states_callback(LIMITED_VALUE, &db_param_limit_filter);
1326 add_db_return_states_callback(FILTER_VALUE, &db_param_limit_filter);
1327 add_db_return_states_callback(ADDED_VALUE, &db_param_add);
1328 add_db_return_states_after(&db_limited_after);
1331 void register_smatch_extra_late(int id)
1333 add_hook(&match_dereferences, DEREF_HOOK);
1334 add_hook(&match_pointer_as_array, OP_HOOK);
1335 add_db_fn_call_callback(DEREFERENCE, &set_param_dereferenced);
1336 add_indirect_modification_hook(SMATCH_EXTRA, reset_struct_members);
1337 if (option_no_db)
1338 add_hook(&match_function_call, FUNCTION_CALL_HOOK);
1339 add_hook(&match_assign, ASSIGNMENT_HOOK);
1340 add_hook(&unop_expr, OP_HOOK);
1341 add_hook(&asm_expr, ASM_HOOK);
1343 add_hook(&match_call_info, FUNCTION_CALL_HOOK);
1344 add_member_info_callback(my_id, struct_member_callback);
1345 add_returned_member_callback(my_id, returned_member_callback);