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