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 *my_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         LOGIC_HOOK,
  73         CONDITION_HOOK,
  74         WHOLE_CONDITION_HOOK,
  75         FUNCTION_CALL_HOOK,
  76         CALL_ASSIGNMENT_HOOK,
  77         MACRO_ASSIGNMENT_HOOK,
  78         BINOP_HOOK,
  79         OP_HOOK,
  80         DEREF_HOOK,
  81         CASE_HOOK,
  82         ASM_HOOK,
  83         BASE_HOOK,
  84         FUNC_DEF_HOOK,
  85         END_FUNC_HOOK,
  86         RETURN_HOOK,
  87         END_FILE_HOOK,
  88 };
  89
  90 #define TRUE 1
  91 #define FALSE 0
  92
  93 void add_hook(void *func, enum hook_type type);
  94 typedef struct smatch_state *(merge_func_t)(const char *name,
  95                                             struct symbol *sym,
  96                                             struct smatch_state *s1,
  97                                             struct smatch_state *s2);
  98 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
  99 void add_merge_hook(int client_id, merge_func_t *func);
 100 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
 101 typedef void (scope_hook)(void *data);
 102 void add_scope_hook(scope_hook *hook, void *data);
 103 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
 104 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
 105                                 struct expression *assign_expr, void *data);
 106 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
 107
 108 void add_function_assign_hook(const char *look_for, func_hook *call_back,
 109                               void *info);
 110 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
 111                               void *info);
 112 void return_implies_state(const char *look_for, long long start, long long end,
 113                          implication_hook *call_back, void *info);
 114 typedef void (modification_hook)(const char *name, struct symbol *sym,
 115                                 struct expression *expr, void *data);
 116 void add_modification_hook(int owner, const char *variable, modification_hook *hook,
 117                         void *data);
 118 void add_modification_hook_expr(int owner, struct expression *expr, modification_hook *call_back, void *info);
 119 void set_default_modification_hook(int owner, modification_hook *call_back);
 120 void __use_default_modification_hook(int owner, const char *variable);
 121
 122 const char *get_filename(void);
 123 char *get_function(void);
 124 int get_lineno(void);
 125 int get_func_pos(void);
 126 extern int final_pass;
 127 extern struct symbol *cur_func_sym;
 128 extern int option_debug;
 129
 130 #define sm_printf(msg...) do { if (final_pass) printf(msg); } while (0) \
 131
 132 static inline void sm_prefix(void)
 133 {
 134         printf("%s +%d %s(%d) ", get_filename(), get_lineno(), get_function(), get_func_pos());
 135 }
 136
 137
 138 static inline void print_implied_debug_msg();
 139
 140 #define sm_msg(msg...) \
 141 do {                                                           \
 142         print_implied_debug_msg();                             \
 143         if (!option_debug && !final_pass)                      \
 144                 break;                                         \
 145         sm_prefix();                                           \
 146         printf(msg);                                           \
 147         printf("\n");                                          \
 148 } while (0)
 149
 150 extern char *implied_debug_msg;
 151 static inline void print_implied_debug_msg()
 152 {
 153         static struct symbol *last_printed = NULL;
 154
 155         if (!implied_debug_msg)
 156                 return;
 157         if (last_printed == cur_func_sym)
 158                 return;
 159         last_printed = cur_func_sym;
 160         sm_msg("%s", implied_debug_msg);
 161 }
 162
 163 #define sm_debug(msg...) do { if (option_debug) printf(msg); } while (0)
 164
 165 #define sm_info(msg...) do {                                    \
 166         if (option_debug || (option_info && final_pass)) {      \
 167                 sm_prefix();                                    \
 168                 printf("info: ");                               \
 169                 printf(msg);                                    \
 170                 printf("\n");                                   \
 171         }                                                       \
 172 } while(0)
 173
 174 #define POINTER_MAX 0xffffffff
 175
 176 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
 177 struct smatch_state *get_state_expr(int owner, struct expression *expr);
 178 struct state_list *get_possible_states(int owner, const char *name,
 179                                        struct symbol *sym);
 180 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
 181 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
 182                struct smatch_state *state);
 183 struct sm_state *set_state_expr(int owner, struct expression *expr,
 184                 struct smatch_state *state);
 185 void delete_state(int owner, const char *name, struct symbol *sym);
 186 void delete_state_expr(int owner, struct expression *expr);
 187 void set_true_false_states(int owner, const char *name, struct symbol *sym,
 188                            struct smatch_state *true_state,
 189                            struct smatch_state *false_state);
 190 void set_true_false_states_expr(int owner, struct expression *expr,
 191                            struct smatch_state *true_state,
 192                            struct smatch_state *false_state);
 193
 194 struct state_list *get_all_states(int id);
 195 int is_reachable(void);
 196
 197 /* smatch_helper.c */
 198 char *alloc_string(const char *str);
 199 void free_string(char *str);
 200 struct smatch_state *alloc_state_num(int num);
 201 struct expression *get_argument_from_call_expr(struct expression_list *args,
 202                                                int num);
 203 char *get_variable_from_expr_complex(struct expression *expr,
 204                                      struct symbol **sym_ptr);
 205 char *get_variable_from_expr(struct expression *expr,
 206                              struct symbol **sym_ptr);
 207 int sym_name_is(const char *name, struct expression *expr);
 208 int get_value(struct expression *expr, long long *val);
 209 int get_implied_value(struct expression *expr, long long *val);
 210 int get_implied_max(struct expression *expr, long long *val);
 211 int get_implied_min(struct expression *expr, long long *val);
 212 int get_fuzzy_min(struct expression *expr, long long *min);
 213 int get_fuzzy_max(struct expression *expr, long long *max);
 214 int get_absolute_min(struct expression *expr, long long *val);
 215 int get_absolute_max(struct expression *expr, long long *val);
 216 int is_zero(struct expression *expr);
 217 int is_array(struct expression *expr);
 218 struct expression *get_array_name(struct expression *expr);
 219 struct expression *get_array_offset(struct expression *expr);
 220 const char *show_state(struct smatch_state *state);
 221 struct statement *get_expression_statement(struct expression *expr);
 222 struct expression *strip_parens(struct expression *expr);
 223 struct expression *strip_expr(struct expression *expr);
 224 void scoped_state(int my_id, const char *name, struct symbol *sym);
 225 int is_error_return(struct expression *expr);
 226 int getting_address(void);
 227
 228 /* smatch_type.c */
 229 struct symbol *get_type(struct expression *expr);
 230 int type_unsigned(struct symbol *base_type);
 231 int returns_unsigned(struct symbol *base_type);
 232 int returns_pointer(struct symbol *base_type);
 233 long long type_max(struct symbol *base_type);
 234 long long type_min(struct symbol *base_type);
 235
 236 /* smatch_ignore.c */
 237 void add_ignore(int owner, const char *name, struct symbol *sym);
 238 int is_ignored(int owner, const char *name, struct symbol *sym);
 239
 240 /* smatch_tracker */
 241 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
 242 void add_tracker(struct tracker_list **list, int owner, const char *name,
 243                 struct symbol *sym);
 244 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
 245 void del_tracker(struct tracker_list **list, int owner, const char *name,
 246                 struct symbol *sym);
 247 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
 248                 struct symbol *sym);
 249 struct tracker_list *clone_tracker_list(struct tracker_list *orig_list);
 250 void free_tracker_list(struct tracker_list **list);
 251 void free_trackers_and_list(struct tracker_list **list);
 252
 253 /* smatch_conditions */
 254 int in_condition(void);
 255
 256 /* smatch_flow.c */
 257
 258 void smatch (int argc, char **argv);
 259 int inside_loop(void);
 260 int in_expression_statement(void);
 261 void __split_expr(struct expression *expr);
 262 void __split_stmt(struct statement *stmt);
 263 extern int option_assume_loops;
 264 extern int option_known_conditions;
 265 extern int option_two_passes;
 266 extern int option_no_db;
 267 extern struct expression_list *big_expression_stack;
 268 extern struct statement_list *big_statement_stack;
 269 extern int __in_pre_condition;
 270 extern int __bail_on_rest_of_function;
 271
 272 /* smatch_conditions */
 273 void __split_whole_condition(struct expression *expr);
 274 void __handle_logic(struct expression *expr);
 275 int __handle_condition_assigns(struct expression *expr);
 276 int __handle_select_assigns(struct expression *expr);
 277 int __handle_expr_statement_assigns(struct expression *expr);
 278
 279 /* smatch_implied.c */
 280 extern int option_debug_implied;
 281 extern int option_no_implied;
 282 void get_implications(char *name, struct symbol *sym, int comparison, long long num,
 283                       struct state_list **true_states,
 284                       struct state_list **false_states);
 285 struct range_list_stack;
 286 struct state_list *__implied_case_slist(struct expression *switch_expr,
 287                                         struct expression *case_expr,
 288                                         struct range_list_stack **remaining_cases,
 289                                         struct state_list **raw_slist);
 290 struct range_list *__get_implied_values(struct expression *switch_expr);
 291
 292 /* smatch_extras.c */
 293 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
 294
 295 struct data_range {
 296         long long min;
 297         long long max;
 298 };
 299 extern struct data_range whole_range;
 300
 301 int known_condition_true(struct expression *expr);
 302 int known_condition_false(struct expression *expr);
 303 int implied_condition_true(struct expression *expr);
 304 int implied_condition_false(struct expression *expr);
 305
 306 /* smatch_states.c */
 307 void __push_fake_cur_slist();
 308 struct state_list *__pop_fake_cur_slist();
 309
 310 int unreachable(void);
 311 void __set_sm(struct sm_state *sm);
 312 struct state_list *__get_cur_slist(void);
 313 void __set_true_false_sm(struct sm_state *true_state,
 314                         struct sm_state *false_state);
 315 void nullify_path(void);
 316 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 317                                void *unused);
 318 void __unnullify_path(void);
 319 int __path_is_null(void);
 320 void clear_all_states(void);
 321
 322 struct sm_state *get_sm_state(int owner, const char *name,
 323                                 struct symbol *sym);
 324 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
 325 void __push_true_states(void);
 326 void __use_false_states(void);
 327 void __discard_false_states(void);
 328 void __merge_false_states(void);
 329 void __merge_true_states(void);
 330
 331 void __negate_cond_stacks(void);
 332 void __use_pre_cond_states(void);
 333 void __use_cond_true_states(void);
 334 void __use_cond_false_states(void);
 335 void __push_cond_stacks(void);
 336 struct state_list *__copy_cond_true_states(void);
 337 struct state_list *__copy_cond_false_states(void);
 338 struct state_list *__pop_cond_true_stack(void);
 339 struct state_list *__pop_cond_false_stack(void);
 340 void __and_cond_states(void);
 341 void __or_cond_states(void);
 342 void __save_pre_cond_states(void);
 343 void __discard_pre_cond_states(void);
 344 void __use_cond_states(void);
 345
 346 void __warn_on_silly_pre_loops(void);
 347
 348 void __push_continues(void);
 349 void __discard_continues(void);
 350 void __process_continues(void);
 351 void __merge_continues(void);
 352
 353 void __push_breaks(void);
 354 void __process_breaks(void);
 355 void __merge_breaks(void);
 356 void __use_breaks(void);
 357
 358 void __save_switch_states(struct expression *switch_expr);
 359 void __discard_switches(void);
 360 void __merge_switches(struct expression *switch_expr, struct expression *case_expr);
 361 void __push_default(void);
 362 void __set_default(void);
 363 int __pop_default(void);
 364
 365 void __push_conditions(void);
 366 void __discard_conditions(void);
 367
 368 void __save_gotos(const char *name);
 369 void __merge_gotos(const char *name);
 370
 371 void __print_cur_slist(void);
 372
 373 /* smatch_hooks.c */
 374 void __pass_to_client(void *data, enum hook_type type);
 375 void __pass_to_client_no_data(enum hook_type type);
 376 void __pass_case_to_client(struct expression *switch_expr,
 377                            struct expression *case_expr);
 378 int __has_merge_function(int client_id);
 379 struct smatch_state *__client_merge_function(int owner, const char *name,
 380                                              struct symbol *sym,
 381                                              struct smatch_state *s1,
 382                                              struct smatch_state *s2);
 383 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 384 void __push_scope_hooks(void);
 385 void __call_scope_hooks(void);
 386
 387 /* smatch_function_hooks.c */
 388 void create_function_hook_hash(void);
 389 void __match_initializer_call(struct symbol *sym);
 390
 391 /* smatch_db.c */
 392 #define run_sql(call_back, sql...)    \
 393 do {                                  \
 394         char sql_txt[1024];           \
 395         snprintf(sql_txt, 1024, sql); \
 396         sql_txt[1023] = '\0';         \
 397         sql_exec(call_back, sql_txt); \
 398 } while (0)
 399
 400 void sql_exec(int (*callback)(void*, int, char**, char**), const char *sql);
 401 void open_smatch_db(void);
 402
 403 /* smatch_files.c */
 404 struct token *get_tokens_file(const char *filename);
 405
 406 /* smatch.c */
 407 extern char *option_project_str;
 408 extern char *data_dir;
 409 extern int option_no_data;
 410 extern int option_spammy;
 411 extern int option_full_path;
 412 extern int option_param_mapper;
 413 extern int option_print_returns;
 414 extern int option_info;
 415 extern int option_call_tree;
 416 extern int num_checks;
 417
 418 enum project_type {
 419         PROJ_NONE,
 420         PROJ_KERNEL,
 421         PROJ_WINE,
 422 };
 423 extern enum project_type option_project;
 424 const char *check_name(unsigned short id);
 425
 426
 427 /* smatch_buf_size.c */
 428 int get_array_size(struct expression *expr);
 429 int get_array_size_bytes(struct expression *expr);
 430
 431 /* check_locking.c */
 432 void print_held_locks();
 433
 434 #endif      /* !SMATCH_H_ */