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