slist: mangle the line number of merged states
[smatch.git] / smatch.h
blobca91e9ec11701ae8eef649c0a0a6e8bc2a237e56
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 struct smatch_state {
41 const char *name;
42 void *data;
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)
59 return (int)(long)p;
62 struct tracker {
63 char *name;
64 struct symbol *sym;
65 unsigned short owner;
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 */
72 struct sm_state {
73 const char *name;
74 struct symbol *sym;
75 unsigned short owner;
76 unsigned short merged:1;
77 unsigned short implied:1;
78 unsigned int nr_children;
79 unsigned int line;
80 struct smatch_state *state;
81 struct stree *pool;
82 struct sm_state *left;
83 struct sm_state *right;
84 struct state_list *possible;
87 struct var_sym {
88 char *var;
89 struct symbol *sym;
91 DECLARE_ALLOCATOR(var_sym);
92 DECLARE_PTR_LIST(var_sym_list, struct var_sym);
94 enum hook_type {
95 EXPR_HOOK,
96 STMT_HOOK,
97 STMT_HOOK_AFTER,
98 SYM_HOOK,
99 STRING_HOOK,
100 DECLARATION_HOOK,
101 ASSIGNMENT_HOOK,
102 RAW_ASSIGNMENT_HOOK,
103 GLOBAL_ASSIGNMENT_HOOK,
104 LOGIC_HOOK,
105 CONDITION_HOOK,
106 PRELOOP_HOOK,
107 SELECT_HOOK,
108 WHOLE_CONDITION_HOOK,
109 FUNCTION_CALL_HOOK,
110 CALL_HOOK_AFTER_INLINE,
111 FUNCTION_CALL_HOOK_AFTER_DB,
112 CALL_ASSIGNMENT_HOOK,
113 MACRO_ASSIGNMENT_HOOK,
114 BINOP_HOOK,
115 OP_HOOK,
116 DEREF_HOOK,
117 CASE_HOOK,
118 ASM_HOOK,
119 CAST_HOOK,
120 SIZEOF_HOOK,
121 BASE_HOOK,
122 FUNC_DEF_HOOK,
123 AFTER_DEF_HOOK,
124 END_FUNC_HOOK,
125 AFTER_FUNC_HOOK,
126 RETURN_HOOK,
127 INLINE_FN_START,
128 INLINE_FN_END,
129 END_FILE_HOOK,
130 NUM_HOOKS,
133 #define TRUE 1
134 #define FALSE 0
136 struct range_list;
138 void add_hook(void *func, enum hook_type type);
139 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
140 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
141 void add_merge_hook(int client_id, merge_func_t *func);
142 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
143 void add_pre_merge_hook(int client_id, void (*hook)(struct sm_state *sm));
144 typedef void (scope_hook)(void *data);
145 void add_scope_hook(scope_hook *hook, void *data);
146 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
147 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
148 struct expression *assign_expr, void *data);
149 typedef void (return_implies_hook)(struct expression *call_expr,
150 int param, char *key, char *value);
151 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list **rl);
152 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
154 void add_function_assign_hook(const char *look_for, func_hook *call_back,
155 void *info);
156 void add_implied_return_hook(const char *look_for,
157 implied_return_hook *call_back,
158 void *info);
159 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
160 void *info);
161 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
162 void *info);
163 void return_implies_state(const char *look_for, long long start, long long end,
164 implication_hook *call_back, void *info);
165 void select_return_states_hook(int type, return_implies_hook *callback);
166 void select_return_states_before(void (*fn)(void));
167 void select_return_states_after(void (*fn)(void));
168 int get_implied_return(struct expression *expr, struct range_list **rl);
169 void allocate_hook_memory(void);
171 struct modification_data {
172 struct smatch_state *prev;
173 struct expression *cur;
176 typedef void (modification_hook)(struct sm_state *sm, struct expression *mod_expr);
177 void add_modification_hook(int owner, modification_hook *call_back);
178 void add_indirect_modification_hook(int owner, modification_hook *call_back);
179 void add_modification_hook_late(int owner, modification_hook *call_back);
180 void add_indirect_modification_hook_late(int owner, modification_hook *call_back);
181 struct smatch_state *get_modification_state(struct expression *expr);
183 int outside_of_function(void);
184 const char *get_filename(void);
185 const char *get_base_file(void);
186 char *get_function(void);
187 int get_lineno(void);
188 extern int final_pass;
189 extern struct symbol *cur_func_sym;
190 extern int option_debug;
191 extern int local_debug;
192 extern int option_info;
193 extern char *trace_variable;
194 extern struct stree *global_states;
195 int is_silenced_function(void);
197 extern FILE *sm_outfd;
198 #define sm_printf(msg...) do { if (final_pass || option_debug || local_debug) fprintf(sm_outfd, msg); } while (0)
200 static inline void sm_prefix(void)
202 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
205 static inline void print_implied_debug_msg();
207 #define sm_msg(msg...) \
208 do { \
209 print_implied_debug_msg(); \
210 if (!option_debug && !final_pass && !local_debug) \
211 break; \
212 if (!option_info && is_silenced_function()) \
213 break; \
214 sm_prefix(); \
215 sm_printf(msg); \
216 sm_printf("\n"); \
217 } while (0)
219 #define local_debug(msg...) \
220 do { \
221 if (local_debug) \
222 sm_msg(msg); \
223 } while (0)
225 extern char *implied_debug_msg;
226 static inline void print_implied_debug_msg(void)
228 static struct symbol *last_printed = NULL;
230 if (!implied_debug_msg)
231 return;
232 if (last_printed == cur_func_sym)
233 return;
234 last_printed = cur_func_sym;
235 sm_msg("%s", implied_debug_msg);
238 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
240 #define sm_info(msg...) do { \
241 if (option_debug || (option_info && final_pass)) { \
242 sm_prefix(); \
243 sm_printf("info: "); \
244 sm_printf(msg); \
245 sm_printf("\n"); \
247 } while(0)
249 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
251 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
252 struct smatch_state *get_state_expr(int owner, struct expression *expr);
253 struct state_list *get_possible_states(int owner, const char *name,
254 struct symbol *sym);
255 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
256 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
257 struct smatch_state *state);
258 struct sm_state *set_state_expr(int owner, struct expression *expr,
259 struct smatch_state *state);
260 void delete_state(int owner, const char *name, struct symbol *sym);
261 void delete_state_expr(int owner, struct expression *expr);
262 void __delete_all_states_sym(struct symbol *sym);
263 void set_true_false_states(int owner, const char *name, struct symbol *sym,
264 struct smatch_state *true_state,
265 struct smatch_state *false_state);
266 void set_true_false_states_expr(int owner, struct expression *expr,
267 struct smatch_state *true_state,
268 struct smatch_state *false_state);
270 struct stree *get_all_states_from_stree(int owner, struct stree *source);
271 struct stree *get_all_states_stree(int id);
272 struct stree *__get_cur_stree(void);
273 int is_reachable(void);
275 /* smatch_helper.c */
276 char *alloc_string(const char *str);
277 void free_string(char *str);
278 void append(char *dest, const char *data, int buff_len);
279 void remove_parens(char *str);
280 struct smatch_state *alloc_state_num(int num);
281 struct smatch_state *alloc_state_str(const char *name);
282 struct smatch_state *alloc_state_expr(struct expression *expr);
283 struct expression *get_argument_from_call_expr(struct expression_list *args,
284 int num);
286 char *expr_to_var(struct expression *expr);
287 struct symbol *expr_to_sym(struct expression *expr);
288 char *expr_to_str(struct expression *expr);
289 char *expr_to_str_sym(struct expression *expr,
290 struct symbol **sym_ptr);
291 char *expr_to_var_sym(struct expression *expr,
292 struct symbol **sym_ptr);
293 char *expr_to_known_chunk_sym(struct expression *expr, struct symbol **sym);
294 char *expr_to_chunk_sym_vsl(struct expression *expr, struct symbol **sym, struct var_sym_list **vsl);
295 int get_complication_score(struct expression *expr);
297 int sym_name_is(const char *name, struct expression *expr);
298 int get_const_value(struct expression *expr, sval_t *sval);
299 int get_value(struct expression *expr, sval_t *val);
300 int get_implied_value(struct expression *expr, sval_t *val);
301 int get_implied_min(struct expression *expr, sval_t *sval);
302 int get_implied_max(struct expression *expr, sval_t *val);
303 int get_hard_max(struct expression *expr, sval_t *sval);
304 int get_fuzzy_min(struct expression *expr, sval_t *min);
305 int get_fuzzy_max(struct expression *expr, sval_t *max);
306 int get_absolute_min(struct expression *expr, sval_t *sval);
307 int get_absolute_max(struct expression *expr, sval_t *sval);
308 int parse_call_math(struct expression *expr, char *math, sval_t *val);
309 int parse_call_math_rl(struct expression *call, char *math, struct range_list **rl);
310 char *get_value_in_terms_of_parameter_math(struct expression *expr);
311 char *get_value_in_terms_of_parameter_math_var_sym(const char *var, struct symbol *sym);
312 int is_zero(struct expression *expr);
313 int known_condition_true(struct expression *expr);
314 int known_condition_false(struct expression *expr);
315 int implied_condition_true(struct expression *expr);
316 int implied_condition_false(struct expression *expr);
317 int can_integer_overflow(struct symbol *type, struct expression *expr);
319 int is_array(struct expression *expr);
320 struct expression *get_array_base(struct expression *expr);
321 struct expression *get_array_offset(struct expression *expr);
322 const char *show_state(struct smatch_state *state);
323 struct statement *get_expression_statement(struct expression *expr);
324 struct expression *strip_parens(struct expression *expr);
325 struct expression *strip_expr(struct expression *expr);
326 void scoped_state(int my_id, const char *name, struct symbol *sym);
327 int is_error_return(struct expression *expr);
328 int getting_address(void);
329 char *get_member_name(struct expression *expr);
330 char *get_fnptr_name(struct expression *expr);
331 int cmp_pos(struct position pos1, struct position pos2);
332 int positions_eq(struct position pos1, struct position pos2);
333 struct statement *get_current_statement(void);
334 struct statement *get_prev_statement(void);
335 int get_param_num_from_sym(struct symbol *sym);
336 int get_param_num(struct expression *expr);
337 int ms_since(struct timeval *start);
338 int parent_is_gone_var_sym(const char *name, struct symbol *sym);
339 int parent_is_gone(struct expression *expr);
340 int invert_op(int op);
341 int expr_equiv(struct expression *one, struct expression *two);
343 /* smatch_type.c */
344 struct symbol *get_real_base_type(struct symbol *sym);
345 int type_bytes(struct symbol *type);
346 struct symbol *get_pointer_type(struct expression *expr);
347 struct symbol *get_type(struct expression *expr);
348 int type_signed(struct symbol *base_type);
349 int expr_unsigned(struct expression *expr);
350 int expr_signed(struct expression *expr);
351 int returns_unsigned(struct symbol *base_type);
352 int is_pointer(struct expression *expr);
353 int returns_pointer(struct symbol *base_type);
354 sval_t sval_type_max(struct symbol *base_type);
355 sval_t sval_type_min(struct symbol *base_type);
356 int nr_bits(struct expression *expr);
357 int is_void_pointer(struct expression *expr);
358 int is_char_pointer(struct expression *expr);
359 int is_string(struct expression *expr);
360 int is_static(struct expression *expr);
361 int is_local_variable(struct expression *expr);
362 int types_equiv(struct symbol *one, struct symbol *two);
363 int fn_static(void);
364 const char *global_static();
365 struct symbol *cur_func_return_type(void);
366 struct symbol *get_arg_type(struct expression *fn, int arg);
367 struct symbol *get_member_type_from_key(struct expression *expr, char *key);
368 int is_struct(struct expression *expr);
369 char *type_to_str(struct symbol *type);
371 /* smatch_ignore.c */
372 void add_ignore(int owner, const char *name, struct symbol *sym);
373 int is_ignored(int owner, const char *name, struct symbol *sym);
375 /* smatch_var_sym */
376 struct var_sym *alloc_var_sym(const char *var, struct symbol *sym);
377 struct var_sym_list *expr_to_vsl(struct expression *expr);
378 void add_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
379 void add_var_sym_expr(struct var_sym_list **list, struct expression *expr);
380 void del_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
381 int in_var_sym_list(struct var_sym_list *list, const char *var, struct symbol *sym);
382 struct var_sym_list *clone_var_sym_list(struct var_sym_list *from_vsl);
383 void merge_var_sym_list(struct var_sym_list **dest, struct var_sym_list *src);
384 struct var_sym_list *combine_var_sym_lists(struct var_sym_list *one, struct var_sym_list *two);
385 void free_var_sym_list(struct var_sym_list **list);
386 void free_var_syms_and_list(struct var_sym_list **list);
388 /* smatch_tracker */
389 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
390 void add_tracker(struct tracker_list **list, int owner, const char *name,
391 struct symbol *sym);
392 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
393 void del_tracker(struct tracker_list **list, int owner, const char *name,
394 struct symbol *sym);
395 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
396 struct symbol *sym);
397 void free_tracker_list(struct tracker_list **list);
398 void free_trackers_and_list(struct tracker_list **list);
400 /* smatch_conditions */
401 int in_condition(void);
403 /* smatch_flow.c */
405 extern int __in_fake_assign;
406 void smatch (int argc, char **argv);
407 int inside_loop(void);
408 int definitely_inside_loop(void);
409 struct expression *get_switch_expr(void);
410 int in_expression_statement(void);
411 void __process_post_op_stack(void);
412 void set_parent_expr(struct expression *expr, struct expression *parent);
413 void __split_expr(struct expression *expr);
414 void __split_label_stmt(struct statement *stmt);
415 void __split_stmt(struct statement *stmt);
416 extern int __in_function_def;
417 extern int option_assume_loops;
418 extern int option_two_passes;
419 extern int option_no_db;
420 extern int option_file_output;
421 extern int option_time;
422 extern struct expression_list *big_expression_stack;
423 extern struct expression_list *big_condition_stack;
424 extern struct statement_list *big_statement_stack;
425 int is_assigned_call(struct expression *expr);
426 int inlinable(struct expression *expr);
427 extern int __inline_call;
428 extern struct expression *__inline_fn;
429 extern int __in_pre_condition;
430 extern int __bail_on_rest_of_function;
431 extern struct statement *__prev_stmt;
432 extern struct statement *__cur_stmt;
433 extern struct statement *__next_stmt;
435 /* smatch_struct_assignment.c */
436 struct expression *get_faked_expression(void);
437 void __fake_struct_member_assignments(struct expression *expr);
439 /* smatch_project.c */
440 int is_no_inline_function(const char *function);
442 /* smatch_conditions */
443 void __split_whole_condition(struct expression *expr);
444 void __handle_logic(struct expression *expr);
445 int is_condition(struct expression *expr);
446 int __handle_condition_assigns(struct expression *expr);
447 int __handle_select_assigns(struct expression *expr);
448 int __handle_expr_statement_assigns(struct expression *expr);
450 /* smatch_implied.c */
451 extern int option_debug_implied;
452 extern int option_debug_related;
453 struct range_list_stack;
454 void param_limit_implications(struct expression *expr, int param, char *key, char *value);
455 struct stree *__implied_case_stree(struct expression *switch_expr,
456 struct range_list *case_rl,
457 struct range_list_stack **remaining_cases,
458 struct stree **raw_stree);
459 void overwrite_states_using_pool(struct sm_state *sm);
460 int assume(struct expression *expr);
461 void end_assume(void);
463 /* smatch_extras.c */
464 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
465 extern int RETURN_ID;
467 struct data_range {
468 sval_t min;
469 sval_t max;
472 extern long long valid_ptr_min, valid_ptr_max;
473 extern sval_t valid_ptr_min_sval, valid_ptr_max_sval;
474 static const sval_t array_min_sval = {
475 .type = &ptr_ctype,
476 {.value = 100000},
478 static const sval_t array_max_sval = {
479 .type = &ptr_ctype,
480 {.value = 199999},
482 static const sval_t text_seg_min = {
483 .type = &ptr_ctype,
484 {.value = 100000000},
486 static const sval_t text_seg_max = {
487 .type = &ptr_ctype,
488 {.value = 177777777},
490 static const sval_t data_seg_min = {
491 .type = &ptr_ctype,
492 {.value = 200000000},
494 static const sval_t data_seg_max = {
495 .type = &ptr_ctype,
496 {.value = 277777777},
498 static const sval_t bss_seg_min = {
499 .type = &ptr_ctype,
500 {.value = 300000000},
502 static const sval_t bss_seg_max = {
503 .type = &ptr_ctype,
504 {.value = 377777777},
506 static const sval_t stack_seg_min = {
507 .type = &ptr_ctype,
508 {.value = 400000000},
510 static const sval_t stack_seg_max = {
511 .type = &ptr_ctype,
512 {.value = 477777777},
514 static const sval_t kmalloc_seg_min = {
515 .type = &ptr_ctype,
516 {.value = 500000000},
518 static const sval_t kmalloc_seg_max = {
519 .type = &ptr_ctype,
520 {.value = 577777777},
522 static const sval_t vmalloc_seg_min = {
523 .type = &ptr_ctype,
524 {.value = 600000000},
526 static const sval_t vmalloc_seg_max = {
527 .type = &ptr_ctype,
528 {.value = 677777777},
531 #define STRLEN_MAX_RET 1010101
533 /* smatch_absolute.c */
534 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
535 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
537 /* smatch_local_values.c */
538 int get_local_rl(struct expression *expr, struct range_list **rl);
539 int get_local_max_helper(struct expression *expr, sval_t *sval);
540 int get_local_min_helper(struct expression *expr, sval_t *sval);
542 /* smatch_type_value.c */
543 int get_db_type_rl(struct expression *expr, struct range_list **rl);
545 /* smatch_states.c */
546 void __swap_cur_stree(struct stree *stree);
547 void __push_fake_cur_stree();
548 struct stree *__pop_fake_cur_stree();
549 void __free_fake_cur_stree();
550 void __set_fake_cur_stree_fast(struct stree *stree);
551 void __pop_fake_cur_stree_fast(void);
552 void __merge_stree_into_cur(struct stree *stree);
554 int unreachable(void);
555 void __set_sm(struct sm_state *sm);
556 void __set_sm_cur_stree(struct sm_state *sm);
557 void __set_sm_fake_stree(struct sm_state *sm);
558 void __set_true_false_sm(struct sm_state *true_state,
559 struct sm_state *false_state);
560 void nullify_path(void);
561 void __match_nullify_path_hook(const char *fn, struct expression *expr,
562 void *unused);
563 void __unnullify_path(void);
564 int __path_is_null(void);
565 void save_all_states(void);
566 void restore_all_states(void);
567 void free_goto_stack(void);
568 void clear_all_states(void);
570 struct sm_state *get_sm_state(int owner, const char *name,
571 struct symbol *sym);
572 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
573 void __push_true_states(void);
574 void __use_false_states(void);
575 void __discard_false_states(void);
576 void __merge_false_states(void);
577 void __merge_true_states(void);
579 void __negate_cond_stacks(void);
580 void __use_pre_cond_states(void);
581 void __use_cond_true_states(void);
582 void __use_cond_false_states(void);
583 void __push_cond_stacks(void);
584 void __fold_in_set_states(void);
585 void __free_set_states(void);
586 struct stree *__copy_cond_true_states(void);
587 struct stree *__copy_cond_false_states(void);
588 struct stree *__pop_cond_true_stack(void);
589 struct stree *__pop_cond_false_stack(void);
590 void __and_cond_states(void);
591 void __or_cond_states(void);
592 void __save_pre_cond_states(void);
593 void __discard_pre_cond_states(void);
594 struct stree *__get_true_states(void);
595 struct stree *__get_false_states(void);
596 void __use_cond_states(void);
597 extern struct state_list *__last_base_slist;
599 void __push_continues(void);
600 void __discard_continues(void);
601 void __process_continues(void);
602 void __merge_continues(void);
604 void __push_breaks(void);
605 void __process_breaks(void);
606 int __has_breaks(void);
607 void __merge_breaks(void);
608 void __use_breaks(void);
610 void __save_switch_states(struct expression *switch_expr);
611 void __discard_switches(void);
612 void __merge_switches(struct expression *switch_expr, struct range_list *case_rl);
613 void __push_default(void);
614 void __set_default(void);
615 int __pop_default(void);
617 void __push_conditions(void);
618 void __discard_conditions(void);
620 void __save_gotos(const char *name);
621 void __merge_gotos(const char *name);
623 void __print_cur_stree(void);
625 /* smatch_hooks.c */
626 void __pass_to_client(void *data, enum hook_type type);
627 void __pass_to_client_no_data(enum hook_type type);
628 void __pass_case_to_client(struct expression *switch_expr,
629 struct range_list *rl);
630 int __has_merge_function(int client_id);
631 struct smatch_state *__client_merge_function(int owner,
632 struct smatch_state *s1,
633 struct smatch_state *s2);
634 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
635 void call_pre_merge_hook(struct sm_state *sm);
636 void __push_scope_hooks(void);
637 void __call_scope_hooks(void);
639 /* smatch_function_hooks.c */
640 void create_function_hook_hash(void);
641 void __match_initializer_call(struct symbol *sym);
643 /* smatch_db.c */
644 enum info_type {
645 INTERNAL = 0,
647 * Changing these numbers is a pain. Don't do it. If you ever use a
648 * number it can't be re-used right away so there may be gaps.
649 * We select these in order by type so if the order matters, then give
650 * it a number below 100-999,9000-9999 ranges. */
652 PARAM_CLEARED = 101,
653 PARAM_LIMIT = 103,
654 PARAM_FILTER = 104,
656 PARAM_VALUE = 1001,
657 BUF_SIZE = 1002,
658 USER_DATA = 1003,
659 CAPPED_DATA = 1004,
660 RETURN_VALUE = 1005,
661 DEREFERENCE = 1006,
662 RANGE_CAP = 1007,
663 LOCK_HELD = 1008,
664 LOCK_RELEASED = 1009,
665 ABSOLUTE_LIMITS = 1010,
666 PARAM_ADD = 1012,
667 PARAM_FREED = 1013,
668 DATA_SOURCE = 1014,
669 FUZZY_MAX = 1015,
670 STR_LEN = 1016,
671 ARRAY_LEN = 1017,
672 CAPABLE = 1018,
673 NS_CAPABLE = 1019,
674 TYPE_LINK = 1022,
675 UNTRACKED_PARAM = 1023,
676 CULL_PATH = 1024,
677 PARAM_SET = 1025,
678 PARAM_USED = 1026,
679 PARAM_COMPARE = 1028,
681 /* put random temporary stuff in the 7000-7999 range for testing */
682 USER_DATA3 = 8017,
683 USER_DATA_SET = 9018,
684 USER_DATA_LIMITED = 9019,
687 void debug_sql(const char *sql);
688 void debug_mem_sql(const char *sql);
689 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
690 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
691 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr));
692 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));
693 void select_call_implies_hook(int type, void (*callback)(struct expression *arg, char *key, char *value));
694 struct range_list *db_return_vals(struct expression *expr);
695 struct range_list *db_return_vals_from_str(const char *fn_name);
696 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym);
697 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl);
698 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym);
699 const char *get_param_name_var_sym(const char *name, struct symbol *sym);
700 const char *get_param_name(struct sm_state *sm);
701 char *get_data_info_name(struct expression *expr);
703 #define run_sql(call_back, data, sql...) \
704 do { \
705 char sql_txt[1024]; \
706 if (option_no_db) \
707 break; \
708 snprintf(sql_txt, 1024, sql); \
709 debug_sql(sql_txt); \
710 sql_exec(call_back, data, sql_txt); \
711 } while (0)
713 /* like run_sql() but for the in-memory database */
714 #define mem_sql(call_back, data, sql...) \
715 do { \
716 char sql_txt[1024]; \
718 snprintf(sql_txt, sizeof(sql_txt), sql); \
719 sm_debug("in-mem: %s\n", sql_txt); \
720 debug_mem_sql(sql_txt); \
721 sql_mem_exec(call_back, data, sql_txt); \
722 } while (0)
724 char *get_static_filter(struct symbol *sym);
726 void sql_insert_return_states(int return_id, const char *return_ranges,
727 int type, int param, const char *key, const char *value);
728 void sql_insert_caller_info(struct expression *call, int type, int param,
729 const char *key, const char *value);
730 void sql_insert_function_ptr(const char *fn, const char *struct_name);
731 void sql_insert_return_values(const char *return_values);
732 void sql_insert_call_implies(int type, int param, const char *key, const char *value);
733 void sql_insert_function_type_size(const char *member, const char *ranges);
734 void sql_insert_local_values(const char *name, const char *value);
735 void sql_insert_function_type_value(const char *type, const char *value);
736 void sql_insert_function_type_info(int param, const char *value);
737 void sql_insert_data_info(struct expression *data, int type, const char *value);
739 void sql_select_return_states(const char *cols, struct expression *call,
740 int (*callback)(void*, int, char**, char**), void *info);
741 void sql_select_caller_info(const char *cols, struct symbol *sym,
742 int (*callback)(void*, int, char**, char**));
743 void sql_select_call_implies(const char *cols, struct expression *call,
744 int (*callback)(void*, int, char**, char**));
746 void sql_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql);
747 void sql_mem_exec(int (*callback)(void*, int, char**, char**), void *data, const char *sql);
749 void open_smatch_db(void);
751 /* smatch_files.c */
752 int open_data_file(const char *filename);
753 struct token *get_tokens_file(const char *filename);
755 /* smatch.c */
756 extern char *option_debug_check;
757 extern char *option_project_str;
758 extern char *data_dir;
759 extern int option_no_data;
760 extern int option_spammy;
761 extern int option_full_path;
762 extern int option_param_mapper;
763 extern int option_call_tree;
764 extern int num_checks;
766 enum project_type {
767 PROJ_NONE,
768 PROJ_KERNEL,
769 PROJ_WINE,
771 extern enum project_type option_project;
772 const char *check_name(unsigned short id);
775 /* smatch_buf_size.c */
776 int get_array_size(struct expression *expr);
777 int get_array_size_bytes(struct expression *expr);
778 int get_array_size_bytes_min(struct expression *expr);
779 int get_array_size_bytes_max(struct expression *expr);
780 struct range_list *get_array_size_bytes_rl(struct expression *expr);
781 int get_real_array_size(struct expression *expr);
782 /* smatch_strlen.c */
783 int get_implied_strlen(struct expression *expr, struct range_list **rl);
784 int get_size_from_strlen(struct expression *expr);
786 /* smatch_capped.c */
787 int is_capped(struct expression *expr);
788 int is_capped_var_sym(const char *name, struct symbol *sym);
790 /* check_user_data.c */
791 int is_user_macro(struct expression *expr);
792 int is_user_data(struct expression *expr);
793 int is_capped_user_data(struct expression *expr);
794 int implied_user_data(struct expression *expr, struct range_list **rl);
795 int get_user_rl(struct expression *expr, struct range_list **rl);
796 int get_user_rl_var_sym(const char *name, struct symbol *sym, struct range_list **rl);
798 /* check_locking.c */
799 void print_held_locks();
801 /* check_assigned_expr.c */
802 struct expression *get_assigned_expr(struct expression *expr);
803 struct expression *get_assigned_expr_name_sym(const char *name, struct symbol *sym);
805 /* smatch_comparison.c */
806 struct compare_data {
807 const char *var1;
808 struct var_sym_list *vsl1;
809 int comparison;
810 const char *var2;
811 struct var_sym_list *vsl2;
813 int get_comparison(struct expression *left, struct expression *right);
814 int get_comparison_strings(const char *one, const char *two);
815 int possible_comparison(struct expression *a, int comparison, struct expression *b);
816 struct state_list *get_all_comparisons(struct expression *expr);
817 struct state_list *get_all_possible_equal_comparisons(struct expression *expr);
818 void __add_comparison_info(struct expression *expr, struct expression *call, const char *range);
819 char *name_sym_to_param_comparison(const char *name, struct symbol *sym);
820 char *expr_equal_to_param(struct expression *expr, int ignore);
821 char *expr_lte_to_param(struct expression *expr, int ignore);
822 char *expr_param_comparison(struct expression *expr, int ignore);
823 int flip_comparison(int op);
824 int negate_comparison(int op);
825 void filter_by_comparison(struct range_list **rl, int comparison, struct range_list *right);
826 struct sm_state *comparison_implication_hook(struct expression *expr,
827 struct state_list **true_stack,
828 struct state_list **false_stack);
830 /* smatch_sval.c */
831 sval_t *sval_alloc(sval_t sval);
832 sval_t *sval_alloc_permanent(sval_t sval);
833 sval_t sval_blank(struct expression *expr);
834 sval_t sval_type_val(struct symbol *type, long long val);
835 sval_t sval_from_val(struct expression *expr, long long val);
836 int sval_unsigned(sval_t sval);
837 int sval_signed(sval_t sval);
838 int sval_bits(sval_t sval);
839 int sval_bits_used(sval_t sval);
840 int sval_is_negative(sval_t sval);
841 int sval_is_positive(sval_t sval);
842 int sval_is_min(sval_t sval);
843 int sval_is_max(sval_t sval);
844 int sval_is_a_min(sval_t sval);
845 int sval_is_a_max(sval_t sval);
846 int sval_is_negative_min(sval_t sval);
847 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
848 int sval_cmp_val(sval_t one, long long val);
849 sval_t sval_min(sval_t one, sval_t two);
850 sval_t sval_max(sval_t one, sval_t two);
851 int sval_too_low(struct symbol *type, sval_t sval);
852 int sval_too_high(struct symbol *type, sval_t sval);
853 int sval_fits(struct symbol *type, sval_t sval);
854 sval_t sval_cast(struct symbol *type, sval_t sval);
855 sval_t sval_preop(sval_t sval, int op);
856 sval_t sval_binop(sval_t left, int op, sval_t right);
857 int sval_binop_overflows(sval_t left, int op, sval_t right);
858 unsigned long long fls_mask(unsigned long long uvalue);
859 unsigned long long sval_fls_mask(sval_t sval);
860 const char *sval_to_str(sval_t sval);
861 const char *sval_to_numstr(sval_t sval);
862 sval_t ll_to_sval(long long val);
864 /* smatch_string_list.c */
865 int list_has_string(struct string_list *str_list, const char *str);
866 void insert_string(struct string_list **str_list, const char *str);
867 struct string_list *clone_str_list(struct string_list *orig);
868 struct string_list *combine_string_lists(struct string_list *one, struct string_list *two);
870 /* smatch_start_states.c */
871 struct stree *get_start_states(void);
873 /* smatch_recurse.c */
874 int has_symbol(struct expression *expr, struct symbol *sym);
875 int has_variable(struct expression *expr, struct expression *var);
876 int has_inc_dec(struct expression *expr);
878 /* smatch_stored_conditions.c */
879 struct smatch_state *get_stored_condition(struct expression *expr);
880 struct sm_state *stored_condition_implication_hook(struct expression *expr,
881 struct state_list **true_stack,
882 struct state_list **false_stack);
884 /* check_string_len.c */
885 int get_formatted_string_size(struct expression *call, int arg);
887 /* smatch_param_set.c */
888 int param_was_set(struct expression *expr);
889 int param_was_set_var_sym(const char *name, struct symbol *sym);
890 /* smatch_param_filter.c */
891 int param_has_filter_data(struct sm_state *sm);
893 /* smatch_links.c */
894 void set_up_link_functions(int id, int linkid);
895 struct smatch_state *merge_link_states(struct smatch_state *s1, struct smatch_state *s2);
896 void store_link(int link_id, const char *name, struct symbol *sym, const char *link_name, struct symbol *link_sym);
898 /* smatch_auto_copy.c */
899 void set_auto_copy(int owner);
901 /* check_buf_comparison */
902 struct expression *get_size_variable(struct expression *buf);
904 /* smatch_untracked_param.c */
905 void add_untracked_param_hook(void (func)(struct expression *call, int param));
907 /* smatch_impossible.c */
908 int is_impossible_path(void);
910 /* smatch_strings.c */
911 struct state_list *get_strings(struct expression *expr);
913 /* smatch_estate.c */
914 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
916 /* smatch_address.c */
917 int get_address_rl(struct expression *expr, struct range_list **rl);
918 int get_member_offset(struct symbol *type, char *member_name);
919 int get_member_offset_from_deref(struct expression *expr);
921 /* for now this is in smatch_used_parameter.c */
922 void __get_state_hook(int owner, const char *name, struct symbol *sym);
924 /* smatch_buf_comparison.c */
925 int db_var_is_array_limit(struct expression *array, const char *name, struct var_sym_list *vsl);
927 struct stree *get_all_return_states(void);
928 struct stree_stack *get_all_return_strees(void);
930 static inline int type_bits(struct symbol *type)
932 if (!type)
933 return 0;
934 if (type->type == SYM_PTR) /* Sparse doesn't set this for &pointers */
935 return bits_in_pointer;
936 if (!type->examined)
937 examine_symbol_type(type);
938 return type->bit_size;
941 static inline int type_unsigned(struct symbol *base_type)
943 if (!base_type)
944 return 0;
945 if (base_type->ctype.modifiers & MOD_UNSIGNED)
946 return 1;
947 return 0;
950 static inline int type_positive_bits(struct symbol *type)
952 if (!type)
953 return 0;
954 // if (type->type == SYM_PTR)
955 // return bits_in_pointer;
956 if (type_unsigned(type))
957 return type_bits(type);
958 return type_bits(type) - 1;
961 static inline int sval_positive_bits(sval_t sval)
963 return type_positive_bits(sval.type);
967 * Returns -1 if one is smaller, 0 if they are the same and 1 if two is larger.
969 static inline int sval_cmp(sval_t one, sval_t two)
971 struct symbol *type;
973 type = one.type;
974 if (sval_positive_bits(two) > sval_positive_bits(one))
975 type = two.type;
976 if (type_bits(type) < 31)
977 type = &int_ctype;
979 one = sval_cast(type, one);
980 two = sval_cast(type, two);
982 if (type_unsigned(type)) {
983 if (one.uvalue < two.uvalue)
984 return -1;
985 if (one.uvalue == two.uvalue)
986 return 0;
987 return 1;
989 /* fix me handle type promotion and unsigned values */
990 if (one.value < two.value)
991 return -1;
992 if (one.value == two.value)
993 return 0;
994 return 1;
997 #endif /* !SMATCH_H_ */