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
);
80 MACRO_ASSIGNMENT_HOOK
,
97 void add_hook(void *func
, enum hook_type type
);
98 typedef struct smatch_state
*(merge_func_t
)(const char *name
,
100 struct smatch_state
*s1
,
101 struct smatch_state
*s2
);
102 typedef struct smatch_state
*(unmatched_func_t
)(struct sm_state
*state
);
103 void add_merge_hook(int client_id
, merge_func_t
*func
);
104 void add_unmatched_state_hook(int client_id
, unmatched_func_t
*func
);
105 typedef void (scope_hook
)(void *data
);
106 void add_scope_hook(scope_hook
*hook
, void *data
);
107 typedef void (func_hook
)(const char *fn
, struct expression
*expr
, void *data
);
108 typedef void (implication_hook
)(const char *fn
, struct expression
*call_expr
,
109 struct expression
*assign_expr
, void *data
);
110 void add_function_hook(const char *look_for
, func_hook
*call_back
, void *data
);
112 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
114 void add_macro_assign_hook(const char *look_for
, func_hook
*call_back
,
116 void return_implies_state(const char *look_for
, long long start
, long long end
,
117 implication_hook
*call_back
, void *info
);
118 typedef void (modification_hook
)(const char *name
, struct symbol
*sym
,
119 struct expression
*expr
, void *data
);
120 void add_modification_hook(int owner
, const char *variable
, modification_hook
*hook
,
122 void add_modification_hook_expr(int owner
, struct expression
*expr
, modification_hook
*call_back
, void *info
);
123 void set_default_modification_hook(int owner
, modification_hook
*call_back
);
124 void __use_default_modification_hook(int owner
, const char *variable
);
126 const char *get_filename(void);
127 char *get_function(void);
128 int get_lineno(void);
129 extern int final_pass
;
130 extern struct symbol
*cur_func_sym
;
131 extern int option_debug
;
133 extern FILE *sm_outfd
;
134 #define sm_printf(msg...) do { if (final_pass) fprintf(sm_outfd, msg); } while (0)
136 static inline void sm_prefix(void)
138 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
141 static inline void print_implied_debug_msg();
143 #define sm_msg(msg...) \
145 print_implied_debug_msg(); \
146 if (!option_debug && !final_pass) \
153 extern char *implied_debug_msg
;
154 static inline void print_implied_debug_msg()
156 static struct symbol
*last_printed
= NULL
;
158 if (!implied_debug_msg
)
160 if (last_printed
== cur_func_sym
)
162 last_printed
= cur_func_sym
;
163 sm_msg("%s", implied_debug_msg
);
166 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
168 #define sm_info(msg...) do { \
169 if (option_debug || (option_info && final_pass)) { \
171 sm_printf("info: "); \
177 #define POINTER_MAX 0xffffffff
179 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
180 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
181 struct state_list
*get_possible_states(int owner
, const char *name
,
183 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
184 struct sm_state
*set_state(int owner
, const char *name
, struct symbol
*sym
,
185 struct smatch_state
*state
);
186 struct sm_state
*set_state_expr(int owner
, struct expression
*expr
,
187 struct smatch_state
*state
);
188 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
189 void delete_state_expr(int owner
, struct expression
*expr
);
190 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
191 struct smatch_state
*true_state
,
192 struct smatch_state
*false_state
);
193 void set_true_false_states_expr(int owner
, struct expression
*expr
,
194 struct smatch_state
*true_state
,
195 struct smatch_state
*false_state
);
197 struct state_list
*get_all_states(int id
);
198 int is_reachable(void);
200 /* smatch_helper.c */
201 char *alloc_string(const char *str
);
202 void free_string(char *str
);
203 struct smatch_state
*alloc_state_num(int num
);
204 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
206 char *get_variable_from_expr_complex(struct expression
*expr
,
207 struct symbol
**sym_ptr
);
208 char *get_variable_from_expr(struct expression
*expr
,
209 struct symbol
**sym_ptr
);
210 int sym_name_is(const char *name
, struct expression
*expr
);
211 int get_value(struct expression
*expr
, long long *val
);
212 int get_implied_value(struct expression
*expr
, long long *val
);
213 int get_implied_max(struct expression
*expr
, long long *val
);
214 int get_implied_min(struct expression
*expr
, long long *val
);
215 int get_fuzzy_min(struct expression
*expr
, long long *min
);
216 int get_fuzzy_max(struct expression
*expr
, long long *max
);
217 int get_absolute_min(struct expression
*expr
, long long *val
);
218 int get_absolute_max(struct expression
*expr
, long long *val
);
219 int is_zero(struct expression
*expr
);
220 int known_condition_true(struct expression
*expr
);
221 int known_condition_false(struct expression
*expr
);
222 int implied_condition_true(struct expression
*expr
);
223 int implied_condition_false(struct expression
*expr
);
225 int is_array(struct expression
*expr
);
226 struct expression
*get_array_name(struct expression
*expr
);
227 struct expression
*get_array_offset(struct expression
*expr
);
228 const char *show_state(struct smatch_state
*state
);
229 struct statement
*get_expression_statement(struct expression
*expr
);
230 struct expression
*strip_parens(struct expression
*expr
);
231 struct expression
*strip_expr(struct expression
*expr
);
232 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
233 int is_error_return(struct expression
*expr
);
234 int getting_address(void);
235 char *get_member_name(struct expression
*expr
);
236 char *get_fnptr_name(struct expression
*expr
);
237 int positions_eq(struct position pos1
, struct position pos2
);
240 struct symbol
*get_real_base_type(struct symbol
*sym
);
241 struct symbol
*get_pointer_type(struct expression
*expr
);
242 struct symbol
*get_type(struct expression
*expr
);
243 int type_unsigned(struct symbol
*base_type
);
244 int expr_unsigned(struct expression
*expr
);
245 int returns_unsigned(struct symbol
*base_type
);
246 int is_pointer(struct expression
*expr
);
247 int returns_pointer(struct symbol
*base_type
);
248 long long type_max(struct symbol
*base_type
);
249 long long type_min(struct symbol
*base_type
);
250 int nr_bits(struct expression
*expr
);
252 /* smatch_ignore.c */
253 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
254 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
257 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
258 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
260 void add_tracker_expr(struct tracker_list
**list
, int owner
, struct expression
*expr
);
261 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
263 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
265 struct tracker_list
*clone_tracker_list(struct tracker_list
*orig_list
);
266 void free_tracker_list(struct tracker_list
**list
);
267 void free_trackers_and_list(struct tracker_list
**list
);
269 /* smatch_conditions */
270 int in_condition(void);
274 void smatch (int argc
, char **argv
);
275 int inside_loop(void);
276 int in_expression_statement(void);
277 void __split_expr(struct expression
*expr
);
278 void __split_stmt(struct statement
*stmt
);
279 extern int option_assume_loops
;
280 extern int option_known_conditions
;
281 extern int option_two_passes
;
282 extern int option_no_db
;
283 extern int option_file_output
;
284 extern struct expression_list
*big_expression_stack
;
285 extern struct statement_list
*big_statement_stack
;
286 extern int __in_pre_condition
;
287 extern int __bail_on_rest_of_function
;
289 /* smatch_conditions */
290 void __split_whole_condition(struct expression
*expr
);
291 void __handle_logic(struct expression
*expr
);
292 int __is_condition_assign(struct expression
*expr
);
293 int __handle_condition_assigns(struct expression
*expr
);
294 int __handle_select_assigns(struct expression
*expr
);
295 int __handle_expr_statement_assigns(struct expression
*expr
);
297 /* smatch_implied.c */
298 extern int option_debug_implied
;
299 extern int option_debug_related
;
300 extern int option_no_implied
;
301 void get_implications(char *name
, struct symbol
*sym
, int comparison
, long long num
,
302 struct state_list
**true_states
,
303 struct state_list
**false_states
);
304 struct range_list_stack
;
305 struct state_list
*__implied_case_slist(struct expression
*switch_expr
,
306 struct expression
*case_expr
,
307 struct range_list_stack
**remaining_cases
,
308 struct state_list
**raw_slist
);
309 struct range_list
*__get_implied_values(struct expression
*switch_expr
);
311 /* smatch_extras.c */
312 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
318 extern struct data_range whole_range
;
319 static const long long valid_ptr_max
= LONG_MAX
;
320 static const long long valid_ptr_min
= 4096;
322 /* smatch_states.c */
323 void __push_fake_cur_slist();
324 struct state_list
*__pop_fake_cur_slist();
325 void __merge_slist_into_cur(struct state_list
*slist
);
327 int unreachable(void);
328 void __set_sm(struct sm_state
*sm
);
329 struct state_list
*__get_cur_slist(void);
330 void __set_true_false_sm(struct sm_state
*true_state
,
331 struct sm_state
*false_state
);
332 void nullify_path(void);
333 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
335 void __unnullify_path(void);
336 int __path_is_null(void);
337 void clear_all_states(void);
339 struct sm_state
*get_sm_state(int owner
, const char *name
,
341 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
342 void __push_true_states(void);
343 void __use_false_states(void);
344 void __discard_false_states(void);
345 void __merge_false_states(void);
346 void __merge_true_states(void);
348 void __negate_cond_stacks(void);
349 void __use_pre_cond_states(void);
350 void __use_cond_true_states(void);
351 void __use_cond_false_states(void);
352 void __push_cond_stacks(void);
353 struct state_list
*__copy_cond_true_states(void);
354 struct state_list
*__copy_cond_false_states(void);
355 struct state_list
*__pop_cond_true_stack(void);
356 struct state_list
*__pop_cond_false_stack(void);
357 void __and_cond_states(void);
358 void __or_cond_states(void);
359 void __save_pre_cond_states(void);
360 void __discard_pre_cond_states(void);
361 void __use_cond_states(void);
363 void __warn_on_silly_pre_loops(void);
365 void __push_continues(void);
366 void __discard_continues(void);
367 void __process_continues(void);
368 void __merge_continues(void);
370 void __push_breaks(void);
371 void __process_breaks(void);
372 void __merge_breaks(void);
373 void __use_breaks(void);
375 void __save_switch_states(struct expression
*switch_expr
);
376 void __discard_switches(void);
377 void __merge_switches(struct expression
*switch_expr
, struct expression
*case_expr
);
378 void __push_default(void);
379 void __set_default(void);
380 int __pop_default(void);
382 void __push_conditions(void);
383 void __discard_conditions(void);
385 void __save_gotos(const char *name
);
386 void __merge_gotos(const char *name
);
388 void __print_cur_slist(void);
391 void __pass_to_client(void *data
, enum hook_type type
);
392 void __pass_to_client_no_data(enum hook_type type
);
393 void __pass_case_to_client(struct expression
*switch_expr
,
394 struct expression
*case_expr
);
395 int __has_merge_function(int client_id
);
396 struct smatch_state
*__client_merge_function(int owner
, const char *name
,
398 struct smatch_state
*s1
,
399 struct smatch_state
*s2
);
400 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
401 void __push_scope_hooks(void);
402 void __call_scope_hooks(void);
404 /* smatch_function_hooks.c */
405 void create_function_hook_hash(void);
406 void __match_initializer_call(struct symbol
*sym
);
418 void add_definition_db_callback(void (*callback
)(const char *name
, struct symbol
*sym
, char *key
, char *value
), int type
);
419 void add_member_info_callback(int owner
, void (*callback
)(char *fn
, int param
, char *printed_name
, struct smatch_state
*state
));
420 void add_db_fn_call_callback(int type
, void (*callback
)(struct expression
*arg
, char *value
));
421 struct range_list
*db_return_vals(struct expression
*expr
);
423 #define run_sql(call_back, sql...) \
425 char sql_txt[1024]; \
426 snprintf(sql_txt, 1024, sql); \
427 sql_exec(call_back, sql_txt); \
430 void sql_exec(int (*callback
)(void*, int, char**, char**), const char *sql
);
431 void open_smatch_db(void);
434 struct token
*get_tokens_file(const char *filename
);
437 extern char *option_project_str
;
438 extern char *data_dir
;
439 extern int option_no_data
;
440 extern int option_spammy
;
441 extern int option_full_path
;
442 extern int option_param_mapper
;
443 extern int option_info
;
444 extern int option_call_tree
;
445 extern int num_checks
;
452 extern enum project_type option_project
;
453 const char *check_name(unsigned short id
);
456 /* smatch_buf_size.c */
457 int get_array_size(struct expression
*expr
);
458 int get_array_size_bytes(struct expression
*expr
);
460 /* smatch_capped.c */
461 int is_capped(struct expression
*expr
);
463 /* check_user_data.c */
464 int is_user_data(struct expression
*expr
);
466 /* check_locking.c */
467 void print_held_locks();
469 #endif /* !SMATCH_H_ */