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 int nr_children;
  78         unsigned int line;
  79         struct smatch_state *state;
  80         struct stree *pool;
  81         struct sm_state *left;
  82         struct sm_state *right;
  83         struct state_list *possible;
  84 };
  85
  86 struct var_sym {
  87         char *var;
  88         struct symbol *sym;
  89 };
  90 DECLARE_ALLOCATOR(var_sym);
  91 DECLARE_PTR_LIST(var_sym_list, struct var_sym);
  92
  93 enum hook_type {
  94         EXPR_HOOK,
  95         STMT_HOOK,
  96         STMT_HOOK_AFTER,
  97         SYM_HOOK,
  98         STRING_HOOK,
  99         DECLARATION_HOOK,
 100         ASSIGNMENT_HOOK,
 101         ASSIGNMENT_HOOK_AFTER,
 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_DB,
 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         NUM_HOOKS,
 131 };
 132
 133 #define TRUE 1
 134 #define FALSE 0
 135
 136 struct range_list;
 137
 138 void add_hook(void *func, enum hook_type type);
 139 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
 140 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
 141 void add_merge_hook(int client_id, merge_func_t *func);
 142 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
 143 void add_pre_merge_hook(int client_id, void (*hook)(struct sm_state *sm));
 144 typedef void (scope_hook)(void *data);
 145 void add_scope_hook(scope_hook *hook, void *data);
 146 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
 147 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
 148                                 struct expression *assign_expr, void *data);
 149 typedef void (return_implies_hook)(struct expression *call_expr,
 150                                    int param, char *key, char *value);
 151 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list **rl);
 152 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
 153
 154 void add_function_assign_hook(const char *look_for, func_hook *call_back,
 155                               void *info);
 156 void add_implied_return_hook(const char *look_for,
 157                              implied_return_hook *call_back,
 158                              void *info);
 159 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
 160                               void *info);
 161 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
 162                               void *info);
 163 void return_implies_state(const char *look_for, long long start, long long end,
 164                          implication_hook *call_back, void *info);
 165 void select_return_states_hook(int type, return_implies_hook *callback);
 166 void select_return_states_before(void (*fn)(void));
 167 void select_return_states_after(void (*fn)(void));
 168 int get_implied_return(struct expression *expr, struct range_list **rl);
 169 void allocate_hook_memory(void);
 170
 171 struct modification_data {
 172         struct smatch_state *prev;
 173         struct expression *cur;
 174 };
 175
 176 typedef void (modification_hook)(struct sm_state *sm, struct expression *mod_expr);
 177 void add_modification_hook(int owner, modification_hook *call_back);
 178 void add_indirect_modification_hook(int owner, modification_hook *call_back);
 179 void add_modification_hook_late(int owner, modification_hook *call_back);
 180 void add_indirect_modification_hook_late(int owner, modification_hook *call_back);
 181 struct smatch_state *get_modification_state(struct expression *expr);
 182
 183 int outside_of_function(void);
 184 const char *get_filename(void);
 185 const char *get_base_file(void);
 186 char *get_function(void);
 187 int get_lineno(void);
 188 extern int final_pass;
 189 extern struct symbol *cur_func_sym;
 190 extern int option_debug;
 191 extern int local_debug;
 192 extern int option_info;
 193 extern int option_spammy;
 194 extern char *trace_variable;
 195 extern struct stree *global_states;
 196 int is_silenced_function(void);
 197
 198 /* smatch_impossible.c */
 199 int is_impossible_path(void);
 200 void set_path_impossible(void);
 201
 202 extern FILE *sm_outfd;
 203 #define sm_printf(msg...) do { if (final_pass || option_debug || local_debug) fprintf(sm_outfd, msg); } while (0)
 204
 205 static inline void sm_prefix(void)
 206 {
 207         sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
 208 }
 209
 210 static inline void print_implied_debug_msg();
 211
 212 #define sm_msg(msg...) \
 213 do {                                                           \
 214         print_implied_debug_msg();                             \
 215         if (!option_debug && !final_pass && !local_debug)      \
 216                 break;                                         \
 217         if (!option_info && is_silenced_function())            \
 218                 break;                                         \
 219         sm_prefix();                                           \
 220         sm_printf(msg);                                        \
 221         sm_printf("\n");                                       \
 222 } while (0)
 223
 224 #define local_debug(msg...)                                     \
 225 do {                                                            \
 226         if (local_debug)                                        \
 227                 sm_msg(msg);                                    \
 228 } while (0)
 229
 230 extern char *implied_debug_msg;
 231 static inline void print_implied_debug_msg(void)
 232 {
 233         static struct symbol *last_printed = NULL;
 234
 235         if (!implied_debug_msg)
 236                 return;
 237         if (last_printed == cur_func_sym)
 238                 return;
 239         last_printed = cur_func_sym;
 240         sm_msg("%s", implied_debug_msg);
 241 }
 242
 243 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
 244
 245 #define sm_info(msg...) do {                                    \
 246         if (option_debug || (option_info && final_pass)) {      \
 247                 sm_prefix();                                    \
 248                 sm_printf("info: ");                            \
 249                 sm_printf(msg);                                 \
 250                 sm_printf("\n");                                \
 251         }                                                       \
 252 } while(0)
 253
 254 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
 255
 256 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
 257 struct smatch_state *get_state_expr(int owner, struct expression *expr);
 258 struct state_list *get_possible_states(int owner, const char *name,
 259                                        struct symbol *sym);
 260 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
 261 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
 262                struct smatch_state *state);
 263 struct sm_state *set_state_expr(int owner, struct expression *expr,
 264                 struct smatch_state *state);
 265 void delete_state(int owner, const char *name, struct symbol *sym);
 266 void delete_state_expr(int owner, struct expression *expr);
 267 void __delete_all_states_sym(struct symbol *sym);
 268 void set_true_false_states(int owner, const char *name, struct symbol *sym,
 269                            struct smatch_state *true_state,
 270                            struct smatch_state *false_state);
 271 void set_true_false_states_expr(int owner, struct expression *expr,
 272                            struct smatch_state *true_state,
 273                            struct smatch_state *false_state);
 274
 275 struct stree *get_all_states_from_stree(int owner, struct stree *source);
 276 struct stree *get_all_states_stree(int id);
 277 struct stree *__get_cur_stree(void);
 278 int is_reachable(void);
 279
 280 /* smatch_helper.c */
 281 DECLARE_PTR_LIST(int_stack, int);
 282 char *alloc_string(const char *str);
 283 void free_string(char *str);
 284 void append(char *dest, const char *data, int buff_len);
 285 void remove_parens(char *str);
 286 struct smatch_state *alloc_state_num(int num);
 287 struct smatch_state *alloc_state_str(const char *name);
 288 struct smatch_state *alloc_state_expr(struct expression *expr);
 289 struct expression *get_argument_from_call_expr(struct expression_list *args,
 290                                                int num);
 291
 292 char *expr_to_var(struct expression *expr);
 293 struct symbol *expr_to_sym(struct expression *expr);
 294 char *expr_to_str(struct expression *expr);
 295 char *expr_to_str_sym(struct expression *expr,
 296                                      struct symbol **sym_ptr);
 297 char *expr_to_var_sym(struct expression *expr,
 298                              struct symbol **sym_ptr);
 299 char *expr_to_known_chunk_sym(struct expression *expr, struct symbol **sym);
 300 char *expr_to_chunk_sym_vsl(struct expression *expr, struct symbol **sym, struct var_sym_list **vsl);
 301 int get_complication_score(struct expression *expr);
 302
 303 int sym_name_is(const char *name, struct expression *expr);
 304 int get_const_value(struct expression *expr, sval_t *sval);
 305 int get_value(struct expression *expr, sval_t *val);
 306 int get_implied_value(struct expression *expr, sval_t *val);
 307 int get_implied_min(struct expression *expr, sval_t *sval);
 308 int get_implied_max(struct expression *expr, sval_t *val);
 309 int get_hard_max(struct expression *expr, sval_t *sval);
 310 int get_fuzzy_min(struct expression *expr, sval_t *min);
 311 int get_fuzzy_max(struct expression *expr, sval_t *max);
 312 int get_absolute_min(struct expression *expr, sval_t *sval);
 313 int get_absolute_max(struct expression *expr, sval_t *sval);
 314 int parse_call_math(struct expression *expr, char *math, sval_t *val);
 315 int parse_call_math_rl(struct expression *call, char *math, struct range_list **rl);
 316 char *get_value_in_terms_of_parameter_math(struct expression *expr);
 317 char *get_value_in_terms_of_parameter_math_var_sym(const char *var, struct symbol *sym);
 318 int is_zero(struct expression *expr);
 319 int known_condition_true(struct expression *expr);
 320 int known_condition_false(struct expression *expr);
 321 int implied_condition_true(struct expression *expr);
 322 int implied_condition_false(struct expression *expr);
 323 int can_integer_overflow(struct symbol *type, struct expression *expr);
 324
 325 int is_array(struct expression *expr);
 326 struct expression *get_array_base(struct expression *expr);
 327 struct expression *get_array_offset(struct expression *expr);
 328 const char *show_state(struct smatch_state *state);
 329 struct statement *get_expression_statement(struct expression *expr);
 330 struct expression *strip_parens(struct expression *expr);
 331 struct expression *strip_expr(struct expression *expr);
 332 void scoped_state(int my_id, const char *name, struct symbol *sym);
 333 int is_error_return(struct expression *expr);
 334 int getting_address(void);
 335 char *get_member_name(struct expression *expr);
 336 char *get_fnptr_name(struct expression *expr);
 337 int cmp_pos(struct position pos1, struct position pos2);
 338 int positions_eq(struct position pos1, struct position pos2);
 339 struct statement *get_current_statement(void);
 340 struct statement *get_prev_statement(void);
 341 int get_param_num_from_sym(struct symbol *sym);
 342 int get_param_num(struct expression *expr);
 343 int ms_since(struct timeval *start);
 344 int parent_is_gone_var_sym(const char *name, struct symbol *sym);
 345 int parent_is_gone(struct expression *expr);
 346 int invert_op(int op);
 347 int expr_equiv(struct expression *one, struct expression *two);
 348 void push_int(struct int_stack **stack, int num);
 349 int pop_int(struct int_stack **stack);
 350
 351 /* smatch_type.c */
 352 struct symbol *get_real_base_type(struct symbol *sym);
 353 int type_bytes(struct symbol *type);
 354 struct symbol *get_pointer_type(struct expression *expr);
 355 struct symbol *get_type(struct expression *expr);
 356 int type_signed(struct symbol *base_type);
 357 int expr_unsigned(struct expression *expr);
 358 int expr_signed(struct expression *expr);
 359 int returns_unsigned(struct symbol *base_type);
 360 int is_pointer(struct expression *expr);
 361 int returns_pointer(struct symbol *base_type);
 362 sval_t sval_type_max(struct symbol *base_type);
 363 sval_t sval_type_min(struct symbol *base_type);
 364 int nr_bits(struct expression *expr);
 365 int is_void_pointer(struct expression *expr);
 366 int is_char_pointer(struct expression *expr);
 367 int is_string(struct expression *expr);
 368 int is_static(struct expression *expr);
 369 int is_local_variable(struct expression *expr);
 370 int types_equiv(struct symbol *one, struct symbol *two);
 371 int fn_static(void);
 372 const char *global_static();
 373 struct symbol *cur_func_return_type(void);
 374 struct symbol *get_arg_type(struct expression *fn, int arg);
 375 struct symbol *get_member_type_from_key(struct expression *expr, char *key);
 376 int is_struct(struct expression *expr);
 377 char *type_to_str(struct symbol *type);
 378
 379 /* smatch_ignore.c */
 380 void add_ignore(int owner, const char *name, struct symbol *sym);
 381 int is_ignored(int owner, const char *name, struct symbol *sym);
 382
 383 /* smatch_var_sym */
 384 struct var_sym *alloc_var_sym(const char *var, struct symbol *sym);
 385 struct var_sym_list *expr_to_vsl(struct expression *expr);
 386 void add_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
 387 void add_var_sym_expr(struct var_sym_list **list, struct expression *expr);
 388 void del_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
 389 int in_var_sym_list(struct var_sym_list *list, const char *var, struct symbol *sym);
 390 struct var_sym_list *clone_var_sym_list(struct var_sym_list *from_vsl);
 391 void merge_var_sym_list(struct var_sym_list **dest, struct var_sym_list *src);
 392 struct var_sym_list *combine_var_sym_lists(struct var_sym_list *one, struct var_sym_list *two);
 393 void free_var_sym_list(struct var_sym_list **list);
 394 void free_var_syms_and_list(struct var_sym_list **list);
 395
 396 /* smatch_tracker */
 397 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
 398 void add_tracker(struct tracker_list **list, int owner, const char *name,
 399                 struct symbol *sym);
 400 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
 401 void del_tracker(struct tracker_list **list, int owner, const char *name,
 402                 struct symbol *sym);
 403 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
 404                 struct symbol *sym);
 405 void free_tracker_list(struct tracker_list **list);
 406 void free_trackers_and_list(struct tracker_list **list);
 407
 408 /* smatch_conditions */
 409 int in_condition(void);
 410
 411 /* smatch_flow.c */
 412
 413 extern int __in_fake_assign;
 414 void smatch (int argc, char **argv);
 415 int inside_loop(void);
 416 int definitely_inside_loop(void);
 417 struct expression *get_switch_expr(void);
 418 int in_expression_statement(void);
 419 void __process_post_op_stack(void);
 420 void set_parent_expr(struct expression *expr, struct expression *parent);
 421 void __split_expr(struct expression *expr);
 422 void __split_label_stmt(struct statement *stmt);
 423 void __split_stmt(struct statement *stmt);
 424 extern int __in_function_def;
 425 extern int option_assume_loops;
 426 extern int option_two_passes;
 427 extern int option_no_db;
 428 extern int option_file_output;
 429 extern int option_time;
 430 extern struct expression_list *big_expression_stack;
 431 extern struct expression_list *big_condition_stack;
 432 extern struct statement_list *big_statement_stack;
 433 int is_assigned_call(struct expression *expr);
 434 int inlinable(struct expression *expr);
 435 extern int __inline_call;
 436 extern struct expression *__inline_fn;
 437 extern int __in_pre_condition;
 438 extern int __bail_on_rest_of_function;
 439 extern struct statement *__prev_stmt;
 440 extern struct statement *__cur_stmt;
 441 extern struct statement *__next_stmt;
 442
 443 /* smatch_struct_assignment.c */
 444 struct expression *get_faked_expression(void);
 445 void __fake_struct_member_assignments(struct expression *expr);
 446
 447 /* smatch_project.c */
 448 int is_no_inline_function(const char *function);
 449
 450 /* smatch_conditions */
 451 void __split_whole_condition(struct expression *expr);
 452 void __handle_logic(struct expression *expr);
 453 int is_condition(struct expression *expr);
 454 int __handle_condition_assigns(struct expression *expr);
 455 int __handle_select_assigns(struct expression *expr);
 456 int __handle_expr_statement_assigns(struct expression *expr);
 457
 458 /* smatch_implied.c */
 459 extern int option_debug_implied;
 460 extern int option_debug_related;
 461 struct range_list_stack;
 462 void param_limit_implications(struct expression *expr, int param, char *key, char *value);
 463 struct stree *__implied_case_stree(struct expression *switch_expr,
 464                                    struct range_list *case_rl,
 465                                    struct range_list_stack **remaining_cases,
 466                                    struct stree **raw_stree);
 467 void overwrite_states_using_pool(struct sm_state *gate_sm, struct sm_state *pool_sm);
 468 int assume(struct expression *expr);
 469 void end_assume(void);
 470
 471 /* smatch_extras.c */
 472 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
 473 extern int RETURN_ID;
 474
 475 struct data_range {
 476         sval_t min;
 477         sval_t max;
 478 };
 479
 480 extern long long valid_ptr_min, valid_ptr_max;
 481 extern sval_t valid_ptr_min_sval, valid_ptr_max_sval;
 482 static const sval_t array_min_sval = {
 483         .type = &ptr_ctype,
 484         {.value = 100000},
 485 };
 486 static const sval_t array_max_sval = {
 487         .type = &ptr_ctype,
 488         {.value = 199999},
 489 };
 490 static const sval_t text_seg_min = {
 491         .type = &ptr_ctype,
 492         {.value = 100000000},
 493 };
 494 static const sval_t text_seg_max = {
 495         .type = &ptr_ctype,
 496         {.value = 177777777},
 497 };
 498 static const sval_t data_seg_min = {
 499         .type = &ptr_ctype,
 500         {.value = 200000000},
 501 };
 502 static const sval_t data_seg_max = {
 503         .type = &ptr_ctype,
 504         {.value = 277777777},
 505 };
 506 static const sval_t bss_seg_min = {
 507         .type = &ptr_ctype,
 508         {.value = 300000000},
 509 };
 510 static const sval_t bss_seg_max = {
 511         .type = &ptr_ctype,
 512         {.value = 377777777},
 513 };
 514 static const sval_t stack_seg_min = {
 515         .type = &ptr_ctype,
 516         {.value = 400000000},
 517 };
 518 static const sval_t stack_seg_max = {
 519         .type = &ptr_ctype,
 520         {.value = 477777777},
 521 };
 522 static const sval_t kmalloc_seg_min = {
 523         .type = &ptr_ctype,
 524         {.value = 500000000},
 525 };
 526 static const sval_t kmalloc_seg_max = {
 527         .type = &ptr_ctype,
 528         {.value = 577777777},
 529 };
 530 static const sval_t vmalloc_seg_min = {
 531         .type = &ptr_ctype,
 532         {.value = 600000000},
 533 };
 534 static const sval_t vmalloc_seg_max = {
 535         .type = &ptr_ctype,
 536         {.value = 677777777},
 537 };
 538
 539 char *get_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
 540
 541 #define STRLEN_MAX_RET 1010101
 542
 543 /* smatch_absolute.c */
 544 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
 545 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
 546
 547 /* smatch_local_values.c */
 548 int get_local_rl(struct expression *expr, struct range_list **rl);
 549 int get_local_max_helper(struct expression *expr, sval_t *sval);
 550 int get_local_min_helper(struct expression *expr, sval_t *sval);
 551
 552 /* smatch_type_value.c */
 553 int get_db_type_rl(struct expression *expr, struct range_list **rl);
 554 /* smatch_data_val.c */
 555 int get_db_data_rl(struct expression *expr, struct range_list **rl);
 556
 557 /* smatch_states.c */
 558 void __swap_cur_stree(struct stree *stree);
 559 void __push_fake_cur_stree();
 560 struct stree *__pop_fake_cur_stree();
 561 void __free_fake_cur_stree();
 562 void __set_fake_cur_stree_fast(struct stree *stree);
 563 void __pop_fake_cur_stree_fast(void);
 564 void __merge_stree_into_cur(struct stree *stree);
 565
 566 int unreachable(void);
 567 void __set_sm(struct sm_state *sm);
 568 void __set_sm_cur_stree(struct sm_state *sm);
 569 void __set_sm_fake_stree(struct sm_state *sm);
 570 void __set_true_false_sm(struct sm_state *true_state,
 571                         struct sm_state *false_state);
 572 void nullify_path(void);
 573 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 574                                void *unused);
 575 void __unnullify_path(void);
 576 int __path_is_null(void);
 577 void save_all_states(void);
 578 void restore_all_states(void);
 579 void free_goto_stack(void);
 580 void clear_all_states(void);
 581
 582 struct sm_state *get_sm_state(int owner, const char *name,
 583                                 struct symbol *sym);
 584 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
 585 void __push_true_states(void);
 586 void __use_false_states(void);
 587 void __discard_false_states(void);
 588 void __merge_false_states(void);
 589 void __merge_true_states(void);
 590
 591 void __negate_cond_stacks(void);
 592 void __use_pre_cond_states(void);
 593 void __use_cond_true_states(void);
 594 void __use_cond_false_states(void);
 595 void __push_cond_stacks(void);
 596 void __fold_in_set_states(void);
 597 void __free_set_states(void);
 598 struct stree *__copy_cond_true_states(void);
 599 struct stree *__copy_cond_false_states(void);
 600 struct stree *__pop_cond_true_stack(void);
 601 struct stree *__pop_cond_false_stack(void);
 602 void __and_cond_states(void);
 603 void __or_cond_states(void);
 604 void __save_pre_cond_states(void);
 605 void __discard_pre_cond_states(void);
 606 struct stree *__get_true_states(void);
 607 struct stree *__get_false_states(void);
 608 void __use_cond_states(void);
 609 extern struct state_list *__last_base_slist;
 610
 611 void __push_continues(void);
 612 void __discard_continues(void);
 613 void __process_continues(void);
 614 void __merge_continues(void);
 615
 616 void __push_breaks(void);
 617 void __process_breaks(void);
 618 int __has_breaks(void);
 619 void __merge_breaks(void);
 620 void __use_breaks(void);
 621
 622 void __save_switch_states(struct expression *switch_expr);
 623 void __discard_switches(void);
 624 void __merge_switches(struct expression *switch_expr, struct range_list *case_rl);
 625 void __push_default(void);
 626 void __set_default(void);
 627 int __pop_default(void);
 628
 629 void __push_conditions(void);
 630 void __discard_conditions(void);
 631
 632 void __save_gotos(const char *name, struct symbol *sym);
 633 void __merge_gotos(const char *name, struct symbol *sym);
 634
 635 void __print_cur_stree(void);
 636
 637 /* smatch_hooks.c */
 638 void __pass_to_client(void *data, enum hook_type type);
 639 void __pass_to_client_no_data(enum hook_type type);
 640 void __pass_case_to_client(struct expression *switch_expr,
 641                            struct range_list *rl);
 642 int __has_merge_function(int client_id);
 643 struct smatch_state *__client_merge_function(int owner,
 644                                              struct smatch_state *s1,
 645                                              struct smatch_state *s2);
 646 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 647 void call_pre_merge_hook(struct sm_state *sm);
 648 void __push_scope_hooks(void);
 649 void __call_scope_hooks(void);
 650
 651 /* smatch_function_hooks.c */
 652 void create_function_hook_hash(void);
 653 void __match_initializer_call(struct symbol *sym);
 654
 655 /* smatch_db.c */
 656 enum info_type {
 657         INTERNAL        = 0,
 658         /*
 659          * Changing these numbers is a pain.  Don't do it.  If you ever use a
 660          * number it can't be re-used right away so there may be gaps.
 661          * We select these in order by type so if the order matters, then give
 662          * it a number below 100-999,9000-9999 ranges. */
 663
 664         PARAM_CLEARED   = 101,
 665         PARAM_LIMIT     = 103,
 666         PARAM_FILTER    = 104,
 667
 668         PARAM_VALUE     = 1001,
 669         BUF_SIZE        = 1002,
 670         USER_DATA       = 1003,
 671         CAPPED_DATA     = 1004,
 672         RETURN_VALUE    = 1005,
 673         DEREFERENCE     = 1006,
 674         RANGE_CAP       = 1007,
 675         LOCK_HELD       = 1008,
 676         LOCK_RELEASED   = 1009,
 677         ABSOLUTE_LIMITS = 1010,
 678         PARAM_ADD       = 1012,
 679         PARAM_FREED     = 1013,
 680         DATA_SOURCE     = 1014,
 681         FUZZY_MAX       = 1015,
 682         STR_LEN         = 1016,
 683         ARRAY_LEN       = 1017,
 684         CAPABLE         = 1018,
 685         NS_CAPABLE      = 1019,
 686         CONTAINER       = 1020,
 687         CASTED_CALL     = 1021,
 688         TYPE_LINK       = 1022,
 689         UNTRACKED_PARAM = 1023,
 690         CULL_PATH       = 1024,
 691         PARAM_SET       = 1025,
 692         PARAM_USED      = 1026,
 693         BYTE_UNITS      = 1027,
 694         COMPARE_LIMIT   = 1028,
 695         PARAM_COMPARE   = 1029,
 696
 697         /* put random temporary stuff in the 7000-7999 range for testing */
 698         USER_DATA3      = 8017,
 699         USER_DATA3_SET  = 9017,
 700         NO_OVERFLOW     = 8018,
 701         NO_OVERFLOW_SIMPLE = 8019,
 702         LOCKED          = 8020,
 703         UNLOCKED        = 8021,
 704         SET_FS          = 8022,
 705         ATOMIC_INC      = 8023,
 706         ATOMIC_DEC      = 8024,
 707         NO_SIDE_EFFECT  = 8025,
 708 };
 709
 710 void debug_sql(const char *sql);
 711 void debug_mem_sql(const char *sql);
 712 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
 713 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
 714 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr));
 715 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));
 716 void select_call_implies_hook(int type, void (*callback)(struct expression *arg, char *key, char *value));
 717 struct range_list *db_return_vals(struct expression *expr);
 718 struct range_list *db_return_vals_from_str(const char *fn_name);
 719 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym);
 720 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl);
 721 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym);
 722 const char *get_param_name_var_sym(const char *name, struct symbol *sym);
 723 const char *get_param_name(struct sm_state *sm);
 724 char *get_data_info_name(struct expression *expr);
 725
 726 #define run_sql(call_back, data, sql...)    \
 727 do {                                  \
 728         char sql_txt[1024];           \
 729         if (option_no_db)             \
 730                 break;                \
 731         snprintf(sql_txt, 1024, sql); \
 732         debug_sql(sql_txt);           \
 733         sql_exec(call_back, data, sql_txt); \
 734 } while (0)
 735
 736 /* like run_sql() but for the in-memory database */
 737 #define mem_sql(call_back, data, sql...)                                                \
 738 do {                                                                            \
 739         char sql_txt[1024];                                                     \
 740                                                                                 \
 741         snprintf(sql_txt, sizeof(sql_txt), sql);                                \
 742         sm_debug("in-mem: %s\n", sql_txt);                                      \
 743         debug_mem_sql(sql_txt);                                                 \
 744         sql_mem_exec(call_back, data, sql_txt);                                 \
 745 } while (0)
 746
 747 char *get_static_filter(struct symbol *sym);
 748
 749 void sql_insert_return_states(int return_id, const char *return_ranges,
 750                 int type, int param, const char *key, const char *value);
 751 void sql_insert_caller_info(struct expression *call, int type, int param,
 752                 const char *key, const char *value);
 753 void sql_insert_function_ptr(const char *fn, const char *struct_name);
 754 void sql_insert_return_values(const char *return_values);
 755 void sql_insert_call_implies(int type, int param, const char *key, const char *value);
 756 void sql_insert_function_type_size(const char *member, const char *ranges);
 757 void sql_insert_local_values(const char *name, const char *value);
 758 void sql_insert_function_type_value(const char *type, const char *value);
 759 void sql_insert_function_type(int param, const char *value);
 760 void sql_insert_data_info(struct expression *data, int type, const char *value);
 761
 762 void sql_select_return_states(const char *cols, struct expression *call,
 763         int (*callback)(void*, int, char**, char**), void *info);
 764 void sql_select_caller_info(const char *cols, struct symbol *sym,
 765         int (*callback)(void*, int, char**, char**));
 766 void sql_select_call_implies(const char *cols, struct expression *call,
 767         int (*callback)(void*, int, char**, char**));
 768
 769 void sql_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql);
 770 void sql_mem_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql);
 771
 772 void open_smatch_db(void);
 773
 774 /* smatch_files.c */
 775 int open_data_file(const char *filename);
 776 struct token *get_tokens_file(const char *filename);
 777
 778 /* smatch.c */
 779 extern char *option_debug_check;
 780 extern char *option_project_str;
 781 extern char *data_dir;
 782 extern int option_no_data;
 783 extern int option_full_path;
 784 extern int option_param_mapper;
 785 extern int option_call_tree;
 786 extern int num_checks;
 787
 788 enum project_type {
 789         PROJ_NONE,
 790         PROJ_KERNEL,
 791         PROJ_WINE,
 792 };
 793 extern enum project_type option_project;
 794 const char *check_name(unsigned short id);
 795 int id_from_name(const char *name);
 796
 797
 798 /* smatch_buf_size.c */
 799 int get_array_size(struct expression *expr);
 800 int get_array_size_bytes(struct expression *expr);
 801 int get_array_size_bytes_min(struct expression *expr);
 802 int get_array_size_bytes_max(struct expression *expr);
 803 struct range_list *get_array_size_bytes_rl(struct expression *expr);
 804 int get_real_array_size(struct expression *expr);
 805 /* smatch_strlen.c */
 806 int get_implied_strlen(struct expression *expr, struct range_list **rl);
 807 int get_size_from_strlen(struct expression *expr);
 808
 809 /* smatch_capped.c */
 810 int is_capped(struct expression *expr);
 811 int is_capped_var_sym(const char *name, struct symbol *sym);
 812
 813 /* check_user_data.c */
 814 int is_user_macro(struct expression *expr);
 815 int is_user_data(struct expression *expr);
 816 int is_capped_user_data(struct expression *expr);
 817 int implied_user_data(struct expression *expr, struct range_list **rl);
 818 int get_user_rl(struct expression *expr, struct range_list **rl);
 819 int get_user_rl_var_sym(const char *name, struct symbol *sym, struct range_list **rl);
 820
 821 /* check_locking.c */
 822 void print_held_locks();
 823
 824 /* check_assigned_expr.c */
 825 struct expression *get_assigned_expr(struct expression *expr);
 826 struct expression *get_assigned_expr_name_sym(const char *name, struct symbol *sym);
 827
 828 /* smatch_comparison.c */
 829 struct compare_data {
 830         const char *var1;
 831         struct var_sym_list *vsl1;
 832         int comparison;
 833         const char *var2;
 834         struct var_sym_list *vsl2;
 835 };
 836 DECLARE_ALLOCATOR(compare_data);
 837 struct smatch_state *alloc_compare_state(
 838                 const char *var1, struct var_sym_list *vsl1,
 839                 int comparison,
 840                 const char *var2, struct var_sym_list *vsl2);
 841 int merge_comparisons(int one, int two);
 842 int combine_comparisons(int left_compare, int right_compare);
 843 int state_to_comparison(struct smatch_state *state);
 844 struct smatch_state *merge_compare_states(struct smatch_state *s1, struct smatch_state *s2);
 845 int get_comparison(struct expression *left, struct expression *right);
 846 int get_comparison_strings(const char *one, const char *two);
 847 int possible_comparison(struct expression *a, int comparison, struct expression *b);
 848 struct state_list *get_all_comparisons(struct expression *expr);
 849 struct state_list *get_all_possible_equal_comparisons(struct expression *expr);
 850 void __add_comparison_info(struct expression *expr, struct expression *call, const char *range);
 851 char *get_printed_param_name(struct expression *call, const char *param_name, struct symbol *param_sym);
 852 char *name_sym_to_param_comparison(const char *name, struct symbol *sym);
 853 char *expr_equal_to_param(struct expression *expr, int ignore);
 854 char *expr_lte_to_param(struct expression *expr, int ignore);
 855 char *expr_param_comparison(struct expression *expr, int ignore);
 856 int flip_comparison(int op);
 857 int negate_comparison(int op);
 858 int param_compare_limit_is_impossible(struct expression *expr, int left_param, char *left_key, char *value);
 859 void filter_by_comparison(struct range_list **rl, int comparison, struct range_list *right);
 860 struct sm_state *comparison_implication_hook(struct expression *expr,
 861                         struct state_list **true_stack,
 862                         struct state_list **false_stack);
 863 void __compare_param_limit_hook(struct expression *left_expr, struct expression *right_expr,
 864                                 const char *state_name,
 865                                 struct smatch_state *true_state, struct smatch_state *false_state);
 866
 867
 868 /* smatch_sval.c */
 869 sval_t *sval_alloc(sval_t sval);
 870 sval_t *sval_alloc_permanent(sval_t sval);
 871 sval_t sval_blank(struct expression *expr);
 872 sval_t sval_type_val(struct symbol *type, long long val);
 873 sval_t sval_from_val(struct expression *expr, long long val);
 874 int sval_unsigned(sval_t sval);
 875 int sval_signed(sval_t sval);
 876 int sval_bits(sval_t sval);
 877 int sval_bits_used(sval_t sval);
 878 int sval_is_negative(sval_t sval);
 879 int sval_is_positive(sval_t sval);
 880 int sval_is_min(sval_t sval);
 881 int sval_is_max(sval_t sval);
 882 int sval_is_a_min(sval_t sval);
 883 int sval_is_a_max(sval_t sval);
 884 int sval_is_negative_min(sval_t sval);
 885 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
 886 int sval_cmp_val(sval_t one, long long val);
 887 sval_t sval_min(sval_t one, sval_t two);
 888 sval_t sval_max(sval_t one, sval_t two);
 889 int sval_too_low(struct symbol *type, sval_t sval);
 890 int sval_too_high(struct symbol *type, sval_t sval);
 891 int sval_fits(struct symbol *type, sval_t sval);
 892 sval_t sval_cast(struct symbol *type, sval_t sval);
 893 sval_t sval_preop(sval_t sval, int op);
 894 sval_t sval_binop(sval_t left, int op, sval_t right);
 895 int sval_binop_overflows(sval_t left, int op, sval_t right);
 896 unsigned long long fls_mask(unsigned long long uvalue);
 897 unsigned long long sval_fls_mask(sval_t sval);
 898 const char *sval_to_str(sval_t sval);
 899 const char *sval_to_numstr(sval_t sval);
 900 sval_t ll_to_sval(long long val);
 901
 902 /* smatch_string_list.c */
 903 int list_has_string(struct string_list *str_list, const char *str);
 904 void insert_string(struct string_list **str_list, const char *str);
 905 struct string_list *clone_str_list(struct string_list *orig);
 906 struct string_list *combine_string_lists(struct string_list *one, struct string_list *two);
 907
 908 /* smatch_start_states.c */
 909 struct stree *get_start_states(void);
 910
 911 /* smatch_recurse.c */
 912 int has_symbol(struct expression *expr, struct symbol *sym);
 913 int has_variable(struct expression *expr, struct expression *var);
 914 int has_inc_dec(struct expression *expr);
 915
 916 /* smatch_stored_conditions.c */
 917 struct smatch_state *get_stored_condition(struct expression *expr);
 918 struct sm_state *stored_condition_implication_hook(struct expression *expr,
 919                         struct state_list **true_stack,
 920                         struct state_list **false_stack);
 921
 922 /* check_string_len.c */
 923 int get_formatted_string_size(struct expression *call, int arg);
 924
 925 /* smatch_param_set.c */
 926 int param_was_set(struct expression *expr);
 927 int param_was_set_var_sym(const char *name, struct symbol *sym);
 928 /* smatch_param_filter.c */
 929 int param_has_filter_data(struct sm_state *sm);
 930
 931 /* smatch_links.c */
 932 void set_up_link_functions(int id, int linkid);
 933 struct smatch_state *merge_link_states(struct smatch_state *s1, struct smatch_state *s2);
 934 void store_link(int link_id, const char *name, struct symbol *sym, const char *link_name, struct symbol *link_sym);
 935
 936 /* smatch_auto_copy.c */
 937 void set_auto_copy(int owner);
 938
 939 /* check_buf_comparison */
 940 struct expression *get_size_variable(struct expression *buf);
 941
 942 /* smatch_untracked_param.c */
 943 void add_untracked_param_hook(void (func)(struct expression *call, int param));
 944
 945 /* smatch_strings.c */
 946 struct state_list *get_strings(struct expression *expr);
 947
 948 /* smatch_estate.c */
 949 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
 950
 951 /* smatch_address.c */
 952 int get_address_rl(struct expression *expr, struct range_list **rl);
 953 int get_member_offset(struct symbol *type, char *member_name);
 954 int get_member_offset_from_deref(struct expression *expr);
 955
 956 /* for now this is in smatch_used_parameter.c */
 957 void __get_state_hook(int owner, const char *name, struct symbol *sym);
 958
 959 /* smatch_buf_comparison.c */
 960 int db_var_is_array_limit(struct expression *array, const char *name, struct var_sym_list *vsl);
 961
 962 struct stree *get_all_return_states(void);
 963 struct stree_stack *get_all_return_strees(void);
 964
 965 static inline int type_bits(struct symbol *type)
 966 {
 967         if (!type)
 968                 return 0;
 969         if (type->type == SYM_PTR)  /* Sparse doesn't set this for &pointers */
 970                 return bits_in_pointer;
 971         if (!type->examined)
 972                 examine_symbol_type(type);
 973         return type->bit_size;
 974 }
 975
 976 static inline int type_unsigned(struct symbol *base_type)
 977 {
 978         if (!base_type)
 979                 return 0;
 980         if (base_type->ctype.modifiers & MOD_UNSIGNED)
 981                 return 1;
 982         return 0;
 983 }
 984
 985 static inline int type_positive_bits(struct symbol *type)
 986 {
 987         if (!type)
 988                 return 0;
 989 //      if (type->type == SYM_PTR)
 990 //              return bits_in_pointer;
 991         if (type_unsigned(type))
 992                 return type_bits(type);
 993         return type_bits(type) - 1;
 994 }
 995
 996 static inline int sval_positive_bits(sval_t sval)
 997 {
 998         return type_positive_bits(sval.type);
 999 }
1000
1001 /*
1002  * Returns -1 if one is smaller, 0 if they are the same and 1 if two is larger.
1003  */
1004 static inline int sval_cmp(sval_t one, sval_t two)
1005 {
1006         struct symbol *type;
1007
1008         type = one.type;
1009         if (sval_positive_bits(two) > sval_positive_bits(one))
1010                 type = two.type;
1011         if (type_bits(type) < 31)
1012                 type = &int_ctype;
1013
1014         one = sval_cast(type, one);
1015         two = sval_cast(type, two);
1016
1017         if (type_unsigned(type)) {
1018                 if (one.uvalue < two.uvalue)
1019                         return -1;
1020                 if (one.uvalue == two.uvalue)
1021                         return 0;
1022                 return 1;
1023         }
1024         /* fix me handle type promotion and unsigned values */
1025         if (one.value < two.value)
1026                 return -1;
1027         if (one.value == two.value)
1028                 return 0;
1029         return 1;
1030 }
1031
1032 #endif      /* !SMATCH_H_ */