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         DECLARATION_HOOK,
  70         ASSIGNMENT_HOOK,
  71         CONDITION_HOOK,
  72         WHOLE_CONDITION_HOOK,
  73         FUNCTION_CALL_HOOK,
  74         CALL_ASSIGNMENT_HOOK,
  75         OP_HOOK,
  76         DEREF_HOOK,
  77         CASE_HOOK,
  78         BASE_HOOK,
  79         FUNC_DEF_HOOK,
  80         END_FUNC_HOOK,
  81         RETURN_HOOK,
  82         END_FILE_HOOK,
  83 };
  84 void add_hook(void *func, enum hook_type type);
  85 typedef struct smatch_state *(merge_func_t)(const char *name,
  86                                             struct symbol *sym,
  87                                             struct smatch_state *s1,
  88                                             struct smatch_state *s2);
  89 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
  90 void add_merge_hook(int client_id, merge_func_t *func);
  91 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
  92 typedef void (scope_hook)(void *data);
  93 void add_scope_hook(scope_hook *hook, void *data);
  94 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
  95 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
  96                                 struct expression *assign_expr, void *data);
  97 void add_function_hook(const char *lock_for, func_hook *call_back, void *data);
  98
  99 void add_conditional_hook(const char *look_for, func_hook *call_back, void *data);
 100 void add_function_assign_hook(const char *look_for, func_hook *call_back,
 101                               void *info);
 102 void return_implies_state(const char *look_for, long long start, long long end,
 103                          implication_hook *call_back, void *info);
 104 typedef void (modification_hook)(const char *name, struct symbol *sym,
 105                                 struct expression *expr, void *data);
 106 void add_modification_hook(const char *variable, modification_hook *hook,
 107                         void *data);
 108 int is_member(struct expression *expr);
 109 void reset_on_container_modified(int owner, struct expression *expr);
 110 void set_default_state(int owner, struct smatch_state *state);
 111
 112 extern int final_pass;
 113
 114 #define sm_printf(msg...) do { if (final_pass) printf(msg); } while (0) \
 115
 116 #define sm_msg(msg...) \
 117 do {                                                          \
 118         if (!final_pass)                                      \
 119                 break;                                        \
 120         printf("%s +%d %s(%d) ", get_filename(), get_lineno(), \
 121                get_function(), get_func_pos());               \
 122         printf(msg);                                          \
 123         printf("\n");                                         \
 124 } while (0)
 125
 126 #define sm_debug(msg...) do { if (debug_states) printf(msg); } while (0)
 127
 128 #define UNDEFINED INT_MIN
 129 #define POINTER_MAX 0xffffffff
 130
 131 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
 132 struct smatch_state *get_state_expr(int owner, struct expression *expr);
 133 struct state_list *get_possible_states(int owner, const char *name,
 134                                        struct symbol *sym);
 135 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
 136 void set_state(int owner, const char *name, struct symbol *sym,
 137                struct smatch_state *state);
 138 void set_state_expr(int owner, struct expression *expr,
 139                 struct smatch_state *state);
 140 void delete_state(int owner, const char *name, struct symbol *sym);
 141 void delete_state_expr(int owner, struct expression *expr);
 142 void set_true_false_states(int owner, const char *name, struct symbol *sym,
 143                            struct smatch_state *true_state,
 144                            struct smatch_state *false_state);
 145 void set_true_false_states_expr(int owner, struct expression *expr,
 146                            struct smatch_state *true_state,
 147                            struct smatch_state *false_state);
 148
 149 struct state_list *get_all_states(int id);
 150 int is_reachable();
 151 char *get_filename();
 152 char *get_function();
 153 int get_lineno();
 154 int get_func_pos();
 155
 156 /* smatch_helper.c */
 157 char *alloc_string(const char *str);
 158 void free_string(char *str);
 159 struct expression *get_argument_from_call_expr(struct expression_list *args,
 160                                                int num);
 161 char *get_variable_from_expr_complex(struct expression *expr,
 162                                      struct symbol **sym_ptr);
 163 char *get_variable_from_expr(struct expression *expr,
 164                              struct symbol **sym_ptr);
 165 struct symbol *get_ptr_type(struct expression *expr);
 166 int sym_name_is(const char *name, struct expression *expr);
 167 int get_value(struct expression *expr);
 168 int get_implied_value(struct expression *expr);
 169 int is_zero(struct expression *expr);
 170 int is_array(struct expression *expr);
 171 struct expression *get_array_name(struct expression *expr);
 172 struct expression *get_array_offset(struct expression *expr);
 173 const char *show_state(struct smatch_state *state);
 174 struct statement *get_block_thing(struct expression *expr);
 175 struct expression *strip_expr(struct expression *expr);
 176 void scoped_state(const char *name, int my_id, struct symbol *sym);
 177 int is_error_return(struct expression *expr);
 178
 179 /* smatch_ignore.c */
 180 void add_ignore(int owner, const char *name, struct symbol *sym);
 181 int is_ignored(int owner, const char *name, struct symbol *sym);
 182
 183 /* smatch_tracker */
 184 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
 185 void add_tracker(struct tracker_list **list, int owner, const char *name,
 186                 struct symbol *sym);
 187 void del_tracker(struct tracker_list **list, int owner, const char *name,
 188                 struct symbol *sym);
 189 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
 190                 struct symbol *sym);
 191 void free_tracker_list(struct tracker_list **list);
 192 void free_trackers_and_list(struct tracker_list **list);
 193
 194 /* smatch_conditions */
 195 int in_condition();
 196
 197 /* ----------------------------------------------------------------
 198    The stuff below is all used internally and shouldn't
 199    be called from other programs
 200  -----------------------------------------------------------------*/
 201
 202 /* smatch_flow.c */
 203
 204 void smatch (int argc, char **argv);
 205 void __split_expr(struct expression *expr);
 206 void __split_statements(struct statement *stmt);
 207 extern int option_assume_loops;
 208 extern int option_known_conditions;
 209 extern int option_two_passes;
 210 extern struct symbol *cur_func_sym;
 211
 212 /* smatch_conditions */
 213 void __split_whole_condition(struct expression *expr);
 214
 215 /* smatch_implied.c */
 216 extern int debug_implied_states;
 217 extern int option_no_implied;
 218 void get_implications(char *name, struct symbol *sym, int comparison, int num,
 219                       struct state_list **true_states,
 220                       struct state_list **false_states);
 221 struct range_list_stack;
 222 struct state_list *__implied_case_slist(struct expression *switch_expr,
 223                                         struct expression *case_expr,
 224                                         struct range_list_stack **remaining_cases,
 225                                         struct state_list **raw_slist);
 226 struct range_list *__get_implied_values(struct expression *switch_expr);
 227
 228 /* smatch_extras.c */
 229 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
 230
 231 struct data_range {
 232         long long min;
 233         long long max;
 234 };
 235 extern struct data_range whole_range;
 236
 237 int get_implied_single_val(struct expression *expr);
 238 int get_implied_max(struct expression *expr);
 239 int get_implied_min(struct expression *expr);
 240 int true_comparison(int left, int comparison, int right);
 241 int known_condition_true(struct expression *expr);
 242 int known_condition_false(struct expression *expr);
 243 int implied_condition_true(struct expression *expr);
 244 int implied_condition_false(struct expression *expr);
 245
 246 /* smatch_states.c */
 247 extern int debug_states;
 248
 249 extern int __fake_cur;
 250 extern struct state_list *__fake_cur_slist;
 251 extern int __fake_conditions;
 252 extern struct state_list *__fake_cond_true;
 253 extern struct state_list *__fake_cond_false;
 254
 255
 256 void __set_state(struct sm_state *sm);
 257 struct state_list *__get_cur_slist();
 258 void __set_true_false_sm(struct sm_state *true_state,
 259                         struct sm_state *false_state);
 260 void nullify_path();
 261 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 262                                void *unused);
 263 void __unnullify_path();
 264 int __path_is_null();
 265 void clear_all_states();
 266
 267 struct sm_state *get_sm_state(int owner, const char *name,
 268                                 struct symbol *sym);
 269 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
 270 void __use_false_only_stack();
 271 void __pop_false_only_stack();
 272 void __push_true_states();
 273 void __use_false_states();
 274 void __pop_false_states();
 275 void __merge_false_states();
 276 void __merge_true_states();
 277
 278 void __negate_cond_stacks();
 279 void __save_false_states_for_later();
 280 void __use_previously_stored_false_states();
 281 void __use_cond_true_states();
 282 void __use_cond_false_states();
 283 void __push_cond_stacks();
 284 void __and_cond_states();
 285 void __or_cond_states();
 286 void __save_pre_cond_states();
 287 void __pop_pre_cond_states();
 288 void __use_cond_states();
 289
 290 void __warn_on_silly_pre_loops();
 291
 292 void __push_continues();
 293 void __pop_continues();
 294 void __process_continues();
 295 void __merge_continues();
 296
 297 void __push_breaks();
 298 void __process_breaks();
 299 void __merge_breaks();
 300 void __use_breaks();
 301
 302 void __save_switch_states(struct expression *switch_expr);
 303 void __pop_switches();
 304 void __merge_switches(struct expression *switch_expr, struct expression *case_expr);
 305 void __push_default();
 306 void __set_default();
 307 int __pop_default();
 308
 309 void __push_conditions();
 310 void __pop_conditions();
 311
 312 void __save_gotos(const char *name);
 313 void __merge_gotos(const char *name);
 314
 315 void __print_cur_slist();
 316
 317 /* smatch_hooks.c */
 318 void __pass_to_client(void *data, enum hook_type type);
 319 void __pass_to_client_no_data(enum hook_type type);
 320 void __pass_case_to_client(struct expression *switch_expr,
 321                            struct expression *case_expr);
 322 int __has_merge_function(int client_id);
 323 struct smatch_state *__client_merge_function(int owner, const char *name,
 324                                              struct symbol *sym,
 325                                              struct smatch_state *s1,
 326                                              struct smatch_state *s2);
 327 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 328 void __push_scope_hooks(void);
 329 void __call_scope_hooks(void);
 330
 331 /* smatch_function_hooks.c */
 332 void create_function_hash(void);
 333 void __match_initializer_call(struct symbol *sym);
 334
 335 /* smatch_files.c */
 336 struct token *get_tokens_file(const char *filename);
 337
 338 /* smatch_oom.c */
 339 extern int option_oom_kb;
 340 int out_of_memory();
 341
 342 /* smatch.c */
 343 extern char *option_project_str;
 344 extern char *data_dir;
 345 extern int option_no_data;
 346 extern int option_spammy;
 347 extern struct smatch_state *default_state[];
 348
 349 enum project_type {
 350         PROJ_NONE,
 351         PROJ_KERNEL,
 352 };
 353 extern enum project_type option_project;
 354
 355
 356 #endif      /* !SMATCH_H_ */