1 \input texinfo @c -*-texinfo-*-
3 @setfilename gccint.info
4 @c INTERNALS is used by md.texi to determine whether to include the
5 @c whole of that file, in the internals manual, or only the part
6 @c dealing with constraints, in the user manual.
9 @c See miscellaneous notes in gcc.texi on checks/things to do.
11 @include gcc-common.texi
13 @settitle GNU Compiler Collection (GCC) Internals
15 @c Create a separate index for command line options.
17 @c Merge the standard indexes into a single one.
29 Copyright @copyright{} 1988-2018 Free Software Foundation, Inc.
31 Permission is granted to copy, distribute and/or modify this document
32 under the terms of the GNU Free Documentation License, Version 1.3 or
33 any later version published by the Free Software Foundation; with the
34 Invariant Sections being ``Funding Free Software'', the Front-Cover
35 Texts being (a) (see below), and with the Back-Cover Texts being (b)
36 (see below). A copy of the license is included in the section entitled
37 ``GNU Free Documentation License''.
39 (a) The FSF's Front-Cover Text is:
43 (b) The FSF's Back-Cover Text is:
45 You have freedom to copy and modify this GNU Manual, like GNU
46 software. Copies published by the Free Software Foundation raise
47 funds for GNU development.
50 @dircategory Software development
52 * gccint: (gccint). Internals of the GNU Compiler Collection.
54 This file documents the internals of the GNU compilers.
60 @setchapternewpage odd
62 @title GNU Compiler Collection Internals
64 @author Richard M. Stallman and the @sc{GCC} Developer Community
66 @vskip 0pt plus 1filll
73 @node Top, Contributing
77 This manual documents the internals of the GNU compilers, including
78 how to port them to new targets and some information about how to
79 write front ends for new languages. It corresponds to the compilers
80 @ifset VERSION_PACKAGE
81 @value{VERSION_PACKAGE}
83 version @value{version-GCC}. The use of the GNU compilers is documented in a
84 separate manual. @xref{Top,, Introduction, gcc, Using the GNU
85 Compiler Collection (GCC)}.
87 This manual is mainly a reference manual rather than a tutorial. It
88 discusses how to contribute to GCC (@pxref{Contributing}), the
89 characteristics of the machines supported by GCC as hosts and targets
90 (@pxref{Portability}), how GCC relates to the ABIs on such systems
91 (@pxref{Interface}), and the characteristics of the languages for
92 which GCC front ends are written (@pxref{Languages}). It then
93 describes the GCC source tree structure and build system, some of the
94 interfaces to GCC front ends, and how support for a target system is
97 Additional tutorial information is linked to from
98 @uref{http://gcc.gnu.org/readings.html}.
101 * Contributing:: How to contribute to testing and developing GCC.
102 * Portability:: Goals of GCC's portability features.
103 * Interface:: Function-call interface of GCC output.
104 * Libgcc:: Low-level runtime library used by GCC.
105 * Languages:: Languages for which GCC front ends are written.
106 * Source Tree:: GCC source tree structure and build system.
107 * Testsuites:: GCC testsuites.
108 * Options:: Option specification files.
109 * Passes:: Order of passes, what they do, and what each file is for.
110 * poly_int:: Representation of runtime sizes and offsets.
111 * GENERIC:: Language-independent representation generated by Front Ends
112 * GIMPLE:: Tuple representation used by Tree SSA optimizers
113 * Tree SSA:: Analysis and optimization of GIMPLE
114 * RTL:: Machine-dependent low-level intermediate representation.
115 * Control Flow:: Maintaining and manipulating the control flow graph.
116 * Loop Analysis and Representation:: Analysis and representation of loops
117 * Machine Desc:: How to write machine description instruction patterns.
118 * Target Macros:: How to write the machine description C macros and functions.
119 * Host Config:: Writing the @file{xm-@var{machine}.h} file.
120 * Fragments:: Writing the @file{t-@var{target}} and @file{x-@var{host}} files.
121 * Collect2:: How @code{collect2} works; how it finds @code{ld}.
122 * Header Dirs:: Understanding the standard header file directories.
123 * Type Information:: GCC's memory management; generating type information.
124 * Plugins:: Extending the compiler with plugins.
125 * LTO:: Using Link-Time Optimization.
127 * Match and Simplify:: How to write expression simplification patterns for GIMPLE and GENERIC
128 * Funding:: How to help assure funding for free software.
129 * GNU Project:: The GNU Project and GNU/Linux.
131 * Copying:: GNU General Public License says
132 how you can copy and share GCC.
133 * GNU Free Documentation License:: How you can copy and share this manual.
134 * Contributors:: People who have contributed to GCC.
136 * Option Index:: Index to command line options.
137 * Concept Index:: Index of concepts and symbol names.
140 @include contribute.texi
141 @include portability.texi
142 @include interface.texi
144 @include languages.texi
145 @include sourcebuild.texi
146 @include options.texi
148 @include poly-int.texi
149 @include generic.texi
151 @include tree-ssa.texi
157 @include hostconfig.texi
158 @include fragments.texi
159 @include collect2.texi
160 @include headerdirs.texi
162 @include plugins.texi
164 @include match-and-simplify.texi
166 @include funding.texi
170 @c ---------------------------------------------------------------------
172 @c ---------------------------------------------------------------------
176 @include contrib.texi
178 @c ---------------------------------------------------------------------
180 @c ---------------------------------------------------------------------
183 @unnumbered Option Index
185 GCC's command line options are indexed here without any initial @samp{-}
186 or @samp{--}. Where an option has both positive and negative forms
187 (such as @option{-f@var{option}} and @option{-fno-@var{option}}),
188 relevant entries in the manual are indexed under the most appropriate
189 form; it may sometimes be useful to look up both forms.
194 @unnumbered Concept Index
198 @c ---------------------------------------------------------------------
200 @c ---------------------------------------------------------------------