smatch.h

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