Fix warning of clang
[tinycc.git] / tccrun.c
blobbd8c33f272dc267162335e2abce6a24070791c49
1 /*
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
21 #include "tcc.h"
23 /* only native compiler supports -run */
24 #ifdef TCC_IS_NATIVE
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;
30 #endif
32 #ifdef _WIN32
33 #define ucontext_t CONTEXT
34 #endif
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);
42 #ifdef _WIN64
43 static void win64_add_function_table(TCCState *s1);
44 #endif
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)
52 int ret;
54 if (TCC_RELOCATE_AUTO != ptr)
55 return tcc_relocate_ex(s1, ptr);
57 ret = tcc_relocate_ex(s1, NULL);
58 if (ret < 0)
59 return ret;
61 #ifdef HAVE_SELINUX
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);
68 s1->mem_size = ret;
69 unlink (tmpfname);
70 ftruncate (fd, s1->mem_size);
72 s1->write_mem = mmap (NULL, ret, PROT_READ|PROT_WRITE,
73 MAP_SHARED, fd, 0);
74 if (s1->write_mem == MAP_FAILED)
75 tcc_error("/tmp not writeable");
77 s1->runtime_mem = mmap (NULL, ret, PROT_READ|PROT_EXEC,
78 MAP_SHARED, fd, 0);
79 if (s1->runtime_mem == MAP_FAILED)
80 tcc_error("/tmp not executable");
82 ret = tcc_relocate_ex(s1, s1->write_mem);
84 #else
85 s1->runtime_mem = tcc_malloc(ret);
86 ret = tcc_relocate_ex(s1, s1->runtime_mem);
87 #endif
88 return ret;
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 **);
95 int ret;
97 if (tcc_relocate(s1, TCC_RELOCATE_AUTO) < 0)
98 return -1;
100 prog_main = tcc_get_symbol_err(s1, s1->runtime_main);
102 #ifdef CONFIG_TCC_BACKTRACE
103 if (s1->do_debug) {
104 set_exception_handler();
105 rt_prog_main = prog_main;
107 #endif
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);
115 int i;
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");
124 bound_init();
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);
137 bound_exit();
138 } else
139 #endif
140 ret = (*prog_main)(argc, argv);
141 return ret;
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)
148 Section *s;
149 unsigned long offset, length;
150 addr_t mem;
151 int i;
153 if (NULL == ptr) {
154 s1->nb_errors = 0;
155 #ifdef TCC_TARGET_PE
156 pe_output_file(s1, NULL);
157 #else
158 tcc_add_runtime(s1);
159 relocate_common_syms();
160 tcc_add_linker_symbols(s1);
161 build_got_entries(s1);
162 #endif
163 if (s1->nb_errors)
164 return -1;
167 offset = 0, mem = (addr_t)ptr;
168 for(i = 1; i < s1->nb_sections; i++) {
169 s = s1->sections[i];
170 if (0 == (s->sh_flags & SHF_ALLOC))
171 continue;
172 length = s->data_offset;
173 s->sh_addr = mem ? (mem + offset + 15) & ~15 : 0;
174 offset = (offset + length + 15) & ~15;
176 offset += 16;
178 /* relocate symbols */
179 relocate_syms(s1, 1);
180 if (s1->nb_errors)
181 return -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? */
188 offset *= 2;
189 #endif
191 if (0 == mem)
192 return offset;
194 /* relocate each section */
195 for(i = 1; i < s1->nb_sections; i++) {
196 s = s1->sections[i];
197 if (s->reloc)
198 relocate_section(s1, s);
201 for(i = 1; i < s1->nb_sections; i++) {
202 s = s1->sections[i];
203 if (0 == (s->sh_flags & SHF_ALLOC))
204 continue;
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);
210 else
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);
220 #endif
222 #ifdef _WIN64
223 win64_add_function_table(s1);
224 #endif
225 return 0;
228 /* ------------------------------------------------------------- */
229 /* allow to run code in memory */
231 static void set_pages_executable(void *ptr, unsigned long length)
233 #ifdef _WIN32
234 unsigned long old_protect;
235 VirtualProtect(ptr, length, PAGE_EXECUTE_READWRITE, &old_protect);
236 #else
237 extern void __clear_cache(char *beginning, char *end);
238 #ifndef PAGESIZE
239 # define PAGESIZE 4096
240 #endif
241 addr_t start, end;
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);
247 #endif
250 /* ------------------------------------------------------------- */
251 #ifdef CONFIG_TCC_BACKTRACE
253 ST_FUNC void tcc_set_num_callers(int n)
255 rt_num_callers = 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;
266 const char *str, *p;
268 Stab_Sym *stab_sym = NULL, *stab_sym_end, *sym;
269 int stab_len = 0;
270 char *stab_str = NULL;
272 if (stab_section) {
273 stab_len = stab_section->data_offset;
274 stab_sym = (Stab_Sym *)stab_section->data;
275 stab_str = (char *) stabstr_section->data;
278 func_name[0] = '\0';
279 func_addr = 0;
280 incl_index = 0;
281 last_func_name[0] = '\0';
282 last_pc = (addr_t)-1;
283 last_line_num = 1;
285 if (!stab_sym)
286 goto no_stabs;
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 */
292 case N_FUN:
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)
297 goto found;
298 func_name[0] = '\0';
299 func_addr = 0;
300 } else {
301 str = stab_str + sym->n_strx;
302 p = strchr(str, ':');
303 if (!p) {
304 pstrcpy(func_name, sizeof(func_name), str);
305 } else {
306 len = p - 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;
314 break;
315 /* line number info */
316 case N_SLINE:
317 pc = sym->n_value + func_addr;
318 if (wanted_pc >= last_pc && wanted_pc < pc)
319 goto found;
320 last_pc = pc;
321 last_line_num = sym->n_desc;
322 /* XXX: slow! */
323 strcpy(last_func_name, func_name);
324 break;
325 /* include files */
326 case N_BINCL:
327 str = stab_str + sym->n_strx;
328 add_incl:
329 if (incl_index < INCLUDE_STACK_SIZE) {
330 incl_files[incl_index++] = str;
332 break;
333 case N_EINCL:
334 if (incl_index > 1)
335 incl_index--;
336 break;
337 case N_SO:
338 if (sym->n_strx == 0) {
339 incl_index = 0; /* end of translation unit */
340 } else {
341 str = stab_str + sym->n_strx;
342 /* do not add path */
343 len = strlen(str);
344 if (len > 0 && str[len - 1] != '/')
345 goto add_incl;
347 break;
351 no_stabs:
352 /* second pass: we try symtab symbols (no line number info) */
353 incl_index = 0;
354 if (symtab_section)
356 ElfW(Sym) *sym, *sym_end;
357 int type;
359 sym_end = (ElfW(Sym) *)(symtab_section->data + symtab_section->data_offset);
360 for(sym = (ElfW(Sym) *)symtab_section->data + 1;
361 sym < sym_end;
362 sym++) {
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;
370 goto found;
375 /* did not find any info: */
376 fprintf(stderr, "%s %p ???\n", msg, (void*)wanted_pc);
377 fflush(stderr);
378 return 0;
379 found:
380 i = incl_index;
381 if (i > 0)
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);
386 if (--i >= 0) {
387 fprintf(stderr, " (included from ");
388 for (;;) {
389 fprintf(stderr, "%s", incl_files[i]);
390 if (--i < 0)
391 break;
392 fprintf(stderr, ", ");
394 fprintf(stderr, ")");
396 fprintf(stderr, "\n");
397 fflush(stderr);
398 return func_addr;
401 /* emit a run time error at position 'pc' */
402 static void rt_error(ucontext_t *uc, const char *fmt, ...)
404 va_list ap;
405 addr_t pc;
406 int i;
408 fprintf(stderr, "Runtime error: ");
409 va_start(ap, fmt);
410 vfprintf(stderr, fmt, ap);
411 va_end(ap);
412 fprintf(stderr, "\n");
414 for(i=0;i<rt_num_callers;i++) {
415 if (rt_get_caller_pc(&pc, uc, i) < 0)
416 break;
417 pc = rt_printline(pc, i ? "by" : "at");
418 if (pc == (addr_t)rt_prog_main && pc)
419 break;
423 /* ------------------------------------------------------------- */
424 #ifndef _WIN32
426 /* signal handler for fatal errors */
427 static void sig_error(int signum, siginfo_t *siginf, void *puc)
429 ucontext_t *uc = puc;
431 switch(signum) {
432 case SIGFPE:
433 switch(siginf->si_code) {
434 case FPE_INTDIV:
435 case FPE_FLTDIV:
436 rt_error(uc, "division by zero");
437 break;
438 default:
439 rt_error(uc, "floating point exception");
440 break;
442 break;
443 case SIGBUS:
444 case SIGSEGV:
445 if (rt_bound_error_msg && *rt_bound_error_msg)
446 rt_error(uc, *rt_bound_error_msg);
447 else
448 rt_error(uc, "dereferencing invalid pointer");
449 break;
450 case SIGILL:
451 rt_error(uc, "illegal instruction");
452 break;
453 case SIGABRT:
454 rt_error(uc, "abort() called");
455 break;
456 default:
457 rt_error(uc, "caught signal %d", signum);
458 break;
460 exit(255);
463 #ifndef SA_SIGINFO
464 # define SA_SIGINFO 0x00000004u
465 #endif
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
472 runtime errors */
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 /* ------------------------------------------------------------- */
484 #ifdef __i386__
486 /* fix for glibc 2.1 */
487 #ifndef REG_EIP
488 #define REG_EIP EIP
489 #define REG_EBP EBP
490 #endif
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)
495 addr_t fp;
496 int i;
498 if (level == 0) {
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;
505 #else
506 *paddr = uc->uc_mcontext.gregs[REG_EIP];
507 #endif
508 return 0;
509 } else {
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;
516 #else
517 fp = uc->uc_mcontext.gregs[REG_EBP];
518 #endif
519 for(i=1;i<level;i++) {
520 /* XXX: check address validity with program info */
521 if (fp <= 0x1000 || fp >= 0xc0000000)
522 return -1;
523 fp = ((addr_t *)fp)[0];
525 *paddr = ((addr_t *)fp)[1];
526 return 0;
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)
536 addr_t fp;
537 int i;
539 if (level == 0) {
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;
545 #else
546 *paddr = uc->uc_mcontext.gregs[REG_RIP];
547 #endif
548 return 0;
549 } else {
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;
554 #else
555 fp = uc->uc_mcontext.gregs[REG_RBP];
556 #endif
557 for(i=1;i<level;i++) {
558 /* XXX: check address validity with program info */
559 if (fp <= 0x1000)
560 return -1;
561 fp = ((addr_t *)fp)[0];
563 *paddr = ((addr_t *)fp)[1];
564 return 0;
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)
574 addr_t fp, sp;
575 int i;
577 if (level == 0) {
578 /* XXX: only supports linux */
579 #if defined(__linux__)
580 *paddr = uc->uc_mcontext.arm_pc;
581 #else
582 return -1;
583 #endif
584 return 0;
585 } else {
586 #if defined(__linux__)
587 fp = uc->uc_mcontext.arm_fp;
588 sp = uc->uc_mcontext.arm_sp;
589 if (sp < 0x1000)
590 sp = 0x1000;
591 #else
592 return -1;
593 #endif
594 /* XXX: specific to tinycc stack frames */
595 if (fp < sp + 12 || fp & 3)
596 return -1;
597 for(i = 1; i < level; i++) {
598 sp = ((addr_t *)fp)[-2];
599 if (sp < fp || sp - fp > 16 || sp & 3)
600 return -1;
601 fp = ((addr_t *)fp)[-3];
602 if (fp <= sp || fp - sp < 12 || fp & 3)
603 return -1;
605 /* XXX: check address validity with program info */
606 *paddr = ((addr_t *)fp)[-1];
607 return 0;
611 /* ------------------------------------------------------------- */
612 #else
614 #warning add arch specific rt_get_caller_pc()
615 static int rt_get_caller_pc(addr_t *paddr, ucontext_t *uc, int level)
617 return -1;
620 #endif /* !__i386__ */
622 /* ------------------------------------------------------------- */
623 #else /* WIN32 */
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);
633 else
634 rt_error(uc, "access violation");
635 break;
636 case EXCEPTION_STACK_OVERFLOW:
637 rt_error(uc, "stack overflow");
638 break;
639 case EXCEPTION_INT_DIVIDE_BY_ZERO:
640 rt_error(uc, "division by zero");
641 break;
642 default:
643 rt_error(uc, "exception caught");
644 break;
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);
655 #ifdef _WIN64
656 static void win64_add_function_table(TCCState *s1)
658 RtlAddFunctionTable(
659 (RUNTIME_FUNCTION*)s1->uw_pdata->sh_addr,
660 s1->uw_pdata->data_offset / sizeof (RUNTIME_FUNCTION),
661 text_section->sh_addr
664 #endif
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)
669 addr_t fp, pc;
670 int i;
671 #ifdef _WIN64
672 pc = uc->Rip;
673 fp = uc->Rbp;
674 #else
675 pc = uc->Eip;
676 fp = uc->Ebp;
677 #endif
678 if (level > 0) {
679 for(i=1;i<level;i++) {
680 /* XXX: check address validity with program info */
681 if (fp <= 0x1000 || fp >= 0xc0000000)
682 return -1;
683 fp = ((addr_t*)fp)[0];
685 pc = ((addr_t*)fp)[1];
687 *paddr = pc;
688 return 0;
691 #endif /* _WIN32 */
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)
699 return NULL;
702 ST_FUNC void dlclose(void *p)
706 ST_FUNC const char *dlerror(void)
708 return "error";
711 typedef struct TCCSyms {
712 char *str;
713 void *ptr;
714 } 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, },
721 TCCSYM(printf)
722 TCCSYM(fprintf)
723 TCCSYM(fopen)
724 TCCSYM(fclose)
725 #undef TCCSYM
726 #endif
727 { NULL, NULL },
730 ST_FUNC void *resolve_sym(TCCState *s1, const char *symbol)
732 TCCSyms *p;
733 p = tcc_syms;
734 while (p->str != NULL) {
735 if (!strcmp(p->str, symbol))
736 return p->ptr;
737 p++;
739 return NULL;
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 /* ------------------------------------------------------------- */