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_silenced_function(void);
207 /* smatch_impossible.c */
208 int is_impossible_path(void);
209 void set_path_impossible(void);
211 extern FILE *sm_outfd
;
212 extern FILE *sql_outfd
;
213 extern FILE *caller_info_fd
;
214 #define sm_printf(msg...) do { if (final_pass || option_debug || local_debug) fprintf(sm_outfd, msg); } while (0)
216 static inline void sm_prefix(void)
218 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
221 static inline void print_implied_debug_msg();
223 extern bool __silence_warnings_for_stmt
;
225 #define sm_msg(msg...) \
227 print_implied_debug_msg(); \
228 if (!final_pass && !option_debug && !local_debug) \
230 if (__silence_warnings_for_stmt && !option_debug && !local_debug) \
232 if (!option_info && is_silenced_function()) \
239 #define local_debug(msg...) \
245 extern char *implied_debug_msg
;
246 static inline void print_implied_debug_msg(void)
248 static struct symbol
*last_printed
= NULL
;
250 if (!implied_debug_msg
)
252 if (last_printed
== cur_func_sym
)
254 last_printed
= cur_func_sym
;
255 sm_msg("%s", implied_debug_msg
);
258 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
260 #define sm_info(msg...) do { \
261 if (option_debug || (option_info && final_pass)) { \
263 sm_printf("info: "); \
269 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
271 struct smatch_state
*__get_state(int owner
, const char *name
, struct symbol
*sym
);
272 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
273 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
274 struct state_list
*get_possible_states(int owner
, const char *name
,
276 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
277 struct sm_state
*set_state(int owner
, const char *name
, struct symbol
*sym
,
278 struct smatch_state
*state
);
279 struct sm_state
*set_state_expr(int owner
, struct expression
*expr
,
280 struct smatch_state
*state
);
281 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
282 void delete_state_expr(int owner
, struct expression
*expr
);
283 void __delete_all_states_sym(struct symbol
*sym
);
284 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
285 struct smatch_state
*true_state
,
286 struct smatch_state
*false_state
);
287 void set_true_false_states_expr(int owner
, struct expression
*expr
,
288 struct smatch_state
*true_state
,
289 struct smatch_state
*false_state
);
291 struct stree
*get_all_states_from_stree(int owner
, struct stree
*source
);
292 struct stree
*get_all_states_stree(int id
);
293 struct stree
*__get_cur_stree(void);
294 int is_reachable(void);
295 void add_get_state_hook(void (*fn
)(int owner
, const char *name
, struct symbol
*sym
));
297 /* smatch_helper.c */
298 DECLARE_PTR_LIST(int_stack
, int);
299 char *alloc_string(const char *str
);
300 void free_string(char *str
);
301 void append(char *dest
, const char *data
, int buff_len
);
302 void remove_parens(char *str
);
303 struct smatch_state
*alloc_state_num(int num
);
304 struct smatch_state
*alloc_state_str(const char *name
);
305 struct smatch_state
*alloc_state_expr(struct expression
*expr
);
306 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
309 char *expr_to_var(struct expression
*expr
);
310 struct symbol
*expr_to_sym(struct expression
*expr
);
311 char *expr_to_str(struct expression
*expr
);
312 char *expr_to_str_sym(struct expression
*expr
,
313 struct symbol
**sym_ptr
);
314 char *expr_to_var_sym(struct expression
*expr
,
315 struct symbol
**sym_ptr
);
316 char *expr_to_known_chunk_sym(struct expression
*expr
, struct symbol
**sym
);
317 char *expr_to_chunk_sym_vsl(struct expression
*expr
, struct symbol
**sym
, struct var_sym_list
**vsl
);
318 int get_complication_score(struct expression
*expr
);
320 int sym_name_is(const char *name
, struct expression
*expr
);
321 int get_const_value(struct expression
*expr
, sval_t
*sval
);
322 int get_value(struct expression
*expr
, sval_t
*val
);
323 int get_implied_value(struct expression
*expr
, sval_t
*val
);
324 int get_implied_min(struct expression
*expr
, sval_t
*sval
);
325 int get_implied_max(struct expression
*expr
, sval_t
*val
);
326 int get_hard_max(struct expression
*expr
, sval_t
*sval
);
327 int get_fuzzy_min(struct expression
*expr
, sval_t
*min
);
328 int get_fuzzy_max(struct expression
*expr
, sval_t
*max
);
329 int get_absolute_min(struct expression
*expr
, sval_t
*sval
);
330 int get_absolute_max(struct expression
*expr
, sval_t
*sval
);
331 int parse_call_math(struct expression
*expr
, char *math
, sval_t
*val
);
332 int parse_call_math_rl(struct expression
*call
, char *math
, struct range_list
**rl
);
333 char *get_value_in_terms_of_parameter_math(struct expression
*expr
);
334 char *get_value_in_terms_of_parameter_math_var_sym(const char *var
, struct symbol
*sym
);
335 int is_zero(struct expression
*expr
);
336 int known_condition_true(struct expression
*expr
);
337 int known_condition_false(struct expression
*expr
);
338 int implied_condition_true(struct expression
*expr
);
339 int implied_condition_false(struct expression
*expr
);
340 int can_integer_overflow(struct symbol
*type
, struct expression
*expr
);
341 void clear_math_cache(void);
343 int is_array(struct expression
*expr
);
344 struct expression
*get_array_base(struct expression
*expr
);
345 struct expression
*get_array_offset(struct expression
*expr
);
346 const char *show_state(struct smatch_state
*state
);
347 struct statement
*get_expression_statement(struct expression
*expr
);
348 struct expression
*strip_parens(struct expression
*expr
);
349 struct expression
*strip_expr(struct expression
*expr
);
350 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
351 int is_error_return(struct expression
*expr
);
352 int getting_address(void);
353 int get_struct_and_member(struct expression
*expr
, const char **type
, const char **member
);
354 char *get_member_name(struct expression
*expr
);
355 char *get_fnptr_name(struct expression
*expr
);
356 int cmp_pos(struct position pos1
, struct position pos2
);
357 int positions_eq(struct position pos1
, struct position pos2
);
358 struct statement
*get_current_statement(void);
359 struct statement
*get_prev_statement(void);
360 struct expression
*get_last_expr_from_expression_stmt(struct expression
*expr
);
361 int get_param_num_from_sym(struct symbol
*sym
);
362 int get_param_num(struct expression
*expr
);
363 int ms_since(struct timeval
*start
);
364 int parent_is_gone_var_sym(const char *name
, struct symbol
*sym
);
365 int parent_is_gone(struct expression
*expr
);
366 int invert_op(int op
);
367 int expr_equiv(struct expression
*one
, struct expression
*two
);
368 void push_int(struct int_stack
**stack
, int num
);
369 int pop_int(struct int_stack
**stack
);
372 struct symbol
*get_real_base_type(struct symbol
*sym
);
373 int type_bytes(struct symbol
*type
);
374 int array_bytes(struct symbol
*type
);
375 struct symbol
*get_pointer_type(struct expression
*expr
);
376 struct symbol
*get_type(struct expression
*expr
);
377 int type_signed(struct symbol
*base_type
);
378 int expr_unsigned(struct expression
*expr
);
379 int expr_signed(struct expression
*expr
);
380 int returns_unsigned(struct symbol
*base_type
);
381 int is_pointer(struct expression
*expr
);
382 int returns_pointer(struct symbol
*base_type
);
383 sval_t
sval_type_max(struct symbol
*base_type
);
384 sval_t
sval_type_min(struct symbol
*base_type
);
385 int nr_bits(struct expression
*expr
);
386 int is_void_pointer(struct expression
*expr
);
387 int is_char_pointer(struct expression
*expr
);
388 int is_string(struct expression
*expr
);
389 int is_static(struct expression
*expr
);
390 int is_local_variable(struct expression
*expr
);
391 int types_equiv(struct symbol
*one
, struct symbol
*two
);
393 const char *global_static();
394 struct symbol
*cur_func_return_type(void);
395 struct symbol
*get_arg_type(struct expression
*fn
, int arg
);
396 struct symbol
*get_member_type_from_key(struct expression
*expr
, const char *key
);
397 int is_struct(struct expression
*expr
);
398 char *type_to_str(struct symbol
*type
);
400 /* smatch_ignore.c */
401 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
402 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
403 void add_ignore_expr(int owner
, struct expression
*expr
);
404 int is_ignored_expr(int owner
, struct expression
*expr
);
407 struct var_sym
*alloc_var_sym(const char *var
, struct symbol
*sym
);
408 struct var_sym_list
*expr_to_vsl(struct expression
*expr
);
409 void add_var_sym(struct var_sym_list
**list
, const char *var
, struct symbol
*sym
);
410 void add_var_sym_expr(struct var_sym_list
**list
, struct expression
*expr
);
411 void del_var_sym(struct var_sym_list
**list
, const char *var
, struct symbol
*sym
);
412 int in_var_sym_list(struct var_sym_list
*list
, const char *var
, struct symbol
*sym
);
413 struct var_sym_list
*clone_var_sym_list(struct var_sym_list
*from_vsl
);
414 void merge_var_sym_list(struct var_sym_list
**dest
, struct var_sym_list
*src
);
415 struct var_sym_list
*combine_var_sym_lists(struct var_sym_list
*one
, struct var_sym_list
*two
);
416 int var_sym_lists_equiv(struct var_sym_list
*one
, struct var_sym_list
*two
);
417 void free_var_sym_list(struct var_sym_list
**list
);
418 void free_var_syms_and_list(struct var_sym_list
**list
);
421 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
422 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
424 void add_tracker_expr(struct tracker_list
**list
, int owner
, struct expression
*expr
);
425 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
427 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
429 void free_tracker_list(struct tracker_list
**list
);
430 void free_trackers_and_list(struct tracker_list
**list
);
432 /* smatch_conditions */
433 int in_condition(void);
437 extern int __in_fake_assign
;
438 extern int __in_fake_struct_assign
;
439 void smatch (int argc
, char **argv
);
440 int inside_loop(void);
441 int definitely_inside_loop(void);
442 struct expression
*get_switch_expr(void);
443 int in_expression_statement(void);
444 void __process_post_op_stack(void);
445 void __split_expr(struct expression
*expr
);
446 void __split_label_stmt(struct statement
*stmt
);
447 void __split_stmt(struct statement
*stmt
);
448 extern int __in_function_def
;
449 extern int option_assume_loops
;
450 extern int option_two_passes
;
451 extern int option_no_db
;
452 extern int option_file_output
;
453 extern int option_time
;
454 extern struct expression_list
*big_expression_stack
;
455 extern struct expression_list
*big_condition_stack
;
456 extern struct statement_list
*big_statement_stack
;
457 int is_assigned_call(struct expression
*expr
);
458 int inlinable(struct expression
*expr
);
459 extern int __inline_call
;
460 extern struct expression
*__inline_fn
;
461 extern int __in_pre_condition
;
462 extern int __bail_on_rest_of_function
;
463 extern struct statement
*__prev_stmt
;
464 extern struct statement
*__cur_stmt
;
465 extern struct statement
*__next_stmt
;
466 void init_fake_env(void);
467 void end_fake_env(void);
468 int time_parsing_function(void);
470 /* smatch_struct_assignment.c */
471 struct expression
*get_faked_expression(void);
472 void __fake_struct_member_assignments(struct expression
*expr
);
474 /* smatch_project.c */
475 int is_no_inline_function(const char *function
);
477 /* smatch_conditions */
478 void __split_whole_condition(struct expression
*expr
);
479 void __handle_logic(struct expression
*expr
);
480 int is_condition(struct expression
*expr
);
481 int __handle_condition_assigns(struct expression
*expr
);
482 int __handle_select_assigns(struct expression
*expr
);
483 int __handle_expr_statement_assigns(struct expression
*expr
);
485 /* smatch_implied.c */
486 extern int option_debug_implied
;
487 extern int option_debug_related
;
488 struct range_list_stack
;
489 void param_limit_implications(struct expression
*expr
, int param
, char *key
, char *value
);
490 struct stree
*__implied_case_stree(struct expression
*switch_expr
,
491 struct range_list
*case_rl
,
492 struct range_list_stack
**remaining_cases
,
493 struct stree
**raw_stree
);
494 void overwrite_states_using_pool(struct sm_state
*gate_sm
, struct sm_state
*pool_sm
);
495 int assume(struct expression
*expr
);
496 void end_assume(void);
497 int impossible_assumption(struct expression
*left
, int op
, sval_t sval
);
499 /* smatch_extras.c */
500 #define SMATCH_EXTRA 5 /* this is my_id from smatch extra set in smatch.c */
501 extern int RETURN_ID
;
508 extern long long valid_ptr_min
, valid_ptr_max
;
509 extern sval_t valid_ptr_min_sval
, valid_ptr_max_sval
;
510 static const sval_t array_min_sval
= {
514 static const sval_t array_max_sval
= {
518 static const sval_t text_seg_min
= {
520 {.value
= 100000000},
522 static const sval_t text_seg_max
= {
524 {.value
= 177777777},
526 static const sval_t data_seg_min
= {
528 {.value
= 200000000},
530 static const sval_t data_seg_max
= {
532 {.value
= 277777777},
534 static const sval_t bss_seg_min
= {
536 {.value
= 300000000},
538 static const sval_t bss_seg_max
= {
540 {.value
= 377777777},
542 static const sval_t stack_seg_min
= {
544 {.value
= 400000000},
546 static const sval_t stack_seg_max
= {
548 {.value
= 477777777},
550 static const sval_t kmalloc_seg_min
= {
552 {.value
= 500000000},
554 static const sval_t kmalloc_seg_max
= {
556 {.value
= 577777777},
558 static const sval_t vmalloc_seg_min
= {
560 {.value
= 600000000},
562 static const sval_t vmalloc_seg_max
= {
564 {.value
= 677777777},
566 static const sval_t fn_ptr_min
= {
568 {.value
= 700000000},
570 static const sval_t fn_ptr_max
= {
572 {.value
= 777777777},
575 char *get_other_name_sym(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
576 char *map_call_to_other_name_sym(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
577 char *map_long_to_short_name_sym(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
578 char *map_long_to_short_name_sym_nostack(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
580 #define STRLEN_MAX_RET 1010101
582 /* smatch_absolute.c */
583 int get_absolute_min_helper(struct expression
*expr
, sval_t
*sval
);
584 int get_absolute_max_helper(struct expression
*expr
, sval_t
*sval
);
586 /* smatch_local_values.c */
587 int get_local_rl(struct expression
*expr
, struct range_list
**rl
);
588 int get_local_max_helper(struct expression
*expr
, sval_t
*sval
);
589 int get_local_min_helper(struct expression
*expr
, sval_t
*sval
);
591 /* smatch_type_value.c */
592 int get_db_type_rl(struct expression
*expr
, struct range_list
**rl
);
593 /* smatch_data_val.c */
594 int get_db_data_rl(struct expression
*expr
, struct range_list
**rl
);
596 /* smatch_states.c */
597 void __swap_cur_stree(struct stree
*stree
);
598 void __push_fake_cur_stree();
599 struct stree
*__pop_fake_cur_stree();
600 void __free_fake_cur_stree();
601 void __set_fake_cur_stree_fast(struct stree
*stree
);
602 void __pop_fake_cur_stree_fast(void);
603 void __merge_stree_into_cur(struct stree
*stree
);
605 int unreachable(void);
606 void __set_sm(struct sm_state
*sm
);
607 void __set_sm_cur_stree(struct sm_state
*sm
);
608 void __set_sm_fake_stree(struct sm_state
*sm
);
609 void __set_true_false_sm(struct sm_state
*true_state
,
610 struct sm_state
*false_state
);
611 void nullify_path(void);
612 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
614 void __unnullify_path(void);
615 int __path_is_null(void);
616 void save_all_states(void);
617 void restore_all_states(void);
618 void free_goto_stack(void);
619 void clear_all_states(void);
621 struct sm_state
*get_sm_state(int owner
, const char *name
,
623 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
624 void __push_true_states(void);
625 void __use_false_states(void);
626 void __discard_false_states(void);
627 void __merge_false_states(void);
628 void __merge_true_states(void);
630 void __negate_cond_stacks(void);
631 void __use_pre_cond_states(void);
632 void __use_cond_true_states(void);
633 void __use_cond_false_states(void);
634 void __push_cond_stacks(void);
635 void __fold_in_set_states(void);
636 void __free_set_states(void);
637 struct stree
*__copy_cond_true_states(void);
638 struct stree
*__copy_cond_false_states(void);
639 struct stree
*__pop_cond_true_stack(void);
640 struct stree
*__pop_cond_false_stack(void);
641 void __and_cond_states(void);
642 void __or_cond_states(void);
643 void __save_pre_cond_states(void);
644 void __discard_pre_cond_states(void);
645 struct stree
*__get_true_states(void);
646 struct stree
*__get_false_states(void);
647 void __use_cond_states(void);
648 extern struct state_list
*__last_base_slist
;
650 void __push_continues(void);
651 void __discard_continues(void);
652 void __process_continues(void);
653 void __merge_continues(void);
655 void __push_breaks(void);
656 void __process_breaks(void);
657 int __has_breaks(void);
658 void __merge_breaks(void);
659 void __use_breaks(void);
661 void __save_switch_states(struct expression
*switch_expr
);
662 void __discard_switches(void);
663 int have_remaining_cases(void);
664 void __merge_switches(struct expression
*switch_expr
, struct range_list
*case_rl
);
665 void __push_default(void);
666 void __set_default(void);
667 int __pop_default(void);
669 void __push_conditions(void);
670 void __discard_conditions(void);
672 void __save_gotos(const char *name
, struct symbol
*sym
);
673 void __merge_gotos(const char *name
, struct symbol
*sym
);
675 void __print_cur_stree(void);
678 void __pass_to_client(void *data
, enum hook_type type
);
679 void __pass_to_client_no_data(enum hook_type type
);
680 void __pass_case_to_client(struct expression
*switch_expr
,
681 struct range_list
*rl
);
682 int __has_merge_function(int client_id
);
683 struct smatch_state
*__client_merge_function(int owner
,
684 struct smatch_state
*s1
,
685 struct smatch_state
*s2
);
686 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
687 void call_pre_merge_hook(struct sm_state
*sm
);
688 void __push_scope_hooks(void);
689 void __call_scope_hooks(void);
691 /* smatch_function_hooks.c */
692 void create_function_hook_hash(void);
693 void __match_initializer_call(struct symbol
*sym
);
699 * Changing these numbers is a pain. Don't do it. If you ever use a
700 * number it can't be re-used right away so there may be gaps.
701 * We select these in order by type so if the order matters, then give
702 * it a number below 100-999,9000-9999 ranges. */
716 LOCK_RELEASED
= 1009,
717 ABSOLUTE_LIMITS
= 1010,
729 UNTRACKED_PARAM
= 1023,
734 COMPARE_LIMIT
= 1028,
735 PARAM_COMPARE
= 1029,
738 CONSTRAINT_REQUIRED
= 1033,
741 /* put random temporary stuff in the 7000-7999 range for testing */
743 USER_DATA3_SET
= 9017,
745 NO_OVERFLOW_SIMPLE
= 8019,
751 NO_SIDE_EFFECT
= 8025,
754 ARRAYSIZE_ARG
= 8033,
760 extern struct sqlite3
*smatch_db
;
761 extern struct sqlite3
*mem_db
;
762 extern struct sqlite3
*cache_db
;
764 void debug_sql(struct sqlite3
*db
, const char *sql
);
765 void db_ignore_states(int id
);
766 void select_caller_info_hook(void (*callback
)(const char *name
, struct symbol
*sym
, char *key
, char *value
), int type
);
767 void add_member_info_callback(int owner
, void (*callback
)(struct expression
*call
, int param
, char *printed_name
, struct sm_state
*sm
));
768 void add_split_return_callback(void (*fn
)(int return_id
, char *return_ranges
, struct expression
*returned_expr
));
769 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
));
770 void select_call_implies_hook(int type
, void (*callback
)(struct expression
*call
, struct expression
*arg
, char *key
, char *value
));
771 struct range_list
*db_return_vals(struct expression
*expr
);
772 struct range_list
*db_return_vals_from_str(const char *fn_name
);
773 char *return_state_to_var_sym(struct expression
*expr
, int param
, const char *key
, struct symbol
**sym
);
774 char *get_chunk_from_key(struct expression
*arg
, char *key
, struct symbol
**sym
, struct var_sym_list
**vsl
);
775 char *get_variable_from_key(struct expression
*arg
, const char *key
, struct symbol
**sym
);
776 const char *state_name_to_param_name(const char *state_name
, const char *param_name
);
777 const char *get_param_name_var_sym(const char *name
, struct symbol
*sym
);
778 const char *get_param_name(struct sm_state
*sm
);
779 const char *get_mtag_name_var_sym(const char *state_name
, struct symbol
*sym
);
780 const char *get_mtag_name_expr(struct expression
*expr
);
781 char *get_data_info_name(struct expression
*expr
);
783 void sql_exec(struct sqlite3
*db
, int (*callback
)(void*, int, char**, char**), void *data
, const char *sql
);
785 #define sql_helper(db, call_back, data, sql...) \
787 char sql_txt[1024]; \
789 snprintf(sql_txt, sizeof(sql_txt), sql); \
790 sm_debug("debug: %s\n", sql_txt); \
791 debug_sql(db, sql_txt); \
792 sql_exec(db, call_back, data, sql_txt); \
796 #define run_sql(call_back, data, sql...) \
800 sql_helper(smatch_db, call_back, data, sql); \
803 #define mem_sql(call_back, data, sql...) \
804 sql_helper(mem_db, call_back, data, sql)
806 #define cache_sql(call_back, data, sql...) \
807 sql_helper(cache_db, call_back, data, sql)
809 #define sql_insert_helper(table, db, ignore, late, values...) \
811 struct sqlite3 *_db = db; \
813 if (__inline_fn && !_db) \
817 char *err, *p = buf; \
820 p += snprintf(p, buf + sizeof(buf) - p, \
821 "insert %sinto %s values (", \
822 ignore ? "or ignore " : "", #table); \
823 p += snprintf(p, buf + sizeof(buf) - p, values); \
824 p += snprintf(p, buf + sizeof(buf) - p, ");"); \
825 sm_debug("mem-db: %s\n", buf); \
826 rc = sqlite3_exec(_db, buf, NULL, NULL, &err); \
827 if (rc != SQLITE_OK) { \
828 fprintf(stderr, "SQL error #2: %s\n", err); \
829 fprintf(stderr, "SQL: '%s'\n", buf); \
835 FILE *tmp_fd = sm_outfd; \
836 sm_outfd = sql_outfd; \
838 sm_printf("SQL%s: insert %sinto " #table " values(", \
839 late ? "_late" : "", ignore ? "or ignore " : ""); \
846 #define sql_insert(table, values...) sql_insert_helper(table, 0, 0, 0, values);
847 #define sql_insert_or_ignore(table, values...) sql_insert_helper(table, 0, 1, 0, values);
848 #define sql_insert_late(table, values...) sql_insert_helper(table, 0, 0, 1, values);
849 #define sql_insert_cache(table, values...) sql_insert_helper(table, cache_db, 1, 0, values);
851 char *get_static_filter(struct symbol
*sym
);
853 void sql_insert_return_states(int return_id
, const char *return_ranges
,
854 int type
, int param
, const char *key
, const char *value
);
855 void sql_insert_caller_info(struct expression
*call
, int type
, int param
,
856 const char *key
, const char *value
);
857 void sql_insert_function_ptr(const char *fn
, const char *struct_name
);
858 void sql_insert_return_values(const char *return_values
);
859 void sql_insert_call_implies(int type
, int param
, const char *key
, const char *value
);
860 void sql_insert_function_type_size(const char *member
, const char *ranges
);
861 void sql_insert_local_values(const char *name
, const char *value
);
862 void sql_insert_function_type_value(const char *type
, const char *value
);
863 void sql_insert_function_type(int param
, const char *value
);
864 void sql_insert_parameter_name(int param
, const char *value
);
865 void sql_insert_data_info(struct expression
*data
, int type
, const char *value
);
866 void sql_insert_data_info_var_sym(const char *var
, struct symbol
*sym
, int type
, const char *value
);
867 void sql_save_constraint(const char *con
);
868 void sql_save_constraint_required(const char *data
, int op
, const char *limit
);
869 void sql_copy_constraint_required(const char *new_limit
, const char *old_limit
);
870 void sql_insert_fn_ptr_data_link(const char *ptr
, const char *data
);
871 void sql_insert_fn_data_link(struct expression
*fn
, int type
, int param
, const char *key
, const char *value
);
872 void sql_insert_mtag_about(mtag_t tag
, const char *left_name
, const char *right_name
);
873 void insert_mtag_data(mtag_t tag
, int offset
, struct range_list
*rl
);
874 void sql_insert_mtag_map(mtag_t tag
, int offset
, mtag_t container
);
875 void sql_insert_mtag_alias(mtag_t orig
, mtag_t alias
);
876 int mtag_map_select_container(mtag_t tag
, int offset
, mtag_t
*container
);
877 int mtag_map_select_tag(mtag_t container
, int offset
, mtag_t
*tag
);
879 void sql_select_return_states(const char *cols
, struct expression
*call
,
880 int (*callback
)(void*, int, char**, char**), void *info
);
881 void sql_select_call_implies(const char *cols
, struct expression
*call
,
882 int (*callback
)(void*, int, char**, char**));
884 void open_smatch_db(void);
887 int open_data_file(const char *filename
);
888 struct token
*get_tokens_file(const char *filename
);
891 extern char *option_debug_check
;
892 extern char *option_project_str
;
893 extern char *data_dir
;
894 extern int option_no_data
;
895 extern int option_full_path
;
896 extern int option_param_mapper
;
897 extern int option_call_tree
;
898 extern int num_checks
;
906 extern enum project_type option_project
;
907 const char *check_name(unsigned short id
);
908 int id_from_name(const char *name
);
911 /* smatch_buf_size.c */
912 int get_array_size(struct expression
*expr
);
913 int get_array_size_bytes(struct expression
*expr
);
914 int get_array_size_bytes_min(struct expression
*expr
);
915 int get_array_size_bytes_max(struct expression
*expr
);
916 struct range_list
*get_array_size_bytes_rl(struct expression
*expr
);
917 int get_real_array_size(struct expression
*expr
);
918 int last_member_is_resizable(struct symbol
*type
);
919 /* smatch_strlen.c */
920 int get_implied_strlen(struct expression
*expr
, struct range_list
**rl
);
921 int get_size_from_strlen(struct expression
*expr
);
923 /* smatch_capped.c */
924 int is_capped(struct expression
*expr
);
925 int is_capped_var_sym(const char *name
, struct symbol
*sym
);
927 /* check_user_data.c */
928 int is_user_macro(struct expression
*expr
);
929 int is_user_data(struct expression
*expr
);
930 int is_capped_user_data(struct expression
*expr
);
931 int implied_user_data(struct expression
*expr
, struct range_list
**rl
);
932 int get_user_rl(struct expression
*expr
, struct range_list
**rl
);
933 int get_user_rl_spammy(struct expression
*expr
, struct range_list
**rl
);
934 int is_user_rl(struct expression
*expr
);
935 int get_user_rl_var_sym(const char *name
, struct symbol
*sym
, struct range_list
**rl
);
937 /* check_locking.c */
938 void print_held_locks();
940 /* check_assigned_expr.c */
941 struct expression
*get_assigned_expr(struct expression
*expr
);
942 struct expression
*get_assigned_expr_name_sym(const char *name
, struct symbol
*sym
);
943 /* smatch_return_to_param.c */
944 void __add_return_to_param_mapping(struct expression
*assign
, const char *return_string
);
945 char *map_call_to_param_name_sym(struct expression
*expr
, struct symbol
**sym
);
947 /* smatch_comparison.c */
948 struct compare_data
{
949 /* The ->left and ->right expression pointers might be NULL (I'm lazy) */
950 struct expression
*left
;
951 const char *left_var
;
952 struct var_sym_list
*left_vsl
;
954 struct expression
*right
;
955 const char *right_var
;
956 struct var_sym_list
*right_vsl
;
958 DECLARE_ALLOCATOR(compare_data
);
959 struct smatch_state
*alloc_compare_state(
960 struct expression
*left
,
961 const char *left_var
, struct var_sym_list
*left_vsl
,
963 struct expression
*right
,
964 const char *right_var
, struct var_sym_list
*right_vsl
);
965 int merge_comparisons(int one
, int two
);
966 int combine_comparisons(int left_compare
, int right_compare
);
967 int state_to_comparison(struct smatch_state
*state
);
968 struct smatch_state
*merge_compare_states(struct smatch_state
*s1
, struct smatch_state
*s2
);
969 int get_comparison(struct expression
*left
, struct expression
*right
);
970 int get_comparison_strings(const char *one
, const char *two
);
971 int possible_comparison(struct expression
*a
, int comparison
, struct expression
*b
);
972 struct state_list
*get_all_comparisons(struct expression
*expr
);
973 struct state_list
*get_all_possible_equal_comparisons(struct expression
*expr
);
974 void __add_return_comparison(struct expression
*call
, const char *range
);
975 void __add_comparison_info(struct expression
*expr
, struct expression
*call
, const char *range
);
976 char *get_printed_param_name(struct expression
*call
, const char *param_name
, struct symbol
*param_sym
);
977 char *name_sym_to_param_comparison(const char *name
, struct symbol
*sym
);
978 char *expr_equal_to_param(struct expression
*expr
, int ignore
);
979 char *expr_lte_to_param(struct expression
*expr
, int ignore
);
980 char *expr_param_comparison(struct expression
*expr
, int ignore
);
981 int flip_comparison(int op
);
982 int negate_comparison(int op
);
983 int remove_unsigned_from_comparison(int op
);
984 int param_compare_limit_is_impossible(struct expression
*expr
, int left_param
, char *left_key
, char *value
);
985 void filter_by_comparison(struct range_list
**rl
, int comparison
, struct range_list
*right
);
986 struct sm_state
*comparison_implication_hook(struct expression
*expr
,
987 struct state_list
**true_stack
,
988 struct state_list
**false_stack
);
989 void __compare_param_limit_hook(struct expression
*left_expr
, struct expression
*right_expr
,
990 const char *state_name
,
991 struct smatch_state
*true_state
, struct smatch_state
*false_state
);
992 int impossibly_high_comparison(struct expression
*expr
);
995 sval_t
*sval_alloc(sval_t sval
);
996 sval_t
*sval_alloc_permanent(sval_t sval
);
997 sval_t
sval_blank(struct expression
*expr
);
998 sval_t
sval_type_val(struct symbol
*type
, long long val
);
999 sval_t
sval_from_val(struct expression
*expr
, long long val
);
1000 int sval_unsigned(sval_t sval
);
1001 int sval_signed(sval_t sval
);
1002 int sval_bits(sval_t sval
);
1003 int sval_bits_used(sval_t sval
);
1004 int sval_is_negative(sval_t sval
);
1005 int sval_is_positive(sval_t sval
);
1006 int sval_is_min(sval_t sval
);
1007 int sval_is_max(sval_t sval
);
1008 int sval_is_a_min(sval_t sval
);
1009 int sval_is_a_max(sval_t sval
);
1010 int sval_is_negative_min(sval_t sval
);
1011 int sval_cmp_t(struct symbol
*type
, sval_t one
, sval_t two
);
1012 int sval_cmp_val(sval_t one
, long long val
);
1013 sval_t
sval_min(sval_t one
, sval_t two
);
1014 sval_t
sval_max(sval_t one
, sval_t two
);
1015 int sval_too_low(struct symbol
*type
, sval_t sval
);
1016 int sval_too_high(struct symbol
*type
, sval_t sval
);
1017 int sval_fits(struct symbol
*type
, sval_t sval
);
1018 sval_t
sval_cast(struct symbol
*type
, sval_t sval
);
1019 sval_t
sval_preop(sval_t sval
, int op
);
1020 sval_t
sval_binop(sval_t left
, int op
, sval_t right
);
1021 int sval_binop_overflows(sval_t left
, int op
, sval_t right
);
1022 unsigned long long fls_mask(unsigned long long uvalue
);
1023 unsigned long long sval_fls_mask(sval_t sval
);
1024 const char *sval_to_str(sval_t sval
);
1025 const char *sval_to_numstr(sval_t sval
);
1026 sval_t
ll_to_sval(long long val
);
1028 /* smatch_string_list.c */
1029 int list_has_string(struct string_list
*str_list
, const char *str
);
1030 void insert_string(struct string_list
**str_list
, const char *str
);
1031 struct string_list
*clone_str_list(struct string_list
*orig
);
1032 struct string_list
*combine_string_lists(struct string_list
*one
, struct string_list
*two
);
1034 /* smatch_start_states.c */
1035 struct stree
*get_start_states(void);
1037 /* smatch_recurse.c */
1038 int has_symbol(struct expression
*expr
, struct symbol
*sym
);
1039 int has_variable(struct expression
*expr
, struct expression
*var
);
1040 int has_inc_dec(struct expression
*expr
);
1042 /* smatch_stored_conditions.c */
1043 struct smatch_state
*get_stored_condition(struct expression
*expr
);
1044 struct expression_list
*get_conditions(struct expression
*expr
);
1045 struct sm_state
*stored_condition_implication_hook(struct expression
*expr
,
1046 struct state_list
**true_stack
,
1047 struct state_list
**false_stack
);
1049 /* check_string_len.c */
1050 int get_formatted_string_size(struct expression
*call
, int arg
);
1052 /* smatch_param_set.c */
1053 int param_was_set(struct expression
*expr
);
1054 int param_was_set_var_sym(const char *name
, struct symbol
*sym
);
1055 /* smatch_param_filter.c */
1056 int param_has_filter_data(struct sm_state
*sm
);
1058 /* smatch_links.c */
1059 void set_up_link_functions(int id
, int linkid
);
1060 struct smatch_state
*merge_link_states(struct smatch_state
*s1
, struct smatch_state
*s2
);
1061 void store_link(int link_id
, const char *name
, struct symbol
*sym
, const char *link_name
, struct symbol
*link_sym
);
1063 /* smatch_auto_copy.c */
1064 void set_auto_copy(int owner
);
1066 /* check_buf_comparison */
1067 struct expression
*get_size_variable(struct expression
*buf
);
1068 struct expression
*get_array_variable(struct expression
*size
);
1070 /* smatch_untracked_param.c */
1071 void mark_untracked(struct expression
*expr
, int param
, const char *key
, const char *value
);
1072 void add_untracked_param_hook(void (func
)(struct expression
*call
, int param
));
1073 void mark_all_params_untracked(int return_id
, char *return_ranges
, struct expression
*expr
);
1075 /* smatch_strings.c */
1076 struct state_list
*get_strings(struct expression
*expr
);
1078 /* smatch_estate.c */
1079 int estate_get_single_value(struct smatch_state
*state
, sval_t
*sval
);
1081 /* smatch_address.c */
1082 int get_address_rl(struct expression
*expr
, struct range_list
**rl
);
1083 int get_member_offset(struct symbol
*type
, const char *member_name
);
1084 int get_member_offset_from_deref(struct expression
*expr
);
1086 /* for now this is in smatch_used_parameter.c */
1087 void __get_state_hook(int owner
, const char *name
, struct symbol
*sym
);
1089 /* smatch_buf_comparison.c */
1090 int db_var_is_array_limit(struct expression
*array
, const char *name
, struct var_sym_list
*vsl
);
1092 struct stree
*get_all_return_states(void);
1093 struct stree_stack
*get_all_return_strees(void);
1094 int on_atomic_dec_path(void);
1095 int was_inced(const char *name
, struct symbol
*sym
);
1097 /* smatch_constraints.c */
1098 char *get_constraint_str(struct expression
*expr
);
1099 struct constraint_list
*get_constraints(struct expression
*expr
);
1100 char *unmet_constraint(struct expression
*data
, struct expression
*offset
);
1101 char *get_required_constraint(const char *data_str
);
1103 /* smatch_container_of.c */
1104 int get_param_from_container_of(struct expression
*expr
);
1105 int get_offset_from_container_of(struct expression
*expr
);
1108 int get_toplevel_mtag(struct symbol
*sym
, mtag_t
*tag
);
1109 int get_mtag(struct expression
*expr
, mtag_t
*tag
);
1110 int get_mtag_offset(struct expression
*expr
);
1111 int create_mtag_alias(mtag_t tag
, struct expression
*expr
, mtag_t
*new);
1112 int expr_to_mtag_name_offset(struct expression
*expr
, mtag_t
*tag
, char **name
, int *offset
);
1113 void update_mtag_data(struct expression
*expr
);
1115 /* smatch_mem_tracker.c */
1116 extern int option_mem
;
1117 unsigned long get_max_memory(void);
1119 /* check_is_nospec.c */
1120 bool is_nospec(struct expression
*expr
);
1122 static inline int type_bits(struct symbol
*type
)
1126 if (type
->type
== SYM_PTR
) /* Sparse doesn't set this for &pointers */
1127 return bits_in_pointer
;
1128 if (type
->type
== SYM_ARRAY
)
1129 return bits_in_pointer
;
1130 if (!type
->examined
)
1131 examine_symbol_type(type
);
1132 return type
->bit_size
;
1135 static inline int type_unsigned(struct symbol
*base_type
)
1139 if (base_type
->ctype
.modifiers
& MOD_UNSIGNED
)
1144 static inline int type_positive_bits(struct symbol
*type
)
1148 if (type
->type
== SYM_ARRAY
)
1149 return bits_in_pointer
- 1;
1150 if (type_unsigned(type
))
1151 return type_bits(type
);
1152 return type_bits(type
) - 1;
1155 static inline int sval_positive_bits(sval_t sval
)
1157 return type_positive_bits(sval
.type
);
1161 * Returns -1 if one is smaller, 0 if they are the same and 1 if two is larger.
1163 static inline int sval_cmp(sval_t one
, sval_t two
)
1165 struct symbol
*type
;
1168 if (sval_positive_bits(two
) > sval_positive_bits(one
))
1170 if (type_bits(type
) < 31)
1173 one
= sval_cast(type
, one
);
1174 two
= sval_cast(type
, two
);
1176 if (type_unsigned(type
)) {
1177 if (one
.uvalue
< two
.uvalue
)
1179 if (one
.uvalue
== two
.uvalue
)
1183 /* fix me handle type promotion and unsigned values */
1184 if (one
.value
< two
.value
)
1186 if (one
.value
== two
.value
)
1191 #endif /* !SMATCH_H_ */