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 <float.h>
  25 #include <sys/time.h>
  26 #include <sqlite3.h>
  27 #include "lib.h"
  28 #include "allocate.h"
  29 #include "scope.h"
  30 #include "parse.h"
  31 #include "expression.h"
  32 #include "avl.h"
  33 #include "smatch_constants.h"
  34
  35 typedef long long mtag_t;
  36
  37 struct smatch_state {
  38         const char *name;
  39         void *data;
  40 };
  41 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
  42 extern struct smatch_state undefined;
  43 extern struct smatch_state ghost;
  44 extern struct smatch_state merged;
  45 extern struct smatch_state true_state;
  46 extern struct smatch_state false_state;
  47 DECLARE_ALLOCATOR(smatch_state);
  48
  49 static inline void *INT_PTR(int i)
  50 {
  51         return (void *)(long)i;
  52 }
  53
  54 static inline int PTR_INT(void *p)
  55 {
  56         return (int)(long)p;
  57 }
  58
  59 struct tracker {
  60         char *name;
  61         struct symbol *sym;
  62         unsigned short owner;
  63 };
  64 DECLARE_ALLOCATOR(tracker);
  65 DECLARE_PTR_LIST(tracker_list, struct tracker);
  66 DECLARE_PTR_LIST(stree_stack, struct stree);
  67
  68 /* The first 3 struct members must match struct tracker */
  69 struct sm_state {
  70         const char *name;
  71         struct symbol *sym;
  72         unsigned short owner;
  73         unsigned short merged:1;
  74         unsigned int line;
  75         struct smatch_state *state;
  76         struct stree *pool;
  77         struct sm_state *left;
  78         struct sm_state *right;
  79         struct state_list *possible;
  80 };
  81
  82 struct var_sym {
  83         char *var;
  84         struct symbol *sym;
  85 };
  86 DECLARE_ALLOCATOR(var_sym);
  87 DECLARE_PTR_LIST(var_sym_list, struct var_sym);
  88
  89 struct constraint {
  90         int op;
  91         int id;
  92 };
  93 DECLARE_PTR_LIST(constraint_list, struct constraint);
  94
  95 struct alloc_info {
  96         const char *fn;
  97         int size_param, nr;
  98 };
  99 extern struct alloc_info *alloc_funcs;
 100
 101 struct bit_info {
 102         unsigned long long set;
 103         unsigned long long possible;
 104 };
 105
 106 enum hook_type {
 107         EXPR_HOOK,
 108         EXPR_HOOK_AFTER,
 109         STMT_HOOK,
 110         STMT_HOOK_AFTER,
 111         SYM_HOOK,
 112         STRING_HOOK,
 113         DECLARATION_HOOK,
 114         ASSIGNMENT_HOOK,
 115         ASSIGNMENT_HOOK_AFTER,
 116         RAW_ASSIGNMENT_HOOK,
 117         GLOBAL_ASSIGNMENT_HOOK,
 118         LOGIC_HOOK,
 119         CONDITION_HOOK,
 120         PRELOOP_HOOK,
 121         SELECT_HOOK,
 122         WHOLE_CONDITION_HOOK,
 123         FUNCTION_CALL_HOOK_BEFORE,
 124         FUNCTION_CALL_HOOK,
 125         CALL_HOOK_AFTER_INLINE,
 126         FUNCTION_CALL_HOOK_AFTER_DB,
 127         CALL_ASSIGNMENT_HOOK,
 128         MACRO_ASSIGNMENT_HOOK,
 129         BINOP_HOOK,
 130         OP_HOOK,
 131         DEREF_HOOK,
 132         CASE_HOOK,
 133         ASM_HOOK,
 134         CAST_HOOK,
 135         SIZEOF_HOOK,
 136         BASE_HOOK,
 137         FUNC_DEF_HOOK,
 138         AFTER_DEF_HOOK,
 139         END_FUNC_HOOK,
 140         AFTER_FUNC_HOOK,
 141         RETURN_HOOK,
 142         INLINE_FN_START,
 143         INLINE_FN_END,
 144         END_FILE_HOOK,
 145         NUM_HOOKS,
 146 };
 147
 148 #define TRUE 1
 149 #define FALSE 0
 150
 151 struct range_list;
 152
 153 void add_hook(void *func, enum hook_type type);
 154 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
 155 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
 156 void add_merge_hook(int client_id, merge_func_t *func);
 157 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
 158 void add_pre_merge_hook(int client_id, void (*hook)(struct sm_state *cur, struct sm_state *other));
 159 typedef void (scope_hook)(void *data);
 160 void add_scope_hook(scope_hook *hook, void *data);
 161 typedef void (param_key_hook)(struct expression *expr, const char *name, struct symbol *sym, void *data);
 162 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
 163 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
 164                                 struct expression *assign_expr, void *data);
 165 typedef void (return_implies_hook)(struct expression *call_expr,
 166                                    int param, char *key, char *value);
 167 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list **rl);
 168 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
 169
 170 void add_function_assign_hook(const char *look_for, func_hook *call_back,
 171                               void *info);
 172 void register_func_hooks_from_file(const char *file,
 173                                    func_hook *call_back, void *info);
 174 void register_assign_hooks_from_file(const char *file,
 175                                      func_hook *call_back, void *info);
 176 void add_implied_return_hook(const char *look_for,
 177                              implied_return_hook *call_back,
 178                              void *info);
 179 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
 180                               void *info);
 181 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
 182                               void *info);
 183 void return_implies_state(const char *look_for, long long start, long long end,
 184                          implication_hook *call_back, void *info);
 185 void return_implies_state_sval(const char *look_for, sval_t start, sval_t end,
 186                          implication_hook *call_back, void *info);
 187 void return_implies_exact(const char *look_for, sval_t start, sval_t end,
 188                           implication_hook *call_back, void *info);
 189 struct range_list *get_range_implications(const char *fn);
 190 void select_return_states_hook(int type, return_implies_hook *callback);
 191 void select_return_states_before(void (*fn)(void));
 192 void select_return_states_after(void (*fn)(void));
 193 void add_function_param_key_hook(const char *look_for, param_key_hook *call_back,
 194                                  int param, const char *key, void *info);
 195 void return_implies_param_key(const char *look_for, sval_t start, sval_t end,
 196                               param_key_hook *call_back,
 197                               int param, const char *key, void *info);
 198 void return_implies_param_key_exact(const char *look_for, sval_t start, sval_t end,
 199                                     param_key_hook *call_back,
 200                                     int param, const char *key, void *info);
 201 void select_return_param_key(int type, param_key_hook *callback);
 202 int get_implied_return(struct expression *expr, struct range_list **rl);
 203 void allocate_hook_memory(void);
 204 void allocate_tracker_array(int num_checks);
 205
 206 struct modification_data {
 207         struct smatch_state *prev;
 208         struct expression *cur;
 209 };
 210
 211 typedef void (modification_hook)(struct sm_state *sm, struct expression *mod_expr);
 212 bool is_sub_member(const char *name, struct symbol *sym, struct sm_state *sm);
 213 void add_modification_hook(int owner, modification_hook *call_back);
 214 void add_modification_hook_late(int owner, modification_hook *call_back);
 215 struct smatch_state *get_modification_state(struct expression *expr);
 216
 217 int outside_of_function(void);
 218 const char *get_filename(void);
 219 const char *get_base_file(void);
 220 char *get_function(void);
 221 int get_lineno(void);
 222 extern int final_pass;
 223 extern struct symbol *cur_func_sym;
 224 extern int option_debug;
 225 extern int local_debug;
 226 extern int debug_db;
 227 extern bool implied_debug;
 228 bool debug_implied(void);
 229 bool debug_on(const char *check_name, const char *var);
 230 extern int option_info;
 231 extern int option_spammy;
 232 extern int option_print_names;
 233 extern char *trace_variable;
 234 extern struct stree *global_states;
 235 void set_function_skipped(void);
 236 int is_skipped_function(void);
 237 int is_silenced_function(void);
 238 extern bool implications_off;
 239
 240 /* smatch_impossible.c */
 241 int is_impossible_path(void);
 242 void set_path_impossible(void);
 243
 244 extern FILE *sm_outfd;
 245 extern FILE *sql_outfd;
 246 extern FILE *caller_info_fd;
 247 extern int sm_nr_checks;
 248 extern int sm_nr_errors;
 249
 250 /*
 251  * How to use these routines:
 252  *
 253  * sm_fatal(): an internal error of some kind that should immediately exit
 254  * sm_ierror(): an internal error
 255  * sm_perror(): an internal error from parsing input source
 256  * sm_error(): an error from input source
 257  * sm_warning(): a warning from input source
 258  * sm_info(): info message (from option_info)
 259  * sm_debug(): debug message
 260  * sm_msg(): other message (please avoid using this)
 261  */
 262
 263 #define sm_printf(msg...) do {                                          \
 264         if (final_pass || option_debug || local_debug || debug_db)      \
 265                 fprintf(sm_outfd, msg);                                 \
 266 } while (0)
 267
 268 static inline void sm_prefix(void)
 269 {
 270         sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
 271         if (option_info || !option_print_names)
 272                 return;
 273         sm_printf("[smatch.%s] ", __CHECKNAME__);
 274 }
 275
 276 static inline void print_implied_debug_msg();
 277
 278 extern bool __silence_warnings_for_stmt;
 279
 280 #define sm_print_msg(type, msg...) \
 281 do {                                                           \
 282         print_implied_debug_msg();                             \
 283         if (!final_pass && !option_debug && !local_debug && !debug_db)    \
 284                 break;                                         \
 285         if (__silence_warnings_for_stmt && !option_debug && !local_debug) \
 286                 break;                                         \
 287         if (!option_info && is_silenced_function())            \
 288                 break;                                         \
 289         sm_prefix();                                           \
 290         if (type == 1) {                                       \
 291                 sm_printf("warn: ");                           \
 292                 sm_nr_checks++;                                \
 293         } else if (type == 2) {                                \
 294                 sm_printf("error: ");                          \
 295                 sm_nr_checks++;                                \
 296         } else if (type == 3) {                                \
 297                 sm_printf("parse error: ");                    \
 298                 sm_nr_errors++;                                \
 299         }                                                      \
 300         sm_printf(msg);                                        \
 301         sm_printf("\n");                                       \
 302 } while (0)
 303
 304 #define sm_msg(msg...) do { sm_print_msg(0, msg); } while (0)
 305
 306 extern char *implied_debug_msg;
 307 static inline void print_implied_debug_msg(void)
 308 {
 309         static struct symbol *last_printed = NULL;
 310
 311         if (!implied_debug_msg)
 312                 return;
 313         if (last_printed == cur_func_sym)
 314                 return;
 315         last_printed = cur_func_sym;
 316         sm_msg("%s", implied_debug_msg);
 317 }
 318
 319 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
 320 #define db_debug(msg...) do { if (option_debug || debug_db) sm_printf(msg); } while (0)
 321
 322 #define sm_info(msg...) do {                                    \
 323         if (option_debug || (option_info && final_pass)) {      \
 324                 sm_prefix();                                    \
 325                 sm_printf("info: ");                            \
 326                 sm_printf(msg);                                 \
 327                 sm_printf("\n");                                \
 328         }                                                       \
 329 } while(0)
 330
 331 #define sm_warning(msg...) do { sm_print_msg(1, msg); } while (0)
 332 #define sm_error(msg...) do { sm_print_msg(2, msg); } while (0)
 333 #define sm_perror(msg...) do { sm_print_msg(3, msg); } while (0)
 334
 335 static inline void sm_fatal(const char *fmt, ...)
 336 {
 337         va_list args;
 338
 339         va_start(args, fmt);
 340         vfprintf(sm_outfd, fmt, args);
 341         va_end(args);
 342
 343         fprintf(sm_outfd, "\n");
 344
 345         exit(1);
 346 }
 347
 348 static inline void sm_ierror(const char *fmt, ...)
 349 {
 350         va_list args;
 351
 352         sm_nr_errors++;
 353
 354         fprintf(sm_outfd, "internal error: ");
 355
 356         va_start(args, fmt);
 357         vfprintf(sm_outfd, fmt, args);
 358         va_end(args);
 359
 360         fprintf(sm_outfd, "\n");
 361 }
 362 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
 363
 364 bool has_states(int owner);
 365 struct smatch_state *__get_state(int owner, const char *name, struct symbol *sym);
 366 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
 367 struct smatch_state *get_state_expr(int owner, struct expression *expr);
 368 struct state_list *get_possible_states(int owner, const char *name,
 369                                        struct symbol *sym);
 370 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
 371 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
 372                struct smatch_state *state);
 373 struct sm_state *set_state_expr(int owner, struct expression *expr,
 374                 struct smatch_state *state);
 375 void __delete_state(int owner, const char *name, struct symbol *sym);
 376 void __delete_all_states_sym(struct symbol *sym);
 377 void set_true_false_states(int owner, const char *name, struct symbol *sym,
 378                            struct smatch_state *true_state,
 379                            struct smatch_state *false_state);
 380 void set_true_false_states_expr(int owner, struct expression *expr,
 381                            struct smatch_state *true_state,
 382                            struct smatch_state *false_state);
 383
 384 struct stree *get_all_states_from_stree(int owner, struct stree *source);
 385 struct stree *get_all_states_stree(int id);
 386 struct stree *__get_cur_stree(void);
 387 int is_reachable(void);
 388 void add_get_state_hook(void (*fn)(int owner, const char *name, struct symbol *sym));
 389
 390 /* smatch_helper.c */
 391 DECLARE_PTR_LIST(int_stack, int);
 392 char *alloc_string(const char *str);
 393 char *alloc_string_newline(const char *str);
 394 void free_string(char *str);
 395 void append(char *dest, const char *data, int buff_len);
 396 void remove_parens(char *str);
 397 struct smatch_state *alloc_state_num(int num);
 398 struct smatch_state *alloc_state_str(const char *name);
 399 struct smatch_state *merge_str_state(struct smatch_state *s1, struct smatch_state *s2);
 400 struct smatch_state *alloc_state_expr(struct expression *expr);
 401 struct expression *get_argument_from_call_expr(struct expression_list *args,
 402                                                int num);
 403 struct expression *get_array_expr(struct expression *expr);
 404
 405 char *expr_to_var(struct expression *expr);
 406 struct symbol *expr_to_sym(struct expression *expr);
 407 char *expr_to_str(struct expression *expr);
 408 char *expr_to_str_sym(struct expression *expr,
 409                                      struct symbol **sym_ptr);
 410 char *expr_to_var_sym(struct expression *expr,
 411                              struct symbol **sym_ptr);
 412 char *expr_to_known_chunk_sym(struct expression *expr, struct symbol **sym);
 413 char *expr_to_chunk_sym_vsl(struct expression *expr, struct symbol **sym, struct var_sym_list **vsl);
 414 int get_complication_score(struct expression *expr);
 415
 416 int sym_name_is(const char *name, struct expression *expr);
 417 int get_const_value(struct expression *expr, sval_t *sval);
 418 int get_value(struct expression *expr, sval_t *val);
 419 int get_implied_value(struct expression *expr, sval_t *val);
 420 int get_implied_value_fast(struct expression *expr, sval_t *sval);
 421 int get_implied_min(struct expression *expr, sval_t *sval);
 422 int get_implied_max(struct expression *expr, sval_t *val);
 423 int get_hard_max(struct expression *expr, sval_t *sval);
 424 int get_fuzzy_min(struct expression *expr, sval_t *min);
 425 int get_fuzzy_max(struct expression *expr, sval_t *max);
 426 int get_absolute_min(struct expression *expr, sval_t *sval);
 427 int get_absolute_max(struct expression *expr, sval_t *sval);
 428 int parse_call_math(struct expression *expr, char *math, sval_t *val);
 429 int parse_call_math_rl(struct expression *call, const char *math, struct range_list **rl);
 430 const char *get_allocation_math(struct expression *expr);
 431 char *get_value_in_terms_of_parameter_math(struct expression *expr);
 432 char *get_value_in_terms_of_parameter_math_var_sym(const char *var, struct symbol *sym);
 433 int expr_is_zero(struct expression *expr);
 434 int known_condition_true(struct expression *expr);
 435 int known_condition_false(struct expression *expr);
 436 int implied_condition_true(struct expression *expr);
 437 int implied_condition_false(struct expression *expr);
 438 int can_integer_overflow(struct symbol *type, struct expression *expr);
 439 void clear_math_cache(void);
 440 void set_fast_math_only(void);
 441 void clear_fast_math_only(void);
 442
 443 int is_array(struct expression *expr);
 444 struct expression *get_array_base(struct expression *expr);
 445 struct expression *get_array_offset(struct expression *expr);
 446 const char *show_state(struct smatch_state *state);
 447 struct statement *get_expression_statement(struct expression *expr);
 448 struct expression *strip_parens(struct expression *expr);
 449 struct expression *strip_expr(struct expression *expr);
 450 struct expression *strip_expr_set_parent(struct expression *expr);
 451 void scoped_state(int my_id, const char *name, struct symbol *sym);
 452 int is_error_return(struct expression *expr);
 453 int getting_address(struct expression *expr);
 454 int get_struct_and_member(struct expression *expr, const char **type, const char **member);
 455 char *get_member_name(struct expression *expr);
 456 char *get_fnptr_name(struct expression *expr);
 457 int cmp_pos(struct position pos1, struct position pos2);
 458 int positions_eq(struct position pos1, struct position pos2);
 459 struct statement *get_current_statement(void);
 460 struct statement *get_prev_statement(void);
 461 struct expression *get_last_expr_from_expression_stmt(struct expression *expr);
 462
 463 #define RETURN_VAR    -1
 464 #define LOCAL_SCOPE   -2
 465 #define FILE_SCOPE    -3
 466 #define GLOBAL_SCOPE  -4
 467 #define UNKNOWN_SCOPE -5
 468
 469 char *get_param_var_sym_var_sym(const char *name, struct symbol *sym, struct expression *ret_expr, struct symbol **sym_p);
 470 char *get_param_name_sym(struct expression *expr, struct symbol **sym_p);
 471 int get_param_key_from_var_sym(const char *name, struct symbol *sym,
 472                                struct expression *ret_expr,
 473                                const char **key);
 474 int get_param_key_from_sm(struct sm_state *sm, struct expression *ret_expr,
 475                           const char **key);
 476 int map_to_param(const char *name, struct symbol *sym);
 477 int get_param_num_from_sym(struct symbol *sym);
 478 int get_param_num(struct expression *expr);
 479 struct symbol *get_param_sym_from_num(int num);
 480
 481 int ms_since(struct timeval *start);
 482 int parent_is_gone_var_sym(const char *name, struct symbol *sym);
 483 int parent_is_gone(struct expression *expr);
 484 bool is_noderef_ptr(struct expression *expr);
 485 int invert_op(int op);
 486 int op_remove_assign(int op);
 487 int expr_equiv(struct expression *one, struct expression *two);
 488 void push_int(struct int_stack **stack, int num);
 489 int pop_int(struct int_stack **stack);
 490
 491 /* smatch_type.c */
 492 struct symbol *get_real_base_type(struct symbol *sym);
 493 int type_bytes(struct symbol *type);
 494 int array_bytes(struct symbol *type);
 495 struct symbol *get_pointer_type(struct expression *expr);
 496 struct symbol *get_type(struct expression *expr);
 497 struct symbol *get_final_type(struct expression *expr);
 498 struct symbol *get_promoted_type(struct symbol *left, struct symbol *right);
 499 int type_signed(struct symbol *base_type);
 500 int expr_unsigned(struct expression *expr);
 501 int expr_signed(struct expression *expr);
 502 int returns_unsigned(struct symbol *base_type);
 503 int is_pointer(struct expression *expr);
 504 int returns_pointer(struct symbol *base_type);
 505 sval_t sval_type_max(struct symbol *base_type);
 506 sval_t sval_type_min(struct symbol *base_type);
 507 int nr_bits(struct expression *expr);
 508 int is_void_pointer(struct expression *expr);
 509 int is_char_pointer(struct expression *expr);
 510 int is_string(struct expression *expr);
 511 bool is_struct_ptr(struct symbol *type);
 512 int is_static(struct expression *expr);
 513 bool is_local_variable(struct expression *expr);
 514 int types_equiv(struct symbol *one, struct symbol *two);
 515 bool type_fits(struct symbol *type, struct symbol *test);
 516 int fn_static(void);
 517 const char *global_static();
 518 struct symbol *cur_func_return_type(void);
 519 struct symbol *get_arg_type(struct expression *fn, int arg);
 520 struct symbol *get_member_type_from_key(struct expression *expr, const char *key);
 521 struct symbol *get_arg_type_from_key(struct expression *fn, int param, struct expression *arg, const char *key);
 522 int is_struct(struct expression *expr);
 523 char *type_to_str(struct symbol *type);
 524
 525 /* smatch_ignore.c */
 526 void add_ignore(int owner, const char *name, struct symbol *sym);
 527 int is_ignored(int owner, const char *name, struct symbol *sym);
 528 void add_ignore_expr(int owner, struct expression *expr);
 529 int is_ignored_expr(int owner, struct expression *expr);
 530
 531 /* smatch_var_sym */
 532 struct smatch_state *alloc_var_sym_state(const char *var, struct symbol *sym);
 533 struct var_sym *alloc_var_sym(const char *var, struct symbol *sym);
 534 struct var_sym_list *expr_to_vsl(struct expression *expr);
 535 void add_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
 536 void add_var_sym_expr(struct var_sym_list **list, struct expression *expr);
 537 void del_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
 538 int in_var_sym_list(struct var_sym_list *list, const char *var, struct symbol *sym);
 539 struct var_sym_list *clone_var_sym_list(struct var_sym_list *from_vsl);
 540 void merge_var_sym_list(struct var_sym_list **dest, struct var_sym_list *src);
 541 struct var_sym_list *combine_var_sym_lists(struct var_sym_list *one, struct var_sym_list *two);
 542 int var_sym_lists_equiv(struct var_sym_list *one, struct var_sym_list *two);
 543 void free_var_sym_list(struct var_sym_list **list);
 544 void free_var_syms_and_list(struct var_sym_list **list);
 545
 546 /* smatch_tracker */
 547 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
 548 void add_tracker(struct tracker_list **list, int owner, const char *name,
 549                 struct symbol *sym);
 550 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
 551 void del_tracker(struct tracker_list **list, int owner, const char *name,
 552                 struct symbol *sym);
 553 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
 554                 struct symbol *sym);
 555 void free_tracker_list(struct tracker_list **list);
 556 void free_trackers_and_list(struct tracker_list **list);
 557
 558 /* smatch_conditions */
 559 int in_condition(void);
 560
 561 /* smatch_flow.c */
 562
 563 extern int __in_fake_assign;
 564 extern int __in_fake_parameter_assign;
 565 extern int __in_fake_struct_assign;
 566 extern int __in_fake_var_assign;
 567 extern int __fake_state_cnt;
 568 extern int in_fake_env;
 569 void smatch (struct string_list *filelist);
 570 int inside_loop(void);
 571 int definitely_inside_loop(void);
 572 struct expression *get_switch_expr(void);
 573 int in_expression_statement(void);
 574 void __process_post_op_stack(void);
 575 void __split_expr(struct expression *expr);
 576 void __split_label_stmt(struct statement *stmt);
 577 void __split_stmt(struct statement *stmt);
 578 extern int __in_function_def;
 579 extern int __in_unmatched_hook;
 580 extern int option_assume_loops;
 581 extern int option_two_passes;
 582 extern int option_no_db;
 583 extern int option_file_output;
 584 extern int option_time;
 585 extern int option_time_stmt;
 586 extern struct expression_list *big_expression_stack;
 587 extern struct expression_list *big_condition_stack;
 588 extern struct statement_list *big_statement_stack;
 589 int is_assigned_call(struct expression *expr);
 590 int is_fake_assigned_call(struct expression *expr);
 591 void add_function_data(unsigned long *fn_data);
 592 int inlinable(struct expression *expr);
 593 extern int __inline_call;
 594 extern struct expression *__inline_fn;
 595 extern int __in_pre_condition;
 596 extern int __bail_on_rest_of_function;
 597 extern struct statement *__prev_stmt;
 598 extern struct statement *__cur_stmt;
 599 extern struct statement *__next_stmt;
 600 void init_fake_env(void);
 601 void end_fake_env(void);
 602 int time_parsing_function(void);
 603 bool taking_too_long(void);
 604 int is_last_stmt(struct statement *cur_stmt);
 605
 606 /* smatch_struct_assignment.c */
 607 struct expression *get_faked_expression(void);
 608 void __fake_struct_member_assignments(struct expression *expr);
 609
 610 /* smatch_project.c */
 611 int is_no_inline_function(const char *function);
 612
 613 /* smatch_conditions */
 614 void __split_whole_condition(struct expression *expr);
 615 void __handle_logic(struct expression *expr);
 616 int is_condition(struct expression *expr);
 617 int __handle_condition_assigns(struct expression *expr);
 618 int __handle_select_assigns(struct expression *expr);
 619 int __handle_expr_statement_assigns(struct expression *expr);
 620
 621 /* smatch_implied.c */
 622 struct range_list_stack;
 623 void param_limit_implications(struct expression *expr, int param, char *key, char *value, struct stree **implied);
 624 struct stree *__implied_case_stree(struct expression *switch_expr,
 625                                    struct range_list *case_rl,
 626                                    struct range_list_stack **remaining_cases,
 627                                    struct stree **raw_stree);
 628 void overwrite_states_using_pool(struct sm_state *gate_sm, struct sm_state *pool_sm);
 629 int assume(struct expression *expr);
 630 void end_assume(void);
 631 int impossible_assumption(struct expression *left, int op, sval_t sval);
 632
 633 /* smatch_slist.h */
 634 bool has_dynamic_states(unsigned short owner);
 635 void set_dynamic_states(unsigned short owner);
 636
 637 /* smatch_extras.c */
 638 int in_warn_on_macro(void);
 639 #define SMATCH_EXTRA 5 /* this is my_id from smatch extra set in smatch.c */
 640 extern int RETURN_ID;
 641
 642 struct data_range {
 643         sval_t min;
 644         sval_t max;
 645 };
 646
 647 #define MTAG_ALIAS_BIT (1ULL << 63)
 648 #define MTAG_OFFSET_MASK 0xfffULL
 649 #define MTAG_SEED 0xdead << 12
 650
 651 const extern unsigned long valid_ptr_min;
 652 extern unsigned long valid_ptr_max;
 653 extern const sval_t valid_ptr_min_sval;
 654 extern sval_t valid_ptr_max_sval;
 655 extern struct range_list *valid_ptr_rl;
 656 void alloc_valid_ptr_rl(void);
 657
 658 static const sval_t array_min_sval = {
 659         .type = &ptr_ctype,
 660         {.value = 100000},
 661 };
 662 static const sval_t array_max_sval = {
 663         .type = &ptr_ctype,
 664         {.value = ULONG_MAX - 4095},
 665 };
 666 static const sval_t text_seg_min = {
 667         .type = &ptr_ctype,
 668         {.value = 4096},
 669 };
 670 static const sval_t text_seg_max = {
 671         .type = &ptr_ctype,
 672         {.value = ULONG_MAX - 4095},
 673 };
 674 static const sval_t data_seg_min = {
 675         .type = &ptr_ctype,
 676         {.value = 4096},
 677 };
 678 static const sval_t data_seg_max = {
 679         .type = &ptr_ctype,
 680         {.value = ULONG_MAX - 4095},
 681 };
 682 static const sval_t bss_seg_min = {
 683         .type = &ptr_ctype,
 684         {.value = 4096},
 685 };
 686 static const sval_t bss_seg_max = {
 687         .type = &ptr_ctype,
 688         {.value = ULONG_MAX - 4095},
 689 };
 690 static const sval_t stack_seg_min = {
 691         .type = &ptr_ctype,
 692         {.value = 4096},
 693 };
 694 static const sval_t stack_seg_max = {
 695         .type = &ptr_ctype,
 696         {.value = ULONG_MAX - 4095},
 697 };
 698 static const sval_t kmalloc_seg_min = {
 699         .type = &ptr_ctype,
 700         {.value = 4096},
 701 };
 702 static const sval_t kmalloc_seg_max = {
 703         .type = &ptr_ctype,
 704         {.value = ULONG_MAX - 4095},
 705 };
 706 static const sval_t vmalloc_seg_min = {
 707         .type = &ptr_ctype,
 708         {.value = 4096},
 709 };
 710 static const sval_t vmalloc_seg_max = {
 711         .type = &ptr_ctype,
 712         {.value = ULONG_MAX - 4095},
 713 };
 714 static const sval_t fn_ptr_min = {
 715         .type = &ptr_ctype,
 716         {.value = 4096},
 717 };
 718 static const sval_t fn_ptr_max = {
 719         .type = &ptr_ctype,
 720         {.value = ULONG_MAX - 4095},
 721 };
 722
 723 char *get_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
 724 char *map_call_to_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
 725 char *map_long_to_short_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym, bool use_stack);
 726
 727 #define STRLEN_MAX_RET 1010101
 728
 729 /* smatch_absolute.c */
 730 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
 731 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
 732
 733 /* smatch_type_value.c */
 734 void clear_type_value_cache(void);
 735 int get_db_type_rl(struct expression *expr, struct range_list **rl);
 736
 737 /* smatch_data_val.c */
 738 int get_mtag_rl(struct expression *expr, struct range_list **rl);
 739 /* smatch_array_values.c */
 740 int get_array_rl(struct expression *expr, struct range_list **rl);
 741
 742 /* smatch_states.c */
 743 struct stree *__swap_cur_stree(struct stree *stree);
 744 void __push_fake_cur_stree();
 745 struct stree *__pop_fake_cur_stree();
 746 void __free_fake_cur_stree();
 747 void __set_fake_cur_stree_fast(struct stree *stree);
 748 void __pop_fake_cur_stree_fast(void);
 749 void __merge_stree_into_cur(struct stree *stree);
 750
 751 int unreachable(void);
 752 void __set_cur_stree_readonly(void);
 753 void __set_cur_stree_writable(void);
 754 void __set_sm(struct sm_state *sm);
 755 void __set_sm_cur_stree(struct sm_state *sm);
 756 void __set_sm_fake_stree(struct sm_state *sm);
 757 void __set_true_false_sm(struct sm_state *true_state,
 758                         struct sm_state *false_state);
 759 void nullify_path(void);
 760 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 761                                void *unused);
 762 void __unnullify_path(void);
 763 int __path_is_null(void);
 764 void save_all_states(void);
 765 void restore_all_states(void);
 766 void free_goto_stack(void);
 767 void clear_all_states(void);
 768
 769 struct sm_state *get_sm_state(int owner, const char *name,
 770                                 struct symbol *sym);
 771 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
 772 void __push_true_states(void);
 773 void __use_false_states(void);
 774 void __discard_false_states(void);
 775 void __merge_false_states(void);
 776 void __merge_true_states(void);
 777
 778 void __negate_cond_stacks(void);
 779 void __use_pre_cond_states(void);
 780 void __use_cond_true_states(void);
 781 void __use_cond_false_states(void);
 782 void __push_cond_stacks(void);
 783 void __fold_in_set_states(void);
 784 void __free_set_states(void);
 785 struct stree *__copy_cond_true_states(void);
 786 struct stree *__copy_cond_false_states(void);
 787 struct stree *__pop_cond_true_stack(void);
 788 struct stree *__pop_cond_false_stack(void);
 789 void __and_cond_states(void);
 790 void __or_cond_states(void);
 791 void __save_pre_cond_states(void);
 792 void __discard_pre_cond_states(void);
 793 struct stree *__get_true_states(void);
 794 struct stree *__get_false_states(void);
 795 void __use_cond_states(void);
 796 extern struct state_list *__last_base_slist;
 797
 798 void __push_continues(void);
 799 void __discard_continues(void);
 800 void __process_continues(void);
 801 void __merge_continues(void);
 802
 803 void __push_breaks(void);
 804 void __process_breaks(void);
 805 int __has_breaks(void);
 806 void __merge_breaks(void);
 807 void __use_breaks(void);
 808
 809 void __save_switch_states(struct expression *switch_expr);
 810 void __discard_switches(void);
 811 int have_remaining_cases(void);
 812 void __merge_switches(struct expression *switch_expr, struct range_list *case_rl);
 813 void __push_default(void);
 814 void __set_default(void);
 815 int __pop_default(void);
 816
 817 void __push_conditions(void);
 818 void __discard_conditions(void);
 819
 820 void __save_gotos(const char *name, struct symbol *sym);
 821 void __merge_gotos(const char *name, struct symbol *sym);
 822
 823 void __discard_fake_states(struct expression *call);
 824
 825 void __print_cur_stree(void);
 826 bool __print_states(const char *owner);
 827 typedef void (check_tracker_hook)(int owner, const char *name, struct symbol *sym, struct smatch_state *state);
 828 void add_check_tracker(const char *check_name, check_tracker_hook *fn);
 829
 830 /* smatch_hooks.c */
 831 void __pass_to_client(void *data, enum hook_type type);
 832 void __pass_case_to_client(struct expression *switch_expr,
 833                            struct range_list *rl);
 834 int __has_merge_function(int client_id);
 835 struct smatch_state *__client_merge_function(int owner,
 836                                              struct smatch_state *s1,
 837                                              struct smatch_state *s2);
 838 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 839 void call_pre_merge_hook(struct sm_state *cur, struct sm_state *other);
 840 void __push_scope_hooks(void);
 841 void __call_scope_hooks(void);
 842
 843 /* smatch_function_hooks.c */
 844 void create_function_hook_hash(void);
 845 void __match_initializer_call(struct symbol *sym);
 846
 847 /* smatch_db.c */
 848 enum info_type {
 849         INTERNAL        = 0,
 850         /*
 851          * Changing these numbers is a pain.  Don't do it.  If you ever use a
 852          * number it can't be re-used right away so there may be gaps.
 853          * We select these in order by type so if the order matters, then give
 854          * it a number below 100-999,9000-9999 ranges. */
 855
 856         PARAM_CLEARED   = 101,
 857         PARAM_LIMIT     = 103,
 858         PARAM_FILTER    = 104,
 859
 860         PARAM_VALUE     = 1001,
 861         BUF_SIZE        = 1002,
 862         CAPPED_DATA     = 1004,
 863         RETURN_VALUE    = 1005,
 864         DEREFERENCE     = 1006,
 865         RANGE_CAP       = 1007,
 866         ABSOLUTE_LIMITS = 1010,
 867         PARAM_ADD       = 1012,
 868         PARAM_FREED     = 1013,
 869         MAYBE_FREED     = 2014,
 870         DATA_SOURCE     = 1014,
 871         FUZZY_MAX       = 1015,
 872         HARD_MAX        = 2015,
 873         STR_LEN         = 1016,
 874         ARRAY_LEN       = 1017,
 875         CAPABLE         = 1018,
 876         NS_CAPABLE      = 1019,
 877         CONTAINER       = 1020,
 878         CASTED_CALL     = 1021,
 879         TYPE_LINK       = 1022,
 880         UNTRACKED_PARAM = 1023,
 881         LOST_PARAM      = 2023,
 882         CULL_PATH       = 1024,
 883         PARAM_SET       = 1025,
 884         PARAM_USED      = 1026,
 885         BYTE_UNITS      = 1027,
 886         COMPARE_LIMIT   = 1028,
 887         PARAM_COMPARE   = 1029,
 888         CONSTRAINT      = 1031,
 889         PASSES_TYPE     = 1032,
 890         CONSTRAINT_REQUIRED = 1033,
 891         BIT_INFO        = 1034,
 892         NOSPEC          = 1035,
 893         NOSPEC_WB       = 1036,
 894         STMT_CNT        = 1037,
 895         TERMINATED      = 1038,
 896         FRESH_ALLOC     = 1044,
 897         ALLOCATOR       = 1045,
 898         FUNC_TIME       = 1047,
 899
 900         /* put random temporary stuff in the 7000-7999 range for testing */
 901         USER_DATA       = 8017,
 902         USER_DATA_SET   = 9017,
 903         USER_PTR        = 9018,
 904         USER_PTR_SET    = 9019,
 905         NO_OVERFLOW     = 8018,
 906         NO_OVERFLOW_SIMPLE = 8019,
 907         LOCK            = 8020,
 908         UNLOCK          = 8021,
 909         HALF_LOCKED     = 9022,
 910         RESTORE         = 9023,
 911         KNOWN_LOCKED    = 9024,
 912         KNOWN_UNLOCKED  = 9025,
 913         IGNORE_LOCK     = 9026,
 914         SET_FS          = 8022,
 915         ATOMIC_INC      = 8023,
 916         ATOMIC_DEC      = 8024,
 917         REFCOUNT        = 9025,
 918         NO_SIDE_EFFECT  = 8025,
 919         FN_ARG_LINK     = 8028,
 920         DATA_VALUE      = 8029,
 921         ARRAYSIZE_ARG   = 8033,
 922         SIZEOF_ARG      = 8034,
 923         MEMORY_TAG      = 8036,
 924         MTAG_ASSIGN     = 8035,
 925         STRING_VALUE    = 8041,
 926         ALLOC           = 8045,
 927         RELEASE         = 8046,
 928
 929         BYTE_COUNT      = 8050,
 930         ELEM_COUNT      = 8051,
 931         ELEM_LAST       = 8052,
 932         USED_LAST       = 8053,
 933         USED_COUNT      = 8054,
 934 };
 935
 936 extern struct sqlite3 *smatch_db;
 937 extern struct sqlite3 *mem_db;
 938 extern struct sqlite3 *cache_db;
 939
 940 bool db_incomplete(void);
 941 void db_ignore_states(int id);
 942 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
 943 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
 944 void add_caller_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
 945 void add_return_info_callback(int owner,
 946                               void (*callback)(int return_id, char *return_ranges,
 947                                                struct expression *returned_expr,
 948                                                int param,
 949                                                const char *printed_name,
 950                                                struct sm_state *sm));
 951 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr));
 952 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));
 953 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
 954 void select_return_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
 955 struct range_list *db_return_vals(struct expression *expr);
 956 struct range_list *db_return_vals_from_str(const char *fn_name);
 957 struct range_list *db_return_vals_no_args(struct expression *expr);
 958 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl);
 959 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym);
 960 char *get_name_sym_from_key(struct expression *expr, int param, const char *key, struct symbol **sym);
 961 char *get_param_name_var_sym(const char *name, struct symbol *sym);
 962 char *get_param_name(struct sm_state *sm);
 963 const char *get_mtag_name_var_sym(const char *state_name, struct symbol *sym);
 964 const char *get_mtag_name_expr(struct expression *expr);
 965 char *get_data_info_name(struct expression *expr);
 966 char *sm_to_arg_name(struct expression *expr, struct sm_state *sm);
 967 int is_recursive_member(const char *param_name);
 968
 969 char *escape_newlines(const char *str);
 970 void sql_exec(struct sqlite3 *db, int (*callback)(void*, int, char**, char**), void *data, const char *sql);
 971
 972 #define sql_helper(db, call_back, data, sql...)                                 \
 973 do {                                                                            \
 974         char sql_txt[1024];                                                     \
 975                                                                                 \
 976         sqlite3_snprintf(sizeof(sql_txt), sql_txt, sql);                        \
 977         db_debug("debug: %s\n", sql_txt);                                       \
 978         sql_exec(db, call_back, data, sql_txt);                                 \
 979 } while (0)
 980
 981
 982 #define run_sql(call_back, data, sql...)                                        \
 983 do {                                                                            \
 984         if (option_no_db)                                                       \
 985                 break;                                                          \
 986         sql_helper(smatch_db, call_back, data, sql);                            \
 987 } while (0)
 988
 989 #define mem_sql(call_back, data, sql...)                                        \
 990         sql_helper(mem_db, call_back, data, sql)
 991
 992 #define cache_sql(call_back, data, sql...)                                      \
 993         sql_helper(cache_db, call_back, data, sql)
 994
 995 #define sql_insert_helper(table, db, ignore, late, values...)                   \
 996 do {                                                                            \
 997         struct sqlite3 *_db = db;                                               \
 998                                                                                 \
 999         if (__inline_fn && !_db)                                                \
1000                 _db = mem_db;                                                   \
1001         if (_db) {                                                              \
1002                 char buf[1024];                                                 \
1003                 char *err, *p = buf;                                            \
1004                 int rc;                                                         \
1005                                                                                 \
1006                 p += snprintf(p, buf + sizeof(buf) - p,                         \
1007                               "insert %sinto %s values (",                      \
1008                               ignore ? "or ignore " : "", #table);              \
1009                 p += snprintf(p, buf + sizeof(buf) - p, values);                \
1010                 p += snprintf(p, buf + sizeof(buf) - p, ");");                  \
1011                 db_debug("mem-db: %s\n", buf);                                  \
1012                 rc = sqlite3_exec(_db, buf, NULL, NULL, &err);                  \
1013                 if (rc != SQLITE_OK) {                                          \
1014                         sm_ierror("SQL error #2: %s", err);                     \
1015                         sm_ierror("SQL: '%s'", buf);                            \
1016                         parse_error = 1;                                        \
1017                 }                                                               \
1018                 break;                                                          \
1019         }                                                                       \
1020         if (option_info) {                                                      \
1021                 FILE *tmp_fd = sm_outfd;                                        \
1022                 sm_outfd = sql_outfd;                                           \
1023                 sm_prefix();                                                    \
1024                 sm_printf("SQL%s: insert %sinto " #table " values(",            \
1025                           late ? "_late" : "", ignore ? "or ignore " : "");     \
1026                 sm_printf(values);                                              \
1027                 sm_printf(");\n");                                              \
1028                 sm_outfd = tmp_fd;                                              \
1029         }                                                                       \
1030 } while (0)
1031
1032 #define sql_insert(table, values...) sql_insert_helper(table, 0, 0, 0, values);
1033 #define sql_insert_or_ignore(table, values...) sql_insert_helper(table, 0, 1, 0, values);
1034 #define sql_insert_late(table, values...) sql_insert_helper(table, 0, 0, 1, values);
1035 #define sql_insert_cache(table, values...) sql_insert_helper(table, cache_db, 1, 0, values);
1036
1037 char *get_static_filter(struct symbol *sym);
1038
1039 void sql_insert_return_states(int return_id, const char *return_ranges,
1040                 int type, int param, const char *key, const char *value);
1041 void sql_insert_caller_info(struct expression *call, int type, int param,
1042                 const char *key, const char *value);
1043 void sql_insert_function_ptr(const char *fn, const char *struct_name);
1044 void sql_insert_return_values(const char *return_values);
1045 void sql_insert_return_implies(int type, int param, const char *key, const char *value);
1046 void sql_insert_function_type_size(const char *member, const char *ranges);
1047 void sql_insert_function_type_info(int type, const char *struct_type, const char *member, const char *value);
1048 void sql_insert_type_info(int type, const char *member, const char *value);
1049 void sql_insert_local_values(const char *name, const char *value);
1050 void sql_insert_function_type_value(const char *type, const char *value);
1051 void sql_insert_function_type(int param, const char *value);
1052 void sql_insert_parameter_name(int param, const char *value);
1053 void sql_insert_data_info(struct expression *data, int type, const char *value);
1054 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value);
1055 void sql_save_constraint(const char *con);
1056 void sql_save_constraint_required(const char *data, int op, const char *limit);
1057 void sql_copy_constraint_required(const char *new_limit, const char *old_limit);
1058 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data);
1059 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value);
1060 void sql_insert_mtag_about(mtag_t tag, const char *left_name, const char *right_name);
1061 void sql_insert_mtag_info(mtag_t tag, int type, const char *value);
1062 void sql_insert_mtag_map(mtag_t container, int container_offset, mtag_t tag, int tag_offset);
1063 void sql_insert_mtag_alias(mtag_t orig, mtag_t alias);
1064 int mtag_map_select_container(mtag_t tag, int container_offset, mtag_t *container);
1065 int mtag_map_select_tag(mtag_t container, int offset, mtag_t *tag);
1066 struct smatch_state *get_mtag_return(struct expression *expr, struct smatch_state *state);
1067 struct range_list *swap_mtag_seed(struct expression *expr, struct range_list *rl);
1068
1069 void sql_select_return_states(const char *cols, struct expression *call,
1070         int (*callback)(void*, int, char**, char**), void *info);
1071 void sql_select_call_implies(const char *cols, struct expression *call,
1072         int (*callback)(void*, int, char**, char**));
1073
1074 void open_smatch_db(char *db_file);
1075
1076 /* smatch_files.c */
1077 int open_data_file(const char *filename);
1078 int open_schema_file(const char *schema);
1079 struct token *get_tokens_file(const char *filename);
1080 struct string_list *load_strings_from_file(const char *project, const char *filename);
1081
1082 /* smatch.c */
1083 extern char *option_debug_check;
1084 extern char *option_debug_var;
1085 extern char *option_project_str;
1086 extern char *bin_dir;
1087 extern char *data_dir;
1088 extern int option_no_data;
1089 extern int option_full_path;
1090 extern int option_call_tree;
1091 extern int num_checks;
1092
1093 enum project_type {
1094         PROJ_NONE,
1095         PROJ_KERNEL,
1096         PROJ_WINE,
1097         PROJ_ILLUMOS_KERNEL,
1098         PROJ_ILLUMOS_USER,
1099         PROJ_UNKNOWN,
1100 };
1101 extern enum project_type option_project;
1102 const char *check_name(unsigned short id);
1103 int id_from_name(const char *name);
1104
1105
1106 /* smatch_buf_size.c */
1107 int get_array_size(struct expression *expr);
1108 int get_array_size_bytes(struct expression *expr);
1109 int get_array_size_bytes_min(struct expression *expr);
1110 int get_array_size_bytes_max(struct expression *expr);
1111 struct range_list *get_array_size_bytes_rl(struct expression *expr);
1112 int get_real_array_size(struct expression *expr);
1113 int last_member_is_resizable(struct symbol *type);
1114 /* smatch_strlen.c */
1115 int get_implied_strlen(struct expression *expr, struct range_list **rl);
1116 int get_size_from_strlen(struct expression *expr);
1117
1118 /* smatch_capped.c */
1119 int is_capped(struct expression *expr);
1120 int is_capped_var_sym(const char *name, struct symbol *sym);
1121
1122 /* smatch_kernel_user_data.c */
1123 int is_user_macro(struct expression *expr);
1124 int is_capped_user_data(struct expression *expr);
1125 int implied_user_data(struct expression *expr, struct range_list **rl);
1126 struct stree *get_user_stree(void);
1127 int get_user_rl(struct expression *expr, struct range_list **rl);
1128 int is_user_rl(struct expression *expr);
1129 int get_user_rl_var_sym(const char *name, struct symbol *sym, struct range_list **rl);
1130 bool user_rl_capped(struct expression *expr);
1131 struct range_list *var_user_rl(struct expression *expr);
1132 bool we_pass_user_data(struct expression *call);
1133 /* smatch_points_to_user_data.c */
1134 bool is_user_data_fn(struct symbol *fn);
1135 bool is_skb_data(struct expression *expr);
1136 bool points_to_user_data(struct expression *expr);
1137 void set_points_to_user_data(struct expression *expr);
1138
1139 /* check_locking.c */
1140 void print_held_locks();
1141
1142 /* check_assigned_expr.c */
1143 extern int check_assigned_expr_id;
1144 struct expression *get_assigned_expr(struct expression *expr);
1145 struct sm_state *get_assigned_sm(struct expression *expr);
1146 struct expression *get_assigned_expr_recurse(struct expression *expr);
1147 struct expression *get_assigned_expr_name_sym(const char *name, struct symbol *sym);
1148 struct expression *get_assigned_expr_name_sym_recurse(const char *name, struct symbol *sym);
1149
1150 /* smatch_return_to_param.c */
1151 void __add_return_to_param_mapping(struct expression *assign, const char *return_string);
1152 char *map_call_to_param_name_sym(struct expression *expr, struct symbol **sym);
1153
1154 /* smatch_comparison.c */
1155 extern int comparison_id;
1156 #define UNKNOWN_COMPARISON 0
1157 #define IMPOSSIBLE_COMPARISON -1
1158 struct compare_data {
1159         /* The ->left and ->right expression pointers might be NULL (I'm lazy) */
1160         struct expression *left;
1161         const char *left_var;
1162         struct var_sym_list *left_vsl;
1163         int comparison;
1164         struct expression *right;
1165         const char *right_var;
1166         struct var_sym_list *right_vsl;
1167 };
1168 DECLARE_ALLOCATOR(compare_data);
1169 struct smatch_state *alloc_compare_state(
1170                 struct expression *left,
1171                 const char *left_var, struct var_sym_list *left_vsl,
1172                 int comparison,
1173                 struct expression *right,
1174                 const char *right_var, struct var_sym_list *right_vsl);
1175 int comparison_intersection(int orig, int op);
1176 int merge_comparisons(int one, int two);
1177 int combine_comparisons(int left_compare, int right_compare);
1178 int state_to_comparison(struct smatch_state *state);
1179 struct smatch_state *merge_compare_states(struct smatch_state *s1, struct smatch_state *s2);
1180 int get_comparison(struct expression *left, struct expression *right);
1181 int get_comparison_no_extra(struct expression *a, struct expression *b);
1182 int get_comparison_strings(const char *one, const char *two);
1183 int possible_comparison(struct expression *a, int comparison, struct expression *b);
1184 struct state_list *get_all_comparisons(struct expression *expr);
1185 struct state_list *get_all_possible_equal_comparisons(struct expression *expr);
1186 void __add_return_comparison(struct expression *call, const char *range);
1187 void __add_comparison_info(struct expression *expr, struct expression *call, const char *range);
1188 char *get_printed_param_name(struct expression *call, const char *param_name, struct symbol *param_sym);
1189 char *name_sym_to_param_comparison(const char *name, struct symbol *sym);
1190 char *expr_equal_to_param(struct expression *expr, int ignore);
1191 char *expr_lte_to_param(struct expression *expr, int ignore);
1192 char *expr_param_comparison(struct expression *expr, int ignore);
1193 int flip_comparison(int op);
1194 int negate_comparison(int op);
1195 int remove_unsigned_from_comparison(int op);
1196 int param_compare_limit_is_impossible(struct expression *expr, int left_param, char *left_key, char *value);
1197 void filter_by_comparison(struct range_list **rl, int comparison, struct range_list *right);
1198 void __compare_param_limit_hook(struct expression *left_expr, struct expression *right_expr,
1199                                 const char *state_name,
1200                                 struct smatch_state *true_state, struct smatch_state *false_state);
1201 int impossibly_high_comparison(struct expression *expr);
1202
1203 /* smatch_sval.c */
1204 sval_t *sval_alloc(sval_t sval);
1205 sval_t *sval_alloc_permanent(sval_t sval);
1206 sval_t sval_blank(struct expression *expr);
1207 sval_t sval_type_val(struct symbol *type, long long val);
1208 sval_t sval_type_fval(struct symbol *type, long double fval);
1209 sval_t sval_from_val(struct expression *expr, long long val);
1210 sval_t sval_from_fval(struct expression *expr, long double fval);
1211 int sval_is_ptr(sval_t sval);
1212 bool sval_is_fp(sval_t sval);
1213 int sval_unsigned(sval_t sval);
1214 int sval_signed(sval_t sval);
1215 int sval_bits(sval_t sval);
1216 int sval_bits_used(sval_t sval);
1217 int sval_is_negative(sval_t sval);
1218 int sval_is_positive(sval_t sval);
1219 int sval_is_min(sval_t sval);
1220 int sval_is_max(sval_t sval);
1221 int sval_is_a_min(sval_t sval);
1222 int sval_is_a_max(sval_t sval);
1223 int sval_is_negative_min(sval_t sval);
1224 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
1225 int sval_cmp_val(sval_t one, long long val);
1226 sval_t sval_min(sval_t one, sval_t two);
1227 sval_t sval_min_nonneg(sval_t one, sval_t two);
1228 sval_t sval_max(sval_t one, sval_t two);
1229 int sval_too_low(struct symbol *type, sval_t sval);
1230 int sval_too_high(struct symbol *type, sval_t sval);
1231 int sval_fits(struct symbol *type, sval_t sval);
1232 sval_t sval_cast(struct symbol *type, sval_t sval);
1233 sval_t sval_preop(sval_t sval, int op);
1234 sval_t sval_binop(sval_t left, int op, sval_t right);
1235 int sval_binop_overflows(sval_t left, int op, sval_t right);
1236 int sval_binop_overflows_no_sign(sval_t left, int op, sval_t right);
1237 int find_first_zero_bit(unsigned long long uvalue);
1238 int sm_fls64(unsigned long long uvalue);
1239 unsigned long long fls_mask(unsigned long long uvalue);
1240 unsigned long long sval_fls_mask(sval_t sval);
1241 const char *sval_to_str(sval_t sval);
1242 const char *sval_to_str_or_err_ptr(sval_t sval);
1243 const char *sval_to_numstr(sval_t sval);
1244 sval_t ll_to_sval(long long val);
1245
1246 /* smatch_string_list.c */
1247 int list_has_string(struct string_list *str_list, const char *str);
1248 int insert_string(struct string_list **str_list, const char *str);
1249 struct string_list *clone_str_list(struct string_list *orig);
1250 struct string_list *combine_string_lists(struct string_list *one, struct string_list *two);
1251
1252 /* smatch_start_states.c */
1253 struct stree *get_start_states(void);
1254
1255 /* smatch_recurse.c */
1256 int has_symbol(struct expression *expr, struct symbol *sym);
1257 int has_variable(struct expression *expr, struct expression *var);
1258 int has_inc_dec(struct expression *expr);
1259
1260 /* smatch_stored_conditions.c */
1261 struct smatch_state *get_stored_condition(struct expression *expr);
1262 struct expression_list *get_conditions(struct expression *expr);
1263 struct sm_state *stored_condition_implication_hook(struct expression *expr,
1264                         struct state_list **true_stack,
1265                         struct state_list **false_stack);
1266 /* smatch_parsed_conditions.c */
1267 struct sm_state *parsed_condition_implication_hook(struct expression *expr,
1268                         struct state_list **true_stack,
1269                         struct state_list **false_stack);
1270 /* smatch_comparison.c */
1271 struct sm_state *comparison_implication_hook(struct expression *expr,
1272                                              struct state_list **true_stack,
1273                                              struct state_list **false_stack);
1274
1275 /* check_string_len.c */
1276 int get_formatted_string_size(struct expression *call, int arg);
1277 int get_formatted_string_min_size(struct expression *call, int arg);
1278
1279 /* smatch_param_set.c */
1280 int param_was_set(struct expression *expr);
1281 int param_was_set_var_sym(const char *name, struct symbol *sym);
1282 void print_limited_param_set(int return_id, char *return_ranges, struct expression *expr);
1283 /* param_clear */
1284 bool parent_was_PARAM_CLEAR(const char *name, struct symbol *sym);
1285 bool parent_was_PARAM_CLEAR_ZERO(const char *name, struct symbol *sym);
1286
1287 /* smatch_param_filter.c */
1288 int param_has_filter_data(struct sm_state *sm);
1289
1290 /* smatch_links.c */
1291 void set_up_link_functions(int id, int linkid);
1292 struct smatch_state *merge_link_states(struct smatch_state *s1, struct smatch_state *s2);
1293 void store_link(int link_id, const char *name, struct symbol *sym, const char *link_name, struct symbol *link_sym);
1294
1295 /* check_buf_comparison */
1296 const char *limit_type_str(unsigned int limit_type);
1297 struct expression *get_size_variable(struct expression *buf, int *limit_type);
1298 struct expression *get_array_variable(struct expression *size);
1299 int buf_comparison_index_ok(struct expression *expr);
1300
1301 /* smatch_untracked_param.c */
1302 void mark_untracked(struct expression *expr, int param, const char *key, const char *value);
1303 void add_untracked_param_hook(void (func)(struct expression *call, int param));
1304 void add_lost_param_hook(void (func)(struct expression *call, int param));
1305 void mark_all_params_untracked(int return_id, char *return_ranges, struct expression *expr);
1306
1307 /* smatch_strings.c */
1308 struct state_list *get_strings(struct expression *expr);
1309 struct expression *fake_string_from_mtag(mtag_t tag);
1310
1311 /* smatch_estate.c */
1312 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
1313
1314 /* smatch_address.c */
1315 int get_address_rl(struct expression *expr, struct range_list **rl);
1316 int get_member_offset(struct symbol *type, const char *member_name);
1317 int get_member_offset_from_deref(struct expression *expr);
1318
1319 /* for now this is in smatch_used_parameter.c */
1320 void __get_state_hook(int owner, const char *name, struct symbol *sym);
1321 extern int __ignore_param_used;
1322
1323 /* smatch_buf_comparison.c */
1324 int db_var_is_array_limit(struct expression *array, const char *name, struct var_sym_list *vsl);
1325
1326 struct range_list *get_fs(void);
1327
1328 struct stree *get_all_return_states(void);
1329 struct stree_stack *get_all_return_strees(void);
1330 int on_atomic_dec_path(void);
1331 int was_inced(const char *name, struct symbol *sym);
1332 void set_refcount_inc(char *name, struct symbol *sym);
1333 void set_refcount_dec(char *name, struct symbol *sym);
1334
1335 /* smatch_constraints.c */
1336 char *get_constraint_str(struct expression *expr);
1337 struct constraint_list *get_constraints(struct expression *expr);
1338 char *unmet_constraint(struct expression *data, struct expression *offset);
1339 char *get_required_constraint(const char *data_str);
1340
1341 /* smatch_container_of.c */
1342 int get_param_from_container_of(struct expression *expr);
1343 int get_offset_from_container_of(struct expression *expr);
1344 char *get_container_name(struct expression *container, struct expression *expr);
1345
1346 /* smatch_mtag.c */
1347 mtag_t str_to_mtag(const char *str);
1348 int get_string_mtag(struct expression *expr, mtag_t *tag);
1349 int get_toplevel_mtag(struct symbol *sym, mtag_t *tag);
1350 int create_mtag_alias(mtag_t tag, struct expression *expr, mtag_t *new);
1351 int expr_to_mtag_offset(struct expression *expr, mtag_t *tag, int *offset);
1352 void update_mtag_data(struct expression *expr, struct smatch_state *state);
1353 int get_mtag_sval(struct expression *expr, sval_t *sval);
1354
1355 /* Trinity fuzzer stuff */
1356 const char *get_syscall_arg_type(struct symbol *sym);
1357
1358 /* smatch_bit_info.c */
1359 struct bit_info *rl_to_binfo(struct range_list *rl);
1360 struct bit_info *get_bit_info(struct expression *expr);
1361 struct bit_info *get_bit_info_var_sym(const char *name, struct symbol *sym);
1362 /* smatch_mem_tracker.c */
1363 extern int option_mem;
1364 unsigned long get_mem_kb(void);
1365 unsigned long get_max_memory(void);
1366
1367 /* check_is_nospec.c */
1368 bool is_nospec(struct expression *expr);
1369 long get_stmt_cnt(void);
1370
1371 /* smatch_nul_terminator.c */
1372 bool is_nul_terminated_var_sym(const char *name, struct symbol *sym);
1373 bool is_nul_terminated(struct expression *expr);
1374 /* check_kernel.c  */
1375 bool is_ignored_kernel_data(const char *name);
1376
1377 bool is_fresh_alloc_var_sym(const char *var, struct symbol *sym);
1378 bool is_fresh_alloc(struct expression *expr);
1379 bool is_freed_var_sym(const char *name, struct symbol *sym);
1380 void track_freed_param(struct expression *expr, struct smatch_state *state);
1381 void track_freed_param_var_sym(const char *name, struct symbol *sym,
1382                                struct smatch_state *state);
1383
1384 static inline bool type_is_ptr(struct symbol *type)
1385 {
1386         return type &&
1387                (type->type == SYM_PTR ||
1388                 type->type == SYM_ARRAY ||
1389                 type->type == SYM_FN);
1390 }
1391
1392 static inline bool type_is_fp(struct symbol *type)
1393 {
1394         return type &&
1395                (type == &float_ctype ||
1396                 type == &double_ctype ||
1397                 type == &ldouble_ctype);
1398 }
1399
1400 static inline int type_bits(struct symbol *type)
1401 {
1402         if (!type)
1403                 return 0;
1404         if (type_is_ptr(type))
1405                 return bits_in_pointer;
1406         if (!type->examined)
1407                 examine_symbol_type(type);
1408         return type->bit_size;
1409 }
1410
1411 static inline int type_unsigned(struct symbol *base_type)
1412 {
1413         if (!base_type)
1414                 return 0;
1415         if (is_ptr_type(base_type))
1416                 return 1;
1417         if (base_type->ctype.modifiers & MOD_UNSIGNED)
1418                 return 1;
1419         return 0;
1420 }
1421
1422 static inline int type_positive_bits(struct symbol *type)
1423 {
1424         if (!type)
1425                 return 0;
1426         if (is_ptr_type(type))
1427                 return bits_in_pointer;
1428         if (type_unsigned(type))
1429                 return type_bits(type);
1430         return type_bits(type) - 1;
1431 }
1432
1433 static inline int sval_positive_bits(sval_t sval)
1434 {
1435         return type_positive_bits(sval.type);
1436 }
1437
1438 /*
1439  * Returns -1 if one is smaller, 0 if they are the same and 1 if two is larger.
1440  */
1441
1442 static inline int fp_cmp(sval_t one, sval_t two)
1443 {
1444         struct symbol *type;
1445
1446         if (sval_is_fp(one) && sval_is_fp(two))
1447                 type = type_bits(one.type) > type_bits(two.type) ? one.type : two.type;
1448         else if (sval_is_fp(one))
1449                 type = one.type;
1450         else
1451                 type = two.type;
1452
1453         one = sval_cast(type, one);
1454         two = sval_cast(type, two);
1455
1456         if (one.type == &float_ctype) {
1457                 if (one.fvalue < two.fvalue)
1458                         return -1;
1459                 if (one.fvalue == two.fvalue)
1460                         return 0;
1461                 return 1;
1462         }
1463         if (one.type == &double_ctype) {
1464                 if (one.dvalue < two.dvalue)
1465                         return -1;
1466                 if (one.dvalue == two.dvalue)
1467                         return 0;
1468                 return 1;
1469         }
1470         if (one.type == &ldouble_ctype) {
1471                 if (one.ldvalue < two.ldvalue)
1472                         return -1;
1473                 if (one.ldvalue == two.ldvalue)
1474                         return 0;
1475                 return 1;
1476         }
1477         sm_perror("bad type in fp_cmp(): %s", type_to_str(type));
1478         return 1;
1479 }
1480
1481 static inline int sval_cmp(sval_t one, sval_t two)
1482 {
1483         struct symbol *type;
1484
1485         if (sval_is_fp(one) || sval_is_fp(two))
1486                 return fp_cmp(one, two);
1487
1488         type = one.type;
1489         if (sval_positive_bits(two) > sval_positive_bits(one))
1490                 type = two.type;
1491         if (type_bits(type) < 31)
1492                 type = &int_ctype;
1493
1494         one = sval_cast(type, one);
1495         two = sval_cast(type, two);
1496
1497         if (type_unsigned(type)) {
1498                 if (one.uvalue < two.uvalue)
1499                         return -1;
1500                 if (one.uvalue == two.uvalue)
1501                         return 0;
1502                 return 1;
1503         }
1504         /* fix me handle type promotion and unsigned values */
1505         if (one.value < two.value)
1506                 return -1;
1507         if (one.value == two.value)
1508                 return 0;
1509         return 1;
1510 }
1511
1512 #endif      /* !SMATCH_H_ */