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