hooks: introduce FUNCTION_CALL_HOOK_BEFORE
[smatch.git] / smatch.h
blob6042ea4fb43e71d74ac1fd15683e81bcad90f2ae
1 /*
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
18 #ifndef SMATCH_H_
19 # define SMATCH_H_
21 #include <stdio.h>
22 #include <string.h>
23 #include <limits.h>
24 #include <sys/time.h>
25 #include "lib.h"
26 #include "allocate.h"
27 #include "scope.h"
28 #include "parse.h"
29 #include "expression.h"
30 #include "avl.h"
32 typedef struct {
33 struct symbol *type;
34 union {
35 long long value;
36 unsigned long long uvalue;
38 } sval_t;
40 typedef long long mtag_t;
42 struct smatch_state {
43 const char *name;
44 void *data;
46 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
47 extern struct smatch_state undefined;
48 extern struct smatch_state ghost;
49 extern struct smatch_state merged;
50 extern struct smatch_state true_state;
51 extern struct smatch_state false_state;
52 DECLARE_ALLOCATOR(smatch_state);
54 static inline void *INT_PTR(int i)
56 return (void *)(long)i;
59 static inline int PTR_INT(void *p)
61 return (int)(long)p;
64 struct tracker {
65 char *name;
66 struct symbol *sym;
67 unsigned short owner;
69 DECLARE_ALLOCATOR(tracker);
70 DECLARE_PTR_LIST(tracker_list, struct tracker);
71 DECLARE_PTR_LIST(stree_stack, struct stree);
73 /* The first 3 struct members must match struct tracker */
74 struct sm_state {
75 const char *name;
76 struct symbol *sym;
77 unsigned short owner;
78 unsigned short merged:1;
79 unsigned short skip_implications:1;
80 unsigned int nr_children;
81 unsigned int line;
82 struct smatch_state *state;
83 struct stree *pool;
84 struct sm_state *left;
85 struct sm_state *right;
86 struct state_list *possible;
89 struct var_sym {
90 char *var;
91 struct symbol *sym;
93 DECLARE_ALLOCATOR(var_sym);
94 DECLARE_PTR_LIST(var_sym_list, struct var_sym);
96 struct constraint {
97 int op;
98 int id;
100 DECLARE_PTR_LIST(constraint_list, struct constraint);
102 enum hook_type {
103 EXPR_HOOK,
104 STMT_HOOK,
105 STMT_HOOK_AFTER,
106 SYM_HOOK,
107 STRING_HOOK,
108 DECLARATION_HOOK,
109 ASSIGNMENT_HOOK,
110 ASSIGNMENT_HOOK_AFTER,
111 RAW_ASSIGNMENT_HOOK,
112 GLOBAL_ASSIGNMENT_HOOK,
113 LOGIC_HOOK,
114 CONDITION_HOOK,
115 PRELOOP_HOOK,
116 SELECT_HOOK,
117 WHOLE_CONDITION_HOOK,
118 FUNCTION_CALL_HOOK_BEFORE,
119 FUNCTION_CALL_HOOK,
120 CALL_HOOK_AFTER_INLINE,
121 FUNCTION_CALL_HOOK_AFTER_DB,
122 CALL_ASSIGNMENT_HOOK,
123 MACRO_ASSIGNMENT_HOOK,
124 BINOP_HOOK,
125 OP_HOOK,
126 DEREF_HOOK,
127 CASE_HOOK,
128 ASM_HOOK,
129 CAST_HOOK,
130 SIZEOF_HOOK,
131 BASE_HOOK,
132 FUNC_DEF_HOOK,
133 AFTER_DEF_HOOK,
134 END_FUNC_HOOK,
135 AFTER_FUNC_HOOK,
136 RETURN_HOOK,
137 INLINE_FN_START,
138 INLINE_FN_END,
139 END_FILE_HOOK,
140 NUM_HOOKS,
143 #define TRUE 1
144 #define FALSE 0
146 struct range_list;
148 void add_hook(void *func, enum hook_type type);
149 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
150 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
151 void add_merge_hook(int client_id, merge_func_t *func);
152 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
153 void add_pre_merge_hook(int client_id, void (*hook)(struct sm_state *sm));
154 typedef void (scope_hook)(void *data);
155 void add_scope_hook(scope_hook *hook, void *data);
156 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
157 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
158 struct expression *assign_expr, void *data);
159 typedef void (return_implies_hook)(struct expression *call_expr,
160 int param, char *key, char *value);
161 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list **rl);
162 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
164 void add_function_assign_hook(const char *look_for, func_hook *call_back,
165 void *info);
166 void add_implied_return_hook(const char *look_for,
167 implied_return_hook *call_back,
168 void *info);
169 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
170 void *info);
171 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
172 void *info);
173 void return_implies_state(const char *look_for, long long start, long long end,
174 implication_hook *call_back, void *info);
175 void select_return_states_hook(int type, return_implies_hook *callback);
176 void select_return_states_before(void (*fn)(void));
177 void select_return_states_after(void (*fn)(void));
178 int get_implied_return(struct expression *expr, struct range_list **rl);
179 void allocate_hook_memory(void);
181 struct modification_data {
182 struct smatch_state *prev;
183 struct expression *cur;
186 typedef void (modification_hook)(struct sm_state *sm, struct expression *mod_expr);
187 void add_modification_hook(int owner, modification_hook *call_back);
188 void add_modification_hook_late(int owner, modification_hook *call_back);
189 struct smatch_state *get_modification_state(struct expression *expr);
191 int outside_of_function(void);
192 const char *get_filename(void);
193 const char *get_base_file(void);
194 char *get_function(void);
195 int get_lineno(void);
196 extern int final_pass;
197 extern struct symbol *cur_func_sym;
198 extern int option_debug;
199 extern int local_debug;
200 extern int option_info;
201 extern int option_spammy;
202 extern char *trace_variable;
203 extern struct stree *global_states;
204 int is_silenced_function(void);
206 /* smatch_impossible.c */
207 int is_impossible_path(void);
208 void set_path_impossible(void);
210 extern FILE *sm_outfd;
211 extern FILE *sql_outfd;
212 extern FILE *caller_info_fd;
213 #define sm_printf(msg...) do { if (final_pass || option_debug || local_debug) fprintf(sm_outfd, msg); } while (0)
215 static inline void sm_prefix(void)
217 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
220 static inline void print_implied_debug_msg();
222 extern bool __silence_warnings_for_stmt;
224 #define sm_msg(msg...) \
225 do { \
226 print_implied_debug_msg(); \
227 if (!final_pass && !option_debug && !local_debug) \
228 break; \
229 if (__silence_warnings_for_stmt && !option_debug && !local_debug) \
230 break; \
231 if (!option_info && is_silenced_function()) \
232 break; \
233 sm_prefix(); \
234 sm_printf(msg); \
235 sm_printf("\n"); \
236 } while (0)
238 #define local_debug(msg...) \
239 do { \
240 if (local_debug) \
241 sm_msg(msg); \
242 } while (0)
244 extern char *implied_debug_msg;
245 static inline void print_implied_debug_msg(void)
247 static struct symbol *last_printed = NULL;
249 if (!implied_debug_msg)
250 return;
251 if (last_printed == cur_func_sym)
252 return;
253 last_printed = cur_func_sym;
254 sm_msg("%s", implied_debug_msg);
257 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
259 #define sm_info(msg...) do { \
260 if (option_debug || (option_info && final_pass)) { \
261 sm_prefix(); \
262 sm_printf("info: "); \
263 sm_printf(msg); \
264 sm_printf("\n"); \
266 } while(0)
268 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
270 struct smatch_state *__get_state(int owner, const char *name, struct symbol *sym);
271 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
272 struct smatch_state *get_state_expr(int owner, struct expression *expr);
273 struct state_list *get_possible_states(int owner, const char *name,
274 struct symbol *sym);
275 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
276 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
277 struct smatch_state *state);
278 struct sm_state *set_state_expr(int owner, struct expression *expr,
279 struct smatch_state *state);
280 void delete_state(int owner, const char *name, struct symbol *sym);
281 void delete_state_expr(int owner, struct expression *expr);
282 void __delete_all_states_sym(struct symbol *sym);
283 void set_true_false_states(int owner, const char *name, struct symbol *sym,
284 struct smatch_state *true_state,
285 struct smatch_state *false_state);
286 void set_true_false_states_expr(int owner, struct expression *expr,
287 struct smatch_state *true_state,
288 struct smatch_state *false_state);
290 struct stree *get_all_states_from_stree(int owner, struct stree *source);
291 struct stree *get_all_states_stree(int id);
292 struct stree *__get_cur_stree(void);
293 int is_reachable(void);
294 void add_get_state_hook(void (*fn)(int owner, const char *name, struct symbol *sym));
296 /* smatch_helper.c */
297 DECLARE_PTR_LIST(int_stack, int);
298 char *alloc_string(const char *str);
299 void free_string(char *str);
300 void append(char *dest, const char *data, int buff_len);
301 void remove_parens(char *str);
302 struct smatch_state *alloc_state_num(int num);
303 struct smatch_state *alloc_state_str(const char *name);
304 struct smatch_state *alloc_state_expr(struct expression *expr);
305 struct expression *get_argument_from_call_expr(struct expression_list *args,
306 int num);
308 char *expr_to_var(struct expression *expr);
309 struct symbol *expr_to_sym(struct expression *expr);
310 char *expr_to_str(struct expression *expr);
311 char *expr_to_str_sym(struct expression *expr,
312 struct symbol **sym_ptr);
313 char *expr_to_var_sym(struct expression *expr,
314 struct symbol **sym_ptr);
315 char *expr_to_known_chunk_sym(struct expression *expr, struct symbol **sym);
316 char *expr_to_chunk_sym_vsl(struct expression *expr, struct symbol **sym, struct var_sym_list **vsl);
317 int get_complication_score(struct expression *expr);
319 int sym_name_is(const char *name, struct expression *expr);
320 int get_const_value(struct expression *expr, sval_t *sval);
321 int get_value(struct expression *expr, sval_t *val);
322 int get_implied_value(struct expression *expr, sval_t *val);
323 int get_implied_min(struct expression *expr, sval_t *sval);
324 int get_implied_max(struct expression *expr, sval_t *val);
325 int get_hard_max(struct expression *expr, sval_t *sval);
326 int get_fuzzy_min(struct expression *expr, sval_t *min);
327 int get_fuzzy_max(struct expression *expr, sval_t *max);
328 int get_absolute_min(struct expression *expr, sval_t *sval);
329 int get_absolute_max(struct expression *expr, sval_t *sval);
330 int parse_call_math(struct expression *expr, char *math, sval_t *val);
331 int parse_call_math_rl(struct expression *call, char *math, struct range_list **rl);
332 char *get_value_in_terms_of_parameter_math(struct expression *expr);
333 char *get_value_in_terms_of_parameter_math_var_sym(const char *var, struct symbol *sym);
334 int is_zero(struct expression *expr);
335 int known_condition_true(struct expression *expr);
336 int known_condition_false(struct expression *expr);
337 int implied_condition_true(struct expression *expr);
338 int implied_condition_false(struct expression *expr);
339 int can_integer_overflow(struct symbol *type, struct expression *expr);
341 int is_array(struct expression *expr);
342 struct expression *get_array_base(struct expression *expr);
343 struct expression *get_array_offset(struct expression *expr);
344 const char *show_state(struct smatch_state *state);
345 struct statement *get_expression_statement(struct expression *expr);
346 struct expression *strip_parens(struct expression *expr);
347 struct expression *strip_expr(struct expression *expr);
348 void scoped_state(int my_id, const char *name, struct symbol *sym);
349 int is_error_return(struct expression *expr);
350 int getting_address(void);
351 int get_struct_and_member(struct expression *expr, const char **type, const char **member);
352 char *get_member_name(struct expression *expr);
353 char *get_fnptr_name(struct expression *expr);
354 int cmp_pos(struct position pos1, struct position pos2);
355 int positions_eq(struct position pos1, struct position pos2);
356 struct statement *get_current_statement(void);
357 struct statement *get_prev_statement(void);
358 int get_param_num_from_sym(struct symbol *sym);
359 int get_param_num(struct expression *expr);
360 int ms_since(struct timeval *start);
361 int parent_is_gone_var_sym(const char *name, struct symbol *sym);
362 int parent_is_gone(struct expression *expr);
363 int invert_op(int op);
364 int expr_equiv(struct expression *one, struct expression *two);
365 void push_int(struct int_stack **stack, int num);
366 int pop_int(struct int_stack **stack);
368 /* smatch_type.c */
369 struct symbol *get_real_base_type(struct symbol *sym);
370 int type_bytes(struct symbol *type);
371 int array_bytes(struct symbol *type);
372 struct symbol *get_pointer_type(struct expression *expr);
373 struct symbol *get_type(struct expression *expr);
374 int type_signed(struct symbol *base_type);
375 int expr_unsigned(struct expression *expr);
376 int expr_signed(struct expression *expr);
377 int returns_unsigned(struct symbol *base_type);
378 int is_pointer(struct expression *expr);
379 int returns_pointer(struct symbol *base_type);
380 sval_t sval_type_max(struct symbol *base_type);
381 sval_t sval_type_min(struct symbol *base_type);
382 int nr_bits(struct expression *expr);
383 int is_void_pointer(struct expression *expr);
384 int is_char_pointer(struct expression *expr);
385 int is_string(struct expression *expr);
386 int is_static(struct expression *expr);
387 int is_local_variable(struct expression *expr);
388 int types_equiv(struct symbol *one, struct symbol *two);
389 int fn_static(void);
390 const char *global_static();
391 struct symbol *cur_func_return_type(void);
392 struct symbol *get_arg_type(struct expression *fn, int arg);
393 struct symbol *get_member_type_from_key(struct expression *expr, const char *key);
394 int is_struct(struct expression *expr);
395 char *type_to_str(struct symbol *type);
397 /* smatch_ignore.c */
398 void add_ignore(int owner, const char *name, struct symbol *sym);
399 int is_ignored(int owner, const char *name, struct symbol *sym);
400 void add_ignore_expr(int owner, struct expression *expr);
401 int is_ignored_expr(int owner, struct expression *expr);
403 /* smatch_var_sym */
404 struct var_sym *alloc_var_sym(const char *var, struct symbol *sym);
405 struct var_sym_list *expr_to_vsl(struct expression *expr);
406 void add_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
407 void add_var_sym_expr(struct var_sym_list **list, struct expression *expr);
408 void del_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
409 int in_var_sym_list(struct var_sym_list *list, const char *var, struct symbol *sym);
410 struct var_sym_list *clone_var_sym_list(struct var_sym_list *from_vsl);
411 void merge_var_sym_list(struct var_sym_list **dest, struct var_sym_list *src);
412 struct var_sym_list *combine_var_sym_lists(struct var_sym_list *one, struct var_sym_list *two);
413 int var_sym_lists_equiv(struct var_sym_list *one, struct var_sym_list *two);
414 void free_var_sym_list(struct var_sym_list **list);
415 void free_var_syms_and_list(struct var_sym_list **list);
417 /* smatch_tracker */
418 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
419 void add_tracker(struct tracker_list **list, int owner, const char *name,
420 struct symbol *sym);
421 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
422 void del_tracker(struct tracker_list **list, int owner, const char *name,
423 struct symbol *sym);
424 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
425 struct symbol *sym);
426 void free_tracker_list(struct tracker_list **list);
427 void free_trackers_and_list(struct tracker_list **list);
429 /* smatch_conditions */
430 int in_condition(void);
432 /* smatch_flow.c */
434 extern int __in_fake_assign;
435 extern int __in_fake_struct_assign;
436 void smatch (int argc, char **argv);
437 int inside_loop(void);
438 int definitely_inside_loop(void);
439 struct expression *get_switch_expr(void);
440 int in_expression_statement(void);
441 void __process_post_op_stack(void);
442 void __split_expr(struct expression *expr);
443 void __split_label_stmt(struct statement *stmt);
444 void __split_stmt(struct statement *stmt);
445 extern int __in_function_def;
446 extern int option_assume_loops;
447 extern int option_two_passes;
448 extern int option_no_db;
449 extern int option_file_output;
450 extern int option_time;
451 extern struct expression_list *big_expression_stack;
452 extern struct expression_list *big_condition_stack;
453 extern struct statement_list *big_statement_stack;
454 int is_assigned_call(struct expression *expr);
455 int inlinable(struct expression *expr);
456 extern int __inline_call;
457 extern struct expression *__inline_fn;
458 extern int __in_pre_condition;
459 extern int __bail_on_rest_of_function;
460 extern struct statement *__prev_stmt;
461 extern struct statement *__cur_stmt;
462 extern struct statement *__next_stmt;
463 void init_fake_env(void);
464 void end_fake_env(void);
465 int time_parsing_function(void);
467 /* smatch_struct_assignment.c */
468 struct expression *get_faked_expression(void);
469 void __fake_struct_member_assignments(struct expression *expr);
471 /* smatch_project.c */
472 int is_no_inline_function(const char *function);
474 /* smatch_conditions */
475 void __split_whole_condition(struct expression *expr);
476 void __handle_logic(struct expression *expr);
477 int is_condition(struct expression *expr);
478 int __handle_condition_assigns(struct expression *expr);
479 int __handle_select_assigns(struct expression *expr);
480 int __handle_expr_statement_assigns(struct expression *expr);
482 /* smatch_implied.c */
483 extern int option_debug_implied;
484 extern int option_debug_related;
485 struct range_list_stack;
486 void param_limit_implications(struct expression *expr, int param, char *key, char *value);
487 struct stree *__implied_case_stree(struct expression *switch_expr,
488 struct range_list *case_rl,
489 struct range_list_stack **remaining_cases,
490 struct stree **raw_stree);
491 void overwrite_states_using_pool(struct sm_state *gate_sm, struct sm_state *pool_sm);
492 int assume(struct expression *expr);
493 void end_assume(void);
494 int impossible_assumption(struct expression *left, int op, sval_t sval);
496 /* smatch_extras.c */
497 #define SMATCH_EXTRA 5 /* this is my_id from smatch extra set in smatch.c */
498 extern int RETURN_ID;
500 struct data_range {
501 sval_t min;
502 sval_t max;
505 extern long long valid_ptr_min, valid_ptr_max;
506 extern sval_t valid_ptr_min_sval, valid_ptr_max_sval;
507 static const sval_t array_min_sval = {
508 .type = &ptr_ctype,
509 {.value = 100000},
511 static const sval_t array_max_sval = {
512 .type = &ptr_ctype,
513 {.value = 199999},
515 static const sval_t text_seg_min = {
516 .type = &ptr_ctype,
517 {.value = 100000000},
519 static const sval_t text_seg_max = {
520 .type = &ptr_ctype,
521 {.value = 177777777},
523 static const sval_t data_seg_min = {
524 .type = &ptr_ctype,
525 {.value = 200000000},
527 static const sval_t data_seg_max = {
528 .type = &ptr_ctype,
529 {.value = 277777777},
531 static const sval_t bss_seg_min = {
532 .type = &ptr_ctype,
533 {.value = 300000000},
535 static const sval_t bss_seg_max = {
536 .type = &ptr_ctype,
537 {.value = 377777777},
539 static const sval_t stack_seg_min = {
540 .type = &ptr_ctype,
541 {.value = 400000000},
543 static const sval_t stack_seg_max = {
544 .type = &ptr_ctype,
545 {.value = 477777777},
547 static const sval_t kmalloc_seg_min = {
548 .type = &ptr_ctype,
549 {.value = 500000000},
551 static const sval_t kmalloc_seg_max = {
552 .type = &ptr_ctype,
553 {.value = 577777777},
555 static const sval_t vmalloc_seg_min = {
556 .type = &ptr_ctype,
557 {.value = 600000000},
559 static const sval_t vmalloc_seg_max = {
560 .type = &ptr_ctype,
561 {.value = 677777777},
563 static const sval_t fn_ptr_min = {
564 .type = &ptr_ctype,
565 {.value = 700000000},
567 static const sval_t fn_ptr_max = {
568 .type = &ptr_ctype,
569 {.value = 777777777},
572 char *get_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
573 char *map_call_to_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
574 char *map_long_to_short_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
575 char *map_long_to_short_name_sym_nostack(const char *name, struct symbol *sym, struct symbol **new_sym);
577 #define STRLEN_MAX_RET 1010101
579 /* smatch_absolute.c */
580 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
581 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
583 /* smatch_local_values.c */
584 int get_local_rl(struct expression *expr, struct range_list **rl);
585 int get_local_max_helper(struct expression *expr, sval_t *sval);
586 int get_local_min_helper(struct expression *expr, sval_t *sval);
588 /* smatch_type_value.c */
589 int get_db_type_rl(struct expression *expr, struct range_list **rl);
590 /* smatch_data_val.c */
591 int get_db_data_rl(struct expression *expr, struct range_list **rl);
593 /* smatch_states.c */
594 void __swap_cur_stree(struct stree *stree);
595 void __push_fake_cur_stree();
596 struct stree *__pop_fake_cur_stree();
597 void __free_fake_cur_stree();
598 void __set_fake_cur_stree_fast(struct stree *stree);
599 void __pop_fake_cur_stree_fast(void);
600 void __merge_stree_into_cur(struct stree *stree);
602 int unreachable(void);
603 void __set_sm(struct sm_state *sm);
604 void __set_sm_cur_stree(struct sm_state *sm);
605 void __set_sm_fake_stree(struct sm_state *sm);
606 void __set_true_false_sm(struct sm_state *true_state,
607 struct sm_state *false_state);
608 void nullify_path(void);
609 void __match_nullify_path_hook(const char *fn, struct expression *expr,
610 void *unused);
611 void __unnullify_path(void);
612 int __path_is_null(void);
613 void save_all_states(void);
614 void restore_all_states(void);
615 void free_goto_stack(void);
616 void clear_all_states(void);
618 struct sm_state *get_sm_state(int owner, const char *name,
619 struct symbol *sym);
620 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
621 void __push_true_states(void);
622 void __use_false_states(void);
623 void __discard_false_states(void);
624 void __merge_false_states(void);
625 void __merge_true_states(void);
627 void __negate_cond_stacks(void);
628 void __use_pre_cond_states(void);
629 void __use_cond_true_states(void);
630 void __use_cond_false_states(void);
631 void __push_cond_stacks(void);
632 void __fold_in_set_states(void);
633 void __free_set_states(void);
634 struct stree *__copy_cond_true_states(void);
635 struct stree *__copy_cond_false_states(void);
636 struct stree *__pop_cond_true_stack(void);
637 struct stree *__pop_cond_false_stack(void);
638 void __and_cond_states(void);
639 void __or_cond_states(void);
640 void __save_pre_cond_states(void);
641 void __discard_pre_cond_states(void);
642 struct stree *__get_true_states(void);
643 struct stree *__get_false_states(void);
644 void __use_cond_states(void);
645 extern struct state_list *__last_base_slist;
647 void __push_continues(void);
648 void __discard_continues(void);
649 void __process_continues(void);
650 void __merge_continues(void);
652 void __push_breaks(void);
653 void __process_breaks(void);
654 int __has_breaks(void);
655 void __merge_breaks(void);
656 void __use_breaks(void);
658 void __save_switch_states(struct expression *switch_expr);
659 void __discard_switches(void);
660 int have_remaining_cases(void);
661 void __merge_switches(struct expression *switch_expr, struct range_list *case_rl);
662 void __push_default(void);
663 void __set_default(void);
664 int __pop_default(void);
666 void __push_conditions(void);
667 void __discard_conditions(void);
669 void __save_gotos(const char *name, struct symbol *sym);
670 void __merge_gotos(const char *name, struct symbol *sym);
672 void __print_cur_stree(void);
674 /* smatch_hooks.c */
675 void __pass_to_client(void *data, enum hook_type type);
676 void __pass_to_client_no_data(enum hook_type type);
677 void __pass_case_to_client(struct expression *switch_expr,
678 struct range_list *rl);
679 int __has_merge_function(int client_id);
680 struct smatch_state *__client_merge_function(int owner,
681 struct smatch_state *s1,
682 struct smatch_state *s2);
683 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
684 void call_pre_merge_hook(struct sm_state *sm);
685 void __push_scope_hooks(void);
686 void __call_scope_hooks(void);
688 /* smatch_function_hooks.c */
689 void create_function_hook_hash(void);
690 void __match_initializer_call(struct symbol *sym);
692 /* smatch_db.c */
693 enum info_type {
694 INTERNAL = 0,
696 * Changing these numbers is a pain. Don't do it. If you ever use a
697 * number it can't be re-used right away so there may be gaps.
698 * We select these in order by type so if the order matters, then give
699 * it a number below 100-999,9000-9999 ranges. */
701 PARAM_CLEARED = 101,
702 PARAM_LIMIT = 103,
703 PARAM_FILTER = 104,
705 PARAM_VALUE = 1001,
706 BUF_SIZE = 1002,
707 USER_DATA = 1003,
708 CAPPED_DATA = 1004,
709 RETURN_VALUE = 1005,
710 DEREFERENCE = 1006,
711 RANGE_CAP = 1007,
712 LOCK_HELD = 1008,
713 LOCK_RELEASED = 1009,
714 ABSOLUTE_LIMITS = 1010,
715 PARAM_ADD = 1012,
716 PARAM_FREED = 1013,
717 DATA_SOURCE = 1014,
718 FUZZY_MAX = 1015,
719 STR_LEN = 1016,
720 ARRAY_LEN = 1017,
721 CAPABLE = 1018,
722 NS_CAPABLE = 1019,
723 CONTAINER = 1020,
724 CASTED_CALL = 1021,
725 TYPE_LINK = 1022,
726 UNTRACKED_PARAM = 1023,
727 CULL_PATH = 1024,
728 PARAM_SET = 1025,
729 PARAM_USED = 1026,
730 BYTE_UNITS = 1027,
731 COMPARE_LIMIT = 1028,
732 PARAM_COMPARE = 1029,
733 CONSTRAINT = 1031,
734 PASSES_TYPE = 1032,
735 CONSTRAINT_REQUIRED = 1033,
737 /* put random temporary stuff in the 7000-7999 range for testing */
738 USER_DATA3 = 8017,
739 USER_DATA3_SET = 9017,
740 NO_OVERFLOW = 8018,
741 NO_OVERFLOW_SIMPLE = 8019,
742 LOCKED = 8020,
743 UNLOCKED = 8021,
744 SET_FS = 8022,
745 ATOMIC_INC = 8023,
746 ATOMIC_DEC = 8024,
747 NO_SIDE_EFFECT = 8025,
748 FN_ARG_LINK = 8028,
749 DATA_VALUE = 8029,
750 ARRAYSIZE_ARG = 8033,
751 SIZEOF_ARG = 8034,
752 MEMORY_TAG = 8036,
753 MTAG_ASSIGN = 8035,
756 void debug_sql(const char *sql);
757 void debug_mem_sql(const char *sql);
758 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
759 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
760 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr));
761 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));
762 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
763 struct range_list *db_return_vals(struct expression *expr);
764 struct range_list *db_return_vals_from_str(const char *fn_name);
765 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym);
766 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl);
767 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym);
768 const char *state_name_to_param_name(const char *state_name, const char *param_name);
769 const char *get_param_name_var_sym(const char *name, struct symbol *sym);
770 const char *get_param_name(struct sm_state *sm);
771 const char *get_mtag_name_var_sym(const char *state_name, struct symbol *sym);
772 const char *get_mtag_name_expr(struct expression *expr);
773 char *get_data_info_name(struct expression *expr);
775 #define run_sql(call_back, data, sql...) \
776 do { \
777 char sql_txt[1024]; \
778 if (option_no_db) \
779 break; \
780 snprintf(sql_txt, 1024, sql); \
781 debug_sql(sql_txt); \
782 sql_exec(call_back, data, sql_txt); \
783 } while (0)
785 /* like run_sql() but for the in-memory database */
786 #define mem_sql(call_back, data, sql...) \
787 do { \
788 char sql_txt[1024]; \
790 snprintf(sql_txt, sizeof(sql_txt), sql); \
791 sm_debug("in-mem: %s\n", sql_txt); \
792 debug_mem_sql(sql_txt); \
793 sql_mem_exec(call_back, data, sql_txt); \
794 } while (0)
796 char *get_static_filter(struct symbol *sym);
798 void sql_insert_return_states(int return_id, const char *return_ranges,
799 int type, int param, const char *key, const char *value);
800 void sql_insert_caller_info(struct expression *call, int type, int param,
801 const char *key, const char *value);
802 void sql_insert_function_ptr(const char *fn, const char *struct_name);
803 void sql_insert_return_values(const char *return_values);
804 void sql_insert_call_implies(int type, int param, const char *key, const char *value);
805 void sql_insert_function_type_size(const char *member, const char *ranges);
806 void sql_insert_local_values(const char *name, const char *value);
807 void sql_insert_function_type_value(const char *type, const char *value);
808 void sql_insert_function_type(int param, const char *value);
809 void sql_insert_parameter_name(int param, const char *value);
810 void sql_insert_data_info(struct expression *data, int type, const char *value);
811 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value);
812 void sql_save_constraint(const char *con);
813 void sql_save_constraint_required(const char *data, int op, const char *limit);
814 void sql_copy_constraint_required(const char *new_limit, const char *old_limit);
815 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data);
816 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value);
817 void sql_insert_mtag_about(mtag_t tag, const char *left_name, const char *right_name);
818 void insert_mtag_data(mtag_t tag, int offset, struct range_list *rl);
819 void sql_insert_mtag_map(mtag_t tag, int offset, mtag_t container);
820 void sql_insert_mtag_alias(mtag_t orig, mtag_t alias);
821 int mtag_map_select_container(mtag_t tag, int offset, mtag_t *container);
822 int mtag_map_select_tag(mtag_t container, int offset, mtag_t *tag);
824 void sql_select_return_states(const char *cols, struct expression *call,
825 int (*callback)(void*, int, char**, char**), void *info);
826 void sql_select_call_implies(const char *cols, struct expression *call,
827 int (*callback)(void*, int, char**, char**));
829 void sql_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql);
830 void sql_mem_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql);
832 void open_smatch_db(void);
834 /* smatch_files.c */
835 int open_data_file(const char *filename);
836 struct token *get_tokens_file(const char *filename);
838 /* smatch.c */
839 extern char *option_debug_check;
840 extern char *option_project_str;
841 extern char *data_dir;
842 extern int option_no_data;
843 extern int option_full_path;
844 extern int option_param_mapper;
845 extern int option_call_tree;
846 extern int num_checks;
848 enum project_type {
849 PROJ_NONE,
850 PROJ_KERNEL,
851 PROJ_WINE,
852 PROJ_UNKNOWN,
854 extern enum project_type option_project;
855 const char *check_name(unsigned short id);
856 int id_from_name(const char *name);
859 /* smatch_buf_size.c */
860 int get_array_size(struct expression *expr);
861 int get_array_size_bytes(struct expression *expr);
862 int get_array_size_bytes_min(struct expression *expr);
863 int get_array_size_bytes_max(struct expression *expr);
864 struct range_list *get_array_size_bytes_rl(struct expression *expr);
865 int get_real_array_size(struct expression *expr);
866 int last_member_is_resizable(struct symbol *type);
867 /* smatch_strlen.c */
868 int get_implied_strlen(struct expression *expr, struct range_list **rl);
869 int get_size_from_strlen(struct expression *expr);
871 /* smatch_capped.c */
872 int is_capped(struct expression *expr);
873 int is_capped_var_sym(const char *name, struct symbol *sym);
875 /* check_user_data.c */
876 int is_user_macro(struct expression *expr);
877 int is_user_data(struct expression *expr);
878 int is_capped_user_data(struct expression *expr);
879 int implied_user_data(struct expression *expr, struct range_list **rl);
880 int get_user_rl(struct expression *expr, struct range_list **rl);
881 int get_user_rl_var_sym(const char *name, struct symbol *sym, struct range_list **rl);
883 /* check_locking.c */
884 void print_held_locks();
886 /* check_assigned_expr.c */
887 struct expression *get_assigned_expr(struct expression *expr);
888 struct expression *get_assigned_expr_name_sym(const char *name, struct symbol *sym);
889 /* smatch_return_to_param.c */
890 void __add_return_to_param_mapping(struct expression *assign, const char *return_string);
891 char *map_call_to_param_name_sym(struct expression *expr, struct symbol **sym);
893 /* smatch_comparison.c */
894 struct compare_data {
895 /* The ->left and ->right expression pointers might be NULL (I'm lazy) */
896 struct expression *left;
897 const char *left_var;
898 struct var_sym_list *left_vsl;
899 int comparison;
900 struct expression *right;
901 const char *right_var;
902 struct var_sym_list *right_vsl;
904 DECLARE_ALLOCATOR(compare_data);
905 struct smatch_state *alloc_compare_state(
906 struct expression *left,
907 const char *left_var, struct var_sym_list *left_vsl,
908 int comparison,
909 struct expression *right,
910 const char *right_var, struct var_sym_list *right_vsl);
911 int merge_comparisons(int one, int two);
912 int combine_comparisons(int left_compare, int right_compare);
913 int state_to_comparison(struct smatch_state *state);
914 struct smatch_state *merge_compare_states(struct smatch_state *s1, struct smatch_state *s2);
915 int get_comparison(struct expression *left, struct expression *right);
916 int get_comparison_strings(const char *one, const char *two);
917 int possible_comparison(struct expression *a, int comparison, struct expression *b);
918 struct state_list *get_all_comparisons(struct expression *expr);
919 struct state_list *get_all_possible_equal_comparisons(struct expression *expr);
920 void __add_return_comparison(struct expression *call, const char *range);
921 void __add_comparison_info(struct expression *expr, struct expression *call, const char *range);
922 char *get_printed_param_name(struct expression *call, const char *param_name, struct symbol *param_sym);
923 char *name_sym_to_param_comparison(const char *name, struct symbol *sym);
924 char *expr_equal_to_param(struct expression *expr, int ignore);
925 char *expr_lte_to_param(struct expression *expr, int ignore);
926 char *expr_param_comparison(struct expression *expr, int ignore);
927 int flip_comparison(int op);
928 int negate_comparison(int op);
929 int remove_unsigned_from_comparison(int op);
930 int param_compare_limit_is_impossible(struct expression *expr, int left_param, char *left_key, char *value);
931 void filter_by_comparison(struct range_list **rl, int comparison, struct range_list *right);
932 struct sm_state *comparison_implication_hook(struct expression *expr,
933 struct state_list **true_stack,
934 struct state_list **false_stack);
935 void __compare_param_limit_hook(struct expression *left_expr, struct expression *right_expr,
936 const char *state_name,
937 struct smatch_state *true_state, struct smatch_state *false_state);
940 /* smatch_sval.c */
941 sval_t *sval_alloc(sval_t sval);
942 sval_t *sval_alloc_permanent(sval_t sval);
943 sval_t sval_blank(struct expression *expr);
944 sval_t sval_type_val(struct symbol *type, long long val);
945 sval_t sval_from_val(struct expression *expr, long long val);
946 int sval_unsigned(sval_t sval);
947 int sval_signed(sval_t sval);
948 int sval_bits(sval_t sval);
949 int sval_bits_used(sval_t sval);
950 int sval_is_negative(sval_t sval);
951 int sval_is_positive(sval_t sval);
952 int sval_is_min(sval_t sval);
953 int sval_is_max(sval_t sval);
954 int sval_is_a_min(sval_t sval);
955 int sval_is_a_max(sval_t sval);
956 int sval_is_negative_min(sval_t sval);
957 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
958 int sval_cmp_val(sval_t one, long long val);
959 sval_t sval_min(sval_t one, sval_t two);
960 sval_t sval_max(sval_t one, sval_t two);
961 int sval_too_low(struct symbol *type, sval_t sval);
962 int sval_too_high(struct symbol *type, sval_t sval);
963 int sval_fits(struct symbol *type, sval_t sval);
964 sval_t sval_cast(struct symbol *type, sval_t sval);
965 sval_t sval_preop(sval_t sval, int op);
966 sval_t sval_binop(sval_t left, int op, sval_t right);
967 int sval_binop_overflows(sval_t left, int op, sval_t right);
968 unsigned long long fls_mask(unsigned long long uvalue);
969 unsigned long long sval_fls_mask(sval_t sval);
970 const char *sval_to_str(sval_t sval);
971 const char *sval_to_numstr(sval_t sval);
972 sval_t ll_to_sval(long long val);
974 /* smatch_string_list.c */
975 int list_has_string(struct string_list *str_list, const char *str);
976 void insert_string(struct string_list **str_list, const char *str);
977 struct string_list *clone_str_list(struct string_list *orig);
978 struct string_list *combine_string_lists(struct string_list *one, struct string_list *two);
980 /* smatch_start_states.c */
981 struct stree *get_start_states(void);
983 /* smatch_recurse.c */
984 int has_symbol(struct expression *expr, struct symbol *sym);
985 int has_variable(struct expression *expr, struct expression *var);
986 int has_inc_dec(struct expression *expr);
988 /* smatch_stored_conditions.c */
989 struct smatch_state *get_stored_condition(struct expression *expr);
990 struct expression_list *get_conditions(struct expression *expr);
991 struct sm_state *stored_condition_implication_hook(struct expression *expr,
992 struct state_list **true_stack,
993 struct state_list **false_stack);
995 /* check_string_len.c */
996 int get_formatted_string_size(struct expression *call, int arg);
998 /* smatch_param_set.c */
999 int param_was_set(struct expression *expr);
1000 int param_was_set_var_sym(const char *name, struct symbol *sym);
1001 /* smatch_param_filter.c */
1002 int param_has_filter_data(struct sm_state *sm);
1004 /* smatch_links.c */
1005 void set_up_link_functions(int id, int linkid);
1006 struct smatch_state *merge_link_states(struct smatch_state *s1, struct smatch_state *s2);
1007 void store_link(int link_id, const char *name, struct symbol *sym, const char *link_name, struct symbol *link_sym);
1009 /* smatch_auto_copy.c */
1010 void set_auto_copy(int owner);
1012 /* check_buf_comparison */
1013 struct expression *get_size_variable(struct expression *buf);
1014 struct expression *get_array_variable(struct expression *size);
1016 /* smatch_untracked_param.c */
1017 void mark_untracked(struct expression *expr, int param, const char *key, const char *value);
1018 void add_untracked_param_hook(void (func)(struct expression *call, int param));
1020 /* smatch_strings.c */
1021 struct state_list *get_strings(struct expression *expr);
1023 /* smatch_estate.c */
1024 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
1026 /* smatch_address.c */
1027 int get_address_rl(struct expression *expr, struct range_list **rl);
1028 int get_member_offset(struct symbol *type, const char *member_name);
1029 int get_member_offset_from_deref(struct expression *expr);
1031 /* for now this is in smatch_used_parameter.c */
1032 void __get_state_hook(int owner, const char *name, struct symbol *sym);
1034 /* smatch_buf_comparison.c */
1035 int db_var_is_array_limit(struct expression *array, const char *name, struct var_sym_list *vsl);
1037 struct stree *get_all_return_states(void);
1038 struct stree_stack *get_all_return_strees(void);
1039 int on_atomic_dec_path(void);
1040 int was_inced(const char *name, struct symbol *sym);
1042 /* smatch_constraints.c */
1043 char *get_constraint_str(struct expression *expr);
1044 struct constraint_list *get_constraints(struct expression *expr);
1045 char *unmet_constraint(struct expression *data, struct expression *offset);
1046 char *get_required_constraint(const char *data_str);
1048 /* smatch_container_of.c */
1049 int get_param_from_container_of(struct expression *expr);
1050 int get_offset_from_container_of(struct expression *expr);
1052 /* smatch_mtag.c */
1053 int get_toplevel_mtag(struct symbol *sym, mtag_t *tag);
1054 int get_mtag(struct expression *expr, mtag_t *tag);
1055 int get_mtag_offset(struct expression *expr);
1056 int create_mtag_alias(mtag_t tag, struct expression *expr, mtag_t *new);
1057 int expr_to_mtag_name_offset(struct expression *expr, mtag_t *tag, char **name, int *offset);
1058 void update_mtag_data(struct expression *expr);
1060 static inline int type_bits(struct symbol *type)
1062 if (!type)
1063 return 0;
1064 if (type->type == SYM_PTR) /* Sparse doesn't set this for &pointers */
1065 return bits_in_pointer;
1066 if (type->type == SYM_ARRAY)
1067 return bits_in_pointer;
1068 if (!type->examined)
1069 examine_symbol_type(type);
1070 return type->bit_size;
1073 static inline int type_unsigned(struct symbol *base_type)
1075 if (!base_type)
1076 return 0;
1077 if (base_type->ctype.modifiers & MOD_UNSIGNED)
1078 return 1;
1079 return 0;
1082 static inline int type_positive_bits(struct symbol *type)
1084 if (!type)
1085 return 0;
1086 if (type->type == SYM_ARRAY)
1087 return bits_in_pointer - 1;
1088 if (type_unsigned(type))
1089 return type_bits(type);
1090 return type_bits(type) - 1;
1093 static inline int sval_positive_bits(sval_t sval)
1095 return type_positive_bits(sval.type);
1099 * Returns -1 if one is smaller, 0 if they are the same and 1 if two is larger.
1101 static inline int sval_cmp(sval_t one, sval_t two)
1103 struct symbol *type;
1105 type = one.type;
1106 if (sval_positive_bits(two) > sval_positive_bits(one))
1107 type = two.type;
1108 if (type_bits(type) < 31)
1109 type = &int_ctype;
1111 one = sval_cast(type, one);
1112 two = sval_cast(type, two);
1114 if (type_unsigned(type)) {
1115 if (one.uvalue < two.uvalue)
1116 return -1;
1117 if (one.uvalue == two.uvalue)
1118 return 0;
1119 return 1;
1121 /* fix me handle type promotion and unsigned values */
1122 if (one.value < two.value)
1123 return -1;
1124 if (one.value == two.value)
1125 return 0;
1126 return 1;
1129 #endif /* !SMATCH_H_ */