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 int is_whole_range_rl(struct range_list *rl);
  37 sval_t rl_min(struct range_list *rl);
  38 sval_t rl_max(struct range_list *rl);
  39
  40 struct data_range *alloc_range_perm(sval_t min, sval_t max);
  41 struct range_list *alloc_range_list(sval_t min, sval_t max);
  42 struct range_list *whole_range_list(struct symbol *type);
  43 void add_range(struct range_list **list, sval_t min, sval_t max);
  44 int ranges_equiv(struct data_range *one, struct data_range *two);
  45 int range_lists_equiv(struct range_list *one, struct range_list *two);
  46 int true_comparison_range(struct data_range *left, int comparison, struct data_range *right);
  47
  48 int possibly_true(struct expression *left, int comparison, struct expression *right);
  49 int possibly_true_range_lists(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  50 int possibly_true_range_lists_lr(int comparison, struct range_list *a, struct range_list *b, int left);
  51
  52 int possibly_false(struct expression *left, int comparison, struct expression *right);
  53 int possibly_false_range_lists(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  54 int possibly_false_range_lists_lr(int comparison, struct range_list *a, struct range_list *b, int left);
  55
  56 void free_range_list(struct range_list **rlist);
  57 void free_data_info_allocs(void);
  58 struct range_list *clone_range_list(struct range_list *list);
  59 struct range_list *clone_permanent(struct range_list *list);
  60 char *show_ranges(struct range_list *list);
  61 void parse_value_ranges_type(struct symbol *type, char *value, struct range_list **rl);
  62
  63 struct range_list *remove_range(struct range_list *list, sval_t min, sval_t max);
  64 struct range_list *rl_invert(struct range_list *orig);
  65 struct range_list *rl_filter(struct range_list *rl, struct range_list *filter);
  66 struct range_list *rl_intersection(struct range_list *one, struct range_list *two);
  67
  68 /* used in smatch_slist.  implemented in smatch_extra.c */
  69 void add_extra_mod_hook(void (*fn)(const char *name, struct symbol *sym, struct smatch_state *state));
  70 int implied_not_equal(struct expression *expr, long long val);
  71 struct sm_state *__extra_handle_canonical_loops(struct statement *loop, struct state_list **slist);
  72 int __iterator_unchanged(struct sm_state *sm);
  73 void __extra_pre_loop_hook_after(struct sm_state *sm,
  74                                 struct statement *iterator,
  75                                 struct expression *condition);
  76
  77 /* also implemented in smatch_extra */
  78 struct smatch_state *merge_estates(struct smatch_state *s1, struct smatch_state *s2);
  79 int estates_equiv(struct smatch_state *one, struct smatch_state *two);
  80 struct smatch_state *clone_estate(struct smatch_state *state);
  81 struct sm_state *set_extra_mod(const char *name, struct symbol *sym, struct smatch_state *state);
  82 struct sm_state *set_extra_expr_mod(struct expression *expr, struct smatch_state *state);
  83 void set_extra_expr_nomod(struct expression *expr, struct smatch_state *state);
  84 struct smatch_state *alloc_estate_empty(void);
  85 struct smatch_state *alloc_estate(sval_t sval);
  86 struct smatch_state *alloc_estate_range_list(struct range_list *rl);
  87 struct data_info *get_dinfo(struct smatch_state *state);
  88 struct range_list *estate_ranges(struct smatch_state *state);
  89 struct related_list *estate_related(struct smatch_state *state);
  90
  91 int estate_has_hard_max(struct smatch_state *state);
  92 void estate_set_hard_max(struct smatch_state *state);
  93 void estate_clear_hard_max(struct smatch_state *state);
  94 int estate_get_hard_max(struct smatch_state *state, sval_t *sval);
  95
  96 sval_t estate_min(struct smatch_state *state);
  97 sval_t estate_max(struct smatch_state *state);
  98 struct symbol *estate_type(struct smatch_state *state);
  99 struct smatch_state *add_filter(struct smatch_state *orig, sval_t filter);
 100 struct smatch_state *filter_range(struct smatch_state *orig, sval_t filter_min, sval_t filter_max);
 101 struct smatch_state *extra_undefined(struct symbol *type);
 102
 103 struct range_list *range_list_union(struct range_list *one, struct range_list *two);
 104 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
 105 struct smatch_state *get_implied_estate(struct expression *expr);
 106
 107 void function_comparison(int comparison, struct expression *expr, sval_t sval, int left);
 108
 109 int true_comparison_range_lr(int comparison, struct data_range *var, struct data_range *val, int left);
 110 int false_comparison_range_lr(int comparison, struct data_range *var, struct data_range *val, int left);
 111 struct data_range *alloc_range(sval_t min, sval_t max);
 112 void tack_on(struct range_list **list, struct data_range *drange);
 113
 114 struct smatch_state *alloc_estate_range(sval_t min, sval_t max);
 115
 116 void push_range_list(struct range_list_stack **rl_stack, struct range_list *rl);
 117 struct range_list *pop_range_list(struct range_list_stack **rl_stack);
 118 struct range_list *top_range_list(struct range_list_stack *rl_stack);
 119
 120 void filter_top_range_list(struct range_list_stack **rl_stack, sval_t sval);
 121 struct range_list *cast_rl(struct symbol *type, struct range_list *rl);
 122 int get_implied_range_list(struct expression *expr, struct range_list **rl);
 123 int is_whole_range(struct smatch_state *state);
 124
 125 /* smatch_expressions.c */
 126 struct expression *zero_expr();
 127 struct expression *value_expr(long long val);
 128 struct expression *deref_expression(struct expression *deref, int op, struct ident *member);
 129 struct expression *assign_expression(struct expression *left, struct expression *right);
 130 struct expression *symbol_expression(struct symbol *sym);
 131
 132 /* implemented in smatch_constraints */
 133 void set_equiv(struct expression *left, struct expression *right);
 134 void set_related(struct smatch_state *estate, struct related_list *rlist);
 135 struct related_list *get_shared_relations(struct related_list *one,
 136                                               struct related_list *two);
 137 struct related_list *clone_related_list(struct related_list *related);
 138 void remove_from_equiv(const char *name, struct symbol *sym);
 139 void remove_from_equiv_expr(struct expression *expr);
 140 void set_equiv_state_expr(int id, struct expression *expr, struct smatch_state *state);
 141