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