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
, s1
->runtime_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 void (*bound_new_region
)(void *p
, unsigned long size
);
114 int (*bound_delete_region
)(void *p
);
117 /* set error function */
118 rt_bound_error_msg
= tcc_get_symbol_err(s1
, "__bound_error_msg");
119 /* XXX: use .init section so that it also work in binary ? */
120 bound_init
= tcc_get_symbol_err(s1
, "__bound_init");
121 bound_exit
= tcc_get_symbol_err(s1
, "__bound_exit");
122 bound_new_region
= tcc_get_symbol_err(s1
, "__bound_new_region");
123 bound_delete_region
= tcc_get_symbol_err(s1
, "__bound_delete_region");
125 /* mark argv area as valid */
126 bound_new_region(argv
, argc
*sizeof(argv
[0]));
127 for (i
=0; i
<argc
; ++i
)
128 bound_new_region(argv
[i
], strlen(argv
[i
]));
130 ret
= (*prog_main
)(argc
, argv
);
132 /* unmark argv area */
133 for (i
=0; i
<argc
; ++i
)
134 bound_delete_region(argv
[i
]);
135 bound_delete_region(argv
);
140 ret
= (*prog_main
)(argc
, argv
);
144 /* relocate code. Return -1 on error, required size if ptr is NULL,
145 otherwise copy code into buffer passed by the caller */
146 static int tcc_relocate_ex(TCCState
*s1
, void *ptr
)
149 unsigned long offset
, length
;
156 pe_output_file(s1
, NULL
);
159 relocate_common_syms();
160 tcc_add_linker_symbols(s1
);
161 build_got_entries(s1
);
167 offset
= 0, mem
= (addr_t
)ptr
;
168 for(i
= 1; i
< s1
->nb_sections
; i
++) {
170 if (0 == (s
->sh_flags
& SHF_ALLOC
))
172 length
= s
->data_offset
;
173 s
->sh_addr
= mem
? (mem
+ offset
+ 15) & ~15 : 0;
174 offset
= (offset
+ length
+ 15) & ~15;
178 /* relocate symbols */
179 relocate_syms(s1
, 1);
183 #ifdef TCC_HAS_RUNTIME_PLTGOT
184 s1
->runtime_plt_and_got_offset
= 0;
185 s1
->runtime_plt_and_got
= (char *)(mem
+ offset
);
186 /* double the size of the buffer for got and plt entries
187 XXX: calculate exact size for them? */
194 /* relocate each section */
195 for(i
= 1; i
< s1
->nb_sections
; i
++) {
198 relocate_section(s1
, s
);
201 for(i
= 1; i
< s1
->nb_sections
; i
++) {
203 if (0 == (s
->sh_flags
& SHF_ALLOC
))
205 length
= s
->data_offset
;
206 // printf("%-12s %08x %04x\n", s->name, s->sh_addr, length);
207 ptr
= (void*)s
->sh_addr
;
208 if (NULL
== s
->data
|| s
->sh_type
== SHT_NOBITS
)
209 memset(ptr
, 0, length
);
211 memcpy(ptr
, s
->data
, length
);
212 /* mark executable sections as executable in memory */
213 if (s
->sh_flags
& SHF_EXECINSTR
)
214 set_pages_executable(ptr
, length
);
217 #ifdef TCC_HAS_RUNTIME_PLTGOT
218 set_pages_executable(s1
->runtime_plt_and_got
,
219 s1
->runtime_plt_and_got_offset
);
223 win64_add_function_table(s1
);
228 /* ------------------------------------------------------------- */
229 /* allow to run code in memory */
231 static void set_pages_executable(void *ptr
, unsigned long length
)
234 unsigned long old_protect
;
235 VirtualProtect(ptr
, length
, PAGE_EXECUTE_READWRITE
, &old_protect
);
237 extern void __clear_cache(char *beginning
, char *end
);
239 # define PAGESIZE 4096
242 start
= (addr_t
)ptr
& ~(PAGESIZE
- 1);
243 end
= (addr_t
)ptr
+ length
;
244 end
= (end
+ PAGESIZE
- 1) & ~(PAGESIZE
- 1);
245 mprotect((void *)start
, end
- start
, PROT_READ
| PROT_WRITE
| PROT_EXEC
);
246 __clear_cache(ptr
, ptr
+ length
);
250 /* ------------------------------------------------------------- */
251 #ifdef CONFIG_TCC_BACKTRACE
253 ST_FUNC
void tcc_set_num_callers(int n
)
258 /* print the position in the source file of PC value 'pc' by reading
259 the stabs debug information */
260 static addr_t
rt_printline(addr_t wanted_pc
, const char *msg
)
262 char func_name
[128], last_func_name
[128];
263 addr_t func_addr
, last_pc
, pc
;
264 const char *incl_files
[INCLUDE_STACK_SIZE
];
265 int incl_index
, len
, last_line_num
, i
;
268 Stab_Sym
*stab_sym
= NULL
, *stab_sym_end
, *sym
;
270 char *stab_str
= NULL
;
273 stab_len
= stab_section
->data_offset
;
274 stab_sym
= (Stab_Sym
*)stab_section
->data
;
275 stab_str
= (char *) stabstr_section
->data
;
281 last_func_name
[0] = '\0';
282 last_pc
= (addr_t
)-1;
288 stab_sym_end
= (Stab_Sym
*)((char*)stab_sym
+ stab_len
);
289 for (sym
= stab_sym
+ 1; sym
< stab_sym_end
; ++sym
) {
290 switch(sym
->n_type
) {
291 /* function start or end */
293 if (sym
->n_strx
== 0) {
294 /* we test if between last line and end of function */
295 pc
= sym
->n_value
+ func_addr
;
296 if (wanted_pc
>= last_pc
&& wanted_pc
< pc
)
301 str
= stab_str
+ sym
->n_strx
;
302 p
= strchr(str
, ':');
304 pstrcpy(func_name
, sizeof(func_name
), str
);
307 if (len
> sizeof(func_name
) - 1)
308 len
= sizeof(func_name
) - 1;
309 memcpy(func_name
, str
, len
);
310 func_name
[len
] = '\0';
312 func_addr
= sym
->n_value
;
315 /* line number info */
317 pc
= sym
->n_value
+ func_addr
;
318 if (wanted_pc
>= last_pc
&& wanted_pc
< pc
)
321 last_line_num
= sym
->n_desc
;
323 strcpy(last_func_name
, func_name
);
327 str
= stab_str
+ sym
->n_strx
;
329 if (incl_index
< INCLUDE_STACK_SIZE
) {
330 incl_files
[incl_index
++] = str
;
338 if (sym
->n_strx
== 0) {
339 incl_index
= 0; /* end of translation unit */
341 str
= stab_str
+ sym
->n_strx
;
342 /* do not add path */
344 if (len
> 0 && str
[len
- 1] != '/')
352 /* second pass: we try symtab symbols (no line number info) */
356 ElfW(Sym
) *sym
, *sym_end
;
359 sym_end
= (ElfW(Sym
) *)(symtab_section
->data
+ symtab_section
->data_offset
);
360 for(sym
= (ElfW(Sym
) *)symtab_section
->data
+ 1;
363 type
= ELFW(ST_TYPE
)(sym
->st_info
);
364 if (type
== STT_FUNC
|| type
== STT_GNU_IFUNC
) {
365 if (wanted_pc
>= sym
->st_value
&&
366 wanted_pc
< sym
->st_value
+ sym
->st_size
) {
367 pstrcpy(last_func_name
, sizeof(last_func_name
),
368 (char *) strtab_section
->data
+ sym
->st_name
);
369 func_addr
= sym
->st_value
;
375 /* did not find any info: */
376 fprintf(stderr
, "%s %p ???\n", msg
, (void*)wanted_pc
);
382 fprintf(stderr
, "%s:%d: ", incl_files
[--i
], last_line_num
);
383 fprintf(stderr
, "%s %p", msg
, (void*)wanted_pc
);
384 if (last_func_name
[0] != '\0')
385 fprintf(stderr
, " %s()", last_func_name
);
387 fprintf(stderr
, " (included from ");
389 fprintf(stderr
, "%s", incl_files
[i
]);
392 fprintf(stderr
, ", ");
394 fprintf(stderr
, ")");
396 fprintf(stderr
, "\n");
401 /* emit a run time error at position 'pc' */
402 static void rt_error(ucontext_t
*uc
, const char *fmt
, ...)
408 fprintf(stderr
, "Runtime error: ");
410 vfprintf(stderr
, fmt
, ap
);
412 fprintf(stderr
, "\n");
414 for(i
=0;i
<rt_num_callers
;i
++) {
415 if (rt_get_caller_pc(&pc
, uc
, i
) < 0)
417 pc
= rt_printline(pc
, i
? "by" : "at");
418 if (pc
== (addr_t
)rt_prog_main
&& pc
)
423 /* ------------------------------------------------------------- */
426 /* signal handler for fatal errors */
427 static void sig_error(int signum
, siginfo_t
*siginf
, void *puc
)
429 ucontext_t
*uc
= puc
;
433 switch(siginf
->si_code
) {
436 rt_error(uc
, "division by zero");
439 rt_error(uc
, "floating point exception");
445 if (rt_bound_error_msg
&& *rt_bound_error_msg
)
446 rt_error(uc
, *rt_bound_error_msg
);
448 rt_error(uc
, "dereferencing invalid pointer");
451 rt_error(uc
, "illegal instruction");
454 rt_error(uc
, "abort() called");
457 rt_error(uc
, "caught signal %d", signum
);
464 # define SA_SIGINFO 0x00000004u
467 /* Generate a stack backtrace when a CPU exception occurs. */
468 static void set_exception_handler(void)
470 struct sigaction sigact
;
471 /* install TCC signal handlers to print debug info on fatal
473 sigact
.sa_flags
= SA_SIGINFO
| SA_RESETHAND
;
474 sigact
.sa_sigaction
= sig_error
;
475 sigemptyset(&sigact
.sa_mask
);
476 sigaction(SIGFPE
, &sigact
, NULL
);
477 sigaction(SIGILL
, &sigact
, NULL
);
478 sigaction(SIGSEGV
, &sigact
, NULL
);
479 sigaction(SIGBUS
, &sigact
, NULL
);
480 sigaction(SIGABRT
, &sigact
, NULL
);
483 /* ------------------------------------------------------------- */
486 /* fix for glibc 2.1 */
492 /* return the PC at frame level 'level'. Return negative if not found */
493 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
499 #if defined(__APPLE__)
500 *paddr
= uc
->uc_mcontext
->__ss
.__eip
;
501 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
502 *paddr
= uc
->uc_mcontext
.mc_eip
;
503 #elif defined(__dietlibc__)
504 *paddr
= uc
->uc_mcontext
.eip
;
506 *paddr
= uc
->uc_mcontext
.gregs
[REG_EIP
];
510 #if defined(__APPLE__)
511 fp
= uc
->uc_mcontext
->__ss
.__ebp
;
512 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
513 fp
= uc
->uc_mcontext
.mc_ebp
;
514 #elif defined(__dietlibc__)
515 fp
= uc
->uc_mcontext
.ebp
;
517 fp
= uc
->uc_mcontext
.gregs
[REG_EBP
];
519 for(i
=1;i
<level
;i
++) {
520 /* XXX: check address validity with program info */
521 if (fp
<= 0x1000 || fp
>= 0xc0000000)
523 fp
= ((addr_t
*)fp
)[0];
525 *paddr
= ((addr_t
*)fp
)[1];
530 /* ------------------------------------------------------------- */
531 #elif defined(__x86_64__)
533 /* return the PC at frame level 'level'. Return negative if not found */
534 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
540 /* XXX: only support linux */
541 #if defined(__APPLE__)
542 *paddr
= uc
->uc_mcontext
->__ss
.__rip
;
543 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
544 *paddr
= uc
->uc_mcontext
.mc_rip
;
546 *paddr
= uc
->uc_mcontext
.gregs
[REG_RIP
];
550 #if defined(__APPLE__)
551 fp
= uc
->uc_mcontext
->__ss
.__rbp
;
552 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
553 fp
= uc
->uc_mcontext
.mc_rbp
;
555 fp
= uc
->uc_mcontext
.gregs
[REG_RBP
];
557 for(i
=1;i
<level
;i
++) {
558 /* XXX: check address validity with program info */
561 fp
= ((addr_t
*)fp
)[0];
563 *paddr
= ((addr_t
*)fp
)[1];
568 /* ------------------------------------------------------------- */
569 #elif defined(__arm__)
571 /* return the PC at frame level 'level'. Return negative if not found */
572 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
578 /* XXX: only supports linux */
579 #if defined(__linux__)
580 *paddr
= uc
->uc_mcontext
.arm_pc
;
586 #if defined(__linux__)
587 fp
= uc
->uc_mcontext
.arm_fp
;
588 sp
= uc
->uc_mcontext
.arm_sp
;
594 /* XXX: specific to tinycc stack frames */
595 if (fp
< sp
+ 12 || fp
& 3)
597 for(i
= 1; i
< level
; i
++) {
598 sp
= ((addr_t
*)fp
)[-2];
599 if (sp
< fp
|| sp
- fp
> 16 || sp
& 3)
601 fp
= ((addr_t
*)fp
)[-3];
602 if (fp
<= sp
|| fp
- sp
< 12 || fp
& 3)
605 /* XXX: check address validity with program info */
606 *paddr
= ((addr_t
*)fp
)[-1];
611 /* ------------------------------------------------------------- */
614 #warning add arch specific rt_get_caller_pc()
615 static int rt_get_caller_pc(addr_t
*paddr
, ucontext_t
*uc
, int level
)
620 #endif /* !__i386__ */
622 /* ------------------------------------------------------------- */
625 static long __stdcall
cpu_exception_handler(EXCEPTION_POINTERS
*ex_info
)
627 EXCEPTION_RECORD
*er
= ex_info
->ExceptionRecord
;
628 CONTEXT
*uc
= ex_info
->ContextRecord
;
629 switch (er
->ExceptionCode
) {
630 case EXCEPTION_ACCESS_VIOLATION
:
631 if (rt_bound_error_msg
&& *rt_bound_error_msg
)
632 rt_error(uc
, *rt_bound_error_msg
);
634 rt_error(uc
, "access violation");
636 case EXCEPTION_STACK_OVERFLOW
:
637 rt_error(uc
, "stack overflow");
639 case EXCEPTION_INT_DIVIDE_BY_ZERO
:
640 rt_error(uc
, "division by zero");
643 rt_error(uc
, "exception caught");
646 return EXCEPTION_EXECUTE_HANDLER
;
649 /* Generate a stack backtrace when a CPU exception occurs. */
650 static void set_exception_handler(void)
652 SetUnhandledExceptionFilter(cpu_exception_handler
);
656 static void win64_add_function_table(TCCState
*s1
)
659 (RUNTIME_FUNCTION
*)s1
->uw_pdata
->sh_addr
,
660 s1
->uw_pdata
->data_offset
/ sizeof (RUNTIME_FUNCTION
),
661 text_section
->sh_addr
666 /* return the PC at frame level 'level'. Return non zero if not found */
667 static int rt_get_caller_pc(addr_t
*paddr
, CONTEXT
*uc
, int level
)
679 for(i
=1;i
<level
;i
++) {
680 /* XXX: check address validity with program info */
681 if (fp
<= 0x1000 || fp
>= 0xc0000000)
683 fp
= ((addr_t
*)fp
)[0];
685 pc
= ((addr_t
*)fp
)[1];
692 #endif /* CONFIG_TCC_BACKTRACE */
693 /* ------------------------------------------------------------- */
694 #ifdef CONFIG_TCC_STATIC
696 /* dummy function for profiling */
697 ST_FUNC
void *dlopen(const char *filename
, int flag
)
702 ST_FUNC
void dlclose(void *p
)
706 ST_FUNC
const char *dlerror(void)
711 typedef struct TCCSyms
{
717 /* add the symbol you want here if no dynamic linking is done */
718 static TCCSyms tcc_syms
[] = {
719 #if !defined(CONFIG_TCCBOOT)
720 #define TCCSYM(a) { #a, &a, },
730 ST_FUNC
void *resolve_sym(TCCState
*s1
, const char *symbol
)
734 while (p
->str
!= NULL
) {
735 if (!strcmp(p
->str
, symbol
))
742 #elif !defined(_WIN32)
744 ST_FUNC
void *resolve_sym(TCCState
*s1
, const char *sym
)
746 return dlsym(RTLD_DEFAULT
, sym
);
749 #endif /* CONFIG_TCC_STATIC */
750 #endif /* TCC_IS_NATIVE */
751 /* ------------------------------------------------------------- */