Add my copyright for changes in arm-gen.c
[tinycc.git] / tcc-doc.texi
blob4d4a029596a9d69fc5d52b47fe11ae798625b32d
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 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 -v
161 Display current TCC version, increase verbosity.
163 @item -print-search-dirs
164 Print the name of the configured installation directory and a list
165 of program and library directories tcc will search.
167 @item -c
168 Generate an object file.
170 @item -o outfile
171 Put object file, executable, or dll into output file @file{outfile}.
173 @item -Bdir
174 Set the path where the tcc internal libraries can be found (default is
175 @file{PREFIX/lib/tcc}).
177 @item -bench
178 Output compilation statistics.
180 @item -run source [args...]
181 Compile file @var{source} and run it with the command line arguments
182 @var{args}. In order to be able to give more than one argument to a
183 script, several TCC options can be given @emph{after} the
184 @option{-run} option, separated by spaces. Example:
186 @example
187 tcc "-run -L/usr/X11R6/lib -lX11" ex4.c
188 @end example
190 In a script, it gives the following header:
192 @example
193 #!/usr/local/bin/tcc -run -L/usr/X11R6/lib -lX11
194 #include <stdlib.h>
195 int main(int argc, char **argv)
197     ...
199 @end example
201 @end table
203 Preprocessor options:
205 @table @option
206 @item -Idir
207 Specify an additional include path. Include paths are searched in the
208 order they are specified.
210 System include paths are always searched after. The default system
211 include paths are: @file{/usr/local/include}, @file{/usr/include}
212 and @file{PREFIX/lib/tcc/include}. (@file{PREFIX} is usually
213 @file{/usr} or @file{/usr/local}).
215 @item -Dsym[=val]
216 Define preprocessor symbol @samp{sym} to
217 val. If val is not present, its value is @samp{1}. Function-like macros can
218 also be defined: @option{-DF(a)=a+1}
220 @item -Usym
221 Undefine preprocessor symbol @samp{sym}.
222 @end table
224 Compilation flags:
226 Note: each of the following warning options has a negative form beginning with
227 @option{-fno-}.
229 @table @option
230 @item -funsigned-char
231 Let the @code{char} type be unsigned.
233 @item -fsigned-char
234 Let the @code{char} type be signed.
236 @item -fno-common
237 Do not generate common symbols for uninitialized data.
239 @item -fleading-underscore
240 Add a leading underscore at the beginning of each C symbol.
242 @end table
244 Warning options:
246 @table @option
247 @item -w
248 Disable all warnings.
250 @end table
252 Note: each of the following warning options has a negative form beginning with
253 @option{-Wno-}.
255 @table @option
256 @item -Wimplicit-function-declaration
257 Warn about implicit function declaration.
259 @item -Wunsupported
260 Warn about unsupported GCC features that are ignored by TCC.
262 @item -Wwrite-strings
263 Make string constants be of type @code{const char *} instead of @code{char
266 @item -Werror
267 Abort compilation if warnings are issued.
269 @item -Wall 
270 Activate all warnings, except @option{-Werror}, @option{-Wunusupported} and
271 @option{-Wwrite-strings}.
273 @end table
275 Linker options:
277 @table @option
278 @item -Ldir
279 Specify an additional static library path for the @option{-l} option. The
280 default library paths are @file{/usr/local/lib}, @file{/usr/lib} and @file{/lib}.
282 @item -lxxx
283 Link your program with dynamic library libxxx.so or static library
284 libxxx.a. The library is searched in the paths specified by the
285 @option{-L} option.
287 @item -shared
288 Generate a shared library instead of an executable.
290 @item -soname name
291 set name for shared library to be used at runtime
293 @item -static
294 Generate a statically linked executable (default is a shared linked
295 executable).
297 @item -rdynamic
298 Export global symbols to the dynamic linker. It is useful when a library
299 opened with @code{dlopen()} needs to access executable symbols.
301 @item -r
302 Generate an object file combining all input files.
304 @item -Wl,-Ttext,address
305 Set the start of the .text section to @var{address}.
307 @item -Wl,--oformat,fmt
308 Use @var{fmt} as output format. The supported output formats are:
309 @table @code
310 @item elf32-i386
311 ELF output format (default)
312 @item binary
313 Binary image (only for executable output)
314 @item coff
315 COFF output format (only for executable output for TMS320C67xx target)
316 @end table
318 @item -Wl,-rpath=path
319 Set custom library search path
321 @end table
323 Debugger options:
325 @table @option
326 @item -g
327 Generate run time debug information so that you get clear run time
328 error messages: @code{ test.c:68: in function 'test5()': dereferencing
329 invalid pointer} instead of the laconic @code{Segmentation
330 fault}.
332 @item -b
333 Generate additional support code to check
334 memory allocations and array/pointer bounds. @option{-g} is implied. Note
335 that the generated code is slower and bigger in this case.
337 Note: @option{-b} is only available on i386 for the moment.
339 @item -bt N
340 Display N callers in stack traces. This is useful with @option{-g} or
341 @option{-b}.
343 @end table
345 Note: GCC options @option{-Ox}, @option{-fx} and @option{-mx} are
346 ignored.
347 @c man end
349 @ignore
351 @setfilename tcc
352 @settitle Tiny C Compiler
354 @c man begin SEEALSO
355 gcc(1)
356 @c man end
358 @c man begin AUTHOR
359 Fabrice Bellard
360 @c man end
362 @end ignore
364 @node Clang
365 @chapter C language support
367 @section ANSI C
369 TCC implements all the ANSI C standard, including structure bit fields
370 and floating point numbers (@code{long double}, @code{double}, and
371 @code{float} fully supported).
373 @section ISOC99 extensions
375 TCC implements many features of the new C standard: ISO C99. Currently
376 missing items are: complex and imaginary numbers and variable length
377 arrays.
379 Currently implemented ISOC99 features:
381 @itemize
383 @item 64 bit @code{long long} types are fully supported.
385 @item The boolean type @code{_Bool} is supported.
387 @item @code{__func__} is a string variable containing the current
388 function name.
390 @item Variadic macros: @code{__VA_ARGS__} can be used for
391    function-like macros:
392 @example
393     #define dprintf(level, __VA_ARGS__) printf(__VA_ARGS__)
394 @end example
396 @noindent
397 @code{dprintf} can then be used with a variable number of parameters.
399 @item Declarations can appear anywhere in a block (as in C++).
401 @item Array and struct/union elements can be initialized in any order by
402   using designators:
403 @example
404     struct @{ int x, y; @} st[10] = @{ [0].x = 1, [0].y = 2 @};
406     int tab[10] = @{ 1, 2, [5] = 5, [9] = 9@};
407 @end example
408     
409 @item Compound initializers are supported:
410 @example
411     int *p = (int [])@{ 1, 2, 3 @};
412 @end example
413 to initialize a pointer pointing to an initialized array. The same
414 works for structures and strings.
416 @item Hexadecimal floating point constants are supported:
417 @example
418           double d = 0x1234p10;
419 @end example
421 @noindent
422 is the same as writing 
423 @example
424           double d = 4771840.0;
425 @end example
427 @item @code{inline} keyword is ignored.
429 @item @code{restrict} keyword is ignored.
430 @end itemize
432 @section GNU C extensions
434 TCC implements some GNU C extensions:
436 @itemize
438 @item array designators can be used without '=': 
439 @example
440     int a[10] = @{ [0] 1, [5] 2, 3, 4 @};
441 @end example
443 @item Structure field designators can be a label: 
444 @example
445     struct @{ int x, y; @} st = @{ x: 1, y: 1@};
446 @end example
447 instead of
448 @example
449     struct @{ int x, y; @} st = @{ .x = 1, .y = 1@};
450 @end example
452 @item @code{\e} is ASCII character 27.
454 @item case ranges : ranges can be used in @code{case}s:
455 @example
456     switch(a) @{
457     case 1 @dots{} 9:
458           printf("range 1 to 9\n");
459           break;
460     default:
461           printf("unexpected\n");
462           break;
463     @}
464 @end example
466 @cindex aligned attribute
467 @cindex packed attribute
468 @cindex section attribute
469 @cindex unused attribute
470 @cindex cdecl attribute
471 @cindex stdcall attribute
472 @cindex regparm attribute
473 @cindex dllexport attribute
475 @item The keyword @code{__attribute__} is handled to specify variable or
476 function attributes. The following attributes are supported:
477   @itemize
479   @item @code{aligned(n)}: align a variable or a structure field to n bytes
480 (must be a power of two).
482   @item @code{packed}: force alignment of a variable or a structure field to
483   1.
485   @item @code{section(name)}: generate function or data in assembly section
486 name (name is a string containing the section name) instead of the default
487 section.
489   @item @code{unused}: specify that the variable or the function is unused.
491   @item @code{cdecl}: use standard C calling convention (default).
493   @item @code{stdcall}: use Pascal-like calling convention.
495   @item @code{regparm(n)}: use fast i386 calling convention. @var{n} must be
496 between 1 and 3. The first @var{n} function parameters are respectively put in
497 registers @code{%eax}, @code{%edx} and @code{%ecx}.
499   @item @code{dllexport}: export function from dll/executable (win32 only)
501   @end itemize
503 Here are some examples:
504 @example
505     int a __attribute__ ((aligned(8), section(".mysection")));
506 @end example
508 @noindent
509 align variable @code{a} to 8 bytes and put it in section @code{.mysection}.
511 @example
512     int my_add(int a, int b) __attribute__ ((section(".mycodesection"))) 
513     @{
514         return a + b;
515     @}
516 @end example
518 @noindent
519 generate function @code{my_add} in section @code{.mycodesection}.
521 @item GNU style variadic macros:
522 @example
523     #define dprintf(fmt, args@dots{}) printf(fmt, ## args)
525     dprintf("no arg\n");
526     dprintf("one arg %d\n", 1);
527 @end example
529 @item @code{__FUNCTION__} is interpreted as C99 @code{__func__} 
530 (so it has not exactly the same semantics as string literal GNUC
531 where it is a string literal).
533 @item The @code{__alignof__} keyword can be used as @code{sizeof} 
534 to get the alignment of a type or an expression.
536 @item The @code{typeof(x)} returns the type of @code{x}. 
537 @code{x} is an expression or a type.
539 @item Computed gotos: @code{&&label} returns a pointer of type 
540 @code{void *} on the goto label @code{label}. @code{goto *expr} can be
541 used to jump on the pointer resulting from @code{expr}.
543 @item Inline assembly with asm instruction:
544 @cindex inline assembly
545 @cindex assembly, inline
546 @cindex __asm__
547 @example
548 static inline void * my_memcpy(void * to, const void * from, size_t n)
550 int d0, d1, d2;
551 __asm__ __volatile__(
552         "rep ; movsl\n\t"
553         "testb $2,%b4\n\t"
554         "je 1f\n\t"
555         "movsw\n"
556         "1:\ttestb $1,%b4\n\t"
557         "je 2f\n\t"
558         "movsb\n"
559         "2:"
560         : "=&c" (d0), "=&D" (d1), "=&S" (d2)
561         :"0" (n/4), "q" (n),"1" ((long) to),"2" ((long) from)
562         : "memory");
563 return (to);
565 @end example
567 @noindent
568 @cindex gas
569 TCC includes its own x86 inline assembler with a @code{gas}-like (GNU
570 assembler) syntax. No intermediate files are generated. GCC 3.x named
571 operands are supported.
573 @item @code{__builtin_types_compatible_p()} and @code{__builtin_constant_p()} 
574 are supported.
576 @item @code{#pragma pack} is supported for win32 compatibility.
578 @end itemize
580 @section TinyCC extensions
582 @itemize
584 @item @code{__TINYC__} is a predefined macro to @code{1} to
585 indicate that you use TCC.
587 @item @code{#!} at the start of a line is ignored to allow scripting.
589 @item Binary digits can be entered (@code{0b101} instead of
590 @code{5}).
592 @item @code{__BOUNDS_CHECKING_ON} is defined if bound checking is activated.
594 @end itemize
596 @node asm
597 @chapter TinyCC Assembler
599 Since version 0.9.16, TinyCC integrates its own assembler. TinyCC
600 assembler supports a gas-like syntax (GNU assembler). You can
601 desactivate assembler support if you want a smaller TinyCC executable
602 (the C compiler does not rely on the assembler).
604 TinyCC Assembler is used to handle files with @file{.S} (C
605 preprocessed assembler) and @file{.s} extensions. It is also used to
606 handle the GNU inline assembler with the @code{asm} keyword.
608 @section Syntax
610 TinyCC Assembler supports most of the gas syntax. The tokens are the
611 same as C.
613 @itemize
615 @item C and C++ comments are supported.
617 @item Identifiers are the same as C, so you cannot use '.' or '$'.
619 @item Only 32 bit integer numbers are supported.
621 @end itemize
623 @section Expressions
625 @itemize
627 @item Integers in decimal, octal and hexa are supported.
629 @item Unary operators: +, -, ~.
631 @item Binary operators in decreasing priority order:
633 @enumerate
634 @item *, /, %
635 @item &, |, ^
636 @item +, -
637 @end enumerate
639 @item A value is either an absolute number or a label plus an offset. 
640 All operators accept absolute values except '+' and '-'. '+' or '-' can be
641 used to add an offset to a label. '-' supports two labels only if they
642 are the same or if they are both defined and in the same section.
644 @end itemize
646 @section Labels
648 @itemize
650 @item All labels are considered as local, except undefined ones.
652 @item Numeric labels can be used as local @code{gas}-like labels. 
653 They can be defined several times in the same source. Use 'b'
654 (backward) or 'f' (forward) as suffix to reference them:
656 @example
657  1:
658       jmp 1b /* jump to '1' label before */
659       jmp 1f /* jump to '1' label after */
660  1:
661 @end example
663 @end itemize
665 @section Directives
666 @cindex assembler directives
667 @cindex directives, assembler
668 @cindex align directive
669 @cindex skip directive
670 @cindex space directive
671 @cindex byte directive
672 @cindex word directive
673 @cindex short directive
674 @cindex int directive
675 @cindex long directive
676 @cindex quad directive
677 @cindex globl directive
678 @cindex global directive
679 @cindex section directive
680 @cindex text directive
681 @cindex data directive
682 @cindex bss directive
683 @cindex fill directive
684 @cindex org directive
685 @cindex previous directive
686 @cindex string directive
687 @cindex asciz directive
688 @cindex ascii directive
690 All directives are preceeded by a '.'. The following directives are
691 supported:
693 @itemize
694 @item .align n[,value]
695 @item .skip n[,value]
696 @item .space n[,value]
697 @item .byte value1[,...]
698 @item .word value1[,...]
699 @item .short value1[,...]
700 @item .int value1[,...]
701 @item .long value1[,...]
702 @item .quad immediate_value1[,...]
703 @item .globl symbol
704 @item .global symbol
705 @item .section section
706 @item .text
707 @item .data
708 @item .bss
709 @item .fill repeat[,size[,value]]
710 @item .org n
711 @item .previous
712 @item .string string[,...]
713 @item .asciz string[,...]
714 @item .ascii string[,...]
715 @end itemize
717 @section X86 Assembler
718 @cindex assembler
720 All X86 opcodes are supported. Only ATT syntax is supported (source
721 then destination operand order). If no size suffix is given, TinyCC
722 tries to guess it from the operand sizes.
724 Currently, MMX opcodes are supported but not SSE ones.
726 @node linker
727 @chapter TinyCC Linker
728 @cindex linker
730 @section ELF file generation
731 @cindex ELF
733 TCC can directly output relocatable ELF files (object files),
734 executable ELF files and dynamic ELF libraries without relying on an
735 external linker.
737 Dynamic ELF libraries can be output but the C compiler does not generate
738 position independent code (PIC). It means that the dynamic library
739 code generated by TCC cannot be factorized among processes yet.
741 TCC linker eliminates unreferenced object code in libraries. A single pass is
742 done on the object and library list, so the order in which object files and
743 libraries are specified is important (same constraint as GNU ld). No grouping
744 options (@option{--start-group} and @option{--end-group}) are supported.
746 @section ELF file loader
748 TCC can load ELF object files, archives (.a files) and dynamic
749 libraries (.so).
751 @section PE-i386 file generation
752 @cindex PE-i386
754 TCC for Windows supports the native Win32 executable file format (PE-i386).  It
755 generates EXE files (console and gui) and DLL files.
757 For usage on Windows, see also tcc-win32.txt.
759 @section GNU Linker Scripts
760 @cindex scripts, linker
761 @cindex linker scripts
762 @cindex GROUP, linker command
763 @cindex FILE, linker command
764 @cindex OUTPUT_FORMAT, linker command
765 @cindex TARGET, linker command
767 Because on many Linux systems some dynamic libraries (such as
768 @file{/usr/lib/libc.so}) are in fact GNU ld link scripts (horrible!),
769 the TCC linker also supports a subset of GNU ld scripts.
771 The @code{GROUP} and @code{FILE} commands are supported. @code{OUTPUT_FORMAT}
772 and @code{TARGET} are ignored.
774 Example from @file{/usr/lib/libc.so}:
775 @example
776 /* GNU ld script
777    Use the shared library, but some functions are only in
778    the static library, so try that secondarily.  */
779 GROUP ( /lib/libc.so.6 /usr/lib/libc_nonshared.a )
780 @end example
782 @node Bounds
783 @chapter TinyCC Memory and Bound checks
784 @cindex bound checks
785 @cindex memory checks
787 This feature is activated with the @option{-b} (@pxref{Invoke}).
789 Note that pointer size is @emph{unchanged} and that code generated
790 with bound checks is @emph{fully compatible} with unchecked
791 code. When a pointer comes from unchecked code, it is assumed to be
792 valid. Even very obscure C code with casts should work correctly.
794 For more information about the ideas behind this method, see
795 @url{http://www.doc.ic.ac.uk/~phjk/BoundsChecking.html}.
797 Here are some examples of caught errors:
799 @table @asis
801 @item Invalid range with standard string function:
802 @example
804     char tab[10];
805     memset(tab, 0, 11);
807 @end example
809 @item Out of bounds-error in global or local arrays:
810 @example
812     int tab[10];
813     for(i=0;i<11;i++) @{
814         sum += tab[i];
815     @}
817 @end example
819 @item Out of bounds-error in malloc'ed data:
820 @example
822     int *tab;
823     tab = malloc(20 * sizeof(int));
824     for(i=0;i<21;i++) @{
825         sum += tab4[i];
826     @}
827     free(tab);
829 @end example
831 @item Access of freed memory:
832 @example
834     int *tab;
835     tab = malloc(20 * sizeof(int));
836     free(tab);
837     for(i=0;i<20;i++) @{
838         sum += tab4[i];
839     @}
841 @end example
843 @item Double free:
844 @example
846     int *tab;
847     tab = malloc(20 * sizeof(int));
848     free(tab);
849     free(tab);
851 @end example
853 @end table
855 @node Libtcc
856 @chapter The @code{libtcc} library
858 The @code{libtcc} library enables you to use TCC as a backend for
859 dynamic code generation. 
861 Read the @file{libtcc.h} to have an overview of the API. Read
862 @file{libtcc_test.c} to have a very simple example.
864 The idea consists in giving a C string containing the program you want
865 to compile directly to @code{libtcc}. Then you can access to any global
866 symbol (function or variable) defined.
868 @node devel
869 @chapter Developer's guide
871 This chapter gives some hints to understand how TCC works. You can skip
872 it if you do not intend to modify the TCC code.
874 @section File reading
876 The @code{BufferedFile} structure contains the context needed to read a
877 file, including the current line number. @code{tcc_open()} opens a new
878 file and @code{tcc_close()} closes it. @code{inp()} returns the next
879 character.
881 @section Lexer
883 @code{next()} reads the next token in the current
884 file. @code{next_nomacro()} reads the next token without macro
885 expansion.
887 @code{tok} contains the current token (see @code{TOK_xxx})
888 constants. Identifiers and keywords are also keywords. @code{tokc}
889 contains additional infos about the token (for example a constant value
890 if number or string token).
892 @section Parser
894 The parser is hardcoded (yacc is not necessary). It does only one pass,
895 except:
897 @itemize
899 @item For initialized arrays with unknown size, a first pass 
900 is done to count the number of elements.
902 @item For architectures where arguments are evaluated in 
903 reverse order, a first pass is done to reverse the argument order.
905 @end itemize
907 @section Types
909 The types are stored in a single 'int' variable. It was choosen in the
910 first stages of development when tcc was much simpler. Now, it may not
911 be the best solution.
913 @example
914 #define VT_INT        0  /* integer type */
915 #define VT_BYTE       1  /* signed byte type */
916 #define VT_SHORT      2  /* short type */
917 #define VT_VOID       3  /* void type */
918 #define VT_PTR        4  /* pointer */
919 #define VT_ENUM       5  /* enum definition */
920 #define VT_FUNC       6  /* function type */
921 #define VT_STRUCT     7  /* struct/union definition */
922 #define VT_FLOAT      8  /* IEEE float */
923 #define VT_DOUBLE     9  /* IEEE double */
924 #define VT_LDOUBLE   10  /* IEEE long double */
925 #define VT_BOOL      11  /* ISOC99 boolean type */
926 #define VT_LLONG     12  /* 64 bit integer */
927 #define VT_LONG      13  /* long integer (NEVER USED as type, only
928                             during parsing) */
929 #define VT_BTYPE      0x000f /* mask for basic type */
930 #define VT_UNSIGNED   0x0010  /* unsigned type */
931 #define VT_ARRAY      0x0020  /* array type (also has VT_PTR) */
932 #define VT_VLA        0x20000 /* VLA type (also has VT_PTR and VT_ARRAY) */
933 #define VT_BITFIELD   0x0040  /* bitfield modifier */
934 #define VT_CONSTANT   0x0800  /* const modifier */
935 #define VT_VOLATILE   0x1000  /* volatile modifier */
936 #define VT_SIGNED     0x2000  /* signed type */
938 #define VT_STRUCT_SHIFT 18   /* structure/enum name shift (14 bits left) */
939 @end example
941 When a reference to another type is needed (for pointers, functions and
942 structures), the @code{32 - VT_STRUCT_SHIFT} high order bits are used to
943 store an identifier reference.
945 The @code{VT_UNSIGNED} flag can be set for chars, shorts, ints and long
946 longs.
948 Arrays are considered as pointers @code{VT_PTR} with the flag
949 @code{VT_ARRAY} set. Variable length arrays are considered as special
950 arrays and have flag @code{VT_VLA} set instead of @code{VT_ARRAY}.
952 The @code{VT_BITFIELD} flag can be set for chars, shorts, ints and long
953 longs. If it is set, then the bitfield position is stored from bits
954 VT_STRUCT_SHIFT to VT_STRUCT_SHIFT + 5 and the bit field size is stored
955 from bits VT_STRUCT_SHIFT + 6 to VT_STRUCT_SHIFT + 11.
957 @code{VT_LONG} is never used except during parsing.
959 During parsing, the storage of an object is also stored in the type
960 integer:
962 @example
963 #define VT_EXTERN  0x00000080  /* extern definition */
964 #define VT_STATIC  0x00000100  /* static variable */
965 #define VT_TYPEDEF 0x00000200  /* typedef definition */
966 #define VT_INLINE  0x00000400  /* inline definition */
967 #define VT_IMPORT  0x00004000  /* win32: extern data imported from dll */
968 #define VT_EXPORT  0x00008000  /* win32: data exported from dll */
969 #define VT_WEAK    0x00010000  /* win32: data exported from dll */
970 @end example
972 @section Symbols
974 All symbols are stored in hashed symbol stacks. Each symbol stack
975 contains @code{Sym} structures.
977 @code{Sym.v} contains the symbol name (remember
978 an idenfier is also a token, so a string is never necessary to store
979 it). @code{Sym.t} gives the type of the symbol. @code{Sym.r} is usually
980 the register in which the corresponding variable is stored. @code{Sym.c} is
981 usually a constant associated to the symbol like its address for normal
982 symbols, and the number of entries for symbols representing arrays.
983 Variable length array types use @code{Sym.c} as a location on the stack
984 which holds the runtime sizeof for the type.
986 Four main symbol stacks are defined:
988 @table @code
990 @item define_stack
991 for the macros (@code{#define}s).
993 @item global_stack
994 for the global variables, functions and types.
996 @item local_stack
997 for the local variables, functions and types.
999 @item global_label_stack
1000 for the local labels (for @code{goto}).
1002 @item label_stack
1003 for GCC block local labels (see the @code{__label__} keyword).
1005 @end table
1007 @code{sym_push()} is used to add a new symbol in the local symbol
1008 stack. If no local symbol stack is active, it is added in the global
1009 symbol stack.
1011 @code{sym_pop(st,b)} pops symbols from the symbol stack @var{st} until
1012 the symbol @var{b} is on the top of stack. If @var{b} is NULL, the stack
1013 is emptied.
1015 @code{sym_find(v)} return the symbol associated to the identifier
1016 @var{v}. The local stack is searched first from top to bottom, then the
1017 global stack.
1019 @section Sections
1021 The generated code and datas are written in sections. The structure
1022 @code{Section} contains all the necessary information for a given
1023 section. @code{new_section()} creates a new section. ELF file semantics
1024 is assumed for each section.
1026 The following sections are predefined:
1028 @table @code
1030 @item text_section
1031 is the section containing the generated code. @var{ind} contains the
1032 current position in the code section.
1034 @item data_section
1035 contains initialized data
1037 @item bss_section
1038 contains uninitialized data
1040 @item bounds_section
1041 @itemx lbounds_section
1042 are used when bound checking is activated
1044 @item stab_section
1045 @itemx stabstr_section
1046 are used when debugging is actived to store debug information
1048 @item symtab_section
1049 @itemx strtab_section
1050 contain the exported symbols (currently only used for debugging).
1052 @end table
1054 @section Code generation
1055 @cindex code generation
1057 @subsection Introduction
1059 The TCC code generator directly generates linked binary code in one
1060 pass. It is rather unusual these days (see gcc for example which
1061 generates text assembly), but it can be very fast and surprisingly
1062 little complicated.
1064 The TCC code generator is register based. Optimization is only done at
1065 the expression level. No intermediate representation of expression is
1066 kept except the current values stored in the @emph{value stack}.
1068 On x86, three temporary registers are used. When more registers are
1069 needed, one register is spilled into a new temporary variable on the stack.
1071 @subsection The value stack
1072 @cindex value stack, introduction
1074 When an expression is parsed, its value is pushed on the value stack
1075 (@var{vstack}). The top of the value stack is @var{vtop}. Each value
1076 stack entry is the structure @code{SValue}.
1078 @code{SValue.t} is the type. @code{SValue.r} indicates how the value is
1079 currently stored in the generated code. It is usually a CPU register
1080 index (@code{REG_xxx} constants), but additional values and flags are
1081 defined:
1083 @example
1084 #define VT_CONST     0x00f0
1085 #define VT_LLOCAL    0x00f1
1086 #define VT_LOCAL     0x00f2
1087 #define VT_CMP       0x00f3
1088 #define VT_JMP       0x00f4
1089 #define VT_JMPI      0x00f5
1090 #define VT_LVAL      0x0100
1091 #define VT_SYM       0x0200
1092 #define VT_MUSTCAST  0x0400
1093 #define VT_MUSTBOUND 0x0800
1094 #define VT_BOUNDED   0x8000
1095 #define VT_LVAL_BYTE     0x1000
1096 #define VT_LVAL_SHORT    0x2000
1097 #define VT_LVAL_UNSIGNED 0x4000
1098 #define VT_LVAL_TYPE     (VT_LVAL_BYTE | VT_LVAL_SHORT | VT_LVAL_UNSIGNED)
1099 @end example
1101 @table @code
1103 @item VT_CONST
1104 indicates that the value is a constant. It is stored in the union
1105 @code{SValue.c}, depending on its type.
1107 @item VT_LOCAL
1108 indicates a local variable pointer at offset @code{SValue.c.i} in the
1109 stack.
1111 @item VT_CMP
1112 indicates that the value is actually stored in the CPU flags (i.e. the
1113 value is the consequence of a test). The value is either 0 or 1. The
1114 actual CPU flags used is indicated in @code{SValue.c.i}. 
1116 If any code is generated which destroys the CPU flags, this value MUST be
1117 put in a normal register.
1119 @item VT_JMP
1120 @itemx VT_JMPI
1121 indicates that the value is the consequence of a conditional jump. For VT_JMP,
1122 it is 1 if the jump is taken, 0 otherwise. For VT_JMPI it is inverted.
1124 These values are used to compile the @code{||} and @code{&&} logical
1125 operators.
1127 If any code is generated, this value MUST be put in a normal
1128 register. Otherwise, the generated code won't be executed if the jump is
1129 taken.
1131 @item VT_LVAL
1132 is a flag indicating that the value is actually an lvalue (left value of
1133 an assignment). It means that the value stored is actually a pointer to
1134 the wanted value. 
1136 Understanding the use @code{VT_LVAL} is very important if you want to
1137 understand how TCC works.
1139 @item VT_LVAL_BYTE
1140 @itemx VT_LVAL_SHORT
1141 @itemx VT_LVAL_UNSIGNED
1142 if the lvalue has an integer type, then these flags give its real
1143 type. The type alone is not enough in case of cast optimisations.
1145 @item VT_LLOCAL
1146 is a saved lvalue on the stack. @code{VT_LLOCAL} should be eliminated
1147 ASAP because its semantics are rather complicated.
1149 @item VT_MUSTCAST
1150 indicates that a cast to the value type must be performed if the value
1151 is used (lazy casting).
1153 @item VT_SYM
1154 indicates that the symbol @code{SValue.sym} must be added to the constant.
1156 @item VT_MUSTBOUND
1157 @itemx VT_BOUNDED
1158 are only used for optional bound checking.
1160 @end table
1162 @subsection Manipulating the value stack
1163 @cindex value stack
1165 @code{vsetc()} and @code{vset()} pushes a new value on the value
1166 stack. If the previous @var{vtop} was stored in a very unsafe place(for
1167 example in the CPU flags), then some code is generated to put the
1168 previous @var{vtop} in a safe storage.
1170 @code{vpop()} pops @var{vtop}. In some cases, it also generates cleanup
1171 code (for example if stacked floating point registers are used as on
1172 x86).
1174 The @code{gv(rc)} function generates code to evaluate @var{vtop} (the
1175 top value of the stack) into registers. @var{rc} selects in which
1176 register class the value should be put. @code{gv()} is the @emph{most
1177 important function} of the code generator.
1179 @code{gv2()} is the same as @code{gv()} but for the top two stack
1180 entries.
1182 @subsection CPU dependent code generation
1183 @cindex CPU dependent
1184 See the @file{i386-gen.c} file to have an example.
1186 @table @code
1188 @item load()
1189 must generate the code needed to load a stack value into a register.
1191 @item store()
1192 must generate the code needed to store a register into a stack value
1193 lvalue.
1195 @item gfunc_start()
1196 @itemx gfunc_param()
1197 @itemx gfunc_call()
1198 should generate a function call
1200 @item gfunc_prolog()
1201 @itemx gfunc_epilog()
1202 should generate a function prolog/epilog.
1204 @item gen_opi(op)
1205 must generate the binary integer operation @var{op} on the two top
1206 entries of the stack which are guaranted to contain integer types.
1208 The result value should be put on the stack.
1210 @item gen_opf(op)
1211 same as @code{gen_opi()} for floating point operations. The two top
1212 entries of the stack are guaranted to contain floating point values of
1213 same types.
1215 @item gen_cvt_itof()
1216 integer to floating point conversion.
1218 @item gen_cvt_ftoi()
1219 floating point to integer conversion.
1221 @item gen_cvt_ftof()
1222 floating point to floating point of different size conversion.
1224 @item gen_bounded_ptr_add()
1225 @item gen_bounded_ptr_deref()
1226 are only used for bounds checking.
1228 @end table
1230 @section Optimizations done
1231 @cindex optimizations
1232 @cindex constant propagation
1233 @cindex strength reduction
1234 @cindex comparison operators
1235 @cindex caching processor flags
1236 @cindex flags, caching
1237 @cindex jump optimization
1238 Constant propagation is done for all operations. Multiplications and
1239 divisions are optimized to shifts when appropriate. Comparison
1240 operators are optimized by maintaining a special cache for the
1241 processor flags. &&, || and ! are optimized by maintaining a special
1242 'jump target' value. No other jump optimization is currently performed
1243 because it would require to store the code in a more abstract fashion.
1245 @unnumbered Concept Index
1246 @printindex cp
1248 @bye
1250 @c Local variables:
1251 @c fill-column: 78
1252 @c texinfo-column-for-description: 32
1253 @c End: