Optimize arithmetic with pointer to value on stack + constant
[tinycc/daniel.git] / tcc-doc.texi
blob38426ca7ecd77f41267a41f07eb372d88bbf845e
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 @c @ifhtml
20 @contents
21 @c @end ifhtml
23 @ifnothtml
24 @node Top, Introduction, (dir), (dir)
25 @top Tiny C Compiler Reference Documentation
27 This manual documents version @value{VERSION} of the Tiny C Compiler.
29 @menu
30 * Introduction::                Introduction to tcc.
31 * Invoke::                      Invocation of tcc (command line, options).
32 * Bounds::                      Automatic bounds-checking of C code.
33 * Libtcc::                      The libtcc library.
34 @end menu
35 @end ifnothtml
37 @node Introduction
38 @chapter Introduction
40 TinyCC (aka TCC) is a small but hyper fast C compiler. Unlike other C
41 compilers, it is meant to be self-relying: you do not need an
42 external assembler or linker because TCC does that for you.
44 TCC compiles so @emph{fast} that even for big projects @code{Makefile}s may
45 not be necessary. 
47 TCC not only supports ANSI C, but also most of the new ISO C99
48 standard and many GNUC extensions including inline assembly.
50 TCC can also be used to make @emph{C scripts}, i.e. pieces of C source
51 that you run as a Perl or Python script. Compilation is so fast that
52 your script will be as fast as if it was an executable.
54 TCC can also automatically generate memory and bound checks
55 (@pxref{Bounds}) while allowing all C pointers operations. TCC can do
56 these checks even if non patched libraries are used.
58 With @code{libtcc}, you can use TCC as a backend for dynamic code
59 generation (@pxref{Libtcc}).
61 TCC mainly supports the i386 target on Linux and Windows. There are alpha
62 ports for the ARM (@code{arm-tcc}) and the TMS320C67xx targets
63 (@code{c67-tcc}). More information about the ARM port is available at
64 @url{http://lists.gnu.org/archive/html/tinycc-devel/2003-10/msg00044.html}.
66 @node Invoke
67 @chapter Command line invocation
69 [This manual documents version @value{VERSION} of the Tiny C Compiler]
71 @section Quick start
73 @example
74 @c man begin SYNOPSIS
75 usage: tcc [options] [@var{infile1} @var{infile2}@dots{}] [@option{-run} @var{infile} @var{args}@dots{}]
76 @c man end
77 @end example
79 @noindent
80 @c man begin DESCRIPTION
81 TCC options are a very much like gcc options. The main difference is that TCC
82 can also execute directly the resulting program and give it runtime
83 arguments.
85 Here are some examples to understand the logic:
87 @table @code
88 @item @samp{tcc -run a.c}
89 Compile @file{a.c} and execute it directly
91 @item @samp{tcc -run a.c arg1}
92 Compile a.c and execute it directly. arg1 is given as first argument to
93 the @code{main()} of a.c.
95 @item @samp{tcc a.c -run b.c arg1}
96 Compile @file{a.c} and @file{b.c}, link them together and execute them. arg1 is given
97 as first argument to the @code{main()} of the resulting program. 
98 @ignore 
99 Because multiple C files are specified, @option{--} are necessary to clearly 
100 separate the program arguments from the TCC options.
101 @end ignore
103 @item @samp{tcc -o myprog a.c b.c}
104 Compile @file{a.c} and @file{b.c}, link them and generate the executable @file{myprog}.
106 @item @samp{tcc -o myprog a.o b.o}
107 link @file{a.o} and @file{b.o} together and generate the executable @file{myprog}.
109 @item @samp{tcc -c a.c}
110 Compile @file{a.c} and generate object file @file{a.o}.
112 @item @samp{tcc -c asmfile.S}
113 Preprocess with C preprocess and assemble @file{asmfile.S} and generate
114 object file @file{asmfile.o}.
116 @item @samp{tcc -c asmfile.s}
117 Assemble (but not preprocess) @file{asmfile.s} and generate object file
118 @file{asmfile.o}.
120 @item @samp{tcc -r -o ab.o a.c b.c}
121 Compile @file{a.c} and @file{b.c}, link them together and generate the object file @file{ab.o}.
123 @end table
125 Scripting:
127 TCC can be invoked from @emph{scripts}, just as shell scripts. You just
128 need to add @code{#!/usr/local/bin/tcc -run} at the start of your C source:
130 @example
131 #!/usr/local/bin/tcc -run
132 #include <stdio.h>
134 int main() 
136     printf("Hello World\n");
137     return 0;
139 @end example
141 TCC can read C source code from @emph{standard input} when @option{-} is used in 
142 place of @option{infile}. Example:
144 @example
145 echo 'main(){puts("hello");}' | tcc -run -
146 @end example
147 @c man end
149 @section Option summary
151 General Options:
153 @c man begin OPTIONS
154 @table @option
155 @item -v
156 Display current TCC version, increase verbosity.
158 @item -c
159 Generate an object file (@option{-o} option must also be given).
161 @item -o outfile
162 Put object file, executable, or dll into output file @file{outfile}.
164 @item -Bdir
165 Set the path where the tcc internal libraries can be found (default is
166 @file{PREFIX/lib/tcc}).
168 @item -bench
169 Output compilation statistics.
171 @item -run source [args...]
172 Compile file @var{source} and run it with the command line arguments
173 @var{args}. In order to be able to give more than one argument to a
174 script, several TCC options can be given @emph{after} the
175 @option{-run} option, separated by spaces. Example:
177 @example
178 tcc "-run -L/usr/X11R6/lib -lX11" ex4.c
179 @end example
181 In a script, it gives the following header:
183 @example
184 #!/usr/local/bin/tcc -run -L/usr/X11R6/lib -lX11
185 #include <stdlib.h>
186 int main(int argc, char **argv)
188     ...
190 @end example
192 @end table
194 Preprocessor options:
196 @table @option
197 @item -Idir
198 Specify an additional include path. Include paths are searched in the
199 order they are specified.
201 System include paths are always searched after. The default system
202 include paths are: @file{/usr/local/include}, @file{/usr/include}
203 and @file{PREFIX/lib/tcc/include}. (@file{PREFIX} is usually
204 @file{/usr} or @file{/usr/local}).
206 @item -Dsym[=val]
207 Define preprocessor symbol @samp{sym} to
208 val. If val is not present, its value is @samp{1}. Function-like macros can
209 also be defined: @option{-DF(a)=a+1}
211 @item -Usym
212 Undefine preprocessor symbol @samp{sym}.
213 @end table
215 Compilation flags:
217 Note: each of the following warning 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 @end table
235 Warning options:
237 @table @option
238 @item -w
239 Disable all warnings.
241 @end table
243 Note: each of the following warning options has a negative form beginning with
244 @option{-Wno-}.
246 @table @option
247 @item -Wimplicit-function-declaration
248 Warn about implicit function declaration.
250 @item -Wunsupported
251 Warn about unsupported GCC features that are ignored by TCC.
253 @item -Wwrite-strings
254 Make string constants be of type @code{const char *} instead of @code{char
257 @item -Werror
258 Abort compilation if warnings are issued.
260 @item -Wall 
261 Activate all warnings, except @option{-Werror}, @option{-Wunusupported} and
262 @option{-Wwrite-strings}.
264 @end table
266 Linker options:
268 @table @option
269 @item -Ldir
270 Specify an additional static library path for the @option{-l} option. The
271 default library paths are @file{/usr/local/lib}, @file{/usr/lib} and @file{/lib}.
273 @item -lxxx
274 Link your program with dynamic library libxxx.so or static library
275 libxxx.a. The library is searched in the paths specified by the
276 @option{-L} option.
278 @item -shared
279 Generate a shared library instead of an executable (@option{-o} option
280 must also be given).
282 @item -static
283 Generate a statically linked executable (default is a shared linked
284 executable) (@option{-o} option must also be given).
286 @item -rdynamic
287 Export global symbols to the dynamic linker. It is useful when a library
288 opened with @code{dlopen()} needs to access executable symbols.
290 @item -r
291 Generate an object file combining all input files (@option{-o} option must
292 also be given).
294 @item -Wl,-Ttext,address
295 Set the start of the .text section to @var{address}.
297 @item -Wl,--oformat,fmt
298 Use @var{fmt} as output format. The supported output formats are:
299 @table @code
300 @item elf32-i386
301 ELF output format (default)
302 @item binary
303 Binary image (only for executable output)
304 @item coff
305 COFF output format (only for executable output for TMS320C67xx target)
306 @end table
308 @end table
310 Debugger options:
312 @table @option
313 @item -g
314 Generate run time debug information so that you get clear run time
315 error messages: @code{ test.c:68: in function 'test5()': dereferencing
316 invalid pointer} instead of the laconic @code{Segmentation
317 fault}.
319 @item -b
320 Generate additional support code to check
321 memory allocations and array/pointer bounds. @option{-g} is implied. Note
322 that the generated code is slower and bigger in this case.
324 @item -bt N
325 Display N callers in stack traces. This is useful with @option{-g} or
326 @option{-b}.
328 @end table
330 Note: GCC options @option{-Ox}, @option{-fx} and @option{-mx} are
331 ignored.
332 @c man end
334 @ignore
336 @setfilename tcc
337 @settitle Tiny C Compiler
339 @c man begin SEEALSO
340 gcc(1)
341 @c man end
343 @c man begin AUTHOR
344 Fabrice Bellard
345 @c man end
347 @end ignore
349 @chapter C language support
351 @section ANSI C
353 TCC implements all the ANSI C standard, including structure bit fields
354 and floating point numbers (@code{long double}, @code{double}, and
355 @code{float} fully supported).
357 @section ISOC99 extensions
359 TCC implements many features of the new C standard: ISO C99. Currently
360 missing items are: complex and imaginary numbers and variable length
361 arrays.
363 Currently implemented ISOC99 features:
365 @itemize
367 @item 64 bit @code{long long} types are fully supported.
369 @item The boolean type @code{_Bool} is supported.
371 @item @code{__func__} is a string variable containing the current
372 function name.
374 @item Variadic macros: @code{__VA_ARGS__} can be used for
375    function-like macros:
376 @example
377     #define dprintf(level, __VA_ARGS__) printf(__VA_ARGS__)
378 @end example
380 @noindent
381 @code{dprintf} can then be used with a variable number of parameters.
383 @item Declarations can appear anywhere in a block (as in C++).
385 @item Array and struct/union elements can be initialized in any order by
386   using designators:
387 @example
388     struct @{ int x, y; @} st[10] = @{ [0].x = 1, [0].y = 2 @};
390     int tab[10] = @{ 1, 2, [5] = 5, [9] = 9@};
391 @end example
392     
393 @item Compound initializers are supported:
394 @example
395     int *p = (int [])@{ 1, 2, 3 @};
396 @end example
397 to initialize a pointer pointing to an initialized array. The same
398 works for structures and strings.
400 @item Hexadecimal floating point constants are supported:
401 @example
402           double d = 0x1234p10;
403 @end example
405 @noindent
406 is the same as writing 
407 @example
408           double d = 4771840.0;
409 @end example
411 @item @code{inline} keyword is ignored.
413 @item @code{restrict} keyword is ignored.
414 @end itemize
416 @section GNU C extensions
418 TCC implements some GNU C extensions:
420 @itemize
422 @item array designators can be used without '=': 
423 @example
424     int a[10] = @{ [0] 1, [5] 2, 3, 4 @};
425 @end example
427 @item Structure field designators can be a label: 
428 @example
429     struct @{ int x, y; @} st = @{ x: 1, y: 1@};
430 @end example
431 instead of
432 @example
433     struct @{ int x, y; @} st = @{ .x = 1, .y = 1@};
434 @end example
436 @item @code{\e} is ASCII character 27.
438 @item case ranges : ranges can be used in @code{case}s:
439 @example
440     switch(a) @{
441     case 1 @dots{} 9:
442           printf("range 1 to 9\n");
443           break;
444     default:
445           printf("unexpected\n");
446           break;
447     @}
448 @end example
450 @cindex aligned attribute
451 @cindex packed attribute
452 @cindex section attribute
453 @cindex unused attribute
454 @cindex cdecl attribute
455 @cindex stdcall attribute
456 @cindex regparm attribute
457 @cindex dllexport attribute
459 @item The keyword @code{__attribute__} is handled to specify variable or
460 function attributes. The following attributes are supported:
461   @itemize
463   @item @code{aligned(n)}: align a variable or a structure field to n bytes
464 (must be a power of two).
466   @item @code{packed}: force alignment of a variable or a structure field to
467   1.
469   @item @code{section(name)}: generate function or data in assembly section
470 name (name is a string containing the section name) instead of the default
471 section.
473   @item @code{unused}: specify that the variable or the function is unused.
475   @item @code{cdecl}: use standard C calling convention (default).
477   @item @code{stdcall}: use Pascal-like calling convention.
479   @item @code{regparm(n)}: use fast i386 calling convention. @var{n} must be
480 between 1 and 3. The first @var{n} function parameters are respectively put in
481 registers @code{%eax}, @code{%edx} and @code{%ecx}.
483   @item @code{dllexport}: export function from dll/executable (win32 only)
485   @end itemize
487 Here are some examples:
488 @example
489     int a __attribute__ ((aligned(8), section(".mysection")));
490 @end example
492 @noindent
493 align variable @code{a} to 8 bytes and put it in section @code{.mysection}.
495 @example
496     int my_add(int a, int b) __attribute__ ((section(".mycodesection"))) 
497     @{
498         return a + b;
499     @}
500 @end example
502 @noindent
503 generate function @code{my_add} in section @code{.mycodesection}.
505 @item GNU style variadic macros:
506 @example
507     #define dprintf(fmt, args@dots{}) printf(fmt, ## args)
509     dprintf("no arg\n");
510     dprintf("one arg %d\n", 1);
511 @end example
513 @item @code{__FUNCTION__} is interpreted as C99 @code{__func__} 
514 (so it has not exactly the same semantics as string literal GNUC
515 where it is a string literal).
517 @item The @code{__alignof__} keyword can be used as @code{sizeof} 
518 to get the alignment of a type or an expression.
520 @item The @code{typeof(x)} returns the type of @code{x}. 
521 @code{x} is an expression or a type.
523 @item Computed gotos: @code{&&label} returns a pointer of type 
524 @code{void *} on the goto label @code{label}. @code{goto *expr} can be
525 used to jump on the pointer resulting from @code{expr}.
527 @item Inline assembly with asm instruction:
528 @cindex inline assembly
529 @cindex assembly, inline
530 @cindex __asm__
531 @example
532 static inline void * my_memcpy(void * to, const void * from, size_t n)
534 int d0, d1, d2;
535 __asm__ __volatile__(
536         "rep ; movsl\n\t"
537         "testb $2,%b4\n\t"
538         "je 1f\n\t"
539         "movsw\n"
540         "1:\ttestb $1,%b4\n\t"
541         "je 2f\n\t"
542         "movsb\n"
543         "2:"
544         : "=&c" (d0), "=&D" (d1), "=&S" (d2)
545         :"0" (n/4), "q" (n),"1" ((long) to),"2" ((long) from)
546         : "memory");
547 return (to);
549 @end example
551 @noindent
552 @cindex gas
553 TCC includes its own x86 inline assembler with a @code{gas}-like (GNU
554 assembler) syntax. No intermediate files are generated. GCC 3.x named
555 operands are supported.
557 @item @code{__builtin_types_compatible_p()} and @code{__builtin_constant_p()} 
558 are supported.
560 @item @code{#pragma pack} is supported for win32 compatibility.
562 @end itemize
564 @section TinyCC extensions
566 @itemize
568 @item @code{__TINYC__} is a predefined macro to @code{1} to
569 indicate that you use TCC.
571 @item @code{#!} at the start of a line is ignored to allow scripting.
573 @item Binary digits can be entered (@code{0b101} instead of
574 @code{5}).
576 @item @code{__BOUNDS_CHECKING_ON} is defined if bound checking is activated.
578 @end itemize
580 @chapter TinyCC Assembler
582 Since version 0.9.16, TinyCC integrates its own assembler. TinyCC
583 assembler supports a gas-like syntax (GNU assembler). You can
584 desactivate assembler support if you want a smaller TinyCC executable
585 (the C compiler does not rely on the assembler).
587 TinyCC Assembler is used to handle files with @file{.S} (C
588 preprocessed assembler) and @file{.s} extensions. It is also used to
589 handle the GNU inline assembler with the @code{asm} keyword.
591 @section Syntax
593 TinyCC Assembler supports most of the gas syntax. The tokens are the
594 same as C.
596 @itemize
598 @item C and C++ comments are supported.
600 @item Identifiers are the same as C, so you cannot use '.' or '$'.
602 @item Only 32 bit integer numbers are supported.
604 @end itemize
606 @section Expressions
608 @itemize
610 @item Integers in decimal, octal and hexa are supported.
612 @item Unary operators: +, -, ~.
614 @item Binary operators in decreasing priority order:
616 @enumerate
617 @item *, /, %
618 @item &, |, ^
619 @item +, -
620 @end enumerate
622 @item A value is either an absolute number or a label plus an offset. 
623 All operators accept absolute values except '+' and '-'. '+' or '-' can be
624 used to add an offset to a label. '-' supports two labels only if they
625 are the same or if they are both defined and in the same section.
627 @end itemize
629 @section Labels
631 @itemize
633 @item All labels are considered as local, except undefined ones.
635 @item Numeric labels can be used as local @code{gas}-like labels. 
636 They can be defined several times in the same source. Use 'b'
637 (backward) or 'f' (forward) as suffix to reference them:
639 @example
640  1:
641       jmp 1b /* jump to '1' label before */
642       jmp 1f /* jump to '1' label after */
643  1:
644 @end example
646 @end itemize
648 @section Directives
649 @cindex assembler directives
650 @cindex directives, assembler
651 @cindex align directive
652 @cindex skip directive
653 @cindex space directive
654 @cindex byte directive
655 @cindex word directive
656 @cindex short directive
657 @cindex int directive
658 @cindex long directive
659 @cindex quad directive
660 @cindex globl directive
661 @cindex global directive
662 @cindex section directive
663 @cindex text directive
664 @cindex data directive
665 @cindex bss directive
666 @cindex fill directive
667 @cindex org directive
668 @cindex previous directive
669 @cindex string directive
670 @cindex asciz directive
671 @cindex ascii directive
673 All directives are preceeded by a '.'. The following directives are
674 supported:
676 @itemize
677 @item .align n[,value]
678 @item .skip n[,value]
679 @item .space n[,value]
680 @item .byte value1[,...]
681 @item .word value1[,...]
682 @item .short value1[,...]
683 @item .int value1[,...]
684 @item .long value1[,...]
685 @item .quad immediate_value1[,...]
686 @item .globl symbol
687 @item .global symbol
688 @item .section section
689 @item .text
690 @item .data
691 @item .bss
692 @item .fill repeat[,size[,value]]
693 @item .org n
694 @item .previous
695 @item .string string[,...]
696 @item .asciz string[,...]
697 @item .ascii string[,...]
698 @end itemize
700 @section X86 Assembler
701 @cindex assembler
703 All X86 opcodes are supported. Only ATT syntax is supported (source
704 then destination operand order). If no size suffix is given, TinyCC
705 tries to guess it from the operand sizes.
707 Currently, MMX opcodes are supported but not SSE ones.
709 @chapter TinyCC Linker
710 @cindex linker
712 @section ELF file generation
713 @cindex ELF
715 TCC can directly output relocatable ELF files (object files),
716 executable ELF files and dynamic ELF libraries without relying on an
717 external linker.
719 Dynamic ELF libraries can be output but the C compiler does not generate
720 position independent code (PIC). It means that the dynamic library
721 code generated by TCC cannot be factorized among processes yet.
723 TCC linker eliminates unreferenced object code in libraries. A single pass is
724 done on the object and library list, so the order in which object files and
725 libraries are specified is important (same constraint as GNU ld). No grouping
726 options (@option{--start-group} and @option{--end-group}) are supported.
728 @section ELF file loader
730 TCC can load ELF object files, archives (.a files) and dynamic
731 libraries (.so).
733 @section PE-i386 file generation
734 @cindex PE-i386
736 TCC for Windows supports the native Win32 executable file format (PE-i386). It
737 generates both EXE and DLL files. DLL symbols can be imported thru DEF files
738 generated with the @code{tiny_impdef} tool.
740 On the object file level, currently TCC supports only the ELF format, not COFF 
741 as used by MINGW and MSVC. It is not possible to exchange object files or 
742 libraries between TCC and these compilers.  However libraries for TCC from objects 
743 by TCC can be made using the @code{tiny_libmaker} tool or MINGW's @code{ar}.
745 No leading underscore is generated in the ELF symbols.  Only functions (no 
746 data) can be exported. Bounds checking (@option{-b}) is not supported currently.
748 @section GNU Linker Scripts
749 @cindex scripts, linker
750 @cindex linker scripts
751 @cindex GROUP, linker command
752 @cindex FILE, linker command
753 @cindex OUTPUT_FORMAT, linker command
754 @cindex TARGET, linker command
756 Because on many Linux systems some dynamic libraries (such as
757 @file{/usr/lib/libc.so}) are in fact GNU ld link scripts (horrible!),
758 the TCC linker also supports a subset of GNU ld scripts.
760 The @code{GROUP} and @code{FILE} commands are supported. @code{OUTPUT_FORMAT}
761 and @code{TARGET} are ignored.
763 Example from @file{/usr/lib/libc.so}:
764 @example
765 /* GNU ld script
766    Use the shared library, but some functions are only in
767    the static library, so try that secondarily.  */
768 GROUP ( /lib/libc.so.6 /usr/lib/libc_nonshared.a )
769 @end example
771 @node Bounds
772 @chapter TinyCC Memory and Bound checks
773 @cindex bound checks
774 @cindex memory checks
776 This feature is activated with the @option{-b} (@pxref{Invoke}).
778 Note that pointer size is @emph{unchanged} and that code generated
779 with bound checks is @emph{fully compatible} with unchecked
780 code. When a pointer comes from unchecked code, it is assumed to be
781 valid. Even very obscure C code with casts should work correctly.
783 For more information about the ideas behind this method, see
784 @url{http://www.doc.ic.ac.uk/~phjk/BoundsChecking.html}.
786 Here are some examples of caught errors:
788 @table @asis
790 @item Invalid range with standard string function:
791 @example
793     char tab[10];
794     memset(tab, 0, 11);
796 @end example
798 @item Out of bounds-error in global or local arrays:
799 @example
801     int tab[10];
802     for(i=0;i<11;i++) @{
803         sum += tab[i];
804     @}
806 @end example
808 @item Out of bounds-error in malloc'ed data:
809 @example
811     int *tab;
812     tab = malloc(20 * sizeof(int));
813     for(i=0;i<21;i++) @{
814         sum += tab4[i];
815     @}
816     free(tab);
818 @end example
820 @item Access of freed memory:
821 @example
823     int *tab;
824     tab = malloc(20 * sizeof(int));
825     free(tab);
826     for(i=0;i<20;i++) @{
827         sum += tab4[i];
828     @}
830 @end example
832 @item Double free:
833 @example
835     int *tab;
836     tab = malloc(20 * sizeof(int));
837     free(tab);
838     free(tab);
840 @end example
842 @end table
844 @node Libtcc
845 @chapter The @code{libtcc} library
847 The @code{libtcc} library enables you to use TCC as a backend for
848 dynamic code generation. 
850 Read the @file{libtcc.h} to have an overview of the API. Read
851 @file{libtcc_test.c} to have a very simple example.
853 The idea consists in giving a C string containing the program you want
854 to compile directly to @code{libtcc}. Then you can access to any global
855 symbol (function or variable) defined.
857 @chapter Developer's guide
859 This chapter gives some hints to understand how TCC works. You can skip
860 it if you do not intend to modify the TCC code.
862 @section File reading
864 The @code{BufferedFile} structure contains the context needed to read a
865 file, including the current line number. @code{tcc_open()} opens a new
866 file and @code{tcc_close()} closes it. @code{inp()} returns the next
867 character.
869 @section Lexer
871 @code{next()} reads the next token in the current
872 file. @code{next_nomacro()} reads the next token without macro
873 expansion.
875 @code{tok} contains the current token (see @code{TOK_xxx})
876 constants. Identifiers and keywords are also keywords. @code{tokc}
877 contains additional infos about the token (for example a constant value
878 if number or string token).
880 @section Parser
882 The parser is hardcoded (yacc is not necessary). It does only one pass,
883 except:
885 @itemize
887 @item For initialized arrays with unknown size, a first pass 
888 is done to count the number of elements.
890 @item For architectures where arguments are evaluated in 
891 reverse order, a first pass is done to reverse the argument order.
893 @end itemize
895 @section Types
897 The types are stored in a single 'int' variable. It was choosen in the
898 first stages of development when tcc was much simpler. Now, it may not
899 be the best solution.
901 @example
902 #define VT_INT        0  /* integer type */
903 #define VT_BYTE       1  /* signed byte type */
904 #define VT_SHORT      2  /* short type */
905 #define VT_VOID       3  /* void type */
906 #define VT_PTR        4  /* pointer */
907 #define VT_ENUM       5  /* enum definition */
908 #define VT_FUNC       6  /* function type */
909 #define VT_STRUCT     7  /* struct/union definition */
910 #define VT_FLOAT      8  /* IEEE float */
911 #define VT_DOUBLE     9  /* IEEE double */
912 #define VT_LDOUBLE   10  /* IEEE long double */
913 #define VT_BOOL      11  /* ISOC99 boolean type */
914 #define VT_LLONG     12  /* 64 bit integer */
915 #define VT_LONG      13  /* long integer (NEVER USED as type, only
916                             during parsing) */
917 #define VT_BTYPE      0x000f /* mask for basic type */
918 #define VT_UNSIGNED   0x0010  /* unsigned type */
919 #define VT_ARRAY      0x0020  /* array type (also has VT_PTR) */
920 #define VT_BITFIELD   0x0040  /* bitfield modifier */
922 #define VT_STRUCT_SHIFT 16   /* structure/enum name shift (16 bits left) */
923 @end example
925 When a reference to another type is needed (for pointers, functions and
926 structures), the @code{32 - VT_STRUCT_SHIFT} high order bits are used to
927 store an identifier reference.
929 The @code{VT_UNSIGNED} flag can be set for chars, shorts, ints and long
930 longs.
932 Arrays are considered as pointers @code{VT_PTR} with the flag
933 @code{VT_ARRAY} set.
935 The @code{VT_BITFIELD} flag can be set for chars, shorts, ints and long
936 longs. If it is set, then the bitfield position is stored from bits
937 VT_STRUCT_SHIFT to VT_STRUCT_SHIFT + 5 and the bit field size is stored
938 from bits VT_STRUCT_SHIFT + 6 to VT_STRUCT_SHIFT + 11.
940 @code{VT_LONG} is never used except during parsing.
942 During parsing, the storage of an object is also stored in the type
943 integer:
945 @example
946 #define VT_EXTERN  0x00000080  /* extern definition */
947 #define VT_STATIC  0x00000100  /* static variable */
948 #define VT_TYPEDEF 0x00000200  /* typedef definition */
949 @end example
951 @section Symbols
953 All symbols are stored in hashed symbol stacks. Each symbol stack
954 contains @code{Sym} structures.
956 @code{Sym.v} contains the symbol name (remember
957 an idenfier is also a token, so a string is never necessary to store
958 it). @code{Sym.t} gives the type of the symbol. @code{Sym.r} is usually
959 the register in which the corresponding variable is stored. @code{Sym.c} is
960 usually a constant associated to the symbol.
962 Four main symbol stacks are defined:
964 @table @code
966 @item define_stack
967 for the macros (@code{#define}s).
969 @item global_stack
970 for the global variables, functions and types.
972 @item local_stack
973 for the local variables, functions and types.
975 @item global_label_stack
976 for the local labels (for @code{goto}).
978 @item label_stack
979 for GCC block local labels (see the @code{__label__} keyword).
981 @end table
983 @code{sym_push()} is used to add a new symbol in the local symbol
984 stack. If no local symbol stack is active, it is added in the global
985 symbol stack.
987 @code{sym_pop(st,b)} pops symbols from the symbol stack @var{st} until
988 the symbol @var{b} is on the top of stack. If @var{b} is NULL, the stack
989 is emptied.
991 @code{sym_find(v)} return the symbol associated to the identifier
992 @var{v}. The local stack is searched first from top to bottom, then the
993 global stack.
995 @section Sections
997 The generated code and datas are written in sections. The structure
998 @code{Section} contains all the necessary information for a given
999 section. @code{new_section()} creates a new section. ELF file semantics
1000 is assumed for each section.
1002 The following sections are predefined:
1004 @table @code
1006 @item text_section
1007 is the section containing the generated code. @var{ind} contains the
1008 current position in the code section.
1010 @item data_section
1011 contains initialized data
1013 @item bss_section
1014 contains uninitialized data
1016 @item bounds_section
1017 @itemx lbounds_section
1018 are used when bound checking is activated
1020 @item stab_section
1021 @itemx stabstr_section
1022 are used when debugging is actived to store debug information
1024 @item symtab_section
1025 @itemx strtab_section
1026 contain the exported symbols (currently only used for debugging).
1028 @end table
1030 @section Code generation
1031 @cindex code generation
1033 @subsection Introduction
1035 The TCC code generator directly generates linked binary code in one
1036 pass. It is rather unusual these days (see gcc for example which
1037 generates text assembly), but it can be very fast and surprisingly
1038 little complicated.
1040 The TCC code generator is register based. Optimization is only done at
1041 the expression level. No intermediate representation of expression is
1042 kept except the current values stored in the @emph{value stack}.
1044 On x86, three temporary registers are used. When more registers are
1045 needed, one register is spilled into a new temporary variable on the stack.
1047 @subsection The value stack
1048 @cindex value stack, introduction
1050 When an expression is parsed, its value is pushed on the value stack
1051 (@var{vstack}). The top of the value stack is @var{vtop}. Each value
1052 stack entry is the structure @code{SValue}.
1054 @code{SValue.t} is the type. @code{SValue.r} indicates how the value is
1055 currently stored in the generated code. It is usually a CPU register
1056 index (@code{REG_xxx} constants), but additional values and flags are
1057 defined:
1059 @example
1060 #define VT_CONST     0x00f0
1061 #define VT_LLOCAL    0x00f1
1062 #define VT_LOCAL     0x00f2
1063 #define VT_CMP       0x00f3
1064 #define VT_JMP       0x00f4
1065 #define VT_JMPI      0x00f5
1066 #define VT_LVAL      0x0100
1067 #define VT_SYM       0x0200
1068 #define VT_MUSTCAST  0x0400
1069 #define VT_MUSTBOUND 0x0800
1070 #define VT_BOUNDED   0x8000
1071 #define VT_LVAL_BYTE     0x1000
1072 #define VT_LVAL_SHORT    0x2000
1073 #define VT_LVAL_UNSIGNED 0x4000
1074 #define VT_LVAL_TYPE     (VT_LVAL_BYTE | VT_LVAL_SHORT | VT_LVAL_UNSIGNED)
1075 @end example
1077 @table @code
1079 @item VT_CONST
1080 indicates that the value is a constant. It is stored in the union
1081 @code{SValue.c}, depending on its type.
1083 @item VT_LOCAL
1084 indicates a local variable pointer at offset @code{SValue.c.i} in the
1085 stack.
1087 @item VT_CMP
1088 indicates that the value is actually stored in the CPU flags (i.e. the
1089 value is the consequence of a test). The value is either 0 or 1. The
1090 actual CPU flags used is indicated in @code{SValue.c.i}. 
1092 If any code is generated which destroys the CPU flags, this value MUST be
1093 put in a normal register.
1095 @item VT_JMP
1096 @itemx VT_JMPI
1097 indicates that the value is the consequence of a conditional jump. For VT_JMP,
1098 it is 1 if the jump is taken, 0 otherwise. For VT_JMPI it is inverted.
1100 These values are used to compile the @code{||} and @code{&&} logical
1101 operators.
1103 If any code is generated, this value MUST be put in a normal
1104 register. Otherwise, the generated code won't be executed if the jump is
1105 taken.
1107 @item VT_LVAL
1108 is a flag indicating that the value is actually an lvalue (left value of
1109 an assignment). It means that the value stored is actually a pointer to
1110 the wanted value. 
1112 Understanding the use @code{VT_LVAL} is very important if you want to
1113 understand how TCC works.
1115 @item VT_LVAL_BYTE
1116 @itemx VT_LVAL_SHORT
1117 @itemx VT_LVAL_UNSIGNED
1118 if the lvalue has an integer type, then these flags give its real
1119 type. The type alone is not enough in case of cast optimisations.
1121 @item VT_LLOCAL
1122 is a saved lvalue on the stack. @code{VT_LLOCAL} should be eliminated
1123 ASAP because its semantics are rather complicated.
1125 @item VT_MUSTCAST
1126 indicates that a cast to the value type must be performed if the value
1127 is used (lazy casting).
1129 @item VT_SYM
1130 indicates that the symbol @code{SValue.sym} must be added to the constant.
1132 @item VT_MUSTBOUND
1133 @itemx VT_BOUNDED
1134 are only used for optional bound checking.
1136 @end table
1138 @subsection Manipulating the value stack
1139 @cindex value stack
1141 @code{vsetc()} and @code{vset()} pushes a new value on the value
1142 stack. If the previous @var{vtop} was stored in a very unsafe place(for
1143 example in the CPU flags), then some code is generated to put the
1144 previous @var{vtop} in a safe storage.
1146 @code{vpop()} pops @var{vtop}. In some cases, it also generates cleanup
1147 code (for example if stacked floating point registers are used as on
1148 x86).
1150 The @code{gv(rc)} function generates code to evaluate @var{vtop} (the
1151 top value of the stack) into registers. @var{rc} selects in which
1152 register class the value should be put. @code{gv()} is the @emph{most
1153 important function} of the code generator.
1155 @code{gv2()} is the same as @code{gv()} but for the top two stack
1156 entries.
1158 @subsection CPU dependent code generation
1159 @cindex CPU dependent
1160 See the @file{i386-gen.c} file to have an example.
1162 @table @code
1164 @item load()
1165 must generate the code needed to load a stack value into a register.
1167 @item store()
1168 must generate the code needed to store a register into a stack value
1169 lvalue.
1171 @item gfunc_start()
1172 @itemx gfunc_param()
1173 @itemx gfunc_call()
1174 should generate a function call
1176 @item gfunc_prolog()
1177 @itemx gfunc_epilog()
1178 should generate a function prolog/epilog.
1180 @item gen_opi(op)
1181 must generate the binary integer operation @var{op} on the two top
1182 entries of the stack which are guaranted to contain integer types.
1184 The result value should be put on the stack.
1186 @item gen_opf(op)
1187 same as @code{gen_opi()} for floating point operations. The two top
1188 entries of the stack are guaranted to contain floating point values of
1189 same types.
1191 @item gen_cvt_itof()
1192 integer to floating point conversion.
1194 @item gen_cvt_ftoi()
1195 floating point to integer conversion.
1197 @item gen_cvt_ftof()
1198 floating point to floating point of different size conversion.
1200 @item gen_bounded_ptr_add()
1201 @item gen_bounded_ptr_deref()
1202 are only used for bounds checking.
1204 @end table
1206 @section Optimizations done
1207 @cindex optimizations
1208 @cindex constant propagation
1209 @cindex strength reduction
1210 @cindex comparison operators
1211 @cindex caching processor flags
1212 @cindex flags, caching
1213 @cindex jump optimization
1214 Constant propagation is done for all operations. Multiplications and
1215 divisions are optimized to shifts when appropriate. Comparison
1216 operators are optimized by maintaining a special cache for the
1217 processor flags. &&, || and ! are optimized by maintaining a special
1218 'jump target' value. No other jump optimization is currently performed
1219 because it would require to store the code in a more abstract fashion.
1221 @unnumbered Concept Index
1222 @printindex cp
1224 @bye
1226 @c Local variables:
1227 @c fill-column: 78
1228 @c texinfo-column-for-description: 32
1229 @c End: