smatch_extra.h

   1 /*
   2  * sparse/smatch_extra.h
   3  *
   4  * Copyright (C) 2009 Dan Carpenter.
   5  *
   6  * Licensed under the Open Software License version 1.1
   7  *
   8  */
   9
  10 DECLARE_PTR_LIST(range_list, struct data_range);
  11 DECLARE_PTR_LIST(range_list_stack, struct range_list);
  12
  13 struct relation {
  14         char *name;
  15         struct symbol *sym;
  16 };
  17
  18 DECLARE_PTR_LIST(related_list, struct relation);
  19
  20 struct data_info {
  21         struct related_list *related;
  22         struct range_list *value_ranges;
  23         unsigned int hard_max:1;
  24 };
  25 DECLARE_ALLOCATOR(data_info);
  26
  27 extern struct string_list *__ignored_macros;
  28
  29 /* these are implemented in smatch_ranges.c */
  30 char *show_rl(struct range_list *list);
  31 int str_to_comparison_arg(const char *c, struct expression *call, int *comparison, struct expression **arg);
  32 void str_to_rl(struct symbol *type, char *value, struct range_list **rl);
  33 void call_results_to_rl(struct expression *call, struct symbol *type, char *value, struct range_list **rl);
  34
  35 struct data_range *alloc_range(sval_t min, sval_t max);
  36 struct data_range *alloc_range_perm(sval_t min, sval_t max);
  37
  38 struct range_list *alloc_rl(sval_t min, sval_t max);
  39 struct range_list *clone_rl(struct range_list *list);
  40 struct range_list *clone_rl_permanent(struct range_list *list);
  41 struct range_list *alloc_whole_rl(struct symbol *type);
  42
  43 void add_range(struct range_list **list, sval_t min, sval_t max);
  44 struct range_list *remove_range(struct range_list *list, sval_t min, sval_t max);
  45 void tack_on(struct range_list **list, struct data_range *drange);
  46
  47 int true_comparison_range(struct data_range *left, int comparison, struct data_range *right);
  48 int true_comparison_range_LR(int comparison, struct data_range *var, struct data_range *val, int left);
  49 int false_comparison_range_LR(int comparison, struct data_range *var, struct data_range *val, int left);
  50
  51 int possibly_true(struct expression *left, int comparison, struct expression *right);
  52 int possibly_true_rl(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  53 int possibly_true_rl_LR(int comparison, struct range_list *a, struct range_list *b, int left);
  54
  55 int possibly_false(struct expression *left, int comparison, struct expression *right);
  56 int possibly_false_rl(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  57 int possibly_false_rl_LR(int comparison, struct range_list *a, struct range_list *b, int left);
  58
  59 int ranges_equiv(struct data_range *one, struct data_range *two);
  60
  61 int rl_equiv(struct range_list *one, struct range_list *two);
  62 int is_whole_rl(struct range_list *rl);
  63
  64 sval_t rl_min(struct range_list *rl);
  65 sval_t rl_max(struct range_list *rl);
  66 int rl_to_sval(struct range_list *rl, sval_t *sval);
  67 struct symbol *rl_type(struct range_list *rl);
  68
  69 struct range_list *rl_invert(struct range_list *orig);
  70 struct range_list *rl_filter(struct range_list *rl, struct range_list *filter);
  71 struct range_list *rl_intersection(struct range_list *one, struct range_list *two);
  72 struct range_list *rl_union(struct range_list *one, struct range_list *two);
  73
  74 void push_rl(struct range_list_stack **rl_stack, struct range_list *rl);
  75 struct range_list *pop_rl(struct range_list_stack **rl_stack);
  76 struct range_list *top_rl(struct range_list_stack *rl_stack);
  77 void filter_top_rl(struct range_list_stack **rl_stack, sval_t sval);
  78
  79 struct range_list *rl_truncate_cast(struct symbol *type, struct range_list *rl);
  80 struct range_list *cast_rl(struct symbol *type, struct range_list *rl);
  81 int get_implied_rl(struct expression *expr, struct range_list **rl);
  82 int get_implied_rl_var_sym(const char *var, struct symbol *sym, struct range_list **rl);
  83
  84 void free_rl(struct range_list **rlist);
  85 void free_data_info_allocs(void);
  86
  87 /* smatch_estate.c */
  88
  89 struct smatch_state *alloc_estate_empty(void);
  90 struct smatch_state *alloc_estate_sval(sval_t sval);
  91 struct smatch_state *alloc_estate_range(sval_t min, sval_t max);
  92 struct smatch_state *alloc_estate_rl(struct range_list *rl);
  93 struct smatch_state *alloc_estate_whole(struct symbol *type);
  94 struct smatch_state *clone_estate(struct smatch_state *state);
  95
  96 struct smatch_state *merge_estates(struct smatch_state *s1, struct smatch_state *s2);
  97
  98 int estates_equiv(struct smatch_state *one, struct smatch_state *two);
  99 int estate_is_whole(struct smatch_state *state);
 100
 101 struct range_list *estate_rl(struct smatch_state *state);
 102 struct related_list *estate_related(struct smatch_state *state);
 103
 104 sval_t estate_min(struct smatch_state *state);
 105 sval_t estate_max(struct smatch_state *state);
 106 struct symbol *estate_type(struct smatch_state *state);
 107
 108 int estate_has_hard_max(struct smatch_state *state);
 109 void estate_set_hard_max(struct smatch_state *state);
 110 void estate_clear_hard_max(struct smatch_state *state);
 111 int estate_get_hard_max(struct smatch_state *state, sval_t *sval);
 112
 113 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
 114 struct smatch_state *get_implied_estate(struct expression *expr);
 115
 116 struct smatch_state *estate_filter_sval(struct smatch_state *orig, sval_t filter);
 117 struct smatch_state *estate_filter_range(struct smatch_state *orig, sval_t filter_min, sval_t filter_max);
 118
 119 /* smatch_extra.c */
 120 void call_extra_mod_hooks(const char *name, struct symbol *sym, struct smatch_state *state);
 121 struct sm_state *set_extra_mod(const char *name, struct symbol *sym, struct smatch_state *state);
 122 struct sm_state *set_extra_expr_mod(struct expression *expr, struct smatch_state *state);
 123 void set_extra_nomod(const char *name, struct symbol *sym, struct smatch_state *state);
 124 void set_extra_expr_nomod(struct expression *expr, struct smatch_state *state);
 125
 126 struct data_info *get_dinfo(struct smatch_state *state);
 127
 128 void add_extra_mod_hook(void (*fn)(const char *name, struct symbol *sym, struct smatch_state *state));
 129 int implied_not_equal(struct expression *expr, long long val);
 130
 131 struct sm_state *__extra_handle_canonical_loops(struct statement *loop, struct state_list **slist);
 132 int __iterator_unchanged(struct sm_state *sm);
 133 void __extra_pre_loop_hook_after(struct sm_state *sm,
 134                                 struct statement *iterator,
 135                                 struct expression *condition);
 136
 137 /* smatch_equiv.c */
 138 void set_equiv(struct expression *left, struct expression *right);
 139 void set_related(struct smatch_state *estate, struct related_list *rlist);
 140 struct related_list *get_shared_relations(struct related_list *one,
 141                                               struct related_list *two);
 142 struct related_list *clone_related_list(struct related_list *related);
 143 void remove_from_equiv(const char *name, struct symbol *sym);
 144 void remove_from_equiv_expr(struct expression *expr);
 145 void set_equiv_state_expr(int id, struct expression *expr, struct smatch_state *state);
 146
 147 /* smatch_function_hooks.c */
 148 void function_comparison(int comparison, struct expression *expr, sval_t sval, int left);
 149
 150 /* smatch_expressions.c */
 151 struct expression *zero_expr();
 152 struct expression *value_expr(long long val);
 153 struct expression *member_expression(struct expression *deref, int op, struct ident *member);
 154 struct expression *deref_expression(struct expression *expr);
 155 struct expression *assign_expression(struct expression *left, struct expression *right);
 156 struct expression *binop_expression(struct expression *left, int op, struct expression *right);
 157 struct expression *array_element_expression(struct expression *array, struct expression *offset);
 158 struct expression *symbol_expression(struct symbol *sym);
 159
 160 /* smatch_param_limit.c */
 161 struct smatch_state *get_orig_estate(const char *name, struct symbol *sym);