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
29 #include "expression.h"
36 unsigned long long uvalue
;
44 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
45 extern struct smatch_state undefined
;
46 extern struct smatch_state ghost
;
47 extern struct smatch_state merged
;
48 extern struct smatch_state true_state
;
49 extern struct smatch_state false_state
;
50 DECLARE_ALLOCATOR(smatch_state
);
52 static inline void *INT_PTR(int i
)
54 return (void *)(long)i
;
57 static inline int PTR_INT(void *p
)
67 DECLARE_ALLOCATOR(tracker
);
68 DECLARE_PTR_LIST(tracker_list
, struct tracker
);
69 DECLARE_PTR_LIST(stree_stack
, struct stree
);
71 /* The first 3 struct members must match struct tracker */
76 unsigned short merged
:1;
77 unsigned int nr_children
;
79 struct smatch_state
*state
;
81 struct sm_state
*left
;
82 struct sm_state
*right
;
83 struct state_list
*possible
;
90 DECLARE_ALLOCATOR(var_sym
);
91 DECLARE_PTR_LIST(var_sym_list
, struct var_sym
);
97 DECLARE_PTR_LIST(constraint_list
, struct constraint
);
107 ASSIGNMENT_HOOK_AFTER
,
109 GLOBAL_ASSIGNMENT_HOOK
,
114 WHOLE_CONDITION_HOOK
,
116 CALL_HOOK_AFTER_INLINE
,
117 FUNCTION_CALL_HOOK_AFTER_DB
,
118 CALL_ASSIGNMENT_HOOK
,
119 MACRO_ASSIGNMENT_HOOK
,
144 void add_hook(void *func
, enum hook_type type
);
145 typedef struct smatch_state
*(merge_func_t
)(struct smatch_state
*s1
, struct smatch_state
*s2
);
146 typedef struct smatch_state
*(unmatched_func_t
)(struct sm_state
*state
);
147 void add_merge_hook(int client_id
, merge_func_t
*func
);
148 void add_unmatched_state_hook(int client_id
, unmatched_func_t
*func
);
149 void add_pre_merge_hook(int client_id
, void (*hook
)(struct sm_state
*sm
));
150 typedef void (scope_hook
)(void *data
);
151 void add_scope_hook(scope_hook
*hook
, void *data
);
152 typedef void (func_hook
)(const char *fn
, struct expression
*expr
, void *data
);
153 typedef void (implication_hook
)(const char *fn
, struct expression
*call_expr
,
154 struct expression
*assign_expr
, void *data
);
155 typedef void (return_implies_hook
)(struct expression
*call_expr
,
156 int param
, char *key
, char *value
);
157 typedef int (implied_return_hook
)(struct expression
*call_expr
, void *info
, struct range_list
**rl
);
158 void add_function_hook(const char *look_for
, func_hook
*call_back
, void *data
);
160 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
162 void add_implied_return_hook(const char *look_for
,
163 implied_return_hook
*call_back
,
165 void add_macro_assign_hook(const char *look_for
, func_hook
*call_back
,
167 void add_macro_assign_hook_extra(const char *look_for
, func_hook
*call_back
,
169 void return_implies_state(const char *look_for
, long long start
, long long end
,
170 implication_hook
*call_back
, void *info
);
171 void select_return_states_hook(int type
, return_implies_hook
*callback
);
172 void select_return_states_before(void (*fn
)(void));
173 void select_return_states_after(void (*fn
)(void));
174 int get_implied_return(struct expression
*expr
, struct range_list
**rl
);
175 void allocate_hook_memory(void);
177 struct modification_data
{
178 struct smatch_state
*prev
;
179 struct expression
*cur
;
182 typedef void (modification_hook
)(struct sm_state
*sm
, struct expression
*mod_expr
);
183 void add_modification_hook(int owner
, modification_hook
*call_back
);
184 void add_modification_hook_late(int owner
, modification_hook
*call_back
);
185 struct smatch_state
*get_modification_state(struct expression
*expr
);
187 int outside_of_function(void);
188 const char *get_filename(void);
189 const char *get_base_file(void);
190 char *get_function(void);
191 int get_lineno(void);
192 extern int final_pass
;
193 extern struct symbol
*cur_func_sym
;
194 extern int option_debug
;
195 extern int local_debug
;
196 extern int option_info
;
197 extern int option_spammy
;
198 extern char *trace_variable
;
199 extern struct stree
*global_states
;
200 int is_silenced_function(void);
202 /* smatch_impossible.c */
203 int is_impossible_path(void);
204 void set_path_impossible(void);
206 extern FILE *sm_outfd
;
207 extern FILE *sql_outfd
;
208 extern FILE *caller_info_fd
;
209 #define sm_printf(msg...) do { if (final_pass || option_debug || local_debug) fprintf(sm_outfd, msg); } while (0)
211 static inline void sm_prefix(void)
213 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
216 static inline void print_implied_debug_msg();
218 #define sm_msg(msg...) \
220 print_implied_debug_msg(); \
221 if (!option_debug && !final_pass && !local_debug) \
223 if (!option_info && is_silenced_function()) \
230 #define local_debug(msg...) \
236 extern char *implied_debug_msg
;
237 static inline void print_implied_debug_msg(void)
239 static struct symbol
*last_printed
= NULL
;
241 if (!implied_debug_msg
)
243 if (last_printed
== cur_func_sym
)
245 last_printed
= cur_func_sym
;
246 sm_msg("%s", implied_debug_msg
);
249 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
251 #define sm_info(msg...) do { \
252 if (option_debug || (option_info && final_pass)) { \
254 sm_printf("info: "); \
260 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
262 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
263 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
264 struct state_list
*get_possible_states(int owner
, const char *name
,
266 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
267 struct sm_state
*set_state(int owner
, const char *name
, struct symbol
*sym
,
268 struct smatch_state
*state
);
269 struct sm_state
*set_state_expr(int owner
, struct expression
*expr
,
270 struct smatch_state
*state
);
271 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
272 void delete_state_expr(int owner
, struct expression
*expr
);
273 void __delete_all_states_sym(struct symbol
*sym
);
274 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
275 struct smatch_state
*true_state
,
276 struct smatch_state
*false_state
);
277 void set_true_false_states_expr(int owner
, struct expression
*expr
,
278 struct smatch_state
*true_state
,
279 struct smatch_state
*false_state
);
281 struct stree
*get_all_states_from_stree(int owner
, struct stree
*source
);
282 struct stree
*get_all_states_stree(int id
);
283 struct stree
*__get_cur_stree(void);
284 int is_reachable(void);
286 /* smatch_helper.c */
287 DECLARE_PTR_LIST(int_stack
, int);
288 char *alloc_string(const char *str
);
289 void free_string(char *str
);
290 void append(char *dest
, const char *data
, int buff_len
);
291 void remove_parens(char *str
);
292 struct smatch_state
*alloc_state_num(int num
);
293 struct smatch_state
*alloc_state_str(const char *name
);
294 struct smatch_state
*alloc_state_expr(struct expression
*expr
);
295 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
298 char *expr_to_var(struct expression
*expr
);
299 struct symbol
*expr_to_sym(struct expression
*expr
);
300 char *expr_to_str(struct expression
*expr
);
301 char *expr_to_str_sym(struct expression
*expr
,
302 struct symbol
**sym_ptr
);
303 char *expr_to_var_sym(struct expression
*expr
,
304 struct symbol
**sym_ptr
);
305 char *expr_to_known_chunk_sym(struct expression
*expr
, struct symbol
**sym
);
306 char *expr_to_chunk_sym_vsl(struct expression
*expr
, struct symbol
**sym
, struct var_sym_list
**vsl
);
307 int get_complication_score(struct expression
*expr
);
309 int sym_name_is(const char *name
, struct expression
*expr
);
310 int get_const_value(struct expression
*expr
, sval_t
*sval
);
311 int get_value(struct expression
*expr
, sval_t
*val
);
312 int get_implied_value(struct expression
*expr
, sval_t
*val
);
313 int get_implied_min(struct expression
*expr
, sval_t
*sval
);
314 int get_implied_max(struct expression
*expr
, sval_t
*val
);
315 int get_hard_max(struct expression
*expr
, sval_t
*sval
);
316 int get_fuzzy_min(struct expression
*expr
, sval_t
*min
);
317 int get_fuzzy_max(struct expression
*expr
, sval_t
*max
);
318 int get_absolute_min(struct expression
*expr
, sval_t
*sval
);
319 int get_absolute_max(struct expression
*expr
, sval_t
*sval
);
320 int parse_call_math(struct expression
*expr
, char *math
, sval_t
*val
);
321 int parse_call_math_rl(struct expression
*call
, char *math
, struct range_list
**rl
);
322 char *get_value_in_terms_of_parameter_math(struct expression
*expr
);
323 char *get_value_in_terms_of_parameter_math_var_sym(const char *var
, struct symbol
*sym
);
324 int is_zero(struct expression
*expr
);
325 int known_condition_true(struct expression
*expr
);
326 int known_condition_false(struct expression
*expr
);
327 int implied_condition_true(struct expression
*expr
);
328 int implied_condition_false(struct expression
*expr
);
329 int can_integer_overflow(struct symbol
*type
, struct expression
*expr
);
331 int is_array(struct expression
*expr
);
332 struct expression
*get_array_base(struct expression
*expr
);
333 struct expression
*get_array_offset(struct expression
*expr
);
334 const char *show_state(struct smatch_state
*state
);
335 struct statement
*get_expression_statement(struct expression
*expr
);
336 struct expression
*strip_parens(struct expression
*expr
);
337 struct expression
*strip_expr(struct expression
*expr
);
338 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
339 int is_error_return(struct expression
*expr
);
340 int getting_address(void);
341 int get_struct_and_member(struct expression
*expr
, const char **type
, const char **member
);
342 char *get_member_name(struct expression
*expr
);
343 char *get_fnptr_name(struct expression
*expr
);
344 int cmp_pos(struct position pos1
, struct position pos2
);
345 int positions_eq(struct position pos1
, struct position pos2
);
346 struct statement
*get_current_statement(void);
347 struct statement
*get_prev_statement(void);
348 int get_param_num_from_sym(struct symbol
*sym
);
349 int get_param_num(struct expression
*expr
);
350 int ms_since(struct timeval
*start
);
351 int parent_is_gone_var_sym(const char *name
, struct symbol
*sym
);
352 int parent_is_gone(struct expression
*expr
);
353 int invert_op(int op
);
354 int expr_equiv(struct expression
*one
, struct expression
*two
);
355 void push_int(struct int_stack
**stack
, int num
);
356 int pop_int(struct int_stack
**stack
);
359 struct symbol
*get_real_base_type(struct symbol
*sym
);
360 int type_bytes(struct symbol
*type
);
361 int array_bytes(struct symbol
*type
);
362 struct symbol
*get_pointer_type(struct expression
*expr
);
363 struct symbol
*get_type(struct expression
*expr
);
364 int type_signed(struct symbol
*base_type
);
365 int expr_unsigned(struct expression
*expr
);
366 int expr_signed(struct expression
*expr
);
367 int returns_unsigned(struct symbol
*base_type
);
368 int is_pointer(struct expression
*expr
);
369 int returns_pointer(struct symbol
*base_type
);
370 sval_t
sval_type_max(struct symbol
*base_type
);
371 sval_t
sval_type_min(struct symbol
*base_type
);
372 int nr_bits(struct expression
*expr
);
373 int is_void_pointer(struct expression
*expr
);
374 int is_char_pointer(struct expression
*expr
);
375 int is_string(struct expression
*expr
);
376 int is_static(struct expression
*expr
);
377 int is_local_variable(struct expression
*expr
);
378 int types_equiv(struct symbol
*one
, struct symbol
*two
);
380 const char *global_static();
381 struct symbol
*cur_func_return_type(void);
382 struct symbol
*get_arg_type(struct expression
*fn
, int arg
);
383 struct symbol
*get_member_type_from_key(struct expression
*expr
, char *key
);
384 int is_struct(struct expression
*expr
);
385 char *type_to_str(struct symbol
*type
);
387 /* smatch_ignore.c */
388 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
389 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
392 struct var_sym
*alloc_var_sym(const char *var
, struct symbol
*sym
);
393 struct var_sym_list
*expr_to_vsl(struct expression
*expr
);
394 void add_var_sym(struct var_sym_list
**list
, const char *var
, struct symbol
*sym
);
395 void add_var_sym_expr(struct var_sym_list
**list
, struct expression
*expr
);
396 void del_var_sym(struct var_sym_list
**list
, const char *var
, struct symbol
*sym
);
397 int in_var_sym_list(struct var_sym_list
*list
, const char *var
, struct symbol
*sym
);
398 struct var_sym_list
*clone_var_sym_list(struct var_sym_list
*from_vsl
);
399 void merge_var_sym_list(struct var_sym_list
**dest
, struct var_sym_list
*src
);
400 struct var_sym_list
*combine_var_sym_lists(struct var_sym_list
*one
, struct var_sym_list
*two
);
401 int var_sym_lists_equiv(struct var_sym_list
*one
, struct var_sym_list
*two
);
402 void free_var_sym_list(struct var_sym_list
**list
);
403 void free_var_syms_and_list(struct var_sym_list
**list
);
406 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
407 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
409 void add_tracker_expr(struct tracker_list
**list
, int owner
, struct expression
*expr
);
410 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
412 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
414 void free_tracker_list(struct tracker_list
**list
);
415 void free_trackers_and_list(struct tracker_list
**list
);
417 /* smatch_conditions */
418 int in_condition(void);
422 extern int __in_fake_assign
;
423 void smatch (int argc
, char **argv
);
424 int inside_loop(void);
425 int definitely_inside_loop(void);
426 struct expression
*get_switch_expr(void);
427 int in_expression_statement(void);
428 void __process_post_op_stack(void);
429 void __split_expr(struct expression
*expr
);
430 void __split_label_stmt(struct statement
*stmt
);
431 void __split_stmt(struct statement
*stmt
);
432 extern int __in_function_def
;
433 extern int option_assume_loops
;
434 extern int option_two_passes
;
435 extern int option_no_db
;
436 extern int option_file_output
;
437 extern int option_time
;
438 extern struct expression_list
*big_expression_stack
;
439 extern struct expression_list
*big_condition_stack
;
440 extern struct statement_list
*big_statement_stack
;
441 int is_assigned_call(struct expression
*expr
);
442 int inlinable(struct expression
*expr
);
443 extern int __inline_call
;
444 extern struct expression
*__inline_fn
;
445 extern int __in_pre_condition
;
446 extern int __bail_on_rest_of_function
;
447 extern struct statement
*__prev_stmt
;
448 extern struct statement
*__cur_stmt
;
449 extern struct statement
*__next_stmt
;
450 void init_fake_env(void);
451 void end_fake_env(void);
453 /* smatch_struct_assignment.c */
454 struct expression
*get_faked_expression(void);
455 void __fake_struct_member_assignments(struct expression
*expr
);
457 /* smatch_project.c */
458 int is_no_inline_function(const char *function
);
460 /* smatch_conditions */
461 void __split_whole_condition(struct expression
*expr
);
462 void __handle_logic(struct expression
*expr
);
463 int is_condition(struct expression
*expr
);
464 int __handle_condition_assigns(struct expression
*expr
);
465 int __handle_select_assigns(struct expression
*expr
);
466 int __handle_expr_statement_assigns(struct expression
*expr
);
468 /* smatch_implied.c */
469 extern int option_debug_implied
;
470 extern int option_debug_related
;
471 struct range_list_stack
;
472 void param_limit_implications(struct expression
*expr
, int param
, char *key
, char *value
);
473 struct stree
*__implied_case_stree(struct expression
*switch_expr
,
474 struct range_list
*case_rl
,
475 struct range_list_stack
**remaining_cases
,
476 struct stree
**raw_stree
);
477 void overwrite_states_using_pool(struct sm_state
*gate_sm
, struct sm_state
*pool_sm
);
478 int assume(struct expression
*expr
);
479 void end_assume(void);
481 /* smatch_extras.c */
482 #define SMATCH_EXTRA 3 /* this is my_id from smatch extra set in smatch.c */
483 extern int RETURN_ID
;
490 extern long long valid_ptr_min
, valid_ptr_max
;
491 extern sval_t valid_ptr_min_sval
, valid_ptr_max_sval
;
492 static const sval_t array_min_sval
= {
496 static const sval_t array_max_sval
= {
500 static const sval_t text_seg_min
= {
502 {.value
= 100000000},
504 static const sval_t text_seg_max
= {
506 {.value
= 177777777},
508 static const sval_t data_seg_min
= {
510 {.value
= 200000000},
512 static const sval_t data_seg_max
= {
514 {.value
= 277777777},
516 static const sval_t bss_seg_min
= {
518 {.value
= 300000000},
520 static const sval_t bss_seg_max
= {
522 {.value
= 377777777},
524 static const sval_t stack_seg_min
= {
526 {.value
= 400000000},
528 static const sval_t stack_seg_max
= {
530 {.value
= 477777777},
532 static const sval_t kmalloc_seg_min
= {
534 {.value
= 500000000},
536 static const sval_t kmalloc_seg_max
= {
538 {.value
= 577777777},
540 static const sval_t vmalloc_seg_min
= {
542 {.value
= 600000000},
544 static const sval_t vmalloc_seg_max
= {
546 {.value
= 677777777},
548 static const sval_t fn_ptr_min
= {
550 {.value
= 700000000},
552 static const sval_t fn_ptr_max
= {
554 {.value
= 777777777},
557 char *get_other_name_sym(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
558 char *map_call_to_other_name_sym(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
559 char *map_long_to_short_name_sym(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
560 char *map_long_to_short_name_sym_nostack(const char *name
, struct symbol
*sym
, struct symbol
**new_sym
);
562 #define STRLEN_MAX_RET 1010101
564 /* smatch_absolute.c */
565 int get_absolute_min_helper(struct expression
*expr
, sval_t
*sval
);
566 int get_absolute_max_helper(struct expression
*expr
, sval_t
*sval
);
568 /* smatch_local_values.c */
569 int get_local_rl(struct expression
*expr
, struct range_list
**rl
);
570 int get_local_max_helper(struct expression
*expr
, sval_t
*sval
);
571 int get_local_min_helper(struct expression
*expr
, sval_t
*sval
);
573 /* smatch_type_value.c */
574 int get_db_type_rl(struct expression
*expr
, struct range_list
**rl
);
575 /* smatch_data_val.c */
576 int get_db_data_rl(struct expression
*expr
, struct range_list
**rl
);
578 /* smatch_states.c */
579 void __swap_cur_stree(struct stree
*stree
);
580 void __push_fake_cur_stree();
581 struct stree
*__pop_fake_cur_stree();
582 void __free_fake_cur_stree();
583 void __set_fake_cur_stree_fast(struct stree
*stree
);
584 void __pop_fake_cur_stree_fast(void);
585 void __merge_stree_into_cur(struct stree
*stree
);
587 int unreachable(void);
588 void __set_sm(struct sm_state
*sm
);
589 void __set_sm_cur_stree(struct sm_state
*sm
);
590 void __set_sm_fake_stree(struct sm_state
*sm
);
591 void __set_true_false_sm(struct sm_state
*true_state
,
592 struct sm_state
*false_state
);
593 void nullify_path(void);
594 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
596 void __unnullify_path(void);
597 int __path_is_null(void);
598 void save_all_states(void);
599 void restore_all_states(void);
600 void free_goto_stack(void);
601 void clear_all_states(void);
603 struct sm_state
*get_sm_state(int owner
, const char *name
,
605 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
606 void __push_true_states(void);
607 void __use_false_states(void);
608 void __discard_false_states(void);
609 void __merge_false_states(void);
610 void __merge_true_states(void);
612 void __negate_cond_stacks(void);
613 void __use_pre_cond_states(void);
614 void __use_cond_true_states(void);
615 void __use_cond_false_states(void);
616 void __push_cond_stacks(void);
617 void __fold_in_set_states(void);
618 void __free_set_states(void);
619 struct stree
*__copy_cond_true_states(void);
620 struct stree
*__copy_cond_false_states(void);
621 struct stree
*__pop_cond_true_stack(void);
622 struct stree
*__pop_cond_false_stack(void);
623 void __and_cond_states(void);
624 void __or_cond_states(void);
625 void __save_pre_cond_states(void);
626 void __discard_pre_cond_states(void);
627 struct stree
*__get_true_states(void);
628 struct stree
*__get_false_states(void);
629 void __use_cond_states(void);
630 extern struct state_list
*__last_base_slist
;
632 void __push_continues(void);
633 void __discard_continues(void);
634 void __process_continues(void);
635 void __merge_continues(void);
637 void __push_breaks(void);
638 void __process_breaks(void);
639 int __has_breaks(void);
640 void __merge_breaks(void);
641 void __use_breaks(void);
643 void __save_switch_states(struct expression
*switch_expr
);
644 void __discard_switches(void);
645 void __merge_switches(struct expression
*switch_expr
, struct range_list
*case_rl
);
646 void __push_default(void);
647 void __set_default(void);
648 int __pop_default(void);
650 void __push_conditions(void);
651 void __discard_conditions(void);
653 void __save_gotos(const char *name
, struct symbol
*sym
);
654 void __merge_gotos(const char *name
, struct symbol
*sym
);
656 void __print_cur_stree(void);
659 void __pass_to_client(void *data
, enum hook_type type
);
660 void __pass_to_client_no_data(enum hook_type type
);
661 void __pass_case_to_client(struct expression
*switch_expr
,
662 struct range_list
*rl
);
663 int __has_merge_function(int client_id
);
664 struct smatch_state
*__client_merge_function(int owner
,
665 struct smatch_state
*s1
,
666 struct smatch_state
*s2
);
667 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
668 void call_pre_merge_hook(struct sm_state
*sm
);
669 void __push_scope_hooks(void);
670 void __call_scope_hooks(void);
672 /* smatch_function_hooks.c */
673 void create_function_hook_hash(void);
674 void __match_initializer_call(struct symbol
*sym
);
680 * Changing these numbers is a pain. Don't do it. If you ever use a
681 * number it can't be re-used right away so there may be gaps.
682 * We select these in order by type so if the order matters, then give
683 * it a number below 100-999,9000-9999 ranges. */
697 LOCK_RELEASED
= 1009,
698 ABSOLUTE_LIMITS
= 1010,
710 UNTRACKED_PARAM
= 1023,
715 COMPARE_LIMIT
= 1028,
716 PARAM_COMPARE
= 1029,
719 CONSTRAINT_REQUIRED
= 1033,
721 /* put random temporary stuff in the 7000-7999 range for testing */
723 USER_DATA3_SET
= 9017,
725 NO_OVERFLOW_SIMPLE
= 8019,
731 NO_SIDE_EFFECT
= 8025,
734 ARRAYSIZE_ARG
= 8033,
738 void debug_sql(const char *sql
);
739 void debug_mem_sql(const char *sql
);
740 void select_caller_info_hook(void (*callback
)(const char *name
, struct symbol
*sym
, char *key
, char *value
), int type
);
741 void add_member_info_callback(int owner
, void (*callback
)(struct expression
*call
, int param
, char *printed_name
, struct sm_state
*sm
));
742 void add_split_return_callback(void (*fn
)(int return_id
, char *return_ranges
, struct expression
*returned_expr
));
743 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
));
744 void select_call_implies_hook(int type
, void (*callback
)(struct expression
*call
, struct expression
*arg
, char *key
, char *value
));
745 struct range_list
*db_return_vals(struct expression
*expr
);
746 struct range_list
*db_return_vals_from_str(const char *fn_name
);
747 char *return_state_to_var_sym(struct expression
*expr
, int param
, const char *key
, struct symbol
**sym
);
748 char *get_chunk_from_key(struct expression
*arg
, char *key
, struct symbol
**sym
, struct var_sym_list
**vsl
);
749 char *get_variable_from_key(struct expression
*arg
, const char *key
, struct symbol
**sym
);
750 const char *state_name_to_param_name(const char *state_name
, const char *param_name
);
751 const char *get_param_name_var_sym(const char *name
, struct symbol
*sym
);
752 const char *get_param_name(struct sm_state
*sm
);
753 char *get_data_info_name(struct expression
*expr
);
755 #define run_sql(call_back, data, sql...) \
757 char sql_txt[1024]; \
760 snprintf(sql_txt, 1024, sql); \
761 debug_sql(sql_txt); \
762 sql_exec(call_back, data, sql_txt); \
765 /* like run_sql() but for the in-memory database */
766 #define mem_sql(call_back, data, sql...) \
768 char sql_txt[1024]; \
770 snprintf(sql_txt, sizeof(sql_txt), sql); \
771 sm_debug("in-mem: %s\n", sql_txt); \
772 debug_mem_sql(sql_txt); \
773 sql_mem_exec(call_back, data, sql_txt); \
776 char *get_static_filter(struct symbol
*sym
);
778 void sql_insert_return_states(int return_id
, const char *return_ranges
,
779 int type
, int param
, const char *key
, const char *value
);
780 void sql_insert_caller_info(struct expression
*call
, int type
, int param
,
781 const char *key
, const char *value
);
782 void sql_insert_function_ptr(const char *fn
, const char *struct_name
);
783 void sql_insert_return_values(const char *return_values
);
784 void sql_insert_call_implies(int type
, int param
, const char *key
, const char *value
);
785 void sql_insert_function_type_size(const char *member
, const char *ranges
);
786 void sql_insert_local_values(const char *name
, const char *value
);
787 void sql_insert_function_type_value(const char *type
, const char *value
);
788 void sql_insert_function_type(int param
, const char *value
);
789 void sql_insert_parameter_name(int param
, const char *value
);
790 void sql_insert_data_info(struct expression
*data
, int type
, const char *value
);
791 void sql_insert_data_info_var_sym(const char *var
, struct symbol
*sym
, int type
, const char *value
);
792 void sql_save_constraint(const char *con
);
793 void sql_save_constraint_required(const char *data
, int op
, const char *limit
);
794 void sql_insert_fn_ptr_data_link(const char *ptr
, const char *data
);
795 void sql_insert_fn_data_link(struct expression
*fn
, int type
, int param
, const char *key
, const char *value
);
797 void sql_select_return_states(const char *cols
, struct expression
*call
,
798 int (*callback
)(void*, int, char**, char**), void *info
);
799 void sql_select_call_implies(const char *cols
, struct expression
*call
,
800 int (*callback
)(void*, int, char**, char**));
802 void sql_exec(int (*callback
)(void*, int, char**, char**), void *data
, const char *sql
);
803 void sql_mem_exec(int (*callback
)(void*, int, char**, char**), void *data
, const char *sql
);
805 void open_smatch_db(void);
808 int open_data_file(const char *filename
);
809 struct token
*get_tokens_file(const char *filename
);
812 extern char *option_debug_check
;
813 extern char *option_project_str
;
814 extern char *data_dir
;
815 extern int option_no_data
;
816 extern int option_full_path
;
817 extern int option_param_mapper
;
818 extern int option_call_tree
;
819 extern int num_checks
;
827 extern enum project_type option_project
;
828 const char *check_name(unsigned short id
);
829 int id_from_name(const char *name
);
832 /* smatch_buf_size.c */
833 int get_array_size(struct expression
*expr
);
834 int get_array_size_bytes(struct expression
*expr
);
835 int get_array_size_bytes_min(struct expression
*expr
);
836 int get_array_size_bytes_max(struct expression
*expr
);
837 struct range_list
*get_array_size_bytes_rl(struct expression
*expr
);
838 int get_real_array_size(struct expression
*expr
);
839 /* smatch_strlen.c */
840 int get_implied_strlen(struct expression
*expr
, struct range_list
**rl
);
841 int get_size_from_strlen(struct expression
*expr
);
843 /* smatch_capped.c */
844 int is_capped(struct expression
*expr
);
845 int is_capped_var_sym(const char *name
, struct symbol
*sym
);
847 /* check_user_data.c */
848 int is_user_macro(struct expression
*expr
);
849 int is_user_data(struct expression
*expr
);
850 int is_capped_user_data(struct expression
*expr
);
851 int implied_user_data(struct expression
*expr
, struct range_list
**rl
);
852 int get_user_rl(struct expression
*expr
, struct range_list
**rl
);
853 int get_user_rl_var_sym(const char *name
, struct symbol
*sym
, struct range_list
**rl
);
855 /* check_locking.c */
856 void print_held_locks();
858 /* check_assigned_expr.c */
859 struct expression
*get_assigned_expr(struct expression
*expr
);
860 struct expression
*get_assigned_expr_name_sym(const char *name
, struct symbol
*sym
);
861 /* smatch_return_to_param.c */
862 void __add_return_to_param_mapping(struct expression
*assign
, const char *return_string
);
863 char *map_call_to_param_name_sym(struct expression
*expr
, struct symbol
**sym
);
865 /* smatch_comparison.c */
866 struct compare_data
{
868 struct var_sym_list
*vsl1
;
871 struct var_sym_list
*vsl2
;
873 DECLARE_ALLOCATOR(compare_data
);
874 struct smatch_state
*alloc_compare_state(
875 const char *var1
, struct var_sym_list
*vsl1
,
877 const char *var2
, struct var_sym_list
*vsl2
);
878 int merge_comparisons(int one
, int two
);
879 int combine_comparisons(int left_compare
, int right_compare
);
880 int state_to_comparison(struct smatch_state
*state
);
881 struct smatch_state
*merge_compare_states(struct smatch_state
*s1
, struct smatch_state
*s2
);
882 int get_comparison(struct expression
*left
, struct expression
*right
);
883 int get_comparison_strings(const char *one
, const char *two
);
884 int possible_comparison(struct expression
*a
, int comparison
, struct expression
*b
);
885 struct state_list
*get_all_comparisons(struct expression
*expr
);
886 struct state_list
*get_all_possible_equal_comparisons(struct expression
*expr
);
887 void __add_return_comparison(struct expression
*call
, const char *range
);
888 void __add_comparison_info(struct expression
*expr
, struct expression
*call
, const char *range
);
889 char *get_printed_param_name(struct expression
*call
, const char *param_name
, struct symbol
*param_sym
);
890 char *name_sym_to_param_comparison(const char *name
, struct symbol
*sym
);
891 char *expr_equal_to_param(struct expression
*expr
, int ignore
);
892 char *expr_lte_to_param(struct expression
*expr
, int ignore
);
893 char *expr_param_comparison(struct expression
*expr
, int ignore
);
894 int flip_comparison(int op
);
895 int negate_comparison(int op
);
896 int param_compare_limit_is_impossible(struct expression
*expr
, int left_param
, char *left_key
, char *value
);
897 void filter_by_comparison(struct range_list
**rl
, int comparison
, struct range_list
*right
);
898 struct sm_state
*comparison_implication_hook(struct expression
*expr
,
899 struct state_list
**true_stack
,
900 struct state_list
**false_stack
);
901 void __compare_param_limit_hook(struct expression
*left_expr
, struct expression
*right_expr
,
902 const char *state_name
,
903 struct smatch_state
*true_state
, struct smatch_state
*false_state
);
907 sval_t
*sval_alloc(sval_t sval
);
908 sval_t
*sval_alloc_permanent(sval_t sval
);
909 sval_t
sval_blank(struct expression
*expr
);
910 sval_t
sval_type_val(struct symbol
*type
, long long val
);
911 sval_t
sval_from_val(struct expression
*expr
, long long val
);
912 int sval_unsigned(sval_t sval
);
913 int sval_signed(sval_t sval
);
914 int sval_bits(sval_t sval
);
915 int sval_bits_used(sval_t sval
);
916 int sval_is_negative(sval_t sval
);
917 int sval_is_positive(sval_t sval
);
918 int sval_is_min(sval_t sval
);
919 int sval_is_max(sval_t sval
);
920 int sval_is_a_min(sval_t sval
);
921 int sval_is_a_max(sval_t sval
);
922 int sval_is_negative_min(sval_t sval
);
923 int sval_cmp_t(struct symbol
*type
, sval_t one
, sval_t two
);
924 int sval_cmp_val(sval_t one
, long long val
);
925 sval_t
sval_min(sval_t one
, sval_t two
);
926 sval_t
sval_max(sval_t one
, sval_t two
);
927 int sval_too_low(struct symbol
*type
, sval_t sval
);
928 int sval_too_high(struct symbol
*type
, sval_t sval
);
929 int sval_fits(struct symbol
*type
, sval_t sval
);
930 sval_t
sval_cast(struct symbol
*type
, sval_t sval
);
931 sval_t
sval_preop(sval_t sval
, int op
);
932 sval_t
sval_binop(sval_t left
, int op
, sval_t right
);
933 int sval_binop_overflows(sval_t left
, int op
, sval_t right
);
934 unsigned long long fls_mask(unsigned long long uvalue
);
935 unsigned long long sval_fls_mask(sval_t sval
);
936 const char *sval_to_str(sval_t sval
);
937 const char *sval_to_numstr(sval_t sval
);
938 sval_t
ll_to_sval(long long val
);
940 /* smatch_string_list.c */
941 int list_has_string(struct string_list
*str_list
, const char *str
);
942 void insert_string(struct string_list
**str_list
, const char *str
);
943 struct string_list
*clone_str_list(struct string_list
*orig
);
944 struct string_list
*combine_string_lists(struct string_list
*one
, struct string_list
*two
);
946 /* smatch_start_states.c */
947 struct stree
*get_start_states(void);
949 /* smatch_recurse.c */
950 int has_symbol(struct expression
*expr
, struct symbol
*sym
);
951 int has_variable(struct expression
*expr
, struct expression
*var
);
952 int has_inc_dec(struct expression
*expr
);
954 /* smatch_stored_conditions.c */
955 struct smatch_state
*get_stored_condition(struct expression
*expr
);
956 struct expression_list
*get_conditions(struct expression
*expr
);
957 struct sm_state
*stored_condition_implication_hook(struct expression
*expr
,
958 struct state_list
**true_stack
,
959 struct state_list
**false_stack
);
961 /* check_string_len.c */
962 int get_formatted_string_size(struct expression
*call
, int arg
);
964 /* smatch_param_set.c */
965 int param_was_set(struct expression
*expr
);
966 int param_was_set_var_sym(const char *name
, struct symbol
*sym
);
967 /* smatch_param_filter.c */
968 int param_has_filter_data(struct sm_state
*sm
);
971 void set_up_link_functions(int id
, int linkid
);
972 struct smatch_state
*merge_link_states(struct smatch_state
*s1
, struct smatch_state
*s2
);
973 void store_link(int link_id
, const char *name
, struct symbol
*sym
, const char *link_name
, struct symbol
*link_sym
);
975 /* smatch_auto_copy.c */
976 void set_auto_copy(int owner
);
978 /* check_buf_comparison */
979 struct expression
*get_size_variable(struct expression
*buf
);
981 /* smatch_untracked_param.c */
982 void mark_untracked(struct expression
*expr
, int param
, const char *key
, const char *value
);
983 void add_untracked_param_hook(void (func
)(struct expression
*call
, int param
));
985 /* smatch_strings.c */
986 struct state_list
*get_strings(struct expression
*expr
);
988 /* smatch_estate.c */
989 int estate_get_single_value(struct smatch_state
*state
, sval_t
*sval
);
991 /* smatch_address.c */
992 int get_address_rl(struct expression
*expr
, struct range_list
**rl
);
993 int get_member_offset(struct symbol
*type
, char *member_name
);
994 int get_member_offset_from_deref(struct expression
*expr
);
996 /* for now this is in smatch_used_parameter.c */
997 void __get_state_hook(int owner
, const char *name
, struct symbol
*sym
);
999 /* smatch_buf_comparison.c */
1000 int db_var_is_array_limit(struct expression
*array
, const char *name
, struct var_sym_list
*vsl
);
1002 struct stree
*get_all_return_states(void);
1003 struct stree_stack
*get_all_return_strees(void);
1004 int was_inced(const char *name
, struct symbol
*sym
);
1006 /* smatch_constraints.c */
1007 char *get_constraint_str(struct expression
*expr
);
1008 struct constraint_list
*get_constraints(struct expression
*expr
);
1009 char *unmet_constraint(struct expression
*data
, struct expression
*offset
);
1010 char *get_required_constraint(const char *data_str
);
1012 static inline int type_bits(struct symbol
*type
)
1016 if (type
->type
== SYM_PTR
) /* Sparse doesn't set this for &pointers */
1017 return bits_in_pointer
;
1018 if (type
->type
== SYM_ARRAY
)
1019 return bits_in_pointer
;
1020 if (!type
->examined
)
1021 examine_symbol_type(type
);
1022 return type
->bit_size
;
1025 static inline int type_unsigned(struct symbol
*base_type
)
1029 if (base_type
->ctype
.modifiers
& MOD_UNSIGNED
)
1034 static inline int type_positive_bits(struct symbol
*type
)
1038 if (type
->type
== SYM_ARRAY
)
1039 return bits_in_pointer
- 1;
1040 if (type_unsigned(type
))
1041 return type_bits(type
);
1042 return type_bits(type
) - 1;
1045 static inline int sval_positive_bits(sval_t sval
)
1047 return type_positive_bits(sval
.type
);
1051 * Returns -1 if one is smaller, 0 if they are the same and 1 if two is larger.
1053 static inline int sval_cmp(sval_t one
, sval_t two
)
1055 struct symbol
*type
;
1058 if (sval_positive_bits(two
) > sval_positive_bits(one
))
1060 if (type_bits(type
) < 31)
1063 one
= sval_cast(type
, one
);
1064 two
= sval_cast(type
, two
);
1066 if (type_unsigned(type
)) {
1067 if (one
.uvalue
< two
.uvalue
)
1069 if (one
.uvalue
== two
.uvalue
)
1073 /* fix me handle type promotion and unsigned values */
1074 if (one
.value
< two
.value
)
1076 if (one
.value
== two
.value
)
1081 #endif /* !SMATCH_H_ */