smatch.h

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