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
);
89 void add_hook(void *func
, enum hook_type type
);
90 typedef struct smatch_state
*(merge_func_t
)(const char *name
,
92 struct smatch_state
*s1
,
93 struct smatch_state
*s2
);
94 typedef struct smatch_state
*(unmatched_func_t
)(struct sm_state
*state
);
95 void add_merge_hook(int client_id
, merge_func_t
*func
);
96 void add_unmatched_state_hook(int client_id
, unmatched_func_t
*func
);
97 typedef void (scope_hook
)(void *data
);
98 void add_scope_hook(scope_hook
*hook
, void *data
);
99 typedef void (func_hook
)(const char *fn
, struct expression
*expr
, void *data
);
100 typedef void (implication_hook
)(const char *fn
, struct expression
*call_expr
,
101 struct expression
*assign_expr
, void *data
);
102 void add_function_hook(const char *lock_for
, func_hook
*call_back
, void *data
);
104 void add_conditional_hook(const char *look_for
, func_hook
*call_back
, void *data
);
105 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
107 void return_implies_state(const char *look_for
, long long start
, long long end
,
108 implication_hook
*call_back
, void *info
);
109 typedef void (modification_hook
)(const char *name
, struct symbol
*sym
,
110 struct expression
*expr
, void *data
);
111 void add_modification_hook(const char *variable
, modification_hook
*hook
,
113 void add_modification_hook_expr(struct expression
*expr
, modification_hook
*call_back
, void *info
);
114 int is_member(struct expression
*expr
);
115 void reset_on_container_modified(int owner
, struct expression
*expr
);
116 void set_default_state(int owner
, struct smatch_state
*state
);
118 char *get_filename();
119 char *get_function();
122 extern int final_pass
;
124 #define sm_printf(msg...) do { if (final_pass) printf(msg); } while (0) \
126 static inline void sm_prefix()
128 printf("%s +%d %s(%d) ", get_filename(), get_lineno(), get_function(), get_func_pos());
131 #define sm_msg(msg...) \
133 if (!option_debug && !final_pass) \
140 #define sm_debug(msg...) do { if (option_debug) printf(msg); } while (0)
142 #define sm_info(msg...) do { \
143 if (option_debug || (option_info && final_pass)) { \
151 #define POINTER_MAX 0xffffffff
153 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
154 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
155 struct state_list
*get_possible_states(int owner
, const char *name
,
157 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
158 void set_state(int owner
, const char *name
, struct symbol
*sym
,
159 struct smatch_state
*state
);
160 void set_state_expr(int owner
, struct expression
*expr
,
161 struct smatch_state
*state
);
162 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
163 void delete_state_expr(int owner
, struct expression
*expr
);
164 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
165 struct smatch_state
*true_state
,
166 struct smatch_state
*false_state
);
167 void set_true_false_states_expr(int owner
, struct expression
*expr
,
168 struct smatch_state
*true_state
,
169 struct smatch_state
*false_state
);
171 struct state_list
*get_all_states(int id
);
174 /* smatch_helper.c */
175 char *alloc_string(const char *str
);
176 void free_string(char *str
);
177 struct smatch_state
*alloc_state_num(int num
);
178 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
180 char *get_variable_from_expr_complex(struct expression
*expr
,
181 struct symbol
**sym_ptr
);
182 char *get_variable_from_expr(struct expression
*expr
,
183 struct symbol
**sym_ptr
);
184 int sym_name_is(const char *name
, struct expression
*expr
);
185 int get_value(struct expression
*expr
, long long *val
);
186 int get_implied_value(struct expression
*expr
, long long *val
);
187 int get_fuzzy_max(struct expression
*expr
, long long *max
);
188 int is_zero(struct expression
*expr
);
189 int is_array(struct expression
*expr
);
190 struct expression
*get_array_name(struct expression
*expr
);
191 struct expression
*get_array_offset(struct expression
*expr
);
192 const char *show_state(struct smatch_state
*state
);
193 struct statement
*get_block_thing(struct expression
*expr
);
194 struct expression
*strip_parens(struct expression
*expr
);
195 struct expression
*strip_expr(struct expression
*expr
);
196 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
197 int is_error_return(struct expression
*expr
);
198 int getting_address();
201 struct symbol
*get_type(struct expression
*expr
);
203 /* smatch_ignore.c */
204 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
205 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
208 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
209 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
211 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
213 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
215 void free_tracker_list(struct tracker_list
**list
);
216 void free_trackers_and_list(struct tracker_list
**list
);
218 /* smatch_conditions */
223 void smatch (int argc
, char **argv
);
224 void __split_expr(struct expression
*expr
);
225 void __split_statements(struct statement
*stmt
);
226 extern int option_assume_loops
;
227 extern int option_known_conditions
;
228 extern int option_two_passes
;
229 extern struct symbol
*cur_func_sym
;
230 extern struct expression_list
*big_expression_stack
;
232 /* smatch_conditions */
233 void __split_whole_condition(struct expression
*expr
);
235 /* smatch_implied.c */
236 extern int option_debug_implied
;
237 extern int option_no_implied
;
238 void get_implications(char *name
, struct symbol
*sym
, int comparison
, int num
,
239 struct state_list
**true_states
,
240 struct state_list
**false_states
);
241 struct range_list_stack
;
242 struct state_list
*__implied_case_slist(struct expression
*switch_expr
,
243 struct expression
*case_expr
,
244 struct range_list_stack
**remaining_cases
,
245 struct state_list
**raw_slist
);
246 struct range_list
*__get_implied_values(struct expression
*switch_expr
);
248 /* smatch_extras.c */
249 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
255 extern struct data_range whole_range
;
257 int get_implied_single_val(struct expression
*expr
, long long *val
);
258 int get_implied_single_fuzzy_max(struct expression
*expr
, long long *max
);
259 int get_implied_max(struct expression
*expr
, long long *val
);
260 int get_implied_min(struct expression
*expr
, long long *val
);
261 int true_comparison(int left
, int comparison
, int right
);
262 int known_condition_true(struct expression
*expr
);
263 int known_condition_false(struct expression
*expr
);
264 int implied_condition_true(struct expression
*expr
);
265 int implied_condition_false(struct expression
*expr
);
267 /* smatch_states.c */
268 extern int option_debug
;
270 extern int __fake_cur
;
271 extern struct state_list
*__fake_cur_slist
;
272 extern int __fake_conditions
;
273 extern struct state_list
*__fake_cond_true
;
274 extern struct state_list
*__fake_cond_false
;
278 void __set_state(struct sm_state
*sm
);
279 struct state_list
*__get_cur_slist();
280 void __set_true_false_sm(struct sm_state
*true_state
,
281 struct sm_state
*false_state
);
283 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
285 void __unnullify_path();
286 int __path_is_null();
287 void clear_all_states();
289 struct sm_state
*get_sm_state(int owner
, const char *name
,
291 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
292 void __push_true_states();
293 void __use_false_states();
294 void __pop_false_states();
295 void __merge_false_states();
296 void __merge_true_states();
298 void __negate_cond_stacks();
299 void __save_false_states_for_later();
300 void __use_previously_stored_false_states();
301 void __use_cond_true_states();
302 void __use_cond_false_states();
303 void __push_cond_stacks();
304 void __and_cond_states();
305 void __or_cond_states();
306 void __save_pre_cond_states();
307 void __pop_pre_cond_states();
308 void __use_cond_states();
310 void __warn_on_silly_pre_loops();
312 void __push_continues();
313 void __pop_continues();
314 void __process_continues();
315 void __merge_continues();
317 void __push_breaks();
318 void __process_breaks();
319 void __merge_breaks();
322 void __save_switch_states(struct expression
*switch_expr
);
323 void __pop_switches();
324 void __merge_switches(struct expression
*switch_expr
, struct expression
*case_expr
);
325 void __push_default();
326 void __set_default();
329 void __push_conditions();
330 void __pop_conditions();
332 void __save_gotos(const char *name
);
333 void __merge_gotos(const char *name
);
335 void __print_cur_slist();
338 void __pass_to_client(void *data
, enum hook_type type
);
339 void __pass_to_client_no_data(enum hook_type type
);
340 void __pass_case_to_client(struct expression
*switch_expr
,
341 struct expression
*case_expr
);
342 int __has_merge_function(int client_id
);
343 struct smatch_state
*__client_merge_function(int owner
, const char *name
,
345 struct smatch_state
*s1
,
346 struct smatch_state
*s2
);
347 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
348 void __push_scope_hooks(void);
349 void __call_scope_hooks(void);
351 /* smatch_function_hooks.c */
352 void create_function_hash(void);
353 void __match_initializer_call(struct symbol
*sym
);
356 struct token
*get_tokens_file(const char *filename
);
359 extern int option_oom_kb
;
363 extern char *option_project_str
;
364 extern char *data_dir
;
365 extern int option_no_data
;
366 extern int option_spammy
;
367 extern int option_rare
;
368 extern int option_full_path
;
369 extern int option_param_mapper
;
370 extern int option_info
;
371 extern int option_call_tree
;
373 extern struct smatch_state
*default_state
[];
380 extern enum project_type option_project
;
381 const char *check_name(unsigned short id
);
383 #endif /* !SMATCH_H_ */