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
*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
,
99 void add_hook(void *func
, enum hook_type type
);
100 typedef struct smatch_state
*(merge_func_t
)(struct smatch_state
*s1
, struct smatch_state
*s2
);
101 typedef struct smatch_state
*(unmatched_func_t
)(struct sm_state
*state
);
102 void add_merge_hook(int client_id
, merge_func_t
*func
);
103 void add_unmatched_state_hook(int client_id
, unmatched_func_t
*func
);
104 typedef void (scope_hook
)(void *data
);
105 void add_scope_hook(scope_hook
*hook
, void *data
);
106 typedef void (func_hook
)(const char *fn
, struct expression
*expr
, void *data
);
107 typedef void (implication_hook
)(const char *fn
, struct expression
*call_expr
,
108 struct expression
*assign_expr
, void *data
);
109 typedef void (return_implies_hook
)(struct expression
*call_expr
,
110 int param
, char *key
, char *value
);
111 typedef int (implied_return_hook
)(struct expression
*call_expr
, void *info
, struct range_list
**rl
);
112 void add_function_hook(const char *look_for
, func_hook
*call_back
, void *data
);
114 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
116 void add_implied_return_hook(const char *look_for
,
117 implied_return_hook
*call_back
,
119 void add_macro_assign_hook(const char *look_for
, func_hook
*call_back
,
121 void add_macro_assign_hook_extra(const char *look_for
, func_hook
*call_back
,
123 void return_implies_state(const char *look_for
, long long start
, long long end
,
124 implication_hook
*call_back
, void *info
);
125 void add_db_return_implies_callback(int type
, return_implies_hook
*callback
);
126 void add_db_return_states_callback(int type
, return_implies_hook
*callback
);
127 int get_implied_return(struct expression
*expr
, struct range_list
**rl
);
129 typedef void (modification_hook
)(struct sm_state
*sm
);
130 void add_modification_hook(int owner
, modification_hook
*call_back
);
131 void add_indirect_modification_hook(int owner
, modification_hook
*call_back
);
133 const char *get_filename(void);
134 char *get_function(void);
135 int get_lineno(void);
136 extern int final_pass
;
137 extern struct symbol
*cur_func_sym
;
138 extern int option_debug
;
140 extern FILE *sm_outfd
;
141 #define sm_printf(msg...) do { if (final_pass) fprintf(sm_outfd, msg); } while (0)
143 static inline void sm_prefix(void)
145 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
148 static inline void print_implied_debug_msg();
150 #define sm_msg(msg...) \
152 print_implied_debug_msg(); \
153 if (!option_debug && !final_pass) \
160 extern char *implied_debug_msg
;
161 static inline void print_implied_debug_msg()
163 static struct symbol
*last_printed
= NULL
;
165 if (!implied_debug_msg
)
167 if (last_printed
== cur_func_sym
)
169 last_printed
= cur_func_sym
;
170 sm_msg("%s", implied_debug_msg
);
173 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
175 #define sm_info(msg...) do { \
176 if (option_debug || (option_info && final_pass)) { \
178 sm_printf("info: "); \
184 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
185 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
186 struct state_list
*get_possible_states(int owner
, const char *name
,
188 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
189 struct sm_state
*set_state(int owner
, const char *name
, struct symbol
*sym
,
190 struct smatch_state
*state
);
191 struct sm_state
*set_state_expr(int owner
, struct expression
*expr
,
192 struct smatch_state
*state
);
193 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
194 void delete_state_expr(int owner
, struct expression
*expr
);
195 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
196 struct smatch_state
*true_state
,
197 struct smatch_state
*false_state
);
198 void set_true_false_states_expr(int owner
, struct expression
*expr
,
199 struct smatch_state
*true_state
,
200 struct smatch_state
*false_state
);
202 struct state_list
*get_all_states(int id
);
203 int is_reachable(void);
205 /* smatch_helper.c */
206 char *alloc_string(const char *str
);
207 void free_string(char *str
);
208 struct smatch_state
*alloc_state_num(int num
);
209 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
211 char *get_variable_from_expr_complex(struct expression
*expr
,
212 struct symbol
**sym_ptr
);
213 char *get_variable_from_expr(struct expression
*expr
,
214 struct symbol
**sym_ptr
);
215 int sym_name_is(const char *name
, struct expression
*expr
);
216 int get_value(struct expression
*expr
, long long *val
);
217 int get_implied_value(struct expression
*expr
, long long *val
);
218 int get_implied_max(struct expression
*expr
, long long *val
);
219 int get_implied_min(struct expression
*expr
, long long *val
);
220 int get_fuzzy_min(struct expression
*expr
, long long *min
);
221 int get_fuzzy_max(struct expression
*expr
, long long *max
);
222 int get_absolute_min(struct expression
*expr
, long long *val
);
223 int get_absolute_max(struct expression
*expr
, long long *val
);
224 int parse_call_math(struct expression
*expr
, char *math
, long long *val
);
225 int is_zero(struct expression
*expr
);
226 int known_condition_true(struct expression
*expr
);
227 int known_condition_false(struct expression
*expr
);
228 int implied_condition_true(struct expression
*expr
);
229 int implied_condition_false(struct expression
*expr
);
231 int is_array(struct expression
*expr
);
232 struct expression
*get_array_name(struct expression
*expr
);
233 struct expression
*get_array_offset(struct expression
*expr
);
234 const char *show_state(struct smatch_state
*state
);
235 struct statement
*get_expression_statement(struct expression
*expr
);
236 struct expression
*strip_parens(struct expression
*expr
);
237 struct expression
*strip_expr(struct expression
*expr
);
238 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
239 int is_error_return(struct expression
*expr
);
240 int getting_address(void);
241 char *get_member_name(struct expression
*expr
);
242 char *get_fnptr_name(struct expression
*expr
);
243 int positions_eq(struct position pos1
, struct position pos2
);
244 struct statement
*get_current_statement(void);
247 struct symbol
*get_real_base_type(struct symbol
*sym
);
248 struct symbol
*get_pointer_type(struct expression
*expr
);
249 struct symbol
*get_type(struct expression
*expr
);
250 int type_unsigned(struct symbol
*base_type
);
251 int expr_unsigned(struct expression
*expr
);
252 int returns_unsigned(struct symbol
*base_type
);
253 int is_pointer(struct expression
*expr
);
254 int returns_pointer(struct symbol
*base_type
);
255 long long type_max(struct symbol
*base_type
);
256 long long type_min(struct symbol
*base_type
);
257 int nr_bits(struct expression
*expr
);
258 int is_static(struct expression
*expr
);
259 const char *global_static();
261 /* smatch_ignore.c */
262 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
263 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
266 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
267 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
269 void add_tracker_expr(struct tracker_list
**list
, int owner
, struct expression
*expr
);
270 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
272 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
274 void free_tracker_list(struct tracker_list
**list
);
275 void free_trackers_and_list(struct tracker_list
**list
);
277 /* smatch_conditions */
278 int in_condition(void);
282 void smatch (int argc
, char **argv
);
283 int inside_loop(void);
284 int in_expression_statement(void);
285 void __split_expr(struct expression
*expr
);
286 void __split_stmt(struct statement
*stmt
);
287 extern int option_assume_loops
;
288 extern int option_known_conditions
;
289 extern int option_two_passes
;
290 extern int option_no_db
;
291 extern int option_file_output
;
292 extern struct expression_list
*big_expression_stack
;
293 extern struct statement_list
*big_statement_stack
;
294 extern int __in_pre_condition
;
295 extern int __bail_on_rest_of_function
;
297 /* smatch_conditions */
298 void __split_whole_condition(struct expression
*expr
);
299 void __handle_logic(struct expression
*expr
);
300 int __is_condition_assign(struct expression
*expr
);
301 int __handle_condition_assigns(struct expression
*expr
);
302 int __handle_select_assigns(struct expression
*expr
);
303 int __handle_expr_statement_assigns(struct expression
*expr
);
305 /* smatch_implied.c */
306 extern int option_debug_implied
;
307 extern int option_debug_related
;
308 extern int option_no_implied
;
309 void get_implications(char *name
, struct symbol
*sym
, int comparison
, long long num
,
310 struct state_list
**true_states
,
311 struct state_list
**false_states
);
312 struct range_list_stack
;
313 struct state_list
*__implied_case_slist(struct expression
*switch_expr
,
314 struct expression
*case_expr
,
315 struct range_list_stack
**remaining_cases
,
316 struct state_list
**raw_slist
);
317 struct range_list
*__get_implied_values(struct expression
*switch_expr
);
319 /* smatch_extras.c */
320 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
326 extern struct data_range whole_range
;
327 static const long long valid_ptr_max
= LONG_MAX
;
328 static const long long valid_ptr_min
= 4096;
330 /* smatch_absolute.c */
331 extern int absolute_id
;
333 /* smatch_states.c */
334 void __push_fake_cur_slist();
335 struct state_list
*__pop_fake_cur_slist();
336 void __merge_slist_into_cur(struct state_list
*slist
);
338 int unreachable(void);
339 void __set_sm(struct sm_state
*sm
);
340 struct state_list
*__get_cur_slist(void);
341 void __set_true_false_sm(struct sm_state
*true_state
,
342 struct sm_state
*false_state
);
343 void nullify_path(void);
344 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
346 void __unnullify_path(void);
347 int __path_is_null(void);
348 void clear_all_states(void);
350 struct sm_state
*get_sm_state(int owner
, const char *name
,
352 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
353 void __push_true_states(void);
354 void __use_false_states(void);
355 void __discard_false_states(void);
356 void __merge_false_states(void);
357 void __merge_true_states(void);
359 void __negate_cond_stacks(void);
360 void __use_pre_cond_states(void);
361 void __use_cond_true_states(void);
362 void __use_cond_false_states(void);
363 void __push_cond_stacks(void);
364 struct state_list
*__copy_cond_true_states(void);
365 struct state_list
*__copy_cond_false_states(void);
366 struct state_list
*__pop_cond_true_stack(void);
367 struct state_list
*__pop_cond_false_stack(void);
368 void __and_cond_states(void);
369 void __or_cond_states(void);
370 void __save_pre_cond_states(void);
371 void __discard_pre_cond_states(void);
372 void __use_cond_states(void);
373 extern struct state_list
*__last_base_slist
;
375 void __warn_on_silly_pre_loops(void);
377 void __push_continues(void);
378 void __discard_continues(void);
379 void __process_continues(void);
380 void __merge_continues(void);
382 void __push_breaks(void);
383 void __process_breaks(void);
384 void __merge_breaks(void);
385 void __use_breaks(void);
387 void __save_switch_states(struct expression
*switch_expr
);
388 void __discard_switches(void);
389 void __merge_switches(struct expression
*switch_expr
, struct expression
*case_expr
);
390 void __push_default(void);
391 void __set_default(void);
392 int __pop_default(void);
394 void __push_conditions(void);
395 void __discard_conditions(void);
397 void __save_gotos(const char *name
);
398 void __merge_gotos(const char *name
);
400 void __print_cur_slist(void);
403 void __pass_to_client(void *data
, enum hook_type type
);
404 void __pass_to_client_no_data(enum hook_type type
);
405 void __pass_case_to_client(struct expression
*switch_expr
,
406 struct expression
*case_expr
);
407 int __has_merge_function(int client_id
);
408 struct smatch_state
*__client_merge_function(int owner
,
409 struct smatch_state
*s1
,
410 struct smatch_state
*s2
);
411 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
412 void __push_scope_hooks(void);
413 void __call_scope_hooks(void);
415 /* smatch_function_hooks.c */
416 void create_function_hook_hash(void);
417 void __match_initializer_call(struct symbol
*sym
);
434 int get_return_id(void);
435 void add_definition_db_callback(void (*callback
)(const char *name
, struct symbol
*sym
, char *key
, char *value
), int type
);
436 void add_member_info_callback(int owner
, void (*callback
)(char *fn
, char *global_static
, int param
, char *printed_name
, struct smatch_state
*state
));
437 void add_db_fn_call_callback(int type
, void (*callback
)(struct expression
*arg
, char *value
));
438 struct range_list
*db_return_vals(struct expression
*expr
);
440 #define run_sql(call_back, sql...) \
442 char sql_txt[1024]; \
443 snprintf(sql_txt, 1024, sql); \
444 sm_debug("%s\n", sql_txt); \
445 sql_exec(call_back, sql_txt); \
448 void sql_exec(int (*callback
)(void*, int, char**, char**), const char *sql
);
449 void open_smatch_db(void);
452 struct token
*get_tokens_file(const char *filename
);
455 extern char *option_project_str
;
456 extern char *data_dir
;
457 extern int option_no_data
;
458 extern int option_spammy
;
459 extern int option_full_path
;
460 extern int option_param_mapper
;
461 extern int option_info
;
462 extern int option_call_tree
;
463 extern int num_checks
;
470 extern enum project_type option_project
;
471 const char *check_name(unsigned short id
);
474 /* smatch_buf_size.c */
475 int get_array_size(struct expression
*expr
);
476 int get_array_size_bytes(struct expression
*expr
);
477 int get_array_size_bytes_min(struct expression
*expr
);
479 /* smatch_capped.c */
480 int is_capped(struct expression
*expr
);
482 /* check_user_data.c */
483 int is_user_data(struct expression
*expr
);
485 /* check_locking.c */
486 void print_held_locks();
488 /* check_assigned_expr.c */
489 struct expression
*get_assigned_expr(struct expression
*expr
);
491 #endif /* !SMATCH_H_ */