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         unsigned int capped:1;
  34         unsigned int treat_untagged:1;
  35         unsigned int set:1;
  36 };
  37 DECLARE_ALLOCATOR(data_info);
  38
  39 extern struct string_list *__ignored_macros;
  40
  41 /* these are implemented in smatch_ranges.c */
  42 struct range_list *rl_zero(void);
  43 struct range_list *rl_one(void);
  44 char *show_rl(struct range_list *list);
  45 int str_to_comparison_arg(const char *c, struct expression *call, int *comparison, struct expression **arg);
  46 void str_to_rl(struct symbol *type, char *value, struct range_list **rl);
  47 void call_results_to_rl(struct expression *call, struct symbol *type, const char *value, struct range_list **rl);
  48
  49 struct data_range *alloc_range(sval_t min, sval_t max);
  50 struct data_range *alloc_range_perm(sval_t min, sval_t max);
  51
  52 int rl_fits_in_type(struct range_list *rl, struct symbol *type);
  53 int values_fit_type(struct expression *left, struct expression *right);
  54
  55 struct range_list *alloc_rl(sval_t min, sval_t max);
  56 struct range_list *clone_rl(struct range_list *list);
  57 struct range_list *clone_rl_permanent(struct range_list *list);
  58 struct range_list *alloc_whole_rl(struct symbol *type);
  59
  60 void add_range(struct range_list **list, sval_t min, sval_t max);
  61 struct range_list *remove_range(struct range_list *list, sval_t min, sval_t max);
  62 void tack_on(struct range_list **list, struct data_range *drange);
  63
  64 int true_comparison_range(struct data_range *left, int comparison, struct data_range *right);
  65 int true_comparison_range_LR(int comparison, struct data_range *var, struct data_range *val, int left);
  66 int false_comparison_range_LR(int comparison, struct data_range *var, struct data_range *val, int left);
  67
  68 int possibly_true(struct expression *left, int comparison, struct expression *right);
  69 int possibly_true_rl(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  70 int possibly_true_rl_LR(int comparison, struct range_list *a, struct range_list *b, int left);
  71
  72 int possibly_false(struct expression *left, int comparison, struct expression *right);
  73 int possibly_false_rl(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  74 int possibly_false_rl_LR(int comparison, struct range_list *a, struct range_list *b, int left);
  75
  76 int rl_has_sval(struct range_list *rl, sval_t sval);
  77 int ranges_equiv(struct data_range *one, struct data_range *two);
  78
  79 bool is_err_ptr(sval_t sval);
  80 bool is_err_or_null(struct range_list *rl);
  81 bool is_noderef_ptr_rl(struct range_list *rl);
  82 bool rl_is_zero(struct range_list *rl);
  83
  84 int rl_equiv(struct range_list *one, struct range_list *two);
  85 int is_whole_rl(struct range_list *rl);
  86 int is_unknown_ptr(struct range_list *rl);
  87 bool is_whole_ptr_rl(struct range_list *rl);
  88 int is_whole_rl_non_zero(struct range_list *rl);
  89 int estate_is_unknown(struct smatch_state *state);
  90
  91 sval_t rl_min(struct range_list *rl);
  92 sval_t rl_max(struct range_list *rl);
  93 int rl_to_sval(struct range_list *rl, sval_t *sval);
  94 struct symbol *rl_type(struct range_list *rl);
  95
  96 struct range_list *rl_filter(struct range_list *rl, struct range_list *filter);
  97 struct range_list *rl_intersection(struct range_list *one, struct range_list *two);
  98 struct range_list *rl_union(struct range_list *one, struct range_list *two);
  99 struct range_list *rl_binop(struct range_list *left, int op, struct range_list *right);
 100
 101 void push_rl(struct range_list_stack **rl_stack, struct range_list *rl);
 102 struct range_list *pop_rl(struct range_list_stack **rl_stack);
 103 struct range_list *top_rl(struct range_list_stack *rl_stack);
 104 void filter_top_rl(struct range_list_stack **rl_stack, struct range_list *filter);
 105
 106 struct range_list *rl_truncate_cast(struct symbol *type, struct range_list *rl);
 107 struct range_list *cast_rl(struct symbol *type, struct range_list *rl);
 108 int get_implied_rl(struct expression *expr, struct range_list **rl);
 109 int get_absolute_rl(struct expression *expr, struct range_list **rl);
 110 void set_real_absolute(struct expression *expr, struct smatch_state *state);
 111 int get_real_absolute_rl(struct expression *expr, struct range_list **rl);
 112 struct range_list *var_to_absolute_rl(struct expression *expr);
 113 int custom_get_absolute_rl(struct expression *expr,
 114                            struct range_list *(*fn)(struct expression *expr),
 115                            struct range_list **rl);
 116 int get_implied_rl_var_sym(const char *var, struct symbol *sym, struct range_list **rl);
 117 void split_comparison_rl(struct range_list *left_orig, int op, struct range_list *right_orig,
 118                 struct range_list **left_true_rl, struct range_list **left_false_rl,
 119                 struct range_list **right_true_rl, struct range_list **right_false_rl);
 120
 121 void free_data_info_allocs(void);
 122 void free_all_rl(void);
 123
 124 /* smatch_estate.c */
 125
 126 struct smatch_state *alloc_estate_empty(void);
 127 struct smatch_state *alloc_estate_sval(sval_t sval);
 128 struct smatch_state *alloc_estate_range(sval_t min, sval_t max);
 129 struct smatch_state *alloc_estate_rl(struct range_list *rl);
 130 struct smatch_state *alloc_estate_whole(struct symbol *type);
 131 struct smatch_state *clone_estate(struct smatch_state *state);
 132 struct smatch_state *clone_estate_cast(struct symbol *type, struct smatch_state *state);
 133 struct smatch_state *clone_partial_estate(struct smatch_state *state, struct range_list *rl);
 134
 135 struct smatch_state *merge_estates(struct smatch_state *s1, struct smatch_state *s2);
 136
 137 int estates_equiv(struct smatch_state *one, struct smatch_state *two);
 138 int estate_is_whole(struct smatch_state *state);
 139 int estate_is_empty(struct smatch_state *state);
 140
 141 struct range_list *estate_rl(struct smatch_state *state);
 142 struct related_list *estate_related(struct smatch_state *state);
 143
 144 sval_t estate_min(struct smatch_state *state);
 145 sval_t estate_max(struct smatch_state *state);
 146 struct symbol *estate_type(struct smatch_state *state);
 147
 148 int estate_has_fuzzy_max(struct smatch_state *state);
 149 sval_t estate_get_fuzzy_max(struct smatch_state *state);
 150 void estate_set_fuzzy_max(struct smatch_state *state, sval_t max);
 151 void estate_copy_fuzzy_max(struct smatch_state *new, struct smatch_state *old);
 152 void estate_clear_fuzzy_max(struct smatch_state *state);
 153 int estate_has_hard_max(struct smatch_state *state);
 154 void estate_set_hard_max(struct smatch_state *state);
 155 void estate_clear_hard_max(struct smatch_state *state);
 156 int estate_get_hard_max(struct smatch_state *state, sval_t *sval);
 157 bool estate_capped(struct smatch_state *state);
 158 void estate_set_capped(struct smatch_state *state);
 159 bool estate_treat_untagged(struct smatch_state *state);
 160 void estate_set_treat_untagged(struct smatch_state *state);
 161 bool estate_new(struct smatch_state *state);
 162 void estate_set_new(struct smatch_state *state);
 163
 164 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
 165 struct smatch_state *get_implied_estate(struct expression *expr);
 166
 167 struct smatch_state *estate_filter_sval(struct smatch_state *orig, sval_t filter);
 168 struct data_info *clone_dinfo_perm(struct data_info *dinfo);
 169 struct smatch_state *clone_estate_perm(struct smatch_state *state);
 170
 171 /* smatch_extra.c */
 172 bool is_impossible_variable(struct expression *expr);
 173 struct sm_state *get_extra_sm_state(struct expression *expr);
 174 struct smatch_state *get_extra_state(struct expression *expr);
 175 void call_extra_mod_hooks(const char *name, struct symbol *sym, struct expression *expr, struct smatch_state *state);
 176 void set_extra_mod(const char *name, struct symbol *sym, struct expression *expr, struct smatch_state *state);
 177 void set_extra_expr_mod(struct expression *expr, struct smatch_state *state);
 178 void set_extra_nomod(const char *name, struct symbol *sym, struct expression *expr, struct smatch_state *state);
 179 void set_extra_nomod_vsl(const char *name, struct symbol *sym, struct var_sym_list *vsl, struct expression *expr, struct smatch_state *state);
 180 void set_extra_expr_nomod(struct expression *expr, struct smatch_state *state);
 181 void set_extra_mod_helper(const char *name, struct symbol *sym, struct expression *expr, struct smatch_state *state);
 182
 183 struct data_info *get_dinfo(struct smatch_state *state);
 184
 185 void add_extra_mod_hook(void (*fn)(const char *name, struct symbol *sym, struct expression *expr, struct smatch_state *state));
 186 void add_extra_nomod_hook(void (*fn)(const char *name, struct symbol *sym, struct expression *expr, struct smatch_state *state));
 187 int implied_not_equal(struct expression *expr, long long val);
 188 int implied_not_equal_name_sym(char *name, struct symbol *sym, long long val);
 189 int parent_is_null_var_sym(const char *name, struct symbol *sym);
 190 int parent_is_err_or_null_var_sym(const char *name, struct symbol *sym);
 191 int parent_is_null(struct expression *expr);
 192 int parent_is_free_var_sym_strict(const char *name, struct symbol *sym);
 193 int parent_is_free_var_sym(const char *name, struct symbol *sym);
 194 int parent_is_free(struct expression *expr);
 195
 196 struct sm_state *__extra_handle_canonical_loops(struct statement *loop, struct stree **stree);
 197 int __iterator_unchanged(struct sm_state *sm);
 198 void __extra_pre_loop_hook_after(struct sm_state *sm,
 199                                 struct statement *iterator,
 200                                 struct expression *condition);
 201
 202 /* smatch_equiv.c */
 203 void set_equiv(struct expression *left, struct expression *right);
 204 void set_related(struct smatch_state *estate, struct related_list *rlist);
 205 struct related_list *get_shared_relations(struct related_list *one,
 206                                               struct related_list *two);
 207 struct related_list *clone_related_list(struct related_list *related);
 208 void remove_from_equiv(const char *name, struct symbol *sym);
 209 void remove_from_equiv_expr(struct expression *expr);
 210 void set_equiv_state_expr(int id, struct expression *expr, struct smatch_state *state);
 211
 212 /* smatch_function_hooks.c */
 213 void function_comparison(struct expression *left, int comparison, struct expression *right);
 214
 215 /* smatch_expressions.c */
 216 struct expression *zero_expr();
 217 struct expression *value_expr(long long val);
 218 struct expression *member_expression(struct expression *deref, int op, struct ident *member);
 219 struct expression *preop_expression(struct expression *expr, int op);
 220 struct expression *deref_expression(struct expression *expr);
 221 struct expression *assign_expression(struct expression *left, int op, struct expression *right);
 222 struct expression *binop_expression(struct expression *left, int op, struct expression *right);
 223 struct expression *array_element_expression(struct expression *array, struct expression *offset);
 224 struct expression *symbol_expression(struct symbol *sym);
 225 struct expression *gen_string_expression(char *str);
 226 struct expression *compare_expression(struct expression *left, int op, struct expression *right);
 227 struct expression *call_expression(struct expression *fn, struct expression_list *args);
 228 struct expression *unknown_value_expression(struct expression *expr);
 229 int is_fake_call(struct expression *expr);
 230 struct expression *gen_expression_from_name_sym(const char *name, struct symbol *sym);
 231 struct expression *gen_expression_from_key(struct expression *arg, const char *key);
 232 struct expression *gen_expr_from_param_key(struct expression *expr, int param, const char *key);
 233 bool is_fake_var(struct expression *expr);
 234 struct expression *fake_variable(struct symbol *type, const char *name);
 235 void free_tmp_expressions(void);
 236 void expr_set_parent_expr(struct expression *expr, struct expression *parent);
 237 void expr_set_parent_stmt(struct expression *expr, struct statement *parent);
 238 struct expression *expr_get_parent_expr(struct expression *expr);
 239 struct expression *expr_get_fake_parent_expr(struct expression *expr);
 240 struct statement *expr_get_parent_stmt(struct expression *expr);
 241 struct statement *get_parent_stmt(struct expression *expr);
 242
 243 /* smatch_param_limit.c */
 244 struct smatch_state *get_orig_estate(const char *name, struct symbol *sym);
 245
 246 /* smatch_real_absolute.c */
 247 struct smatch_state *get_real_absolute_state(struct expression *expr);
 248 struct smatch_state *get_real_absolute_state_var_sym(const char *name, struct symbol *sym);
 249
 250 /* smatch_imaginary_absolute.c */
 251 void __save_imaginary_state(struct expression *expr, struct range_list *true_rl, struct range_list *false_rl);
 252 int get_imaginary_absolute(struct expression *expr, struct range_list **rl);
 253