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 int is_member(struct expression
*expr
);
114 void reset_on_container_modified(int owner
, struct expression
*expr
);
115 void set_default_state(int owner
, struct smatch_state
*state
);
117 char *get_filename();
118 char *get_function();
121 extern int final_pass
;
123 #define sm_printf(msg...) do { if (final_pass) printf(msg); } while (0) \
125 static inline void sm_prefix()
127 printf("%s +%d %s(%d) ", get_filename(), get_lineno(), get_function(), get_func_pos());
130 #define sm_msg(msg...) \
132 if (!option_debug && !final_pass) \
139 #define sm_debug(msg...) do { if (option_debug) printf(msg); } while (0)
141 #define sm_info(msg...) do { \
142 if (option_debug || (option_info && final_pass)) { \
150 #define POINTER_MAX 0xffffffff
152 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
153 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
154 struct state_list
*get_possible_states(int owner
, const char *name
,
156 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
157 void set_state(int owner
, const char *name
, struct symbol
*sym
,
158 struct smatch_state
*state
);
159 void set_state_expr(int owner
, struct expression
*expr
,
160 struct smatch_state
*state
);
161 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
162 void delete_state_expr(int owner
, struct expression
*expr
);
163 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
164 struct smatch_state
*true_state
,
165 struct smatch_state
*false_state
);
166 void set_true_false_states_expr(int owner
, struct expression
*expr
,
167 struct smatch_state
*true_state
,
168 struct smatch_state
*false_state
);
170 struct state_list
*get_all_states(int id
);
173 /* smatch_helper.c */
174 char *alloc_string(const char *str
);
175 void free_string(char *str
);
176 struct smatch_state
*alloc_state_num(int num
);
177 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
179 char *get_variable_from_expr_complex(struct expression
*expr
,
180 struct symbol
**sym_ptr
);
181 char *get_variable_from_expr(struct expression
*expr
,
182 struct symbol
**sym_ptr
);
183 int sym_name_is(const char *name
, struct expression
*expr
);
184 int get_value(struct expression
*expr
, long long *val
);
185 int get_implied_value(struct expression
*expr
, long long *val
);
186 int get_fuzzy_max(struct expression
*expr
, long long *max
);
187 int is_zero(struct expression
*expr
);
188 int is_array(struct expression
*expr
);
189 struct expression
*get_array_name(struct expression
*expr
);
190 struct expression
*get_array_offset(struct expression
*expr
);
191 const char *show_state(struct smatch_state
*state
);
192 struct statement
*get_block_thing(struct expression
*expr
);
193 struct expression
*strip_expr(struct expression
*expr
);
194 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
195 int is_error_return(struct expression
*expr
);
196 int getting_address();
199 struct symbol
*get_type(struct expression
*expr
);
201 /* smatch_ignore.c */
202 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
203 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
206 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
207 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
209 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
211 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
213 void free_tracker_list(struct tracker_list
**list
);
214 void free_trackers_and_list(struct tracker_list
**list
);
216 /* smatch_conditions */
221 void smatch (int argc
, char **argv
);
222 void __split_expr(struct expression
*expr
);
223 void __split_statements(struct statement
*stmt
);
224 extern int option_assume_loops
;
225 extern int option_known_conditions
;
226 extern int option_two_passes
;
227 extern struct symbol
*cur_func_sym
;
228 extern struct expression_list
*big_expression_stack
;
230 /* smatch_conditions */
231 void __split_whole_condition(struct expression
*expr
);
233 /* smatch_implied.c */
234 extern int option_debug_implied
;
235 extern int option_no_implied
;
236 void get_implications(char *name
, struct symbol
*sym
, int comparison
, int num
,
237 struct state_list
**true_states
,
238 struct state_list
**false_states
);
239 struct range_list_stack
;
240 struct state_list
*__implied_case_slist(struct expression
*switch_expr
,
241 struct expression
*case_expr
,
242 struct range_list_stack
**remaining_cases
,
243 struct state_list
**raw_slist
);
244 struct range_list
*__get_implied_values(struct expression
*switch_expr
);
246 /* smatch_extras.c */
247 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
253 extern struct data_range whole_range
;
255 int get_implied_single_val(struct expression
*expr
, long long *val
);
256 int get_implied_single_fuzzy_max(struct expression
*expr
, long long *max
);
257 int get_implied_max(struct expression
*expr
, long long *val
);
258 int get_implied_min(struct expression
*expr
, long long *val
);
259 int true_comparison(int left
, int comparison
, int right
);
260 int known_condition_true(struct expression
*expr
);
261 int known_condition_false(struct expression
*expr
);
262 int implied_condition_true(struct expression
*expr
);
263 int implied_condition_false(struct expression
*expr
);
265 /* smatch_states.c */
266 extern int option_debug
;
268 extern int __fake_cur
;
269 extern struct state_list
*__fake_cur_slist
;
270 extern int __fake_conditions
;
271 extern struct state_list
*__fake_cond_true
;
272 extern struct state_list
*__fake_cond_false
;
276 void __set_state(struct sm_state
*sm
);
277 struct state_list
*__get_cur_slist();
278 void __set_true_false_sm(struct sm_state
*true_state
,
279 struct sm_state
*false_state
);
281 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
283 void __unnullify_path();
284 int __path_is_null();
285 void clear_all_states();
287 struct sm_state
*get_sm_state(int owner
, const char *name
,
289 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
290 void __push_true_states();
291 void __use_false_states();
292 void __pop_false_states();
293 void __merge_false_states();
294 void __merge_true_states();
296 void __negate_cond_stacks();
297 void __save_false_states_for_later();
298 void __use_previously_stored_false_states();
299 void __use_cond_true_states();
300 void __use_cond_false_states();
301 void __push_cond_stacks();
302 void __and_cond_states();
303 void __or_cond_states();
304 void __save_pre_cond_states();
305 void __pop_pre_cond_states();
306 void __use_cond_states();
308 void __warn_on_silly_pre_loops();
310 void __push_continues();
311 void __pop_continues();
312 void __process_continues();
313 void __merge_continues();
315 void __push_breaks();
316 void __process_breaks();
317 void __merge_breaks();
320 void __save_switch_states(struct expression
*switch_expr
);
321 void __pop_switches();
322 void __merge_switches(struct expression
*switch_expr
, struct expression
*case_expr
);
323 void __push_default();
324 void __set_default();
327 void __push_conditions();
328 void __pop_conditions();
330 void __save_gotos(const char *name
);
331 void __merge_gotos(const char *name
);
333 void __print_cur_slist();
336 void __pass_to_client(void *data
, enum hook_type type
);
337 void __pass_to_client_no_data(enum hook_type type
);
338 void __pass_case_to_client(struct expression
*switch_expr
,
339 struct expression
*case_expr
);
340 int __has_merge_function(int client_id
);
341 struct smatch_state
*__client_merge_function(int owner
, const char *name
,
343 struct smatch_state
*s1
,
344 struct smatch_state
*s2
);
345 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
346 void __push_scope_hooks(void);
347 void __call_scope_hooks(void);
349 /* smatch_function_hooks.c */
350 void create_function_hash(void);
351 void __match_initializer_call(struct symbol
*sym
);
354 struct token
*get_tokens_file(const char *filename
);
357 extern int option_oom_kb
;
361 extern char *option_project_str
;
362 extern char *data_dir
;
363 extern int option_no_data
;
364 extern int option_spammy
;
365 extern int option_full_path
;
366 extern int option_param_mapper
;
367 extern int option_info
;
368 extern int option_call_tree
;
370 extern struct smatch_state
*default_state
[];
377 extern enum project_type option_project
;
378 const char *check_name(unsigned short id
);
380 #endif /* !SMATCH_H_ */