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 DECLARE_PTR_LIST(range_list_sval, struct data_range_sval);
  18 DECLARE_PTR_LIST(range_list_stack_sval, struct range_list_sval);
  19
  20 struct relation {
  21         int op;
  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         enum data_type type;
  31         struct range_list *value_ranges;
  32 };
  33 DECLARE_ALLOCATOR(data_info);
  34
  35 extern struct string_list *__ignored_macros;
  36
  37 extern struct smatch_state estate_undefined;
  38 void alloc_estate_undefined(void);
  39
  40 /* these are implemented in smatch_ranges.c */
  41 int is_whole_range_rl(struct range_list *rl);
  42 int is_whole_range_rl_sval(struct range_list_sval *rl);
  43 int rl_contiguous(struct range_list *rl);
  44 long long rl_min(struct range_list *rl);
  45 long long rl_max(struct range_list *rl);
  46 sval_t rl_min_sval(struct range_list_sval *rl);
  47 sval_t rl_max_sval(struct range_list_sval *rl);
  48
  49 struct data_range *alloc_range_perm(long long min, long long max);
  50 struct data_range_sval *alloc_range_perm_sval(sval_t min, sval_t max);
  51 struct range_list *alloc_range_list(long long min, long long max);
  52 struct range_list_sval *alloc_range_list_sval(sval_t min, sval_t max);
  53 struct range_list *whole_range_list(void);
  54 void add_range(struct range_list **list, long long min, long long max);
  55 void add_range_sval(struct range_list_sval **list, sval_t min, sval_t max);
  56 int ranges_equiv_sval(struct data_range_sval *one, struct data_range_sval *two);
  57 int range_lists_equiv(struct range_list *one, struct range_list *two);
  58 struct range_list *invert_range_list(struct range_list *orig);
  59 int true_comparison_range(struct data_range *left, int comparison, struct data_range *right);
  60 int true_comparison_range_sval(struct data_range_sval *left, int comparison, struct data_range_sval *right);
  61
  62 int possibly_true(struct expression *left, int comparison, struct expression *right);
  63 int possibly_true_range_lists(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  64 int possibly_true_range_lists_sval(struct range_list_sval *left_ranges, int comparison, struct range_list_sval *right_ranges);
  65 int possibly_true_range_lists_rl(int comparison, struct range_list *a, struct range_list *b, int left);
  66 int possibly_true_range_lists_rl_sval(int comparison, struct range_list_sval *a, struct range_list_sval *b, int left);
  67
  68 int possibly_false(struct expression *left, int comparison, struct expression *right);
  69 int possibly_false_range_lists(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  70 int possibly_false_range_lists_sval(struct range_list_sval *left_ranges, int comparison, struct range_list_sval *right_ranges);
  71 int possibly_false_range_lists_rl(int comparison, struct range_list *a, struct range_list *b, int left);
  72 int possibly_false_range_lists_rl_sval(int comparison, struct range_list_sval *a, struct range_list_sval *b, int left);
  73
  74 void free_range_list(struct range_list **rlist);
  75 void free_range_list_sval(struct range_list_sval **rlist);
  76 void free_data_info_allocs(void);
  77 struct range_list *clone_range_list(struct range_list *list);
  78 struct range_list_sval *clone_range_list_sval(struct range_list_sval *list);
  79 struct range_list *clone_permanent(struct range_list *list);
  80 char *show_ranges(struct range_list *list);
  81 char *show_ranges_sval(struct range_list_sval *list);
  82 void get_value_ranges(char *value, struct range_list **rl);
  83 void get_value_ranges_sval(char *value, struct range_list_sval **rl);
  84
  85 struct range_list *remove_range(struct range_list *list, long long min, long long max);
  86 struct range_list_sval *remove_range_sval(struct range_list_sval *list, sval_t min, sval_t max);
  87
  88 /* used in smatch_slist.  implemented in smatch_extra.c */
  89 int implied_not_equal(struct expression *expr, long long val);
  90 struct sm_state *__extra_handle_canonical_loops(struct statement *loop, struct state_list **slist);
  91 int __iterator_unchanged(struct sm_state *sm);
  92 void __extra_pre_loop_hook_after(struct sm_state *sm,
  93                                 struct statement *iterator,
  94                                 struct expression *condition);
  95
  96 /* also implemented in smatch_extra */
  97 int estates_equiv(struct smatch_state *one, struct smatch_state *two);
  98 struct smatch_state *clone_estate(struct smatch_state *state);
  99 struct sm_state *set_extra_mod(const char *name, struct symbol *sym, struct smatch_state *state);
 100 struct sm_state *set_extra_expr_mod(struct expression *expr, struct smatch_state *state);
 101 void set_extra_expr_nomod(struct expression *expr, struct smatch_state *state);
 102 struct smatch_state *alloc_estate_empty(void);
 103 struct smatch_state *alloc_estate(long long val);
 104 struct smatch_state *alloc_estate_sval(sval_t sval);
 105 struct smatch_state *alloc_estate_range_list(struct range_list *rl);
 106 struct smatch_state *alloc_estate_range_list_sval(struct range_list_sval *rl);
 107 struct data_info *get_dinfo(struct smatch_state *state);
 108 struct range_list *estate_ranges(struct smatch_state *state);
 109 struct range_list_sval *estate_ranges_sval(struct smatch_state *state);
 110 struct related_list *estate_related(struct smatch_state *state);
 111 long long estate_min(struct smatch_state *state);
 112 long long estate_max(struct smatch_state *state);
 113 sval_t estate_min_sval(struct smatch_state *state);
 114 sval_t estate_max_sval(struct smatch_state *state);
 115 struct smatch_state *filter_range_list(struct smatch_state *orig,
 116                                  struct range_list *rl);
 117 struct smatch_state *add_filter(struct smatch_state *orig, long long filter);
 118 struct smatch_state *filter_range(struct smatch_state *orig,
 119                                  long long filter_min, long long filter_max);
 120 struct smatch_state *extra_undefined(void);
 121
 122 struct range_list *range_list_union(struct range_list *one, struct range_list *two);
 123 struct range_list_sval *range_list_union_sval(struct range_list_sval *one, struct range_list_sval *two);
 124 int estate_get_single_value(struct smatch_state *estate, long long *val);
 125 int estate_get_single_value_sval(struct smatch_state *state, sval_t *sval);
 126
 127 void function_comparison(int comparison, struct expression *expr, long long value, int left);
 128
 129 int true_comparison_range_lr(int comparison, struct data_range *var, struct data_range *val, int left);
 130 int false_comparison_range_lr(int comparison, struct data_range *var, struct data_range *val, int left);
 131 int true_comparison_range_lr_sval(int comparison, struct data_range_sval *var, struct data_range_sval *val, int left);
 132 int false_comparison_range_lr_sval(int comparison, struct data_range_sval *var, struct data_range_sval *val, int left);
 133 struct data_range *alloc_range(long long min, long long max);
 134 struct data_range_sval *alloc_range_sval(sval_t min, sval_t max);
 135 struct data_range_sval *drange_to_drange_sval(struct data_range *drange);
 136 struct data_range *drange_sval_to_drange(struct data_range_sval *drange);
 137 void tack_on(struct range_list **list, struct data_range *drange);
 138 void tack_on_sval(struct range_list_sval **list, struct data_range_sval *drange);
 139
 140 struct smatch_state *alloc_estate_range(long long min, long long max);
 141 struct smatch_state *alloc_estate_range_sval(sval_t min, sval_t max);
 142
 143 void push_range_list(struct range_list_stack **rl_stack, struct range_list *rl);
 144 struct range_list *pop_range_list(struct range_list_stack **rl_stack);
 145 struct range_list *top_range_list(struct range_list_stack *rl_stack);
 146 void push_range_list_sval(struct range_list_stack_sval **rl_stack, struct range_list_sval *rl);
 147 struct range_list_sval *pop_range_list_sval(struct range_list_stack_sval **rl_stack);
 148 struct range_list_sval *top_range_list_sval(struct range_list_stack_sval *rl_stack);
 149
 150 void filter_top_range_list(struct range_list_stack **rl_stack, long long num);
 151 void filter_top_range_list_sval(struct range_list_stack_sval **rl_stack, sval_t sval);
 152 int get_implied_range_list(struct expression *expr, struct range_list **rl);
 153 int get_implied_range_list_sval(struct expression *expr, struct range_list_sval **rl);
 154 int is_whole_range(struct smatch_state *state);
 155
 156 struct range_list_sval *range_list_to_sval(struct range_list *list);
 157 struct range_list *rl_sval_to_rl(struct range_list_sval *list);
 158
 159 /* smatch_expressions.c */
 160 struct expression *zero_expr();
 161 struct expression *value_expr(long long val);
 162 struct expression *deref_expression(struct expression *deref, int op, struct ident *member);
 163 struct expression *assign_expression(struct expression *left, struct expression *right);
 164 struct expression *symbol_expression(struct symbol *sym);
 165
 166 /* implemented in smatch_constraints */
 167 void set_equiv(struct expression *left, struct expression *right);
 168 void set_related(struct smatch_state **estate, struct related_list *rlist);
 169 struct related_list *get_shared_relations(struct related_list *one,
 170                                               struct related_list *two);
 171 struct related_list *clone_related_list(struct related_list *related);
 172 void remove_from_equiv(const char *name, struct symbol *sym);
 173 void remove_from_equiv_expr(struct expression *expr);
 174 void set_equiv_state_expr(int id, struct expression *expr, struct smatch_state *state);
 175