OSDN Git Service

* doc/sourcebuild.texi (Front End): Remove reference to
[pf3gnuchains/gcc-fork.git] / gcc / doc / sourcebuild.texi
1 @c Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010
2 @c Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @node Source Tree
7 @chapter Source Tree Structure and Build System
8
9 This chapter describes the structure of the GCC source tree, and how
10 GCC is built.  The user documentation for building and installing GCC
11 is in a separate manual (@uref{http://gcc.gnu.org/install/}), with
12 which it is presumed that you are familiar.
13
14 @menu
15 * Configure Terms:: Configuration terminology and history.
16 * Top Level::       The top level source directory.
17 * gcc Directory::   The @file{gcc} subdirectory.
18 @end menu
19
20 @include configterms.texi
21
22 @node Top Level
23 @section Top Level Source Directory
24
25 The top level source directory in a GCC distribution contains several
26 files and directories that are shared with other software
27 distributions such as that of GNU Binutils.  It also contains several
28 subdirectories that contain parts of GCC and its runtime libraries:
29
30 @table @file
31 @item boehm-gc
32 The Boehm conservative garbage collector, used as part of the Java
33 runtime library.
34
35 @item config
36 Autoconf macros and Makefile fragments used throughout the tree.
37
38 @item contrib
39 Contributed scripts that may be found useful in conjunction with GCC@.
40 One of these, @file{contrib/texi2pod.pl}, is used to generate man
41 pages from Texinfo manuals as part of the GCC build process.
42
43 @item fixincludes
44 The support for fixing system headers to work with GCC@.  See
45 @file{fixincludes/README} for more information.  The headers fixed by
46 this mechanism are installed in @file{@var{libsubdir}/include-fixed}.
47 Along with those headers, @file{README-fixinc} is also installed, as
48 @file{@var{libsubdir}/include-fixed/README}.
49
50 @item gcc
51 The main sources of GCC itself (except for runtime libraries),
52 including optimizers, support for different target architectures,
53 language front ends, and testsuites.  @xref{gcc Directory, , The
54 @file{gcc} Subdirectory}, for details.
55
56 @item gnattools
57 Support tools for GNAT.
58
59 @item include
60 Headers for the @code{libiberty} library.
61
62 @item intl
63 GNU @code{libintl}, from GNU @code{gettext}, for systems which do not
64 include it in @code{libc}.
65
66 @item libada
67 The Ada runtime library.
68
69 @item libcpp
70 The C preprocessor library.
71
72 @item libdecnumber
73 The Decimal Float support library.
74
75 @item libffi
76 The @code{libffi} library, used as part of the Java runtime library.
77
78 @item libgcc
79 The GCC runtime library.
80
81 @item libgfortran
82 The Fortran runtime library.
83
84 @item libgo
85 The Go runtime library.  The bulk of this library is mirrored from the
86 @uref{http://code.google.com/@/p/@/go, master Go repository}.
87
88 @item libgomp
89 The GNU OpenMP runtime library.
90
91 @item libiberty
92 The @code{libiberty} library, used for portability and for some
93 generally useful data structures and algorithms.  @xref{Top, ,
94 Introduction, libiberty, @sc{gnu} libiberty}, for more information
95 about this library.
96
97 @item libjava
98 The Java runtime library.
99
100 @item libmudflap
101 The @code{libmudflap} library, used for instrumenting pointer and array
102 dereferencing operations.
103
104 @item libobjc
105 The Objective-C and Objective-C++ runtime library.
106
107 @item libssp
108 The Stack protector runtime library.
109
110 @item libstdc++-v3
111 The C++ runtime library.
112
113 @item lto-plugin
114 Plugin used by @command{gold} if link-time optimizations are enabled.
115
116 @item maintainer-scripts
117 Scripts used by the @code{gccadmin} account on @code{gcc.gnu.org}.
118
119 @item zlib
120 The @code{zlib} compression library, used by the Java front end, as
121 part of the Java runtime library, and for compressing and uncompressing
122 GCC's intermediate language in LTO object files.
123 @end table
124
125 The build system in the top level directory, including how recursion
126 into subdirectories works and how building runtime libraries for
127 multilibs is handled, is documented in a separate manual, included
128 with GNU Binutils.  @xref{Top, , GNU configure and build system,
129 configure, The GNU configure and build system}, for details.
130
131 @node gcc Directory
132 @section The @file{gcc} Subdirectory
133
134 The @file{gcc} directory contains many files that are part of the C
135 sources of GCC, other files used as part of the configuration and
136 build process, and subdirectories including documentation and a
137 testsuite.  The files that are sources of GCC are documented in a
138 separate chapter.  @xref{Passes, , Passes and Files of the Compiler}.
139
140 @menu
141 * Subdirectories:: Subdirectories of @file{gcc}.
142 * Configuration::  The configuration process, and the files it uses.
143 * Build::          The build system in the @file{gcc} directory.
144 * Makefile::       Targets in @file{gcc/Makefile}.
145 * Library Files::  Library source files and headers under @file{gcc/}.
146 * Headers::        Headers installed by GCC.
147 * Documentation::  Building documentation in GCC.
148 * Front End::      Anatomy of a language front end.
149 * Back End::       Anatomy of a target back end.
150 @end menu
151
152 @node Subdirectories
153 @subsection Subdirectories of @file{gcc}
154
155 The @file{gcc} directory contains the following subdirectories:
156
157 @table @file
158 @item @var{language}
159 Subdirectories for various languages.  Directories containing a file
160 @file{config-lang.in} are language subdirectories.  The contents of
161 the subdirectories @file{cp} (for C++), @file{lto} (for LTO),
162 @file{objc} (for Objective-C) and @file{objcp} (for Objective-C++) are
163 documented in this manual (@pxref{Passes, , Passes and Files of the
164 Compiler}); those for other languages are not.  @xref{Front End, ,
165 Anatomy of a Language Front End}, for details of the files in these
166 directories.
167
168 @item config
169 Configuration files for supported architectures and operating
170 systems.  @xref{Back End, , Anatomy of a Target Back End}, for
171 details of the files in this directory.
172
173 @item doc
174 Texinfo documentation for GCC, together with automatically generated
175 man pages and support for converting the installation manual to
176 HTML@.  @xref{Documentation}.
177
178 @item ginclude
179 System headers installed by GCC, mainly those required by the C
180 standard of freestanding implementations.  @xref{Headers, , Headers
181 Installed by GCC}, for details of when these and other headers are
182 installed.
183
184 @item po
185 Message catalogs with translations of messages produced by GCC into
186 various languages, @file{@var{language}.po}.  This directory also
187 contains @file{gcc.pot}, the template for these message catalogues,
188 @file{exgettext}, a wrapper around @command{gettext} to extract the
189 messages from the GCC sources and create @file{gcc.pot}, which is run
190 by @samp{make gcc.pot}, and @file{EXCLUDES}, a list of files from
191 which messages should not be extracted.
192
193 @item testsuite
194 The GCC testsuites (except for those for runtime libraries).
195 @xref{Testsuites}.
196 @end table
197
198 @node Configuration
199 @subsection Configuration in the @file{gcc} Directory
200
201 The @file{gcc} directory is configured with an Autoconf-generated
202 script @file{configure}.  The @file{configure} script is generated
203 from @file{configure.ac} and @file{aclocal.m4}.  From the files
204 @file{configure.ac} and @file{acconfig.h}, Autoheader generates the
205 file @file{config.in}.  The file @file{cstamp-h.in} is used as a
206 timestamp.
207
208 @menu
209 * Config Fragments::     Scripts used by @file{configure}.
210 * System Config::        The @file{config.build}, @file{config.host}, and
211                          @file{config.gcc} files.
212 * Configuration Files::  Files created by running @file{configure}.
213 @end menu
214
215 @node Config Fragments
216 @subsubsection Scripts Used by @file{configure}
217
218 @file{configure} uses some other scripts to help in its work:
219
220 @itemize @bullet
221 @item The standard GNU @file{config.sub} and @file{config.guess}
222 files, kept in the top level directory, are used.
223
224 @item The file @file{config.gcc} is used to handle configuration
225 specific to the particular target machine.  The file
226 @file{config.build} is used to handle configuration specific to the
227 particular build machine.  The file @file{config.host} is used to handle
228 configuration specific to the particular host machine.  (In general,
229 these should only be used for features that cannot reasonably be tested in
230 Autoconf feature tests.)
231 @xref{System Config, , The @file{config.build}; @file{config.host};
232 and @file{config.gcc} Files}, for details of the contents of these files.
233
234 @item Each language subdirectory has a file
235 @file{@var{language}/config-lang.in} that is used for
236 front-end-specific configuration.  @xref{Front End Config, , The Front
237 End @file{config-lang.in} File}, for details of this file.
238
239 @item A helper script @file{configure.frag} is used as part of
240 creating the output of @file{configure}.
241 @end itemize
242
243 @node System Config
244 @subsubsection The @file{config.build}; @file{config.host}; and @file{config.gcc} Files
245
246 The @file{config.build} file contains specific rules for particular systems
247 which GCC is built on.  This should be used as rarely as possible, as the
248 behavior of the build system can always be detected by autoconf.
249
250 The @file{config.host} file contains specific rules for particular systems
251 which GCC will run on.  This is rarely needed.
252
253 The @file{config.gcc} file contains specific rules for particular systems
254 which GCC will generate code for.  This is usually needed.
255
256 Each file has a list of the shell variables it sets, with descriptions, at the
257 top of the file.
258
259 FIXME: document the contents of these files, and what variables should
260 be set to control build, host and target configuration.
261
262 @include configfiles.texi
263
264 @node Build
265 @subsection Build System in the @file{gcc} Directory
266
267 FIXME: describe the build system, including what is built in what
268 stages.  Also list the various source files that are used in the build
269 process but aren't source files of GCC itself and so aren't documented
270 below (@pxref{Passes}).
271
272 @include makefile.texi
273
274 @node Library Files
275 @subsection Library Source Files and Headers under the @file{gcc} Directory
276
277 FIXME: list here, with explanation, all the C source files and headers
278 under the @file{gcc} directory that aren't built into the GCC
279 executable but rather are part of runtime libraries and object files,
280 such as @file{crtstuff.c} and @file{unwind-dw2.c}.  @xref{Headers, ,
281 Headers Installed by GCC}, for more information about the
282 @file{ginclude} directory.
283
284 @node Headers
285 @subsection Headers Installed by GCC
286
287 In general, GCC expects the system C library to provide most of the
288 headers to be used with it.  However, GCC will fix those headers if
289 necessary to make them work with GCC, and will install some headers
290 required of freestanding implementations.  These headers are installed
291 in @file{@var{libsubdir}/include}.  Headers for non-C runtime
292 libraries are also installed by GCC; these are not documented here.
293 (FIXME: document them somewhere.)
294
295 Several of the headers GCC installs are in the @file{ginclude}
296 directory.  These headers, @file{iso646.h},
297 @file{stdarg.h}, @file{stdbool.h}, and @file{stddef.h},
298 are installed in @file{@var{libsubdir}/include},
299 unless the target Makefile fragment (@pxref{Target Fragment})
300 overrides this by setting @code{USER_H}.
301
302 In addition to these headers and those generated by fixing system
303 headers to work with GCC, some other headers may also be installed in
304 @file{@var{libsubdir}/include}.  @file{config.gcc} may set
305 @code{extra_headers}; this specifies additional headers under
306 @file{config} to be installed on some systems.
307
308 GCC installs its own version of @code{<float.h>}, from @file{ginclude/float.h}.
309 This is done to cope with command-line options that change the
310 representation of floating point numbers.
311
312 GCC also installs its own version of @code{<limits.h>}; this is generated
313 from @file{glimits.h}, together with @file{limitx.h} and
314 @file{limity.h} if the system also has its own version of
315 @code{<limits.h>}.  (GCC provides its own header because it is
316 required of ISO C freestanding implementations, but needs to include
317 the system header from its own header as well because other standards
318 such as POSIX specify additional values to be defined in
319 @code{<limits.h>}.)  The system's @code{<limits.h>} header is used via
320 @file{@var{libsubdir}/include/syslimits.h}, which is copied from
321 @file{gsyslimits.h} if it does not need fixing to work with GCC; if it
322 needs fixing, @file{syslimits.h} is the fixed copy.
323
324 GCC can also install @code{<tgmath.h>}.  It will do this when
325 @file{config.gcc} sets @code{use_gcc_tgmath} to @code{yes}.
326
327 @node Documentation
328 @subsection Building Documentation
329
330 The main GCC documentation is in the form of manuals in Texinfo
331 format.  These are installed in Info format; DVI versions may be
332 generated by @samp{make dvi}, PDF versions by @samp{make pdf}, and
333 HTML versions by @samp{make html}.  In addition, some man pages are
334 generated from the Texinfo manuals, there are some other text files
335 with miscellaneous documentation, and runtime libraries have their own
336 documentation outside the @file{gcc} directory.  FIXME: document the
337 documentation for runtime libraries somewhere.
338
339 @menu
340 * Texinfo Manuals::      GCC manuals in Texinfo format.
341 * Man Page Generation::  Generating man pages from Texinfo manuals.
342 * Miscellaneous Docs::   Miscellaneous text files with documentation.
343 @end menu
344
345 @node Texinfo Manuals
346 @subsubsection Texinfo Manuals
347
348 The manuals for GCC as a whole, and the C and C++ front ends, are in
349 files @file{doc/*.texi}.  Other front ends have their own manuals in
350 files @file{@var{language}/*.texi}.  Common files
351 @file{doc/include/*.texi} are provided which may be included in
352 multiple manuals; the following files are in @file{doc/include}:
353
354 @table @file
355 @item fdl.texi
356 The GNU Free Documentation License.
357 @item funding.texi
358 The section ``Funding Free Software''.
359 @item gcc-common.texi
360 Common definitions for manuals.
361 @item gpl.texi
362 @itemx gpl_v3.texi
363 The GNU General Public License.
364 @item texinfo.tex
365 A copy of @file{texinfo.tex} known to work with the GCC manuals.
366 @end table
367
368 DVI-formatted manuals are generated by @samp{make dvi}, which uses
369 @command{texi2dvi} (via the Makefile macro @code{$(TEXI2DVI)}).  
370 PDF-formatted manuals are generated by @samp{make pdf}, which uses
371 @command{texi2pdf} (via the Makefile macro @code{$(TEXI2PDF)}).  HTML
372 formatted manuals are generated by @samp{make html}.  Info
373 manuals are generated by @samp{make info} (which is run as part of
374 a bootstrap); this generates the manuals in the source directory,
375 using @command{makeinfo} via the Makefile macro @code{$(MAKEINFO)},
376 and they are included in release distributions.
377
378 Manuals are also provided on the GCC web site, in both HTML and
379 PostScript forms.  This is done via the script
380 @file{maintainer-scripts/update_web_docs_svn}.  Each manual to be
381 provided online must be listed in the definition of @code{MANUALS} in
382 that file; a file @file{@var{name}.texi} must only appear once in the
383 source tree, and the output manual must have the same name as the
384 source file.  (However, other Texinfo files, included in manuals but
385 not themselves the root files of manuals, may have names that appear
386 more than once in the source tree.)  The manual file
387 @file{@var{name}.texi} should only include other files in its own
388 directory or in @file{doc/include}.  HTML manuals will be generated by
389 @samp{makeinfo --html}, PostScript manuals by @command{texi2dvi}
390 and @command{dvips}, and PDF manuals by @command{texi2pdf}.
391 All Texinfo files that are parts of manuals must
392 be version-controlled, even if they are generated files, for the
393 generation of online manuals to work.
394
395 The installation manual, @file{doc/install.texi}, is also provided on
396 the GCC web site.  The HTML version is generated by the script
397 @file{doc/install.texi2html}.
398
399 @node Man Page Generation
400 @subsubsection Man Page Generation
401
402 Because of user demand, in addition to full Texinfo manuals, man pages
403 are provided which contain extracts from those manuals.  These man
404 pages are generated from the Texinfo manuals using
405 @file{contrib/texi2pod.pl} and @command{pod2man}.  (The man page for
406 @command{g++}, @file{cp/g++.1}, just contains a @samp{.so} reference
407 to @file{gcc.1}, but all the other man pages are generated from
408 Texinfo manuals.)
409
410 Because many systems may not have the necessary tools installed to
411 generate the man pages, they are only generated if the
412 @file{configure} script detects that recent enough tools are
413 installed, and the Makefiles allow generating man pages to fail
414 without aborting the build.  Man pages are also included in release
415 distributions.  They are generated in the source directory.
416
417 Magic comments in Texinfo files starting @samp{@@c man} control what
418 parts of a Texinfo file go into a man page.  Only a subset of Texinfo
419 is supported by @file{texi2pod.pl}, and it may be necessary to add
420 support for more Texinfo features to this script when generating new
421 man pages.  To improve the man page output, some special Texinfo
422 macros are provided in @file{doc/include/gcc-common.texi} which
423 @file{texi2pod.pl} understands:
424
425 @table @code
426 @item @@gcctabopt
427 Use in the form @samp{@@table @@gcctabopt} for tables of options,
428 where for printed output the effect of @samp{@@code} is better than
429 that of @samp{@@option} but for man page output a different effect is
430 wanted.
431 @item @@gccoptlist
432 Use for summary lists of options in manuals.
433 @item @@gol
434 Use at the end of each line inside @samp{@@gccoptlist}.  This is
435 necessary to avoid problems with differences in how the
436 @samp{@@gccoptlist} macro is handled by different Texinfo formatters.
437 @end table
438
439 FIXME: describe the @file{texi2pod.pl} input language and magic
440 comments in more detail.
441
442 @node Miscellaneous Docs
443 @subsubsection Miscellaneous Documentation
444
445 In addition to the formal documentation that is installed by GCC,
446 there are several other text files in the @file{gcc} subdirectory
447 with miscellaneous documentation:
448
449 @table @file
450 @item ABOUT-GCC-NLS
451 Notes on GCC's Native Language Support.  FIXME: this should be part of
452 this manual rather than a separate file.
453 @item ABOUT-NLS
454 Notes on the Free Translation Project.
455 @item COPYING
456 @itemx COPYING3
457 The GNU General Public License, Versions 2 and 3.
458 @item COPYING.LIB
459 @itemx COPYING3.LIB
460 The GNU Lesser General Public License, Versions 2.1 and 3.
461 @item *ChangeLog*
462 @itemx */ChangeLog*
463 Change log files for various parts of GCC@.
464 @item LANGUAGES
465 Details of a few changes to the GCC front-end interface.  FIXME: the
466 information in this file should be part of general documentation of
467 the front-end interface in this manual.
468 @item ONEWS
469 Information about new features in old versions of GCC@.  (For recent
470 versions, the information is on the GCC web site.)
471 @item README.Portability
472 Information about portability issues when writing code in GCC@.  FIXME:
473 why isn't this part of this manual or of the GCC Coding Conventions?
474 @end table
475
476 FIXME: document such files in subdirectories, at least @file{config},
477 @file{cp}, @file{objc}, @file{testsuite}.
478
479 @node Front End
480 @subsection Anatomy of a Language Front End
481
482 A front end for a language in GCC has the following parts:
483
484 @itemize @bullet
485 @item
486 A directory @file{@var{language}} under @file{gcc} containing source
487 files for that front end.  @xref{Front End Directory, , The Front End
488 @file{@var{language}} Directory}, for details.
489 @item
490 A mention of the language in the list of supported languages in
491 @file{gcc/doc/install.texi}.
492 @item
493 A mention of the name under which the language's runtime library is
494 recognized by @option{--enable-shared=@var{package}} in the
495 documentation of that option in @file{gcc/doc/install.texi}.
496 @item
497 A mention of any special prerequisites for building the front end in
498 the documentation of prerequisites in @file{gcc/doc/install.texi}.
499 @item
500 Details of contributors to that front end in
501 @file{gcc/doc/contrib.texi}.  If the details are in that front end's
502 own manual then there should be a link to that manual's list in
503 @file{contrib.texi}.
504 @item
505 Information about support for that language in
506 @file{gcc/doc/frontends.texi}.
507 @item
508 Information about standards for that language, and the front end's
509 support for them, in @file{gcc/doc/standards.texi}.  This may be a
510 link to such information in the front end's own manual.
511 @item
512 Details of source file suffixes for that language and @option{-x
513 @var{lang}} options supported, in @file{gcc/doc/invoke.texi}.
514 @item
515 Entries in @code{default_compilers} in @file{gcc.c} for source file
516 suffixes for that language.
517 @item
518 Preferably testsuites, which may be under @file{gcc/testsuite} or
519 runtime library directories.  FIXME: document somewhere how to write
520 testsuite harnesses.
521 @item
522 Probably a runtime library for the language, outside the @file{gcc}
523 directory.  FIXME: document this further.
524 @item
525 Details of the directories of any runtime libraries in
526 @file{gcc/doc/sourcebuild.texi}.
527 @item
528 Check targets in @file{Makefile.def} for the top-level @file{Makefile}
529 to check just the compiler or the compiler and runtime library for the
530 language.
531 @end itemize
532
533 If the front end is added to the official GCC source repository, the
534 following are also necessary:
535
536 @itemize @bullet
537 @item
538 At least one Bugzilla component for bugs in that front end and runtime
539 libraries.  This category needs to be added to the Bugzilla database.
540 @item
541 Normally, one or more maintainers of that front end listed in
542 @file{MAINTAINERS}.
543 @item
544 Mentions on the GCC web site in @file{index.html} and
545 @file{frontends.html}, with any relevant links on
546 @file{readings.html}.  (Front ends that are not an official part of
547 GCC may also be listed on @file{frontends.html}, with relevant links.)
548 @item
549 A news item on @file{index.html}, and possibly an announcement on the
550 @email{gcc-announce@@gcc.gnu.org} mailing list.
551 @item
552 The front end's manuals should be mentioned in
553 @file{maintainer-scripts/update_web_docs_svn} (@pxref{Texinfo Manuals})
554 and the online manuals should be linked to from
555 @file{onlinedocs/index.html}.
556 @item
557 Any old releases or CVS repositories of the front end, before its
558 inclusion in GCC, should be made available on the GCC FTP site
559 @uref{ftp://gcc.gnu.org/pub/gcc/old-releases/}.
560 @item
561 The release and snapshot script @file{maintainer-scripts/gcc_release}
562 should be updated to generate appropriate tarballs for this front end.
563 @item
564 If this front end includes its own version files that include the
565 current date, @file{maintainer-scripts/update_version} should be
566 updated accordingly.
567 @end itemize
568
569 @menu
570 * Front End Directory::  The front end @file{@var{language}} directory.
571 * Front End Config::     The front end @file{config-lang.in} file.
572 * Front End Makefile::   The front end @file{Make-lang.in} file.
573 @end menu
574
575 @node Front End Directory
576 @subsubsection The Front End @file{@var{language}} Directory
577
578 A front end @file{@var{language}} directory contains the source files
579 of that front end (but not of any runtime libraries, which should be
580 outside the @file{gcc} directory).  This includes documentation, and
581 possibly some subsidiary programs built alongside the front end.
582 Certain files are special and other parts of the compiler depend on
583 their names:
584
585 @table @file
586 @item config-lang.in
587 This file is required in all language subdirectories.  @xref{Front End
588 Config, , The Front End @file{config-lang.in} File}, for details of
589 its contents
590 @item Make-lang.in
591 This file is required in all language subdirectories.  @xref{Front End
592 Makefile, , The Front End @file{Make-lang.in} File}, for details of its
593 contents.
594 @item lang.opt
595 This file registers the set of switches that the front end accepts on
596 the command line, and their @option{--help} text.  @xref{Options}.
597 @item lang-specs.h
598 This file provides entries for @code{default_compilers} in
599 @file{gcc.c} which override the default of giving an error that a
600 compiler for that language is not installed.
601 @item @var{language}-tree.def
602 This file, which need not exist, defines any language-specific tree
603 codes.
604 @end table
605
606 @node Front End Config
607 @subsubsection The Front End @file{config-lang.in} File
608
609 Each language subdirectory contains a @file{config-lang.in} file.  In
610 addition the main directory contains @file{c-config-lang.in}, which
611 contains limited information for the C language.  This file is a shell
612 script that may define some variables describing the language:
613
614 @table @code
615 @item language
616 This definition must be present, and gives the name of the language
617 for some purposes such as arguments to @option{--enable-languages}.
618 @item lang_requires
619 If defined, this variable lists (space-separated) language front ends
620 other than C that this front end requires to be enabled (with the
621 names given being their @code{language} settings).  For example, the
622 Java front end depends on the C++ front end, so sets
623 @samp{lang_requires=c++}.
624 @item subdir_requires
625 If defined, this variable lists (space-separated) front end directories
626 other than C that this front end requires to be present.  For example,
627 the Objective-C++ front end uses source files from the C++ and
628 Objective-C front ends, so sets @samp{subdir_requires="cp objc"}.
629 @item target_libs
630 If defined, this variable lists (space-separated) targets in the top
631 level @file{Makefile} to build the runtime libraries for this
632 language, such as @code{target-libobjc}.
633 @item lang_dirs
634 If defined, this variable lists (space-separated) top level
635 directories (parallel to @file{gcc}), apart from the runtime libraries,
636 that should not be configured if this front end is not built.
637 @item build_by_default
638 If defined to @samp{no}, this language front end is not built unless
639 enabled in a @option{--enable-languages} argument.  Otherwise, front
640 ends are built by default, subject to any special logic in
641 @file{configure.ac} (as is present to disable the Ada front end if the
642 Ada compiler is not already installed).
643 @item boot_language
644 If defined to @samp{yes}, this front end is built in stage1 of the
645 bootstrap.  This is only relevant to front ends written in their own
646 languages.
647 @item compilers
648 If defined, a space-separated list of compiler executables that will
649 be run by the driver.  The names here will each end
650 with @samp{\$(exeext)}.
651 @item outputs
652 If defined, a space-separated list of files that should be generated
653 by @file{configure} substituting values in them.  This mechanism can
654 be used to create a file @file{@var{language}/Makefile} from
655 @file{@var{language}/Makefile.in}, but this is deprecated, building
656 everything from the single @file{gcc/Makefile} is preferred.
657 @item gtfiles
658 If defined, a space-separated list of files that should be scanned by
659 @file{gengtype.c} to generate the garbage collection tables and routines for
660 this language.  This excludes the files that are common to all front
661 ends.  @xref{Type Information}.
662
663 @end table
664
665 @node Front End Makefile
666 @subsubsection The Front End @file{Make-lang.in} File
667
668 Each language subdirectory contains a @file{Make-lang.in} file.  It contains
669 targets @code{@var{lang}.@var{hook}} (where @code{@var{lang}} is the
670 setting of @code{language} in @file{config-lang.in}) for the following
671 values of @code{@var{hook}}, and any other Makefile rules required to
672 build those targets (which may if necessary use other Makefiles
673 specified in @code{outputs} in @file{config-lang.in}, although this is
674 deprecated).  It also adds any testsuite targets that can use the
675 standard rule in @file{gcc/Makefile.in} to the variable
676 @code{lang_checks}.
677
678 @table @code
679 @itemx all.cross
680 @itemx start.encap
681 @itemx rest.encap
682 FIXME: exactly what goes in each of these targets?
683 @item tags
684 Build an @command{etags} @file{TAGS} file in the language subdirectory
685 in the source tree.
686 @item info
687 Build info documentation for the front end, in the build directory.
688 This target is only called by @samp{make bootstrap} if a suitable
689 version of @command{makeinfo} is available, so does not need to check
690 for this, and should fail if an error occurs.
691 @item dvi
692 Build DVI documentation for the front end, in the build directory.
693 This should be done using @code{$(TEXI2DVI)}, with appropriate
694 @option{-I} arguments pointing to directories of included files.
695 @item pdf
696 Build PDF documentation for the front end, in the build directory.
697 This should be done using @code{$(TEXI2PDF)}, with appropriate
698 @option{-I} arguments pointing to directories of included files.
699 @item html
700 Build HTML documentation for the front end, in the build directory.
701 @item man
702 Build generated man pages for the front end from Texinfo manuals
703 (@pxref{Man Page Generation}), in the build directory.  This target
704 is only called if the necessary tools are available, but should ignore
705 errors so as not to stop the build if errors occur; man pages are
706 optional and the tools involved may be installed in a broken way.
707 @item install-common
708 Install everything that is part of the front end, apart from the
709 compiler executables listed in @code{compilers} in
710 @file{config-lang.in}.
711 @item install-info
712 Install info documentation for the front end, if it is present in the
713 source directory.  This target should have dependencies on info files
714 that should be installed.
715 @item install-man
716 Install man pages for the front end.  This target should ignore
717 errors.
718 @item install-plugin
719 Install headers needed for plugins.
720 @item srcextra
721 Copies its dependencies into the source directory.  This generally should
722 be used for generated files such as Bison output files which are not
723 version-controlled, but should be included in any release tarballs.  This
724 target will be executed during a bootstrap if
725 @samp{--enable-generated-files-in-srcdir} was specified as a
726 @file{configure} option.
727 @item srcinfo
728 @itemx srcman
729 Copies its dependencies into the source directory.  These targets will be
730 executed during a bootstrap if @samp{--enable-generated-files-in-srcdir}
731 was specified as a @file{configure} option.
732 @item uninstall
733 Uninstall files installed by installing the compiler.  This is
734 currently documented not to be supported, so the hook need not do
735 anything.
736 @item mostlyclean
737 @itemx clean
738 @itemx distclean
739 @itemx maintainer-clean
740 The language parts of the standard GNU
741 @samp{*clean} targets.  @xref{Standard Targets, , Standard Targets for
742 Users, standards, GNU Coding Standards}, for details of the standard
743 targets.  For GCC, @code{maintainer-clean} should delete
744 all generated files in the source directory that are not version-controlled,
745 but should not delete anything that is.
746 @end table
747
748 @file{Make-lang.in} must also define a variable @code{@var{lang}_OBJS}
749 to a list of host object files that are used by that language.
750
751 @node Back End
752 @subsection Anatomy of a Target Back End
753
754 A back end for a target architecture in GCC has the following parts:
755
756 @itemize @bullet
757 @item
758 A directory @file{@var{machine}} under @file{gcc/config}, containing a
759 machine description @file{@var{machine}.md} file (@pxref{Machine Desc,
760 , Machine Descriptions}), header files @file{@var{machine}.h} and
761 @file{@var{machine}-protos.h} and a source file @file{@var{machine}.c}
762 (@pxref{Target Macros, , Target Description Macros and Functions}),
763 possibly a target Makefile fragment @file{t-@var{machine}}
764 (@pxref{Target Fragment, , The Target Makefile Fragment}), and maybe
765 some other files.  The names of these files may be changed from the
766 defaults given by explicit specifications in @file{config.gcc}.
767 @item
768 If necessary, a file @file{@var{machine}-modes.def} in the
769 @file{@var{machine}} directory, containing additional machine modes to
770 represent condition codes.  @xref{Condition Code}, for further details.
771 @item
772 An optional @file{@var{machine}.opt} file in the @file{@var{machine}}
773 directory, containing a list of target-specific options.  You can also
774 add other option files using the @code{extra_options} variable in
775 @file{config.gcc}.  @xref{Options}.
776 @item
777 Entries in @file{config.gcc} (@pxref{System Config, , The
778 @file{config.gcc} File}) for the systems with this target
779 architecture.
780 @item
781 Documentation in @file{gcc/doc/invoke.texi} for any command-line
782 options supported by this target (@pxref{Run-time Target, , Run-time
783 Target Specification}).  This means both entries in the summary table
784 of options and details of the individual options.
785 @item
786 Documentation in @file{gcc/doc/extend.texi} for any target-specific
787 attributes supported (@pxref{Target Attributes, , Defining
788 target-specific uses of @code{__attribute__}}), including where the
789 same attribute is already supported on some targets, which are
790 enumerated in the manual.
791 @item
792 Documentation in @file{gcc/doc/extend.texi} for any target-specific
793 pragmas supported.
794 @item
795 Documentation in @file{gcc/doc/extend.texi} of any target-specific
796 built-in functions supported.
797 @item
798 Documentation in @file{gcc/doc/extend.texi} of any target-specific
799 format checking styles supported.
800 @item
801 Documentation in @file{gcc/doc/md.texi} of any target-specific
802 constraint letters (@pxref{Machine Constraints, , Constraints for
803 Particular Machines}).
804 @item
805 A note in @file{gcc/doc/contrib.texi} under the person or people who
806 contributed the target support.
807 @item
808 Entries in @file{gcc/doc/install.texi} for all target triplets
809 supported with this target architecture, giving details of any special
810 notes about installation for this target, or saying that there are no
811 special notes if there are none.
812 @item
813 Possibly other support outside the @file{gcc} directory for runtime
814 libraries.  FIXME: reference docs for this.  The @code{libstdc++} porting
815 manual needs to be installed as info for this to work, or to be a
816 chapter of this manual.
817 @end itemize
818
819 If the back end is added to the official GCC source repository, the
820 following are also necessary:
821
822 @itemize @bullet
823 @item
824 An entry for the target architecture in @file{readings.html} on the
825 GCC web site, with any relevant links.
826 @item
827 Details of the properties of the back end and target architecture in
828 @file{backends.html} on the GCC web site.
829 @item
830 A news item about the contribution of support for that target
831 architecture, in @file{index.html} on the GCC web site.
832 @item
833 Normally, one or more maintainers of that target listed in
834 @file{MAINTAINERS}.  Some existing architectures may be unmaintained,
835 but it would be unusual to add support for a target that does not have
836 a maintainer when support is added.
837 @end itemize
838
839 @node Testsuites
840 @chapter Testsuites
841
842 GCC contains several testsuites to help maintain compiler quality.
843 Most of the runtime libraries and language front ends in GCC have
844 testsuites.  Currently only the C language testsuites are documented
845 here; FIXME: document the others.
846
847 @menu
848 * Test Idioms::     Idioms used in testsuite code.
849 * Test Directives:: Directives used within DejaGnu tests.
850 * Ada Tests::       The Ada language testsuites.
851 * C Tests::         The C language testsuites.
852 * libgcj Tests::    The Java library testsuites.
853 * LTO Testing::     Support for testing link-time optimizations.
854 * gcov Testing::    Support for testing gcov.
855 * profopt Testing:: Support for testing profile-directed optimizations.
856 * compat Testing::  Support for testing binary compatibility.
857 * Torture Tests::   Support for torture testing using multiple options.
858 @end menu
859
860 @node Test Idioms
861 @section Idioms Used in Testsuite Code
862
863 In general, C testcases have a trailing @file{-@var{n}.c}, starting
864 with @file{-1.c}, in case other testcases with similar names are added
865 later.  If the test is a test of some well-defined feature, it should
866 have a name referring to that feature such as
867 @file{@var{feature}-1.c}.  If it does not test a well-defined feature
868 but just happens to exercise a bug somewhere in the compiler, and a
869 bug report has been filed for this bug in the GCC bug database,
870 @file{pr@var{bug-number}-1.c} is the appropriate form of name.
871 Otherwise (for miscellaneous bugs not filed in the GCC bug database),
872 and previously more generally, test cases are named after the date on
873 which they were added.  This allows people to tell at a glance whether
874 a test failure is because of a recently found bug that has not yet
875 been fixed, or whether it may be a regression, but does not give any
876 other information about the bug or where discussion of it may be
877 found.  Some other language testsuites follow similar conventions.
878
879 In the @file{gcc.dg} testsuite, it is often necessary to test that an
880 error is indeed a hard error and not just a warning---for example,
881 where it is a constraint violation in the C standard, which must
882 become an error with @option{-pedantic-errors}.  The following idiom,
883 where the first line shown is line @var{line} of the file and the line
884 that generates the error, is used for this:
885
886 @smallexample
887 /* @{ dg-bogus "warning" "warning in place of error" @} */
888 /* @{ dg-error "@var{regexp}" "@var{message}" @{ target *-*-* @} @var{line} @} */
889 @end smallexample
890
891 It may be necessary to check that an expression is an integer constant
892 expression and has a certain value.  To check that @code{@var{E}} has
893 value @code{@var{V}}, an idiom similar to the following is used:
894
895 @smallexample
896 char x[((E) == (V) ? 1 : -1)];
897 @end smallexample
898
899 In @file{gcc.dg} tests, @code{__typeof__} is sometimes used to make
900 assertions about the types of expressions.  See, for example,
901 @file{gcc.dg/c99-condexpr-1.c}.  The more subtle uses depend on the
902 exact rules for the types of conditional expressions in the C
903 standard; see, for example, @file{gcc.dg/c99-intconst-1.c}.
904
905 It is useful to be able to test that optimizations are being made
906 properly.  This cannot be done in all cases, but it can be done where
907 the optimization will lead to code being optimized away (for example,
908 where flow analysis or alias analysis should show that certain code
909 cannot be called) or to functions not being called because they have
910 been expanded as built-in functions.  Such tests go in
911 @file{gcc.c-torture/execute}.  Where code should be optimized away, a
912 call to a nonexistent function such as @code{link_failure ()} may be
913 inserted; a definition
914
915 @smallexample
916 #ifndef __OPTIMIZE__
917 void
918 link_failure (void)
919 @{
920   abort ();
921 @}
922 #endif
923 @end smallexample
924
925 @noindent
926 will also be needed so that linking still succeeds when the test is
927 run without optimization.  When all calls to a built-in function
928 should have been optimized and no calls to the non-built-in version of
929 the function should remain, that function may be defined as
930 @code{static} to call @code{abort ()} (although redeclaring a function
931 as static may not work on all targets).
932
933 All testcases must be portable.  Target-specific testcases must have
934 appropriate code to avoid causing failures on unsupported systems;
935 unfortunately, the mechanisms for this differ by directory.
936
937 FIXME: discuss non-C testsuites here.
938
939 @node Test Directives
940 @section Directives used within DejaGnu tests
941
942 @menu
943 * Directives::  Syntax and descriptions of test directives.
944 * Selectors:: Selecting targets to which a test applies.
945 * Effective-Target Keywords:: Keywords describing target attributes.
946 * Add Options:: Features for @code{dg-add-options}
947 * Require Support:: Variants of @code{dg-require-@var{support}}
948 * Final Actions:: Commands for use in @code{dg-final}
949 @end menu
950
951 @node Directives
952 @subsection Syntax and Descriptions of test directives
953
954 Test directives appear within comments in a test source file and begin
955 with @code{dg-}.  Some of these are defined within DejaGnu and others
956 are local to the GCC testsuite.
957
958 The order in which test directives appear in a test can be important:
959 directives local to GCC sometimes override information used by the
960 DejaGnu directives, which know nothing about the GCC directives, so the
961 DejaGnu directives must precede GCC directives.
962
963 Several test directives include selectors (@pxref{Selectors, , })
964 which are usually preceded by the keyword @code{target} or @code{xfail}.
965
966 @subsubsection Specify how to build the test
967
968 @table @code
969 @item @{ dg-do @var{do-what-keyword} [@{ target/xfail @var{selector} @}] @}
970 @var{do-what-keyword} specifies how the test is compiled and whether
971 it is executed.  It is one of:
972
973 @table @code
974 @item preprocess
975 Compile with @option{-E} to run only the preprocessor.
976 @item compile
977 Compile with @option{-S} to produce an assembly code file.
978 @item assemble
979 Compile with @option{-c} to produce a relocatable object file.
980 @item link
981 Compile, assemble, and link to produce an executable file.
982 @item run
983 Produce and run an executable file, which is expected to return
984 an exit code of 0.
985 @end table
986
987 The default is @code{compile}.  That can be overridden for a set of
988 tests by redefining @code{dg-do-what-default} within the @code{.exp}
989 file for those tests.
990
991 If the directive includes the optional @samp{@{ target @var{selector} @}}
992 then the test is skipped unless the target system matches the
993 @var{selector}.
994
995 If @var{do-what-keyword} is @code{run} and the directive includes
996 the optional @samp{@{ xfail @var{selector} @}} and the selector is met
997 then the test is expected to fail.  The @code{xfail} clause is ignored
998 for other values of @var{do-what-keyword}; those tests can use
999 directive @code{dg-xfail-if}.
1000 @end table
1001
1002 @subsubsection Specify additional compiler options
1003
1004 @table @code
1005 @item @{ dg-options @var{options} [@{ target @var{selector} @}] @}
1006 This DejaGnu directive provides a list of compiler options, to be used
1007 if the target system matches @var{selector}, that replace the default
1008 options used for this set of tests.
1009
1010 @item @{ dg-add-options @var{feature} @dots{} @}
1011 Add any compiler options that are needed to access certain features.
1012 This directive does nothing on targets that enable the features by
1013 default, or that don't provide them at all.  It must come after
1014 all @code{dg-options} directives.
1015 For supported values of @var{feature} see @ref{Add Options, ,}.
1016 @end table
1017
1018 @subsubsection Modify the test timeout value
1019
1020 The normal timeout limit, in seconds, is found by searching the
1021 following in order:
1022
1023 @itemize @bullet
1024 @item the value defined by an earlier @code{dg-timeout} directive in
1025 the test
1026
1027 @item variable @var{tool_timeout} defined by the set of tests
1028
1029 @item @var{gcc},@var{timeout} set in the target board
1030
1031 @item 300
1032 @end itemize
1033
1034 @table @code
1035 @item @{ dg-timeout @var{n} [@{target @var{selector} @}] @}
1036 Set the time limit for the compilation and for the execution of the test
1037 to the specified number of seconds.
1038
1039 @item @{ dg-timeout-factor @var{x} [@{ target @var{selector} @}] @}
1040 Multiply the normal time limit for compilation and execution of the test
1041 by the specified floating-point factor.
1042 @end table
1043
1044 @subsubsection Skip a test for some targets
1045
1046 @table @code
1047 @item @{ dg-skip-if @var{comment} @{ @var{selector} @} [@{ @var{include-opts} @} [@{ @var{exclude-opts} @}]] @}
1048 Arguments @var{include-opts} and @var{exclude-opts} are lists in which
1049 each element is a string of zero or more GCC options.
1050 Skip the test if all of the following conditions are met:
1051 @itemize @bullet
1052 @item the test system is included in @var{selector}
1053
1054 @item for at least one of the option strings in @var{include-opts},
1055 every option from that string is in the set of options with which
1056 the test would be compiled; use @samp{"*"} for an @var{include-opts} list
1057 that matches any options; that is the default if @var{include-opts} is
1058 not specified
1059
1060 @item for each of the option strings in @var{exclude-opts}, at least one
1061 option from that string is not in the set of options with which the test
1062 would be compiled; use @samp{""} for an empty @var{exclude-opts} list;
1063 that is the default if @var{exclude-opts} is not specified
1064 @end itemize
1065
1066 For example, to skip a test if option @code{-Os} is present:
1067
1068 @smallexample
1069 /* @{ dg-skip-if "" @{ *-*-* @}  @{ "-Os" @} @{ "" @} @} */
1070 @end smallexample
1071
1072 To skip a test if both options @code{-O2} and @code{-g} are present:
1073
1074 @smallexample
1075 /* @{ dg-skip-if "" @{ *-*-* @}  @{ "-O2 -g" @} @{ "" @} @} */
1076 @end smallexample
1077
1078 To skip a test if either @code{-O2} or @code{-O3} is present:
1079
1080 @smallexample
1081 /* @{ dg-skip-if "" @{ *-*-* @}  @{ "-O2" "-O3" @} @{ "" @} @} */
1082 @end smallexample
1083
1084 To skip a test unless option @code{-Os} is present:
1085
1086 @smallexample
1087 /* @{ dg-skip-if "" @{ *-*-* @}  @{ "*" @} @{ "-Os" @} @} */
1088 @end smallexample
1089
1090 To skip a test if either @code{-O2} or @code{-O3} is used with @code{-g}
1091 but not if @code{-fpic} is also present:
1092
1093 @smallexample
1094 /* @{ dg-skip-if "" @{ *-*-* @}  @{ "-O2 -g" "-O3 -g" @} @{ "-fpic" @} @} */
1095 @end smallexample
1096
1097 @item @{ dg-require-effective-target @var{keyword} [@{ @var{selector} @}] @}
1098 Skip the test if the test target, including current multilib flags,
1099 is not covered by the effective-target keyword.
1100 If the directive includes the optional @samp{@{ @var{selector} @}}
1101 then the effective-target test is only performed if the target system
1102 matches the @var{selector}.
1103 This directive must appear after any @code{dg-do} directive in the test
1104 and before any @code{dg-additional-sources} directive.
1105 @xref{Effective-Target Keywords, , }.
1106
1107 @item @{ dg-require-@var{support} args @}
1108 Skip the test if the target does not provide the required support.
1109 These directives must appear after any @code{dg-do} directive in the test
1110 and before any @code{dg-additional-sources} directive.
1111 They require at least one argument, which can be an empty string if the
1112 specific procedure does not examine the argument.
1113 @xref{Require Support, , }, for a complete list of these directives.
1114 @end table
1115
1116 @subsubsection Expect a test to fail for some targets
1117
1118 @table @code
1119 @item  @{ dg-xfail-if @var{comment} @{ @var{selector} @} [@{ @var{include-opts} @} [@{ @var{exclude-opts} @}]] @}
1120 Expect the test to fail if the conditions (which are the same as for
1121 @code{dg-skip-if}) are met.  This does not affect the execute step.
1122
1123 @item  @{ dg-xfail-run-if @var{comment} @{ @var{selector} @} [@{ @var{include-opts} @} [@{ @var{exclude-opts} @}]] @}
1124 Expect the execute step of a test to fail if the conditions (which are
1125 the same as for @code{dg-skip-if}) are met.
1126 @end table
1127
1128 @subsubsection Expect the test executable to fail
1129
1130 @table @code
1131 @item  @{ dg-shouldfail @var{comment} [@{ @var{selector} @} [@{ @var{include-opts} @} [@{ @var{exclude-opts} @}]]] @}
1132 Expect the test executable to return a nonzero exit status if the
1133 conditions (which are the same as for @code{dg-skip-if}) are met.
1134 @end table
1135
1136 @subsubsection Verify compiler messages
1137
1138 @table @code
1139 @item @{ dg-error @var{regexp} [@var{comment} [@{ target/xfail @var{selector} @} [@var{line}] @}]] @}
1140 This DejaGnu directive appears on a source line that is expected to get
1141 an error message, or else specifies the source line associated with the
1142 message.  If there is no message for that line or if the text of that
1143 message is not matched by @var{regexp} then the check fails and
1144 @var{comment} is included in the @code{FAIL} message.  The check does
1145 not look for the string @samp{error} unless it is part of @var{regexp}.
1146
1147 @item @{ dg-warning @var{regexp} [@var{comment} [@{ target/xfail @var{selector} @} [@var{line}] @}]] @}
1148 This DejaGnu directive appears on a source line that is expected to get
1149 a warning message, or else specifies the source line associated with the
1150 message.  If there is no message for that line or if the text of that
1151 message is not matched by @var{regexp} then the check fails and
1152 @var{comment} is included in the @code{FAIL} message.  The check does
1153 not look for the string @samp{warning} unless it is part of @var{regexp}.
1154
1155 @item @{ dg-message @var{regexp} [@var{comment} [@{ target/xfail @var{selector} @} [@var{line}] @}]] @}
1156 The line is expected to get a message other than an error or warning.
1157 If there is no message for that line or if the text of that message is
1158 not matched by @var{regexp} then the check fails and @var{comment} is
1159 included in the @code{FAIL} message.
1160
1161 @item @{ dg-bogus @var{regexp} [@var{comment} [@{ target/xfail @var{selector} @} [@var{line}] @}]] @}
1162 This DejaGnu directive appears on a source line that should not get a
1163 message matching @var{regexp}, or else specifies the source line
1164 associated with the bogus message.  It is usually used with @samp{xfail}
1165 to indicate that the message is a known problem for a particular set of
1166 targets.
1167
1168 @item @{ dg-excess-errors @var{comment} [@{ target/xfail @var{selector} @}] @}
1169 This DejaGnu directive indicates that the test is expected to fail due
1170 to compiler messages that are not handled by @samp{dg-error},
1171 @samp{dg-warning} or @samp{dg-bogus}.  For this directive @samp{xfail}
1172 has the same effect as @samp{target}.
1173
1174 @item @{ dg-prune-output @var{regexp} @}
1175 Prune messages matching @var{regexp} from the test output.
1176 @end table
1177
1178 @subsubsection Verify output of the test executable
1179
1180 @table @code
1181 @item @{ dg-output @var{regexp} [@{ target/xfail @var{selector} @}] @}
1182 This DejaGnu directive compares @var{regexp} to the combined output
1183 that the test executable writes to @file{stdout} and @file{stderr}.
1184 @end table
1185
1186 @subsubsection Specify additional files for a test
1187
1188 @table @code
1189 @item @{ dg-additional-files "@var{filelist}" @}
1190 Specify additional files, other than source files, that must be copied
1191 to the system where the compiler runs.
1192
1193 @item @{ dg-additional-sources "@var{filelist}" @}
1194 Specify additional source files to appear in the compile line
1195 following the main test file.
1196 @end table
1197
1198 @subsubsection Add checks at the end of a test
1199
1200 @table @code
1201 @item @{ dg-final @{ @var{local-directive} @} @}
1202 This DejaGnu directive is placed within a comment anywhere in the
1203 source file and is processed after the test has been compiled and run.
1204 Multiple @samp{dg-final} commands are processed in the order in which
1205 they appear in the source file.  @xref{Final Actions, , }, for a list
1206 of directives that can be used within @code{dg-final}.
1207 @end table
1208
1209 @node Selectors
1210 @subsection Selecting targets to which a test applies
1211
1212 Several test directives include @var{selector}s to limit the targets
1213 for which a test is run or to declare that a test is expected to fail
1214 on particular targets.
1215
1216 A selector is:
1217 @itemize @bullet
1218 @item one or more target triplets, possibly including wildcard characters
1219 @item a single effective-target keyword (@pxref{Effective-Target Keywords})
1220 @item a logical expression
1221 @end itemize
1222
1223 Depending on the
1224 context, the selector specifies whether a test is skipped and reported
1225 as unsupported or is expected to fail.  Use @samp{*-*-*} to match any
1226 target.
1227
1228 A selector expression appears within curly braces and uses a single
1229 logical operator: one of @samp{!}, @samp{&&}, or @samp{||}.  An
1230 operand is another selector expression, an effective-target keyword,
1231 a single target triplet, or a list of target triplets within quotes or
1232 curly braces.  For example:
1233
1234 @smallexample
1235 @{ target @{ ! "hppa*-*-* ia64*-*-*" @} @}
1236 @{ target @{ powerpc*-*-* && lp64 @} @}
1237 @{ xfail @{ lp64 || vect_no_align @} @}
1238 @end smallexample
1239
1240 @node Effective-Target Keywords
1241 @subsection Keywords describing target attributes
1242
1243 Effective-target keywords identify sets of targets that support
1244 particular functionality.  They are used to limit tests to be run only
1245 for particular targets, or to specify that particular sets of targets
1246 are expected to fail some tests.
1247
1248 Effective-target keywords are defined in @file{lib/target-supports.exp} in
1249 the GCC testsuite, with the exception of those that are documented as
1250 being local to a particular test directory.
1251
1252 The @samp{effective target} takes into account all of the compiler options
1253 with which the test will be compiled, including the multilib options.
1254 By convention, keywords ending in @code{_nocache} can also include options
1255 specified for the particular test in an earlier @code{dg-options} or
1256 @code{dg-add-options} directive.
1257
1258 @subsubsection Data type sizes
1259
1260 @table @code
1261 @item ilp32
1262 Target has 32-bit @code{int}, @code{long}, and pointers.
1263
1264 @item lp64
1265 Target has 32-bit @code{int}, 64-bit @code{long} and pointers.
1266
1267 @item llp64
1268 Target has 32-bit @code{int} and @code{long}, 64-bit @code{long long}
1269 and pointers.
1270
1271 @item double64
1272 Target has 64-bit @code{double}.
1273
1274 @item double64plus
1275 Target has @code{double} that is 64 bits or longer.
1276
1277 @item int32plus
1278 Target has @code{int} that is at 32 bits or longer.
1279
1280 @item int16
1281 Target has @code{int} that is 16 bits or shorter.
1282
1283 @item large_double
1284 Target supports @code{double} that is longer than @code{float}.
1285
1286 @item large_long_double
1287 Target supports @code{long double} that is longer than @code{double}.
1288
1289 @item ptr32plus
1290 Target has pointers that are 32 bits or longer.
1291
1292 @item size32plus
1293 Target supports array and structure sizes that are 32 bits or longer.
1294
1295 @item 4byte_wchar_t
1296 Target has @code{wchar_t} that is at least 4 bytes.
1297 @end table
1298
1299 @subsubsection Fortran-specific attributes
1300
1301 @table @code
1302 @item fortran_integer_16
1303 Target supports Fortran @code{integer} that is 16 bytes or longer.
1304
1305 @item fortran_large_int
1306 Target supports Fortran @code{integer} kinds larger than @code{integer(8)}.
1307
1308 @item fortran_large_real
1309 Target supports Fortran @code{real} kinds larger than @code{real(8)}.
1310 @end table
1311
1312 @subsubsection Vector-specific attributes
1313
1314 @table @code
1315 @item vect_condition
1316 Target supports vector conditional operations.
1317
1318 @item vect_double
1319 Target supports hardware vectors of @code{double}.
1320
1321 @item vect_float
1322 Target supports hardware vectors of @code{float}.
1323
1324 @item vect_int
1325 Target supports hardware vectors of @code{int}.
1326
1327 @item vect_long
1328 Target supports hardware vectors of @code{long}.
1329
1330 @item vect_long_long
1331 Target supports hardware vectors of @code{long long}.
1332
1333 @item vect_aligned_arrays
1334 Target aligns arrays to vector alignment boundary.
1335
1336 @item vect_hw_misalign
1337 Target supports a vector misalign access.
1338
1339 @item vect_no_align
1340 Target does not support a vector alignment mechanism.
1341
1342 @item vect_no_int_max
1343 Target does not support a vector max instruction on @code{int}.
1344
1345 @item vect_no_int_add
1346 Target does not support a vector add instruction on @code{int}.
1347
1348 @item vect_no_bitwise
1349 Target does not support vector bitwise instructions.
1350
1351 @item vect_char_mult
1352 Target supports @code{vector char} multiplication.
1353
1354 @item vect_short_mult
1355 Target supports @code{vector short} multiplication.
1356
1357 @item vect_int_mult
1358 Target supports @code{vector int} multiplication.
1359
1360 @item vect_extract_even_odd
1361 Target supports vector even/odd element extraction.
1362
1363 @item vect_extract_even_odd_wide
1364 Target supports vector even/odd element extraction of vectors with elements
1365 @code{SImode} or larger.
1366
1367 @item vect_interleave
1368 Target supports vector interleaving.
1369
1370 @item vect_strided
1371 Target supports vector interleaving and extract even/odd.
1372
1373 @item vect_strided_wide
1374 Target supports vector interleaving and extract even/odd for wide
1375 element types.
1376
1377 @item vect_perm
1378 Target supports vector permutation.
1379
1380 @item vect_shift
1381 Target supports a hardware vector shift operation.
1382
1383 @item vect_widen_sum_hi_to_si
1384 Target supports a vector widening summation of @code{short} operands
1385 into @code{int} results, or can promote (unpack) from @code{short}
1386 to @code{int}.
1387
1388 @item vect_widen_sum_qi_to_hi
1389 Target supports a vector widening summation of @code{char} operands
1390 into @code{short} results, or can promote (unpack) from @code{char}
1391 to @code{short}.
1392
1393 @item vect_widen_sum_qi_to_si
1394 Target supports a vector widening summation of @code{char} operands
1395 into @code{int} results.
1396
1397 @item vect_widen_mult_qi_to_hi
1398 Target supports a vector widening multiplication of @code{char} operands
1399 into @code{short} results, or can promote (unpack) from @code{char} to
1400 @code{short} and perform non-widening multiplication of @code{short}.
1401
1402 @item vect_widen_mult_hi_to_si
1403 Target supports a vector widening multiplication of @code{short} operands
1404 into @code{int} results, or can promote (unpack) from @code{short} to
1405 @code{int} and perform non-widening multiplication of @code{int}.
1406
1407 @item vect_sdot_qi
1408 Target supports a vector dot-product of @code{signed char}.
1409
1410 @item vect_udot_qi
1411 Target supports a vector dot-product of @code{unsigned char}.
1412
1413 @item vect_sdot_hi
1414 Target supports a vector dot-product of @code{signed short}.
1415
1416 @item vect_udot_hi
1417 Target supports a vector dot-product of @code{unsigned short}.
1418
1419 @item vect_pack_trunc
1420 Target supports a vector demotion (packing) of @code{short} to @code{char}
1421 and from @code{int} to @code{short} using modulo arithmetic.
1422
1423 @item vect_unpack
1424 Target supports a vector promotion (unpacking) of @code{char} to @code{short}
1425 and from @code{char} to @code{int}.
1426
1427 @item vect_intfloat_cvt
1428 Target supports conversion from @code{signed int} to @code{float}.
1429
1430 @item vect_uintfloat_cvt
1431 Target supports conversion from @code{unsigned int} to @code{float}.
1432
1433 @item vect_floatint_cvt
1434 Target supports conversion from @code{float} to @code{signed int}.
1435
1436 @item vect_floatuint_cvt
1437 Target supports conversion from @code{float} to @code{unsigned int}.
1438 @end table
1439
1440 @subsubsection Thread Local Storage attributes
1441
1442 @table @code
1443 @item tls
1444 Target supports thread-local storage.
1445
1446 @item tls_native
1447 Target supports native (rather than emulated) thread-local storage.
1448
1449 @item tls_runtime
1450 Test system supports executing TLS executables.
1451 @end table
1452
1453 @subsubsection Decimal floating point attributes
1454
1455 @table @code
1456 @item dfp
1457 Targets supports compiling decimal floating point extension to C.
1458
1459 @item dfp_nocache
1460 Including the options used to compile this particular test, the
1461 target supports compiling decimal floating point extension to C.
1462
1463 @item dfprt
1464 Test system can execute decimal floating point tests.
1465
1466 @item dfprt_nocache
1467 Including the options used to compile this particular test, the
1468 test system can execute decimal floating point tests.
1469
1470 @item hard_dfp
1471 Target generates decimal floating point instructions with current options.
1472 @end table
1473
1474 @subsubsection ARM-specific attributes
1475
1476 @table @code
1477 @item arm32
1478 ARM target generates 32-bit code.
1479
1480 @item arm_eabi
1481 ARM target adheres to the ABI for the ARM Architecture.
1482
1483 @item arm_hard_vfp_ok
1484 ARM target supports @code{-mfpu=vfp -mfloat-abi=hard}.
1485 Some multilibs may be incompatible with these options.
1486
1487 @item arm_iwmmxt_ok
1488 ARM target supports @code{-mcpu=iwmmxt}.
1489 Some multilibs may be incompatible with this option.
1490
1491 @item arm_neon
1492 ARM target supports generating NEON instructions.
1493
1494 @item arm_neon_hw
1495 Test system supports executing NEON instructions.
1496
1497 @item arm_neon_ok
1498 @anchor{arm_neon_ok}
1499 ARM Target supports @code{-mfpu=neon -mfloat-abi=softfp} or compatible
1500 options.  Some multilibs may be incompatible with these options.
1501
1502 @item arm_neon_fp16_ok
1503 @anchor{arm_neon_fp16_ok}
1504 ARM Target supports @code{-mfpu=neon-fp16 -mfloat-abi=softfp} or compatible
1505 options.  Some multilibs may be incompatible with these options.
1506
1507 @item arm_thumb1_ok
1508 ARM target generates Thumb-1 code for @code{-mthumb}.
1509
1510 @item arm_thumb2_ok
1511 ARM target generates Thumb-2 code for @code{-mthumb}.
1512
1513 @item arm_vfp_ok
1514 ARM target supports @code{-mfpu=vfp -mfloat-abi=softfp}.
1515 Some multilibs may be incompatible with these options.
1516 @end table
1517
1518 @subsubsection MIPS-specific attributes
1519
1520 @table @code
1521 @item mips64
1522 MIPS target supports 64-bit instructions.
1523
1524 @item nomips16
1525 MIPS target does not produce MIPS16 code.
1526
1527 @item mips16_attribute
1528 MIPS target can generate MIPS16 code.
1529
1530 @item mips_loongson
1531 MIPS target is a Loongson-2E or -2F target using an ABI that supports
1532 the Loongson vector modes.
1533
1534 @item mips_newabi_large_long_double
1535 MIPS target supports @code{long double} larger than @code{double}
1536 when using the new ABI.
1537
1538 @item mpaired_single
1539 MIPS target supports @code{-mpaired-single}.
1540 @end table
1541
1542 @subsubsection PowerPC-specific attributes
1543
1544 @table @code
1545 @item powerpc64
1546 Test system supports executing 64-bit instructions.
1547
1548 @item powerpc_altivec
1549 PowerPC target supports AltiVec.
1550
1551 @item powerpc_altivec_ok
1552 PowerPC target supports @code{-maltivec}.
1553
1554 @item powerpc_fprs
1555 PowerPC target supports floating-point registers.
1556
1557 @item powerpc_hard_double
1558 PowerPC target supports hardware double-precision floating-point.
1559
1560 @item powerpc_ppu_ok
1561 PowerPC target supports @code{-mcpu=cell}.
1562
1563 @item powerpc_spe
1564 PowerPC target supports PowerPC SPE.
1565
1566 @item powerpc_spe_nocache
1567 Including the options used to compile this particular test, the
1568 PowerPC target supports PowerPC SPE.
1569
1570 @item powerpc_spu
1571 PowerPC target supports PowerPC SPU.
1572
1573 @item spu_auto_overlay
1574 SPU target has toolchain that supports automatic overlay generation.
1575
1576 @item powerpc_vsx_ok
1577 PowerPC target supports @code{-mvsx}.
1578
1579 @item powerpc_405_nocache
1580 Including the options used to compile this particular test, the
1581 PowerPC target supports PowerPC 405.
1582
1583 @item vmx_hw
1584 PowerPC target supports executing AltiVec instructions.
1585 @end table
1586
1587 @subsubsection Other hardware attributes
1588
1589 @table @code
1590 @item avx
1591 Target supports compiling AVX instructions.
1592
1593 @item cell_hw
1594 Test system can execute AltiVec and Cell PPU instructions.
1595
1596 @item coldfire_fpu
1597 Target uses a ColdFire FPU.
1598
1599 @item hard_float
1600 Target supports FPU instructions.
1601
1602 @item sse
1603 Target supports compiling @code{sse} instructions.
1604
1605 @item sse_runtime
1606 Target supports the execution of @code{sse} instructions.
1607
1608 @item sse2
1609 Target supports compiling @code{sse2} instructions.
1610
1611 @item sse2_runtime
1612 Target supports the execution of @code{sse2} instructions.
1613
1614 @item sync_char_short
1615 Target supports atomic operations on @code{char} and @code{short}.
1616
1617 @item sync_int_long
1618 Target supports atomic operations on @code{int} and @code{long}.
1619
1620 @item ultrasparc_hw
1621 Test environment appears to run executables on a simulator that
1622 accepts only @code{EM_SPARC} executables and chokes on @code{EM_SPARC32PLUS}
1623 or @code{EM_SPARCV9} executables.
1624
1625 @item vect_cmdline_needed
1626 Target requires a command line argument to enable a SIMD instruction set.
1627 @end table
1628
1629 @subsubsection Environment attributes
1630
1631 @table @code
1632 @item c
1633 The language for the compiler under test is C.
1634
1635 @item c++
1636 The language for the compiler under test is C++.
1637
1638 @item c99_runtime
1639 Target provides a full C99 runtime.
1640
1641 @item correct_iso_cpp_string_wchar_protos
1642 Target @code{string.h} and @code{wchar.h} headers provide C++ required
1643 overloads for @code{strchr} etc. functions.
1644
1645 @item dummy_wcsftime
1646 Target uses a dummy @code{wcsftime} function that always returns zero.
1647
1648 @item fd_truncate
1649 Target can truncate a file from a file descriptor, as used by
1650 @file{libgfortran/io/unix.c:fd_truncate}; i.e. @code{ftruncate} or
1651 @code{chsize}.
1652
1653 @item freestanding
1654 Target is @samp{freestanding} as defined in section 4 of the C99 standard.
1655 Effectively, it is a target which supports no extra headers or libraries
1656 other than what is considered essential.
1657
1658 @item init_priority
1659 Target supports constructors with initialization priority arguments.
1660
1661 @item inttypes_types
1662 Target has the basic signed and unsigned types in @code{inttypes.h}.
1663 This is for tests that GCC's notions of these types agree with those
1664 in the header, as some systems have only @code{inttypes.h}.
1665
1666 @item lax_strtofp
1667 Target might have errors of a few ULP in string to floating-point
1668 conversion functions and overflow is not always detected correctly by
1669 those functions.
1670
1671 @item newlib
1672 Target supports Newlib.
1673
1674 @item pow10
1675 Target provides @code{pow10} function.
1676
1677 @item pthread
1678 Target can compile using @code{pthread.h} with no errors or warnings.
1679
1680 @item pthread_h
1681 Target has @code{pthread.h}.
1682
1683 @item run_expensive_tests
1684 Expensive testcases (usually those that consume excessive amounts of CPU
1685 time) should be run on this target.  This can be enabled by setting the
1686 @env{GCC_TEST_RUN_EXPENSIVE} environment variable to a non-empty string.
1687
1688 @item simulator
1689 Test system runs executables on a simulator (i.e. slowly) rather than
1690 hardware (i.e. fast).
1691
1692 @item stdint_types
1693 Target has the basic signed and unsigned C types in @code{stdint.h}.
1694 This will be obsolete when GCC ensures a working @code{stdint.h} for
1695 all targets.
1696
1697 @item trampolines
1698 Target supports trampolines.
1699
1700 @item uclibc
1701 Target supports uClibc.
1702
1703 @item unwrapped
1704 Target does not use a status wrapper.
1705
1706 @item vxworks_kernel
1707 Target is a VxWorks kernel.
1708
1709 @item vxworks_rtp
1710 Target is a VxWorks RTP.
1711
1712 @item wchar
1713 Target supports wide characters.
1714 @end table
1715
1716 @subsubsection Other attributes
1717
1718 @table @code
1719 @item automatic_stack_alignment
1720 Target supports automatic stack alignment.
1721
1722 @item cxa_atexit
1723 Target uses @code{__cxa_atexit}.
1724
1725 @item default_packed
1726 Target has packed layout of structure members by default.
1727
1728 @item fgraphite
1729 Target supports Graphite optimizations.
1730
1731 @item fixed_point
1732 Target supports fixed-point extension to C.
1733
1734 @item fopenmp
1735 Target supports OpenMP via @option{-fopenmp}.
1736
1737 @item fpic
1738 Target supports @option{-fpic} and @option{-fPIC}.
1739
1740 @item freorder
1741 Target supports @option{-freorder-blocks-and-partition}.
1742
1743 @item fstack_protector
1744 Target supports @option{-fstack-protector}.
1745
1746 @item gas
1747 Target uses GNU @command{as}.
1748
1749 @item gc_sections
1750 Target supports @option{--gc-sections}.
1751
1752 @item keeps_null_pointer_checks
1753 Target keeps null pointer checks, either due to the use of
1754 @option{-fno-delete-null-pointer-checks} or hardwired into the target.
1755
1756 @item lto
1757 Compiler has been configured to support link-time optimization (LTO).
1758
1759 @item named_sections
1760 Target supports named sections.
1761
1762 @item natural_alignment_32
1763 Target uses natural alignment (aligned to type size) for types of
1764 32 bits or less.
1765
1766 @item target_natural_alignment_64
1767 Target uses natural alignment (aligned to type size) for types of
1768 64 bits or less.
1769
1770 @item nonpic
1771 Target does not generate PIC by default.
1772
1773 @item pcc_bitfield_type_matters
1774 Target defines @code{PCC_BITFIELD_TYPE_MATTERS}.
1775
1776 @item pe_aligned_commons
1777 Target supports @option{-mpe-aligned-commons}.
1778
1779 @item section_anchors
1780 Target supports section anchors.
1781
1782 @item short_enums
1783 Target defaults to short enums.
1784
1785 @item static
1786 Target supports @option{-static}.
1787
1788 @item static_libgfortran
1789 Target supports statically linking @samp{libgfortran}.
1790
1791 @item string_merging
1792 Target supports merging string constants at link time.
1793
1794 @item ucn
1795 Target supports compiling and assembling UCN.
1796
1797 @item ucn_nocache
1798 Including the options used to compile this particular test, the
1799 target supports compiling and assembling UCN.
1800
1801 @item unaligned_stack
1802 Target does not guarantee that its @code{STACK_BOUNDARY} is greater than
1803 or equal to the required vector alignment.
1804
1805 @item vector_alignment_reachable
1806 Vector alignment is reachable for types of 32 bits or less.
1807
1808 @item vector_alignment_reachable_for_64bit
1809 Vector alignment is reachable for types of 64 bits or less.
1810
1811 @item wchar_t_char16_t_compatible
1812 Target supports @code{wchar_t} that is compatible with @code{char16_t}.
1813
1814 @item wchar_t_char32_t_compatible
1815 Target supports @code{wchar_t} that is compatible with @code{char32_t}.
1816 @end table
1817
1818 @subsubsection Local to tests in @code{gcc.target/i386}
1819
1820 @table @code
1821 @item 3dnow
1822 Target supports compiling @code{3dnow} instructions.
1823
1824 @item aes
1825 Target supports compiling @code{aes} instructions.
1826
1827 @item fma4
1828 Target supports compiling @code{fma4} instructions.
1829
1830 @item ms_hook_prologue
1831 Target supports attribute @code{ms_hook_prologue}.
1832
1833 @item pclmul
1834 Target supports compiling @code{pclmul} instructions.
1835
1836 @item sse3
1837 Target supports compiling @code{sse3} instructions.
1838
1839 @item sse4
1840 Target supports compiling @code{sse4} instructions.
1841
1842 @item sse4a
1843 Target supports compiling @code{sse4a} instructions.
1844
1845 @item ssse3
1846 Target supports compiling @code{ssse3} instructions.
1847
1848 @item vaes
1849 Target supports compiling @code{vaes} instructions.
1850
1851 @item vpclmul
1852 Target supports compiling @code{vpclmul} instructions.
1853
1854 @item xop
1855 Target supports compiling @code{xop} instructions.
1856 @end table
1857
1858 @subsubsection Local to tests in @code{gcc.target/spu/ea}
1859
1860 @table @code
1861 @item ealib
1862 Target @code{__ea} library functions are available.
1863 @end table
1864
1865 @subsubsection Local to tests in @code{gcc.test-framework}
1866
1867 @table @code
1868 @item no
1869 Always returns 0.
1870
1871 @item yes
1872 Always returns 1.
1873 @end table
1874
1875 @node Add Options
1876 @subsection Features for @code{dg-add-options}
1877
1878 The supported values of @var{feature} for directive @code{dg-add-options}
1879 are:
1880
1881 @table @code
1882 @item arm_neon
1883 NEON support.  Only ARM targets support this feature, and only then
1884 in certain modes; see the @ref{arm_neon_ok,,arm_neon_ok effective target
1885 keyword}.
1886
1887 @item arm_neon_fp16
1888 NEON and half-precision floating point support.  Only ARM targets
1889 support this feature, and only then in certain modes; see
1890 the @ref{arm_neon_ok,,arm_neon_fp16_ok effective target keyword}.
1891
1892 @item bind_pic_locally
1893 Add the target-specific flags needed to enable functions to bind
1894 locally when using pic/PIC passes in the testsuite.
1895
1896 @item c99_runtime
1897 Add the target-specific flags needed to access the C99 runtime.
1898
1899 @item ieee
1900 Add the target-specific flags needed to enable full IEEE
1901 compliance mode.
1902
1903 @item mips16_attribute
1904 @code{mips16} function attributes.
1905 Only MIPS targets support this feature, and only then in certain modes.
1906
1907 @item tls
1908 Add the target-specific flags needed to use thread-local storage.
1909 @end table
1910
1911 @node Require Support
1912 @subsection Variants of @code{dg-require-@var{support}}
1913
1914 A few of the @code{dg-require} directives take arguments.
1915
1916 @table @code
1917 @item dg-require-iconv @var{codeset}
1918 Skip the test if the target does not support iconv.  @var{codeset} is
1919 the codeset to convert to.
1920
1921 @item dg-require-profiling @var{profopt}
1922 Skip the test if the target does not support profiling with option
1923 @var{profopt}.
1924
1925 @item dg-require-visibility @var{vis}
1926 Skip the test if the target does not support the @code{visibility} attribute.
1927 If @var{vis} is @code{""}, support for @code{visibility("hidden")} is
1928 checked, for @code{visibility("@var{vis}")} otherwise.
1929 @end table
1930
1931 The original @code{dg-require} directives were defined before there
1932 was support for effective-target keywords.  The directives that do not
1933 take arguments could be replaced with effective-target keywords.
1934
1935 @table @code
1936 @item dg-require-alias ""
1937 Skip the test if the target does not support the @samp{alias} attribute.
1938
1939 @item dg-require-compat-dfp ""
1940 Skip this test unless both compilers in a @file{compat} testsuite
1941 support decimal floating point.
1942
1943 @item dg-require-cxa-atexit ""
1944 Skip the test if the target does not support @code{__cxa_atexit}.
1945 This is equivalent to @code{dg-require-effective-target cxa_atexit}.
1946
1947 @item dg-require-dll ""
1948 Skip the test if the target does not support DLL attributes.
1949
1950 @item dg-require-fork ""
1951 Skip the test if the target does not support @code{fork}.
1952
1953 @item dg-require-gc-sections ""
1954 Skip the test if the target's linker does not support the
1955 @code{--gc-sections} flags.
1956 This is equivalent to @code{dg-require-effective-target gc-sections}.
1957
1958 @item dg-require-host-local ""
1959 Skip the test if the host is remote, rather than the same as the build
1960 system.  Some tests are incompatible with DejaGnu's handling of remote
1961 hosts, which involves copying the source file to the host and compiling
1962 it with a relative path and "@code{-o a.out}".
1963
1964 @item dg-require-mkfifo ""
1965 Skip the test if the target does not support @code{mkfifo}.
1966
1967 @item dg-require-named-sections ""
1968 Skip the test is the target does not support named sections.
1969 This is equivalent to @code{dg-require-effective-target named_sections}.
1970
1971 @item dg-require-weak ""
1972 Skip the test if the target does not support weak symbols.
1973
1974 @item dg-require-weak-override ""
1975 Skip the test if the target does not support overriding weak symbols.
1976 @end table
1977
1978 @node Final Actions
1979 @subsection Commands for use in @code{dg-final}
1980
1981 The GCC testsuite defines the following directives to be used within
1982 @code{dg-final}.
1983
1984 @subsubsection Scan a particular file
1985
1986 @table @code
1987 @item scan-file @var{filename} @var{regexp} [@{ target/xfail @var{selector} @}]
1988 Passes if @var{regexp} matches text in @var{filename}.
1989 @item scan-file-not @var{filename} @var{regexp} [@{ target/xfail @var{selector} @}]
1990 Passes if @var{regexp} does not match text in @var{filename}.
1991 @item scan-module @var{module} @var{regexp} [@{ target/xfail @var{selector} @}]
1992 Passes if @var{regexp} matches in Fortran module @var{module}.
1993 @end table
1994
1995 @subsubsection Scan the assembly output
1996
1997 @table @code
1998 @item scan-assembler @var{regex} [@{ target/xfail @var{selector} @}]
1999 Passes if @var{regex} matches text in the test's assembler output.
2000
2001 @item scan-assembler-not @var{regex} [@{ target/xfail @var{selector} @}]
2002 Passes if @var{regex} does not match text in the test's assembler output.
2003
2004 @item scan-assembler-times @var{regex} @var{num} [@{ target/xfail @var{selector} @}]
2005 Passes if @var{regex} is matched exactly @var{num} times in the test's
2006 assembler output.
2007
2008 @item scan-assembler-dem @var{regex} [@{ target/xfail @var{selector} @}]
2009 Passes if @var{regex} matches text in the test's demangled assembler output.
2010
2011 @item scan-assembler-dem-not @var{regex} [@{ target/xfail @var{selector} @}]
2012 Passes if @var{regex} does not match text in the test's demangled assembler
2013 output.
2014
2015 @item scan-hidden @var{symbol} [@{ target/xfail @var{selector} @}]
2016 Passes if @var{symbol} is defined as a hidden symbol in the test's
2017 assembly output.
2018
2019 @item scan-not-hidden @var{symbol} [@{ target/xfail @var{selector} @}]
2020 Passes if @var{symbol} is not defined as a hidden symbol in the test's
2021 assembly output.
2022 @end table
2023
2024 @subsubsection Scan optimization dump files
2025
2026 These commands are available for @var{kind} of @code{tree}, @code{rtl},
2027 and @code{ipa}.
2028
2029 @table @code
2030 @item scan-@var{kind}-dump @var{regex} @var{suffix} [@{ target/xfail @var{selector} @}]
2031 Passes if @var{regex} matches text in the dump file with suffix @var{suffix}.
2032
2033 @item scan-@var{kind}-dump-not @var{regex} @var{suffix} [@{ target/xfail @var{selector} @}]
2034 Passes if @var{regex} does not match text in the dump file with suffix
2035 @var{suffix}.
2036
2037 @item scan-@var{kind}-dump-times @var{regex} @var{num} @var{suffix} [@{ target/xfail @var{selector} @}]
2038 Passes if @var{regex} is found exactly @var{num} times in the dump file
2039 with suffix @var{suffix}.
2040
2041 @item scan-@var{kind}-dump-dem @var{regex} @var{suffix} [@{ target/xfail @var{selector} @}]
2042 Passes if @var{regex} matches demangled text in the dump file with
2043 suffix @var{suffix}.
2044
2045 @item scan-@var{kind}-dump-dem-not @var{regex} @var{suffix} [@{ target/xfail @var{selector} @}]
2046 Passes if @var{regex} does not match demangled text in the dump file with
2047 suffix @var{suffix}.
2048 @end table
2049
2050 @subsubsection Verify that an output files exists or not
2051
2052 @table @code
2053 @item output-exists [@{ target/xfail @var{selector} @}]
2054 Passes if compiler output file exists.
2055
2056 @item output-exists-not [@{ target/xfail @var{selector} @}]
2057 Passes if compiler output file does not exist.
2058 @end table
2059
2060 @subsubsection Check for LTO tests
2061
2062 @table @code
2063 @item scan-symbol @var{regexp} [@{ target/xfail @var{selector} @}]
2064 Passes if the pattern is present in the final executable.
2065 @end table
2066
2067 @subsubsection Checks for @command{gcov} tests
2068
2069 @table @code
2070 @item run-gcov @var{sourcefile}
2071 Check line counts in @command{gcov} tests.
2072
2073 @item run-gcov [branches] [calls] @{ @var{opts} @var{sourcefile} @}
2074 Check branch and/or call counts, in addition to line counts, in
2075 @command{gcov} tests.
2076 @end table
2077
2078 @subsubsection Clean up generated test files
2079
2080 @table @code
2081 @item cleanup-coverage-files
2082 Removes coverage data files generated for this test.
2083
2084 @item cleanup-ipa-dump @var{suffix}
2085 Removes IPA dump files generated for this test.
2086
2087 @item cleanup-modules
2088 Removes Fortran module files generated for this test.
2089
2090 @item cleanup-profile-file
2091 Removes profiling files generated for this test.
2092
2093 @item cleanup-repo-files
2094 Removes files generated for this test for @option{-frepo}.
2095
2096 @item cleanup-rtl-dump @var{suffix}
2097 Removes RTL dump files generated for this test.
2098
2099 @item cleanup-saved-temps
2100 Removes files for the current test which were kept for @option{-save-temps}.
2101
2102 @item cleanup-tree-dump @var{suffix}
2103 Removes tree dump files matching @var{suffix} which were generated for
2104 this test.
2105 @end table
2106
2107 @node Ada Tests
2108 @section Ada Language Testsuites
2109
2110 The Ada testsuite includes executable tests from the ACATS 2.5
2111 testsuite, publicly available at
2112 @uref{http://www.adaic.org/compilers/acats/2.5}.
2113
2114 These tests are integrated in the GCC testsuite in the
2115 @file{ada/acats} directory, and
2116 enabled automatically when running @code{make check}, assuming
2117 the Ada language has been enabled when configuring GCC@.
2118
2119 You can also run the Ada testsuite independently, using
2120 @code{make check-ada}, or run a subset of the tests by specifying which
2121 chapter to run, e.g.:
2122
2123 @smallexample
2124 $ make check-ada CHAPTERS="c3 c9"
2125 @end smallexample
2126
2127 The tests are organized by directory, each directory corresponding to
2128 a chapter of the Ada Reference Manual.  So for example, @file{c9} corresponds
2129 to chapter 9, which deals with tasking features of the language.
2130
2131 There is also an extra chapter called @file{gcc} containing a template for
2132 creating new executable tests, although this is deprecated in favor of
2133 the @file{gnat.dg} testsuite.
2134
2135 The tests are run using two @command{sh} scripts: @file{run_acats} and
2136 @file{run_all.sh}.  To run the tests using a simulator or a cross
2137 target, see the small
2138 customization section at the top of @file{run_all.sh}.
2139
2140 These tests are run using the build tree: they can be run without doing
2141 a @code{make install}.
2142
2143 @node C Tests
2144 @section C Language Testsuites
2145
2146 GCC contains the following C language testsuites, in the
2147 @file{gcc/testsuite} directory:
2148
2149 @table @file
2150 @item gcc.dg
2151 This contains tests of particular features of the C compiler, using the
2152 more modern @samp{dg} harness.  Correctness tests for various compiler
2153 features should go here if possible.
2154
2155 Magic comments determine whether the file
2156 is preprocessed, compiled, linked or run.  In these tests, error and warning
2157 message texts are compared against expected texts or regular expressions
2158 given in comments.  These tests are run with the options @samp{-ansi -pedantic}
2159 unless other options are given in the test.  Except as noted below they
2160 are not run with multiple optimization options.
2161 @item gcc.dg/compat
2162 This subdirectory contains tests for binary compatibility using
2163 @file{lib/compat.exp}, which in turn uses the language-independent support
2164 (@pxref{compat Testing, , Support for testing binary compatibility}).
2165 @item gcc.dg/cpp
2166 This subdirectory contains tests of the preprocessor.
2167 @item gcc.dg/debug
2168 This subdirectory contains tests for debug formats.  Tests in this
2169 subdirectory are run for each debug format that the compiler supports.
2170 @item gcc.dg/format
2171 This subdirectory contains tests of the @option{-Wformat} format
2172 checking.  Tests in this directory are run with and without
2173 @option{-DWIDE}.
2174 @item gcc.dg/noncompile
2175 This subdirectory contains tests of code that should not compile and
2176 does not need any special compilation options.  They are run with
2177 multiple optimization options, since sometimes invalid code crashes
2178 the compiler with optimization.
2179 @item gcc.dg/special
2180 FIXME: describe this.
2181
2182 @item gcc.c-torture
2183 This contains particular code fragments which have historically broken easily.
2184 These tests are run with multiple optimization options, so tests for features
2185 which only break at some optimization levels belong here.  This also contains
2186 tests to check that certain optimizations occur.  It might be worthwhile to
2187 separate the correctness tests cleanly from the code quality tests, but
2188 it hasn't been done yet.
2189
2190 @item gcc.c-torture/compat
2191 FIXME: describe this.
2192
2193 This directory should probably not be used for new tests.
2194 @item gcc.c-torture/compile
2195 This testsuite contains test cases that should compile, but do not
2196 need to link or run.  These test cases are compiled with several
2197 different combinations of optimization options.  All warnings are
2198 disabled for these test cases, so this directory is not suitable if
2199 you wish to test for the presence or absence of compiler warnings.
2200 While special options can be set, and tests disabled on specific
2201 platforms, by the use of @file{.x} files, mostly these test cases
2202 should not contain platform dependencies.  FIXME: discuss how defines
2203 such as @code{NO_LABEL_VALUES} and @code{STACK_SIZE} are used.
2204 @item gcc.c-torture/execute
2205 This testsuite contains test cases that should compile, link and run;
2206 otherwise the same comments as for @file{gcc.c-torture/compile} apply.
2207 @item gcc.c-torture/execute/ieee
2208 This contains tests which are specific to IEEE floating point.
2209 @item gcc.c-torture/unsorted
2210 FIXME: describe this.
2211
2212 This directory should probably not be used for new tests.
2213 @item gcc.misc-tests
2214 This directory contains C tests that require special handling.  Some
2215 of these tests have individual expect files, and others share
2216 special-purpose expect files:
2217
2218 @table @file
2219 @item @code{bprob*.c}
2220 Test @option{-fbranch-probabilities} using
2221 @file{gcc.misc-tests/bprob.exp}, which
2222 in turn uses the generic, language-independent framework
2223 (@pxref{profopt Testing, , Support for testing profile-directed
2224 optimizations}).
2225
2226 @item @code{gcov*.c}
2227 Test @command{gcov} output using @file{gcov.exp}, which in turn uses the
2228 language-independent support (@pxref{gcov Testing, , Support for testing gcov}).
2229
2230 @item @code{i386-pf-*.c}
2231 Test i386-specific support for data prefetch using @file{i386-prefetch.exp}.
2232 @end table
2233
2234 @item gcc.test-framework
2235 @table @file
2236 @item @code{dg-*.c}
2237 Test the testsuite itself using @file{gcc.test-framework/test-framework.exp}.
2238 @end table
2239
2240 @end table
2241
2242 FIXME: merge in @file{testsuite/README.gcc} and discuss the format of
2243 test cases and magic comments more.
2244
2245 @node libgcj Tests
2246 @section The Java library testsuites.
2247
2248 Runtime tests are executed via @samp{make check} in the
2249 @file{@var{target}/libjava/testsuite} directory in the build
2250 tree.  Additional runtime tests can be checked into this testsuite.
2251
2252 Regression testing of the core packages in libgcj is also covered by the
2253 Mauve testsuite.  The @uref{http://sourceware.org/mauve/,,Mauve Project}
2254 develops tests for the Java Class Libraries.  These tests are run as part
2255 of libgcj testing by placing the Mauve tree within the libjava testsuite
2256 sources at @file{libjava/testsuite/libjava.mauve/mauve}, or by specifying
2257 the location of that tree when invoking @samp{make}, as in
2258 @samp{make MAUVEDIR=~/mauve check}.
2259
2260 To detect regressions, a mechanism in @file{mauve.exp} compares the
2261 failures for a test run against the list of expected failures in
2262 @file{libjava/testsuite/libjava.mauve/xfails} from the source hierarchy.
2263 Update this file when adding new failing tests to Mauve, or when fixing
2264 bugs in libgcj that had caused Mauve test failures.
2265
2266 We encourage developers to contribute test cases to Mauve.
2267
2268 @node LTO Testing
2269 @section Support for testing link-time optimizations
2270
2271 Tests for link-time optimizations usually require multiple source files
2272 that are compiled separately, perhaps with different sets of options.
2273 There are several special-purpose test directives used for these tests.
2274
2275 @table @code
2276 @item @{ dg-lto-do @var{do-what-keyword} @}
2277 @var{do-what-keyword} specifies how the test is compiled and whether
2278 it is executed.  It is one of:
2279
2280 @table @code
2281 @item assemble
2282 Compile with @option{-c} to produce a relocatable object file.
2283 @item link
2284 Compile, assemble, and link to produce an executable file.
2285 @item run
2286 Produce and run an executable file, which is expected to return
2287 an exit code of 0.
2288 @end table
2289
2290 The default is @code{assemble}.  That can be overridden for a set of
2291 tests by redefining @code{dg-do-what-default} within the @code{.exp}
2292 file for those tests.
2293
2294 Unlike @code{dg-do}, @code{dg-lto-do} does not support an optional
2295 @samp{target} or @samp{xfail} list.  Use @code{dg-skip-if},
2296 @code{dg-xfail-if}, or @code{dg-xfail-run-if}.
2297
2298 @item @{ dg-lto-options @{ @{ @var{options} @} [@{ @var{options} @}] @} [@{ target @var{selector} @}]@}
2299 This directive provides a list of one or more sets of compiler options
2300 to override @var{LTO_OPTIONS}.  Each test will be compiled and run with
2301 each of these sets of options.
2302
2303 @item @{ dg-extra-ld-options @var{options} [@{ target @var{selector} @}]@}
2304 This directive adds @var{options} to the linker options used.
2305
2306 @item @{ dg-suppress-ld-options @var{options} [@{ target @var{selector} @}]@}
2307 This directive removes @var{options} from the set of linker options used.
2308 @end table
2309
2310 @node gcov Testing
2311 @section Support for testing @command{gcov}
2312
2313 Language-independent support for testing @command{gcov}, and for checking
2314 that branch profiling produces expected values, is provided by the
2315 expect file @file{lib/gcov.exp}.  @command{gcov} tests also rely on procedures
2316 in @file{lib/gcc-dg.exp} to compile and run the test program.  A typical
2317 @command{gcov} test contains the following DejaGnu commands within comments:
2318
2319 @smallexample
2320 @{ dg-options "-fprofile-arcs -ftest-coverage" @}
2321 @{ dg-do run @{ target native @} @}
2322 @{ dg-final @{ run-gcov sourcefile @} @}
2323 @end smallexample
2324
2325 Checks of @command{gcov} output can include line counts, branch percentages,
2326 and call return percentages.  All of these checks are requested via
2327 commands that appear in comments in the test's source file.
2328 Commands to check line counts are processed by default.
2329 Commands to check branch percentages and call return percentages are
2330 processed if the @command{run-gcov} command has arguments @code{branches}
2331 or @code{calls}, respectively.  For example, the following specifies
2332 checking both, as well as passing @option{-b} to @command{gcov}:
2333
2334 @smallexample
2335 @{ dg-final @{ run-gcov branches calls @{ -b sourcefile @} @} @}
2336 @end smallexample
2337
2338 A line count command appears within a comment on the source line
2339 that is expected to get the specified count and has the form
2340 @code{count(@var{cnt})}.  A test should only check line counts for
2341 lines that will get the same count for any architecture.
2342
2343 Commands to check branch percentages (@code{branch}) and call
2344 return percentages (@code{returns}) are very similar to each other.
2345 A beginning command appears on or before the first of a range of
2346 lines that will report the percentage, and the ending command
2347 follows that range of lines.  The beginning command can include a
2348 list of percentages, all of which are expected to be found within
2349 the range.  A range is terminated by the next command of the same
2350 kind.  A command @code{branch(end)} or @code{returns(end)} marks
2351 the end of a range without starting a new one.  For example:
2352
2353 @smallexample
2354 if (i > 10 && j > i && j < 20)  /* @r{branch(27 50 75)} */
2355                                 /* @r{branch(end)} */
2356   foo (i, j);
2357 @end smallexample
2358
2359 For a call return percentage, the value specified is the
2360 percentage of calls reported to return.  For a branch percentage,
2361 the value is either the expected percentage or 100 minus that
2362 value, since the direction of a branch can differ depending on the
2363 target or the optimization level.
2364
2365 Not all branches and calls need to be checked.  A test should not
2366 check for branches that might be optimized away or replaced with
2367 predicated instructions.  Don't check for calls inserted by the
2368 compiler or ones that might be inlined or optimized away.
2369
2370 A single test can check for combinations of line counts, branch
2371 percentages, and call return percentages.  The command to check a
2372 line count must appear on the line that will report that count, but
2373 commands to check branch percentages and call return percentages can
2374 bracket the lines that report them.
2375
2376 @node profopt Testing
2377 @section Support for testing profile-directed optimizations
2378
2379 The file @file{profopt.exp} provides language-independent support for
2380 checking correct execution of a test built with profile-directed
2381 optimization.  This testing requires that a test program be built and
2382 executed twice.  The first time it is compiled to generate profile
2383 data, and the second time it is compiled to use the data that was
2384 generated during the first execution.  The second execution is to
2385 verify that the test produces the expected results.
2386
2387 To check that the optimization actually generated better code, a
2388 test can be built and run a third time with normal optimizations to
2389 verify that the performance is better with the profile-directed
2390 optimizations.  @file{profopt.exp} has the beginnings of this kind
2391 of support.
2392
2393 @file{profopt.exp} provides generic support for profile-directed
2394 optimizations.  Each set of tests that uses it provides information
2395 about a specific optimization:
2396
2397 @table @code
2398 @item tool
2399 tool being tested, e.g., @command{gcc}
2400
2401 @item profile_option
2402 options used to generate profile data
2403
2404 @item feedback_option
2405 options used to optimize using that profile data
2406
2407 @item prof_ext
2408 suffix of profile data files
2409
2410 @item PROFOPT_OPTIONS
2411 list of options with which to run each test, similar to the lists for
2412 torture tests
2413
2414 @item @{ dg-final-generate @{ @var{local-directive} @} @}
2415 This directive is similar to @code{dg-final}, but the
2416 @var{local-directive} is run after the generation of profile data.
2417
2418 @item @{ dg-final-use @{ @var{local-directive} @} @}
2419 The @var{local-directive} is run after the profile data have been
2420 used.
2421 @end table
2422
2423 @node compat Testing
2424 @section Support for testing binary compatibility
2425
2426 The file @file{compat.exp} provides language-independent support for
2427 binary compatibility testing.  It supports testing interoperability of
2428 two compilers that follow the same ABI, or of multiple sets of
2429 compiler options that should not affect binary compatibility.  It is
2430 intended to be used for testsuites that complement ABI testsuites.
2431
2432 A test supported by this framework has three parts, each in a
2433 separate source file: a main program and two pieces that interact
2434 with each other to split up the functionality being tested.
2435
2436 @table @file
2437 @item @var{testname}_main.@var{suffix}
2438 Contains the main program, which calls a function in file
2439 @file{@var{testname}_x.@var{suffix}}.
2440
2441 @item @var{testname}_x.@var{suffix}
2442 Contains at least one call to a function in
2443 @file{@var{testname}_y.@var{suffix}}.
2444
2445 @item @var{testname}_y.@var{suffix}
2446 Shares data with, or gets arguments from,
2447 @file{@var{testname}_x.@var{suffix}}.
2448 @end table
2449
2450 Within each test, the main program and one functional piece are
2451 compiled by the GCC under test.  The other piece can be compiled by
2452 an alternate compiler.  If no alternate compiler is specified,
2453 then all three source files are all compiled by the GCC under test.
2454 You can specify pairs of sets of compiler options.  The first element
2455 of such a pair specifies options used with the GCC under test, and the
2456 second element of the pair specifies options used with the alternate
2457 compiler.  Each test is compiled with each pair of options.
2458
2459 @file{compat.exp} defines default pairs of compiler options.
2460 These can be overridden by defining the environment variable
2461 @env{COMPAT_OPTIONS} as:
2462
2463 @smallexample
2464 COMPAT_OPTIONS="[list [list @{@var{tst1}@} @{@var{alt1}@}]
2465   @dots{}[list @{@var{tstn}@} @{@var{altn}@}]]"
2466 @end smallexample
2467
2468 where @var{tsti} and @var{alti} are lists of options, with @var{tsti}
2469 used by the compiler under test and @var{alti} used by the alternate
2470 compiler.  For example, with
2471 @code{[list [list @{-g -O0@} @{-O3@}] [list @{-fpic@} @{-fPIC -O2@}]]},
2472 the test is first built with @option{-g -O0} by the compiler under
2473 test and with @option{-O3} by the alternate compiler.  The test is
2474 built a second time using @option{-fpic} by the compiler under test
2475 and @option{-fPIC -O2} by the alternate compiler.
2476
2477 An alternate compiler is specified by defining an environment
2478 variable to be the full pathname of an installed compiler; for C
2479 define @env{ALT_CC_UNDER_TEST}, and for C++ define
2480 @env{ALT_CXX_UNDER_TEST}.  These will be written to the
2481 @file{site.exp} file used by DejaGnu.  The default is to build each
2482 test with the compiler under test using the first of each pair of
2483 compiler options from @env{COMPAT_OPTIONS}.  When
2484 @env{ALT_CC_UNDER_TEST} or
2485 @env{ALT_CXX_UNDER_TEST} is @code{same}, each test is built using
2486 the compiler under test but with combinations of the options from
2487 @env{COMPAT_OPTIONS}.
2488
2489 To run only the C++ compatibility suite using the compiler under test
2490 and another version of GCC using specific compiler options, do the
2491 following from @file{@var{objdir}/gcc}:
2492
2493 @smallexample
2494 rm site.exp
2495 make -k \
2496   ALT_CXX_UNDER_TEST=$@{alt_prefix@}/bin/g++ \
2497   COMPAT_OPTIONS="@var{lists as shown above}" \
2498   check-c++ \
2499   RUNTESTFLAGS="compat.exp"
2500 @end smallexample
2501
2502 A test that fails when the source files are compiled with different
2503 compilers, but passes when the files are compiled with the same
2504 compiler, demonstrates incompatibility of the generated code or
2505 runtime support.  A test that fails for the alternate compiler but
2506 passes for the compiler under test probably tests for a bug that was
2507 fixed in the compiler under test but is present in the alternate
2508 compiler.
2509
2510 The binary compatibility tests support a small number of test framework
2511 commands that appear within comments in a test file.
2512
2513 @table @code
2514 @item dg-require-*
2515 These commands can be used in @file{@var{testname}_main.@var{suffix}}
2516 to skip the test if specific support is not available on the target.
2517
2518 @item dg-options
2519 The specified options are used for compiling this particular source
2520 file, appended to the options from @env{COMPAT_OPTIONS}.  When this
2521 command appears in @file{@var{testname}_main.@var{suffix}} the options
2522 are also used to link the test program.
2523
2524 @item dg-xfail-if
2525 This command can be used in a secondary source file to specify that
2526 compilation is expected to fail for particular options on particular
2527 targets.
2528 @end table
2529
2530 @node Torture Tests
2531 @section Support for torture testing using multiple options
2532
2533 Throughout the compiler testsuite there are several directories whose
2534 tests are run multiple times, each with a different set of options.
2535 These are known as torture tests.
2536 @file{lib/torture-options.exp} defines procedures to
2537 set up these lists:
2538
2539 @table @code
2540 @item torture-init
2541 Initialize use of torture lists.
2542 @item set-torture-options
2543 Set lists of torture options to use for tests with and without loops.
2544 Optionally combine a set of torture options with a set of other
2545 options, as is done with Objective-C runtime options.
2546 @item torture-finish
2547 Finalize use of torture lists.
2548 @end table
2549
2550 The @file{.exp} file for a set of tests that use torture options must
2551 include calls to these three procedures if:
2552
2553 @itemize @bullet
2554 @item It calls @code{gcc-dg-runtest} and overrides @var{DG_TORTURE_OPTIONS}.
2555
2556 @item It calls @var{$@{tool@}}@code{-torture} or
2557 @var{$@{tool@}}@code{-torture-execute}, where @var{tool} is @code{c},
2558 @code{fortran}, or @code{objc}.
2559
2560 @item It calls @code{dg-pch}.
2561 @end itemize
2562
2563 It is not necessary for a @file{.exp} file that calls @code{gcc-dg-runtest}
2564 to call the torture procedures if the tests should use the list in
2565 @var{DG_TORTURE_OPTIONS} defined in @file{gcc-dg.exp}.
2566
2567 Most uses of torture options can override the default lists by defining
2568 @var{TORTURE_OPTIONS} or add to the default list by defining
2569 @var{ADDITIONAL_TORTURE_OPTIONS}.  Define these in a @file{.dejagnurc}
2570 file or add them to the @file{site.exp} file; for example
2571
2572 @smallexample
2573 set ADDITIONAL_TORTURE_OPTIONS  [list \
2574   @{ -O2 -ftree-loop-linear @} \
2575   @{ -O2 -fpeel-loops @} ]
2576 @end smallexample