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