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