2 * Copyright (C) 2006 Dan Carpenter.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see http://www.gnu.org/copyleft/gpl.txt
30 #include "expression.h"
37 unsigned long long uvalue
;
41 typedef long long mtag_t
;
47 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
48 extern struct smatch_state undefined
;
49 extern struct smatch_state ghost
;
50 extern struct smatch_state merged
;
51 extern struct smatch_state true_state
;
52 extern struct smatch_state false_state
;
53 DECLARE_ALLOCATOR(smatch_state
);
55 static inline void *INT_PTR(int i
)
57 return (void *)(long)i
;
60 static inline int PTR_INT(void *p
)
70 DECLARE_ALLOCATOR(tracker
);
71 DECLARE_PTR_LIST(tracker_list
, struct tracker
);
72 DECLARE_PTR_LIST(stree_stack
, struct stree
);
74 /* The first 3 struct members must match struct tracker */
79 unsigned short merged
:1;
80 unsigned short skip_implications
:1;
81 unsigned int nr_children
;
83 struct smatch_state
*state
;
85 struct sm_state
*left
;
86 struct sm_state
*right
;
87 struct state_list
*possible
;
94 DECLARE_ALLOCATOR(var_sym
);
95 DECLARE_PTR_LIST(var_sym_list
, struct var_sym
);
101 DECLARE_PTR_LIST(constraint_list
, struct constraint
);
111 ASSIGNMENT_HOOK_AFTER
,
113 GLOBAL_ASSIGNMENT_HOOK
,
118 WHOLE_CONDITION_HOOK
,
119 FUNCTION_CALL_HOOK_BEFORE
,
121 CALL_HOOK_AFTER_INLINE
,
122 FUNCTION_CALL_HOOK_AFTER_DB
,
123 CALL_ASSIGNMENT_HOOK
,
124 MACRO_ASSIGNMENT_HOOK
,
149 void add_hook(void *func
, enum hook_type type
);
150 typedef struct smatch_state
*(merge_func_t
)(struct smatch_state
*s1
, struct smatch_state
*s2
);
151 typedef struct smatch_state
*(unmatched_func_t
)(struct sm_state
*state
);
152 void add_merge_hook(int client_id
, merge_func_t
*func
);
153 void add_unmatched_state_hook(int client_id
, unmatched_func_t
*func
);
154 void add_pre_merge_hook(int client_id
, void (*hook
)(struct sm_state
*sm
));
155 typedef void (scope_hook
)(void *data
);
156 void add_scope_hook(scope_hook
*hook
, void *data
);
157 typedef void (func_hook
)(const char *fn
, struct expression
*expr
, void *data
);
158 typedef void (implication_hook
)(const char *fn
, struct expression
*call_expr
,
159 struct expression
*assign_expr
, void *data
);
160 typedef void (return_implies_hook
)(struct expression
*call_expr
,
161 int param
, char *key
, char *value
);
162 typedef int (implied_return_hook
)(struct expression
*call_expr
, void *info
, struct range_list
**rl
);
163 void add_function_hook(const char *look_for
, func_hook
*call_back
, void *data
);
165 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
167 void add_implied_return_hook(const char *look_for
,
168 implied_return_hook
*call_back
,
170 void add_macro_assign_hook(const char *look_for
, func_hook
*call_back
,
172 void add_macro_assign_hook_extra(const char *look_for
, func_hook
*call_back
,
174 void return_implies_state(const char *look_for
, long long start
, long long end
,
175 implication_hook
*call_back
, void *info
);
176 void select_return_states_hook(int type
, return_implies_hook
*callback
);
177 void select_return_states_before(void (*fn
)(void));
178 void select_return_states_after(void (*fn
)(void));
179 int get_implied_return(struct expression
*expr
, struct range_list
**rl
);
180 void allocate_hook_memory(void);
182 struct modification_data
{
183 struct smatch_state
*prev
;
184 struct expression
*cur
;
187 typedef void (modification_hook
)(struct sm_state
*sm
, struct expression
*mod_expr
);
188 void add_modification_hook(int owner
, modification_hook
*call_back
);
189 void add_modification_hook_late(int owner
, modification_hook
*call_back
);
190 struct smatch_state
*get_modification_state(struct expression
*expr
);
192 int outside_of_function(void);
193 const char *get_filename(void);
194 const char *get_base_file(void);
195 char *get_function(void);
196 int get_lineno(void);
197 extern int final_pass
;
198 extern struct symbol
*cur_func_sym
;
199 extern int option_debug
;
200 extern int local_debug
;
201 extern int option_info
;
202 extern int option_spammy
;
203 extern char *trace_variable
;
204 extern struct stree
*global_states
;
205 int is_skipped_function(void);
206 int is_silenced_function(void);
208 /* smatch_impossible.c */
209 int is_impossible_path(void);
210 void set_path_impossible(void);
212 extern FILE *sm_outfd
;
213 extern FILE *sql_outfd
;
214 extern FILE *caller_info_fd
;
215 #define sm_printf(msg...) do { if (final_pass || option_debug || local_debug) fprintf(sm_outfd, msg); } while (0)
217 static inline void sm_prefix(void)
219 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
222 static inline void print_implied_debug_msg();
224 extern bool __silence_warnings_for_stmt
;
226 #define sm_msg(msg...) \
228 print_implied_debug_msg(); \
229 if (!final_pass && !option_debug && !local_debug) \
231 if (__silence_warnings_for_stmt && !option_debug && !local_debug) \
233 if (!option_info && is_silenced_function()) \
240 #define local_debug(msg...) \
246 extern char *implied_debug_msg
;
247 static inline void print_implied_debug_msg(void)
249 static struct symbol
*last_printed
= NULL
;
251 if (!implied_debug_msg
)
253 if (last_printed
== cur_func_sym
)
255 last_printed
= cur_func_sym
;
256 sm_msg("%s", implied_debug_msg
);
259 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
261 #define sm_info(msg...) do { \
262 if (option_debug || (option_info && final_pass)) { \
264 sm_printf("info: "); \
270 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
272 struct smatch_state
*__get_state(int owner
, const char *name
, struct symbol
*sym
);
273 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
274 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
275 struct state_list
*get_possible_states(int owner
, const char *name
,
277 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
278 struct sm_state
*set_state(int owner
, const char *name
, struct symbol
*sym
,
279 struct smatch_state
*state
);
280 struct sm_state
*set_state_expr(int owner
, struct expression
*expr
,
281 struct smatch_state
*state
);
282 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
283 void delete_state_expr(int owner
, struct expression
*expr
);
284 void __delete_all_states_sym(struct symbol
*sym
);
285 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
286 struct smatch_state
*true_state
,
287 struct smatch_state
*false_state
);
288 void set_true_false_states_expr(int owner
, struct expression
*expr
,
289 struct smatch_state
*true_state
,
290 struct smatch_state
*false_state
);
292 struct stree
*get_all_states_from_stree(int owner
, struct stree
*source
);
293 struct stree
*get_all_states_stree(int id
);
294 struct stree
*__get_cur_stree(void);
295 int is_reachable(void);
296 void add_get_state_hook(void (*fn
)(int owner
, const char *name
, struct symbol
*sym
));
298 /* smatch_helper.c */
299 DECLARE_PTR_LIST(int_stack
, int);
300 char *alloc_string(const char *str
);
301 void free_string(char *str
);
302 void append(char *dest
, const char *data
, int buff_len
);
303 void remove_parens(char *str
);
304 struct smatch_state
*alloc_state_num(int num
);
305 struct smatch_state
*alloc_state_str(const char *name
);
306 struct smatch_state
*alloc_state_expr(struct expression
*expr
);
307 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
310 char *expr_to_var(struct expression
*expr
);
311 struct symbol
*expr_to_sym(struct expression
*expr
);
312 char *expr_to_str(struct expression
*expr
);
313 char *expr_to_str_sym(struct expression
*expr
,
314 struct symbol
**sym_ptr
);
315 char *expr_to_var_sym(struct expression
*expr
,
316 struct symbol
**sym_ptr
);
317 char *expr_to_known_chunk_sym(struct expression
*expr
, struct symbol
**sym
);
318 char *expr_to_chunk_sym_vsl(struct expression
*expr
, struct symbol
**sym
, struct var_sym_list
**vsl
);
319 int get_complication_score(struct expression
*expr
);
321 int sym_name_is(const char *name
, struct expression
*expr
);
322 int get_const_value(struct expression
*expr
, sval_t
*sval
);
323 int get_value(struct expression
*expr
, sval_t
*val
);
324 int get_implied_value(struct expression
*expr
, sval_t
*val
);
325 int get_implied_min(struct expression
*expr
, sval_t
*sval
);
326 int get_implied_max(struct expression
*expr
, sval_t
*val
);
327 int get_hard_max(struct expression
*expr
, sval_t
*sval
);
328 int get_fuzzy_min(struct expression
*expr
, sval_t
*min
);
329 int get_fuzzy_max(struct expression
*expr
, sval_t
*max
);
330 int get_absolute_min(struct expression
*expr
, sval_t
*sval
);
331 int get_absolute_max(struct expression
*expr
, sval_t
*sval
);
332 int parse_call_math(struct expression
*expr
, char *math
, sval_t
*val
);
333 int parse_call_math_rl(struct expression
*call
, char *math
, struct range_list
**rl
);
334 char *get_value_in_terms_of_parameter_math(struct expression
*expr
);
335 char *get_value_in_terms_of_parameter_math_var_sym(const char *var
, struct symbol
*sym
);
336 int is_zero(struct expression
*expr
);
337 int known_condition_true(struct expression
*expr
);
338 int known_condition_false(struct expression
*expr
);
339 int implied_condition_true(struct expression
*expr
);
340 int implied_condition_false(struct expression
*expr
);
341 int can_integer_overflow(struct symbol
*type
, struct expression
*expr
);
342 void clear_math_cache(void);
344 int is_array(struct expression
*expr
);
345 struct expression
*get_array_base(struct expression
*expr
);
346 struct expression
*get_array_offset(struct expression
*expr
);
347 const char *show_state(struct smatch_state
*state
);
348 struct statement
*get_expression_statement(struct expression
*expr
);
349 struct expression
*strip_parens(struct expression
*expr
);
350 struct expression
*strip_expr(struct expression
*expr
);
351 struct expression
*strip_expr_set_parent(struct expression
*expr
);
352 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
353 int is_error_return(struct expression
*expr
);
354 int getting_address(void);
355 int get_struct_and_member(struct expression
*expr
, const char **type
, const char **member
);
356 char *get_member_name(struct expression
*expr
);
357 char *get_fnptr_name(struct expression
*expr
);
358 int cmp_pos(struct position pos1
, struct position pos2
);
359 int positions_eq(struct position pos1
, struct position pos2
);
360 struct statement
*get_current_statement(void);
361 struct statement
*get_prev_statement(void);
362 struct expression
*get_last_expr_from_expression_stmt(struct expression
*expr
);
363 int get_param_num_from_sym(struct symbol
*sym
);
364 int get_param_num(struct expression
*expr
);
365 int ms_since(struct timeval
*start
);
366 int parent_is_gone_var_sym(const char *name
, struct symbol
*sym
);
367 int parent_is_gone(struct expression
*expr
);
368 int invert_op(int op
);
369 int expr_equiv(struct expression
*one
, struct expression
*two
);
370 void push_int(struct int_stack
**stack
, int num
);
371 int pop_int(struct int_stack
**stack
);
374 struct symbol
*get_real_base_type(struct symbol
*sym
);
375 int type_bytes(struct symbol
*type
);
376 int array_bytes(struct symbol
*type
);
377 struct symbol
*get_pointer_type(struct expression
*expr
);
378 struct symbol
*get_type(struct expression
*expr
);
379 struct symbol
*get_final_type(struct expression
*expr
);
380 struct symbol
*get_promoted_type(struct symbol
*left
, struct symbol
*right
);
381 int type_signed(struct symbol
*base_type
);
382 int expr_unsigned(struct expression
*expr
);
383 int expr_signed(struct expression
*expr
);
384 int returns_unsigned(struct symbol
*base_type
);
385 int is_pointer(struct expression
*expr
);
386 int returns_pointer(struct symbol
*base_type
);
387 sval_t
sval_type_max(struct symbol
*base_type
);
388 sval_t
sval_type_min(struct symbol
*base_type
);
389 int nr_bits(struct expression
*expr
);
390 int is_void_pointer(struct expression
*expr
);
391 int is_char_pointer(struct expression
*expr
);
392 int is_string(struct expression
*expr
);
393 int is_static(struct expression
*expr
);
394 int is_local_variable(struct expression
*expr
);
395 int types_equiv(struct symbol
*one
, struct symbol
*two
);
397 const char *global_static();
398 struct symbol
*cur_func_return_type(void);
399 struct symbol
*get_arg_type(struct expression
*fn
, int arg
);
400 struct symbol
*get_member_type_from_key(struct expression
*expr
, const char *key
);
401 struct symbol
*get_arg_type_from_key(struct expression
*fn
, int param
, struct expression
*arg
, const char *key
);
402 int is_struct(struct expression
*expr
);
403 char *type_to_str(struct symbol
*type
);
405 /* smatch_ignore.c */
406 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
407 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
408 void add_ignore_expr(int owner
, struct expression
*expr
);
409 int is_ignored_expr(int owner
, struct expression
*expr
);
412 struct var_sym
*alloc_var_sym(const char *var
, struct symbol
*sym
);
413 struct var_sym_list
*expr_to_vsl(struct expression
*expr
);
414 void add_var_sym(struct var_sym_list
**list
, const char *var
, struct symbol
*sym
);
415 void add_var_sym_expr(struct var_sym_list
**list
, struct expression
*expr
);
416 void del_var_sym(struct var_sym_list
**list
, const char *var
, struct symbol
*sym
);
417 int in_var_sym_list(struct var_sym_list
*list
, const char *var
, struct symbol
*sym
);
418 struct var_sym_list
*clone_var_sym_list(struct var_sym_list
*from_vsl
);
419 void merge_var_sym_list(struct var_sym_list
**dest
, struct var_sym_list
*src
);
420 struct var_sym_list
*combine_var_sym_lists(struct var_sym_list
*one
, struct var_sym_list
*two
);
421 int var_sym_lists_equiv(struct var_sym_list
*one
, struct var_sym_list
*two
);
422 void free_var_sym_list(struct var_sym_list
**list
);
423 void free_var_syms_and_list(struct var_sym_list
**list
);
426 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
427 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
429 void add_tracker_expr(struct tracker_list
**list
, int owner
, struct expression
*expr
);
430 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
432 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
434 void free_tracker_list(struct tracker_list
**list
);
435 void free_trackers_and_list(struct tracker_list
**list
);
437 /* smatch_conditions */
438 int in_condition(void);
442 extern int __in_fake_assign
;
443 extern int __in_fake_parameter_assign
;
444 extern int __in_fake_struct_assign
;
445 extern int in_fake_env
;
446 void smatch (int argc
, char **argv
);
447 int inside_loop(void);
448 int definitely_inside_loop(void);
449 struct expression
*get_switch_expr(void);
450 int in_expression_statement(void);
451 void __process_post_op_stack(void);
452 void __split_expr(struct expression
*expr
);
453 void __split_label_stmt(struct statement
*stmt
);
454 void __split_stmt(struct statement
*stmt
);
455 extern int __in_function_def
;
456 extern int option_assume_loops
;
457 extern int option_two_passes
;
458 extern int option_no_db
;
459 extern int option_file_output
;
460 extern int option_time
;
461 extern struct expression_list
*big_expression_stack
;
462 extern struct expression_list
*big_condition_stack
;
463 extern struct statement_list
*big_statement_stack
;
464 int is_assigned_call(struct expression
*expr
);
465 int inlinable(struct expression
*expr
);
466 extern int __inline_call
;
467 extern struct expression
*__inline_fn
;
468 extern int __in_pre_condition
;
469 extern int __bail_on_rest_of_function
;
470 extern struct statement
*__prev_stmt
;
471 extern struct statement
*__cur_stmt
;
472 extern struct statement
*__next_stmt
;
473 void init_fake_env(void);
474 void end_fake_env(void);
475 int time_parsing_function(void);
477 /* smatch_struct_assignment.c */
478 struct expression
*get_faked_expression(void);
479 void __fake_struct_member_assignments(struct expression
*expr
);
481 /* smatch_project.c */
482 int is_no_inline_function(const char *function
);
484 /* smatch_conditions */
485 void __split_whole_condition(struct expression
*expr
);
486 void __handle_logic(struct expression
*expr
);
487 int is_condition(struct expression
*expr
);
488 int __handle_condition_assigns(struct expression
*expr
);
489 int __handle_select_assigns(struct expression
*expr
);
490 int __handle_expr_statement_assigns(struct expression
*expr
);
492 /* smatch_implied.c */
493 extern int option_debug_implied
;
494 extern int option_debug_related
;
495 struct range_list_stack
;
496 void param_limit_implications(struct expression
*expr
, int param
, char *key
, char *value
);
497 struct stree
*__implied_case_stree(struct expression
*switch_expr
,
498 struct range_list
*case_rl
,
499 struct range_list_stack
**remaining_cases
,
500 struct stree
**raw_stree
);
501 void overwrite_states_using_pool(struct sm_state
*gate_sm
, struct sm_state
*pool_sm
);
502 int assume(struct expression
*expr
);
503 void end_assume(void);
504 int impossible_assumption(struct expression
*left
, int op
, sval_t sval
);
506 /* smatch_extras.c */
507 #define SMATCH_EXTRA 5 /* this is my_id from smatch extra set in smatch.c */
508 extern int RETURN_ID
;
515 #define MTAG_ALIAS_BIT (1ULL << 63)
516 #define MTAG_OFFSET_MASK 0xfffULL
518 extern long long valid_ptr_min
, valid_ptr_max
;
519 extern sval_t valid_ptr_min_sval
, valid_ptr_max_sval
;
520 extern struct range_list
*valid_ptr_rl
;
521 static const sval_t array_min_sval
= {
525 static const sval_t array_max_sval
= {
529 static const sval_t text_seg_min
= {
531 {.value
= 100000000},
533 static const sval_t text_seg_max
= {
535 {.value
= 177777777},
537 static const sval_t data_seg_min
= {
539 {.value
= 200000000},
541 static const sval_t data_seg_max
= {
543 {.value
= 277777777},
545 static const sval_t bss_seg_min
= {
547 {.value
= 300000000},
549 static const sval_t bss_seg_max
= {
551 {.value
= 377777777},
553 static const sval_t stack_seg_min
= {
555 {.value
= 400000000},
557 static const sval_t stack_seg_max
= {
559 {.value
= 477777777},
561 static const sval_t kmalloc_seg_min
= {
563 {.value
= 500000000},
565 static const sval_t kmalloc_seg_max
= {
567 {.value
= 577777777},
569 static const sval_t vmalloc_seg_min
= {
571 {.value
= 600000000},
573 static const sval_t vmalloc_seg_max
= {
575 {.value
= 677777777},
577 static const sval_t fn_ptr_min
= {
579 {.value
= 700000000},
581 static const sval_t fn_ptr_max
= {
583 {.value
= 777777777},
586 char *get_other_name_sym(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
587 char *map_call_to_other_name_sym(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
588 char *map_long_to_short_name_sym(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
589 char *map_long_to_short_name_sym_nostack(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
591 #define STRLEN_MAX_RET 1010101
593 /* smatch_absolute.c */
594 int get_absolute_min_helper(struct expression
*expr
, sval_t
*sval
);
595 int get_absolute_max_helper(struct expression
*expr
, sval_t
*sval
);
597 /* smatch_local_values.c */
598 int get_local_rl(struct expression
*expr
, struct range_list
**rl
);
599 int get_local_max_helper(struct expression
*expr
, sval_t
*sval
);
600 int get_local_min_helper(struct expression
*expr
, sval_t
*sval
);
602 /* smatch_type_value.c */
603 int get_db_type_rl(struct expression
*expr
, struct range_list
**rl
);
604 /* smatch_data_val.c */
605 int get_mtag_rl(struct expression
*expr
, struct range_list
**rl
);
606 /* smatch_array_values.c */
607 int get_array_rl(struct expression
*expr
, struct range_list
**rl
);
609 /* smatch_states.c */
610 void __swap_cur_stree(struct stree
*stree
);
611 void __push_fake_cur_stree();
612 struct stree
*__pop_fake_cur_stree();
613 void __free_fake_cur_stree();
614 void __set_fake_cur_stree_fast(struct stree
*stree
);
615 void __pop_fake_cur_stree_fast(void);
616 void __merge_stree_into_cur(struct stree
*stree
);
618 int unreachable(void);
619 void __set_sm(struct sm_state
*sm
);
620 void __set_sm_cur_stree(struct sm_state
*sm
);
621 void __set_sm_fake_stree(struct sm_state
*sm
);
622 void __set_true_false_sm(struct sm_state
*true_state
,
623 struct sm_state
*false_state
);
624 void nullify_path(void);
625 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
627 void __unnullify_path(void);
628 int __path_is_null(void);
629 void save_all_states(void);
630 void restore_all_states(void);
631 void free_goto_stack(void);
632 void clear_all_states(void);
634 struct sm_state
*get_sm_state(int owner
, const char *name
,
636 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
637 void __push_true_states(void);
638 void __use_false_states(void);
639 void __discard_false_states(void);
640 void __merge_false_states(void);
641 void __merge_true_states(void);
643 void __negate_cond_stacks(void);
644 void __use_pre_cond_states(void);
645 void __use_cond_true_states(void);
646 void __use_cond_false_states(void);
647 void __push_cond_stacks(void);
648 void __fold_in_set_states(void);
649 void __free_set_states(void);
650 struct stree
*__copy_cond_true_states(void);
651 struct stree
*__copy_cond_false_states(void);
652 struct stree
*__pop_cond_true_stack(void);
653 struct stree
*__pop_cond_false_stack(void);
654 void __and_cond_states(void);
655 void __or_cond_states(void);
656 void __save_pre_cond_states(void);
657 void __discard_pre_cond_states(void);
658 struct stree
*__get_true_states(void);
659 struct stree
*__get_false_states(void);
660 void __use_cond_states(void);
661 extern struct state_list
*__last_base_slist
;
663 void __push_continues(void);
664 void __discard_continues(void);
665 void __process_continues(void);
666 void __merge_continues(void);
668 void __push_breaks(void);
669 void __process_breaks(void);
670 int __has_breaks(void);
671 void __merge_breaks(void);
672 void __use_breaks(void);
674 void __save_switch_states(struct expression
*switch_expr
);
675 void __discard_switches(void);
676 int have_remaining_cases(void);
677 void __merge_switches(struct expression
*switch_expr
, struct range_list
*case_rl
);
678 void __push_default(void);
679 void __set_default(void);
680 int __pop_default(void);
682 void __push_conditions(void);
683 void __discard_conditions(void);
685 void __save_gotos(const char *name
, struct symbol
*sym
);
686 void __merge_gotos(const char *name
, struct symbol
*sym
);
688 void __print_cur_stree(void);
691 void __pass_to_client(void *data
, enum hook_type type
);
692 void __pass_to_client_no_data(enum hook_type type
);
693 void __pass_case_to_client(struct expression
*switch_expr
,
694 struct range_list
*rl
);
695 int __has_merge_function(int client_id
);
696 struct smatch_state
*__client_merge_function(int owner
,
697 struct smatch_state
*s1
,
698 struct smatch_state
*s2
);
699 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
700 void call_pre_merge_hook(struct sm_state
*sm
);
701 void __push_scope_hooks(void);
702 void __call_scope_hooks(void);
704 /* smatch_function_hooks.c */
705 void create_function_hook_hash(void);
706 void __match_initializer_call(struct symbol
*sym
);
712 * Changing these numbers is a pain. Don't do it. If you ever use a
713 * number it can't be re-used right away so there may be gaps.
714 * We select these in order by type so if the order matters, then give
715 * it a number below 100-999,9000-9999 ranges. */
729 LOCK_RELEASED
= 1009,
730 ABSOLUTE_LIMITS
= 1010,
742 UNTRACKED_PARAM
= 1023,
747 COMPARE_LIMIT
= 1028,
748 PARAM_COMPARE
= 1029,
751 CONSTRAINT_REQUIRED
= 1033,
756 /* put random temporary stuff in the 7000-7999 range for testing */
758 USER_DATA3_SET
= 9017,
760 NO_OVERFLOW_SIMPLE
= 8019,
766 NO_SIDE_EFFECT
= 8025,
769 ARRAYSIZE_ARG
= 8033,
776 extern struct sqlite3
*smatch_db
;
777 extern struct sqlite3
*mem_db
;
778 extern struct sqlite3
*cache_db
;
780 void debug_sql(struct sqlite3
*db
, const char *sql
);
781 void db_ignore_states(int id
);
782 void select_caller_info_hook(void (*callback
)(const char *name
, struct symbol
*sym
, char *key
, char *value
), int type
);
783 void add_member_info_callback(int owner
, void (*callback
)(struct expression
*call
, int param
, char *printed_name
, struct sm_state
*sm
));
784 void add_split_return_callback(void (*fn
)(int return_id
, char *return_ranges
, struct expression
*returned_expr
));
785 void add_returned_member_callback(int owner
, void (*callback
)(int return_id
, char *return_ranges
, struct expression
*expr
, char *printed_name
, struct smatch_state
*state
));
786 void select_call_implies_hook(int type
, void (*callback
)(struct expression
*call
, struct expression
*arg
, char *key
, char *value
));
787 void select_return_implies_hook(int type
, void (*callback
)(struct expression
*call
, struct expression
*arg
, char *key
, char *value
));
788 struct range_list
*db_return_vals(struct expression
*expr
);
789 struct range_list
*db_return_vals_from_str(const char *fn_name
);
790 char *return_state_to_var_sym(struct expression
*expr
, int param
, const char *key
, struct symbol
**sym
);
791 char *get_chunk_from_key(struct expression
*arg
, char *key
, struct symbol
**sym
, struct var_sym_list
**vsl
);
792 char *get_variable_from_key(struct expression
*arg
, const char *key
, struct symbol
**sym
);
793 const char *state_name_to_param_name(const char *state_name
, const char *param_name
);
794 const char *get_param_name_var_sym(const char *name
, struct symbol
*sym
);
795 const char *get_param_name(struct sm_state
*sm
);
796 const char *get_mtag_name_var_sym(const char *state_name
, struct symbol
*sym
);
797 const char *get_mtag_name_expr(struct expression
*expr
);
798 char *get_data_info_name(struct expression
*expr
);
800 char *escape_newlines(char *str
);
801 void sql_exec(struct sqlite3
*db
, int (*callback
)(void*, int, char**, char**), void *data
, const char *sql
);
803 #define sql_helper(db, call_back, data, sql...) \
805 char sql_txt[1024]; \
807 sqlite3_snprintf(sizeof(sql_txt), sql_txt, sql); \
808 sm_debug("debug: %s\n", sql_txt); \
809 debug_sql(db, sql_txt); \
810 sql_exec(db, call_back, data, sql_txt); \
814 #define run_sql(call_back, data, sql...) \
818 sql_helper(smatch_db, call_back, data, sql); \
821 #define mem_sql(call_back, data, sql...) \
822 sql_helper(mem_db, call_back, data, sql)
824 #define cache_sql(call_back, data, sql...) \
825 sql_helper(cache_db, call_back, data, sql)
827 #define sql_insert_helper(table, db, ignore, late, values...) \
829 struct sqlite3 *_db = db; \
831 if (__inline_fn && !_db) \
835 char *err, *p = buf; \
838 p += snprintf(p, buf + sizeof(buf) - p, \
839 "insert %sinto %s values (", \
840 ignore ? "or ignore " : "", #table); \
841 p += snprintf(p, buf + sizeof(buf) - p, values); \
842 p += snprintf(p, buf + sizeof(buf) - p, ");"); \
843 sm_debug("mem-db: %s\n", buf); \
844 rc = sqlite3_exec(_db, buf, NULL, NULL, &err); \
845 if (rc != SQLITE_OK) { \
846 fprintf(stderr, "SQL error #2: %s\n", err); \
847 fprintf(stderr, "SQL: '%s'\n", buf); \
853 FILE *tmp_fd = sm_outfd; \
854 sm_outfd = sql_outfd; \
856 sm_printf("SQL%s: insert %sinto " #table " values(", \
857 late ? "_late" : "", ignore ? "or ignore " : ""); \
864 #define sql_insert(table, values...) sql_insert_helper(table, 0, 0, 0, values);
865 #define sql_insert_or_ignore(table, values...) sql_insert_helper(table, 0, 1, 0, values);
866 #define sql_insert_late(table, values...) sql_insert_helper(table, 0, 0, 1, values);
867 #define sql_insert_cache(table, values...) sql_insert_helper(table, cache_db, 1, 0, values);
869 char *get_static_filter(struct symbol
*sym
);
871 void sql_insert_return_states(int return_id
, const char *return_ranges
,
872 int type
, int param
, const char *key
, const char *value
);
873 void sql_insert_caller_info(struct expression
*call
, int type
, int param
,
874 const char *key
, const char *value
);
875 void sql_insert_function_ptr(const char *fn
, const char *struct_name
);
876 void sql_insert_return_values(const char *return_values
);
877 void sql_insert_return_implies(int type
, int param
, const char *key
, const char *value
);
878 void sql_insert_function_type_size(const char *member
, const char *ranges
);
879 void sql_insert_function_type_info(int type
, const char *struct_type
, const char *member
, const char *value
);
880 void sql_insert_type_info(int type
, const char *member
, const char *value
);
881 void sql_insert_local_values(const char *name
, const char *value
);
882 void sql_insert_function_type_value(const char *type
, const char *value
);
883 void sql_insert_function_type(int param
, const char *value
);
884 void sql_insert_parameter_name(int param
, const char *value
);
885 void sql_insert_data_info(struct expression
*data
, int type
, const char *value
);
886 void sql_insert_data_info_var_sym(const char *var
, struct symbol
*sym
, int type
, const char *value
);
887 void sql_save_constraint(const char *con
);
888 void sql_save_constraint_required(const char *data
, int op
, const char *limit
);
889 void sql_copy_constraint_required(const char *new_limit
, const char *old_limit
);
890 void sql_insert_fn_ptr_data_link(const char *ptr
, const char *data
);
891 void sql_insert_fn_data_link(struct expression
*fn
, int type
, int param
, const char *key
, const char *value
);
892 void sql_insert_mtag_about(mtag_t tag
, const char *left_name
, const char *right_name
);
893 void insert_mtag_data(sval_t sval
, struct range_list
*rl
);
894 void sql_insert_mtag_map(mtag_t tag
, int offset
, mtag_t container
);
895 void sql_insert_mtag_alias(mtag_t orig
, mtag_t alias
);
896 int mtag_map_select_container(mtag_t tag
, int offset
, mtag_t
*container
);
897 int mtag_map_select_tag(mtag_t container
, int offset
, mtag_t
*tag
);
899 void sql_select_return_states(const char *cols
, struct expression
*call
,
900 int (*callback
)(void*, int, char**, char**), void *info
);
901 void sql_select_call_implies(const char *cols
, struct expression
*call
,
902 int (*callback
)(void*, int, char**, char**));
904 void open_smatch_db(char *db_file
);
907 int open_data_file(const char *filename
);
908 int open_schema_file(const char *schema
);
909 struct token
*get_tokens_file(const char *filename
);
912 extern char *option_debug_check
;
913 extern char *option_project_str
;
914 extern char *bin_dir
;
915 extern char *data_dir
;
916 extern int option_no_data
;
917 extern int option_full_path
;
918 extern int option_param_mapper
;
919 extern int option_call_tree
;
920 extern int num_checks
;
928 extern enum project_type option_project
;
929 const char *check_name(unsigned short id
);
930 int id_from_name(const char *name
);
933 /* smatch_buf_size.c */
934 int get_array_size(struct expression
*expr
);
935 int get_array_size_bytes(struct expression
*expr
);
936 int get_array_size_bytes_min(struct expression
*expr
);
937 int get_array_size_bytes_max(struct expression
*expr
);
938 struct range_list
*get_array_size_bytes_rl(struct expression
*expr
);
939 int get_real_array_size(struct expression
*expr
);
940 int last_member_is_resizable(struct symbol
*type
);
941 /* smatch_strlen.c */
942 int get_implied_strlen(struct expression
*expr
, struct range_list
**rl
);
943 int get_size_from_strlen(struct expression
*expr
);
945 /* smatch_capped.c */
946 int is_capped(struct expression
*expr
);
947 int is_capped_var_sym(const char *name
, struct symbol
*sym
);
949 /* check_user_data.c */
950 int is_user_macro(struct expression
*expr
);
951 int is_user_data(struct expression
*expr
);
952 int is_capped_user_data(struct expression
*expr
);
953 int implied_user_data(struct expression
*expr
, struct range_list
**rl
);
954 struct stree
*get_user_stree(void);
955 int get_user_rl(struct expression
*expr
, struct range_list
**rl
);
956 int get_user_rl_spammy(struct expression
*expr
, struct range_list
**rl
);
957 int is_user_rl(struct expression
*expr
);
958 int get_user_rl_var_sym(const char *name
, struct symbol
*sym
, struct range_list
**rl
);
960 /* check_locking.c */
961 void print_held_locks();
963 /* check_assigned_expr.c */
964 struct expression
*get_assigned_expr(struct expression
*expr
);
965 struct expression
*get_assigned_expr_name_sym(const char *name
, struct symbol
*sym
);
966 /* smatch_return_to_param.c */
967 void __add_return_to_param_mapping(struct expression
*assign
, const char *return_string
);
968 char *map_call_to_param_name_sym(struct expression
*expr
, struct symbol
**sym
);
970 /* smatch_comparison.c */
971 struct compare_data
{
972 /* The ->left and ->right expression pointers might be NULL (I'm lazy) */
973 struct expression
*left
;
974 const char *left_var
;
975 struct var_sym_list
*left_vsl
;
977 struct expression
*right
;
978 const char *right_var
;
979 struct var_sym_list
*right_vsl
;
981 DECLARE_ALLOCATOR(compare_data
);
982 struct smatch_state
*alloc_compare_state(
983 struct expression
*left
,
984 const char *left_var
, struct var_sym_list
*left_vsl
,
986 struct expression
*right
,
987 const char *right_var
, struct var_sym_list
*right_vsl
);
988 int filter_comparison(int orig
, int op
);
989 int merge_comparisons(int one
, int two
);
990 int combine_comparisons(int left_compare
, int right_compare
);
991 int state_to_comparison(struct smatch_state
*state
);
992 struct smatch_state
*merge_compare_states(struct smatch_state
*s1
, struct smatch_state
*s2
);
993 int get_comparison(struct expression
*left
, struct expression
*right
);
994 int get_comparison_strings(const char *one
, const char *two
);
995 int possible_comparison(struct expression
*a
, int comparison
, struct expression
*b
);
996 struct state_list
*get_all_comparisons(struct expression
*expr
);
997 struct state_list
*get_all_possible_equal_comparisons(struct expression
*expr
);
998 void __add_return_comparison(struct expression
*call
, const char *range
);
999 void __add_comparison_info(struct expression
*expr
, struct expression
*call
, const char *range
);
1000 char *get_printed_param_name(struct expression
*call
, const char *param_name
, struct symbol
*param_sym
);
1001 char *name_sym_to_param_comparison(const char *name
, struct symbol
*sym
);
1002 char *expr_equal_to_param(struct expression
*expr
, int ignore
);
1003 char *expr_lte_to_param(struct expression
*expr
, int ignore
);
1004 char *expr_param_comparison(struct expression
*expr
, int ignore
);
1005 int flip_comparison(int op
);
1006 int negate_comparison(int op
);
1007 int remove_unsigned_from_comparison(int op
);
1008 int param_compare_limit_is_impossible(struct expression
*expr
, int left_param
, char *left_key
, char *value
);
1009 void filter_by_comparison(struct range_list
**rl
, int comparison
, struct range_list
*right
);
1010 struct sm_state
*comparison_implication_hook(struct expression
*expr
,
1011 struct state_list
**true_stack
,
1012 struct state_list
**false_stack
);
1013 void __compare_param_limit_hook(struct expression
*left_expr
, struct expression
*right_expr
,
1014 const char *state_name
,
1015 struct smatch_state
*true_state
, struct smatch_state
*false_state
);
1016 int impossibly_high_comparison(struct expression
*expr
);
1019 sval_t
*sval_alloc(sval_t sval
);
1020 sval_t
*sval_alloc_permanent(sval_t sval
);
1021 sval_t
sval_blank(struct expression
*expr
);
1022 sval_t
sval_type_val(struct symbol
*type
, long long val
);
1023 sval_t
sval_from_val(struct expression
*expr
, long long val
);
1024 int sval_is_ptr(sval_t sval
);
1025 int sval_unsigned(sval_t sval
);
1026 int sval_signed(sval_t sval
);
1027 int sval_bits(sval_t sval
);
1028 int sval_bits_used(sval_t sval
);
1029 int sval_is_negative(sval_t sval
);
1030 int sval_is_positive(sval_t sval
);
1031 int sval_is_min(sval_t sval
);
1032 int sval_is_max(sval_t sval
);
1033 int sval_is_a_min(sval_t sval
);
1034 int sval_is_a_max(sval_t sval
);
1035 int sval_is_negative_min(sval_t sval
);
1036 int sval_cmp_t(struct symbol
*type
, sval_t one
, sval_t two
);
1037 int sval_cmp_val(sval_t one
, long long val
);
1038 sval_t
sval_min(sval_t one
, sval_t two
);
1039 sval_t
sval_max(sval_t one
, sval_t two
);
1040 int sval_too_low(struct symbol
*type
, sval_t sval
);
1041 int sval_too_high(struct symbol
*type
, sval_t sval
);
1042 int sval_fits(struct symbol
*type
, sval_t sval
);
1043 sval_t
sval_cast(struct symbol
*type
, sval_t sval
);
1044 sval_t
sval_preop(sval_t sval
, int op
);
1045 sval_t
sval_binop(sval_t left
, int op
, sval_t right
);
1046 int sval_binop_overflows(sval_t left
, int op
, sval_t right
);
1047 int sval_binop_overflows_no_sign(sval_t left
, int op
, sval_t right
);
1048 unsigned long long fls_mask(unsigned long long uvalue
);
1049 unsigned long long sval_fls_mask(sval_t sval
);
1050 const char *sval_to_str(sval_t sval
);
1051 const char *sval_to_numstr(sval_t sval
);
1052 sval_t
ll_to_sval(long long val
);
1054 /* smatch_string_list.c */
1055 int list_has_string(struct string_list
*str_list
, const char *str
);
1056 void insert_string(struct string_list
**str_list
, const char *str
);
1057 struct string_list
*clone_str_list(struct string_list
*orig
);
1058 struct string_list
*combine_string_lists(struct string_list
*one
, struct string_list
*two
);
1060 /* smatch_start_states.c */
1061 struct stree
*get_start_states(void);
1063 /* smatch_recurse.c */
1064 int has_symbol(struct expression
*expr
, struct symbol
*sym
);
1065 int has_variable(struct expression
*expr
, struct expression
*var
);
1066 int has_inc_dec(struct expression
*expr
);
1068 /* smatch_stored_conditions.c */
1069 struct smatch_state
*get_stored_condition(struct expression
*expr
);
1070 struct expression_list
*get_conditions(struct expression
*expr
);
1071 struct sm_state
*stored_condition_implication_hook(struct expression
*expr
,
1072 struct state_list
**true_stack
,
1073 struct state_list
**false_stack
);
1075 /* check_string_len.c */
1076 int get_formatted_string_size(struct expression
*call
, int arg
);
1078 /* smatch_param_set.c */
1079 int param_was_set(struct expression
*expr
);
1080 int param_was_set_var_sym(const char *name
, struct symbol
*sym
);
1081 /* smatch_param_filter.c */
1082 int param_has_filter_data(struct sm_state
*sm
);
1084 /* smatch_links.c */
1085 void set_up_link_functions(int id
, int linkid
);
1086 struct smatch_state
*merge_link_states(struct smatch_state
*s1
, struct smatch_state
*s2
);
1087 void store_link(int link_id
, const char *name
, struct symbol
*sym
, const char *link_name
, struct symbol
*link_sym
);
1089 /* smatch_auto_copy.c */
1090 void set_auto_copy(int owner
);
1092 /* check_buf_comparison */
1093 struct expression
*get_size_variable(struct expression
*buf
);
1094 struct expression
*get_array_variable(struct expression
*size
);
1096 /* smatch_untracked_param.c */
1097 void mark_untracked(struct expression
*expr
, int param
, const char *key
, const char *value
);
1098 void add_untracked_param_hook(void (func
)(struct expression
*call
, int param
));
1099 void mark_all_params_untracked(int return_id
, char *return_ranges
, struct expression
*expr
);
1101 /* smatch_strings.c */
1102 struct state_list
*get_strings(struct expression
*expr
);
1103 struct expression
*fake_string_from_mtag(mtag_t tag
);
1105 /* smatch_estate.c */
1106 int estate_get_single_value(struct smatch_state
*state
, sval_t
*sval
);
1108 /* smatch_address.c */
1109 int get_address_rl(struct expression
*expr
, struct range_list
**rl
);
1110 int get_member_offset(struct symbol
*type
, const char *member_name
);
1111 int get_member_offset_from_deref(struct expression
*expr
);
1113 /* for now this is in smatch_used_parameter.c */
1114 void __get_state_hook(int owner
, const char *name
, struct symbol
*sym
);
1116 /* smatch_buf_comparison.c */
1117 int db_var_is_array_limit(struct expression
*array
, const char *name
, struct var_sym_list
*vsl
);
1119 struct stree
*get_all_return_states(void);
1120 struct stree_stack
*get_all_return_strees(void);
1121 int on_atomic_dec_path(void);
1122 int was_inced(const char *name
, struct symbol
*sym
);
1124 /* smatch_constraints.c */
1125 char *get_constraint_str(struct expression
*expr
);
1126 struct constraint_list
*get_constraints(struct expression
*expr
);
1127 char *unmet_constraint(struct expression
*data
, struct expression
*offset
);
1128 char *get_required_constraint(const char *data_str
);
1130 /* smatch_container_of.c */
1131 int get_param_from_container_of(struct expression
*expr
);
1132 int get_offset_from_container_of(struct expression
*expr
);
1135 int get_string_mtag(struct expression
*expr
, mtag_t
*tag
);
1136 int get_toplevel_mtag(struct symbol
*sym
, mtag_t
*tag
);
1137 int get_mtag(struct expression
*expr
, mtag_t
*tag
);
1138 int get_mtag_offset(struct expression
*expr
, mtag_t
*tag
, int *offset
);
1139 int create_mtag_alias(mtag_t tag
, struct expression
*expr
, mtag_t
*new);
1140 int expr_to_mtag_offset(struct expression
*expr
, mtag_t
*tag
, int *offset
);
1141 void update_mtag_data(struct expression
*expr
);
1142 int get_mtag_sval(struct expression
*expr
, sval_t
*sval
);
1143 int get_mtag_addr_sval(struct expression
*expr
, sval_t
*sval
);
1145 /* Trinity fuzzer stuff */
1146 const char *get_syscall_arg_type(struct symbol
*sym
);
1148 /* smatch_mem_tracker.c */
1149 extern int option_mem
;
1150 unsigned long get_max_memory(void);
1152 /* check_is_nospec.c */
1153 bool is_nospec(struct expression
*expr
);
1155 /* smatch_nul_terminator.c */
1156 bool is_nul_terminated(struct expression
*expr
);
1158 static inline int type_bits(struct symbol
*type
)
1162 if (type
->type
== SYM_PTR
) /* Sparse doesn't set this for &pointers */
1163 return bits_in_pointer
;
1164 if (type
->type
== SYM_ARRAY
)
1165 return bits_in_pointer
;
1166 if (!type
->examined
)
1167 examine_symbol_type(type
);
1168 return type
->bit_size
;
1171 static inline bool type_is_ptr(struct symbol
*type
)
1173 return type
&& (type
->type
== SYM_PTR
|| type
->type
== SYM_ARRAY
);
1176 static inline int type_unsigned(struct symbol
*base_type
)
1180 if (base_type
->ctype
.modifiers
& MOD_UNSIGNED
)
1185 static inline int type_positive_bits(struct symbol
*type
)
1189 if (type
->type
== SYM_ARRAY
)
1190 return bits_in_pointer
- 1;
1191 if (type_unsigned(type
))
1192 return type_bits(type
);
1193 return type_bits(type
) - 1;
1196 static inline int sval_positive_bits(sval_t sval
)
1198 return type_positive_bits(sval
.type
);
1202 * Returns -1 if one is smaller, 0 if they are the same and 1 if two is larger.
1204 static inline int sval_cmp(sval_t one
, sval_t two
)
1206 struct symbol
*type
;
1209 if (sval_positive_bits(two
) > sval_positive_bits(one
))
1211 if (type_bits(type
) < 31)
1214 one
= sval_cast(type
, one
);
1215 two
= sval_cast(type
, two
);
1217 if (type_unsigned(type
)) {
1218 if (one
.uvalue
< two
.uvalue
)
1220 if (one
.uvalue
== two
.uvalue
)
1224 /* fix me handle type promotion and unsigned values */
1225 if (one
.value
< two
.value
)
1227 if (one
.value
== two
.value
)
1232 #endif /* !SMATCH_H_ */