win32: enable bounds checker & exception handler
[tinycc.git] / tcc-doc.texi
blobf325e3656375acbf7dc5594daeb45ecb72dd3bb5
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @setfilename tcc-doc.info
4 @settitle Tiny C Compiler Reference Documentation
5 @c %**end of header
7 @include config.texi
9 @iftex
10 @titlepage
11 @afourpaper
12 @sp 7
13 @center @titlefont{Tiny C Compiler Reference Documentation}
14 @sp 3
15 @end titlepage
16 @headings double
17 @end iftex
19 @contents
21 @node Top, Introduction, (dir), (dir)
22 @top Tiny C Compiler Reference Documentation
24 This manual documents version @value{VERSION} of the Tiny C Compiler.
26 @menu
27 * Introduction::                Introduction to tcc.
28 * Invoke::                      Invocation of tcc (command line, options).
29 * Clang::                       ANSI C and extensions.
30 * asm::                         Assembler syntax.
31 * linker::                      Output file generation and supported targets.
32 * Bounds::                      Automatic bounds-checking of C code.
33 * Libtcc::                      The libtcc library.
34 * devel::                       Guide for Developers.
35 @end menu
38 @node Introduction
39 @chapter Introduction
41 TinyCC (aka TCC) is a small but hyper fast C compiler. Unlike other C
42 compilers, it is meant to be self-relying: you do not need an
43 external assembler or linker because TCC does that for you.
45 TCC compiles so @emph{fast} that even for big projects @code{Makefile}s may
46 not be necessary.
48 TCC not only supports ANSI C, but also most of the new ISO C99
49 standard and many GNUC extensions including inline assembly.
51 TCC can also be used to make @emph{C scripts}, i.e. pieces of C source
52 that you run as a Perl or Python script. Compilation is so fast that
53 your script will be as fast as if it was an executable.
55 TCC can also automatically generate memory and bound checks
56 (@pxref{Bounds}) while allowing all C pointers operations. TCC can do
57 these checks even if non patched libraries are used.
59 With @code{libtcc}, you can use TCC as a backend for dynamic code
60 generation (@pxref{Libtcc}).
62 TCC mainly supports the i386 target on Linux and Windows. There are alpha
63 ports for the ARM (@code{arm-tcc}) and the TMS320C67xx targets
64 (@code{c67-tcc}). More information about the ARM port is available at
65 @url{http://lists.gnu.org/archive/html/tinycc-devel/2003-10/msg00044.html}.
67 For usage on Windows, see also tcc-win32.txt.
69 @node Invoke
70 @chapter Command line invocation
72 @section Quick start
74 @example
75 @c man begin SYNOPSIS
76 usage: tcc [options] [@var{infile1} @var{infile2}@dots{}] [@option{-run} @var{infile} @var{args}@dots{}]
77 @c man end
78 @end example
80 @noindent
81 @c man begin DESCRIPTION
82 TCC options are a very much like gcc options. The main difference is that TCC
83 can also execute directly the resulting program and give it runtime
84 arguments.
86 Here are some examples to understand the logic:
88 @table @code
89 @item @samp{tcc -run a.c}
90 Compile @file{a.c} and execute it directly
92 @item @samp{tcc -run a.c arg1}
93 Compile a.c and execute it directly. arg1 is given as first argument to
94 the @code{main()} of a.c.
96 @item @samp{tcc a.c -run b.c arg1}
97 Compile @file{a.c} and @file{b.c}, link them together and execute them. arg1 is given
98 as first argument to the @code{main()} of the resulting program. 
99 @ignore 
100 Because multiple C files are specified, @option{--} are necessary to clearly 
101 separate the program arguments from the TCC options.
102 @end ignore
104 @item @samp{tcc -o myprog a.c b.c}
105 Compile @file{a.c} and @file{b.c}, link them and generate the executable @file{myprog}.
107 @item @samp{tcc -o myprog a.o b.o}
108 link @file{a.o} and @file{b.o} together and generate the executable @file{myprog}.
110 @item @samp{tcc -c a.c}
111 Compile @file{a.c} and generate object file @file{a.o}.
113 @item @samp{tcc -c asmfile.S}
114 Preprocess with C preprocess and assemble @file{asmfile.S} and generate
115 object file @file{asmfile.o}.
117 @item @samp{tcc -c asmfile.s}
118 Assemble (but not preprocess) @file{asmfile.s} and generate object file
119 @file{asmfile.o}.
121 @item @samp{tcc -r -o ab.o a.c b.c}
122 Compile @file{a.c} and @file{b.c}, link them together and generate the object file @file{ab.o}.
124 @end table
126 Scripting:
128 TCC can be invoked from @emph{scripts}, just as shell scripts. You just
129 need to add @code{#!/usr/local/bin/tcc -run} at the start of your C source:
131 @example
132 #!/usr/local/bin/tcc -run
133 #include <stdio.h>
135 int main() 
137     printf("Hello World\n");
138     return 0;
140 @end example
142 TCC can read C source code from @emph{standard input} when @option{-} is used in 
143 place of @option{infile}. Example:
145 @example
146 echo 'main()@{puts("hello");@}' | tcc -run -
147 @end example
148 @c man end
150 @section Option summary
152 General Options:
154 @c man begin OPTIONS
155 @table @option
156 @item -v
157 Display current TCC version, increase verbosity.
159 @item -print-search-dirs
160 Print the name of the configured installation directory and a list
161 of program and library directories tcc will search.
163 @item -c
164 Generate an object file (@option{-o} option must also be given).
166 @item -o outfile
167 Put object file, executable, or dll into output file @file{outfile}.
169 @item -Bdir
170 Set the path where the tcc internal libraries can be found (default is
171 @file{PREFIX/lib/tcc}).
173 @item -bench
174 Output compilation statistics.
176 @item -run source [args...]
177 Compile file @var{source} and run it with the command line arguments
178 @var{args}. In order to be able to give more than one argument to a
179 script, several TCC options can be given @emph{after} the
180 @option{-run} option, separated by spaces. Example:
182 @example
183 tcc "-run -L/usr/X11R6/lib -lX11" ex4.c
184 @end example
186 In a script, it gives the following header:
188 @example
189 #!/usr/local/bin/tcc -run -L/usr/X11R6/lib -lX11
190 #include <stdlib.h>
191 int main(int argc, char **argv)
193     ...
195 @end example
197 @end table
199 Preprocessor options:
201 @table @option
202 @item -Idir
203 Specify an additional include path. Include paths are searched in the
204 order they are specified.
206 System include paths are always searched after. The default system
207 include paths are: @file{/usr/local/include}, @file{/usr/include}
208 and @file{PREFIX/lib/tcc/include}. (@file{PREFIX} is usually
209 @file{/usr} or @file{/usr/local}).
211 @item -Dsym[=val]
212 Define preprocessor symbol @samp{sym} to
213 val. If val is not present, its value is @samp{1}. Function-like macros can
214 also be defined: @option{-DF(a)=a+1}
216 @item -Usym
217 Undefine preprocessor symbol @samp{sym}.
218 @end table
220 Compilation flags:
222 Note: each of the following warning options has a negative form beginning with
223 @option{-fno-}.
225 @table @option
226 @item -funsigned-char
227 Let the @code{char} type be unsigned.
229 @item -fsigned-char
230 Let the @code{char} type be signed.
232 @item -fno-common
233 Do not generate common symbols for uninitialized data.
235 @item -fleading-underscore
236 Add a leading underscore at the beginning of each C symbol.
238 @end table
240 Warning options:
242 @table @option
243 @item -w
244 Disable all warnings.
246 @end table
248 Note: each of the following warning options has a negative form beginning with
249 @option{-Wno-}.
251 @table @option
252 @item -Wimplicit-function-declaration
253 Warn about implicit function declaration.
255 @item -Wunsupported
256 Warn about unsupported GCC features that are ignored by TCC.
258 @item -Wwrite-strings
259 Make string constants be of type @code{const char *} instead of @code{char
262 @item -Werror
263 Abort compilation if warnings are issued.
265 @item -Wall 
266 Activate all warnings, except @option{-Werror}, @option{-Wunusupported} and
267 @option{-Wwrite-strings}.
269 @end table
271 Linker options:
273 @table @option
274 @item -Ldir
275 Specify an additional static library path for the @option{-l} option. The
276 default library paths are @file{/usr/local/lib}, @file{/usr/lib} and @file{/lib}.
278 @item -lxxx
279 Link your program with dynamic library libxxx.so or static library
280 libxxx.a. The library is searched in the paths specified by the
281 @option{-L} option.
283 @item -shared
284 Generate a shared library instead of an executable (@option{-o} option
285 must also be given).
287 @item -soname name
288 set name for shared library to be used at runtime
290 @item -static
291 Generate a statically linked executable (default is a shared linked
292 executable) (@option{-o} option must also be given).
294 @item -rdynamic
295 Export global symbols to the dynamic linker. It is useful when a library
296 opened with @code{dlopen()} needs to access executable symbols.
298 @item -r
299 Generate an object file combining all input files (@option{-o} option must
300 also be given).
302 @item -Wl,-Ttext,address
303 Set the start of the .text section to @var{address}.
305 @item -Wl,--oformat,fmt
306 Use @var{fmt} as output format. The supported output formats are:
307 @table @code
308 @item elf32-i386
309 ELF output format (default)
310 @item binary
311 Binary image (only for executable output)
312 @item coff
313 COFF output format (only for executable output for TMS320C67xx target)
314 @end table
316 @item -Wl,-rpath=path
317 Set custom library search path
319 @end table
321 Debugger options:
323 @table @option
324 @item -g
325 Generate run time debug information so that you get clear run time
326 error messages: @code{ test.c:68: in function 'test5()': dereferencing
327 invalid pointer} instead of the laconic @code{Segmentation
328 fault}.
330 @item -b
331 Generate additional support code to check
332 memory allocations and array/pointer bounds. @option{-g} is implied. Note
333 that the generated code is slower and bigger in this case.
335 @item -bt N
336 Display N callers in stack traces. This is useful with @option{-g} or
337 @option{-b}.
339 @end table
341 Note: GCC options @option{-Ox}, @option{-fx} and @option{-mx} are
342 ignored.
343 @c man end
345 @ignore
347 @setfilename tcc
348 @settitle Tiny C Compiler
350 @c man begin SEEALSO
351 gcc(1)
352 @c man end
354 @c man begin AUTHOR
355 Fabrice Bellard
356 @c man end
358 @end ignore
360 @node Clang
361 @chapter C language support
363 @section ANSI C
365 TCC implements all the ANSI C standard, including structure bit fields
366 and floating point numbers (@code{long double}, @code{double}, and
367 @code{float} fully supported).
369 @section ISOC99 extensions
371 TCC implements many features of the new C standard: ISO C99. Currently
372 missing items are: complex and imaginary numbers and variable length
373 arrays.
375 Currently implemented ISOC99 features:
377 @itemize
379 @item 64 bit @code{long long} types are fully supported.
381 @item The boolean type @code{_Bool} is supported.
383 @item @code{__func__} is a string variable containing the current
384 function name.
386 @item Variadic macros: @code{__VA_ARGS__} can be used for
387    function-like macros:
388 @example
389     #define dprintf(level, __VA_ARGS__) printf(__VA_ARGS__)
390 @end example
392 @noindent
393 @code{dprintf} can then be used with a variable number of parameters.
395 @item Declarations can appear anywhere in a block (as in C++).
397 @item Array and struct/union elements can be initialized in any order by
398   using designators:
399 @example
400     struct @{ int x, y; @} st[10] = @{ [0].x = 1, [0].y = 2 @};
402     int tab[10] = @{ 1, 2, [5] = 5, [9] = 9@};
403 @end example
404     
405 @item Compound initializers are supported:
406 @example
407     int *p = (int [])@{ 1, 2, 3 @};
408 @end example
409 to initialize a pointer pointing to an initialized array. The same
410 works for structures and strings.
412 @item Hexadecimal floating point constants are supported:
413 @example
414           double d = 0x1234p10;
415 @end example
417 @noindent
418 is the same as writing 
419 @example
420           double d = 4771840.0;
421 @end example
423 @item @code{inline} keyword is ignored.
425 @item @code{restrict} keyword is ignored.
426 @end itemize
428 @section GNU C extensions
430 TCC implements some GNU C extensions:
432 @itemize
434 @item array designators can be used without '=': 
435 @example
436     int a[10] = @{ [0] 1, [5] 2, 3, 4 @};
437 @end example
439 @item Structure field designators can be a label: 
440 @example
441     struct @{ int x, y; @} st = @{ x: 1, y: 1@};
442 @end example
443 instead of
444 @example
445     struct @{ int x, y; @} st = @{ .x = 1, .y = 1@};
446 @end example
448 @item @code{\e} is ASCII character 27.
450 @item case ranges : ranges can be used in @code{case}s:
451 @example
452     switch(a) @{
453     case 1 @dots{} 9:
454           printf("range 1 to 9\n");
455           break;
456     default:
457           printf("unexpected\n");
458           break;
459     @}
460 @end example
462 @cindex aligned attribute
463 @cindex packed attribute
464 @cindex section attribute
465 @cindex unused attribute
466 @cindex cdecl attribute
467 @cindex stdcall attribute
468 @cindex regparm attribute
469 @cindex dllexport attribute
471 @item The keyword @code{__attribute__} is handled to specify variable or
472 function attributes. The following attributes are supported:
473   @itemize
475   @item @code{aligned(n)}: align a variable or a structure field to n bytes
476 (must be a power of two).
478   @item @code{packed}: force alignment of a variable or a structure field to
479   1.
481   @item @code{section(name)}: generate function or data in assembly section
482 name (name is a string containing the section name) instead of the default
483 section.
485   @item @code{unused}: specify that the variable or the function is unused.
487   @item @code{cdecl}: use standard C calling convention (default).
489   @item @code{stdcall}: use Pascal-like calling convention.
491   @item @code{regparm(n)}: use fast i386 calling convention. @var{n} must be
492 between 1 and 3. The first @var{n} function parameters are respectively put in
493 registers @code{%eax}, @code{%edx} and @code{%ecx}.
495   @item @code{dllexport}: export function from dll/executable (win32 only)
497   @end itemize
499 Here are some examples:
500 @example
501     int a __attribute__ ((aligned(8), section(".mysection")));
502 @end example
504 @noindent
505 align variable @code{a} to 8 bytes and put it in section @code{.mysection}.
507 @example
508     int my_add(int a, int b) __attribute__ ((section(".mycodesection"))) 
509     @{
510         return a + b;
511     @}
512 @end example
514 @noindent
515 generate function @code{my_add} in section @code{.mycodesection}.
517 @item GNU style variadic macros:
518 @example
519     #define dprintf(fmt, args@dots{}) printf(fmt, ## args)
521     dprintf("no arg\n");
522     dprintf("one arg %d\n", 1);
523 @end example
525 @item @code{__FUNCTION__} is interpreted as C99 @code{__func__} 
526 (so it has not exactly the same semantics as string literal GNUC
527 where it is a string literal).
529 @item The @code{__alignof__} keyword can be used as @code{sizeof} 
530 to get the alignment of a type or an expression.
532 @item The @code{typeof(x)} returns the type of @code{x}. 
533 @code{x} is an expression or a type.
535 @item Computed gotos: @code{&&label} returns a pointer of type 
536 @code{void *} on the goto label @code{label}. @code{goto *expr} can be
537 used to jump on the pointer resulting from @code{expr}.
539 @item Inline assembly with asm instruction:
540 @cindex inline assembly
541 @cindex assembly, inline
542 @cindex __asm__
543 @example
544 static inline void * my_memcpy(void * to, const void * from, size_t n)
546 int d0, d1, d2;
547 __asm__ __volatile__(
548         "rep ; movsl\n\t"
549         "testb $2,%b4\n\t"
550         "je 1f\n\t"
551         "movsw\n"
552         "1:\ttestb $1,%b4\n\t"
553         "je 2f\n\t"
554         "movsb\n"
555         "2:"
556         : "=&c" (d0), "=&D" (d1), "=&S" (d2)
557         :"0" (n/4), "q" (n),"1" ((long) to),"2" ((long) from)
558         : "memory");
559 return (to);
561 @end example
563 @noindent
564 @cindex gas
565 TCC includes its own x86 inline assembler with a @code{gas}-like (GNU
566 assembler) syntax. No intermediate files are generated. GCC 3.x named
567 operands are supported.
569 @item @code{__builtin_types_compatible_p()} and @code{__builtin_constant_p()} 
570 are supported.
572 @item @code{#pragma pack} is supported for win32 compatibility.
574 @end itemize
576 @section TinyCC extensions
578 @itemize
580 @item @code{__TINYC__} is a predefined macro to @code{1} to
581 indicate that you use TCC.
583 @item @code{#!} at the start of a line is ignored to allow scripting.
585 @item Binary digits can be entered (@code{0b101} instead of
586 @code{5}).
588 @item @code{__BOUNDS_CHECKING_ON} is defined if bound checking is activated.
590 @end itemize
592 @node asm
593 @chapter TinyCC Assembler
595 Since version 0.9.16, TinyCC integrates its own assembler. TinyCC
596 assembler supports a gas-like syntax (GNU assembler). You can
597 desactivate assembler support if you want a smaller TinyCC executable
598 (the C compiler does not rely on the assembler).
600 TinyCC Assembler is used to handle files with @file{.S} (C
601 preprocessed assembler) and @file{.s} extensions. It is also used to
602 handle the GNU inline assembler with the @code{asm} keyword.
604 @section Syntax
606 TinyCC Assembler supports most of the gas syntax. The tokens are the
607 same as C.
609 @itemize
611 @item C and C++ comments are supported.
613 @item Identifiers are the same as C, so you cannot use '.' or '$'.
615 @item Only 32 bit integer numbers are supported.
617 @end itemize
619 @section Expressions
621 @itemize
623 @item Integers in decimal, octal and hexa are supported.
625 @item Unary operators: +, -, ~.
627 @item Binary operators in decreasing priority order:
629 @enumerate
630 @item *, /, %
631 @item &, |, ^
632 @item +, -
633 @end enumerate
635 @item A value is either an absolute number or a label plus an offset. 
636 All operators accept absolute values except '+' and '-'. '+' or '-' can be
637 used to add an offset to a label. '-' supports two labels only if they
638 are the same or if they are both defined and in the same section.
640 @end itemize
642 @section Labels
644 @itemize
646 @item All labels are considered as local, except undefined ones.
648 @item Numeric labels can be used as local @code{gas}-like labels. 
649 They can be defined several times in the same source. Use 'b'
650 (backward) or 'f' (forward) as suffix to reference them:
652 @example
653  1:
654       jmp 1b /* jump to '1' label before */
655       jmp 1f /* jump to '1' label after */
656  1:
657 @end example
659 @end itemize
661 @section Directives
662 @cindex assembler directives
663 @cindex directives, assembler
664 @cindex align directive
665 @cindex skip directive
666 @cindex space directive
667 @cindex byte directive
668 @cindex word directive
669 @cindex short directive
670 @cindex int directive
671 @cindex long directive
672 @cindex quad directive
673 @cindex globl directive
674 @cindex global directive
675 @cindex section directive
676 @cindex text directive
677 @cindex data directive
678 @cindex bss directive
679 @cindex fill directive
680 @cindex org directive
681 @cindex previous directive
682 @cindex string directive
683 @cindex asciz directive
684 @cindex ascii directive
686 All directives are preceeded by a '.'. The following directives are
687 supported:
689 @itemize
690 @item .align n[,value]
691 @item .skip n[,value]
692 @item .space n[,value]
693 @item .byte value1[,...]
694 @item .word value1[,...]
695 @item .short value1[,...]
696 @item .int value1[,...]
697 @item .long value1[,...]
698 @item .quad immediate_value1[,...]
699 @item .globl symbol
700 @item .global symbol
701 @item .section section
702 @item .text
703 @item .data
704 @item .bss
705 @item .fill repeat[,size[,value]]
706 @item .org n
707 @item .previous
708 @item .string string[,...]
709 @item .asciz string[,...]
710 @item .ascii string[,...]
711 @end itemize
713 @section X86 Assembler
714 @cindex assembler
716 All X86 opcodes are supported. Only ATT syntax is supported (source
717 then destination operand order). If no size suffix is given, TinyCC
718 tries to guess it from the operand sizes.
720 Currently, MMX opcodes are supported but not SSE ones.
722 @node linker
723 @chapter TinyCC Linker
724 @cindex linker
726 @section ELF file generation
727 @cindex ELF
729 TCC can directly output relocatable ELF files (object files),
730 executable ELF files and dynamic ELF libraries without relying on an
731 external linker.
733 Dynamic ELF libraries can be output but the C compiler does not generate
734 position independent code (PIC). It means that the dynamic library
735 code generated by TCC cannot be factorized among processes yet.
737 TCC linker eliminates unreferenced object code in libraries. A single pass is
738 done on the object and library list, so the order in which object files and
739 libraries are specified is important (same constraint as GNU ld). No grouping
740 options (@option{--start-group} and @option{--end-group}) are supported.
742 @section ELF file loader
744 TCC can load ELF object files, archives (.a files) and dynamic
745 libraries (.so).
747 @section PE-i386 file generation
748 @cindex PE-i386
750 TCC for Windows supports the native Win32 executable file format (PE-i386).  It
751 generates EXE files (console and gui) and DLL files.
753 For usage on Windows, see also tcc-win32.txt.
755 @section GNU Linker Scripts
756 @cindex scripts, linker
757 @cindex linker scripts
758 @cindex GROUP, linker command
759 @cindex FILE, linker command
760 @cindex OUTPUT_FORMAT, linker command
761 @cindex TARGET, linker command
763 Because on many Linux systems some dynamic libraries (such as
764 @file{/usr/lib/libc.so}) are in fact GNU ld link scripts (horrible!),
765 the TCC linker also supports a subset of GNU ld scripts.
767 The @code{GROUP} and @code{FILE} commands are supported. @code{OUTPUT_FORMAT}
768 and @code{TARGET} are ignored.
770 Example from @file{/usr/lib/libc.so}:
771 @example
772 /* GNU ld script
773    Use the shared library, but some functions are only in
774    the static library, so try that secondarily.  */
775 GROUP ( /lib/libc.so.6 /usr/lib/libc_nonshared.a )
776 @end example
778 @node Bounds
779 @chapter TinyCC Memory and Bound checks
780 @cindex bound checks
781 @cindex memory checks
783 This feature is activated with the @option{-b} (@pxref{Invoke}).
785 Note that pointer size is @emph{unchanged} and that code generated
786 with bound checks is @emph{fully compatible} with unchecked
787 code. When a pointer comes from unchecked code, it is assumed to be
788 valid. Even very obscure C code with casts should work correctly.
790 For more information about the ideas behind this method, see
791 @url{http://www.doc.ic.ac.uk/~phjk/BoundsChecking.html}.
793 Here are some examples of caught errors:
795 @table @asis
797 @item Invalid range with standard string function:
798 @example
800     char tab[10];
801     memset(tab, 0, 11);
803 @end example
805 @item Out of bounds-error in global or local arrays:
806 @example
808     int tab[10];
809     for(i=0;i<11;i++) @{
810         sum += tab[i];
811     @}
813 @end example
815 @item Out of bounds-error in malloc'ed data:
816 @example
818     int *tab;
819     tab = malloc(20 * sizeof(int));
820     for(i=0;i<21;i++) @{
821         sum += tab4[i];
822     @}
823     free(tab);
825 @end example
827 @item Access of freed memory:
828 @example
830     int *tab;
831     tab = malloc(20 * sizeof(int));
832     free(tab);
833     for(i=0;i<20;i++) @{
834         sum += tab4[i];
835     @}
837 @end example
839 @item Double free:
840 @example
842     int *tab;
843     tab = malloc(20 * sizeof(int));
844     free(tab);
845     free(tab);
847 @end example
849 @end table
851 @node Libtcc
852 @chapter The @code{libtcc} library
854 The @code{libtcc} library enables you to use TCC as a backend for
855 dynamic code generation. 
857 Read the @file{libtcc.h} to have an overview of the API. Read
858 @file{libtcc_test.c} to have a very simple example.
860 The idea consists in giving a C string containing the program you want
861 to compile directly to @code{libtcc}. Then you can access to any global
862 symbol (function or variable) defined.
864 @node devel
865 @chapter Developer's guide
867 This chapter gives some hints to understand how TCC works. You can skip
868 it if you do not intend to modify the TCC code.
870 @section File reading
872 The @code{BufferedFile} structure contains the context needed to read a
873 file, including the current line number. @code{tcc_open()} opens a new
874 file and @code{tcc_close()} closes it. @code{inp()} returns the next
875 character.
877 @section Lexer
879 @code{next()} reads the next token in the current
880 file. @code{next_nomacro()} reads the next token without macro
881 expansion.
883 @code{tok} contains the current token (see @code{TOK_xxx})
884 constants. Identifiers and keywords are also keywords. @code{tokc}
885 contains additional infos about the token (for example a constant value
886 if number or string token).
888 @section Parser
890 The parser is hardcoded (yacc is not necessary). It does only one pass,
891 except:
893 @itemize
895 @item For initialized arrays with unknown size, a first pass 
896 is done to count the number of elements.
898 @item For architectures where arguments are evaluated in 
899 reverse order, a first pass is done to reverse the argument order.
901 @end itemize
903 @section Types
905 The types are stored in a single 'int' variable. It was choosen in the
906 first stages of development when tcc was much simpler. Now, it may not
907 be the best solution.
909 @example
910 #define VT_INT        0  /* integer type */
911 #define VT_BYTE       1  /* signed byte type */
912 #define VT_SHORT      2  /* short type */
913 #define VT_VOID       3  /* void type */
914 #define VT_PTR        4  /* pointer */
915 #define VT_ENUM       5  /* enum definition */
916 #define VT_FUNC       6  /* function type */
917 #define VT_STRUCT     7  /* struct/union definition */
918 #define VT_FLOAT      8  /* IEEE float */
919 #define VT_DOUBLE     9  /* IEEE double */
920 #define VT_LDOUBLE   10  /* IEEE long double */
921 #define VT_BOOL      11  /* ISOC99 boolean type */
922 #define VT_LLONG     12  /* 64 bit integer */
923 #define VT_LONG      13  /* long integer (NEVER USED as type, only
924                             during parsing) */
925 #define VT_BTYPE      0x000f /* mask for basic type */
926 #define VT_UNSIGNED   0x0010  /* unsigned type */
927 #define VT_ARRAY      0x0020  /* array type (also has VT_PTR) */
928 #define VT_BITFIELD   0x0040  /* bitfield modifier */
930 #define VT_STRUCT_SHIFT 16   /* structure/enum name shift (16 bits left) */
931 @end example
933 When a reference to another type is needed (for pointers, functions and
934 structures), the @code{32 - VT_STRUCT_SHIFT} high order bits are used to
935 store an identifier reference.
937 The @code{VT_UNSIGNED} flag can be set for chars, shorts, ints and long
938 longs.
940 Arrays are considered as pointers @code{VT_PTR} with the flag
941 @code{VT_ARRAY} set.
943 The @code{VT_BITFIELD} flag can be set for chars, shorts, ints and long
944 longs. If it is set, then the bitfield position is stored from bits
945 VT_STRUCT_SHIFT to VT_STRUCT_SHIFT + 5 and the bit field size is stored
946 from bits VT_STRUCT_SHIFT + 6 to VT_STRUCT_SHIFT + 11.
948 @code{VT_LONG} is never used except during parsing.
950 During parsing, the storage of an object is also stored in the type
951 integer:
953 @example
954 #define VT_EXTERN  0x00000080  /* extern definition */
955 #define VT_STATIC  0x00000100  /* static variable */
956 #define VT_TYPEDEF 0x00000200  /* typedef definition */
957 @end example
959 @section Symbols
961 All symbols are stored in hashed symbol stacks. Each symbol stack
962 contains @code{Sym} structures.
964 @code{Sym.v} contains the symbol name (remember
965 an idenfier is also a token, so a string is never necessary to store
966 it). @code{Sym.t} gives the type of the symbol. @code{Sym.r} is usually
967 the register in which the corresponding variable is stored. @code{Sym.c} is
968 usually a constant associated to the symbol.
970 Four main symbol stacks are defined:
972 @table @code
974 @item define_stack
975 for the macros (@code{#define}s).
977 @item global_stack
978 for the global variables, functions and types.
980 @item local_stack
981 for the local variables, functions and types.
983 @item global_label_stack
984 for the local labels (for @code{goto}).
986 @item label_stack
987 for GCC block local labels (see the @code{__label__} keyword).
989 @end table
991 @code{sym_push()} is used to add a new symbol in the local symbol
992 stack. If no local symbol stack is active, it is added in the global
993 symbol stack.
995 @code{sym_pop(st,b)} pops symbols from the symbol stack @var{st} until
996 the symbol @var{b} is on the top of stack. If @var{b} is NULL, the stack
997 is emptied.
999 @code{sym_find(v)} return the symbol associated to the identifier
1000 @var{v}. The local stack is searched first from top to bottom, then the
1001 global stack.
1003 @section Sections
1005 The generated code and datas are written in sections. The structure
1006 @code{Section} contains all the necessary information for a given
1007 section. @code{new_section()} creates a new section. ELF file semantics
1008 is assumed for each section.
1010 The following sections are predefined:
1012 @table @code
1014 @item text_section
1015 is the section containing the generated code. @var{ind} contains the
1016 current position in the code section.
1018 @item data_section
1019 contains initialized data
1021 @item bss_section
1022 contains uninitialized data
1024 @item bounds_section
1025 @itemx lbounds_section
1026 are used when bound checking is activated
1028 @item stab_section
1029 @itemx stabstr_section
1030 are used when debugging is actived to store debug information
1032 @item symtab_section
1033 @itemx strtab_section
1034 contain the exported symbols (currently only used for debugging).
1036 @end table
1038 @section Code generation
1039 @cindex code generation
1041 @subsection Introduction
1043 The TCC code generator directly generates linked binary code in one
1044 pass. It is rather unusual these days (see gcc for example which
1045 generates text assembly), but it can be very fast and surprisingly
1046 little complicated.
1048 The TCC code generator is register based. Optimization is only done at
1049 the expression level. No intermediate representation of expression is
1050 kept except the current values stored in the @emph{value stack}.
1052 On x86, three temporary registers are used. When more registers are
1053 needed, one register is spilled into a new temporary variable on the stack.
1055 @subsection The value stack
1056 @cindex value stack, introduction
1058 When an expression is parsed, its value is pushed on the value stack
1059 (@var{vstack}). The top of the value stack is @var{vtop}. Each value
1060 stack entry is the structure @code{SValue}.
1062 @code{SValue.t} is the type. @code{SValue.r} indicates how the value is
1063 currently stored in the generated code. It is usually a CPU register
1064 index (@code{REG_xxx} constants), but additional values and flags are
1065 defined:
1067 @example
1068 #define VT_CONST     0x00f0
1069 #define VT_LLOCAL    0x00f1
1070 #define VT_LOCAL     0x00f2
1071 #define VT_CMP       0x00f3
1072 #define VT_JMP       0x00f4
1073 #define VT_JMPI      0x00f5
1074 #define VT_LVAL      0x0100
1075 #define VT_SYM       0x0200
1076 #define VT_MUSTCAST  0x0400
1077 #define VT_MUSTBOUND 0x0800
1078 #define VT_BOUNDED   0x8000
1079 #define VT_LVAL_BYTE     0x1000
1080 #define VT_LVAL_SHORT    0x2000
1081 #define VT_LVAL_UNSIGNED 0x4000
1082 #define VT_LVAL_TYPE     (VT_LVAL_BYTE | VT_LVAL_SHORT | VT_LVAL_UNSIGNED)
1083 @end example
1085 @table @code
1087 @item VT_CONST
1088 indicates that the value is a constant. It is stored in the union
1089 @code{SValue.c}, depending on its type.
1091 @item VT_LOCAL
1092 indicates a local variable pointer at offset @code{SValue.c.i} in the
1093 stack.
1095 @item VT_CMP
1096 indicates that the value is actually stored in the CPU flags (i.e. the
1097 value is the consequence of a test). The value is either 0 or 1. The
1098 actual CPU flags used is indicated in @code{SValue.c.i}. 
1100 If any code is generated which destroys the CPU flags, this value MUST be
1101 put in a normal register.
1103 @item VT_JMP
1104 @itemx VT_JMPI
1105 indicates that the value is the consequence of a conditional jump. For VT_JMP,
1106 it is 1 if the jump is taken, 0 otherwise. For VT_JMPI it is inverted.
1108 These values are used to compile the @code{||} and @code{&&} logical
1109 operators.
1111 If any code is generated, this value MUST be put in a normal
1112 register. Otherwise, the generated code won't be executed if the jump is
1113 taken.
1115 @item VT_LVAL
1116 is a flag indicating that the value is actually an lvalue (left value of
1117 an assignment). It means that the value stored is actually a pointer to
1118 the wanted value. 
1120 Understanding the use @code{VT_LVAL} is very important if you want to
1121 understand how TCC works.
1123 @item VT_LVAL_BYTE
1124 @itemx VT_LVAL_SHORT
1125 @itemx VT_LVAL_UNSIGNED
1126 if the lvalue has an integer type, then these flags give its real
1127 type. The type alone is not enough in case of cast optimisations.
1129 @item VT_LLOCAL
1130 is a saved lvalue on the stack. @code{VT_LLOCAL} should be eliminated
1131 ASAP because its semantics are rather complicated.
1133 @item VT_MUSTCAST
1134 indicates that a cast to the value type must be performed if the value
1135 is used (lazy casting).
1137 @item VT_SYM
1138 indicates that the symbol @code{SValue.sym} must be added to the constant.
1140 @item VT_MUSTBOUND
1141 @itemx VT_BOUNDED
1142 are only used for optional bound checking.
1144 @end table
1146 @subsection Manipulating the value stack
1147 @cindex value stack
1149 @code{vsetc()} and @code{vset()} pushes a new value on the value
1150 stack. If the previous @var{vtop} was stored in a very unsafe place(for
1151 example in the CPU flags), then some code is generated to put the
1152 previous @var{vtop} in a safe storage.
1154 @code{vpop()} pops @var{vtop}. In some cases, it also generates cleanup
1155 code (for example if stacked floating point registers are used as on
1156 x86).
1158 The @code{gv(rc)} function generates code to evaluate @var{vtop} (the
1159 top value of the stack) into registers. @var{rc} selects in which
1160 register class the value should be put. @code{gv()} is the @emph{most
1161 important function} of the code generator.
1163 @code{gv2()} is the same as @code{gv()} but for the top two stack
1164 entries.
1166 @subsection CPU dependent code generation
1167 @cindex CPU dependent
1168 See the @file{i386-gen.c} file to have an example.
1170 @table @code
1172 @item load()
1173 must generate the code needed to load a stack value into a register.
1175 @item store()
1176 must generate the code needed to store a register into a stack value
1177 lvalue.
1179 @item gfunc_start()
1180 @itemx gfunc_param()
1181 @itemx gfunc_call()
1182 should generate a function call
1184 @item gfunc_prolog()
1185 @itemx gfunc_epilog()
1186 should generate a function prolog/epilog.
1188 @item gen_opi(op)
1189 must generate the binary integer operation @var{op} on the two top
1190 entries of the stack which are guaranted to contain integer types.
1192 The result value should be put on the stack.
1194 @item gen_opf(op)
1195 same as @code{gen_opi()} for floating point operations. The two top
1196 entries of the stack are guaranted to contain floating point values of
1197 same types.
1199 @item gen_cvt_itof()
1200 integer to floating point conversion.
1202 @item gen_cvt_ftoi()
1203 floating point to integer conversion.
1205 @item gen_cvt_ftof()
1206 floating point to floating point of different size conversion.
1208 @item gen_bounded_ptr_add()
1209 @item gen_bounded_ptr_deref()
1210 are only used for bounds checking.
1212 @end table
1214 @section Optimizations done
1215 @cindex optimizations
1216 @cindex constant propagation
1217 @cindex strength reduction
1218 @cindex comparison operators
1219 @cindex caching processor flags
1220 @cindex flags, caching
1221 @cindex jump optimization
1222 Constant propagation is done for all operations. Multiplications and
1223 divisions are optimized to shifts when appropriate. Comparison
1224 operators are optimized by maintaining a special cache for the
1225 processor flags. &&, || and ! are optimized by maintaining a special
1226 'jump target' value. No other jump optimization is currently performed
1227 because it would require to store the code in a more abstract fashion.
1229 @unnumbered Concept Index
1230 @printindex cp
1232 @bye
1234 @c Local variables:
1235 @c fill-column: 78
1236 @c texinfo-column-for-description: 32
1237 @c End: