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 #define KERNEL
  22 #define MAXSMSTATES 1000000 /* Limits RAM use.  Give up on big functions */
  23 struct smatch_state {
  24         const char *name;
  25         void *data;
  26 };
  27 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
  28 extern struct smatch_state undefined;
  29 extern struct smatch_state merged;
  30 extern struct smatch_state true_state;
  31 extern struct smatch_state false_state;
  32 DECLARE_ALLOCATOR(smatch_state);
  33
  34 static inline void *INT_PTR(int i)
  35 {
  36         return (void *)(long)i;
  37 }
  38
  39 static inline int PTR_INT(void *p)
  40 {
  41         return (int)(long)p;
  42 }
  43
  44 struct sm_state {
  45         const char *name;
  46         unsigned int owner;
  47         struct symbol *sym;
  48         struct smatch_state *state;
  49         int line;
  50         int merged;
  51         struct state_list_stack *my_pools;
  52         struct state_list *pre_merge;
  53         struct state_list *possible;
  54 };
  55
  56 enum hook_type {
  57         EXPR_HOOK,
  58         STMT_HOOK,
  59         SYM_HOOK,
  60         DECLARATION_HOOK,
  61         ASSIGNMENT_HOOK,
  62         CONDITION_HOOK,
  63         WHOLE_CONDITION_HOOK,
  64         FUNCTION_CALL_HOOK,
  65         CALL_ASSIGNMENT_HOOK,
  66         OP_HOOK,
  67         DEREF_HOOK,
  68         CASE_HOOK,
  69         BASE_HOOK,
  70         FUNC_DEF_HOOK,
  71         END_FUNC_HOOK,
  72         RETURN_HOOK,
  73         END_FILE_HOOK,
  74 };
  75 void add_hook(void *func, enum hook_type type);
  76 typedef struct smatch_state *(merge_func_t)(const char *name,
  77                                             struct symbol *sym,
  78                                             struct smatch_state *s1,
  79                                             struct smatch_state *s2);
  80 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
  81 void add_merge_hook(int client_id, merge_func_t *func);
  82 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
  83 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
  84 void add_function_hook(const char *lock_for, func_hook *call_back, void *data);
  85
  86 void add_conditional_hook(const char *look_for, func_hook *call_back, void *data);
  87 void add_function_assign_hook(const char *look_for, func_hook *call_back,
  88                               void *info);
  89 void return_implies_state(const char *look_for, long long start, long long end,
  90                          func_hook *call_back, void *info);
  91
  92 #define smatch_msg(msg...) \
  93 do {                                                          \
  94         printf("%s +%d %s(%d) ", get_filename(), get_lineno(), \
  95                get_function(), get_func_pos());               \
  96         printf(msg);                                          \
  97         printf("\n");                                         \
  98 } while (0)
  99
 100 #define SM_DEBUG(msg...) do { if (debug_states) printf(msg); } while (0)
 101 #define DIMPLIED(msg...) do { if (debug_implied_states) printf(msg); } while (0)
 102
 103 #define UNDEFINED INT_MIN
 104
 105 struct smatch_state *get_state(const char *name, int owner, struct symbol *sym);
 106 struct state_list *get_possible_states(const char *name, int owner,
 107                                        struct symbol *sym);
 108 void set_state(const char *name, int owner, struct symbol *sym,
 109                struct smatch_state *state);
 110 void delete_state(const char *name, int owner, struct symbol *sym);
 111 void set_true_false_states(const char *name, int owner, struct symbol *sym,
 112                            struct smatch_state *true_state,
 113                            struct smatch_state *false_state);
 114
 115 struct state_list *get_all_states(int id);
 116 int is_reachable();
 117 char *get_filename();
 118 char *get_function();
 119 int get_lineno();
 120 int get_func_pos();
 121
 122 /* smatch_helper.c */
 123 char *alloc_string(const char *str);
 124 void free_string(char *str);
 125 struct expression *get_argument_from_call_expr(struct expression_list *args,
 126                                                int num);
 127 char *get_variable_from_expr_complex(struct expression *expr,
 128                                      struct symbol **sym_ptr);
 129 char *get_variable_from_expr(struct expression *expr,
 130                              struct symbol **sym_ptr);
 131 struct symbol *get_ptr_type(struct expression *expr);
 132 int sym_name_is(const char *name, struct expression *expr);
 133 int get_value(struct expression *expr);
 134 int is_zero(struct expression *expr);
 135 const char *show_state(struct smatch_state *state);
 136 struct statement *get_block_thing(struct expression *expr);
 137 struct expression *strip_expr(struct expression *expr);
 138
 139 /* smatch_ignore.c */
 140 struct tracker {
 141         char *name;
 142         int owner;
 143         struct symbol *sym;
 144 };
 145 DECLARE_PTR_LIST(tracker_list, struct tracker);
 146
 147 void add_ignore(const char *name, int owner, struct symbol *sym);
 148 int is_ignored(const char *name, int owner, struct symbol *sym);
 149
 150 /* smatch_tracker */
 151 void add_tracker(struct tracker_list **list, const char *name, int owner,
 152                 struct symbol *sym);
 153 void del_tracker(struct tracker_list **list, const char *name, int owner,
 154                 struct symbol *sym);
 155 int in_tracker_list(struct tracker_list *list, const char *name, int owner,
 156                 struct symbol *sym);
 157 void free_tracker_list(struct tracker_list **list);
 158 void free_trackers_and_list(struct tracker_list **list);
 159
 160 /* smatch_conditions */
 161 int in_condition();
 162
 163 /* ----------------------------------------------------------------
 164    The stuff below is all used internally and shouldn't
 165    be called from other programs
 166  -----------------------------------------------------------------*/
 167
 168 /* smatch_flow.c */
 169
 170 void smatch (int argc, char **argv);
 171 void __split_expr(struct expression *expr);
 172 void __split_statements(struct statement *stmt);
 173 extern int option_assume_loops;
 174 extern int option_known_conditions;
 175
 176 /* smatch_conditions */
 177 void __split_whole_condition(struct expression *expr);
 178
 179 /* smatch_implied.c */
 180 extern int debug_implied_states;
 181 extern int option_no_implied;
 182 void get_implications(char *name, struct symbol *sym, int comparison, int num,
 183                       struct state_list **true_states,
 184                       struct state_list **false_states);
 185 struct state_list *__implied_case_slist(struct expression *switch_expr,
 186                                         struct expression *case_expr,
 187                                         struct state_list **raw_slist);
 188
 189 /* smatch_extras.c */
 190 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
 191
 192 struct data_range {
 193         long long min;
 194         long long max;
 195 };
 196 extern struct data_range whole_range;
 197
 198 int get_implied_value(struct expression *expr);
 199 int true_comparison(int left, int comparison, int right);
 200 int known_condition_true(struct expression *expr);
 201 int known_condition_false(struct expression *expr);
 202 int implied_condition_true(struct expression *expr);
 203 int implied_condition_false(struct expression *expr);
 204
 205 /* smatch_states.c */
 206 extern int debug_states;
 207
 208 extern int __fake_cur;
 209 extern struct state_list *__fake_cur_slist;
 210 extern int __fake_conditions;
 211 extern struct state_list *__fake_cond_true;
 212 extern struct state_list *__fake_cond_false;
 213
 214
 215 void __set_state(struct sm_state *sm);
 216 struct state_list *__get_cur_slist();
 217 void __set_true_false_sm(struct sm_state *true_state,
 218                         struct sm_state *false_state);
 219 void nullify_path();
 220 void __match_nullify_path_hook(const char *fn, struct expression *expr,
 221                                void *unused);
 222 void __unnullify_path();
 223 int __path_is_null();
 224 void clear_all_states();
 225
 226 struct sm_state *get_sm_state(const char *name, int owner,
 227                                 struct symbol *sym);
 228 void __use_false_only_stack();
 229 void __pop_false_only_stack();
 230 void __push_true_states();
 231 void __use_false_states();
 232 void __pop_false_states();
 233 void __merge_false_states();
 234 void __merge_true_states();
 235
 236 void __negate_cond_stacks();
 237 void __save_false_states_for_later();
 238 void __use_previously_stored_false_states();
 239 void __use_cond_true_states();
 240 void __use_cond_false_states();
 241 void __push_cond_stacks();
 242 void __and_cond_states();
 243 void __or_cond_states();
 244 void __save_pre_cond_states();
 245 void __pop_pre_cond_states();
 246 void __use_cond_states();
 247
 248 void __warn_on_silly_pre_loops();
 249
 250 void __push_continues();
 251 void __pop_continues();
 252 void __process_continues();
 253 void __merge_continues();
 254
 255 void __push_breaks();
 256 void __process_breaks();
 257 void __merge_breaks();
 258 void __use_breaks();
 259
 260 void __save_switch_states();
 261 void __pop_switches();
 262 void __merge_switches(struct expression *switch_expr, struct expression *case_expr);
 263 void __push_default();
 264 void __set_default();
 265 int __pop_default();
 266
 267 void __push_conditions();
 268 void __pop_conditions();
 269
 270 void __save_gotos(const char *name);
 271 void __merge_gotos(const char *name);
 272
 273 void __print_cur_slist();
 274
 275 /* smatch_hooks.c */
 276 void __pass_to_client(void *data, enum hook_type type);
 277 void __pass_to_client_no_data(enum hook_type type);
 278 void __pass_case_to_client(struct expression *switch_expr,
 279                            struct expression *case_expr);
 280 int __has_merge_function(int client_id);
 281 struct smatch_state *__client_merge_function(int owner, const char *name,
 282                                              struct symbol *sym,
 283                                              struct smatch_state *s1,
 284                                              struct smatch_state *s2);
 285 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
 286
 287 /* smatch_function_hooks.c */
 288 struct fcall_back {
 289         int type;
 290         struct data_range *range;
 291         func_hook *call_back;
 292         void *info;
 293 };
 294 DECLARE_ALLOCATOR(fcall_back);
 295 DECLARE_PTR_LIST(call_back_list, struct fcall_back);
 296 void create_function_hash(void);
 297 void __match_initializer_call(struct symbol *sym);
 298
 299 /* smatch_files.c */
 300 struct token *get_tokens_file(const char *filename);
 301
 302 /* smatch.c */
 303 extern char *data_dir;
 304 extern int option_no_data;
 305
 306 #endif      /* !SMATCH_H_ */