Adding two more people to the RELICENSING file.
[tinycc.git] / tcc-doc.texi
bloba8849f0017ad59e81c606fa79f767d60afcff7cc
1 \input texinfo @c -*- texinfo -*-
2 @c %**start of header
3 @setfilename tcc-doc.info
4 @settitle Tiny C Compiler Reference Documentation
5 @dircategory Software development
6 @direntry
7 * TCC: (tcc-doc).               The Tiny C Compiler.
8 @end direntry
9 @c %**end of header
11 @include config.texi
13 @iftex
14 @titlepage
15 @afourpaper
16 @sp 7
17 @center @titlefont{Tiny C Compiler Reference Documentation}
18 @sp 3
19 @end titlepage
20 @headings double
21 @end iftex
23 @contents
25 @node Top, Introduction, (dir), (dir)
26 @top Tiny C Compiler Reference Documentation
28 This manual documents version @value{VERSION} of the Tiny C Compiler.
30 @menu
31 * Introduction::                Introduction to tcc.
32 * Invoke::                      Invocation of tcc (command line, options).
33 * Clang::                       ANSI C and extensions.
34 * asm::                         Assembler syntax.
35 * linker::                      Output file generation and supported targets.
36 * Bounds::                      Automatic bounds-checking of C code.
37 * Libtcc::                      The libtcc library.
38 * devel::                       Guide for Developers.
39 @end menu
42 @node Introduction
43 @chapter Introduction
45 TinyCC (aka TCC) is a small but hyper fast C compiler. Unlike other C
46 compilers, it is meant to be self-relying: you do not need an
47 external assembler or linker because TCC does that for you.
49 TCC compiles so @emph{fast} that even for big projects @code{Makefile}s may
50 not be necessary.
52 TCC not only supports ANSI C, but also most of the new ISO C99
53 standard and many GNUC extensions including inline assembly.
55 TCC can also be used to make @emph{C scripts}, i.e. pieces of C source
56 that you run as a Perl or Python script. Compilation is so fast that
57 your script will be as fast as if it was an executable.
59 TCC can also automatically generate memory and bound checks
60 (@pxref{Bounds}) while allowing all C pointers operations. TCC can do
61 these checks even if non patched libraries are used.
63 With @code{libtcc}, you can use TCC as a backend for dynamic code
64 generation (@pxref{Libtcc}).
66 TCC mainly supports the i386 target on Linux and Windows. There are alpha
67 ports for the ARM (@code{arm-tcc}) and the TMS320C67xx targets
68 (@code{c67-tcc}). More information about the ARM port is available at
69 @url{http://lists.gnu.org/archive/html/tinycc-devel/2003-10/msg00044.html}.
71 For usage on Windows, see also @url{tcc-win32.txt}.
73 @node Invoke
74 @chapter Command line invocation
76 @section Quick start
78 @example
79 @c man begin SYNOPSIS
80 usage: tcc [options] [@var{infile1} @var{infile2}@dots{}] [@option{-run} @var{infile} @var{args}@dots{}]
81 @c man end
82 @end example
84 @noindent
85 @c man begin DESCRIPTION
86 TCC options are a very much like gcc options. The main difference is that TCC
87 can also execute directly the resulting program and give it runtime
88 arguments.
90 Here are some examples to understand the logic:
92 @table @code
93 @item @samp{tcc -run a.c}
94 Compile @file{a.c} and execute it directly
96 @item @samp{tcc -run a.c arg1}
97 Compile a.c and execute it directly. arg1 is given as first argument to
98 the @code{main()} of a.c.
100 @item @samp{tcc a.c -run b.c arg1}
101 Compile @file{a.c} and @file{b.c}, link them together and execute them. arg1 is given
102 as first argument to the @code{main()} of the resulting program. 
103 @ignore 
104 Because multiple C files are specified, @option{--} are necessary to clearly 
105 separate the program arguments from the TCC options.
106 @end ignore
108 @item @samp{tcc -o myprog a.c b.c}
109 Compile @file{a.c} and @file{b.c}, link them and generate the executable @file{myprog}.
111 @item @samp{tcc -o myprog a.o b.o}
112 link @file{a.o} and @file{b.o} together and generate the executable @file{myprog}.
114 @item @samp{tcc -c a.c}
115 Compile @file{a.c} and generate object file @file{a.o}.
117 @item @samp{tcc -c asmfile.S}
118 Preprocess with C preprocess and assemble @file{asmfile.S} and generate
119 object file @file{asmfile.o}.
121 @item @samp{tcc -c asmfile.s}
122 Assemble (but not preprocess) @file{asmfile.s} and generate object file
123 @file{asmfile.o}.
125 @item @samp{tcc -r -o ab.o a.c b.c}
126 Compile @file{a.c} and @file{b.c}, link them together and generate the object file @file{ab.o}.
128 @end table
130 Scripting:
132 TCC can be invoked from @emph{scripts}, just as shell scripts. You just
133 need to add @code{#!/usr/local/bin/tcc -run} at the start of your C source:
135 @example
136 #!/usr/local/bin/tcc -run
137 #include <stdio.h>
139 int main() 
140 @{
141     printf("Hello World\n");
142     return 0;
143 @}
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 -mfloat-abi (ARM only)
180 Select the float ABI. Possible values: @code{softfp} and @code{hard}
182 @item -dumpversion
183 Print only the compiler version and nothing else.
185 @item -v
186 Display TCC version.
188 @item -vv
189 Show included files.  As sole argument, print search dirs (as below).
191 @item -bench
192 Display compilation statistics.
194 @item -print-search-dirs
195 Print the configured installation directory and a list of library
196 and include directories tcc will search.
198 @end table
200 Preprocessor options:
202 @table @option
203 @item -Idir
204 Specify an additional include path. Include paths are searched in the
205 order they are specified.
207 System include paths are always searched after. The default system
208 include paths are: @file{/usr/local/include}, @file{/usr/include}
209 and @file{PREFIX/lib/tcc/include}. (@file{PREFIX} is usually
210 @file{/usr} or @file{/usr/local}).
212 @item -Dsym[=val]
213 Define preprocessor symbol @samp{sym} to
214 val. If val is not present, its value is @samp{1}. Function-like macros can
215 also be defined: @option{-DF(a)=a+1}
217 @item -Usym
218 Undefine preprocessor symbol @samp{sym}.
219 @end table
221 Compilation flags:
223 Note: each of the following options has a negative form beginning with
224 @option{-fno-}.
226 @table @option
227 @item -funsigned-char
228 Let the @code{char} type be unsigned.
230 @item -fsigned-char
231 Let the @code{char} type be signed.
233 @item -fno-common
234 Do not generate common symbols for uninitialized data.
236 @item -fleading-underscore
237 Add a leading underscore at the beginning of each C symbol.
239 @item -fms-extensions
240 Allow a MS C compiler extensions to the language. Curretly this
241 assume a nested named structure declaration without identifier behave
242 like an unnamed one.
244 @item -fdollars-in-identifiers
245 Allow a dollars in identifiers
247 @end table
249 Warning options:
251 @table @option
252 @item -w
253 Disable all warnings.
255 @end table
257 Note: each of the following warning options has a negative form beginning with
258 @option{-Wno-}.
260 @table @option
261 @item -Wimplicit-function-declaration
262 Warn about implicit function declaration.
264 @item -Wunsupported
265 Warn about unsupported GCC features that are ignored by TCC.
267 @item -Wwrite-strings
268 Make string constants be of type @code{const char *} instead of @code{char
269 *}.
271 @item -Werror
272 Abort compilation if warnings are issued.
274 @item -Wall 
275 Activate all warnings, except @option{-Werror}, @option{-Wunusupported} and
276 @option{-Wwrite-strings}.
278 @end table
280 Linker options:
282 @table @option
283 @item -Ldir
284 Specify an additional static library path for the @option{-l} option. The
285 default library paths are @file{/usr/local/lib}, @file{/usr/lib} and @file{/lib}.
287 @item -lxxx
288 Link your program with dynamic library libxxx.so or static library
289 libxxx.a. The library is searched in the paths specified by the
290 @option{-L} option and @env{LIBRARY_PATH} variable.
292 @item -Bdir
293 Set the path where the tcc internal libraries (and include files) can be
294 found (default is @file{PREFIX/lib/tcc}).
296 @item -shared
297 Generate a shared library instead of an executable.
299 @item -soname name
300 set name for shared library to be used at runtime
302 @item -static
303 Generate a statically linked executable (default is a shared linked
304 executable).
306 @item -rdynamic
307 Export global symbols to the dynamic linker. It is useful when a library
308 opened with @code{dlopen()} needs to access executable symbols.
310 @item -r
311 Generate an object file combining all input files.
313 @item -Wl,-rpath=path
314 Put custom seatch path for dynamic libraries into executable.
316 @item -Wl,--oformat=fmt
317 Use @var{fmt} as output format. The supported output formats are:
318 @table @code
319 @item elf32-i386
320 ELF output format (default)
321 @item binary
322 Binary image (only for executable output)
323 @item coff
324 COFF output format (only for executable output for TMS320C67xx target)
325 @end table
327 @item -Wl,-subsystem=console/gui/wince/...
328 Set type for PE (Windows) executables.
330 @item -Wl,-[Ttext=# | section-alignment=# | file-alignment=# | image-base=# | stack=#]
331 Modify executable layout.
333 @item -Wl,-Bsymbolic
334 Set DT_SYMBOLIC tag.
336 @end table
338 Debugger options:
340 @table @option
341 @item -g
342 Generate run time debug information so that you get clear run time
343 error messages: @code{ test.c:68: in function 'test5()': dereferencing
344 invalid pointer} instead of the laconic @code{Segmentation
345 fault}.
347 @item -b
348 Generate additional support code to check
349 memory allocations and array/pointer bounds. @option{-g} is implied. Note
350 that the generated code is slower and bigger in this case.
352 Note: @option{-b} is only available on i386 when using libtcc for the moment.
354 @item -bt N
355 Display N callers in stack traces. This is useful with @option{-g} or
356 @option{-b}.
358 @end table
360 Misc options:
362 @table @option
363 @item -MD
364 Generate makefile fragment with dependencies.
366 @item -MF depfile
367 Use @file{depfile} as output for -MD.
369 @end table
371 Note: GCC options @option{-Ox}, @option{-fx} and @option{-mx} are
372 ignored.
373 @c man end
375 @c man begin ENVIRONMENT
376 Environment variables that affect how tcc operates.
378 @table @option
380 @item CPATH
381 @item C_INCLUDE_PATH
382 A colon-separated list of directories searched for include files,
383 directories given with @option{-I} are searched first.
385 @item LIBRARY_PATH
386 A colon-separated list of directories searched for libraries for the
387 @option{-l} option, directories given with @option{-L} are searched first.
389 @end table
391 @c man end
393 @ignore
395 @setfilename tcc
396 @settitle Tiny C Compiler
398 @c man begin SEEALSO
399 cpp(1),
400 gcc(1)
401 @c man end
403 @c man begin AUTHOR
404 Fabrice Bellard
405 @c man end
407 @end ignore
409 @node Clang
410 @chapter C language support
412 @section ANSI C
414 TCC implements all the ANSI C standard, including structure bit fields
415 and floating point numbers (@code{long double}, @code{double}, and
416 @code{float} fully supported).
418 @section ISOC99 extensions
420 TCC implements many features of the new C standard: ISO C99. Currently
421 missing items are: complex and imaginary numbers.
423 Currently implemented ISOC99 features:
425 @itemize
427 @item variable length arrays.
429 @item 64 bit @code{long long} types are fully supported.
431 @item The boolean type @code{_Bool} is supported.
433 @item @code{__func__} is a string variable containing the current
434 function name.
436 @item Variadic macros: @code{__VA_ARGS__} can be used for
437    function-like macros:
438 @example
439     #define dprintf(level, __VA_ARGS__) printf(__VA_ARGS__)
440 @end example
442 @noindent
443 @code{dprintf} can then be used with a variable number of parameters.
445 @item Declarations can appear anywhere in a block (as in C++).
447 @item Array and struct/union elements can be initialized in any order by
448   using designators:
449 @example
450     struct @{ int x, y; @} st[10] = @{ [0].x = 1, [0].y = 2 @};
452     int tab[10] = @{ 1, 2, [5] = 5, [9] = 9@};
453 @end example
454     
455 @item Compound initializers are supported:
456 @example
457     int *p = (int [])@{ 1, 2, 3 @};
458 @end example
459 to initialize a pointer pointing to an initialized array. The same
460 works for structures and strings.
462 @item Hexadecimal floating point constants are supported:
463 @example
464           double d = 0x1234p10;
465 @end example
467 @noindent
468 is the same as writing 
469 @example
470           double d = 4771840.0;
471 @end example
473 @item @code{inline} keyword is ignored.
475 @item @code{restrict} keyword is ignored.
476 @end itemize
478 @section GNU C extensions
480 TCC implements some GNU C extensions:
482 @itemize
484 @item array designators can be used without '=': 
485 @example
486     int a[10] = @{ [0] 1, [5] 2, 3, 4 @};
487 @end example
489 @item Structure field designators can be a label: 
490 @example
491     struct @{ int x, y; @} st = @{ x: 1, y: 1@};
492 @end example
493 instead of
494 @example
495     struct @{ int x, y; @} st = @{ .x = 1, .y = 1@};
496 @end example
498 @item @code{\e} is ASCII character 27.
500 @item case ranges : ranges can be used in @code{case}s:
501 @example
502     switch(a) @{
503     case 1 @dots{} 9:
504           printf("range 1 to 9\n");
505           break;
506     default:
507           printf("unexpected\n");
508           break;
509     @}
510 @end example
512 @cindex aligned attribute
513 @cindex packed attribute
514 @cindex section attribute
515 @cindex unused attribute
516 @cindex cdecl attribute
517 @cindex stdcall attribute
518 @cindex regparm attribute
519 @cindex dllexport attribute
521 @item The keyword @code{__attribute__} is handled to specify variable or
522 function attributes. The following attributes are supported:
523   @itemize
525   @item @code{aligned(n)}: align a variable or a structure field to n bytes
526 (must be a power of two).
528   @item @code{packed}: force alignment of a variable or a structure field to
529   1.
531   @item @code{section(name)}: generate function or data in assembly section
532 name (name is a string containing the section name) instead of the default
533 section.
535   @item @code{unused}: specify that the variable or the function is unused.
537   @item @code{cdecl}: use standard C calling convention (default).
539   @item @code{stdcall}: use Pascal-like calling convention.
541   @item @code{regparm(n)}: use fast i386 calling convention. @var{n} must be
542 between 1 and 3. The first @var{n} function parameters are respectively put in
543 registers @code{%eax}, @code{%edx} and @code{%ecx}.
545   @item @code{dllexport}: export function from dll/executable (win32 only)
547   @end itemize
549 Here are some examples:
550 @example
551     int a __attribute__ ((aligned(8), section(".mysection")));
552 @end example
554 @noindent
555 align variable @code{a} to 8 bytes and put it in section @code{.mysection}.
557 @example
558     int my_add(int a, int b) __attribute__ ((section(".mycodesection"))) 
559     @{
560         return a + b;
561     @}
562 @end example
564 @noindent
565 generate function @code{my_add} in section @code{.mycodesection}.
567 @item GNU style variadic macros:
568 @example
569     #define dprintf(fmt, args@dots{}) printf(fmt, ## args)
571     dprintf("no arg\n");
572     dprintf("one arg %d\n", 1);
573 @end example
575 @item @code{__FUNCTION__} is interpreted as C99 @code{__func__} 
576 (so it has not exactly the same semantics as string literal GNUC
577 where it is a string literal).
579 @item The @code{__alignof__} keyword can be used as @code{sizeof} 
580 to get the alignment of a type or an expression.
582 @item The @code{typeof(x)} returns the type of @code{x}. 
583 @code{x} is an expression or a type.
585 @item Computed gotos: @code{&&label} returns a pointer of type 
586 @code{void *} on the goto label @code{label}. @code{goto *expr} can be
587 used to jump on the pointer resulting from @code{expr}.
589 @item Inline assembly with asm instruction:
590 @cindex inline assembly
591 @cindex assembly, inline
592 @cindex __asm__
593 @example
594 static inline void * my_memcpy(void * to, const void * from, size_t n)
595 @{
596 int d0, d1, d2;
597 __asm__ __volatile__(
598         "rep ; movsl\n\t"
599         "testb $2,%b4\n\t"
600         "je 1f\n\t"
601         "movsw\n"
602         "1:\ttestb $1,%b4\n\t"
603         "je 2f\n\t"
604         "movsb\n"
605         "2:"
606         : "=&c" (d0), "=&D" (d1), "=&S" (d2)
607         :"0" (n/4), "q" (n),"1" ((long) to),"2" ((long) from)
608         : "memory");
609 return (to);
610 @}
611 @end example
613 @noindent
614 @cindex gas
615 TCC includes its own x86 inline assembler with a @code{gas}-like (GNU
616 assembler) syntax. No intermediate files are generated. GCC 3.x named
617 operands are supported.
619 @item @code{__builtin_types_compatible_p()} and @code{__builtin_constant_p()} 
620 are supported.
622 @item @code{#pragma pack} is supported for win32 compatibility.
624 @end itemize
626 @section TinyCC extensions
628 @itemize
630 @item @code{__TINYC__} is a predefined macro to indicate that you use TCC.
632 @item @code{#!} at the start of a line is ignored to allow scripting.
634 @item Binary digits can be entered (@code{0b101} instead of
635 @code{5}).
637 @item @code{__BOUNDS_CHECKING_ON} is defined if bound checking is activated.
639 @end itemize
641 @node asm
642 @chapter TinyCC Assembler
644 Since version 0.9.16, TinyCC integrates its own assembler. TinyCC
645 assembler supports a gas-like syntax (GNU assembler). You can
646 desactivate assembler support if you want a smaller TinyCC executable
647 (the C compiler does not rely on the assembler).
649 TinyCC Assembler is used to handle files with @file{.S} (C
650 preprocessed assembler) and @file{.s} extensions. It is also used to
651 handle the GNU inline assembler with the @code{asm} keyword.
653 @section Syntax
655 TinyCC Assembler supports most of the gas syntax. The tokens are the
656 same as C.
658 @itemize
660 @item C and C++ comments are supported.
662 @item Identifiers are the same as C, so you cannot use '.' or '$'.
664 @item Only 32 bit integer numbers are supported.
666 @end itemize
668 @section Expressions
670 @itemize
672 @item Integers in decimal, octal and hexa are supported.
674 @item Unary operators: +, -, ~.
676 @item Binary operators in decreasing priority order:
678 @enumerate
679 @item *, /, %
680 @item &, |, ^
681 @item +, -
682 @end enumerate
684 @item A value is either an absolute number or a label plus an offset. 
685 All operators accept absolute values except '+' and '-'. '+' or '-' can be
686 used to add an offset to a label. '-' supports two labels only if they
687 are the same or if they are both defined and in the same section.
689 @end itemize
691 @section Labels
693 @itemize
695 @item All labels are considered as local, except undefined ones.
697 @item Numeric labels can be used as local @code{gas}-like labels. 
698 They can be defined several times in the same source. Use 'b'
699 (backward) or 'f' (forward) as suffix to reference them:
701 @example
702  1:
703       jmp 1b /* jump to '1' label before */
704       jmp 1f /* jump to '1' label after */
705  1:
706 @end example
708 @end itemize
710 @section Directives
711 @cindex assembler directives
712 @cindex directives, assembler
713 @cindex align directive
714 @cindex skip directive
715 @cindex space directive
716 @cindex byte directive
717 @cindex word directive
718 @cindex short directive
719 @cindex int directive
720 @cindex long directive
721 @cindex quad directive
722 @cindex globl directive
723 @cindex global directive
724 @cindex section directive
725 @cindex text directive
726 @cindex data directive
727 @cindex bss directive
728 @cindex fill directive
729 @cindex org directive
730 @cindex previous directive
731 @cindex string directive
732 @cindex asciz directive
733 @cindex ascii directive
735 All directives are preceded by a '.'. The following directives are
736 supported:
738 @itemize
739 @item .align n[,value]
740 @item .skip n[,value]
741 @item .space n[,value]
742 @item .byte value1[,...]
743 @item .word value1[,...]
744 @item .short value1[,...]
745 @item .int value1[,...]
746 @item .long value1[,...]
747 @item .quad immediate_value1[,...]
748 @item .globl symbol
749 @item .global symbol
750 @item .section section
751 @item .text
752 @item .data
753 @item .bss
754 @item .fill repeat[,size[,value]]
755 @item .org n
756 @item .previous
757 @item .string string[,...]
758 @item .asciz string[,...]
759 @item .ascii string[,...]
760 @end itemize
762 @section X86 Assembler
763 @cindex assembler
765 All X86 opcodes are supported. Only ATT syntax is supported (source
766 then destination operand order). If no size suffix is given, TinyCC
767 tries to guess it from the operand sizes.
769 Currently, MMX opcodes are supported but not SSE ones.
771 @node linker
772 @chapter TinyCC Linker
773 @cindex linker
775 @section ELF file generation
776 @cindex ELF
778 TCC can directly output relocatable ELF files (object files),
779 executable ELF files and dynamic ELF libraries without relying on an
780 external linker.
782 Dynamic ELF libraries can be output but the C compiler does not generate
783 position independent code (PIC). It means that the dynamic library
784 code generated by TCC cannot be factorized among processes yet.
786 TCC linker eliminates unreferenced object code in libraries. A single pass is
787 done on the object and library list, so the order in which object files and
788 libraries are specified is important (same constraint as GNU ld). No grouping
789 options (@option{--start-group} and @option{--end-group}) are supported.
791 @section ELF file loader
793 TCC can load ELF object files, archives (.a files) and dynamic
794 libraries (.so).
796 @section PE-i386 file generation
797 @cindex PE-i386
799 TCC for Windows supports the native Win32 executable file format (PE-i386).  It
800 generates EXE files (console and gui) and DLL files.
802 For usage on Windows, see also tcc-win32.txt.
804 @section GNU Linker Scripts
805 @cindex scripts, linker
806 @cindex linker scripts
807 @cindex GROUP, linker command
808 @cindex FILE, linker command
809 @cindex OUTPUT_FORMAT, linker command
810 @cindex TARGET, linker command
812 Because on many Linux systems some dynamic libraries (such as
813 @file{/usr/lib/libc.so}) are in fact GNU ld link scripts (horrible!),
814 the TCC linker also supports a subset of GNU ld scripts.
816 The @code{GROUP} and @code{FILE} commands are supported. @code{OUTPUT_FORMAT}
817 and @code{TARGET} are ignored.
819 Example from @file{/usr/lib/libc.so}:
820 @example
821 /* GNU ld script
822    Use the shared library, but some functions are only in
823    the static library, so try that secondarily.  */
824 GROUP ( /lib/libc.so.6 /usr/lib/libc_nonshared.a )
825 @end example
827 @node Bounds
828 @chapter TinyCC Memory and Bound checks
829 @cindex bound checks
830 @cindex memory checks
832 This feature is activated with the @option{-b} (@pxref{Invoke}).
834 Note that pointer size is @emph{unchanged} and that code generated
835 with bound checks is @emph{fully compatible} with unchecked
836 code. When a pointer comes from unchecked code, it is assumed to be
837 valid. Even very obscure C code with casts should work correctly.
839 For more information about the ideas behind this method, see
840 @url{http://www.doc.ic.ac.uk/~phjk/BoundsChecking.html}.
842 Here are some examples of caught errors:
844 @table @asis
846 @item Invalid range with standard string function:
847 @example
848 @{
849     char tab[10];
850     memset(tab, 0, 11);
851 @}
852 @end example
854 @item Out of bounds-error in global or local arrays:
855 @example
856 @{
857     int tab[10];
858     for(i=0;i<11;i++) @{
859         sum += tab[i];
860     @}
861 @}
862 @end example
864 @item Out of bounds-error in malloc'ed data:
865 @example
866 @{
867     int *tab;
868     tab = malloc(20 * sizeof(int));
869     for(i=0;i<21;i++) @{
870         sum += tab4[i];
871     @}
872     free(tab);
873 @}
874 @end example
876 @item Access of freed memory:
877 @example
878 @{
879     int *tab;
880     tab = malloc(20 * sizeof(int));
881     free(tab);
882     for(i=0;i<20;i++) @{
883         sum += tab4[i];
884     @}
885 @}
886 @end example
888 @item Double free:
889 @example
890 @{
891     int *tab;
892     tab = malloc(20 * sizeof(int));
893     free(tab);
894     free(tab);
895 @}
896 @end example
898 @end table
900 @node Libtcc
901 @chapter The @code{libtcc} library
903 The @code{libtcc} library enables you to use TCC as a backend for
904 dynamic code generation. 
906 Read the @file{libtcc.h} to have an overview of the API. Read
907 @file{libtcc_test.c} to have a very simple example.
909 The idea consists in giving a C string containing the program you want
910 to compile directly to @code{libtcc}. Then you can access to any global
911 symbol (function or variable) defined.
913 @node devel
914 @chapter Developer's guide
916 This chapter gives some hints to understand how TCC works. You can skip
917 it if you do not intend to modify the TCC code.
919 @section File reading
921 The @code{BufferedFile} structure contains the context needed to read a
922 file, including the current line number. @code{tcc_open()} opens a new
923 file and @code{tcc_close()} closes it. @code{inp()} returns the next
924 character.
926 @section Lexer
928 @code{next()} reads the next token in the current
929 file. @code{next_nomacro()} reads the next token without macro
930 expansion.
932 @code{tok} contains the current token (see @code{TOK_xxx})
933 constants. Identifiers and keywords are also keywords. @code{tokc}
934 contains additional infos about the token (for example a constant value
935 if number or string token).
937 @section Parser
939 The parser is hardcoded (yacc is not necessary). It does only one pass,
940 except:
942 @itemize
944 @item For initialized arrays with unknown size, a first pass 
945 is done to count the number of elements.
947 @item For architectures where arguments are evaluated in 
948 reverse order, a first pass is done to reverse the argument order.
950 @end itemize
952 @section Types
954 The types are stored in a single 'int' variable. It was chosen in the
955 first stages of development when tcc was much simpler. Now, it may not
956 be the best solution.
958 @example
959 #define VT_INT        0  /* integer type */
960 #define VT_BYTE       1  /* signed byte type */
961 #define VT_SHORT      2  /* short type */
962 #define VT_VOID       3  /* void type */
963 #define VT_PTR        4  /* pointer */
964 #define VT_ENUM       5  /* enum definition */
965 #define VT_FUNC       6  /* function type */
966 #define VT_STRUCT     7  /* struct/union definition */
967 #define VT_FLOAT      8  /* IEEE float */
968 #define VT_DOUBLE     9  /* IEEE double */
969 #define VT_LDOUBLE   10  /* IEEE long double */
970 #define VT_BOOL      11  /* ISOC99 boolean type */
971 #define VT_LLONG     12  /* 64 bit integer */
972 #define VT_LONG      13  /* long integer (NEVER USED as type, only
973                             during parsing) */
974 #define VT_BTYPE      0x000f /* mask for basic type */
975 #define VT_UNSIGNED   0x0010  /* unsigned type */
976 #define VT_ARRAY      0x0020  /* array type (also has VT_PTR) */
977 #define VT_VLA        0x20000 /* VLA type (also has VT_PTR and VT_ARRAY) */
978 #define VT_BITFIELD   0x0040  /* bitfield modifier */
979 #define VT_CONSTANT   0x0800  /* const modifier */
980 #define VT_VOLATILE   0x1000  /* volatile modifier */
981 #define VT_DEFSIGN    0x2000  /* signed type */
983 #define VT_STRUCT_SHIFT 18   /* structure/enum name shift (14 bits left) */
984 @end example
986 When a reference to another type is needed (for pointers, functions and
987 structures), the @code{32 - VT_STRUCT_SHIFT} high order bits are used to
988 store an identifier reference.
990 The @code{VT_UNSIGNED} flag can be set for chars, shorts, ints and long
991 longs.
993 Arrays are considered as pointers @code{VT_PTR} with the flag
994 @code{VT_ARRAY} set. Variable length arrays are considered as special
995 arrays and have flag @code{VT_VLA} set instead of @code{VT_ARRAY}.
997 The @code{VT_BITFIELD} flag can be set for chars, shorts, ints and long
998 longs. If it is set, then the bitfield position is stored from bits
999 VT_STRUCT_SHIFT to VT_STRUCT_SHIFT + 5 and the bit field size is stored
1000 from bits VT_STRUCT_SHIFT + 6 to VT_STRUCT_SHIFT + 11.
1002 @code{VT_LONG} is never used except during parsing.
1004 During parsing, the storage of an object is also stored in the type
1005 integer:
1007 @example
1008 #define VT_EXTERN  0x00000080  /* extern definition */
1009 #define VT_STATIC  0x00000100  /* static variable */
1010 #define VT_TYPEDEF 0x00000200  /* typedef definition */
1011 #define VT_INLINE  0x00000400  /* inline definition */
1012 #define VT_IMPORT  0x00004000  /* win32: extern data imported from dll */
1013 #define VT_EXPORT  0x00008000  /* win32: data exported from dll */
1014 #define VT_WEAK    0x00010000  /* win32: data exported from dll */
1015 @end example
1017 @section Symbols
1019 All symbols are stored in hashed symbol stacks. Each symbol stack
1020 contains @code{Sym} structures.
1022 @code{Sym.v} contains the symbol name (remember
1023 an idenfier is also a token, so a string is never necessary to store
1024 it). @code{Sym.t} gives the type of the symbol. @code{Sym.r} is usually
1025 the register in which the corresponding variable is stored. @code{Sym.c} is
1026 usually a constant associated to the symbol like its address for normal
1027 symbols, and the number of entries for symbols representing arrays.
1028 Variable length array types use @code{Sym.c} as a location on the stack
1029 which holds the runtime sizeof for the type.
1031 Four main symbol stacks are defined:
1033 @table @code
1035 @item define_stack
1036 for the macros (@code{#define}s).
1038 @item global_stack
1039 for the global variables, functions and types.
1041 @item local_stack
1042 for the local variables, functions and types.
1044 @item global_label_stack
1045 for the local labels (for @code{goto}).
1047 @item label_stack
1048 for GCC block local labels (see the @code{__label__} keyword).
1050 @end table
1052 @code{sym_push()} is used to add a new symbol in the local symbol
1053 stack. If no local symbol stack is active, it is added in the global
1054 symbol stack.
1056 @code{sym_pop(st,b)} pops symbols from the symbol stack @var{st} until
1057 the symbol @var{b} is on the top of stack. If @var{b} is NULL, the stack
1058 is emptied.
1060 @code{sym_find(v)} return the symbol associated to the identifier
1061 @var{v}. The local stack is searched first from top to bottom, then the
1062 global stack.
1064 @section Sections
1066 The generated code and datas are written in sections. The structure
1067 @code{Section} contains all the necessary information for a given
1068 section. @code{new_section()} creates a new section. ELF file semantics
1069 is assumed for each section.
1071 The following sections are predefined:
1073 @table @code
1075 @item text_section
1076 is the section containing the generated code. @var{ind} contains the
1077 current position in the code section.
1079 @item data_section
1080 contains initialized data
1082 @item bss_section
1083 contains uninitialized data
1085 @item bounds_section
1086 @itemx lbounds_section
1087 are used when bound checking is activated
1089 @item stab_section
1090 @itemx stabstr_section
1091 are used when debugging is active to store debug information
1093 @item symtab_section
1094 @itemx strtab_section
1095 contain the exported symbols (currently only used for debugging).
1097 @end table
1099 @section Code generation
1100 @cindex code generation
1102 @subsection Introduction
1104 The TCC code generator directly generates linked binary code in one
1105 pass. It is rather unusual these days (see gcc for example which
1106 generates text assembly), but it can be very fast and surprisingly
1107 little complicated.
1109 The TCC code generator is register based. Optimization is only done at
1110 the expression level. No intermediate representation of expression is
1111 kept except the current values stored in the @emph{value stack}.
1113 On x86, three temporary registers are used. When more registers are
1114 needed, one register is spilled into a new temporary variable on the stack.
1116 @subsection The value stack
1117 @cindex value stack, introduction
1119 When an expression is parsed, its value is pushed on the value stack
1120 (@var{vstack}). The top of the value stack is @var{vtop}. Each value
1121 stack entry is the structure @code{SValue}.
1123 @code{SValue.t} is the type. @code{SValue.r} indicates how the value is
1124 currently stored in the generated code. It is usually a CPU register
1125 index (@code{REG_xxx} constants), but additional values and flags are
1126 defined:
1128 @example
1129 #define VT_CONST     0x00f0
1130 #define VT_LLOCAL    0x00f1
1131 #define VT_LOCAL     0x00f2
1132 #define VT_CMP       0x00f3
1133 #define VT_JMP       0x00f4
1134 #define VT_JMPI      0x00f5
1135 #define VT_LVAL      0x0100
1136 #define VT_SYM       0x0200
1137 #define VT_MUSTCAST  0x0400
1138 #define VT_MUSTBOUND 0x0800
1139 #define VT_BOUNDED   0x8000
1140 #define VT_LVAL_BYTE     0x1000
1141 #define VT_LVAL_SHORT    0x2000
1142 #define VT_LVAL_UNSIGNED 0x4000
1143 #define VT_LVAL_TYPE     (VT_LVAL_BYTE | VT_LVAL_SHORT | VT_LVAL_UNSIGNED)
1144 @end example
1146 @table @code
1148 @item VT_CONST
1149 indicates that the value is a constant. It is stored in the union
1150 @code{SValue.c}, depending on its type.
1152 @item VT_LOCAL
1153 indicates a local variable pointer at offset @code{SValue.c.i} in the
1154 stack.
1156 @item VT_CMP
1157 indicates that the value is actually stored in the CPU flags (i.e. the
1158 value is the consequence of a test). The value is either 0 or 1. The
1159 actual CPU flags used is indicated in @code{SValue.c.i}. 
1161 If any code is generated which destroys the CPU flags, this value MUST be
1162 put in a normal register.
1164 @item VT_JMP
1165 @itemx VT_JMPI
1166 indicates that the value is the consequence of a conditional jump. For VT_JMP,
1167 it is 1 if the jump is taken, 0 otherwise. For VT_JMPI it is inverted.
1169 These values are used to compile the @code{||} and @code{&&} logical
1170 operators.
1172 If any code is generated, this value MUST be put in a normal
1173 register. Otherwise, the generated code won't be executed if the jump is
1174 taken.
1176 @item VT_LVAL
1177 is a flag indicating that the value is actually an lvalue (left value of
1178 an assignment). It means that the value stored is actually a pointer to
1179 the wanted value. 
1181 Understanding the use @code{VT_LVAL} is very important if you want to
1182 understand how TCC works.
1184 @item VT_LVAL_BYTE
1185 @itemx VT_LVAL_SHORT
1186 @itemx VT_LVAL_UNSIGNED
1187 if the lvalue has an integer type, then these flags give its real
1188 type. The type alone is not enough in case of cast optimisations.
1190 @item VT_LLOCAL
1191 is a saved lvalue on the stack. @code{VT_LVAL} must also be set with
1192 @code{VT_LLOCAL}. @code{VT_LLOCAL} can arise when a @code{VT_LVAL} in
1193 a register has to be saved to the stack, or it can come from an
1194 architecture-specific calling convention.
1196 @item VT_MUSTCAST
1197 indicates that a cast to the value type must be performed if the value
1198 is used (lazy casting).
1200 @item VT_SYM
1201 indicates that the symbol @code{SValue.sym} must be added to the constant.
1203 @item VT_MUSTBOUND
1204 @itemx VT_BOUNDED
1205 are only used for optional bound checking.
1207 @end table
1209 @subsection Manipulating the value stack
1210 @cindex value stack
1212 @code{vsetc()} and @code{vset()} pushes a new value on the value
1213 stack. If the previous @var{vtop} was stored in a very unsafe place(for
1214 example in the CPU flags), then some code is generated to put the
1215 previous @var{vtop} in a safe storage.
1217 @code{vpop()} pops @var{vtop}. In some cases, it also generates cleanup
1218 code (for example if stacked floating point registers are used as on
1219 x86).
1221 The @code{gv(rc)} function generates code to evaluate @var{vtop} (the
1222 top value of the stack) into registers. @var{rc} selects in which
1223 register class the value should be put. @code{gv()} is the @emph{most
1224 important function} of the code generator.
1226 @code{gv2()} is the same as @code{gv()} but for the top two stack
1227 entries.
1229 @subsection CPU dependent code generation
1230 @cindex CPU dependent
1231 See the @file{i386-gen.c} file to have an example.
1233 @table @code
1235 @item load()
1236 must generate the code needed to load a stack value into a register.
1238 @item store()
1239 must generate the code needed to store a register into a stack value
1240 lvalue.
1242 @item gfunc_start()
1243 @itemx gfunc_param()
1244 @itemx gfunc_call()
1245 should generate a function call
1247 @item gfunc_prolog()
1248 @itemx gfunc_epilog()
1249 should generate a function prolog/epilog.
1251 @item gen_opi(op)
1252 must generate the binary integer operation @var{op} on the two top
1253 entries of the stack which are guaranted to contain integer types.
1255 The result value should be put on the stack.
1257 @item gen_opf(op)
1258 same as @code{gen_opi()} for floating point operations. The two top
1259 entries of the stack are guaranted to contain floating point values of
1260 same types.
1262 @item gen_cvt_itof()
1263 integer to floating point conversion.
1265 @item gen_cvt_ftoi()
1266 floating point to integer conversion.
1268 @item gen_cvt_ftof()
1269 floating point to floating point of different size conversion.
1271 @item gen_bounded_ptr_add()
1272 @item gen_bounded_ptr_deref()
1273 are only used for bounds checking.
1275 @end table
1277 @section Optimizations done
1278 @cindex optimizations
1279 @cindex constant propagation
1280 @cindex strength reduction
1281 @cindex comparison operators
1282 @cindex caching processor flags
1283 @cindex flags, caching
1284 @cindex jump optimization
1285 Constant propagation is done for all operations. Multiplications and
1286 divisions are optimized to shifts when appropriate. Comparison
1287 operators are optimized by maintaining a special cache for the
1288 processor flags. &&, || and ! are optimized by maintaining a special
1289 'jump target' value. No other jump optimization is currently performed
1290 because it would require to store the code in a more abstract fashion.
1292 @unnumbered Concept Index
1293 @printindex cp
1295 @bye
1297 @c Local variables:
1298 @c fill-column: 78
1299 @c texinfo-column-for-description: 32
1300 @c End: