smatch.h

   1 /*
   2  * sparse/smatch.h
   3  *
   4  * Copyright (C) 2006 Dan Carpenter.
   5  *
   6  *  Licensed under the Open Software License version 1.1
   7  *
   8  */
   9
  10 #ifndef         SMATCH_H_
  11 # define        SMATCH_H_
  12
  13 #include <stdio.h>
  14 #include <string.h>
  15 #include <limits.h>
  16 #include "lib.h"
  17 #include "allocate.h"
  18 #include "parse.h"
  19 #include "expression.h"
  20
  21 #define KERNEL
  22 #define MAXSMSTATES 1000000 /* Limits RAM use.  Give up on big functions */
  23 struct smatch_state {
  24         const char *name;
  25         void *data;
  26 };
  27 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
  28 extern struct smatch_state undefined;
  29 extern struct smatch_state merged;
  30 extern struct smatch_state true_state;
  31 extern struct smatch_state false_state;
  32 DECLARE_ALLOCATOR(smatch_state);
  33
  34 struct sm_state {
  35         const char *name;
  36         unsigned int owner;
  37         struct symbol *sym;
  38         struct smatch_state *state;
  39         int line;
  40         struct state_list_stack *my_pools;
  41         struct state_list_stack *all_pools;
  42         struct state_list *possible;
  43 };
  44
  45 enum hook_type {
  46         EXPR_HOOK,
  47         STMT_HOOK,
  48         SYM_HOOK,
  49         DECLARATION_HOOK,
  50         ASSIGNMENT_HOOK,
  51         CONDITION_HOOK,
  52         WHOLE_CONDITION_HOOK,
  53         FUNCTION_CALL_HOOK,
  54         CALL_ASSIGNMENT_HOOK,
  55         OP_HOOK,
  56         DEREF_HOOK,
  57         BASE_HOOK,
  58         FUNC_DEF_HOOK,
  59         END_FUNC_HOOK,
  60         RETURN_HOOK,
  61         END_FILE_HOOK,
  62 };
  63 void add_hook(void *func, enum hook_type type);
  64 typedef struct smatch_state *(merge_func_t)(const char *name,
  65                                             struct symbol *sym,
  66                                             struct smatch_state *s1,
  67                                             struct smatch_state *s2);
  68 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
  69 void add_merge_hook(int client_id, merge_func_t *func);
  70 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
  71 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
  72 void add_function_hook(const char *lock_for, func_hook *call_back, void *data);
  73
  74 void add_conditional_hook(const char *look_for, func_hook *call_back, void *data);
  75 void set_cond_states(const char *name, int owner, struct symbol *sym,
  76                      struct smatch_state *true_state,
  77                      struct smatch_state *false_state);
  78 void add_function_assign_hook(const char *look_for, func_hook *call_back,
  79                               void *info);
  80
  81 #define smatch_msg(msg...) \
  82 do {                                                          \
  83         printf("%s +%d %s(%d) ", get_filename(), get_lineno(), \
  84                get_function(), get_func_pos());               \
  85         printf(msg);                                          \
  86         printf("\n");                                         \
  87 } while (0)
  88
  89 #define SM_DEBUG(msg...) do { if (debug_states) printf(msg); } while (0)
  90 #define DIMPLIED(msg...) do { if (debug_implied_states) printf(msg); } while (0)
  91
  92 #define UNDEFINED INT_MIN
  93
  94 struct smatch_state *get_state(const char *name, int owner, struct symbol *sym);
  95 struct state_list *get_possible_states(const char *name, int owner,
  96                                        struct symbol *sym);
  97 void set_state(const char *name, int owner, struct symbol *sym,
  98                struct smatch_state *state);
  99 void delete_state(const char *name, int owner, struct symbol *sym);
 100 void set_true_false_states(const char *name, int owner, struct symbol *sym,
 101                            struct smatch_state *true_state,
 102                            struct smatch_state *false_state);
 103
 104 struct state_list *get_all_states(int id);
 105 int is_reachable();
 106 char *get_filename();
 107 char *get_function();
 108 int get_lineno();
 109 int get_func_pos();
 110
 111 /* smatch_helper.c */
 112 char *alloc_string(const char *str);
 113 void free_string(char *str);
 114 struct expression *get_argument_from_call_expr(struct expression_list *args,
 115                                                int num);
 116 char *get_variable_from_expr_complex(struct expression *expr,
 117                                      struct symbol **sym_ptr);
 118 char *get_variable_from_expr(struct expression *expr,
 119                              struct symbol **sym_ptr);
 120 struct symbol *get_ptr_type(struct expression *expr);
 121 int sym_name_is(const char *name, struct expression *expr);
 122 int get_value(struct expression *expr);
 123 int is_zero(struct expression *expr);
 124 const char *show_state(struct smatch_state *state);
 125 struct statement *get_block_thing(struct expression *expr);
 126 struct expression *strip_expr(struct expression *expr);
 127
 128 /* smatch_ignore.c */
 129 struct tracker {
 130         char *name;
 131         int owner;
 132         struct symbol *sym;
 133 };
 134 DECLARE_PTR_LIST(tracker_list, struct tracker);
 135
 136 void add_ignore(const char *name, int owner, struct symbol *sym);
 137 int is_ignored(const char *name, int owner, struct symbol *sym);
 138
 139 /* smatch_tracker */
 140 void add_tracker(struct tracker_list **list, const char *name, int owner,
 141                 struct symbol *sym);
 142 void del_tracker(struct tracker_list **list, const char *name, int owner,
 143                 struct symbol *sym);
 144 int in_tracker_list(struct tracker_list *list, const char *name, int owner,
 145                 struct symbol *sym);
 146 void free_tracker_list(struct tracker_list **list);
 147 void free_trackers_and_list(struct tracker_list **list);
 148
 149 /* smatch_conditions */
 150 int in_condition();
 151
 152 /* ----------------------------------------------------------------
 153    The stuff below is all used internally and shouldn't
 154    be called from other programs
 155  -----------------------------------------------------------------*/
 156
 157 /* smatch_flow.c */
 158
 159 void smatch (int argc, char **argv);
 160 void __split_expr(struct expression *expr);
 161 void __split_statements(struct statement *stmt);
 162 extern int option_assume_loops;
 163 extern int option_known_conditions;
 164
 165 /* smatch_conditions */
 166 void __split_whole_condition(struct expression *expr);
 167
 168 /* smatch_implied.c */
 169 extern int debug_implied_states;
 170 extern int option_no_implied;
 171 void get_implications(char *name, struct symbol *sym, int comparison, int num,
 172                       struct state_list **true_states,
 173                       struct state_list **false_states);
 174
 175 /* smatch_extras.c */
 176 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
 177 int true_comparison(int left, int comparison, int right);
 178 int known_condition_true(struct expression *expr);
 179 int known_condition_false(struct expression *expr);
 180
 181 /* smatch_states.c */
 182 extern int debug_states;
 183
 184 struct state_list *__get_cur_slist();
 185 void __set_true_false_sm(struct sm_state *true_state,
 186                         struct sm_state *false_state);
 187 void nullify_path();
 188 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 189                                void *unused);
 190 void __unnullify_path();
 191 int __path_is_null();
 192 void clear_all_states();
 193
 194 struct sm_state *get_sm_state(const char *name, int owner,
 195                                 struct symbol *sym);
 196 void __use_false_only_stack();
 197 void __pop_false_only_stack();
 198 void __push_true_states();
 199 void __use_false_states();
 200 void __pop_false_states();
 201 void __merge_false_states();
 202 void __merge_true_states();
 203
 204 void __negate_cond_stacks();
 205 void __save_false_states_for_later();
 206 void __use_previously_stored_false_states();
 207 void __use_cond_true_states();
 208 void __use_cond_false_states();
 209 void __push_cond_stacks();
 210 void __and_cond_states();
 211 void __or_cond_states();
 212 void __save_pre_cond_states();
 213 void __pop_pre_cond_states();
 214 void __use_cond_states();
 215
 216 void __warn_on_silly_pre_loops();
 217
 218 void __push_continues();
 219 void __pop_continues();
 220 void __process_continues();
 221 void __merge_continues();
 222
 223 void __push_breaks();
 224 void __process_breaks();
 225 void __merge_breaks();
 226 void __use_breaks();
 227
 228 void __save_switch_states();
 229 void __pop_switches();
 230 void __merge_switches();
 231 void __push_default();
 232 void __set_default();
 233 int __pop_default();
 234
 235 void __push_conditions();
 236 void __pop_conditions();
 237
 238 void __save_gotos(const char *name);
 239 void __merge_gotos(const char *name);
 240
 241 void __print_cur_slist();
 242
 243 /* smatch_hooks.c */
 244 void __pass_to_client(void *data, enum hook_type type);
 245 void __pass_to_client_no_data(enum hook_type type);
 246 int __has_merge_function(int client_id);
 247 struct smatch_state *__client_merge_function(int owner, const char *name,
 248                                              struct symbol *sym,
 249                                              struct smatch_state *s1,
 250                                              struct smatch_state *s2);
 251 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 252
 253 /* smatch_function_hooks.c */
 254 struct fcall_back {
 255         int type;
 256         func_hook *call_back;
 257         void *info;
 258 };
 259 DECLARE_ALLOCATOR(fcall_back);
 260 DECLARE_PTR_LIST(call_back_list, struct fcall_back);
 261 void create_function_hash(void);
 262 void __match_initializer_call(struct symbol *sym);
 263
 264 /* smatch_files.c */
 265 struct token *get_tokens_file(const char *filename);
 266
 267 /* smatch.c */
 268 extern char *bin_dir;
 269
 270 #endif      /* !SMATCH_H_ */