Add linker's --export-dynamic flag alias
[tinycc.git] / tcc-doc.texi
blobfc07c12c41238d41eb13badedc584d5b56bb11e8
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @setfilename tcc-doc.info
4 @settitle Tiny C Compiler Reference Documentation
5 @dircategory Software development
6 @direntry
7 * TCC: (tcc-doc).               The Tiny C Compiler.
8 @end direntry
9 @c %**end of header
11 @include config.texi
13 @iftex
14 @titlepage
15 @afourpaper
16 @sp 7
17 @center @titlefont{Tiny C Compiler Reference Documentation}
18 @sp 3
19 @end titlepage
20 @headings double
21 @end iftex
23 @contents
25 @node Top, Introduction, (dir), (dir)
26 @top Tiny C Compiler Reference Documentation
28 This manual documents version @value{VERSION} of the Tiny C Compiler.
30 @menu
31 * Introduction::                Introduction to tcc.
32 * Invoke::                      Invocation of tcc (command line, options).
33 * Clang::                       ANSI C and extensions.
34 * asm::                         Assembler syntax.
35 * linker::                      Output file generation and supported targets.
36 * Bounds::                      Automatic bounds-checking of C code.
37 * Libtcc::                      The libtcc library.
38 * devel::                       Guide for Developers.
39 @end menu
42 @node Introduction
43 @chapter Introduction
45 TinyCC (aka TCC) is a small but hyper fast C compiler. Unlike other C
46 compilers, it is meant to be self-relying: you do not need an
47 external assembler or linker because TCC does that for you.
49 TCC compiles so @emph{fast} that even for big projects @code{Makefile}s may
50 not be necessary.
52 TCC not only supports ANSI C, but also most of the new ISO C99
53 standard and many GNUC extensions including inline assembly.
55 TCC can also be used to make @emph{C scripts}, i.e. pieces of C source
56 that you run as a Perl or Python script. Compilation is so fast that
57 your script will be as fast as if it was an executable.
59 TCC can also automatically generate memory and bound checks
60 (@pxref{Bounds}) while allowing all C pointers operations. TCC can do
61 these checks even if non patched libraries are used.
63 With @code{libtcc}, you can use TCC as a backend for dynamic code
64 generation (@pxref{Libtcc}).
66 TCC mainly supports the i386 target on Linux and Windows. There are alpha
67 ports for the ARM (@code{arm-tcc}) and the TMS320C67xx targets
68 (@code{c67-tcc}). More information about the ARM port is available at
69 @url{http://lists.gnu.org/archive/html/tinycc-devel/2003-10/msg00044.html}.
71 For usage on Windows, see also @url{tcc-win32.txt}.
73 @node Invoke
74 @chapter Command line invocation
76 @section Quick start
78 @example
79 @c man begin SYNOPSIS
80 usage: tcc [options] [@var{infile1} @var{infile2}@dots{}] [@option{-run} @var{infile} @var{args}@dots{}]
81 @c man end
82 @end example
84 @noindent
85 @c man begin DESCRIPTION
86 TCC options are a very much like gcc options. The main difference is that TCC
87 can also execute directly the resulting program and give it runtime
88 arguments.
90 Here are some examples to understand the logic:
92 @table @code
93 @item @samp{tcc -run a.c}
94 Compile @file{a.c} and execute it directly
96 @item @samp{tcc -run a.c arg1}
97 Compile a.c and execute it directly. arg1 is given as first argument to
98 the @code{main()} of a.c.
100 @item @samp{tcc a.c -run b.c arg1}
101 Compile @file{a.c} and @file{b.c}, link them together and execute them. arg1 is given
102 as first argument to the @code{main()} of the resulting program. 
103 @ignore 
104 Because multiple C files are specified, @option{--} are necessary to clearly 
105 separate the program arguments from the TCC options.
106 @end ignore
108 @item @samp{tcc -o myprog a.c b.c}
109 Compile @file{a.c} and @file{b.c}, link them and generate the executable @file{myprog}.
111 @item @samp{tcc -o myprog a.o b.o}
112 link @file{a.o} and @file{b.o} together and generate the executable @file{myprog}.
114 @item @samp{tcc -c a.c}
115 Compile @file{a.c} and generate object file @file{a.o}.
117 @item @samp{tcc -c asmfile.S}
118 Preprocess with C preprocess and assemble @file{asmfile.S} and generate
119 object file @file{asmfile.o}.
121 @item @samp{tcc -c asmfile.s}
122 Assemble (but not preprocess) @file{asmfile.s} and generate object file
123 @file{asmfile.o}.
125 @item @samp{tcc -r -o ab.o a.c b.c}
126 Compile @file{a.c} and @file{b.c}, link them together and generate the object file @file{ab.o}.
128 @end table
130 Scripting:
132 TCC can be invoked from @emph{scripts}, just as shell scripts. You just
133 need to add @code{#!/usr/local/bin/tcc -run} at the start of your C source:
135 @example
136 #!/usr/local/bin/tcc -run
137 #include <stdio.h>
139 int main() 
141     printf("Hello World\n");
142     return 0;
144 @end example
146 TCC can read C source code from @emph{standard input} when @option{-} is used in 
147 place of @option{infile}. Example:
149 @example
150 echo 'main()@{puts("hello");@}' | tcc -run -
151 @end example
152 @c man end
154 @section Option summary
156 General Options:
158 @c man begin OPTIONS
159 @table @option
160 @item -c
161 Generate an object file.
163 @item -o outfile
164 Put object file, executable, or dll into output file @file{outfile}.
166 @item -run source [args...]
167 Compile file @var{source} and run it with the command line arguments
168 @var{args}. In order to be able to give more than one argument to a
169 script, several TCC options can be given @emph{after} the
170 @option{-run} option, separated by spaces:
171 @example
172 tcc "-run -L/usr/X11R6/lib -lX11" ex4.c
173 @end example
174 In a script, it gives the following header:
175 @example
176 #!/usr/local/bin/tcc -run -L/usr/X11R6/lib -lX11
177 @end example
179 @item -v
180 Display TCC version.
182 @item -vv
183 Show included files.  As sole argument, print search dirs.  -vvv shows tries too.
185 @item -bench
186 Display compilation statistics.
188 @end table
190 Preprocessor options:
192 @table @option
193 @item -Idir
194 Specify an additional include path. Include paths are searched in the
195 order they are specified.
197 System include paths are always searched after. The default system
198 include paths are: @file{/usr/local/include}, @file{/usr/include}
199 and @file{PREFIX/lib/tcc/include}. (@file{PREFIX} is usually
200 @file{/usr} or @file{/usr/local}).
202 @item -Dsym[=val]
203 Define preprocessor symbol @samp{sym} to
204 val. If val is not present, its value is @samp{1}. Function-like macros can
205 also be defined: @option{-DF(a)=a+1}
207 @item -Usym
208 Undefine preprocessor symbol @samp{sym}.
210 @item -E
211 Preprocess only, to stdout or file (with -o).
213 @end table
215 Compilation flags:
217 Note: each of the following options has a negative form beginning with
218 @option{-fno-}.
220 @table @option
221 @item -funsigned-char
222 Let the @code{char} type be unsigned.
224 @item -fsigned-char
225 Let the @code{char} type be signed.
227 @item -fno-common
228 Do not generate common symbols for uninitialized data.
230 @item -fleading-underscore
231 Add a leading underscore at the beginning of each C symbol.
233 @item -fms-extensions
234 Allow a MS C compiler extensions to the language. Currently this
235 assumes a nested named structure declaration without an identifier
236 behaves like an unnamed one.
238 @item -fdollars-in-identifiers
239 Allow dollar signs in identifiers
241 @end table
243 Warning options:
245 @table @option
246 @item -w
247 Disable all warnings.
249 @end table
251 Note: each of the following warning options has a negative form beginning with
252 @option{-Wno-}.
254 @table @option
255 @item -Wimplicit-function-declaration
256 Warn about implicit function declaration.
258 @item -Wunsupported
259 Warn about unsupported GCC features that are ignored by TCC.
261 @item -Wwrite-strings
262 Make string constants be of type @code{const char *} instead of @code{char
265 @item -Werror
266 Abort compilation if warnings are issued.
268 @item -Wall 
269 Activate all warnings, except @option{-Werror}, @option{-Wunusupported} and
270 @option{-Wwrite-strings}.
272 @end table
274 Linker options:
276 @table @option
277 @item -Ldir
278 Specify an additional static library path for the @option{-l} option. The
279 default library paths are @file{/usr/local/lib}, @file{/usr/lib} and @file{/lib}.
281 @item -lxxx
282 Link your program with dynamic library libxxx.so or static library
283 libxxx.a. The library is searched in the paths specified by the
284 @option{-L} option and @env{LIBRARY_PATH} variable.
286 @item -Bdir
287 Set the path where the tcc internal libraries (and include files) can be
288 found (default is @file{PREFIX/lib/tcc}).
290 @item -shared
291 Generate a shared library instead of an executable.
293 @item -soname name
294 set name for shared library to be used at runtime
296 @item -static
297 Generate a statically linked executable (default is a shared linked
298 executable).
300 @item -rdynamic
301 Export global symbols to the dynamic linker. It is useful when a library
302 opened with @code{dlopen()} needs to access executable symbols.
304 @item -r
305 Generate an object file combining all input files.
307 @item -Wl,-rpath=path
308 Put custom search path for dynamic libraries into executable.
310 @item -Wl,--enable-new-dtags
311 When putting a custom search path for dynamic libraries into the executable,
312 create the new ELF dynamic tag DT_RUNPATH instead of the old legacy DT_RPATH.
314 @item -Wl,--oformat=fmt
315 Use @var{fmt} as output format. The supported output formats are:
316 @table @code
317 @item elf32-i386
318 ELF output format (default)
319 @item binary
320 Binary image (only for executable output)
321 @item coff
322 COFF output format (only for executable output for TMS320C67xx target)
323 @end table
325 @item -Wl,--export-all-symbols
326 @item -Wl,--export-dynamic
327 Export global symbols to the dynamic linker. It is useful when a library
328 opened with @code{dlopen()} needs to access executable symbols.
330 @item -Wl,-subsystem=console/gui/wince/...
331 Set type for PE (Windows) executables.
333 @item -Wl,-[Ttext=# | section-alignment=# | file-alignment=# | image-base=# | stack=#]
334 Modify executable layout.
336 @item -Wl,-Bsymbolic
337 Set DT_SYMBOLIC tag.
339 @item -Wl,-(no-)whole-archive
340 Turn on/off linking of all objects in archives.
342 @end table
344 Debugger options:
346 @table @option
347 @item -g
348 Generate run time debug information so that you get clear run time
349 error messages: @code{ test.c:68: in function 'test5()': dereferencing
350 invalid pointer} instead of the laconic @code{Segmentation
351 fault}.
353 @item -b
354 Generate additional support code to check
355 memory allocations and array/pointer bounds. @option{-g} is implied. Note
356 that the generated code is slower and bigger in this case.
358 Note: @option{-b} is only available on i386 when using libtcc for the moment.
360 @item -bt N
361 Display N callers in stack traces. This is useful with @option{-g} or
362 @option{-b}.
364 @end table
366 Misc options:
368 @table @option
369 @item -MD
370 Generate makefile fragment with dependencies.
372 @item -MF depfile
373 Use @file{depfile} as output for -MD.
375 @item -print-search-dirs
376 Print the configured installation directory and a list of library
377 and include directories tcc will search.
379 @item -dumpversion
380 Print version.
382 @end table
384 Target specific options:
386 @table @option
387 @item -mms-bitfields
388 Use an algorithm for bitfield alignment consistent with MSVC. Default is
389 gcc's algorithm.
391 @item -mfloat-abi (ARM only)
392 Select the float ABI. Possible values: @code{softfp} and @code{hard}
394 @item -mno-sse
395 Do not use sse registers on x86_64
397 @item -m32, -m64
398 Pass command line to the i386/x86_64 cross compiler.
400 @end table
402 Note: GCC options @option{-Ox}, @option{-fx} and @option{-mx} are
403 ignored.
404 @c man end
406 @c man begin ENVIRONMENT
407 Environment variables that affect how tcc operates.
409 @table @option
411 @item CPATH
412 @item C_INCLUDE_PATH
413 A colon-separated list of directories searched for include files,
414 directories given with @option{-I} are searched first.
416 @item LIBRARY_PATH
417 A colon-separated list of directories searched for libraries for the
418 @option{-l} option, directories given with @option{-L} are searched first.
420 @end table
422 @c man end
424 @ignore
426 @setfilename tcc
427 @settitle Tiny C Compiler
429 @c man begin SEEALSO
430 cpp(1),
431 gcc(1)
432 @c man end
434 @c man begin AUTHOR
435 Fabrice Bellard
436 @c man end
438 @end ignore
440 @node Clang
441 @chapter C language support
443 @section ANSI C
445 TCC implements all the ANSI C standard, including structure bit fields
446 and floating point numbers (@code{long double}, @code{double}, and
447 @code{float} fully supported).
449 @section ISOC99 extensions
451 TCC implements many features of the new C standard: ISO C99. Currently
452 missing items are: complex and imaginary numbers.
454 Currently implemented ISOC99 features:
456 @itemize
458 @item variable length arrays.
460 @item 64 bit @code{long long} types are fully supported.
462 @item The boolean type @code{_Bool} is supported.
464 @item @code{__func__} is a string variable containing the current
465 function name.
467 @item Variadic macros: @code{__VA_ARGS__} can be used for
468    function-like macros:
469 @example
470     #define dprintf(level, __VA_ARGS__) printf(__VA_ARGS__)
471 @end example
473 @noindent
474 @code{dprintf} can then be used with a variable number of parameters.
476 @item Declarations can appear anywhere in a block (as in C++).
478 @item Array and struct/union elements can be initialized in any order by
479   using designators:
480 @example
481     struct @{ int x, y; @} st[10] = @{ [0].x = 1, [0].y = 2 @};
483     int tab[10] = @{ 1, 2, [5] = 5, [9] = 9@};
484 @end example
485     
486 @item Compound initializers are supported:
487 @example
488     int *p = (int [])@{ 1, 2, 3 @};
489 @end example
490 to initialize a pointer pointing to an initialized array. The same
491 works for structures and strings.
493 @item Hexadecimal floating point constants are supported:
494 @example
495           double d = 0x1234p10;
496 @end example
498 @noindent
499 is the same as writing 
500 @example
501           double d = 4771840.0;
502 @end example
504 @item @code{inline} keyword is ignored.
506 @item @code{restrict} keyword is ignored.
507 @end itemize
509 @section GNU C extensions
511 TCC implements some GNU C extensions:
513 @itemize
515 @item array designators can be used without '=': 
516 @example
517     int a[10] = @{ [0] 1, [5] 2, 3, 4 @};
518 @end example
520 @item Structure field designators can be a label: 
521 @example
522     struct @{ int x, y; @} st = @{ x: 1, y: 1@};
523 @end example
524 instead of
525 @example
526     struct @{ int x, y; @} st = @{ .x = 1, .y = 1@};
527 @end example
529 @item @code{\e} is ASCII character 27.
531 @item case ranges : ranges can be used in @code{case}s:
532 @example
533     switch(a) @{
534     case 1 @dots{} 9:
535           printf("range 1 to 9\n");
536           break;
537     default:
538           printf("unexpected\n");
539           break;
540     @}
541 @end example
543 @cindex aligned attribute
544 @cindex packed attribute
545 @cindex section attribute
546 @cindex unused attribute
547 @cindex cdecl attribute
548 @cindex stdcall attribute
549 @cindex regparm attribute
550 @cindex dllexport attribute
552 @item The keyword @code{__attribute__} is handled to specify variable or
553 function attributes. The following attributes are supported:
554   @itemize
556   @item @code{aligned(n)}: align a variable or a structure field to n bytes
557 (must be a power of two).
559   @item @code{packed}: force alignment of a variable or a structure field to
560   1.
562   @item @code{section(name)}: generate function or data in assembly section
563 name (name is a string containing the section name) instead of the default
564 section.
566   @item @code{unused}: specify that the variable or the function is unused.
568   @item @code{cdecl}: use standard C calling convention (default).
570   @item @code{stdcall}: use Pascal-like calling convention.
572   @item @code{regparm(n)}: use fast i386 calling convention. @var{n} must be
573 between 1 and 3. The first @var{n} function parameters are respectively put in
574 registers @code{%eax}, @code{%edx} and @code{%ecx}.
576   @item @code{dllexport}: export function from dll/executable (win32 only)
578   @end itemize
580 Here are some examples:
581 @example
582     int a __attribute__ ((aligned(8), section(".mysection")));
583 @end example
585 @noindent
586 align variable @code{a} to 8 bytes and put it in section @code{.mysection}.
588 @example
589     int my_add(int a, int b) __attribute__ ((section(".mycodesection"))) 
590     @{
591         return a + b;
592     @}
593 @end example
595 @noindent
596 generate function @code{my_add} in section @code{.mycodesection}.
598 @item GNU style variadic macros:
599 @example
600     #define dprintf(fmt, args@dots{}) printf(fmt, ## args)
602     dprintf("no arg\n");
603     dprintf("one arg %d\n", 1);
604 @end example
606 @item @code{__FUNCTION__} is interpreted as C99 @code{__func__} 
607 (so it has not exactly the same semantics as string literal GNUC
608 where it is a string literal).
610 @item The @code{__alignof__} keyword can be used as @code{sizeof} 
611 to get the alignment of a type or an expression.
613 @item The @code{typeof(x)} returns the type of @code{x}. 
614 @code{x} is an expression or a type.
616 @item Computed gotos: @code{&&label} returns a pointer of type 
617 @code{void *} on the goto label @code{label}. @code{goto *expr} can be
618 used to jump on the pointer resulting from @code{expr}.
620 @item Inline assembly with asm instruction:
621 @cindex inline assembly
622 @cindex assembly, inline
623 @cindex __asm__
624 @example
625 static inline void * my_memcpy(void * to, const void * from, size_t n)
627 int d0, d1, d2;
628 __asm__ __volatile__(
629         "rep ; movsl\n\t"
630         "testb $2,%b4\n\t"
631         "je 1f\n\t"
632         "movsw\n"
633         "1:\ttestb $1,%b4\n\t"
634         "je 2f\n\t"
635         "movsb\n"
636         "2:"
637         : "=&c" (d0), "=&D" (d1), "=&S" (d2)
638         :"0" (n/4), "q" (n),"1" ((long) to),"2" ((long) from)
639         : "memory");
640 return (to);
642 @end example
644 @noindent
645 @cindex gas
646 TCC includes its own x86 inline assembler with a @code{gas}-like (GNU
647 assembler) syntax. No intermediate files are generated. GCC 3.x named
648 operands are supported.
650 @item @code{__builtin_types_compatible_p()} and @code{__builtin_constant_p()} 
651 are supported.
653 @item @code{#pragma pack} is supported for win32 compatibility.
655 @end itemize
657 @section TinyCC extensions
659 @itemize
661 @item @code{__TINYC__} is a predefined macro to indicate that you use TCC.
663 @item @code{#!} at the start of a line is ignored to allow scripting.
665 @item Binary digits can be entered (@code{0b101} instead of
666 @code{5}).
668 @item @code{__BOUNDS_CHECKING_ON} is defined if bound checking is activated.
670 @end itemize
672 @node asm
673 @chapter TinyCC Assembler
675 Since version 0.9.16, TinyCC integrates its own assembler. TinyCC
676 assembler supports a gas-like syntax (GNU assembler). You can
677 deactivate assembler support if you want a smaller TinyCC executable
678 (the C compiler does not rely on the assembler).
680 TinyCC Assembler is used to handle files with @file{.S} (C
681 preprocessed assembler) and @file{.s} extensions. It is also used to
682 handle the GNU inline assembler with the @code{asm} keyword.
684 @section Syntax
686 TinyCC Assembler supports most of the gas syntax. The tokens are the
687 same as C.
689 @itemize
691 @item C and C++ comments are supported.
693 @item Identifiers are the same as C, so you cannot use '.' or '$'.
695 @item Only 32 bit integer numbers are supported.
697 @end itemize
699 @section Expressions
701 @itemize
703 @item Integers in decimal, octal and hexa are supported.
705 @item Unary operators: +, -, ~.
707 @item Binary operators in decreasing priority order:
709 @enumerate
710 @item *, /, %
711 @item &, |, ^
712 @item +, -
713 @end enumerate
715 @item A value is either an absolute number or a label plus an offset. 
716 All operators accept absolute values except '+' and '-'. '+' or '-' can be
717 used to add an offset to a label. '-' supports two labels only if they
718 are the same or if they are both defined and in the same section.
720 @end itemize
722 @section Labels
724 @itemize
726 @item All labels are considered as local, except undefined ones.
728 @item Numeric labels can be used as local @code{gas}-like labels. 
729 They can be defined several times in the same source. Use 'b'
730 (backward) or 'f' (forward) as suffix to reference them:
732 @example
733  1:
734       jmp 1b /* jump to '1' label before */
735       jmp 1f /* jump to '1' label after */
736  1:
737 @end example
739 @end itemize
741 @section Directives
742 @cindex assembler directives
743 @cindex directives, assembler
744 @cindex align directive
745 @cindex skip directive
746 @cindex space directive
747 @cindex byte directive
748 @cindex word directive
749 @cindex short directive
750 @cindex int directive
751 @cindex long directive
752 @cindex quad directive
753 @cindex globl directive
754 @cindex global directive
755 @cindex section directive
756 @cindex text directive
757 @cindex data directive
758 @cindex bss directive
759 @cindex fill directive
760 @cindex org directive
761 @cindex previous directive
762 @cindex string directive
763 @cindex asciz directive
764 @cindex ascii directive
766 All directives are preceded by a '.'. The following directives are
767 supported:
769 @itemize
770 @item .align n[,value]
771 @item .skip n[,value]
772 @item .space n[,value]
773 @item .byte value1[,...]
774 @item .word value1[,...]
775 @item .short value1[,...]
776 @item .int value1[,...]
777 @item .long value1[,...]
778 @item .quad immediate_value1[,...]
779 @item .globl symbol
780 @item .global symbol
781 @item .section section
782 @item .text
783 @item .data
784 @item .bss
785 @item .fill repeat[,size[,value]]
786 @item .org n
787 @item .previous
788 @item .string string[,...]
789 @item .asciz string[,...]
790 @item .ascii string[,...]
791 @end itemize
793 @section X86 Assembler
794 @cindex assembler
796 All X86 opcodes are supported. Only ATT syntax is supported (source
797 then destination operand order). If no size suffix is given, TinyCC
798 tries to guess it from the operand sizes.
800 Currently, MMX opcodes are supported but not SSE ones.
802 @node linker
803 @chapter TinyCC Linker
804 @cindex linker
806 @section ELF file generation
807 @cindex ELF
809 TCC can directly output relocatable ELF files (object files),
810 executable ELF files and dynamic ELF libraries without relying on an
811 external linker.
813 Dynamic ELF libraries can be output but the C compiler does not generate
814 position independent code (PIC). It means that the dynamic library
815 code generated by TCC cannot be factorized among processes yet.
817 TCC linker eliminates unreferenced object code in libraries. A single pass is
818 done on the object and library list, so the order in which object files and
819 libraries are specified is important (same constraint as GNU ld). No grouping
820 options (@option{--start-group} and @option{--end-group}) are supported.
822 @section ELF file loader
824 TCC can load ELF object files, archives (.a files) and dynamic
825 libraries (.so).
827 @section PE-i386 file generation
828 @cindex PE-i386
830 TCC for Windows supports the native Win32 executable file format (PE-i386).  It
831 generates EXE files (console and gui) and DLL files.
833 For usage on Windows, see also tcc-win32.txt.
835 @section GNU Linker Scripts
836 @cindex scripts, linker
837 @cindex linker scripts
838 @cindex GROUP, linker command
839 @cindex FILE, linker command
840 @cindex OUTPUT_FORMAT, linker command
841 @cindex TARGET, linker command
843 Because on many Linux systems some dynamic libraries (such as
844 @file{/usr/lib/libc.so}) are in fact GNU ld link scripts (horrible!),
845 the TCC linker also supports a subset of GNU ld scripts.
847 The @code{GROUP} and @code{FILE} commands are supported. @code{OUTPUT_FORMAT}
848 and @code{TARGET} are ignored.
850 Example from @file{/usr/lib/libc.so}:
851 @example
852 /* GNU ld script
853    Use the shared library, but some functions are only in
854    the static library, so try that secondarily.  */
855 GROUP ( /lib/libc.so.6 /usr/lib/libc_nonshared.a )
856 @end example
858 @node Bounds
859 @chapter TinyCC Memory and Bound checks
860 @cindex bound checks
861 @cindex memory checks
863 This feature is activated with the @option{-b} (@pxref{Invoke}).
865 Note that pointer size is @emph{unchanged} and that code generated
866 with bound checks is @emph{fully compatible} with unchecked
867 code. When a pointer comes from unchecked code, it is assumed to be
868 valid. Even very obscure C code with casts should work correctly.
870 For more information about the ideas behind this method, see
871 @url{http://www.doc.ic.ac.uk/~phjk/BoundsChecking.html}.
873 Here are some examples of caught errors:
875 @table @asis
877 @item Invalid range with standard string function:
878 @example
880     char tab[10];
881     memset(tab, 0, 11);
883 @end example
885 @item Out of bounds-error in global or local arrays:
886 @example
888     int tab[10];
889     for(i=0;i<11;i++) @{
890         sum += tab[i];
891     @}
893 @end example
895 @item Out of bounds-error in malloc'ed data:
896 @example
898     int *tab;
899     tab = malloc(20 * sizeof(int));
900     for(i=0;i<21;i++) @{
901         sum += tab4[i];
902     @}
903     free(tab);
905 @end example
907 @item Access of freed memory:
908 @example
910     int *tab;
911     tab = malloc(20 * sizeof(int));
912     free(tab);
913     for(i=0;i<20;i++) @{
914         sum += tab4[i];
915     @}
917 @end example
919 @item Double free:
920 @example
922     int *tab;
923     tab = malloc(20 * sizeof(int));
924     free(tab);
925     free(tab);
927 @end example
929 @end table
931 @node Libtcc
932 @chapter The @code{libtcc} library
934 The @code{libtcc} library enables you to use TCC as a backend for
935 dynamic code generation. 
937 Read the @file{libtcc.h} to have an overview of the API. Read
938 @file{libtcc_test.c} to have a very simple example.
940 The idea consists in giving a C string containing the program you want
941 to compile directly to @code{libtcc}. Then you can access to any global
942 symbol (function or variable) defined.
944 @node devel
945 @chapter Developer's guide
947 This chapter gives some hints to understand how TCC works. You can skip
948 it if you do not intend to modify the TCC code.
950 @section File reading
952 The @code{BufferedFile} structure contains the context needed to read a
953 file, including the current line number. @code{tcc_open()} opens a new
954 file and @code{tcc_close()} closes it. @code{inp()} returns the next
955 character.
957 @section Lexer
959 @code{next()} reads the next token in the current
960 file. @code{next_nomacro()} reads the next token without macro
961 expansion.
963 @code{tok} contains the current token (see @code{TOK_xxx})
964 constants. Identifiers and keywords are also keywords. @code{tokc}
965 contains additional infos about the token (for example a constant value
966 if number or string token).
968 @section Parser
970 The parser is hardcoded (yacc is not necessary). It does only one pass,
971 except:
973 @itemize
975 @item For initialized arrays with unknown size, a first pass 
976 is done to count the number of elements.
978 @item For architectures where arguments are evaluated in 
979 reverse order, a first pass is done to reverse the argument order.
981 @end itemize
983 @section Types
985 The types are stored in a single 'int' variable. It was chosen in the
986 first stages of development when tcc was much simpler. Now, it may not
987 be the best solution.
989 @example
990 #define VT_INT        0  /* integer type */
991 #define VT_BYTE       1  /* signed byte type */
992 #define VT_SHORT      2  /* short type */
993 #define VT_VOID       3  /* void type */
994 #define VT_PTR        4  /* pointer */
995 #define VT_ENUM       5  /* enum definition */
996 #define VT_FUNC       6  /* function type */
997 #define VT_STRUCT     7  /* struct/union definition */
998 #define VT_FLOAT      8  /* IEEE float */
999 #define VT_DOUBLE     9  /* IEEE double */
1000 #define VT_LDOUBLE   10  /* IEEE long double */
1001 #define VT_BOOL      11  /* ISOC99 boolean type */
1002 #define VT_LLONG     12  /* 64 bit integer */
1003 #define VT_LONG      13  /* long integer (NEVER USED as type, only
1004                             during parsing) */
1005 #define VT_BTYPE      0x000f /* mask for basic type */
1006 #define VT_UNSIGNED   0x0010  /* unsigned type */
1007 #define VT_ARRAY      0x0020  /* array type (also has VT_PTR) */
1008 #define VT_VLA        0x20000 /* VLA type (also has VT_PTR and VT_ARRAY) */
1009 #define VT_BITFIELD   0x0040  /* bitfield modifier */
1010 #define VT_CONSTANT   0x0800  /* const modifier */
1011 #define VT_VOLATILE   0x1000  /* volatile modifier */
1012 #define VT_DEFSIGN    0x2000  /* signed type */
1014 #define VT_STRUCT_SHIFT 18   /* structure/enum name shift (14 bits left) */
1015 @end example
1017 When a reference to another type is needed (for pointers, functions and
1018 structures), the @code{32 - VT_STRUCT_SHIFT} high order bits are used to
1019 store an identifier reference.
1021 The @code{VT_UNSIGNED} flag can be set for chars, shorts, ints and long
1022 longs.
1024 Arrays are considered as pointers @code{VT_PTR} with the flag
1025 @code{VT_ARRAY} set. Variable length arrays are considered as special
1026 arrays and have flag @code{VT_VLA} set instead of @code{VT_ARRAY}.
1028 The @code{VT_BITFIELD} flag can be set for chars, shorts, ints and long
1029 longs. If it is set, then the bitfield position is stored from bits
1030 VT_STRUCT_SHIFT to VT_STRUCT_SHIFT + 5 and the bit field size is stored
1031 from bits VT_STRUCT_SHIFT + 6 to VT_STRUCT_SHIFT + 11.
1033 @code{VT_LONG} is never used except during parsing.
1035 During parsing, the storage of an object is also stored in the type
1036 integer:
1038 @example
1039 #define VT_EXTERN  0x00000080  /* extern definition */
1040 #define VT_STATIC  0x00000100  /* static variable */
1041 #define VT_TYPEDEF 0x00000200  /* typedef definition */
1042 #define VT_INLINE  0x00000400  /* inline definition */
1043 #define VT_IMPORT  0x00004000  /* win32: extern data imported from dll */
1044 #define VT_EXPORT  0x00008000  /* win32: data exported from dll */
1045 #define VT_WEAK    0x00010000  /* win32: data exported from dll */
1046 @end example
1048 @section Symbols
1050 All symbols are stored in hashed symbol stacks. Each symbol stack
1051 contains @code{Sym} structures.
1053 @code{Sym.v} contains the symbol name (remember
1054 an identifier is also a token, so a string is never necessary to store
1055 it). @code{Sym.t} gives the type of the symbol. @code{Sym.r} is usually
1056 the register in which the corresponding variable is stored. @code{Sym.c} is
1057 usually a constant associated to the symbol like its address for normal
1058 symbols, and the number of entries for symbols representing arrays.
1059 Variable length array types use @code{Sym.c} as a location on the stack
1060 which holds the runtime sizeof for the type.
1062 Four main symbol stacks are defined:
1064 @table @code
1066 @item define_stack
1067 for the macros (@code{#define}s).
1069 @item global_stack
1070 for the global variables, functions and types.
1072 @item local_stack
1073 for the local variables, functions and types.
1075 @item global_label_stack
1076 for the local labels (for @code{goto}).
1078 @item label_stack
1079 for GCC block local labels (see the @code{__label__} keyword).
1081 @end table
1083 @code{sym_push()} is used to add a new symbol in the local symbol
1084 stack. If no local symbol stack is active, it is added in the global
1085 symbol stack.
1087 @code{sym_pop(st,b)} pops symbols from the symbol stack @var{st} until
1088 the symbol @var{b} is on the top of stack. If @var{b} is NULL, the stack
1089 is emptied.
1091 @code{sym_find(v)} return the symbol associated to the identifier
1092 @var{v}. The local stack is searched first from top to bottom, then the
1093 global stack.
1095 @section Sections
1097 The generated code and data are written in sections. The structure
1098 @code{Section} contains all the necessary information for a given
1099 section. @code{new_section()} creates a new section. ELF file semantics
1100 is assumed for each section.
1102 The following sections are predefined:
1104 @table @code
1106 @item text_section
1107 is the section containing the generated code. @var{ind} contains the
1108 current position in the code section.
1110 @item data_section
1111 contains initialized data
1113 @item bss_section
1114 contains uninitialized data
1116 @item bounds_section
1117 @itemx lbounds_section
1118 are used when bound checking is activated
1120 @item stab_section
1121 @itemx stabstr_section
1122 are used when debugging is active to store debug information
1124 @item symtab_section
1125 @itemx strtab_section
1126 contain the exported symbols (currently only used for debugging).
1128 @end table
1130 @section Code generation
1131 @cindex code generation
1133 @subsection Introduction
1135 The TCC code generator directly generates linked binary code in one
1136 pass. It is rather unusual these days (see gcc for example which
1137 generates text assembly), but it can be very fast and surprisingly
1138 little complicated.
1140 The TCC code generator is register based. Optimization is only done at
1141 the expression level. No intermediate representation of expression is
1142 kept except the current values stored in the @emph{value stack}.
1144 On x86, three temporary registers are used. When more registers are
1145 needed, one register is spilled into a new temporary variable on the stack.
1147 @subsection The value stack
1148 @cindex value stack, introduction
1150 When an expression is parsed, its value is pushed on the value stack
1151 (@var{vstack}). The top of the value stack is @var{vtop}. Each value
1152 stack entry is the structure @code{SValue}.
1154 @code{SValue.t} is the type. @code{SValue.r} indicates how the value is
1155 currently stored in the generated code. It is usually a CPU register
1156 index (@code{REG_xxx} constants), but additional values and flags are
1157 defined:
1159 @example
1160 #define VT_CONST     0x00f0
1161 #define VT_LLOCAL    0x00f1
1162 #define VT_LOCAL     0x00f2
1163 #define VT_CMP       0x00f3
1164 #define VT_JMP       0x00f4
1165 #define VT_JMPI      0x00f5
1166 #define VT_LVAL      0x0100
1167 #define VT_SYM       0x0200
1168 #define VT_MUSTCAST  0x0400
1169 #define VT_MUSTBOUND 0x0800
1170 #define VT_BOUNDED   0x8000
1171 #define VT_LVAL_BYTE     0x1000
1172 #define VT_LVAL_SHORT    0x2000
1173 #define VT_LVAL_UNSIGNED 0x4000
1174 #define VT_LVAL_TYPE     (VT_LVAL_BYTE | VT_LVAL_SHORT | VT_LVAL_UNSIGNED)
1175 @end example
1177 @table @code
1179 @item VT_CONST
1180 indicates that the value is a constant. It is stored in the union
1181 @code{SValue.c}, depending on its type.
1183 @item VT_LOCAL
1184 indicates a local variable pointer at offset @code{SValue.c.i} in the
1185 stack.
1187 @item VT_CMP
1188 indicates that the value is actually stored in the CPU flags (i.e. the
1189 value is the consequence of a test). The value is either 0 or 1. The
1190 actual CPU flags used is indicated in @code{SValue.c.i}. 
1192 If any code is generated which destroys the CPU flags, this value MUST be
1193 put in a normal register.
1195 @item VT_JMP
1196 @itemx VT_JMPI
1197 indicates that the value is the consequence of a conditional jump. For VT_JMP,
1198 it is 1 if the jump is taken, 0 otherwise. For VT_JMPI it is inverted.
1200 These values are used to compile the @code{||} and @code{&&} logical
1201 operators.
1203 If any code is generated, this value MUST be put in a normal
1204 register. Otherwise, the generated code won't be executed if the jump is
1205 taken.
1207 @item VT_LVAL
1208 is a flag indicating that the value is actually an lvalue (left value of
1209 an assignment). It means that the value stored is actually a pointer to
1210 the wanted value. 
1212 Understanding the use @code{VT_LVAL} is very important if you want to
1213 understand how TCC works.
1215 @item VT_LVAL_BYTE
1216 @itemx VT_LVAL_SHORT
1217 @itemx VT_LVAL_UNSIGNED
1218 if the lvalue has an integer type, then these flags give its real
1219 type. The type alone is not enough in case of cast optimisations.
1221 @item VT_LLOCAL
1222 is a saved lvalue on the stack. @code{VT_LVAL} must also be set with
1223 @code{VT_LLOCAL}. @code{VT_LLOCAL} can arise when a @code{VT_LVAL} in
1224 a register has to be saved to the stack, or it can come from an
1225 architecture-specific calling convention.
1227 @item VT_MUSTCAST
1228 indicates that a cast to the value type must be performed if the value
1229 is used (lazy casting).
1231 @item VT_SYM
1232 indicates that the symbol @code{SValue.sym} must be added to the constant.
1234 @item VT_MUSTBOUND
1235 @itemx VT_BOUNDED
1236 are only used for optional bound checking.
1238 @end table
1240 @subsection Manipulating the value stack
1241 @cindex value stack
1243 @code{vsetc()} and @code{vset()} pushes a new value on the value
1244 stack. If the previous @var{vtop} was stored in a very unsafe place(for
1245 example in the CPU flags), then some code is generated to put the
1246 previous @var{vtop} in a safe storage.
1248 @code{vpop()} pops @var{vtop}. In some cases, it also generates cleanup
1249 code (for example if stacked floating point registers are used as on
1250 x86).
1252 The @code{gv(rc)} function generates code to evaluate @var{vtop} (the
1253 top value of the stack) into registers. @var{rc} selects in which
1254 register class the value should be put. @code{gv()} is the @emph{most
1255 important function} of the code generator.
1257 @code{gv2()} is the same as @code{gv()} but for the top two stack
1258 entries.
1260 @subsection CPU dependent code generation
1261 @cindex CPU dependent
1262 See the @file{i386-gen.c} file to have an example.
1264 @table @code
1266 @item load()
1267 must generate the code needed to load a stack value into a register.
1269 @item store()
1270 must generate the code needed to store a register into a stack value
1271 lvalue.
1273 @item gfunc_start()
1274 @itemx gfunc_param()
1275 @itemx gfunc_call()
1276 should generate a function call
1278 @item gfunc_prolog()
1279 @itemx gfunc_epilog()
1280 should generate a function prolog/epilog.
1282 @item gen_opi(op)
1283 must generate the binary integer operation @var{op} on the two top
1284 entries of the stack which are guaranteed to contain integer types.
1286 The result value should be put on the stack.
1288 @item gen_opf(op)
1289 same as @code{gen_opi()} for floating point operations. The two top
1290 entries of the stack are guaranteed to contain floating point values of
1291 same types.
1293 @item gen_cvt_itof()
1294 integer to floating point conversion.
1296 @item gen_cvt_ftoi()
1297 floating point to integer conversion.
1299 @item gen_cvt_ftof()
1300 floating point to floating point of different size conversion.
1302 @item gen_bounded_ptr_add()
1303 @item gen_bounded_ptr_deref()
1304 are only used for bounds checking.
1306 @end table
1308 @section Optimizations done
1309 @cindex optimizations
1310 @cindex constant propagation
1311 @cindex strength reduction
1312 @cindex comparison operators
1313 @cindex caching processor flags
1314 @cindex flags, caching
1315 @cindex jump optimization
1316 Constant propagation is done for all operations. Multiplications and
1317 divisions are optimized to shifts when appropriate. Comparison
1318 operators are optimized by maintaining a special cache for the
1319 processor flags. &&, || and ! are optimized by maintaining a special
1320 'jump target' value. No other jump optimization is currently performed
1321 because it would require to store the code in a more abstract fashion.
1323 @unnumbered Concept Index
1324 @printindex cp
1326 @bye
1328 @c Local variables:
1329 @c fill-column: 78
1330 @c texinfo-column-for-description: 32
1331 @c End: