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