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
);
81 GLOBAL_ASSIGNMENT_HOOK
,
88 CALL_HOOK_AFTER_INLINE
,
90 MACRO_ASSIGNMENT_HOOK
,
114 void add_hook(void *func
, enum hook_type type
);
115 typedef struct smatch_state
*(merge_func_t
)(struct smatch_state
*s1
, struct smatch_state
*s2
);
116 typedef struct smatch_state
*(unmatched_func_t
)(struct sm_state
*state
);
117 void add_merge_hook(int client_id
, merge_func_t
*func
);
118 void add_unmatched_state_hook(int client_id
, unmatched_func_t
*func
);
119 typedef void (scope_hook
)(void *data
);
120 void add_scope_hook(scope_hook
*hook
, void *data
);
121 typedef void (func_hook
)(const char *fn
, struct expression
*expr
, void *data
);
122 typedef void (implication_hook
)(const char *fn
, struct expression
*call_expr
,
123 struct expression
*assign_expr
, void *data
);
124 typedef void (return_implies_hook
)(struct expression
*call_expr
,
125 int param
, char *key
, char *value
);
126 typedef int (implied_return_hook
)(struct expression
*call_expr
, void *info
, struct range_list
**rl
);
127 void add_function_hook(const char *look_for
, func_hook
*call_back
, void *data
);
129 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
131 void add_implied_return_hook(const char *look_for
,
132 implied_return_hook
*call_back
,
134 void add_macro_assign_hook(const char *look_for
, func_hook
*call_back
,
136 void add_macro_assign_hook_extra(const char *look_for
, func_hook
*call_back
,
138 void return_implies_state(const char *look_for
, long long start
, long long end
,
139 implication_hook
*call_back
, void *info
);
140 void add_db_return_states_callback(int type
, return_implies_hook
*callback
);
141 void add_db_return_states_before(void (*fn
)(void));
142 void add_db_return_states_after(void (*fn
)(void));
143 int get_implied_return(struct expression
*expr
, struct range_list
**rl
);
145 typedef void (modification_hook
)(struct sm_state
*sm
, struct expression
*mod_expr
);
146 void add_modification_hook(int owner
, modification_hook
*call_back
);
147 void add_indirect_modification_hook(int owner
, modification_hook
*call_back
);
149 const char *get_filename(void);
150 const char *get_base_file(void);
151 char *get_function(void);
152 int get_lineno(void);
153 extern int final_pass
;
154 extern struct symbol
*cur_func_sym
;
155 extern int option_debug
;
156 extern int local_debug
;
158 extern FILE *sm_outfd
;
159 #define sm_printf(msg...) do { if (final_pass || option_debug) fprintf(sm_outfd, msg); } while (0)
161 static inline void sm_prefix(void)
163 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
166 static inline void print_implied_debug_msg();
168 #define sm_msg(msg...) \
170 print_implied_debug_msg(); \
171 if (!option_debug && !final_pass) \
178 #define local_debug(msg...) \
184 extern char *implied_debug_msg
;
185 static inline void print_implied_debug_msg()
187 static struct symbol
*last_printed
= NULL
;
189 if (!implied_debug_msg
)
191 if (last_printed
== cur_func_sym
)
193 last_printed
= cur_func_sym
;
194 sm_msg("%s", implied_debug_msg
);
197 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
199 #define sm_info(msg...) do { \
200 if (option_debug || (option_info && final_pass)) { \
202 sm_printf("info: "); \
208 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
209 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
210 struct state_list
*get_possible_states(int owner
, const char *name
,
212 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
213 struct sm_state
*set_state(int owner
, const char *name
, struct symbol
*sym
,
214 struct smatch_state
*state
);
215 struct sm_state
*set_state_expr(int owner
, struct expression
*expr
,
216 struct smatch_state
*state
);
217 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
218 void delete_state_expr(int owner
, struct expression
*expr
);
219 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
220 struct smatch_state
*true_state
,
221 struct smatch_state
*false_state
);
222 void set_true_false_states_expr(int owner
, struct expression
*expr
,
223 struct smatch_state
*true_state
,
224 struct smatch_state
*false_state
);
226 struct state_list
*get_all_states_slist(int owner
, struct state_list
*source
);
227 struct state_list
*get_all_states(int id
);
228 int is_reachable(void);
230 /* smatch_helper.c */
231 char *alloc_string(const char *str
);
232 void free_string(char *str
);
233 void remove_parens(char *str
);
234 struct smatch_state
*alloc_state_num(int num
);
235 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
238 char *expr_to_var(struct expression
*expr
);
239 char *expr_to_str(struct expression
*expr
);
240 char *expr_to_str_sym(struct expression
*expr
,
241 struct symbol
**sym_ptr
);
242 char *expr_to_var_sym(struct expression
*expr
,
243 struct symbol
**sym_ptr
);
245 int sym_name_is(const char *name
, struct expression
*expr
);
246 int get_value(struct expression
*expr
, sval_t
*val
);
247 int get_implied_value(struct expression
*expr
, sval_t
*val
);
248 int get_implied_min(struct expression
*expr
, sval_t
*sval
);
249 int get_implied_max(struct expression
*expr
, sval_t
*val
);
250 int get_hard_max(struct expression
*expr
, sval_t
*sval
);
251 int get_fuzzy_min(struct expression
*expr
, sval_t
*min
);
252 int get_fuzzy_max(struct expression
*expr
, sval_t
*max
);
253 int get_absolute_min(struct expression
*expr
, sval_t
*sval
);
254 int get_absolute_max(struct expression
*expr
, sval_t
*sval
);
255 int parse_call_math(struct expression
*expr
, char *math
, sval_t
*val
);
256 int is_zero(struct expression
*expr
);
257 int known_condition_true(struct expression
*expr
);
258 int known_condition_false(struct expression
*expr
);
259 int implied_condition_true(struct expression
*expr
);
260 int implied_condition_false(struct expression
*expr
);
262 int is_array(struct expression
*expr
);
263 struct expression
*get_array_name(struct expression
*expr
);
264 struct expression
*get_array_offset(struct expression
*expr
);
265 const char *show_state(struct smatch_state
*state
);
266 struct statement
*get_expression_statement(struct expression
*expr
);
267 struct expression
*strip_parens(struct expression
*expr
);
268 struct expression
*strip_expr(struct expression
*expr
);
269 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
270 int is_error_return(struct expression
*expr
);
271 int getting_address(void);
272 char *get_member_name(struct expression
*expr
);
273 char *get_fnptr_name(struct expression
*expr
);
274 int positions_eq(struct position pos1
, struct position pos2
);
275 struct statement
*get_current_statement(void);
276 int get_param_num_from_sym(struct symbol
*sym
);
279 struct symbol
*get_real_base_type(struct symbol
*sym
);
280 int type_bits(struct symbol
*type
);
281 int type_positive_bits(struct symbol
*type
);
282 struct symbol
*get_pointer_type(struct expression
*expr
);
283 struct symbol
*get_type(struct expression
*expr
);
284 int type_unsigned(struct symbol
*base_type
);
285 int type_signed(struct symbol
*base_type
);
286 int expr_unsigned(struct expression
*expr
);
287 int returns_unsigned(struct symbol
*base_type
);
288 int is_pointer(struct expression
*expr
);
289 int returns_pointer(struct symbol
*base_type
);
290 sval_t
sval_type_max(struct symbol
*base_type
);
291 sval_t
sval_type_min(struct symbol
*base_type
);
292 int nr_bits(struct expression
*expr
);
293 int is_void_pointer(struct expression
*expr
);
294 int is_char_pointer(struct expression
*expr
);
295 int is_static(struct expression
*expr
);
296 int types_equiv(struct symbol
*one
, struct symbol
*two
);
298 const char *global_static();
299 struct symbol
*cur_func_return_type(void);
300 struct symbol
*get_arg_type(struct expression
*fn
, int arg
);
301 struct symbol
*get_member_type_from_key(struct expression
*expr
, char *key
);
303 /* smatch_ignore.c */
304 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
305 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
308 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
309 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
311 void add_tracker_expr(struct tracker_list
**list
, int owner
, struct expression
*expr
);
312 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
314 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
316 void free_tracker_list(struct tracker_list
**list
);
317 void free_trackers_and_list(struct tracker_list
**list
);
319 /* smatch_conditions */
320 int in_condition(void);
324 void smatch (int argc
, char **argv
);
325 int inside_loop(void);
326 struct expression
*get_switch_expr(void);
327 int in_expression_statement(void);
328 void __process_post_op_stack(void);
329 void __split_expr(struct expression
*expr
);
330 void __split_stmt(struct statement
*stmt
);
331 extern int option_assume_loops
;
332 extern int option_known_conditions
;
333 extern int option_two_passes
;
334 extern int option_no_db
;
335 extern int option_file_output
;
336 extern struct expression_list
*big_expression_stack
;
337 extern struct statement_list
*big_statement_stack
;
338 int inlinable(struct expression
*expr
);
339 extern int __inline_call
;
340 extern struct expression
*__inline_fn
;
341 extern int __in_pre_condition
;
342 extern int __bail_on_rest_of_function
;
344 /* smatch_conditions */
345 void __split_whole_condition(struct expression
*expr
);
346 void __handle_logic(struct expression
*expr
);
347 int is_condition(struct expression
*expr
);
348 int __handle_condition_assigns(struct expression
*expr
);
349 int __handle_select_assigns(struct expression
*expr
);
350 int __handle_expr_statement_assigns(struct expression
*expr
);
352 /* smatch_implied.c */
353 extern int option_debug_implied
;
354 extern int option_debug_related
;
355 extern int option_no_implied
;
356 void get_implications(char *name
, struct symbol
*sym
, int comparison
, long long num
,
357 struct state_list
**true_states
,
358 struct state_list
**false_states
);
359 struct range_list_stack
;
360 struct state_list
*__implied_case_slist(struct expression
*switch_expr
,
361 struct expression
*case_expr
,
362 struct range_list_stack
**remaining_cases
,
363 struct state_list
**raw_slist
);
364 struct range_list
*__get_implied_values(struct expression
*switch_expr
);
365 void overwrite_states_using_pool(struct sm_state
*sm
);
367 /* smatch_extras.c */
368 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
375 static const long long valid_ptr_max
= LONG_MAX
;
376 static const long long valid_ptr_min
= 4096;
377 static const sval_t valid_ptr_max_sval
= {
381 static const sval_t valid_ptr_min_sval
= {
386 /* smatch_absolute.c */
387 int get_absolute_min_helper(struct expression
*expr
, sval_t
*sval
);
388 int get_absolute_max_helper(struct expression
*expr
, sval_t
*sval
);
390 /* smatch_local_values.c */
391 int get_local_rl(struct expression
*expr
, struct range_list
**rl
);
392 int get_local_max_helper(struct expression
*expr
, sval_t
*sval
);
393 int get_local_min_helper(struct expression
*expr
, sval_t
*sval
);
395 /* smatch_states.c */
396 void __push_fake_cur_slist();
397 struct state_list
*__pop_fake_cur_slist();
398 void __free_fake_cur_slist();
399 void __set_fake_cur_slist_fast(struct state_list
*slist
);
400 void __pop_fake_cur_slist_fast(void);
401 void __merge_slist_into_cur(struct state_list
*slist
);
403 int unreachable(void);
404 void __set_sm(struct sm_state
*sm
);
405 struct state_list
*__get_cur_slist(void);
406 void __set_true_false_sm(struct sm_state
*true_state
,
407 struct sm_state
*false_state
);
408 void nullify_path(void);
409 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
411 void __unnullify_path(void);
412 int __path_is_null(void);
413 void save_all_states(void);
414 void nullify_all_states(void);
415 void restore_all_states(void);
416 void clear_all_states(void);
418 struct sm_state
*get_sm_state(int owner
, const char *name
,
420 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
421 void __push_true_states(void);
422 void __use_false_states(void);
423 void __discard_false_states(void);
424 void __merge_false_states(void);
425 void __merge_true_states(void);
427 void __negate_cond_stacks(void);
428 void __use_pre_cond_states(void);
429 void __use_cond_true_states(void);
430 void __use_cond_false_states(void);
431 void __push_cond_stacks(void);
432 struct state_list
*__copy_cond_true_states(void);
433 struct state_list
*__copy_cond_false_states(void);
434 struct state_list
*__pop_cond_true_stack(void);
435 struct state_list
*__pop_cond_false_stack(void);
436 void __and_cond_states(void);
437 void __or_cond_states(void);
438 void __save_pre_cond_states(void);
439 void __discard_pre_cond_states(void);
440 void __use_cond_states(void);
441 extern struct state_list
*__last_base_slist
;
443 void __warn_on_silly_pre_loops(void);
445 void __push_continues(void);
446 void __discard_continues(void);
447 void __process_continues(void);
448 void __merge_continues(void);
450 void __push_breaks(void);
451 void __process_breaks(void);
452 int __has_breaks(void);
453 void __merge_breaks(void);
454 void __use_breaks(void);
456 void __save_switch_states(struct expression
*switch_expr
);
457 void __discard_switches(void);
458 void __merge_switches(struct expression
*switch_expr
, struct expression
*case_expr
);
459 void __push_default(void);
460 void __set_default(void);
461 int __pop_default(void);
463 void __push_conditions(void);
464 void __discard_conditions(void);
466 void __save_gotos(const char *name
);
467 void __merge_gotos(const char *name
);
469 void __print_cur_slist(void);
472 void __pass_to_client(void *data
, enum hook_type type
);
473 void __pass_to_client_no_data(enum hook_type type
);
474 void __pass_case_to_client(struct expression
*switch_expr
,
475 struct expression
*case_expr
);
476 int __has_merge_function(int client_id
);
477 struct smatch_state
*__client_merge_function(int owner
,
478 struct smatch_state
*s1
,
479 struct smatch_state
*s2
);
480 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
481 void __push_scope_hooks(void);
482 void __call_scope_hooks(void);
484 /* smatch_function_hooks.c */
485 void create_function_hook_hash(void);
486 void __match_initializer_call(struct symbol
*sym
);
500 ABSOLUTE_LIMITS
= 10,
507 void add_definition_db_callback(void (*callback
)(const char *name
, struct symbol
*sym
, char *key
, char *value
), int type
);
508 void add_member_info_callback(int owner
, void (*callback
)(struct expression
*call
, int param
, char *printed_name
, struct smatch_state
*state
));
509 void add_returned_state_callback(void (*fn
)(int return_id
, char *return_ranges
, struct expression
*returned_expr
));
510 void add_returned_member_callback(int owner
, void (*callback
)(int return_id
, char *return_ranges
, char *printed_name
, struct smatch_state
*state
));
511 void add_db_fn_call_callback(int type
, void (*callback
)(struct expression
*arg
, char *value
));
512 struct range_list
*db_return_vals(struct expression
*expr
);
513 char *get_variable_from_key(struct expression
*arg
, char *key
, struct symbol
**sym
);
514 const char *get_param_name(struct sm_state
*sm
);
516 #define run_sql(call_back, sql...) \
518 char sql_txt[1024]; \
521 snprintf(sql_txt, 1024, sql); \
522 sm_debug("%s\n", sql_txt); \
523 sql_exec(call_back, sql_txt); \
526 /* like run_sql() but for the in-memory database */
527 #define mem_sql(call_back, sql...) \
529 char sql_txt[1024]; \
531 snprintf(sql_txt, sizeof(sql_txt), sql); \
532 sm_debug("in-mem: %s\n", sql_txt); \
533 sql_mem_exec(call_back, sql_txt); \
536 void sql_insert_return_states(int return_id
, const char *return_ranges
,
537 int type
, int param
, const char *key
, const char *value
);
538 void sql_insert_caller_info(struct expression
*call
, int type
, int param
,
539 const char *key
, const char *value
);
540 void sql_insert_function_ptr(const char *fn
, const char *struct_name
);
541 void sql_insert_return_values(const char *return_values
);
542 void sql_insert_call_implies(int type
, int param
, int value
);
543 void sql_insert_type_size(const char *member
, int size
);
544 void sql_insert_local_values(const char *name
, const char *value
);
546 void sql_select_return_states(const char *cols
, struct expression
*call
,
547 int (*callback
)(void*, int, char**, char**));
548 void sql_select_caller_info(const char *cols
, struct symbol
*sym
,
549 int (*callback
)(void*, int, char**, char**));
550 void sql_select_call_implies(const char *cols
, struct expression
*call
,
551 int (*callback
)(void*, int, char**, char**));
553 void sql_exec(int (*callback
)(void*, int, char**, char**), const char *sql
);
554 void sql_mem_exec(int (*callback
)(void*, int, char**, char**), const char *sql
);
556 void open_smatch_db(void);
559 int open_data_file(const char *filename
);
560 struct token
*get_tokens_file(const char *filename
);
563 extern char *option_project_str
;
564 extern char *data_dir
;
565 extern int option_no_data
;
566 extern int option_spammy
;
567 extern int option_full_path
;
568 extern int option_param_mapper
;
569 extern int option_info
;
570 extern int option_call_tree
;
571 extern int num_checks
;
578 extern enum project_type option_project
;
579 const char *check_name(unsigned short id
);
582 /* smatch_buf_size.c */
583 int get_array_size(struct expression
*expr
);
584 int get_array_size_bytes(struct expression
*expr
);
585 int get_array_size_bytes_min(struct expression
*expr
);
586 int get_real_array_size(struct expression
*expr
);
588 /* smatch_capped.c */
589 int is_capped(struct expression
*expr
);
590 int is_capped_var_sym(const char *name
, struct symbol
*sym
);
592 /* check_user_data.c */
593 int is_user_data(struct expression
*expr
);
594 int is_capped_user_data(struct expression
*expr
);
596 /* check_locking.c */
597 void print_held_locks();
599 /* check_assigned_expr.c */
600 struct expression
*get_assigned_expr(struct expression
*expr
);
602 /* smatch_comparison.c */
603 int get_comparison(struct expression
*left
, struct expression
*right
);
604 void __add_comparison_info(struct expression
*expr
, struct expression
*call
, const char *range
);
605 char *range_comparison_to_param(struct expression
*expr
);
608 sval_t
*sval_alloc(sval_t sval
);
609 sval_t
*sval_alloc_permanent(sval_t sval
);
610 sval_t
sval_blank(struct expression
*expr
);
611 sval_t
sval_type_val(struct symbol
*type
, long long val
);
612 sval_t
sval_from_val(struct expression
*expr
, long long val
);
613 int sval_unsigned(sval_t sval
);
614 int sval_signed(sval_t sval
);
615 int sval_bits(sval_t sval
);
616 int sval_positive_bits(sval_t sval
);
617 int sval_bits_used(sval_t sval
);
618 int sval_is_negative(sval_t sval
);
619 int sval_is_positive(sval_t sval
);
620 int sval_is_min(sval_t sval
);
621 int sval_is_max(sval_t sval
);
622 int sval_is_a_min(sval_t sval
);
623 int sval_is_a_max(sval_t sval
);
624 int sval_is_negative_min(sval_t sval
);
625 int sval_cmp(sval_t one
, sval_t two
);
626 int sval_cmp_t(struct symbol
*type
, sval_t one
, sval_t two
);
627 int sval_cmp_val(sval_t one
, long long val
);
628 sval_t
sval_min(sval_t one
, sval_t two
);
629 sval_t
sval_max(sval_t one
, sval_t two
);
630 int sval_too_low(struct symbol
*type
, sval_t sval
);
631 int sval_too_high(struct symbol
*type
, sval_t sval
);
632 int sval_fits(struct symbol
*type
, sval_t sval
);
633 sval_t
sval_cast(struct symbol
*type
, sval_t sval
);
634 sval_t
sval_preop(sval_t sval
, int op
);
635 sval_t
sval_binop(sval_t left
, int op
, sval_t right
);
636 int sval_binop_overflows(sval_t left
, int op
, sval_t right
);
637 const char *sval_to_str(sval_t sval
);
638 const char *sval_to_numstr(sval_t sval
);
639 sval_t
ll_to_sval(long long val
);
641 /* smatch_string_list.c */
642 int list_has_string(struct string_list
*str_list
, char *str
);
643 void insert_string(struct string_list
**str_list
, char *str
);
644 struct string_list
*clone_str_list(struct string_list
*orig
);
645 struct string_list
*combine_string_lists(struct string_list
*one
, struct string_list
*two
);
647 /* smatch_clear_buffer.c */
648 int is_uninitialized(struct expression
*expr
);
649 int has_uninitialized_members(struct expression
*expr
);
651 /* smatch_start_states.c */
652 struct state_list
*get_start_states(void);
654 /* smatch_recurse.c */
655 int has_symbol(struct expression
*expr
, struct symbol
*sym
);
656 int has_variable(struct expression
*expr
, struct expression
*var
);
658 #endif /* !SMATCH_H_ */