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