smatch_extra.h

   1 /*
   2  * Copyright (C) 2009 Dan Carpenter.
   3  *
   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.
   8  *
   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.
  13  *
  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
  16  */
  17
  18 DECLARE_PTR_LIST(range_list, struct data_range);
  19 DECLARE_PTR_LIST(range_list_stack, struct range_list);
  20
  21 struct relation {
  22         char *name;
  23         struct symbol *sym;
  24 };
  25
  26 DECLARE_PTR_LIST(related_list, struct relation);
  27
  28 struct data_info {
  29         struct related_list *related;
  30         struct range_list *value_ranges;
  31         sval_t fuzzy_max;
  32         unsigned int hard_max:1;
  33 };
  34 DECLARE_ALLOCATOR(data_info);
  35
  36 extern struct string_list *__ignored_macros;
  37
  38 /* these are implemented in smatch_ranges.c */
  39 struct range_list *rl_zero(void);
  40 struct range_list *rl_one(void);
  41 char *show_rl(struct range_list *list);
  42 int str_to_comparison_arg(const char *c, struct expression *call, int *comparison, struct expression **arg);
  43 void str_to_rl(struct symbol *type, char *value, struct range_list **rl);
  44 void call_results_to_rl(struct expression *call, struct symbol *type, char *value, struct range_list **rl);
  45
  46 struct data_range *alloc_range(sval_t min, sval_t max);
  47 struct data_range *alloc_range_perm(sval_t min, sval_t max);
  48
  49 struct range_list *alloc_rl(sval_t min, sval_t max);
  50 struct range_list *clone_rl(struct range_list *list);
  51 struct range_list *clone_rl_permanent(struct range_list *list);
  52 struct range_list *alloc_whole_rl(struct symbol *type);
  53
  54 void add_range(struct range_list **list, sval_t min, sval_t max);
  55 struct range_list *remove_range(struct range_list *list, sval_t min, sval_t max);
  56 void tack_on(struct range_list **list, struct data_range *drange);
  57
  58 int true_comparison_range(struct data_range *left, int comparison, struct data_range *right);
  59 int true_comparison_range_LR(int comparison, struct data_range *var, struct data_range *val, int left);
  60 int false_comparison_range_LR(int comparison, struct data_range *var, struct data_range *val, int left);
  61
  62 int possibly_true(struct expression *left, int comparison, struct expression *right);
  63 int possibly_true_rl(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  64 int possibly_true_rl_LR(int comparison, struct range_list *a, struct range_list *b, int left);
  65
  66 int possibly_false(struct expression *left, int comparison, struct expression *right);
  67 int possibly_false_rl(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  68 int possibly_false_rl_LR(int comparison, struct range_list *a, struct range_list *b, int left);
  69
  70 int rl_has_sval(struct range_list *rl, sval_t sval);
  71 int ranges_equiv(struct data_range *one, struct data_range *two);
  72
  73 int rl_equiv(struct range_list *one, struct range_list *two);
  74 int is_whole_rl(struct range_list *rl);
  75 int is_whole_rl_non_zero(struct range_list *rl);
  76 int estate_is_unknown(struct smatch_state *state);
  77
  78 sval_t rl_min(struct range_list *rl);
  79 sval_t rl_max(struct range_list *rl);
  80 int rl_to_sval(struct range_list *rl, sval_t *sval);
  81 struct symbol *rl_type(struct range_list *rl);
  82
  83 struct range_list *rl_invert(struct range_list *orig);
  84 struct range_list *rl_filter(struct range_list *rl, struct range_list *filter);
  85 struct range_list *rl_intersection(struct range_list *one, struct range_list *two);
  86 struct range_list *rl_union(struct range_list *one, struct range_list *two);
  87 struct range_list *rl_binop(struct range_list *left, int op, struct range_list *right);
  88
  89 void push_rl(struct range_list_stack **rl_stack, struct range_list *rl);
  90 struct range_list *pop_rl(struct range_list_stack **rl_stack);
  91 struct range_list *top_rl(struct range_list_stack *rl_stack);
  92 void filter_top_rl(struct range_list_stack **rl_stack, struct range_list *filter);
  93
  94 struct range_list *rl_truncate_cast(struct symbol *type, struct range_list *rl);
  95 struct range_list *cast_rl(struct symbol *type, struct range_list *rl);
  96 int get_implied_rl(struct expression *expr, struct range_list **rl);
  97 int get_absolute_rl(struct expression *expr, struct range_list **rl);
  98 int get_real_absolute_rl(struct expression *expr, struct range_list **rl);
  99 struct range_list *var_to_absolute_rl(struct expression *expr);
 100 int custom_get_absolute_rl(struct expression *expr,
 101                            struct range_list *(*fn)(struct expression *expr),
 102                            struct range_list **rl);
 103 int get_implied_rl_var_sym(const char *var, struct symbol *sym, struct range_list **rl);
 104 void split_comparison_rl(struct range_list *left_orig, int op, struct range_list *right_orig,
 105                 struct range_list **left_true_rl, struct range_list **left_false_rl,
 106                 struct range_list **right_true_rl, struct range_list **right_false_rl);
 107
 108 void free_rl(struct range_list **rlist);
 109 void free_data_info_allocs(void);
 110
 111 /* smatch_estate.c */
 112
 113 struct smatch_state *alloc_estate_empty(void);
 114 struct smatch_state *alloc_estate_sval(sval_t sval);
 115 struct smatch_state *alloc_estate_range(sval_t min, sval_t max);
 116 struct smatch_state *alloc_estate_rl(struct range_list *rl);
 117 struct smatch_state *alloc_estate_whole(struct symbol *type);
 118 struct smatch_state *clone_estate(struct smatch_state *state);
 119 struct smatch_state *clone_estate_cast(struct symbol *type, struct smatch_state *state);
 120
 121 struct smatch_state *merge_estates(struct smatch_state *s1, struct smatch_state *s2);
 122
 123 int estates_equiv(struct smatch_state *one, struct smatch_state *two);
 124 int estate_is_whole(struct smatch_state *state);
 125 int estate_is_empty(struct smatch_state *state);
 126
 127 struct range_list *estate_rl(struct smatch_state *state);
 128 struct related_list *estate_related(struct smatch_state *state);
 129
 130 sval_t estate_min(struct smatch_state *state);
 131 sval_t estate_max(struct smatch_state *state);
 132 struct symbol *estate_type(struct smatch_state *state);
 133
 134 int estate_has_fuzzy_max(struct smatch_state *state);
 135 sval_t estate_get_fuzzy_max(struct smatch_state *state);
 136 void estate_set_fuzzy_max(struct smatch_state *state, sval_t max);
 137 void estate_copy_fuzzy_max(struct smatch_state *new, struct smatch_state *old);
 138 void estate_clear_fuzzy_max(struct smatch_state *state);
 139 int estate_has_hard_max(struct smatch_state *state);
 140 void estate_set_hard_max(struct smatch_state *state);
 141 void estate_clear_hard_max(struct smatch_state *state);
 142 int estate_get_hard_max(struct smatch_state *state, sval_t *sval);
 143
 144 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
 145 struct smatch_state *get_implied_estate(struct expression *expr);
 146
 147 struct smatch_state *estate_filter_sval(struct smatch_state *orig, sval_t filter);
 148 struct smatch_state *estate_filter_range(struct smatch_state *orig, sval_t filter_min, sval_t filter_max);
 149 struct data_info *clone_dinfo_perm(struct data_info *dinfo);
 150 struct smatch_state *clone_estate_perm(struct smatch_state *state);
 151
 152 /* smatch_extra.c */
 153 struct smatch_state *get_extra_state(struct expression *expr);
 154 void call_extra_mod_hooks(const char *name, struct symbol *sym, struct expression *expr, struct smatch_state *state);
 155 void set_extra_mod(const char *name, struct symbol *sym, struct expression *expr, struct smatch_state *state);
 156 void set_extra_expr_mod(struct expression *expr, struct smatch_state *state);
 157 void set_extra_nomod(const char *name, struct symbol *sym, struct expression *expr, struct smatch_state *state);
 158 void set_extra_nomod_vsl(const char *name, struct symbol *sym, struct var_sym_list *vsl, struct expression *expr, struct smatch_state *state);
 159 void set_extra_expr_nomod(struct expression *expr, struct smatch_state *state);
 160
 161 struct data_info *get_dinfo(struct smatch_state *state);
 162
 163 void add_extra_mod_hook(void (*fn)(const char *name, struct symbol *sym, struct expression *expr, struct smatch_state *state));
 164 void add_extra_nomod_hook(void (*fn)(const char *name, struct symbol *sym, struct expression *expr, struct smatch_state *state));
 165 int implied_not_equal(struct expression *expr, long long val);
 166 int implied_not_equal_name_sym(char *name, struct symbol *sym, long long val);
 167 int parent_is_null_var_sym(const char *name, struct symbol *sym);
 168 int parent_is_null(struct expression *expr);
 169 int parent_is_free_var_sym_strict(const char *name, struct symbol *sym);
 170 int parent_is_free_var_sym(const char *name, struct symbol *sym);
 171 int parent_is_free(struct expression *expr);
 172
 173 struct sm_state *__extra_handle_canonical_loops(struct statement *loop, struct stree **stree);
 174 int __iterator_unchanged(struct sm_state *sm);
 175 void __extra_pre_loop_hook_after(struct sm_state *sm,
 176                                 struct statement *iterator,
 177                                 struct expression *condition);
 178
 179 /* smatch_equiv.c */
 180 void set_equiv(struct expression *left, struct expression *right);
 181 void set_related(struct smatch_state *estate, struct related_list *rlist);
 182 struct related_list *get_shared_relations(struct related_list *one,
 183                                               struct related_list *two);
 184 struct related_list *clone_related_list(struct related_list *related);
 185 void remove_from_equiv(const char *name, struct symbol *sym);
 186 void remove_from_equiv_expr(struct expression *expr);
 187 void set_equiv_state_expr(int id, struct expression *expr, struct smatch_state *state);
 188
 189 /* smatch_function_hooks.c */
 190 void function_comparison(struct expression *left, int comparison, struct expression *right);
 191
 192 /* smatch_expressions.c */
 193 struct expression *zero_expr();
 194 struct expression *value_expr(long long val);
 195 struct expression *member_expression(struct expression *deref, int op, struct ident *member);
 196 struct expression *deref_expression(struct expression *expr);
 197 struct expression *assign_expression(struct expression *left, struct expression *right);
 198 struct expression *binop_expression(struct expression *left, int op, struct expression *right);
 199 struct expression *array_element_expression(struct expression *array, struct expression *offset);
 200 struct expression *symbol_expression(struct symbol *sym);
 201 struct expression *compare_expression(struct expression *left, int op, struct expression *right);
 202 struct expression *unknown_value_expression(struct expression *expr);
 203 int is_fake_call(struct expression *expr);
 204 struct expression *gen_expression_from_key(struct expression *arg, const char *key);
 205
 206 /* smatch_param_limit.c */
 207 struct smatch_state *get_orig_estate(const char *name, struct symbol *sym);
 208
 209 /* smatch_real_absolute.c */
 210 struct smatch_state *get_real_absolute_state(struct expression *expr);
 211 struct smatch_state *get_real_absolute_state_var_sym(const char *name, struct symbol *sym);
 212
 213 /* smatch_imaginary_absolute.c */
 214 void __save_imaginary_state(struct expression *expr, struct range_list *true_rl, struct range_list *false_rl);
 215 int get_imaginary_absolute(struct expression *expr, struct range_list **rl);
 216