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.
26 @c Use with @@smallbook.
28 @c Cause even numbered pages to be printed on the left hand side of
29 @c the page and odd numbered pages to be printed on the right hand
30 @c side of the page. Using this, you can print on both sides of a
31 @c sheet of paper and have the text on the same part of the sheet.
33 @c The text on right hand pages is pushed towards the right hand
34 @c margin and the text on left hand pages is pushed toward the left
36 @c (To provide the reverse effect, set bindingoffset to -0.75in.)
39 @c \global\bindingoffset=0.75in
40 @c \global\normaloffset =0.75in
43 @c Change the font used for @def... commands, since the default
44 @c proportional one used is bad for names starting __.
46 \global\setfont\defbf\ttbshape{10}{\magstep1}
50 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
51 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
53 Permission is granted to copy, distribute and/or modify this document
54 under the terms of the GNU Free Documentation License, Version 1.1 or
55 any later version published by the Free Software Foundation; with the
56 Invariant Sections being ``GNU General Public License'' and ``Funding
57 Free Software'', the Front-Cover texts being (a) (see below), and with
58 the Back-Cover Texts being (b) (see below). A copy of the license is
59 included in the section entitled ``GNU Free Documentation License''.
61 (a) The FSF's Front-Cover Text is:
65 (b) The FSF's Back-Cover Text is:
67 You have freedom to copy and modify this GNU Manual, like GNU
68 software. Copies published by the Free Software Foundation raise
69 funds for GNU development.
72 @dircategory Programming
74 * gccint: (gccint). Internals of the GNU Compiler Collection.
76 This file documents the internals of the GNU compilers.
78 Published by the Free Software Foundation@*
79 59 Temple Place - Suite 330@*
80 Boston, MA 02111-1307 USA
85 @setchapternewpage odd
87 @center @titlefont{GNU Compiler Collection Internals}
89 @center Richard M. Stallman
91 @center Last updated 28 December 2002
94 @center for GCC @value{version-GCC}
96 @vskip 0pt plus 1filll
97 For GCC Version @value{version-GCC}@*
99 Published by the Free Software Foundation @*
100 59 Temple Place---Suite 330@*
101 Boston, MA 02111-1307, USA@*
102 Last printed April, 1998.@*
103 Printed copies are available for $50 each.@*
104 @c Update this ISBN when printing a new edition.
115 @node Top, Contributing,, (DIR)
119 This manual documents the internals of the GNU compilers, including
120 how to port them to new targets and some information about how to
121 write front ends for new languages. It corresponds to GCC version
122 @value{version-GCC}. The use of the GNU compilers is documented in a
123 separate manual. @xref{Top,, Introduction, gcc, Using the GNU
124 Compiler Collection (GCC)}.
126 This manual is mainly a reference manual rather than a tutorial. It
127 discusses how to contribute to GCC (@pxref{Contributing}), the
128 characteristics of the machines supported by GCC as hosts and targets
129 (@pxref{Portability}), how GCC relates to the ABIs on such systems
130 (@pxref{Interface}), and the characteristics of the languages for
131 which GCC front ends are written (@pxref{Languages}). It then
132 describes the GCC source tree structure and build system, some of the
133 interfaces to GCC front ends, and how support for a target system is
136 Additional tutorial information is linked to from
137 @uref{http://gcc.gnu.org/readings.html}.
140 * Contributing:: How to contribute to testing and developing GCC.
141 * Portability:: Goals of GCC's portability features.
142 * Interface:: Function-call interface of GCC output.
143 * Languages:: Languages for which GCC front ends are written.
144 * Source Tree:: GCC source tree structure and build system.
145 * Passes:: Order of passes, what they do, and what each file is for.
146 * Trees:: The source representation used by the C and C++ front ends.
147 * RTL:: The intermediate representation that most passes work on.
148 * Machine Desc:: How to write machine description instruction patterns.
149 * Target Macros:: How to write the machine description C macros and functions.
150 * Host Config:: Writing the @file{xm-@var{machine}.h} file.
151 * Fragments:: Writing the @file{t-@var{target}} and @file{x-@var{host}} files.
152 * Collect2:: How @code{collect2} works; how it finds @code{ld}.
153 * Header Dirs:: Understanding the standard header file directories.
154 * Type Information:: GCC's memory management; generating type information.
156 * Funding:: How to help assure funding for free software.
157 * GNU Project:: The GNU Project and GNU/Linux.
159 * Copying:: GNU General Public License says
160 how you can copy and share GCC.
161 * GNU Free Documentation License:: How you can copy and share this manual.
162 * Contributors:: People who have contributed to GCC.
164 * Option Index:: Index to command line options.
165 * Index:: Index of concepts and symbol names.
168 @include contribute.texi
169 @include portability.texi
170 @include interface.texi
171 @include languages.texi
172 @include sourcebuild.texi
178 @include hostconfig.texi
179 @include fragments.texi
180 @include collect2.texi
181 @include headerdirs.texi
184 @include funding.texi
188 @c ---------------------------------------------------------------------
190 @c ---------------------------------------------------------------------
194 @include contrib.texi
196 @c ---------------------------------------------------------------------
198 @c ---------------------------------------------------------------------
201 @unnumbered Option Index
203 GCC's command line options are indexed here without any initial @samp{-}
204 or @samp{--}. Where an option has both positive and negative forms
205 (such as @option{-f@var{option}} and @option{-fno-@var{option}}),
206 relevant entries in the manual are indexed under the most appropriate
207 form; it may sometimes be useful to look up both forms.
216 @c ---------------------------------------------------------------------
218 @c ---------------------------------------------------------------------