4 * Copyright (C) 2006 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
19 #include "expression.h"
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
);
32 static inline void *INT_PTR(int i
)
34 return (void *)(long)i
;
37 static inline int PTR_INT(void *p
)
44 unsigned int merged
:1;
45 unsigned int implied
:1;
48 struct smatch_state
*state
;
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
;
62 DECLARE_ALLOCATOR(tracker
);
63 DECLARE_PTR_LIST(tracker_list
, struct tracker
);
88 void add_hook(void *func
, enum hook_type type
);
89 typedef struct smatch_state
*(merge_func_t
)(const char *name
,
91 struct smatch_state
*s1
,
92 struct smatch_state
*s2
);
93 typedef struct smatch_state
*(unmatched_func_t
)(struct sm_state
*state
);
94 void add_merge_hook(int client_id
, merge_func_t
*func
);
95 void add_unmatched_state_hook(int client_id
, unmatched_func_t
*func
);
96 typedef void (scope_hook
)(void *data
);
97 void add_scope_hook(scope_hook
*hook
, void *data
);
98 typedef void (func_hook
)(const char *fn
, struct expression
*expr
, void *data
);
99 typedef void (implication_hook
)(const char *fn
, struct expression
*call_expr
,
100 struct expression
*assign_expr
, void *data
);
101 void add_function_hook(const char *lock_for
, func_hook
*call_back
, void *data
);
103 void add_conditional_hook(const char *look_for
, func_hook
*call_back
, void *data
);
104 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
106 void return_implies_state(const char *look_for
, long long start
, long long end
,
107 implication_hook
*call_back
, void *info
);
108 typedef void (modification_hook
)(const char *name
, struct symbol
*sym
,
109 struct expression
*expr
, void *data
);
110 void add_modification_hook(const char *variable
, modification_hook
*hook
,
112 int is_member(struct expression
*expr
);
113 void reset_on_container_modified(int owner
, struct expression
*expr
);
114 void set_default_state(int owner
, struct smatch_state
*state
);
116 extern int final_pass
;
118 #define sm_printf(msg...) do { if (final_pass) printf(msg); } while (0) \
120 #define sm_msg(msg...) \
124 printf("%s +%d %s(%d) ", get_filename(), get_lineno(), \
125 get_function(), get_func_pos()); \
130 #define sm_debug(msg...) do { if (debug_states) printf(msg); } while (0)
132 #define POINTER_MAX 0xffffffff
134 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
135 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
136 struct state_list
*get_possible_states(int owner
, const char *name
,
138 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
139 void set_state(int owner
, const char *name
, struct symbol
*sym
,
140 struct smatch_state
*state
);
141 void set_state_expr(int owner
, struct expression
*expr
,
142 struct smatch_state
*state
);
143 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
144 void delete_state_expr(int owner
, struct expression
*expr
);
145 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
146 struct smatch_state
*true_state
,
147 struct smatch_state
*false_state
);
148 void set_true_false_states_expr(int owner
, struct expression
*expr
,
149 struct smatch_state
*true_state
,
150 struct smatch_state
*false_state
);
152 struct state_list
*get_all_states(int id
);
154 char *get_filename();
155 char *get_function();
159 /* smatch_helper.c */
160 char *alloc_string(const char *str
);
161 void free_string(char *str
);
162 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
164 char *get_variable_from_expr_complex(struct expression
*expr
,
165 struct symbol
**sym_ptr
);
166 char *get_variable_from_expr(struct expression
*expr
,
167 struct symbol
**sym_ptr
);
168 int sym_name_is(const char *name
, struct expression
*expr
);
169 int get_value(struct expression
*expr
, long long *val
);
170 int get_implied_value(struct expression
*expr
, long long *val
);
171 int is_zero(struct expression
*expr
);
172 int is_array(struct expression
*expr
);
173 struct expression
*get_array_name(struct expression
*expr
);
174 struct expression
*get_array_offset(struct expression
*expr
);
175 const char *show_state(struct smatch_state
*state
);
176 struct statement
*get_block_thing(struct expression
*expr
);
177 struct expression
*strip_expr(struct expression
*expr
);
178 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
179 int is_error_return(struct expression
*expr
);
182 struct symbol
*get_type(struct expression
*expr
);
184 /* smatch_ignore.c */
185 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
186 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
189 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
190 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
192 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
194 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
196 void free_tracker_list(struct tracker_list
**list
);
197 void free_trackers_and_list(struct tracker_list
**list
);
199 /* smatch_conditions */
202 /* ----------------------------------------------------------------
203 The stuff below is all used internally and shouldn't
204 be called from other programs
205 -----------------------------------------------------------------*/
209 void smatch (int argc
, char **argv
);
210 void __split_expr(struct expression
*expr
);
211 void __split_statements(struct statement
*stmt
);
212 extern int option_assume_loops
;
213 extern int option_known_conditions
;
214 extern int option_two_passes
;
215 extern struct symbol
*cur_func_sym
;
217 /* smatch_conditions */
218 void __split_whole_condition(struct expression
*expr
);
220 /* smatch_implied.c */
221 extern int debug_implied_states
;
222 extern int option_no_implied
;
223 void get_implications(char *name
, struct symbol
*sym
, int comparison
, int num
,
224 struct state_list
**true_states
,
225 struct state_list
**false_states
);
226 struct range_list_stack
;
227 struct state_list
*__implied_case_slist(struct expression
*switch_expr
,
228 struct expression
*case_expr
,
229 struct range_list_stack
**remaining_cases
,
230 struct state_list
**raw_slist
);
231 struct range_list
*__get_implied_values(struct expression
*switch_expr
);
233 /* smatch_extras.c */
234 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
240 extern struct data_range whole_range
;
242 int get_implied_single_val(struct expression
*expr
, long long *val
);
243 int get_implied_max(struct expression
*expr
, long long *val
);
244 int get_implied_min(struct expression
*expr
, long long *val
);
245 int true_comparison(int left
, int comparison
, int right
);
246 int known_condition_true(struct expression
*expr
);
247 int known_condition_false(struct expression
*expr
);
248 int implied_condition_true(struct expression
*expr
);
249 int implied_condition_false(struct expression
*expr
);
251 /* smatch_states.c */
252 extern int debug_states
;
254 extern int __fake_cur
;
255 extern struct state_list
*__fake_cur_slist
;
256 extern int __fake_conditions
;
257 extern struct state_list
*__fake_cond_true
;
258 extern struct state_list
*__fake_cond_false
;
261 void __set_state(struct sm_state
*sm
);
262 struct state_list
*__get_cur_slist();
263 void __set_true_false_sm(struct sm_state
*true_state
,
264 struct sm_state
*false_state
);
266 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
268 void __unnullify_path();
269 int __path_is_null();
270 void clear_all_states();
272 struct sm_state
*get_sm_state(int owner
, const char *name
,
274 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
275 void __use_false_only_stack();
276 void __pop_false_only_stack();
277 void __push_true_states();
278 void __use_false_states();
279 void __pop_false_states();
280 void __merge_false_states();
281 void __merge_true_states();
283 void __negate_cond_stacks();
284 void __save_false_states_for_later();
285 void __use_previously_stored_false_states();
286 void __use_cond_true_states();
287 void __use_cond_false_states();
288 void __push_cond_stacks();
289 void __and_cond_states();
290 void __or_cond_states();
291 void __save_pre_cond_states();
292 void __pop_pre_cond_states();
293 void __use_cond_states();
295 void __warn_on_silly_pre_loops();
297 void __push_continues();
298 void __pop_continues();
299 void __process_continues();
300 void __merge_continues();
302 void __push_breaks();
303 void __process_breaks();
304 void __merge_breaks();
307 void __save_switch_states(struct expression
*switch_expr
);
308 void __pop_switches();
309 void __merge_switches(struct expression
*switch_expr
, struct expression
*case_expr
);
310 void __push_default();
311 void __set_default();
314 void __push_conditions();
315 void __pop_conditions();
317 void __save_gotos(const char *name
);
318 void __merge_gotos(const char *name
);
320 void __print_cur_slist();
323 void __pass_to_client(void *data
, enum hook_type type
);
324 void __pass_to_client_no_data(enum hook_type type
);
325 void __pass_case_to_client(struct expression
*switch_expr
,
326 struct expression
*case_expr
);
327 int __has_merge_function(int client_id
);
328 struct smatch_state
*__client_merge_function(int owner
, const char *name
,
330 struct smatch_state
*s1
,
331 struct smatch_state
*s2
);
332 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
333 void __push_scope_hooks(void);
334 void __call_scope_hooks(void);
336 /* smatch_function_hooks.c */
337 void create_function_hash(void);
338 void __match_initializer_call(struct symbol
*sym
);
341 struct token
*get_tokens_file(const char *filename
);
344 extern int option_oom_kb
;
348 extern char *option_project_str
;
349 extern char *data_dir
;
350 extern int option_no_data
;
351 extern int option_spammy
;
352 extern int option_full_path
;
353 extern struct smatch_state
*default_state
[];
360 extern enum project_type option_project
;
361 const char *check_name(unsigned short id
);
363 #endif /* !SMATCH_H_ */