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 typedef long long mtag_t;
  41
  42 struct smatch_state {
  43         const char *name;
  44         void *data;
  45 };
  46 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
  47 extern struct smatch_state undefined;
  48 extern struct smatch_state ghost;
  49 extern struct smatch_state merged;
  50 extern struct smatch_state true_state;
  51 extern struct smatch_state false_state;
  52 DECLARE_ALLOCATOR(smatch_state);
  53
  54 static inline void *INT_PTR(int i)
  55 {
  56         return (void *)(long)i;
  57 }
  58
  59 static inline int PTR_INT(void *p)
  60 {
  61         return (int)(long)p;
  62 }
  63
  64 struct tracker {
  65         char *name;
  66         struct symbol *sym;
  67         unsigned short owner;
  68 };
  69 DECLARE_ALLOCATOR(tracker);
  70 DECLARE_PTR_LIST(tracker_list, struct tracker);
  71 DECLARE_PTR_LIST(stree_stack, struct stree);
  72
  73 /* The first 3 struct members must match struct tracker */
  74 struct sm_state {
  75         const char *name;
  76         struct symbol *sym;
  77         unsigned short owner;
  78         unsigned short merged:1;
  79         unsigned short skip_implications:1;
  80         unsigned int nr_children;
  81         unsigned int line;
  82         struct smatch_state *state;
  83         struct stree *pool;
  84         struct sm_state *left;
  85         struct sm_state *right;
  86         struct state_list *possible;
  87 };
  88
  89 struct var_sym {
  90         char *var;
  91         struct symbol *sym;
  92 };
  93 DECLARE_ALLOCATOR(var_sym);
  94 DECLARE_PTR_LIST(var_sym_list, struct var_sym);
  95
  96 struct constraint {
  97         int op;
  98         int id;
  99 };
 100 DECLARE_PTR_LIST(constraint_list, struct constraint);
 101
 102 enum hook_type {
 103         EXPR_HOOK,
 104         STMT_HOOK,
 105         STMT_HOOK_AFTER,
 106         SYM_HOOK,
 107         STRING_HOOK,
 108         DECLARATION_HOOK,
 109         ASSIGNMENT_HOOK,
 110         ASSIGNMENT_HOOK_AFTER,
 111         RAW_ASSIGNMENT_HOOK,
 112         GLOBAL_ASSIGNMENT_HOOK,
 113         LOGIC_HOOK,
 114         CONDITION_HOOK,
 115         PRELOOP_HOOK,
 116         SELECT_HOOK,
 117         WHOLE_CONDITION_HOOK,
 118         FUNCTION_CALL_HOOK,
 119         CALL_HOOK_AFTER_INLINE,
 120         FUNCTION_CALL_HOOK_AFTER_DB,
 121         CALL_ASSIGNMENT_HOOK,
 122         MACRO_ASSIGNMENT_HOOK,
 123         BINOP_HOOK,
 124         OP_HOOK,
 125         DEREF_HOOK,
 126         CASE_HOOK,
 127         ASM_HOOK,
 128         CAST_HOOK,
 129         SIZEOF_HOOK,
 130         BASE_HOOK,
 131         FUNC_DEF_HOOK,
 132         AFTER_DEF_HOOK,
 133         END_FUNC_HOOK,
 134         AFTER_FUNC_HOOK,
 135         RETURN_HOOK,
 136         INLINE_FN_START,
 137         INLINE_FN_END,
 138         END_FILE_HOOK,
 139         NUM_HOOKS,
 140 };
 141
 142 #define TRUE 1
 143 #define FALSE 0
 144
 145 struct range_list;
 146
 147 void add_hook(void *func, enum hook_type type);
 148 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
 149 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
 150 void add_merge_hook(int client_id, merge_func_t *func);
 151 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
 152 void add_pre_merge_hook(int client_id, void (*hook)(struct sm_state *sm));
 153 typedef void (scope_hook)(void *data);
 154 void add_scope_hook(scope_hook *hook, void *data);
 155 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
 156 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
 157                                 struct expression *assign_expr, void *data);
 158 typedef void (return_implies_hook)(struct expression *call_expr,
 159                                    int param, char *key, char *value);
 160 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list **rl);
 161 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
 162
 163 void add_function_assign_hook(const char *look_for, func_hook *call_back,
 164                               void *info);
 165 void add_implied_return_hook(const char *look_for,
 166                              implied_return_hook *call_back,
 167                              void *info);
 168 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
 169                               void *info);
 170 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
 171                               void *info);
 172 void return_implies_state(const char *look_for, long long start, long long end,
 173                          implication_hook *call_back, void *info);
 174 void select_return_states_hook(int type, return_implies_hook *callback);
 175 void select_return_states_before(void (*fn)(void));
 176 void select_return_states_after(void (*fn)(void));
 177 int get_implied_return(struct expression *expr, struct range_list **rl);
 178 void allocate_hook_memory(void);
 179
 180 struct modification_data {
 181         struct smatch_state *prev;
 182         struct expression *cur;
 183 };
 184
 185 typedef void (modification_hook)(struct sm_state *sm, struct expression *mod_expr);
 186 void add_modification_hook(int owner, modification_hook *call_back);
 187 void add_modification_hook_late(int owner, modification_hook *call_back);
 188 struct smatch_state *get_modification_state(struct expression *expr);
 189
 190 int outside_of_function(void);
 191 const char *get_filename(void);
 192 const char *get_base_file(void);
 193 char *get_function(void);
 194 int get_lineno(void);
 195 extern int final_pass;
 196 extern struct symbol *cur_func_sym;
 197 extern int option_debug;
 198 extern int local_debug;
 199 extern int option_info;
 200 extern int option_spammy;
 201 extern char *trace_variable;
 202 extern struct stree *global_states;
 203 int is_silenced_function(void);
 204
 205 /* smatch_impossible.c */
 206 int is_impossible_path(void);
 207 void set_path_impossible(void);
 208
 209 extern FILE *sm_outfd;
 210 extern FILE *sql_outfd;
 211 extern FILE *caller_info_fd;
 212 #define sm_printf(msg...) do { if (final_pass || option_debug || local_debug) fprintf(sm_outfd, msg); } while (0)
 213
 214 static inline void sm_prefix(void)
 215 {
 216         sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
 217 }
 218
 219 static inline void print_implied_debug_msg();
 220
 221 #define sm_msg(msg...) \
 222 do {                                                           \
 223         print_implied_debug_msg();                             \
 224         if (!option_debug && !final_pass && !local_debug)      \
 225                 break;                                         \
 226         if (!option_info && is_silenced_function())            \
 227                 break;                                         \
 228         sm_prefix();                                           \
 229         sm_printf(msg);                                        \
 230         sm_printf("\n");                                       \
 231 } while (0)
 232
 233 #define local_debug(msg...)                                     \
 234 do {                                                            \
 235         if (local_debug)                                        \
 236                 sm_msg(msg);                                    \
 237 } while (0)
 238
 239 extern char *implied_debug_msg;
 240 static inline void print_implied_debug_msg(void)
 241 {
 242         static struct symbol *last_printed = NULL;
 243
 244         if (!implied_debug_msg)
 245                 return;
 246         if (last_printed == cur_func_sym)
 247                 return;
 248         last_printed = cur_func_sym;
 249         sm_msg("%s", implied_debug_msg);
 250 }
 251
 252 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
 253
 254 #define sm_info(msg...) do {                                    \
 255         if (option_debug || (option_info && final_pass)) {      \
 256                 sm_prefix();                                    \
 257                 sm_printf("info: ");                            \
 258                 sm_printf(msg);                                 \
 259                 sm_printf("\n");                                \
 260         }                                                       \
 261 } while(0)
 262
 263 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
 264
 265 struct smatch_state *__get_state(int owner, const char *name, struct symbol *sym);
 266 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
 267 struct smatch_state *get_state_expr(int owner, struct expression *expr);
 268 struct state_list *get_possible_states(int owner, const char *name,
 269                                        struct symbol *sym);
 270 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
 271 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
 272                struct smatch_state *state);
 273 struct sm_state *set_state_expr(int owner, struct expression *expr,
 274                 struct smatch_state *state);
 275 void delete_state(int owner, const char *name, struct symbol *sym);
 276 void delete_state_expr(int owner, struct expression *expr);
 277 void __delete_all_states_sym(struct symbol *sym);
 278 void set_true_false_states(int owner, const char *name, struct symbol *sym,
 279                            struct smatch_state *true_state,
 280                            struct smatch_state *false_state);
 281 void set_true_false_states_expr(int owner, struct expression *expr,
 282                            struct smatch_state *true_state,
 283                            struct smatch_state *false_state);
 284
 285 struct stree *get_all_states_from_stree(int owner, struct stree *source);
 286 struct stree *get_all_states_stree(int id);
 287 struct stree *__get_cur_stree(void);
 288 int is_reachable(void);
 289 void add_get_state_hook(void (*fn)(int owner, const char *name, struct symbol *sym));
 290
 291 /* smatch_helper.c */
 292 DECLARE_PTR_LIST(int_stack, int);
 293 char *alloc_string(const char *str);
 294 void free_string(char *str);
 295 void append(char *dest, const char *data, int buff_len);
 296 void remove_parens(char *str);
 297 struct smatch_state *alloc_state_num(int num);
 298 struct smatch_state *alloc_state_str(const char *name);
 299 struct smatch_state *alloc_state_expr(struct expression *expr);
 300 struct expression *get_argument_from_call_expr(struct expression_list *args,
 301                                                int num);
 302
 303 char *expr_to_var(struct expression *expr);
 304 struct symbol *expr_to_sym(struct expression *expr);
 305 char *expr_to_str(struct expression *expr);
 306 char *expr_to_str_sym(struct expression *expr,
 307                                      struct symbol **sym_ptr);
 308 char *expr_to_var_sym(struct expression *expr,
 309                              struct symbol **sym_ptr);
 310 char *expr_to_known_chunk_sym(struct expression *expr, struct symbol **sym);
 311 char *expr_to_chunk_sym_vsl(struct expression *expr, struct symbol **sym, struct var_sym_list **vsl);
 312 int get_complication_score(struct expression *expr);
 313
 314 int sym_name_is(const char *name, struct expression *expr);
 315 int get_const_value(struct expression *expr, sval_t *sval);
 316 int get_value(struct expression *expr, sval_t *val);
 317 int get_implied_value(struct expression *expr, sval_t *val);
 318 int get_implied_min(struct expression *expr, sval_t *sval);
 319 int get_implied_max(struct expression *expr, sval_t *val);
 320 int get_hard_max(struct expression *expr, sval_t *sval);
 321 int get_fuzzy_min(struct expression *expr, sval_t *min);
 322 int get_fuzzy_max(struct expression *expr, sval_t *max);
 323 int get_absolute_min(struct expression *expr, sval_t *sval);
 324 int get_absolute_max(struct expression *expr, sval_t *sval);
 325 int parse_call_math(struct expression *expr, char *math, sval_t *val);
 326 int parse_call_math_rl(struct expression *call, char *math, struct range_list **rl);
 327 char *get_value_in_terms_of_parameter_math(struct expression *expr);
 328 char *get_value_in_terms_of_parameter_math_var_sym(const char *var, struct symbol *sym);
 329 int is_zero(struct expression *expr);
 330 int known_condition_true(struct expression *expr);
 331 int known_condition_false(struct expression *expr);
 332 int implied_condition_true(struct expression *expr);
 333 int implied_condition_false(struct expression *expr);
 334 int can_integer_overflow(struct symbol *type, struct expression *expr);
 335
 336 int is_array(struct expression *expr);
 337 struct expression *get_array_base(struct expression *expr);
 338 struct expression *get_array_offset(struct expression *expr);
 339 const char *show_state(struct smatch_state *state);
 340 struct statement *get_expression_statement(struct expression *expr);
 341 struct expression *strip_parens(struct expression *expr);
 342 struct expression *strip_expr(struct expression *expr);
 343 void scoped_state(int my_id, const char *name, struct symbol *sym);
 344 int is_error_return(struct expression *expr);
 345 int getting_address(void);
 346 int get_struct_and_member(struct expression *expr, const char **type, const char **member);
 347 char *get_member_name(struct expression *expr);
 348 char *get_fnptr_name(struct expression *expr);
 349 int cmp_pos(struct position pos1, struct position pos2);
 350 int positions_eq(struct position pos1, struct position pos2);
 351 struct statement *get_current_statement(void);
 352 struct statement *get_prev_statement(void);
 353 int get_param_num_from_sym(struct symbol *sym);
 354 int get_param_num(struct expression *expr);
 355 int ms_since(struct timeval *start);
 356 int parent_is_gone_var_sym(const char *name, struct symbol *sym);
 357 int parent_is_gone(struct expression *expr);
 358 int invert_op(int op);
 359 int expr_equiv(struct expression *one, struct expression *two);
 360 void push_int(struct int_stack **stack, int num);
 361 int pop_int(struct int_stack **stack);
 362
 363 /* smatch_type.c */
 364 struct symbol *get_real_base_type(struct symbol *sym);
 365 int type_bytes(struct symbol *type);
 366 int array_bytes(struct symbol *type);
 367 struct symbol *get_pointer_type(struct expression *expr);
 368 struct symbol *get_type(struct expression *expr);
 369 int type_signed(struct symbol *base_type);
 370 int expr_unsigned(struct expression *expr);
 371 int expr_signed(struct expression *expr);
 372 int returns_unsigned(struct symbol *base_type);
 373 int is_pointer(struct expression *expr);
 374 int returns_pointer(struct symbol *base_type);
 375 sval_t sval_type_max(struct symbol *base_type);
 376 sval_t sval_type_min(struct symbol *base_type);
 377 int nr_bits(struct expression *expr);
 378 int is_void_pointer(struct expression *expr);
 379 int is_char_pointer(struct expression *expr);
 380 int is_string(struct expression *expr);
 381 int is_static(struct expression *expr);
 382 int is_local_variable(struct expression *expr);
 383 int types_equiv(struct symbol *one, struct symbol *two);
 384 int fn_static(void);
 385 const char *global_static();
 386 struct symbol *cur_func_return_type(void);
 387 struct symbol *get_arg_type(struct expression *fn, int arg);
 388 struct symbol *get_member_type_from_key(struct expression *expr, const char *key);
 389 int is_struct(struct expression *expr);
 390 char *type_to_str(struct symbol *type);
 391
 392 /* smatch_ignore.c */
 393 void add_ignore(int owner, const char *name, struct symbol *sym);
 394 int is_ignored(int owner, const char *name, struct symbol *sym);
 395 void add_ignore_expr(int owner, struct expression *expr);
 396 int is_ignored_expr(int owner, struct expression *expr);
 397
 398 /* smatch_var_sym */
 399 struct var_sym *alloc_var_sym(const char *var, struct symbol *sym);
 400 struct var_sym_list *expr_to_vsl(struct expression *expr);
 401 void add_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
 402 void add_var_sym_expr(struct var_sym_list **list, struct expression *expr);
 403 void del_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
 404 int in_var_sym_list(struct var_sym_list *list, const char *var, struct symbol *sym);
 405 struct var_sym_list *clone_var_sym_list(struct var_sym_list *from_vsl);
 406 void merge_var_sym_list(struct var_sym_list **dest, struct var_sym_list *src);
 407 struct var_sym_list *combine_var_sym_lists(struct var_sym_list *one, struct var_sym_list *two);
 408 int var_sym_lists_equiv(struct var_sym_list *one, struct var_sym_list *two);
 409 void free_var_sym_list(struct var_sym_list **list);
 410 void free_var_syms_and_list(struct var_sym_list **list);
 411
 412 /* smatch_tracker */
 413 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
 414 void add_tracker(struct tracker_list **list, int owner, const char *name,
 415                 struct symbol *sym);
 416 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
 417 void del_tracker(struct tracker_list **list, int owner, const char *name,
 418                 struct symbol *sym);
 419 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
 420                 struct symbol *sym);
 421 void free_tracker_list(struct tracker_list **list);
 422 void free_trackers_and_list(struct tracker_list **list);
 423
 424 /* smatch_conditions */
 425 int in_condition(void);
 426
 427 /* smatch_flow.c */
 428
 429 extern int __in_fake_assign;
 430 void smatch (int argc, char **argv);
 431 int inside_loop(void);
 432 int definitely_inside_loop(void);
 433 struct expression *get_switch_expr(void);
 434 int in_expression_statement(void);
 435 void __process_post_op_stack(void);
 436 void __split_expr(struct expression *expr);
 437 void __split_label_stmt(struct statement *stmt);
 438 void __split_stmt(struct statement *stmt);
 439 extern int __in_function_def;
 440 extern int option_assume_loops;
 441 extern int option_two_passes;
 442 extern int option_no_db;
 443 extern int option_file_output;
 444 extern int option_time;
 445 extern struct expression_list *big_expression_stack;
 446 extern struct expression_list *big_condition_stack;
 447 extern struct statement_list *big_statement_stack;
 448 int is_assigned_call(struct expression *expr);
 449 int inlinable(struct expression *expr);
 450 extern int __inline_call;
 451 extern struct expression *__inline_fn;
 452 extern int __in_pre_condition;
 453 extern int __bail_on_rest_of_function;
 454 extern struct statement *__prev_stmt;
 455 extern struct statement *__cur_stmt;
 456 extern struct statement *__next_stmt;
 457 void init_fake_env(void);
 458 void end_fake_env(void);
 459 int time_parsing_function(void);
 460
 461 /* smatch_struct_assignment.c */
 462 struct expression *get_faked_expression(void);
 463 void __fake_struct_member_assignments(struct expression *expr);
 464
 465 /* smatch_project.c */
 466 int is_no_inline_function(const char *function);
 467
 468 /* smatch_conditions */
 469 void __split_whole_condition(struct expression *expr);
 470 void __handle_logic(struct expression *expr);
 471 int is_condition(struct expression *expr);
 472 int __handle_condition_assigns(struct expression *expr);
 473 int __handle_select_assigns(struct expression *expr);
 474 int __handle_expr_statement_assigns(struct expression *expr);
 475
 476 /* smatch_implied.c */
 477 extern int option_debug_implied;
 478 extern int option_debug_related;
 479 struct range_list_stack;
 480 void param_limit_implications(struct expression *expr, int param, char *key, char *value);
 481 struct stree *__implied_case_stree(struct expression *switch_expr,
 482                                    struct range_list *case_rl,
 483                                    struct range_list_stack **remaining_cases,
 484                                    struct stree **raw_stree);
 485 void overwrite_states_using_pool(struct sm_state *gate_sm, struct sm_state *pool_sm);
 486 int assume(struct expression *expr);
 487 void end_assume(void);
 488
 489 /* smatch_extras.c */
 490 #define SMATCH_EXTRA 5 /* this is my_id from smatch extra set in smatch.c */
 491 extern int RETURN_ID;
 492
 493 struct data_range {
 494         sval_t min;
 495         sval_t max;
 496 };
 497
 498 extern long long valid_ptr_min, valid_ptr_max;
 499 extern sval_t valid_ptr_min_sval, valid_ptr_max_sval;
 500 static const sval_t array_min_sval = {
 501         .type = &ptr_ctype,
 502         {.value = 100000},
 503 };
 504 static const sval_t array_max_sval = {
 505         .type = &ptr_ctype,
 506         {.value = 199999},
 507 };
 508 static const sval_t text_seg_min = {
 509         .type = &ptr_ctype,
 510         {.value = 100000000},
 511 };
 512 static const sval_t text_seg_max = {
 513         .type = &ptr_ctype,
 514         {.value = 177777777},
 515 };
 516 static const sval_t data_seg_min = {
 517         .type = &ptr_ctype,
 518         {.value = 200000000},
 519 };
 520 static const sval_t data_seg_max = {
 521         .type = &ptr_ctype,
 522         {.value = 277777777},
 523 };
 524 static const sval_t bss_seg_min = {
 525         .type = &ptr_ctype,
 526         {.value = 300000000},
 527 };
 528 static const sval_t bss_seg_max = {
 529         .type = &ptr_ctype,
 530         {.value = 377777777},
 531 };
 532 static const sval_t stack_seg_min = {
 533         .type = &ptr_ctype,
 534         {.value = 400000000},
 535 };
 536 static const sval_t stack_seg_max = {
 537         .type = &ptr_ctype,
 538         {.value = 477777777},
 539 };
 540 static const sval_t kmalloc_seg_min = {
 541         .type = &ptr_ctype,
 542         {.value = 500000000},
 543 };
 544 static const sval_t kmalloc_seg_max = {
 545         .type = &ptr_ctype,
 546         {.value = 577777777},
 547 };
 548 static const sval_t vmalloc_seg_min = {
 549         .type = &ptr_ctype,
 550         {.value = 600000000},
 551 };
 552 static const sval_t vmalloc_seg_max = {
 553         .type = &ptr_ctype,
 554         {.value = 677777777},
 555 };
 556 static const sval_t fn_ptr_min = {
 557         .type = &ptr_ctype,
 558         {.value = 700000000},
 559 };
 560 static const sval_t fn_ptr_max = {
 561         .type = &ptr_ctype,
 562         {.value = 777777777},
 563 };
 564
 565 char *get_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
 566 char *map_call_to_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
 567 char *map_long_to_short_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
 568 char *map_long_to_short_name_sym_nostack(const char *name, struct symbol *sym, struct symbol **new_sym);
 569
 570 #define STRLEN_MAX_RET 1010101
 571
 572 /* smatch_absolute.c */
 573 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
 574 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
 575
 576 /* smatch_local_values.c */
 577 int get_local_rl(struct expression *expr, struct range_list **rl);
 578 int get_local_max_helper(struct expression *expr, sval_t *sval);
 579 int get_local_min_helper(struct expression *expr, sval_t *sval);
 580
 581 /* smatch_type_value.c */
 582 int get_db_type_rl(struct expression *expr, struct range_list **rl);
 583 /* smatch_data_val.c */
 584 int get_db_data_rl(struct expression *expr, struct range_list **rl);
 585
 586 /* smatch_states.c */
 587 void __swap_cur_stree(struct stree *stree);
 588 void __push_fake_cur_stree();
 589 struct stree *__pop_fake_cur_stree();
 590 void __free_fake_cur_stree();
 591 void __set_fake_cur_stree_fast(struct stree *stree);
 592 void __pop_fake_cur_stree_fast(void);
 593 void __merge_stree_into_cur(struct stree *stree);
 594
 595 int unreachable(void);
 596 void __set_sm(struct sm_state *sm);
 597 void __set_sm_cur_stree(struct sm_state *sm);
 598 void __set_sm_fake_stree(struct sm_state *sm);
 599 void __set_true_false_sm(struct sm_state *true_state,
 600                         struct sm_state *false_state);
 601 void nullify_path(void);
 602 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 603                                void *unused);
 604 void __unnullify_path(void);
 605 int __path_is_null(void);
 606 void save_all_states(void);
 607 void restore_all_states(void);
 608 void free_goto_stack(void);
 609 void clear_all_states(void);
 610
 611 struct sm_state *get_sm_state(int owner, const char *name,
 612                                 struct symbol *sym);
 613 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
 614 void __push_true_states(void);
 615 void __use_false_states(void);
 616 void __discard_false_states(void);
 617 void __merge_false_states(void);
 618 void __merge_true_states(void);
 619
 620 void __negate_cond_stacks(void);
 621 void __use_pre_cond_states(void);
 622 void __use_cond_true_states(void);
 623 void __use_cond_false_states(void);
 624 void __push_cond_stacks(void);
 625 void __fold_in_set_states(void);
 626 void __free_set_states(void);
 627 struct stree *__copy_cond_true_states(void);
 628 struct stree *__copy_cond_false_states(void);
 629 struct stree *__pop_cond_true_stack(void);
 630 struct stree *__pop_cond_false_stack(void);
 631 void __and_cond_states(void);
 632 void __or_cond_states(void);
 633 void __save_pre_cond_states(void);
 634 void __discard_pre_cond_states(void);
 635 struct stree *__get_true_states(void);
 636 struct stree *__get_false_states(void);
 637 void __use_cond_states(void);
 638 extern struct state_list *__last_base_slist;
 639
 640 void __push_continues(void);
 641 void __discard_continues(void);
 642 void __process_continues(void);
 643 void __merge_continues(void);
 644
 645 void __push_breaks(void);
 646 void __process_breaks(void);
 647 int __has_breaks(void);
 648 void __merge_breaks(void);
 649 void __use_breaks(void);
 650
 651 void __save_switch_states(struct expression *switch_expr);
 652 void __discard_switches(void);
 653 void __merge_switches(struct expression *switch_expr, struct range_list *case_rl);
 654 void __push_default(void);
 655 void __set_default(void);
 656 int __pop_default(void);
 657
 658 void __push_conditions(void);
 659 void __discard_conditions(void);
 660
 661 void __save_gotos(const char *name, struct symbol *sym);
 662 void __merge_gotos(const char *name, struct symbol *sym);
 663
 664 void __print_cur_stree(void);
 665
 666 /* smatch_hooks.c */
 667 void __pass_to_client(void *data, enum hook_type type);
 668 void __pass_to_client_no_data(enum hook_type type);
 669 void __pass_case_to_client(struct expression *switch_expr,
 670                            struct range_list *rl);
 671 int __has_merge_function(int client_id);
 672 struct smatch_state *__client_merge_function(int owner,
 673                                              struct smatch_state *s1,
 674                                              struct smatch_state *s2);
 675 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 676 void call_pre_merge_hook(struct sm_state *sm);
 677 void __push_scope_hooks(void);
 678 void __call_scope_hooks(void);
 679
 680 /* smatch_function_hooks.c */
 681 void create_function_hook_hash(void);
 682 void __match_initializer_call(struct symbol *sym);
 683
 684 /* smatch_db.c */
 685 enum info_type {
 686         INTERNAL        = 0,
 687         /*
 688          * Changing these numbers is a pain.  Don't do it.  If you ever use a
 689          * number it can't be re-used right away so there may be gaps.
 690          * We select these in order by type so if the order matters, then give
 691          * it a number below 100-999,9000-9999 ranges. */
 692
 693         PARAM_CLEARED   = 101,
 694         PARAM_LIMIT     = 103,
 695         PARAM_FILTER    = 104,
 696
 697         PARAM_VALUE     = 1001,
 698         BUF_SIZE        = 1002,
 699         USER_DATA       = 1003,
 700         CAPPED_DATA     = 1004,
 701         RETURN_VALUE    = 1005,
 702         DEREFERENCE     = 1006,
 703         RANGE_CAP       = 1007,
 704         LOCK_HELD       = 1008,
 705         LOCK_RELEASED   = 1009,
 706         ABSOLUTE_LIMITS = 1010,
 707         PARAM_ADD       = 1012,
 708         PARAM_FREED     = 1013,
 709         DATA_SOURCE     = 1014,
 710         FUZZY_MAX       = 1015,
 711         STR_LEN         = 1016,
 712         ARRAY_LEN       = 1017,
 713         CAPABLE         = 1018,
 714         NS_CAPABLE      = 1019,
 715         CONTAINER       = 1020,
 716         CASTED_CALL     = 1021,
 717         TYPE_LINK       = 1022,
 718         UNTRACKED_PARAM = 1023,
 719         CULL_PATH       = 1024,
 720         PARAM_SET       = 1025,
 721         PARAM_USED      = 1026,
 722         BYTE_UNITS      = 1027,
 723         COMPARE_LIMIT   = 1028,
 724         PARAM_COMPARE   = 1029,
 725         CONSTRAINT      = 1031,
 726         PASSES_TYPE     = 1032,
 727         CONSTRAINT_REQUIRED = 1033,
 728
 729         /* put random temporary stuff in the 7000-7999 range for testing */
 730         USER_DATA3      = 8017,
 731         USER_DATA3_SET  = 9017,
 732         NO_OVERFLOW     = 8018,
 733         NO_OVERFLOW_SIMPLE = 8019,
 734         LOCKED          = 8020,
 735         UNLOCKED        = 8021,
 736         SET_FS          = 8022,
 737         ATOMIC_INC      = 8023,
 738         ATOMIC_DEC      = 8024,
 739         NO_SIDE_EFFECT  = 8025,
 740         FN_ARG_LINK     = 8028,
 741         DATA_VALUE      = 8029,
 742         ARRAYSIZE_ARG   = 8033,
 743         SIZEOF_ARG      = 8034,
 744         MEMORY_TAG      = 8036,
 745         MTAG_ASSIGN     = 8035,
 746 };
 747
 748 void debug_sql(const char *sql);
 749 void debug_mem_sql(const char *sql);
 750 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
 751 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
 752 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr));
 753 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));
 754 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
 755 struct range_list *db_return_vals(struct expression *expr);
 756 struct range_list *db_return_vals_from_str(const char *fn_name);
 757 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym);
 758 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl);
 759 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym);
 760 const char *state_name_to_param_name(const char *state_name, const char *param_name);
 761 const char *get_param_name_var_sym(const char *name, struct symbol *sym);
 762 const char *get_param_name(struct sm_state *sm);
 763 const char *get_mtag_name_var_sym(const char *state_name, struct symbol *sym);
 764 const char *get_mtag_name_expr(struct expression *expr);
 765 char *get_data_info_name(struct expression *expr);
 766
 767 #define run_sql(call_back, data, sql...)    \
 768 do {                                  \
 769         char sql_txt[1024];           \
 770         if (option_no_db)             \
 771                 break;                \
 772         snprintf(sql_txt, 1024, sql); \
 773         debug_sql(sql_txt);           \
 774         sql_exec(call_back, data, sql_txt); \
 775 } while (0)
 776
 777 /* like run_sql() but for the in-memory database */
 778 #define mem_sql(call_back, data, sql...)                                                \
 779 do {                                                                            \
 780         char sql_txt[1024];                                                     \
 781                                                                                 \
 782         snprintf(sql_txt, sizeof(sql_txt), sql);                                \
 783         sm_debug("in-mem: %s\n", sql_txt);                                      \
 784         debug_mem_sql(sql_txt);                                                 \
 785         sql_mem_exec(call_back, data, sql_txt);                                 \
 786 } while (0)
 787
 788 char *get_static_filter(struct symbol *sym);
 789
 790 void sql_insert_return_states(int return_id, const char *return_ranges,
 791                 int type, int param, const char *key, const char *value);
 792 void sql_insert_caller_info(struct expression *call, int type, int param,
 793                 const char *key, const char *value);
 794 void sql_insert_function_ptr(const char *fn, const char *struct_name);
 795 void sql_insert_return_values(const char *return_values);
 796 void sql_insert_call_implies(int type, int param, const char *key, const char *value);
 797 void sql_insert_function_type_size(const char *member, const char *ranges);
 798 void sql_insert_local_values(const char *name, const char *value);
 799 void sql_insert_function_type_value(const char *type, const char *value);
 800 void sql_insert_function_type(int param, const char *value);
 801 void sql_insert_parameter_name(int param, const char *value);
 802 void sql_insert_data_info(struct expression *data, int type, const char *value);
 803 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value);
 804 void sql_save_constraint(const char *con);
 805 void sql_save_constraint_required(const char *data, int op, const char *limit);
 806 void sql_copy_constraint_required(const char *new_limit, const char *old_limit);
 807 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data);
 808 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value);
 809 void sql_insert_mtag_about(mtag_t tag, const char *left_name, const char *right_name);
 810 void insert_mtag_data(mtag_t tag, const char *data_name, int offset, struct range_list *rl);
 811 void sql_insert_mtag_map(mtag_t tag, int offset, mtag_t container);
 812 int mtag_map_select_container(mtag_t tag, int offset, mtag_t *container);
 813 int mtag_map_select_tag(mtag_t container, int offset, mtag_t *tag);
 814
 815 void sql_select_return_states(const char *cols, struct expression *call,
 816         int (*callback)(void*, int, char**, char**), void *info);
 817 void sql_select_call_implies(const char *cols, struct expression *call,
 818         int (*callback)(void*, int, char**, char**));
 819
 820 void sql_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql);
 821 void sql_mem_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql);
 822
 823 void open_smatch_db(void);
 824
 825 /* smatch_files.c */
 826 int open_data_file(const char *filename);
 827 struct token *get_tokens_file(const char *filename);
 828
 829 /* smatch.c */
 830 extern char *option_debug_check;
 831 extern char *option_project_str;
 832 extern char *data_dir;
 833 extern int option_no_data;
 834 extern int option_full_path;
 835 extern int option_param_mapper;
 836 extern int option_call_tree;
 837 extern int num_checks;
 838
 839 enum project_type {
 840         PROJ_NONE,
 841         PROJ_KERNEL,
 842         PROJ_WINE,
 843         PROJ_UNKNOWN,
 844 };
 845 extern enum project_type option_project;
 846 const char *check_name(unsigned short id);
 847 int id_from_name(const char *name);
 848
 849
 850 /* smatch_buf_size.c */
 851 int get_array_size(struct expression *expr);
 852 int get_array_size_bytes(struct expression *expr);
 853 int get_array_size_bytes_min(struct expression *expr);
 854 int get_array_size_bytes_max(struct expression *expr);
 855 struct range_list *get_array_size_bytes_rl(struct expression *expr);
 856 int get_real_array_size(struct expression *expr);
 857 int last_member_is_resizable(struct symbol *type);
 858 /* smatch_strlen.c */
 859 int get_implied_strlen(struct expression *expr, struct range_list **rl);
 860 int get_size_from_strlen(struct expression *expr);
 861
 862 /* smatch_capped.c */
 863 int is_capped(struct expression *expr);
 864 int is_capped_var_sym(const char *name, struct symbol *sym);
 865
 866 /* check_user_data.c */
 867 int is_user_macro(struct expression *expr);
 868 int is_user_data(struct expression *expr);
 869 int is_capped_user_data(struct expression *expr);
 870 int implied_user_data(struct expression *expr, struct range_list **rl);
 871 int get_user_rl(struct expression *expr, struct range_list **rl);
 872 int get_user_rl_var_sym(const char *name, struct symbol *sym, struct range_list **rl);
 873
 874 /* check_locking.c */
 875 void print_held_locks();
 876
 877 /* check_assigned_expr.c */
 878 struct expression *get_assigned_expr(struct expression *expr);
 879 struct expression *get_assigned_expr_name_sym(const char *name, struct symbol *sym);
 880 /* smatch_return_to_param.c */
 881 void __add_return_to_param_mapping(struct expression *assign, const char *return_string);
 882 char *map_call_to_param_name_sym(struct expression *expr, struct symbol **sym);
 883
 884 /* smatch_comparison.c */
 885 struct compare_data {
 886         /* The ->left and ->right expression pointers might be NULL (I'm lazy) */
 887         struct expression *left;
 888         const char *left_var;
 889         struct var_sym_list *left_vsl;
 890         int comparison;
 891         struct expression *right;
 892         const char *right_var;
 893         struct var_sym_list *right_vsl;
 894 };
 895 DECLARE_ALLOCATOR(compare_data);
 896 struct smatch_state *alloc_compare_state(
 897                 struct expression *left,
 898                 const char *left_var, struct var_sym_list *left_vsl,
 899                 int comparison,
 900                 struct expression *right,
 901                 const char *right_var, struct var_sym_list *right_vsl);
 902 int merge_comparisons(int one, int two);
 903 int combine_comparisons(int left_compare, int right_compare);
 904 int state_to_comparison(struct smatch_state *state);
 905 struct smatch_state *merge_compare_states(struct smatch_state *s1, struct smatch_state *s2);
 906 int get_comparison(struct expression *left, struct expression *right);
 907 int get_comparison_strings(const char *one, const char *two);
 908 int possible_comparison(struct expression *a, int comparison, struct expression *b);
 909 struct state_list *get_all_comparisons(struct expression *expr);
 910 struct state_list *get_all_possible_equal_comparisons(struct expression *expr);
 911 void __add_return_comparison(struct expression *call, const char *range);
 912 void __add_comparison_info(struct expression *expr, struct expression *call, const char *range);
 913 char *get_printed_param_name(struct expression *call, const char *param_name, struct symbol *param_sym);
 914 char *name_sym_to_param_comparison(const char *name, struct symbol *sym);
 915 char *expr_equal_to_param(struct expression *expr, int ignore);
 916 char *expr_lte_to_param(struct expression *expr, int ignore);
 917 char *expr_param_comparison(struct expression *expr, int ignore);
 918 int flip_comparison(int op);
 919 int negate_comparison(int op);
 920 int remove_unsigned_from_comparison(int op);
 921 int param_compare_limit_is_impossible(struct expression *expr, int left_param, char *left_key, char *value);
 922 void filter_by_comparison(struct range_list **rl, int comparison, struct range_list *right);
 923 struct sm_state *comparison_implication_hook(struct expression *expr,
 924                         struct state_list **true_stack,
 925                         struct state_list **false_stack);
 926 void __compare_param_limit_hook(struct expression *left_expr, struct expression *right_expr,
 927                                 const char *state_name,
 928                                 struct smatch_state *true_state, struct smatch_state *false_state);
 929
 930
 931 /* smatch_sval.c */
 932 sval_t *sval_alloc(sval_t sval);
 933 sval_t *sval_alloc_permanent(sval_t sval);
 934 sval_t sval_blank(struct expression *expr);
 935 sval_t sval_type_val(struct symbol *type, long long val);
 936 sval_t sval_from_val(struct expression *expr, long long val);
 937 int sval_unsigned(sval_t sval);
 938 int sval_signed(sval_t sval);
 939 int sval_bits(sval_t sval);
 940 int sval_bits_used(sval_t sval);
 941 int sval_is_negative(sval_t sval);
 942 int sval_is_positive(sval_t sval);
 943 int sval_is_min(sval_t sval);
 944 int sval_is_max(sval_t sval);
 945 int sval_is_a_min(sval_t sval);
 946 int sval_is_a_max(sval_t sval);
 947 int sval_is_negative_min(sval_t sval);
 948 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
 949 int sval_cmp_val(sval_t one, long long val);
 950 sval_t sval_min(sval_t one, sval_t two);
 951 sval_t sval_max(sval_t one, sval_t two);
 952 int sval_too_low(struct symbol *type, sval_t sval);
 953 int sval_too_high(struct symbol *type, sval_t sval);
 954 int sval_fits(struct symbol *type, sval_t sval);
 955 sval_t sval_cast(struct symbol *type, sval_t sval);
 956 sval_t sval_preop(sval_t sval, int op);
 957 sval_t sval_binop(sval_t left, int op, sval_t right);
 958 int sval_binop_overflows(sval_t left, int op, sval_t right);
 959 unsigned long long fls_mask(unsigned long long uvalue);
 960 unsigned long long sval_fls_mask(sval_t sval);
 961 const char *sval_to_str(sval_t sval);
 962 const char *sval_to_numstr(sval_t sval);
 963 sval_t ll_to_sval(long long val);
 964
 965 /* smatch_string_list.c */
 966 int list_has_string(struct string_list *str_list, const char *str);
 967 void insert_string(struct string_list **str_list, const char *str);
 968 struct string_list *clone_str_list(struct string_list *orig);
 969 struct string_list *combine_string_lists(struct string_list *one, struct string_list *two);
 970
 971 /* smatch_start_states.c */
 972 struct stree *get_start_states(void);
 973
 974 /* smatch_recurse.c */
 975 int has_symbol(struct expression *expr, struct symbol *sym);
 976 int has_variable(struct expression *expr, struct expression *var);
 977 int has_inc_dec(struct expression *expr);
 978
 979 /* smatch_stored_conditions.c */
 980 struct smatch_state *get_stored_condition(struct expression *expr);
 981 struct expression_list *get_conditions(struct expression *expr);
 982 struct sm_state *stored_condition_implication_hook(struct expression *expr,
 983                         struct state_list **true_stack,
 984                         struct state_list **false_stack);
 985
 986 /* check_string_len.c */
 987 int get_formatted_string_size(struct expression *call, int arg);
 988
 989 /* smatch_param_set.c */
 990 int param_was_set(struct expression *expr);
 991 int param_was_set_var_sym(const char *name, struct symbol *sym);
 992 /* smatch_param_filter.c */
 993 int param_has_filter_data(struct sm_state *sm);
 994
 995 /* smatch_links.c */
 996 void set_up_link_functions(int id, int linkid);
 997 struct smatch_state *merge_link_states(struct smatch_state *s1, struct smatch_state *s2);
 998 void store_link(int link_id, const char *name, struct symbol *sym, const char *link_name, struct symbol *link_sym);
 999
