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