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 typedef struct {
  22         struct symbol *type;
  23         union {
  24                 long long value;
  25                 unsigned long long uvalue;
  26         };
  27 } sval_t;
  28
  29 struct smatch_state {
  30         const char *name;
  31         void *data;
  32 };
  33 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
  34 extern struct smatch_state undefined;
  35 extern struct smatch_state merged;
  36 extern struct smatch_state true_state;
  37 extern struct smatch_state false_state;
  38 DECLARE_ALLOCATOR(smatch_state);
  39
  40 static inline void *INT_PTR(int i)
  41 {
  42         return (void *)(long)i;
  43 }
  44
  45 static inline int PTR_INT(void *p)
  46 {
  47         return (int)(long)p;
  48 }
  49
  50 struct sm_state {
  51         unsigned short owner;
  52         unsigned int merged:1;
  53         unsigned int implied:1;
  54         const char *name;
  55         struct symbol *sym;
  56         struct smatch_state *state;
  57         unsigned int line;
  58         struct state_list *pool;
  59         struct sm_state *left;
  60         struct sm_state *right;
  61         unsigned int nr_children;
  62         struct state_list *possible;
  63 };
  64
  65 struct tracker {
  66         int owner;
  67         char *name;
  68         struct symbol *sym;
  69 };
  70 DECLARE_ALLOCATOR(tracker);
  71 DECLARE_PTR_LIST(tracker_list, struct tracker);
  72
  73 enum hook_type {
  74         EXPR_HOOK,
  75         STMT_HOOK,
  76         SYM_HOOK,
  77         STRING_HOOK,
  78         DECLARATION_HOOK,
  79         ASSIGNMENT_HOOK,
  80         RAW_ASSIGNMENT_HOOK,
  81         GLOBAL_ASSIGNMENT_HOOK,
  82         LOGIC_HOOK,
  83         CONDITION_HOOK,
  84         PRELOOP_HOOK,
  85         SELECT_HOOK,
  86         WHOLE_CONDITION_HOOK,
  87         FUNCTION_CALL_HOOK,
  88         CALL_ASSIGNMENT_HOOK,
  89         MACRO_ASSIGNMENT_HOOK,
  90         BINOP_HOOK,
  91         OP_HOOK,
  92         DEREF_HOOK,
  93         CASE_HOOK,
  94         ASM_HOOK,
  95         CAST_HOOK,
  96         SIZEOF_HOOK,
  97         BASE_HOOK,
  98         FUNC_DEF_HOOK,
  99         AFTER_DEF_HOOK,
 100         END_FUNC_HOOK,
 101         RETURN_HOOK,
 102         END_FILE_HOOK,
 103 };
 104
 105 #define TRUE 1
 106 #define FALSE 0
 107
 108 struct range_list;
 109
 110 void add_hook(void *func, enum hook_type type);
 111 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
 112 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
 113 void add_merge_hook(int client_id, merge_func_t *func);
 114 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
 115 typedef void (scope_hook)(void *data);
 116 void add_scope_hook(scope_hook *hook, void *data);
 117 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
 118 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
 119                                 struct expression *assign_expr, void *data);
 120 typedef void (return_implies_hook)(struct expression *call_expr,
 121                                    int param, char *key, char *value);
 122 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list **rl);
 123 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
 124
 125 void add_function_assign_hook(const char *look_for, func_hook *call_back,
 126                               void *info);
 127 void add_implied_return_hook(const char *look_for,
 128                              implied_return_hook *call_back,
 129                              void *info);
 130 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
 131                               void *info);
 132 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
 133                               void *info);
 134 void return_implies_state(const char *look_for, long long start, long long end,
 135                          implication_hook *call_back, void *info);
 136 void add_db_return_states_callback(int type, return_implies_hook *callback);
 137 void add_db_return_states_before(void (*fn)(void));
 138 void add_db_return_states_after(void (*fn)(void));
 139 int get_implied_return(struct expression *expr, struct range_list **rl);
 140
 141 typedef void (modification_hook)(struct sm_state *sm);
 142 void add_modification_hook(int owner, modification_hook *call_back);
 143 void add_indirect_modification_hook(int owner, modification_hook *call_back);
 144
 145 const char *get_filename(void);
 146 char *get_function(void);
 147 int get_lineno(void);
 148 extern int final_pass;
 149 extern struct symbol *cur_func_sym;
 150 extern int option_debug;
 151 extern int local_debug;
 152
 153 extern FILE *sm_outfd;
 154 #define sm_printf(msg...) do { if (final_pass) fprintf(sm_outfd, msg); } while (0)
 155
 156 static inline void sm_prefix(void)
 157 {
 158         sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
 159 }
 160
 161 static inline void print_implied_debug_msg();
 162
 163 #define sm_msg(msg...) \
 164 do {                                                           \
 165         print_implied_debug_msg();                             \
 166         if (!option_debug && !final_pass)                      \
 167                 break;                                         \
 168         sm_prefix();                                           \
 169         sm_printf(msg);                                        \
 170         sm_printf("\n");                                       \
 171 } while (0)
 172
 173 #define local_debug(msg...)                                     \
 174 do {                                                            \
 175         if (local_debug)                                        \
 176                 sm_msg(msg);                                    \
 177 } while (0)
 178
 179 extern char *implied_debug_msg;
 180 static inline void print_implied_debug_msg()
 181 {
 182         static struct symbol *last_printed = NULL;
 183
 184         if (!implied_debug_msg)
 185                 return;
 186         if (last_printed == cur_func_sym)
 187                 return;
 188         last_printed = cur_func_sym;
 189         sm_msg("%s", implied_debug_msg);
 190 }
 191
 192 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
 193
 194 #define sm_info(msg...) do {                                    \
 195         if (option_debug || (option_info && final_pass)) {      \
 196                 sm_prefix();                                    \
 197                 sm_printf("info: ");                            \
 198                 sm_printf(msg);                                 \
 199                 sm_printf("\n");                                \
 200         }                                                       \
 201 } while(0)
 202
 203 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
 204 struct smatch_state *get_state_expr(int owner, struct expression *expr);
 205 struct state_list *get_possible_states(int owner, const char *name,
 206                                        struct symbol *sym);
 207 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
 208 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
 209                struct smatch_state *state);
 210 struct sm_state *set_state_expr(int owner, struct expression *expr,
 211                 struct smatch_state *state);
 212 void delete_state(int owner, const char *name, struct symbol *sym);
 213 void delete_state_expr(int owner, struct expression *expr);
 214 void set_true_false_states(int owner, const char *name, struct symbol *sym,
 215                            struct smatch_state *true_state,
 216                            struct smatch_state *false_state);
 217 void set_true_false_states_expr(int owner, struct expression *expr,
 218                            struct smatch_state *true_state,
 219                            struct smatch_state *false_state);
 220
 221 struct state_list *get_all_states_slist(int owner, struct state_list *source);
 222 struct state_list *get_all_states(int id);
 223 int is_reachable(void);
 224
 225 /* smatch_helper.c */
 226 char *alloc_string(const char *str);
 227 void free_string(char *str);
 228 struct smatch_state *alloc_state_num(int num);
 229 struct expression *get_argument_from_call_expr(struct expression_list *args,
 230                                                int num);
 231
 232 char *expr_to_var(struct expression *expr);
 233 char *expr_to_str(struct expression *expr);
 234 char *expr_to_str_sym(struct expression *expr,
 235                                      struct symbol **sym_ptr);
 236 char *expr_to_var_sym(struct expression *expr,
 237                              struct symbol **sym_ptr);
 238
 239 int sym_name_is(const char *name, struct expression *expr);
 240 int get_value(struct expression *expr, sval_t *val);
 241 int get_implied_value(struct expression *expr, sval_t *val);
 242 int get_implied_min(struct expression *expr, sval_t *sval);
 243 int get_implied_max(struct expression *expr, sval_t *val);
 244 int get_hard_max(struct expression *expr, sval_t *sval);
 245 int get_fuzzy_min(struct expression *expr, sval_t *min);
 246 int get_fuzzy_max(struct expression *expr, sval_t *max);
 247 int get_absolute_min(struct expression *expr, sval_t *sval);
 248 int get_absolute_max(struct expression *expr, sval_t *sval);
 249 int parse_call_math(struct expression *expr, char *math, sval_t *val);
 250 int is_zero(struct expression *expr);
 251 int known_condition_true(struct expression *expr);
 252 int known_condition_false(struct expression *expr);
 253 int implied_condition_true(struct expression *expr);
 254 int implied_condition_false(struct expression *expr);
 255
 256 int is_array(struct expression *expr);
 257 struct expression *get_array_name(struct expression *expr);
 258 struct expression *get_array_offset(struct expression *expr);
 259 const char *show_state(struct smatch_state *state);
 260 struct statement *get_expression_statement(struct expression *expr);
 261 struct expression *strip_parens(struct expression *expr);
 262 struct expression *strip_expr(struct expression *expr);
 263 void scoped_state(int my_id, const char *name, struct symbol *sym);
 264 int is_error_return(struct expression *expr);
 265 int getting_address(void);
 266 char *get_member_name(struct expression *expr);
 267 char *get_fnptr_name(struct expression *expr);
 268 int positions_eq(struct position pos1, struct position pos2);
 269 struct statement *get_current_statement(void);
 270 int get_param_num_from_sym(struct symbol *sym);
 271
 272 /* smatch_type.c */
 273 struct symbol *get_real_base_type(struct symbol *sym);
 274 int type_bits(struct symbol *type);
 275 int type_positive_bits(struct symbol *type);
 276 struct symbol *get_pointer_type(struct expression *expr);
 277 struct symbol *get_type(struct expression *expr);
 278 int type_unsigned(struct symbol *base_type);
 279 int type_signed(struct symbol *base_type);
 280 int expr_unsigned(struct expression *expr);
 281 int returns_unsigned(struct symbol *base_type);
 282 int is_pointer(struct expression *expr);
 283 int returns_pointer(struct symbol *base_type);
 284 sval_t sval_type_max(struct symbol *base_type);
 285 sval_t sval_type_min(struct symbol *base_type);
 286 int nr_bits(struct expression *expr);
 287 int is_static(struct expression *expr);
 288 int types_equiv(struct symbol *one, struct symbol *two);
 289 const char *global_static();
 290 struct symbol *cur_func_return_type(void);
 291 struct symbol *get_arg_type(struct expression *fn, int arg);
 292 struct symbol *get_member_type_from_key(struct expression *expr, char *key);
 293
 294 /* smatch_ignore.c */
 295 void add_ignore(int owner, const char *name, struct symbol *sym);
 296 int is_ignored(int owner, const char *name, struct symbol *sym);
 297
 298 /* smatch_tracker */
 299 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
 300 void add_tracker(struct tracker_list **list, int owner, const char *name,
 301                 struct symbol *sym);
 302 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
 303 void del_tracker(struct tracker_list **list, int owner, const char *name,
 304                 struct symbol *sym);
 305 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
 306                 struct symbol *sym);
 307 void free_tracker_list(struct tracker_list **list);
 308 void free_trackers_and_list(struct tracker_list **list);
 309
 310 /* smatch_conditions */
 311 int in_condition(void);
 312
 313 /* smatch_flow.c */
 314
 315 void smatch (int argc, char **argv);
 316 int inside_loop(void);
 317 struct expression *get_switch_expr(void);
 318 int in_expression_statement(void);
 319 void __split_expr(struct expression *expr);
 320 void __split_stmt(struct statement *stmt);
 321 extern int option_assume_loops;
 322 extern int option_known_conditions;
 323 extern int option_two_passes;
 324 extern int option_no_db;
 325 extern int option_file_output;
 326 extern struct expression_list *big_expression_stack;
 327 extern struct statement_list *big_statement_stack;
 328 extern int __in_pre_condition;
 329 extern int __bail_on_rest_of_function;
 330
 331 /* smatch_conditions */
 332 void __split_whole_condition(struct expression *expr);
 333 void __handle_logic(struct expression *expr);
 334 int is_condition(struct expression *expr);
 335 int __handle_condition_assigns(struct expression *expr);
 336 int __handle_select_assigns(struct expression *expr);
 337 int __handle_expr_statement_assigns(struct expression *expr);
 338
 339 /* smatch_implied.c */
 340 extern int option_debug_implied;
 341 extern int option_debug_related;
 342 extern int option_no_implied;
 343 void get_implications(char *name, struct symbol *sym, int comparison, long long num,
 344                       struct state_list **true_states,
 345                       struct state_list **false_states);
 346 struct range_list_stack;
 347 struct state_list *__implied_case_slist(struct expression *switch_expr,
 348                                         struct expression *case_expr,
 349                                         struct range_list_stack **remaining_cases,
 350                                         struct state_list **raw_slist);
 351 struct range_list *__get_implied_values(struct expression *switch_expr);
 352 void overwrite_states_using_pool(struct sm_state *sm);
 353
 354 /* smatch_extras.c */
 355 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
 356
 357 struct data_range {
 358         sval_t min;
 359         sval_t max;
 360 };
 361
 362 static const long long valid_ptr_max = LONG_MAX;
 363 static const long long valid_ptr_min = 4096;
 364 static const sval_t valid_ptr_max_sval = {
 365         .type = &ptr_ctype,
 366         .value = LONG_MAX,
 367 };
 368 static const sval_t valid_ptr_min_sval = {
 369         .type = &ptr_ctype,
 370         .value = 4096,
 371 };
 372
 373 /* smatch_absolute.c */
 374 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
 375 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
 376
 377 /* smatch_states.c */
 378 void __push_fake_cur_slist();
 379 struct state_list *__pop_fake_cur_slist();
 380 void __merge_slist_into_cur(struct state_list *slist);
 381
 382 int unreachable(void);
 383 void __set_sm(struct sm_state *sm);
 384 struct state_list *__get_cur_slist(void);
 385 void __set_true_false_sm(struct sm_state *true_state,
 386                         struct sm_state *false_state);
 387 void nullify_path(void);
 388 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 389                                void *unused);
 390 void __unnullify_path(void);
 391 int __path_is_null(void);
 392 void clear_all_states(void);
 393
 394 struct sm_state *get_sm_state(int owner, const char *name,
 395                                 struct symbol *sym);
 396 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
 397 void __push_true_states(void);
 398 void __use_false_states(void);
 399 void __discard_false_states(void);
 400 void __merge_false_states(void);
 401 void __merge_true_states(void);
 402
 403 void __negate_cond_stacks(void);
 404 void __use_pre_cond_states(void);
 405 void __use_cond_true_states(void);
 406 void __use_cond_false_states(void);
 407 void __push_cond_stacks(void);
 408 struct state_list *__copy_cond_true_states(void);
 409 struct state_list *__copy_cond_false_states(void);
 410 struct state_list *__pop_cond_true_stack(void);
 411 struct state_list *__pop_cond_false_stack(void);
 412 void __and_cond_states(void);
 413 void __or_cond_states(void);
 414 void __save_pre_cond_states(void);
 415 void __discard_pre_cond_states(void);
 416 void __use_cond_states(void);
 417 extern struct state_list *__last_base_slist;
 418
 419 void __warn_on_silly_pre_loops(void);
 420
 421 void __push_continues(void);
 422 void __discard_continues(void);
 423 void __process_continues(void);
 424 void __merge_continues(void);
 425
 426 void __push_breaks(void);
 427 void __process_breaks(void);
 428 int __has_breaks(void);
 429 void __merge_breaks(void);
 430 void __use_breaks(void);
 431
 432 void __save_switch_states(struct expression *switch_expr);
 433 void __discard_switches(void);
 434 void __merge_switches(struct expression *switch_expr, struct expression *case_expr);
 435 void __push_default(void);
 436 void __set_default(void);
 437 int __pop_default(void);
 438
 439 void __push_conditions(void);
 440 void __discard_conditions(void);
 441
 442 void __save_gotos(const char *name);
 443 void __merge_gotos(const char *name);
 444
 445 void __print_cur_slist(void);
 446
 447 /* smatch_hooks.c */
 448 void __pass_to_client(void *data, enum hook_type type);
 449 void __pass_to_client_no_data(enum hook_type type);
 450 void __pass_case_to_client(struct expression *switch_expr,
 451                            struct expression *case_expr);
 452 int __has_merge_function(int client_id);
 453 struct smatch_state *__client_merge_function(int owner,
 454                                              struct smatch_state *s1,
 455                                              struct smatch_state *s2);
 456 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 457 void __push_scope_hooks(void);
 458 void __call_scope_hooks(void);
 459
 460 /* smatch_function_hooks.c */
 461 void create_function_hook_hash(void);
 462 void __match_initializer_call(struct symbol *sym);
 463
 464 /* smatch_db.c */
 465 enum info_type {
 466         INTERNAL        = 0,
 467         PARAM_VALUE     = 1,
 468         BUF_SIZE        = 2,
 469         USER_DATA       = 3,
 470         CAPPED_DATA     = 4,
 471         RETURN_VALUE    = 5,
 472         DEREFERENCE     = 6,
 473         RANGE_CAP       = 7,
 474         LOCK_HELD       = 8,
 475         LOCK_RELEASED   = 9,
 476         ABSOLUTE_LIMITS = 10,
 477         LIMITED_VALUE   = 11,
 478         ADDED_VALUE     = 12,
 479         FILTER_VALUE    = 13,
 480 };
 481
 482 void add_definition_db_callback(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
 483 void add_member_info_callback(int owner, void (*callback)(char *fn, char *global_static, int param, char *printed_name, struct smatch_state *state));
 484 void add_returned_state_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr, struct state_list *slist));
 485 void add_returned_member_callback(int owner, void (*callback)(int return_id, char *return_ranges, char *printed_name, struct smatch_state *state));
 486 void add_db_fn_call_callback(int type, void (*callback)(struct expression *arg, char *value));
 487 struct range_list *db_return_vals(struct expression *expr);
 488
 489 #define run_sql(call_back, sql...)    \
 490 do {                                  \
 491         char sql_txt[1024];           \
 492         snprintf(sql_txt, 1024, sql); \
 493         sm_debug("%s\n", sql_txt);    \
 494         sql_exec(call_back, sql_txt); \
 495 } while (0)
 496
 497 void sql_exec(int (*callback)(void*, int, char**, char**), const char *sql);
 498 void open_smatch_db(void);
 499
 500 /* smatch_files.c */
 501 struct token *get_tokens_file(const char *filename);
 502
 503 /* smatch.c */
 504 extern char *option_project_str;
 505 extern char *data_dir;
 506 extern int option_no_data;
 507 extern int option_spammy;
 508 extern int option_full_path;
 509 extern int option_param_mapper;
 510 extern int option_info;
 511 extern int option_call_tree;
 512 extern int num_checks;
 513
 514 enum project_type {
 515         PROJ_NONE,
 516         PROJ_KERNEL,
 517         PROJ_WINE,
 518 };
 519 extern enum project_type option_project;
 520 const char *check_name(unsigned short id);
 521
 522
 523 /* smatch_buf_size.c */
 524 int get_array_size(struct expression *expr);
 525 int get_array_size_bytes(struct expression *expr);
 526 int get_array_size_bytes_min(struct expression *expr);
 527
 528 /* smatch_capped.c */
 529 int is_capped(struct expression *expr);
 530
 531 /* check_user_data.c */
 532 int is_user_data(struct expression *expr);
 533
 534 /* check_locking.c */
 535 void print_held_locks();
 536
 537 /* check_assigned_expr.c */
 538 struct expression *get_assigned_expr(struct expression *expr);
 539
 540 /* smatch_comparison.c */
 541 int get_comparison(struct expression *left, struct expression *right);
 542
 543 /* smatch_sval.c */
 544 sval_t *sval_alloc(sval_t sval);
 545 sval_t *sval_alloc_permanent(sval_t sval);
 546 sval_t sval_blank(struct expression *expr);
 547 sval_t sval_type_val(struct symbol *type, long long val);
 548 sval_t sval_from_val(struct expression *expr, long long val);
 549 int sval_unsigned(sval_t sval);
 550 int sval_signed(sval_t sval);
 551 int sval_bits(sval_t sval);
 552 int sval_positive_bits(sval_t sval);
 553 int sval_bits_used(sval_t sval);
 554 int sval_is_negative(sval_t sval);
 555 int sval_is_positive(sval_t sval);
 556 int sval_is_min(sval_t sval);
 557 int sval_is_max(sval_t sval);
 558 int sval_is_a_min(sval_t sval);
 559 int sval_is_a_max(sval_t sval);
 560 int sval_cmp(sval_t one, sval_t two);
 561 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
 562 int sval_cmp_val(sval_t one, long long val);
 563 sval_t sval_min(sval_t one, sval_t two);
 564 sval_t sval_max(sval_t one, sval_t two);
 565 int sval_too_low(struct symbol *type, sval_t sval);
 566 int sval_too_high(struct symbol *type, sval_t sval);
 567 int sval_fits(struct symbol *type, sval_t sval);
 568 sval_t sval_cast(struct symbol *type, sval_t sval);
 569 sval_t sval_preop(sval_t sval, int op);
 570 sval_t sval_binop(sval_t left, int op, sval_t right);
 571 int sval_binop_overflows(sval_t left, int op, sval_t right);
 572 const char *sval_to_str(sval_t sval);
 573 const char *sval_to_numstr(sval_t sval);
 574 sval_t ll_to_sval(long long val);
 575
 576 #endif      /* !SMATCH_H_ */