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 /* these are implimented in smatch_ranges.c */
  35 int is_whole_range_rl(struct range_list *rl);
  36 long long rl_min(struct range_list *rl);
  37 long long rl_max(struct range_list *rl);
  38 struct data_range *alloc_range_perm(long long min, long long max);
  39 struct range_list *alloc_range_list(long long min, long long max);
  40 struct range_list *whole_range_list(void);
  41 void add_range(struct range_list **list, long long min, long long max);
  42 int range_lists_equiv(struct range_list *one, struct range_list *two);
  43 struct range_list *invert_range_list(struct range_list *orig);
  44 int true_comparison_range(struct data_range *left, int comparison, struct data_range *right);
  45 int possibly_true(struct expression *left, int comparison, struct expression *right);
  46 int possibly_true_range_lists(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  47 int possibly_false(struct expression *left, int comparison, struct expression *right);
  48 int possibly_false_range_lists(struct range_list *left_ranges, int comparison, struct range_list *right_ranges);
  49 void free_range_list(struct range_list **rlist);
  50 void free_data_info_allocs(void);
  51 struct range_list *clone_range_list(struct range_list *list);
  52 struct range_list *clone_permanent(struct range_list *list);
  53 char *show_ranges(struct range_list *list);
  54 void get_value_ranges(char *value, struct range_list **rl);
  55
  56 struct range_list *remove_range(struct range_list *list, long long min, long long max);
  57
  58 /* used in smatch_slist.  implemented in smatch_extra.c */
  59 int implied_not_equal(struct expression *expr, long long val);
  60 struct sm_state *__extra_handle_canonical_loops(struct statement *loop, struct state_list **slist);
  61 int __iterator_unchanged(struct sm_state *sm);
  62 void __extra_pre_loop_hook_after(struct sm_state *sm,
  63                                 struct statement *iterator,
  64                                 struct expression *condition);
  65
  66 /* also implemented in smatch_extra */
  67 struct smatch_state *clone_estate(struct smatch_state *state);
  68 struct sm_state *set_extra_mod(const char *name, struct symbol *sym, struct smatch_state *state);
  69 struct sm_state *set_extra_expr_mod(struct expression *expr, struct smatch_state *state);
  70 void set_extra_expr_nomod(struct expression *expr, struct smatch_state *state);
  71 struct smatch_state *alloc_estate_empty(void);
  72 struct smatch_state *alloc_estate(long long val);
  73 struct smatch_state *alloc_estate_range_list(struct range_list *rl);
  74 struct data_info *get_dinfo(struct smatch_state *state);
  75 struct range_list *estate_ranges(struct smatch_state *state);
  76 struct related_list *estate_related(struct smatch_state *state);
  77 long long estate_min(struct smatch_state *state);
  78 long long estate_max(struct smatch_state *state);
  79 struct smatch_state *add_filter(struct smatch_state *orig, long long filter);
  80 struct smatch_state *extra_undefined(void);
  81
  82 struct range_list *range_list_union(struct range_list *one, struct range_list *two);
  83 int estate_get_single_value(struct smatch_state *estate, long long *val);
  84
  85 void function_comparison(int comparison, struct expression *expr, long long value, int left);
  86
  87 int true_comparison_range_lr(int comparison, struct data_range *var, struct data_range *val, int left);
  88 int false_comparison_range_lr(int comparison, struct data_range *var, struct data_range *val, int left);
  89 struct data_range *alloc_range(long long min, long long max);
  90 void tack_on(struct range_list **list, struct data_range *drange);
  91 int in_list_exact(struct range_list *list, struct data_range *drange);
  92
  93 struct smatch_state *alloc_estate_range(long long min, long long max);
  94
  95 void push_range_list(struct range_list_stack **rl_stack, struct range_list *rl);
  96 struct range_list *pop_range_list(struct range_list_stack **rl_stack);
  97 struct range_list *top_range_list(struct range_list_stack *rl_stack);
  98 void filter_top_range_list(struct range_list_stack **rl_stack, long long num);
  99 int get_implied_range_list(struct expression *expr, struct range_list **rl);
 100 int is_whole_range(struct smatch_state *state);
 101
 102 /* smatch_expressions.c */
 103 struct expression *zero_expr();
 104 struct expression *value_expr(long long val);
 105
 106 /* implemented in smatch_constraints */
 107 void set_equiv(struct expression *left, struct expression *right);
 108 struct relation *get_common_relationship(struct smatch_state *estate, int op,
 109                                         const char *name, struct symbol *sym);
 110 struct related_list *clone_related_list(struct related_list *related);
 111 void add_related(struct smatch_state *state, int op, const char *name, struct symbol *sym);
 112 void add_equiv(struct smatch_state *state, const char *name, struct symbol *sym);
 113 void remove_from_equiv(const char *name, struct symbol *sym);
 114 void remove_from_equiv_expr(struct expression *expr);
 115 void set_equiv_state_expr(int id, struct expression *expr, struct smatch_state *state);