2 * Copyright (C) 2010 Dan Carpenter.
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.
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.
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
22 #include "smatch_slist.h"
23 #include "smatch_extra.h"
24 #include "smatch_function_hashtable.h"
26 #define UNKNOWN_SIZE (-1)
28 static int my_size_id
;
34 static struct limiter b0_l2
= {0, 2};
36 static DEFINE_HASHTABLE_INSERT(insert_func
, char, int);
37 static DEFINE_HASHTABLE_SEARCH(search_func
, char, int);
38 static struct hashtable
*allocation_funcs
;
40 static char *get_fn_name(struct expression
*expr
)
42 if (expr
->type
!= EXPR_CALL
)
44 if (expr
->fn
->type
!= EXPR_SYMBOL
)
46 return expr_to_var(expr
->fn
);
49 static int is_allocation_function(struct expression
*expr
)
54 func
= get_fn_name(expr
);
57 if (search_func(allocation_funcs
, func
))
63 static void add_allocation_function(const char *func
, void *call_back
, int param
)
65 insert_func(allocation_funcs
, (char *)func
, (int *)1);
66 add_function_assign_hook(func
, call_back
, INT_PTR(param
));
69 static int estate_to_size(struct smatch_state
*state
)
73 if (!state
|| !estate_rl(state
))
75 sval
= estate_max(state
);
79 static struct smatch_state
*size_to_estate(int size
)
83 sval
.type
= &int_ctype
;
86 return alloc_estate_sval(sval
);
89 static struct range_list
*size_to_rl(int size
)
93 sval
.type
= &int_ctype
;
96 return alloc_rl(sval
, sval
);
99 static struct smatch_state
*unmatched_size_state(struct sm_state
*sm
)
101 return size_to_estate(UNKNOWN_SIZE
);
104 static void set_size_undefined(struct sm_state
*sm
, struct expression
*mod_expr
)
106 set_state(sm
->owner
, sm
->name
, sm
->sym
, size_to_estate(UNKNOWN_SIZE
));
109 static struct smatch_state
*merge_size_func(struct smatch_state
*s1
, struct smatch_state
*s2
)
111 return merge_estates(s1
, s2
);
114 void set_param_buf_size(const char *name
, struct symbol
*sym
, char *key
, char *value
)
116 struct range_list
*rl
= NULL
;
117 struct smatch_state
*state
;
120 if (strncmp(key
, "$", 1) != 0)
123 snprintf(fullname
, 256, "%s%s", name
, key
+ 1);
125 str_to_rl(&int_ctype
, value
, &rl
);
126 if (!rl
|| is_whole_rl(rl
))
128 state
= alloc_estate_rl(rl
);
129 set_state(my_size_id
, fullname
, sym
, state
);
132 static int bytes_per_element(struct expression
*expr
)
138 if (expr
->type
== EXPR_STRING
)
140 type
= get_type(expr
);
144 if (type
->type
!= SYM_PTR
&& type
->type
!= SYM_ARRAY
)
147 type
= get_base_type(type
);
148 return type_bytes(type
);
151 static int bytes_to_elements(struct expression
*expr
, int bytes
)
155 bpe
= bytes_per_element(expr
);
161 static int elements_to_bytes(struct expression
*expr
, int elements
)
165 bpe
= bytes_per_element(expr
);
166 return elements
* bpe
;
169 static int get_initializer_size(struct expression
*expr
)
171 switch (expr
->type
) {
173 return expr
->string
->length
;
174 case EXPR_INITIALIZER
: {
175 struct expression
*tmp
;
178 FOR_EACH_PTR(expr
->expr_list
, tmp
) {
179 if (tmp
->type
== EXPR_INDEX
) {
180 if (tmp
->idx_to
>= i
)
187 } END_FOR_EACH_PTR(tmp
);
191 return get_array_size(expr
);
196 static struct range_list
*db_size_rl
;
197 static int db_size_callback(void *unused
, int argc
, char **argv
, char **azColName
)
199 struct range_list
*tmp
= NULL
;
202 str_to_rl(&int_ctype
, argv
[0], &db_size_rl
);
204 str_to_rl(&int_ctype
, argv
[0], &tmp
);
205 db_size_rl
= rl_union(db_size_rl
, tmp
);
210 static struct range_list
*size_from_db(struct expression
*expr
)
212 int this_file_only
= 0;
215 name
= get_member_name(expr
);
216 if (!name
&& is_static(expr
)) {
217 name
= expr_to_var(expr
);
223 if (this_file_only
) {
225 run_sql(db_size_callback
, NULL
,
226 "select size from function_type_size where type = '%s' and file = '%s';",
227 name
, get_filename());
234 run_sql(db_size_callback
, NULL
,
235 "select size from type_size where type = '%s';",
240 static void db_returns_buf_size(struct expression
*expr
, int param
, char *unused
, char *math
)
242 struct expression
*call
;
245 if (expr
->type
!= EXPR_ASSIGNMENT
)
247 call
= strip_expr(expr
->right
);
249 if (!parse_call_math(call
, math
, &sval
))
251 set_state_expr(my_size_id
, expr
->left
, size_to_estate(sval
.value
));
254 int get_real_array_size(struct expression
*expr
)
261 if (expr
->type
== EXPR_BINOP
) /* array elements foo[5] */
264 type
= get_type(expr
);
267 if (!type
|| type
->type
!= SYM_ARRAY
)
270 if (!get_implied_value(type
->array_size
, &sval
))
273 /* People put one element arrays on the end of structs */
280 static int get_size_from_initializer(struct expression
*expr
)
282 if (expr
->type
!= EXPR_SYMBOL
|| !expr
->symbol
|| !expr
->symbol
->initializer
)
284 if (expr
->symbol
->initializer
== expr
) /* int a = a; */
286 return get_initializer_size(expr
->symbol
->initializer
);
289 static struct range_list
*get_stored_size_bytes(struct expression
*expr
)
291 struct smatch_state
*state
;
293 state
= get_state_expr(my_size_id
, expr
);
296 return estate_rl(state
);
299 static int get_bytes_from_address(struct expression
*expr
)
306 if (expr
->type
!= EXPR_PREOP
|| expr
->op
!= '&')
308 type
= get_type(expr
);
312 if (type
->type
== SYM_PTR
)
313 type
= get_base_type(type
);
315 ret
= type_bytes(type
);
317 return 0; /* ignore char pointers */
322 static struct expression
*remove_addr_fluff(struct expression
*expr
)
324 struct expression
*tmp
;
327 expr
= strip_expr(expr
);
329 /* remove '&' and '*' operations that cancel */
330 while (expr
&& expr
->type
== EXPR_PREOP
&& expr
->op
== '&') {
331 tmp
= strip_expr(expr
->unop
);
332 if (tmp
->type
!= EXPR_PREOP
)
336 expr
= strip_expr(tmp
->unop
);
342 /* "foo + 0" is just "foo" */
343 if (expr
->type
== EXPR_BINOP
&& expr
->op
== '+' &&
344 get_value(expr
->right
, &sval
) && sval
.value
== 0)
350 static int is_last_member_of_struct(struct symbol
*sym
, struct ident
*member
)
356 FOR_EACH_PTR_REVERSE(sym
->symbol_list
, tmp
) {
357 if (i
++ || !tmp
->ident
)
359 if (tmp
->ident
== member
)
362 } END_FOR_EACH_PTR_REVERSE(tmp
);
367 static int get_stored_size_end_struct_bytes(struct expression
*expr
)
372 struct smatch_state
*state
;
375 if (expr
->type
== EXPR_BINOP
) /* array elements foo[5] */
378 type
= get_type(expr
);
379 if (!type
|| type
->type
!= SYM_ARRAY
)
382 if (!get_implied_value(type
->array_size
, &sval
))
385 if (sval
.value
!= 0 && sval
.value
!= 1)
388 name
= expr_to_var_sym(expr
, &sym
);
390 if (!sym
|| !sym
->ident
)
392 if (!type_bytes(sym
))
395 if (sym
->type
!= SYM_NODE
)
398 state
= get_state(my_size_id
, sym
->ident
->name
, sym
);
399 if (!estate_to_size(state
))
402 sym
= get_real_base_type(sym
);
403 if (!sym
|| sym
->type
!= SYM_PTR
)
405 sym
= get_real_base_type(sym
);
406 if (!sym
|| sym
->type
!= SYM_STRUCT
)
408 if (!is_last_member_of_struct(sym
, expr
->member
))
411 return estate_to_size(state
) - type_bytes(sym
) + type_bytes(type
);
414 static struct range_list
*alloc_int_rl(int value
)
421 return alloc_rl(sval
, sval
);
424 struct range_list
*get_array_size_bytes_rl(struct expression
*expr
)
426 int declared_size
= 0;
427 struct range_list
*ret
= NULL
;
430 expr
= remove_addr_fluff(expr
);
435 if (expr
->type
== EXPR_STRING
)
436 return alloc_int_rl(expr
->string
->length
);
438 if (expr
->type
== EXPR_BINOP
&& expr
->op
== '+') {
441 if (!get_implied_value(expr
->right
, &offset
))
443 size
= get_array_size_bytes(expr
->left
);
446 return alloc_int_rl(size
- offset
.value
);
450 size
= get_real_array_size(expr
);
452 declared_size
= elements_to_bytes(expr
, size
);
454 /* buf = malloc(1024); */
455 ret
= get_stored_size_bytes(expr
);
458 return rl_union(ret
, alloc_int_rl(size
));
462 return alloc_int_rl(declared_size
);
464 size
= get_stored_size_end_struct_bytes(expr
);
466 return alloc_int_rl(size
);
468 /* char *foo = "BAR" */
469 size
= get_size_from_initializer(expr
);
471 return alloc_int_rl(elements_to_bytes(expr
, size
));
473 size
= get_bytes_from_address(expr
);
475 return alloc_int_rl(size
);
477 /* if (strlen(foo) > 4) */
478 size
= get_size_from_strlen(expr
);
480 return alloc_int_rl(size
);
482 ret
= size_from_db(expr
);
489 int get_array_size_bytes(struct expression
*expr
)
491 struct range_list
*rl
;
494 rl
= get_array_size_bytes_rl(expr
);
495 if (!rl_to_sval(rl
, &sval
))
497 if (sval
.uvalue
>= INT_MAX
)
502 int get_array_size_bytes_max(struct expression
*expr
)
504 struct range_list
*rl
;
507 rl
= get_array_size_bytes_rl(expr
);
514 if (bytes
.uvalue
>= INT_MAX
)
519 int get_array_size_bytes_min(struct expression
*expr
)
521 struct range_list
*rl
;
522 struct data_range
*range
;
524 rl
= get_array_size_bytes_rl(expr
);
528 FOR_EACH_PTR(rl
, range
) {
529 if (range
->min
.value
<= 0)
531 if (range
->max
.value
<= 0)
533 if (range
->min
.uvalue
>= INT_MAX
)
535 return range
->min
.value
;
536 } END_FOR_EACH_PTR(range
);
541 int get_array_size(struct expression
*expr
)
545 return bytes_to_elements(expr
, get_array_size_bytes_max(expr
));
548 static void match_strlen_condition(struct expression
*expr
)
550 struct expression
*left
;
551 struct expression
*right
;
552 struct expression
*str
= NULL
;
554 int strlen_right
= 0;
556 struct smatch_state
*true_state
= NULL
;
557 struct smatch_state
*false_state
= NULL
;
559 if (expr
->type
!= EXPR_COMPARE
)
561 left
= strip_expr(expr
->left
);
562 right
= strip_expr(expr
->right
);
564 if (left
->type
== EXPR_CALL
&& sym_name_is("strlen", left
->fn
)) {
565 str
= get_argument_from_call_expr(left
->args
, 0);
568 if (right
->type
== EXPR_CALL
&& sym_name_is("strlen", right
->fn
)) {
569 str
= get_argument_from_call_expr(right
->args
, 0);
573 if (!strlen_left
&& !strlen_right
)
575 if (strlen_left
&& strlen_right
)
579 if (!get_value(right
, &sval
))
583 if (!get_value(left
, &sval
))
587 /* FIXME: why are we using my_size_id here instead of my_strlen_id */
589 if (expr
->op
== SPECIAL_EQUAL
) {
590 set_true_false_states_expr(my_size_id
, str
, size_to_estate(sval
.value
+ 1), NULL
);
593 if (expr
->op
== SPECIAL_NOTEQUAL
) {
594 set_true_false_states_expr(my_size_id
, str
, NULL
, size_to_estate(sval
.value
+ 1));
600 case SPECIAL_UNSIGNED_LT
:
602 true_state
= size_to_estate(sval
.value
);
604 false_state
= size_to_estate(sval
.value
+ 1);
607 case SPECIAL_UNSIGNED_LTE
:
609 true_state
= size_to_estate(sval
.value
+ 1);
611 false_state
= size_to_estate(sval
.value
);
614 case SPECIAL_UNSIGNED_GTE
:
616 false_state
= size_to_estate(sval
.value
);
618 true_state
= size_to_estate(sval
.value
+ 1);
621 case SPECIAL_UNSIGNED_GT
:
623 true_state
= size_to_estate(-1);
624 false_state
= size_to_estate(sval
.value
+ 1);
626 true_state
= size_to_estate(sval
.value
);
629 set_true_false_states_expr(my_size_id
, str
, true_state
, false_state
);
632 static struct expression
*strip_ampersands(struct expression
*expr
)
636 if (expr
->type
!= EXPR_PREOP
)
640 type
= get_type(expr
->unop
);
641 if (!type
|| type
->type
!= SYM_ARRAY
)
646 static void info_record_alloction(struct expression
*buffer
, struct range_list
*rl
)
653 name
= get_member_name(buffer
);
654 if (!name
&& is_static(buffer
))
655 name
= expr_to_var(buffer
);
658 if (rl
&& !is_whole_rl(rl
))
659 sql_insert_function_type_size(name
, show_rl(rl
));
661 sql_insert_function_type_size(name
, "(-1)");
666 static void store_alloc(struct expression
*expr
, struct range_list
*rl
)
668 rl
= clone_rl(rl
); // FIXME!!!
669 info_record_alloction(expr
, rl
);
670 set_state_expr(my_size_id
, expr
, alloc_estate_rl(rl
));
673 static void match_array_assignment(struct expression
*expr
)
675 struct expression
*left
;
676 struct expression
*right
;
677 char *left_member
, *right_member
;
678 struct range_list
*rl
;
683 left
= strip_expr(expr
->left
);
684 right
= strip_expr(expr
->right
);
685 right
= strip_ampersands(right
);
687 if (!is_pointer(left
))
689 if (is_allocation_function(right
))
692 left_member
= get_member_name(left
);
693 right_member
= get_member_name(right
);
694 if (left_member
&& right_member
&& strcmp(left_member
, right_member
) == 0) {
695 free_string(left_member
);
696 free_string(right_member
);
699 free_string(left_member
);
700 free_string(right_member
);
702 if (get_implied_value(right
, &sval
) && sval
.value
== 0) {
703 rl
= alloc_int_rl(0);
707 rl
= get_array_size_bytes_rl(right
);
710 store_alloc(left
, rl
);
713 static void match_alloc(const char *fn
, struct expression
*expr
, void *_size_arg
)
715 int size_arg
= PTR_INT(_size_arg
);
716 struct expression
*right
;
717 struct expression
*arg
;
718 struct range_list
*rl
;
720 right
= strip_expr(expr
->right
);
721 arg
= get_argument_from_call_expr(right
->args
, size_arg
);
722 get_absolute_rl(arg
, &rl
);
723 rl
= cast_rl(&int_ctype
, rl
);
724 store_alloc(expr
->left
, rl
);
727 static void match_calloc(const char *fn
, struct expression
*expr
, void *unused
)
729 struct expression
*right
;
730 struct expression
*arg
;
734 right
= strip_expr(expr
->right
);
735 arg
= get_argument_from_call_expr(right
->args
, 0);
736 if (!get_implied_value(arg
, &elements
))
738 arg
= get_argument_from_call_expr(right
->args
, 1);
739 if (get_implied_value(arg
, &size
))
740 store_alloc(expr
->left
, size_to_rl(elements
.value
* size
.value
));
742 store_alloc(expr
->left
, size_to_rl(-1));
745 static void match_limited(const char *fn
, struct expression
*expr
, void *_limiter
)
747 struct limiter
*limiter
= (struct limiter
*)_limiter
;
748 struct expression
*dest
;
749 struct expression
*size_expr
;
752 dest
= get_argument_from_call_expr(expr
->args
, limiter
->buf_arg
);
753 size_expr
= get_argument_from_call_expr(expr
->args
, limiter
->limit_arg
);
754 if (!get_implied_max(size_expr
, &size
))
756 set_state_expr(my_size_id
, dest
, size_to_estate(size
.value
));
759 static void match_strcpy(const char *fn
, struct expression
*expr
, void *unused
)
761 struct expression fake_assign
;
763 fake_assign
.op
= '=';
764 fake_assign
.left
= get_argument_from_call_expr(expr
->args
, 0);
765 fake_assign
.right
= get_argument_from_call_expr(expr
->args
, 1);
766 match_array_assignment(&fake_assign
);
769 static void match_strndup(const char *fn
, struct expression
*expr
, void *unused
)
771 struct expression
*fn_expr
;
772 struct expression
*size_expr
;
775 fn_expr
= strip_expr(expr
->right
);
776 size_expr
= get_argument_from_call_expr(fn_expr
->args
, 1);
777 if (get_implied_max(size_expr
, &size
)) {
779 store_alloc(expr
->left
, size_to_rl(size
.value
));
781 store_alloc(expr
->left
, size_to_rl(-1));
786 static void match_call(struct expression
*expr
)
788 struct expression
*arg
;
790 struct range_list
*rl
;
794 FOR_EACH_PTR(expr
->args
, arg
) {
796 type
= get_type(arg
);
797 if (!type
|| (type
->type
!= SYM_PTR
&& type
->type
!= SYM_ARRAY
))
799 rl
= get_array_size_bytes_rl(arg
);
804 sql_insert_caller_info(expr
, BUF_SIZE
, i
, "$", show_rl(rl
));
805 } END_FOR_EACH_PTR(arg
);
808 static void struct_member_callback(struct expression
*call
, int param
, char *printed_name
, struct sm_state
*sm
)
810 if (sm
->state
== &merged
||
811 strcmp(sm
->state
->name
, "(-1)") == 0 ||
812 strcmp(sm
->state
->name
, "empty") == 0 ||
813 strcmp(sm
->state
->name
, "0") == 0)
815 sql_insert_caller_info(call
, BUF_SIZE
, param
, printed_name
, sm
->state
->name
);
818 void register_buf_size(int id
)
822 add_unmatched_state_hook(my_size_id
, &unmatched_size_state
);
824 select_caller_info_hook(set_param_buf_size
, BUF_SIZE
);
825 select_return_states_hook(BUF_SIZE
, &db_returns_buf_size
);
827 allocation_funcs
= create_function_hashtable(100);
828 add_allocation_function("malloc", &match_alloc
, 0);
829 add_allocation_function("calloc", &match_calloc
, 0);
830 add_allocation_function("memdup", &match_alloc
, 1);
831 add_allocation_function("realloc", &match_alloc
, 1);
832 if (option_project
== PROJ_KERNEL
) {
833 add_allocation_function("kmalloc", &match_alloc
, 0);
834 add_allocation_function("kzalloc", &match_alloc
, 0);
835 add_allocation_function("vmalloc", &match_alloc
, 0);
836 add_allocation_function("__vmalloc", &match_alloc
, 0);
837 add_allocation_function("kcalloc", &match_calloc
, 0);
838 add_allocation_function("kmalloc_array", &match_calloc
, 0);
839 add_allocation_function("drm_malloc_ab", &match_calloc
, 0);
840 add_allocation_function("drm_calloc_large", &match_calloc
, 0);
841 add_allocation_function("sock_kmalloc", &match_alloc
, 1);
842 add_allocation_function("kmemdup", &match_alloc
, 1);
843 add_allocation_function("kmemdup_user", &match_alloc
, 1);
844 add_allocation_function("dma_alloc_attrs", &match_alloc
, 1);
845 add_allocation_function("pci_alloc_consistent", &match_alloc
, 1);
846 add_allocation_function("pci_alloc_coherent", &match_alloc
, 1);
847 add_allocation_function("devm_kmalloc", &match_alloc
, 1);
848 add_allocation_function("devm_kzalloc", &match_alloc
, 1);
849 add_allocation_function("krealloc", &match_alloc
, 1);
851 add_hook(&match_strlen_condition
, CONDITION_HOOK
);
853 add_allocation_function("strndup", match_strndup
, 0);
854 if (option_project
== PROJ_KERNEL
)
855 add_allocation_function("kstrndup", match_strndup
, 0);
857 add_modification_hook(my_size_id
, &set_size_undefined
);
859 add_merge_hook(my_size_id
, &merge_size_func
);
862 void register_buf_size_late(int id
)
864 /* has to happen after match_alloc() */
865 add_hook(&match_array_assignment
, ASSIGNMENT_HOOK
);
867 add_function_hook("strlcpy", &match_limited
, &b0_l2
);
868 add_function_hook("strlcat", &match_limited
, &b0_l2
);
869 add_function_hook("memscan", &match_limited
, &b0_l2
);
871 add_function_hook("strcpy", &match_strcpy
, NULL
);
873 add_hook(&match_call
, FUNCTION_CALL_HOOK
);
874 add_member_info_callback(my_size_id
, struct_member_callback
);