points_to_user_data: handle some pointer math better
[smatch.git] / smatch.h
blobb3a708ad8bcec148355680677fa856890a17987a
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 <float.h>
25 #include <sys/time.h>
26 #include <sqlite3.h>
27 #include "lib.h"
28 #include "allocate.h"
29 #include "scope.h"
30 #include "parse.h"
31 #include "expression.h"
32 #include "avl.h"
33 #include "smatch_constants.h"
35 typedef long long mtag_t;
37 struct smatch_state {
38 const char *name;
39 void *data;
41 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
42 extern struct smatch_state undefined;
43 extern struct smatch_state merged;
44 extern struct smatch_state true_state;
45 extern struct smatch_state false_state;
46 DECLARE_ALLOCATOR(smatch_state);
48 static inline void *INT_PTR(int i)
50 return (void *)(long)i;
53 static inline int PTR_INT(void *p)
55 return (int)(long)p;
58 struct tracker {
59 char *name;
60 struct symbol *sym;
61 unsigned short owner;
63 DECLARE_ALLOCATOR(tracker);
64 DECLARE_PTR_LIST(tracker_list, struct tracker);
65 DECLARE_PTR_LIST(stree_stack, struct stree);
67 /* The first 3 struct members must match struct tracker */
68 struct sm_state {
69 const char *name;
70 struct symbol *sym;
71 unsigned short owner;
72 unsigned short merged:1;
73 unsigned short leaf:1;
74 unsigned int line;
75 struct smatch_state *state;
76 struct stree *pool;
77 struct sm_state *left;
78 struct sm_state *right;
79 struct state_list *possible;
82 struct var_sym {
83 char *var;
84 struct symbol *sym;
86 DECLARE_ALLOCATOR(var_sym);
87 DECLARE_PTR_LIST(var_sym_list, struct var_sym);
89 struct constraint {
90 int op;
91 int id;
93 DECLARE_PTR_LIST(constraint_list, struct constraint);
95 struct alloc_info {
96 const char *fn;
97 int size_param, nr;
99 extern struct alloc_info *alloc_funcs;
101 struct bit_info {
102 unsigned long long set;
103 unsigned long long possible;
106 enum hook_type {
107 EXPR_HOOK,
108 EXPR_HOOK_AFTER,
109 STMT_HOOK,
110 STMT_HOOK_AFTER,
111 SYM_HOOK,
112 STRING_HOOK,
113 DECLARATION_HOOK,
114 DECLARATION_HOOK_AFTER,
115 ASSIGNMENT_HOOK,
116 ASSIGNMENT_HOOK_AFTER,
117 RAW_ASSIGNMENT_HOOK,
118 GLOBAL_ASSIGNMENT_HOOK,
119 LOGIC_HOOK,
120 CONDITION_HOOK,
121 PRELOOP_HOOK,
122 POSTLOOP_HOOK,
123 AFTER_LOOP_NO_BREAKS,
124 SELECT_HOOK,
125 WHOLE_CONDITION_HOOK,
126 FUNCTION_CALL_HOOK_BEFORE,
127 FUNCTION_CALL_HOOK,
128 CALL_HOOK_AFTER_INLINE,
129 FUNCTION_CALL_HOOK_AFTER_DB,
130 CALL_ASSIGNMENT_HOOK,
131 MACRO_ASSIGNMENT_HOOK,
132 BINOP_HOOK,
133 OP_HOOK,
134 DEREF_HOOK,
135 CASE_HOOK,
136 ASM_HOOK,
137 CAST_HOOK,
138 SIZEOF_HOOK,
139 BASE_HOOK,
140 FUNC_DEF_HOOK,
141 AFTER_DEF_HOOK,
142 END_FUNC_HOOK,
143 AFTER_FUNC_HOOK,
144 RETURN_HOOK,
145 INLINE_FN_START,
146 INLINE_FN_END,
147 END_FILE_HOOK,
148 NUM_HOOKS,
151 #define TRUE 1
152 #define FALSE 0
154 struct range_list;
156 typedef void (void_fn)(void);
157 typedef void (expr_func)(struct expression *expr);
158 typedef void (stmt_func)(struct statement *stmt);
159 typedef void (sym_func)(struct symbol *sym);
160 typedef void (name_sym_hook)(struct expression *expr, const char *name, struct symbol *sym);
161 typedef void (sm_hook)(struct sm_state *sm, struct expression *mod_expr);
162 typedef void (string_hook)(struct expression *expr, const char *str);
163 DECLARE_PTR_LIST(void_fn_list, void_fn);
164 DECLARE_PTR_LIST(expr_fn_list, expr_func);
165 DECLARE_PTR_LIST(stmt_fn_list, stmt_func);
166 DECLARE_PTR_LIST(sym_fn_list, sym_func);
167 DECLARE_PTR_LIST(name_sym_fn_list, name_sym_hook);
168 DECLARE_PTR_LIST(string_hook_list, string_hook);
169 void call_void_fns(struct void_fn_list *list);
170 void call_expr_fns(struct expr_fn_list *list, struct expression *expr);
171 void call_stmt_fns(struct stmt_fn_list *list, struct statement *stmt);
172 void call_sym_fns(struct sym_fn_list *list, struct symbol *sym);
173 void call_name_sym_fns(struct name_sym_fn_list *list, struct expression *expr, const char *name, struct symbol *sym);
174 void call_string_hooks(struct string_hook_list *list, struct expression *expr, const char *str);
176 struct allocation_info {
177 const char *fn_name;
178 const char *size_str;
179 struct expression *total_size;
180 struct expression *nr_elems;
181 struct expression *elem_size;
182 long min, max;
183 bool zeroed;
184 bool safe; /* safe from overflows */
186 typedef void (alloc_hook)(struct expression *expr, const char *name, struct symbol *sym, struct allocation_info *info);
187 void add_allocation_hook(alloc_hook *func);
189 void add_hook(void *func, enum hook_type type);
190 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
191 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
192 void add_merge_hook(int client_id, merge_func_t *func);
193 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
194 void add_pre_merge_hook(int client_id, void (*hook)(struct sm_state *cur, struct sm_state *other));
195 typedef void (scope_hook)(void *data);
196 void add_scope_hook(scope_hook *hook, void *data);
197 void add_return_string_hook(string_hook *fn);
198 typedef void (param_key_hook)(struct expression *expr, const char *name, struct symbol *sym, void *data);
199 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
200 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
201 struct expression *assign_expr, void *data);
202 typedef void (return_implies_hook)(struct expression *call_expr,
203 int param, char *key, char *value);
204 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list **rl);
205 void add_function_hook_early(const char *look_for, func_hook *call_back, void *data);
206 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
207 void add_function_hook_late(const char *look_for, func_hook *call_back, void *info);
209 void add_function_assign_hook(const char *look_for, func_hook *call_back,
210 void *info);
211 void register_func_hooks_from_file(const char *file,
212 func_hook *call_back, void *info);
213 void register_assign_hooks_from_file(const char *file,
214 func_hook *call_back, void *info);
215 void add_implied_return_hook(const char *look_for,
216 implied_return_hook *call_back,
217 void *info);
218 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
219 void *info);
220 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
221 void *info);
222 void return_implies_state(const char *look_for, long long start, long long end,
223 implication_hook *call_back, void *info);
224 void return_implies_state_sval(const char *look_for, sval_t start, sval_t end,
225 implication_hook *call_back, void *info);
226 void return_implies_exact(const char *look_for, sval_t start, sval_t end,
227 implication_hook *call_back, void *info);
228 struct range_list *get_range_implications(const char *fn);
229 void select_return_states_hook(int type, return_implies_hook *callback);
230 void select_return_states_before(void (*fn)(void));
231 void select_return_states_after(void (*fn)(void));
232 void add_function_param_key_hook(const char *look_for, param_key_hook *call_back,
233 int param, const char *key, void *info);
234 void add_function_param_key_hook_early(const char *look_for, param_key_hook *call_back,
235 int param, const char *key, void *info);
236 void add_function_param_key_hook_late(const char *look_for, param_key_hook *call_back,
237 int param, const char *key, void *info);
238 void return_implies_param_key(const char *look_for, sval_t start, sval_t end,
239 param_key_hook *call_back,
240 int param, const char *key, void *info);
241 void return_implies_param_key_exact(const char *look_for, sval_t start, sval_t end,
242 param_key_hook *call_back,
243 int param, const char *key, void *info);
244 void select_return_param_key(int type, param_key_hook *callback);
245 bool get_implied_return(struct expression *expr, struct range_list **rl);
246 void allocate_hook_memory(void);
247 void allocate_tracker_array(int num_checks);
249 struct modification_data {
250 struct smatch_state *prev;
251 struct expression *cur;
254 void allocate_modification_hooks(void);
255 bool is_sub_member(const char *name, struct symbol *sym, struct sm_state *sm);
256 void add_all_modifications_hook(int owner, name_sym_hook *hook);
257 void add_modification_hook(int owner, sm_hook *call_back);
258 void add_modification_hook_late(int owner, sm_hook *call_back);
259 struct smatch_state *get_modification_state(struct expression *expr);
261 int outside_of_function(void);
262 const char *get_filename(void);
263 extern int base_file_stream;
264 const char *get_base_file(void);
265 unsigned long long get_file_id(void);
266 unsigned long long get_base_file_id(void);
267 char *get_function(void);
268 extern int __smatch_lineno;
269 int get_lineno(void);
270 extern int final_pass;
271 extern struct symbol *cur_func_sym;
272 extern int option_debug;
273 extern int local_debug;
274 extern int debug_db;
275 extern bool implied_debug;
276 bool debug_implied(void);
277 bool debug_on(const char *check_name, const char *var);
278 extern int option_info;
279 extern int option_spammy;
280 extern int option_pedantic;
281 extern int option_print_names;
282 extern char *trace_variable;
283 extern struct stree *global_states;
284 void set_function_skipped(void);
285 int is_skipped_function(void);
286 int is_silenced_function(void);
287 extern bool implications_off;
289 /* smatch_impossible.c */
290 int is_impossible_path(void);
291 void set_true_path_impossible(void);
292 void set_false_path_impossible(void);
293 void set_path_impossible(void);
295 extern FILE *sm_outfd;
296 extern FILE *sql_outfd;
297 extern FILE *caller_info_fd;
298 extern int sm_nr_checks;
299 extern int sm_nr_errors;
302 * How to use these routines:
304 * sm_fatal(): an internal error of some kind that should immediately exit
305 * sm_ierror(): an internal error
306 * sm_perror(): an internal error from parsing input source
307 * sm_error(): an error from input source
308 * sm_warning(): a warning from input source
309 * sm_info(): info message (from option_info)
310 * sm_debug(): debug message
311 * sm_msg(): other message (please avoid using this)
314 #define sm_printf(msg...) do { \
315 if (final_pass || option_debug || local_debug || debug_db) \
316 fprintf(sm_outfd, msg); \
317 } while (0)
319 static inline void sm_prefix(void)
321 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
322 if (option_info || !option_print_names)
323 return;
324 sm_printf("[smatch.%s] ", __CHECKNAME__);
327 static inline void print_implied_debug_msg();
329 extern bool __silence_warnings_for_stmt;
331 #define sm_print_msg(type, msg...) \
332 do { \
333 print_implied_debug_msg(); \
334 if (!final_pass && !option_debug && !local_debug && !debug_db) \
335 break; \
336 if (__silence_warnings_for_stmt && !option_debug && !local_debug) \
337 break; \
338 if (!option_info && is_silenced_function()) \
339 break; \
340 sm_prefix(); \
341 if (type == 1) { \
342 sm_printf("warn: "); \
343 sm_nr_checks++; \
344 } else if (type == 2) { \
345 sm_printf("error: "); \
346 sm_nr_checks++; \
347 } else if (type == 3) { \
348 sm_printf("parse error: "); \
349 sm_nr_errors++; \
350 } else if (type == 4) { \
351 sm_printf("pedantic: "); \
353 sm_printf(msg); \
354 sm_printf("\n"); \
355 } while (0)
357 #define sm_msg(msg...) do { sm_print_msg(0, msg); } while (0)
359 extern char *implied_debug_msg;
360 static inline void print_implied_debug_msg(void)
362 static struct symbol *last_printed = NULL;
364 if (!implied_debug_msg)
365 return;
366 if (last_printed == cur_func_sym)
367 return;
368 last_printed = cur_func_sym;
369 sm_msg("%s", implied_debug_msg);
372 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
373 #define db_debug(msg...) do { if (option_debug || debug_db) sm_printf(msg); } while (0)
375 #define sm_info(msg...) do { \
376 if (option_debug || (option_info && final_pass)) { \
377 sm_prefix(); \
378 sm_printf("info: "); \
379 sm_printf(msg); \
380 sm_printf("\n"); \
382 } while(0)
384 #define sm_warning(msg...) do { sm_print_msg(1, msg); } while (0)
385 #define sm_warning_line(line, msg...) do { \
386 int __orig = __smatch_lineno; \
387 __smatch_lineno = line; \
388 sm_print_msg(1, msg); \
389 __smatch_lineno = __orig; \
390 } while (0)
391 #define sm_error(msg...) do { sm_print_msg(2, msg); } while (0)
392 #define sm_perror(msg...) do { sm_print_msg(3, msg); } while (0)
393 #define sm_pedantic(msg...) do { if (option_pedantic) sm_print_msg(4, msg); } while (0)
395 static inline void sm_fatal(const char *fmt, ...)
397 va_list args;
399 va_start(args, fmt);
400 vfprintf(sm_outfd, fmt, args);
401 va_end(args);
403 fprintf(sm_outfd, "\n");
405 exit(1);
408 static inline void sm_ierror(const char *fmt, ...)
410 va_list args;
412 sm_nr_errors++;
414 fprintf(sm_outfd, "internal error: ");
416 va_start(args, fmt);
417 vfprintf(sm_outfd, fmt, args);
418 va_end(args);
420 fprintf(sm_outfd, "\n");
422 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
424 bool has_states(struct stree *stree, int owner);
425 struct smatch_state *__get_state(int owner, const char *name, struct symbol *sym);
426 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
427 struct smatch_state *get_state_expr(int owner, struct expression *expr);
428 bool has_possible_state(int owner, const char *name, struct symbol *sym, struct smatch_state *state);
429 bool expr_has_possible_state(int owner, struct expression *expr, struct smatch_state *state);
430 struct state_list *get_possible_states(int owner, const char *name,
431 struct symbol *sym);
432 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
433 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
434 struct smatch_state *state);
435 struct sm_state *set_state_expr(int owner, struct expression *expr,
436 struct smatch_state *state);
437 void __delete_state(int owner, const char *name, struct symbol *sym);
438 void __delete_all_states_sym(struct symbol *sym);
439 void set_true_false_states(int owner, const char *name, struct symbol *sym,
440 struct smatch_state *true_state,
441 struct smatch_state *false_state);
442 void set_true_false_states_expr(int owner, struct expression *expr,
443 struct smatch_state *true_state,
444 struct smatch_state *false_state);
446 struct stree *get_all_states_from_stree(int owner, struct stree *source);
447 struct stree *get_all_states_stree(int id);
448 struct stree *__get_cur_stree(void);
449 int is_reachable(void);
450 void add_get_state_hook(void (*fn)(int owner, const char *name, struct symbol *sym));
452 /* smatch_ssa.c */
453 char *ssa_name(const char *name);
454 void set_ssa_state(int owner, const char *name, struct symbol *sym, struct smatch_state *state);
455 void update_ssa_state(int owner, const char *name, struct symbol *sym,
456 struct smatch_state *state);
457 void update_ssa_sm(int owner, struct sm_state *sm, struct smatch_state *state);
458 void set_ssa_state_expr(int owner, struct expression *expr, struct smatch_state *state);
459 struct sm_state *get_ssa_sm_state(int owner, const char *name, struct symbol *sym);
460 struct sm_state *get_ssa_sm_state_expr(int owner, struct expression *expr);
461 struct smatch_state *get_ssa_state(int owner, const char *name, struct symbol *sym);
462 struct smatch_state *get_ssa_state_expr(int owner, struct expression *expr);
464 /* smatch_helper.c */
465 DECLARE_PTR_LIST(int_stack, int);
466 char *alloc_string(const char *str);
467 char *alloc_string_newline(const char *str);
468 void free_string(char *str);
469 void remove_parens(char *str);
470 struct smatch_state *alloc_state_num(int num);
471 struct smatch_state *alloc_state_str(const char *name);
472 struct smatch_state *merge_str_state(struct smatch_state *s1, struct smatch_state *s2);
473 struct smatch_state *alloc_state_expr(struct expression *expr);
474 struct expression *get_assigned_call(struct expression *expr);
475 struct expression *get_argument_from_call_expr(struct expression_list *args,
476 int num);
477 struct expression *get_array_expr(struct expression *expr);
479 char *expr_to_var(struct expression *expr);
480 struct symbol *expr_to_sym(struct expression *expr);
481 char *expr_to_str(struct expression *expr);
482 char *expr_to_str_sym(struct expression *expr,
483 struct symbol **sym_ptr);
484 char *expr_to_var_sym(struct expression *expr,
485 struct symbol **sym_ptr);
486 char *expr_to_known_chunk_sym(struct expression *expr, struct symbol **sym);
487 char *expr_to_chunk_sym_vsl(struct expression *expr, struct symbol **sym, struct var_sym_list **vsl);
488 int get_complication_score(struct expression *expr);
490 int sym_name_is(const char *name, struct expression *expr);
491 int get_const_value(struct expression *expr, sval_t *sval);
492 int get_value(struct expression *expr, sval_t *val);
493 int get_implied_value(struct expression *expr, sval_t *val);
494 int get_implied_value_fast(struct expression *expr, sval_t *sval);
495 int get_implied_min(struct expression *expr, sval_t *sval);
496 int get_implied_max(struct expression *expr, sval_t *val);
497 int get_hard_max(struct expression *expr, sval_t *sval);
498 int get_fuzzy_min(struct expression *expr, sval_t *min);
499 int get_fuzzy_max(struct expression *expr, sval_t *max);
500 int get_absolute_min(struct expression *expr, sval_t *sval);
501 int get_absolute_max(struct expression *expr, sval_t *sval);
502 int parse_call_math(struct expression *expr, char *math, sval_t *val);
503 int parse_call_math_rl(struct expression *call, const char *math, struct range_list **rl);
504 const char *get_allocation_math(struct expression *expr);
505 char *get_value_in_terms_of_parameter_math(struct expression *expr);
506 char *get_value_in_terms_of_parameter_math_var_sym(const char *var, struct symbol *sym);
507 int expr_is_zero(struct expression *expr);
508 int known_condition_true(struct expression *expr);
509 int known_condition_false(struct expression *expr);
510 int implied_condition_true(struct expression *expr);
511 int implied_condition_false(struct expression *expr);
512 int can_integer_overflow(struct symbol *type, struct expression *expr);
513 void clear_math_cache(void);
514 void set_fast_math_only(void);
515 void clear_fast_math_only(void);
517 int is_array(struct expression *expr);
518 struct expression *get_array_base(struct expression *expr);
519 struct expression *get_array_offset(struct expression *expr);
520 const char *show_state(struct smatch_state *state);
521 struct statement *get_expression_statement(struct expression *expr);
522 struct expression *strip__builtin_choose_expr(struct expression *expr);
523 struct expression *strip_Generic(struct expression *expr);
524 struct expression *strip_parens(struct expression *expr);
525 struct expression *strip_expr(struct expression *expr);
526 struct expression *strip_no_cast(struct expression *expr);
527 struct expression *strip_expr_set_parent(struct expression *expr);
528 void scoped_state(int my_id, const char *name, struct symbol *sym);
529 int is_error_return(struct expression *expr);
530 int getting_address(struct expression *expr);
531 int get_struct_and_member(struct expression *expr, const char **type, const char **member);
532 char *get_member_name(struct expression *expr);
533 char *get_fnptr_name(struct expression *expr);
534 int cmp_pos(struct position pos1, struct position pos2);
535 int positions_eq(struct position pos1, struct position pos2);
536 struct statement *get_current_statement(void);
537 struct statement *get_prev_statement(void);
538 struct expression *get_last_expr_from_expression_stmt(struct expression *expr);
540 enum { RET_SUCCESS, RET_FAIL, RET_UNKNOWN };
541 int success_fail_return(struct range_list *rl);
543 #define RETURN_VAR -1
544 #define LOCAL_SCOPE -2
545 #define FILE_SCOPE -3
546 #define GLOBAL_SCOPE -4
547 #define UNKNOWN_SCOPE -5
549 char *swap_names(const char *orig, const char *remove, const char *add);
550 char *get_param_var_sym_var_sym(const char *name, struct symbol *sym, struct expression *ret_expr, struct symbol **sym_p);
551 char *get_param_name_sym(struct expression *expr, struct symbol **sym_p);
552 int get_param_key_from_var_sym(const char *name, struct symbol *sym,
553 struct expression *ret_expr,
554 const char **key);
555 int get_param_key_from_sm(struct sm_state *sm, struct expression *ret_expr,
556 const char **key);
557 int get_param_key_from_expr(struct expression *expr, struct expression *ret_expr,
558 const char **key);
559 const char *get_param_key_swap_dollar(struct expression *expr);
560 int map_to_param(const char *name, struct symbol *sym);
561 int get_param_num_from_sym(struct symbol *sym);
562 int get_param_num(struct expression *expr);
563 struct symbol *get_param_sym_from_num(int num);
564 struct expression *map_container_of_to_simpler_expr_key(struct expression *expr, const char *orig_key, char **new_key);
565 const char *get_container_of_str(struct expression *expr);
566 bool get_offset_param(const char *ret_str, int *offset, int *param);
567 /* smatch_points_to_container.c */
568 struct expression *get_stored_container(struct expression *expr, int offset);
570 int ms_since(struct timeval *start);
571 int parent_is_gone_var_sym(const char *name, struct symbol *sym);
572 int parent_is_gone(struct expression *expr);
573 bool is_noderef_ptr(struct expression *expr);
574 int invert_op(int op);
575 int op_remove_assign(int op);
576 int expr_equiv(struct expression *one, struct expression *two);
577 void push_int(struct int_stack **stack, int num);
578 int pop_int(struct int_stack **stack);
579 bool macro_to_ul(const char *macro, unsigned long *val);
581 /* smatch_type.c */
582 struct symbol *get_real_base_type(struct symbol *sym);
583 int type_bytes(struct symbol *type);
584 int array_bytes(struct symbol *type);
585 struct symbol *get_pointer_type(struct expression *expr);
586 struct symbol *get_type(struct expression *expr);
587 struct symbol *get_comparison_type(struct expression *expr);
588 struct symbol *get_final_type(struct expression *expr);
589 struct symbol *get_promoted_type(struct symbol *left, struct symbol *right);
590 int type_signed(struct symbol *base_type);
591 int expr_unsigned(struct expression *expr);
592 int expr_signed(struct expression *expr);
593 int returns_unsigned(struct symbol *base_type);
594 int is_pointer(struct expression *expr);
595 bool is_void_ptr(struct symbol *type);
596 int returns_pointer(struct symbol *base_type);
597 sval_t sval_type_max(struct symbol *base_type);
598 sval_t sval_type_min(struct symbol *base_type);
599 int nr_bits(struct expression *expr);
600 int is_void_pointer(struct expression *expr);
601 int is_char_pointer(struct expression *expr);
602 int is_string(struct expression *expr);
603 bool is_struct_ptr(struct symbol *type);
604 int is_static(struct expression *expr);
605 bool is_local_variable(struct expression *expr);
606 int types_equiv(struct symbol *one, struct symbol *two);
607 bool type_fits(struct symbol *type, struct symbol *test);
608 int fn_static(void);
609 const char *global_static();
610 struct symbol *cur_func_return_type(void);
611 struct symbol *get_arg_type(struct expression *fn, int arg);
612 struct symbol *get_member_type_from_key(struct expression *expr, const char *key);
613 struct symbol *get_arg_type_from_key(struct expression *fn, int param, struct expression *arg, const char *key);
614 int is_struct(struct expression *expr);
615 char *type_to_str(struct symbol *type);
617 /* smatch_ignore.c */
618 void add_ignore(int owner, const char *name, struct symbol *sym);
619 int is_ignored(int owner, const char *name, struct symbol *sym);
620 void add_ignore_expr(int owner, struct expression *expr);
621 int is_ignored_expr(int owner, struct expression *expr);
623 /* smatch_var_sym */
624 struct smatch_state *alloc_var_sym_state(const char *var, struct symbol *sym);
625 struct var_sym *alloc_var_sym(const char *var, struct symbol *sym);
626 struct var_sym_list *expr_to_vsl(struct expression *expr);
627 void add_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
628 void add_var_sym_expr(struct var_sym_list **list, struct expression *expr);
629 void del_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
630 int in_var_sym_list(struct var_sym_list *list, const char *var, struct symbol *sym);
631 struct var_sym_list *clone_var_sym_list(struct var_sym_list *from_vsl);
632 void merge_var_sym_list(struct var_sym_list **dest, struct var_sym_list *src);
633 struct var_sym_list *combine_var_sym_lists(struct var_sym_list *one, struct var_sym_list *two);
634 int var_sym_lists_equiv(struct var_sym_list *one, struct var_sym_list *two);
635 void free_var_sym_list(struct var_sym_list **list);
636 void free_var_syms_and_list(struct var_sym_list **list);
638 /* smatch_tracker */
639 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
640 void add_tracker(struct tracker_list **list, int owner, const char *name,
641 struct symbol *sym);
642 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
643 void del_tracker(struct tracker_list **list, int owner, const char *name,
644 struct symbol *sym);
645 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
646 struct symbol *sym);
647 void free_tracker_list(struct tracker_list **list);
648 void free_trackers_and_list(struct tracker_list **list);
650 /* smatch_conditions */
651 int in_condition(void);
653 /* smatch_flow.c */
655 extern int __in_fake_assign;
656 extern int __in_fake_parameter_assign;
657 extern int __in_fake_struct_assign;
658 extern int __in_fake_var_assign;
659 extern int __in_builtin_overflow_func;
660 extern int __fake_state_cnt;
661 extern int in_fake_env;
662 bool is_fake_var_assign(struct expression *expr);
663 void smatch (struct string_list *filelist);
664 int inside_loop(void);
665 int definitely_inside_loop(void);
666 struct expression *get_switch_expr(void);
667 int in_expression_statement(void);
668 void __process_post_op_stack(void);
669 void __split_expr(struct expression *expr);
670 void __split_label_stmt(struct statement *stmt);
671 void __split_stmt(struct statement *stmt);
672 extern int __in_function_def;
673 extern int __in_unmatched_hook;
674 extern int option_assume_loops;
675 extern int option_two_passes;
676 extern int option_no_db;
677 extern int option_file_output;
678 extern int option_time;
679 extern int option_time_stmt;
680 extern struct expression_list *big_expression_stack;
681 extern struct expression_list *big_condition_stack;
682 extern struct statement_list *big_statement_stack;
683 int is_condition_call(struct expression *expr);
684 int is_assigned_call(struct expression *expr);
685 int is_fake_assigned_call(struct expression *expr);
686 void add_function_data(unsigned long *fn_data);
687 int inlinable(struct expression *expr);
688 extern int __inline_call;
689 extern struct expression *__inline_fn;
690 extern int __in_pre_condition;
691 extern int __bail_on_rest_of_function;
692 extern struct statement *__prev_stmt;
693 extern struct statement *__cur_stmt;
694 extern struct statement *__next_stmt;
695 void init_fake_env(void);
696 void end_fake_env(void);
697 int time_parsing_function(void);
698 bool taking_too_long(void);
699 struct statement *get_last_stmt(void);
700 int is_last_stmt(struct statement *cur_stmt);
702 /* smatch_struct_assignment.c */
703 struct expression *get_faked_expression(void);
704 void __fake_struct_member_assignments(struct expression *expr);
706 /* smatch_project.c */
707 int is_no_inline_function(const char *function);
709 /* smatch_conditions */
710 void __split_whole_condition(struct expression *expr);
711 void __handle_logic(struct expression *expr);
712 int is_condition(struct expression *expr);
713 int __handle_condition_assigns(struct expression *expr);
714 int __handle_select_assigns(struct expression *expr);
715 int __handle_expr_statement_assigns(struct expression *expr);
717 /* smatch_implied.c */
718 struct range_list_stack;
719 void param_limit_implications(struct expression *expr, int param, char *key, char *value, struct stree **implied);
720 struct stree *__implied_case_stree(struct expression *switch_expr,
721 struct range_list *case_rl,
722 struct range_list_stack **remaining_cases,
723 struct stree **raw_stree);
724 void overwrite_states_using_pool(struct sm_state *gate_sm, struct sm_state *pool_sm);
725 int assume(struct expression *expr);
726 void end_assume(void);
727 int impossible_assumption(struct expression *left, int op, sval_t sval);
729 /* smatch_slist.h */
730 bool has_dynamic_states(unsigned short owner);
731 void set_dynamic_states(unsigned short owner);
733 /* smatch_extras.c */
734 int in_warn_on_macro(void);
735 extern int SMATCH_EXTRA;
736 extern int RETURN_ID;
738 struct data_range {
739 sval_t min;
740 sval_t max;
743 char *get_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
744 char *map_call_to_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
745 char *map_long_to_short_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym, bool use_stack);
747 #define STRLEN_MAX_RET 1010101
749 /* smatch_absolute.c */
750 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
751 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
753 /* smatch_type_value.c */
754 void disable_type_val_lookups(void);
755 void enable_type_val_lookups(void);
756 void clear_type_value_cache(void);
757 int get_db_type_rl(struct expression *expr, struct range_list **rl);
759 /* smatch_data_val.c */
760 int get_mtag_rl(struct expression *expr, struct range_list **rl);
761 /* smatch_array_values.c */
762 void clear_array_values_cache(void);
763 int get_array_rl(struct expression *expr, struct range_list **rl);
765 /* smatch_states.c */
766 struct stree *__swap_cur_stree(struct stree *stree);
767 void __push_fake_cur_stree();
768 struct stree *__pop_fake_cur_stree();
769 void __free_fake_cur_stree();
770 void __set_fake_cur_stree_fast(struct stree *stree);
771 void __pop_fake_cur_stree_fast(void);
772 void __merge_stree_into_cur(struct stree *stree);
774 int unreachable(void);
775 void __set_cur_stree_readonly(void);
776 void __set_cur_stree_writable(void);
777 void __set_sm(struct sm_state *sm);
778 void __set_sm_cur_stree(struct sm_state *sm);
779 void __set_true_false_sm(struct sm_state *true_state,
780 struct sm_state *false_state);
781 void nullify_path(void);
782 void __match_nullify_path_hook(const char *fn, struct expression *expr,
783 void *unused);
784 void __unnullify_path(void);
785 int __path_is_null(void);
786 void save_all_states(void);
787 void restore_all_states(void);
788 void free_goto_stack(void);
789 void clear_all_states(void);
791 struct sm_state *get_sm_state(int owner, const char *name,
792 struct symbol *sym);
793 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
794 void __push_true_states(void);
795 void __use_false_states(void);
796 void __discard_false_states(void);
797 void __merge_false_states(void);
798 void __merge_true_states(void);
800 void __negate_cond_stacks(void);
801 void __use_pre_cond_states(void);
802 void __use_cond_true_states(void);
803 void __use_cond_false_states(void);
804 void __push_cond_stacks(void);
805 void __fold_in_set_states(void);
806 void __free_set_states(void);
807 struct stree *__copy_cond_true_states(void);
808 struct stree *__copy_cond_false_states(void);
809 struct stree *__pop_cond_true_stack(void);
810 struct stree *__pop_cond_false_stack(void);
811 void __and_cond_states(void);
812 void __or_cond_states(void);
813 void __save_pre_cond_states(void);
814 void __discard_pre_cond_states(void);
815 struct stree *__get_true_states(void);
816 struct stree *__get_false_states(void);
817 void __use_cond_states(void);
818 extern struct state_list *__last_base_slist;
820 void __push_continues(void);
821 void __discard_continues(void);
822 void __process_continues(void);
823 void __merge_continues(void);
825 void __push_breaks(void);
826 void __process_breaks(void);
827 int __has_breaks(void);
828 void __merge_breaks(void);
829 void __use_breaks(void);
831 void __save_switch_states(struct expression *switch_expr);
832 void __discard_switches(void);
833 int have_remaining_cases(void);
834 void __merge_switches(struct expression *switch_expr, struct range_list *case_rl);
835 void __push_default(void);
836 void __set_default(void);
837 bool __has_default_case(void);
838 int __pop_default(void);
840 void __push_conditions(void);
841 void __discard_conditions(void);
843 void __save_gotos(const char *name, struct symbol *sym);
844 void __merge_gotos(const char *name, struct symbol *sym);
846 void __discard_fake_states(struct expression *call);
848 void __print_cur_stree(void);
849 bool __print_states(const char *owner);
850 typedef void (check_tracker_hook)(int owner, const char *name, struct symbol *sym, struct smatch_state *state);
851 void add_check_tracker(const char *check_name, check_tracker_hook *fn);
853 /* smatch_hooks.c */
854 void __pass_to_client(void *data, enum hook_type type);
855 void __pass_case_to_client(struct expression *switch_expr,
856 struct range_list *rl);
857 int __has_merge_function(int client_id);
858 struct smatch_state *__client_merge_function(int owner,
859 struct smatch_state *s1,
860 struct smatch_state *s2);
861 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
862 void call_pre_merge_hook(struct sm_state *cur, struct sm_state *other);
863 void __push_scope_hooks(void);
864 void __call_scope_hooks(void);
865 void add_array_initialized_hook(void (*hook)(struct expression *array, int nr));
866 void __call_array_initialized_hooks(struct expression *array, int nr);
868 /* smatch_function_hooks.c */
869 void add_fake_call_after_return(struct expression *call);
870 void create_function_hook_hash(void);
871 void __match_initializer_call(struct symbol *sym);
873 struct expression *get_unfaked_call(void);
874 void fake_param_assign_helper(struct expression *call, struct expression *fake_assign);
876 /* smatch_db.c */
877 enum info_type {
878 INTERNAL = 0,
880 * Changing these numbers is a pain. Don't do it. If you ever use a
881 * number it can't be re-used right away so there may be gaps.
882 * We select these in order by type so if the order matters, then give
883 * it a number below 100-999,9000-9999 ranges. */
885 PARAM_LIMIT = 103,
886 PARAM_FILTER = 104,
888 RELEASE = 500,
889 BUF_CLEARED = 501,
891 PARAM_VALUE = 1001,
892 BUF_SIZE = 1002,
893 CAPPED_DATA = 1004,
894 RETURN_VALUE = 1005,
895 DEREFERENCE = 1006,
896 RANGE_CAP = 1007,
897 ABSOLUTE_LIMITS = 1010,
898 PARAM_ADD = 1012,
899 PARAM_FREED = 1013,
900 MAYBE_FREED = 2014,
901 DATA_SOURCE = 1014,
902 FUZZY_MAX = 1015,
903 HARD_MAX = 2015,
904 STR_LEN = 1016,
905 ARRAY_LEN = 1017,
906 CAPABLE = 1018,
907 NS_CAPABLE = 1019,
908 CONTAINER = 1020,
909 CASTED_CALL = 1021,
910 TYPE_LINK = 1022,
911 UNTRACKED_PARAM = 1023,
912 LOST_PARAM = 2023,
913 CULL_PATH = 1024,
914 PARAM_SET = 1025,
915 PARAM_USED = 1026,
916 BYTE_UNITS = 1027,
917 COMPARE_LIMIT = 1028,
918 PARAM_COMPARE = 1029,
919 CONSTRAINT = 1031,
920 PASSES_TYPE = 1032,
921 CONSTRAINT_REQUIRED = 1033,
922 BIT_INFO = 1034,
923 NOSPEC = 1035,
924 NOSPEC_WB = 1036,
925 STMT_CNT = 1037,
926 TERMINATED = 1038,
927 SLEEP = 1039,
928 FRESH_ALLOC = 1044,
929 ALLOCATOR = 1045,
930 FUNC_TIME = 1047,
931 POWER_OF_TWO = 1048,
932 POWER_OF_TWO_SET = 1049,
933 BIT_SET = 1051,
934 BIT_CLEAR = 1052,
935 BIT_IS_SET = 1053,
936 BIT_IS_CLEAR = 1054,
938 NEGATIVE_ERROR = 1057,
939 PREEMPT_ADD = 2054,
940 PREEMPT_SUB = 2055,
941 /* put random temporary stuff in the 7000-7999 range for testing */
942 HOST_DATA = 7016,
943 HOST_DATA_SET = 7017,
944 HOST_PTR = 7018,
945 HOST_PTR_SET = 7019,
946 USER_DATA = 8017,
947 USER_DATA_SET = 9017,
948 USER_PTR = 9018,
949 USER_PTR_SET = 9019,
950 NO_OVERFLOW = 8018,
951 NO_OVERFLOW_SIMPLE = 8019,
952 LOCK = 8020,
953 UNLOCK = 8021,
954 HALF_LOCKED = 9022,
955 RESTORE = 9023,
956 KNOWN_LOCKED = 9024,
957 KNOWN_UNLOCKED = 9025,
958 IGNORE_LOCK = 9026,
959 SET_FS = 8022,
960 ATOMIC_INC = 8023,
961 ATOMIC_DEC = 8024,
962 REFCOUNT_INIT = 9025,
963 REFCOUNT_INC = 9027,
964 REFCOUNT_DEC = 9028,
965 NO_SIDE_EFFECT = 8025,
966 FN_ARG_LINK = 8028,
967 DATA_VALUE = 8029,
968 ARRAYSIZE_ARG = 8033,
969 SIZEOF_ARG = 8034,
970 MEMORY_TAG = 8036,
971 MTAG_ASSIGN = 8035,
972 STRING_VALUE = 8041,
973 ALLOC = 8045,
975 BYTE_COUNT = 8050,
976 ELEM_COUNT = 8051,
977 ELEM_LAST = 8052,
978 USED_LAST = 8053,
979 USED_COUNT = 8054,
981 /* Do not use numbers above 100k */
984 extern struct sqlite3 *smatch_db;
985 extern struct sqlite3 *mem_db;
986 extern struct sqlite3 *cache_db;
988 bool db_incomplete(void);
989 void db_ignore_states(int id);
990 typedef bool (delete_hook)(struct expression *expr);
991 void add_delete_return_hook(delete_hook *hook);
992 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
993 void select_caller_name_sym(void (*fn)(const char *name, struct symbol *sym, char *value), int type);
994 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
995 void add_caller_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
996 void add_return_info_callback(int owner,
997 void (*callback)(int return_id, char *return_ranges,
998 struct expression *returned_expr,
999 int param,
1000 const char *printed_name,
1001 struct sm_state *sm));
1002 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr));
1003 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));
1004 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
1005 void select_return_implies_hook_early(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
1006 void select_return_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
1007 struct range_list *db_return_vals(struct expression *expr);
1008 struct range_list *db_return_vals_from_str(const char *fn_name);
1009 struct range_list *db_return_vals_no_args(struct expression *expr);
1010 bool split_param_key(const char *value, int *param, char *key, int len);
1011 bool get_implied_rl_from_call_str(struct expression *expr, const char *data, struct range_list **rl);
1012 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl);
1013 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym);
1014 char *get_name_sym_from_param_key(struct expression *expr, int param, const char *key, struct symbol **sym);
1015 char *get_param_name_var_sym(const char *name, struct symbol *sym);
1016 char *get_param_name(struct sm_state *sm);
1017 const char *get_mtag_name_var_sym(const char *state_name, struct symbol *sym);
1018 const char *get_mtag_name_expr(struct expression *expr);
1019 char *get_data_info_name(struct expression *expr);
1020 char *sm_to_arg_name(struct expression *expr, struct sm_state *sm);
1021 int is_recursive_member(const char *param_name);
1023 char *escape_newlines(const char *str);
1024 void sql_exec(struct sqlite3 *db, int (*callback)(void*, int, char**, char**), void *data, const char *sql);
1026 #define sql_helper(db, call_back, data, sql...) \
1027 do { \
1028 char sql_txt[1024]; \
1030 sqlite3_snprintf(sizeof(sql_txt), sql_txt, sql); \
1031 db_debug("debug: %s\n", sql_txt); \
1032 sql_exec(db, call_back, data, sql_txt); \
1033 } while (0)
1036 #define run_sql(call_back, data, sql...) \
1037 do { \
1038 if (option_no_db) \
1039 break; \
1040 sql_helper(smatch_db, call_back, data, sql); \
1041 } while (0)
1043 #define mem_sql(call_back, data, sql...) \
1044 sql_helper(mem_db, call_back, data, sql)
1046 #define cache_sql(call_back, data, sql...) \
1047 sql_helper(cache_db, call_back, data, sql)
1049 #define sql_insert_helper(table, db, ignore, late, values...) \
1050 do { \
1051 struct sqlite3 *_db = db; \
1053 if (__inline_fn && !_db) \
1054 _db = mem_db; \
1055 if (_db) { \
1056 char buf[1024]; \
1057 char *err, *p = buf; \
1058 int rc; \
1060 p += snprintf(p, buf + sizeof(buf) - p, \
1061 "insert %sinto %s values (", \
1062 ignore ? "or ignore " : "", #table); \
1063 p += snprintf(p, buf + sizeof(buf) - p, values); \
1064 p += snprintf(p, buf + sizeof(buf) - p, ");"); \
1065 db_debug("mem-db: %s\n", buf); \
1066 rc = sqlite3_exec(_db, buf, NULL, NULL, &err); \
1067 if (rc != SQLITE_OK) { \
1068 sm_ierror("SQL error #2: %s", err); \
1069 sm_ierror("SQL: '%s'", buf); \
1070 parse_error = 1; \
1072 break; \
1074 if (option_info) { \
1075 FILE *tmp_fd = sm_outfd; \
1076 sm_outfd = sql_outfd; \
1077 sm_prefix(); \
1078 sm_printf("SQL%s: insert %sinto " #table " values(", \
1079 late ? "_late" : "", ignore ? "or ignore " : ""); \
1080 sm_printf(values); \
1081 sm_printf(");\n"); \
1082 sm_outfd = tmp_fd; \
1084 } while (0)
1086 #define sql_insert(table, values...) sql_insert_helper(table, NULL, 0, 0, values);
1087 #define sql_insert_or_ignore(table, values...) sql_insert_helper(table, NULL, 1, 0, values);
1088 #define sql_insert_late(table, values...) sql_insert_helper(table, NULL, 0, 1, values);
1089 #define sql_insert_cache(table, values...) sql_insert_helper(table, cache_db, 1, 0, values);
1090 #define sql_insert_cache_or_ignore(table, values...) sql_insert_helper(table, cache_db, 1, 0, values);
1092 char *get_static_filter(struct symbol *sym);
1094 void sql_insert_return_states(int return_id, const char *return_ranges,
1095 int type, int param, const char *key, const char *value);
1096 void sql_insert_caller_info(struct expression *call, int type, int param,
1097 const char *key, const char *value);
1098 void sql_insert_function_ptr(const char *fn, const char *struct_name);
1099 void sql_insert_return_values(const char *return_values);
1100 void sql_insert_return_implies(int type, int param, const char *key, const char *value);
1101 void sql_insert_function_type_size(const char *member, const char *ranges);
1102 void sql_insert_function_type_info(int type, const char *struct_type, const char *member, const char *value);
1103 void sql_insert_type_info(int type, const char *member, const char *value);
1104 void sql_insert_local_values(const char *name, const char *value);
1105 void sql_insert_function_type_value(const char *type, const char *value);
1106 void sql_insert_function_type(int param, const char *value);
1107 void sql_insert_parameter_name(int param, const char *value);
1108 void sql_insert_data_info(struct expression *data, int type, const char *value);
1109 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value);
1110 void sql_save_constraint(const char *con);
1111 void sql_save_constraint_required(const char *data, int op, const char *limit);
1112 void sql_copy_constraint_required(const char *new_limit, const char *old_limit);
1113 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data);
1114 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value);
1115 void sql_insert_mtag_about(mtag_t tag, const char *left_name, const char *right_name);
1116 void sql_insert_mtag_info(mtag_t tag, int type, const char *value);
1117 void sql_insert_mtag_map(mtag_t container, int container_offset, mtag_t tag, int tag_offset);
1118 void sql_insert_mtag_alias(mtag_t orig, mtag_t alias);
1119 int mtag_map_select_container(mtag_t tag, int container_offset, mtag_t *container);
1120 int mtag_map_select_tag(mtag_t container, int offset, mtag_t *tag);
1121 struct smatch_state *get_mtag_return(struct expression *expr, struct smatch_state *state);
1122 struct range_list *swap_mtag_seed(struct expression *expr, struct range_list *rl);
1124 bool is_fn_ptr(struct expression *fn);
1125 void sql_select_return_states(const char *cols, struct expression *call,
1126 int (*callback)(void*, int, char**, char**), void *info);
1127 void sql_select_call_implies(const char *cols, struct expression *call,
1128 int (*callback)(void*, int, char**, char**));
1130 void open_smatch_db(char *db_file);
1132 /* smatch_files.c */
1133 int open_data_file(const char *filename);
1134 int open_schema_file(const char *schema);
1135 struct token *get_tokens_file(const char *filename);
1136 struct string_list *load_strings_from_file(const char *project, const char *filename);
1138 /* smatch.c */
1139 extern char *option_debug_check;
1140 extern char *option_debug_var;
1141 extern char *option_project_str;
1142 extern char *bin_dir;
1143 extern char *data_dir;
1144 extern int option_no_data;
1145 extern int option_full_path;
1146 extern int option_call_tree;
1147 extern int num_checks;
1149 enum project_type {
1150 PROJ_NONE,
1151 PROJ_KERNEL,
1152 PROJ_WINE,
1153 PROJ_ILLUMOS_KERNEL,
1154 PROJ_ILLUMOS_USER,
1155 PROJ_UNKNOWN,
1157 extern enum project_type option_project;
1158 const char *check_name(unsigned short id);
1159 int id_from_name(const char *name);
1162 /* smatch_buf_size.c */
1163 int bytes_to_elements(struct expression *expr, int bytes);
1164 int get_array_size(struct expression *expr);
1165 int get_array_size_bytes(struct expression *expr);
1166 int get_array_size_bytes_min(struct expression *expr);
1167 int get_array_size_bytes_max(struct expression *expr);
1168 struct range_list *get_array_size_bytes_rl(struct expression *expr);
1169 int get_real_array_size(struct expression *expr);
1170 int last_member_is_resizable(struct symbol *type);
1171 /* smatch_strlen.c */
1172 bool is_strlen(struct expression *expr);
1173 int get_implied_strlen(struct expression *expr, struct range_list **rl);
1174 int get_size_from_strlen(struct expression *expr);
1176 /* smatch_capped.c */
1177 int is_capped(struct expression *expr);
1178 int is_capped_var_sym(const char *name, struct symbol *sym);
1180 /* smatch_kernel_user_data.c */
1181 int is_user_macro(struct expression *expr);
1182 int is_capped_user_data(struct expression *expr);
1183 int implied_user_data(struct expression *expr, struct range_list **rl);
1184 struct stree *get_user_stree(void);
1185 int get_user_rl(struct expression *expr, struct range_list **rl);
1186 int is_user_rl(struct expression *expr);
1187 int get_user_rl_var_sym(const char *name, struct symbol *sym, struct range_list **rl);
1188 bool user_rl_capped_var_sym(const char *name, struct symbol *sym);
1189 bool user_rl_capped(struct expression *expr);
1190 struct range_list *var_user_rl(struct expression *expr);
1191 bool we_pass_user_data(struct expression *call);
1192 /* smatch_points_to_user_data.c */
1193 bool is_user_data_fn(struct symbol *fn);
1194 bool is_skb_data(struct expression *expr);
1195 bool is_socket_stuff(struct symbol *sym);
1196 bool points_to_user_data(struct expression *expr);
1197 void set_points_to_user_data(struct expression *expr, bool is_new);
1199 /* smatch_kernel_host_data.c */
1200 int is_host_macro(struct expression *expr);
1201 int get_host_data_fn_param(const char *fn);
1202 int is_capped_host_data(struct expression *expr);
1203 int implied_host_data(struct expression *expr, struct range_list **rl);
1204 struct stree *get_host_stree(void);
1205 int get_host_rl(struct expression *expr, struct range_list **rl);
1206 int is_host_rl(struct expression *expr);
1207 int get_host_rl_var_sym(const char *name, struct symbol *sym, struct range_list **rl);
1208 bool host_rl_capped(struct expression *expr);
1209 struct range_list *var_host_rl(struct expression *expr);
1210 bool we_pass_host_data(struct expression *call);
1211 /* smatch_points_to_host_data.c */
1212 bool is_host_data_fn(struct symbol *fn);
1213 bool points_to_host_data(struct expression *expr);
1214 void set_points_to_host_data(struct expression *expr, bool is_new);
1215 bool is_fn_points_to_host_data(char* fn);
1216 /* check_locking.c */
1217 void print_held_locks();
1218 /* preempt */
1219 void __preempt_add(void);
1220 void __preempt_sub(void);
1221 int get_preempt_cnt(void);
1222 void clear_preempt_cnt(void);
1223 bool function_decrements_preempt(void);
1224 void add_sleep_callback(expr_func *fn);
1225 unsigned long GFP_DIRECT_RECLAIM(void);
1226 unsigned long GFP_ATOMIC(void);
1228 /* check_assigned_expr.c */
1229 extern int check_assigned_expr_id;
1230 struct expression *get_assigned_expr(struct expression *expr);
1231 struct sm_state *get_assigned_sm(struct expression *expr);
1232 struct expression *get_assigned_expr_recurse(struct expression *expr);
1233 struct expression *get_assigned_expr_name_sym(const char *name, struct symbol *sym);
1234 struct expression *get_assigned_expr_name_sym_recurse(const char *name, struct symbol *sym);
1236 /* smatch_return_to_param.c */
1237 char *map_call_to_param_name_sym(struct expression *expr, struct symbol **sym);
1239 /* smatch_comparison.c */
1240 extern int comparison_id;
1241 #define UNKNOWN_COMPARISON 0
1242 #define IMPOSSIBLE_COMPARISON -1
1243 struct compare_data {
1244 /* The ->left and ->right expression pointers might be NULL (I'm lazy) */
1245 struct expression *left;
1246 const char *left_var;
1247 struct var_sym_list *left_vsl;
1248 int comparison;
1249 struct expression *right;
1250 const char *right_var;
1251 struct var_sym_list *right_vsl;
1253 DECLARE_ALLOCATOR(compare_data);
1254 struct smatch_state *alloc_compare_state(
1255 struct expression *left,
1256 const char *left_var, struct var_sym_list *left_vsl,
1257 int comparison,
1258 struct expression *right,
1259 const char *right_var, struct var_sym_list *right_vsl);
1260 int comparison_intersection(int orig, int op);
1261 int merge_comparisons(int one, int two);
1262 int combine_comparisons(int left_compare, int right_compare);
1263 int state_to_comparison(struct smatch_state *state);
1264 struct smatch_state *merge_compare_states(struct smatch_state *s1, struct smatch_state *s2);
1265 int get_comparison(struct expression *left, struct expression *right);
1266 int get_comparison_no_extra(struct expression *a, struct expression *b);
1267 int get_comparison_strings(const char *one, const char *two);
1268 int possible_comparison(struct expression *a, int comparison, struct expression *b);
1269 struct state_list *get_all_comparisons(struct expression *expr);
1270 struct state_list *get_all_possible_equal_comparisons(struct expression *expr);
1271 void __add_comparison_info(struct expression *expr, struct expression *call, const char *range);
1272 char *get_printed_param_name(struct expression *call, const char *param_name, struct symbol *param_sym);
1273 char *name_sym_to_param_comparison(const char *name, struct symbol *sym);
1274 char *expr_equal_to_param(struct expression *expr, int ignore);
1275 char *expr_lte_to_param(struct expression *expr, int ignore);
1276 char *expr_param_comparison(struct expression *expr, int ignore);
1277 int flip_comparison(int op);
1278 int negate_comparison(int op);
1279 int remove_unsigned_from_comparison(int op);
1280 int param_compare_limit_is_impossible(struct expression *expr, int left_param, char *left_key, char *value);
1281 void filter_by_comparison(struct range_list **rl, int comparison, struct range_list *right);
1282 void __compare_param_limit_hook(struct expression *left_expr, struct expression *right_expr,
1283 const char *state_name,
1284 struct smatch_state *true_state, struct smatch_state *false_state);
1285 int impossibly_high_comparison(struct expression *expr);
1286 void add_comparison_var_sym(
1287 struct expression *left_expr,
1288 const char *left_name, struct var_sym_list *left_vsl,
1289 int comparison,
1290 struct expression *right_expr,
1291 const char *right_name, struct var_sym_list *right_vsl,
1292 struct expression *mod_expr);
1294 /* smatch_sval.c */
1295 sval_t *sval_alloc(sval_t sval);
1296 sval_t *sval_alloc_permanent(sval_t sval);
1297 sval_t sval_blank(struct expression *expr);
1298 sval_t sval_type_val(struct symbol *type, long long val);
1299 sval_t sval_type_fval(struct symbol *type, long double fval);
1300 sval_t sval_from_val(struct expression *expr, long long val);
1301 sval_t sval_from_fval(struct expression *expr, long double fval);
1302 int sval_is_ptr(sval_t sval);
1303 bool sval_is_fp(sval_t sval);
1304 int sval_unsigned(sval_t sval);
1305 int sval_signed(sval_t sval);
1306 int sval_bits(sval_t sval);
1307 int sval_bits_used(sval_t sval);
1308 int sval_is_negative(sval_t sval);
1309 int sval_is_positive(sval_t sval);
1310 int sval_is_min(sval_t sval);
1311 int sval_is_max(sval_t sval);
1312 int sval_is_a_min(sval_t sval);
1313 int sval_is_a_max(sval_t sval);
1314 int sval_is_negative_min(sval_t sval);
1315 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
1316 int sval_cmp_val(sval_t one, long long val);
1317 sval_t sval_min(sval_t one, sval_t two);
1318 sval_t sval_min_nonneg(sval_t one, sval_t two);
1319 sval_t sval_max(sval_t one, sval_t two);
1320 int sval_too_low(struct symbol *type, sval_t sval);
1321 int sval_too_high(struct symbol *type, sval_t sval);
1322 int sval_fits(struct symbol *type, sval_t sval);
1323 sval_t sval_cast(struct symbol *type, sval_t sval);
1324 sval_t sval_preop(sval_t sval, int op);
1325 sval_t sval_binop(sval_t left, int op, sval_t right);
1326 int sval_binop_overflows(sval_t left, int op, sval_t right);
1327 int sval_binop_overflows_no_sign(sval_t left, int op, sval_t right);
1328 int find_first_zero_bit(unsigned long long uvalue);
1329 int sm_fls64(unsigned long long uvalue);
1330 unsigned long long fls_mask(unsigned long long uvalue);
1331 unsigned long long sval_fls_mask(sval_t sval);
1332 const char *sval_to_str(sval_t sval);
1333 const char *sval_to_str_or_err_ptr(sval_t sval);
1334 const char *sval_to_numstr(sval_t sval);
1335 sval_t ll_to_sval(long long val);
1337 /* smatch_string_list.c */
1338 int list_has_string(struct string_list *str_list, const char *str);
1339 int insert_string(struct string_list **str_list, const char *str);
1340 struct string_list *clone_str_list(struct string_list *orig);
1341 struct string_list *combine_string_lists(struct string_list *one, struct string_list *two);
1343 /* smatch_start_states.c */
1344 struct stree *get_start_states(void);
1346 /* smatch_recurse.c */
1347 int recurse(struct expression *expr,
1348 int (func)(struct expression *expr, void *p),
1349 void *param, int nr);
1350 int has_symbol(struct expression *expr, struct symbol *sym);
1351 int has_variable(struct expression *expr, struct expression *var);
1352 int has_inc_dec(struct expression *expr);
1354 /* smatch_stored_conditions.c */
1355 struct smatch_state *get_stored_condition(struct expression *expr);
1356 struct expression_list *get_conditions(struct expression *expr);
1357 struct sm_state *stored_condition_implication_hook(struct expression *expr,
1358 struct state_list **true_stack,
1359 struct state_list **false_stack);
1360 /* smatch_parsed_conditions.c */
1361 struct sm_state *parsed_condition_implication_hook(struct expression *expr,
1362 struct state_list **true_stack,
1363 struct state_list **false_stack);
1364 /* smatch_comparison.c */
1365 struct sm_state *comparison_implication_hook(struct expression *expr,
1366 struct state_list **true_stack,
1367 struct state_list **false_stack);
1369 /* check_string_len.c */
1370 int get_formatted_string_size(struct expression *call, int arg);
1371 int get_formatted_string_min_size(struct expression *call, int arg);
1373 /* smatch_param_set.c */
1374 int param_was_set(struct expression *expr);
1375 int param_was_set_var_sym(const char *name, struct symbol *sym);
1376 void print_limited_param_set(int return_id, char *return_ranges, struct expression *expr);
1377 /* param_clear */
1378 void __promote_sets_to_clears(int return_id, char *return_ranges, struct expression *expr);
1379 bool parent_was_PARAM_CLEAR(const char *name, struct symbol *sym);
1380 bool parent_was_PARAM_CLEAR_ZERO(const char *name, struct symbol *sym);
1382 /* smatch_param_filter.c */
1383 int param_has_filter_data(struct sm_state *sm);
1385 /* smatch_links.c */
1386 void set_up_link_functions(int id, int linkid);
1387 struct smatch_state *merge_link_states(struct smatch_state *s1, struct smatch_state *s2);
1388 void store_link(int link_id, const char *name, struct symbol *sym, const char *link_name, struct symbol *link_sym);
1390 /* check_buf_comparison */
1391 const char *limit_type_str(unsigned int limit_type);
1392 struct expression *get_size_variable(struct expression *buf, int *limit_type);
1393 struct expression *get_array_variable(struct expression *size);
1394 int buf_comparison_index_ok(struct expression *expr);
1395 bool buf_comp_has_bytes(struct expression *buf, struct expression *var);
1396 bool buf_comp2_has_bytes(struct expression *buf_expr, struct expression *var);
1398 /* smatch_untracked_param.c */
1399 void mark_untracked(struct expression *expr, int param, const char *key, const char *value);
1400 void add_untracked_param_hook(void (func)(struct expression *call, int param));
1401 void add_lost_param_hook(void (func)(struct expression *call, int param));
1402 void mark_all_params_untracked(int return_id, char *return_ranges, struct expression *expr);
1403 /* smatch_untracked_var.c */
1404 bool is_untracked(struct expression *expr);
1406 /* smatch_strings.c */
1407 struct state_list *get_strings(struct expression *expr);
1408 struct expression *fake_string_from_mtag(mtag_t tag);
1410 /* smatch_estate.c */
1411 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
1413 /* smatch_address.c */
1414 int get_address_rl(struct expression *expr, struct range_list **rl);
1415 int get_member_offset(struct symbol *type, const char *member_name);
1416 int get_member_offset_from_deref(struct expression *expr);
1418 /* for now this is in smatch_used_parameter.c */
1419 void __get_state_hook(int owner, const char *name, struct symbol *sym);
1420 extern int __ignore_param_used;
1422 /* smatch_buf_comparison.c */
1423 int db_var_is_array_limit(struct expression *array, const char *name, struct var_sym_list *vsl);
1425 struct range_list *get_fs(void);
1427 struct stree *get_all_return_states(void);
1428 struct stree_stack *get_all_return_strees(void);
1429 int on_atomic_dec_path(void);
1430 int was_inced(const char *name, struct symbol *sym);
1431 void set_refcount_inc(char *name, struct symbol *sym);
1432 void set_refcount_dec(char *name, struct symbol *sym);
1433 void add_refcount_init_hook(name_sym_hook *hook);
1434 void add_refcount_inc_hook(name_sym_hook *hook);
1435 void add_refcount_dec_hook(name_sym_hook *hook);
1437 /* smatch_constraints.c */
1438 char *get_constraint_str(struct expression *expr);
1439 struct constraint_list *get_constraints(struct expression *expr);
1440 char *unmet_constraint(struct expression *data, struct expression *offset);
1441 char *get_required_constraint(const char *data_str);
1443 /* smatch_container_of.c */
1444 int get_param_from_container_of(struct expression *expr);
1445 int get_offset_from_container_of(struct expression *expr);
1446 char *get_container_name(struct expression *container, struct expression *expr);
1448 /* smatch_mtag.c */
1449 unsigned long long str_to_llu_hash(const char *str);
1450 mtag_t str_to_mtag(const char *str);
1451 int get_string_mtag(struct expression *expr, mtag_t *tag);
1452 int get_toplevel_mtag(struct symbol *sym, mtag_t *tag);
1453 int create_mtag_alias(mtag_t tag, struct expression *expr, mtag_t *new);
1454 int expr_to_mtag_offset(struct expression *expr, mtag_t *tag, int *offset);
1455 void update_mtag_data(struct expression *expr, struct smatch_state *state);
1456 int get_mtag_sval(struct expression *expr, sval_t *sval);
1458 /* Trinity fuzzer stuff */
1459 const char *get_syscall_arg_type(struct symbol *sym);
1461 /* smatch_bits.c */
1462 int binfo_equiv(struct bit_info *one, struct bit_info *two);
1463 struct bit_info *alloc_bit_info(unsigned long long set, unsigned long long possible);
1464 struct smatch_state *alloc_bstate(unsigned long long set, unsigned long long possible);
1465 struct smatch_state *merge_bstates(struct smatch_state *one_state, struct smatch_state *two_state);
1467 /* smatch_param_bits_set.c */
1468 void __set_param_modified_helper(struct expression *expr, struct smatch_state *state);
1469 void __set_param_modified_helper_sym(const char *name, struct symbol *sym,
1470 struct smatch_state *state);
1472 /* smatch_param_bits_clear.c */
1473 void __set_param_modified_helper_clear(struct expression *expr, struct smatch_state *state);
1474 void __set_param_modified_helper_sym_clear(const char *name, struct symbol *sym,
1475 struct smatch_state *state);
1477 /* smatch_bit_info.c */
1478 struct bit_info *rl_to_binfo(struct range_list *rl);
1479 struct bit_info *get_bit_info(struct expression *expr);
1480 struct bit_info *get_bit_info_var_sym(const char *name, struct symbol *sym);
1482 /* smatch_mem_tracker.c */
1483 extern int option_mem;
1484 unsigned long get_mem_kb(void);
1485 unsigned long get_max_memory(void);
1487 /* smatch_goto_tracker.c */
1488 struct sm_state *get_goto_sm_state(void);
1490 /* check_is_nospec.c */
1491 bool is_nospec(struct expression *expr);
1492 long get_stmt_cnt(void);
1494 /* smatch_nul_terminator.c */
1495 bool is_nul_terminated_var_sym(const char *name, struct symbol *sym);
1496 bool is_nul_terminated(struct expression *expr);
1497 /* check_kernel.c */
1498 bool is_ignored_kernel_data(const char *name);
1499 int get_gfp_param(struct expression *expr);
1501 bool is_fresh_alloc_var_sym(const char *var, struct symbol *sym);
1502 bool is_fresh_alloc(struct expression *expr);
1503 bool is_freed_var_sym(const char *name, struct symbol *sym);
1504 void track_freed_param(struct expression *expr, struct smatch_state *state);
1505 void track_freed_param_var_sym(const char *name, struct symbol *sym,
1506 struct smatch_state *state);
1507 bool is_part_of_condition(struct expression *expr);
1508 bool is_percent_p_print(struct expression *expr);
1510 void add_free_hook(name_sym_hook *hook);
1512 /* smatch_unconstant_macros.c */
1513 int is_unconstant_macro(struct expression *expr);
1515 /* smatch_assigned_state.c */
1516 void add_state_assigned_hook(int owner, sm_hook *call_back);
1517 void add_ssa_state_assigned_hook(int owner, sm_hook *call_back);
1519 static inline bool type_is_ptr(struct symbol *type)
1521 return type &&
1522 (type->type == SYM_PTR ||
1523 type->type == SYM_ARRAY ||
1524 type->type == SYM_FN);
1527 static inline bool type_is_fp(struct symbol *type)
1529 return type &&
1530 (type == &float_ctype ||
1531 type == &double_ctype ||
1532 type == &ldouble_ctype);
1535 static inline int type_bits(struct symbol *type)
1537 if (!type)
1538 return 0;
1539 if (type_is_ptr(type))
1540 return bits_in_pointer;
1541 if (!type->examined)
1542 examine_symbol_type(type);
1543 return type->bit_size;
1546 static inline int type_unsigned(struct symbol *base_type)
1548 if (!base_type)
1549 return 0;
1550 if (is_ptr_type(base_type))
1551 return 1;
1552 if (base_type->ctype.modifiers & MOD_UNSIGNED)
1553 return 1;
1554 return 0;
1557 static inline int type_positive_bits(struct symbol *type)
1559 if (!type)
1560 return 0;
1561 if (is_ptr_type(type))
1562 return bits_in_pointer;
1563 if (type_unsigned(type))
1564 return type_bits(type);
1565 return type_bits(type) - 1;
1568 static inline int sval_positive_bits(sval_t sval)
1570 return type_positive_bits(sval.type);
1574 * Returns -1 if one is smaller, 0 if they are the same and 1 if two is larger.
1577 static inline int fp_cmp(sval_t one, sval_t two)
1579 struct symbol *type;
1581 if (sval_is_fp(one) && sval_is_fp(two))
1582 type = type_bits(one.type) > type_bits(two.type) ? one.type : two.type;
1583 else if (sval_is_fp(one))
1584 type = one.type;
1585 else
1586 type = two.type;
1588 one = sval_cast(type, one);
1589 two = sval_cast(type, two);
1591 if (one.type == &float_ctype) {
1592 if (one.fvalue < two.fvalue)
1593 return -1;
1594 if (one.fvalue == two.fvalue)
1595 return 0;
1596 return 1;
1598 if (one.type == &double_ctype) {
1599 if (one.dvalue < two.dvalue)
1600 return -1;
1601 if (one.dvalue == two.dvalue)
1602 return 0;
1603 return 1;
1605 if (one.type == &ldouble_ctype) {
1606 if (one.ldvalue < two.ldvalue)
1607 return -1;
1608 if (one.ldvalue == two.ldvalue)
1609 return 0;
1610 return 1;
1612 sm_perror("bad type in fp_cmp(): %s", type_to_str(type));
1613 return 1;
1616 static inline int sval_cmp(sval_t one, sval_t two)
1618 struct symbol *type;
1620 if (sval_is_fp(one) || sval_is_fp(two))
1621 return fp_cmp(one, two);
1623 type = one.type;
1624 if (sval_positive_bits(two) > sval_positive_bits(one))
1625 type = two.type;
1626 if (type_bits(type) < 31)
1627 type = &int_ctype;
1629 one = sval_cast(type, one);
1630 two = sval_cast(type, two);
1632 if (type_unsigned(type)) {
1633 if (one.uvalue < two.uvalue)
1634 return -1;
1635 if (one.uvalue == two.uvalue)
1636 return 0;
1637 return 1;
1639 /* fix me handle type promotion and unsigned values */
1640 if (one.value < two.value)
1641 return -1;
1642 if (one.value == two.value)
1643 return 0;
1644 return 1;
1647 #endif /* !SMATCH_H_ */