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