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 unsigned long is_invalid
; /* true if pointers outside region are invalid */
78 /* external interface */
79 void __bound_init(void);
80 void __bound_new_region(void *p
, unsigned long size
);
81 int __bound_delete_region(void *p
);
83 #define FASTCALL __attribute__((regparm(3)))
85 void *__bound_malloc(size_t size
, const void *caller
);
86 void *__bound_memalign(size_t size
, size_t align
, const void *caller
);
87 void __bound_free(void *ptr
, const void *caller
);
88 void *__bound_realloc(void *ptr
, size_t size
, const void *caller
);
89 static void *libc_malloc(size_t size
);
90 static void libc_free(void *ptr
);
91 static void install_malloc_hooks(void);
92 static void restore_malloc_hooks(void);
94 #ifdef CONFIG_TCC_MALLOC_HOOKS
95 static void *saved_malloc_hook
;
96 static void *saved_free_hook
;
97 static void *saved_realloc_hook
;
98 static void *saved_memalign_hook
;
101 /* TCC definitions */
102 extern char __bounds_start
; /* start of static bounds table */
103 /* error message, just for TCC */
104 const char *__bound_error_msg
;
106 /* runtime error output */
107 extern void rt_error(unsigned long pc
, const char *fmt
, ...);
110 static BoundEntry
*__bound_t1
[BOUND_T1_SIZE
]; /* page table */
112 static BoundEntry
**__bound_t1
; /* page table */
114 static BoundEntry
*__bound_empty_t2
; /* empty page, for unused pages */
115 static BoundEntry
*__bound_invalid_t2
; /* invalid page, for invalid pointers */
117 static BoundEntry
*__bound_find_region(BoundEntry
*e1
, void *p
)
119 unsigned long addr
, tmp
;
124 addr
= (unsigned long)p
;
126 if (addr
<= e
->size
) {
127 /* put region at the head */
129 e1
->start
= e
->start
;
138 /* no entry found: return empty entry or invalid entry */
140 return __bound_invalid_t2
;
142 return __bound_empty_t2
;
145 /* print a bound error message */
146 static void bound_error(const char *fmt
, ...)
148 __bound_error_msg
= fmt
;
149 *(int *)0 = 0; /* force a runtime error */
152 static void bound_alloc_error(void)
154 bound_error("not enough memory for bound checking code");
157 /* return '(p + offset)' for pointer arithmetic (a pointer can reach
158 the end of a region in this case */
159 void * FASTCALL
__bound_ptr_add(void *p
, int offset
)
161 unsigned long addr
= (unsigned long)p
;
163 #if defined(BOUND_DEBUG)
164 printf("add: 0x%x %d\n", (int)p
, offset
);
167 e
= __bound_t1
[addr
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
)];
168 e
= (BoundEntry
*)((char *)e
+
169 ((addr
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
170 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
)));
172 if (addr
> e
->size
) {
173 e
= __bound_find_region(e
, p
);
174 addr
= (unsigned long)p
- e
->start
;
178 return INVALID_POINTER
; /* return an invalid pointer */
182 /* return '(p + offset)' for pointer indirection (the resulting must
183 be strictly inside the region */
184 #define BOUND_PTR_INDIR(dsize) \
185 void * FASTCALL __bound_ptr_indir ## dsize (void *p, int offset) \
187 unsigned long addr = (unsigned long)p; \
190 e = __bound_t1[addr >> (BOUND_T2_BITS + BOUND_T3_BITS)]; \
191 e = (BoundEntry *)((char *)e + \
192 ((addr >> (BOUND_T3_BITS - BOUND_E_BITS)) & \
193 ((BOUND_T2_SIZE - 1) << BOUND_E_BITS))); \
195 if (addr > e->size) { \
196 e = __bound_find_region(e, p); \
197 addr = (unsigned long)p - e->start; \
199 addr += offset + dsize; \
200 if (addr > e->size) \
201 return INVALID_POINTER; /* return an invalid pointer */ \
212 /* return the frame pointer of the caller */
213 #define GET_CALLER_FP(fp)\
215 fp = (unsigned long)__builtin_frame_address(1);\
218 /* called when entering a function to add all the local regions */
219 void FASTCALL
__bound_local_new(void *p1
)
221 unsigned long addr
, size
, fp
, *p
= p1
;
230 __bound_new_region((void *)addr
, size
);
234 /* called when leaving a function to delete all the local regions */
235 void FASTCALL
__bound_local_delete(void *p1
)
237 unsigned long addr
, fp
, *p
= p1
;
245 __bound_delete_region((void *)addr
);
249 static BoundEntry
*__bound_new_page(void)
254 page
= libc_malloc(sizeof(BoundEntry
) * BOUND_T2_SIZE
);
257 for(i
=0;i
<BOUND_T2_SIZE
;i
++) {
258 /* put empty entries */
260 page
[i
].size
= EMPTY_SIZE
;
262 page
[i
].is_invalid
= 0;
267 /* currently we use malloc(). Should use bound_new_page() */
268 static BoundEntry
*bound_new_entry(void)
271 e
= libc_malloc(sizeof(BoundEntry
));
275 static void bound_free_entry(BoundEntry
*e
)
280 static inline BoundEntry
*get_page(int index
)
283 page
= __bound_t1
[index
];
284 if (page
== __bound_empty_t2
|| page
== __bound_invalid_t2
) {
285 /* create a new page if necessary */
286 page
= __bound_new_page();
287 __bound_t1
[index
] = page
;
292 /* mark a region as being invalid (can only be used during init) */
293 static void mark_invalid(unsigned long addr
, unsigned long size
)
295 unsigned long start
, end
;
297 int t1_start
, t1_end
, i
, j
, t2_start
, t2_end
;
302 t2_start
= (start
+ BOUND_T3_SIZE
- 1) >> BOUND_T3_BITS
;
304 t2_end
= end
>> BOUND_T3_BITS
;
306 t2_end
= 1 << (BOUND_T1_BITS
+ BOUND_T2_BITS
);
309 printf("mark_invalid: start = %x %x\n", t2_start
, t2_end
);
312 /* first we handle full pages */
313 t1_start
= (t2_start
+ BOUND_T2_SIZE
- 1) >> BOUND_T2_BITS
;
314 t1_end
= t2_end
>> BOUND_T2_BITS
;
316 i
= t2_start
& (BOUND_T2_SIZE
- 1);
317 j
= t2_end
& (BOUND_T2_SIZE
- 1);
319 if (t1_start
== t1_end
) {
320 page
= get_page(t2_start
>> BOUND_T2_BITS
);
322 page
[i
].size
= INVALID_SIZE
;
323 page
[i
].is_invalid
= 1;
327 page
= get_page(t2_start
>> BOUND_T2_BITS
);
328 for(; i
< BOUND_T2_SIZE
; i
++) {
329 page
[i
].size
= INVALID_SIZE
;
330 page
[i
].is_invalid
= 1;
333 for(i
= t1_start
; i
< t1_end
; i
++) {
334 __bound_t1
[i
] = __bound_invalid_t2
;
337 page
= get_page(t1_end
);
338 for(i
= 0; i
< j
; i
++) {
339 page
[i
].size
= INVALID_SIZE
;
340 page
[i
].is_invalid
= 1;
346 void __bound_init(void)
350 unsigned long start
, size
;
353 __PTRDIFF_TYPE__
*p
; /* 32 or 64 bit integer */
355 /* save malloc hooks and install bound check hooks */
356 install_malloc_hooks();
359 __bound_t1
= libc_malloc(BOUND_T1_SIZE
* sizeof(BoundEntry
*));
363 __bound_empty_t2
= __bound_new_page();
364 for(i
=0;i
<BOUND_T1_SIZE
;i
++) {
365 __bound_t1
[i
] = __bound_empty_t2
;
368 page
= __bound_new_page();
369 for(i
=0;i
<BOUND_T2_SIZE
;i
++) {
370 /* put invalid entries */
372 page
[i
].size
= INVALID_SIZE
;
374 page
[i
].is_invalid
= 1;
376 __bound_invalid_t2
= page
;
378 /* invalid pointer zone */
379 start
= (unsigned long)INVALID_POINTER
& ~(BOUND_T23_SIZE
- 1);
380 size
= BOUND_T23_SIZE
;
381 mark_invalid(start
, size
);
383 #if defined(CONFIG_TCC_MALLOC_HOOKS)
384 /* malloc zone is also marked invalid. can only use that with
385 * hooks because all libs should use the same malloc. The solution
386 * would be to build a new malloc for tcc.
388 * usually heap (= malloc zone) comes right after bss, i.e. after _end, but
389 * not always - either if we are running from under `tcc -b -run`, or if
390 * address space randomization is turned on(a), heap start will be separated
393 * So sbrk(0) will be a good approximation for start_brk:
395 * - if we are a separately compiled program, __bound_init() runs early,
396 * and sbrk(0) should be equal or very near to start_brk(b) (in case other
397 * constructors malloc something), or
399 * - if we are running from under `tcc -b -run`, sbrk(0) will return
400 * start of heap portion which is under this program control, and not
401 * mark as invalid earlier allocated memory.
404 * (a) /proc/sys/kernel/randomize_va_space = 2, on Linux;
405 * usually turned on by default.
407 * (b) on Linux >= v3.3, the alternative is to read
408 * start_brk from /proc/self/stat
410 start
= (unsigned long)sbrk(0);
411 size
= 128 * 0x100000;
412 mark_invalid(start
, size
);
415 /* add all static bound check values */
416 p
= (__PTRDIFF_TYPE__
*)&__bounds_start
;
418 __bound_new_region((void *)p
[0], p
[1]);
423 void __bound_main_arg(void **p
)
427 __bound_new_region(start
, (void *) p
- start
);
430 void __bound_exit(void)
432 restore_malloc_hooks();
435 static inline void add_region(BoundEntry
*e
,
436 unsigned long start
, unsigned long size
)
440 /* no region : add it */
444 /* already regions in the list: add it at the head */
445 e1
= bound_new_entry();
446 e1
->start
= e
->start
;
455 /* create a new region. It should not already exist in the region list */
456 void __bound_new_region(void *p
, unsigned long size
)
458 unsigned long start
, end
;
459 BoundEntry
*page
, *e
, *e2
;
460 int t1_start
, t1_end
, i
, t2_start
, t2_end
;
462 start
= (unsigned long)p
;
464 t1_start
= start
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
);
465 t1_end
= end
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
);
468 page
= get_page(t1_start
);
469 t2_start
= (start
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
470 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
);
471 t2_end
= (end
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
472 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
);
474 printf("new %lx %lx %x %x %x %x\n",
475 start
, end
, t1_start
, t1_end
, t2_start
, t2_end
);
478 e
= (BoundEntry
*)((char *)page
+ t2_start
);
479 add_region(e
, start
, size
);
481 if (t1_end
== t1_start
) {
482 /* same ending page */
483 e2
= (BoundEntry
*)((char *)page
+ t2_end
);
490 add_region(e
, start
, size
);
493 /* mark until end of page */
494 e2
= page
+ BOUND_T2_SIZE
;
500 /* mark intermediate pages, if any */
501 for(i
=t1_start
+1;i
<t1_end
;i
++) {
503 e2
= page
+ BOUND_T2_SIZE
;
504 for(e
=page
;e
<e2
;e
++) {
510 page
= get_page(t1_end
);
511 e2
= (BoundEntry
*)((char *)page
+ t2_end
);
512 for(e
=page
;e
<e2
;e
++) {
516 add_region(e
, start
, size
);
520 /* delete a region */
521 static inline void delete_region(BoundEntry
*e
,
522 void *p
, unsigned long empty_size
)
527 addr
= (unsigned long)p
;
529 if (addr
<= e
->size
) {
530 /* region found is first one */
533 /* no more region: mark it empty */
535 e
->size
= empty_size
;
537 /* copy next region in head */
538 e
->start
= e1
->start
;
541 bound_free_entry(e1
);
544 /* find the matching region */
548 /* region not found: do nothing */
551 addr
= (unsigned long)p
- e
->start
;
552 if (addr
<= e
->size
) {
553 /* found: remove entry */
562 /* WARNING: 'p' must be the starting point of the region. */
563 /* return non zero if error */
564 int __bound_delete_region(void *p
)
566 unsigned long start
, end
, addr
, size
, empty_size
;
567 BoundEntry
*page
, *e
, *e2
;
568 int t1_start
, t1_end
, t2_start
, t2_end
, i
;
570 start
= (unsigned long)p
;
571 t1_start
= start
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
);
572 t2_start
= (start
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
573 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
);
575 /* find region size */
576 page
= __bound_t1
[t1_start
];
577 e
= (BoundEntry
*)((char *)page
+ t2_start
);
578 addr
= start
- e
->start
;
580 e
= __bound_find_region(e
, p
);
581 /* test if invalid region */
582 if (e
->size
== EMPTY_SIZE
|| (unsigned long)p
!= e
->start
)
584 /* compute the size we put in invalid regions */
586 empty_size
= INVALID_SIZE
;
588 empty_size
= EMPTY_SIZE
;
592 /* now we can free each entry */
593 t1_end
= end
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
);
594 t2_end
= (end
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
595 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
);
597 delete_region(e
, p
, empty_size
);
598 if (t1_end
== t1_start
) {
599 /* same ending page */
600 e2
= (BoundEntry
*)((char *)page
+ t2_end
);
605 e
->size
= empty_size
;
607 delete_region(e
, p
, empty_size
);
610 /* mark until end of page */
611 e2
= page
+ BOUND_T2_SIZE
;
615 e
->size
= empty_size
;
617 /* mark intermediate pages, if any */
618 /* XXX: should free them */
619 for(i
=t1_start
+1;i
<t1_end
;i
++) {
621 e2
= page
+ BOUND_T2_SIZE
;
622 for(e
=page
;e
<e2
;e
++) {
624 e
->size
= empty_size
;
628 page
= get_page(t1_end
);
629 e2
= (BoundEntry
*)((char *)page
+ t2_end
);
630 for(e
=page
;e
<e2
;e
++) {
632 e
->size
= empty_size
;
634 delete_region(e
, p
, empty_size
);
639 /* return the size of the region starting at p, or EMPTY_SIZE if non
641 static unsigned long get_region_size(void *p
)
643 unsigned long addr
= (unsigned long)p
;
646 e
= __bound_t1
[addr
>> (BOUND_T2_BITS
+ BOUND_T3_BITS
)];
647 e
= (BoundEntry
*)((char *)e
+
648 ((addr
>> (BOUND_T3_BITS
- BOUND_E_BITS
)) &
649 ((BOUND_T2_SIZE
- 1) << BOUND_E_BITS
)));
652 e
= __bound_find_region(e
, p
);
653 if (e
->start
!= (unsigned long)p
)
658 /* patched memory functions */
660 /* force compiler to perform stores coded up to this point */
661 #define barrier() __asm__ __volatile__ ("": : : "memory")
663 static void install_malloc_hooks(void)
665 #ifdef CONFIG_TCC_MALLOC_HOOKS
666 saved_malloc_hook
= __malloc_hook
;
667 saved_free_hook
= __free_hook
;
668 saved_realloc_hook
= __realloc_hook
;
669 saved_memalign_hook
= __memalign_hook
;
670 __malloc_hook
= __bound_malloc
;
671 __free_hook
= __bound_free
;
672 __realloc_hook
= __bound_realloc
;
673 __memalign_hook
= __bound_memalign
;
679 static void restore_malloc_hooks(void)
681 #ifdef CONFIG_TCC_MALLOC_HOOKS
682 __malloc_hook
= saved_malloc_hook
;
683 __free_hook
= saved_free_hook
;
684 __realloc_hook
= saved_realloc_hook
;
685 __memalign_hook
= saved_memalign_hook
;
691 static void *libc_malloc(size_t size
)
694 restore_malloc_hooks();
696 install_malloc_hooks();
700 static void libc_free(void *ptr
)
702 restore_malloc_hooks();
704 install_malloc_hooks();
707 /* XXX: we should use a malloc which ensure that it is unlikely that
708 two malloc'ed data have the same address if 'free' are made in
710 void *__bound_malloc(size_t size
, const void *caller
)
714 /* we allocate one more byte to ensure the regions will be
715 separated by at least one byte. With the glibc malloc, it may
716 be in fact not necessary */
717 ptr
= libc_malloc(size
+ 1);
721 __bound_new_region(ptr
, size
);
725 void *__bound_memalign(size_t size
, size_t align
, const void *caller
)
729 restore_malloc_hooks();
731 #ifndef HAVE_MEMALIGN
733 /* XXX: handle it ? */
736 /* we suppose that malloc aligns to at least four bytes */
737 ptr
= malloc(size
+ 1);
740 /* we allocate one more byte to ensure the regions will be
741 separated by at least one byte. With the glibc malloc, it may
742 be in fact not necessary */
743 ptr
= memalign(size
+ 1, align
);
746 install_malloc_hooks();
750 __bound_new_region(ptr
, size
);
754 void __bound_free(void *ptr
, const void *caller
)
758 if (__bound_delete_region(ptr
) != 0)
759 bound_error("freeing invalid region");
764 void *__bound_realloc(void *ptr
, size_t size
, const void *caller
)
770 __bound_free(ptr
, caller
);
773 ptr1
= __bound_malloc(size
, caller
);
774 if (ptr
== NULL
|| ptr1
== NULL
)
776 old_size
= get_region_size(ptr
);
777 if (old_size
== EMPTY_SIZE
)
778 bound_error("realloc'ing invalid pointer");
779 memcpy(ptr1
, ptr
, old_size
);
780 __bound_free(ptr
, caller
);
785 #ifndef CONFIG_TCC_MALLOC_HOOKS
786 void *__bound_calloc(size_t nmemb
, size_t size
)
790 ptr
= __bound_malloc(size
, NULL
);
793 memset(ptr
, 0, size
);
799 static void bound_dump(void)
801 BoundEntry
*page
, *e
;
804 printf("region dump:\n");
805 for(i
=0;i
<BOUND_T1_SIZE
;i
++) {
806 page
= __bound_t1
[i
];
807 for(j
=0;j
<BOUND_T2_SIZE
;j
++) {
809 /* do not print invalid or empty entries */
810 if (e
->size
!= EMPTY_SIZE
&& e
->start
!= 0) {
812 (i
<< (BOUND_T2_BITS
+ BOUND_T3_BITS
)) +
813 (j
<< BOUND_T3_BITS
));
815 printf(" %08lx:%08lx", e
->start
, e
->start
+ e
->size
);
825 /* some useful checked functions */
827 /* check that (p ... p + size - 1) lies inside 'p' region, if any */
828 static void __bound_check(const void *p
, size_t size
)
832 p
= __bound_ptr_add((void *)p
, size
);
833 if (p
== INVALID_POINTER
)
834 bound_error("invalid pointer");
837 void *__bound_memcpy(void *dst
, const void *src
, size_t size
)
839 __bound_check(dst
, size
);
840 __bound_check(src
, size
);
841 /* check also region overlap */
842 if (src
>= dst
&& src
< dst
+ size
)
843 bound_error("overlapping regions in memcpy()");
844 return memcpy(dst
, src
, size
);
847 void *__bound_memmove(void *dst
, const void *src
, size_t size
)
849 __bound_check(dst
, size
);
850 __bound_check(src
, size
);
851 return memmove(dst
, src
, size
);
854 void *__bound_memset(void *dst
, int c
, size_t size
)
856 __bound_check(dst
, size
);
857 return memset(dst
, c
, size
);
860 /* XXX: could be optimized */
861 int __bound_strlen(const char *s
)
868 p
= __bound_ptr_indir1((char *)s
, len
);
869 if (p
== INVALID_POINTER
)
870 bound_error("bad pointer in strlen()");
878 char *__bound_strcpy(char *dst
, const char *src
)
881 len
= __bound_strlen(src
);
882 return __bound_memcpy(dst
, src
, len
+ 1);