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