2 * Tiny C Memory and bounds checker
4 * Copyright (c) 2002 Fabrice Bellard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #if !defined(__FreeBSD__) && !defined(__FreeBSD_kernel__) \
25 && !defined(__DragonFly__) && !defined(__OpenBSD__) && !defined(__NetBSD__)
32 /* #define BOUND_DEBUG */
34 /* define so that bound array is static (faster, but use memory if
35 bound checking not used) */
36 /* #define BOUND_STATIC */
38 /* use malloc hooks. Currently the code cannot be reliable if no hooks */
39 #define CONFIG_TCC_MALLOC_HOOKS
42 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) \
43 || defined(__DragonFly__) || defined(__dietlibc__) \
44 || defined(__UCLIBC__) || defined(__OpenBSD__) || defined(__NetBSD__) \
45 || defined(_WIN32) || defined(TCC_UCLIBC)
46 #warning Bound checking does not support malloc (etc.) in this environment.
47 #undef CONFIG_TCC_MALLOC_HOOKS
51 #define BOUND_T1_BITS 13
52 #define BOUND_T2_BITS 11
53 #define BOUND_T3_BITS (32 - BOUND_T1_BITS - BOUND_T2_BITS)
55 #define BOUND_T1_SIZE (1 << BOUND_T1_BITS)
56 #define BOUND_T2_SIZE (1 << BOUND_T2_BITS)
57 #define BOUND_T3_SIZE (1 << BOUND_T3_BITS)
58 #define BOUND_E_BITS 4
60 #define BOUND_T23_BITS (BOUND_T2_BITS + BOUND_T3_BITS)
61 #define BOUND_T23_SIZE (1 << BOUND_T23_BITS)
64 /* this pointer is generated when bound check is incorrect */
65 #define INVALID_POINTER ((void *)(-2))
66 /* size of an empty region */
67 #define EMPTY_SIZE 0xffffffff
68 /* size of an invalid region */
69 #define INVALID_SIZE 0
71 typedef struct BoundEntry
{
74 struct BoundEntry
*next
;
75 size_t is_invalid
; /* true if pointers outside region are invalid */
78 /* external interface */
79 void __bound_init(void);
80 void __bound_new_region(void *p
, size_t size
);
81 int __bound_delete_region(void *p
);
84 /* an __attribute__ macro is defined in the system headers */
87 #define FASTCALL __attribute__((regparm(3)))
89 void *__bound_malloc(size_t size
, const void *caller
);
90 void *__bound_memalign(size_t size
, size_t align
, const void *caller
);
91 void __bound_free(void *ptr
, const void *caller
);
92 void *__bound_realloc(void *ptr
, size_t size
, const void *caller
);
93 static void *libc_malloc(size_t size
);
94 static void libc_free(void *ptr
);
95 static void install_malloc_hooks(void);
96 static void restore_malloc_hooks(void);
98 #ifdef CONFIG_TCC_MALLOC_HOOKS
99 static void *saved_malloc_hook
;
100 static void *saved_free_hook
;
101 static void *saved_realloc_hook
;
102 static void *saved_memalign_hook
;
105 /* TCC definitions */
106 extern char __bounds_start
; /* start of static bounds table */
107 /* error message, just for TCC */
108 const char *__bound_error_msg
;
110 /* runtime error output */
111 extern void rt_error(size_t pc
, const char *fmt
, ...);
114 static BoundEntry
*__bound_t1
[BOUND_T1_SIZE
]; /* page table */
116 static BoundEntry
**__bound_t1
; /* page table */
118 static BoundEntry
*__bound_empty_t2
; /* empty page, for unused pages */
119 static BoundEntry
*__bound_invalid_t2
; /* invalid page, for invalid pointers */
121 static BoundEntry
*__bound_find_region(BoundEntry
*e1
, void *p
)
130 if (addr
<= e
->size
) {
131 /* put region at the head */
133 e1
->start
= e
->start
;
142 /* no entry found: return empty entry or invalid entry */
144 return __bound_invalid_t2
;
146 return __bound_empty_t2
;
149 /* print a bound error message */
150 static void bound_error(const char *fmt
, ...)
152 __bound_error_msg
= fmt
;
153 fprintf(stderr
,"%s %s: %s\n", __FILE__
, __FUNCTION__
, fmt
);
154 *(int *)0 = 0; /* force a runtime error */
157 static void bound_alloc_error(void)
159 bound_error("not enough memory for bound checking code");
162 /* return '(p + offset)' for pointer arithmetic (a pointer can reach
163 the end of a region in this case */
164 void * FASTCALL
__bound_ptr_add(void *p
, size_t offset
)
166 size_t addr
= (size_t)p
;
171 #if defined(BOUND_DEBUG)
172 printf("%s %s: 0x%x %d\n", __FILE__
, __FUNCTION__
, (int)p
, offset
);
175 e
= __bound_t1
[addr
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
)];
176 e
= (BoundEntry
*)((char *)e
+
177 ((addr
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
178 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
)));
180 if (addr
> e
->size
) {
181 e
= __bound_find_region(e
, p
);
182 addr
= (size_t)p
- e
->start
;
185 if (addr
>= e
->size
) {
186 fprintf(stderr
,"%s %s: %p is outside of the region\n", __FILE__
, __FUNCTION__
, p
+ offset
);
187 return INVALID_POINTER
; /* return an invalid pointer */
192 /* return '(p + offset)' for pointer indirection (the resulting must
193 be strictly inside the region */
194 #define BOUND_PTR_INDIR(dsize) \
195 void * FASTCALL __bound_ptr_indir ## dsize (void *p, size_t offset) \
197 size_t addr = (size_t)p; \
201 e = __bound_t1[addr >> (BOUND_T2_BITS + BOUND_T3_BITS)]; \
202 e = (BoundEntry *)((char *)e + \
203 ((addr >> (BOUND_T3_BITS - BOUND_E_BITS)) & \
204 ((BOUND_T2_SIZE - 1) << BOUND_E_BITS))); \
206 if (addr > e->size) { \
207 e = __bound_find_region(e, p); \
208 addr = (size_t)p - e->start; \
210 addr += offset + dsize; \
211 if (addr > e->size) { \
212 fprintf(stderr,"%s %s: %p is outside of the region\n", __FILE__, __FUNCTION__, p + offset); \
213 return INVALID_POINTER; /* return an invalid pointer */ \
225 /* return the frame pointer of the caller */
226 #define GET_CALLER_FP(fp)\
228 fp = (size_t)__builtin_frame_address(1);\
231 /* called when entering a function to add all the local regions */
232 void FASTCALL
__bound_local_new(void *p1
)
234 size_t addr
, size
, fp
, *p
= p1
;
236 fprintf(stderr
, "%s, %s start p1=%p *p1=%p\n", __FILE__
, __FUNCTION__
, p
, *p
);
246 __bound_new_region((void *)addr
, size
);
249 fprintf(stderr
, "%s, %s end\n", __FILE__
, __FUNCTION__
);
253 /* called when leaving a function to delete all the local regions */
254 void FASTCALL
__bound_local_delete(void *p1
)
256 size_t addr
, fp
, *p
= p1
;
264 __bound_delete_region((void *)addr
);
268 static BoundEntry
*__bound_new_page(void)
273 page
= libc_malloc(sizeof(BoundEntry
) * BOUND_T2_SIZE
);
276 for(i
=0;i
<BOUND_T2_SIZE
;i
++) {
277 /* put empty entries */
279 page
[i
].size
= EMPTY_SIZE
;
281 page
[i
].is_invalid
= 0;
286 /* currently we use malloc(). Should use bound_new_page() */
287 static BoundEntry
*bound_new_entry(void)
290 e
= libc_malloc(sizeof(BoundEntry
));
294 static void bound_free_entry(BoundEntry
*e
)
299 static inline BoundEntry
*get_page(int index
)
302 page
= __bound_t1
[index
];
303 if (page
== __bound_empty_t2
|| page
== __bound_invalid_t2
) {
304 /* create a new page if necessary */
305 page
= __bound_new_page();
306 __bound_t1
[index
] = page
;
311 /* mark a region as being invalid (can only be used during init) */
312 static void mark_invalid(size_t addr
, size_t size
)
316 size_t t1_start
, t1_end
, i
, j
, t2_start
, t2_end
;
321 t2_start
= (start
+ BOUND_T3_SIZE
- 1) >> BOUND_T3_BITS
;
323 t2_end
= end
>> BOUND_T3_BITS
;
325 t2_end
= 1 << (BOUND_T1_BITS
+ BOUND_T2_BITS
);
328 printf("mark_invalid: start = %x %x\n", t2_start
, t2_end
);
331 /* first we handle full pages */
332 t1_start
= (t2_start
+ BOUND_T2_SIZE
- 1) >> BOUND_T2_BITS
;
333 t1_end
= t2_end
>> BOUND_T2_BITS
;
335 i
= t2_start
& (BOUND_T2_SIZE
- 1);
336 j
= t2_end
& (BOUND_T2_SIZE
- 1);
338 if (t1_start
== t1_end
) {
339 page
= get_page(t2_start
>> BOUND_T2_BITS
);
341 page
[i
].size
= INVALID_SIZE
;
342 page
[i
].is_invalid
= 1;
346 page
= get_page(t2_start
>> BOUND_T2_BITS
);
347 for(; i
< BOUND_T2_SIZE
; i
++) {
348 page
[i
].size
= INVALID_SIZE
;
349 page
[i
].is_invalid
= 1;
352 for(i
= t1_start
; i
< t1_end
; i
++) {
353 __bound_t1
[i
] = __bound_invalid_t2
;
356 page
= get_page(t1_end
);
357 for(i
= 0; i
< j
; i
++) {
358 page
[i
].size
= INVALID_SIZE
;
359 page
[i
].is_invalid
= 1;
365 void __bound_init(void)
379 fprintf(stderr
, "%s, %s() start\n", __FILE__
, __FUNCTION__
);
382 /* save malloc hooks and install bound check hooks */
383 install_malloc_hooks();
386 __bound_t1
= libc_malloc(BOUND_T1_SIZE
* sizeof(BoundEntry
*));
390 __bound_empty_t2
= __bound_new_page();
391 for(i
=0;i
<BOUND_T1_SIZE
;i
++) {
392 __bound_t1
[i
] = __bound_empty_t2
;
395 page
= __bound_new_page();
396 for(i
=0;i
<BOUND_T2_SIZE
;i
++) {
397 /* put invalid entries */
399 page
[i
].size
= INVALID_SIZE
;
401 page
[i
].is_invalid
= 1;
403 __bound_invalid_t2
= page
;
405 /* invalid pointer zone */
406 start
= (size_t)INVALID_POINTER
& ~(BOUND_T23_SIZE
- 1);
407 size
= BOUND_T23_SIZE
;
408 mark_invalid(start
, size
);
410 #if defined(CONFIG_TCC_MALLOC_HOOKS)
411 /* malloc zone is also marked invalid. can only use that with
412 * hooks because all libs should use the same malloc. The solution
413 * would be to build a new malloc for tcc.
415 * usually heap (= malloc zone) comes right after bss, i.e. after _end, but
416 * not always - either if we are running from under `tcc -b -run`, or if
417 * address space randomization is turned on(a), heap start will be separated
420 * So sbrk(0) will be a good approximation for start_brk:
422 * - if we are a separately compiled program, __bound_init() runs early,
423 * and sbrk(0) should be equal or very near to start_brk(b) (in case other
424 * constructors malloc something), or
426 * - if we are running from under `tcc -b -run`, sbrk(0) will return
427 * start of heap portion which is under this program control, and not
428 * mark as invalid earlier allocated memory.
431 * (a) /proc/sys/kernel/randomize_va_space = 2, on Linux;
432 * usually turned on by default.
434 * (b) on Linux >= v3.3, the alternative is to read
435 * start_brk from /proc/self/stat
437 start
= (size_t)sbrk(0);
438 size
= 128 * 0x100000;
439 mark_invalid(start
, size
);
442 /* add all static bound check values */
443 p
= (size_t *)&__bounds_start
;
445 __bound_new_region((void *)p
[0], p
[1]);
449 fprintf(stderr
, "%s, %s() end\n\n", __FILE__
, __FUNCTION__
);
453 void __bound_main_arg(void **p
)
458 fprintf(stderr
, "%s, %s calling __bound_new_region(%p, %p)\n",
459 __FILE__
, __FUNCTION__
, (void *) p
- start
);
461 __bound_new_region(start
, (void *) p
- start
);
464 void __bound_exit(void)
466 restore_malloc_hooks();
469 static inline void add_region(BoundEntry
*e
,
470 size_t start
, size_t size
)
474 /* no region : add it */
478 /* already regions in the list: add it at the head */
479 e1
= bound_new_entry();
480 e1
->start
= e
->start
;
489 /* create a new region. It should not already exist in the region list */
490 void __bound_new_region(void *p
, size_t size
)
493 BoundEntry
*page
, *e
, *e2
;
494 size_t t1_start
, t1_end
, i
, t2_start
, t2_end
;
499 fprintf(stderr
, "%s, %s(%p, %p) start\n",
500 __FILE__
, __FUNCTION__
, p
, size
);
505 t1_start
= start
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
);
506 t1_end
= end
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
);
509 page
= get_page(t1_start
);
510 t2_start
= (start
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
511 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
);
512 t2_end
= (end
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
513 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
);
516 e
= (BoundEntry
*)((char *)page
+ t2_start
);
517 add_region(e
, start
, size
);
519 if (t1_end
== t1_start
) {
520 /* same ending page */
521 e2
= (BoundEntry
*)((char *)page
+ t2_end
);
528 add_region(e
, start
, size
);
531 /* mark until end of page */
532 e2
= page
+ BOUND_T2_SIZE
;
538 /* mark intermediate pages, if any */
539 for(i
=t1_start
+1;i
<t1_end
;i
++) {
541 e2
= page
+ BOUND_T2_SIZE
;
542 for(e
=page
;e
<e2
;e
++) {
548 page
= get_page(t1_end
);
549 e2
= (BoundEntry
*)((char *)page
+ t2_end
);
550 for(e
=page
;e
<e2
;e
++) {
554 add_region(e
, start
, size
);
557 fprintf(stderr
, "%s, %s end\n", __FILE__
, __FUNCTION__
);
561 /* delete a region */
562 static inline void delete_region(BoundEntry
*e
,
563 void *p
, size_t empty_size
)
570 if (addr
<= e
->size
) {
571 /* region found is first one */
574 /* no more region: mark it empty */
576 e
->size
= empty_size
;
578 /* copy next region in head */
579 e
->start
= e1
->start
;
582 bound_free_entry(e1
);
585 /* find the matching region */
589 /* region not found: do nothing */
592 addr
= (size_t)p
- e
->start
;
593 if (addr
<= e
->size
) {
594 /* found: remove entry */
603 /* WARNING: 'p' must be the starting point of the region. */
604 /* return non zero if error */
605 int __bound_delete_region(void *p
)
607 size_t start
, end
, addr
, size
, empty_size
;
608 BoundEntry
*page
, *e
, *e2
;
609 size_t t1_start
, t1_end
, t2_start
, t2_end
, i
;
614 fprintf(stderr
, "%s %s() start\n", __FILE__
, __FUNCTION__
);
618 t1_start
= start
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
);
619 t2_start
= (start
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
620 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
);
622 /* find region size */
623 page
= __bound_t1
[t1_start
];
624 e
= (BoundEntry
*)((char *)page
+ t2_start
);
625 addr
= start
- e
->start
;
627 e
= __bound_find_region(e
, p
);
628 /* test if invalid region */
629 if (e
->size
== EMPTY_SIZE
|| (size_t)p
!= e
->start
)
631 /* compute the size we put in invalid regions */
633 empty_size
= INVALID_SIZE
;
635 empty_size
= EMPTY_SIZE
;
639 /* now we can free each entry */
640 t1_end
= end
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
);
641 t2_end
= (end
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
642 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
);
644 delete_region(e
, p
, empty_size
);
645 if (t1_end
== t1_start
) {
646 /* same ending page */
647 e2
= (BoundEntry
*)((char *)page
+ t2_end
);
652 e
->size
= empty_size
;
654 delete_region(e
, p
, empty_size
);
657 /* mark until end of page */
658 e2
= page
+ BOUND_T2_SIZE
;
662 e
->size
= empty_size
;
664 /* mark intermediate pages, if any */
665 /* XXX: should free them */
666 for(i
=t1_start
+1;i
<t1_end
;i
++) {
668 e2
= page
+ BOUND_T2_SIZE
;
669 for(e
=page
;e
<e2
;e
++) {
671 e
->size
= empty_size
;
675 page
= get_page(t1_end
);
676 e2
= (BoundEntry
*)((char *)page
+ t2_end
);
677 for(e
=page
;e
<e2
;e
++) {
679 e
->size
= empty_size
;
681 delete_region(e
, p
, empty_size
);
685 fprintf(stderr
, "%s %s() end\n", __FILE__
, __FUNCTION__
);
691 /* return the size of the region starting at p, or EMPTY_SIZE if non
693 static size_t get_region_size(void *p
)
695 size_t addr
= (size_t)p
;
698 e
= __bound_t1
[addr
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
)];
699 e
= (BoundEntry
*)((char *)e
+
700 ((addr
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
701 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
)));
704 e
= __bound_find_region(e
, p
);
705 if (e
->start
!= (size_t)p
)
710 /* patched memory functions */
712 /* force compiler to perform stores coded up to this point */
713 #define barrier() __asm__ __volatile__ ("": : : "memory")
715 static void install_malloc_hooks(void)
717 #ifdef CONFIG_TCC_MALLOC_HOOKS
718 saved_malloc_hook
= __malloc_hook
;
719 saved_free_hook
= __free_hook
;
720 saved_realloc_hook
= __realloc_hook
;
721 saved_memalign_hook
= __memalign_hook
;
722 __malloc_hook
= __bound_malloc
;
723 __free_hook
= __bound_free
;
724 __realloc_hook
= __bound_realloc
;
725 __memalign_hook
= __bound_memalign
;
731 static void restore_malloc_hooks(void)
733 #ifdef CONFIG_TCC_MALLOC_HOOKS
734 __malloc_hook
= saved_malloc_hook
;
735 __free_hook
= saved_free_hook
;
736 __realloc_hook
= saved_realloc_hook
;
737 __memalign_hook
= saved_memalign_hook
;
743 static void *libc_malloc(size_t size
)
746 restore_malloc_hooks();
748 install_malloc_hooks();
752 static void libc_free(void *ptr
)
754 restore_malloc_hooks();
756 install_malloc_hooks();
759 /* XXX: we should use a malloc which ensure that it is unlikely that
760 two malloc'ed data have the same address if 'free' are made in
762 void *__bound_malloc(size_t size
, const void *caller
)
766 /* we allocate one more byte to ensure the regions will be
767 separated by at least one byte. With the glibc malloc, it may
768 be in fact not necessary */
769 ptr
= libc_malloc(size
+ 1);
775 fprintf(stderr
, "%s, %s calling __bound_new_region(%p, %p)\n",
776 __FILE__
, __FUNCTION__
, ptr
, size
);
778 __bound_new_region(ptr
, size
);
782 void *__bound_memalign(size_t size
, size_t align
, const void *caller
)
786 restore_malloc_hooks();
788 #ifndef HAVE_MEMALIGN
790 /* XXX: handle it ? */
793 /* we suppose that malloc aligns to at least four bytes */
794 ptr
= malloc(size
+ 1);
797 /* we allocate one more byte to ensure the regions will be
798 separated by at least one byte. With the glibc malloc, it may
799 be in fact not necessary */
800 ptr
= memalign(size
+ 1, align
);
803 install_malloc_hooks();
809 fprintf(stderr
, "%s, %s calling __bound_new_region(%p, %p)\n",
810 __FILE__
, __FUNCTION__
, ptr
, size
);
812 __bound_new_region(ptr
, size
);
816 void __bound_free(void *ptr
, const void *caller
)
820 if (__bound_delete_region(ptr
) != 0)
821 bound_error("freeing invalid region");
826 void *__bound_realloc(void *ptr
, size_t size
, const void *caller
)
832 __bound_free(ptr
, caller
);
835 ptr1
= __bound_malloc(size
, caller
);
836 if (ptr
== NULL
|| ptr1
== NULL
)
838 old_size
= get_region_size(ptr
);
839 if (old_size
== EMPTY_SIZE
)
840 bound_error("realloc'ing invalid pointer");
841 memcpy(ptr1
, ptr
, old_size
);
842 __bound_free(ptr
, caller
);
847 #ifndef CONFIG_TCC_MALLOC_HOOKS
848 void *__bound_calloc(size_t nmemb
, size_t size
)
852 ptr
= __bound_malloc(size
, NULL
);
855 memset(ptr
, 0, size
);
861 static void bound_dump(void)
863 BoundEntry
*page
, *e
;
866 printf("region dump:\n");
867 for(i
=0;i
<BOUND_T1_SIZE
;i
++) {
868 page
= __bound_t1
[i
];
869 for(j
=0;j
<BOUND_T2_SIZE
;j
++) {
871 /* do not print invalid or empty entries */
872 if (e
->size
!= EMPTY_SIZE
&& e
->start
!= 0) {
874 (i
<< (BOUND_T2_BITS
+ BOUND_T3_BITS
)) +
875 (j
<< BOUND_T3_BITS
));
877 printf(" %08lx:%08lx", e
->start
, e
->start
+ e
->size
);
887 /* some useful checked functions */
889 /* check that (p ... p + size - 1) lies inside 'p' region, if any */
890 static void __bound_check(const void *p
, size_t size
)
894 p
= __bound_ptr_add((void *)p
, size
);
895 if (p
== INVALID_POINTER
)
896 bound_error("invalid pointer");
899 void *__bound_memcpy(void *dst
, const void *src
, size_t size
)
901 __bound_check(dst
, size
);
902 __bound_check(src
, size
);
903 /* check also region overlap */
904 if (src
>= dst
&& src
< dst
+ size
)
905 bound_error("overlapping regions in memcpy()");
906 return memcpy(dst
, src
, size
);
909 void *__bound_memmove(void *dst
, const void *src
, size_t size
)
911 __bound_check(dst
, size
);
912 __bound_check(src
, size
);
913 return memmove(dst
, src
, size
);
916 void *__bound_memset(void *dst
, int c
, size_t size
)
918 __bound_check(dst
, size
);
919 return memset(dst
, c
, size
);
922 /* XXX: could be optimized */
923 int __bound_strlen(const char *s
)
930 p
= __bound_ptr_indir1((char *)s
, len
);
931 if (p
== INVALID_POINTER
)
932 bound_error("bad pointer in strlen()");
940 char *__bound_strcpy(char *dst
, const char *src
)
943 len
= __bound_strlen(src
);
944 return __bound_memcpy(dst
, src
, len
+ 1);