4 * Copyright (C) 2006 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
19 #include "expression.h"
25 unsigned long long uvalue
;
33 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
34 extern struct smatch_state undefined
;
35 extern struct smatch_state merged
;
36 extern struct smatch_state true_state
;
37 extern struct smatch_state false_state
;
38 DECLARE_ALLOCATOR(smatch_state
);
40 static inline void *INT_PTR(int i
)
42 return (void *)(long)i
;
45 static inline int PTR_INT(void *p
)
52 unsigned int merged
:1;
53 unsigned int implied
:1;
56 struct smatch_state
*state
;
58 struct state_list
*pool
;
59 struct sm_state
*left
;
60 struct sm_state
*right
;
61 unsigned int nr_children
;
62 struct state_list
*possible
;
70 DECLARE_ALLOCATOR(tracker
);
71 DECLARE_PTR_LIST(tracker_list
, struct tracker
);
88 MACRO_ASSIGNMENT_HOOK
,
106 struct range_list_sval
;
108 void add_hook(void *func
, enum hook_type type
);
109 typedef struct smatch_state
*(merge_func_t
)(struct smatch_state
*s1
, struct smatch_state
*s2
);
110 typedef struct smatch_state
*(unmatched_func_t
)(struct sm_state
*state
);
111 void add_merge_hook(int client_id
, merge_func_t
*func
);
112 void add_unmatched_state_hook(int client_id
, unmatched_func_t
*func
);
113 typedef void (scope_hook
)(void *data
);
114 void add_scope_hook(scope_hook
*hook
, void *data
);
115 typedef void (func_hook
)(const char *fn
, struct expression
*expr
, void *data
);
116 typedef void (implication_hook
)(const char *fn
, struct expression
*call_expr
,
117 struct expression
*assign_expr
, void *data
);
118 typedef void (return_implies_hook
)(struct expression
*call_expr
,
119 int param
, char *key
, char *value
);
120 typedef int (implied_return_hook
)(struct expression
*call_expr
, void *info
, struct range_list_sval
**rl
);
121 void add_function_hook(const char *look_for
, func_hook
*call_back
, void *data
);
123 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
125 void add_implied_return_hook(const char *look_for
,
126 implied_return_hook
*call_back
,
128 void add_macro_assign_hook(const char *look_for
, func_hook
*call_back
,
130 void add_macro_assign_hook_extra(const char *look_for
, func_hook
*call_back
,
132 void return_implies_state(const char *look_for
, long long start
, long long end
,
133 implication_hook
*call_back
, void *info
);
134 void add_db_return_implies_callback(int type
, return_implies_hook
*callback
);
135 void add_db_return_states_callback(int type
, return_implies_hook
*callback
);
136 int get_implied_return(struct expression
*expr
, struct range_list
**rl
);
137 int get_implied_return_sval(struct expression
*expr
, struct range_list_sval
**rl
);
139 typedef void (modification_hook
)(struct sm_state
*sm
);
140 void add_modification_hook(int owner
, modification_hook
*call_back
);
141 void add_indirect_modification_hook(int owner
, modification_hook
*call_back
);
143 const char *get_filename(void);
144 char *get_function(void);
145 int get_lineno(void);
146 extern int final_pass
;
147 extern struct symbol
*cur_func_sym
;
148 extern int option_debug
;
150 extern FILE *sm_outfd
;
151 #define sm_printf(msg...) do { if (final_pass) fprintf(sm_outfd, msg); } while (0)
153 static inline void sm_prefix(void)
155 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
158 static inline void print_implied_debug_msg();
160 #define sm_msg(msg...) \
162 print_implied_debug_msg(); \
163 if (!option_debug && !final_pass) \
170 extern char *implied_debug_msg
;
171 static inline void print_implied_debug_msg()
173 static struct symbol
*last_printed
= NULL
;
175 if (!implied_debug_msg
)
177 if (last_printed
== cur_func_sym
)
179 last_printed
= cur_func_sym
;
180 sm_msg("%s", implied_debug_msg
);
183 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
185 #define sm_info(msg...) do { \
186 if (option_debug || (option_info && final_pass)) { \
188 sm_printf("info: "); \
194 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
195 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
196 struct state_list
*get_possible_states(int owner
, const char *name
,
198 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
199 struct sm_state
*set_state(int owner
, const char *name
, struct symbol
*sym
,
200 struct smatch_state
*state
);
201 struct sm_state
*set_state_expr(int owner
, struct expression
*expr
,
202 struct smatch_state
*state
);
203 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
204 void delete_state_expr(int owner
, struct expression
*expr
);
205 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
206 struct smatch_state
*true_state
,
207 struct smatch_state
*false_state
);
208 void set_true_false_states_expr(int owner
, struct expression
*expr
,
209 struct smatch_state
*true_state
,
210 struct smatch_state
*false_state
);
212 struct state_list
*get_all_states(int id
);
213 int is_reachable(void);
215 /* smatch_helper.c */
216 char *alloc_string(const char *str
);
217 void free_string(char *str
);
218 struct smatch_state
*alloc_state_num(int num
);
219 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
221 char *get_variable_from_expr_complex(struct expression
*expr
,
222 struct symbol
**sym_ptr
);
223 char *get_variable_from_expr(struct expression
*expr
,
224 struct symbol
**sym_ptr
);
225 int sym_name_is(const char *name
, struct expression
*expr
);
226 int get_value(struct expression
*expr
, long long *val
);
227 int get_implied_value(struct expression
*expr
, long long *val
);
228 int get_implied_max(struct expression
*expr
, long long *val
);
229 int get_implied_min(struct expression
*expr
, long long *val
);
230 int get_fuzzy_min(struct expression
*expr
, long long *min
);
231 int get_fuzzy_max(struct expression
*expr
, long long *max
);
232 int get_absolute_min(struct expression
*expr
, long long *val
);
233 int get_value_sval(struct expression
*expr
, sval_t
*val
);
234 int get_implied_value_sval(struct expression
*expr
, sval_t
*val
);
235 int get_implied_max_sval(struct expression
*expr
, sval_t
*val
);
236 int get_implied_min_sval(struct expression
*expr
, sval_t
*sval
);
237 int get_fuzzy_min_sval(struct expression
*expr
, sval_t
*min
);
238 int get_fuzzy_max_sval(struct expression
*expr
, sval_t
*max
);
239 int get_absolute_min_sval(struct expression
*expr
, sval_t
*sval
);
240 int get_absolute_max_sval(struct expression
*expr
, sval_t
*sval
);
241 int parse_call_math_sval(struct expression
*expr
, char *math
, sval_t
*val
);
242 int is_zero(struct expression
*expr
);
243 int known_condition_true(struct expression
*expr
);
244 int known_condition_false(struct expression
*expr
);
245 int implied_condition_true(struct expression
*expr
);
246 int implied_condition_false(struct expression
*expr
);
248 int is_array(struct expression
*expr
);
249 struct expression
*get_array_name(struct expression
*expr
);
250 struct expression
*get_array_offset(struct expression
*expr
);
251 const char *show_state(struct smatch_state
*state
);
252 struct statement
*get_expression_statement(struct expression
*expr
);
253 struct expression
*strip_parens(struct expression
*expr
);
254 struct expression
*strip_expr(struct expression
*expr
);
255 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
256 int is_error_return(struct expression
*expr
);
257 int getting_address(void);
258 char *get_member_name(struct expression
*expr
);
259 char *get_fnptr_name(struct expression
*expr
);
260 int positions_eq(struct position pos1
, struct position pos2
);
261 struct statement
*get_current_statement(void);
264 struct symbol
*get_real_base_type(struct symbol
*sym
);
265 struct symbol
*get_pointer_type(struct expression
*expr
);
266 struct symbol
*get_type(struct expression
*expr
);
267 int type_unsigned(struct symbol
*base_type
);
268 int expr_unsigned(struct expression
*expr
);
269 int returns_unsigned(struct symbol
*base_type
);
270 int is_pointer(struct expression
*expr
);
271 int returns_pointer(struct symbol
*base_type
);
272 sval_t
sval_type_max(struct symbol
*base_type
);
273 sval_t
sval_type_min(struct symbol
*base_type
);
274 int nr_bits(struct expression
*expr
);
275 int is_static(struct expression
*expr
);
276 const char *global_static();
278 /* smatch_ignore.c */
279 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
280 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
283 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
284 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
286 void add_tracker_expr(struct tracker_list
**list
, int owner
, struct expression
*expr
);
287 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
289 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
291 void free_tracker_list(struct tracker_list
**list
);
292 void free_trackers_and_list(struct tracker_list
**list
);
294 /* smatch_conditions */
295 int in_condition(void);
299 void smatch (int argc
, char **argv
);
300 int inside_loop(void);
301 int in_expression_statement(void);
302 void __split_expr(struct expression
*expr
);
303 void __split_stmt(struct statement
*stmt
);
304 extern int option_assume_loops
;
305 extern int option_known_conditions
;
306 extern int option_two_passes
;
307 extern int option_no_db
;
308 extern int option_file_output
;
309 extern struct expression_list
*big_expression_stack
;
310 extern struct statement_list
*big_statement_stack
;
311 extern int __in_pre_condition
;
312 extern int __bail_on_rest_of_function
;
314 /* smatch_conditions */
315 void __split_whole_condition(struct expression
*expr
);
316 void __handle_logic(struct expression
*expr
);
317 int __is_condition_assign(struct expression
*expr
);
318 int __handle_condition_assigns(struct expression
*expr
);
319 int __handle_select_assigns(struct expression
*expr
);
320 int __handle_expr_statement_assigns(struct expression
*expr
);
322 /* smatch_implied.c */
323 extern int option_debug_implied
;
324 extern int option_debug_related
;
325 extern int option_no_implied
;
326 void get_implications(char *name
, struct symbol
*sym
, int comparison
, long long num
,
327 struct state_list
**true_states
,
328 struct state_list
**false_states
);
329 struct range_list_stack
;
330 struct range_list_stack_sval
;
331 struct state_list
*__implied_case_slist(struct expression
*switch_expr
,
332 struct expression
*case_expr
,
333 struct range_list_stack_sval
**remaining_cases
,
334 struct state_list
**raw_slist
);
335 struct range_list_sval
*__get_implied_values(struct expression
*switch_expr
);
337 /* smatch_extras.c */
338 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
345 struct data_range_sval
{
350 extern struct data_range whole_range
;
351 static const long long valid_ptr_max
= LONG_MAX
;
352 static const long long valid_ptr_min
= 4096;
354 /* smatch_absolute.c */
355 extern int absolute_id
;
357 /* smatch_states.c */
358 void __push_fake_cur_slist();
359 struct state_list
*__pop_fake_cur_slist();
360 void __merge_slist_into_cur(struct state_list
*slist
);
362 int unreachable(void);
363 void __set_sm(struct sm_state
*sm
);
364 struct state_list
*__get_cur_slist(void);
365 void __set_true_false_sm(struct sm_state
*true_state
,
366 struct sm_state
*false_state
);
367 void nullify_path(void);
368 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
370 void __unnullify_path(void);
371 int __path_is_null(void);
372 void clear_all_states(void);
374 struct sm_state
*get_sm_state(int owner
, const char *name
,
376 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
377 void __push_true_states(void);
378 void __use_false_states(void);
379 void __discard_false_states(void);
380 void __merge_false_states(void);
381 void __merge_true_states(void);
383 void __negate_cond_stacks(void);
384 void __use_pre_cond_states(void);
385 void __use_cond_true_states(void);
386 void __use_cond_false_states(void);
387 void __push_cond_stacks(void);
388 struct state_list
*__copy_cond_true_states(void);
389 struct state_list
*__copy_cond_false_states(void);
390 struct state_list
*__pop_cond_true_stack(void);
391 struct state_list
*__pop_cond_false_stack(void);
392 void __and_cond_states(void);
393 void __or_cond_states(void);
394 void __save_pre_cond_states(void);
395 void __discard_pre_cond_states(void);
396 void __use_cond_states(void);
397 extern struct state_list
*__last_base_slist
;
399 void __warn_on_silly_pre_loops(void);
401 void __push_continues(void);
402 void __discard_continues(void);
403 void __process_continues(void);
404 void __merge_continues(void);
406 void __push_breaks(void);
407 void __process_breaks(void);
408 void __merge_breaks(void);
409 void __use_breaks(void);
411 void __save_switch_states(struct expression
*switch_expr
);
412 void __discard_switches(void);
413 void __merge_switches(struct expression
*switch_expr
, struct expression
*case_expr
);
414 void __push_default(void);
415 void __set_default(void);
416 int __pop_default(void);
418 void __push_conditions(void);
419 void __discard_conditions(void);
421 void __save_gotos(const char *name
);
422 void __merge_gotos(const char *name
);
424 void __print_cur_slist(void);
427 void __pass_to_client(void *data
, enum hook_type type
);
428 void __pass_to_client_no_data(enum hook_type type
);
429 void __pass_case_to_client(struct expression
*switch_expr
,
430 struct expression
*case_expr
);
431 int __has_merge_function(int client_id
);
432 struct smatch_state
*__client_merge_function(int owner
,
433 struct smatch_state
*s1
,
434 struct smatch_state
*s2
);
435 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
436 void __push_scope_hooks(void);
437 void __call_scope_hooks(void);
439 /* smatch_function_hooks.c */
440 void create_function_hook_hash(void);
441 void __match_initializer_call(struct symbol
*sym
);
458 int get_return_id(void);
459 void add_definition_db_callback(void (*callback
)(const char *name
, struct symbol
*sym
, char *key
, char *value
), int type
);
460 void add_member_info_callback(int owner
, void (*callback
)(char *fn
, char *global_static
, int param
, char *printed_name
, struct smatch_state
*state
));
461 void add_db_fn_call_callback(int type
, void (*callback
)(struct expression
*arg
, char *value
));
462 struct range_list_sval
*db_return_vals(struct expression
*expr
);
464 #define run_sql(call_back, sql...) \
466 char sql_txt[1024]; \
467 snprintf(sql_txt, 1024, sql); \
468 sm_debug("%s\n", sql_txt); \
469 sql_exec(call_back, sql_txt); \
472 void sql_exec(int (*callback
)(void*, int, char**, char**), const char *sql
);
473 void open_smatch_db(void);
476 struct token
*get_tokens_file(const char *filename
);
479 extern char *option_project_str
;
480 extern char *data_dir
;
481 extern int option_no_data
;
482 extern int option_spammy
;
483 extern int option_full_path
;
484 extern int option_param_mapper
;
485 extern int option_info
;
486 extern int option_call_tree
;
487 extern int num_checks
;
494 extern enum project_type option_project
;
495 const char *check_name(unsigned short id
);
498 /* smatch_buf_size.c */
499 int get_array_size(struct expression
*expr
);
500 int get_array_size_bytes(struct expression
*expr
);
501 int get_array_size_bytes_min(struct expression
*expr
);
503 /* smatch_capped.c */
504 int is_capped(struct expression
*expr
);
506 /* check_user_data.c */
507 int is_user_data(struct expression
*expr
);
509 /* check_locking.c */
510 void print_held_locks();
512 /* check_assigned_expr.c */
513 struct expression
*get_assigned_expr(struct expression
*expr
);
516 sval_t
*sval_alloc(sval_t sval
);
517 sval_t
*sval_alloc_permanent(sval_t sval
);
518 sval_t
sval_blank(struct expression
*expr
);
519 sval_t
sval_from_val(struct expression
*expr
, long long val
);
520 int sval_unsigned(sval_t sval
);
521 int sval_signed(sval_t sval
);
522 int sval_bits(sval_t sval
);
523 int sval_is_min(sval_t sval
);
524 int sval_is_max(sval_t sval
);
525 int sval_cmp(sval_t one
, sval_t two
);
526 int sval_cmp_val(sval_t one
, long long val
);
527 sval_t
sval_cast(sval_t sval
, struct expression
*expr
);
528 sval_t
sval_preop(sval_t sval
, int op
);
529 sval_t
sval_binop(sval_t left
, int op
, sval_t right
);
530 const char *sval_to_str(sval_t sval
);
531 long long sval_to_ll(sval_t sval
);
532 sval_t
ll_to_sval(long long val
);
534 #endif /* !SMATCH_H_ */