smatch.h

   1 /*
   2  * Copyright (C) 2006 Dan Carpenter.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, see http://www.gnu.org/copyleft/gpl.txt
  16  */
  17
  18 #ifndef         SMATCH_H_
  19 # define        SMATCH_H_
  20
  21 #include <stdio.h>
  22 #include <string.h>
  23 #include <limits.h>
  24 #include <sys/time.h>
  25 #include "lib.h"
  26 #include "allocate.h"
  27 #include "scope.h"
  28 #include "parse.h"
  29 #include "expression.h"
  30 #include "avl.h"
  31
  32 typedef struct {
  33         struct symbol *type;
  34         union {
  35                 long long value;
  36                 unsigned long long uvalue;
  37         };
  38 } sval_t;
  39
  40 struct smatch_state {
  41         const char *name;
  42         void *data;
  43 };
  44 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
  45 extern struct smatch_state undefined;
  46 extern struct smatch_state ghost;
  47 extern struct smatch_state merged;
  48 extern struct smatch_state true_state;
  49 extern struct smatch_state false_state;
  50 DECLARE_ALLOCATOR(smatch_state);
  51
  52 static inline void *INT_PTR(int i)
  53 {
  54         return (void *)(long)i;
  55 }
  56
  57 static inline int PTR_INT(void *p)
  58 {
  59         return (int)(long)p;
  60 }
  61
  62 struct tracker {
  63         char *name;
  64         struct symbol *sym;
  65         unsigned short owner;
  66 };
  67 DECLARE_ALLOCATOR(tracker);
  68 DECLARE_PTR_LIST(tracker_list, struct tracker);
  69 DECLARE_PTR_LIST(stree_stack, struct stree);
  70
  71 /* The first 3 struct members must match struct tracker */
  72 struct sm_state {
  73         const char *name;
  74         struct symbol *sym;
  75         unsigned short owner;
  76         unsigned short merged:1;
  77         unsigned short implied:1;
  78         unsigned int nr_children;
  79         unsigned int line;
  80         struct smatch_state *state;
  81         struct stree *pool;
  82         struct sm_state *left;
  83         struct sm_state *right;
  84         struct state_list *possible;
  85 };
  86
  87 struct var_sym {
  88         char *var;
  89         struct symbol *sym;
  90 };
  91 DECLARE_ALLOCATOR(var_sym);
  92 DECLARE_PTR_LIST(var_sym_list, struct var_sym);
  93
  94 enum hook_type {
  95         EXPR_HOOK,
  96         STMT_HOOK,
  97         STMT_HOOK_AFTER,
  98         SYM_HOOK,
  99         STRING_HOOK,
 100         DECLARATION_HOOK,
 101         ASSIGNMENT_HOOK,
 102         RAW_ASSIGNMENT_HOOK,
 103         GLOBAL_ASSIGNMENT_HOOK,
 104         LOGIC_HOOK,
 105         CONDITION_HOOK,
 106         PRELOOP_HOOK,
 107         SELECT_HOOK,
 108         WHOLE_CONDITION_HOOK,
 109         FUNCTION_CALL_HOOK,
 110         CALL_HOOK_AFTER_INLINE,
 111         FUNCTION_CALL_HOOK_AFTER,
 112         CALL_ASSIGNMENT_HOOK,
 113         MACRO_ASSIGNMENT_HOOK,
 114         BINOP_HOOK,
 115         OP_HOOK,
 116         DEREF_HOOK,
 117         CASE_HOOK,
 118         ASM_HOOK,
 119         CAST_HOOK,
 120         SIZEOF_HOOK,
 121         BASE_HOOK,
 122         FUNC_DEF_HOOK,
 123         AFTER_DEF_HOOK,
 124         END_FUNC_HOOK,
 125         AFTER_FUNC_HOOK,
 126         RETURN_HOOK,
 127         INLINE_FN_START,
 128         INLINE_FN_END,
 129         END_FILE_HOOK,
 130 };
 131
 132 #define TRUE 1
 133 #define FALSE 0
 134
 135 struct range_list;
 136
 137 void add_hook(void *func, enum hook_type type);
 138 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
 139 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
 140 void add_merge_hook(int client_id, merge_func_t *func);
 141 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
 142 void add_pre_merge_hook(int client_id, void (*hook)(struct sm_state *sm));
 143 typedef void (scope_hook)(void *data);
 144 void add_scope_hook(scope_hook *hook, void *data);
 145 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
 146 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
 147                                 struct expression *assign_expr, void *data);
 148 typedef void (return_implies_hook)(struct expression *call_expr,
 149                                    int param, char *key, char *value);
 150 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list **rl);
 151 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
 152
 153 void add_function_assign_hook(const char *look_for, func_hook *call_back,
 154                               void *info);
 155 void add_implied_return_hook(const char *look_for,
 156                              implied_return_hook *call_back,
 157                              void *info);
 158 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
 159                               void *info);
 160 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
 161                               void *info);
 162 void return_implies_state(const char *look_for, long long start, long long end,
 163                          implication_hook *call_back, void *info);
 164 void select_return_states_hook(int type, return_implies_hook *callback);
 165 void select_return_states_before(void (*fn)(void));
 166 void select_return_states_after(void (*fn)(void));
 167 int get_implied_return(struct expression *expr, struct range_list **rl);
 168 void allocate_hook_memory(void);
 169
 170 struct modification_data {
 171         struct smatch_state *prev;
 172         struct expression *cur;
 173 };
 174
 175 typedef void (modification_hook)(struct sm_state *sm, struct expression *mod_expr);
 176 void add_modification_hook(int owner, modification_hook *call_back);
 177 void add_indirect_modification_hook(int owner, modification_hook *call_back);
 178 struct smatch_state *get_modification_state(struct expression *expr);
 179
 180 int outside_of_function(void);
 181 const char *get_filename(void);
 182 const char *get_base_file(void);
 183 char *get_function(void);
 184 int get_lineno(void);
 185 extern int final_pass;
 186 extern struct symbol *cur_func_sym;
 187 extern int option_debug;
 188 extern int local_debug;
 189 extern int option_info;
 190 extern char *trace_variable;
 191 extern struct stree *global_states;
 192 int is_silenced_function(void);
 193
 194 extern FILE *sm_outfd;
 195 #define sm_printf(msg...) do { if (final_pass || option_debug) fprintf(sm_outfd, msg); } while (0)
 196
 197 static inline void sm_prefix(void)
 198 {
 199         sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
 200 }
 201
 202 static inline void print_implied_debug_msg();
 203
 204 #define sm_msg(msg...) \
 205 do {                                                           \
 206         print_implied_debug_msg();                             \
 207         if (!option_debug && !final_pass)                      \
 208                 break;                                         \
 209         if (!option_info && is_silenced_function())            \
 210                 break;                                         \
 211         sm_prefix();                                           \
 212         sm_printf(msg);                                        \
 213         sm_printf("\n");                                       \
 214 } while (0)
 215
 216 #define local_debug(msg...)                                     \
 217 do {                                                            \
 218         if (local_debug)                                        \
 219                 sm_msg(msg);                                    \
 220 } while (0)
 221
 222 extern char *implied_debug_msg;
 223 static inline void print_implied_debug_msg(void)
 224 {
 225         static struct symbol *last_printed = NULL;
 226
 227         if (!implied_debug_msg)
 228                 return;
 229         if (last_printed == cur_func_sym)
 230                 return;
 231         last_printed = cur_func_sym;
 232         sm_msg("%s", implied_debug_msg);
 233 }
 234
 235 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
 236
 237 #define sm_info(msg...) do {                                    \
 238         if (option_debug || (option_info && final_pass)) {      \
 239                 sm_prefix();                                    \
 240                 sm_printf("info: ");                            \
 241                 sm_printf(msg);                                 \
 242                 sm_printf("\n");                                \
 243         }                                                       \
 244 } while(0)
 245
 246 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
 247 struct smatch_state *get_state_expr(int owner, struct expression *expr);
 248 struct state_list *get_possible_states(int owner, const char *name,
 249                                        struct symbol *sym);
 250 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
 251 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
 252                struct smatch_state *state);
 253 struct sm_state *set_state_expr(int owner, struct expression *expr,
 254                 struct smatch_state *state);
 255 void delete_state(int owner, const char *name, struct symbol *sym);
 256 void delete_state_expr(int owner, struct expression *expr);
 257 void set_true_false_states(int owner, const char *name, struct symbol *sym,
 258                            struct smatch_state *true_state,
 259                            struct smatch_state *false_state);
 260 void set_true_false_states_expr(int owner, struct expression *expr,
 261                            struct smatch_state *true_state,
 262                            struct smatch_state *false_state);
 263
 264 struct stree *get_all_states_from_stree(int owner, struct stree *source);
 265 struct stree *get_all_states_stree(int id);
 266 struct stree *__get_cur_stree(void);
 267 int is_reachable(void);
 268
 269 /* smatch_helper.c */
 270 char *alloc_string(const char *str);
 271 void free_string(char *str);
 272 void append(char *dest, const char *data, int buff_len);
 273 void remove_parens(char *str);
 274 struct smatch_state *alloc_state_num(int num);
 275 struct smatch_state *alloc_state_str(const char *name);
 276 struct expression *get_argument_from_call_expr(struct expression_list *args,
 277                                                int num);
 278
 279 char *expr_to_var(struct expression *expr);
 280 struct symbol *expr_to_sym(struct expression *expr);
 281 char *expr_to_str(struct expression *expr);
 282 char *expr_to_str_sym(struct expression *expr,
 283                                      struct symbol **sym_ptr);
 284 char *expr_to_var_sym(struct expression *expr,
 285                              struct symbol **sym_ptr);
 286 char *expr_to_known_chunk_sym(struct expression *expr, struct symbol **sym);
 287 char *expr_to_chunk_sym_vsl(struct expression *expr, struct symbol **sym, struct var_sym_list **vsl);
 288 int get_complication_score(struct expression *expr);
 289
 290 int sym_name_is(const char *name, struct expression *expr);
 291 int get_const_value(struct expression *expr, sval_t *sval);
 292 int get_value(struct expression *expr, sval_t *val);
 293 int get_implied_value(struct expression *expr, sval_t *val);
 294 int get_implied_min(struct expression *expr, sval_t *sval);
 295 int get_implied_max(struct expression *expr, sval_t *val);
 296 int get_hard_max(struct expression *expr, sval_t *sval);
 297 int get_fuzzy_min(struct expression *expr, sval_t *min);
 298 int get_fuzzy_max(struct expression *expr, sval_t *max);
 299 int get_absolute_min(struct expression *expr, sval_t *sval);
 300 int get_absolute_max(struct expression *expr, sval_t *sval);
 301 int parse_call_math(struct expression *expr, char *math, sval_t *val);
 302 int parse_call_math_rl(struct expression *call, char *math, struct range_list **rl);
 303 char *get_value_in_terms_of_parameter_math(struct expression *expr);
 304 char *get_value_in_terms_of_parameter_math_var_sym(const char *var, struct symbol *sym);
 305 int is_zero(struct expression *expr);
 306 int known_condition_true(struct expression *expr);
 307 int known_condition_false(struct expression *expr);
 308 int implied_condition_true(struct expression *expr);
 309 int implied_condition_false(struct expression *expr);
 310 int can_integer_overflow(struct symbol *type, struct expression *expr);
 311
 312 int is_array(struct expression *expr);
 313 struct expression *get_array_base(struct expression *expr);
 314 struct expression *get_array_offset(struct expression *expr);
 315 const char *show_state(struct smatch_state *state);
 316 struct statement *get_expression_statement(struct expression *expr);
 317 struct expression *strip_parens(struct expression *expr);
 318 struct expression *strip_expr(struct expression *expr);
 319 void scoped_state(int my_id, const char *name, struct symbol *sym);
 320 int is_error_return(struct expression *expr);
 321 int getting_address(void);
 322 char *get_member_name(struct expression *expr);
 323 char *get_fnptr_name(struct expression *expr);
 324 int cmp_pos(struct position pos1, struct position pos2);
 325 int positions_eq(struct position pos1, struct position pos2);
 326 struct statement *get_current_statement(void);
 327 struct statement *get_prev_statement(void);
 328 int get_param_num_from_sym(struct symbol *sym);
 329 int get_param_num(struct expression *expr);
 330 int ms_since(struct timeval *start);
 331 int parent_is_gone_var_sym(const char *name, struct symbol *sym);
 332 int parent_is_gone(struct expression *expr);
 333 int invert_op(int op);
 334
 335 /* smatch_type.c */
 336 struct symbol *get_real_base_type(struct symbol *sym);
 337 int type_bits(struct symbol *type);
 338 int type_bytes(struct symbol *type);
 339 int type_positive_bits(struct symbol *type);
 340 struct symbol *get_pointer_type(struct expression *expr);
 341 struct symbol *get_type(struct expression *expr);
 342 int type_unsigned(struct symbol *base_type);
 343 int type_signed(struct symbol *base_type);
 344 int expr_unsigned(struct expression *expr);
 345 int expr_signed(struct expression *expr);
 346 int returns_unsigned(struct symbol *base_type);
 347 int is_pointer(struct expression *expr);
 348 int returns_pointer(struct symbol *base_type);
 349 sval_t sval_type_max(struct symbol *base_type);
 350 sval_t sval_type_min(struct symbol *base_type);
 351 int nr_bits(struct expression *expr);
 352 int is_void_pointer(struct expression *expr);
 353 int is_char_pointer(struct expression *expr);
 354 int is_string(struct expression *expr);
 355 int is_static(struct expression *expr);
 356 int is_local_variable(struct expression *expr);
 357 int types_equiv(struct symbol *one, struct symbol *two);
 358 int fn_static(void);
 359 const char *global_static();
 360 struct symbol *cur_func_return_type(void);
 361 struct symbol *get_arg_type(struct expression *fn, int arg);
 362 struct symbol *get_member_type_from_key(struct expression *expr, char *key);
 363 int is_struct(struct expression *expr);
 364 char *type_to_str(struct symbol *type);
 365
 366 /* smatch_ignore.c */
 367 void add_ignore(int owner, const char *name, struct symbol *sym);
 368 int is_ignored(int owner, const char *name, struct symbol *sym);
 369
 370 /* smatch_var_sym */
 371 struct var_sym *alloc_var_sym(const char *var, struct symbol *sym);
 372 struct var_sym_list *expr_to_vsl(struct expression *expr);
 373 void add_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
 374 void add_var_sym_expr(struct var_sym_list **list, struct expression *expr);
 375 void del_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
 376 int in_var_sym_list(struct var_sym_list *list, const char *var, struct symbol *sym);
 377 struct var_sym_list *clone_var_sym_list(struct var_sym_list *from_vsl);
 378 void merge_var_sym_list(struct var_sym_list **dest, struct var_sym_list *src);
 379 struct var_sym_list *combine_var_sym_lists(struct var_sym_list *one, struct var_sym_list *two);
 380 void free_var_sym_list(struct var_sym_list **list);
 381 void free_var_syms_and_list(struct var_sym_list **list);
 382
 383 /* smatch_tracker */
 384 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
 385 void add_tracker(struct tracker_list **list, int owner, const char *name,
 386                 struct symbol *sym);
 387 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
 388 void del_tracker(struct tracker_list **list, int owner, const char *name,
 389                 struct symbol *sym);
 390 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
 391                 struct symbol *sym);
 392 void free_tracker_list(struct tracker_list **list);
 393 void free_trackers_and_list(struct tracker_list **list);
 394
 395 /* smatch_conditions */
 396 int in_condition(void);
 397
 398 /* smatch_flow.c */
 399
 400 extern int __in_fake_assign;
 401 void smatch (int argc, char **argv);
 402 int inside_loop(void);
 403 int definitely_inside_loop(void);
 404 struct expression *get_switch_expr(void);
 405 int in_expression_statement(void);
 406 void __process_post_op_stack(void);
 407 void __split_expr(struct expression *expr);
 408 void __split_stmt(struct statement *stmt);
 409 extern int __in_function_def;
 410 extern int option_assume_loops;
 411 extern int option_known_conditions;
 412 extern int option_two_passes;
 413 extern int option_no_db;
 414 extern int option_file_output;
 415 extern int option_time;
 416 extern struct expression_list *big_expression_stack;
 417 extern struct statement_list *big_statement_stack;
 418 int is_assigned_call(struct expression *expr);
 419 int inlinable(struct expression *expr);
 420 extern int __inline_call;
 421 extern struct expression *__inline_fn;
 422 extern int __in_pre_condition;
 423 extern int __bail_on_rest_of_function;
 424 extern struct statement *__prev_stmt;
 425 extern struct statement *__cur_stmt;
 426 extern struct statement *__next_stmt;
 427
 428 /* smatch_struct_assignment.c */
 429 struct expression *get_faked_expression(void);
 430 void __fake_struct_member_assignments(struct expression *expr);
 431
 432 /* smatch_project.c */
 433 int is_no_inline_function(const char *function);
 434
 435 /* smatch_conditions */
 436 void __split_whole_condition(struct expression *expr);
 437 void __handle_logic(struct expression *expr);
 438 int is_condition(struct expression *expr);
 439 int __handle_condition_assigns(struct expression *expr);
 440 int __handle_select_assigns(struct expression *expr);
 441 int __handle_expr_statement_assigns(struct expression *expr);
 442
 443 /* smatch_implied.c */
 444 extern int option_debug_implied;
 445 extern int option_debug_related;
 446 extern int option_no_implied;
 447 struct range_list_stack;
 448 struct stree *__implied_case_stree(struct expression *switch_expr,
 449                                  struct expression *case_expr,
 450                                  struct range_list_stack **remaining_cases,
 451                                  struct stree **raw_stree);
 452 struct range_list *__get_implied_values(struct expression *switch_expr);
 453 void overwrite_states_using_pool(struct sm_state *sm);
 454 void add_pool(struct stree_stack **pools, struct stree *new);
 455
 456 /* smatch_extras.c */
 457 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
 458
 459 struct data_range {
 460         sval_t min;
 461         sval_t max;
 462 };
 463
 464 extern long long valid_ptr_min, valid_ptr_max;
 465 extern sval_t valid_ptr_min_sval, valid_ptr_max_sval;
 466 static const sval_t array_min_sval = {
 467         .type = &ptr_ctype,
 468         {.value = 100000},
 469 };
 470 static const sval_t array_max_sval = {
 471         .type = &ptr_ctype,
 472         {.value = 199999},
 473 };
 474 static const sval_t text_seg_min = {
 475         .type = &ptr_ctype,
 476         {.value = 100000000},
 477 };
 478 static const sval_t text_seg_max = {
 479         .type = &ptr_ctype,
 480         {.value = 177777777},
 481 };
 482 static const sval_t data_seg_min = {
 483         .type = &ptr_ctype,
 484         {.value = 200000000},
 485 };
 486 static const sval_t data_seg_max = {
 487         .type = &ptr_ctype,
 488         {.value = 277777777},
 489 };
 490 static const sval_t bss_seg_min = {
 491         .type = &ptr_ctype,
 492         {.value = 300000000},
 493 };
 494 static const sval_t bss_seg_max = {
 495         .type = &ptr_ctype,
 496         {.value = 377777777},
 497 };
 498 static const sval_t stack_seg_min = {
 499         .type = &ptr_ctype,
 500         {.value = 400000000},
 501 };
 502 static const sval_t stack_seg_max = {
 503         .type = &ptr_ctype,
 504         {.value = 477777777},
 505 };
 506 static const sval_t kmalloc_seg_min = {
 507         .type = &ptr_ctype,
 508         {.value = 500000000},
 509 };
 510 static const sval_t kmalloc_seg_max = {
 511         .type = &ptr_ctype,
 512         {.value = 577777777},
 513 };
 514 static const sval_t vmalloc_seg_min = {
 515         .type = &ptr_ctype,
 516         {.value = 600000000},
 517 };
 518 static const sval_t vmalloc_seg_max = {
 519         .type = &ptr_ctype,
 520         {.value = 677777777},
 521 };
 522
 523 #define STRLEN_MAX_RET 1010101
 524
 525 /* smatch_absolute.c */
 526 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
 527 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
 528
 529 /* smatch_local_values.c */
 530 int get_local_rl(struct expression *expr, struct range_list **rl);
 531 int get_local_max_helper(struct expression *expr, sval_t *sval);
 532 int get_local_min_helper(struct expression *expr, sval_t *sval);
 533
 534 /* smatch_type_value.c */
 535 int get_db_type_rl(struct expression *expr, struct range_list **rl);
 536
 537 /* smatch_states.c */
 538 void __swap_cur_stree(struct stree *stree);
 539 void __push_fake_cur_stree();
 540 struct stree *__pop_fake_cur_stree();
 541 void __free_fake_cur_stree();
 542 void __set_fake_cur_stree_fast(struct stree *stree);
 543 void __pop_fake_cur_stree_fast(void);
 544 void __merge_stree_into_cur(struct stree *stree);
 545
 546 int unreachable(void);
 547 void __set_sm(struct sm_state *sm);
 548 void __set_true_false_sm(struct sm_state *true_state,
 549                         struct sm_state *false_state);
 550 void nullify_path(void);
 551 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 552                                void *unused);
 553 void __unnullify_path(void);
 554 int __path_is_null(void);
 555 void save_all_states(void);
 556 void restore_all_states(void);
 557 void free_goto_stack(void);
 558 void clear_all_states(void);
 559
 560 struct sm_state *get_sm_state(int owner, const char *name,
 561                                 struct symbol *sym);
 562 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
 563 void __push_true_states(void);
 564 void __use_false_states(void);
 565 void __discard_false_states(void);
 566 void __merge_false_states(void);
 567 void __merge_true_states(void);
 568
 569 void __negate_cond_stacks(void);
 570 void __use_pre_cond_states(void);
 571 void __use_cond_true_states(void);
 572 void __use_cond_false_states(void);
 573 void __push_cond_stacks(void);
 574 struct stree *__copy_cond_true_states(void);
 575 struct stree *__copy_cond_false_states(void);
 576 struct stree *__pop_cond_true_stack(void);
 577 struct stree *__pop_cond_false_stack(void);
 578 void __and_cond_states(void);
 579 void __or_cond_states(void);
 580 void __save_pre_cond_states(void);
 581 void __discard_pre_cond_states(void);
 582 void __use_cond_states(void);
 583 extern struct state_list *__last_base_slist;
 584
 585 void __push_continues(void);
 586 void __discard_continues(void);
 587 void __process_continues(void);
 588 void __merge_continues(void);
 589
 590 void __push_breaks(void);
 591 void __process_breaks(void);
 592 int __has_breaks(void);
 593 void __merge_breaks(void);
 594 void __use_breaks(void);
 595
 596 void __save_switch_states(struct expression *switch_expr);
 597 void __discard_switches(void);
 598 void __merge_switches(struct expression *switch_expr, struct expression *case_expr);
 599 void __push_default(void);
 600 void __set_default(void);
 601 int __pop_default(void);
 602
 603 void __push_conditions(void);
 604 void __discard_conditions(void);
 605
 606 void __save_gotos(const char *name);
 607 void __merge_gotos(const char *name);
 608
 609 void __print_cur_stree(void);
 610
 611 /* smatch_hooks.c */
 612 void __pass_to_client(void *data, enum hook_type type);
 613 void __pass_to_client_no_data(enum hook_type type);
 614 void __pass_case_to_client(struct expression *switch_expr,
 615                            struct expression *case_expr);
 616 int __has_merge_function(int client_id);
 617 struct smatch_state *__client_merge_function(int owner,
 618                                              struct smatch_state *s1,
 619                                              struct smatch_state *s2);
 620 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 621 void call_pre_merge_hook(struct sm_state *sm);
 622 void __push_scope_hooks(void);
 623 void __call_scope_hooks(void);
 624
 625 /* smatch_function_hooks.c */
 626 void create_function_hook_hash(void);
 627 void __match_initializer_call(struct symbol *sym);
 628
 629 /* smatch_db.c */
 630 enum info_type {
 631         INTERNAL        = 0,
 632         /*
 633          * Changing these numbers is a pain.  Don't do it.  If you ever use a
 634          * number it can't be re-used right away so there may be gaps.
 635          * We select these in order by type so if the order matters, then give
 636          * it a number below 100-999,9000-9999 ranges. */
 637
 638         PARAM_CLEARED   = 101,
 639         PARAM_LIMIT     = 103,
 640         PARAM_FILTER    = 104,
 641
 642         PARAM_VALUE     = 1001,
 643         BUF_SIZE        = 1002,
 644         USER_DATA       = 1003,
 645         CAPPED_DATA     = 1004,
 646         RETURN_VALUE    = 1005,
 647         DEREFERENCE     = 1006,
 648         RANGE_CAP       = 1007,
 649         LOCK_HELD       = 1008,
 650         LOCK_RELEASED   = 1009,
 651         ABSOLUTE_LIMITS = 1010,
 652         PARAM_ADD       = 1012,
 653         PARAM_FREED     = 1013,
 654         DATA_SOURCE     = 1014,
 655         FUZZY_MAX       = 1015,
 656         STR_LEN         = 1016,
 657         ARRAY_LEN       = 1017,
 658         CAPABLE         = 1018,
 659         NS_CAPABLE      = 1019,
 660         TYPE_LINK       = 1022,
 661         UNTRACKED_PARAM = 1023,
 662         CULL_PATH       = 1024,
 663         PARAM_SET       = 1025,
 664         PARAM_USED      = 1026,
 665
 666         /* put random temporary stuff in the 7000-7999 range for testing */
 667         USER_DATA3      = 8017,
 668         USER_DATA_SET   = 9018,
 669         USER_DATA_LIMITED = 9019,
 670 };
 671
 672 void debug_sql(const char *sql);
 673 void debug_mem_sql(const char *sql);
 674 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
 675 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
 676 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr));
 677 void add_returned_member_callback(int owner, void (*callback)(int return_id, char *return_ranges, struct expression *expr, char *printed_name, struct smatch_state *state));
 678 void select_call_implies_hook(int type, void (*callback)(struct expression *arg, char *key, char *value));
 679 struct range_list *db_return_vals(struct expression *expr);
 680 char *return_state_to_var_sym(struct expression *expr, int param, char *key, struct symbol **sym);
 681 char *get_variable_from_key(struct expression *arg, char *key, struct symbol **sym);
 682 const char *get_param_name(struct sm_state *sm);
 683 char *get_data_info_name(struct expression *expr);
 684
 685 #define run_sql(call_back, data, sql...)    \
 686 do {                                  \
 687         char sql_txt[1024];           \
 688         if (option_no_db)             \
 689                 break;                \
 690         snprintf(sql_txt, 1024, sql); \
 691         debug_sql(sql_txt);           \
 692         sql_exec(call_back, data, sql_txt); \
 693 } while (0)
 694
 695 /* like run_sql() but for the in-memory database */
 696 #define mem_sql(call_back, data, sql...)                                                \
 697 do {                                                                            \
 698         char sql_txt[1024];                                                     \
 699                                                                                 \
 700         snprintf(sql_txt, sizeof(sql_txt), sql);                                \
 701         sm_debug("in-mem: %s\n", sql_txt);                                      \
 702         debug_mem_sql(sql_txt);                                                 \
 703         sql_mem_exec(call_back, data, sql_txt);                                 \
 704 } while (0)
 705
 706 char *get_static_filter(struct symbol *sym);
 707
 708 void sql_insert_return_states(int return_id, const char *return_ranges,
 709                 int type, int param, const char *key, const char *value);
 710 void sql_insert_caller_info(struct expression *call, int type, int param,
 711                 const char *key, const char *value);
 712 void sql_insert_function_ptr(const char *fn, const char *struct_name);
 713 void sql_insert_return_values(const char *return_values);
 714 void sql_insert_call_implies(int type, int param, const char *key, const char *value);
 715 void sql_insert_function_type_size(const char *member, const char *ranges);
 716 void sql_insert_local_values(const char *name, const char *value);
 717 void sql_insert_function_type_value(const char *type, const char *value);
 718 void sql_insert_function_type_info(int param, const char *value);
 719 void sql_insert_data_info(struct expression *data, int type, const char *value);
 720
 721 void sql_select_return_states(const char *cols, struct expression *call,
 722         int (*callback)(void*, int, char**, char**), void *info);
 723 void sql_select_caller_info(const char *cols, struct symbol *sym,
 724         int (*callback)(void*, int, char**, char**));
 725 void sql_select_call_implies(const char *cols, struct expression *call,
 726         int (*callback)(void*, int, char**, char**));
 727
 728 void sql_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql);
 729 void sql_mem_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql);
 730
 731 void open_smatch_db(void);
 732
 733 /* smatch_files.c */
 734 int open_data_file(const char *filename);
 735 struct token *get_tokens_file(const char *filename);
 736
 737 /* smatch.c */
 738 extern char *option_debug_check;
 739 extern char *option_project_str;
 740 extern char *data_dir;
 741 extern int option_no_data;
 742 extern int option_spammy;
 743 extern int option_full_path;
 744 extern int option_param_mapper;
 745 extern int option_call_tree;
 746 extern int num_checks;
 747
 748 enum project_type {
 749         PROJ_NONE,
 750         PROJ_KERNEL,
 751         PROJ_WINE,
 752 };
 753 extern enum project_type option_project;
 754 const char *check_name(unsigned short id);
 755
 756
 757 /* smatch_buf_size.c */
 758 int get_array_size(struct expression *expr);
 759 int get_array_size_bytes(struct expression *expr);
 760 int get_array_size_bytes_min(struct expression *expr);
 761 int get_array_size_bytes_max(struct expression *expr);
 762 struct range_list *get_array_size_bytes_rl(struct expression *expr);
 763 int get_real_array_size(struct expression *expr);
 764 /* smatch_strlen.c */
 765 int get_implied_strlen(struct expression *expr, struct range_list **rl);
 766 int get_size_from_strlen(struct expression *expr);
 767
 768 /* smatch_capped.c */
 769 int is_capped(struct expression *expr);
 770 int is_capped_var_sym(const char *name, struct symbol *sym);
 771
 772 /* check_user_data.c */
 773 int is_user_macro(struct expression *expr);
 774 int is_user_data(struct expression *expr);
 775 int is_capped_user_data(struct expression *expr);
 776 int implied_user_data(struct expression *expr, struct range_list **rl);
 777 int get_user_rl(struct expression *expr, struct range_list **rl);
 778
 779 /* check_locking.c */
 780 void print_held_locks();
 781
 782 /* check_assigned_expr.c */
 783 struct expression *get_assigned_expr(struct expression *expr);
 784 struct expression *get_assigned_expr_name_sym(const char *name, struct symbol *sym);
 785
 786 /* smatch_comparison.c */
 787 struct compare_data {
 788         const char *var1;
 789         struct var_sym_list *vsl1;
 790         int comparison;
 791         const char *var2;
 792         struct var_sym_list *vsl2;
 793 };
 794 int get_comparison(struct expression *left, struct expression *right);
 795 int get_comparison_strings(const char *one, const char *two);
 796 int possible_comparison(struct expression *a, int comparison, struct expression *b);
 797 struct state_list *get_all_comparisons(struct expression *expr);
 798 struct state_list *get_all_possible_equal_comparisons(struct expression *expr);
 799 void __add_comparison_info(struct expression *expr, struct expression *call, const char *range);
 800 char *expr_equal_to_param(struct expression *expr, int ignore);
 801 char *expr_lte_to_param(struct expression *expr, int ignore);
 802 char *expr_param_comparison(struct expression *expr, int ignore);
 803 int flip_comparison(int op);
 804 int negate_comparison(int op);
 805 void filter_by_comparison(struct range_list **rl, int comparison, struct range_list *right);
 806 struct sm_state *comparison_implication_hook(struct expression *expr,
 807                         struct stree_stack **true_stack,
 808                         struct stree_stack **false_stack);
 809
 810 /* smatch_sval.c */
 811 sval_t *sval_alloc(sval_t sval);
 812 sval_t *sval_alloc_permanent(sval_t sval);
 813 sval_t sval_blank(struct expression *expr);
 814 sval_t sval_type_val(struct symbol *type, long long val);
 815 sval_t sval_from_val(struct expression *expr, long long val);
 816 int sval_unsigned(sval_t sval);
 817 int sval_signed(sval_t sval);
 818 int sval_bits(sval_t sval);
 819 int sval_positive_bits(sval_t sval);
 820 int sval_bits_used(sval_t sval);
 821 int sval_is_negative(sval_t sval);
 822 int sval_is_positive(sval_t sval);
 823 int sval_is_min(sval_t sval);
 824 int sval_is_max(sval_t sval);
 825 int sval_is_a_min(sval_t sval);
 826 int sval_is_a_max(sval_t sval);
 827 int sval_is_negative_min(sval_t sval);
 828 int sval_cmp(sval_t one, sval_t two);
 829 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
 830 int sval_cmp_val(sval_t one, long long val);
 831 sval_t sval_min(sval_t one, sval_t two);
 832 sval_t sval_max(sval_t one, sval_t two);
 833 int sval_too_low(struct symbol *type, sval_t sval);
 834 int sval_too_high(struct symbol *type, sval_t sval);
 835 int sval_fits(struct symbol *type, sval_t sval);
 836 sval_t sval_cast(struct symbol *type, sval_t sval);
 837 sval_t sval_preop(sval_t sval, int op);
 838 sval_t sval_binop(sval_t left, int op, sval_t right);
 839 int sval_binop_overflows(sval_t left, int op, sval_t right);
 840 const char *sval_to_str(sval_t sval);
 841 const char *sval_to_numstr(sval_t sval);
 842 sval_t ll_to_sval(long long val);
 843
 844 /* smatch_string_list.c */
 845 int list_has_string(struct string_list *str_list, char *str);
 846 void insert_string(struct string_list **str_list, char *str);
 847 struct string_list *clone_str_list(struct string_list *orig);
 848 struct string_list *combine_string_lists(struct string_list *one, struct string_list *two);
 849
 850 /* smatch_start_states.c */
 851 struct stree *get_start_states(void);
 852
 853 /* smatch_recurse.c */
 854 int has_symbol(struct expression *expr, struct symbol *sym);
 855 int has_variable(struct expression *expr, struct expression *var);
 856 int has_inc_dec(struct expression *expr);
 857
 858 /* smatch_stored_conditions.c */
 859 struct smatch_state *get_stored_condition(struct expression *expr);
 860 struct sm_state *stored_condition_implication_hook(struct expression *expr,
 861                         struct stree_stack **true_stack,
 862                         struct stree_stack **false_stack);
 863
 864 /* check_string_len.c */
 865 int get_formatted_string_size(struct expression *call, int arg);
 866
 867 /* smatch_param_set.c */
 868 int param_was_set(struct expression *expr);
 869 /* smatch_param_filter.c */
 870 int param_has_filter_data(struct sm_state *sm);
 871
 872 /* smatch_links.c */
 873 void set_up_link_functions(int id, int linkid);
 874 struct smatch_state *merge_link_states(struct smatch_state *s1, struct smatch_state *s2);
 875 void store_link(int link_id, const char *name, struct symbol *sym, const char *link_name, struct symbol *link_sym);
 876
 877 /* smatch_auto_copy.c */
 878 void set_auto_copy(int owner);
 879
 880 /* check_buf_comparison */
 881 struct expression *get_size_variable(struct expression *buf);
 882
 883 /* smatch_untracked_param.c */
 884 void add_untracked_param_hook(void (func)(struct expression *call, int param));
 885
 886 /* smatch_impossible.c */
 887 int is_impossible_path(void);
 888
 889 /* smatch_strings.c */
 890 struct state_list *get_strings(struct expression *expr);
 891
 892 /* smatch_estate.c */
 893 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
 894
 895 /* smatch_address.c */
 896 int get_address_rl(struct expression *expr, struct range_list **rl);
 897
 898 /* for now this is in smatch_used_parameter.c */
 899 void __get_state_hook(int owner, const char *name, struct symbol *sym);
 900 #endif      /* !SMATCH_H_ */