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