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. Ref:
63 http://www.gnu.org/s/libc/manual/html_node/File-Size.html */
65 char tmpfname
[] = "/tmp/.tccrunXXXXXX";
66 int fd
= mkstemp (tmpfname
);
70 ftruncate (fd
, s1
->mem_size
);
72 s1
->write_mem
= mmap (NULL
, ret
, PROT_READ
|PROT_WRITE
,
74 if (s1
->write_mem
== MAP_FAILED
)
75 tcc_error("/tmp not writeable");
77 s1
->runtime_mem
= mmap (NULL
, ret
, PROT_READ
|PROT_EXEC
,
79 if (s1
->runtime_mem
== MAP_FAILED
)
80 tcc_error("/tmp not executable");
82 ret
= tcc_relocate_ex(s1
, s1
->write_mem
);
85 s1
->runtime_mem
= tcc_malloc(ret
);
86 ret
= tcc_relocate_ex(s1
, s1
->runtime_mem
);
91 /* launch the compiled program with the given arguments */
92 LIBTCCAPI
int tcc_run(TCCState
*s1
, int argc
, char **argv
)
94 int (*prog_main
)(int, char **);
97 if (tcc_relocate(s1
, TCC_RELOCATE_AUTO
) < 0)
100 prog_main
= tcc_get_symbol_err(s1
, "main");
102 #ifdef CONFIG_TCC_BACKTRACE
104 set_exception_handler();
105 rt_prog_main
= prog_main
;
109 #ifdef CONFIG_TCC_BCHECK
110 if (s1
->do_bounds_check
) {
111 void (*bound_init
)(void);
112 void (*bound_exit
)(void);
113 /* set error function */
114 rt_bound_error_msg
= tcc_get_symbol_err(s1
, "__bound_error_msg");
115 /* XXX: use .init section so that it also work in binary ? */
116 bound_init
= tcc_get_symbol_err(s1
, "__bound_init");
117 bound_exit
= tcc_get_symbol_err(s1
, "__bound_exit");
119 ret
= (*prog_main
)(argc
, argv
);
123 ret
= (*prog_main
)(argc
, argv
);
127 /* relocate code. Return -1 on error, required size if ptr is NULL,
128 otherwise copy code into buffer passed by the caller */
129 static int tcc_relocate_ex(TCCState
*s1
, void *ptr
)
132 unsigned long offset
, length
;
139 pe_output_file(s1
, NULL
);
142 relocate_common_syms();
143 tcc_add_linker_symbols(s1
);
144 build_got_entries(s1
);
150 offset
= 0, mem
= (addr_t
)ptr
;
151 for(i
= 1; i
< s1
->nb_sections
; i
++) {
153 if (0 == (s
->sh_flags
& SHF_ALLOC
))
155 length
= s
->data_offset
;
156 s
->sh_addr
= mem
? (mem
+ offset
+ 15) & ~15 : 0;
157 offset
= (offset
+ length
+ 15) & ~15;
161 /* relocate symbols */
162 relocate_syms(s1
, 1);
166 #ifdef TCC_HAS_RUNTIME_PLTGOT
167 s1
->runtime_plt_and_got_offset
= 0;
168 s1
->runtime_plt_and_got
= (char *)(mem
+ offset
);
169 /* double the size of the buffer for got and plt entries
170 XXX: calculate exact size for them? */
177 /* relocate each section */
178 for(i
= 1; i
< s1
->nb_sections
; i
++) {
181 relocate_section(s1
, s
);
184 for(i
= 1; i
< s1
->nb_sections
; i
++) {
186 if (0 == (s
->sh_flags
& SHF_ALLOC
))
188 length
= s
->data_offset
;
189 // printf("%-12s %08x %04x\n", s->name, s->sh_addr, length);
190 ptr
= (void*)s
->sh_addr
;
191 if (NULL
== s
->data
|| s
->sh_type
== SHT_NOBITS
)
192 memset(ptr
, 0, length
);
194 memcpy(ptr
, s
->data
, length
);
195 /* mark executable sections as executable in memory */
196 if (s
->sh_flags
& SHF_EXECINSTR
)
197 set_pages_executable(ptr
, length
);
200 #ifdef TCC_HAS_RUNTIME_PLTGOT
201 set_pages_executable(s1
->runtime_plt_and_got
,
202 s1
->runtime_plt_and_got_offset
);
206 win64_add_function_table(s1
);
211 /* ------------------------------------------------------------- */
212 /* allow to run code in memory */
214 static void set_pages_executable(void *ptr
, unsigned long length
)
217 unsigned long old_protect
;
218 VirtualProtect(ptr
, length
, PAGE_EXECUTE_READWRITE
, &old_protect
);
221 # define PAGESIZE 4096
224 start
= (addr_t
)ptr
& ~(PAGESIZE
- 1);
225 end
= (addr_t
)ptr
+ length
;
226 end
= (end
+ PAGESIZE
- 1) & ~(PAGESIZE
- 1);
227 mprotect((void *)start
, end
- start
, PROT_READ
| PROT_WRITE
| PROT_EXEC
);
231 /* ------------------------------------------------------------- */
232 #ifdef CONFIG_TCC_BACKTRACE
234 ST_FUNC
void tcc_set_num_callers(int n
)
239 /* print the position in the source file of PC value 'pc' by reading
240 the stabs debug information */
241 static addr_t
rt_printline(addr_t wanted_pc
, const char *msg
)
243 char func_name
[128], last_func_name
[128];
244 addr_t func_addr
, last_pc
, pc
;
245 const char *incl_files
[INCLUDE_STACK_SIZE
];
246 int incl_index
, len
, last_line_num
, i
;
249 Stab_Sym
*stab_sym
= NULL
, *stab_sym_end
, *sym
;
251 char *stab_str
= NULL
;
254 stab_len
= stab_section
->data_offset
;
255 stab_sym
= (Stab_Sym
*)stab_section
->data
;
256 stab_str
= stabstr_section
->data
;
262 last_func_name
[0] = '\0';
263 last_pc
= (addr_t
)-1;
269 stab_sym_end
= (Stab_Sym
*)((char*)stab_sym
+ stab_len
);
270 for (sym
= stab_sym
+ 1; sym
< stab_sym_end
; ++sym
) {
271 switch(sym
->n_type
) {
272 /* function start or end */
274 if (sym
->n_strx
== 0) {
275 /* we test if between last line and end of function */
276 pc
= sym
->n_value
+ func_addr
;
277 if (wanted_pc
>= last_pc
&& wanted_pc
< pc
)
282 str
= stab_str
+ sym
->n_strx
;
283 p
= strchr(str
, ':');
285 pstrcpy(func_name
, sizeof(func_name
), str
);
288 if (len
> sizeof(func_name
) - 1)
289 len
= sizeof(func_name
) - 1;
290 memcpy(func_name
, str
, len
);
291 func_name
[len
] = '\0';
293 func_addr
= sym
->n_value
;
296 /* line number info */
298 pc
= sym
->n_value
+ func_addr
;
299 if (wanted_pc
>= last_pc
&& wanted_pc
< pc
)
302 last_line_num
= sym
->n_desc
;
304 strcpy(last_func_name
, func_name
);
308 str
= stab_str
+ sym
->n_strx
;
310 if (incl_index
< INCLUDE_STACK_SIZE
) {
311 incl_files
[incl_index
++] = str
;
319 if (sym
->n_strx
== 0) {
320 incl_index
= 0; /* end of translation unit */
322 str
= stab_str
+ sym
->n_strx
;
323 /* do not add path */
325 if (len
> 0 && str
[len
- 1] != '/')
333 /* second pass: we try symtab symbols (no line number info) */
337 ElfW(Sym
) *sym
, *sym_end
;
340 sym_end
= (ElfW(Sym
) *)(symtab_section
->data
+ symtab_section
->data_offset
);
341 for(sym
= (ElfW(Sym
) *)symtab_section
->data
+ 1;
344 type
= ELFW(ST_TYPE
)(sym
->st_info
);
345 if (type
== STT_FUNC
|| type
== STT_GNU_IFUNC
) {
346 if (wanted_pc
>= sym
->st_value
&&
347 wanted_pc
< sym
->st_value
+ sym
->st_size
) {
348 pstrcpy(last_func_name
, sizeof(last_func_name
),
349 strtab_section
->data
+ sym
->st_name
);
350 func_addr
= sym
->st_value
;
356 /* did not find any info: */
357 fprintf(stderr
, "%s %p ???\n", msg
, (void*)wanted_pc
);
363 fprintf(stderr
, "%s:%d: ", incl_files
[--i
], last_line_num
);
364 fprintf(stderr
, "%s %p", msg
, (void*)wanted_pc
);
365 if (last_func_name
[0] != '\0')
366 fprintf(stderr
, " %s()", last_func_name
);
368 fprintf(stderr
, " (included from ");
370 fprintf(stderr
, "%s", incl_files
[i
]);
373 fprintf(stderr
, ", ");
375 fprintf(stderr
, ")");
377 fprintf(stderr
, "\n");
382 /* emit a run time error at position 'pc' */
383 static void rt_error(ucontext_t
*uc
, const char *fmt
, ...)
389 fprintf(stderr
, "Runtime error: ");
391 vfprintf(stderr
, fmt
, ap
);
393 fprintf(stderr
, "\n");
395 for(i
=0;i
<rt_num_callers
;i
++) {
396 if (rt_get_caller_pc(&pc
, uc
, i
) < 0)
398 pc
= rt_printline(pc
, i
? "by" : "at");
399 if (pc
== (addr_t
)rt_prog_main
&& pc
)
404 /* ------------------------------------------------------------- */
407 /* signal handler for fatal errors */
408 static void sig_error(int signum
, siginfo_t
*siginf
, void *puc
)
410 ucontext_t
*uc
= puc
;
414 switch(siginf
->si_code
) {
417 rt_error(uc
, "division by zero");
420 rt_error(uc
, "floating point exception");
426 if (rt_bound_error_msg
&& *rt_bound_error_msg
)
427 rt_error(uc
, *rt_bound_error_msg
);
429 rt_error(uc
, "dereferencing invalid pointer");
432 rt_error(uc
, "illegal instruction");
435 rt_error(uc
, "abort() called");
438 rt_error(uc
, "caught signal %d", signum
);
445 # define SA_SIGINFO 0x00000004u
448 /* Generate a stack backtrace when a CPU exception occurs. */
449 static void set_exception_handler(void)
451 struct sigaction sigact
;
452 /* install TCC signal handlers to print debug info on fatal
454 sigact
.sa_flags
= SA_SIGINFO
| SA_RESETHAND
;
455 sigact
.sa_sigaction
= sig_error
;
456 sigemptyset(&sigact
.sa_mask
);
457 sigaction(SIGFPE
, &sigact
, NULL
);
458 sigaction(SIGILL
, &sigact
, NULL
);
459 sigaction(SIGSEGV
, &sigact
, NULL
);
460 sigaction(SIGBUS
, &sigact
, NULL
);
461 sigaction(SIGABRT
, &sigact
, NULL
);
464 /* ------------------------------------------------------------- */
467 /* fix for glibc 2.1 */
473 /* return the PC at frame level 'level'. Return negative if not found */
474 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
480 #if defined(__APPLE__)
481 *paddr
= uc
->uc_mcontext
->__ss
.__eip
;
482 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
483 *paddr
= uc
->uc_mcontext
.mc_eip
;
484 #elif defined(__dietlibc__)
485 *paddr
= uc
->uc_mcontext
.eip
;
487 *paddr
= uc
->uc_mcontext
.gregs
[REG_EIP
];
491 #if defined(__APPLE__)
492 fp
= uc
->uc_mcontext
->__ss
.__ebp
;
493 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
494 fp
= uc
->uc_mcontext
.mc_ebp
;
495 #elif defined(__dietlibc__)
496 fp
= uc
->uc_mcontext
.ebp
;
498 fp
= uc
->uc_mcontext
.gregs
[REG_EBP
];
500 for(i
=1;i
<level
;i
++) {
501 /* XXX: check address validity with program info */
502 if (fp
<= 0x1000 || fp
>= 0xc0000000)
504 fp
= ((addr_t
*)fp
)[0];
506 *paddr
= ((addr_t
*)fp
)[1];
511 /* ------------------------------------------------------------- */
512 #elif defined(__x86_64__)
514 /* return the PC at frame level 'level'. Return negative if not found */
515 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
521 /* XXX: only support linux */
522 #if defined(__APPLE__)
523 *paddr
= uc
->uc_mcontext
->__ss
.__rip
;
524 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
525 *paddr
= uc
->uc_mcontext
.mc_rip
;
527 *paddr
= uc
->uc_mcontext
.gregs
[REG_RIP
];
531 #if defined(__APPLE__)
532 fp
= uc
->uc_mcontext
->__ss
.__rbp
;
533 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
534 fp
= uc
->uc_mcontext
.mc_rbp
;
536 fp
= uc
->uc_mcontext
.gregs
[REG_RBP
];
538 for(i
=1;i
<level
;i
++) {
539 /* XXX: check address validity with program info */
542 fp
= ((addr_t
*)fp
)[0];
544 *paddr
= ((addr_t
*)fp
)[1];
549 /* ------------------------------------------------------------- */
550 #elif defined(__arm__)
552 /* return the PC at frame level 'level'. Return negative if not found */
553 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
559 /* XXX: only supports linux */
560 #if defined(__linux__)
561 *paddr
= uc
->uc_mcontext
.arm_pc
;
567 #if defined(__linux__)
568 fp
= uc
->uc_mcontext
.arm_fp
;
569 sp
= uc
->uc_mcontext
.arm_sp
;
575 /* XXX: specific to tinycc stack frames */
576 if (fp
< sp
+ 12 || fp
& 3)
578 for(i
= 1; i
< level
; i
++) {
579 sp
= ((addr_t
*)fp
)[-2];
580 if (sp
< fp
|| sp
- fp
> 16 || sp
& 3)
582 fp
= ((addr_t
*)fp
)[-3];
583 if (fp
<= sp
|| fp
- sp
< 12 || fp
& 3)
586 /* XXX: check address validity with program info */
587 *paddr
= ((addr_t
*)fp
)[-1];
592 /* ------------------------------------------------------------- */
595 #warning add arch specific rt_get_caller_pc()
596 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
601 #endif /* !__i386__ */
603 /* ------------------------------------------------------------- */
606 static long __stdcall
cpu_exception_handler(EXCEPTION_POINTERS
*ex_info
)
608 EXCEPTION_RECORD
*er
= ex_info
->ExceptionRecord
;
609 CONTEXT
*uc
= ex_info
->ContextRecord
;
610 switch (er
->ExceptionCode
) {
611 case EXCEPTION_ACCESS_VIOLATION
:
612 if (rt_bound_error_msg
&& *rt_bound_error_msg
)
613 rt_error(uc
, *rt_bound_error_msg
);
615 rt_error(uc
, "access violation");
617 case EXCEPTION_STACK_OVERFLOW
:
618 rt_error(uc
, "stack overflow");
620 case EXCEPTION_INT_DIVIDE_BY_ZERO
:
621 rt_error(uc
, "division by zero");
624 rt_error(uc
, "exception caught");
627 return EXCEPTION_EXECUTE_HANDLER
;
630 /* Generate a stack backtrace when a CPU exception occurs. */
631 static void set_exception_handler(void)
633 SetUnhandledExceptionFilter(cpu_exception_handler
);
637 static void win64_add_function_table(TCCState
*s1
)
640 (RUNTIME_FUNCTION
*)s1
->uw_pdata
->sh_addr
,
641 s1
->uw_pdata
->data_offset
/ sizeof (RUNTIME_FUNCTION
),
642 text_section
->sh_addr
647 /* return the PC at frame level 'level'. Return non zero if not found */
648 static int rt_get_caller_pc(addr_t
*paddr
, CONTEXT
*uc
, int level
)
660 for(i
=1;i
<level
;i
++) {
661 /* XXX: check address validity with program info */
662 if (fp
<= 0x1000 || fp
>= 0xc0000000)
664 fp
= ((addr_t
*)fp
)[0];
666 pc
= ((addr_t
*)fp
)[1];
673 #endif /* CONFIG_TCC_BACKTRACE */
674 /* ------------------------------------------------------------- */
675 #ifdef CONFIG_TCC_STATIC
677 /* dummy function for profiling */
678 ST_FUNC
void *dlopen(const char *filename
, int flag
)
683 ST_FUNC
void dlclose(void *p
)
687 ST_FUNC
const char *dlerror(void)
692 typedef struct TCCSyms
{
698 /* add the symbol you want here if no dynamic linking is done */
699 static TCCSyms tcc_syms
[] = {
700 #if !defined(CONFIG_TCCBOOT)
701 #define TCCSYM(a) { #a, &a, },
711 ST_FUNC
void *resolve_sym(TCCState
*s1
, const char *symbol
)
715 while (p
->str
!= NULL
) {
716 if (!strcmp(p
->str
, symbol
))
723 #elif !defined(_WIN32)
725 ST_FUNC
void *resolve_sym(TCCState
*s1
, const char *sym
)
727 return dlsym(RTLD_DEFAULT
, sym
);
730 #endif /* CONFIG_TCC_STATIC */
731 #endif /* TCC_IS_NATIVE */
732 /* ------------------------------------------------------------- */