Go to file
Kirill Smelkov 646b51833f lib/bcheck: Prevent libc_malloc/libc_free etc from being miscompiled
On i386 and gcc-4.7 I found that libc_malloc was miscompiled - look:

static void *libc_malloc(size_t size)
{
    void *ptr;
    restore_malloc_hooks();     // __malloc_hook = saved_malloc_hook
    ptr = malloc(size);
    install_malloc_hooks();     // saved_malloc_hook = __malloc_hook, __malloc_hook = __bound_malloc
    return ptr;
}

	.type	libc_malloc, @function
libc_malloc:
.LFB56:
	.cfi_startproc
	pushl	%edx
	.cfi_def_cfa_offset 8
	movl	%eax, (%esp)
	call	malloc
	movl	$__bound_malloc, __malloc_hook
	movl	$__bound_free, __free_hook
	movl	$__bound_realloc, __realloc_hook
	movl	$__bound_memalign, __memalign_hook
	popl	%ecx
	.cfi_def_cfa_offset 4
	ret

Here gcc inlined both restore_malloc_hooks() and install_malloc_hooks()
and decided that

    saved_malloc_hook -> __malloc_hook -> saved_malloc_hook

stores are not needed and could be ommitted. Only it did not know
__molloc_hook affects malloc()...

So add compiler barrier to both install and restore hooks functions and
be done with it - the code is now ok:

    diff --git a/bcheck0.s b/bcheck1.s
    index 5f50293..4c02a5f 100644
    --- a/bcheck0.s
    +++ b/bcheck1.s
    @@ -42,8 +42,24 @@ libc_malloc:
            .cfi_startproc
            pushl   %edx
            .cfi_def_cfa_offset 8
    +       movl    saved_malloc_hook, %edx
    +       movl    %edx, __malloc_hook
    +       movl    saved_free_hook, %edx
    +       movl    %edx, __free_hook
    +       movl    saved_realloc_hook, %edx
    +       movl    %edx, __realloc_hook
    +       movl    saved_memalign_hook, %edx
    +       movl    %edx, __memalign_hook
            movl    %eax, (%esp)
            call    malloc
    +       movl    __malloc_hook, %edx
    +       movl    %edx, saved_malloc_hook
    +       movl    __free_hook, %edx
    +       movl    %edx, saved_free_hook
    +       movl    __realloc_hook, %edx
    +       movl    %edx, saved_realloc_hook
    +       movl    __memalign_hook, %edx
    +       movl    %edx, saved_memalign_hook
            movl    $__bound_malloc, __malloc_hook
            movl    $__bound_free, __free_hook
            movl    $__bound_realloc, __realloc_hook

For barrier I use

    __asm__ __volatile__ ("": : : "memory")

which is used as compiler barrier by Linux kernel, and mentioned in gcc
docs and in wikipedia [1].

Without this patch any program compiled with tcc -b crashes in startup
because of infinite recursion in libc_malloc.

