2 * sparse/smatch_slist.c
4 * Copyright (C) 2008,2009 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
13 #include "smatch_slist.h"
17 ALLOCATOR(smatch_state
, "smatch state");
18 ALLOCATOR(sm_state
, "sm state");
19 ALLOCATOR(named_slist
, "named slist");
20 __DO_ALLOCATOR(char, 0, 1, "state names", sname
);
22 void __print_slist(struct state_list
*slist
)
24 struct sm_state
*state
;
25 struct sm_state
*poss
;
28 printf("dumping slist at %d\n", get_lineno());
29 FOR_EACH_PTR(slist
, state
) {
30 printf("[%s] '%s'=%s (", check_name(state
->owner
), state
->name
,
31 show_state(state
->state
));
33 FOR_EACH_PTR(state
->possible
, poss
) {
36 printf("%s", show_state(poss
->state
));
37 } END_FOR_EACH_PTR(poss
);
39 } END_FOR_EACH_PTR(state
);
44 /* NULL states go at the end to simplify merge_slist */
45 int cmp_tracker(const struct sm_state
*a
, const struct sm_state
*b
)
56 if (a
->owner
> b
->owner
)
58 if (a
->owner
< b
->owner
)
61 ret
= strcmp(a
->name
, b
->name
);
65 if (!b
->sym
&& a
->sym
)
67 if (!a
->sym
&& b
->sym
)
77 static int cmp_sm_states(const struct sm_state
*a
, const struct sm_state
*b
)
81 ret
= cmp_tracker(a
, b
);
85 /* todo: add hook for smatch_extra.c */
86 if (a
->state
> b
->state
)
88 if (a
->state
< b
->state
)
93 static struct sm_state
*alloc_state_no_name(int owner
, const char *name
,
95 struct smatch_state
*state
)
99 tmp
= alloc_sm_state(owner
, NULL
, sym
, state
);
104 void add_sm_state_slist(struct state_list
**slist
, struct sm_state
*new)
106 struct sm_state
*tmp
;
108 FOR_EACH_PTR(*slist
, tmp
) {
109 if (cmp_sm_states(tmp
, new) < 0)
111 else if (cmp_sm_states(tmp
, new) == 0) {
114 INSERT_CURRENT(new, tmp
);
117 } END_FOR_EACH_PTR(tmp
);
118 add_ptr_list(slist
, new);
121 static void add_possible(struct sm_state
*sm
, struct sm_state
*new)
123 struct sm_state
*tmp
;
124 struct sm_state
*tmp2
;
127 struct smatch_state
*s
;
129 s
= merge_states(sm
->owner
, sm
->name
, sm
->sym
, sm
->state
, NULL
);
130 tmp
= alloc_state_no_name(sm
->owner
, sm
->name
, sm
->sym
, s
);
131 add_sm_state_slist(&sm
->possible
, tmp
);
135 FOR_EACH_PTR(new->possible
, tmp
) {
136 tmp2
= alloc_state_no_name(tmp
->owner
,tmp
->name
, tmp
->sym
,
138 add_sm_state_slist(&sm
->possible
, tmp2
);
139 } END_FOR_EACH_PTR(tmp
);
142 char *alloc_sname(const char *str
)
148 tmp
= __alloc_sname(strlen(str
) + 1);
153 struct sm_state
*alloc_sm_state(int owner
, const char *name
,
154 struct symbol
*sym
, struct smatch_state
*state
)
156 struct sm_state
*sm_state
= __alloc_sm_state(0);
158 sm_state
->name
= alloc_sname(name
);
159 sm_state
->owner
= owner
;
161 sm_state
->state
= state
;
162 sm_state
->line
= get_lineno();
163 sm_state
->merged
= 0;
164 sm_state
->implied
= 0;
165 sm_state
->my_pool
= NULL
;
166 sm_state
->left
= NULL
;
167 sm_state
->right
= NULL
;
168 sm_state
->nr_children
= 1;
169 sm_state
->possible
= NULL
;
170 add_ptr_list(&sm_state
->possible
, sm_state
);
174 static void free_sm_state(struct sm_state
*sm
)
176 free_slist(&sm
->possible
);
178 * fixme. Free the actual state.
179 * Right now we leave it until the end of the function
180 * because we don't want to double free it.
181 * Use the freelist to not double free things
185 static void free_all_sm_states(struct allocation_blob
*blob
)
187 unsigned int size
= sizeof(struct sm_state
);
188 unsigned int offset
= 0;
190 while (offset
< blob
->offset
) {
191 free_sm_state((struct sm_state
*)(blob
->data
+ offset
));
196 /* At the end of every function we free all the sm_states */
197 void free_every_single_sm_state(void)
199 struct allocator_struct
*desc
= &sm_state_allocator
;
200 struct allocation_blob
*blob
= desc
->blobs
;
203 desc
->allocations
= 0;
204 desc
->total_bytes
= 0;
205 desc
->useful_bytes
= 0;
206 desc
->freelist
= NULL
;
208 struct allocation_blob
*next
= blob
->next
;
209 free_all_sm_states(blob
);
210 blob_free(blob
, desc
->chunking
);
216 struct sm_state
*clone_state(struct sm_state
*s
)
218 struct sm_state
*ret
;
220 ret
= alloc_state_no_name(s
->owner
, s
->name
, s
->sym
, s
->state
);
221 ret
->merged
= s
->merged
;
222 ret
->implied
= s
->implied
;
223 /* clone_state() doesn't copy the my_pools. Each state needs to have
225 ret
->possible
= clone_slist(s
->possible
);
227 ret
->right
= s
->right
;
228 ret
->nr_children
= s
->nr_children
;
232 int is_merged(struct sm_state
*sm
)
237 int is_implied(struct sm_state
*sm
)
242 int slist_has_state(struct state_list
*slist
, struct smatch_state
*state
)
244 struct sm_state
*tmp
;
246 FOR_EACH_PTR(slist
, tmp
) {
247 if (tmp
->state
== state
)
249 } END_FOR_EACH_PTR(tmp
);
253 static void check_order(struct state_list
*slist
)
256 struct sm_state
*state
;
257 struct sm_state
*last
= NULL
;
260 FOR_EACH_PTR(slist
, state
) {
261 if (last
&& cmp_tracker(state
, last
) <= 0) {
262 printf("Error. Unsorted slist %d vs %d, %p vs %p, "
263 "%s vs %s\n", last
->owner
, state
->owner
,
264 last
->sym
, state
->sym
, last
->name
, state
->name
);
268 } END_FOR_EACH_PTR(state
);
275 struct state_list
*clone_slist(struct state_list
*from_slist
)
277 struct sm_state
*state
;
278 struct state_list
*to_slist
= NULL
;
280 FOR_EACH_PTR(from_slist
, state
) {
281 add_ptr_list(&to_slist
, state
);
282 } END_FOR_EACH_PTR(state
);
283 check_order(to_slist
);
287 struct state_list_stack
*clone_stack(struct state_list_stack
*from_stack
)
289 struct state_list
*slist
;
290 struct state_list_stack
*to_stack
= NULL
;
292 FOR_EACH_PTR(from_stack
, slist
) {
293 push_slist(&to_stack
, slist
);
294 } END_FOR_EACH_PTR(slist
);
298 struct smatch_state
*merge_states(int owner
, const char *name
,
300 struct smatch_state
*state1
,
301 struct smatch_state
*state2
)
303 struct smatch_state
*ret
;
305 if (state1
== state2
)
307 else if (__has_merge_function(owner
))
308 ret
= __client_merge_function(owner
, name
, sym
, state1
, state2
);
309 else if (!state1
|| !state2
)
317 * add_pool() adds a slist to ->pools. If the slist has already been
318 * added earlier then it doesn't get added a second time.
320 void add_pool(struct state_list_stack
**pools
, struct state_list
*new)
322 struct state_list
*tmp
;
324 FOR_EACH_PTR(*pools
, tmp
) {
327 else if (tmp
== new) {
330 INSERT_CURRENT(new, tmp
);
333 } END_FOR_EACH_PTR(tmp
);
334 add_ptr_list(pools
, new);
337 struct sm_state
*merge_sm_states(struct sm_state
*one
, struct sm_state
*two
)
339 struct smatch_state
*s
;
340 struct sm_state
*result
;
344 s
= merge_states(one
->owner
, one
->name
, one
->sym
, one
->state
, two
->state
);
345 result
= alloc_state_no_name(one
->owner
, one
->name
, one
->sym
, s
);
346 if (one
->line
== two
->line
)
347 result
->line
= one
->line
;
351 result
->nr_children
= one
->nr_children
+ two
->nr_children
;
352 add_possible(result
, one
);
353 add_possible(result
, two
);
356 struct sm_state
*tmp
;
359 printf("%d merge name='%s' [%s] %s(L %d) + %s(L %d) => %s (",
360 get_lineno(), one
->name
, check_name(one
->owner
),
361 show_state(one
->state
), one
->line
,
362 show_state(two
->state
), two
->line
,
365 FOR_EACH_PTR(result
->possible
, tmp
) {
369 printf("%s", show_state(tmp
->state
));
370 } END_FOR_EACH_PTR(tmp
);
377 struct sm_state
*get_sm_state_slist(struct state_list
*slist
, int owner
, const char *name
,
380 struct sm_state
*state
;
385 FOR_EACH_PTR(slist
, state
) {
386 if (state
->owner
== owner
&& state
->sym
== sym
387 && !strcmp(state
->name
, name
))
389 } END_FOR_EACH_PTR(state
);
393 struct smatch_state
*get_state_slist(struct state_list
*slist
,
394 int owner
, const char *name
,
397 struct sm_state
*state
;
399 state
= get_sm_state_slist(slist
, owner
, name
, sym
);
405 void overwrite_sm_state(struct state_list
**slist
, struct sm_state
*new)
407 struct sm_state
*tmp
;
409 FOR_EACH_PTR(*slist
, tmp
) {
410 if (cmp_tracker(tmp
, new) < 0)
412 else if (cmp_tracker(tmp
, new) == 0) {
413 REPLACE_CURRENT_PTR(tmp
, new);
416 INSERT_CURRENT(new, tmp
);
419 } END_FOR_EACH_PTR(tmp
);
420 add_ptr_list(slist
, new);
423 void overwrite_sm_state_stack(struct state_list_stack
**stack
,
424 struct sm_state
*state
)
426 struct state_list
*slist
;
428 slist
= pop_slist(stack
);
429 overwrite_sm_state(&slist
, state
);
430 push_slist(stack
, slist
);
433 void set_state_slist(struct state_list
**slist
, int owner
, const char *name
,
434 struct symbol
*sym
, struct smatch_state
*state
)
436 struct sm_state
*tmp
;
437 struct sm_state
*new = alloc_sm_state(owner
, name
, sym
, state
);
439 FOR_EACH_PTR(*slist
, tmp
) {
440 if (cmp_tracker(tmp
, new) < 0)
442 else if (cmp_tracker(tmp
, new) == 0) {
443 REPLACE_CURRENT_PTR(tmp
, new);
446 INSERT_CURRENT(new, tmp
);
449 } END_FOR_EACH_PTR(tmp
);
450 add_ptr_list(slist
, new);
453 void delete_state_slist(struct state_list
**slist
, int owner
, const char *name
,
456 struct sm_state
*state
;
458 FOR_EACH_PTR(*slist
, state
) {
459 if (state
->owner
== owner
&& state
->sym
== sym
460 && !strcmp(state
->name
, name
)){
461 DELETE_CURRENT_PTR(state
);
464 } END_FOR_EACH_PTR(state
);
467 void delete_state_stack(struct state_list_stack
**stack
, int owner
, const char *name
,
470 struct state_list
*slist
;
472 slist
= pop_slist(stack
);
473 delete_state_slist(&slist
, owner
, name
, sym
);
474 push_slist(stack
, slist
);
477 void push_slist(struct state_list_stack
**list_stack
, struct state_list
*slist
)
479 add_ptr_list(list_stack
, slist
);
482 struct state_list
*pop_slist(struct state_list_stack
**list_stack
)
484 struct state_list
*slist
;
486 slist
= last_ptr_list((struct ptr_list
*)*list_stack
);
487 delete_ptr_list_last((struct ptr_list
**)list_stack
);
491 void free_slist(struct state_list
**slist
)
493 __free_ptr_list((struct ptr_list
**)slist
);
496 void free_stack(struct state_list_stack
**stack
)
498 __free_ptr_list((struct ptr_list
**)stack
);
501 void free_stack_and_slists(struct state_list_stack
**slist_stack
)
503 struct state_list
*slist
;
505 FOR_EACH_PTR(*slist_stack
, slist
) {
507 } END_FOR_EACH_PTR(slist
);
508 free_stack(slist_stack
);
512 * set_state_stack() sets the state for the top slist on the stack.
514 void set_state_stack(struct state_list_stack
**stack
, int owner
, const char *name
,
515 struct symbol
*sym
, struct smatch_state
*state
)
517 struct state_list
*slist
;
519 slist
= pop_slist(stack
);
520 set_state_slist(&slist
, owner
, name
, sym
, state
);
521 push_slist(stack
, slist
);
525 * get_sm_state_stack() gets the state for the top slist on the stack.
527 struct sm_state
*get_sm_state_stack(struct state_list_stack
*stack
,
528 int owner
, const char *name
,
531 struct state_list
*slist
;
532 struct sm_state
*ret
;
534 slist
= pop_slist(&stack
);
535 ret
= get_sm_state_slist(slist
, owner
, name
, sym
);
536 push_slist(&stack
, slist
);
541 struct smatch_state
*get_state_stack(struct state_list_stack
*stack
,
542 int owner
, const char *name
,
545 struct sm_state
*state
;
547 state
= get_sm_state_stack(stack
, owner
, name
, sym
);
553 static void match_states(struct state_list
**one
, struct state_list
**two
)
555 struct sm_state
*one_state
;
556 struct sm_state
*two_state
;
557 struct sm_state
*tmp
;
558 struct smatch_state
*tmp_state
;
559 struct state_list
*add_to_one
= NULL
;
560 struct state_list
*add_to_two
= NULL
;
562 PREPARE_PTR_LIST(*one
, one_state
);
563 PREPARE_PTR_LIST(*two
, two_state
);
565 if (!one_state
&& !two_state
)
567 if (cmp_tracker(one_state
, two_state
) < 0) {
568 tmp_state
= __client_unmatched_state_function(one_state
);
569 tmp
= alloc_state_no_name(one_state
->owner
,one_state
->name
,
570 one_state
->sym
, tmp_state
);
571 add_ptr_list(&add_to_two
, tmp
);
572 NEXT_PTR_LIST(one_state
);
573 } else if (cmp_tracker(one_state
, two_state
) == 0) {
574 NEXT_PTR_LIST(one_state
);
575 NEXT_PTR_LIST(two_state
);
577 tmp_state
= __client_unmatched_state_function(two_state
);
578 tmp
= alloc_state_no_name(two_state
->owner
,two_state
->name
,
579 two_state
->sym
, tmp_state
);
580 add_ptr_list(&add_to_one
, tmp
);
581 NEXT_PTR_LIST(two_state
);
584 FINISH_PTR_LIST(two_state
);
585 FINISH_PTR_LIST(one_state
);
587 overwrite_slist(add_to_one
, one
);
588 overwrite_slist(add_to_two
, two
);
591 static void clone_pool_havers(struct state_list
*slist
)
593 struct sm_state
*state
;
594 struct sm_state
*new;
596 FOR_EACH_PTR(slist
, state
) {
597 if (state
->my_pool
) {
598 new = clone_state(state
);
599 REPLACE_CURRENT_PTR(state
, new);
601 } END_FOR_EACH_PTR(state
);
605 * merge_slist() is called whenever paths merge, such as after
606 * an if statement. It takes the two slists and creates one.
608 void merge_slist(struct state_list
**to
, struct state_list
*slist
)
610 struct sm_state
*one_state
, *two_state
, *tmp
;
611 struct state_list
*results
= NULL
;
612 struct state_list
*implied_one
= NULL
;
613 struct state_list
*implied_two
= NULL
;
618 /* merging a null and nonnull path gives you only the nonnull path */
623 *to
= clone_slist(slist
);
627 implied_one
= clone_slist(*to
);
628 implied_two
= clone_slist(slist
);
630 match_states(&implied_one
, &implied_two
);
632 clone_pool_havers(implied_one
);
633 clone_pool_havers(implied_two
);
635 PREPARE_PTR_LIST(implied_one
, one_state
);
636 PREPARE_PTR_LIST(implied_two
, two_state
);
638 if (!one_state
&& !two_state
)
640 if (cmp_tracker(one_state
, two_state
) < 0) {
641 sm_msg("error: Internal smatch error.");
642 NEXT_PTR_LIST(one_state
);
643 } else if (cmp_tracker(one_state
, two_state
) == 0) {
644 if (one_state
!= two_state
) {
645 one_state
->my_pool
= implied_one
;
646 two_state
->my_pool
= implied_two
;
649 tmp
= merge_sm_states(one_state
, two_state
);
650 add_ptr_list(&results
, tmp
);
651 NEXT_PTR_LIST(one_state
);
652 NEXT_PTR_LIST(two_state
);
654 sm_msg("error: Internal smatch error.");
655 NEXT_PTR_LIST(two_state
);
658 FINISH_PTR_LIST(two_state
);
659 FINISH_PTR_LIST(one_state
);
666 * and_slist_stack() is basically the same as popping the top two slists,
667 * overwriting the one with the other and pushing it back on the stack.
668 * The difference is that it checks to see that a mutually exclusive
669 * state isn't included in both stacks. If smatch sees something like
670 * "if (a && !a)" it assumes the second one is true.
672 void and_slist_stack(struct state_list_stack
**slist_stack
)
674 struct sm_state
*tmp
;
675 struct state_list
*right_slist
= pop_slist(slist_stack
);
677 FOR_EACH_PTR(right_slist
, tmp
) {
678 overwrite_sm_state_stack(slist_stack
, tmp
);
679 } END_FOR_EACH_PTR(tmp
);
680 free_slist(&right_slist
);
684 * or_slist_stack() is for if we have: if (foo || bar) { foo->baz;
685 * It pops the two slists from the top of the stack and merges them
686 * together in a way that preserves the things they have in common
687 * but creates a merged state for most of the rest.
688 * You could have code that had: if (foo || foo) { foo->baz;
689 * It's this function which ensures smatch does the right thing.
691 void or_slist_stack(struct state_list_stack
**pre_conds
,
692 struct state_list
*cur_slist
,
693 struct state_list_stack
**slist_stack
)
695 struct state_list
*new;
696 struct state_list
*old
;
697 struct state_list
*res
= NULL
;
698 struct state_list
*tmp_slist
;
700 new = pop_slist(slist_stack
);
701 old
= pop_slist(slist_stack
);
703 tmp_slist
= pop_slist(pre_conds
);
704 res
= clone_slist(tmp_slist
);
705 push_slist(pre_conds
, tmp_slist
);
706 overwrite_slist(old
, &res
);
708 tmp_slist
= clone_slist(cur_slist
);
709 overwrite_slist(new, &tmp_slist
);
711 merge_slist(&res
, tmp_slist
);
713 push_slist(slist_stack
, res
);
714 free_slist(&tmp_slist
);
720 * get_slist_from_named_stack() is only used for gotos.
722 struct state_list
**get_slist_from_named_stack(struct named_stack
*stack
,
725 struct named_slist
*tmp
;
727 FOR_EACH_PTR(stack
, tmp
) {
728 if (!strcmp(tmp
->name
, name
))
730 } END_FOR_EACH_PTR(tmp
);
734 void overwrite_slist(struct state_list
*from
, struct state_list
**to
)
736 struct sm_state
*tmp
;
738 FOR_EACH_PTR(from
, tmp
) {
739 overwrite_sm_state(to
, tmp
);
740 } END_FOR_EACH_PTR(tmp
);