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