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
  16 DECLARE_PTR_LIST(range_list_sval, struct data_range_sval);
  17 DECLARE_PTR_LIST(range_list_stack_sval, struct range_list_sval);
  18
  19 struct relation {
  20         int op;
  21         char *name;
  22         struct symbol *sym;
  23 };
  24
  25 DECLARE_PTR_LIST(related_list, struct relation);
  26
  27 struct data_info {
  28         struct related_list *related;
  29         enum data_type type;
  30         struct range_list_sval *value_ranges;
  31 };
  32 DECLARE_ALLOCATOR(data_info);
  33
  34 extern struct string_list *__ignored_macros;
  35
  36 extern struct smatch_state estate_undefined;
  37 void alloc_estate_undefined(void);
  38
  39 /* these are implemented in smatch_ranges.c */
  40 int is_whole_range_rl_sval(struct range_list_sval *rl);
  41 sval_t rl_min_sval(struct range_list_sval *rl);
  42 sval_t rl_max_sval(struct range_list_sval *rl);
  43
  44 struct data_range *alloc_range_perm(long long min, long long max);
  45 struct data_range_sval *alloc_range_perm_sval(sval_t min, sval_t max);
  46 struct range_list_sval *alloc_range_list_sval(sval_t min, sval_t max);
  47 struct range_list_sval *whole_range_list_sval(void);
  48 void add_range_sval(struct range_list_sval **list, sval_t min, sval_t max);
  49 int ranges_equiv_sval(struct data_range_sval *one, struct data_range_sval *two);
  50 int range_lists_equiv_sval(struct range_list_sval *one, struct range_list_sval *two);
  51 int true_comparison_range_sval(struct data_range_sval *left, int comparison, struct data_range_sval *right);
  52
  53 int possibly_true(struct expression *left, int comparison, struct expression *right);
  54 int possibly_true_range_lists_sval(struct range_list_sval *left_ranges, int comparison, struct range_list_sval *right_ranges);
  55 int possibly_true_range_lists_rl_sval(int comparison, struct range_list_sval *a, struct range_list_sval *b, int left);
  56
  57 int possibly_false(struct expression *left, int comparison, struct expression *right);
  58 int possibly_false_range_lists_sval(struct range_list_sval *left_ranges, int comparison, struct range_list_sval *right_ranges);
  59 int possibly_false_range_lists_rl_sval(int comparison, struct range_list_sval *a, struct range_list_sval *b, int left);
  60
  61 void free_range_list_sval(struct range_list_sval **rlist);
  62 void free_data_info_allocs(void);
  63 struct range_list_sval *clone_range_list_sval(struct range_list_sval *list);
  64 struct range_list_sval *clone_permanent_sval(struct range_list_sval *list);
  65 char *show_ranges_sval(struct range_list_sval *list);
  66 void get_value_ranges_sval(char *value, struct range_list_sval **rl);
  67
  68 struct range_list_sval *remove_range_sval(struct range_list_sval *list, sval_t min, sval_t max);
  69
  70 /* used in smatch_slist.  implemented in smatch_extra.c */
  71 int implied_not_equal(struct expression *expr, long long val);
  72 struct sm_state *__extra_handle_canonical_loops(struct statement *loop, struct state_list **slist);
  73 int __iterator_unchanged(struct sm_state *sm);
  74 void __extra_pre_loop_hook_after(struct sm_state *sm,
  75                                 struct statement *iterator,
  76                                 struct expression *condition);
  77
  78 /* also implemented in smatch_extra */
  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(sval_t sval);
  86 struct smatch_state *alloc_estate_range_list_sval(struct range_list_sval *rl);
  87 struct data_info *get_dinfo(struct smatch_state *state);
  88 struct range_list_sval *estate_ranges_sval(struct smatch_state *state);
  89 struct related_list *estate_related(struct smatch_state *state);
  90 sval_t estate_min_sval(struct smatch_state *state);
  91 sval_t estate_max_sval(struct smatch_state *state);
  92 struct smatch_state *filter_range_list(struct smatch_state *orig,
  93                                  struct range_list_sval *rl);
  94 struct smatch_state *add_filter(struct smatch_state *orig, sval_t filter);
  95 struct smatch_state *filter_range(struct smatch_state *orig, sval_t filter_min, sval_t filter_max);
  96 struct smatch_state *extra_undefined(void);
  97
  98 struct range_list_sval *range_list_union_sval(struct range_list_sval *one, struct range_list_sval *two);
  99 int estate_get_single_value_sval(struct smatch_state *state, sval_t *sval);
 100
 101 void function_comparison(int comparison, struct expression *expr, sval_t sval, int left);
 102
 103 int true_comparison_range_lr_sval(int comparison, struct data_range_sval *var, struct data_range_sval *val, int left);
 104 int false_comparison_range_lr_sval(int comparison, struct data_range_sval *var, struct data_range_sval *val, int left);
 105 struct data_range *alloc_range(long long min, long long max);
 106 struct data_range_sval *alloc_range_sval(sval_t min, sval_t max);
 107 struct data_range_sval *drange_to_drange_sval(struct data_range *drange);
 108 struct data_range *drange_sval_to_drange(struct data_range_sval *drange);
 109 void tack_on_sval(struct range_list_sval **list, struct data_range_sval *drange);
 110
 111 struct smatch_state *alloc_estate_range_sval(sval_t min, sval_t max);
 112
 113 void push_range_list_sval(struct range_list_stack_sval **rl_stack, struct range_list_sval *rl);
 114 struct range_list_sval *pop_range_list_sval(struct range_list_stack_sval **rl_stack);
 115 struct range_list_sval *top_range_list_sval(struct range_list_stack_sval *rl_stack);
 116
 117 void filter_top_range_list_sval(struct range_list_stack_sval **rl_stack, sval_t sval);
 118 int get_implied_range_list_sval(struct expression *expr, struct range_list_sval **rl);
 119 int is_whole_range(struct smatch_state *state);
 120
 121 struct range_list_sval *range_list_to_sval(struct range_list *list);
 122 struct range_list *rl_sval_to_rl(struct range_list_sval *list);
 123
 124 /* smatch_expressions.c */
 125 struct expression *zero_expr();
 126 struct expression *value_expr(long long val);
 127 struct expression *deref_expression(struct expression *deref, int op, struct ident *member);
 128 struct expression *assign_expression(struct expression *left, struct expression *right);
 129 struct expression *symbol_expression(struct symbol *sym);
 130
 131 /* implemented in smatch_constraints */
 132 void set_equiv(struct expression *left, struct expression *right);
 133 void set_related(struct smatch_state **estate, struct related_list *rlist);
 134 struct related_list *get_shared_relations(struct related_list *one,
 135                                               struct related_list *two);
 136 struct related_list *clone_related_list(struct related_list *related);
 137 void remove_from_equiv(const char *name, struct symbol *sym);
 138 void remove_from_equiv_expr(struct expression *expr);
 139 void set_equiv_state_expr(int id, struct expression *expr, struct smatch_state *state);
 140