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         int op;
  19         char *name;
  20         struct symbol *sym;
  21 };
  22
  23 DECLARE_PTR_LIST(related_list, struct relation);
  24
  25 struct data_info {
  26         struct related_list *related;
  27         enum data_type type;
  28         struct range_list *value_ranges;
  29         unsigned int hard_max:1;
  30 };
  31 DECLARE_ALLOCATOR(data_info);
  32
  33 extern struct string_list *__ignored_macros;
  34
  35 /* these are implemented in smatch_ranges.c */
  36 char *show_ranges(struct range_list *list);
  37 void str_to_rl(struct symbol *type, char *value, struct range_list **rl);
  38
  39 struct data_range *alloc_range_perm(sval_t min, sval_t max);
  40 struct range_list *alloc_rl(sval_t min, sval_t max);
  41 struct range_list *clone_rl(struct range_list *list);
  42 struct range_list *clone_rl_permanent(struct range_list *list);
  43 struct range_list *alloc_whole_rl(struct symbol *type);
  44
  45 void add_range(struct range_list **list, sval_t min, sval_t max);
  46 void tack_on(struct range_list **list, struct data_range *drange);
  47 struct range_list *remove_range(struct range_list *list, sval_t min, sval_t max);
  48
  49 int true_comparison_range(struct data_range *left, int comparison, struct data_range *right);
  50 int true_comparison_range_LR(int comparison, struct data_range *var, struct data_range *val, int left);
  51 int false_comparison_range_LR(int comparison, struct data_range *var, struct data_range *val, int left);
  52 struct data_range *alloc_range(sval_t min, sval_t max);
  53
  54 int possibly_true(struct expression *left, int comparison, struct expression *right);
  55 int possibly_true_range_lists(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  56 int possibly_true_range_lists_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_range_lists(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  60 int possibly_false_range_lists_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 int range_lists_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
  69 struct range_list *rl_invert(struct range_list *orig);
  70 struct range_list *rl_filter(struct range_list *rl, struct range_list *filter);
  71 struct range_list *rl_intersection(struct range_list *one, struct range_list *two);
  72 struct range_list *rl_union(struct range_list *one, struct range_list *two);
  73
  74 void push_range_list(struct range_list_stack **rl_stack, struct range_list *rl);
  75 struct range_list *pop_range_list(struct range_list_stack **rl_stack);
  76 struct range_list *top_range_list(struct range_list_stack *rl_stack);
  77 void filter_top_range_list(struct range_list_stack **rl_stack, sval_t sval);
  78
  79 struct range_list *cast_rl(struct symbol *type, struct range_list *rl);
  80 int get_implied_range_list(struct expression *expr, struct range_list **rl);
  81
  82 void free_range_list(struct range_list **rlist);
  83 void free_data_info_allocs(void);
  84
  85 /* used in smatch_slist.  implemented in smatch_extra.c */
  86 void add_extra_mod_hook(void (*fn)(const char *name, struct symbol *sym, struct smatch_state *state));
  87 int implied_not_equal(struct expression *expr, long long val);
  88 struct sm_state *__extra_handle_canonical_loops(struct statement *loop, struct state_list **slist);
  89 int __iterator_unchanged(struct sm_state *sm);
  90 void __extra_pre_loop_hook_after(struct sm_state *sm,
  91                                 struct statement *iterator,
  92                                 struct expression *condition);
  93
  94 /* also implemented in smatch_extra */
  95 struct smatch_state *merge_estates(struct smatch_state *s1, struct smatch_state *s2);
  96 int estates_equiv(struct smatch_state *one, struct smatch_state *two);
  97 struct smatch_state *clone_estate(struct smatch_state *state);
  98 struct sm_state *set_extra_mod(const char *name, struct symbol *sym, struct smatch_state *state);
  99 struct sm_state *set_extra_expr_mod(struct expression *expr, struct smatch_state *state);
 100 void set_extra_expr_nomod(struct expression *expr, struct smatch_state *state);
 101 struct smatch_state *alloc_estate_empty(void);
 102 struct smatch_state *alloc_estate(sval_t sval);
 103 struct smatch_state *alloc_estate_range_list(struct range_list *rl);
 104 struct data_info *get_dinfo(struct smatch_state *state);
 105 struct range_list *estate_ranges(struct smatch_state *state);
 106 struct related_list *estate_related(struct smatch_state *state);
 107
 108 int estate_has_hard_max(struct smatch_state *state);
 109 void estate_set_hard_max(struct smatch_state *state);
 110 void estate_clear_hard_max(struct smatch_state *state);
 111 int estate_get_hard_max(struct smatch_state *state, sval_t *sval);
 112
 113 sval_t estate_min(struct smatch_state *state);
 114 sval_t estate_max(struct smatch_state *state);
 115 struct symbol *estate_type(struct smatch_state *state);
 116 struct smatch_state *add_filter(struct smatch_state *orig, sval_t filter);
 117 struct smatch_state *filter_range(struct smatch_state *orig, sval_t filter_min, sval_t filter_max);
 118 struct smatch_state *extra_undefined(struct symbol *type);
 119
 120 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
 121 struct smatch_state *get_implied_estate(struct expression *expr);
 122
 123 void function_comparison(int comparison, struct expression *expr, sval_t sval, int left);
 124
 125 struct smatch_state *alloc_estate_range(sval_t min, sval_t max);
 126
 127 int is_whole_range(struct smatch_state *state);
 128
 129 /* smatch_expressions.c */
 130 struct expression *zero_expr();
 131 struct expression *value_expr(long long val);
 132 struct expression *deref_expression(struct expression *deref, int op, struct ident *member);
 133 struct expression *assign_expression(struct expression *left, struct expression *right);
 134 struct expression *symbol_expression(struct symbol *sym);
 135
 136 /* implemented in smatch_constraints */
 137 void set_equiv(struct expression *left, struct expression *right);
 138 void set_related(struct smatch_state *estate, struct related_list *rlist);
 139 struct related_list *get_shared_relations(struct related_list *one,
 140                                               struct related_list *two);
 141 struct related_list *clone_related_list(struct related_list *related);
 142 void remove_from_equiv(const char *name, struct symbol *sym);
 143 void remove_from_equiv_expr(struct expression *expr);
 144 void set_equiv_state_expr(int id, struct expression *expr, struct smatch_state *state);
 145