flow: strip out parentheses before faking a return
[smatch.git] / smatch.h
blobf6eb99a4b63899b298333c19bd63a480e838144f
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(const char *look_for, func_hook *call_back, void *data);
206 void add_function_hook_late(const char *look_for, func_hook *call_back, void *info);
208 void add_function_assign_hook(const char *look_for, func_hook *call_back,
209 void *info);
210 void register_func_hooks_from_file(const char *file,
211 func_hook *call_back, void *info);
212 void register_assign_hooks_from_file(const char *file,
213 func_hook *call_back, void *info);
214 void add_implied_return_hook(const char *look_for,
215 implied_return_hook *call_back,
216 void *info);
217 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
218 void *info);
219 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
220 void *info);
221 void return_implies_state(const char *look_for, long long start, long long end,
222 implication_hook *call_back, void *info);
223 void return_implies_state_sval(const char *look_for, sval_t start, sval_t end,
224 implication_hook *call_back, void *info);
225 void return_implies_exact(const char *look_for, sval_t start, sval_t end,
226 implication_hook *call_back, void *info);
227 struct range_list *get_range_implications(const char *fn);
228 void select_return_states_hook(int type, return_implies_hook *callback);
229 void select_return_states_before(void (*fn)(void));
230 void select_return_states_after(void (*fn)(void));
231 void add_function_param_key_hook(const char *look_for, param_key_hook *call_back,
232 int param, const char *key, void *info);
233 void add_function_param_key_hook_late(const char *look_for, param_key_hook *call_back,
234 int param, const char *key, void *info);
235 void return_implies_param_key(const char *look_for, sval_t start, sval_t end,
236 param_key_hook *call_back,
237 int param, const char *key, void *info);
238 void return_implies_param_key_exact(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 select_return_param_key(int type, param_key_hook *callback);
242 bool get_implied_return(struct expression *expr, struct range_list **rl);
243 void allocate_hook_memory(void);
244 void allocate_tracker_array(int num_checks);
246 struct modification_data {
247 struct smatch_state *prev;
248 struct expression *cur;
251 void allocate_modification_hooks(void);
252 bool is_sub_member(const char *name, struct symbol *sym, struct sm_state *sm);
253 void add_all_modifications_hook(int owner, name_sym_hook *hook);
254 void add_modification_hook(int owner, sm_hook *call_back);
255 void add_modification_hook_late(int owner, sm_hook *call_back);
256 struct smatch_state *get_modification_state(struct expression *expr);
258 int outside_of_function(void);
259 const char *get_filename(void);
260 extern int base_file_stream;
261 const char *get_base_file(void);
262 char *get_function(void);
263 int get_lineno(void);
264 extern int final_pass;
265 extern struct symbol *cur_func_sym;
266 extern int option_debug;
267 extern int local_debug;
268 extern int debug_db;
269 extern bool implied_debug;
270 bool debug_implied(void);
271 bool debug_on(const char *check_name, const char *var);
272 extern int option_info;
273 extern int option_spammy;
274 extern int option_pedantic;
275 extern int option_print_names;
276 extern char *trace_variable;
277 extern struct stree *global_states;
278 void set_function_skipped(void);
279 int is_skipped_function(void);
280 int is_silenced_function(void);
281 extern bool implications_off;
283 /* smatch_impossible.c */
284 int is_impossible_path(void);
285 void set_true_path_impossible(void);
286 void set_false_path_impossible(void);
287 void set_path_impossible(void);
289 extern FILE *sm_outfd;
290 extern FILE *sql_outfd;
291 extern FILE *caller_info_fd;
292 extern int sm_nr_checks;
293 extern int sm_nr_errors;
296 * How to use these routines:
298 * sm_fatal(): an internal error of some kind that should immediately exit
299 * sm_ierror(): an internal error
300 * sm_perror(): an internal error from parsing input source
301 * sm_error(): an error from input source
302 * sm_warning(): a warning from input source
303 * sm_info(): info message (from option_info)
304 * sm_debug(): debug message
305 * sm_msg(): other message (please avoid using this)
308 #define sm_printf(msg...) do { \
309 if (final_pass || option_debug || local_debug || debug_db) \
310 fprintf(sm_outfd, msg); \
311 } while (0)
313 static inline void sm_prefix(void)
315 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
316 if (option_info || !option_print_names)
317 return;
318 sm_printf("[smatch.%s] ", __CHECKNAME__);
321 static inline void print_implied_debug_msg();
323 extern bool __silence_warnings_for_stmt;
325 #define sm_print_msg(type, msg...) \
326 do { \
327 print_implied_debug_msg(); \
328 if (!final_pass && !option_debug && !local_debug && !debug_db) \
329 break; \
330 if (__silence_warnings_for_stmt && !option_debug && !local_debug) \
331 break; \
332 if (!option_info && is_silenced_function()) \
333 break; \
334 sm_prefix(); \
335 if (type == 1) { \
336 sm_printf("warn: "); \
337 sm_nr_checks++; \
338 } else if (type == 2) { \
339 sm_printf("error: "); \
340 sm_nr_checks++; \
341 } else if (type == 3) { \
342 sm_printf("parse error: "); \
343 sm_nr_errors++; \
344 } else if (type == 4) { \
345 sm_printf("pedantic: "); \
347 sm_printf(msg); \
348 sm_printf("\n"); \
349 } while (0)
351 #define sm_msg(msg...) do { sm_print_msg(0, msg); } while (0)
353 extern char *implied_debug_msg;
354 static inline void print_implied_debug_msg(void)
356 static struct symbol *last_printed = NULL;
358 if (!implied_debug_msg)
359 return;
360 if (last_printed == cur_func_sym)
361 return;
362 last_printed = cur_func_sym;
363 sm_msg("%s", implied_debug_msg);
366 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
367 #define db_debug(msg...) do { if (option_debug || debug_db) sm_printf(msg); } while (0)
369 #define sm_info(msg...) do { \
370 if (option_debug || (option_info && final_pass)) { \
371 sm_prefix(); \
372 sm_printf("info: "); \
373 sm_printf(msg); \
374 sm_printf("\n"); \
376 } while(0)
378 #define sm_warning(msg...) do { sm_print_msg(1, msg); } while (0)
379 #define sm_warning_line(line, msg...) do { \
380 int __orig = __smatch_lineno; \
381 __smatch_lineno = line; \
382 sm_print_msg(1, msg); \
383 __smatch_lineno = __orig; \
384 } while (0)
385 #define sm_error(msg...) do { sm_print_msg(2, msg); } while (0)
386 #define sm_perror(msg...) do { sm_print_msg(3, msg); } while (0)
387 #define sm_pedantic(msg...) do { if (option_pedantic) sm_print_msg(4, msg); } while (0)
389 static inline void sm_fatal(const char *fmt, ...)
391 va_list args;
393 va_start(args, fmt);
394 vfprintf(sm_outfd, fmt, args);
395 va_end(args);
397 fprintf(sm_outfd, "\n");
399 exit(1);
402 static inline void sm_ierror(const char *fmt, ...)
404 va_list args;
406 sm_nr_errors++;
408 fprintf(sm_outfd, "internal error: ");
410 va_start(args, fmt);
411 vfprintf(sm_outfd, fmt, args);
412 va_end(args);
414 fprintf(sm_outfd, "\n");
416 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
418 bool has_states(struct stree *stree, int owner);
419 struct smatch_state *__get_state(int owner, const char *name, struct symbol *sym);
420 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
421 struct smatch_state *get_state_expr(int owner, struct expression *expr);
422 bool has_possible_state(int owner, const char *name, struct symbol *sym, struct smatch_state *state);
423 bool expr_has_possible_state(int owner, struct expression *expr, struct smatch_state *state);
424 struct state_list *get_possible_states(int owner, const char *name,
425 struct symbol *sym);
426 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
427 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
428 struct smatch_state *state);
429 struct sm_state *set_state_expr(int owner, struct expression *expr,
430 struct smatch_state *state);
431 void __delete_state(int owner, const char *name, struct symbol *sym);
432 void __delete_all_states_sym(struct symbol *sym);
433 void set_true_false_states(int owner, const char *name, struct symbol *sym,
434 struct smatch_state *true_state,
435 struct smatch_state *false_state);
436 void set_true_false_states_expr(int owner, struct expression *expr,
437 struct smatch_state *true_state,
438 struct smatch_state *false_state);
440 struct stree *get_all_states_from_stree(int owner, struct stree *source);
441 struct stree *get_all_states_stree(int id);
442 struct stree *__get_cur_stree(void);
443 int is_reachable(void);
444 void add_get_state_hook(void (*fn)(int owner, const char *name, struct symbol *sym));
446 /* smatch_ssa.c */
447 char *ssa_name(const char *name);
448 void set_ssa_state(int owner, const char *name, struct symbol *sym, struct smatch_state *state);
449 void update_ssa_state(int owner, const char *name, struct symbol *sym,
450 struct smatch_state *state);
451 void update_ssa_sm(int owner, struct sm_state *sm, struct smatch_state *state);
452 void set_ssa_state_expr(int owner, struct expression *expr, struct smatch_state *state);
453 struct sm_state *get_ssa_sm_state(int owner, const char *name, struct symbol *sym);
454 struct sm_state *get_ssa_sm_state_expr(int owner, struct expression *expr);
455 struct smatch_state *get_ssa_state(int owner, const char *name, struct symbol *sym);
456 struct smatch_state *get_ssa_state_expr(int owner, struct expression *expr);
458 /* smatch_helper.c */
459 DECLARE_PTR_LIST(int_stack, int);
460 char *alloc_string(const char *str);
461 char *alloc_string_newline(const char *str);
462 void free_string(char *str);
463 void remove_parens(char *str);
464 struct smatch_state *alloc_state_num(int num);
465 struct smatch_state *alloc_state_str(const char *name);
466 struct smatch_state *merge_str_state(struct smatch_state *s1, struct smatch_state *s2);
467 struct smatch_state *alloc_state_expr(struct expression *expr);
468 struct expression *get_assigned_call(struct expression *expr);
469 struct expression *get_argument_from_call_expr(struct expression_list *args,
470 int num);
471 struct expression *get_array_expr(struct expression *expr);
473 char *expr_to_var(struct expression *expr);
474 struct symbol *expr_to_sym(struct expression *expr);
475 char *expr_to_str(struct expression *expr);
476 char *expr_to_str_sym(struct expression *expr,
477 struct symbol **sym_ptr);
478 char *expr_to_var_sym(struct expression *expr,
479 struct symbol **sym_ptr);
480 char *expr_to_known_chunk_sym(struct expression *expr, struct symbol **sym);
481 char *expr_to_chunk_sym_vsl(struct expression *expr, struct symbol **sym, struct var_sym_list **vsl);
482 int get_complication_score(struct expression *expr);
484 int sym_name_is(const char *name, struct expression *expr);
485 int get_const_value(struct expression *expr, sval_t *sval);
486 int get_value(struct expression *expr, sval_t *val);
487 int get_implied_value(struct expression *expr, sval_t *val);
488 int get_implied_value_fast(struct expression *expr, sval_t *sval);
489 int get_implied_min(struct expression *expr, sval_t *sval);
490 int get_implied_max(struct expression *expr, sval_t *val);
491 int get_hard_max(struct expression *expr, sval_t *sval);
492 int get_fuzzy_min(struct expression *expr, sval_t *min);
493 int get_fuzzy_max(struct expression *expr, sval_t *max);
494 int get_absolute_min(struct expression *expr, sval_t *sval);
495 int get_absolute_max(struct expression *expr, sval_t *sval);
496 int parse_call_math(struct expression *expr, char *math, sval_t *val);
497 int parse_call_math_rl(struct expression *call, const char *math, struct range_list **rl);
498 const char *get_allocation_math(struct expression *expr);
499 char *get_value_in_terms_of_parameter_math(struct expression *expr);
500 char *get_value_in_terms_of_parameter_math_var_sym(const char *var, struct symbol *sym);
501 int expr_is_zero(struct expression *expr);
502 int known_condition_true(struct expression *expr);
503 int known_condition_false(struct expression *expr);
504 int implied_condition_true(struct expression *expr);
505 int implied_condition_false(struct expression *expr);
506 int can_integer_overflow(struct symbol *type, struct expression *expr);
507 void clear_math_cache(void);
508 void set_fast_math_only(void);
509 void clear_fast_math_only(void);
511 int is_array(struct expression *expr);
512 struct expression *get_array_base(struct expression *expr);
513 struct expression *get_array_offset(struct expression *expr);
514 const char *show_state(struct smatch_state *state);
515 struct statement *get_expression_statement(struct expression *expr);
516 struct expression *strip_parens(struct expression *expr);
517 struct expression *strip_expr(struct expression *expr);
518 struct expression *strip_no_cast(struct expression *expr);
519 struct expression *strip_expr_set_parent(struct expression *expr);
520 void scoped_state(int my_id, const char *name, struct symbol *sym);
521 int is_error_return(struct expression *expr);
522 int getting_address(struct expression *expr);
523 int get_struct_and_member(struct expression *expr, const char **type, const char **member);
524 char *get_member_name(struct expression *expr);
525 char *get_fnptr_name(struct expression *expr);
526 int cmp_pos(struct position pos1, struct position pos2);
527 int positions_eq(struct position pos1, struct position pos2);
528 struct statement *get_current_statement(void);
529 struct statement *get_prev_statement(void);
530 struct expression *get_last_expr_from_expression_stmt(struct expression *expr);
532 enum { RET_SUCCESS, RET_FAIL, RET_UNKNOWN };
533 int success_fail_return(struct range_list *rl);
535 #define RETURN_VAR -1
536 #define LOCAL_SCOPE -2
537 #define FILE_SCOPE -3
538 #define GLOBAL_SCOPE -4
539 #define UNKNOWN_SCOPE -5
541 char *swap_names(const char *orig, const char *remove, const char *add);
542 char *get_param_var_sym_var_sym(const char *name, struct symbol *sym, struct expression *ret_expr, struct symbol **sym_p);
543 char *get_param_name_sym(struct expression *expr, struct symbol **sym_p);
544 int get_param_key_from_var_sym(const char *name, struct symbol *sym,
545 struct expression *ret_expr,
546 const char **key);
547 int get_param_key_from_sm(struct sm_state *sm, struct expression *ret_expr,
548 const char **key);
549 int get_param_key_from_expr(struct expression *expr, struct expression *ret_expr,
550 const char **key);
551 int map_to_param(const char *name, struct symbol *sym);
552 int get_param_num_from_sym(struct symbol *sym);
553 int get_param_num(struct expression *expr);
554 struct symbol *get_param_sym_from_num(int num);
555 struct expression *map_container_of_to_simpler_expr_key(struct expression *expr, const char *orig_key, char **new_key);
556 const char *get_container_of_str(struct expression *expr);
557 bool get_offset_param(const char *ret_str, int *offset, int *param);
558 /* smatch_points_to_container.c */
559 struct expression *get_stored_container(struct expression *expr, int offset);
561 int ms_since(struct timeval *start);
562 int parent_is_gone_var_sym(const char *name, struct symbol *sym);
563 int parent_is_gone(struct expression *expr);
564 bool is_noderef_ptr(struct expression *expr);
565 int invert_op(int op);
566 int op_remove_assign(int op);
567 int expr_equiv(struct expression *one, struct expression *two);
568 void push_int(struct int_stack **stack, int num);
569 int pop_int(struct int_stack **stack);
570 bool macro_to_ul(const char *macro, unsigned long *val);
572 /* smatch_type.c */
573 struct symbol *get_real_base_type(struct symbol *sym);
574 int type_bytes(struct symbol *type);
575 int array_bytes(struct symbol *type);
576 struct symbol *get_pointer_type(struct expression *expr);
577 struct symbol *get_type(struct expression *expr);
578 struct symbol *get_comparison_type(struct expression *expr);
579 struct symbol *get_final_type(struct expression *expr);
580 struct symbol *get_promoted_type(struct symbol *left, struct symbol *right);
581 int type_signed(struct symbol *base_type);
582 int expr_unsigned(struct expression *expr);
583 int expr_signed(struct expression *expr);
584 int returns_unsigned(struct symbol *base_type);
585 int is_pointer(struct expression *expr);
586 int returns_pointer(struct symbol *base_type);
587 sval_t sval_type_max(struct symbol *base_type);
588 sval_t sval_type_min(struct symbol *base_type);
589 int nr_bits(struct expression *expr);
590 int is_void_pointer(struct expression *expr);
591 int is_char_pointer(struct expression *expr);
592 int is_string(struct expression *expr);
593 bool is_struct_ptr(struct symbol *type);
594 int is_static(struct expression *expr);
595 bool is_local_variable(struct expression *expr);
596 int types_equiv(struct symbol *one, struct symbol *two);
597 bool type_fits(struct symbol *type, struct symbol *test);
598 int fn_static(void);
599 const char *global_static();
600 struct symbol *cur_func_return_type(void);
601 struct symbol *get_arg_type(struct expression *fn, int arg);
602 struct symbol *get_member_type_from_key(struct expression *expr, const char *key);
603 struct symbol *get_arg_type_from_key(struct expression *fn, int param, struct expression *arg, const char *key);
604 int is_struct(struct expression *expr);
605 char *type_to_str(struct symbol *type);
607 /* smatch_ignore.c */
608 void add_ignore(int owner, const char *name, struct symbol *sym);
609 int is_ignored(int owner, const char *name, struct symbol *sym);
610 void add_ignore_expr(int owner, struct expression *expr);
611 int is_ignored_expr(int owner, struct expression *expr);
613 /* smatch_var_sym */
614 struct smatch_state *alloc_var_sym_state(const char *var, struct symbol *sym);
615 struct var_sym *alloc_var_sym(const char *var, struct symbol *sym);
616 struct var_sym_list *expr_to_vsl(struct expression *expr);
617 void add_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
618 void add_var_sym_expr(struct var_sym_list **list, struct expression *expr);
619 void del_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
620 int in_var_sym_list(struct var_sym_list *list, const char *var, struct symbol *sym);
621 struct var_sym_list *clone_var_sym_list(struct var_sym_list *from_vsl);
622 void merge_var_sym_list(struct var_sym_list **dest, struct var_sym_list *src);
623 struct var_sym_list *combine_var_sym_lists(struct var_sym_list *one, struct var_sym_list *two);
624 int var_sym_lists_equiv(struct var_sym_list *one, struct var_sym_list *two);
625 void free_var_sym_list(struct var_sym_list **list);
626 void free_var_syms_and_list(struct var_sym_list **list);
628 /* smatch_tracker */
629 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
630 void add_tracker(struct tracker_list **list, int owner, const char *name,
631 struct symbol *sym);
632 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
633 void del_tracker(struct tracker_list **list, int owner, const char *name,
634 struct symbol *sym);
635 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
636 struct symbol *sym);
637 void free_tracker_list(struct tracker_list **list);
638 void free_trackers_and_list(struct tracker_list **list);
640 /* smatch_conditions */
641 int in_condition(void);
643 /* smatch_flow.c */
645 extern int __in_fake_assign;
646 extern int __in_fake_parameter_assign;
647 extern int __in_fake_struct_assign;
648 extern int __in_fake_var_assign;
649 extern int __fake_state_cnt;
650 extern int in_fake_env;
651 bool is_fake_var_assign(struct expression *expr);
652 void smatch (struct string_list *filelist);
653 int inside_loop(void);
654 int definitely_inside_loop(void);
655 struct expression *get_switch_expr(void);
656 int in_expression_statement(void);
657 void __process_post_op_stack(void);
658 void __split_expr(struct expression *expr);
659 void __split_label_stmt(struct statement *stmt);
660 void __split_stmt(struct statement *stmt);
661 extern int __in_function_def;
662 extern int __in_unmatched_hook;
663 extern int option_assume_loops;
664 extern int option_two_passes;
665 extern int option_no_db;
666 extern int option_file_output;
667 extern int option_time;
668 extern int option_time_stmt;
669 extern struct expression_list *big_expression_stack;
670 extern struct expression_list *big_condition_stack;
671 extern struct statement_list *big_statement_stack;
672 int is_condition_call(struct expression *expr);
673 int is_assigned_call(struct expression *expr);
674 int is_fake_assigned_call(struct expression *expr);
675 void add_function_data(unsigned long *fn_data);
676 int inlinable(struct expression *expr);
677 extern int __inline_call;
678 extern struct expression *__inline_fn;
679 extern int __in_pre_condition;
680 extern int __bail_on_rest_of_function;
681 extern struct statement *__prev_stmt;
682 extern struct statement *__cur_stmt;
683 extern struct statement *__next_stmt;
684 void init_fake_env(void);
685 void end_fake_env(void);
686 int time_parsing_function(void);
687 bool taking_too_long(void);
688 struct statement *get_last_stmt(void);
689 int is_last_stmt(struct statement *cur_stmt);
691 /* smatch_struct_assignment.c */
692 struct expression *get_faked_expression(void);
693 void __fake_struct_member_assignments(struct expression *expr);
695 /* smatch_project.c */
696 int is_no_inline_function(const char *function);
698 /* smatch_conditions */
699 void __split_whole_condition(struct expression *expr);
700 void __handle_logic(struct expression *expr);
701 int is_condition(struct expression *expr);
702 int __handle_condition_assigns(struct expression *expr);
703 int __handle_select_assigns(struct expression *expr);
704 int __handle_expr_statement_assigns(struct expression *expr);
706 /* smatch_implied.c */
707 struct range_list_stack;
708 void param_limit_implications(struct expression *expr, int param, char *key, char *value, struct stree **implied);
709 struct stree *__implied_case_stree(struct expression *switch_expr,
710 struct range_list *case_rl,
711 struct range_list_stack **remaining_cases,
712 struct stree **raw_stree);
713 void overwrite_states_using_pool(struct sm_state *gate_sm, struct sm_state *pool_sm);
714 int assume(struct expression *expr);
715 void end_assume(void);
716 int impossible_assumption(struct expression *left, int op, sval_t sval);
718 /* smatch_slist.h */
719 bool has_dynamic_states(unsigned short owner);
720 void set_dynamic_states(unsigned short owner);
722 /* smatch_extras.c */
723 int in_warn_on_macro(void);
724 extern int SMATCH_EXTRA;
725 extern int RETURN_ID;
727 struct data_range {
728 sval_t min;
729 sval_t max;
732 char *get_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
733 char *map_call_to_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
734 char *map_long_to_short_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym, bool use_stack);
736 #define STRLEN_MAX_RET 1010101
738 /* smatch_absolute.c */
739 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
740 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
742 /* smatch_type_value.c */
743 void disable_type_val_lookups(void);
744 void enable_type_val_lookups(void);
745 void clear_type_value_cache(void);
746 int get_db_type_rl(struct expression *expr, struct range_list **rl);
748 /* smatch_data_val.c */
749 int get_mtag_rl(struct expression *expr, struct range_list **rl);
750 /* smatch_array_values.c */
751 void clear_array_values_cache(void);
752 int get_array_rl(struct expression *expr, struct range_list **rl);
754 /* smatch_states.c */
755 struct stree *__swap_cur_stree(struct stree *stree);
756 void __push_fake_cur_stree();
757 struct stree *__pop_fake_cur_stree();
758 void __free_fake_cur_stree();
759 void __set_fake_cur_stree_fast(struct stree *stree);
760 void __pop_fake_cur_stree_fast(void);
761 void __merge_stree_into_cur(struct stree *stree);
763 int unreachable(void);
764 void __set_cur_stree_readonly(void);
765 void __set_cur_stree_writable(void);
766 void __set_sm(struct sm_state *sm);
767 void __set_sm_cur_stree(struct sm_state *sm);
768 void __set_true_false_sm(struct sm_state *true_state,
769 struct sm_state *false_state);
770 void nullify_path(void);
771 void __match_nullify_path_hook(const char *fn, struct expression *expr,
772 void *unused);
773 void __unnullify_path(void);
774 int __path_is_null(void);
775 void save_all_states(void);
776 void restore_all_states(void);
777 void free_goto_stack(void);
778 void clear_all_states(void);
780 struct sm_state *get_sm_state(int owner, const char *name,
781 struct symbol *sym);
782 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
783 void __push_true_states(void);
784 void __use_false_states(void);
785 void __discard_false_states(void);
786 void __merge_false_states(void);
787 void __merge_true_states(void);
789 void __negate_cond_stacks(void);
790 void __use_pre_cond_states(void);
791 void __use_cond_true_states(void);
792 void __use_cond_false_states(void);
793 void __push_cond_stacks(void);
794 void __fold_in_set_states(void);
795 void __free_set_states(void);
796 struct stree *__copy_cond_true_states(void);
797 struct stree *__copy_cond_false_states(void);
798 struct stree *__pop_cond_true_stack(void);
799 struct stree *__pop_cond_false_stack(void);
800 void __and_cond_states(void);
801 void __or_cond_states(void);
802 void __save_pre_cond_states(void);
803 void __discard_pre_cond_states(void);
804 struct stree *__get_true_states(void);
805 struct stree *__get_false_states(void);
806 void __use_cond_states(void);
807 extern struct state_list *__last_base_slist;
809 void __push_continues(void);
810 void __discard_continues(void);
811 void __process_continues(void);
812 void __merge_continues(void);
814 void __push_breaks(void);
815 void __process_breaks(void);
816 int __has_breaks(void);
817 void __merge_breaks(void);
818 void __use_breaks(void);
820 void __save_switch_states(struct expression *switch_expr);
821 void __discard_switches(void);
822 int have_remaining_cases(void);
823 void __merge_switches(struct expression *switch_expr, struct range_list *case_rl);
824 void __push_default(void);
825 void __set_default(void);
826 bool __has_default_case(void);
827 int __pop_default(void);
829 void __push_conditions(void);
830 void __discard_conditions(void);
832 void __save_gotos(const char *name, struct symbol *sym);
833 void __merge_gotos(const char *name, struct symbol *sym);
835 void __discard_fake_states(struct expression *call);
837 void __print_cur_stree(void);
838 bool __print_states(const char *owner);
839 typedef void (check_tracker_hook)(int owner, const char *name, struct symbol *sym, struct smatch_state *state);
840 void add_check_tracker(const char *check_name, check_tracker_hook *fn);
842 /* smatch_hooks.c */
843 void __pass_to_client(void *data, enum hook_type type);
844 void __pass_case_to_client(struct expression *switch_expr,
845 struct range_list *rl);
846 int __has_merge_function(int client_id);
847 struct smatch_state *__client_merge_function(int owner,
848 struct smatch_state *s1,
849 struct smatch_state *s2);
850 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
851 void call_pre_merge_hook(struct sm_state *cur, struct sm_state *other);
852 void __push_scope_hooks(void);
853 void __call_scope_hooks(void);
854 void add_array_initialized_hook(void (*hook)(struct expression *array, int nr));
855 void __call_array_initialized_hooks(struct expression *array, int nr);
857 /* smatch_function_hooks.c */
858 void create_function_hook_hash(void);
859 void __match_initializer_call(struct symbol *sym);
861 /* smatch_db.c */
862 enum info_type {
863 INTERNAL = 0,
865 * Changing these numbers is a pain. Don't do it. If you ever use a
866 * number it can't be re-used right away so there may be gaps.
867 * We select these in order by type so if the order matters, then give
868 * it a number below 100-999,9000-9999 ranges. */
870 PARAM_LIMIT = 103,
871 PARAM_FILTER = 104,
873 RELEASE = 500,
874 BUF_CLEARED = 501,
876 PARAM_VALUE = 1001,
877 BUF_SIZE = 1002,
878 CAPPED_DATA = 1004,
879 RETURN_VALUE = 1005,
880 DEREFERENCE = 1006,
881 RANGE_CAP = 1007,
882 ABSOLUTE_LIMITS = 1010,
883 PARAM_ADD = 1012,
884 PARAM_FREED = 1013,
885 MAYBE_FREED = 2014,
886 DATA_SOURCE = 1014,
887 FUZZY_MAX = 1015,
888 HARD_MAX = 2015,
889 STR_LEN = 1016,
890 ARRAY_LEN = 1017,
891 CAPABLE = 1018,
892 NS_CAPABLE = 1019,
893 CONTAINER = 1020,
894 CASTED_CALL = 1021,
895 TYPE_LINK = 1022,
896 UNTRACKED_PARAM = 1023,
897 LOST_PARAM = 2023,
898 CULL_PATH = 1024,
899 PARAM_SET = 1025,
900 PARAM_USED = 1026,
901 BYTE_UNITS = 1027,
902 COMPARE_LIMIT = 1028,
903 PARAM_COMPARE = 1029,
904 CONSTRAINT = 1031,
905 PASSES_TYPE = 1032,
906 CONSTRAINT_REQUIRED = 1033,
907 BIT_INFO = 1034,
908 NOSPEC = 1035,
909 NOSPEC_WB = 1036,
910 STMT_CNT = 1037,
911 TERMINATED = 1038,
912 SLEEP = 1039,
913 FRESH_ALLOC = 1044,
914 ALLOCATOR = 1045,
915 FUNC_TIME = 1047,
916 POWER_OF_TWO = 1048,
917 POWER_OF_TWO_SET = 1049,
918 BIT_SET = 1051,
919 BIT_CLEAR = 1052,
920 BIT_IS_SET = 1053,
921 BIT_IS_CLEAR = 1054,
923 NEGATIVE_ERROR = 1057,
924 PREEMPT_ADD = 2054,
925 PREEMPT_SUB = 2055,
926 /* put random temporary stuff in the 7000-7999 range for testing */
927 HOST_DATA = 7016,
928 HOST_DATA_SET = 7017,
929 HOST_PTR = 7018,
930 HOST_PTR_SET = 7019,
931 USER_DATA = 8017,
932 USER_DATA_SET = 9017,
933 USER_PTR = 9018,
934 USER_PTR_SET = 9019,
935 NO_OVERFLOW = 8018,
936 NO_OVERFLOW_SIMPLE = 8019,
937 LOCK = 8020,
938 UNLOCK = 8021,
939 HALF_LOCKED = 9022,
940 RESTORE = 9023,
941 KNOWN_LOCKED = 9024,
942 KNOWN_UNLOCKED = 9025,
943 IGNORE_LOCK = 9026,
944 SET_FS = 8022,
945 ATOMIC_INC = 8023,
946 ATOMIC_DEC = 8024,
947 REFCOUNT_INIT = 9025,
948 REFCOUNT_INC = 9027,
949 REFCOUNT_DEC = 9028,
950 NO_SIDE_EFFECT = 8025,
951 FN_ARG_LINK = 8028,
952 DATA_VALUE = 8029,
953 ARRAYSIZE_ARG = 8033,
954 SIZEOF_ARG = 8034,
955 MEMORY_TAG = 8036,
956 MTAG_ASSIGN = 8035,
957 STRING_VALUE = 8041,
958 ALLOC = 8045,
959 RELEASE_OLD = 8046, // FIXME: delete this after Jul 2022
961 BYTE_COUNT = 8050,
962 ELEM_COUNT = 8051,
963 ELEM_LAST = 8052,
964 USED_LAST = 8053,
965 USED_COUNT = 8054,
967 /* Do not use numbers above 100k */
970 extern struct sqlite3 *smatch_db;
971 extern struct sqlite3 *mem_db;
972 extern struct sqlite3 *cache_db;
974 bool db_incomplete(void);
975 void db_ignore_states(int id);
976 typedef bool (delete_hook)(struct expression *expr);
977 void add_delete_return_hook(delete_hook *hook);
978 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
979 void select_caller_name_sym(void (*fn)(const char *name, struct symbol *sym, char *value), int type);
980 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
981 void add_caller_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
982 void add_return_info_callback(int owner,
983 void (*callback)(int return_id, char *return_ranges,
984 struct expression *returned_expr,
985 int param,
986 const char *printed_name,
987 struct sm_state *sm));
988 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr));
989 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));
990 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
991 void select_return_implies_hook_early(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
992 void select_return_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
993 struct range_list *db_return_vals(struct expression *expr);
994 struct range_list *db_return_vals_from_str(const char *fn_name);
995 struct range_list *db_return_vals_no_args(struct expression *expr);
996 bool get_implied_rl_from_call_str(struct expression *expr, const char *data, struct range_list **rl);
997 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl);
998 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym);
999 char *get_name_sym_from_param_key(struct expression *expr, int param, const char *key, struct symbol **sym);
1000 char *get_param_name_var_sym(const char *name, struct symbol *sym);
1001 char *get_param_name(struct sm_state *sm);
1002 const char *get_mtag_name_var_sym(const char *state_name, struct symbol *sym);
1003 const char *get_mtag_name_expr(struct expression *expr);
1004 char *get_data_info_name(struct expression *expr);
1005 char *sm_to_arg_name(struct expression *expr, struct sm_state *sm);
1006 int is_recursive_member(const char *param_name);
1008 char *escape_newlines(const char *str);
1009 void sql_exec(struct sqlite3 *db, int (*callback)(void*, int, char**, char**), void *data, const char *sql);
1011 #define sql_helper(db, call_back, data, sql...) \
1012 do { \
1013 char sql_txt[1024]; \
1015 sqlite3_snprintf(sizeof(sql_txt), sql_txt, sql); \
1016 db_debug("debug: %s\n", sql_txt); \
1017 sql_exec(db, call_back, data, sql_txt); \
1018 } while (0)
1021 #define run_sql(call_back, data, sql...) \
1022 do { \
1023 if (option_no_db) \
1024 break; \
1025 sql_helper(smatch_db, call_back, data, sql); \
1026 } while (0)
1028 #define mem_sql(call_back, data, sql...) \
1029 sql_helper(mem_db, call_back, data, sql)
1031 #define cache_sql(call_back, data, sql...) \
1032 sql_helper(cache_db, call_back, data, sql)
1034 #define sql_insert_helper(table, db, ignore, late, values...) \
1035 do { \
1036 struct sqlite3 *_db = db; \
1038 if (__inline_fn && !_db) \
1039 _db = mem_db; \
1040 if (_db) { \
1041 char buf[1024]; \
1042 char *err, *p = buf; \
1043 int rc; \
1045 p += snprintf(p, buf + sizeof(buf) - p, \
1046 "insert %sinto %s values (", \
1047 ignore ? "or ignore " : "", #table); \
1048 p += snprintf(p, buf + sizeof(buf) - p, values); \
1049 p += snprintf(p, buf + sizeof(buf) - p, ");"); \
1050 db_debug("mem-db: %s\n", buf); \
1051 rc = sqlite3_exec(_db, buf, NULL, NULL, &err); \
1052 if (rc != SQLITE_OK) { \
1053 sm_ierror("SQL error #2: %s", err); \
1054 sm_ierror("SQL: '%s'", buf); \
1055 parse_error = 1; \
1057 break; \
1059 if (option_info) { \
1060 FILE *tmp_fd = sm_outfd; \
1061 sm_outfd = sql_outfd; \
1062 sm_prefix(); \
1063 sm_printf("SQL%s: insert %sinto " #table " values(", \
1064 late ? "_late" : "", ignore ? "or ignore " : ""); \
1065 sm_printf(values); \
1066 sm_printf(");\n"); \
1067 sm_outfd = tmp_fd; \
1069 } while (0)
1071 #define sql_insert(table, values...) sql_insert_helper(table, 0, 0, 0, values);
1072 #define sql_insert_or_ignore(table, values...) sql_insert_helper(table, 0, 1, 0, values);
1073 #define sql_insert_late(table, values...) sql_insert_helper(table, 0, 0, 1, values);
1074 #define sql_insert_cache(table, values...) sql_insert_helper(table, cache_db, 1, 0, values);
1076 char *get_static_filter(struct symbol *sym);
1078 void sql_insert_return_states(int return_id, const char *return_ranges,
1079 int type, int param, const char *key, const char *value);
1080 void sql_insert_caller_info(struct expression *call, int type, int param,
1081 const char *key, const char *value);
1082 void sql_insert_function_ptr(const char *fn, const char *struct_name);
1083 void sql_insert_return_values(const char *return_values);
1084 void sql_insert_return_implies(int type, int param, const char *key, const char *value);
1085 void sql_insert_function_type_size(const char *member, const char *ranges);
1086 void sql_insert_function_type_info(int type, const char *struct_type, const char *member, const char *value);
1087 void sql_insert_type_info(int type, const char *member, const char *value);
1088 void sql_insert_local_values(const char *name, const char *value);
1089 void sql_insert_function_type_value(const char *type, const char *value);
1090 void sql_insert_function_type(int param, const char *value);
1091 void sql_insert_parameter_name(int param, const char *value);
1092 void sql_insert_data_info(struct expression *data, int type, const char *value);
1093 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value);
1094 void sql_save_constraint(const char *con);
1095 void sql_save_constraint_required(const char *data, int op, const char *limit);
1096 void sql_copy_constraint_required(const char *new_limit, const char *old_limit);
1097 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data);
1098 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value);
1099 void sql_insert_mtag_about(mtag_t tag, const char *left_name, const char *right_name);
1100 void sql_insert_mtag_info(mtag_t tag, int type, const char *value);
1101 void sql_insert_mtag_map(mtag_t container, int container_offset, mtag_t tag, int tag_offset);
1102 void sql_insert_mtag_alias(mtag_t orig, mtag_t alias);
1103 int mtag_map_select_container(mtag_t tag, int container_offset, mtag_t *container);
1104 int mtag_map_select_tag(mtag_t container, int offset, mtag_t *tag);
1105 struct smatch_state *get_mtag_return(struct expression *expr, struct smatch_state *state);
1106 struct range_list *swap_mtag_seed(struct expression *expr, struct range_list *rl);
1108 bool is_fn_ptr(struct expression *fn);
1109 void sql_select_return_states(const char *cols, struct expression *call,
1110 int (*callback)(void*, int, char**, char**), void *info);
1111 void sql_select_call_implies(const char *cols, struct expression *call,
1112 int (*callback)(void*, int, char**, char**));
1114 void open_smatch_db(char *db_file);
1116 /* smatch_files.c */
1117 int open_data_file(const char *filename);
1118 int open_schema_file(const char *schema);
1119 struct token *get_tokens_file(const char *filename);
1120 struct string_list *load_strings_from_file(const char *project, const char *filename);
1122 /* smatch.c */
1123 extern char *option_debug_check;
1124 extern char *option_debug_var;
1125 extern char *option_project_str;
1126 extern char *bin_dir;
1127 extern char *data_dir;
1128 extern int option_no_data;
1129 extern int option_full_path;
1130 extern int option_call_tree;
1131 extern int num_checks;
1133 enum project_type {
1134 PROJ_NONE,
1135 PROJ_KERNEL,
1136 PROJ_WINE,
1137 PROJ_ILLUMOS_KERNEL,
1138 PROJ_ILLUMOS_USER,
1139 PROJ_UNKNOWN,
1141 extern enum project_type option_project;
1142 const char *check_name(unsigned short id);
1143 int id_from_name(const char *name);
1146 /* smatch_buf_size.c */
1147 int get_array_size(struct expression *expr);
1148 int get_array_size_bytes(struct expression *expr);
1149 int get_array_size_bytes_min(struct expression *expr);
1150 int get_array_size_bytes_max(struct expression *expr);
1151 struct range_list *get_array_size_bytes_rl(struct expression *expr);
1152 int get_real_array_size(struct expression *expr);
1153 int last_member_is_resizable(struct symbol *type);
1154 /* smatch_strlen.c */
1155 int get_implied_strlen(struct expression *expr, struct range_list **rl);
1156 int get_size_from_strlen(struct expression *expr);
1158 /* smatch_capped.c */
1159 int is_capped(struct expression *expr);
1160 int is_capped_var_sym(const char *name, struct symbol *sym);
1162 /* smatch_kernel_user_data.c */
1163 int is_user_macro(struct expression *expr);
1164 int is_capped_user_data(struct expression *expr);
1165 int implied_user_data(struct expression *expr, struct range_list **rl);
1166 struct stree *get_user_stree(void);
1167 int get_user_rl(struct expression *expr, struct range_list **rl);
1168 int is_user_rl(struct expression *expr);
1169 int get_user_rl_var_sym(const char *name, struct symbol *sym, struct range_list **rl);
1170 bool user_rl_capped_var_sym(const char *name, struct symbol *sym);
1171 bool user_rl_capped(struct expression *expr);
1172 struct range_list *var_user_rl(struct expression *expr);
1173 bool we_pass_user_data(struct expression *call);
1174 /* smatch_points_to_user_data.c */
1175 bool is_user_data_fn(struct symbol *fn);
1176 bool is_skb_data(struct expression *expr);
1177 bool is_socket_stuff(struct symbol *sym);
1178 bool points_to_user_data(struct expression *expr);
1179 void set_points_to_user_data(struct expression *expr, bool is_new);
1181 /* smatch_kernel_host_data.c */
1182 int is_host_macro(struct expression *expr);
1183 int is_capped_host_data(struct expression *expr);
1184 int implied_host_data(struct expression *expr, struct range_list **rl);
1185 struct stree *get_host_stree(void);
1186 int get_host_rl(struct expression *expr, struct range_list **rl);
1187 int is_host_rl(struct expression *expr);
1188 int get_host_rl_var_sym(const char *name, struct symbol *sym, struct range_list **rl);
1189 bool host_rl_capped(struct expression *expr);
1190 struct range_list *var_host_rl(struct expression *expr);
1191 bool we_pass_host_data(struct expression *call);
1192 /* smatch_points_to_host_data.c */
1193 bool is_host_data_fn(struct symbol *fn);
1194 bool points_to_host_data(struct expression *expr);
1195 void set_points_to_host_data(struct expression *expr, bool is_new);
1197 /* check_locking.c */
1198 void print_held_locks();
1199 /* preempt */
1200 void __preempt_add(void);
1201 void __preempt_sub(void);
1202 int get_preempt_cnt(void);
1203 void clear_preempt_cnt(void);
1204 bool function_decrements_preempt(void);
1205 void add_sleep_callback(void_fn *fn);
1206 unsigned long GFP_DIRECT_RECLAIM(void);
1207 unsigned long GFP_ATOMIC(void);
1209 /* check_assigned_expr.c */
1210 extern int check_assigned_expr_id;
1211 struct expression *get_assigned_expr(struct expression *expr);
1212 struct sm_state *get_assigned_sm(struct expression *expr);
1213 struct expression *get_assigned_expr_recurse(struct expression *expr);
1214 struct expression *get_assigned_expr_name_sym(const char *name, struct symbol *sym);
1215 struct expression *get_assigned_expr_name_sym_recurse(const char *name, struct symbol *sym);
1217 /* smatch_return_to_param.c */
1218 char *map_call_to_param_name_sym(struct expression *expr, struct symbol **sym);
1220 /* smatch_comparison.c */
1221 extern int comparison_id;
1222 #define UNKNOWN_COMPARISON 0
1223 #define IMPOSSIBLE_COMPARISON -1
1224 struct compare_data {
1225 /* The ->left and ->right expression pointers might be NULL (I'm lazy) */
1226 struct expression *left;
1227 const char *left_var;
1228 struct var_sym_list *left_vsl;
1229 int comparison;
1230 struct expression *right;
1231 const char *right_var;
1232 struct var_sym_list *right_vsl;
1234 DECLARE_ALLOCATOR(compare_data);
1235 struct smatch_state *alloc_compare_state(
1236 struct expression *left,
1237 const char *left_var, struct var_sym_list *left_vsl,
1238 int comparison,
1239 struct expression *right,
1240 const char *right_var, struct var_sym_list *right_vsl);
1241 int comparison_intersection(int orig, int op);
1242 int merge_comparisons(int one, int two);
1243 int combine_comparisons(int left_compare, int right_compare);
1244 int state_to_comparison(struct smatch_state *state);
1245 struct smatch_state *merge_compare_states(struct smatch_state *s1, struct smatch_state *s2);
1246 int get_comparison(struct expression *left, struct expression *right);
1247 int get_comparison_no_extra(struct expression *a, struct expression *b);
1248 int get_comparison_strings(const char *one, const char *two);
1249 int possible_comparison(struct expression *a, int comparison, struct expression *b);
1250 struct state_list *get_all_comparisons(struct expression *expr);
1251 struct state_list *get_all_possible_equal_comparisons(struct expression *expr);
1252 void __add_comparison_info(struct expression *expr, struct expression *call, const char *range);
1253 char *get_printed_param_name(struct expression *call, const char *param_name, struct symbol *param_sym);
1254 char *name_sym_to_param_comparison(const char *name, struct symbol *sym);
1255 char *expr_equal_to_param(struct expression *expr, int ignore);
1256 char *expr_lte_to_param(struct expression *expr, int ignore);
1257 char *expr_param_comparison(struct expression *expr, int ignore);
1258 int flip_comparison(int op);
1259 int negate_comparison(int op);
1260 int remove_unsigned_from_comparison(int op);
1261 int param_compare_limit_is_impossible(struct expression *expr, int left_param, char *left_key, char *value);
1262 void filter_by_comparison(struct range_list **rl, int comparison, struct range_list *right);
1263 void __compare_param_limit_hook(struct expression *left_expr, struct expression *right_expr,
1264 const char *state_name,
1265 struct smatch_state *true_state, struct smatch_state *false_state);
1266 int impossibly_high_comparison(struct expression *expr);
1267 void add_comparison_var_sym(
1268 struct expression *left_expr,
1269 const char *left_name, struct var_sym_list *left_vsl,
1270 int comparison,
1271 struct expression *right_expr,
1272 const char *right_name, struct var_sym_list *right_vsl,
1273 struct expression *mod_expr);
1275 /* smatch_sval.c */
1276 sval_t *sval_alloc(sval_t sval);
1277 sval_t *sval_alloc_permanent(sval_t sval);
1278 sval_t sval_blank(struct expression *expr);
1279 sval_t sval_type_val(struct symbol *type, long long val);
1280 sval_t sval_type_fval(struct symbol *type, long double fval);
1281 sval_t sval_from_val(struct expression *expr, long long val);
1282 sval_t sval_from_fval(struct expression *expr, long double fval);
1283 int sval_is_ptr(sval_t sval);
1284 bool sval_is_fp(sval_t sval);
1285 int sval_unsigned(sval_t sval);
1286 int sval_signed(sval_t sval);
1287 int sval_bits(sval_t sval);
1288 int sval_bits_used(sval_t sval);
1289 int sval_is_negative(sval_t sval);
1290 int sval_is_positive(sval_t sval);
1291 int sval_is_min(sval_t sval);
1292 int sval_is_max(sval_t sval);
1293 int sval_is_a_min(sval_t sval);
1294 int sval_is_a_max(sval_t sval);
1295 int sval_is_negative_min(sval_t sval);
1296 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
1297 int sval_cmp_val(sval_t one, long long val);
1298 sval_t sval_min(sval_t one, sval_t two);
1299 sval_t sval_min_nonneg(sval_t one, sval_t two);
1300 sval_t sval_max(sval_t one, sval_t two);
1301 int sval_too_low(struct symbol *type, sval_t sval);
1302 int sval_too_high(struct symbol *type, sval_t sval);
1303 int sval_fits(struct symbol *type, sval_t sval);
1304 sval_t sval_cast(struct symbol *type, sval_t sval);
1305 sval_t sval_preop(sval_t sval, int op);
1306 sval_t sval_binop(sval_t left, int op, sval_t right);
1307 int sval_binop_overflows(sval_t left, int op, sval_t right);
1308 int sval_binop_overflows_no_sign(sval_t left, int op, sval_t right);
1309 int find_first_zero_bit(unsigned long long uvalue);
1310 int sm_fls64(unsigned long long uvalue);
1311 unsigned long long fls_mask(unsigned long long uvalue);
1312 unsigned long long sval_fls_mask(sval_t sval);
1313 const char *sval_to_str(sval_t sval);
1314 const char *sval_to_str_or_err_ptr(sval_t sval);
1315 const char *sval_to_numstr(sval_t sval);
1316 sval_t ll_to_sval(long long val);
1318 /* smatch_string_list.c */
1319 int list_has_string(struct string_list *str_list, const char *str);
1320 int insert_string(struct string_list **str_list, const char *str);
1321 struct string_list *clone_str_list(struct string_list *orig);
1322 struct string_list *combine_string_lists(struct string_list *one, struct string_list *two);
1324 /* smatch_start_states.c */
1325 struct stree *get_start_states(void);
1327 /* smatch_recurse.c */
1328 int recurse(struct expression *expr,
1329 int (func)(struct expression *expr, void *p),
1330 void *param, int nr);
1331 int has_symbol(struct expression *expr, struct symbol *sym);
1332 int has_variable(struct expression *expr, struct expression *var);
1333 int has_inc_dec(struct expression *expr);
1335 /* smatch_stored_conditions.c */
1336 struct smatch_state *get_stored_condition(struct expression *expr);
1337 struct expression_list *get_conditions(struct expression *expr);
1338 struct sm_state *stored_condition_implication_hook(struct expression *expr,
1339 struct state_list **true_stack,
1340 struct state_list **false_stack);
1341 /* smatch_parsed_conditions.c */
1342 struct sm_state *parsed_condition_implication_hook(struct expression *expr,
1343 struct state_list **true_stack,
1344 struct state_list **false_stack);
1345 /* smatch_comparison.c */
1346 struct sm_state *comparison_implication_hook(struct expression *expr,
1347 struct state_list **true_stack,
1348 struct state_list **false_stack);
1350 /* check_string_len.c */
1351 int get_formatted_string_size(struct expression *call, int arg);
1352 int get_formatted_string_min_size(struct expression *call, int arg);
1354 /* smatch_param_set.c */
1355 int param_was_set(struct expression *expr);
1356 int param_was_set_var_sym(const char *name, struct symbol *sym);
1357 void print_limited_param_set(int return_id, char *return_ranges, struct expression *expr);
1358 /* param_clear */
1359 void __promote_sets_to_clears(int return_id, char *return_ranges, struct expression *expr);
1360 bool parent_was_PARAM_CLEAR(const char *name, struct symbol *sym);
1361 bool parent_was_PARAM_CLEAR_ZERO(const char *name, struct symbol *sym);
1363 /* smatch_param_filter.c */
1364 int param_has_filter_data(struct sm_state *sm);
1366 /* smatch_links.c */
1367 void set_up_link_functions(int id, int linkid);
1368 struct smatch_state *merge_link_states(struct smatch_state *s1, struct smatch_state *s2);
1369 void store_link(int link_id, const char *name, struct symbol *sym, const char *link_name, struct symbol *link_sym);
1371 /* check_buf_comparison */
1372 const char *limit_type_str(unsigned int limit_type);
1373 struct expression *get_size_variable(struct expression *buf, int *limit_type);
1374 struct expression *get_array_variable(struct expression *size);
1375 int buf_comparison_index_ok(struct expression *expr);
1376 bool buf_comp_has_bytes(struct expression *buf, struct expression *var);
1377 bool buf_comp2_has_bytes(struct expression *buf_expr, struct expression *var);
1379 /* smatch_untracked_param.c */
1380 void mark_untracked(struct expression *expr, int param, const char *key, const char *value);
1381 void add_untracked_param_hook(void (func)(struct expression *call, int param));
1382 void add_lost_param_hook(void (func)(struct expression *call, int param));
1383 void mark_all_params_untracked(int return_id, char *return_ranges, struct expression *expr);
1384 /* smatch_untracked_var.c */
1385 bool is_untracked(struct expression *expr);
1387 /* smatch_strings.c */
1388 struct state_list *get_strings(struct expression *expr);
1389 struct expression *fake_string_from_mtag(mtag_t tag);
1391 /* smatch_estate.c */
1392 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
1394 /* smatch_address.c */
1395 int get_address_rl(struct expression *expr, struct range_list **rl);
1396 int get_member_offset(struct symbol *type, const char *member_name);
1397 int get_member_offset_from_deref(struct expression *expr);
1399 /* for now this is in smatch_used_parameter.c */
1400 void __get_state_hook(int owner, const char *name, struct symbol *sym);
1401 extern int __ignore_param_used;
1403 /* smatch_buf_comparison.c */
1404 int db_var_is_array_limit(struct expression *array, const char *name, struct var_sym_list *vsl);
1406 struct range_list *get_fs(void);
1408 struct stree *get_all_return_states(void);
1409 struct stree_stack *get_all_return_strees(void);
1410 int on_atomic_dec_path(void);
1411 int was_inced(const char *name, struct symbol *sym);
1412 void set_refcount_inc(char *name, struct symbol *sym);
1413 void set_refcount_dec(char *name, struct symbol *sym);
1414 void add_refcount_init_hook(name_sym_hook *hook);
1415 void add_refcount_inc_hook(name_sym_hook *hook);
1416 void add_refcount_dec_hook(name_sym_hook *hook);
1418 /* smatch_constraints.c */
1419 char *get_constraint_str(struct expression *expr);
1420 struct constraint_list *get_constraints(struct expression *expr);
1421 char *unmet_constraint(struct expression *data, struct expression *offset);
1422 char *get_required_constraint(const char *data_str);
1424 /* smatch_container_of.c */
1425 int get_param_from_container_of(struct expression *expr);
1426 int get_offset_from_container_of(struct expression *expr);
1427 char *get_container_name(struct expression *container, struct expression *expr);
1429 /* smatch_mtag.c */
1430 mtag_t str_to_mtag(const char *str);
1431 int get_string_mtag(struct expression *expr, mtag_t *tag);
1432 int get_toplevel_mtag(struct symbol *sym, mtag_t *tag);
1433 int create_mtag_alias(mtag_t tag, struct expression *expr, mtag_t *new);
1434 int expr_to_mtag_offset(struct expression *expr, mtag_t *tag, int *offset);
1435 void update_mtag_data(struct expression *expr, struct smatch_state *state);
1436 int get_mtag_sval(struct expression *expr, sval_t *sval);
1438 /* Trinity fuzzer stuff */
1439 const char *get_syscall_arg_type(struct symbol *sym);
1441 /* smatch_bits.c */
1442 int binfo_equiv(struct bit_info *one, struct bit_info *two);
1443 struct bit_info *alloc_bit_info(unsigned long long set, unsigned long long possible);
1444 struct smatch_state *alloc_bstate(unsigned long long set, unsigned long long possible);
1445 struct smatch_state *merge_bstates(struct smatch_state *one_state, struct smatch_state *two_state);
1447 /* smatch_param_bits_set.c */
1448 void __set_param_modified_helper(struct expression *expr, struct smatch_state *state);
1449 void __set_param_modified_helper_sym(const char *name, struct symbol *sym,
1450 struct smatch_state *state);
1452 /* smatch_param_bits_clear.c */
1453 void __set_param_modified_helper_clear(struct expression *expr, struct smatch_state *state);
1454 void __set_param_modified_helper_sym_clear(const char *name, struct symbol *sym,
1455 struct smatch_state *state);
1457 /* smatch_bit_info.c */
1458 struct bit_info *rl_to_binfo(struct range_list *rl);
1459 struct bit_info *get_bit_info(struct expression *expr);
1460 struct bit_info *get_bit_info_var_sym(const char *name, struct symbol *sym);
1462 /* smatch_mem_tracker.c */
1463 extern int option_mem;
1464 unsigned long get_mem_kb(void);
1465 unsigned long get_max_memory(void);
1467 /* check_is_nospec.c */
1468 bool is_nospec(struct expression *expr);
1469 long get_stmt_cnt(void);
1471 /* smatch_nul_terminator.c */
1472 bool is_nul_terminated_var_sym(const char *name, struct symbol *sym);
1473 bool is_nul_terminated(struct expression *expr);
1474 /* check_kernel.c */
1475 bool is_ignored_kernel_data(const char *name);
1476 int get_gfp_param(struct expression *expr);
1478 bool is_fresh_alloc_var_sym(const char *var, struct symbol *sym);
1479 bool is_fresh_alloc(struct expression *expr);
1480 bool is_freed_var_sym(const char *name, struct symbol *sym);
1481 void track_freed_param(struct expression *expr, struct smatch_state *state);
1482 void track_freed_param_var_sym(const char *name, struct symbol *sym,
1483 struct smatch_state *state);
1484 bool is_part_of_condition(struct expression *expr);
1485 bool is_percent_p_print(struct expression *expr);
1487 void add_free_hook(name_sym_hook *hook);
1489 /* smatch_unconstant_macros.c */
1490 int is_unconstant_macro(struct expression *expr);
1492 /* smatch_assigned_state.c */
1493 void add_state_assigned_hook(int owner, sm_hook *call_back);
1494 void add_ssa_state_assigned_hook(int owner, sm_hook *call_back);
1496 static inline bool type_is_ptr(struct symbol *type)
1498 return type &&
1499 (type->type == SYM_PTR ||
1500 type->type == SYM_ARRAY ||
1501 type->type == SYM_FN);
1504 static inline bool type_is_fp(struct symbol *type)
1506 return type &&
1507 (type == &float_ctype ||
1508 type == &double_ctype ||
1509 type == &ldouble_ctype);
1512 static inline int type_bits(struct symbol *type)
1514 if (!type)
1515 return 0;
1516 if (type_is_ptr(type))
1517 return bits_in_pointer;
1518 if (!type->examined)
1519 examine_symbol_type(type);
1520 return type->bit_size;
1523 static inline int type_unsigned(struct symbol *base_type)
1525 if (!base_type)
1526 return 0;
1527 if (is_ptr_type(base_type))
1528 return 1;
1529 if (base_type->ctype.modifiers & MOD_UNSIGNED)
1530 return 1;
1531 return 0;
1534 static inline int type_positive_bits(struct symbol *type)
1536 if (!type)
1537 return 0;
1538 if (is_ptr_type(type))
1539 return bits_in_pointer;
1540 if (type_unsigned(type))
1541 return type_bits(type);
1542 return type_bits(type) - 1;
1545 static inline int sval_positive_bits(sval_t sval)
1547 return type_positive_bits(sval.type);
1551 * Returns -1 if one is smaller, 0 if they are the same and 1 if two is larger.
1554 static inline int fp_cmp(sval_t one, sval_t two)
1556 struct symbol *type;
1558 if (sval_is_fp(one) && sval_is_fp(two))
1559 type = type_bits(one.type) > type_bits(two.type) ? one.type : two.type;
1560 else if (sval_is_fp(one))
1561 type = one.type;
1562 else
1563 type = two.type;
1565 one = sval_cast(type, one);
1566 two = sval_cast(type, two);
1568 if (one.type == &float_ctype) {
1569 if (one.fvalue < two.fvalue)
1570 return -1;
1571 if (one.fvalue == two.fvalue)
1572 return 0;
1573 return 1;
1575 if (one.type == &double_ctype) {
1576 if (one.dvalue < two.dvalue)
1577 return -1;
1578 if (one.dvalue == two.dvalue)
1579 return 0;
1580 return 1;
1582 if (one.type == &ldouble_ctype) {
1583 if (one.ldvalue < two.ldvalue)
1584 return -1;
1585 if (one.ldvalue == two.ldvalue)
1586 return 0;
1587 return 1;
1589 sm_perror("bad type in fp_cmp(): %s", type_to_str(type));
1590 return 1;
1593 static inline int sval_cmp(sval_t one, sval_t two)
1595 struct symbol *type;
1597 if (sval_is_fp(one) || sval_is_fp(two))
1598 return fp_cmp(one, two);
1600 type = one.type;
1601 if (sval_positive_bits(two) > sval_positive_bits(one))
1602 type = two.type;
1603 if (type_bits(type) < 31)
1604 type = &int_ctype;
1606 one = sval_cast(type, one);
1607 two = sval_cast(type, two);
1609 if (type_unsigned(type)) {
1610 if (one.uvalue < two.uvalue)
1611 return -1;
1612 if (one.uvalue == two.uvalue)
1613 return 0;
1614 return 1;
1616 /* fix me handle type promotion and unsigned values */
1617 if (one.value < two.value)
1618 return -1;
1619 if (one.value == two.value)
1620 return 0;
1621 return 1;
1624 #endif /* !SMATCH_H_ */