xref: /illumos-gate/usr/src/tools/smatch/src/smatch.h (revision c85f09cc)
1 /*
2  * Copyright (C) 2006 Dan Carpenter.
3  *
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.
8  *
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.
13  *
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
16  *
17  * Copyright 2019 Joyent, Inc.
18  */
19 
20 #ifndef   	SMATCH_H_
21 # define   	SMATCH_H_
22 
23 #include <stdio.h>
24 #include <string.h>
25 #include <limits.h>
26 #include <sys/time.h>
27 #include <sqlite3.h>
28 #include "lib.h"
29 #include "allocate.h"
30 #include "scope.h"
31 #include "parse.h"
32 #include "expression.h"
33 #include "avl.h"
34 
35 typedef struct {
36 	struct symbol *type;
37 	union {
38 		long long value;
39 		unsigned long long uvalue;
40 	};
41 } sval_t;
42 
43 typedef long long mtag_t;
44 
45 struct smatch_state {
46 	const char *name;
47 	void *data;
48 };
49 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
50 extern struct smatch_state undefined;
51 extern struct smatch_state ghost;
52 extern struct smatch_state merged;
53 extern struct smatch_state true_state;
54 extern struct smatch_state false_state;
55 DECLARE_ALLOCATOR(smatch_state);
56 
57 static inline void *INT_PTR(int i)
58 {
59 	return (void *)(long)i;
60 }
61 
62 static inline int PTR_INT(void *p)
63 {
64 	return (int)(long)p;
65 }
66 
67 struct tracker {
68 	char *name;
69 	struct symbol *sym;
70 	unsigned short owner;
71 };
72 DECLARE_ALLOCATOR(tracker);
73 DECLARE_PTR_LIST(tracker_list, struct tracker);
74 DECLARE_PTR_LIST(stree_stack, struct stree);
75 
76 /* The first 3 struct members must match struct tracker */
77 struct sm_state {
78 	const char *name;
79 	struct symbol *sym;
80 	unsigned short owner;
81 	unsigned short merged:1;
82 	unsigned int line;
83   	struct smatch_state *state;
84 	struct stree *pool;
85 	struct sm_state *left;
86 	struct sm_state *right;
87 	struct state_list *possible;
88 };
89 
90 struct var_sym {
91 	char *var;
92 	struct symbol *sym;
93 };
94 DECLARE_ALLOCATOR(var_sym);
95 DECLARE_PTR_LIST(var_sym_list, struct var_sym);
96 
97 struct constraint {
98 	int op;
99 	int id;
100 };
101 DECLARE_PTR_LIST(constraint_list, struct constraint);
102 
103 struct bit_info {
104 	unsigned long long set;
105 	unsigned long long possible;
106 };
107 
108 enum hook_type {
109 	EXPR_HOOK,
110 	EXPR_HOOK_AFTER,
111 	STMT_HOOK,
112 	STMT_HOOK_AFTER,
113 	SYM_HOOK,
114 	STRING_HOOK,
115 	DECLARATION_HOOK,
116 	ASSIGNMENT_HOOK,
117 	ASSIGNMENT_HOOK_AFTER,
118 	RAW_ASSIGNMENT_HOOK,
119 	GLOBAL_ASSIGNMENT_HOOK,
120 	LOGIC_HOOK,
121 	CONDITION_HOOK,
122 	PRELOOP_HOOK,
123 	SELECT_HOOK,
124 	WHOLE_CONDITION_HOOK,
125 	FUNCTION_CALL_HOOK_BEFORE,
126 	FUNCTION_CALL_HOOK,
127 	CALL_HOOK_AFTER_INLINE,
128 	FUNCTION_CALL_HOOK_AFTER_DB,
129 	CALL_ASSIGNMENT_HOOK,
130 	MACRO_ASSIGNMENT_HOOK,
131 	BINOP_HOOK,
132 	OP_HOOK,
133 	DEREF_HOOK,
134 	CASE_HOOK,
135 	ASM_HOOK,
136 	CAST_HOOK,
137 	SIZEOF_HOOK,
138 	BASE_HOOK,
139 	FUNC_DEF_HOOK,
140 	AFTER_DEF_HOOK,
141 	END_FUNC_HOOK,
142 	AFTER_FUNC_HOOK,
143 	RETURN_HOOK,
144 	INLINE_FN_START,
145 	INLINE_FN_END,
146 	END_FILE_HOOK,
147 	NUM_HOOKS,
148 };
149 
150 #define TRUE 1
151 #define FALSE 0
152 
153 struct range_list;
154 
155 void add_hook(void *func, enum hook_type type);
156 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
157 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
158 void add_merge_hook(int client_id, merge_func_t *func);
159 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
160 void add_pre_merge_hook(int client_id, void (*hook)(struct sm_state *cur, struct sm_state *other));
161 typedef void (scope_hook)(void *data);
162 void add_scope_hook(scope_hook *hook, void *data);
163 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
164 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
165 				struct expression *assign_expr, void *data);
166 typedef void (return_implies_hook)(struct expression *call_expr,
167 				   int param, char *key, char *value);
168 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list **rl);
169 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
170 
171 void add_function_assign_hook(const char *look_for, func_hook *call_back,
172 			      void *info);
173 void add_implied_return_hook(const char *look_for,
174 			     implied_return_hook *call_back,
175 			     void *info);
176 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
177 			      void *info);
178 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
179 			      void *info);
180 void return_implies_state(const char *look_for, long long start, long long end,
181 			 implication_hook *call_back, void *info);
182 void return_implies_state_sval(const char *look_for, sval_t start, sval_t end,
183 			 implication_hook *call_back, void *info);
184 void select_return_states_hook(int type, return_implies_hook *callback);
185 void select_return_states_before(void (*fn)(void));
186 void select_return_states_after(void (*fn)(void));
187 int get_implied_return(struct expression *expr, struct range_list **rl);
188 void allocate_hook_memory(void);
189 
190 struct modification_data {
191 	struct smatch_state *prev;
192 	struct expression *cur;
193 };
194 
195 typedef void (modification_hook)(struct sm_state *sm, struct expression *mod_expr);
196 void add_modification_hook(int owner, modification_hook *call_back);
197 void add_modification_hook_late(int owner, modification_hook *call_back);
198 struct smatch_state *get_modification_state(struct expression *expr);
199 
200 int outside_of_function(void);
201 const char *get_filename(void);
202 const char *get_base_file(void);
203 char *get_function(void);
204 int get_lineno(void);
205 extern int final_pass;
206 extern struct symbol *cur_func_sym;
207 extern int option_debug;
208 extern int local_debug;
209 bool debug_implied(void);
210 extern int option_info;
211 extern int option_spammy;
212 extern int option_timeout;
213 extern char *trace_variable;
214 extern struct stree *global_states;
215 int is_skipped_function(void);
216 int is_silenced_function(void);
217 extern bool implications_off;
218 
219 /* smatch_impossible.c */
220 int is_impossible_path(void);
221 void set_path_impossible(void);
222 
223 extern FILE *sm_outfd;
224 extern FILE *sql_outfd;
225 extern FILE *caller_info_fd;
226 extern int sm_nr_checks;
227 extern int sm_nr_errors;
228 extern const char *progname;
229 
230 /*
231  * How to use these routines:
232  *
233  * sm_fatal(): an internal error of some kind that should immediately exit
234  * sm_ierror(): an internal error
235  * sm_perror(): an internal error from parsing input source
236  * sm_error(): an error from input source
237  * sm_warning(): a warning from input source
238  * sm_info(): info message (from option_info)
239  * sm_debug(): debug message
240  * sm_msg(): other message (please avoid using this)
241  */
242 
243 #define sm_printf(msg...) do { if (final_pass || option_debug || local_debug) fprintf(sm_outfd, msg); } while (0)
244 
245 static inline void sm_prefix(void)
246 {
247 	sm_printf("%s: %s:%d %s() ", progname, get_filename(), get_lineno(), get_function());
248 }
249 
250 static inline void print_implied_debug_msg();
251 
252 extern bool __silence_warnings_for_stmt;
253 
254 #define sm_print_msg(type, msg...) \
255 do {                                                           \
256 	print_implied_debug_msg();                             \
257 	if (!final_pass && !option_debug && !local_debug)      \
258 		break;                                         \
259 	if (__silence_warnings_for_stmt && !option_debug && !local_debug) \
260 		break;					       \
261 	if (!option_info && is_silenced_function())	       \
262 		break;					       \
263 	sm_prefix();					       \
264 	if (type == 1) {				       \
265 		sm_printf("warn: ");			       \
266 		sm_nr_checks++;			    	       \
267 	} else if (type == 2) {				       \
268 		sm_printf("error: ");			       \
269 		sm_nr_checks++;				       \
270 	} else if (type == 3) {				       \
271 		sm_printf("parse error: ");		       \
272 		sm_nr_errors++;				       \
273 	}						       \
274         sm_printf(msg);                                        \
275         sm_printf("\n");                                       \
276 } while (0)
277 
278 #define sm_msg(msg...) do { sm_print_msg(0, msg); } while (0)
279 
280 #define local_debug(msg...)					\
281 do {								\
282 	if (local_debug)					\
283 		sm_msg(msg);					\
284 } while (0)
285 
286 extern char *implied_debug_msg;
287 static inline void print_implied_debug_msg(void)
288 {
289 	static struct symbol *last_printed = NULL;
290 
291 	if (!implied_debug_msg)
292 		return;
293 	if (last_printed == cur_func_sym)
294 		return;
295 	last_printed = cur_func_sym;
296 	sm_msg("%s", implied_debug_msg);
297 }
298 
299 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
300 
301 #define sm_info(msg...) do {					\
302 	if (option_debug || (option_info && final_pass)) {	\
303 		sm_prefix();					\
304 		sm_printf("info: ");				\
305 		sm_printf(msg);					\
306 		sm_printf("\n");				\
307 	}							\
308 } while(0)
309 
310 #define sm_warning(msg...) do { sm_print_msg(1, msg); } while (0)
311 #define sm_error(msg...) do { sm_print_msg(2, msg); } while (0)
312 #define sm_perror(msg...) do { sm_print_msg(3, msg); } while (0)
313 
314 static inline void sm_fatal(const char *fmt, ...)
315 {
316 	va_list args;
317 
318 	va_start(args, fmt);
319 	vfprintf(sm_outfd, fmt, args);
320 	va_end(args);
321 
322 	fprintf(sm_outfd, "\n");
323 
324 	exit(1);
325 }
326 
327 static inline void sm_ierror(const char *fmt, ...)
328 {
329 	va_list args;
330 
331 	sm_nr_errors++;
332 
333 	fprintf(sm_outfd, "internal error: ");
334 
335 	va_start(args, fmt);
336 	vfprintf(sm_outfd, fmt, args);
337 	va_end(args);
338 
339 	fprintf(sm_outfd, "\n");
340 }
341 #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
342 
343 struct smatch_state *__get_state(int owner, const char *name, struct symbol *sym);
344 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
345 struct smatch_state *get_state_expr(int owner, struct expression *expr);
346 struct state_list *get_possible_states(int owner, const char *name,
347 				       struct symbol *sym);
348 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
349 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
350 	       struct smatch_state *state);
351 struct sm_state *set_state_expr(int owner, struct expression *expr,
352 		struct smatch_state *state);
353 void delete_state(int owner, const char *name, struct symbol *sym);
354 void delete_state_expr(int owner, struct expression *expr);
355 void __delete_all_states_sym(struct symbol *sym);
356 void set_true_false_states(int owner, const char *name, struct symbol *sym,
357 			   struct smatch_state *true_state,
358 			   struct smatch_state *false_state);
359 void set_true_false_states_expr(int owner, struct expression *expr,
360 			   struct smatch_state *true_state,
361 			   struct smatch_state *false_state);
362 
363 struct stree *get_all_states_from_stree(int owner, struct stree *source);
364 struct stree *get_all_states_stree(int id);
365 struct stree *__get_cur_stree(void);
366 int is_reachable(void);
367 void add_get_state_hook(void (*fn)(int owner, const char *name, struct symbol *sym));
368 
369 /* smatch_helper.c */
370 DECLARE_PTR_LIST(int_stack, int);
371 char *alloc_string(const char *str);
372 char *alloc_string_newline(const char *str);
373 void free_string(char *str);
374 void append(char *dest, const char *data, int buff_len);
375 void remove_parens(char *str);
376 struct smatch_state *alloc_state_num(int num);
377 struct smatch_state *alloc_state_str(const char *name);
378 struct smatch_state *merge_str_state(struct smatch_state *s1, struct smatch_state *s2);
379 struct smatch_state *alloc_state_expr(struct expression *expr);
380 struct expression *get_argument_from_call_expr(struct expression_list *args,
381 					       int num);
382 
383 char *expr_to_var(struct expression *expr);
384 struct symbol *expr_to_sym(struct expression *expr);
385 char *expr_to_str(struct expression *expr);
386 char *expr_to_str_sym(struct expression *expr,
387 				     struct symbol **sym_ptr);
388 char *expr_to_var_sym(struct expression *expr,
389 			     struct symbol **sym_ptr);
390 char *expr_to_known_chunk_sym(struct expression *expr, struct symbol **sym);
391 char *expr_to_chunk_sym_vsl(struct expression *expr, struct symbol **sym, struct var_sym_list **vsl);
392 int get_complication_score(struct expression *expr);
393 
394 int sym_name_is(const char *name, struct expression *expr);
395 int get_const_value(struct expression *expr, sval_t *sval);
396 int get_value(struct expression *expr, sval_t *val);
397 int get_implied_value(struct expression *expr, sval_t *val);
398 int get_implied_min(struct expression *expr, sval_t *sval);
399 int get_implied_max(struct expression *expr, sval_t *val);
400 int get_hard_max(struct expression *expr, sval_t *sval);
401 int get_fuzzy_min(struct expression *expr, sval_t *min);
402 int get_fuzzy_max(struct expression *expr, sval_t *max);
403 int get_absolute_min(struct expression *expr, sval_t *sval);
404 int get_absolute_max(struct expression *expr, sval_t *sval);
405 int parse_call_math(struct expression *expr, char *math, sval_t *val);
406 int parse_call_math_rl(struct expression *call, const char *math, struct range_list **rl);
407 const char *get_allocation_math(struct expression *expr);
408 char *get_value_in_terms_of_parameter_math(struct expression *expr);
409 char *get_value_in_terms_of_parameter_math_var_sym(const char *var, struct symbol *sym);
410 int expr_is_zero(struct expression *expr);
411 int known_condition_true(struct expression *expr);
412 int known_condition_false(struct expression *expr);
413 int implied_condition_true(struct expression *expr);
414 int implied_condition_false(struct expression *expr);
415 int can_integer_overflow(struct symbol *type, struct expression *expr);
416 void clear_math_cache(void);
417 void set_fast_math_only(void);
418 void clear_fast_math_only(void);
419 
420 int is_array(struct expression *expr);
421 struct expression *get_array_base(struct expression *expr);
422 struct expression *get_array_offset(struct expression *expr);
423 const char *show_state(struct smatch_state *state);
424 struct statement *get_expression_statement(struct expression *expr);
425 struct expression *strip_parens(struct expression *expr);
426 struct expression *strip_expr(struct expression *expr);
427 struct expression *strip_expr_set_parent(struct expression *expr);
428 void scoped_state(int my_id, const char *name, struct symbol *sym);
429 int is_error_return(struct expression *expr);
430 int getting_address(struct expression *expr);
431 int get_struct_and_member(struct expression *expr, const char **type, const char **member);
432 char *get_member_name(struct expression *expr);
433 char *get_fnptr_name(struct expression *expr);
434 int cmp_pos(struct position pos1, struct position pos2);
435 int positions_eq(struct position pos1, struct position pos2);
436 struct statement *get_current_statement(void);
437 struct statement *get_prev_statement(void);
438 struct expression *get_last_expr_from_expression_stmt(struct expression *expr);
439 int get_param_num_from_sym(struct symbol *sym);
440 int get_param_num(struct expression *expr);
441 int ms_since(struct timeval *start);
442 int parent_is_gone_var_sym(const char *name, struct symbol *sym);
443 int parent_is_gone(struct expression *expr);
444 int invert_op(int op);
445 int op_remove_assign(int op);
446 int expr_equiv(struct expression *one, struct expression *two);
447 void push_int(struct int_stack **stack, int num);
448 int pop_int(struct int_stack **stack);
449 
450 /* smatch_type.c */
451 struct symbol *get_real_base_type(struct symbol *sym);
452 int type_bytes(struct symbol *type);
453 int array_bytes(struct symbol *type);
454 struct symbol *get_pointer_type(struct expression *expr);
455 struct symbol *get_type(struct expression *expr);
456 struct symbol *get_final_type(struct expression *expr);
457 struct symbol *get_promoted_type(struct symbol *left, struct symbol *right);
458 int type_signed(struct symbol *base_type);
459 int expr_unsigned(struct expression *expr);
460 int expr_signed(struct expression *expr);
461 int returns_unsigned(struct symbol *base_type);
462 int is_pointer(struct expression *expr);
463 int returns_pointer(struct symbol *base_type);
464 sval_t sval_type_max(struct symbol *base_type);
465 sval_t sval_type_min(struct symbol *base_type);
466 int nr_bits(struct expression *expr);
467 int is_void_pointer(struct expression *expr);
468 int is_char_pointer(struct expression *expr);
469 int is_string(struct expression *expr);
470 int is_static(struct expression *expr);
471 bool is_local_variable(struct expression *expr);
472 int types_equiv(struct symbol *one, struct symbol *two);
473 int fn_static(void);
474 const char *global_static();
475 struct symbol *cur_func_return_type(void);
476 struct symbol *get_arg_type(struct expression *fn, int arg);
477 struct symbol *get_member_type_from_key(struct expression *expr, const char *key);
478 struct symbol *get_arg_type_from_key(struct expression *fn, int param, struct expression *arg, const char *key);
479 int is_struct(struct expression *expr);
480 char *type_to_str(struct symbol *type);
481 
482 /* smatch_ignore.c */
483 void add_ignore(int owner, const char *name, struct symbol *sym);
484 int is_ignored(int owner, const char *name, struct symbol *sym);
485 void add_ignore_expr(int owner, struct expression *expr);
486 int is_ignored_expr(int owner, struct expression *expr);
487 
488 /* smatch_var_sym */
489 struct var_sym *alloc_var_sym(const char *var, struct symbol *sym);
490 struct var_sym_list *expr_to_vsl(struct expression *expr);
491 void add_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
492 void add_var_sym_expr(struct var_sym_list **list, struct expression *expr);
493 void del_var_sym(struct var_sym_list **list, const char *var, struct symbol *sym);
494 int in_var_sym_list(struct var_sym_list *list, const char *var, struct symbol *sym);
495 struct var_sym_list *clone_var_sym_list(struct var_sym_list *from_vsl);
496 void merge_var_sym_list(struct var_sym_list **dest, struct var_sym_list *src);
497 struct var_sym_list *combine_var_sym_lists(struct var_sym_list *one, struct var_sym_list *two);
498 int var_sym_lists_equiv(struct var_sym_list *one, struct var_sym_list *two);
499 void free_var_sym_list(struct var_sym_list **list);
500 void free_var_syms_and_list(struct var_sym_list **list);
501 
502 /* smatch_tracker */
503 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
504 void add_tracker(struct tracker_list **list, int owner, const char *name,
505 		struct symbol *sym);
506 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
507 void del_tracker(struct tracker_list **list, int owner, const char *name,
508 		struct symbol *sym);
509 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
510 		struct symbol *sym);
511 void free_tracker_list(struct tracker_list **list);
512 void free_trackers_and_list(struct tracker_list **list);
513 
514 /* smatch_conditions */
515 int in_condition(void);
516 
517 /* smatch_flow.c */
518 
519 extern int __in_fake_assign;
520 extern int __in_fake_parameter_assign;
521 extern int __in_fake_struct_assign;
522 extern int in_fake_env;
523 void smatch (struct string_list *filelist);
524 int inside_loop(void);
525 int definitely_inside_loop(void);
526 struct expression *get_switch_expr(void);
527 int in_expression_statement(void);
528 void __process_post_op_stack(void);
529 void __split_expr(struct expression *expr);
530 void __split_label_stmt(struct statement *stmt);
531 void __split_stmt(struct statement *stmt);
532 extern int __in_function_def;
533 extern int __in_unmatched_hook;
534 extern int option_assume_loops;
535 extern int option_two_passes;
536 extern int option_no_db;
537 extern int option_file_output;
538 extern int option_time;
539 extern struct expression_list *big_expression_stack;
540 extern struct expression_list *big_condition_stack;
541 extern struct statement_list *big_statement_stack;
542 int is_assigned_call(struct expression *expr);
543 int inlinable(struct expression *expr);
544 extern int __inline_call;
545 extern struct expression *__inline_fn;
546 extern int __in_pre_condition;
547 extern int __bail_on_rest_of_function;
548 extern struct statement *__prev_stmt;
549 extern struct statement *__cur_stmt;
550 extern struct statement *__next_stmt;
551 void init_fake_env(void);
552 void end_fake_env(void);
553 int time_parsing_function(void);
554 bool taking_too_long(void);
555 
556 /* smatch_struct_assignment.c */
557 struct expression *get_faked_expression(void);
558 void __fake_struct_member_assignments(struct expression *expr);
559 
560 /* smatch_project.c */
561 int is_no_inline_function(const char *function);
562 
563 /* smatch_conditions */
564 void __split_whole_condition(struct expression *expr);
565 void __handle_logic(struct expression *expr);
566 int is_condition(struct expression *expr);
567 int __handle_condition_assigns(struct expression *expr);
568 int __handle_select_assigns(struct expression *expr);
569 int __handle_expr_statement_assigns(struct expression *expr);
570 
571 /* smatch_implied.c */
572 struct range_list_stack;
573 void param_limit_implications(struct expression *expr, int param, char *key, char *value);
574 struct stree *__implied_case_stree(struct expression *switch_expr,
575 				   struct range_list *case_rl,
576 				   struct range_list_stack **remaining_cases,
577 				   struct stree **raw_stree);
578 void overwrite_states_using_pool(struct sm_state *gate_sm, struct sm_state *pool_sm);
579 int assume(struct expression *expr);
580 void end_assume(void);
581 int impossible_assumption(struct expression *left, int op, sval_t sval);
582 
583 /* smatch_slist.h */
584 bool has_dynamic_states(unsigned short owner);
585 void set_dynamic_states(unsigned short owner);
586 
587 /* smatch_extras.c */
588 int in_warn_on_macro(void);
589 #define SMATCH_EXTRA 5 /* this is my_id from smatch extra set in smatch.c */
590 extern int RETURN_ID;
591 
592 struct data_range {
593 	sval_t min;
594 	sval_t max;
595 };
596 
597 #define MTAG_ALIAS_BIT (1ULL << 63)
598 #define MTAG_OFFSET_MASK 0xfffULL
599 #define MTAG_SEED 0xdead << 12
600 
601 const extern unsigned long valid_ptr_min;
602 extern unsigned long valid_ptr_max;
603 extern const sval_t valid_ptr_min_sval;
604 extern sval_t valid_ptr_max_sval;
605 extern struct range_list *valid_ptr_rl;
606 void alloc_valid_ptr_rl(void);
607 
608 static const sval_t array_min_sval = {
609 	.type = &ptr_ctype,
610 	{.value = 100000},
611 };
612 static const sval_t array_max_sval = {
613 	.type = &ptr_ctype,
614 	{.value = ULONG_MAX - 4095},
615 };
616 static const sval_t text_seg_min = {
617 	.type = &ptr_ctype,
618 	{.value = 4096},
619 };
620 static const sval_t text_seg_max = {
621 	.type = &ptr_ctype,
622 	{.value = ULONG_MAX - 4095},
623 };
624 static const sval_t data_seg_min = {
625 	.type = &ptr_ctype,
626 	{.value = 4096},
627 };
628 static const sval_t data_seg_max = {
629 	.type = &ptr_ctype,
630 	{.value = ULONG_MAX - 4095},
631 };
632 static const sval_t bss_seg_min = {
633 	.type = &ptr_ctype,
634 	{.value = 4096},
635 };
636 static const sval_t bss_seg_max = {
637 	.type = &ptr_ctype,
638 	{.value = ULONG_MAX - 4095},
639 };
640 static const sval_t stack_seg_min = {
641 	.type = &ptr_ctype,
642 	{.value = 4096},
643 };
644 static const sval_t stack_seg_max = {
645 	.type = &ptr_ctype,
646 	{.value = ULONG_MAX - 4095},
647 };
648 static const sval_t kmalloc_seg_min = {
649 	.type = &ptr_ctype,
650 	{.value = 4096},
651 };
652 static const sval_t kmalloc_seg_max = {
653 	.type = &ptr_ctype,
654 	{.value = ULONG_MAX - 4095},
655 };
656 static const sval_t vmalloc_seg_min = {
657 	.type = &ptr_ctype,
658 	{.value = 4096},
659 };
660 static const sval_t vmalloc_seg_max = {
661 	.type = &ptr_ctype,
662 	{.value = ULONG_MAX - 4095},
663 };
664 static const sval_t fn_ptr_min = {
665 	.type = &ptr_ctype,
666 	{.value = 4096},
667 };
668 static const sval_t fn_ptr_max = {
669 	.type = &ptr_ctype,
670 	{.value = ULONG_MAX - 4095},
671 };
672 
673 char *get_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
674 char *map_call_to_other_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym);
675 char *map_long_to_short_name_sym(const char *name, struct symbol *sym, struct symbol **new_sym, bool use_stack);
676 
677 #define STRLEN_MAX_RET 1010101
678 
679 /* smatch_absolute.c */
680 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
681 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
682 
683 /* smatch_type_value.c */
684 int get_db_type_rl(struct expression *expr, struct range_list **rl);
685 /* smatch_data_val.c */
686 int get_mtag_rl(struct expression *expr, struct range_list **rl);
687 /* smatch_array_values.c */
688 int get_array_rl(struct expression *expr, struct range_list **rl);
689 
690 /* smatch_states.c */
691 struct stree *__swap_cur_stree(struct stree *stree);
692 void __push_fake_cur_stree();
693 struct stree *__pop_fake_cur_stree();
694 void __free_fake_cur_stree();
695 void __set_fake_cur_stree_fast(struct stree *stree);
696 void __pop_fake_cur_stree_fast(void);
697 void __merge_stree_into_cur(struct stree *stree);
698 
699 int unreachable(void);
700 void __set_cur_stree_readonly(void);
701 void __set_cur_stree_writable(void);
702 void __set_sm(struct sm_state *sm);
703 void __set_sm_cur_stree(struct sm_state *sm);
704 void __set_sm_fake_stree(struct sm_state *sm);
705 void __set_true_false_sm(struct sm_state *true_state,
706 			struct sm_state *false_state);
707 void nullify_path(void);
708 void __match_nullify_path_hook(const char *fn, struct expression *expr,
709 			       void *unused);
710 void __unnullify_path(void);
711 int __path_is_null(void);
712 void save_all_states(void);
713 void restore_all_states(void);
714 void free_goto_stack(void);
715 void clear_all_states(void);
716 
717 struct sm_state *get_sm_state(int owner, const char *name,
718 				struct symbol *sym);
719 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
720 void __push_true_states(void);
721 void __use_false_states(void);
722 void __discard_false_states(void);
723 void __merge_false_states(void);
724 void __merge_true_states(void);
725 
726 void __negate_cond_stacks(void);
727 void __use_pre_cond_states(void);
728 void __use_cond_true_states(void);
729 void __use_cond_false_states(void);
730 void __push_cond_stacks(void);
731 void __fold_in_set_states(void);
732 void __free_set_states(void);
733 struct stree *__copy_cond_true_states(void);
734 struct stree *__copy_cond_false_states(void);
735 struct stree *__pop_cond_true_stack(void);
736 struct stree *__pop_cond_false_stack(void);
737 void __and_cond_states(void);
738 void __or_cond_states(void);
739 void __save_pre_cond_states(void);
740 void __discard_pre_cond_states(void);
741 struct stree *__get_true_states(void);
742 struct stree *__get_false_states(void);
743 void __use_cond_states(void);
744 extern struct state_list *__last_base_slist;
745 
746 void __push_continues(void);
747 void __discard_continues(void);
748 void __process_continues(void);
749 void __merge_continues(void);
750 
751 void __push_breaks(void);
752 void __process_breaks(void);
753 int __has_breaks(void);
754 void __merge_breaks(void);
755 void __use_breaks(void);
756 
757 void __save_switch_states(struct expression *switch_expr);
758 void __discard_switches(void);
759 int have_remaining_cases(void);
760 void __merge_switches(struct expression *switch_expr, struct range_list *case_rl);
761 void __push_default(void);
762 void __set_default(void);
763 int __pop_default(void);
764 
765 void __push_conditions(void);
766 void __discard_conditions(void);
767 
768 void __save_gotos(const char *name, struct symbol *sym);
769 void __merge_gotos(const char *name, struct symbol *sym);
770 
771 void __print_cur_stree(void);
772 
773 /* smatch_hooks.c */
774 void __pass_to_client(void *data, enum hook_type type);
775 void __pass_case_to_client(struct expression *switch_expr,
776 			   struct range_list *rl);
777 int __has_merge_function(int client_id);
778 struct smatch_state *__client_merge_function(int owner,
779 					     struct smatch_state *s1,
780 					     struct smatch_state *s2);
781 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
782 void call_pre_merge_hook(struct sm_state *cur, struct sm_state *other);
783 void __push_scope_hooks(void);
784 void __call_scope_hooks(void);
785 
786 /* smatch_function_hooks.c */
787 void create_function_hook_hash(void);
788 void __match_initializer_call(struct symbol *sym);
789 
790 /* smatch_db.c */
791 enum info_type {
792 	INTERNAL	= 0,
793 	/*
794 	 * Changing these numbers is a pain.  Don't do it.  If you ever use a
795 	 * number it can't be re-used right away so there may be gaps.
796 	 * We select these in order by type so if the order matters, then give
797 	 * it a number below 100-999,9000-9999 ranges. */
798 
799 	PARAM_CLEARED	= 101,
800 	PARAM_LIMIT	= 103,
801 	PARAM_FILTER	= 104,
802 
803 	PARAM_VALUE	= 1001,
804 	BUF_SIZE	= 1002,
805 	CAPPED_DATA	= 1004,
806 	RETURN_VALUE	= 1005,
807 	DEREFERENCE	= 1006,
808 	RANGE_CAP	= 1007,
809 	LOCK_HELD	= 1008,
810 	LOCK_RELEASED	= 1009,
811 	ABSOLUTE_LIMITS	= 1010,
812 	PARAM_ADD	= 1012,
813 	PARAM_FREED	= 1013,
814 	DATA_SOURCE	= 1014,
815 	FUZZY_MAX	= 1015,
816 	HARD_MAX	= 2015,
817 	STR_LEN		= 1016,
818 	ARRAY_LEN	= 1017,
819 	CAPABLE		= 1018,
820 	NS_CAPABLE	= 1019,
821 	CONTAINER	= 1020,
822 	CASTED_CALL	= 1021,
823 	TYPE_LINK	= 1022,
824 	UNTRACKED_PARAM = 1023,
825 	LOST_PARAM	= 2023,
826 	CULL_PATH	= 1024,
827 	PARAM_SET	= 1025,
828 	PARAM_USED	= 1026,
829 	BYTE_UNITS      = 1027,
830 	COMPARE_LIMIT	= 1028,
831 	PARAM_COMPARE	= 1029,
832 	CONSTRAINT	= 1031,
833 	PASSES_TYPE	= 1032,
834 	CONSTRAINT_REQUIRED = 1033,
835 	BIT_INFO	= 1034,
836 	NOSPEC		= 1035,
837 	NOSPEC_WB	= 1036,
838 	STMT_CNT	= 1037,
839 	TERMINATED	= 1038,
840 
841 	/* put random temporary stuff in the 7000-7999 range for testing */
842 	USER_DATA	= 8017,
843 	USER_DATA_SET	= 9017,
844 	NO_OVERFLOW	= 8018,
845 	NO_OVERFLOW_SIMPLE = 8019,
846 	LOCKED		= 8020,
847 	UNLOCKED	= 8021,
848 	SET_FS		= 8022,
849 	ATOMIC_INC	= 8023,
850 	ATOMIC_DEC	= 8024,
851 	NO_SIDE_EFFECT  = 8025,
852 	FN_ARG_LINK	= 8028,
853 	DATA_VALUE	= 8029,
854 	ARRAYSIZE_ARG	= 8033,
855 	SIZEOF_ARG	= 8034,
856 	MEMORY_TAG	= 8036,
857 	MTAG_ASSIGN	= 8035,
858 	STRING_VALUE	= 8041,
859 
860 	BYTE_COUNT	= 8050,
861 	ELEM_COUNT	= 8051,
862 	ELEM_LAST	= 8052,
863 	USED_LAST	= 8053,
864 	USED_COUNT	= 8054,
865 };
866 
867 extern struct sqlite3 *smatch_db;
868 extern struct sqlite3 *mem_db;
869 extern struct sqlite3 *cache_db;
870 
871 void db_ignore_states(int id);
872 void select_caller_info_hook(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
873 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct sm_state *sm));
874 void add_split_return_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr));
875 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));
876 void select_call_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
877 void select_return_implies_hook(int type, void (*callback)(struct expression *call, struct expression *arg, char *key, char *value));
878 struct range_list *db_return_vals(struct expression *expr);
879 struct range_list *db_return_vals_from_str(const char *fn_name);
880 struct range_list *db_return_vals_no_args(struct expression *expr);
881 char *return_state_to_var_sym(struct expression *expr, int param, const char *key, struct symbol **sym);
882 char *get_chunk_from_key(struct expression *arg, char *key, struct symbol **sym, struct var_sym_list **vsl);
883 char *get_variable_from_key(struct expression *arg, const char *key, struct symbol **sym);
884 const char *state_name_to_param_name(const char *state_name, const char *param_name);
885 const char *get_param_name_var_sym(const char *name, struct symbol *sym);
886 const char *get_param_name(struct sm_state *sm);
887 const char *get_mtag_name_var_sym(const char *state_name, struct symbol *sym);
888 const char *get_mtag_name_expr(struct expression *expr);
889 char *get_data_info_name(struct expression *expr);
890 int is_recursive_member(const char *param_name);
891 
892 char *escape_newlines(const char *str);
893 void sql_exec(struct sqlite3 *db, int (*callback)(void*, int, char**, char**), void *data, const char *sql);
894 
895 #define sql_helper(db, call_back, data, sql...)					\
896 do {										\
897 	char sql_txt[1024];							\
898 										\
899 	sqlite3_snprintf(sizeof(sql_txt), sql_txt, sql);			\
900 	sm_debug("debug: %s\n", sql_txt);					\
901 	sql_exec(db, call_back, data, sql_txt);					\
902 } while (0)
903 
904 
905 #define run_sql(call_back, data, sql...)					\
906 do {										\
907 	if (option_no_db)							\
908 		break;								\
909 	sql_helper(smatch_db, call_back, data, sql);				\
910 } while (0)
911 
912 #define mem_sql(call_back, data, sql...)					\
913 	sql_helper(mem_db, call_back, data, sql)
914 
915 #define cache_sql(call_back, data, sql...)					\
916 	sql_helper(cache_db, call_back, data, sql)
917 
918 #define sql_insert_helper(table, db, ignore, late, values...)			\
919 do {										\
920 	struct sqlite3 *_db = db;						\
921 										\
922 	if (__inline_fn && !_db)						\
923 		_db = mem_db;							\
924 	if (_db) {								\
925 		char buf[1024];							\
926 		char *err, *p = buf;						\
927 		int rc;								\
928 										\
929 		p += snprintf(p, buf + sizeof(buf) - p,				\
930 			      "insert %sinto %s values (",			\
931 			      ignore ? "or ignore " : "", #table);		\
932 		p += snprintf(p, buf + sizeof(buf) - p, values);		\
933 		p += snprintf(p, buf + sizeof(buf) - p, ");");			\
934 		sm_debug("mem-db: %s\n", buf);					\
935 		rc = sqlite3_exec(_db, buf, NULL, NULL, &err);			\
936 		if (rc != SQLITE_OK) {						\
937 			sm_ierror("SQL error #2: %s", err);			\
938 			sm_ierror("SQL: '%s'", buf);				\
939 			parse_error = 1;					\
940 		}								\
941 		break;								\
942 	}									\
943 	if (option_info) {							\
944 		FILE *tmp_fd = sm_outfd;					\
945 		sm_outfd = sql_outfd;						\
946 		sm_prefix();							\
947 	        sm_printf("SQL%s: insert %sinto " #table " values(",		\
948 			  late ? "_late" : "", ignore ? "or ignore " : "");	\
949 	        sm_printf(values);						\
950 	        sm_printf(");\n");						\
951 		sm_outfd = tmp_fd;						\
952 	}									\
953 } while (0)
954 
955 #define sql_insert(table, values...) sql_insert_helper(table, 0, 0, 0, values);
956 #define sql_insert_or_ignore(table, values...) sql_insert_helper(table, 0, 1, 0, values);
957 #define sql_insert_late(table, values...) sql_insert_helper(table, 0, 0, 1, values);
958 #define sql_insert_cache(table, values...) sql_insert_helper(table, cache_db, 1, 0, values);
959 
960 char *get_static_filter(struct symbol *sym);
961 
962 void sql_insert_return_states(int return_id, const char *return_ranges,
963 		int type, int param, const char *key, const char *value);
964 void sql_insert_caller_info(struct expression *call, int type, int param,
965 		const char *key, const char *value);
966 void sql_insert_function_ptr(const char *fn, const char *struct_name);
967 void sql_insert_return_values(const char *return_values);
968 void sql_insert_return_implies(int type, int param, const char *key, const char *value);
969 void sql_insert_function_type_size(const char *member, const char *ranges);
970 void sql_insert_function_type_info(int type, const char *struct_type, const char *member, const char *value);
971 void sql_insert_type_info(int type, const char *member, const char *value);
972 void sql_insert_local_values(const char *name, const char *value);
973 void sql_insert_function_type_value(const char *type, const char *value);
974 void sql_insert_function_type(int param, const char *value);
975 void sql_insert_parameter_name(int param, const char *value);
976 void sql_insert_data_info(struct expression *data, int type, const char *value);
977 void sql_insert_data_info_var_sym(const char *var, struct symbol *sym, int type, const char *value);
978 void sql_save_constraint(const char *con);
979 void sql_save_constraint_required(const char *data, int op, const char *limit);
980 void sql_copy_constraint_required(const char *new_limit, const char *old_limit);
981 void sql_insert_fn_ptr_data_link(const char *ptr, const char *data);
982 void sql_insert_fn_data_link(struct expression *fn, int type, int param, const char *key, const char *value);
983 void sql_insert_mtag_about(mtag_t tag, const char *left_name, const char *right_name);
984 void sql_insert_mtag_map(mtag_t tag, int offset, mtag_t container);
985 void sql_insert_mtag_alias(mtag_t orig, mtag_t alias);
986 int mtag_map_select_container(mtag_t tag, int offset, mtag_t *container);
987 int mtag_map_select_tag(mtag_t container, int offset, mtag_t *tag);
988 struct smatch_state *swap_mtag_return(struct expression *expr, struct smatch_state *state);
989 struct range_list *swap_mtag_seed(struct expression *expr, struct range_list *rl);
990 
991 void sql_select_return_states(const char *cols, struct expression *call,
992 	int (*callback)(void*, int, char**, char**), void *info);
993 void sql_select_call_implies(const char *cols, struct expression *call,
994 	int (*callback)(void*, int, char**, char**));
995 
996 void open_smatch_db(char *db_file);
997 
998 /* smatch_files.c */
999 int open_data_file(const char *filename);
1000 int open_schema_file(const char *schema);
1001 struct token *get_tokens_file(const char *filename);
1002 
1003 /* smatch.c */
1004 extern char *option_debug_check;
1005 extern char *option_project_str;
1006 extern char *bin_dir;
1007 extern char *data_dir;
1008 extern int option_no_data;
1009 extern int option_full_path;
1010 extern int option_param_mapper;
1011 extern int option_call_tree;
1012 extern int num_checks;
1013 
1014 enum project_type {
1015 	PROJ_NONE,
1016 	PROJ_KERNEL,
1017 	PROJ_WINE,
1018 	PROJ_ILLUMOS_KERNEL,
1019 	PROJ_ILLUMOS_USER,
1020 	PROJ_UNKNOWN,
1021 };
1022 extern enum project_type option_project;
1023 const char *check_name(unsigned short id);
1024 int id_from_name(const char *name);
1025 
1026 
1027 /* smatch_buf_size.c */
1028 int get_array_size(struct expression *expr);
1029 int get_array_size_bytes(struct expression *expr);
1030 int get_array_size_bytes_min(struct expression *expr);
1031 int get_array_size_bytes_max(struct expression *expr);
1032 struct range_list *get_array_size_bytes_rl(struct expression *expr);
1033 int get_real_array_size(struct expression *expr);
1034 int last_member_is_resizable(struct symbol *type);
1035 /* smatch_strlen.c */
1036 int get_implied_strlen(struct expression *expr, struct range_list **rl);
1037 int get_size_from_strlen(struct expression *expr);
1038 
1039 /* smatch_capped.c */
1040 int is_capped(struct expression *expr);
1041 int is_capped_var_sym(const char *name, struct symbol *sym);
1042 
1043 /* check_user_data.c */
1044 int is_user_macro(struct expression *expr);
1045 int is_capped_user_data(struct expression *expr);
1046 int implied_user_data(struct expression *expr, struct range_list **rl);
1047 struct stree *get_user_stree(void);
1048 int get_user_rl(struct expression *expr, struct range_list **rl);
1049 int is_user_rl(struct expression *expr);
1050 int get_user_rl_var_sym(const char *name, struct symbol *sym, struct range_list **rl);
1051 bool user_rl_capped(struct expression *expr);
1052 struct range_list *var_user_rl(struct expression *expr);
1053 
1054 /* check_locking.c */
1055 void print_held_locks();
1056 
1057 /* check_assigned_expr.c */
1058 struct expression *get_assigned_expr(struct expression *expr);
1059 struct expression *get_assigned_expr_name_sym(const char *name, struct symbol *sym);
1060 /* smatch_return_to_param.c */
1061 void __add_return_to_param_mapping(struct expression *assign, const char *return_string);
1062 char *map_call_to_param_name_sym(struct expression *expr, struct symbol **sym);
1063 
1064 /* smatch_comparison.c */
1065 #define UNKNOWN_COMPARISON 0
1066 #define IMPOSSIBLE_COMPARISON -1
1067 struct compare_data {
1068 	/* The ->left and ->right expression pointers might be NULL (I'm lazy) */
1069 	struct expression *left;
1070 	const char *left_var;
1071 	struct var_sym_list *left_vsl;
1072 	int comparison;
1073 	struct expression *right;
1074 	const char *right_var;
1075 	struct var_sym_list *right_vsl;
1076 };
1077 DECLARE_ALLOCATOR(compare_data);
1078 struct smatch_state *alloc_compare_state(
1079 		struct expression *left,
1080 		const char *left_var, struct var_sym_list *left_vsl,
1081 		int comparison,
1082 		struct expression *right,
1083 		const char *right_var, struct var_sym_list *right_vsl);
1084 int comparison_intersection(int orig, int op);
1085 int merge_comparisons(int one, int two);
1086 int combine_comparisons(int left_compare, int right_compare);
1087 int state_to_comparison(struct smatch_state *state);
1088 struct smatch_state *merge_compare_states(struct smatch_state *s1, struct smatch_state *s2);
1089 int get_comparison(struct expression *left, struct expression *right);
1090 int get_comparison_no_extra(struct expression *a, struct expression *b);
1091 int get_comparison_strings(const char *one, const char *two);
1092 int possible_comparison(struct expression *a, int comparison, struct expression *b);
1093 struct state_list *get_all_comparisons(struct expression *expr);
1094 struct state_list *get_all_possible_equal_comparisons(struct expression *expr);
1095 void __add_return_comparison(struct expression *call, const char *range);
1096 void __add_comparison_info(struct expression *expr, struct expression *call, const char *range);
1097 char *get_printed_param_name(struct expression *call, const char *param_name, struct symbol *param_sym);
1098 char *name_sym_to_param_comparison(const char *name, struct symbol *sym);
1099 char *expr_equal_to_param(struct expression *expr, int ignore);
1100 char *expr_lte_to_param(struct expression *expr, int ignore);
1101 char *expr_param_comparison(struct expression *expr, int ignore);
1102 int flip_comparison(int op);
1103 int negate_comparison(int op);
1104 int remove_unsigned_from_comparison(int op);
1105 int param_compare_limit_is_impossible(struct expression *expr, int left_param, char *left_key, char *value);
1106 void filter_by_comparison(struct range_list **rl, int comparison, struct range_list *right);
1107 struct sm_state *comparison_implication_hook(struct expression *expr,
1108 			struct state_list **true_stack,
1109 			struct state_list **false_stack);
1110 void __compare_param_limit_hook(struct expression *left_expr, struct expression *right_expr,
1111 				const char *state_name,
1112 				struct smatch_state *true_state, struct smatch_state *false_state);
1113 int impossibly_high_comparison(struct expression *expr);
1114 
1115 /* smatch_sval.c */
1116 sval_t *sval_alloc(sval_t sval);
1117 sval_t *sval_alloc_permanent(sval_t sval);
1118 sval_t sval_blank(struct expression *expr);
1119 sval_t sval_type_val(struct symbol *type, long long val);
1120 sval_t sval_from_val(struct expression *expr, long long val);
1121 int sval_is_ptr(sval_t sval);
1122 int sval_unsigned(sval_t sval);
1123 int sval_signed(sval_t sval);
1124 int sval_bits(sval_t sval);
1125 int sval_bits_used(sval_t sval);
1126 int sval_is_negative(sval_t sval);
1127 int sval_is_positive(sval_t sval);
1128 int sval_is_min(sval_t sval);
1129 int sval_is_max(sval_t sval);
1130 int sval_is_a_min(sval_t sval);
1131 int sval_is_a_max(sval_t sval);
1132 int sval_is_negative_min(sval_t sval);
1133 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
1134 int sval_cmp_val(sval_t one, long long val);
1135 sval_t sval_min(sval_t one, sval_t two);
1136 sval_t sval_max(sval_t one, sval_t two);
1137 int sval_too_low(struct symbol *type, sval_t sval);
1138 int sval_too_high(struct symbol *type, sval_t sval);
1139 int sval_fits(struct symbol *type, sval_t sval);
1140 sval_t sval_cast(struct symbol *type, sval_t sval);
1141 sval_t sval_preop(sval_t sval, int op);
1142 sval_t sval_binop(sval_t left, int op, sval_t right);
1143 int sval_binop_overflows(sval_t left, int op, sval_t right);
1144 int sval_binop_overflows_no_sign(sval_t left, int op, sval_t right);
1145 int find_first_zero_bit(unsigned long long uvalue);
1146 int sm_fls64(unsigned long long uvalue);
1147 unsigned long long fls_mask(unsigned long long uvalue);
1148 unsigned long long sval_fls_mask(sval_t sval);
1149 const char *sval_to_str(sval_t sval);
1150 const char *sval_to_str_or_err_ptr(sval_t sval);
1151 const char *sval_to_numstr(sval_t sval);
1152 sval_t ll_to_sval(long long val);
1153 
1154 /* smatch_string_list.c */
1155 int list_has_string(struct string_list *str_list, const char *str);
1156 int insert_string(struct string_list **str_list, const char *str);
1157 struct string_list *clone_str_list(struct string_list *orig);
1158 struct string_list *combine_string_lists(struct string_list *one, struct string_list *two);
1159 
1160 /* smatch_start_states.c */
1161 struct stree *get_start_states(void);
1162 
1163 /* smatch_recurse.c */
1164 int has_symbol(struct expression *expr, struct symbol *sym);
1165 int has_variable(struct expression *expr, struct expression *var);
1166 int has_inc_dec(struct expression *expr);
1167 
1168 /* smatch_stored_conditions.c */
1169 struct smatch_state *get_stored_condition(struct expression *expr);
1170 struct expression_list *get_conditions(struct expression *expr);
1171 struct sm_state *stored_condition_implication_hook(struct expression *expr,
1172 			struct state_list **true_stack,
1173 			struct state_list **false_stack);
1174 
1175 /* check_string_len.c */
1176 int get_formatted_string_size(struct expression *call, int arg);
1177 int get_formatted_string_min_size(struct expression *call, int arg);
1178 
1179 /* smatch_param_set.c */
1180 int param_was_set(struct expression *expr);
1181 int param_was_set_var_sym(const char *name, struct symbol *sym);
1182 void print_limited_param_set(int return_id, char *return_ranges, struct expression *expr);
1183 /* smatch_param_filter.c */
1184 int param_has_filter_data(struct sm_state *sm);
1185 
1186 /* smatch_links.c */
1187 void set_up_link_functions(int id, int linkid);
1188 struct smatch_state *merge_link_states(struct smatch_state *s1, struct smatch_state *s2);
1189 void store_link(int link_id, const char *name, struct symbol *sym, const char *link_name, struct symbol *link_sym);
1190 
1191 /* check_buf_comparison */
1192 const char *limit_type_str(unsigned int limit_type);
1193 struct expression *get_size_variable(struct expression *buf, int *limit_type);
1194 struct expression *get_array_variable(struct expression *size);
1195 int buf_comparison_index_ok(struct expression *expr);
1196 
1197 /* smatch_untracked_param.c */
1198 void mark_untracked(struct expression *expr, int param, const char *key, const char *value);
1199 void add_untracked_param_hook(void (func)(struct expression *call, int param));
1200 void add_lost_param_hook(void (func)(struct expression *call, int param));
1201 void mark_all_params_untracked(int return_id, char *return_ranges, struct expression *expr);
1202 
1203 /* smatch_strings.c */
1204 struct state_list *get_strings(struct expression *expr);
1205 struct expression *fake_string_from_mtag(mtag_t tag);
1206 
1207 /* smatch_estate.c */
1208 int estate_get_single_value(struct smatch_state *state, sval_t *sval);
1209 
1210 /* smatch_address.c */
1211 int get_address_rl(struct expression *expr, struct range_list **rl);
1212 int get_member_offset(struct symbol *type, const char *member_name);
1213 int get_member_offset_from_deref(struct expression *expr);
1214 
1215 /* for now this is in smatch_used_parameter.c */
1216 void __get_state_hook(int owner, const char *name, struct symbol *sym);
1217 
1218 /* smatch_buf_comparison.c */
1219 int db_var_is_array_limit(struct expression *array, const char *name, struct var_sym_list *vsl);
1220 
1221 struct stree *get_all_return_states(void);
1222 struct stree_stack *get_all_return_strees(void);
1223 int on_atomic_dec_path(void);
1224 int was_inced(const char *name, struct symbol *sym);
1225 
1226 /* smatch_constraints.c */
1227 char *get_constraint_str(struct expression *expr);
1228 struct constraint_list *get_constraints(struct expression *expr);
1229 char *unmet_constraint(struct expression *data, struct expression *offset);
1230 char *get_required_constraint(const char *data_str);
1231 
1232 /* smatch_container_of.c */
1233 int get_param_from_container_of(struct expression *expr);
1234 int get_offset_from_container_of(struct expression *expr);
1235 char *get_container_name(struct expression *container, struct expression *expr);
1236 
1237 /* smatch_mtag.c */
1238 int get_string_mtag(struct expression *expr, mtag_t *tag);
1239 int get_toplevel_mtag(struct symbol *sym, mtag_t *tag);
1240 int create_mtag_alias(mtag_t tag, struct expression *expr, mtag_t *new);
1241 int expr_to_mtag_offset(struct expression *expr, mtag_t *tag, int *offset);
1242 void update_mtag_data(struct expression *expr, struct smatch_state *state);
1243 int get_mtag_sval(struct expression *expr, sval_t *sval);
1244 
1245 /* Trinity fuzzer stuff */
1246 const char *get_syscall_arg_type(struct symbol *sym);
1247 
1248 /* smatch_bit_info.c */
1249 struct bit_info *rl_to_binfo(struct range_list *rl);
1250 struct bit_info *get_bit_info(struct expression *expr);
1251 struct bit_info *get_bit_info_var_sym(const char *name, struct symbol *sym);
1252 /* smatch_mem_tracker.c */
1253 extern int option_mem;
1254 unsigned long get_mem_kb(void);
1255 unsigned long get_max_memory(void);
1256 
1257 /* check_is_nospec.c */
1258 bool is_nospec(struct expression *expr);
1259 long get_stmt_cnt(void);
1260 
1261 /* smatch_nul_terminator.c */
1262 bool is_nul_terminated_var_sym(const char *name, struct symbol *sym);
1263 bool is_nul_terminated(struct expression *expr);
1264 /* check_kernel.c  */
1265 bool is_ignored_kernel_data(const char *name);
1266 
1267 static inline bool type_is_ptr(struct symbol *type)
1268 {
1269 	return type &&
1270 	       (type->type == SYM_PTR ||
1271 		type->type == SYM_ARRAY ||
1272 		type->type == SYM_FN);
1273 }
1274 
1275 static inline int type_bits(struct symbol *type)
1276 {
1277 	if (!type)
1278 		return 0;
1279 	if (type_is_ptr(type))
1280 		return bits_in_pointer;
1281 	if (!type->examined)
1282 		examine_symbol_type(type);
1283 	return type->bit_size;
1284 }
1285 
1286 static inline int type_unsigned(struct symbol *base_type)
1287 {
1288 	if (!base_type)
1289 		return 0;
1290 	if (is_ptr_type(base_type))
1291 		return 1;
1292 	if (base_type->ctype.modifiers & MOD_UNSIGNED)
1293 		return 1;
1294 	return 0;
1295 }
1296 
1297 static inline int type_positive_bits(struct symbol *type)
1298 {
1299 	if (!type)
1300 		return 0;
1301 	if (is_ptr_type(type))
1302 		return bits_in_pointer;
1303 	if (type_unsigned(type))
1304 		return type_bits(type);
1305 	return type_bits(type) - 1;
1306 }
1307 
1308 static inline int sval_positive_bits(sval_t sval)
1309 {
1310 	return type_positive_bits(sval.type);
1311 }
1312 
1313 /*
1314  * Returns -1 if one is smaller, 0 if they are the same and 1 if two is larger.
1315  */
1316 static inline int sval_cmp(sval_t one, sval_t two)
1317 {
1318 	struct symbol *type;
1319 
1320 	type = one.type;
1321 	if (sval_positive_bits(two) > sval_positive_bits(one))
1322 		type = two.type;
1323 	if (type_bits(type) < 31)
1324 		type = &int_ctype;
1325 
1326 	one = sval_cast(type, one);
1327 	two = sval_cast(type, two);
1328 
1329 	if (type_unsigned(type)) {
1330 		if (one.uvalue < two.uvalue)
1331 			return -1;
1332 		if (one.uvalue == two.uvalue)
1333 			return 0;
1334 		return 1;
1335 	}
1336 	/* fix me handle type promotion and unsigned values */
1337 	if (one.value < two.value)
1338 		return -1;
1339 	if (one.value == two.value)
1340 		return 0;
1341 	return 1;
1342 }
1343 
1344 #endif 	    /* !SMATCH_H_ */
1345