2 * smatch/smatch_buf_size.c
4 * Copyright (C) 2010 Dan Carpenter.
6 * Licensed under the Open Software License version 1.1
14 #include "smatch_slist.h"
15 #include "smatch_extra.h"
18 * This check has two smatch IDs.
19 * my_size_id - used to store the size of arrays.
20 * my_strlen_id - track the strlen() of buffers.
23 static int my_size_id
;
24 static int my_strlen_id
;
30 static struct limiter b0_l2
= {0, 2};
32 static _Bool params_set
[32];
34 static void set_undefined(struct sm_state
*sm
)
36 if (sm
->state
!= &undefined
)
37 set_state(sm
->owner
, sm
->name
, sm
->sym
, &undefined
);
40 void set_param_buf_size(const char *name
, struct symbol
*sym
, char *key
, char *value
)
45 if (strncmp(key
, "$$", 2))
48 snprintf(fullname
, 256, "%s%s", name
, key
+ 2);
51 size
= strtoul(value
, NULL
, 10);
55 set_state(my_size_id
, fullname
, sym
, alloc_state_num(size
));
58 static int bytes_per_element(struct expression
*expr
)
63 if (expr
->type
== EXPR_STRING
)
65 type
= get_type(expr
);
69 if (type
->type
!= SYM_PTR
&& type
->type
!= SYM_ARRAY
)
72 type
= get_base_type(type
);
73 bpe
= bits_to_bytes(type
->bit_size
);
75 if (bpe
== -1) /* void pointer */
81 static int bytes_to_elements(struct expression
*expr
, int bytes
)
85 bpe
= bytes_per_element(expr
);
91 static int elements_to_bytes(struct expression
*expr
, int elements
)
95 bpe
= bytes_per_element(expr
);
96 return elements
* bpe
;
99 static int get_initializer_size(struct expression
*expr
)
101 switch (expr
->type
) {
103 return expr
->string
->length
;
104 case EXPR_INITIALIZER
: {
105 struct expression
*tmp
;
109 FOR_EACH_PTR(expr
->expr_list
, tmp
) {
110 if (tmp
->type
== EXPR_INDEX
&& tmp
->idx_to
> max
)
113 } END_FOR_EACH_PTR(tmp
);
119 return get_array_size(expr
);
125 static int db_size_callback(void *unused
, int argc
, char **argv
, char **azColName
)
127 db_size
= atoi(argv
[0]);
131 static int size_from_db(struct expression
*expr
)
138 name
= get_member_name(expr
);
143 run_sql(db_size_callback
, "select size from type_size where type = '%s'",
148 static int get_real_array_size(struct expression
*expr
)
153 type
= get_type(expr
);
154 if (!type
|| type
->type
!= SYM_ARRAY
)
157 ret
= get_expression_value(type
->array_size
);
158 /* Dynamically sized array are -1 in sparse */
161 /* People put one element arrays on the end of structs */
168 static int get_size_from_initializer(struct expression
*expr
)
170 if (expr
->type
!= EXPR_SYMBOL
|| !expr
->symbol
->initializer
)
172 if (expr
->symbol
->initializer
== expr
) /* int a = a; */
174 return get_initializer_size(expr
->symbol
->initializer
);
177 static int get_stored_size_bytes(struct expression
*expr
)
179 struct sm_state
*sm
, *tmp
;
182 sm
= get_sm_state_expr(my_size_id
, expr
);
186 FOR_EACH_PTR(sm
->possible
, tmp
) {
187 if (PTR_INT(tmp
->state
->data
) > max
)
188 max
= PTR_INT(tmp
->state
->data
);
189 } END_FOR_EACH_PTR(tmp
);
194 static int get_size_from_strlen(struct expression
*expr
)
196 struct smatch_state
*state
;
199 state
= get_state_expr(my_strlen_id
, expr
);
200 if (!state
|| !state
->data
)
202 if (get_implied_max((struct expression
*)state
->data
, &len
))
203 return len
+ 1; /* add one because strlen doesn't include the NULL */
207 int get_array_size_bytes(struct expression
*expr
)
211 expr
= strip_expr(expr
);
215 /* strcpy(foo, "BAR"); */
216 if (expr
->type
== EXPR_STRING
)
217 return expr
->string
->length
;
220 size
= get_real_array_size(expr
);
222 return elements_to_bytes(expr
, size
);
224 /* buf = malloc(1024); */
225 size
= get_stored_size_bytes(expr
);
229 /* char *foo = "BAR" */
230 size
= get_size_from_initializer(expr
);
232 return elements_to_bytes(expr
, size
);
234 /* if (strlen(foo) > 4) */
235 size
= get_size_from_strlen(expr
);
239 return size_from_db(expr
);
242 int get_array_size(struct expression
*expr
)
246 bytes
= get_array_size_bytes(expr
);
247 return bytes_to_elements(expr
, bytes
);
250 static void match_strlen_condition(struct expression
*expr
)
252 struct expression
*left
;
253 struct expression
*right
;
254 struct expression
*str
= NULL
;
256 int strlen_right
= 0;
258 struct smatch_state
*true_state
= NULL
;
259 struct smatch_state
*false_state
= NULL
;
261 if (expr
->type
!= EXPR_COMPARE
)
263 left
= strip_expr(expr
->left
);
264 right
= strip_expr(expr
->right
);
266 if (left
->type
== EXPR_CALL
&& sym_name_is("strlen", left
->fn
)) {
267 str
= get_argument_from_call_expr(left
->args
, 0);
270 if (right
->type
== EXPR_CALL
&& sym_name_is("strlen", right
->fn
)) {
271 str
= get_argument_from_call_expr(right
->args
, 0);
275 if (!strlen_left
&& !strlen_right
)
277 if (strlen_left
&& strlen_right
)
281 if (!get_value(right
, &val
))
285 if (!get_value(left
, &val
))
289 if (expr
->op
== SPECIAL_EQUAL
) {
290 set_true_false_states_expr(my_size_id
, str
, alloc_state_num(val
+ 1), NULL
);
293 if (expr
->op
== SPECIAL_NOTEQUAL
) {
294 set_true_false_states_expr(my_size_id
, str
, NULL
, alloc_state_num(val
+ 1));
300 case SPECIAL_UNSIGNED_LT
:
302 true_state
= alloc_state_num(val
);
304 false_state
= alloc_state_num(val
+ 1);
307 case SPECIAL_UNSIGNED_LTE
:
309 true_state
= alloc_state_num(val
+ 1);
311 false_state
= alloc_state_num(val
);
314 case SPECIAL_UNSIGNED_GTE
:
316 false_state
= alloc_state_num(val
);
318 true_state
= alloc_state_num(val
+ 1);
321 case SPECIAL_UNSIGNED_GT
:
323 false_state
= alloc_state_num(val
+ 1);
325 true_state
= alloc_state_num(val
);
328 set_true_false_states_expr(my_size_id
, str
, true_state
, false_state
);
331 static struct expression
*strip_ampersands(struct expression
*expr
)
335 if (expr
->type
!= EXPR_PREOP
)
339 type
= get_type(expr
->unop
);
340 if (!type
|| type
->type
!= SYM_ARRAY
)
345 static void match_array_assignment(struct expression
*expr
)
347 struct expression
*left
;
348 struct expression
*right
;
353 left
= strip_expr(expr
->left
);
354 right
= strip_expr(expr
->right
);
355 right
= strip_ampersands(right
);
356 array_size
= get_array_size_bytes(right
);
358 set_state_expr(my_size_id
, left
, alloc_state_num(array_size
));
361 static void match_alloc(const char *fn
, struct expression
*expr
, void *_size_arg
)
363 int size_arg
= PTR_INT(_size_arg
);
364 struct expression
*right
;
365 struct expression
*arg
;
368 right
= strip_expr(expr
->right
);
369 arg
= get_argument_from_call_expr(right
->args
, size_arg
);
370 if (!get_implied_value(arg
, &bytes
))
373 set_state_expr(my_size_id
, expr
->left
, alloc_state_num(bytes
));
376 char *member
= get_member_name(expr
->left
);
379 sm_msg("info: '%s' allocated_buf_size %lld",
385 static void match_calloc(const char *fn
, struct expression
*expr
, void *unused
)
387 struct expression
*right
;
388 struct expression
*arg
;
392 right
= strip_expr(expr
->right
);
393 arg
= get_argument_from_call_expr(right
->args
, 0);
394 if (!get_implied_value(arg
, &elements
))
396 arg
= get_argument_from_call_expr(right
->args
, 1);
397 if (!get_implied_value(arg
, &size
))
399 set_state_expr(my_size_id
, expr
->left
, alloc_state_num(elements
* size
));
402 static void match_strlen(const char *fn
, struct expression
*expr
, void *unused
)
404 struct expression
*right
;
405 struct expression
*str
;
406 struct expression
*len_expr
;
408 struct smatch_state
*state
;
410 right
= strip_expr(expr
->right
);
411 str
= get_argument_from_call_expr(right
->args
, 0);
412 len_expr
= strip_expr(expr
->left
);
414 len_name
= get_variable_from_expr(len_expr
, NULL
);
418 state
= __alloc_smatch_state(0);
419 state
->name
= len_name
;
420 state
->data
= len_expr
;
421 set_state_expr(my_strlen_id
, str
, state
);
424 static void match_limited(const char *fn
, struct expression
*expr
, void *_limiter
)
426 struct limiter
*limiter
= (struct limiter
*)_limiter
;
427 struct expression
*dest
;
428 struct expression
*size_expr
;
431 dest
= get_argument_from_call_expr(expr
->args
, limiter
->buf_arg
);
432 size_expr
= get_argument_from_call_expr(expr
->args
, limiter
->limit_arg
);
433 if (!get_implied_max(size_expr
, &size
))
435 set_state_expr(my_size_id
, dest
, alloc_state_num(size
));
438 static void match_strcpy(const char *fn
, struct expression
*expr
, void *unused
)
440 struct expression fake_assign
;
442 fake_assign
.op
= '=';
443 fake_assign
.left
= get_argument_from_call_expr(expr
->args
, 0);
444 fake_assign
.right
= get_argument_from_call_expr(expr
->args
, 1);
445 match_array_assignment(&fake_assign
);
448 static void match_strndup(const char *fn
, struct expression
*expr
, void *unused
)
450 struct expression
*fn_expr
;
451 struct expression
*size_expr
;
454 fn_expr
= strip_expr(expr
->right
);
455 size_expr
= get_argument_from_call_expr(fn_expr
->args
, 1);
456 if (!get_implied_max(size_expr
, &size
))
459 /* It's easy to forget space for the NUL char */
461 set_state_expr(my_size_id
, expr
->left
, alloc_state_num(size
));
464 static void match_call(struct expression
*expr
)
467 struct expression
*arg
;
471 name
= get_fnptr_name(expr
->fn
);
476 FOR_EACH_PTR(expr
->args
, arg
) {
477 bytes
= get_array_size_bytes(arg
);
479 sm_msg("info: passes_buffer '%s' %d '$$' %d %s",
481 is_static(expr
->fn
) ? "static" : "global");
483 } END_FOR_EACH_PTR(arg
);
488 static void struct_member_callback(char *fn
, char *global_static
, int param
, char *printed_name
, struct smatch_state
*state
)
490 if (state
== &merged
)
492 sm_msg("info: passes_buffer '%s' %d '%s' %s %s", fn
, param
, printed_name
, state
->name
, global_static
);
495 static void match_func_end(struct symbol
*sym
)
497 memset(params_set
, 0, sizeof(params_set
));
500 void register_buf_size(int id
)
504 add_definition_db_callback(set_param_buf_size
, BUF_SIZE
);
506 add_function_assign_hook("malloc", &match_alloc
, INT_PTR(0));
507 add_function_assign_hook("calloc", &match_calloc
, NULL
);
508 add_function_assign_hook("memdup", &match_alloc
, INT_PTR(1));
509 if (option_project
== PROJ_KERNEL
) {
510 add_function_assign_hook("kmalloc", &match_alloc
, INT_PTR(0));
511 add_function_assign_hook("kzalloc", &match_alloc
, INT_PTR(0));
512 add_function_assign_hook("vmalloc", &match_alloc
, INT_PTR(0));
513 add_function_assign_hook("__vmalloc", &match_alloc
, INT_PTR(0));
514 add_function_assign_hook("kcalloc", &match_calloc
, NULL
);
515 add_function_assign_hook("drm_malloc_ab", &match_calloc
, NULL
);
516 add_function_assign_hook("drm_calloc_large", &match_calloc
, NULL
);
517 add_function_assign_hook("kmemdup", &match_alloc
, INT_PTR(1));
518 add_function_assign_hook("kmemdup_user", &match_alloc
, INT_PTR(1));
520 add_hook(&match_array_assignment
, ASSIGNMENT_HOOK
);
521 add_hook(&match_strlen_condition
, CONDITION_HOOK
);
522 add_function_assign_hook("strlen", &match_strlen
, NULL
);
524 add_function_assign_hook("strndup", match_strndup
, NULL
);
525 if (option_project
== PROJ_KERNEL
)
526 add_function_assign_hook("kstrndup", match_strndup
, NULL
);
528 add_hook(&match_func_end
, END_FUNC_HOOK
);
529 add_modification_hook(my_size_id
, &set_undefined
);
532 void register_strlen(int id
)
535 add_modification_hook(my_strlen_id
, &set_undefined
);
538 void register_buf_size_late(int id
)
540 add_function_hook("strlcpy", &match_limited
, &b0_l2
);
541 add_function_hook("strlcat", &match_limited
, &b0_l2
);
542 add_function_hook("memscan", &match_limited
, &b0_l2
);
544 add_function_hook("strcpy", &match_strcpy
, NULL
);
547 add_hook(&match_call
, FUNCTION_CALL_HOOK
);
548 add_member_info_callback(my_size_id
, struct_member_callback
);