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 "lib.h"
  26 #include "allocate.h"
  27 #include "scope.h"
  28 #include "parse.h"
  29 #include "expression.h"
  30 #include "avl.h"
  31
  32 typedef struct {
  33         struct symbol *type;
  34         union {
  35                 long long value;
  36                 unsigned long long uvalue;
  37         };
  38 } sval_t;
  39
  40 struct smatch_state {
  41         const char *name;
  42         void *data;
  43 };
  44 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
  45 extern struct smatch_state undefined;
  46 extern struct smatch_state merged;
  47 extern struct smatch_state true_state;
  48 extern struct smatch_state false_state;
  49 DECLARE_ALLOCATOR(smatch_state);
  50
  51 static inline void *INT_PTR(int i)
  52 {
  53         return (void *)(long)i;
  54 }
  55
  56 static inline int PTR_INT(void *p)
  57 {
  58         return (int)(long)p;
  59 }
  60
  61 struct tracker {
  62         char *name;
  63         struct symbol *sym;
  64         unsigned short owner;
  65 };
  66 DECLARE_ALLOCATOR(tracker);
  67 DECLARE_PTR_LIST(tracker_list, struct tracker);
  68
  69 /* The first 3 struct members must match struct tracker */
  70 struct sm_state {
  71         const char *name;
  72         struct symbol *sym;
  73         unsigned short owner;
  74         unsigned short merged:1;
  75         unsigned short implied:1;
  76         unsigned int nr_children;
  77         unsigned int line;
  78         struct smatch_state *state;
  79         struct stree *pool;
  80         struct sm_state *left;
  81         struct sm_state *right;
  82         struct state_list *possible;
  83 };
  84
  85 struct var_sym {
  86         char *var;
  87         struct symbol *sym;
  88 };
  89 DECLARE_ALLOCATOR(var_sym);
  90 DECLARE_PTR_LIST(var_sym_list, struct var_sym);
  91
  92 enum hook_type {
  93         EXPR_HOOK,
  94         STMT_HOOK,
  95         STMT_HOOK_AFTER,
  96         SYM_HOOK,
  97         STRING_HOOK,
  98         DECLARATION_HOOK,
  99         ASSIGNMENT_HOOK,
 100         RAW_ASSIGNMENT_HOOK,
 101         GLOBAL_ASSIGNMENT_HOOK,
 102         LOGIC_HOOK,
 103         CONDITION_HOOK,
 104         PRELOOP_HOOK,
 105         SELECT_HOOK,
 106         WHOLE_CONDITION_HOOK,
 107         FUNCTION_CALL_HOOK,
 108         CALL_HOOK_AFTER_INLINE,
 109         CALL_ASSIGNMENT_HOOK,
 110         MACRO_ASSIGNMENT_HOOK,
 111         BINOP_HOOK,
 112         OP_HOOK,
 113         DEREF_HOOK,
 114         CASE_HOOK,
 115         ASM_HOOK,
 116         CAST_HOOK,
 117         SIZEOF_HOOK,
 118         BASE_HOOK,
 119         FUNC_DEF_HOOK,
 120         AFTER_DEF_HOOK,
 121         END_FUNC_HOOK,
 122         AFTER_FUNC_HOOK,
 123         RETURN_HOOK,
 124         INLINE_FN_START,
 125         INLINE_FN_END,
 126         END_FILE_HOOK,
 127 };
 128
 129 #define TRUE 1
 130 #define FALSE 0
 131
 132 struct range_list;
 133
 134 void add_hook(void *func, enum hook_type type);
 135 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
 136 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
 137 void add_merge_hook(int client_id, merge_func_t *func);
 138 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
 139 typedef void (scope_hook)(void *data);
 140 void add_scope_hook(scope_hook *hook, void *data);
 141 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
 142 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
 143                                 struct expression *assign_expr, void *data);
 144 typedef void (return_implies_hook)(struct expression *call_expr,
 145                                    int param, char *key, char *value);
 146 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list **rl);
 147 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
 148
 149 void add_function_assign_hook(const char *look_for, func_hook *call_back,
 150                               void *info);
 151 void add_implied_return_hook(const char *look_for,
 152                              implied_return_hook *call_back,
 153                              void *info);
 154 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
 155                               void *info);
 156 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
 157                               void *info);
 158 void return_implies_state(const char *look_for, long long start, long long end,
 159                          implication_hook *call_back, void *info);
 160 void select_return_states_hook(int type, return_implies_hook *callback);
 161 void select_return_states_before(void (*fn)(void));
 162 void select_return_states_after(void (*fn)(void));
 163 int get_implied_return(struct expression *expr, struct range_list **rl);
 164
 165 typedef void (modification_hook)(struct sm_state *sm, struct expression *mod_expr);
 166 void add_modification_hook(int owner, modification_hook *call_back);
 167 void add_indirect_modification_hook(int owner, modification_hook *call_back);
 168
 169 int outside_of_function(void);
 170 const char *get_filename(void);
 171 const char *get_base_file(void);
 172 char *get_function(void);
 173 int get_lineno(void);
 174 extern int final_pass;
 175 extern struct symbol *cur_func_sym;
 176 extern int option_debug;
 177 extern int local_debug;
 178 extern int option_info;
 179 int is_silenced_function(void);
 180
 181 extern FILE *sm_outfd;
 182 #define sm_printf(msg...) do { if (final_pass || option_debug) fprintf(sm_outfd, msg); } while (0)
 183
 184 static inline void sm_prefix(void)
 185 {
 186         sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
 187 }
 188
 189 static inline void print_implied_debug_msg();
 190
 191 #define sm_msg(msg...) \
 192 do {                                                           \
 193         print_implied_debug_msg();                             \
 194         if (!option_debug && !final_pass)                      \
 195                 break;                                         \
 196         if (!option_info && is_silenced_function())            \
 197                 break;                                         \
 198         sm_prefix();                                           \
 199         sm_printf(msg);                                        \
 200         sm_printf("\n");                                       \
 201 } while (0)
 202
 203 #define local_debug(msg...)                                     \
 204 do {                                                            \
 205         if (local_debug)                                        \
 206                 sm_msg(msg);                                    \
 207 } while (0)
 208
 209 extern char *implied_debug_msg;
 210 static inline void print_implied_debug_msg()
 211 {
 212         static struct symbol *last_printed = NULL;
 213
 214         if (!implied_debug_msg)
 215                 return;
 216         if (last_printed == cur_func_sym)
 217                 return;
 218         last_printed = cur_func_sym;
 219         sm_msg("%s", implied_debug_msg);
 220 }
 221
 222 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
 223
 224 #define sm_info(msg...) do {                                    \
 225         if (option_debug || (option_info && final_pass)) {      \
 226                 sm_prefix();                                    \
 227                 sm_printf("info: ");                            \
 228                 sm_printf(msg);                                 \
 229                 sm_printf("\n");                                \
 230         }                                                       \
 231 } while(0)
 232
 233 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
 234 struct smatch_state *get_state_expr(int owner, struct expression *expr);
 235 struct state_list *get_possible_states(int owner, const char *name,
 236                                        struct symbol *sym);
 237 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
 238 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
 239                struct smatch_state *state);
 240 struct sm_state *set_state_expr(int owner, struct expression *expr,
 241                 struct smatch_state *state);
 242 void delete_state(int owner, const char *name, struct symbol *sym);
 243 void delete_state_expr(int owner, struct expression *expr);
 244 void set_true_false_states(int owner, const char *name, struct symbol *sym,
 245                            struct smatch_state *true_state,
 246                            struct smatch_state *false_state);
 247 void set_true_false_states_expr(int owner, struct expression *expr,
 248                            struct smatch_state *true_state,
 249                            struct smatch_state *false_state);
 250
 251 struct stree *get_all_states_from_stree(int owner, struct stree *source);
 252 struct stree *get_all_states_stree(int id);
 253 struct stree *__get_cur_stree(void);
 254 int is_reachable(void);
 255
 256 /* smatch_helper.c */
 257 char *alloc_string(const char *str);
 258 void free_string(char *str);
 259 void append(char *dest, const char *data, int buff_len);
 260 void remove_parens(char *str);
 261 struct smatch_state *alloc_state_num(int num);
 262 struct expression *get_argument_from_call_expr(struct expression_list *args,
 263                                                int num);
 264
 265 char *expr_to_var(struct expression *expr);
 266 char *expr_to_str(struct expression *expr);
 267 char *expr_to_str_sym(struct expression *expr,
 268                                      struct symbol **sym_ptr);
 269 char *expr_to_var_sym(struct expression *expr,
 270                              struct symbol **sym_ptr);
 271
 272 int sym_name_is(const char *name, struct expression *expr);
 273 int get_const_value(struct expression *expr, sval_t *sval);
 274 int get_value(struct expression *expr, sval_t *val);
 275 int get_implied_value(struct expression *expr, sval_t *val);
 276 int get_implied_min(struct expression *expr, sval_t *sval);
 277 int get_implied_max(struct expression *expr, sval_t *val);
 278 int get_hard_max(struct expression *expr, sval_t *sval);
 279 int get_fuzzy_min(struct expression *expr, sval_t *min);
 280 int get_fuzzy_max(struct expression *expr, sval_t *max);
 281 int get_absolute_min(struct expression *expr, sval_t *sval);
 282 int get_absolute_max(struct expression *expr, sval_t *sval);
 283 int parse_call_math(struct expression *expr, char *math, sval_t *val);
 284 int is_zero(struct expression *expr);
 285 int known_condition_true(struct expression *expr);
 286 int known_condition_false(struct expression *expr);
 287 int implied_condition_true(struct expression *expr);
 288 int implied_condition_false(struct expression *expr);
 289
 290 int is_array(struct expression *expr);
 291 struct expression *get_array_name(struct expression *expr);
 292 struct expression *get_array_offset(struct expression *expr);
 293 const char *show_state(struct smatch_state *state);
 294 struct statement *get_expression_statement(struct expression *expr);
 295 struct expression *strip_parens(struct expression *expr);
 296 struct expression *strip_expr(struct expression *expr);
 297 void scoped_state(int my_id, const char *name, struct symbol *sym);
 298 int is_error_return(struct expression *expr);
 299 int getting_address(void);
 300 char *get_member_name(struct expression *expr);
 301 char *get_fnptr_name(struct expression *expr);
 302 int cmp_pos(struct position pos1, struct position pos2);
 303 int positions_eq(struct position pos1, struct position pos2);
 304 struct statement *get_current_statement(void);
 305 int get_param_num_from_sym(struct symbol *sym);
 306 int get_param_num(struct expression *expr);
 307 int ms_since(struct timeval *start);
 308
 309 /* smatch_type.c */
 310 struct symbol *get_real_base_type(struct symbol *sym);
 311 int type_bits(struct symbol *type);
 312 int type_positive_bits(struct symbol *type);
 313 struct symbol *get_pointer_type(struct expression *expr);
 314 struct symbol *get_type(struct expression *expr);
 315 int type_unsigned(struct symbol *base_type);
 316 int type_signed(struct symbol *base_type);
 317 int expr_unsigned(struct expression *expr);
 318 int returns_unsigned(struct symbol *base_type);
 319 int is_pointer(struct expression *expr);
 320 int returns_pointer(struct symbol *base_type);
 321 sval_t sval_type_max(struct symbol *base_type);
 322 sval_t sval_type_min(struct symbol *base_type);
 323 int nr_bits(struct expression *expr);
 324 int is_void_pointer(struct expression *expr);
 325 int is_char_pointer(struct expression *expr);
 326 int is_static(struct expression *expr);
 327 int types_equiv(struct symbol *one, struct symbol *two);
 328 int fn_static(void);
 329 const char *global_static();
 330 struct symbol *cur_func_return_type(void);
 331 struct symbol *get_arg_type(struct expression *fn, int arg);
 332 struct symbol *get_member_type_from_key(struct expression *expr, char *key);
 333
 334 /* smatch_ignore.c */
 335 void add_ignore(int owner, const char *name, struct symbol *sym);
 336 int is_ignored(int owner, const char *name, struct symbol *sym);
 337
 338 /* smatch_var_sym */
 339 struct var_sym *alloc_var_sym(const char *var, struct symbol *sym);
 340 struct var_sym_list *expr_to_vsl(struct expression *expr);
 341 void add_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
 342 void add_var_sym_expr(struct var_sym_list **list, struct expression *expr);
 343 void del_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
 344 int in_var_sym_list(struct var_sym_list *list, const char *var, struct symbol *sym);
 345 struct var_sym_list *clone_var_sym_list(struct var_sym_list *from_vsl);
 346 void merge_var_sym_list(struct var_sym_list **dest, struct var_sym_list *src);
 347 struct var_sym_list *combine_var_sym_lists(struct var_sym_list *one, struct var_sym_list *two);
 348 void free_var_sym_list(struct var_sym_list **list);
 349 void free_var_syms_and_list(struct var_sym_list **list);
 350
 351 /* smatch_tracker */
 352 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
 353 void add_tracker(struct tracker_list **list, int owner, const char *name,
 354                 struct symbol *sym);
 355 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
 356 void del_tracker(struct tracker_list **list, int owner, const char *name,
 357                 struct symbol *sym);
 358 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
 359                 struct symbol *sym);
 360 void free_tracker_list(struct tracker_list **list);
 361 void free_trackers_and_list(struct tracker_list **list);
 362
 363 /* smatch_conditions */
 364 int in_condition(void);
 365
 366 /* smatch_flow.c */
 367
 368 extern int __in_fake_assign;
 369 void smatch (int argc, char **argv);
 370 int inside_loop(void);
 371 int definitely_inside_loop(void);
 372 struct expression *get_switch_expr(void);
 373 int in_expression_statement(void);
 374 void __process_post_op_stack(void);
 375 void __split_expr(struct expression *expr);
 376 void __split_stmt(struct statement *stmt);
 377 extern int __in_function_def;
 378 extern int option_assume_loops;
 379 extern int option_known_conditions;
 380 extern int option_two_passes;
 381 extern int option_no_db;
 382 extern int option_file_output;
 383 extern int option_time;
 384 extern struct expression_list *big_expression_stack;
 385 extern struct statement_list *big_statement_stack;
 386 int inlinable(struct expression *expr);
 387 extern int __inline_call;
 388 extern struct expression *__inline_fn;
 389 extern int __in_pre_condition;
 390 extern int __bail_on_rest_of_function;
 391
 392 /* smatch_struct_assignment.c */
 393 enum {
 394         COPY_NORMAL,
 395         COPY_MEMCPY,
 396         COPY_MEMSET,
 397 };
 398 void __struct_members_copy(int mode, struct expression *left, struct expression *right);
 399 void __fake_struct_member_assignments(struct expression *expr);
 400
 401 /* smatch_project.c */
 402 int is_no_inline_function(const char *function);
 403
 404 /* smatch_conditions */
 405 void __split_whole_condition(struct expression *expr);
 406 void __handle_logic(struct expression *expr);
 407 int is_condition(struct expression *expr);
 408 int __handle_condition_assigns(struct expression *expr);
 409 int __handle_select_assigns(struct expression *expr);
 410 int __handle_expr_statement_assigns(struct expression *expr);
 411
 412 /* smatch_implied.c */
 413 extern int option_debug_implied;
 414 extern int option_debug_related;
 415 extern int option_no_implied;
 416 struct range_list_stack;
 417 struct stree *__implied_case_stree(struct expression *switch_expr,
 418                                  struct expression *case_expr,
 419                                  struct range_list_stack **remaining_cases,
 420                                  struct stree **raw_stree);
 421 struct range_list *__get_implied_values(struct expression *switch_expr);
 422 void overwrite_states_using_pool(struct sm_state *sm);
 423
 424 /* smatch_extras.c */
 425 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
 426
 427 struct data_range {
 428         sval_t min;
 429         sval_t max;
 430 };
 431
 432 static const long long valid_ptr_max = LONG_MAX;
 433 static const long long valid_ptr_min = 4096;
 434 static const sval_t valid_ptr_max_sval = {
 435         .type = &ptr_ctype,
 436         {.value = LONG_MAX},
 437 };
 438 static const sval_t valid_ptr_min_sval = {
 439         .type = &ptr_ctype,
 440         {.value = 4096},
 441 };
 442
 443 /* smatch_absolute.c */
 444 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
 445 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
 446
 447 /* smatch_local_values.c */
 448 int get_local_rl(struct expression *expr, struct range_list **rl);
 449 int get_local_max_helper(struct expression *expr, sval_t *sval);
 450 int get_local_min_helper(struct expression *expr, sval_t *sval);
 451
 452 /* smatch_type_value.c */
 453 int get_db_type_rl(struct expression *expr, struct range_list **rl);
 454
 455 /* smatch_states.c */
 456 void __push_fake_cur_stree();
 457 struct stree *__pop_fake_cur_stree();
 458 void __free_fake_cur_stree();
 459 void __set_fake_cur_stree_fast(struct stree *stree);
 460 void __pop_fake_cur_stree_fast(void);
 461 void __merge_stree_into_cur(struct stree *stree);
 462
 463 int unreachable(void);
 464 void __set_sm(struct sm_state *sm);
 465 void __set_true_false_sm(struct sm_state *true_state,
 466                         struct sm_state *false_state);
 467 void nullify_path(void);
 468 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 469                                void *unused);
 470 void __unnullify_path(void);
 471 int __path_is_null(void);
 472 void save_all_states(void);
 473 void nullify_all_states(void);
 474 void restore_all_states(void);
 475 void clear_all_states(void);
 476
 477 struct sm_state *get_sm_state(int owner, const char *name,
 478                                 struct symbol *sym);
 479 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
 480 void __push_true_states(void);
 481 void __use_false_states(void);
 482 void __discard_false_states(void);
 483 void __merge_false_states(void);
 484 void __merge_true_states(void);
 485
 486 void __negate_cond_stacks(void);
 487 void __use_pre_cond_states(void);
 488 void __use_cond_true_states(void);
 489 void __use_cond_false_states(void);
 490 void __push_cond_stacks(void);
 491 struct stree *__copy_cond_true_states(void);
 492 struct stree *__copy_cond_false_states(void);
 493 struct stree *__pop_cond_true_stack(void);
 494 struct stree *__pop_cond_false_stack(void);
 495 void __and_cond_states(void);
 496 void __or_cond_states(void);
 497 void __save_pre_cond_states(void);
 498 void __discard_pre_cond_states(void);
 499 void __use_cond_states(void);
 500 extern struct state_list *__last_base_slist;
 501
 502 void __warn_on_silly_pre_loops(void);
 503
 504 void __push_continues(void);
 505 void __discard_continues(void);
 506 void __process_continues(void);
 507 void __merge_continues(void);
 508
 509 void __push_breaks(void);
 510 void __process_breaks(void);
 511 int __has_breaks(void);
 512 void __merge_breaks(void);
 513 void __use_breaks(void);
 514
 515 void __save_switch_states(struct expression *switch_expr);
 516 void __discard_switches(void);
 517 void __merge_switches(struct expression *switch_expr, struct expression *case_expr);
 518 void __push_default(void);
 519 void __set_default(void);
 520 int __pop_default(void);
 521
 522 void __push_conditions(void);
 523 void __discard_conditions(void);
 524
 525 void __save_gotos(const char *name);
 526 void __merge_gotos(const char *name);
 527
 528 void __print_cur_stree(void);
 529
 530 /* smatch_hooks.c */
 531 void __pass_to_client(void *data, enum hook_type type);
 532 void __pass_to_client_no_data(enum hook_type type);
 533 void __pass_case_to_client(struct expression *switch_expr,
 534                            struct expression *case_expr);
 535 int __has_merge_function(int client_id);
 536 struct smatch_state *__client_merge_function(int owner,
 537                                              struct smatch_state *s1,
 538                                              struct smatch_state *s2);
 539 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 540 void __push_scope_hooks(void);
 541 void __call_scope_hooks(void);
 542
 543 /* smatch_function_hooks.c */
 544 void create_function_hook_hash(void);
 545 void __match_initializer_call(struct symbol *sym);
 546
 547 /* smatch_db.c */
 548 enum info_type {
 549         INTERNAL        = 0,
 550         /*
 551          * Changing these numbers is a pain.  Don't do it.  If you ever use a
 552          * number it can't be re-used right away so there may be gaps.
 553          * We select these in order by type so if the order matters, then give
 554          * it a number below 100-999,9000-9999 ranges. */
 555
 556         PARAM_CLEARED   = 101,
 557         FILTER_VALUE    = 102,
 558
 559         PARAM_VALUE     = 1001,
 560         BUF_SIZE        = 1002,
 561         USER_DATA       = 1003,
 562         CAPPED_DATA     = 1004,
 563         RETURN_VALUE    = 1005,
 564         DEREFERENCE     = 1006,
 565         RANGE_CAP       = 1007,
 566         LOCK_HELD       = 1008,
 567         LOCK_RELEASED   = 1009,
 568         ABSOLUTE_LIMITS = 1010,
 569         LIMITED_VALUE   = 1011,
 570         ADDED_VALUE     = 1012,
 571         PARAM_FREED     = 1013,
 572         DATA_SOURCE     = 1014,
 573         FUZZY_MAX       = 1015,
 574         STR_LEN         = 1016,
 575 };
 576
 577 void debug_sql(const char *sql);
 578 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
 579 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct smatch_state *state));
 580 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr));
 581 void add_returned_member_callback(int owner, void (*callback)(int return_id, char *return_ranges, char *printed_name, struct smatch_state *state));
 582 void select_call_implies_hook(int type, void (*callback)(struct expression *arg, char *value));
 583 struct range_list *db_return_vals(struct expression *expr);
 584 char *return_state_to_var_sym(struct expression *expr, int param, char *key, struct symbol **sym);
 585 char *get_variable_from_key(struct expression *arg, char *key, struct symbol **sym);
 586 const char *get_param_name(struct sm_state *sm);
 587
 588 #define run_sql(call_back, sql...)    \
 589 do {                                  \
 590         char sql_txt[1024];           \
 591         if (option_no_db)             \
 592                 break;                \
 593         snprintf(sql_txt, 1024, sql); \
 594         debug_sql(sql_txt);           \
 595         sql_exec(call_back, sql_txt); \
 596 } while (0)
 597
 598 /* like run_sql() but for the in-memory database */
 599 #define mem_sql(call_back, sql...)                                              \
 600 do {                                                                            \
 601         char sql_txt[1024];                                                     \
 602                                                                                 \
 603         snprintf(sql_txt, sizeof(sql_txt), sql);                                \
 604         sm_debug("in-mem: %s\n", sql_txt);                                      \
 605         sql_mem_exec(call_back, sql_txt);                                       \
 606 } while (0)
 607
 608 void sql_insert_return_states(int return_id, const char *return_ranges,
 609                 int type, int param, const char *key, const char *value);
 610 void sql_insert_caller_info(struct expression *call, int type, int param,
 611                 const char *key, const char *value);
 612 void sql_insert_function_ptr(const char *fn, const char *struct_name);
 613 void sql_insert_return_values(const char *return_values);
 614 void sql_insert_call_implies(int type, int param, int value);
 615 void sql_insert_function_type_size(const char *member, const char *ranges);
 616 void sql_insert_local_values(const char *name, const char *value);
 617 void sql_insert_function_type_value(const char *type, const char *value);
 618
 619 void sql_select_return_states(const char *cols, struct expression *call,
 620         int (*callback)(void*, int, char**, char**));
 621 void sql_select_caller_info(const char *cols, struct symbol *sym,
 622         int (*callback)(void*, int, char**, char**));
 623 void sql_select_call_implies(const char *cols, struct expression *call,
 624         int (*callback)(void*, int, char**, char**));
 625
 626 void sql_exec(int (*callback)(void*, int, char**, char**), const char *sql);
 627 void sql_mem_exec(int (*callback)(void*, int, char**, char**), const char *sql);
 628
 629 void open_smatch_db(void);
 630
 631 /* smatch_files.c */
 632 int open_data_file(const char *filename);
 633 struct token *get_tokens_file(const char *filename);
 634
 635 /* smatch.c */
 636 extern char *option_debug_check;
 637 extern char *option_project_str;
 638 extern char *data_dir;
 639 extern int option_no_data;
 640 extern int option_spammy;
 641 extern int option_full_path;
 642 extern int option_param_mapper;
 643 extern int option_call_tree;
 644 extern int num_checks;
 645
 646 enum project_type {
 647         PROJ_NONE,
 648         PROJ_KERNEL,
 649         PROJ_WINE,
 650 };
 651 extern enum project_type option_project;
 652 const char *check_name(unsigned short id);
 653
 654
 655 /* smatch_buf_size.c */
 656 int get_array_size(struct expression *expr);
 657 int get_array_size_bytes(struct expression *expr);
 658 int get_array_size_bytes_min(struct expression *expr);
 659 int get_array_size_bytes_max(struct expression *expr);
 660 struct range_list *get_array_size_bytes_rl(struct expression *expr);
 661 int get_real_array_size(struct expression *expr);
 662 /* smatch_strlen.c */
 663 int get_implied_strlen(struct expression *expr, struct range_list **rl);
 664 int get_size_from_strlen(struct expression *expr);
 665
 666 /* smatch_capped.c */
 667 int is_capped(struct expression *expr);
 668 int is_capped_var_sym(const char *name, struct symbol *sym);
 669
 670 /* check_user_data.c */
 671 int is_user_macro(struct expression *expr);
 672 int is_user_data(struct expression *expr);
 673 int is_capped_user_data(struct expression *expr);
 674
 675 /* check_locking.c */
 676 void print_held_locks();
 677
 678 /* check_assigned_expr.c */
 679 struct expression *get_assigned_expr(struct expression *expr);
 680
 681 /* smatch_comparison.c */
 682 int get_comparison(struct expression *left, struct expression *right);
 683 int get_comparison_strings(const char *one, const char *two);
 684 void __add_comparison_info(struct expression *expr, struct expression *call, const char *range);
 685 char *expr_equal_to_param(struct expression *expr);
 686 char *expr_lte_to_param(struct expression *expr);
 687
 688 /* smatch_sval.c */
 689 sval_t *sval_alloc(sval_t sval);
 690 sval_t *sval_alloc_permanent(sval_t sval);
 691 sval_t sval_blank(struct expression *expr);
 692 sval_t sval_type_val(struct symbol *type, long long val);
 693 sval_t sval_from_val(struct expression *expr, long long val);
 694 int sval_unsigned(sval_t sval);
 695 int sval_signed(sval_t sval);
 696 int sval_bits(sval_t sval);
 697 int sval_positive_bits(sval_t sval);
 698 int sval_bits_used(sval_t sval);
 699 int sval_is_negative(sval_t sval);
 700 int sval_is_positive(sval_t sval);
 701 int sval_is_min(sval_t sval);
 702 int sval_is_max(sval_t sval);
 703 int sval_is_a_min(sval_t sval);
 704 int sval_is_a_max(sval_t sval);
 705 int sval_is_negative_min(sval_t sval);
 706 int sval_cmp(sval_t one, sval_t two);
 707 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
 708 int sval_cmp_val(sval_t one, long long val);
 709 sval_t sval_min(sval_t one, sval_t two);
 710 sval_t sval_max(sval_t one, sval_t two);
 711 int sval_too_low(struct symbol *type, sval_t sval);
 712 int sval_too_high(struct symbol *type, sval_t sval);
 713 int sval_fits(struct symbol *type, sval_t sval);
 714 sval_t sval_cast(struct symbol *type, sval_t sval);
 715 sval_t sval_preop(sval_t sval, int op);
 716 sval_t sval_binop(sval_t left, int op, sval_t right);
 717 int sval_binop_overflows(sval_t left, int op, sval_t right);
 718 const char *sval_to_str(sval_t sval);
 719 const char *sval_to_numstr(sval_t sval);
 720 sval_t ll_to_sval(long long val);
 721
 722 /* smatch_string_list.c */
 723 int list_has_string(struct string_list *str_list, char *str);
 724 void insert_string(struct string_list **str_list, char *str);
 725 struct string_list *clone_str_list(struct string_list *orig);
 726 struct string_list *combine_string_lists(struct string_list *one, struct string_list *two);
 727
 728 /* smatch_clear_buffer.c */
 729 int is_uninitialized(struct expression *expr);
 730 int has_uninitialized_members(struct expression *expr);
 731
 732 /* smatch_start_states.c */
 733 struct stree *get_start_states(void);
 734
 735 /* smatch_recurse.c */
 736 int has_symbol(struct expression *expr, struct symbol *sym);
 737 int has_variable(struct expression *expr, struct expression *var);
 738 int has_inc_dec(struct expression *expr);
 739
 740 /* smatch_stored_conditions.c */
 741 struct smatch_state *get_stored_condition(struct expression *expr);
 742
 743 /* check_string_len.c */
 744 int get_formatted_string_size(struct expression *call, int arg);
 745
 746 #endif      /* !SMATCH_H_ */