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