locking: ignore parenthesis
[smatch.git] / smatch.h
blobea84876ceb8517b30761a62467664ba107ce118e
1 /*
2 * sparse/smatch.h
4 * Copyright (C) 2006 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
8 */
10 #ifndef SMATCH_H_
11 # define SMATCH_H_
13 #include <stdio.h>
14 #include <string.h>
15 #include <limits.h>
16 #include "lib.h"
17 #include "allocate.h"
18 #include "parse.h"
19 #include "expression.h"
21 typedef struct {
22 struct symbol *type;
23 union {
24 long long value;
25 unsigned long long uvalue;
27 } sval_t;
29 struct smatch_state {
30 const char *name;
31 void *data;
33 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
34 extern struct smatch_state undefined;
35 extern struct smatch_state merged;
36 extern struct smatch_state true_state;
37 extern struct smatch_state false_state;
38 DECLARE_ALLOCATOR(smatch_state);
40 static inline void *INT_PTR(int i)
42 return (void *)(long)i;
45 static inline int PTR_INT(void *p)
47 return (int)(long)p;
50 struct sm_state {
51 unsigned short owner;
52 unsigned int merged:1;
53 unsigned int implied:1;
54 const char *name;
55 struct symbol *sym;
56 struct smatch_state *state;
57 unsigned int line;
58 struct state_list *pool;
59 struct sm_state *left;
60 struct sm_state *right;
61 unsigned int nr_children;
62 struct state_list *possible;
65 struct tracker {
66 int owner;
67 char *name;
68 struct symbol *sym;
70 DECLARE_ALLOCATOR(tracker);
71 DECLARE_PTR_LIST(tracker_list, struct tracker);
73 enum hook_type {
74 EXPR_HOOK,
75 STMT_HOOK,
76 SYM_HOOK,
77 STRING_HOOK,
78 DECLARATION_HOOK,
79 ASSIGNMENT_HOOK,
80 RAW_ASSIGNMENT_HOOK,
81 GLOBAL_ASSIGNMENT_HOOK,
82 LOGIC_HOOK,
83 CONDITION_HOOK,
84 PRELOOP_HOOK,
85 SELECT_HOOK,
86 WHOLE_CONDITION_HOOK,
87 FUNCTION_CALL_HOOK,
88 CALL_HOOK_AFTER_INLINE,
89 CALL_ASSIGNMENT_HOOK,
90 MACRO_ASSIGNMENT_HOOK,
91 BINOP_HOOK,
92 OP_HOOK,
93 DEREF_HOOK,
94 CASE_HOOK,
95 ASM_HOOK,
96 CAST_HOOK,
97 SIZEOF_HOOK,
98 BASE_HOOK,
99 FUNC_DEF_HOOK,
100 AFTER_DEF_HOOK,
101 END_FUNC_HOOK,
102 RETURN_HOOK,
103 INLINE_FN_START,
104 INLINE_FN_END,
105 END_FILE_HOOK,
108 #define TRUE 1
109 #define FALSE 0
111 struct range_list;
113 void add_hook(void *func, enum hook_type type);
114 typedef struct smatch_state *(merge_func_t)(struct smatch_state *s1, struct smatch_state *s2);
115 typedef struct smatch_state *(unmatched_func_t)(struct sm_state *state);
116 void add_merge_hook(int client_id, merge_func_t *func);
117 void add_unmatched_state_hook(int client_id, unmatched_func_t *func);
118 typedef void (scope_hook)(void *data);
119 void add_scope_hook(scope_hook *hook, void *data);
120 typedef void (func_hook)(const char *fn, struct expression *expr, void *data);
121 typedef void (implication_hook)(const char *fn, struct expression *call_expr,
122 struct expression *assign_expr, void *data);
123 typedef void (return_implies_hook)(struct expression *call_expr,
124 int param, char *key, char *value);
125 typedef int (implied_return_hook)(struct expression *call_expr, void *info, struct range_list **rl);
126 void add_function_hook(const char *look_for, func_hook *call_back, void *data);
128 void add_function_assign_hook(const char *look_for, func_hook *call_back,
129 void *info);
130 void add_implied_return_hook(const char *look_for,
131 implied_return_hook *call_back,
132 void *info);
133 void add_macro_assign_hook(const char *look_for, func_hook *call_back,
134 void *info);
135 void add_macro_assign_hook_extra(const char *look_for, func_hook *call_back,
136 void *info);
137 void return_implies_state(const char *look_for, long long start, long long end,
138 implication_hook *call_back, void *info);
139 void add_db_return_states_callback(int type, return_implies_hook *callback);
140 void add_db_return_states_before(void (*fn)(void));
141 void add_db_return_states_after(void (*fn)(void));
142 int get_implied_return(struct expression *expr, struct range_list **rl);
144 typedef void (modification_hook)(struct sm_state *sm);
145 void add_modification_hook(int owner, modification_hook *call_back);
146 void add_indirect_modification_hook(int owner, modification_hook *call_back);
148 const char *get_filename(void);
149 char *get_function(void);
150 int get_lineno(void);
151 extern int final_pass;
152 extern struct symbol *cur_func_sym;
153 extern int option_debug;
154 extern int local_debug;
156 extern FILE *sm_outfd;
157 #define sm_printf(msg...) do { if (final_pass || option_debug) fprintf(sm_outfd, msg); } while (0)
159 static inline void sm_prefix(void)
161 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
164 static inline void print_implied_debug_msg();
166 #define sm_msg(msg...) \
167 do { \
168 print_implied_debug_msg(); \
169 if (!option_debug && !final_pass) \
170 break; \
171 sm_prefix(); \
172 sm_printf(msg); \
173 sm_printf("\n"); \
174 } while (0)
176 #define local_debug(msg...) \
177 do { \
178 if (local_debug) \
179 sm_msg(msg); \
180 } while (0)
182 extern char *implied_debug_msg;
183 static inline void print_implied_debug_msg()
185 static struct symbol *last_printed = NULL;
187 if (!implied_debug_msg)
188 return;
189 if (last_printed == cur_func_sym)
190 return;
191 last_printed = cur_func_sym;
192 sm_msg("%s", implied_debug_msg);
195 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
197 #define sm_info(msg...) do { \
198 if (option_debug || (option_info && final_pass)) { \
199 sm_prefix(); \
200 sm_printf("info: "); \
201 sm_printf(msg); \
202 sm_printf("\n"); \
204 } while(0)
206 struct smatch_state *get_state(int owner, const char *name, struct symbol *sym);
207 struct smatch_state *get_state_expr(int owner, struct expression *expr);
208 struct state_list *get_possible_states(int owner, const char *name,
209 struct symbol *sym);
210 struct state_list *get_possible_states_expr(int owner, struct expression *expr);
211 struct sm_state *set_state(int owner, const char *name, struct symbol *sym,
212 struct smatch_state *state);
213 struct sm_state *set_state_expr(int owner, struct expression *expr,
214 struct smatch_state *state);
215 void delete_state(int owner, const char *name, struct symbol *sym);
216 void delete_state_expr(int owner, struct expression *expr);
217 void set_true_false_states(int owner, const char *name, struct symbol *sym,
218 struct smatch_state *true_state,
219 struct smatch_state *false_state);
220 void set_true_false_states_expr(int owner, struct expression *expr,
221 struct smatch_state *true_state,
222 struct smatch_state *false_state);
224 struct state_list *get_all_states_slist(int owner, struct state_list *source);
225 struct state_list *get_all_states(int id);
226 int is_reachable(void);
228 /* smatch_helper.c */
229 char *alloc_string(const char *str);
230 void free_string(char *str);
231 struct smatch_state *alloc_state_num(int num);
232 struct expression *get_argument_from_call_expr(struct expression_list *args,
233 int num);
235 char *expr_to_var(struct expression *expr);
236 char *expr_to_str(struct expression *expr);
237 char *expr_to_str_sym(struct expression *expr,
238 struct symbol **sym_ptr);
239 char *expr_to_var_sym(struct expression *expr,
240 struct symbol **sym_ptr);
242 int sym_name_is(const char *name, struct expression *expr);
243 int get_value(struct expression *expr, sval_t *val);
244 int get_implied_value(struct expression *expr, sval_t *val);
245 int get_implied_min(struct expression *expr, sval_t *sval);
246 int get_implied_max(struct expression *expr, sval_t *val);
247 int get_hard_max(struct expression *expr, sval_t *sval);
248 int get_fuzzy_min(struct expression *expr, sval_t *min);
249 int get_fuzzy_max(struct expression *expr, sval_t *max);
250 int get_absolute_min(struct expression *expr, sval_t *sval);
251 int get_absolute_max(struct expression *expr, sval_t *sval);
252 int parse_call_math(struct expression *expr, char *math, sval_t *val);
253 int is_zero(struct expression *expr);
254 int known_condition_true(struct expression *expr);
255 int known_condition_false(struct expression *expr);
256 int implied_condition_true(struct expression *expr);
257 int implied_condition_false(struct expression *expr);
259 int is_array(struct expression *expr);
260 struct expression *get_array_name(struct expression *expr);
261 struct expression *get_array_offset(struct expression *expr);
262 const char *show_state(struct smatch_state *state);
263 struct statement *get_expression_statement(struct expression *expr);
264 struct expression *strip_parens(struct expression *expr);
265 struct expression *strip_expr(struct expression *expr);
266 void scoped_state(int my_id, const char *name, struct symbol *sym);
267 int is_error_return(struct expression *expr);
268 int getting_address(void);
269 char *get_member_name(struct expression *expr);
270 char *get_fnptr_name(struct expression *expr);
271 int positions_eq(struct position pos1, struct position pos2);
272 struct statement *get_current_statement(void);
273 int get_param_num_from_sym(struct symbol *sym);
275 /* smatch_type.c */
276 struct symbol *get_real_base_type(struct symbol *sym);
277 int type_bits(struct symbol *type);
278 int type_positive_bits(struct symbol *type);
279 struct symbol *get_pointer_type(struct expression *expr);
280 struct symbol *get_type(struct expression *expr);
281 int type_unsigned(struct symbol *base_type);
282 int type_signed(struct symbol *base_type);
283 int expr_unsigned(struct expression *expr);
284 int returns_unsigned(struct symbol *base_type);
285 int is_pointer(struct expression *expr);
286 int returns_pointer(struct symbol *base_type);
287 sval_t sval_type_max(struct symbol *base_type);
288 sval_t sval_type_min(struct symbol *base_type);
289 int nr_bits(struct expression *expr);
290 int is_void_pointer(struct expression *expr);
291 int is_char_pointer(struct expression *expr);
292 int is_static(struct expression *expr);
293 int types_equiv(struct symbol *one, struct symbol *two);
294 int fn_static(void);
295 const char *global_static();
296 struct symbol *cur_func_return_type(void);
297 struct symbol *get_arg_type(struct expression *fn, int arg);
298 struct symbol *get_member_type_from_key(struct expression *expr, char *key);
300 /* smatch_ignore.c */
301 void add_ignore(int owner, const char *name, struct symbol *sym);
302 int is_ignored(int owner, const char *name, struct symbol *sym);
304 /* smatch_tracker */
305 struct tracker *alloc_tracker(int owner, const char *name, struct symbol *sym);
306 void add_tracker(struct tracker_list **list, int owner, const char *name,
307 struct symbol *sym);
308 void add_tracker_expr(struct tracker_list **list, int owner, struct expression *expr);
309 void del_tracker(struct tracker_list **list, int owner, const char *name,
310 struct symbol *sym);
311 int in_tracker_list(struct tracker_list *list, int owner, const char *name,
312 struct symbol *sym);
313 void free_tracker_list(struct tracker_list **list);
314 void free_trackers_and_list(struct tracker_list **list);
316 /* smatch_conditions */
317 int in_condition(void);
319 /* smatch_flow.c */
321 void smatch (int argc, char **argv);
322 int inside_loop(void);
323 struct expression *get_switch_expr(void);
324 int in_expression_statement(void);
325 void __split_expr(struct expression *expr);
326 void __split_stmt(struct statement *stmt);
327 extern int option_assume_loops;
328 extern int option_known_conditions;
329 extern int option_two_passes;
330 extern int option_no_db;
331 extern int option_file_output;
332 extern struct expression_list *big_expression_stack;
333 extern struct statement_list *big_statement_stack;
334 int inlinable(struct expression *expr);
335 extern int __inline_call;
336 extern struct expression *__inline_fn;
337 extern int __in_pre_condition;
338 extern int __bail_on_rest_of_function;
340 /* smatch_conditions */
341 void __split_whole_condition(struct expression *expr);
342 void __handle_logic(struct expression *expr);
343 int is_condition(struct expression *expr);
344 int __handle_condition_assigns(struct expression *expr);
345 int __handle_select_assigns(struct expression *expr);
346 int __handle_expr_statement_assigns(struct expression *expr);
348 /* smatch_implied.c */
349 extern int option_debug_implied;
350 extern int option_debug_related;
351 extern int option_no_implied;
352 void get_implications(char *name, struct symbol *sym, int comparison, long long num,
353 struct state_list **true_states,
354 struct state_list **false_states);
355 struct range_list_stack;
356 struct state_list *__implied_case_slist(struct expression *switch_expr,
357 struct expression *case_expr,
358 struct range_list_stack **remaining_cases,
359 struct state_list **raw_slist);
360 struct range_list *__get_implied_values(struct expression *switch_expr);
361 void overwrite_states_using_pool(struct sm_state *sm);
363 /* smatch_extras.c */
364 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
366 struct data_range {
367 sval_t min;
368 sval_t max;
371 static const long long valid_ptr_max = LONG_MAX;
372 static const long long valid_ptr_min = 4096;
373 static const sval_t valid_ptr_max_sval = {
374 .type = &ptr_ctype,
375 {.value = LONG_MAX},
377 static const sval_t valid_ptr_min_sval = {
378 .type = &ptr_ctype,
379 {.value = 4096},
382 /* smatch_absolute.c */
383 int get_absolute_min_helper(struct expression *expr, sval_t *sval);
384 int get_absolute_max_helper(struct expression *expr, sval_t *sval);
386 /* smatch_local_values.c */
387 int get_local_rl(struct expression *expr, struct range_list **rl);
388 int get_local_max_helper(struct expression *expr, sval_t *sval);
389 int get_local_min_helper(struct expression *expr, sval_t *sval);
391 /* smatch_states.c */
392 void __push_fake_cur_slist();
393 struct state_list *__pop_fake_cur_slist();
394 void __merge_slist_into_cur(struct state_list *slist);
396 int unreachable(void);
397 void __set_sm(struct sm_state *sm);
398 struct state_list *__get_cur_slist(void);
399 void __set_true_false_sm(struct sm_state *true_state,
400 struct sm_state *false_state);
401 void nullify_path(void);
402 void __match_nullify_path_hook(const char *fn, struct expression *expr,
403 void *unused);
404 void __unnullify_path(void);
405 int __path_is_null(void);
406 void save_all_states(void);
407 void nullify_all_states(void);
408 void restore_all_states(void);
409 void clear_all_states(void);
411 struct sm_state *get_sm_state(int owner, const char *name,
412 struct symbol *sym);
413 struct sm_state *get_sm_state_expr(int owner, struct expression *expr);
414 void __push_true_states(void);
415 void __use_false_states(void);
416 void __discard_false_states(void);
417 void __merge_false_states(void);
418 void __merge_true_states(void);
420 void __negate_cond_stacks(void);
421 void __use_pre_cond_states(void);
422 void __use_cond_true_states(void);
423 void __use_cond_false_states(void);
424 void __push_cond_stacks(void);
425 struct state_list *__copy_cond_true_states(void);
426 struct state_list *__copy_cond_false_states(void);
427 struct state_list *__pop_cond_true_stack(void);
428 struct state_list *__pop_cond_false_stack(void);
429 void __and_cond_states(void);
430 void __or_cond_states(void);
431 void __save_pre_cond_states(void);
432 void __discard_pre_cond_states(void);
433 void __use_cond_states(void);
434 extern struct state_list *__last_base_slist;
436 void __warn_on_silly_pre_loops(void);
438 void __push_continues(void);
439 void __discard_continues(void);
440 void __process_continues(void);
441 void __merge_continues(void);
443 void __push_breaks(void);
444 void __process_breaks(void);
445 int __has_breaks(void);
446 void __merge_breaks(void);
447 void __use_breaks(void);
449 void __save_switch_states(struct expression *switch_expr);
450 void __discard_switches(void);
451 void __merge_switches(struct expression *switch_expr, struct expression *case_expr);
452 void __push_default(void);
453 void __set_default(void);
454 int __pop_default(void);
456 void __push_conditions(void);
457 void __discard_conditions(void);
459 void __save_gotos(const char *name);
460 void __merge_gotos(const char *name);
462 void __print_cur_slist(void);
464 /* smatch_hooks.c */
465 void __pass_to_client(void *data, enum hook_type type);
466 void __pass_to_client_no_data(enum hook_type type);
467 void __pass_case_to_client(struct expression *switch_expr,
468 struct expression *case_expr);
469 int __has_merge_function(int client_id);
470 struct smatch_state *__client_merge_function(int owner,
471 struct smatch_state *s1,
472 struct smatch_state *s2);
473 struct smatch_state *__client_unmatched_state_function(struct sm_state *sm);
474 void __push_scope_hooks(void);
475 void __call_scope_hooks(void);
477 /* smatch_function_hooks.c */
478 void create_function_hook_hash(void);
479 void __match_initializer_call(struct symbol *sym);
481 /* smatch_db.c */
482 enum info_type {
483 INTERNAL = 0,
484 PARAM_VALUE = 1,
485 BUF_SIZE = 2,
486 USER_DATA = 3,
487 CAPPED_DATA = 4,
488 RETURN_VALUE = 5,
489 DEREFERENCE = 6,
490 RANGE_CAP = 7,
491 LOCK_HELD = 8,
492 LOCK_RELEASED = 9,
493 ABSOLUTE_LIMITS = 10,
494 LIMITED_VALUE = 11,
495 ADDED_VALUE = 12,
496 FILTER_VALUE = 13,
499 void add_definition_db_callback(void (*callback)(const char *name, struct symbol *sym, char *key, char *value), int type);
500 void add_member_info_callback(int owner, void (*callback)(struct expression *call, int param, char *printed_name, struct smatch_state *state));
501 void add_returned_state_callback(void (*fn)(int return_id, char *return_ranges, struct expression *returned_expr, struct state_list *slist));
502 void add_returned_member_callback(int owner, void (*callback)(int return_id, char *return_ranges, char *printed_name, struct smatch_state *state));
503 void add_db_fn_call_callback(int type, void (*callback)(struct expression *arg, char *value));
504 struct range_list *db_return_vals(struct expression *expr);
505 char *get_variable_from_key(struct expression *arg, char *key, struct symbol **sym);
507 #define run_sql(call_back, sql...) \
508 do { \
509 char sql_txt[1024]; \
510 if (option_no_db) \
511 break; \
512 snprintf(sql_txt, 1024, sql); \
513 sm_debug("%s\n", sql_txt); \
514 sql_exec(call_back, sql_txt); \
515 } while (0)
517 /* like run_sql() but for the in-memory database */
518 #define mem_sql(call_back, sql...) \
519 do { \
520 char sql_txt[1024]; \
522 snprintf(sql_txt, sizeof(sql_txt), sql); \
523 sm_debug("in-mem: %s\n", sql_txt); \
524 sql_mem_exec(call_back, sql_txt); \
525 } while (0)
527 void sql_insert_return_states(int return_id, const char *return_ranges,
528 int type, int param, const char *key, const char *value);
529 void sql_insert_caller_info(struct expression *call, int type, int param,
530 const char *key, const char *value);
531 void sql_insert_function_ptr(const char *fn, const char *struct_name);
532 void sql_insert_return_values(const char *return_values);
533 void sql_insert_call_implies(int type, int param, int value);
534 void sql_insert_type_size(const char *member, int size);
535 void sql_insert_local_values(const char *name, const char *value);
537 void sql_select_return_states(const char *cols, struct expression *call,
538 int (*callback)(void*, int, char**, char**));
539 void sql_select_return_values(const char *cols, struct expression *call,
540 int (*callback)(void*, int, char**, char**));
541 void sql_select_caller_info(const char *cols, struct symbol *sym,
542 int (*callback)(void*, int, char**, char**));
543 void sql_select_call_implies(const char *cols, struct expression *call,
544 int (*callback)(void*, int, char**, char**));
546 void sql_exec(int (*callback)(void*, int, char**, char**), const char *sql);
547 void sql_mem_exec(int (*callback)(void*, int, char**, char**), const char *sql);
549 void open_smatch_db(void);
551 /* smatch_files.c */
552 int open_data_file(const char *filename);
553 struct token *get_tokens_file(const char *filename);
555 /* smatch.c */
556 extern char *option_project_str;
557 extern char *data_dir;
558 extern int option_no_data;
559 extern int option_spammy;
560 extern int option_full_path;
561 extern int option_param_mapper;
562 extern int option_info;
563 extern int option_call_tree;
564 extern int num_checks;
566 enum project_type {
567 PROJ_NONE,
568 PROJ_KERNEL,
569 PROJ_WINE,
571 extern enum project_type option_project;
572 const char *check_name(unsigned short id);
575 /* smatch_buf_size.c */
576 int get_array_size(struct expression *expr);
577 int get_array_size_bytes(struct expression *expr);
578 int get_array_size_bytes_min(struct expression *expr);
579 int get_real_array_size(struct expression *expr);
581 /* smatch_capped.c */
582 int is_capped(struct expression *expr);
584 /* check_user_data.c */
585 int is_user_data(struct expression *expr);
587 /* check_locking.c */
588 void print_held_locks();
590 /* check_assigned_expr.c */
591 struct expression *get_assigned_expr(struct expression *expr);
593 /* smatch_comparison.c */
594 int get_comparison(struct expression *left, struct expression *right);
596 /* smatch_sval.c */
597 sval_t *sval_alloc(sval_t sval);
598 sval_t *sval_alloc_permanent(sval_t sval);
599 sval_t sval_blank(struct expression *expr);
600 sval_t sval_type_val(struct symbol *type, long long val);
601 sval_t sval_from_val(struct expression *expr, long long val);
602 int sval_unsigned(sval_t sval);
603 int sval_signed(sval_t sval);
604 int sval_bits(sval_t sval);
605 int sval_positive_bits(sval_t sval);
606 int sval_bits_used(sval_t sval);
607 int sval_is_negative(sval_t sval);
608 int sval_is_positive(sval_t sval);
609 int sval_is_min(sval_t sval);
610 int sval_is_max(sval_t sval);
611 int sval_is_a_min(sval_t sval);
612 int sval_is_a_max(sval_t sval);
613 int sval_cmp(sval_t one, sval_t two);
614 int sval_cmp_t(struct symbol *type, sval_t one, sval_t two);
615 int sval_cmp_val(sval_t one, long long val);
616 sval_t sval_min(sval_t one, sval_t two);
617 sval_t sval_max(sval_t one, sval_t two);
618 int sval_too_low(struct symbol *type, sval_t sval);
619 int sval_too_high(struct symbol *type, sval_t sval);
620 int sval_fits(struct symbol *type, sval_t sval);
621 sval_t sval_cast(struct symbol *type, sval_t sval);
622 sval_t sval_preop(sval_t sval, int op);
623 sval_t sval_binop(sval_t left, int op, sval_t right);
624 int sval_binop_overflows(sval_t left, int op, sval_t right);
625 const char *sval_to_str(sval_t sval);
626 const char *sval_to_numstr(sval_t sval);
627 sval_t ll_to_sval(long long val);
629 #endif /* !SMATCH_H_ */