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