smatch.h

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