2 * TCC - Tiny C Compiler - Support for -run switch
4 * Copyright (c) 2001-2004 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
23 /* only native compiler supports -run */
26 #ifdef CONFIG_TCC_BACKTRACE
27 ST_DATA
int rt_num_callers
= 6;
28 ST_DATA
const char **rt_bound_error_msg
;
29 ST_DATA
void *rt_prog_main
;
33 #define ucontext_t CONTEXT
36 static void set_pages_executable(void *ptr
, unsigned long length
);
37 static void set_exception_handler(void);
38 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
);
39 static void rt_error(ucontext_t
*uc
, const char *fmt
, ...);
40 static int tcc_relocate_ex(TCCState
*s1
, void *ptr
);
43 static void win64_add_function_table(TCCState
*s1
);
46 /* ------------------------------------------------------------- */
47 /* Do all relocations (needed before using tcc_get_symbol())
48 Returns -1 on error. */
50 LIBTCCAPI
int tcc_relocate(TCCState
*s1
, void *ptr
)
54 if (TCC_RELOCATE_AUTO
!= ptr
)
55 return tcc_relocate_ex(s1
, ptr
);
57 ret
= tcc_relocate_ex(s1
, NULL
);
62 { /* Use mmap instead of malloc for Selinux. */
63 s1
->write_mem
= mmap (NULL
, ret
, PROT_READ
|PROT_WRITE
,
64 MAP_PRIVATE
|MAP_ANONYMOUS
, -1, 0);
65 if (s1
->write_mem
== MAP_FAILED
)
66 tcc_error("mmap not writeable");
68 s1
->runtime_mem
= mmap (NULL
, ret
, PROT_READ
|PROT_EXEC
,
69 MAP_PRIVATE
|MAP_ANONYMOUS
, -1, 0);
70 if (s1
->runtime_mem
== MAP_FAILED
)
71 tcc_error("mmap not executable");
73 ret
= tcc_relocate_ex(s1
, s1
->write_mem
);
76 s1
->runtime_mem
= tcc_malloc(ret
);
77 ret
= tcc_relocate_ex(s1
, s1
->runtime_mem
);
82 /* launch the compiled program with the given arguments */
83 LIBTCCAPI
int tcc_run(TCCState
*s1
, int argc
, char **argv
)
85 int (*prog_main
)(int, char **);
88 if (tcc_relocate(s1
, TCC_RELOCATE_AUTO
) < 0)
91 prog_main
= tcc_get_symbol_err(s1
, s1
->runtime_main
);
93 #ifdef CONFIG_TCC_BACKTRACE
95 set_exception_handler();
96 rt_prog_main
= prog_main
;
100 #ifdef CONFIG_TCC_BCHECK
101 if (s1
->do_bounds_check
) {
102 void (*bound_init
)(void);
103 void (*bound_exit
)(void);
104 /* set error function */
105 rt_bound_error_msg
= tcc_get_symbol_err(s1
, "__bound_error_msg");
106 /* XXX: use .init section so that it also work in binary ? */
107 bound_init
= tcc_get_symbol_err(s1
, "__bound_init");
108 bound_exit
= tcc_get_symbol_err(s1
, "__bound_exit");
110 ret
= (*prog_main
)(argc
, argv
);
114 ret
= (*prog_main
)(argc
, argv
);
118 /* relocate code. Return -1 on error, required size if ptr is NULL,
119 otherwise copy code into buffer passed by the caller */
120 static int tcc_relocate_ex(TCCState
*s1
, void *ptr
)
123 unsigned long offset
, length
;
130 pe_output_file(s1
, NULL
);
133 relocate_common_syms();
134 tcc_add_linker_symbols(s1
);
135 build_got_entries(s1
);
141 offset
= 0, mem
= (addr_t
)ptr
;
142 for(i
= 1; i
< s1
->nb_sections
; i
++) {
144 if (0 == (s
->sh_flags
& SHF_ALLOC
))
146 length
= s
->data_offset
;
147 s
->sh_addr
= mem
? (mem
+ offset
+ 15) & ~15 : 0;
148 offset
= (offset
+ length
+ 15) & ~15;
152 /* relocate symbols */
153 relocate_syms(s1
, 1);
157 #ifdef TCC_HAS_RUNTIME_PLTGOT
158 s1
->runtime_plt_and_got_offset
= 0;
159 s1
->runtime_plt_and_got
= (char *)(mem
+ offset
);
160 /* double the size of the buffer for got and plt entries
161 XXX: calculate exact size for them? */
168 /* relocate each section */
169 for(i
= 1; i
< s1
->nb_sections
; i
++) {
172 relocate_section(s1
, s
);
175 for(i
= 1; i
< s1
->nb_sections
; i
++) {
177 if (0 == (s
->sh_flags
& SHF_ALLOC
))
179 length
= s
->data_offset
;
180 // printf("%-12s %08x %04x\n", s->name, s->sh_addr, length);
181 ptr
= (void*)s
->sh_addr
;
182 if (NULL
== s
->data
|| s
->sh_type
== SHT_NOBITS
)
183 memset(ptr
, 0, length
);
185 memcpy(ptr
, s
->data
, length
);
186 /* mark executable sections as executable in memory */
187 if (s
->sh_flags
& SHF_EXECINSTR
)
188 set_pages_executable(ptr
, length
);
191 #ifdef TCC_HAS_RUNTIME_PLTGOT
192 set_pages_executable(s1
->runtime_plt_and_got
,
193 s1
->runtime_plt_and_got_offset
);
197 win64_add_function_table(s1
);
202 /* ------------------------------------------------------------- */
203 /* allow to run code in memory */
205 static void set_pages_executable(void *ptr
, unsigned long length
)
208 unsigned long old_protect
;
209 VirtualProtect(ptr
, length
, PAGE_EXECUTE_READWRITE
, &old_protect
);
212 # define PAGESIZE 4096
215 start
= (addr_t
)ptr
& ~(PAGESIZE
- 1);
216 end
= (addr_t
)ptr
+ length
;
217 end
= (end
+ PAGESIZE
- 1) & ~(PAGESIZE
- 1);
218 mprotect((void *)start
, end
- start
, PROT_READ
| PROT_WRITE
| PROT_EXEC
);
219 __clear_cache(ptr
, ptr
+ length
);
223 /* ------------------------------------------------------------- */
224 #ifdef CONFIG_TCC_BACKTRACE
226 ST_FUNC
void tcc_set_num_callers(int n
)
231 /* print the position in the source file of PC value 'pc' by reading
232 the stabs debug information */
233 static addr_t
rt_printline(addr_t wanted_pc
, const char *msg
)
235 char func_name
[128], last_func_name
[128];
236 addr_t func_addr
, last_pc
, pc
;
237 const char *incl_files
[INCLUDE_STACK_SIZE
];
238 int incl_index
, len
, last_line_num
, i
;
241 Stab_Sym
*stab_sym
= NULL
, *stab_sym_end
, *sym
;
243 char *stab_str
= NULL
;
246 stab_len
= stab_section
->data_offset
;
247 stab_sym
= (Stab_Sym
*)stab_section
->data
;
248 stab_str
= stabstr_section
->data
;
254 last_func_name
[0] = '\0';
255 last_pc
= (addr_t
)-1;
261 stab_sym_end
= (Stab_Sym
*)((char*)stab_sym
+ stab_len
);
262 for (sym
= stab_sym
+ 1; sym
< stab_sym_end
; ++sym
) {
263 switch(sym
->n_type
) {
264 /* function start or end */
266 if (sym
->n_strx
== 0) {
267 /* we test if between last line and end of function */
268 pc
= sym
->n_value
+ func_addr
;
269 if (wanted_pc
>= last_pc
&& wanted_pc
< pc
)
274 str
= stab_str
+ sym
->n_strx
;
275 p
= strchr(str
, ':');
277 pstrcpy(func_name
, sizeof(func_name
), str
);
280 if (len
> sizeof(func_name
) - 1)
281 len
= sizeof(func_name
) - 1;
282 memcpy(func_name
, str
, len
);
283 func_name
[len
] = '\0';
285 func_addr
= sym
->n_value
;
288 /* line number info */
290 pc
= sym
->n_value
+ func_addr
;
291 if (wanted_pc
>= last_pc
&& wanted_pc
< pc
)
294 last_line_num
= sym
->n_desc
;
296 strcpy(last_func_name
, func_name
);
300 str
= stab_str
+ sym
->n_strx
;
302 if (incl_index
< INCLUDE_STACK_SIZE
) {
303 incl_files
[incl_index
++] = str
;
311 if (sym
->n_strx
== 0) {
312 incl_index
= 0; /* end of translation unit */
314 str
= stab_str
+ sym
->n_strx
;
315 /* do not add path */
317 if (len
> 0 && str
[len
- 1] != '/')
325 /* second pass: we try symtab symbols (no line number info) */
329 ElfW(Sym
) *sym
, *sym_end
;
332 sym_end
= (ElfW(Sym
) *)(symtab_section
->data
+ symtab_section
->data_offset
);
333 for(sym
= (ElfW(Sym
) *)symtab_section
->data
+ 1;
336 type
= ELFW(ST_TYPE
)(sym
->st_info
);
337 if (type
== STT_FUNC
|| type
== STT_GNU_IFUNC
) {
338 if (wanted_pc
>= sym
->st_value
&&
339 wanted_pc
< sym
->st_value
+ sym
->st_size
) {
340 pstrcpy(last_func_name
, sizeof(last_func_name
),
341 strtab_section
->data
+ sym
->st_name
);
342 func_addr
= sym
->st_value
;
348 /* did not find any info: */
349 fprintf(stderr
, "%s %p ???\n", msg
, (void*)wanted_pc
);
355 fprintf(stderr
, "%s:%d: ", incl_files
[--i
], last_line_num
);
356 fprintf(stderr
, "%s %p", msg
, (void*)wanted_pc
);
357 if (last_func_name
[0] != '\0')
358 fprintf(stderr
, " %s()", last_func_name
);
360 fprintf(stderr
, " (included from ");
362 fprintf(stderr
, "%s", incl_files
[i
]);
365 fprintf(stderr
, ", ");
367 fprintf(stderr
, ")");
369 fprintf(stderr
, "\n");
374 /* emit a run time error at position 'pc' */
375 static void rt_error(ucontext_t
*uc
, const char *fmt
, ...)
381 fprintf(stderr
, "Runtime error: ");
383 vfprintf(stderr
, fmt
, ap
);
385 fprintf(stderr
, "\n");
387 for(i
=0;i
<rt_num_callers
;i
++) {
388 if (rt_get_caller_pc(&pc
, uc
, i
) < 0)
390 pc
= rt_printline(pc
, i
? "by" : "at");
391 if (pc
== (addr_t
)rt_prog_main
&& pc
)
396 /* ------------------------------------------------------------- */
399 /* signal handler for fatal errors */
400 static void sig_error(int signum
, siginfo_t
*siginf
, void *puc
)
402 ucontext_t
*uc
= puc
;
406 switch(siginf
->si_code
) {
409 rt_error(uc
, "division by zero");
412 rt_error(uc
, "floating point exception");
418 if (rt_bound_error_msg
&& *rt_bound_error_msg
)
419 rt_error(uc
, *rt_bound_error_msg
);
421 rt_error(uc
, "dereferencing invalid pointer");
424 rt_error(uc
, "illegal instruction");
427 rt_error(uc
, "abort() called");
430 rt_error(uc
, "caught signal %d", signum
);
437 # define SA_SIGINFO 0x00000004u
440 /* Generate a stack backtrace when a CPU exception occurs. */
441 static void set_exception_handler(void)
443 struct sigaction sigact
;
444 /* install TCC signal handlers to print debug info on fatal
446 sigact
.sa_flags
= SA_SIGINFO
| SA_RESETHAND
;
447 sigact
.sa_sigaction
= sig_error
;
448 sigemptyset(&sigact
.sa_mask
);
449 sigaction(SIGFPE
, &sigact
, NULL
);
450 sigaction(SIGILL
, &sigact
, NULL
);
451 sigaction(SIGSEGV
, &sigact
, NULL
);
452 sigaction(SIGBUS
, &sigact
, NULL
);
453 sigaction(SIGABRT
, &sigact
, NULL
);
456 /* ------------------------------------------------------------- */
459 /* fix for glibc 2.1 */
465 /* return the PC at frame level 'level'. Return negative if not found */
466 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
472 #if defined(__APPLE__)
473 *paddr
= uc
->uc_mcontext
->__ss
.__eip
;
474 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
475 *paddr
= uc
->uc_mcontext
.mc_eip
;
476 #elif defined(__dietlibc__)
477 *paddr
= uc
->uc_mcontext
.eip
;
479 *paddr
= uc
->uc_mcontext
.gregs
[REG_EIP
];
483 #if defined(__APPLE__)
484 fp
= uc
->uc_mcontext
->__ss
.__ebp
;
485 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
486 fp
= uc
->uc_mcontext
.mc_ebp
;
487 #elif defined(__dietlibc__)
488 fp
= uc
->uc_mcontext
.ebp
;
490 fp
= uc
->uc_mcontext
.gregs
[REG_EBP
];
492 for(i
=1;i
<level
;i
++) {
493 /* XXX: check address validity with program info */
494 if (fp
<= 0x1000 || fp
>= 0xc0000000)
496 fp
= ((addr_t
*)fp
)[0];
498 *paddr
= ((addr_t
*)fp
)[1];
503 /* ------------------------------------------------------------- */
504 #elif defined(__x86_64__)
506 /* return the PC at frame level 'level'. Return negative if not found */
507 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
513 /* XXX: only support linux */
514 #if defined(__APPLE__)
515 *paddr
= uc
->uc_mcontext
->__ss
.__rip
;
516 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
517 *paddr
= uc
->uc_mcontext
.mc_rip
;
519 *paddr
= uc
->uc_mcontext
.gregs
[REG_RIP
];
523 #if defined(__APPLE__)
524 fp
= uc
->uc_mcontext
->__ss
.__rbp
;
525 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
526 fp
= uc
->uc_mcontext
.mc_rbp
;
528 fp
= uc
->uc_mcontext
.gregs
[REG_RBP
];
530 for(i
=1;i
<level
;i
++) {
531 /* XXX: check address validity with program info */
534 fp
= ((addr_t
*)fp
)[0];
536 *paddr
= ((addr_t
*)fp
)[1];
541 /* ------------------------------------------------------------- */
542 #elif defined(__arm__)
544 /* return the PC at frame level 'level'. Return negative if not found */
545 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
551 /* XXX: only supports linux */
552 #if defined(__linux__)
553 *paddr
= uc
->uc_mcontext
.arm_pc
;
559 #if defined(__linux__)
560 fp
= uc
->uc_mcontext
.arm_fp
;
561 sp
= uc
->uc_mcontext
.arm_sp
;
567 /* XXX: specific to tinycc stack frames */
568 if (fp
< sp
+ 12 || fp
& 3)
570 for(i
= 1; i
< level
; i
++) {
571 sp
= ((addr_t
*)fp
)[-2];
572 if (sp
< fp
|| sp
- fp
> 16 || sp
& 3)
574 fp
= ((addr_t
*)fp
)[-3];
575 if (fp
<= sp
|| fp
- sp
< 12 || fp
& 3)
578 /* XXX: check address validity with program info */
579 *paddr
= ((addr_t
*)fp
)[-1];
584 /* ------------------------------------------------------------- */
587 #warning add arch specific rt_get_caller_pc()
588 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
593 #endif /* !__i386__ */
595 /* ------------------------------------------------------------- */
598 static long __stdcall
cpu_exception_handler(EXCEPTION_POINTERS
*ex_info
)
600 EXCEPTION_RECORD
*er
= ex_info
->ExceptionRecord
;
601 CONTEXT
*uc
= ex_info
->ContextRecord
;
602 switch (er
->ExceptionCode
) {
603 case EXCEPTION_ACCESS_VIOLATION
:
604 if (rt_bound_error_msg
&& *rt_bound_error_msg
)
605 rt_error(uc
, *rt_bound_error_msg
);
607 rt_error(uc
, "access violation");
609 case EXCEPTION_STACK_OVERFLOW
:
610 rt_error(uc
, "stack overflow");
612 case EXCEPTION_INT_DIVIDE_BY_ZERO
:
613 rt_error(uc
, "division by zero");
616 rt_error(uc
, "exception caught");
619 return EXCEPTION_EXECUTE_HANDLER
;
622 /* Generate a stack backtrace when a CPU exception occurs. */
623 static void set_exception_handler(void)
625 SetUnhandledExceptionFilter(cpu_exception_handler
);
629 static void win64_add_function_table(TCCState
*s1
)
632 (RUNTIME_FUNCTION
*)s1
->uw_pdata
->sh_addr
,
633 s1
->uw_pdata
->data_offset
/ sizeof (RUNTIME_FUNCTION
),
634 text_section
->sh_addr
639 /* return the PC at frame level 'level'. Return non zero if not found */
640 static int rt_get_caller_pc(addr_t
*paddr
, CONTEXT
*uc
, int level
)
652 for(i
=1;i
<level
;i
++) {
653 /* XXX: check address validity with program info */
654 if (fp
<= 0x1000 || fp
>= 0xc0000000)
656 fp
= ((addr_t
*)fp
)[0];
658 pc
= ((addr_t
*)fp
)[1];
665 #endif /* CONFIG_TCC_BACKTRACE */
666 /* ------------------------------------------------------------- */
667 #ifdef CONFIG_TCC_STATIC
669 /* dummy function for profiling */
670 ST_FUNC
void *dlopen(const char *filename
, int flag
)
675 ST_FUNC
void dlclose(void *p
)
679 ST_FUNC
const char *dlerror(void)
684 typedef struct TCCSyms
{
690 /* add the symbol you want here if no dynamic linking is done */
691 static TCCSyms tcc_syms
[] = {
692 #if !defined(CONFIG_TCCBOOT)
693 #define TCCSYM(a) { #a, &a, },
703 ST_FUNC
void *resolve_sym(TCCState
*s1
, const char *symbol
)
707 while (p
->str
!= NULL
) {
708 if (!strcmp(p
->str
, symbol
))
715 #elif !defined(_WIN32)
717 ST_FUNC
void *resolve_sym(TCCState
*s1
, const char *sym
)
719 return dlsym(RTLD_DEFAULT
, sym
);
722 #endif /* CONFIG_TCC_STATIC */
723 #endif /* TCC_IS_NATIVE */
724 /* ------------------------------------------------------------- */