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