4 * Copyright (C) 2006 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
19 #include "expression.h"
25 #define STATE(_x) static struct smatch_state _x = { .name = #_x }
26 extern struct smatch_state undefined
;
27 extern struct smatch_state merged
;
28 extern struct smatch_state true_state
;
29 extern struct smatch_state false_state
;
30 DECLARE_ALLOCATOR(smatch_state
);
32 static inline void *INT_PTR(int i
)
34 return (void *)(long)i
;
37 static inline int PTR_INT(void *p
)
44 unsigned int merged
:1;
45 unsigned int implied
:1;
48 struct smatch_state
*state
;
50 struct state_list
*my_pool
;
51 struct sm_state
*left
;
52 struct sm_state
*right
;
53 unsigned int nr_children
;
54 struct state_list
*possible
;
62 DECLARE_ALLOCATOR(tracker
);
63 DECLARE_PTR_LIST(tracker_list
, struct tracker
);
77 MACRO_ASSIGNMENT_HOOK
,
92 void add_hook(void *func
, enum hook_type type
);
93 typedef struct smatch_state
*(merge_func_t
)(const char *name
,
95 struct smatch_state
*s1
,
96 struct smatch_state
*s2
);
97 typedef struct smatch_state
*(unmatched_func_t
)(struct sm_state
*state
);
98 void add_merge_hook(int client_id
, merge_func_t
*func
);
99 void add_unmatched_state_hook(int client_id
, unmatched_func_t
*func
);
100 typedef void (scope_hook
)(void *data
);
101 void add_scope_hook(scope_hook
*hook
, void *data
);
102 typedef void (func_hook
)(const char *fn
, struct expression
*expr
, void *data
);
103 typedef void (implication_hook
)(const char *fn
, struct expression
*call_expr
,
104 struct expression
*assign_expr
, void *data
);
105 void add_function_hook(const char *look_for
, func_hook
*call_back
, void *data
);
107 void add_function_assign_hook(const char *look_for
, func_hook
*call_back
,
109 void add_macro_assign_hook(const char *look_for
, func_hook
*call_back
,
111 void return_implies_state(const char *look_for
, long long start
, long long end
,
112 implication_hook
*call_back
, void *info
);
113 typedef void (modification_hook
)(const char *name
, struct symbol
*sym
,
114 struct expression
*expr
, void *data
);
115 void add_modification_hook(int owner
, const char *variable
, modification_hook
*hook
,
117 void add_modification_hook_expr(int owner
, struct expression
*expr
, modification_hook
*call_back
, void *info
);
118 void set_default_modification_hook(int owner
, modification_hook
*call_back
);
119 void __use_default_modification_hook(int owner
, const char *variable
);
121 const char *get_filename(void);
122 char *get_function(void);
123 int get_lineno(void);
124 int get_func_pos(void);
125 extern int final_pass
;
126 extern struct symbol
*cur_func_sym
;
127 extern int option_debug
;
129 #define sm_printf(msg...) do { if (final_pass) printf(msg); } while (0) \
131 static inline void sm_prefix(void)
133 printf("%s +%d %s(%d) ", get_filename(), get_lineno(), get_function(), get_func_pos());
137 static inline void print_implied_debug_msg();
139 #define sm_msg(msg...) \
141 print_implied_debug_msg(); \
142 if (!option_debug && !final_pass) \
149 extern char *implied_debug_msg
;
150 static inline void print_implied_debug_msg()
152 static struct symbol
*last_printed
= NULL
;
154 if (!implied_debug_msg
)
156 if (last_printed
== cur_func_sym
)
158 last_printed
= cur_func_sym
;
159 sm_msg("%s", implied_debug_msg
);
162 #define sm_debug(msg...) do { if (option_debug) printf(msg); } while (0)
164 #define sm_info(msg...) do { \
165 if (option_debug || (option_info && final_pass)) { \
173 #define POINTER_MAX 0xffffffff
175 struct smatch_state
*get_state(int owner
, const char *name
, struct symbol
*sym
);
176 struct smatch_state
*get_state_expr(int owner
, struct expression
*expr
);
177 struct state_list
*get_possible_states(int owner
, const char *name
,
179 struct state_list
*get_possible_states_expr(int owner
, struct expression
*expr
);
180 struct sm_state
*set_state(int owner
, const char *name
, struct symbol
*sym
,
181 struct smatch_state
*state
);
182 struct sm_state
*set_state_expr(int owner
, struct expression
*expr
,
183 struct smatch_state
*state
);
184 void delete_state(int owner
, const char *name
, struct symbol
*sym
);
185 void delete_state_expr(int owner
, struct expression
*expr
);
186 void set_true_false_states(int owner
, const char *name
, struct symbol
*sym
,
187 struct smatch_state
*true_state
,
188 struct smatch_state
*false_state
);
189 void set_true_false_states_expr(int owner
, struct expression
*expr
,
190 struct smatch_state
*true_state
,
191 struct smatch_state
*false_state
);
193 struct state_list
*get_all_states(int id
);
194 int is_reachable(void);
196 /* smatch_helper.c */
197 char *alloc_string(const char *str
);
198 void free_string(char *str
);
199 struct smatch_state
*alloc_state_num(int num
);
200 struct expression
*get_argument_from_call_expr(struct expression_list
*args
,
202 char *get_variable_from_expr_complex(struct expression
*expr
,
203 struct symbol
**sym_ptr
);
204 char *get_variable_from_expr(struct expression
*expr
,
205 struct symbol
**sym_ptr
);
206 int sym_name_is(const char *name
, struct expression
*expr
);
207 int get_value(struct expression
*expr
, long long *val
);
208 int get_implied_value(struct expression
*expr
, long long *val
);
209 int get_implied_max(struct expression
*expr
, long long *val
);
210 int get_implied_min(struct expression
*expr
, long long *val
);
211 int get_fuzzy_min(struct expression
*expr
, long long *min
);
212 int get_fuzzy_max(struct expression
*expr
, long long *max
);
213 int get_absolute_min(struct expression
*expr
, long long *val
);
214 int get_absolute_max(struct expression
*expr
, long long *val
);
215 int is_zero(struct expression
*expr
);
216 int is_array(struct expression
*expr
);
217 struct expression
*get_array_name(struct expression
*expr
);
218 struct expression
*get_array_offset(struct expression
*expr
);
219 const char *show_state(struct smatch_state
*state
);
220 struct statement
*get_expression_statement(struct expression
*expr
);
221 struct expression
*strip_parens(struct expression
*expr
);
222 struct expression
*strip_expr(struct expression
*expr
);
223 void scoped_state(int my_id
, const char *name
, struct symbol
*sym
);
224 int is_error_return(struct expression
*expr
);
225 int getting_address(void);
228 struct symbol
*get_type(struct expression
*expr
);
229 int type_unsigned(struct symbol
*base_type
);
230 int returns_unsigned(struct symbol
*base_type
);
231 int returns_pointer(struct symbol
*base_type
);
232 long long type_max(struct symbol
*base_type
);
233 long long type_min(struct symbol
*base_type
);
235 /* smatch_ignore.c */
236 void add_ignore(int owner
, const char *name
, struct symbol
*sym
);
237 int is_ignored(int owner
, const char *name
, struct symbol
*sym
);
240 struct tracker
*alloc_tracker(int owner
, const char *name
, struct symbol
*sym
);
241 void add_tracker(struct tracker_list
**list
, int owner
, const char *name
,
243 void add_tracker_expr(struct tracker_list
**list
, int owner
, struct expression
*expr
);
244 void del_tracker(struct tracker_list
**list
, int owner
, const char *name
,
246 int in_tracker_list(struct tracker_list
*list
, int owner
, const char *name
,
248 struct tracker_list
*clone_tracker_list(struct tracker_list
*orig_list
);
249 void free_tracker_list(struct tracker_list
**list
);
250 void free_trackers_and_list(struct tracker_list
**list
);
252 /* smatch_conditions */
253 int in_condition(void);
257 void smatch (int argc
, char **argv
);
258 int inside_loop(void);
259 int in_expression_statement(void);
260 void __split_expr(struct expression
*expr
);
261 void __split_stmt(struct statement
*stmt
);
262 extern int option_assume_loops
;
263 extern int option_known_conditions
;
264 extern int option_two_passes
;
265 extern int option_no_db
;
266 extern struct expression_list
*big_expression_stack
;
267 extern struct statement_list
*big_statement_stack
;
268 extern int __in_pre_condition
;
269 extern int __bail_on_rest_of_function
;
271 /* smatch_conditions */
272 void __split_whole_condition(struct expression
*expr
);
273 void __handle_logic(struct expression
*expr
);
274 int __handle_condition_assigns(struct expression
*expr
);
275 int __handle_select_assigns(struct expression
*expr
);
276 int __handle_expr_statement_assigns(struct expression
*expr
);
278 /* smatch_implied.c */
279 extern int option_debug_implied
;
280 extern int option_no_implied
;
281 void get_implications(char *name
, struct symbol
*sym
, int comparison
, long long num
,
282 struct state_list
**true_states
,
283 struct state_list
**false_states
);
284 struct range_list_stack
;
285 struct state_list
*__implied_case_slist(struct expression
*switch_expr
,
286 struct expression
*case_expr
,
287 struct range_list_stack
**remaining_cases
,
288 struct state_list
**raw_slist
);
289 struct range_list
*__get_implied_values(struct expression
*switch_expr
);
291 /* smatch_extras.c */
292 #define SMATCH_EXTRA 1 /* this is my_id from smatch extra set in smatch.c */
298 extern struct data_range whole_range
;
300 int known_condition_true(struct expression
*expr
);
301 int known_condition_false(struct expression
*expr
);
302 int implied_condition_true(struct expression
*expr
);
303 int implied_condition_false(struct expression
*expr
);
305 /* smatch_states.c */
306 void __push_fake_cur_slist();
307 struct state_list
*__pop_fake_cur_slist();
309 int unreachable(void);
310 void __set_sm(struct sm_state
*sm
);
311 struct state_list
*__get_cur_slist(void);
312 void __set_true_false_sm(struct sm_state
*true_state
,
313 struct sm_state
*false_state
);
314 void nullify_path(void);
315 void __match_nullify_path_hook(const char *fn
, struct expression
*expr
,
317 void __unnullify_path(void);
318 int __path_is_null(void);
319 void clear_all_states(void);
321 struct sm_state
*get_sm_state(int owner
, const char *name
,
323 struct sm_state
*get_sm_state_expr(int owner
, struct expression
*expr
);
324 void __push_true_states(void);
325 void __use_false_states(void);
326 void __discard_false_states(void);
327 void __merge_false_states(void);
328 void __merge_true_states(void);
330 void __negate_cond_stacks(void);
331 void __use_pre_cond_states(void);
332 void __use_cond_true_states(void);
333 void __use_cond_false_states(void);
334 void __push_cond_stacks(void);
335 struct state_list
*__copy_cond_true_states(void);
336 struct state_list
*__copy_cond_false_states(void);
337 struct state_list
*__pop_cond_true_stack(void);
338 struct state_list
*__pop_cond_false_stack(void);
339 void __and_cond_states(void);
340 void __or_cond_states(void);
341 void __save_pre_cond_states(void);
342 void __discard_pre_cond_states(void);
343 void __use_cond_states(void);
345 void __warn_on_silly_pre_loops(void);
347 void __push_continues(void);
348 void __discard_continues(void);
349 void __process_continues(void);
350 void __merge_continues(void);
352 void __push_breaks(void);
353 void __process_breaks(void);
354 void __merge_breaks(void);
355 void __use_breaks(void);
357 void __save_switch_states(struct expression
*switch_expr
);
358 void __discard_switches(void);
359 void __merge_switches(struct expression
*switch_expr
, struct expression
*case_expr
);
360 void __push_default(void);
361 void __set_default(void);
362 int __pop_default(void);
364 void __push_conditions(void);
365 void __discard_conditions(void);
367 void __save_gotos(const char *name
);
368 void __merge_gotos(const char *name
);
370 void __print_cur_slist(void);
373 void __pass_to_client(void *data
, enum hook_type type
);
374 void __pass_to_client_no_data(enum hook_type type
);
375 void __pass_case_to_client(struct expression
*switch_expr
,
376 struct expression
*case_expr
);
377 int __has_merge_function(int client_id
);
378 struct smatch_state
*__client_merge_function(int owner
, const char *name
,
380 struct smatch_state
*s1
,
381 struct smatch_state
*s2
);
382 struct smatch_state
*__client_unmatched_state_function(struct sm_state
*sm
);
383 void __push_scope_hooks(void);
384 void __call_scope_hooks(void);
386 /* smatch_function_hooks.c */
387 void create_function_hook_hash(void);
388 void __match_initializer_call(struct symbol
*sym
);
391 #define run_sql(call_back, sql...) \
393 char sql_txt[1024]; \
394 snprintf(sql_txt, 1024, sql); \
395 sql_txt[1023] = '\0'; \
396 sql_exec(call_back, sql_txt); \
399 void sql_exec(int (*callback
)(void*, int, char**, char**), const char *sql
);
400 void open_smatch_db(void);
403 struct token
*get_tokens_file(const char *filename
);
406 extern char *option_project_str
;
407 extern char *data_dir
;
408 extern int option_no_data
;
409 extern int option_spammy
;
410 extern int option_full_path
;
411 extern int option_param_mapper
;
412 extern int option_print_returns
;
413 extern int option_info
;
414 extern int option_call_tree
;
415 extern int num_checks
;
422 extern enum project_type option_project
;
423 const char *check_name(unsigned short id
);
426 /* smatch_buf_size.c */
427 int get_array_size(struct expression
*expr
);
428 int get_array_size_bytes(struct expression
*expr
);
430 /* check_locking.c */
431 void print_held_locks();
433 #endif /* !SMATCH_H_ */