gcc/doc/gccint.texi

   1 \input texinfo  @c -*-texinfo-*-
   2 @c %**start of header
   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.
   7 @set INTERNALS
   8
   9 @c See miscellaneous notes in gcc.texi on checks/things to do.
  10
  11 @include gcc-common.texi
  12
  13 @settitle GNU Compiler Collection (GCC) Internals
  14
  15 @c Create a separate index for command line options.
  16 @defcodeindex op
  17 @c Merge the standard indexes into a single one.
  18 @syncodeindex fn cp
  19 @syncodeindex vr cp
  20 @syncodeindex ky cp
  21 @syncodeindex pg cp
  22 @syncodeindex tp cp
  23
  24 @paragraphindent 1
  25
  26 @c %**end of header
  27
  28 @copying
  29 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
  30 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
  31 2008 Free Software Foundation, Inc.
  32
  33 Permission is granted to copy, distribute and/or modify this document
  34 under the terms of the GNU Free Documentation License, Version 1.2 or
  35 any later version published by the Free Software Foundation; with the
  36 Invariant Sections being ``Funding Free Software'', the Front-Cover
  37 Texts being (a) (see below), and with the Back-Cover Texts being (b)
  38 (see below).  A copy of the license is included in the section entitled
  39 ``GNU Free Documentation License''.
  40
  41 (a) The FSF's Front-Cover Text is:
  42
  43      A GNU Manual
  44
  45 (b) The FSF's Back-Cover Text is:
  46
  47      You have freedom to copy and modify this GNU Manual, like GNU
  48      software.  Copies published by the Free Software Foundation raise
  49      funds for GNU development.
  50 @end copying
  51 @ifnottex
  52 @dircategory Software development
  53 @direntry
  54 * gccint: (gccint).            Internals of the GNU Compiler Collection.
  55 @end direntry
  56 This file documents the internals of the GNU compilers.
  57 @sp 1
  58 @insertcopying
  59 @sp 1
  60 @end ifnottex
  61
  62 @setchapternewpage odd
  63 @titlepage
  64 @title GNU Compiler Collection Internals
  65 @versionsubtitle
  66 @author Richard M. Stallman and the @sc{GCC} Developer Community
  67 @page
  68 @vskip 0pt plus 1filll
  69 @insertcopying
  70 @end titlepage
  71 @summarycontents
  72 @contents
  73 @page
  74
  75 @node Top, Contributing,, (DIR)
  76 @top Introduction
  77 @cindex introduction
  78
  79 This manual documents the internals of the GNU compilers, including
  80 how to port them to new targets and some information about how to
  81 write front ends for new languages.  It corresponds to the compilers
  82 @ifset VERSION_PACKAGE
  83 @value{VERSION_PACKAGE}
  84 @end ifset
  85 version @value{version-GCC}.  The use of the GNU compilers is documented in a
  86 separate manual.  @xref{Top,, Introduction, gcc, Using the GNU
  87 Compiler Collection (GCC)}.
  88
  89 This manual is mainly a reference manual rather than a tutorial.  It
  90 discusses how to contribute to GCC (@pxref{Contributing}), the
  91 characteristics of the machines supported by GCC as hosts and targets
  92 (@pxref{Portability}), how GCC relates to the ABIs on such systems
  93 (@pxref{Interface}), and the characteristics of the languages for
  94 which GCC front ends are written (@pxref{Languages}).  It then
  95 describes the GCC source tree structure and build system, some of the
  96 interfaces to GCC front ends, and how support for a target system is
  97 implemented in GCC@.
  98
  99 Additional tutorial information is linked to from
 100 @uref{http://gcc.gnu.org/readings.html}.
 101
 102 @menu
 103 * Contributing::    How to contribute to testing and developing GCC.
 104 * Portability::     Goals of GCC's portability features.
 105 * Interface::       Function-call interface of GCC output.
 106 * Libgcc::          Low-level runtime library used by GCC.
 107 * Languages::       Languages for which GCC front ends are written.
 108 * Source Tree::     GCC source tree structure and build system.
 109 * Options::         Option specification files.
 110 * Passes::          Order of passes, what they do, and what each file is for.
 111 * Trees::           The source representation used by the C and C++ front ends.
 112 * GENERIC::         Language-independent representation generated by Front Ends
 113 * GIMPLE::          Tuple representation used by Tree SSA optimizers
 114 * Tree SSA::        Analysis and optimization of GIMPLE
 115 * RTL::             Machine-dependent low-level intermediate representation.
 116 * Control Flow::    Maintaining and manipulating the control flow graph.
 117 * Loop Analysis and Representation:: Analysis and representation of loops
 118 * Machine Desc::    How to write machine description instruction patterns.
 119 * Target Macros::   How to write the machine description C macros and functions.
 120 * Host Config::     Writing the @file{xm-@var{machine}.h} file.
 121 * Fragments::       Writing the @file{t-@var{target}} and @file{x-@var{host}} files.
 122 * Collect2::        How @code{collect2} works; how it finds @code{ld}.
 123 * Header Dirs::     Understanding the standard header file directories.
 124 * Type Information:: GCC's memory management; generating type information.
 125 * Plugins::         Extending the compiler with plugins.
 126
 127 * Funding::         How to help assure funding for free software.
 128 * GNU Project::     The GNU Project and GNU/Linux.
 129
 130 * Copying::         GNU General Public License says
 131                     how you can copy and share GCC.
 132 * GNU Free Documentation License:: How you can copy and share this manual.
 133 * Contributors::    People who have contributed to GCC.
 134
 135 * Option Index::    Index to command line options.
 136 * Concept Index::   Index of concepts and symbol names.
 137 @end menu
 138
 139 @include contribute.texi
 140 @include portability.texi
 141 @include interface.texi
 142 @include libgcc.texi
 143 @include languages.texi
 144 @include sourcebuild.texi
 145 @include options.texi
 146 @include passes.texi
 147 @include c-tree.texi
 148 @include rtl.texi
 149 @include generic.texi
 150 @include gimple.texi
 151 @include tree-ssa.texi
 152 @include loop.texi
 153 @include cfg.texi
 154 @include md.texi
 155 @include tm.texi
 156 @include hostconfig.texi
 157 @include fragments.texi
 158 @include collect2.texi
 159 @include headerdirs.texi
 160 @include gty.texi
 161 @include plugins.texi
 162
 163 @include funding.texi
 164 @include gnu.texi
 165 @include gpl_v3.texi
 166
 167 @c ---------------------------------------------------------------------
 168 @c GFDL
 169 @c ---------------------------------------------------------------------
 170
 171 @include fdl.texi
 172
 173 @include contrib.texi
 174
 175 @c ---------------------------------------------------------------------
 176 @c Indexes
 177 @c ---------------------------------------------------------------------
 178
 179 @node Option Index
 180 @unnumbered Option Index
 181
 182 GCC's command line options are indexed here without any initial @samp{-}
 183 or @samp{--}.  Where an option has both positive and negative forms
 184 (such as @option{-f@var{option}} and @option{-fno-@var{option}}),
 185 relevant entries in the manual are indexed under the most appropriate
 186 form; it may sometimes be useful to look up both forms.
 187
 188 @printindex op
 189
 190 @node Concept Index
 191 @unnumbered Concept Index
 192
 193 @printindex cp
 194
 195 @c ---------------------------------------------------------------------
 196 @c Epilogue
 197 @c ---------------------------------------------------------------------
 198
 199 @bye