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