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