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_sval, struct data_range_sval);
  15 DECLARE_PTR_LIST(range_list_stack_sval, struct range_list_sval);
  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_sval *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_sval(struct range_list_sval *rl);
  39 sval_t rl_min_sval(struct range_list_sval *rl);
  40 sval_t rl_max_sval(struct range_list_sval *rl);
  41
  42 struct data_range_sval *alloc_range_perm_sval(sval_t min, sval_t max);
  43 struct range_list_sval *alloc_range_list_sval(sval_t min, sval_t max);
  44 struct range_list_sval *whole_range_list_sval(struct symbol *type);
  45 void add_range_sval(struct range_list_sval **list, sval_t min, sval_t max);
  46 int ranges_equiv_sval(struct data_range_sval *one, struct data_range_sval *two);
  47 int range_lists_equiv_sval(struct range_list_sval *one, struct range_list_sval *two);
  48 int true_comparison_range_sval(struct data_range_sval *left, int comparison, struct data_range_sval *right);
  49
  50 int possibly_true(struct expression *left, int comparison, struct expression *right);
  51 int possibly_true_range_lists_sval(struct range_list_sval *left_ranges, int comparison, struct range_list_sval *right_ranges);
  52 int possibly_true_range_lists_rl_sval(int comparison, struct range_list_sval *a, struct range_list_sval *b, int left);
  53
  54 int possibly_false(struct expression *left, int comparison, struct expression *right);
  55 int possibly_false_range_lists_sval(struct range_list_sval *left_ranges, int comparison, struct range_list_sval *right_ranges);
  56 int possibly_false_range_lists_rl_sval(int comparison, struct range_list_sval *a, struct range_list_sval *b, int left);
  57
  58 void free_range_list_sval(struct range_list_sval **rlist);
  59 void free_data_info_allocs(void);
  60 struct range_list_sval *clone_range_list_sval(struct range_list_sval *list);
  61 struct range_list_sval *clone_permanent_sval(struct range_list_sval *list);
  62 char *show_ranges_sval(struct range_list_sval *list);
  63 void get_value_ranges_sval(char *value, struct range_list_sval **rl);
  64
  65 struct range_list_sval *remove_range_sval(struct range_list_sval *list, sval_t min, sval_t max);
  66
  67 /* used in smatch_slist.  implemented in smatch_extra.c */
  68 int implied_not_equal(struct expression *expr, long long val);
  69 struct sm_state *__extra_handle_canonical_loops(struct statement *loop, struct state_list **slist);
  70 int __iterator_unchanged(struct sm_state *sm);
  71 void __extra_pre_loop_hook_after(struct sm_state *sm,
  72                                 struct statement *iterator,
  73                                 struct expression *condition);
  74
  75 /* also implemented in smatch_extra */
  76 int estates_equiv(struct smatch_state *one, struct smatch_state *two);
  77 struct smatch_state *clone_estate(struct smatch_state *state);
  78 struct sm_state *set_extra_mod(const char *name, struct symbol *sym, struct smatch_state *state);
  79 struct sm_state *set_extra_expr_mod(struct expression *expr, struct smatch_state *state);
  80 void set_extra_expr_nomod(struct expression *expr, struct smatch_state *state);
  81 struct smatch_state *alloc_estate_empty(void);
  82 struct smatch_state *alloc_estate_sval(sval_t sval);
  83 struct smatch_state *alloc_estate_range_list_sval(struct range_list_sval *rl);
  84 struct data_info *get_dinfo(struct smatch_state *state);
  85 struct range_list_sval *estate_ranges_sval(struct smatch_state *state);
  86 struct related_list *estate_related(struct smatch_state *state);
  87 sval_t estate_min_sval(struct smatch_state *state);
  88 sval_t estate_max_sval(struct smatch_state *state);
  89 struct smatch_state *filter_range_list(struct smatch_state *orig,
  90                                  struct range_list_sval *rl);
  91 struct smatch_state *add_filter(struct smatch_state *orig, sval_t filter);
  92 struct smatch_state *filter_range(struct smatch_state *orig, sval_t filter_min, sval_t filter_max);
  93 struct smatch_state *extra_undefined(void);
  94
  95 struct range_list_sval *range_list_union_sval(struct range_list_sval *one, struct range_list_sval *two);
  96 int estate_get_single_value_sval(struct smatch_state *state, sval_t *sval);
  97
  98 void function_comparison(int comparison, struct expression *expr, sval_t sval, int left);
  99
 100 int true_comparison_range_lr_sval(int comparison, struct data_range_sval *var, struct data_range_sval *val, int left);
 101 int false_comparison_range_lr_sval(int comparison, struct data_range_sval *var, struct data_range_sval *val, int left);
 102 struct data_range_sval *alloc_range_sval(sval_t min, sval_t max);
 103 void tack_on_sval(struct range_list_sval **list, struct data_range_sval *drange);
 104
 105 struct smatch_state *alloc_estate_range_sval(sval_t min, sval_t max);
 106
 107 void push_range_list_sval(struct range_list_stack_sval **rl_stack, struct range_list_sval *rl);
 108 struct range_list_sval *pop_range_list_sval(struct range_list_stack_sval **rl_stack);
 109 struct range_list_sval *top_range_list_sval(struct range_list_stack_sval *rl_stack);
 110
 111 void filter_top_range_list_sval(struct range_list_stack_sval **rl_stack, sval_t sval);
 112 struct range_list_sval *cast_rl(struct range_list_sval *rl, struct symbol *type);
 113 int get_implied_range_list_sval(struct expression *expr, struct range_list_sval **rl);
 114 int is_whole_range(struct smatch_state *state);
 115
 116 /* smatch_expressions.c */
 117 struct expression *zero_expr();
 118 struct expression *value_expr(long long val);
 119 struct expression *deref_expression(struct expression *deref, int op, struct ident *member);
 120 struct expression *assign_expression(struct expression *left, struct expression *right);
 121 struct expression *symbol_expression(struct symbol *sym);
 122
 123 /* implemented in smatch_constraints */
 124 void set_equiv(struct expression *left, struct expression *right);
 125 void set_related(struct smatch_state **estate, struct related_list *rlist);
 126 struct related_list *get_shared_relations(struct related_list *one,
 127                                               struct related_list *two);
 128 struct related_list *clone_related_list(struct related_list *related);
 129 void remove_from_equiv(const char *name, struct symbol *sym);
 130 void remove_from_equiv_expr(struct expression *expr);
 131 void set_equiv_state_expr(int id, struct expression *expr, struct smatch_state *state);
 132