1000 /* smatch_auto_copy.c */
1001 void set_auto_copy(int owner);
1002
1003 /* check_buf_comparison */
1004 struct expression *get_size_variable(struct expression *buf);
1005 struct expression *get_array_variable(struct expression *size);
1006
1007 /* smatch_untracked_param.c */
1008 void mark_untracked(struct expression *expr, int param, const char *key, const char *value);
1009 void add_untracked_param_hook(void (func)(struct expression *call, int param));
1010
1011 /* smatch_strings.c */
1012 struct state_list *get_strings(struct expression *expr);
1013
1014 /* smatch_estate.c */
1015 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
1016
1017 /* smatch_address.c */
1018 int get_address_rl(struct expression *expr, struct range_list **rl);
1019 int get_member_offset(struct symbol *type, const char *member_name);
1020 int get_member_offset_from_deref(struct expression *expr);
1021
1022 /* for now this is in smatch_used_parameter.c */
1023 void __get_state_hook(int owner, const char *name, struct symbol *sym);
1024
1025 /* smatch_buf_comparison.c */
1026 int db_var_is_array_limit(struct expression *array, const char *name, struct var_sym_list *vsl);
1027
1028 struct stree *get_all_return_states(void);
1029 struct stree_stack *get_all_return_strees(void);
1030 int on_atomic_dec_path(void);
1031 int was_inced(const char *name, struct symbol *sym);
1032
1033 /* smatch_constraints.c */
1034 char *get_constraint_str(struct expression *expr);
1035 struct constraint_list *get_constraints(struct expression *expr);
1036 char *unmet_constraint(struct expression *data, struct expression *offset);
1037 char *get_required_constraint(const char *data_str);
1038
1039 /* smatch_container_of.c */
1040 int get_param_from_container_of(struct expression *expr);
1041 int get_offset_from_container_of(struct expression *expr);
1042
1043 /* smatch_mtag.c */
1044 int get_toplevel_mtag(struct symbol *sym, mtag_t *tag);
1045 int get_mtag(struct expression *expr, mtag_t *tag);
1046 int create_mtag_alias(mtag_t tag, struct expression *expr, mtag_t *new);
1047 int expr_to_mtag_name_offset(struct expression *expr, mtag_t *tag, char **name, int *offset);
1048
1049 static inline int type_bits(struct symbol *type)
1050 {
1051         if (!type)
1052                 return 0;
1053         if (type->type == SYM_PTR)  /* Sparse doesn't set this for &pointers */
1054                 return bits_in_pointer;
1055         if (type->type == SYM_ARRAY)
1056                 return bits_in_pointer;
1057         if (!type->examined)
1058                 examine_symbol_type(type);
1059         return type->bit_size;
1060 }
1061
1062 static inline int type_unsigned(struct symbol *base_type)
1063 {
1064         if (!base_type)
1065                 return 0;
1066         if (base_type->ctype.modifiers & MOD_UNSIGNED)
1067                 return 1;
1068         return 0;
1069 }
1070
1071 static inline int type_positive_bits(struct symbol *type)
1072 {
1073         if (!type)
1074                 return 0;
1075         if (type->type == SYM_ARRAY)
1076                 return bits_in_pointer - 1;
1077         if (type_unsigned(type))
1078                 return type_bits(type);
1079         return type_bits(type) - 1;
1080 }
1081
1082 static inline int sval_positive_bits(sval_t sval)
1083 {
1084         return type_positive_bits(sval.type);
1085 }
1086
1087 /*
1088  * Returns -1 if one is smaller, 0 if they are the same and 1 if two is larger.
1089  */
1090 static inline int sval_cmp(sval_t one, sval_t two)
1091 {
1092         struct symbol *type;
1093
1094         type = one.type;
1095         if (sval_positive_bits(two) > sval_positive_bits(one))
1096                 type = two.type;
1097         if (type_bits(type) < 31)
1098                 type = &int_ctype;
1099
1100         one = sval_cast(type, one);
1101         two = sval_cast(type, two);
1102
1103         if (type_unsigned(type)) {
1104                 if (one.uvalue < two.uvalue)
1105                         return -1;
1106                 if (one.uvalue == two.uvalue)
1107                         return 0;
1108                 return 1;
1109         }
1110         /* fix me handle type promotion and unsigned values */
1111         if (one.value < two.value)
1112                 return -1;
1113         if (one.value == two.value)
1114                 return 0;
1115         return 1;
1116 }
1117
1118 #endif      /* !SMATCH_H_ */