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