smatch.h

   1 /*
   2  * sparse/smatch.h
   3  *
   4  * Copyright (C) 2006 Dan Carpenter.
   5  *
   6  *  Licensed under the Open Software License version 1.1
   7  *
   8  */
   9
  10 #ifndef         SMATCH_H_
  11 # define        SMATCH_H_
  12
  13 #include <stdio.h>
  14 #include <string.h>
  15 #include <limits.h>
  16 #include "lib.h"
  17 #include "allocate.h"
  18 #include "parse.h"
  19 #include "expression.h"
  20
  21 typedef struct {
  22         struct symbol *type;
  23         union {
  24                 long long value;
  25                 unsigned long long uvalue;
  26         };
  27 } sval_t;
  28
  29 struct smatch_state {
  30         const char *name;
  31         void *data;
  32 };
  33 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
  34 extern struct smatch_state undefined;
  35 extern struct smatch_state merged;
  36 extern struct smatch_state true_state;
  37 extern struct smatch_state false_state;
  38 DECLARE_ALLOCATOR(smatch_state);
  39
  40 static inline void *INT_PTR(int i)
  41 {
  42         return (void *)(long)i;
  43 }
  44
  45 static inline int PTR_INT(void *p)
  46 {
  47         return (int)(long)p;
  48 }
  49
  50 struct sm_state {
  51         unsigned short owner;
  52         unsigned int merged:1;
  53         unsigned int implied:1;
  54         const char *name;
  55         struct symbol *sym;
  56         struct smatch_state *state;
  57         unsigned int line;
  58         struct state_list *pool;
  59         struct sm_state *left;
  60         struct sm_state *right;
  61         unsigned int nr_children;
  62         struct state_list *possible;
  63 };
  64
  65 struct tracker {
  66         int owner;
  67         char *name;
  68         struct symbol *sym;
  69 };
  70 DECLARE_ALLOCATOR(tracker);
  71 DECLARE_PTR_LIST(tracker_list, struct tracker);
  72
  73 enum hook_type {
  74         EXPR_HOOK,
  75         STMT_HOOK,
  76         SYM_HOOK,
  77         STRING_HOOK,
  78         DECLARATION_HOOK,
  79         ASSIGNMENT_HOOK,
  80         RAW_ASSIGNMENT_HOOK,
  81         LOGIC_HOOK,
  82         CONDITION_HOOK,
  83         PRELOOP_HOOK,
  84         SELECT_HOOK,
  85         WHOLE_CONDITION_HOOK,
  86         FUNCTION_CALL_HOOK,
  87         CALL_ASSIGNMENT_HOOK,
  88         MACRO_ASSIGNMENT_HOOK,
  89         BINOP_HOOK,
  90         OP_HOOK,
  91         DEREF_HOOK,
  92         CASE_HOOK,
  93         ASM_HOOK,
  94         CAST_HOOK,
  95         BASE_HOOK,
  96         FUNC_DEF_HOOK,
  97         END_FUNC_HOOK,
  98         RETURN_HOOK,
  99         END_FILE_HOOK,
 100 };
 101
 102 #define TRUE 1
 103 #define FALSE 0
 104
 105 struct range_list_sval;
 106
 107 void add_hook(void *func, enum hook_type type);
 108 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
 109 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
 110 void add_merge_hook(int client_id, merge_func_t *func);
 111 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
 112 typedef void (scope_hook)(void *data);
 113 void add_scope_hook(scope_hook *hook, void *data);
 114 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
 115 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
 116                                 struct expression *assign_expr, void *data);
 117 typedef void (return_implies_hook)(struct expression *call_expr,
 118                                    int param, char *key, char *value);
 119 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list_sval **rl);
 120 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
 121
 122 void add_function_assign_hook(const char *look_for, func_hook *call_back,
 123                               void *info);
 124 void add_implied_return_hook(const char *look_for,
 125                              implied_return_hook *call_back,
 126                              void *info);
 127 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
 128                               void *info);
 129 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
 130                               void *info);
 131 void return_implies_state(const char *look_for, long long start, long long end,
 132                          implication_hook *call_back, void *info);
 133 void add_db_return_implies_callback(int type, return_implies_hook *callback);
 134 void add_db_return_states_callback(int type, return_implies_hook *callback);
 135 int get_implied_return_sval(struct expression *expr, struct range_list_sval **rl);
 136
 137 typedef void (modification_hook)(struct sm_state *sm);
 138 void add_modification_hook(int owner, modification_hook *call_back);
 139 void add_indirect_modification_hook(int owner, modification_hook *call_back);
 140
 141 const char *get_filename(void);
 142 char *get_function(void);
 143 int get_lineno(void);
 144 extern int final_pass;
 145 extern struct symbol *cur_func_sym;
 146 extern int option_debug;
 147
 148 extern FILE *sm_outfd;
 149 #define sm_printf(msg...) do { if (final_pass) fprintf(sm_outfd, msg); } while (0)
 150
 151 static inline void sm_prefix(void)
 152 {
 153         sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
 154 }
 155
 156 static inline void print_implied_debug_msg();
 157
 158 #define sm_msg(msg...) \
 159 do {                                                           \
 160         print_implied_debug_msg();                             \
 161         if (!option_debug && !final_pass)                      \
 162                 break;                                         \
 163         sm_prefix();                                           \
 164         sm_printf(msg);                                        \
 165         sm_printf("\n");                                       \
 166 } while (0)
 167
 168 extern char *implied_debug_msg;
 169 static inline void print_implied_debug_msg()
 170 {
 171         static struct symbol *last_printed = NULL;
 172
 173         if (!implied_debug_msg)
 174                 return;
 175         if (last_printed == cur_func_sym)
 176                 return;
 177         last_printed = cur_func_sym;
 178         sm_msg("%s", implied_debug_msg);
 179 }
 180
 181 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
 182
 183 #define sm_info(msg...) do {                                    \
 184         if (option_debug || (option_info && final_pass)) {      \
 185                 sm_prefix();                                    \
 186                 sm_printf("info: ");                            \
 187                 sm_printf(msg);                                 \
 188                 sm_printf("\n");                                \
 189         }                                                       \
 190 } while(0)
 191
 192 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
 193 struct smatch_state *get_state_expr(int owner, struct expression *expr);
 194 struct state_list *get_possible_states(int owner, const char *name,
 195                                        struct symbol *sym);
 196 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
 197 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
 198                struct smatch_state *state);
 199 struct sm_state *set_state_expr(int owner, struct expression *expr,
 200                 struct smatch_state *state);
 201 void delete_state(int owner, const char *name, struct symbol *sym);
 202 void delete_state_expr(int owner, struct expression *expr);
 203 void set_true_false_states(int owner, const char *name, struct symbol *sym,
 204                            struct smatch_state *true_state,
 205                            struct smatch_state *false_state);
 206 void set_true_false_states_expr(int owner, struct expression *expr,
 207                            struct smatch_state *true_state,
 208                            struct smatch_state *false_state);
 209
 210 struct state_list *get_all_states(int id);
 211 int is_reachable(void);
 212
 213 /* smatch_helper.c */
 214 char *alloc_string(const char *str);
 215 void free_string(char *str);
 216 struct smatch_state *alloc_state_num(int num);
 217 struct expression *get_argument_from_call_expr(struct expression_list *args,
 218                                                int num);
 219 char *get_variable_from_expr_complex(struct expression *expr,
 220                                      struct symbol **sym_ptr);
 221 char *get_variable_from_expr(struct expression *expr,
 222                              struct symbol **sym_ptr);
 223 int sym_name_is(const char *name, struct expression *expr);
 224 int get_value_sval(struct expression *expr, sval_t *val);
 225 int get_implied_value_sval(struct expression *expr, sval_t *val);
 226 int get_implied_max_sval(struct expression *expr, sval_t *val);
 227 int get_implied_min_sval(struct expression *expr, sval_t *sval);
 228 int get_fuzzy_min_sval(struct expression *expr, sval_t *min);
 229 int get_fuzzy_max_sval(struct expression *expr, sval_t *max);
 230 int get_absolute_min_sval(struct expression *expr, sval_t *sval);
 231 int get_absolute_max_sval(struct expression *expr, sval_t *sval);
 232 int parse_call_math_sval(struct expression *expr, char *math, sval_t *val);
 233 int is_zero(struct expression *expr);
 234 int known_condition_true(struct expression *expr);
 235 int known_condition_false(struct expression *expr);
 236 int implied_condition_true(struct expression *expr);
 237 int implied_condition_false(struct expression *expr);
 238
 239 int is_array(struct expression *expr);
 240 struct expression *get_array_name(struct expression *expr);
 241 struct expression *get_array_offset(struct expression *expr);
 242 const char *show_state(struct smatch_state *state);
 243 struct statement *get_expression_statement(struct expression *expr);
 244 struct expression *strip_parens(struct expression *expr);
 245 struct expression *strip_expr(struct expression *expr);
 246 void scoped_state(int my_id, const char *name, struct symbol *sym);
 247 int is_error_return(struct expression *expr);
 248 int getting_address(void);
 249 char *get_member_name(struct expression *expr);
 250 char *get_fnptr_name(struct expression *expr);
 251 int positions_eq(struct position pos1, struct position pos2);
 252 struct statement *get_current_statement(void);
 253
 254 /* smatch_type.c */
 255 struct symbol *get_real_base_type(struct symbol *sym);
 256 struct symbol *get_pointer_type(struct expression *expr);
 257 struct symbol *get_type(struct expression *expr);
 258 int type_unsigned(struct symbol *base_type);
 259 int type_signed(struct symbol *base_type);
 260 int expr_unsigned(struct expression *expr);
 261 int returns_unsigned(struct symbol *base_type);
 262 int is_pointer(struct expression *expr);
 263 int returns_pointer(struct symbol *base_type);
 264 sval_t sval_type_max(struct symbol *base_type);
 265 sval_t sval_type_min(struct symbol *base_type);
 266 int nr_bits(struct expression *expr);
 267 int is_static(struct expression *expr);
 268 int types_equiv(struct symbol *one, struct symbol *two);
 269 const char *global_static();
 270 struct symbol *cur_func_return_type(void);
 271
 272 /* smatch_ignore.c */
 273 void add_ignore(int owner, const char *name, struct symbol *sym);
 274 int is_ignored(int owner, const char *name, struct symbol *sym);
 275
 276 /* smatch_tracker */
 277 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
 278 void add_tracker(struct tracker_list **list, int owner, const char *name,
 279                 struct symbol *sym);
 280 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
 281 void del_tracker(struct tracker_list **list, int owner, const char *name,
 282                 struct symbol *sym);
 283 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
 284                 struct symbol *sym);
 285 void free_tracker_list(struct tracker_list **list);
 286 void free_trackers_and_list(struct tracker_list **list);
 287
 288 /* smatch_conditions */
 289 int in_condition(void);
 290
 291 /* smatch_flow.c */
 292
 293 void smatch (int argc, char **argv);
 294 int inside_loop(void);
 295 int in_expression_statement(void);
 296 void __split_expr(struct expression *expr);
 297 void __split_stmt(struct statement *stmt);
 298 extern int option_assume_loops;
 299 extern int option_known_conditions;
 300 extern int option_two_passes;
 301 extern int option_no_db;
 302 extern int option_file_output;
 303 extern struct expression_list *big_expression_stack;
 304 extern struct statement_list *big_statement_stack;
 305 extern int __in_pre_condition;
 306 extern int __bail_on_rest_of_function;
 307
 308 /* smatch_conditions */
 309 void __split_whole_condition(struct expression *expr);
 310 void __handle_logic(struct expression *expr);
 311 int __is_condition_assign(struct expression *expr);
 312 int __handle_condition_assigns(struct expression *expr);
 313 int __handle_select_assigns(struct expression *expr);
 314 int __handle_expr_statement_assigns(struct expression *expr);
 315
 316 /* smatch_implied.c */
 317 extern int option_debug_implied;
 318 extern int option_debug_related;
 319 extern int option_no_implied;
 320 void get_implications(char *name, struct symbol *sym, int comparison, long long num,
 321                       struct state_list **true_states,
 322                       struct state_list **false_states);
 323 struct range_list_stack_sval;
 324 struct state_list *__implied_case_slist(struct expression *switch_expr,
 325                                         struct expression *case_expr,
 326                                         struct range_list_stack_sval **remaining_cases,
 327                                         struct state_list **raw_slist);
 328 struct range_list_sval *__get_implied_values(struct expression *switch_expr);
 329
 330 /* smatch_extras.c */
 331 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
 332
 333 struct data_range_sval {
 334         sval_t min;
 335         sval_t max;
 336 };
 337
 338 static const long long valid_ptr_max = LONG_MAX;
 339 static const long long valid_ptr_min = 4096;
 340 static const sval_t valid_ptr_max_sval = {
 341         .type = &ptr_ctype,
 342         .value = LONG_MAX,
 343 };
 344 static const sval_t valid_ptr_min_sval = {
 345         .type = &ptr_ctype,
 346         .value = 4096,
 347 };
 348
 349 /* smatch_absolute.c */
 350 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
 351 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
 352
 353 /* smatch_states.c */
 354 void __push_fake_cur_slist();
 355 struct state_list *__pop_fake_cur_slist();
 356 void __merge_slist_into_cur(struct state_list *slist);
 357
 358 int unreachable(void);
 359 void __set_sm(struct sm_state *sm);
 360 struct state_list *__get_cur_slist(void);
 361 void __set_true_false_sm(struct sm_state *true_state,
 362                         struct sm_state *false_state);
 363 void nullify_path(void);
 364 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 365                                void *unused);
 366 void __unnullify_path(void);
 367 int __path_is_null(void);
 368 void clear_all_states(void);
 369
 370 struct sm_state *get_sm_state(int owner, const char *name,
 371                                 struct symbol *sym);
 372 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
 373 void __push_true_states(void);
 374 void __use_false_states(void);
 375 void __discard_false_states(void);
 376 void __merge_false_states(void);
 377 void __merge_true_states(void);
 378
 379 void __negate_cond_stacks(void);
 380 void __use_pre_cond_states(void);
 381 void __use_cond_true_states(void);
 382 void __use_cond_false_states(void);
 383 void __push_cond_stacks(void);
 384 struct state_list *__copy_cond_true_states(void);
 385 struct state_list *__copy_cond_false_states(void);
 386 struct state_list *__pop_cond_true_stack(void);
 387 struct state_list *__pop_cond_false_stack(void);
 388 void __and_cond_states(void);
 389 void __or_cond_states(void);
 390 void __save_pre_cond_states(void);
 391 void __discard_pre_cond_states(void);
 392 void __use_cond_states(void);
 393 extern struct state_list *__last_base_slist;
 394
 395 void __warn_on_silly_pre_loops(void);
 396
 397 void __push_continues(void);
 398 void __discard_continues(void);
 399 void __process_continues(void);
 400 void __merge_continues(void);
 401
 402 void __push_breaks(void);
 403 void __process_breaks(void);
 404 void __merge_breaks(void);
 405 void __use_breaks(void);
 406
 407 void __save_switch_states(struct expression *switch_expr);
 408 void __discard_switches(void);
 409 void __merge_switches(struct expression *switch_expr, struct expression *case_expr);
 410 void __push_default(void);
 411 void __set_default(void);
 412 int __pop_default(void);
 413
 414 void __push_conditions(void);
 415 void __discard_conditions(void);
 416
 417 void __save_gotos(const char *name);
 418 void __merge_gotos(const char *name);
 419
 420 void __print_cur_slist(void);
 421
 422 /* smatch_hooks.c */
 423 void __pass_to_client(void *data, enum hook_type type);
 424 void __pass_to_client_no_data(enum hook_type type);
 425 void __pass_case_to_client(struct expression *switch_expr,
 426                            struct expression *case_expr);
 427 int __has_merge_function(int client_id);
 428 struct smatch_state *__client_merge_function(int owner,
 429                                              struct smatch_state *s1,
 430                                              struct smatch_state *s2);
 431 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 432 void __push_scope_hooks(void);
 433 void __call_scope_hooks(void);
 434
 435 /* smatch_function_hooks.c */
 436 void create_function_hook_hash(void);
 437 void __match_initializer_call(struct symbol *sym);
 438
 439 /* smatch_db.c */
 440 enum info_type {
 441         INTERNAL = 0,
 442         PARAM_VALUE,
 443         BUF_SIZE,
 444         USER_DATA,
 445         CAPPED_DATA,
 446         RETURN_VALUE,
 447         DEREFERENCE,
 448         RANGE_CAP,
 449         LOCK_HELD,
 450         LOCK_RELEASED,
 451         ABSOLUTE_LIMITS,
 452 };
 453
 454 int get_return_id(void);
 455 void add_definition_db_callback(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
 456 void add_member_info_callback(int owner, void (*callback)(char *fn, char *global_static, int param, char *printed_name, struct smatch_state *state));
 457 void add_db_fn_call_callback(int type, void (*callback)(struct expression *arg, char *value));
 458 struct range_list_sval *db_return_vals(struct expression *expr);
 459
 460 #define run_sql(call_back, sql...)    \
 461 do {                                  \
 462         char sql_txt[1024];           \
 463         snprintf(sql_txt, 1024, sql); \
 464         sm_debug("%s\n", sql_txt);    \
 465         sql_exec(call_back, sql_txt); \
 466 } while (0)
 467
 468 void sql_exec(int (*callback)(void*, int, char**, char**), const char *sql);
 469 void open_smatch_db(void);
 470
 471 /* smatch_files.c */
 472 struct token *get_tokens_file(const char *filename);
 473
 474 /* smatch.c */
 475 extern char *option_project_str;
 476 extern char *data_dir;
 477 extern int option_no_data;
 478 extern int option_spammy;
 479 extern int option_full_path;
 480 extern int option_param_mapper;
 481 extern int option_info;
 482 extern int option_call_tree;
 483 extern int num_checks;
 484
 485 enum project_type {
 486         PROJ_NONE,
 487         PROJ_KERNEL,
 488         PROJ_WINE,
 489 };
 490 extern enum project_type option_project;
 491 const char *check_name(unsigned short id);
 492
 493
 494 /* smatch_buf_size.c */
 495 int get_array_size(struct expression *expr);
 496 int get_array_size_bytes(struct expression *expr);
 497 int get_array_size_bytes_min(struct expression *expr);
 498
 499 /* smatch_capped.c */
 500 int is_capped(struct expression *expr);
 501
 502 /* check_user_data.c */
 503 int is_user_data(struct expression *expr);
 504
 505 /* check_locking.c */
 506 void print_held_locks();
 507
 508 /* check_assigned_expr.c */
 509 struct expression *get_assigned_expr(struct expression *expr);
 510
 511 /* smatch_sval.c */
 512 sval_t *sval_alloc(sval_t sval);
 513 sval_t *sval_alloc_permanent(sval_t sval);
 514 sval_t sval_blank(struct expression *expr);
 515 sval_t sval_from_val(struct expression *expr, long long val);
 516 int sval_unsigned(sval_t sval);
 517 int sval_signed(sval_t sval);
 518 int sval_bits(sval_t sval);
 519 int sval_positive_bits(sval_t sval);
 520 int sval_is_min(sval_t sval);
 521 int sval_is_max(sval_t sval);
 522 int sval_cmp(sval_t one, sval_t two);
 523 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
 524 int sval_cmp_val(sval_t one, long long val);
 525 sval_t sval_cast(sval_t sval, struct symbol *type);
 526 sval_t sval_preop(sval_t sval, int op);
 527 sval_t sval_binop(sval_t left, int op, sval_t right);
 528 const char *sval_to_str(sval_t sval);
 529 const char *sval_to_numstr(sval_t sval);
 530 sval_t ll_to_sval(long long val);
 531
 532 #endif      /* !SMATCH_H_ */