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