4 * Copyright (C) 2006 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
20 #include "expression.h"
26 unsigned long long uvalue
;
34 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
35 extern struct smatch_state undefined
;
36 extern struct smatch_state merged
;
37 extern struct smatch_state true_state
;
38 extern struct smatch_state false_state
;
39 DECLARE_ALLOCATOR(smatch_state
);
41 static inline void *INT_PTR(int i
)
43 return (void *)(long)i
;
46 static inline int PTR_INT(void *p
)
53 unsigned int merged
:1;
54 unsigned int implied
:1;
57 struct smatch_state
*state
;
59 struct state_list
*pool
;
60 struct sm_state
*left
;
61 struct sm_state
*right
;
62 unsigned int nr_children
;
63 struct state_list
*possible
;
71 DECLARE_ALLOCATOR(tracker
);
72 DECLARE_PTR_LIST(tracker_list
, struct tracker
);
82 GLOBAL_ASSIGNMENT_HOOK
,
89 CALL_HOOK_AFTER_INLINE
,
91 MACRO_ASSIGNMENT_HOOK
,
115 void add_hook(void *func
, enum hook_type type
);
116 typedef struct smatch_state
*(merge_func_t
)(struct smatch_state
*s1
, struct smatch_state
*s2
);
117 typedef struct smatch_state
*(unmatched_func_t
)(struct sm_state
*state
);
118 void add_merge_hook(int client_id
, merge_func_t
*func
);
119 void add_unmatched_state_hook(int client_id
, unmatched_func_t
*func
);
120 typedef void (scope_hook
)(void *data
);
121 void add_scope_hook(scope_hook
*hook
, void *data
);
122 typedef void (func_hook
)(const char *fn
, struct expression
*expr
, void *data
);
123 typedef void (implication_hook
)(const char *fn
, struct expression
*call_expr
,
124 struct expression
*assign_expr
, void *data
);
125 typedef void (return_implies_hook
)(struct expression
*call_expr
,
126 int param
, char *key
, char *value
);
127 typedef int (implied_return_hook
)(struct expression
*call_expr
, void *info
, struct range_list
**rl
);
128 void add_function_hook(const char *look_for
, func_hook
*call_back
, void *data
);
130 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
132 void add_implied_return_hook(const char *look_for
,
133 implied_return_hook
*call_back
,
135 void add_macro_assign_hook(const char *look_for
, func_hook
*call_back
,
137 void add_macro_assign_hook_extra(const char *look_for
, func_hook
*call_back
,
139 void return_implies_state(const char *look_for
, long long start
, long long end
,
140 implication_hook
*call_back
, void *info
);
141 void select_return_states_hook(int type
, return_implies_hook
*callback
);
142 void select_return_states_before(void (*fn
)(void));
143 void select_return_states_after(void (*fn
)(void));
144 int get_implied_return(struct expression
*expr
, struct range_list
**rl
);
146 typedef void (modification_hook
)(struct sm_state
*sm
, struct expression
*mod_expr
);
147 void add_modification_hook(int owner
, modification_hook
*call_back
);
148 void add_indirect_modification_hook(int owner
, modification_hook
*call_back
);
150 const char *get_filename(void);
151 const char *get_base_file(void);
152 char *get_function(void);
153 int get_lineno(void);
154 extern int final_pass
;
155 extern struct symbol
*cur_func_sym
;
156 extern int option_debug
;
157 extern int local_debug
;
159 extern FILE *sm_outfd
;
160 #define sm_printf(msg...) do { if (final_pass || option_debug) fprintf(sm_outfd, msg); } while (0)
162 static inline void sm_prefix(void)
164 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
167 static inline void print_implied_debug_msg();
169 #define sm_msg(msg...) \
171 print_implied_debug_msg(); \
172 if (!option_debug && !final_pass) \
179 #define local_debug(msg...) \
185 extern char *implied_debug_msg
;
186 static inline void print_implied_debug_msg()
188 static struct symbol
*last_printed
= NULL
;
190 if (!implied_debug_msg
)
192 if (last_printed
== cur_func_sym
)
194 last_printed
= cur_func_sym
;
195 sm_msg("%s", implied_debug_msg
);
198 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
200 #define sm_info(msg...) do { \
201 if (option_debug || (option_info && final_pass)) { \
203 sm_printf("info: "); \
209 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
210 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
211 struct state_list
*get_possible_states(int owner
, const char *name
,
213 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
214 struct sm_state
*set_state(int owner
, const char *name
, struct symbol
*sym
,
215 struct smatch_state
*state
);
216 struct sm_state
*set_state_expr(int owner
, struct expression
*expr
,
217 struct smatch_state
*state
);
218 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
219 void delete_state_expr(int owner
, struct expression
*expr
);
220 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
221 struct smatch_state
*true_state
,
222 struct smatch_state
*false_state
);
223 void set_true_false_states_expr(int owner
, struct expression
*expr
,
224 struct smatch_state
*true_state
,
225 struct smatch_state
*false_state
);
227 struct state_list
*get_all_states_slist(int owner
, struct state_list
*source
);
228 struct state_list
*get_all_states(int id
);
229 int is_reachable(void);
231 /* smatch_helper.c */
232 char *alloc_string(const char *str
);
233 void free_string(char *str
);
234 void remove_parens(char *str
);
235 struct smatch_state
*alloc_state_num(int num
);
236 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
239 char *expr_to_var(struct expression
*expr
);
240 char *expr_to_str(struct expression
*expr
);
241 char *expr_to_str_sym(struct expression
*expr
,
242 struct symbol
**sym_ptr
);
243 char *expr_to_var_sym(struct expression
*expr
,
244 struct symbol
**sym_ptr
);
246 int sym_name_is(const char *name
, struct expression
*expr
);
247 int get_value(struct expression
*expr
, sval_t
*val
);
248 int get_implied_value(struct expression
*expr
, sval_t
*val
);
249 int get_implied_min(struct expression
*expr
, sval_t
*sval
);
250 int get_implied_max(struct expression
*expr
, sval_t
*val
);
251 int get_hard_max(struct expression
*expr
, sval_t
*sval
);
252 int get_fuzzy_min(struct expression
*expr
, sval_t
*min
);
253 int get_fuzzy_max(struct expression
*expr
, sval_t
*max
);
254 int get_absolute_min(struct expression
*expr
, sval_t
*sval
);
255 int get_absolute_max(struct expression
*expr
, sval_t
*sval
);
256 int parse_call_math(struct expression
*expr
, char *math
, sval_t
*val
);
257 int is_zero(struct expression
*expr
);
258 int known_condition_true(struct expression
*expr
);
259 int known_condition_false(struct expression
*expr
);
260 int implied_condition_true(struct expression
*expr
);
261 int implied_condition_false(struct expression
*expr
);
263 int is_array(struct expression
*expr
);
264 struct expression
*get_array_name(struct expression
*expr
);
265 struct expression
*get_array_offset(struct expression
*expr
);
266 const char *show_state(struct smatch_state
*state
);
267 struct statement
*get_expression_statement(struct expression
*expr
);
268 struct expression
*strip_parens(struct expression
*expr
);
269 struct expression
*strip_expr(struct expression
*expr
);
270 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
271 int is_error_return(struct expression
*expr
);
272 int getting_address(void);
273 char *get_member_name(struct expression
*expr
);
274 char *get_fnptr_name(struct expression
*expr
);
275 int positions_eq(struct position pos1
, struct position pos2
);
276 struct statement
*get_current_statement(void);
277 int get_param_num_from_sym(struct symbol
*sym
);
278 int ms_since(struct timeval
*start
);
281 struct symbol
*get_real_base_type(struct symbol
*sym
);
282 int type_bits(struct symbol
*type
);
283 int type_positive_bits(struct symbol
*type
);
284 struct symbol
*get_pointer_type(struct expression
*expr
);
285 struct symbol
*get_type(struct expression
*expr
);
286 int type_unsigned(struct symbol
*base_type
);
287 int type_signed(struct symbol
*base_type
);
288 int expr_unsigned(struct expression
*expr
);
289 int returns_unsigned(struct symbol
*base_type
);
290 int is_pointer(struct expression
*expr
);
291 int returns_pointer(struct symbol
*base_type
);
292 sval_t
sval_type_max(struct symbol
*base_type
);
293 sval_t
sval_type_min(struct symbol
*base_type
);
294 int nr_bits(struct expression
*expr
);
295 int is_void_pointer(struct expression
*expr
);
296 int is_char_pointer(struct expression
*expr
);
297 int is_static(struct expression
*expr
);
298 int types_equiv(struct symbol
*one
, struct symbol
*two
);
300 const char *global_static();
301 struct symbol
*cur_func_return_type(void);
302 struct symbol
*get_arg_type(struct expression
*fn
, int arg
);
303 struct symbol
*get_member_type_from_key(struct expression
*expr
, char *key
);
305 /* smatch_ignore.c */
306 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
307 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
310 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
311 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
313 void add_tracker_expr(struct tracker_list
**list
, int owner
, struct expression
*expr
);
314 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
316 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
318 void free_tracker_list(struct tracker_list
**list
);
319 void free_trackers_and_list(struct tracker_list
**list
);
321 /* smatch_conditions */
322 int in_condition(void);
326 void smatch (int argc
, char **argv
);
327 int inside_loop(void);
328 struct expression
*get_switch_expr(void);
329 int in_expression_statement(void);
330 void __process_post_op_stack(void);
331 void __split_expr(struct expression
*expr
);
332 void __split_stmt(struct statement
*stmt
);
333 extern int option_assume_loops
;
334 extern int option_known_conditions
;
335 extern int option_two_passes
;
336 extern int option_no_db
;
337 extern int option_file_output
;
338 extern int option_time
;
339 extern struct expression_list
*big_expression_stack
;
340 extern struct statement_list
*big_statement_stack
;
341 int inlinable(struct expression
*expr
);
342 extern int __inline_call
;
343 extern struct expression
*__inline_fn
;
344 extern int __in_pre_condition
;
345 extern int __bail_on_rest_of_function
;
347 /* smatch_conditions */
348 void __split_whole_condition(struct expression
*expr
);
349 void __handle_logic(struct expression
*expr
);
350 int is_condition(struct expression
*expr
);
351 int __handle_condition_assigns(struct expression
*expr
);
352 int __handle_select_assigns(struct expression
*expr
);
353 int __handle_expr_statement_assigns(struct expression
*expr
);
355 /* smatch_implied.c */
356 extern int option_debug_implied
;
357 extern int option_debug_related
;
358 extern int option_no_implied
;
359 void get_implications(char *name
, struct symbol
*sym
, int comparison
, long long num
,
360 struct state_list
**true_states
,
361 struct state_list
**false_states
);
362 struct range_list_stack
;
363 struct state_list
*__implied_case_slist(struct expression
*switch_expr
,
364 struct expression
*case_expr
,
365 struct range_list_stack
**remaining_cases
,
366 struct state_list
**raw_slist
);
367 struct range_list
*__get_implied_values(struct expression
*switch_expr
);
368 void overwrite_states_using_pool(struct sm_state
*sm
);
370 /* smatch_extras.c */
371 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
378 static const long long valid_ptr_max
= LONG_MAX
;
379 static const long long valid_ptr_min
= 4096;
380 static const sval_t valid_ptr_max_sval
= {
384 static const sval_t valid_ptr_min_sval
= {
389 /* smatch_absolute.c */
390 int get_absolute_min_helper(struct expression
*expr
, sval_t
*sval
);
391 int get_absolute_max_helper(struct expression
*expr
, sval_t
*sval
);
393 /* smatch_local_values.c */
394 int get_local_rl(struct expression
*expr
, struct range_list
**rl
);
395 int get_local_max_helper(struct expression
*expr
, sval_t
*sval
);
396 int get_local_min_helper(struct expression
*expr
, sval_t
*sval
);
398 /* smatch_states.c */
399 void __push_fake_cur_slist();
400 struct state_list
*__pop_fake_cur_slist();
401 void __free_fake_cur_slist();
402 void __set_fake_cur_slist_fast(struct state_list
*slist
);
403 void __pop_fake_cur_slist_fast(void);
404 void __merge_slist_into_cur(struct state_list
*slist
);
406 int unreachable(void);
407 void __set_sm(struct sm_state
*sm
);
408 struct state_list
*__get_cur_slist(void);
409 void __set_true_false_sm(struct sm_state
*true_state
,
410 struct sm_state
*false_state
);
411 void nullify_path(void);
412 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
414 void __unnullify_path(void);
415 int __path_is_null(void);
416 void save_all_states(void);
417 void nullify_all_states(void);
418 void restore_all_states(void);
419 void clear_all_states(void);
421 struct sm_state
*get_sm_state(int owner
, const char *name
,
423 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
424 void __push_true_states(void);
425 void __use_false_states(void);
426 void __discard_false_states(void);
427 void __merge_false_states(void);
428 void __merge_true_states(void);
430 void __negate_cond_stacks(void);
431 void __use_pre_cond_states(void);
432 void __use_cond_true_states(void);
433 void __use_cond_false_states(void);
434 void __push_cond_stacks(void);
435 struct state_list
*__copy_cond_true_states(void);
436 struct state_list
*__copy_cond_false_states(void);
437 struct state_list
*__pop_cond_true_stack(void);
438 struct state_list
*__pop_cond_false_stack(void);
439 void __and_cond_states(void);
440 void __or_cond_states(void);
441 void __save_pre_cond_states(void);
442 void __discard_pre_cond_states(void);
443 void __use_cond_states(void);
444 extern struct state_list
*__last_base_slist
;
446 void __warn_on_silly_pre_loops(void);
448 void __push_continues(void);
449 void __discard_continues(void);
450 void __process_continues(void);
451 void __merge_continues(void);
453 void __push_breaks(void);
454 void __process_breaks(void);
455 int __has_breaks(void);
456 void __merge_breaks(void);
457 void __use_breaks(void);
459 void __save_switch_states(struct expression
*switch_expr
);
460 void __discard_switches(void);
461 void __merge_switches(struct expression
*switch_expr
, struct expression
*case_expr
);
462 void __push_default(void);
463 void __set_default(void);
464 int __pop_default(void);
466 void __push_conditions(void);
467 void __discard_conditions(void);
469 void __save_gotos(const char *name
);
470 void __merge_gotos(const char *name
);
472 void __print_cur_slist(void);
475 void __pass_to_client(void *data
, enum hook_type type
);
476 void __pass_to_client_no_data(enum hook_type type
);
477 void __pass_case_to_client(struct expression
*switch_expr
,
478 struct expression
*case_expr
);
479 int __has_merge_function(int client_id
);
480 struct smatch_state
*__client_merge_function(int owner
,
481 struct smatch_state
*s1
,
482 struct smatch_state
*s2
);
483 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
484 void __push_scope_hooks(void);
485 void __call_scope_hooks(void);
487 /* smatch_function_hooks.c */
488 void create_function_hook_hash(void);
489 void __match_initializer_call(struct symbol
*sym
);
503 ABSOLUTE_LIMITS
= 10,
510 void select_caller_info_hook(void (*callback
)(const char *name
, struct symbol
*sym
, char *key
, char *value
), int type
);
511 void add_member_info_callback(int owner
, void (*callback
)(struct expression
*call
, int param
, char *printed_name
, struct smatch_state
*state
));
512 void add_returned_state_callback(void (*fn
)(int return_id
, char *return_ranges
, struct expression
*returned_expr
));
513 void add_returned_member_callback(int owner
, void (*callback
)(int return_id
, char *return_ranges
, char *printed_name
, struct smatch_state
*state
));
514 void select_call_implies_hook(int type
, void (*callback
)(struct expression
*arg
, char *value
));
515 struct range_list
*db_return_vals(struct expression
*expr
);
516 char *return_state_to_var_sym(struct expression
*expr
, int param
, char *key
, struct symbol
**sym
);
517 char *get_variable_from_key(struct expression
*arg
, char *key
, struct symbol
**sym
);
518 const char *get_param_name(struct sm_state
*sm
);
520 #define run_sql(call_back, sql...) \
522 char sql_txt[1024]; \
525 snprintf(sql_txt, 1024, sql); \
526 sm_debug("%s\n", sql_txt); \
527 sql_exec(call_back, sql_txt); \
530 /* like run_sql() but for the in-memory database */
531 #define mem_sql(call_back, sql...) \
533 char sql_txt[1024]; \
535 snprintf(sql_txt, sizeof(sql_txt), sql); \
536 sm_debug("in-mem: %s\n", sql_txt); \
537 sql_mem_exec(call_back, sql_txt); \
540 void sql_insert_return_states(int return_id
, const char *return_ranges
,
541 int type
, int param
, const char *key
, const char *value
);
542 void sql_insert_caller_info(struct expression
*call
, int type
, int param
,
543 const char *key
, const char *value
);
544 void sql_insert_function_ptr(const char *fn
, const char *struct_name
);
545 void sql_insert_return_values(const char *return_values
);
546 void sql_insert_call_implies(int type
, int param
, int value
);
547 void sql_insert_type_size(const char *member
, int size
);
548 void sql_insert_local_values(const char *name
, const char *value
);
550 void sql_select_return_states(const char *cols
, struct expression
*call
,
551 int (*callback
)(void*, int, char**, char**));
552 void sql_select_caller_info(const char *cols
, struct symbol
*sym
,
553 int (*callback
)(void*, int, char**, char**));
554 void sql_select_call_implies(const char *cols
, struct expression
*call
,
555 int (*callback
)(void*, int, char**, char**));
557 void sql_exec(int (*callback
)(void*, int, char**, char**), const char *sql
);
558 void sql_mem_exec(int (*callback
)(void*, int, char**, char**), const char *sql
);
560 void open_smatch_db(void);
563 int open_data_file(const char *filename
);
564 struct token
*get_tokens_file(const char *filename
);
567 extern char *option_project_str
;
568 extern char *data_dir
;
569 extern int option_no_data
;
570 extern int option_spammy
;
571 extern int option_full_path
;
572 extern int option_param_mapper
;
573 extern int option_info
;
574 extern int option_call_tree
;
575 extern int num_checks
;
582 extern enum project_type option_project
;
583 const char *check_name(unsigned short id
);
586 /* smatch_buf_size.c */
587 int get_array_size(struct expression
*expr
);
588 int get_array_size_bytes(struct expression
*expr
);
589 int get_array_size_bytes_min(struct expression
*expr
);
590 int get_real_array_size(struct expression
*expr
);
592 /* smatch_capped.c */
593 int is_capped(struct expression
*expr
);
594 int is_capped_var_sym(const char *name
, struct symbol
*sym
);
596 /* check_user_data.c */
597 int is_user_data(struct expression
*expr
);
598 int is_capped_user_data(struct expression
*expr
);
600 /* check_locking.c */
601 void print_held_locks();
603 /* check_assigned_expr.c */
604 struct expression
*get_assigned_expr(struct expression
*expr
);
606 /* smatch_comparison.c */
607 int get_comparison(struct expression
*left
, struct expression
*right
);
608 void __add_comparison_info(struct expression
*expr
, struct expression
*call
, const char *range
);
609 char *expr_equal_to_param(struct expression
*expr
);
610 char *expr_lte_to_param(struct expression
*expr
);
613 sval_t
*sval_alloc(sval_t sval
);
614 sval_t
*sval_alloc_permanent(sval_t sval
);
615 sval_t
sval_blank(struct expression
*expr
);
616 sval_t
sval_type_val(struct symbol
*type
, long long val
);
617 sval_t
sval_from_val(struct expression
*expr
, long long val
);
618 int sval_unsigned(sval_t sval
);
619 int sval_signed(sval_t sval
);
620 int sval_bits(sval_t sval
);
621 int sval_positive_bits(sval_t sval
);
622 int sval_bits_used(sval_t sval
);
623 int sval_is_negative(sval_t sval
);
624 int sval_is_positive(sval_t sval
);
625 int sval_is_min(sval_t sval
);
626 int sval_is_max(sval_t sval
);
627 int sval_is_a_min(sval_t sval
);
628 int sval_is_a_max(sval_t sval
);
629 int sval_is_negative_min(sval_t sval
);
630 int sval_cmp(sval_t one
, sval_t two
);
631 int sval_cmp_t(struct symbol
*type
, sval_t one
, sval_t two
);
632 int sval_cmp_val(sval_t one
, long long val
);
633 sval_t
sval_min(sval_t one
, sval_t two
);
634 sval_t
sval_max(sval_t one
, sval_t two
);
635 int sval_too_low(struct symbol
*type
, sval_t sval
);
636 int sval_too_high(struct symbol
*type
, sval_t sval
);
637 int sval_fits(struct symbol
*type
, sval_t sval
);
638 sval_t
sval_cast(struct symbol
*type
, sval_t sval
);
639 sval_t
sval_preop(sval_t sval
, int op
);
640 sval_t
sval_binop(sval_t left
, int op
, sval_t right
);
641 int sval_binop_overflows(sval_t left
, int op
, sval_t right
);
642 const char *sval_to_str(sval_t sval
);
643 const char *sval_to_numstr(sval_t sval
);
644 sval_t
ll_to_sval(long long val
);
646 /* smatch_string_list.c */
647 int list_has_string(struct string_list
*str_list
, char *str
);
648 void insert_string(struct string_list
**str_list
, char *str
);
649 struct string_list
*clone_str_list(struct string_list
*orig
);
650 struct string_list
*combine_string_lists(struct string_list
*one
, struct string_list
*two
);
652 /* smatch_clear_buffer.c */
653 int is_uninitialized(struct expression
*expr
);
654 int has_uninitialized_members(struct expression
*expr
);
656 /* smatch_start_states.c */
657 struct state_list
*get_start_states(void);
659 /* smatch_recurse.c */
660 int has_symbol(struct expression
*expr
, struct symbol
*sym
);
661 int has_variable(struct expression
*expr
, struct expression
*var
);
663 #endif /* !SMATCH_H_ */