[1] http://en.wikipedia.org/wiki/Memory_ordering#Compiler_memory_barrier
2012-11-13 22:17:51 +04:00
examples Revert "Make ex1.c and ex4.c be executable on any systems" 2012-06-12 15:45:13 +02:00
include Remove semicolon in x86-64 va_arg definition. 2011-08-05 20:32:57 +02:00
lib lib/bcheck: Prevent libc_malloc/libc_free etc from being miscompiled 2012-11-13 22:17:51 +04:00
tests Honour *FLAGS everywhere 2012-11-06 15:20:53 +01:00
tests2 Create a clean target for tests2/Makefile 2012-11-07 14:56:37 +01:00
win32 win32: tcc.exe uses libtcc.dll 2012-04-18 18:38:11 +02:00
.gitignore osx: Removed some optimizations for x86 builds as they were causing seg faults. 2012-06-10 20:58:48 -04:00
COPYING changed license to LGPL 2003-05-24 14:18:56 +00:00
Changelog Add support for arm hardfloat calling convention 2012-06-05 23:09:55 +02:00
Makefile Allow source fortification 2012-11-07 21:15:07 +01:00
README Document in README that ex4.c can be executed. 2011-07-07 12:15:43 +02:00
TODO re-apply VLA by Thomas Preud'homme 2011-04-06 09:17:03 -07:00
VERSION update Changelog, bump version: 0.9.25 2009-05-11 19:01:26 +02:00
arm-gen.c Add support for arm hardfloat calling convention 2012-06-05 23:09:55 +02:00
c67-gen.c rename error/warning -> tcc_(error/warning) 2011-08-11 17:07:56 +02:00
coff.h C67 COFF executable format support (TK) 2004-10-05 22:33:55 +00:00
configure Evaluate configure arguments 2012-06-12 20:48:01 +02:00
elf.h Add support for R_ARM_THM_{JUMP24,CALL} relocs 2012-10-28 19:55:12 +01:00
i386-asm.c rename error/warning -> tcc_(error/warning) 2011-08-11 17:07:56 +02:00
i386-asm.h i386-asm: support "pause" opcode 2011-02-24 09:38:13 -08:00
i386-gen.c i386: fix loading of LLOCAL floats 2012-01-23 01:45:11 +01:00
i386-tok.h integrate x86_64-asm.c into i386-asm.c 2009-12-19 22:16:20 +01:00
il-gen.c rename error/warning -> tcc_(error/warning) 2011-08-11 17:07:56 +02:00
il-opcodes.h added CIL target 2002-02-10 16:14:03 +00:00
libtcc.c fix #include_next infinite loop bug, see http://savannah.nongnu.org/bugs/?31357 2012-09-20 22:12:05 +03:00
libtcc.h tccrun: another incompatible change to the tcc_relocate API 2012-09-01 11:33:34 +02:00
stab.def added 2002-12-08 14:36:36 +00:00
stab.h added 2002-12-08 14:36:36 +00:00
tcc-doc.texi Inform user that -b only exists on i386. 2012-03-13 19:43:43 +01:00
tcc.c tcc.c: fix argv index for parse_args 2012-06-12 15:32:44 +02:00
tcc.h Generate PLT thumb stub only when necessary 2012-11-07 20:51:33 +01:00
tccasm.c Compile tccasm.c conditionally (TCC_CONFIG_ASM) 2012-01-06 18:34:21 +01:00
tcccoff.c rename error/warning -> tcc_(error/warning) 2011-08-11 17:07:56 +02:00
tccelf.c Call to veneers in ARM mode 2012-11-09 10:59:06 +01:00
tccgen.c forbid invalid comparison of struct 2012-11-05 22:34:43 +09:00
tccpe.c pe: fix tcc not linking to user32 and gdi32 2012-11-02 16:59:21 +08:00
tccpp.c Fix parsing function macro invocations 2012-04-18 20:57:13 +02:00
tccrun.c tccrun: another incompatible change to the tcc_relocate API 2012-09-01 11:33:34 +02:00
tcctok.h tcctok.h: fix ifdef target/host confusion 2011-04-12 00:11:47 -07:00
texi2pod.pl automatic man page generation from tcc-doc.texi 2003-05-18 18:11:06 +00:00
x86_64-asm.h x86-64: fix udiv, add cqto instruction 2009-12-19 22:16:19 +01:00
x86_64-gen.c x86-64: Fix call saved register restore 2012-06-10 09:01:26 +02:00

README

Tiny C Compiler - C Scripting Everywhere - The Smallest ANSI C compiler
-----------------------------------------------------------------------

Features:
--------

- SMALL! You can compile and execute C code everywhere, for example on
  rescue disks.

- FAST! tcc generates optimized x86 code. No byte code
  overhead. Compile, assemble and link about 7 times faster than 'gcc
  -O0'.

- UNLIMITED! Any C dynamic library can be used directly. TCC is
  heading torward full ISOC99 compliance. TCC can of course compile
  itself.

- SAFE! tcc includes an optional memory and bound checker. Bound
  checked code can be mixed freely with standard code.

- Compile and execute C source directly. No linking or assembly
  necessary. Full C preprocessor included. 

- C script supported : just add '#!/usr/local/bin/tcc -run' at the first
  line of your C source, and execute it directly from the command
  line.

Documentation:
-------------

1) Installation on a i386 Linux host (for Windows read tcc-win32.txt)

   ./configure
   make
   make test
   make install

By default, tcc is installed in /usr/local/bin.
./configure --help  shows configuration options.


2) Introduction

We assume here that you know ANSI C. Look at the example ex1.c to know
what the programs look like.

The include file <tcclib.h> can be used if you want a small basic libc
include support (especially useful for floppy disks). Of course, you
can also use standard headers, although they are slower to compile.

You can begin your C script with '#!/usr/local/bin/tcc -run' on the first
line and set its execute bits (chmod a+x your_script). Then, you can
launch the C code as a shell or perl script :-) The command line
arguments are put in 'argc' and 'argv' of the main functions, as in
ANSI C.

3) Examples

ex1.c: simplest example (hello world). Can also be launched directly
as a script: './ex1.c'.

ex2.c: more complicated example: find a number with the four
operations given a list of numbers (benchmark).

ex3.c: compute fibonacci numbers (benchmark).

ex4.c: more complicated: X11 program. Very complicated test in fact
because standard headers are being used ! As for ex1.c, can also be launched
directly as a script: './ex4.c'.

ex5.c: 'hello world' with standard glibc headers.

tcc.c: TCC can of course compile itself. Used to check the code
generator.

tcctest.c: auto test for TCC which tests many subtle possible bugs. Used
when doing 'make test'.

4) Full Documentation

Please read tcc-doc.html to have all the features of TCC.

Additional information is available for the Windows port in tcc-win32.txt.

License:
-------

TCC is distributed under the GNU Lesser General Public License (see
COPYING file).

Fabrice Bellard.