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 typedef struct rt_context
29 /* --> tccelf.c:tcc_add_btstub wants those below in that order: */
30 Stab_Sym
*stab_sym
, *stab_sym_end
;
32 ElfW(Sym
) *esym_start
, *esym_end
;
36 struct rt_context
*next
;
45 static rt_context g_rtctxt
;
46 static void set_exception_handler(void);
47 static int _rt_error(void *fp
, void *ip
, const char *fmt
, va_list ap
);
48 static void rt_exit(int code
);
49 #endif /* CONFIG_TCC_BACKTRACE */
51 /* defined when included from lib/bt-exe.c */
52 #ifndef CONFIG_TCC_BACKTRACE_ONLY
55 # include <sys/mman.h>
58 static void set_pages_executable(TCCState
*s1
, void *ptr
, unsigned long length
);
59 static int tcc_relocate_ex(TCCState
*s1
, void *ptr
, addr_t ptr_diff
);
62 static void *win64_add_function_table(TCCState
*s1
);
63 static void win64_del_function_table(void *);
66 /* ------------------------------------------------------------- */
67 /* Do all relocations (needed before using tcc_get_symbol())
68 Returns -1 on error. */
70 LIBTCCAPI
int tcc_relocate(TCCState
*s1
, void *ptr
)
75 if (TCC_RELOCATE_AUTO
!= ptr
)
76 return tcc_relocate_ex(s1
, ptr
, 0);
78 size
= tcc_relocate_ex(s1
, NULL
, 0);
84 /* Using mmap instead of malloc */
86 char tmpfname
[] = "/tmp/.tccrunXXXXXX";
87 int fd
= mkstemp(tmpfname
);
91 ptr
= mmap (NULL
, size
, PROT_READ
|PROT_WRITE
, MAP_SHARED
, fd
, 0);
92 prx
= mmap (NULL
, size
, PROT_READ
|PROT_EXEC
, MAP_SHARED
, fd
, 0);
93 if (ptr
== MAP_FAILED
|| prx
== MAP_FAILED
)
94 tcc_error("tccrun: could not map memory");
95 dynarray_add(&s1
->runtime_mem
, &s1
->nb_runtime_mem
, (void*)(addr_t
)size
);
96 dynarray_add(&s1
->runtime_mem
, &s1
->nb_runtime_mem
, prx
);
97 ptr_diff
= (char*)prx
- (char*)ptr
;
101 ptr
= tcc_malloc(size
);
103 tcc_relocate_ex(s1
, ptr
, ptr_diff
); /* no more errors expected */
104 dynarray_add(&s1
->runtime_mem
, &s1
->nb_runtime_mem
, ptr
);
108 ST_FUNC
void tcc_run_free(TCCState
*s1
)
112 for (i
= 0; i
< s1
->nb_runtime_mem
; ++i
) {
114 unsigned size
= (unsigned)(addr_t
)s1
->runtime_mem
[i
++];
115 munmap(s1
->runtime_mem
[i
++], size
);
116 munmap(s1
->runtime_mem
[i
], size
);
119 win64_del_function_table(*(void**)s1
->runtime_mem
[i
]);
121 tcc_free(s1
->runtime_mem
[i
]);
124 tcc_free(s1
->runtime_mem
);
127 static void run_cdtors(TCCState
*s1
, const char *start
, const char *end
)
129 void **a
= tcc_get_symbol(s1
, start
);
130 void **b
= tcc_get_symbol(s1
, end
);
132 ((void(*)(void))*a
++)();
135 /* launch the compiled program with the given arguments */
136 LIBTCCAPI
int tcc_run(TCCState
*s1
, int argc
, char **argv
)
138 int (*prog_main
)(int, char **), ret
;
139 #ifdef CONFIG_TCC_BACKTRACE
140 rt_context
*rc
= &g_rtctxt
;
143 s1
->runtime_main
= s1
->nostdlib
? "_start" : s1
->leading_underscore
? "_main" : "main";
144 if ((s1
->dflag
& 16) && !find_elf_sym(s1
->symtab
, s1
->runtime_main
))
146 #ifdef CONFIG_TCC_BACKTRACE
148 tcc_add_symbol(s1
, "exit", rt_exit
);
150 if (tcc_relocate(s1
, TCC_RELOCATE_AUTO
) < 0)
152 prog_main
= tcc_get_symbol_err(s1
, s1
->runtime_main
);
154 #ifdef CONFIG_TCC_BACKTRACE
155 memset(rc
, 0, sizeof *rc
);
158 rc
->stab_sym
= (Stab_Sym
*)stab_section
->data
;
159 rc
->stab_sym_end
= (Stab_Sym
*)(stab_section
->data
+ stab_section
->data_offset
);
160 rc
->stab_str
= (char *)stab_section
->link
->data
;
161 rc
->esym_start
= (ElfW(Sym
) *)(symtab_section
->data
);
162 rc
->esym_end
= (ElfW(Sym
) *)(symtab_section
->data
+ symtab_section
->data_offset
);
163 rc
->elf_str
= (char *)symtab_section
->link
->data
;
165 rc
->prog_base
= text_section
->sh_addr
& 0xffffffff00000000ULL
;
167 rc
->top_func
= tcc_get_symbol(s1
, "main");
168 rc
->num_callers
= s1
->rt_num_callers
;
170 if ((p
= tcc_get_symbol(s1
, "__rt_error")))
171 *(void**)p
= _rt_error
;
172 #ifdef CONFIG_TCC_BCHECK
173 if (s1
->do_bounds_check
) {
174 if ((p
= tcc_get_symbol(s1
, "__bound_init")))
175 ((void(*)(void*))p
)(bounds_section
->data
);
178 set_exception_handler();
182 errno
= 0; /* clean errno value */
185 run_cdtors(s1
, "__init_array_start", "__init_array_end");
186 #ifdef CONFIG_TCC_BACKTRACE
187 if (!rc
->do_jmp
|| !(ret
= setjmp(rc
->jmp_buf)))
190 ret
= prog_main(argc
, argv
);
192 run_cdtors(s1
, "__fini_array_start", "__fini_array_end");
193 if ((s1
->dflag
& 16) && ret
)
194 fprintf(s1
->ppfp
, "[returns %d]\n", ret
), fflush(s1
->ppfp
);
198 #if defined TCC_TARGET_I386 || defined TCC_TARGET_X86_64
199 /* To avoid that x86 processors would reload cached instructions
200 each time when data is written in the near, we need to make
201 sure that code and data do not share the same 64 byte unit */
202 #define RUN_SECTION_ALIGNMENT 63
204 #define RUN_SECTION_ALIGNMENT 0
207 /* relocate code. Return -1 on error, required size if ptr is NULL,
208 otherwise copy code into buffer passed by the caller */
209 static int tcc_relocate_ex(TCCState
*s1
, void *ptr
, addr_t ptr_diff
)
212 unsigned offset
, length
, align
, max_align
, i
, k
, f
;
218 pe_output_file(s1
, NULL
);
221 resolve_common_syms(s1
);
222 build_got_entries(s1
);
228 offset
= max_align
= 0, mem
= (addr_t
)ptr
;
230 offset
+= sizeof (void*); /* space for function_table pointer */
232 for (k
= 0; k
< 2; ++k
) {
233 f
= 0, addr
= k
? mem
: mem
+ ptr_diff
;
234 for(i
= 1; i
< s1
->nb_sections
; i
++) {
236 if (0 == (s
->sh_flags
& SHF_ALLOC
))
238 if (k
!= !(s
->sh_flags
& SHF_EXECINSTR
))
240 align
= s
->sh_addralign
- 1;
241 if (++f
== 1 && align
< RUN_SECTION_ALIGNMENT
)
242 align
= RUN_SECTION_ALIGNMENT
;
243 if (max_align
< align
)
245 offset
+= -(addr
+ offset
) & align
;
246 s
->sh_addr
= mem
? addr
+ offset
: 0;
247 offset
+= s
->data_offset
;
250 printf("%-16s %p len %04x align %2d\n",
251 s
->name
, (void*)s
->sh_addr
, (unsigned)s
->data_offset
, align
+ 1);
256 /* relocate symbols */
257 relocate_syms(s1
, s1
->symtab
, !(s1
->nostdlib
));
262 return offset
+ max_align
;
265 s1
->pe_imagebase
= mem
;
268 /* relocate each section */
269 for(i
= 1; i
< s1
->nb_sections
; i
++) {
272 relocate_section(s1
, s
);
274 #if !defined(TCC_TARGET_PE) || defined(TCC_TARGET_MACHO)
278 for(i
= 1; i
< s1
->nb_sections
; i
++) {
280 if (0 == (s
->sh_flags
& SHF_ALLOC
))
282 length
= s
->data_offset
;
283 ptr
= (void*)s
->sh_addr
;
284 if (s
->sh_flags
& SHF_EXECINSTR
)
285 ptr
= (char*)((addr_t
)ptr
- ptr_diff
);
286 if (NULL
== s
->data
|| s
->sh_type
== SHT_NOBITS
)
287 memset(ptr
, 0, length
);
289 memcpy(ptr
, s
->data
, length
);
290 /* mark executable sections as executable in memory */
291 if (s
->sh_flags
& SHF_EXECINSTR
)
292 set_pages_executable(s1
, (char*)((addr_t
)ptr
+ ptr_diff
), length
);
296 *(void**)mem
= win64_add_function_table(s1
);
302 /* ------------------------------------------------------------- */
303 /* allow to run code in memory */
305 static void set_pages_executable(TCCState
*s1
, void *ptr
, unsigned long length
)
308 unsigned long old_protect
;
309 VirtualProtect(ptr
, length
, PAGE_EXECUTE_READWRITE
, &old_protect
);
311 void __clear_cache(void *beginning
, void *end
);
312 # ifndef HAVE_SELINUX
315 # define PAGESIZE 4096
317 start
= (addr_t
)ptr
& ~(PAGESIZE
- 1);
318 end
= (addr_t
)ptr
+ length
;
319 end
= (end
+ PAGESIZE
- 1) & ~(PAGESIZE
- 1);
320 if (mprotect((void *)start
, end
- start
, PROT_READ
| PROT_WRITE
| PROT_EXEC
))
321 tcc_error("mprotect failed: did you mean to configure --with-selinux?");
323 # if defined TCC_TARGET_ARM || defined TCC_TARGET_ARM64
324 __clear_cache(ptr
, (char *)ptr
+ length
);
330 static void *win64_add_function_table(TCCState
*s1
)
334 p
= (void*)s1
->uw_pdata
->sh_addr
;
336 (RUNTIME_FUNCTION
*)p
,
337 s1
->uw_pdata
->data_offset
/ sizeof (RUNTIME_FUNCTION
),
345 static void win64_del_function_table(void *p
)
348 RtlDeleteFunctionTable((RUNTIME_FUNCTION
*)p
);
352 #endif //ndef CONFIG_TCC_BACKTRACE_ONLY
353 /* ------------------------------------------------------------- */
354 #ifdef CONFIG_TCC_BACKTRACE
356 static int rt_vprintf(const char *fmt
, va_list ap
)
358 int ret
= vfprintf(stderr
, fmt
, ap
);
363 static int rt_printf(const char *fmt
, ...)
368 r
= rt_vprintf(fmt
, ap
);
373 #define INCLUDE_STACK_SIZE 32
375 /* print the position in the source file of PC value 'pc' by reading
376 the stabs debug information */
377 static addr_t
rt_printline (rt_context
*rc
, addr_t wanted_pc
,
378 const char *msg
, const char *skip
)
381 addr_t func_addr
, last_pc
, pc
;
382 const char *incl_files
[INCLUDE_STACK_SIZE
];
383 int incl_index
, last_incl_index
, len
, last_line_num
, i
;
392 last_pc
= (addr_t
)-1;
396 for (sym
= rc
->stab_sym
+ 1; sym
< rc
->stab_sym_end
; ++sym
) {
397 str
= rc
->stab_str
+ sym
->n_strx
;
400 switch(sym
->n_type
) {
408 if (sym
->n_strx
== 0) /* end of function */
412 /* Stab_Sym.n_value is only 32bits */
419 if (pc
>= wanted_pc
&& wanted_pc
>= last_pc
)
424 switch(sym
->n_type
) {
425 /* function start or end */
427 if (sym
->n_strx
== 0)
429 p
= strchr(str
, ':');
430 if (0 == p
|| (len
= p
- str
+ 1, len
> sizeof func_name
))
431 len
= sizeof func_name
;
432 pstrcpy(func_name
, len
, str
);
435 /* line number info */
438 last_line_num
= sym
->n_desc
;
439 last_incl_index
= incl_index
;
443 if (incl_index
< INCLUDE_STACK_SIZE
)
444 incl_files
[incl_index
++] = str
;
450 /* start/end of translation unit */
454 /* do not add path */
456 if (len
> 0 && str
[len
- 1] != '/')
457 incl_files
[incl_index
++] = str
;
462 last_pc
= (addr_t
)-1;
464 /* alternative file name (from #line or #include directives) */
467 incl_files
[incl_index
-1] = str
;
476 /* we try symtab symbols (no line number info) */
477 for (esym
= rc
->esym_start
+ 1; esym
< rc
->esym_end
; ++esym
) {
478 int type
= ELFW(ST_TYPE
)(esym
->st_info
);
479 if (type
== STT_FUNC
|| type
== STT_GNU_IFUNC
) {
480 if (wanted_pc
>= esym
->st_value
&&
481 wanted_pc
< esym
->st_value
+ esym
->st_size
) {
482 pstrcpy(func_name
, sizeof(func_name
),
483 rc
->elf_str
+ esym
->st_name
);
484 func_addr
= esym
->st_value
;
496 str
= incl_files
[--i
];
497 if (skip
[0] && strstr(str
, skip
))
499 rt_printf("%s:%d: ", str
, last_line_num
);
501 rt_printf("%08llx : ", (long long)wanted_pc
);
502 rt_printf("%s %s", msg
, func_name
[0] ? func_name
: "???");
505 rt_printf(" (included from ");
507 rt_printf("%s", incl_files
[i
]);
518 static int rt_get_caller_pc(addr_t
*paddr
, rt_context
*rc
, int level
);
520 static int _rt_error(void *fp
, void *ip
, const char *fmt
, va_list ap
)
522 rt_context
*rc
= &g_rtctxt
;
525 int i
, level
, ret
, n
;
526 const char *a
, *b
, *msg
;
529 /* we're called from tcc_backtrace. */
534 /* we're called from signal/exception handler */
535 msg
= "RUNTIME ERROR: ";
539 /* If fmt is like "^file.c^..." then skip calls from 'file.c' */
540 if (fmt
[0] == '^' && (b
= strchr(a
= fmt
+ 1, fmt
[0]))) {
541 memcpy(skip
, a
, b
- a
), skip
[b
- a
] = 0;
545 n
= rc
->num_callers
? rc
->num_callers
: 6;
546 for (i
= level
= 0; level
< n
; i
++) {
547 ret
= rt_get_caller_pc(&pc
, rc
, i
);
550 pc
= rt_printline(rc
, pc
, level
? "by" : "at", skip
);
551 if (pc
== (addr_t
)-1)
558 } else if (ret
== -1)
561 if (ret
== -1 || (pc
== (addr_t
)rc
->top_func
&& pc
))
570 /* emit a run time error at position 'pc' */
571 static int rt_error(const char *fmt
, ...)
576 ret
= _rt_error(0, 0, fmt
, ap
);
581 static void rt_exit(int code
)
583 rt_context
*rc
= &g_rtctxt
;
585 longjmp(rc
->jmp_buf, code
? code
: 256);
589 /* ------------------------------------------------------------- */
594 # include <sys/ucontext.h>
597 # define ucontext_t CONTEXT
600 /* translate from ucontext_t* to internal rt_context * */
601 static void rt_getcontext(ucontext_t
*uc
, rt_context
*rc
)
611 #elif defined __i386__
612 # if defined(__APPLE__)
613 rc
->ip
= uc
->uc_mcontext
->__ss
.__eip
;
614 rc
->fp
= uc
->uc_mcontext
->__ss
.__ebp
;
615 # elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
616 rc
->ip
= uc
->uc_mcontext
.mc_eip
;
617 rc
->fp
= uc
->uc_mcontext
.mc_ebp
;
618 # elif defined(__dietlibc__)
619 rc
->ip
= uc
->uc_mcontext
.eip
;
620 rc
->fp
= uc
->uc_mcontext
.ebp
;
621 # elif defined(__NetBSD__)
622 rc
->ip
= uc
->uc_mcontext
.__gregs
[_REG_EIP
];
623 rc
->fp
= uc
->uc_mcontext
.__gregs
[_REG_EBP
];
624 # elif defined(__OpenBSD__)
627 # elif !defined REG_EIP && defined EIP /* fix for glibc 2.1 */
628 rc
->ip
= uc
->uc_mcontext
.gregs
[EIP
];
629 rc
->fp
= uc
->uc_mcontext
.gregs
[EBP
];
631 rc
->ip
= uc
->uc_mcontext
.gregs
[REG_EIP
];
632 rc
->fp
= uc
->uc_mcontext
.gregs
[REG_EBP
];
634 #elif defined(__x86_64__)
635 # if defined(__APPLE__)
636 rc
->ip
= uc
->uc_mcontext
->__ss
.__rip
;
637 rc
->fp
= uc
->uc_mcontext
->__ss
.__rbp
;
638 # elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(__DragonFly__)
639 rc
->ip
= uc
->uc_mcontext
.mc_rip
;
640 rc
->fp
= uc
->uc_mcontext
.mc_rbp
;
641 # elif defined(__NetBSD__)
642 rc
->ip
= uc
->uc_mcontext
.__gregs
[_REG_RIP
];
643 rc
->fp
= uc
->uc_mcontext
.__gregs
[_REG_RBP
];
645 rc
->ip
= uc
->uc_mcontext
.gregs
[REG_RIP
];
646 rc
->fp
= uc
->uc_mcontext
.gregs
[REG_RBP
];
648 #elif defined(__arm__)
649 rc
->ip
= uc
->uc_mcontext
.arm_pc
;
650 rc
->fp
= uc
->uc_mcontext
.arm_fp
;
651 #elif defined(__aarch64__)
652 rc
->ip
= uc
->uc_mcontext
.pc
;
653 rc
->fp
= uc
->uc_mcontext
.regs
[29];
654 #elif defined(__riscv)
655 rc
->ip
= uc
->uc_mcontext
.__gregs
[REG_PC
];
656 rc
->fp
= uc
->uc_mcontext
.__gregs
[REG_S0
];
660 /* ------------------------------------------------------------- */
662 /* signal handler for fatal errors */
663 static void sig_error(int signum
, siginfo_t
*siginf
, void *puc
)
665 rt_context
*rc
= &g_rtctxt
;
666 rt_getcontext(puc
, rc
);
670 switch(siginf
->si_code
) {
673 rt_error("division by zero");
676 rt_error("floating point exception");
682 rt_error("invalid memory access");
685 rt_error("illegal instruction");
688 rt_error("abort() called");
691 rt_error("caught signal %d", signum
);
698 # define SA_SIGINFO 0x00000004u
701 /* Generate a stack backtrace when a CPU exception occurs. */
702 static void set_exception_handler(void)
704 struct sigaction sigact
;
705 /* install TCC signal handlers to print debug info on fatal
707 sigact
.sa_flags
= SA_SIGINFO
| SA_RESETHAND
;
708 #if 0//def SIGSTKSZ // this causes signals not to work at all on some (older) linuxes
709 sigact
.sa_flags
|= SA_ONSTACK
;
711 sigact
.sa_sigaction
= sig_error
;
712 sigemptyset(&sigact
.sa_mask
);
713 sigaction(SIGFPE
, &sigact
, NULL
);
714 sigaction(SIGILL
, &sigact
, NULL
);
715 sigaction(SIGSEGV
, &sigact
, NULL
);
716 sigaction(SIGBUS
, &sigact
, NULL
);
717 sigaction(SIGABRT
, &sigact
, NULL
);
719 /* This allows stack overflow to be reported instead of a SEGV */
722 static unsigned char stack
[SIGSTKSZ
] __attribute__((aligned(16)));
725 ss
.ss_size
= SIGSTKSZ
;
727 sigaltstack(&ss
, NULL
);
734 /* signal handler for fatal errors */
735 static long __stdcall
cpu_exception_handler(EXCEPTION_POINTERS
*ex_info
)
737 rt_context
*rc
= &g_rtctxt
;
739 rt_getcontext(ex_info
->ContextRecord
, rc
);
741 switch (code
= ex_info
->ExceptionRecord
->ExceptionCode
) {
742 case EXCEPTION_ACCESS_VIOLATION
:
743 rt_error("invalid memory access");
745 case EXCEPTION_STACK_OVERFLOW
:
746 rt_error("stack overflow");
748 case EXCEPTION_INT_DIVIDE_BY_ZERO
:
749 rt_error("division by zero");
751 case EXCEPTION_BREAKPOINT
:
752 case EXCEPTION_SINGLE_STEP
:
753 rc
->ip
= *(addr_t
*)rc
->sp
;
754 rt_error("breakpoint/single-step exception:");
755 return EXCEPTION_CONTINUE_SEARCH
;
757 rt_error("caught exception %08x", code
);
762 return EXCEPTION_EXECUTE_HANDLER
;
765 /* Generate a stack backtrace when a CPU exception occurs. */
766 static void set_exception_handler(void)
768 SetUnhandledExceptionFilter(cpu_exception_handler
);
773 /* ------------------------------------------------------------- */
774 /* return the PC at frame level 'level'. Return negative if not found */
775 #if defined(__i386__) || defined(__x86_64__)
776 static int rt_get_caller_pc(addr_t
*paddr
, rt_context
*rc
, int level
)
785 /* XXX: check address validity with program info */
788 fp
= ((addr_t
*)fp
)[0];
791 ip
= ((addr_t
*)fp
)[1];
799 #elif defined(__arm__)
800 static int rt_get_caller_pc(addr_t
*paddr
, rt_context
*rc
, int level
)
802 /* XXX: only supports linux */
803 #if !defined(__linux__)
811 fp
= ((addr_t
*)fp
)[0];
812 *paddr
= ((addr_t
*)fp
)[2];
818 #elif defined(__aarch64__)
819 static int rt_get_caller_pc(addr_t
*paddr
, rt_context
*rc
, int level
)
824 addr_t
*fp
= (addr_t
*)rc
->fp
;
826 fp
= (addr_t
*)fp
[0];
832 #elif defined(__riscv)
833 static int rt_get_caller_pc(addr_t
*paddr
, rt_context
*rc
, int level
)
838 addr_t
*fp
= (addr_t
*)rc
->fp
;
840 fp
= (addr_t
*)fp
[-2];
847 #warning add arch specific rt_get_caller_pc()
848 static int rt_get_caller_pc(addr_t
*paddr
, rt_context
*rc
, int level
)
854 #endif /* CONFIG_TCC_BACKTRACE */
855 /* ------------------------------------------------------------- */
856 #ifdef CONFIG_TCC_STATIC
858 /* dummy function for profiling */
859 ST_FUNC
void *dlopen(const char *filename
, int flag
)
864 ST_FUNC
void dlclose(void *p
)
868 ST_FUNC
const char *dlerror(void)
873 typedef struct TCCSyms
{
879 /* add the symbol you want here if no dynamic linking is done */
880 static TCCSyms tcc_syms
[] = {
881 #if !defined(CONFIG_TCCBOOT)
882 #define TCCSYM(a) { #a, &a, },
892 ST_FUNC
void *dlsym(void *handle
, const char *symbol
)
896 while (p
->str
!= NULL
) {
897 if (!strcmp(p
->str
, symbol
))
904 #endif /* CONFIG_TCC_STATIC */
905 #endif /* TCC_IS_NATIVE */
906 /* ------------------------------------------------------------- */