4 * Copyright (C) 2006 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
19 #include "expression.h"
25 unsigned long long uvalue
;
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
)
52 unsigned int merged
:1;
53 unsigned int implied
:1;
56 struct smatch_state
*state
;
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
;
70 DECLARE_ALLOCATOR(tracker
);
71 DECLARE_PTR_LIST(tracker_list
, struct tracker
);
81 GLOBAL_ASSIGNMENT_HOOK
,
89 MACRO_ASSIGNMENT_HOOK
,
110 void add_hook(void *func
, enum hook_type type
);
111 typedef struct smatch_state
*(merge_func_t
)(struct smatch_state
*s1
, struct smatch_state
*s2
);
112 typedef struct smatch_state
*(unmatched_func_t
)(struct sm_state
*state
);
113 void add_merge_hook(int client_id
, merge_func_t
*func
);
114 void add_unmatched_state_hook(int client_id
, unmatched_func_t
*func
);
115 typedef void (scope_hook
)(void *data
);
116 void add_scope_hook(scope_hook
*hook
, void *data
);
117 typedef void (func_hook
)(const char *fn
, struct expression
*expr
, void *data
);
118 typedef void (implication_hook
)(const char *fn
, struct expression
*call_expr
,
119 struct expression
*assign_expr
, void *data
);
120 typedef void (return_implies_hook
)(struct expression
*call_expr
,
121 int param
, char *key
, char *value
);
122 typedef int (implied_return_hook
)(struct expression
*call_expr
, void *info
, struct range_list
**rl
);
123 void add_function_hook(const char *look_for
, func_hook
*call_back
, void *data
);
125 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
127 void add_implied_return_hook(const char *look_for
,
128 implied_return_hook
*call_back
,
130 void add_macro_assign_hook(const char *look_for
, func_hook
*call_back
,
132 void add_macro_assign_hook_extra(const char *look_for
, func_hook
*call_back
,
134 void return_implies_state(const char *look_for
, long long start
, long long end
,
135 implication_hook
*call_back
, void *info
);
136 void add_db_return_states_callback(int type
, return_implies_hook
*callback
);
137 void add_db_return_states_before(void (*fn
)(void));
138 void add_db_return_states_after(void (*fn
)(void));
139 int get_implied_return(struct expression
*expr
, struct range_list
**rl
);
141 typedef void (modification_hook
)(struct sm_state
*sm
);
142 void add_modification_hook(int owner
, modification_hook
*call_back
);
143 void add_indirect_modification_hook(int owner
, modification_hook
*call_back
);
145 const char *get_filename(void);
146 char *get_function(void);
147 int get_lineno(void);
148 extern int final_pass
;
149 extern struct symbol
*cur_func_sym
;
150 extern int option_debug
;
151 extern int local_debug
;
153 extern FILE *sm_outfd
;
154 #define sm_printf(msg...) do { if (final_pass || option_debug) fprintf(sm_outfd, msg); } while (0)
156 static inline void sm_prefix(void)
158 sm_printf("%s:%d %s() ", get_filename(), get_lineno(), get_function());
161 static inline void print_implied_debug_msg();
163 #define sm_msg(msg...) \
165 print_implied_debug_msg(); \
166 if (!option_debug && !final_pass) \
173 #define local_debug(msg...) \
179 extern char *implied_debug_msg
;
180 static inline void print_implied_debug_msg()
182 static struct symbol
*last_printed
= NULL
;
184 if (!implied_debug_msg
)
186 if (last_printed
== cur_func_sym
)
188 last_printed
= cur_func_sym
;
189 sm_msg("%s", implied_debug_msg
);
192 #define sm_debug(msg...) do { if (option_debug) sm_printf(msg); } while (0)
194 #define sm_info(msg...) do { \
195 if (option_debug || (option_info && final_pass)) { \
197 sm_printf("info: "); \
203 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
204 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
205 struct state_list
*get_possible_states(int owner
, const char *name
,
207 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
208 struct sm_state
*set_state(int owner
, const char *name
, struct symbol
*sym
,
209 struct smatch_state
*state
);
210 struct sm_state
*set_state_expr(int owner
, struct expression
*expr
,
211 struct smatch_state
*state
);
212 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
213 void delete_state_expr(int owner
, struct expression
*expr
);
214 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
215 struct smatch_state
*true_state
,
216 struct smatch_state
*false_state
);
217 void set_true_false_states_expr(int owner
, struct expression
*expr
,
218 struct smatch_state
*true_state
,
219 struct smatch_state
*false_state
);
221 struct state_list
*get_all_states_slist(int owner
, struct state_list
*source
);
222 struct state_list
*get_all_states(int id
);
223 int is_reachable(void);
225 /* smatch_helper.c */
226 char *alloc_string(const char *str
);
227 void free_string(char *str
);
228 struct smatch_state
*alloc_state_num(int num
);
229 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
232 char *expr_to_var(struct expression
*expr
);
233 char *expr_to_str(struct expression
*expr
);
234 char *expr_to_str_sym(struct expression
*expr
,
235 struct symbol
**sym_ptr
);
236 char *expr_to_var_sym(struct expression
*expr
,
237 struct symbol
**sym_ptr
);
239 int sym_name_is(const char *name
, struct expression
*expr
);
240 int get_value(struct expression
*expr
, sval_t
*val
);
241 int get_implied_value(struct expression
*expr
, sval_t
*val
);
242 int get_implied_min(struct expression
*expr
, sval_t
*sval
);
243 int get_implied_max(struct expression
*expr
, sval_t
*val
);
244 int get_hard_max(struct expression
*expr
, sval_t
*sval
);
245 int get_fuzzy_min(struct expression
*expr
, sval_t
*min
);
246 int get_fuzzy_max(struct expression
*expr
, sval_t
*max
);
247 int get_absolute_min(struct expression
*expr
, sval_t
*sval
);
248 int get_absolute_max(struct expression
*expr
, sval_t
*sval
);
249 int parse_call_math(struct expression
*expr
, char *math
, sval_t
*val
);
250 int is_zero(struct expression
*expr
);
251 int known_condition_true(struct expression
*expr
);
252 int known_condition_false(struct expression
*expr
);
253 int implied_condition_true(struct expression
*expr
);
254 int implied_condition_false(struct expression
*expr
);
256 int is_array(struct expression
*expr
);
257 struct expression
*get_array_name(struct expression
*expr
);
258 struct expression
*get_array_offset(struct expression
*expr
);
259 const char *show_state(struct smatch_state
*state
);
260 struct statement
*get_expression_statement(struct expression
*expr
);
261 struct expression
*strip_parens(struct expression
*expr
);
262 struct expression
*strip_expr(struct expression
*expr
);
263 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
264 int is_error_return(struct expression
*expr
);
265 int getting_address(void);
266 char *get_member_name(struct expression
*expr
);
267 char *get_fnptr_name(struct expression
*expr
);
268 int positions_eq(struct position pos1
, struct position pos2
);
269 struct statement
*get_current_statement(void);
270 int get_param_num_from_sym(struct symbol
*sym
);
273 struct symbol
*get_real_base_type(struct symbol
*sym
);
274 int type_bits(struct symbol
*type
);
275 int type_positive_bits(struct symbol
*type
);
276 struct symbol
*get_pointer_type(struct expression
*expr
);
277 struct symbol
*get_type(struct expression
*expr
);
278 int type_unsigned(struct symbol
*base_type
);
279 int type_signed(struct symbol
*base_type
);
280 int expr_unsigned(struct expression
*expr
);
281 int returns_unsigned(struct symbol
*base_type
);
282 int is_pointer(struct expression
*expr
);
283 int returns_pointer(struct symbol
*base_type
);
284 sval_t
sval_type_max(struct symbol
*base_type
);
285 sval_t
sval_type_min(struct symbol
*base_type
);
286 int nr_bits(struct expression
*expr
);
287 int is_void_pointer(struct expression
*expr
);
288 int is_char_pointer(struct expression
*expr
);
289 int is_static(struct expression
*expr
);
290 int types_equiv(struct symbol
*one
, struct symbol
*two
);
292 const char *global_static();
293 struct symbol
*cur_func_return_type(void);
294 struct symbol
*get_arg_type(struct expression
*fn
, int arg
);
295 struct symbol
*get_member_type_from_key(struct expression
*expr
, char *key
);
297 /* smatch_ignore.c */
298 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
299 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
302 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
303 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
305 void add_tracker_expr(struct tracker_list
**list
, int owner
, struct expression
*expr
);
306 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
308 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
310 void free_tracker_list(struct tracker_list
**list
);
311 void free_trackers_and_list(struct tracker_list
**list
);
313 /* smatch_conditions */
314 int in_condition(void);
318 void smatch (int argc
, char **argv
);
319 int inside_loop(void);
320 struct expression
*get_switch_expr(void);
321 int in_expression_statement(void);
322 void __split_expr(struct expression
*expr
);
323 void __split_stmt(struct statement
*stmt
);
324 extern int option_assume_loops
;
325 extern int option_known_conditions
;
326 extern int option_two_passes
;
327 extern int option_no_db
;
328 extern int option_file_output
;
329 extern struct expression_list
*big_expression_stack
;
330 extern struct statement_list
*big_statement_stack
;
331 int inlinable(struct expression
*expr
);
332 extern int __inline_call
;
333 extern struct expression
*__inline_fn
;
334 extern int __in_pre_condition
;
335 extern int __bail_on_rest_of_function
;
337 /* smatch_conditions */
338 void __split_whole_condition(struct expression
*expr
);
339 void __handle_logic(struct expression
*expr
);
340 int is_condition(struct expression
*expr
);
341 int __handle_condition_assigns(struct expression
*expr
);
342 int __handle_select_assigns(struct expression
*expr
);
343 int __handle_expr_statement_assigns(struct expression
*expr
);
345 /* smatch_implied.c */
346 extern int option_debug_implied
;
347 extern int option_debug_related
;
348 extern int option_no_implied
;
349 void get_implications(char *name
, struct symbol
*sym
, int comparison
, long long num
,
350 struct state_list
**true_states
,
351 struct state_list
**false_states
);
352 struct range_list_stack
;
353 struct state_list
*__implied_case_slist(struct expression
*switch_expr
,
354 struct expression
*case_expr
,
355 struct range_list_stack
**remaining_cases
,
356 struct state_list
**raw_slist
);
357 struct range_list
*__get_implied_values(struct expression
*switch_expr
);
358 void overwrite_states_using_pool(struct sm_state
*sm
);
360 /* smatch_extras.c */
361 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
368 static const long long valid_ptr_max
= LONG_MAX
;
369 static const long long valid_ptr_min
= 4096;
370 static const sval_t valid_ptr_max_sval
= {
374 static const sval_t valid_ptr_min_sval
= {
379 /* smatch_absolute.c */
380 int get_absolute_min_helper(struct expression
*expr
, sval_t
*sval
);
381 int get_absolute_max_helper(struct expression
*expr
, sval_t
*sval
);
383 /* smatch_states.c */
384 void __push_fake_cur_slist();
385 struct state_list
*__pop_fake_cur_slist();
386 void __merge_slist_into_cur(struct state_list
*slist
);
388 int unreachable(void);
389 void __set_sm(struct sm_state
*sm
);
390 struct state_list
*__get_cur_slist(void);
391 void __set_true_false_sm(struct sm_state
*true_state
,
392 struct sm_state
*false_state
);
393 void nullify_path(void);
394 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
396 void __unnullify_path(void);
397 int __path_is_null(void);
398 void save_all_states(void);
399 void nullify_all_states(void);
400 void restore_all_states(void);
401 void clear_all_states(void);
403 struct sm_state
*get_sm_state(int owner
, const char *name
,
405 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
406 void __push_true_states(void);
407 void __use_false_states(void);
408 void __discard_false_states(void);
409 void __merge_false_states(void);
410 void __merge_true_states(void);
412 void __negate_cond_stacks(void);
413 void __use_pre_cond_states(void);
414 void __use_cond_true_states(void);
415 void __use_cond_false_states(void);
416 void __push_cond_stacks(void);
417 struct state_list
*__copy_cond_true_states(void);
418 struct state_list
*__copy_cond_false_states(void);
419 struct state_list
*__pop_cond_true_stack(void);
420 struct state_list
*__pop_cond_false_stack(void);
421 void __and_cond_states(void);
422 void __or_cond_states(void);
423 void __save_pre_cond_states(void);
424 void __discard_pre_cond_states(void);
425 void __use_cond_states(void);
426 extern struct state_list
*__last_base_slist
;
428 void __warn_on_silly_pre_loops(void);
430 void __push_continues(void);
431 void __discard_continues(void);
432 void __process_continues(void);
433 void __merge_continues(void);
435 void __push_breaks(void);
436 void __process_breaks(void);
437 int __has_breaks(void);
438 void __merge_breaks(void);
439 void __use_breaks(void);
441 void __save_switch_states(struct expression
*switch_expr
);
442 void __discard_switches(void);
443 void __merge_switches(struct expression
*switch_expr
, struct expression
*case_expr
);
444 void __push_default(void);
445 void __set_default(void);
446 int __pop_default(void);
448 void __push_conditions(void);
449 void __discard_conditions(void);
451 void __save_gotos(const char *name
);
452 void __merge_gotos(const char *name
);
454 void __print_cur_slist(void);
457 void __pass_to_client(void *data
, enum hook_type type
);
458 void __pass_to_client_no_data(enum hook_type type
);
459 void __pass_case_to_client(struct expression
*switch_expr
,
460 struct expression
*case_expr
);
461 int __has_merge_function(int client_id
);
462 struct smatch_state
*__client_merge_function(int owner
,
463 struct smatch_state
*s1
,
464 struct smatch_state
*s2
);
465 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
466 void __push_scope_hooks(void);
467 void __call_scope_hooks(void);
469 /* smatch_function_hooks.c */
470 void create_function_hook_hash(void);
471 void __match_initializer_call(struct symbol
*sym
);
485 ABSOLUTE_LIMITS
= 10,
491 void add_definition_db_callback(void (*callback
)(const char *name
, struct symbol
*sym
, char *key
, char *value
), int type
);
492 void add_member_info_callback(int owner
, void (*callback
)(struct expression
*call
, int param
, char *printed_name
, struct smatch_state
*state
));
493 void add_returned_state_callback(void (*fn
)(int return_id
, char *return_ranges
, struct expression
*returned_expr
, struct state_list
*slist
));
494 void add_returned_member_callback(int owner
, void (*callback
)(int return_id
, char *return_ranges
, char *printed_name
, struct smatch_state
*state
));
495 void add_db_fn_call_callback(int type
, void (*callback
)(struct expression
*arg
, char *value
));
496 struct range_list
*db_return_vals(struct expression
*expr
);
497 char *get_variable_from_key(struct expression
*arg
, char *key
, struct symbol
**sym
);
499 #define run_sql(call_back, sql...) \
501 char sql_txt[1024]; \
504 snprintf(sql_txt, 1024, sql); \
505 sm_debug("%s\n", sql_txt); \
506 sql_exec(call_back, sql_txt); \
509 void sql_insert_return_states(int return_id
, const char *return_ranges
,
510 int type
, int param
, const char *key
, const char *value
);
511 void sql_insert_caller_info(struct expression
*call
, int type
, int param
,
512 const char *key
, const char *value
);
513 void sql_insert_function_ptr(const char *fn
, const char *struct_name
);
514 void sql_insert_return_values(const char *return_values
);
515 void sql_insert_call_implies(int type
, int param
, int value
);
516 void sql_insert_type_size(const char *member
, int size
);
518 void sql_select_return_states(const char *cols
, struct expression
*call
,
519 int (*callback
)(void*, int, char**, char**));
520 void sql_select_return_values(const char *cols
, struct expression
*call
,
521 int (*callback
)(void*, int, char**, char**));
522 void sql_select_caller_info(const char *cols
, struct symbol
*sym
,
523 int (*callback
)(void*, int, char**, char**));
524 void sql_select_call_implies(const char *cols
, struct expression
*call
,
525 int (*callback
)(void*, int, char**, char**));
527 void sql_exec(int (*callback
)(void*, int, char**, char**), const char *sql
);
528 void open_smatch_db(void);
531 int open_data_file(const char *filename
);
532 struct token
*get_tokens_file(const char *filename
);
535 extern char *option_project_str
;
536 extern char *data_dir
;
537 extern int option_no_data
;
538 extern int option_spammy
;
539 extern int option_full_path
;
540 extern int option_param_mapper
;
541 extern int option_info
;
542 extern int option_call_tree
;
543 extern int num_checks
;
550 extern enum project_type option_project
;
551 const char *check_name(unsigned short id
);
554 /* smatch_buf_size.c */
555 int get_array_size(struct expression
*expr
);
556 int get_array_size_bytes(struct expression
*expr
);
557 int get_array_size_bytes_min(struct expression
*expr
);
559 /* smatch_capped.c */
560 int is_capped(struct expression
*expr
);
562 /* check_user_data.c */
563 int is_user_data(struct expression
*expr
);
565 /* check_locking.c */
566 void print_held_locks();
568 /* check_assigned_expr.c */
569 struct expression
*get_assigned_expr(struct expression
*expr
);
571 /* smatch_comparison.c */
572 int get_comparison(struct expression
*left
, struct expression
*right
);
575 sval_t
*sval_alloc(sval_t sval
);
576 sval_t
*sval_alloc_permanent(sval_t sval
);
577 sval_t
sval_blank(struct expression
*expr
);
578 sval_t
sval_type_val(struct symbol
*type
, long long val
);
579 sval_t
sval_from_val(struct expression
*expr
, long long val
);
580 int sval_unsigned(sval_t sval
);
581 int sval_signed(sval_t sval
);
582 int sval_bits(sval_t sval
);
583 int sval_positive_bits(sval_t sval
);
584 int sval_bits_used(sval_t sval
);
585 int sval_is_negative(sval_t sval
);
586 int sval_is_positive(sval_t sval
);
587 int sval_is_min(sval_t sval
);
588 int sval_is_max(sval_t sval
);
589 int sval_is_a_min(sval_t sval
);
590 int sval_is_a_max(sval_t sval
);
591 int sval_cmp(sval_t one
, sval_t two
);
592 int sval_cmp_t(struct symbol
*type
, sval_t one
, sval_t two
);
593 int sval_cmp_val(sval_t one
, long long val
);
594 sval_t
sval_min(sval_t one
, sval_t two
);
595 sval_t
sval_max(sval_t one
, sval_t two
);
596 int sval_too_low(struct symbol
*type
, sval_t sval
);
597 int sval_too_high(struct symbol
*type
, sval_t sval
);
598 int sval_fits(struct symbol
*type
, sval_t sval
);
599 sval_t
sval_cast(struct symbol
*type
, sval_t sval
);
600 sval_t
sval_preop(sval_t sval
, int op
);
601 sval_t
sval_binop(sval_t left
, int op
, sval_t right
);
602 int sval_binop_overflows(sval_t left
, int op
, sval_t right
);
603 const char *sval_to_str(sval_t sval
);
604 const char *sval_to_numstr(sval_t sval
);
605 sval_t
ll_to_sval(long long val
);
607 #endif /* !SMATCH_H_ */