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