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 };
  30 DECLARE_ALLOCATOR(data_info);
  31
  32 extern struct string_list *__ignored_macros;
  33
  34 extern struct smatch_state estate_undefined;
  35 void alloc_estate_undefined(void);
  36
  37 /* these are implemented in smatch_ranges.c */
  38 int is_whole_range_rl(struct range_list *rl);
  39 int rl_contiguous(struct range_list *rl);
  40 long long rl_min(struct range_list *rl);
  41 long long rl_max(struct range_list *rl);
  42 sval_t rl_min_sval(struct range_list *rl);
  43 sval_t rl_max_sval(struct range_list *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 *whole_range_list(void);
  49 void add_range(struct range_list **list, long long min, long long max);
  50 int ranges_equiv_sval(struct data_range_sval *one, struct data_range_sval *two);
  51 int range_lists_equiv(struct range_list *one, struct range_list *two);
  52 struct range_list *invert_range_list(struct range_list *orig);
  53 int true_comparison_range(struct data_range *left, int comparison, struct data_range *right);
  54 int true_comparison_range_sval(struct data_range_sval *left, int comparison, struct data_range_sval *right);
  55
  56 int possibly_true(struct expression *left, int comparison, struct expression *right);
  57 int possibly_true_range_lists(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  58 int possibly_true_range_lists_rl(int comparison, struct range_list *a, struct range_list *b, int left);
  59
  60 int possibly_false(struct expression *left, int comparison, struct expression *right);
  61 int possibly_false_range_lists(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  62 int possibly_false_range_lists_rl(int comparison, struct range_list *a, struct range_list *b, int left);
  63
  64 void free_range_list(struct range_list **rlist);
  65 void free_data_info_allocs(void);
  66 struct range_list *clone_range_list(struct range_list *list);
  67 struct range_list *clone_permanent(struct range_list *list);
  68 char *show_ranges(struct range_list *list);
  69 void get_value_ranges(char *value, struct range_list **rl);
  70
  71 struct range_list *remove_range(struct range_list *list, long long min, long long max);
  72
  73 /* used in smatch_slist.  implemented in smatch_extra.c */
  74 int implied_not_equal(struct expression *expr, long long val);
  75 struct sm_state *__extra_handle_canonical_loops(struct statement *loop, struct state_list **slist);
  76 int __iterator_unchanged(struct sm_state *sm);
  77 void __extra_pre_loop_hook_after(struct sm_state *sm,
  78                                 struct statement *iterator,
  79                                 struct expression *condition);
  80
  81 /* also implemented in smatch_extra */
  82 int estates_equiv(struct smatch_state *one, struct smatch_state *two);
  83 struct smatch_state *clone_estate(struct smatch_state *state);
  84 struct sm_state *set_extra_mod(const char *name, struct symbol *sym, struct smatch_state *state);
  85 struct sm_state *set_extra_expr_mod(struct expression *expr, struct smatch_state *state);
  86 void set_extra_expr_nomod(struct expression *expr, struct smatch_state *state);
  87 struct smatch_state *alloc_estate_empty(void);
  88 struct smatch_state *alloc_estate(long long val);
  89 struct smatch_state *alloc_estate_range_list(struct range_list *rl);
  90 struct data_info *get_dinfo(struct smatch_state *state);
  91 struct range_list *estate_ranges(struct smatch_state *state);
  92 struct related_list *estate_related(struct smatch_state *state);
  93 long long estate_min(struct smatch_state *state);
  94 long long estate_max(struct smatch_state *state);
  95 sval_t estate_min_sval(struct smatch_state *state);
  96 sval_t estate_max_sval(struct smatch_state *state);
  97 struct smatch_state *filter_range_list(struct smatch_state *orig,
  98                                  struct range_list *rl);
  99 struct smatch_state *add_filter(struct smatch_state *orig, long long filter);
 100 struct smatch_state *filter_range(struct smatch_state *orig,
 101                                  long long filter_min, long long filter_max);
 102 struct smatch_state *extra_undefined(void);
 103
 104 struct range_list *range_list_union(struct range_list *one, struct range_list *two);
 105 int estate_get_single_value(struct smatch_state *estate, long long *val);
 106 int estate_get_single_value_sval(struct smatch_state *state, sval_t *sval);
 107
 108 void function_comparison(int comparison, struct expression *expr, long long value, int left);
 109
 110 int true_comparison_range_lr(int comparison, struct data_range *var, struct data_range *val, int left);
 111 int false_comparison_range_lr(int comparison, struct data_range *var, struct data_range *val, int left);
 112 int true_comparison_range_lr_sval(int comparison, struct data_range_sval *var, struct data_range_sval *val, int left);
 113 int false_comparison_range_lr_sval(int comparison, struct data_range_sval *var, struct data_range_sval *val, int left);
 114 struct data_range *alloc_range(long long min, long long max);
 115 struct data_range_sval *alloc_range_sval(sval_t min, sval_t max);
 116 struct data_range_sval *drange_to_drange_sval(struct data_range *drange);
 117 struct data_range *drange_sval_to_drange(struct data_range_sval *drange);
 118 void tack_on(struct range_list **list, struct data_range *drange);
 119
 120 struct smatch_state *alloc_estate_range(long long min, long long max);
 121
 122 void push_range_list(struct range_list_stack **rl_stack, struct range_list *rl);
 123 struct range_list *pop_range_list(struct range_list_stack **rl_stack);
 124 struct range_list *top_range_list(struct range_list_stack *rl_stack);
 125 void filter_top_range_list(struct range_list_stack **rl_stack, long long num);
 126 int get_implied_range_list(struct expression *expr, struct range_list **rl);
 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