Control symbol table of which to relocate symbols
[tinycc.git] / tcc-doc.texi
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @setfilename
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{}.
71 For usage on Windows, see also @url{tcc-win32.txt}.
73 @node Invoke
74 @chapter Command line invocation
76 @section Quick start
78 @example
79 @c man begin SYNOPSIS
80 usage: tcc [options] [@var{infile1} @var{infile2}@dots{}] [@option{-run} @var{infile} @var{args}@dots{}]
81 @c man end
82 @end example
84 @noindent
85 @c man begin DESCRIPTION
86 TCC options are a very much like gcc options. The main difference is that TCC
87 can also execute directly the resulting program and give it runtime
88 arguments.
90 Here are some examples to understand the logic:
92 @table @code
93 @item @samp{tcc -run a.c}
94 Compile @file{a.c} and execute it directly
96 @item @samp{tcc -run a.c arg1}
97 Compile a.c and execute it directly. arg1 is given as first argument to
98 the @code{main()} of a.c.
100 @item @samp{tcc a.c -run b.c arg1}
101 Compile @file{a.c} and @file{b.c}, link them together and execute them. arg1 is given
102 as first argument to the @code{main()} of the resulting program. 
103 @ignore 
104 Because multiple C files are specified, @option{--} are necessary to clearly 
105 separate the program arguments from the TCC options.
106 @end ignore
108 @item @samp{tcc -o myprog a.c b.c}
109 Compile @file{a.c} and @file{b.c}, link them and generate the executable @file{myprog}.
111 @item @samp{tcc -o myprog a.o b.o}
112 link @file{a.o} and @file{b.o} together and generate the executable @file{myprog}.
114 @item @samp{tcc -c a.c}
115 Compile @file{a.c} and generate object file @file{a.o}.
117 @item @samp{tcc -c asmfile.S}
118 Preprocess with C preprocess and assemble @file{asmfile.S} and generate
119 object file @file{asmfile.o}.
121 @item @samp{tcc -c asmfile.s}
122 Assemble (but not preprocess) @file{asmfile.s} and generate object file
123 @file{asmfile.o}.
125 @item @samp{tcc -r -o ab.o a.c b.c}
126 Compile @file{a.c} and @file{b.c}, link them together and generate the object file @file{ab.o}.
128 @end table
130 Scripting:
132 TCC can be invoked from @emph{scripts}, just as shell scripts. You just
133 need to add @code{#!/usr/local/bin/tcc -run} at the start of your C source:
135 @example
136 #!/usr/local/bin/tcc -run
137 #include <stdio.h>
139 int main() 
141     printf("Hello World\n");
142     return 0;
144 @end example
146 TCC can read C source code from @emph{standard input} when @option{-} is used in 
147 place of @option{infile}. Example:
149 @example
150 echo 'main()@{puts("hello");@}' | tcc -run -
151 @end example
152 @c man end
154 @section Option summary
156 General Options:
158 @c man begin OPTIONS
159 @table @option
160 @item -c
161 Generate an object file.
163 @item -o outfile
164 Put object file, executable, or dll into output file @file{outfile}.
166 @item -run source [args...]
167 Compile file @var{source} and run it with the command line arguments
168 @var{args}. In order to be able to give more than one argument to a
169 script, several TCC options can be given @emph{after} the
170 @option{-run} option, separated by spaces:
171 @example
172 tcc "-run -L/usr/X11R6/lib -lX11" ex4.c
173 @end example
174 In a script, it gives the following header:
175 @example
176 #!/usr/local/bin/tcc -run -L/usr/X11R6/lib -lX11
177 @end example
179 @item -mms-bitfields
180 Use an algorithm for bitfield alignment consistent with MSVC. Default is
181 gcc's algorithm.
183 @item -mfloat-abi (ARM only)
184 Select the float ABI. Possible values: @code{softfp} and @code{hard}
186 @item -dumpversion
187 Print only the compiler version and nothing else.
189 @item -v
190 Display TCC version.
192 @item -vv
193 Show included files.  As sole argument, print search dirs (as below).
195 @item -bench
196 Display compilation statistics.
198 @item -print-search-dirs
199 Print the configured installation directory and a list of library
200 and include directories tcc will search.
202 @end table
204 Preprocessor options:
206 @table @option
207 @item -Idir
208 Specify an additional include path. Include paths are searched in the
209 order they are specified.
211 System include paths are always searched after. The default system
212 include paths are: @file{/usr/local/include}, @file{/usr/include}
213 and @file{PREFIX/lib/tcc/include}. (@file{PREFIX} is usually
214 @file{/usr} or @file{/usr/local}).
216 @item -Dsym[=val]
217 Define preprocessor symbol @samp{sym} to
218 val. If val is not present, its value is @samp{1}. Function-like macros can
219 also be defined: @option{-DF(a)=a+1}
221 @item -Usym
222 Undefine preprocessor symbol @samp{sym}.
223 @end table
225 Compilation flags:
227 Note: each of the following options has a negative form beginning with
228 @option{-fno-}.
230 @table @option
231 @item -funsigned-char
232 Let the @code{char} type be unsigned.
234 @item -fsigned-char
235 Let the @code{char} type be signed.
237 @item -fno-common
238 Do not generate common symbols for uninitialized data.
240 @item -fleading-underscore
241 Add a leading underscore at the beginning of each C symbol.
243 @item -fms-extensions
244 Allow a MS C compiler extensions to the language. Currently this
245 assumes a nested named structure declaration without an identifier
246 behaves like an unnamed one.
248 @item -fdollars-in-identifiers
249 Allow dollar signs in identifiers
251 @end table
253 Warning options:
255 @table @option
256 @item -w
257 Disable all warnings.
259 @end table
261 Note: each of the following warning options has a negative form beginning with
262 @option{-Wno-}.
264 @table @option
265 @item -Wimplicit-function-declaration
266 Warn about implicit function declaration.
268 @item -Wunsupported
269 Warn about unsupported GCC features that are ignored by TCC.
271 @item -Wwrite-strings
272 Make string constants be of type @code{const char *} instead of @code{char
275 @item -Werror
276 Abort compilation if warnings are issued.
278 @item -Wall 
279 Activate all warnings, except @option{-Werror}, @option{-Wunusupported} and
280 @option{-Wwrite-strings}.
282 @end table
284 Linker options:
286 @table @option
287 @item -Ldir
288 Specify an additional static library path for the @option{-l} option. The
289 default library paths are @file{/usr/local/lib}, @file{/usr/lib} and @file{/lib}.
291 @item -lxxx
292 Link your program with dynamic library or static library
293 libxxx.a. The library is searched in the paths specified by the
294 @option{-L} option and @env{LIBRARY_PATH} variable.
296 @item -Bdir
297 Set the path where the tcc internal libraries (and include files) can be
298 found (default is @file{PREFIX/lib/tcc}).
300 @item -shared
301 Generate a shared library instead of an executable.
303 @item -soname name
304 set name for shared library to be used at runtime
306 @item -static
307 Generate a statically linked executable (default is a shared linked
308 executable).
310 @item -rdynamic
311 Export global symbols to the dynamic linker. It is useful when a library
312 opened with @code{dlopen()} needs to access executable symbols.
314 @item -r
315 Generate an object file combining all input files.
317 @item -Wl,-rpath=path
318 Put custom search path for dynamic libraries into executable.
320 @item -Wl,--oformat=fmt
321 Use @var{fmt} as output format. The supported output formats are:
322 @table @code
323 @item elf32-i386
324 ELF output format (default)
325 @item binary
326 Binary image (only for executable output)
327 @item coff
328 COFF output format (only for executable output for TMS320C67xx target)
329 @end table
331 @item -Wl,-subsystem=console/gui/wince/...
332 Set type for PE (Windows) executables.
334 @item -Wl,-[Ttext=# | section-alignment=# | file-alignment=# | image-base=# | stack=#]
335 Modify executable layout.
337 @item -Wl,-Bsymbolic
338 Set DT_SYMBOLIC tag.
340 @end table
342 Debugger options:
344 @table @option
345 @item -g
346 Generate run time debug information so that you get clear run time
347 error messages: @code{ test.c:68: in function 'test5()': dereferencing
348 invalid pointer} instead of the laconic @code{Segmentation
349 fault}.
351 @item -b
352 Generate additional support code to check
353 memory allocations and array/pointer bounds. @option{-g} is implied. Note
354 that the generated code is slower and bigger in this case.
356 Note: @option{-b} is only available on i386 when using libtcc for the moment.
358 @item -bt N
359 Display N callers in stack traces. This is useful with @option{-g} or
360 @option{-b}.
362 @end table
364 Misc options:
366 @table @option
367 @item -MD
368 Generate makefile fragment with dependencies.
370 @item -MF depfile
371 Use @file{depfile} as output for -MD.
373 @end table
375 Note: GCC options @option{-Ox}, @option{-fx} and @option{-mx} are
376 ignored.
377 @c man end
379 @c man begin ENVIRONMENT
380 Environment variables that affect how tcc operates.
382 @table @option
384 @item CPATH
385 @item C_INCLUDE_PATH
386 A colon-separated list of directories searched for include files,
387 directories given with @option{-I} are searched first.
389 @item LIBRARY_PATH
390 A colon-separated list of directories searched for libraries for the
391 @option{-l} option, directories given with @option{-L} are searched first.
393 @end table
395 @c man end
397 @ignore
399 @setfilename tcc
400 @settitle Tiny C Compiler
402 @c man begin SEEALSO
403 cpp(1),
404 gcc(1)
405 @c man end
407 @c man begin AUTHOR
408 Fabrice Bellard
409 @c man end
411 @end ignore
413 @node Clang
414 @chapter C language support
416 @section ANSI C
418 TCC implements all the ANSI C standard, including structure bit fields
419 and floating point numbers (@code{long double}, @code{double}, and
420 @code{float} fully supported).
422 @section ISOC99 extensions
424 TCC implements many features of the new C standard: ISO C99. Currently
425 missing items are: complex and imaginary numbers.
427 Currently implemented ISOC99 features:
429 @itemize
431 @item variable length arrays.
433 @item 64 bit @code{long long} types are fully supported.
435 @item The boolean type @code{_Bool} is supported.
437 @item @code{__func__} is a string variable containing the current
438 function name.
440 @item Variadic macros: @code{__VA_ARGS__} can be used for
441    function-like macros:
442 @example
443     #define dprintf(level, __VA_ARGS__) printf(__VA_ARGS__)
444 @end example
446 @noindent
447 @code{dprintf} can then be used with a variable number of parameters.
449 @item Declarations can appear anywhere in a block (as in C++).
451 @item Array and struct/union elements can be initialized in any order by
452   using designators:
453 @example
454     struct @{ int x, y; @} st[10] = @{ [0].x = 1, [0].y = 2 @};
456     int tab[10] = @{ 1, 2, [5] = 5, [9] = 9@};
457 @end example
459 @item Compound initializers are supported:
460 @example
461     int *p = (int [])@{ 1, 2, 3 @};
462 @end example
463 to initialize a pointer pointing to an initialized array. The same
464 works for structures and strings.
466 @item Hexadecimal floating point constants are supported:
467 @example
468           double d = 0x1234p10;
469 @end example
471 @noindent
472 is the same as writing 
473 @example
474           double d = 4771840.0;
475 @end example
477 @item @code{inline} keyword is ignored.
479 @item @code{restrict} keyword is ignored.
480 @end itemize
482 @section GNU C extensions
484 TCC implements some GNU C extensions:
486 @itemize
488 @item array designators can be used without '=': 
489 @example
490     int a[10] = @{ [0] 1, [5] 2, 3, 4 @};
491 @end example
493 @item Structure field designators can be a label: 
494 @example
495     struct @{ int x, y; @} st = @{ x: 1, y: 1@};
496 @end example
497 instead of
498 @example
499     struct @{ int x, y; @} st = @{ .x = 1, .y = 1@};
500 @end example
502 @item @code{\e} is ASCII character 27.
504 @item case ranges : ranges can be used in @code{case}s:
505 @example
506     switch(a) @{
507     case 1 @dots{} 9:
508           printf("range 1 to 9\n");
509           break;
510     default:
511           printf("unexpected\n");
512           break;
513     @}
514 @end example
516 @cindex aligned attribute
517 @cindex packed attribute
518 @cindex section attribute
519 @cindex unused attribute
520 @cindex cdecl attribute
521 @cindex stdcall attribute
522 @cindex regparm attribute
523 @cindex dllexport attribute
525 @item The keyword @code{__attribute__} is handled to specify variable or
526 function attributes. The following attributes are supported:
527   @itemize
529   @item @code{aligned(n)}: align a variable or a structure field to n bytes
530 (must be a power of two).
532   @item @code{packed}: force alignment of a variable or a structure field to
533   1.
535   @item @code{section(name)}: generate function or data in assembly section
536 name (name is a string containing the section name) instead of the default
537 section.
539   @item @code{unused}: specify that the variable or the function is unused.
541   @item @code{cdecl}: use standard C calling convention (default).
543   @item @code{stdcall}: use Pascal-like calling convention.
545   @item @code{regparm(n)}: use fast i386 calling convention. @var{n} must be
546 between 1 and 3. The first @var{n} function parameters are respectively put in
547 registers @code{%eax}, @code{%edx} and @code{%ecx}.
549   @item @code{dllexport}: export function from dll/executable (win32 only)
551   @end itemize
553 Here are some examples:
554 @example
555     int a __attribute__ ((aligned(8), section(".mysection")));
556 @end example
558 @noindent
559 align variable @code{a} to 8 bytes and put it in section @code{.mysection}.
561 @example
562     int my_add(int a, int b) __attribute__ ((section(".mycodesection"))) 
563     @{
564         return a + b;
565     @}
566 @end example
568 @noindent
569 generate function @code{my_add} in section @code{.mycodesection}.
571 @item GNU style variadic macros:
572 @example
573     #define dprintf(fmt, args@dots{}) printf(fmt, ## args)
575     dprintf("no arg\n");
576     dprintf("one arg %d\n", 1);
577 @end example
579 @item @code{__FUNCTION__} is interpreted as C99 @code{__func__} 
580 (so it has not exactly the same semantics as string literal GNUC
581 where it is a string literal).
583 @item The @code{__alignof__} keyword can be used as @code{sizeof} 
584 to get the alignment of a type or an expression.
586 @item The @code{typeof(x)} returns the type of @code{x}. 
587 @code{x} is an expression or a type.
589 @item Computed gotos: @code{&&label} returns a pointer of type 
590 @code{void *} on the goto label @code{label}. @code{goto *expr} can be
591 used to jump on the pointer resulting from @code{expr}.
593 @item Inline assembly with asm instruction:
594 @cindex inline assembly
595 @cindex assembly, inline
596 @cindex __asm__
597 @example
598 static inline void * my_memcpy(void * to, const void * from, size_t n)
600 int d0, d1, d2;
601 __asm__ __volatile__(
602         "rep ; movsl\n\t"
603         "testb $2,%b4\n\t"
604         "je 1f\n\t"
605         "movsw\n"
606         "1:\ttestb $1,%b4\n\t"
607         "je 2f\n\t"
608         "movsb\n"
609         "2:"
610         : "=&c" (d0), "=&D" (d1), "=&S" (d2)
611         :"0" (n/4), "q" (n),"1" ((long) to),"2" ((long) from)
612         : "memory");
613 return (to);
615 @end example
617 @noindent
618 @cindex gas
619 TCC includes its own x86 inline assembler with a @code{gas}-like (GNU
620 assembler) syntax. No intermediate files are generated. GCC 3.x named
621 operands are supported.
623 @item @code{__builtin_types_compatible_p()} and @code{__builtin_constant_p()} 
624 are supported.
626 @item @code{#pragma pack} is supported for win32 compatibility.
628 @end itemize
630 @section TinyCC extensions
632 @itemize
634 @item @code{__TINYC__} is a predefined macro to indicate that you use TCC.
636 @item @code{#!} at the start of a line is ignored to allow scripting.
638 @item Binary digits can be entered (@code{0b101} instead of
639 @code{5}).
641 @item @code{__BOUNDS_CHECKING_ON} is defined if bound checking is activated.
643 @end itemize
645 @node asm
646 @chapter TinyCC Assembler
648 Since version 0.9.16, TinyCC integrates its own assembler. TinyCC
649 assembler supports a gas-like syntax (GNU assembler). You can
650 desactivate assembler support if you want a smaller TinyCC executable
651 (the C compiler does not rely on the assembler).
653 TinyCC Assembler is used to handle files with @file{.S} (C
654 preprocessed assembler) and @file{.s} extensions. It is also used to
655 handle the GNU inline assembler with the @code{asm} keyword.
657 @section Syntax
659 TinyCC Assembler supports most of the gas syntax. The tokens are the
660 same as C.
662 @itemize
664 @item C and C++ comments are supported.
666 @item Identifiers are the same as C, so you cannot use '.' or '$'.
668 @item Only 32 bit integer numbers are supported.
670 @end itemize
672 @section Expressions
674 @itemize
676 @item Integers in decimal, octal and hexa are supported.
678 @item Unary operators: +, -, ~.
680 @item Binary operators in decreasing priority order:
682 @enumerate
683 @item *, /, %
684 @item &, |, ^
685 @item +, -
686 @end enumerate
688 @item A value is either an absolute number or a label plus an offset. 
689 All operators accept absolute values except '+' and '-'. '+' or '-' can be
690 used to add an offset to a label. '-' supports two labels only if they
691 are the same or if they are both defined and in the same section.
693 @end itemize
695 @section Labels
697 @itemize
699 @item All labels are considered as local, except undefined ones.
701 @item Numeric labels can be used as local @code{gas}-like labels. 
702 They can be defined several times in the same source. Use 'b'
703 (backward) or 'f' (forward) as suffix to reference them:
705 @example
706  1:
707       jmp 1b /* jump to '1' label before */
708       jmp 1f /* jump to '1' label after */
709  1:
710 @end example
712 @end itemize
714 @section Directives
715 @cindex assembler directives
716 @cindex directives, assembler
717 @cindex align directive
718 @cindex skip directive
719 @cindex space directive
720 @cindex byte directive
721 @cindex word directive
722 @cindex short directive
723 @cindex int directive
724 @cindex long directive
725 @cindex quad directive
726 @cindex globl directive
727 @cindex global directive
728 @cindex section directive
729 @cindex text directive
730 @cindex data directive
731 @cindex bss directive
732 @cindex fill directive
733 @cindex org directive
734 @cindex previous directive
735 @cindex string directive
736 @cindex asciz directive
737 @cindex ascii directive
739 All directives are preceded by a '.'. The following directives are
740 supported:
742 @itemize
743 @item .align n[,value]
744 @item .skip n[,value]
745 @item .space n[,value]
746 @item .byte value1[,...]
747 @item .word value1[,...]
748 @item .short value1[,...]
749 @item .int value1[,...]
750 @item .long value1[,...]
751 @item .quad immediate_value1[,...]
752 @item .globl symbol
753 @item .global symbol
754 @item .section section
755 @item .text
756 @item .data
757 @item .bss
758 @item .fill repeat[,size[,value]]
759 @item .org n
760 @item .previous
761 @item .string string[,...]
762 @item .asciz string[,...]
763 @item .ascii string[,...]
764 @end itemize
766 @section X86 Assembler
767 @cindex assembler
769 All X86 opcodes are supported. Only ATT syntax is supported (source
770 then destination operand order). If no size suffix is given, TinyCC
771 tries to guess it from the operand sizes.
773 Currently, MMX opcodes are supported but not SSE ones.
775 @node linker
776 @chapter TinyCC Linker
777 @cindex linker
779 @section ELF file generation
780 @cindex ELF
782 TCC can directly output relocatable ELF files (object files),
783 executable ELF files and dynamic ELF libraries without relying on an
784 external linker.
786 Dynamic ELF libraries can be output but the C compiler does not generate
787 position independent code (PIC). It means that the dynamic library
788 code generated by TCC cannot be factorized among processes yet.
790 TCC linker eliminates unreferenced object code in libraries. A single pass is
791 done on the object and library list, so the order in which object files and
792 libraries are specified is important (same constraint as GNU ld). No grouping
793 options (@option{--start-group} and @option{--end-group}) are supported.
795 @section ELF file loader
797 TCC can load ELF object files, archives (.a files) and dynamic
798 libraries (.so).
800 @section PE-i386 file generation
801 @cindex PE-i386
803 TCC for Windows supports the native Win32 executable file format (PE-i386).  It
804 generates EXE files (console and gui) and DLL files.
806 For usage on Windows, see also tcc-win32.txt.
808 @section GNU Linker Scripts
809 @cindex scripts, linker
810 @cindex linker scripts
811 @cindex GROUP, linker command
812 @cindex FILE, linker command
813 @cindex OUTPUT_FORMAT, linker command
814 @cindex TARGET, linker command
816 Because on many Linux systems some dynamic libraries (such as
817 @file{/usr/lib/}) are in fact GNU ld link scripts (horrible!),
818 the TCC linker also supports a subset of GNU ld scripts.
820 The @code{GROUP} and @code{FILE} commands are supported. @code{OUTPUT_FORMAT}
821 and @code{TARGET} are ignored.
823 Example from @file{/usr/lib/}:
824 @example
825 /* GNU ld script
826    Use the shared library, but some functions are only in
827    the static library, so try that secondarily.  */
828 GROUP ( /lib/ /usr/lib/libc_nonshared.a )
829 @end example
831 @node Bounds
832 @chapter TinyCC Memory and Bound checks
833 @cindex bound checks
834 @cindex memory checks
836 This feature is activated with the @option{-b} (@pxref{Invoke}).
838 Note that pointer size is @emph{unchanged} and that code generated
839 with bound checks is @emph{fully compatible} with unchecked
840 code. When a pointer comes from unchecked code, it is assumed to be
841 valid. Even very obscure C code with casts should work correctly.
843 For more information about the ideas behind this method, see
844 @url{}.
846 Here are some examples of caught errors:
848 @table @asis
850 @item Invalid range with standard string function:
851 @example
853     char tab[10];
854     memset(tab, 0, 11);
856 @end example
858 @item Out of bounds-error in global or local arrays:
859 @example
861     int tab[10];
862     for(i=0;i<11;i++) @{
863         sum += tab[i];
864     @}
866 @end example
868 @item Out of bounds-error in malloc'ed data:
869 @example
871     int *tab;
872     tab = malloc(20 * sizeof(int));
873     for(i=0;i<21;i++) @{
874         sum += tab4[i];
875     @}
876     free(tab);
878 @end example
880 @item Access of freed memory:
881 @example
883     int *tab;
884     tab = malloc(20 * sizeof(int));
885     free(tab);
886     for(i=0;i<20;i++) @{
887         sum += tab4[i];
888     @}
890 @end example
892 @item Double free:
893 @example
895     int *tab;
896     tab = malloc(20 * sizeof(int));
897     free(tab);
898     free(tab);
900 @end example
902 @end table
904 @node Libtcc
905 @chapter The @code{libtcc} library
907 The @code{libtcc} library enables you to use TCC as a backend for
908 dynamic code generation. 
910 Read the @file{libtcc.h} to have an overview of the API. Read
911 @file{libtcc_test.c} to have a very simple example.
913 The idea consists in giving a C string containing the program you want
914 to compile directly to @code{libtcc}. Then you can access to any global
915 symbol (function or variable) defined.
917 @node devel
918 @chapter Developer's guide
920 This chapter gives some hints to understand how TCC works. You can skip
921 it if you do not intend to modify the TCC code.
923 @section File reading
925 The @code{BufferedFile} structure contains the context needed to read a
926 file, including the current line number. @code{tcc_open()} opens a new
927 file and @code{tcc_close()} closes it. @code{inp()} returns the next
928 character.
930 @section Lexer
932 @code{next()} reads the next token in the current
933 file. @code{next_nomacro()} reads the next token without macro
934 expansion.
936 @code{tok} contains the current token (see @code{TOK_xxx})
937 constants. Identifiers and keywords are also keywords. @code{tokc}
938 contains additional infos about the token (for example a constant value
939 if number or string token).
941 @section Parser
943 The parser is hardcoded (yacc is not necessary). It does only one pass,
944 except:
946 @itemize
948 @item For initialized arrays with unknown size, a first pass 
949 is done to count the number of elements.
951 @item For architectures where arguments are evaluated in 
952 reverse order, a first pass is done to reverse the argument order.
954 @end itemize
956 @section Types
958 The types are stored in a single 'int' variable. It was chosen in the
959 first stages of development when tcc was much simpler. Now, it may not
960 be the best solution.
962 @example
963 #define VT_INT        0  /* integer type */
964 #define VT_BYTE       1  /* signed byte type */
965 #define VT_SHORT      2  /* short type */
966 #define VT_VOID       3  /* void type */
967 #define VT_PTR        4  /* pointer */
968 #define VT_ENUM       5  /* enum definition */
969 #define VT_FUNC       6  /* function type */
970 #define VT_STRUCT     7  /* struct/union definition */
971 #define VT_FLOAT      8  /* IEEE float */
972 #define VT_DOUBLE     9  /* IEEE double */
973 #define VT_LDOUBLE   10  /* IEEE long double */
974 #define VT_BOOL      11  /* ISOC99 boolean type */
975 #define VT_LLONG     12  /* 64 bit integer */
976 #define VT_LONG      13  /* long integer (NEVER USED as type, only
977                             during parsing) */
978 #define VT_BTYPE      0x000f /* mask for basic type */
979 #define VT_UNSIGNED   0x0010  /* unsigned type */
980 #define VT_ARRAY      0x0020  /* array type (also has VT_PTR) */
981 #define VT_VLA        0x20000 /* VLA type (also has VT_PTR and VT_ARRAY) */
982 #define VT_BITFIELD   0x0040  /* bitfield modifier */
983 #define VT_CONSTANT   0x0800  /* const modifier */
984 #define VT_VOLATILE   0x1000  /* volatile modifier */
985 #define VT_DEFSIGN    0x2000  /* signed type */
987 #define VT_STRUCT_SHIFT 18   /* structure/enum name shift (14 bits left) */
988 @end example
990 When a reference to another type is needed (for pointers, functions and
991 structures), the @code{32 - VT_STRUCT_SHIFT} high order bits are used to
992 store an identifier reference.
994 The @code{VT_UNSIGNED} flag can be set for chars, shorts, ints and long
995 longs.
997 Arrays are considered as pointers @code{VT_PTR} with the flag
998 @code{VT_ARRAY} set. Variable length arrays are considered as special
999 arrays and have flag @code{VT_VLA} set instead of @code{VT_ARRAY}.
1001 The @code{VT_BITFIELD} flag can be set for chars, shorts, ints and long
1002 longs. If it is set, then the bitfield position is stored from bits
1003 VT_STRUCT_SHIFT to VT_STRUCT_SHIFT + 5 and the bit field size is stored
1004 from bits VT_STRUCT_SHIFT + 6 to VT_STRUCT_SHIFT + 11.
1006 @code{VT_LONG} is never used except during parsing.
1008 During parsing, the storage of an object is also stored in the type
1009 integer:
1011 @example
1012 #define VT_EXTERN  0x00000080  /* extern definition */
1013 #define VT_STATIC  0x00000100  /* static variable */
1014 #define VT_TYPEDEF 0x00000200  /* typedef definition */
1015 #define VT_INLINE  0x00000400  /* inline definition */
1016 #define VT_IMPORT  0x00004000  /* win32: extern data imported from dll */
1017 #define VT_EXPORT  0x00008000  /* win32: data exported from dll */
1018 #define VT_WEAK    0x00010000  /* win32: data exported from dll */
1019 @end example
1021 @section Symbols
1023 All symbols are stored in hashed symbol stacks. Each symbol stack
1024 contains @code{Sym} structures.
1026 @code{Sym.v} contains the symbol name (remember
1027 an idenfier is also a token, so a string is never necessary to store
1028 it). @code{Sym.t} gives the type of the symbol. @code{Sym.r} is usually
1029 the register in which the corresponding variable is stored. @code{Sym.c} is
1030 usually a constant associated to the symbol like its address for normal
1031 symbols, and the number of entries for symbols representing arrays.
1032 Variable length array types use @code{Sym.c} as a location on the stack
1033 which holds the runtime sizeof for the type.
1035 Four main symbol stacks are defined:
1037 @table @code
1039 @item define_stack
1040 for the macros (@code{#define}s).
1042 @item global_stack
1043 for the global variables, functions and types.
1045 @item local_stack
1046 for the local variables, functions and types.
1048 @item global_label_stack
1049 for the local labels (for @code{goto}).
1051 @item label_stack
1052 for GCC block local labels (see the @code{__label__} keyword).
1054 @end table
1056 @code{sym_push()} is used to add a new symbol in the local symbol
1057 stack. If no local symbol stack is active, it is added in the global
1058 symbol stack.
1060 @code{sym_pop(st,b)} pops symbols from the symbol stack @var{st} until
1061 the symbol @var{b} is on the top of stack. If @var{b} is NULL, the stack
1062 is emptied.
1064 @code{sym_find(v)} return the symbol associated to the identifier
1065 @var{v}. The local stack is searched first from top to bottom, then the
1066 global stack.
1068 @section Sections
1070 The generated code and datas are written in sections. The structure
1071 @code{Section} contains all the necessary information for a given
1072 section. @code{new_section()} creates a new section. ELF file semantics
1073 is assumed for each section.
1075 The following sections are predefined:
1077 @table @code
1079 @item text_section
1080 is the section containing the generated code. @var{ind} contains the
1081 current position in the code section.
1083 @item data_section
1084 contains initialized data
1086 @item bss_section
1087 contains uninitialized data
1089 @item bounds_section
1090 @itemx lbounds_section
1091 are used when bound checking is activated
1093 @item stab_section
1094 @itemx stabstr_section
1095 are used when debugging is active to store debug information
1097 @item symtab_section
1098 @itemx strtab_section
1099 contain the exported symbols (currently only used for debugging).
1101 @end table
1103 @section Code generation
1104 @cindex code generation
1106 @subsection Introduction
1108 The TCC code generator directly generates linked binary code in one
1109 pass. It is rather unusual these days (see gcc for example which
1110 generates text assembly), but it can be very fast and surprisingly
1111 little complicated.
1113 The TCC code generator is register based. Optimization is only done at
1114 the expression level. No intermediate representation of expression is
1115 kept except the current values stored in the @emph{value stack}.
1117 On x86, three temporary registers are used. When more registers are
1118 needed, one register is spilled into a new temporary variable on the stack.
1120 @subsection The value stack
1121 @cindex value stack, introduction
1123 When an expression is parsed, its value is pushed on the value stack
1124 (@var{vstack}). The top of the value stack is @var{vtop}. Each value
1125 stack entry is the structure @code{SValue}.
1127 @code{SValue.t} is the type. @code{SValue.r} indicates how the value is
1128 currently stored in the generated code. It is usually a CPU register
1129 index (@code{REG_xxx} constants), but additional values and flags are
1130 defined:
1132 @example
1133 #define VT_CONST     0x00f0
1134 #define VT_LLOCAL    0x00f1
1135 #define VT_LOCAL     0x00f2
1136 #define VT_CMP       0x00f3
1137 #define VT_JMP       0x00f4
1138 #define VT_JMPI      0x00f5
1139 #define VT_LVAL      0x0100
1140 #define VT_SYM       0x0200
1141 #define VT_MUSTCAST  0x0400
1142 #define VT_MUSTBOUND 0x0800
1143 #define VT_BOUNDED   0x8000
1144 #define VT_LVAL_BYTE     0x1000
1145 #define VT_LVAL_SHORT    0x2000
1146 #define VT_LVAL_UNSIGNED 0x4000
1148 @end example
1150 @table @code
1152 @item VT_CONST
1153 indicates that the value is a constant. It is stored in the union
1154 @code{SValue.c}, depending on its type.
1156 @item VT_LOCAL
1157 indicates a local variable pointer at offset @code{SValue.c.i} in the
1158 stack.
1160 @item VT_CMP
1161 indicates that the value is actually stored in the CPU flags (i.e. the
1162 value is the consequence of a test). The value is either 0 or 1. The
1163 actual CPU flags used is indicated in @code{SValue.c.i}. 
1165 If any code is generated which destroys the CPU flags, this value MUST be
1166 put in a normal register.
1168 @item VT_JMP
1169 @itemx VT_JMPI
1170 indicates that the value is the consequence of a conditional jump. For VT_JMP,
1171 it is 1 if the jump is taken, 0 otherwise. For VT_JMPI it is inverted.
1173 These values are used to compile the @code{||} and @code{&&} logical
1174 operators.
1176 If any code is generated, this value MUST be put in a normal
1177 register. Otherwise, the generated code won't be executed if the jump is
1178 taken.
1180 @item VT_LVAL
1181 is a flag indicating that the value is actually an lvalue (left value of
1182 an assignment). It means that the value stored is actually a pointer to
1183 the wanted value. 
1185 Understanding the use @code{VT_LVAL} is very important if you want to
1186 understand how TCC works.
1188 @item VT_LVAL_BYTE
1189 @itemx VT_LVAL_SHORT
1190 @itemx VT_LVAL_UNSIGNED
1191 if the lvalue has an integer type, then these flags give its real
1192 type. The type alone is not enough in case of cast optimisations.
1194 @item VT_LLOCAL
1195 is a saved lvalue on the stack. @code{VT_LVAL} must also be set with
1196 @code{VT_LLOCAL}. @code{VT_LLOCAL} can arise when a @code{VT_LVAL} in
1197 a register has to be saved to the stack, or it can come from an
1198 architecture-specific calling convention.
1200 @item VT_MUSTCAST
1201 indicates that a cast to the value type must be performed if the value
1202 is used (lazy casting).
1204 @item VT_SYM
1205 indicates that the symbol @code{SValue.sym} must be added to the constant.
1207 @item VT_MUSTBOUND
1208 @itemx VT_BOUNDED
1209 are only used for optional bound checking.
1211 @end table
1213 @subsection Manipulating the value stack
1214 @cindex value stack
1216 @code{vsetc()} and @code{vset()} pushes a new value on the value
1217 stack. If the previous @var{vtop} was stored in a very unsafe place(for
1218 example in the CPU flags), then some code is generated to put the
1219 previous @var{vtop} in a safe storage.
1221 @code{vpop()} pops @var{vtop}. In some cases, it also generates cleanup
1222 code (for example if stacked floating point registers are used as on
1223 x86).
1225 The @code{gv(rc)} function generates code to evaluate @var{vtop} (the
1226 top value of the stack) into registers. @var{rc} selects in which
1227 register class the value should be put. @code{gv()} is the @emph{most
1228 important function} of the code generator.
1230 @code{gv2()} is the same as @code{gv()} but for the top two stack
1231 entries.
1233 @subsection CPU dependent code generation
1234 @cindex CPU dependent
1235 See the @file{i386-gen.c} file to have an example.
1237 @table @code
1239 @item load()
1240 must generate the code needed to load a stack value into a register.
1242 @item store()
1243 must generate the code needed to store a register into a stack value
1244 lvalue.
1246 @item gfunc_start()
1247 @itemx gfunc_param()
1248 @itemx gfunc_call()
1249 should generate a function call
1251 @item gfunc_prolog()
1252 @itemx gfunc_epilog()
1253 should generate a function prolog/epilog.
1255 @item gen_opi(op)
1256 must generate the binary integer operation @var{op} on the two top
1257 entries of the stack which are guaranted to contain integer types.
1259 The result value should be put on the stack.
1261 @item gen_opf(op)
1262 same as @code{gen_opi()} for floating point operations. The two top
1263 entries of the stack are guaranted to contain floating point values of
1264 same types.
1266 @item gen_cvt_itof()
1267 integer to floating point conversion.
1269 @item gen_cvt_ftoi()
1270 floating point to integer conversion.
1272 @item gen_cvt_ftof()
1273 floating point to floating point of different size conversion.
1275 @item gen_bounded_ptr_add()
1276 @item gen_bounded_ptr_deref()
1277 are only used for bounds checking.
1279 @end table
1281 @section Optimizations done
1282 @cindex optimizations
1283 @cindex constant propagation
1284 @cindex strength reduction
1285 @cindex comparison operators
1286 @cindex caching processor flags
1287 @cindex flags, caching
1288 @cindex jump optimization
1289 Constant propagation is done for all operations. Multiplications and
1290 divisions are optimized to shifts when appropriate. Comparison
1291 operators are optimized by maintaining a special cache for the
1292 processor flags. &&, || and ! are optimized by maintaining a special
1293 'jump target' value. No other jump optimization is currently performed
1294 because it would require to store the code in a more abstract fashion.
1296 @unnumbered Concept Index
1297 @printindex cp
1299 @bye
1301 @c Local variables:
1302 @c fill-column: 78
1303 @c texinfo-column-for-description: 32
1304 @c End: