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