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 struct smatch_state {
  22         const char *name;
  23         void *data;
  24 };
  25 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
  26 extern struct smatch_state undefined;
  27 extern struct smatch_state merged;
  28 extern struct smatch_state true_state;
  29 extern struct smatch_state false_state;
  30 DECLARE_ALLOCATOR(smatch_state);
  31
  32 static inline void *INT_PTR(int i)
  33 {
  34         return (void *)(long)i;
  35 }
  36
  37 static inline int PTR_INT(void *p)
  38 {
  39         return (int)(long)p;
  40 }
  41
  42 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
  43
  44 struct sm_state {
  45         unsigned short owner;
  46         unsigned int merged:1;
  47         unsigned int implied:1;
  48         const char *name;
  49         struct symbol *sym;
  50         struct smatch_state *state;
  51         unsigned int line;
  52         struct state_list *my_pool;
  53         struct sm_state *left;
  54         struct sm_state *right;
  55         unsigned int nr_children;
  56         struct state_list *possible;
  57 };
  58
  59 struct tracker {
  60         int owner;
  61         char *name;
  62         struct symbol *sym;
  63 };
  64 DECLARE_ALLOCATOR(tracker);
  65 DECLARE_PTR_LIST(tracker_list, struct tracker);
  66
  67 enum hook_type {
  68         EXPR_HOOK,
  69         STMT_HOOK,
  70         SYM_HOOK,
  71         DECLARATION_HOOK,
  72         ASSIGNMENT_HOOK,
  73         CONDITION_HOOK,
  74         WHOLE_CONDITION_HOOK,
  75         FUNCTION_CALL_HOOK,
  76         CALL_ASSIGNMENT_HOOK,
  77         OP_HOOK,
  78         DEREF_HOOK,
  79         CASE_HOOK,
  80         BASE_HOOK,
  81         FUNC_DEF_HOOK,
  82         END_FUNC_HOOK,
  83         RETURN_HOOK,
  84         END_FILE_HOOK,
  85 };
  86 void add_hook(void *func, enum hook_type type);
  87 typedef struct smatch_state *(merge_func_t)(const char *name,
  88                                             struct symbol *sym,
  89                                             struct smatch_state *s1,
  90                                             struct smatch_state *s2);
  91 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
  92 void add_merge_hook(int client_id, merge_func_t *func);
  93 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
  94 typedef void (scope_hook)(void *data);
  95 void add_scope_hook(scope_hook *hook, void *data);
  96 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
  97 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
  98                                 struct expression *assign_expr, void *data);
  99 void add_function_hook(const char *lock_for, func_hook *call_back, void *data);
 100
 101 void add_conditional_hook(const char *look_for, func_hook *call_back, void *data);
 102 void add_function_assign_hook(const char *look_for, func_hook *call_back,
 103                               void *info);
 104 void return_implies_state(const char *look_for, long long start, long long end,
 105                          implication_hook *call_back, void *info);
 106 typedef void (modification_hook)(const char *name, struct symbol *sym,
 107                                 struct expression *expr, void *data);
 108 void add_modification_hook(const char *variable, modification_hook *hook,
 109                         void *data);
 110 int is_member(struct expression *expr);
 111 void reset_on_container_modified(int owner, struct expression *expr);
 112 void set_default_state(int owner, struct smatch_state *state);
 113
 114 extern int final_pass;
 115
 116 #define sm_printf(msg...) do { if (final_pass) printf(msg); } while (0) \
 117
 118 #define sm_msg(msg...) \
 119 do {                                                          \
 120         if (!final_pass)                                      \
 121                 break;                                        \
 122         printf("%s +%d %s(%d) ", get_filename(), get_lineno(), \
 123                get_function(), get_func_pos());               \
 124         printf(msg);                                          \
 125         printf("\n");                                         \
 126 } while (0)
 127
 128 #define sm_debug(msg...) do { if (debug_states) printf(msg); } while (0)
 129
 130 #define POINTER_MAX 0xffffffff
 131
 132 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
 133 struct smatch_state *get_state_expr(int owner, struct expression *expr);
 134 struct state_list *get_possible_states(int owner, const char *name,
 135                                        struct symbol *sym);
 136 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
 137 void set_state(int owner, const char *name, struct symbol *sym,
 138                struct smatch_state *state);
 139 void set_state_expr(int owner, struct expression *expr,
 140                 struct smatch_state *state);
 141 void delete_state(int owner, const char *name, struct symbol *sym);
 142 void delete_state_expr(int owner, struct expression *expr);
 143 void set_true_false_states(int owner, const char *name, struct symbol *sym,
 144                            struct smatch_state *true_state,
 145                            struct smatch_state *false_state);
 146 void set_true_false_states_expr(int owner, struct expression *expr,
 147                            struct smatch_state *true_state,
 148                            struct smatch_state *false_state);
 149
 150 struct state_list *get_all_states(int id);
 151 int is_reachable();
 152 char *get_filename();
 153 char *get_function();
 154 int get_lineno();
 155 int get_func_pos();
 156
 157 /* smatch_helper.c */
 158 char *alloc_string(const char *str);
 159 void free_string(char *str);
 160 struct expression *get_argument_from_call_expr(struct expression_list *args,
 161                                                int num);
 162 char *get_variable_from_expr_complex(struct expression *expr,
 163                                      struct symbol **sym_ptr);
 164 char *get_variable_from_expr(struct expression *expr,
 165                              struct symbol **sym_ptr);
 166 int sym_name_is(const char *name, struct expression *expr);
 167 int get_value(struct expression *expr, long long *val);
 168 int get_implied_value(struct expression *expr, long long *val);
 169 int is_zero(struct expression *expr);
 170 int is_array(struct expression *expr);
 171 struct expression *get_array_name(struct expression *expr);
 172 struct expression *get_array_offset(struct expression *expr);
 173 const char *show_state(struct smatch_state *state);
 174 struct statement *get_block_thing(struct expression *expr);
 175 struct expression *strip_expr(struct expression *expr);
 176 void scoped_state(int my_id, const char *name, struct symbol *sym);
 177 int is_error_return(struct expression *expr);
 178
 179 /* smatch_type.c */
 180 struct symbol *get_type(struct expression *expr);
 181
 182 /* smatch_ignore.c */
 183 void add_ignore(int owner, const char *name, struct symbol *sym);
 184 int is_ignored(int owner, const char *name, struct symbol *sym);
 185
 186 /* smatch_tracker */
 187 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
 188 void add_tracker(struct tracker_list **list, int owner, const char *name,
 189                 struct symbol *sym);
 190 void del_tracker(struct tracker_list **list, int owner, const char *name,
 191                 struct symbol *sym);
 192 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
 193                 struct symbol *sym);
 194 void free_tracker_list(struct tracker_list **list);
 195 void free_trackers_and_list(struct tracker_list **list);
 196
 197 /* smatch_conditions */
 198 int in_condition();
 199
 200 /* ----------------------------------------------------------------
 201    The stuff below is all used internally and shouldn't
 202    be called from other programs
 203  -----------------------------------------------------------------*/
 204
 205 /* smatch_flow.c */
 206
 207 void smatch (int argc, char **argv);
 208 void __split_expr(struct expression *expr);
 209 void __split_statements(struct statement *stmt);
 210 extern int option_assume_loops;
 211 extern int option_known_conditions;
 212 extern int option_two_passes;
 213 extern struct symbol *cur_func_sym;
 214
 215 /* smatch_conditions */
 216 void __split_whole_condition(struct expression *expr);
 217
 218 /* smatch_implied.c */
 219 extern int debug_implied_states;
 220 extern int option_no_implied;
 221 void get_implications(char *name, struct symbol *sym, int comparison, int num,
 222                       struct state_list **true_states,
 223                       struct state_list **false_states);
 224 struct range_list_stack;
 225 struct state_list *__implied_case_slist(struct expression *switch_expr,
 226                                         struct expression *case_expr,
 227                                         struct range_list_stack **remaining_cases,
 228                                         struct state_list **raw_slist);
 229 struct range_list *__get_implied_values(struct expression *switch_expr);
 230
 231 /* smatch_extras.c */
 232 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
 233
 234 struct data_range {
 235         long long min;
 236         long long max;
 237 };
 238 extern struct data_range whole_range;
 239
 240 int get_implied_single_val(struct expression *expr, long long *val);
 241 int get_implied_max(struct expression *expr, long long *val);
 242 int get_implied_min(struct expression *expr, long long *val);
 243 int true_comparison(int left, int comparison, int right);
 244 int known_condition_true(struct expression *expr);
 245 int known_condition_false(struct expression *expr);
 246 int implied_condition_true(struct expression *expr);
 247 int implied_condition_false(struct expression *expr);
 248
 249 /* smatch_states.c */
 250 extern int debug_states;
 251
 252 extern int __fake_cur;
 253 extern struct state_list *__fake_cur_slist;
 254 extern int __fake_conditions;
 255 extern struct state_list *__fake_cond_true;
 256 extern struct state_list *__fake_cond_false;
 257
 258
 259 void __set_state(struct sm_state *sm);
 260 struct state_list *__get_cur_slist();
 261 void __set_true_false_sm(struct sm_state *true_state,
 262                         struct sm_state *false_state);
 263 void nullify_path();
 264 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 265                                void *unused);
 266 void __unnullify_path();
 267 int __path_is_null();
 268 void clear_all_states();
 269
 270 struct sm_state *get_sm_state(int owner, const char *name,
 271                                 struct symbol *sym);
 272 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
 273 void __use_false_only_stack();
 274 void __pop_false_only_stack();
 275 void __push_true_states();
 276 void __use_false_states();
 277 void __pop_false_states();
 278 void __merge_false_states();
 279 void __merge_true_states();
 280
 281 void __negate_cond_stacks();
 282 void __save_false_states_for_later();
 283 void __use_previously_stored_false_states();
 284 void __use_cond_true_states();
 285 void __use_cond_false_states();
 286 void __push_cond_stacks();
 287 void __and_cond_states();
 288 void __or_cond_states();
 289 void __save_pre_cond_states();
 290 void __pop_pre_cond_states();
 291 void __use_cond_states();
 292
 293 void __warn_on_silly_pre_loops();
 294
 295 void __push_continues();
 296 void __pop_continues();
 297 void __process_continues();
 298 void __merge_continues();
 299
 300 void __push_breaks();
 301 void __process_breaks();
 302 void __merge_breaks();
 303 void __use_breaks();
 304
 305 void __save_switch_states(struct expression *switch_expr);
 306 void __pop_switches();
 307 void __merge_switches(struct expression *switch_expr, struct expression *case_expr);
 308 void __push_default();
 309 void __set_default();
 310 int __pop_default();
 311
 312 void __push_conditions();
 313 void __pop_conditions();
 314
 315 void __save_gotos(const char *name);
 316 void __merge_gotos(const char *name);
 317
 318 void __print_cur_slist();
 319
 320 /* smatch_hooks.c */
 321 void __pass_to_client(void *data, enum hook_type type);
 322 void __pass_to_client_no_data(enum hook_type type);
 323 void __pass_case_to_client(struct expression *switch_expr,
 324                            struct expression *case_expr);
 325 int __has_merge_function(int client_id);
 326 struct smatch_state *__client_merge_function(int owner, const char *name,
 327                                              struct symbol *sym,
 328                                              struct smatch_state *s1,
 329                                              struct smatch_state *s2);
 330 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 331 void __push_scope_hooks(void);
 332 void __call_scope_hooks(void);
 333
 334 /* smatch_function_hooks.c */
 335 void create_function_hash(void);
 336 void __match_initializer_call(struct symbol *sym);
 337
 338 /* smatch_files.c */
 339 struct token *get_tokens_file(const char *filename);
 340
 341 /* smatch_oom.c */
 342 extern int option_oom_kb;
 343 int out_of_memory();
 344
 345 /* smatch.c */
 346 extern char *option_project_str;
 347 extern char *data_dir;
 348 extern int option_no_data;
 349 extern int option_spammy;
 350 extern int option_full_path;
 351 extern struct smatch_state *default_state[];
 352
 353 enum project_type {
 354         PROJ_NONE,
 355         PROJ_KERNEL,
 356         PROJ_WINE,
 357 };
 358 extern enum project_type option_project;
 359 const char *check_name(unsigned short id);
 360
 361 #endif      /* !SMATCH_H_ */