]> git.ipfire.org Git - thirdparty/gcc.git/blame - gcc/doc/invoke.texi
[multiple changes]
[thirdparty/gcc.git] / gcc / doc / invoke.texi
CommitLineData
d0a5eb32 1@c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
f2fd3821 2@c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
74291a4b
MM
3@c This is part of the GCC manual.
4@c For copying conditions, see the file gcc.texi.
5
9d86bffc 6@ignore
9d530538
MM
7@c man begin INCLUDE
8@include gcc-vers.texi
9@c man end
10
9d86bffc
JM
11@c man begin COPYRIGHT
12Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
f2fd3821 131998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
9d86bffc 14
77bd67cb 15Permission is granted to copy, distribute and/or modify this document
b3a8389d 16under the terms of the GNU Free Documentation License, Version 1.2 or
77bd67cb
JM
17any later version published by the Free Software Foundation; with the
18Invariant Sections being ``GNU General Public License'' and ``Funding
19Free Software'', the Front-Cover texts being (a) (see below), and with
20the Back-Cover Texts being (b) (see below). A copy of the license is
21included in the gfdl(7) man page.
9d86bffc 22
77bd67cb 23(a) The FSF's Front-Cover Text is:
9d86bffc 24
77bd67cb
JM
25 A GNU Manual
26
27(b) The FSF's Back-Cover Text is:
28
29 You have freedom to copy and modify this GNU Manual, like GNU
30 software. Copies published by the Free Software Foundation raise
31 funds for GNU development.
9d86bffc
JM
32@c man end
33@c Set file name and title for the man page.
34@setfilename gcc
35@settitle GNU project C and C++ compiler
36@c man begin SYNOPSIS
630d3d5a
JM
37gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
38 [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
39 [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
40 [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
41 [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
42 [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
9d530538 43 [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
9d86bffc
JM
44
45Only the most useful options are listed here; see below for the
46remainder. @samp{g++} accepts mostly the same options as @samp{gcc}.
47@c man end
48@c man begin SEEALSO
77bd67cb 49gpl(7), gfdl(7), fsf-funding(7),
b4117c30
ZW
50cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
51and the Info entries for @file{gcc}, @file{cpp}, @file{as},
9d86bffc
JM
52@file{ld}, @file{binutils} and @file{gdb}.
53@c man end
2642624b
JM
54@c man begin BUGS
55For instructions on reporting bugs, see
ee86feaf 56@w{@uref{http://gcc.gnu.org/bugs.html}}.
2642624b
JM
57@c man end
58@c man begin AUTHOR
24dbb440
GP
59See the Info entry for @command{gcc}, or
60@w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
61for contributors to GCC@.
2642624b 62@c man end
9d86bffc
JM
63@end ignore
64
74291a4b 65@node Invoking GCC
0c2d1a2a
JB
66@chapter GCC Command Options
67@cindex GCC command options
74291a4b 68@cindex command options
0c2d1a2a 69@cindex options, GCC command
74291a4b 70
9d86bffc 71@c man begin DESCRIPTION
0c2d1a2a 72When you invoke GCC, it normally does preprocessing, compilation,
74291a4b 73assembly and linking. The ``overall options'' allow you to stop this
630d3d5a 74process at an intermediate stage. For example, the @option{-c} option
74291a4b
MM
75says not to run the linker. Then the output consists of object files
76output by the assembler.
77
78Other options are passed on to one stage of processing. Some options
79control the preprocessor and others the compiler itself. Yet other
80options control the assembler and linker; most of these are not
81documented here, since you rarely need to use any of them.
82
83@cindex C compilation options
0c2d1a2a 84Most of the command line options that you can use with GCC are useful
74291a4b
MM
85for C programs; when an option is only useful with another language
86(usually C++), the explanation says so explicitly. If the description
87for a particular option does not mention a source language, you can use
88that option with all supported languages.
89
90@cindex C++ compilation options
91@xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
92options for compiling C++ programs.
93
94@cindex grouping options
95@cindex options, grouping
bedc7537 96The @command{gcc} program accepts options and file names as operands. Many
b192711e 97options have multi-letter names; therefore multiple single-letter options
630d3d5a 98may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
74291a4b
MM
99-r}}.
100
101@cindex order of options
102@cindex options, order
103You can mix options and other arguments. For the most part, the order
104you use doesn't matter. Order does matter when you use several options
630d3d5a 105of the same kind; for example, if you specify @option{-L} more than once,
74291a4b
MM
106the directories are searched in the order specified.
107
108Many options have long names starting with @samp{-f} or with
1d8eeb63 109@samp{-W}---for example,
630d3d5a 110@option{-fstrength-reduce}, @option{-Wformat} and so on. Most of
74291a4b 111these have both positive and negative forms; the negative form of
630d3d5a 112@option{-ffoo} would be @option{-fno-foo}. This manual documents
74291a4b
MM
113only one of these two forms, whichever one is not the default.
114
9d86bffc
JM
115@c man end
116
cd3bb277
JM
117@xref{Option Index}, for an index to GCC's options.
118
74291a4b
MM
119@menu
120* Option Summary:: Brief list of all options, without explanations.
121* Overall Options:: Controlling the kind of output:
122 an executable, object files, assembler files,
123 or preprocessed source.
124* Invoking G++:: Compiling C++ programs.
125* C Dialect Options:: Controlling the variant of C language compiled.
126* C++ Dialect Options:: Variations on C++.
46e34f96
ZL
127* Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
128 and Objective-C++.
764dbbf2 129* Language Independent Options:: Controlling how diagnostics should be
02f52e19 130 formatted.
74291a4b
MM
131* Warning Options:: How picky should the compiler be?
132* Debugging Options:: Symbol tables, measurements, and debugging dumps.
133* Optimize Options:: How much optimization?
134* Preprocessor Options:: Controlling header files and macro definitions.
135 Also, getting dependency information for Make.
136* Assembler Options:: Passing options to the assembler.
137* Link Options:: Specifying libraries and so on.
138* Directory Options:: Where to find header files and libraries.
139 Where to find the compiler executable files.
a743d340 140* Spec Files:: How to pass switches to sub-processes.
0c2d1a2a 141* Target Options:: Running a cross-compiler, or an old version of GCC.
74291a4b
MM
142* Submodel Options:: Specifying minor hardware or convention variations,
143 such as 68010 vs 68020.
144* Code Gen Options:: Specifying conventions for function calls, data layout
145 and register usage.
0c2d1a2a 146* Environment Variables:: Env vars that affect GCC.
17211ab5 147* Precompiled Headers:: Compiling a header once, and using it many times.
74291a4b
MM
148* Running Protoize:: Automatically adding or removing function prototypes.
149@end menu
150
4bc1997b
JM
151@c man begin OPTIONS
152
74291a4b
MM
153@node Option Summary
154@section Option Summary
155
156Here is a summary of all the options, grouped by type. Explanations are
157in the following sections.
158
159@table @emph
160@item Overall Options
161@xref{Overall Options,,Options Controlling the Kind of Output}.
0855eab7 162@gccoptlist{-c -S -E -o @var{file} -combine -pipe -pass-exit-codes @gol
9d530538 163-x @var{language} -v -### --help --target-help --version @@@var{file}}
74291a4b
MM
164
165@item C Language Options
166@xref{C Dialect Options,,Options Controlling C Dialect}.
9a94f7f3
JM
167@gccoptlist{-ansi -std=@var{standard} -aux-info @var{filename} @gol
168-fno-asm -fno-builtin -fno-builtin-@var{function} @gol
750491fc 169-fhosted -ffreestanding -fms-extensions @gol
8a035a6b 170-trigraphs -no-integrated-cpp -traditional -traditional-cpp @gol
4bc1997b
JM
171-fallow-single-precision -fcond-mismatch @gol
172-fsigned-bitfields -fsigned-char @gol
3521b33c 173-funsigned-bitfields -funsigned-char}
74291a4b
MM
174
175@item C++ Language Options
176@xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
9a94f7f3 177@gccoptlist{-fabi-version=@var{n} -fno-access-control -fcheck-new @gol
d63d5d0c 178-fconserve-space -ffriend-injection -fno-const-strings @gol
aa0cc562 179-fno-elide-constructors @gol
7813d14c 180-fno-enforce-eh-specs @gol
1dbb6023 181-ffor-scope -fno-for-scope -fno-gnu-keywords @gol
90ecce3e 182-fno-implicit-templates @gol
4bc1997b
JM
183-fno-implicit-inline-templates @gol
184-fno-implement-inlines -fms-extensions @gol
aa0cc562 185-fno-nonansi-builtins -fno-operator-names @gol
4bc1997b 186-fno-optional-diags -fpermissive @gol
aa0cc562 187-frepo -fno-rtti -fstats -ftemplate-depth-@var{n} @gol
40aac948 188-fno-threadsafe-statics -fuse-cxa-atexit -fno-weak -nostdinc++ @gol
d7afec4b
ND
189-fno-default-inline -fvisibility-inlines-hidden @gol
190-Wabi -Wctor-dtor-privacy @gol
4bc1997b 191-Wnon-virtual-dtor -Wreorder @gol
b2f97e4a 192-Weffc++ -Wno-deprecated -Wstrict-null-sentinel @gol
4bc1997b
JM
193-Wno-non-template-friend -Wold-style-cast @gol
194-Woverloaded-virtual -Wno-pmf-conversions @gol
4e2db7a8 195-Wsign-promo}
74291a4b 196
46e34f96
ZL
197@item Objective-C and Objective-C++ Language Options
198@xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
199Objective-C and Objective-C++ Dialects}.
264fa2db
ZL
200@gccoptlist{
201-fconstant-string-class=@var{class-name} @gol
202-fgnu-runtime -fnext-runtime @gol
203-fno-nil-receivers @gol
6e955430
ZL
204-fobjc-call-cxx-cdtors @gol
205-fobjc-direct-dispatch @gol
264fa2db 206-fobjc-exceptions @gol
6e955430 207-fobjc-gc @gol
264fa2db
ZL
208-freplace-objc-classes @gol
209-fzero-link @gol
210-gen-decls @gol
6e955430
ZL
211-Wassign-intercept @gol
212-Wno-protocol -Wselector @gol
213-Wstrict-selector-match @gol
214-Wundeclared-selector}
60de6385 215
764dbbf2
GDR
216@item Language Independent Options
217@xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
9a94f7f3 218@gccoptlist{-fmessage-length=@var{n} @gol
ccf08a6e
DD
219-fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
220-fdiagnostics-show-options
764dbbf2 221
74291a4b
MM
222@item Warning Options
223@xref{Warning Options,,Options to Request or Suppress Warnings}.
9a94f7f3 224@gccoptlist{-fsyntax-only -pedantic -pedantic-errors @gol
690a704a 225-w -Wextra -Wall -Waggregate-return -Walways-true -Wno-attributes @gol
b7e20b53 226-Wc++-compat -Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
e23bd218 227-Wconversion -Wno-deprecated-declarations @gol
90689ae1 228-Wdisabled-optimization -Wno-div-by-zero -Wno-endif-labels @gol
fb0317c6 229-Werror -Werror-implicit-function-declaration @gol
c65a01af 230-Wfatal-errors -Wfloat-equal -Wformat -Wformat=2 @gol
fb0317c6 231-Wno-format-extra-args -Wformat-nonliteral @gol
c76f4e8e 232-Wformat-security -Wformat-y2k @gol
fb0317c6
VR
233-Wimplicit -Wimplicit-function-declaration -Wimplicit-int @gol
234-Wimport -Wno-import -Winit-self -Winline @gol
53a2494e 235-Wno-int-to-pointer-cast @gol
fb0317c6 236-Wno-invalid-offsetof -Winvalid-pch @gol
f9cc1a70 237-Wlarger-than-@var{len} -Wunsafe-loop-optimizations -Wlong-long @gol
eaac4679 238-Wmain -Wmissing-braces -Wmissing-field-initializers @gol
b02398bd
BE
239-Wmissing-format-attribute -Wmissing-include-dirs @gol
240-Wmissing-noreturn @gol
fb0317c6 241-Wno-multichar -Wnonnull -Wpacked -Wpadded @gol
53a2494e
JM
242-Wparentheses -Wpointer-arith -Wno-pointer-to-int-cast @gol
243-Wredundant-decls @gol
4bc1997b 244-Wreturn-type -Wsequence-point -Wshadow @gol
0aca9021
JW
245-Wsign-compare -Wstack-protector @gol
246-Wstrict-aliasing -Wstrict-aliasing=2 @gol
d77314ec 247-Wstring-literal-comparison @gol
9a94f7f3
JM
248-Wswitch -Wswitch-default -Wswitch-enum @gol
249-Wsystem-headers -Wtrigraphs -Wundef -Wuninitialized @gol
b9b8dde3 250-Wunknown-pragmas -Wno-pragmas -Wunreachable-code @gol
4bc1997b 251-Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
0aca9021 252-Wunused-value -Wunused-variable -Wvariadic-macros @gol
d35a40fc 253-Wvolatile-register-var -Wwrite-strings}
74291a4b 254
fe50c0eb 255@item C-only Warning Options
9a94f7f3 256@gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
fb0317c6 257-Wmissing-prototypes -Wnested-externs -Wold-style-definition @gol
85617eba 258-Wstrict-prototypes -Wtraditional @gol
f2fd3821 259-Wdeclaration-after-statement -Wno-pointer-sign}
fe50c0eb 260
74291a4b
MM
261@item Debugging Options
262@xref{Debugging Options,,Options for Debugging Your Program or GCC}.
9a94f7f3
JM
263@gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
264-fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
aee96fe9 265-fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
9b3e897d 266-fdump-ipa-all -fdump-ipa-cgraph @gol
6de9cd9a 267-fdump-tree-all @gol
9a94f7f3
JM
268-fdump-tree-original@r{[}-@var{n}@r{]} @gol
269-fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
22367161 270-fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
6de9cd9a
DN
271-fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
272-fdump-tree-ch @gol
273-fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
274-fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
275-fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
276-fdump-tree-dom@r{[}-@var{n}@r{]} @gol
277-fdump-tree-dse@r{[}-@var{n}@r{]} @gol
278-fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
279-fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
280-fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
79fe1b3b 281-fdump-tree-nrv -fdump-tree-vect @gol
fa555252 282-fdump-tree-sink @gol
6de9cd9a 283-fdump-tree-sra@r{[}-@var{n}@r{]} @gol
c75ab022 284-fdump-tree-salias @gol
ff2ad0f7 285-fdump-tree-fre@r{[}-@var{n}@r{]} @gol
08873e96 286-fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
c866976a 287-ftree-vectorizer-verbose=@var{n} @gol
0bca51f0 288-fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
a37db56b 289-feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
8a76829c 290-feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
a37db56b 291-frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
014a1138 292-ftest-coverage -ftime-report -fvar-tracking @gol
def66b10 293-g -g@var{level} -gcoff -gdwarf-2 @gol
5f98259a 294-ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
4bc1997b 295-p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
b1018de6 296-print-multi-directory -print-multi-lib @gol
4bc1997b
JM
297-print-prog-name=@var{program} -print-search-dirs -Q @gol
298-save-temps -time}
74291a4b
MM
299
300@item Optimization Options
301@xref{Optimize Options,,Options that Control Optimization}.
9a94f7f3 302@gccoptlist{-falign-functions=@var{n} -falign-jumps=@var{n} @gol
4bc1997b 303-falign-labels=@var{n} -falign-loops=@var{n} @gol
6de9cd9a 304-fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
fca9dc00 305-fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
1194fc79 306-fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
c7463669 307-fcaller-saves -fcprop-registers -fcse-follow-jumps @gol
3450cbc4 308-fcse-skip-blocks -fcx-limited-range -fdata-sections @gol
d63db217 309-fdelayed-branch -fdelete-null-pointer-checks -fearly-inlining @gol
4bc1997b 310-fexpensive-optimizations -ffast-math -ffloat-store @gol
1d8eeb63 311-fforce-addr -ffunction-sections @gol
db643b91
SH
312-fgcse -fgcse-lm -fgcse-sm -fgcse-las -fgcse-after-reload @gol
313-floop-optimize -fcrossjumping -fif-conversion -fif-conversion2 @gol
355866de
RG
314-finline-functions -finline-functions-called-once @gol
315-finline-limit=@var{n} -fkeep-inline-functions @gol
201556f0 316-fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
cd280abb 317-fmodulo-sched -fno-branch-count-reg @gol
5e962776 318-fno-default-inline -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
feb48bde 319-fno-function-cse -fno-guess-branch-probability @gol
6cfc0341 320-fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
f9cc1a70 321-funsafe-math-optimizations -funsafe-loop-optimizations -ffinite-math-only @gol
474eccc6 322-fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
4bc1997b 323-fomit-frame-pointer -foptimize-register-move @gol
5d22c1a5 324-foptimize-sibling-calls -fprefetch-loop-arrays @gol
a8a5f53a 325-fprofile-generate -fprofile-use @gol
a924fe34 326-fregmove -frename-registers @gol
750054a2 327-freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
4bc1997b 328-frerun-cse-after-loop -frerun-loop-opt @gol
38109dab
GL
329-frounding-math -frtl-abstract-sequences @gol
330-fschedule-insns -fschedule-insns2 @gol
e03b7153 331-fno-sched-interblock -fno-sched-spec -fsched-spec-load @gol
569fa502 332-fsched-spec-load-dangerous @gol
0aca9021 333-fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
569fa502 334-fsched2-use-superblocks @gol
d72372e4 335-fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
8a76829c 336-fsignaling-nans -fsingle-precision-constant @gol
0aca9021 337-fstack-protector -fstack-protector-all @gol
9a94f7f3
JM
338-fstrength-reduce -fstrict-aliasing -ftracer -fthread-jumps @gol
339-funroll-all-loops -funroll-loops -fpeel-loops @gol
113d659a 340-fsplit-ivs-in-unroller -funswitch-loops @gol
f37a4f14 341-fvariable-expansion-in-unroller @gol
c66b6c66 342-ftree-pre -ftree-ccp -ftree-dce -ftree-loop-optimize @gol
599eabdb 343-ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
fa555252 344-ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
79fe1b3b 345-ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
c12cc930 346-ftree-vect-loop-version -ftree-salias -fweb @gol
ce91e74c 347-ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
3af64fd6 348--param @var{name}=@var{value}
4bc1997b 349-O -O0 -O1 -O2 -O3 -Os}
74291a4b
MM
350
351@item Preprocessor Options
352@xref{Preprocessor Options,,Options Controlling the Preprocessor}.
c2d635bc 353@gccoptlist{-A@var{question}=@var{answer} @gol
9a94f7f3 354-A-@var{question}@r{[}=@var{answer}@r{]} @gol
4bc1997b
JM
355-C -dD -dI -dM -dN @gol
356-D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
357-idirafter @var{dir} @gol
358-include @var{file} -imacros @var{file} @gol
359-iprefix @var{file} -iwithprefix @var{dir} @gol
bdd42dd9 360-iwithprefixbefore @var{dir} -isystem @var{dir} @gol
160633c6 361-isysroot @var{dir} @gol
b20d9f0c
AO
362-M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
363-P -fworking-directory -remap @gol
9a94f7f3
JM
364-trigraphs -undef -U@var{macro} -Wp,@var{option} @gol
365-Xpreprocessor @var{option}}
74291a4b
MM
366
367@item Assembler Option
368@xref{Assembler Options,,Passing Options to the Assembler}.
9a94f7f3 369@gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
74291a4b
MM
370
371@item Linker Options
372@xref{Link Options,,Options for Linking}.
9a94f7f3 373@gccoptlist{@var{object-file-name} -l@var{library} @gol
0cbc4d77 374-nostartfiles -nodefaultlibs -nostdlib -pie -rdynamic @gol
4bc1997b 375-s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
aee96fe9 376-Wl,@var{option} -Xlinker @var{option} @gol
4bc1997b 377-u @var{symbol}}
74291a4b
MM
378
379@item Directory Options
380@xref{Directory Options,,Options for Directory Search}.
160633c6
MM
381@gccoptlist{-B@var{prefix} -I@var{dir} -iquote@var{dir} -L@var{dir}
382-specs=@var{file} -I- --sysroot=@var{dir}}
74291a4b
MM
383
384@item Target Options
385@c I wrote this xref this way to avoid overfull hbox. -- rms
386@xref{Target Options}.
9a94f7f3 387@gccoptlist{-V @var{version} -b @var{machine}}
74291a4b
MM
388
389@item Machine Dependent Options
390@xref{Submodel Options,,Hardware Models and Configurations}.
39bc1876
NS
391@c This list is ordered alphanumerically by subsection name.
392@c Try and put the significant identifier (CPU or system) first,
393@c so users have a clue at guessing where the ones they want will be.
5d22c1a5 394
39bc1876
NS
395@emph{ARC Options}
396@gccoptlist{-EB -EL @gol
397-mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
398-mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
74291a4b 399
74291a4b 400@emph{ARM Options}
9a94f7f3 401@gccoptlist{-mapcs-frame -mno-apcs-frame @gol
5848830f 402-mabi=@var{name} @gol
310668e8
JM
403-mapcs-stack-check -mno-apcs-stack-check @gol
404-mapcs-float -mno-apcs-float @gol
405-mapcs-reentrant -mno-apcs-reentrant @gol
406-msched-prolog -mno-sched-prolog @gol
407-mlittle-endian -mbig-endian -mwords-little-endian @gol
34a86306 408-mfloat-abi=@var{name} -msoft-float -mhard-float -mfpe @gol
310668e8 409-mthumb-interwork -mno-thumb-interwork @gol
9b66ebb1 410-mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
247f8561 411-mstructure-size-boundary=@var{n} @gol
4bc1997b 412-mabort-on-noreturn @gol
310668e8
JM
413-mlong-calls -mno-long-calls @gol
414-msingle-pic-base -mno-single-pic-base @gol
247f8561
PB
415-mpic-register=@var{reg} @gol
416-mnop-fun-dllimport @gol
9b6b54e2 417-mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
247f8561 418-mpoke-function-name @gol
310668e8
JM
419-mthumb -marm @gol
420-mtpcs-frame -mtpcs-leaf-frame @gol
d3585b76
DJ
421-mcaller-super-interworking -mcallee-super-interworking @gol
422-mtp=@var{name}}
74291a4b 423
39bc1876
NS
424@emph{AVR Options}
425@gccoptlist{-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
426-mcall-prologues -mno-tablejump -mtiny-stack -mint8}
861bb6c1 427
0d4a78eb 428@emph{Blackfin Options}
3fb192d2
BS
429@gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
430-mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
431-mlow-64k -mno-low64k -mid-shared-library @gol
b6877196
BS
432-mno-id-shared-library -mshared-library-id=@var{n} @gol
433-mlong-calls -mno-long-calls}
0d4a78eb 434
39bc1876
NS
435@emph{CRIS Options}
436@gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
437-mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
438-metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
439-mstack-align -mdata-align -mconst-align @gol
440-m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
441-melf -maout -melinux -mlinux -sim -sim2 @gol
442-mmul-bug-workaround -mno-mul-bug-workaround}
74291a4b 443
53054e77
PW
444@emph{CRX Options}
445@gccoptlist{-mmac -mpush-args}
446
48aec0bc 447@emph{Darwin Options}
6d2f9dd3
JM
448@gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
449-arch_only -bind_at_load -bundle -bundle_loader @gol
450-client_name -compatibility_version -current_version @gol
5079843a 451-dead_strip @gol
6d2f9dd3
JM
452-dependency-file -dylib_file -dylinker_install_name @gol
453-dynamic -dynamiclib -exported_symbols_list @gol
454-filelist -flat_namespace -force_cpusubtype_ALL @gol
455-force_flat_namespace -headerpad_max_install_names @gol
456-image_base -init -install_name -keep_private_externs @gol
457-multi_module -multiply_defined -multiply_defined_unused @gol
5079843a
DP
458-noall_load -no_dead_strip_inits_and_terms @gol
459-nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
6d2f9dd3
JM
460-pagezero_size -prebind -prebind_all_twolevel_modules @gol
461-private_bundle -read_only_relocs -sectalign @gol
462-sectobjectsymbols -whyload -seg1addr @gol
463-sectcreate -sectobjectsymbols -sectorder @gol
5826770c 464-segaddr -segs_read_only_addr -segs_read_write_addr @gol
6d2f9dd3
JM
465-seg_addr_table -seg_addr_table_filename -seglinkedit @gol
466-segprot -segs_read_only_addr -segs_read_write_addr @gol
467-single_module -static -sub_library -sub_umbrella @gol
468-twolevel_namespace -umbrella -undefined @gol
469-unexported_symbols_list -weak_reference_mismatches @gol
337f2a22 470-whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
ed5b9f96 471-mone-byte-bool}
48aec0bc 472
74291a4b 473@emph{DEC Alpha Options}
9a94f7f3 474@gccoptlist{-mno-fp-regs -msoft-float -malpha-as -mgas @gol
4bc1997b
JM
475-mieee -mieee-with-inexact -mieee-conformant @gol
476-mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
477-mtrap-precision=@var{mode} -mbuild-constants @gol
58605ba0
RH
478-mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
479-mbwx -mmax -mfix -mcix @gol
480-mfloat-vax -mfloat-ieee @gol
9a94f7f3
JM
481-mexplicit-relocs -msmall-data -mlarge-data @gol
482-msmall-text -mlarge-text @gol
4bc1997b 483-mmemory-latency=@var{time}}
74291a4b 484
d7c23cdc 485@emph{DEC Alpha/VMS Options}
9a94f7f3 486@gccoptlist{-mvms-return-codes}
d7c23cdc 487
39bc1876
NS
488@emph{FRV Options}
489@gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
490-mhard-float -msoft-float @gol
491-malloc-cc -mfixed-cc -mdword -mno-dword @gol
492-mdouble -mno-double @gol
493-mmedia -mno-media -mmuladd -mno-muladd @gol
c557edf4
RS
494-mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
495-mlinked-fp -mlong-calls -malign-labels @gol
496-mlibrary-pic -macc-4 -macc-8 @gol
39bc1876 497-mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
38c28a25 498-moptimize-membar -mno-optimize-membar @gol
39bc1876
NS
499-mscc -mno-scc -mcond-exec -mno-cond-exec @gol
500-mvliw-branch -mno-vliw-branch @gol
501-mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
502-mno-nested-cond-exec -mtomcat-stats @gol
e4dd71de 503-mTLS -mtls @gol
39bc1876
NS
504-mcpu=@var{cpu}}
505
74291a4b 506@emph{H8/300 Options}
9a94f7f3 507@gccoptlist{-mrelax -mh -ms -mn -mint32 -malign-300}
74291a4b 508
39bc1876
NS
509@emph{HPPA Options}
510@gccoptlist{-march=@var{architecture-type} @gol
511-mbig-switch -mdisable-fpregs -mdisable-indexing @gol
512-mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
a2017852 513-mfixed-range=@var{register-range} @gol
39bc1876
NS
514-mjump-in-delay -mlinker-opt -mlong-calls @gol
515-mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
516-mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
517-mno-jump-in-delay -mno-long-load-store @gol
518-mno-portable-runtime -mno-soft-float @gol
519-mno-space-regs -msoft-float -mpa-risc-1-0 @gol
520-mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
521-mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
d711cf67 522-munix=@var{unix-std} -nolibdld -static -threads}
74291a4b 523
39bc1876
NS
524@emph{i386 and x86-64 Options}
525@gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
526-mfpmath=@var{unit} @gol
527-masm=@var{dialect} -mno-fancy-math-387 @gol
528-mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
529-mno-wide-multiply -mrtd -malign-double @gol
530-mpreferred-stack-boundary=@var{num} @gol
531-mmmx -msse -msse2 -msse3 -m3dnow @gol
532-mthreads -mno-align-stringops -minline-all-stringops @gol
533-mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
1f97667f
RG
534-m96bit-long-double -mregparm=@var{num} -msseregparm @gol
535-momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs @gol
39bc1876 536-mcmodel=@var{code-model} @gol
7dcbf659 537-m32 -m64 -mlarge-data-threshold=@var{num}}
56b2d7a7 538
39bc1876
NS
539@emph{IA-64 Options}
540@gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
4c334b37 541-mvolatile-asm-stop -mregister-names -mno-sdata @gol
39bc1876
NS
542-mconstant-gp -mauto-pic -minline-float-divide-min-latency @gol
543-minline-float-divide-max-throughput @gol
544-minline-int-divide-min-latency @gol
28b43def
SE
545-minline-int-divide-max-throughput @gol
546-minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
547-mno-dwarf2-asm -mearly-stop-bits @gol
548-mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
549-mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
282a61e6 550
39bc1876
NS
551@emph{M32R/D Options}
552@gccoptlist{-m32r2 -m32rx -m32r @gol
553-mdebug @gol
554-malign-loops -mno-align-loops @gol
555-missue-rate=@var{number} @gol
556-mbranch-cost=@var{number} @gol
557-mmodel=@var{code-size-model-type} @gol
558-msdata=@var{sdata-type} @gol
559-mno-flush-func -mflush-func=@var{name} @gol
560-mno-flush-trap -mflush-trap=@var{number} @gol
561-G @var{num}}
83575957 562
38b2d076
DD
563@emph{M32C Options}
564@gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
565
39bc1876
NS
566@emph{M680x0 Options}
567@gccoptlist{-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
568-m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 @gol
569-mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
570-malign-int -mstrict-align -msep-data -mno-sep-data @gol
571-mshared-library-id=n -mid-shared-library -mno-id-shared-library}
789a3090 572
39bc1876
NS
573@emph{M68hc1x Options}
574@gccoptlist{-m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 @gol
575-mauto-incdec -minmax -mlong-calls -mshort @gol
576-msoft-reg-count=@var{count}}
052a4b28 577
789a3090 578@emph{MCore Options}
9a94f7f3 579@gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
310668e8
JM
580-mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
581-m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
582-mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
583-mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
f84271d9 584
39bc1876
NS
585@emph{MIPS Options}
586@gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
587-mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips64 @gol
588-mips16 -mno-mips16 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
589-mxgot -mno-xgot -mgp32 -mgp64 -mfp32 -mfp64 @gol
590-mhard-float -msoft-float -msingle-float -mdouble-float @gol
118ea793 591-mdsp -mpaired-single -mips3d @gol
fb8136b2 592-mlong64 -mlong32 -msym32 -mno-sym32 @gol
39bc1876
NS
593-G@var{num} -membedded-data -mno-embedded-data @gol
594-muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
595-msplit-addresses -mno-split-addresses @gol
596-mexplicit-relocs -mno-explicit-relocs @gol
39bc1876 597-mcheck-zero-division -mno-check-zero-division @gol
9f0df97a 598-mdivide-traps -mdivide-breaks @gol
39bc1876
NS
599-mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
600-mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp @gol
601-mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
0ac40e7a
RS
602-mfix-vr4120 -mno-fix-vr4120 -mfix-vr4130 @gol
603-mfix-sb1 -mno-fix-sb1 @gol
39bc1876
NS
604-mflush-func=@var{func} -mno-flush-func @gol
605-mbranch-likely -mno-branch-likely @gol
606-mfp-exceptions -mno-fp-exceptions @gol
607-mvr4130-align -mno-vr4130-align}
bcf684c7 608
39bc1876
NS
609@emph{MMIX Options}
610@gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
611-mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
612-melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
613-mno-base-addresses -msingle-exit -mno-single-exit}
df6194d4 614
39bc1876
NS
615@emph{MN10300 Options}
616@gccoptlist{-mmult-bug -mno-mult-bug @gol
617-mam33 -mno-am33 @gol
618-mam33-2 -mno-am33-2 @gol
b1eb8119 619-mreturn-pointer-on-d0 @gol
39bc1876 620-mno-crt0 -mrelax}
91abf72d 621
6c9ac67a
NS
622@emph{MT Options}
623@gccoptlist{-mno-crt0 -mbacc -msim @gol
c85ba4fb
AH
624-march=@var{cpu-type} }
625
9f85bca7 626@emph{PDP-11 Options}
9a94f7f3 627@gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
9f85bca7
JM
628-mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
629-mint16 -mno-int32 -mfloat32 -mno-float64 @gol
630-mfloat64 -mno-float32 -mabshi -mno-abshi @gol
631-mbranch-expensive -mbranch-cheap @gol
632-msplit -mno-split -munix-asm -mdec-asm}
633
39bc1876
NS
634@emph{PowerPC Options}
635See RS/6000 and PowerPC Options.
636
637@emph{RS/6000 and PowerPC Options}
638@gccoptlist{-mcpu=@var{cpu-type} @gol
639-mtune=@var{cpu-type} @gol
640-mpower -mno-power -mpower2 -mno-power2 @gol
641-mpowerpc -mpowerpc64 -mno-powerpc @gol
642-maltivec -mno-altivec @gol
643-mpowerpc-gpopt -mno-powerpc-gpopt @gol
644-mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
9719f3b7 645-mmfcrf -mno-mfcrf -mpopcntb -mno-popcntb -mfprnd -mno-fprnd @gol
39bc1876
NS
646-mnew-mnemonics -mold-mnemonics @gol
647-mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
de17c25f 648-m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
39bc1876
NS
649-malign-power -malign-natural @gol
650-msoft-float -mhard-float -mmultiple -mno-multiple @gol
651-mstring -mno-string -mupdate -mno-update @gol
652-mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
653-mstrict-align -mno-strict-align -mrelocatable @gol
654-mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
655-mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
ef765ea9 656-mdynamic-no-pic -maltivec -mswdiv @gol
39bc1876
NS
657-mprioritize-restricted-insns=@var{priority} @gol
658-msched-costly-dep=@var{dependence_type} @gol
659-minsert-sched-nops=@var{scheme} @gol
660-mcall-sysv -mcall-netbsd @gol
661-maix-struct-return -msvr4-struct-return @gol
7f970b70 662-mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
78f5898b 663-misel -mno-isel @gol
39bc1876 664-misel=yes -misel=no @gol
78f5898b 665-mspe -mno-spe @gol
39bc1876 666-mspe=yes -mspe=no @gol
78f5898b 667-mvrsave -mno-vrsave @gol
131aeb82 668-mmulhw -mno-mulhw @gol
4d4cbc0e 669-mfloat-gprs=yes -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
39bc1876
NS
670-mprototype -mno-prototype @gol
671-msim -mmvme -mads -myellowknife -memb -msdata @gol
672-msdata=@var{opt} -mvxworks -mwindiss -G @var{num} -pthread}
673
674@emph{S/390 and zSeries Options}
675@gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
b3d31392
AK
676-mhard-float -msoft-float -mbackchain -mno-backchain @gol
677-mpacked-stack -mno-packed-stack @gol
39bc1876
NS
678-msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
679-m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
d75f90f1
AK
680-mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
681-mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard}
39bc1876
NS
682
683@emph{SH Options}
684@gccoptlist{-m1 -m2 -m2e -m3 -m3e @gol
685-m4-nofpu -m4-single-only -m4-single -m4 @gol
312209c6 686-m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
39bc1876
NS
687-m5-64media -m5-64media-nofpu @gol
688-m5-32media -m5-32media-nofpu @gol
689-m5-compact -m5-compact-nofpu @gol
690-mb -ml -mdalign -mrelax @gol
2acc29bd 691-mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
39bc1876 692-mieee -misize -mpadstruct -mspace @gol
73a4d10b
R
693-mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
694-mdivsi3_libfunc=@var{name} @gol
695-madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
696 -minvalid-symbols}
39bc1876
NS
697
698@emph{SPARC Options}
699@gccoptlist{-mcpu=@var{cpu-type} @gol
700-mtune=@var{cpu-type} @gol
701-mcmodel=@var{code-model} @gol
702-m32 -m64 -mapp-regs -mno-app-regs @gol
703-mfaster-structs -mno-faster-structs @gol
704-mfpu -mno-fpu -mhard-float -msoft-float @gol
705-mhard-quad-float -msoft-quad-float @gol
706-mimpure-text -mno-impure-text -mlittle-endian @gol
707-mstack-bias -mno-stack-bias @gol
708-munaligned-doubles -mno-unaligned-doubles @gol
6bfb2f93
EB
709-mv8plus -mno-v8plus -mvis -mno-vis
710-threads -pthreads}
39bc1876
NS
711
712@emph{System V Options}
713@gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
714
715@emph{TMS320C3x/C4x Options}
716@gccoptlist{-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
717-mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
718-mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
719-mparallel-insns -mparallel-mpy -mpreserve-float}
720
721@emph{V850 Options}
722@gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
723-mprolog-function -mno-prolog-function -mspace @gol
724-mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
725-mapp-regs -mno-app-regs @gol
726-mdisable-callt -mno-disable-callt @gol
727-mv850e1 @gol
728-mv850e @gol
729-mv850 -mbig-switch}
730
731@emph{VAX Options}
732@gccoptlist{-mg -mgnu -munix}
733
734@emph{x86-64 Options}
735See i386 and x86-64 Options.
736
69a0611f 737@emph{Xstormy16 Options}
9a94f7f3 738@gccoptlist{-msim}
69a0611f 739
03984308 740@emph{Xtensa Options}
6cedbe44 741@gccoptlist{-mconst16 -mno-const16 @gol
9a94f7f3 742-mfused-madd -mno-fused-madd @gol
9a94f7f3
JM
743-mtext-section-literals -mno-text-section-literals @gol
744-mtarget-align -mno-target-align @gol
745-mlongcalls -mno-longcalls}
03984308 746
39bc1876
NS
747@emph{zSeries Options}
748See S/390 and zSeries Options.
70899148 749
74291a4b
MM
750@item Code Generation Options
751@xref{Code Gen Options,,Options for Code Generation Conventions}.
9a94f7f3
JM
752@gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
753-ffixed-@var{reg} -fexceptions @gol
5d22c1a5 754-fnon-call-exceptions -funwind-tables @gol
a944ceb9 755-fasynchronous-unwind-tables @gol
4bc1997b 756-finhibit-size-directive -finstrument-functions @gol
dc170a87 757-fno-common -fno-ident @gol
24a4dd31 758-fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
82c0180d 759-fno-jump-tables @gol
4bc1997b 760-freg-struct-return -fshared-data -fshort-enums @gol
271bd540 761-fshort-double -fshort-wchar @gol
467cecf3 762-fverbose-asm -fpack-struct[=@var{n}] -fstack-check @gol
4bc1997b
JM
763-fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
764-fargument-alias -fargument-noalias @gol
478c9e72 765-fargument-noalias-global -fleading-underscore @gol
d4463dfc 766-ftls-model=@var{model} @gol
d7afec4b 767-ftrapv -fwrapv -fbounds-check @gol
953ff289 768-fvisibility -fopenmp}
74291a4b
MM
769@end table
770
771@menu
772* Overall Options:: Controlling the kind of output:
773 an executable, object files, assembler files,
774 or preprocessed source.
775* C Dialect Options:: Controlling the variant of C language compiled.
776* C++ Dialect Options:: Variations on C++.
46e34f96
ZL
777* Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
778 and Objective-C++.
764dbbf2 779* Language Independent Options:: Controlling how diagnostics should be
02f52e19 780 formatted.
74291a4b
MM
781* Warning Options:: How picky should the compiler be?
782* Debugging Options:: Symbol tables, measurements, and debugging dumps.
783* Optimize Options:: How much optimization?
784* Preprocessor Options:: Controlling header files and macro definitions.
785 Also, getting dependency information for Make.
786* Assembler Options:: Passing options to the assembler.
787* Link Options:: Specifying libraries and so on.
788* Directory Options:: Where to find header files and libraries.
789 Where to find the compiler executable files.
a743d340 790* Spec Files:: How to pass switches to sub-processes.
0c2d1a2a 791* Target Options:: Running a cross-compiler, or an old version of GCC.
74291a4b
MM
792@end menu
793
794@node Overall Options
795@section Options Controlling the Kind of Output
796
797Compilation can involve up to four stages: preprocessing, compilation
d1bd0ded
GK
798proper, assembly and linking, always in that order. GCC is capable of
799preprocessing and compiling several files either into several
800assembler input files, or into one assembler input file; then each
801assembler input file produces an object file, and linking combines all
802the object files (those newly compiled, and those specified as input)
803into an executable file.
74291a4b
MM
804
805@cindex file name suffix
806For any given input file, the file name suffix determines what kind of
807compilation is done:
808
2642624b 809@table @gcctabopt
74291a4b
MM
810@item @var{file}.c
811C source code which must be preprocessed.
812
813@item @var{file}.i
814C source code which should not be preprocessed.
815
816@item @var{file}.ii
817C++ source code which should not be preprocessed.
818
819@item @var{file}.m
46e34f96
ZL
820Objective-C source code. Note that you must link with the @file{libobjc}
821library to make an Objective-C program work.
74291a4b 822
b9265ec1
JM
823@item @var{file}.mi
824Objective-C source code which should not be preprocessed.
825
46e34f96
ZL
826@item @var{file}.mm
827@itemx @var{file}.M
828Objective-C++ source code. Note that you must link with the @file{libobjc}
829library to make an Objective-C++ program work. Note that @samp{.M} refers
830to a literal capital M@.
831
832@item @var{file}.mii
833Objective-C++ source code which should not be preprocessed.
834
74291a4b 835@item @var{file}.h
46e34f96
ZL
836C, C++, Objective-C or Objective-C++ header file to be turned into a
837precompiled header.
74291a4b
MM
838
839@item @var{file}.cc
b9265ec1 840@itemx @var{file}.cp
74291a4b
MM
841@itemx @var{file}.cxx
842@itemx @var{file}.cpp
ee8acf89 843@itemx @var{file}.CPP
b9265ec1 844@itemx @var{file}.c++
74291a4b
MM
845@itemx @var{file}.C
846C++ source code which must be preprocessed. Note that in @samp{.cxx},
847the last two letters must both be literally @samp{x}. Likewise,
161d7b59 848@samp{.C} refers to a literal capital C@.
74291a4b 849
6e955430
ZL
850@item @var{file}.mm
851@itemx @var{file}.M
852Objective-C++ source code which must be preprocessed.
853
854@item @var{file}.mii
855Objective-C++ source code which should not be preprocessed.
856
17211ab5
GK
857@item @var{file}.hh
858@itemx @var{file}.H
859C++ header file to be turned into a precompiled header.
860
b9265ec1
JM
861@item @var{file}.f
862@itemx @var{file}.for
863@itemx @var{file}.FOR
80a0c50a 864Fixed form Fortran source code which should not be preprocessed.
b9265ec1
JM
865
866@item @var{file}.F
867@itemx @var{file}.fpp
868@itemx @var{file}.FPP
80a0c50a 869Fixed form Fortran source code which must be preprocessed (with the traditional
b9265ec1
JM
870preprocessor).
871
6de9cd9a
DN
872@item @var{file}.f90
873@itemx @var{file}.f95
80a0c50a 874Free form Fortran source code which should not be preprocessed.
6de9cd9a 875
5a006700
MR
876@item @var{file}.F90
877@itemx @var{file}.F95
80a0c50a 878Free form Fortran source code which must be preprocessed (with the
5a006700
MR
879traditional preprocessor).
880
b9265ec1
JM
881@c FIXME: Descriptions of Java file types.
882@c @var{file}.java
883@c @var{file}.class
884@c @var{file}.zip
885@c @var{file}.jar
886
e23381df
GB
887@item @var{file}.ads
888Ada source code file which contains a library unit declaration (a
889declaration of a package, subprogram, or generic, or a generic
890instantiation), or a library unit renaming declaration (a package,
891generic, or subprogram renaming declaration). Such files are also
892called @dfn{specs}.
893
894@itemx @var{file}.adb
895Ada source code file containing a library unit body (a subprogram or
896package body). Such files are also called @dfn{bodies}.
897
b9265ec1 898@c GCC also knows about some suffixes for languages not yet included:
b9265ec1
JM
899@c Pascal:
900@c @var{file}.p
901@c @var{file}.pas
80a0c50a
TS
902@c Ratfor:
903@c @var{file}.r
b9265ec1 904
74291a4b
MM
905@item @var{file}.s
906Assembler code.
907
908@item @var{file}.S
909Assembler code which must be preprocessed.
910
911@item @var{other}
912An object file to be fed straight into linking.
913Any file name with no recognized suffix is treated this way.
914@end table
915
cd3bb277 916@opindex x
630d3d5a 917You can specify the input language explicitly with the @option{-x} option:
74291a4b 918
2642624b 919@table @gcctabopt
74291a4b
MM
920@item -x @var{language}
921Specify explicitly the @var{language} for the following input files
922(rather than letting the compiler choose a default based on the file
923name suffix). This option applies to all following input files until
630d3d5a 924the next @option{-x} option. Possible values for @var{language} are:
3ab51846 925@smallexample
46e34f96 926c c-header c-cpp-output
17211ab5 927c++ c++-header c++-cpp-output
46e34f96
ZL
928objective-c objective-c-header objective-c-cpp-output
929objective-c++ objective-c++-header objective-c++-cpp-output
74291a4b 930assembler assembler-with-cpp
e23381df 931ada
80a0c50a 932f77 f77-cpp-input
acd1a829 933f95 f95-cpp-input
e23381df 934java
b38b97c4 935treelang
3ab51846 936@end smallexample
74291a4b
MM
937
938@item -x none
939Turn off any specification of a language, so that subsequent files are
630d3d5a 940handled according to their file name suffixes (as they are if @option{-x}
74291a4b 941has not been used at all).
14a774a9
RK
942
943@item -pass-exit-codes
cd3bb277 944@opindex pass-exit-codes
bedc7537 945Normally the @command{gcc} program will exit with the code of 1 if any
14a774a9 946phase of the compiler returns a non-success return code. If you specify
630d3d5a 947@option{-pass-exit-codes}, the @command{gcc} program will instead return with
14a774a9
RK
948numerically highest error produced by any phase that returned an error
949indication.
74291a4b
MM
950@end table
951
952If you only want some of the stages of compilation, you can use
630d3d5a
JM
953@option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
954one of the options @option{-c}, @option{-S}, or @option{-E} to say where
bedc7537
NC
955@command{gcc} is to stop. Note that some combinations (for example,
956@samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
74291a4b 957
2642624b 958@table @gcctabopt
74291a4b 959@item -c
cd3bb277 960@opindex c
74291a4b
MM
961Compile or assemble the source files, but do not link. The linking
962stage simply is not done. The ultimate output is in the form of an
963object file for each source file.
964
965By default, the object file name for a source file is made by replacing
966the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
967
968Unrecognized input files, not requiring compilation or assembly, are
969ignored.
970
971@item -S
cd3bb277 972@opindex S
74291a4b
MM
973Stop after the stage of compilation proper; do not assemble. The output
974is in the form of an assembler code file for each non-assembler input
975file specified.
976
977By default, the assembler file name for a source file is made by
978replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
979
980Input files that don't require compilation are ignored.
981
982@item -E
cd3bb277 983@opindex E
74291a4b
MM
984Stop after the preprocessing stage; do not run the compiler proper. The
985output is in the form of preprocessed source code, which is sent to the
986standard output.
987
988Input files which don't require preprocessing are ignored.
989
990@cindex output file option
991@item -o @var{file}
cd3bb277 992@opindex o
74291a4b
MM
993Place output in file @var{file}. This applies regardless to whatever
994sort of output is being produced, whether it be an executable file,
995an object file, an assembler file or preprocessed C code.
996
488061c8
GK
997If @option{-o} is not specified, the default is to put an executable
998file in @file{a.out}, the object file for
999@file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1000assembler file in @file{@var{source}.s}, a precompiled header file in
1001@file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1002standard output.
74291a4b
MM
1003
1004@item -v
cd3bb277 1005@opindex v
74291a4b
MM
1006Print (on standard error output) the commands executed to run the stages
1007of compilation. Also print the version number of the compiler driver
1008program and of the preprocessor and the compiler proper.
1009
e8b3c8ac
IR
1010@item -###
1011@opindex ###
1012Like @option{-v} except the commands are not executed and all command
1013arguments are quoted. This is useful for shell scripts to capture the
1014driver-generated command lines.
1015
74291a4b 1016@item -pipe
cd3bb277 1017@opindex pipe
74291a4b
MM
1018Use pipes rather than temporary files for communication between the
1019various stages of compilation. This fails to work on some systems where
1020the assembler is unable to read from a pipe; but the GNU assembler has
1021no trouble.
844642e6 1022
0855eab7
CT
1023@item -combine
1024@opindex combine
1025If you are compiling multiple source files, this option tells the driver
f26c1794 1026to pass all the source files to the compiler at once (for those
0855eab7
CT
1027languages for which the compiler can handle this). This will allow
1028intermodule analysis (IMA) to be performed by the compiler. Currently the only
78466c0e 1029language for which this is supported is C@. If you pass source files for
0855eab7
CT
1030multiple languages to the driver, using this option, the driver will invoke
1031the compiler(s) that support IMA once each, passing each compiler all the
1032source files appropriate for it. For those languages that do not support
1033IMA this option will be ignored, and the compiler will be invoked once for
1034each source file in that language. If you use this option in conjunction
78466c0e
JM
1035with @option{-save-temps}, the compiler will generate multiple
1036pre-processed files
1037(one for each source file), but only one (combined) @file{.o} or
1038@file{.s} file.
0855eab7 1039
844642e6 1040@item --help
cd3bb277 1041@opindex help
844642e6 1042Print (on the standard output) a description of the command line options
bedc7537
NC
1043understood by @command{gcc}. If the @option{-v} option is also specified
1044then @option{--help} will also be passed on to the various processes
1045invoked by @command{gcc}, so that they can display the command line options
65ca2d60 1046they accept. If the @option{-Wextra} option is also specified then command
844642e6
NC
1047line options which have no documentation associated with them will also
1048be displayed.
10501d8f
CC
1049
1050@item --target-help
cd3bb277 1051@opindex target-help
10501d8f
CC
1052Print (on the standard output) a description of target specific command
1053line options for each tool.
e03b7153
RS
1054
1055@item --version
1056@opindex version
8a36672b 1057Display the version number and copyrights of the invoked GCC@.
9d530538
MM
1058
1059@include @value{srcdir}/../libiberty/at-file.texi
74291a4b
MM
1060@end table
1061
1062@node Invoking G++
1063@section Compiling C++ Programs
1064
1065@cindex suffixes for C++ source
1066@cindex C++ source file suffixes
1067C++ source files conventionally use one of the suffixes @samp{.C},
17211ab5
GK
1068@samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1069@samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
0c2d1a2a 1070preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
bba975d4 1071files with these names and compiles them as C++ programs even if you
17211ab5
GK
1072call the compiler the same way as for compiling C programs (usually
1073with the name @command{gcc}).
74291a4b
MM
1074
1075@findex g++
1076@findex c++
1077However, C++ programs often require class libraries as well as a
1078compiler that understands the C++ language---and under some
17211ab5
GK
1079circumstances, you might want to compile programs or header files from
1080standard input, or otherwise without a suffix that flags them as C++
1081programs. You might also like to precompile a C header file with a
1082@samp{.h} extension to be used in C++ compilations. @command{g++} is a
1083program that calls GCC with the default language set to C++, and
1084automatically specifies linking against the C++ library. On many
1085systems, @command{g++} is also installed with the name @command{c++}.
74291a4b 1086
bedc7537 1087@cindex invoking @command{g++}
74291a4b
MM
1088When you compile C++ programs, you may specify many of the same
1089command-line options that you use for compiling programs in any
1090language; or command-line options meaningful for C and related
1091languages; or options that are meaningful only for C++ programs.
1092@xref{C Dialect Options,,Options Controlling C Dialect}, for
161d7b59 1093explanations of options for languages related to C@.
74291a4b
MM
1094@xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1095explanations of options that are meaningful only for C++ programs.
1096
1097@node C Dialect Options
1098@section Options Controlling C Dialect
1099@cindex dialect options
1100@cindex language dialect options
1101@cindex options, dialect
1102
1103The following options control the dialect of C (or languages derived
46e34f96
ZL
1104from C, such as C++, Objective-C and Objective-C++) that the compiler
1105accepts:
74291a4b 1106
2642624b 1107@table @gcctabopt
74291a4b 1108@cindex ANSI support
c1030c7c 1109@cindex ISO support
74291a4b 1110@item -ansi
cd3bb277 1111@opindex ansi
3764f879 1112In C mode, support all ISO C90 programs. In C++ mode,
775afb25 1113remove GNU extensions that conflict with ISO C++.
74291a4b 1114
c1030c7c 1115This turns off certain features of GCC that are incompatible with ISO
3764f879 1116C90 (when compiling C code), or of standard C++ (when compiling C++ code),
0c2d1a2a 1117such as the @code{asm} and @code{typeof} keywords, and
74291a4b
MM
1118predefined macros such as @code{unix} and @code{vax} that identify the
1119type of system you are using. It also enables the undesirable and
02f52e19 1120rarely used ISO trigraph feature. For the C compiler,
0c2d1a2a 1121it disables recognition of C++ style @samp{//} comments as well as
775afb25 1122the @code{inline} keyword.
74291a4b
MM
1123
1124The alternate keywords @code{__asm__}, @code{__extension__},
1125@code{__inline__} and @code{__typeof__} continue to work despite
630d3d5a 1126@option{-ansi}. You would not want to use them in an ISO C program, of
74291a4b 1127course, but it is useful to put them in header files that might be included
630d3d5a 1128in compilations done with @option{-ansi}. Alternate predefined macros
74291a4b 1129such as @code{__unix__} and @code{__vax__} are also available, with or
630d3d5a 1130without @option{-ansi}.
74291a4b 1131
630d3d5a
JM
1132The @option{-ansi} option does not cause non-ISO programs to be
1133rejected gratuitously. For that, @option{-pedantic} is required in
1134addition to @option{-ansi}. @xref{Warning Options}.
74291a4b 1135
630d3d5a 1136The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
74291a4b
MM
1137option is used. Some header files may notice this macro and refrain
1138from declaring certain functions or defining certain macros that the
c1030c7c 1139ISO standard doesn't call for; this is to avoid interfering with any
74291a4b
MM
1140programs that might use these names for other things.
1141
c771326b
JM
1142Functions which would normally be built in but do not have semantics
1143defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
630d3d5a 1144functions with @option{-ansi} is used. @xref{Other Builtins,,Other
f0523f02 1145built-in functions provided by GCC}, for details of the functions
01702459 1146affected.
74291a4b 1147
49419c8f 1148@item -std=
cd3bb277 1149@opindex std
aee96fe9 1150Determine the language standard. This option is currently only
f749a36b
NB
1151supported when compiling C or C++. A value for this option must be
1152provided; possible values are
3932261a 1153
ee457005 1154@table @samp
aee96fe9
JM
1155@item c89
1156@itemx iso9899:1990
3764f879 1157ISO C90 (same as @option{-ansi}).
3043b30e
ML
1158
1159@item iso9899:199409
3764f879 1160ISO C90 as modified in amendment 1.
3043b30e 1161
49419c8f 1162@item c99
aee96fe9
JM
1163@itemx c9x
1164@itemx iso9899:1999
1165@itemx iso9899:199x
1166ISO C99. Note that this standard is not yet fully supported; see
1167@w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1168names @samp{c9x} and @samp{iso9899:199x} are deprecated.
3043b30e
ML
1169
1170@item gnu89
3764f879 1171Default, ISO C90 plus GNU extensions (including some C99 features).
3043b30e 1172
49419c8f 1173@item gnu99
31775d31 1174@itemx gnu9x
d15a05b3
EC
1175ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1176this will become the default. The name @samp{gnu9x} is deprecated.
49419c8f 1177
f749a36b
NB
1178@item c++98
1179The 1998 ISO C++ standard plus amendments.
1180
1181@item gnu++98
1182The same as @option{-std=c++98} plus GNU extensions. This is the
1183default for C++ code.
ee457005 1184@end table
3043b30e
ML
1185
1186Even when this option is not specified, you can still use some of the
1187features of newer standards in so far as they do not conflict with
1188previous C standards. For example, you may use @code{__restrict__} even
bedc7537 1189when @option{-std=c99} is not specified.
3932261a 1190
5490d604 1191The @option{-std} options specifying some version of ISO C have the same
3764f879 1192effects as @option{-ansi}, except that features that were not in ISO C90
5490d604
JM
1193but are in the specified version (for example, @samp{//} comments and
1194the @code{inline} keyword in ISO C99) are not disabled.
1195
c1030c7c
JM
1196@xref{Standards,,Language Standards Supported by GCC}, for details of
1197these standard versions.
1198
b1018de6
AO
1199@item -aux-info @var{filename}
1200@opindex aux-info
1201Output to the given filename prototyped declarations for all functions
1202declared and/or defined in a translation unit, including those in header
161d7b59 1203files. This option is silently ignored in any language other than C@.
b1018de6
AO
1204
1205Besides declarations, the file indicates, in comments, the origin of
1206each declaration (source file and line), whether the declaration was
1207implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1208@samp{O} for old, respectively, in the first character after the line
1209number and the colon), and whether it came from a declaration or a
1210definition (@samp{C} or @samp{F}, respectively, in the following
1211character). In the case of function definitions, a K&R-style list of
1212arguments followed by their declarations is also provided, inside
1213comments, after the declaration.
1214
74291a4b 1215@item -fno-asm
cd3bb277 1216@opindex fno-asm
74291a4b
MM
1217Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1218keyword, so that code can use these words as identifiers. You can use
1219the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
630d3d5a 1220instead. @option{-ansi} implies @option{-fno-asm}.
74291a4b
MM
1221
1222In C++, this switch only affects the @code{typeof} keyword, since
1223@code{asm} and @code{inline} are standard keywords. You may want to
630d3d5a 1224use the @option{-fno-gnu-keywords} flag instead, which has the same
5490d604
JM
1225effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1226switch only affects the @code{asm} and @code{typeof} keywords, since
1227@code{inline} is a standard keyword in ISO C99.
74291a4b
MM
1228
1229@item -fno-builtin
a3926fe1 1230@itemx -fno-builtin-@var{function}
cd3bb277 1231@opindex fno-builtin
c771326b
JM
1232@cindex built-in functions
1233Don't recognize built-in functions that do not begin with
01702459 1234@samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
f0523f02 1235functions provided by GCC}, for details of the functions affected,
c771326b 1236including those which are not built-in functions when @option{-ansi} or
5490d604
JM
1237@option{-std} options for strict ISO C conformance are used because they
1238do not have an ISO standard meaning.
74291a4b 1239
c771326b 1240GCC normally generates special code to handle certain built-in functions
74291a4b
MM
1241more efficiently; for instance, calls to @code{alloca} may become single
1242instructions that adjust the stack directly, and calls to @code{memcpy}
1243may become inline copy loops. The resulting code is often both smaller
1244and faster, but since the function calls no longer appear as such, you
1245cannot set a breakpoint on those calls, nor can you change the behavior
e6e931b7
JM
1246of the functions by linking with a different library. In addition,
1247when a function is recognized as a built-in function, GCC may use
1248information about that function to warn about problems with calls to
1249that function, or to generate more efficient code, even if the
1250resulting code still contains calls to that function. For example,
1251warnings are given with @option{-Wformat} for bad calls to
1252@code{printf}, when @code{printf} is built in, and @code{strlen} is
1253known not to modify global memory.
74291a4b 1254
a3926fe1
RS
1255With the @option{-fno-builtin-@var{function}} option
1256only the built-in function @var{function} is
7d14c755
JM
1257disabled. @var{function} must not begin with @samp{__builtin_}. If a
1258function is named this is not built-in in this version of GCC, this
1259option is ignored. There is no corresponding
1260@option{-fbuiltin-@var{function}} option; if you wish to enable
1261built-in functions selectively when using @option{-fno-builtin} or
1262@option{-ffreestanding}, you may define macros such as:
1263
1264@smallexample
1265#define abs(n) __builtin_abs ((n))
1266#define strcpy(d, s) __builtin_strcpy ((d), (s))
1267@end smallexample
1268
861bb6c1 1269@item -fhosted
cd3bb277 1270@opindex fhosted
861bb6c1
JL
1271@cindex hosted environment
1272
1273Assert that compilation takes place in a hosted environment. This implies
630d3d5a 1274@option{-fbuiltin}. A hosted environment is one in which the
861bb6c1
JL
1275entire standard library is available, and in which @code{main} has a return
1276type of @code{int}. Examples are nearly everything except a kernel.
630d3d5a 1277This is equivalent to @option{-fno-freestanding}.
861bb6c1
JL
1278
1279@item -ffreestanding
cd3bb277 1280@opindex ffreestanding
861bb6c1
JL
1281@cindex hosted environment
1282
1283Assert that compilation takes place in a freestanding environment. This
630d3d5a 1284implies @option{-fno-builtin}. A freestanding environment
861bb6c1
JL
1285is one in which the standard library may not exist, and program startup may
1286not necessarily be at @code{main}. The most obvious example is an OS kernel.
630d3d5a 1287This is equivalent to @option{-fno-hosted}.
861bb6c1 1288
c1030c7c
JM
1289@xref{Standards,,Language Standards Supported by GCC}, for details of
1290freestanding and hosted environments.
1291
750491fc
RH
1292@item -fms-extensions
1293@opindex fms-extensions
1294Accept some non-standard constructs used in Microsoft header files.
1295
2fbebc71
JM
1296Some cases of unnamed fields in structures and unions are only
1297accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
1298fields within structs/unions}, for details.
1299
74291a4b 1300@item -trigraphs
cd3bb277 1301@opindex trigraphs
3bce8a01
NB
1302Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1303options for strict ISO C conformance) implies @option{-trigraphs}.
74291a4b 1304
8a035a6b
AH
1305@item -no-integrated-cpp
1306@opindex no-integrated-cpp
1307Performs a compilation in two passes: preprocessing and compiling. This
1308option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
8a36672b 1309@option{-B} option. The user supplied compilation step can then add in
8a035a6b 1310an additional preprocessing step after normal preprocessing but before
8a36672b 1311compiling. The default is to use the integrated cpp (internal cpp)
8a035a6b
AH
1312
1313The semantics of this option will change if "cc1", "cc1plus", and
1314"cc1obj" are merged.
1315
74291a4b
MM
1316@cindex traditional C language
1317@cindex C language, traditional
1318@item -traditional
f458d1d5 1319@itemx -traditional-cpp
cd3bb277 1320@opindex traditional-cpp
f458d1d5
ZW
1321@opindex traditional
1322Formerly, these options caused GCC to attempt to emulate a pre-standard
1323C compiler. They are now only supported with the @option{-E} switch.
1324The preprocessor continues to support a pre-standard mode. See the GNU
1325CPP manual for details.
74291a4b
MM
1326
1327@item -fcond-mismatch
cd3bb277 1328@opindex fcond-mismatch
74291a4b 1329Allow conditional expressions with mismatched types in the second and
a7537031
JM
1330third arguments. The value of such an expression is void. This option
1331is not supported for C++.
74291a4b
MM
1332
1333@item -funsigned-char
cd3bb277 1334@opindex funsigned-char
74291a4b
MM
1335Let the type @code{char} be unsigned, like @code{unsigned char}.
1336
1337Each kind of machine has a default for what @code{char} should
1338be. It is either like @code{unsigned char} by default or like
1339@code{signed char} by default.
1340
1341Ideally, a portable program should always use @code{signed char} or
1342@code{unsigned char} when it depends on the signedness of an object.
1343But many programs have been written to use plain @code{char} and
1344expect it to be signed, or expect it to be unsigned, depending on the
1345machines they were written for. This option, and its inverse, let you
1346make such a program work with the opposite default.
1347
1348The type @code{char} is always a distinct type from each of
1349@code{signed char} or @code{unsigned char}, even though its behavior
1350is always just like one of those two.
1351
1352@item -fsigned-char
cd3bb277 1353@opindex fsigned-char
74291a4b
MM
1354Let the type @code{char} be signed, like @code{signed char}.
1355
630d3d5a
JM
1356Note that this is equivalent to @option{-fno-unsigned-char}, which is
1357the negative form of @option{-funsigned-char}. Likewise, the option
1358@option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
74291a4b 1359
74291a4b
MM
1360@item -fsigned-bitfields
1361@itemx -funsigned-bitfields
1362@itemx -fno-signed-bitfields
1363@itemx -fno-unsigned-bitfields
cd3bb277
JM
1364@opindex fsigned-bitfields
1365@opindex funsigned-bitfields
1366@opindex fno-signed-bitfields
1367@opindex fno-unsigned-bitfields
c771326b 1368These options control whether a bit-field is signed or unsigned, when the
74291a4b 1369declaration does not use either @code{signed} or @code{unsigned}. By
c771326b 1370default, such a bit-field is signed, because this is consistent: the
74291a4b 1371basic integer types such as @code{int} are signed types.
74291a4b
MM
1372@end table
1373
1374@node C++ Dialect Options
1375@section Options Controlling C++ Dialect
1376
1377@cindex compiler options, C++
1378@cindex C++ options, command line
1379@cindex options, C++
1380This section describes the command-line options that are only meaningful
1381for C++ programs; but you can also use most of the GNU compiler options
1382regardless of what language your program is in. For example, you
1383might compile a file @code{firstClass.C} like this:
1384
3ab51846 1385@smallexample
1dc5fc4b 1386g++ -g -frepo -O -c firstClass.C
3ab51846 1387@end smallexample
74291a4b
MM
1388
1389@noindent
630d3d5a 1390In this example, only @option{-frepo} is an option meant
74291a4b 1391only for C++ programs; you can use the other options with any
161d7b59 1392language supported by GCC@.
74291a4b
MM
1393
1394Here is a list of options that are @emph{only} for compiling C++ programs:
1395
2642624b 1396@table @gcctabopt
2d3e278d
MM
1397
1398@item -fabi-version=@var{n}
1399@opindex fabi-version
8a36672b 1400Use version @var{n} of the C++ ABI@. Version 2 is the version of the
57702a80
MM
1401C++ ABI that first appeared in G++ 3.4. Version 1 is the version of
1402the C++ ABI that first appeared in G++ 3.2. Version 0 will always be
1403the version that conforms most closely to the C++ ABI specification.
1404Therefore, the ABI obtained using version 0 will change as ABI bugs
1405are fixed.
2d3e278d 1406
d150ccef 1407The default is version 2.
46c83bce 1408
74291a4b 1409@item -fno-access-control
cd3bb277 1410@opindex fno-access-control
74291a4b
MM
1411Turn off all access checking. This switch is mainly useful for working
1412around bugs in the access control code.
1413
74291a4b 1414@item -fcheck-new
cd3bb277 1415@opindex fcheck-new
74291a4b 1416Check that the pointer returned by @code{operator new} is non-null
6d9c4c83
JW
1417before attempting to modify the storage allocated. This check is
1418normally unnecessary because the C++ standard specifies that
1419@code{operator new} will only return @code{0} if it is declared
1420@samp{throw()}, in which case the compiler will always check the
1421return value even without this option. In all other cases, when
1422@code{operator new} has a non-empty exception specification, memory
1423exhaustion is signalled by throwing @code{std::bad_alloc}. See also
1424@samp{new (nothrow)}.
1dc5fc4b 1425
74291a4b 1426@item -fconserve-space
cd3bb277 1427@opindex fconserve-space
74291a4b
MM
1428Put uninitialized or runtime-initialized global variables into the
1429common segment, as C does. This saves space in the executable at the
1430cost of not diagnosing duplicate definitions. If you compile with this
1431flag and your program mysteriously crashes after @code{main()} has
1432completed, you may have an object that is being destroyed twice because
1433two definitions were merged.
1434
1dc5fc4b
JM
1435This option is no longer useful on most targets, now that support has
1436been added for putting variables into BSS without making them common.
1437
d63d5d0c
ILT
1438@item -ffriend-injection
1439@opindex ffriend-injection
1440Inject friend functions into the enclosing namespace, so that they are
1441visible outside the scope of the class in which they are declared.
1442Friend functions were documented to work this way in the old Annotated
1443C++ Reference Manual, and versions of G++ before 4.1 always worked
1444that way. However, in ISO C++ a friend function which is not declared
1445in an enclosing scope can only be found using argument dependent
1446lookup. This option causes friends to be injected as they were in
1447earlier releases.
1448
1449This option is for compatibility, and may be removed in a future
1450release of G++.
1451
02f52e19 1452@item -fno-const-strings
cd3bb277 1453@opindex fno-const-strings
fcca588c
MM
1454Give string constants type @code{char *} instead of type @code{const
1455char *}. By default, G++ uses type @code{const char *} as required by
630d3d5a 1456the standard. Even if you use @option{-fno-const-strings}, you cannot
3521b33c 1457actually modify the value of a string constant.
fcca588c
MM
1458
1459This option might be removed in a future release of G++. For maximum
1460portability, you should structure your code so that it works with
1461string constants that have type @code{const char *}.
1462
1dc5fc4b 1463@item -fno-elide-constructors
cd3bb277 1464@opindex fno-elide-constructors
1dc5fc4b
JM
1465The C++ standard allows an implementation to omit creating a temporary
1466which is only used to initialize another object of the same type.
aee96fe9 1467Specifying this option disables that optimization, and forces G++ to
1dc5fc4b 1468call the copy constructor in all cases.
74291a4b 1469
dd1ba632 1470@item -fno-enforce-eh-specs
cd3bb277 1471@opindex fno-enforce-eh-specs
4381020e
JM
1472Don't generate code to check for violation of exception specifications
1473at runtime. This option violates the C++ standard, but may be useful
1474for reducing code size in production builds, much like defining
1475@samp{NDEBUG}. This does not give user code permission to throw
1476exceptions in violation of the exception specifications; the compiler
1477will still optimize based on the specifications, so throwing an
1478unexpected exception will result in undefined behavior.
dd1ba632 1479
74291a4b 1480@item -ffor-scope
8c81598d 1481@itemx -fno-for-scope
cd3bb277
JM
1482@opindex ffor-scope
1483@opindex fno-for-scope
695ac33f 1484If @option{-ffor-scope} is specified, the scope of variables declared in
74291a4b 1485a @i{for-init-statement} is limited to the @samp{for} loop itself,
34527c47 1486as specified by the C++ standard.
695ac33f 1487If @option{-fno-for-scope} is specified, the scope of variables declared in
74291a4b 1488a @i{for-init-statement} extends to the end of the enclosing scope,
aee96fe9 1489as was the case in old versions of G++, and other (traditional)
74291a4b
MM
1490implementations of C++.
1491
1492The default if neither flag is given to follow the standard,
1493but to allow and give a warning for old-style code that would
1494otherwise be invalid, or have different behavior.
1495
1496@item -fno-gnu-keywords
cd3bb277 1497@opindex fno-gnu-keywords
9762e8a4 1498Do not recognize @code{typeof} as a keyword, so that code can use this
767094dd 1499word as an identifier. You can use the keyword @code{__typeof__} instead.
630d3d5a 1500@option{-ansi} implies @option{-fno-gnu-keywords}.
74291a4b 1501
1dc5fc4b 1502@item -fno-implicit-templates
cd3bb277 1503@opindex fno-implicit-templates
bba975d4 1504Never emit code for non-inline templates which are instantiated
e979f9e8 1505implicitly (i.e.@: by use); only emit code for explicit instantiations.
bba975d4
JM
1506@xref{Template Instantiation}, for more information.
1507
1508@item -fno-implicit-inline-templates
cd3bb277 1509@opindex fno-implicit-inline-templates
bba975d4
JM
1510Don't emit code for implicit instantiations of inline templates, either.
1511The default is to handle inlines differently so that compiles with and
1512without optimization will need the same set of explicit instantiations.
1dc5fc4b 1513
74291a4b 1514@item -fno-implement-inlines
cd3bb277 1515@opindex fno-implement-inlines
74291a4b
MM
1516To save space, do not emit out-of-line copies of inline functions
1517controlled by @samp{#pragma implementation}. This will cause linker
1518errors if these functions are not inlined everywhere they are called.
1519
631cf95d 1520@item -fms-extensions
cd3bb277 1521@opindex fms-extensions
32fb1fb2
PE
1522Disable pedantic warnings about constructs used in MFC, such as implicit
1523int and getting a pointer to member function via non-standard syntax.
631cf95d 1524
fcca588c 1525@item -fno-nonansi-builtins
cd3bb277 1526@opindex fno-nonansi-builtins
c771326b 1527Disable built-in declarations of functions that are not mandated by
161d7b59 1528ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
fcca588c
MM
1529@code{index}, @code{bzero}, @code{conjf}, and other related functions.
1530
775afb25 1531@item -fno-operator-names
cd3bb277 1532@opindex fno-operator-names
775afb25 1533Do not treat the operator name keywords @code{and}, @code{bitand},
74291a4b 1534@code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
775afb25 1535synonyms as keywords.
74291a4b 1536
4f8b4fd9 1537@item -fno-optional-diags
cd3bb277 1538@opindex fno-optional-diags
4f8b4fd9 1539Disable diagnostics that the standard says a compiler does not need to
aee96fe9 1540issue. Currently, the only such diagnostic issued by G++ is the one for
bba975d4 1541a name having multiple meanings within a class.
4f8b4fd9 1542
8c7707b0 1543@item -fpermissive
cd3bb277 1544@opindex fpermissive
4a386498
MM
1545Downgrade some diagnostics about nonconformant code from errors to
1546warnings. Thus, using @option{-fpermissive} will allow some
1547nonconforming code to compile.
8c7707b0 1548
8c81598d 1549@item -frepo
cd3bb277 1550@opindex frepo
9c34dbbf
ZW
1551Enable automatic template instantiation at link time. This option also
1552implies @option{-fno-implicit-templates}. @xref{Template
1553Instantiation}, for more information.
8c81598d 1554
8c7707b0 1555@item -fno-rtti
cd3bb277 1556@opindex fno-rtti
a7fbfcf9
JM
1557Disable generation of information about every class with virtual
1558functions for use by the C++ runtime type identification features
1559(@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1560of the language, you can save some space by using this flag. Note that
1561exception handling uses the same information, but it will generate it as
1562needed.
8c7707b0 1563
fcca588c 1564@item -fstats
cd3bb277 1565@opindex fstats
fcca588c
MM
1566Emit statistics about front-end processing at the end of the compilation.
1567This information is generally only useful to the G++ development team.
1568
1dc5fc4b 1569@item -ftemplate-depth-@var{n}
cd3bb277 1570@opindex ftemplate-depth
1dc5fc4b
JM
1571Set the maximum instantiation depth for template classes to @var{n}.
1572A limit on the template instantiation depth is needed to detect
767094dd 1573endless recursions during template class instantiation. ANSI/ISO C++
1dc5fc4b
JM
1574conforming programs must not rely on a maximum depth greater than 17.
1575
40aac948
JM
1576@item -fno-threadsafe-statics
1577@opindex fno-threadsafe-statics
1578Do not emit the extra code to use the routines specified in the C++
1579ABI for thread-safe initialization of local statics. You can use this
1580option to reduce code size slightly in code that doesn't need to be
1581thread-safe.
1582
fc693822 1583@item -fuse-cxa-atexit
cd3bb277 1584@opindex fuse-cxa-atexit
fc693822
MM
1585Register destructors for objects with static storage duration with the
1586@code{__cxa_atexit} function rather than the @code{atexit} function.
1587This option is required for fully standards-compliant handling of static
1588destructors, but will only work if your C library supports
1589@code{__cxa_atexit}.
1590
d7afec4b
ND
1591@item -fvisibility-inlines-hidden
1592@opindex fvisibility-inlines-hidden
1593Causes all inlined methods to be marked with
1594@code{__attribute__ ((visibility ("hidden")))} so that they do not
1595appear in the export table of a DSO and do not require a PLT indirection
8a36672b 1596when used within the DSO@. Enabling this option can have a dramatic effect
d7afec4b 1597on load and link times of a DSO as it massively reduces the size of the
8a36672b 1598dynamic export table when the library makes heavy use of templates. While
d7afec4b
ND
1599it can cause bloating through duplication of code within each DSO where
1600it is used, often the wastage is less than the considerable space occupied
1601by a long symbol name in the export table which is typical when using
8a36672b 1602templates and namespaces. For even more savings, combine with the
4ec7afd7 1603@option{-fvisibility=hidden} switch.
d7afec4b 1604
02f52e19 1605@item -fno-weak
cd3bb277 1606@opindex fno-weak
90ecce3e 1607Do not use weak symbol support, even if it is provided by the linker.
fcca588c
MM
1608By default, G++ will use weak symbols if they are available. This
1609option exists only for testing, and should not be used by end-users;
1610it will result in inferior code and has no benefits. This option may
1611be removed in a future release of G++.
1612
74291a4b 1613@item -nostdinc++
cd3bb277 1614@opindex nostdinc++
74291a4b
MM
1615Do not search for header files in the standard directories specific to
1616C++, but do still search the other standard directories. (This option
e5e809f4 1617is used when building the C++ library.)
74291a4b
MM
1618@end table
1619
1620In addition, these optimization, warning, and code generation options
1621have meanings only for C++ programs:
1622
2642624b 1623@table @gcctabopt
74291a4b 1624@item -fno-default-inline
cd3bb277 1625@opindex fno-default-inline
74291a4b 1626Do not assume @samp{inline} for functions defined inside a class scope.
1dc5fc4b
JM
1627@xref{Optimize Options,,Options That Control Optimization}. Note that these
1628functions will have linkage like inline functions; they just won't be
1629inlined by default.
74291a4b 1630
eca7f13c
MM
1631@item -Wabi @r{(C++ only)}
1632@opindex Wabi
1633Warn when G++ generates code that is probably not compatible with the
8a36672b 1634vendor-neutral C++ ABI@. Although an effort has been made to warn about
daf2f129 1635all such cases, there are probably some cases that are not warned about,
eca7f13c
MM
1636even though G++ is generating incompatible code. There may also be
1637cases where warnings are emitted even though the code that is generated
1638will be compatible.
1639
1640You should rewrite your code to avoid these warnings if you are
1641concerned about the fact that code generated by G++ may not be binary
1642compatible with code generated by other compilers.
1643
3364c33b 1644The known incompatibilities at this point include:
eca7f13c
MM
1645
1646@itemize @bullet
1647
1648@item
1649Incorrect handling of tail-padding for bit-fields. G++ may attempt to
1650pack data into the same byte as a base class. For example:
1651
1652@smallexample
1653struct A @{ virtual void f(); int f1 : 1; @};
1654struct B : public A @{ int f2 : 1; @};
1655@end smallexample
1656
1657@noindent
1658In this case, G++ will place @code{B::f2} into the same byte
daf2f129 1659as@code{A::f1}; other compilers will not. You can avoid this problem
eca7f13c
MM
1660by explicitly padding @code{A} so that its size is a multiple of the
1661byte size on your platform; that will cause G++ and other compilers to
1662layout @code{B} identically.
1663
1664@item
1665Incorrect handling of tail-padding for virtual bases. G++ does not use
1666tail padding when laying out virtual bases. For example:
1667
1668@smallexample
1669struct A @{ virtual void f(); char c1; @};
1670struct B @{ B(); char c2; @};
1671struct C : public A, public virtual B @{@};
1672@end smallexample
1673
1674@noindent
1675In this case, G++ will not place @code{B} into the tail-padding for
1676@code{A}; other compilers will. You can avoid this problem by
1677explicitly padding @code{A} so that its size is a multiple of its
1678alignment (ignoring virtual base classes); that will cause G++ and other
1679compilers to layout @code{C} identically.
1680
2d3e278d
MM
1681@item
1682Incorrect handling of bit-fields with declared widths greater than that
1683of their underlying types, when the bit-fields appear in a union. For
1684example:
1685
1686@smallexample
1687union U @{ int i : 4096; @};
1688@end smallexample
1689
1690@noindent
1691Assuming that an @code{int} does not have 4096 bits, G++ will make the
1692union too small by the number of bits in an @code{int}.
1693
956d9305
MM
1694@item
1695Empty classes can be placed at incorrect offsets. For example:
daf2f129 1696
956d9305
MM
1697@smallexample
1698struct A @{@};
1699
1700struct B @{
1701 A a;
1702 virtual void f ();
1703@};
1704
1705struct C : public B, public A @{@};
1706@end smallexample
1707
1708@noindent
c0478a66 1709G++ will place the @code{A} base class of @code{C} at a nonzero offset;
956d9305
MM
1710it should be placed at offset zero. G++ mistakenly believes that the
1711@code{A} data member of @code{B} is already at offset zero.
1712
6397d80b
MM
1713@item
1714Names of template functions whose types involve @code{typename} or
1715template template parameters can be mangled incorrectly.
1716
1717@smallexample
1718template <typename Q>
1719void f(typename Q::X) @{@}
1720
1721template <template <typename> class Q>
1722void f(typename Q<int>::X) @{@}
1723@end smallexample
1724
1725@noindent
3364c33b 1726Instantiations of these templates may be mangled incorrectly.
6397d80b 1727
eca7f13c
MM
1728@end itemize
1729
aee96fe9 1730@item -Wctor-dtor-privacy @r{(C++ only)}
cd3bb277 1731@opindex Wctor-dtor-privacy
9eff22bc
LG
1732Warn when a class seems unusable because all the constructors or
1733destructors in that class are private, and it has neither friends nor
78d0a54d 1734public static member functions.
bba975d4 1735
aee96fe9 1736@item -Wnon-virtual-dtor @r{(C++ only)}
cd3bb277 1737@opindex Wnon-virtual-dtor
9eff22bc
LG
1738Warn when a class appears to be polymorphic, thereby requiring a virtual
1739destructor, yet it declares a non-virtual one.
bd8f9aec 1740This warning is enabled by @option{-Wall}.
bba975d4 1741
aee96fe9 1742@item -Wreorder @r{(C++ only)}
cd3bb277 1743@opindex Wreorder
bba975d4
JM
1744@cindex reordering, warning
1745@cindex warning for reordering of member initializers
1746Warn when the order of member initializers given in the code does not
1747match the order in which they must be executed. For instance:
1748
1749@smallexample
1750struct A @{
1751 int i;
1752 int j;
1753 A(): j (0), i (1) @{ @}
1754@};
1755@end smallexample
1756
9eff22bc
LG
1757The compiler will rearrange the member initializers for @samp{i}
1758and @samp{j} to match the declaration order of the members, emitting
1759a warning to that effect. This warning is enabled by @option{-Wall}.
bba975d4
JM
1760@end table
1761
630d3d5a 1762The following @option{-W@dots{}} options are not affected by @option{-Wall}.
bba975d4 1763
2642624b 1764@table @gcctabopt
aee96fe9 1765@item -Weffc++ @r{(C++ only)}
cd3bb277 1766@opindex Weffc++
77f6c1eb
RS
1767Warn about violations of the following style guidelines from Scott Meyers'
1768@cite{Effective C++} book:
1769
1770@itemize @bullet
1771@item
1772Item 11: Define a copy constructor and an assignment operator for classes
1773with dynamically allocated memory.
1774
1775@item
1776Item 12: Prefer initialization to assignment in constructors.
1777
1778@item
1779Item 14: Make destructors virtual in base classes.
1780
1781@item
1782Item 15: Have @code{operator=} return a reference to @code{*this}.
1783
1784@item
1785Item 23: Don't try to return a reference when you must return an object.
1786
1787@end itemize
1788
daf2f129 1789Also warn about violations of the following style guidelines from
9eff22bc 1790Scott Meyers' @cite{More Effective C++} book:
77f6c1eb
RS
1791
1792@itemize @bullet
1793@item
1794Item 6: Distinguish between prefix and postfix forms of increment and
1795decrement operators.
1796
1797@item
1798Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1799
1800@end itemize
1801
9eff22bc
LG
1802When selecting this option, be aware that the standard library
1803headers do not obey all of these guidelines; use @samp{grep -v}
77f6c1eb 1804to filter out those warnings.
bba975d4 1805
aee96fe9 1806@item -Wno-deprecated @r{(C++ only)}
cd3bb277 1807@opindex Wno-deprecated
767094dd 1808Do not warn about usage of deprecated features. @xref{Deprecated Features}.
2de45c06 1809
b2f97e4a
MM
1810@item -Wstrict-null-sentinel @r{(C++ only)}
1811@opindex Wstrict-null-sentinel
1812Warn also about the use of an uncasted @code{NULL} as sentinel. When
1813compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1814to @code{__null}. Although it is a null pointer constant not a null pointer,
1815it is guaranteed to of the same size as a pointer. But this use is
1816not portable across different compilers.
1817
aee96fe9 1818@item -Wno-non-template-friend @r{(C++ only)}
cd3bb277 1819@opindex Wno-non-template-friend
bba975d4 1820Disable warnings when non-templatized friend functions are declared
9eff22bc 1821within a template. Since the advent of explicit template specification
aee96fe9 1822support in G++, if the name of the friend is an unqualified-id (i.e.,
bba975d4 1823@samp{friend foo(int)}), the C++ language specification demands that the
767094dd 1824friend declare or define an ordinary, nontemplate function. (Section
aee96fe9 182514.5.3). Before G++ implemented explicit specification, unqualified-ids
bba975d4 1826could be interpreted as a particular specialization of a templatized
767094dd 1827function. Because this non-conforming behavior is no longer the default
aee96fe9 1828behavior for G++, @option{-Wnon-template-friend} allows the compiler to
9eff22bc 1829check existing code for potential trouble spots and is on by default.
2228d450 1830This new compiler behavior can be turned off with
630d3d5a 1831@option{-Wno-non-template-friend} which keeps the conformant compiler code
2228d450 1832but disables the helpful warning.
bba975d4 1833
aee96fe9 1834@item -Wold-style-cast @r{(C++ only)}
cd3bb277 1835@opindex Wold-style-cast
323728aa 1836Warn if an old-style (C-style) cast to a non-void type is used within
7cd5c075
GP
1837a C++ program. The new-style casts (@samp{dynamic_cast},
1838@samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1839less vulnerable to unintended effects and much easier to search for.
bba975d4 1840
aee96fe9 1841@item -Woverloaded-virtual @r{(C++ only)}
cd3bb277 1842@opindex Woverloaded-virtual
bba975d4
JM
1843@cindex overloaded virtual fn, warning
1844@cindex warning for overloaded virtual fn
3747f3dc
MM
1845Warn when a function declaration hides virtual functions from a
1846base class. For example, in:
1847
1848@smallexample
1849struct A @{
1850 virtual void f();
1851@};
1852
1853struct B: public A @{
1854 void f(int);
1855@};
1856@end smallexample
1857
1858the @code{A} class version of @code{f} is hidden in @code{B}, and code
9eff22bc 1859like:
3747f3dc
MM
1860
1861@smallexample
1862B* b;
1863b->f();
1864@end smallexample
1865
1866will fail to compile.
bba975d4 1867
aee96fe9 1868@item -Wno-pmf-conversions @r{(C++ only)}
cd3bb277 1869@opindex Wno-pmf-conversions
bba975d4
JM
1870Disable the diagnostic for converting a bound pointer to member function
1871to a plain pointer.
1872
aee96fe9 1873@item -Wsign-promo @r{(C++ only)}
cd3bb277 1874@opindex Wsign-promo
bba975d4 1875Warn when overload resolution chooses a promotion from unsigned or
2eac577f 1876enumerated type to a signed type, over a conversion to an unsigned type of
aee96fe9 1877the same size. Previous versions of G++ would try to preserve
bba975d4
JM
1878unsignedness, but the standard mandates the current behavior.
1879
bba975d4
JM
1880@smallexample
1881struct A @{
1882 operator int ();
1883 A& operator = (int);
1884@};
1885
1886main ()
1887@{
1888 A a,b;
1889 a = b;
1890@}
1891@end smallexample
74291a4b 1892
aee96fe9 1893In this example, G++ will synthesize a default @samp{A& operator =
bba975d4 1894(const A&);}, while cfront will use the user-defined @samp{operator =}.
74291a4b
MM
1895@end table
1896
46e34f96
ZL
1897@node Objective-C and Objective-C++ Dialect Options
1898@section Options Controlling Objective-C and Objective-C++ Dialects
60de6385 1899
46e34f96
ZL
1900@cindex compiler options, Objective-C and Objective-C++
1901@cindex Objective-C and Objective-C++ options, command line
1902@cindex options, Objective-C and Objective-C++
1903(NOTE: This manual does not describe the Objective-C and Objective-C++
1904languages themselves. See @xref{Standards,,Language Standards
1905Supported by GCC}, for references.)
264fa2db 1906
60de6385 1907This section describes the command-line options that are only meaningful
46e34f96
ZL
1908for Objective-C and Objective-C++ programs, but you can also use most of
1909the language-independent GNU compiler options.
1910For example, you might compile a file @code{some_class.m} like this:
60de6385 1911
3ab51846 1912@smallexample
60de6385 1913gcc -g -fgnu-runtime -O -c some_class.m
3ab51846 1914@end smallexample
60de6385
SS
1915
1916@noindent
9eff22bc 1917In this example, @option{-fgnu-runtime} is an option meant only for
46e34f96
ZL
1918Objective-C and Objective-C++ programs; you can use the other options with
1919any language supported by GCC@.
1920
1921Note that since Objective-C is an extension of the C language, Objective-C
f0eb93a8 1922compilations may also use options specific to the C front-end (e.g.,
46e34f96
ZL
1923@option{-Wtraditional}). Similarly, Objective-C++ compilations may use
1924C++-specific options (e.g., @option{-Wabi}).
60de6385
SS
1925
1926Here is a list of options that are @emph{only} for compiling Objective-C
46e34f96 1927and Objective-C++ programs:
60de6385
SS
1928
1929@table @gcctabopt
630d3d5a 1930@item -fconstant-string-class=@var{class-name}
cd3bb277 1931@opindex fconstant-string-class
630d3d5a 1932Use @var{class-name} as the name of the class to instantiate for each
695ac33f 1933literal string specified with the syntax @code{@@"@dots{}"}. The default
264fa2db
ZL
1934class name is @code{NXConstantString} if the GNU runtime is being used, and
1935@code{NSConstantString} if the NeXT runtime is being used (see below). The
1936@option{-fconstant-cfstrings} option, if also present, will override the
1937@option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1938to be laid out as constant CoreFoundation strings.
60de6385
SS
1939
1940@item -fgnu-runtime
cd3bb277 1941@opindex fgnu-runtime
60de6385
SS
1942Generate object code compatible with the standard GNU Objective-C
1943runtime. This is the default for most types of systems.
1944
1945@item -fnext-runtime
cd3bb277 1946@opindex fnext-runtime
60de6385 1947Generate output compatible with the NeXT runtime. This is the default
1f676100
NP
1948for NeXT-based systems, including Darwin and Mac OS X@. The macro
1949@code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1950used.
60de6385 1951
264fa2db 1952@item -fno-nil-receivers
5ad7ae7f 1953@opindex fno-nil-receivers
daf2f129
JM
1954Assume that all Objective-C message dispatches (e.g.,
1955@code{[receiver message:arg]}) in this translation unit ensure that the receiver
46e34f96
ZL
1956is not @code{nil}. This allows for more efficient entry points in the runtime
1957to be used. Currently, this option is only available in conjunction with
264fa2db
ZL
1958the NeXT runtime on Mac OS X 10.3 and later.
1959
6e955430
ZL
1960@item -fobjc-call-cxx-cdtors
1961@opindex fobjc-call-cxx-cdtors
1962For each Objective-C class, check if any of its instance variables is a
1963C++ object with a non-trivial default constructor. If so, synthesize a
1964special @code{- (id) .cxx_construct} instance method that will run
1965non-trivial default constructors on any such instance variables, in order,
1966and then return @code{self}. Similarly, check if any instance variable
1967is a C++ object with a non-trivial destructor, and if so, synthesize a
1968special @code{- (void) .cxx_destruct} method that will run
1969all such default destructors, in reverse order.
1970
1971The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1972thusly generated will only operate on instance variables declared in the
1973current Objective-C class, and not those inherited from superclasses. It
1974is the responsibility of the Objective-C runtime to invoke all such methods
1975in an object's inheritance hierarchy. The @code{- (id) .cxx_construct} methods
1976will be invoked by the runtime immediately after a new object
1977instance is allocated; the @code{- (void) .cxx_destruct} methods will
1978be invoked immediately before the runtime deallocates an object instance.
1979
1980As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1981support for invoking the @code{- (id) .cxx_construct} and
1982@code{- (void) .cxx_destruct} methods.
1983
1984@item -fobjc-direct-dispatch
1985@opindex fobjc-direct-dispatch
1986Allow fast jumps to the message dispatcher. On Darwin this is
128a79fb 1987accomplished via the comm page.
6e955430 1988
264fa2db 1989@item -fobjc-exceptions
5ad7ae7f 1990@opindex fobjc-exceptions
daf2f129 1991Enable syntactic support for structured exception handling in Objective-C,
3dd9b65f
MS
1992similar to what is offered by C++ and Java. This option is
1993unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
1994earlier.
264fa2db
ZL
1995
1996@smallexample
1997 @@try @{
1998 @dots{}
1999 @@throw expr;
2000 @dots{}
2001 @}
2002 @@catch (AnObjCClass *exc) @{
2003 @dots{}
2004 @@throw expr;
2005 @dots{}
2006 @@throw;
2007 @dots{}
2008 @}
2009 @@catch (AnotherClass *exc) @{
2010 @dots{}
2011 @}
2012 @@catch (id allOthers) @{
2013 @dots{}
2014 @}
2015 @@finally @{
2016 @dots{}
2017 @@throw expr;
2018 @dots{}
2019 @}
2020@end smallexample
2021
2022The @code{@@throw} statement may appear anywhere in an Objective-C or
daf2f129
JM
2023Objective-C++ program; when used inside of a @code{@@catch} block, the
2024@code{@@throw} may appear without an argument (as shown above), in which case
264fa2db
ZL
2025the object caught by the @code{@@catch} will be rethrown.
2026
2027Note that only (pointers to) Objective-C objects may be thrown and
2028caught using this scheme. When an object is thrown, it will be caught
2029by the nearest @code{@@catch} clause capable of handling objects of that type,
daf2f129
JM
2030analogously to how @code{catch} blocks work in C++ and Java. A
2031@code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
264fa2db
ZL
2032any and all Objective-C exceptions not caught by previous @code{@@catch}
2033clauses (if any).
2034
2035The @code{@@finally} clause, if present, will be executed upon exit from the
2036immediately preceding @code{@@try @dots{} @@catch} section. This will happen
2037regardless of whether any exceptions are thrown, caught or rethrown
2038inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2039of the @code{finally} clause in Java.
2040
2041There are several caveats to using the new exception mechanism:
2042
2043@itemize @bullet
2044@item
daf2f129 2045Although currently designed to be binary compatible with @code{NS_HANDLER}-style
264fa2db
ZL
2046idioms provided by the @code{NSException} class, the new
2047exceptions can only be used on Mac OS X 10.3 (Panther) and later
2048systems, due to additional functionality needed in the (NeXT) Objective-C
2049runtime.
2050
2051@item
2052As mentioned above, the new exceptions do not support handling
daf2f129 2053types other than Objective-C objects. Furthermore, when used from
264fa2db
ZL
2054Objective-C++, the Objective-C exception model does not interoperate with C++
2055exceptions at this time. This means you cannot @code{@@throw} an exception
daf2f129 2056from Objective-C and @code{catch} it in C++, or vice versa
264fa2db
ZL
2057(i.e., @code{throw @dots{} @@catch}).
2058@end itemize
daf2f129 2059
264fa2db
ZL
2060The @option{-fobjc-exceptions} switch also enables the use of synchronization
2061blocks for thread-safe execution:
2062
2063@smallexample
2064 @@synchronized (ObjCClass *guard) @{
2065 @dots{}
2066 @}
2067@end smallexample
2068
2069Upon entering the @code{@@synchronized} block, a thread of execution shall
2070first check whether a lock has been placed on the corresponding @code{guard}
2071object by another thread. If it has, the current thread shall wait until
daf2f129 2072the other thread relinquishes its lock. Once @code{guard} becomes available,
264fa2db
ZL
2073the current thread will place its own lock on it, execute the code contained in
2074the @code{@@synchronized} block, and finally relinquish the lock (thereby
2075making @code{guard} available to other threads).
2076
2077Unlike Java, Objective-C does not allow for entire methods to be marked
2078@code{@@synchronized}. Note that throwing exceptions out of
2079@code{@@synchronized} blocks is allowed, and will cause the guarding object
2080to be unlocked properly.
2081
6e955430
ZL
2082@item -fobjc-gc
2083@opindex fobjc-gc
2084Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2085
264fa2db 2086@item -freplace-objc-classes
5ad7ae7f 2087@opindex freplace-objc-classes
264fa2db
ZL
2088Emit a special marker instructing @command{ld(1)} not to statically link in
2089the resulting object file, and allow @command{dyld(1)} to load it in at
2090run time instead. This is used in conjunction with the Fix-and-Continue
daf2f129 2091debugging mode, where the object file in question may be recompiled and
264fa2db
ZL
2092dynamically reloaded in the course of program execution, without the need
2093to restart the program itself. Currently, Fix-and-Continue functionality
daf2f129 2094is only available in conjunction with the NeXT runtime on Mac OS X 10.3
264fa2db
ZL
2095and later.
2096
2097@item -fzero-link
5ad7ae7f 2098@opindex fzero-link
264fa2db
ZL
2099When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2100to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2101compile time) with static class references that get initialized at load time,
2102which improves run-time performance. Specifying the @option{-fzero-link} flag
2103suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
daf2f129 2104to be retained. This is useful in Zero-Link debugging mode, since it allows
264fa2db
ZL
2105for individual class implementations to be modified during program execution.
2106
60de6385 2107@item -gen-decls
cd3bb277 2108@opindex gen-decls
60de6385
SS
2109Dump interface declarations for all classes seen in the source file to a
2110file named @file{@var{sourcename}.decl}.
2111
6e955430
ZL
2112@item -Wassign-intercept
2113@opindex Wassign-intercept
2114Warn whenever an Objective-C assignment is being intercepted by the
2115garbage collector.
2116
60de6385 2117@item -Wno-protocol
cd3bb277 2118@opindex Wno-protocol
1f676100
NP
2119If a class is declared to implement a protocol, a warning is issued for
2120every method in the protocol that is not implemented by the class. The
6335b0aa 2121default behavior is to issue a warning for every method not explicitly
1f676100 2122implemented in the class, even if a method implementation is inherited
4ec7afd7 2123from the superclass. If you use the @option{-Wno-protocol} option, then
1f676100
NP
2124methods inherited from the superclass are considered to be implemented,
2125and no warning is issued for them.
60de6385
SS
2126
2127@item -Wselector
cd3bb277 2128@opindex Wselector
1f676100
NP
2129Warn if multiple methods of different types for the same selector are
2130found during compilation. The check is performed on the list of methods
2131in the final stage of compilation. Additionally, a check is performed
9eff22bc
LG
2132for each selector appearing in a @code{@@selector(@dots{})}
2133expression, and a corresponding method for that selector has been found
1f676100
NP
2134during compilation. Because these checks scan the method table only at
2135the end of compilation, these warnings are not produced if the final
2136stage of compilation is not reached, for example because an error is
4ec7afd7 2137found during compilation, or because the @option{-fsyntax-only} option is
1f676100
NP
2138being used.
2139
6e955430
ZL
2140@item -Wstrict-selector-match
2141@opindex Wstrict-selector-match
2142Warn if multiple methods with differing argument and/or return types are
2143found for a given selector when attempting to send a message using this
2144selector to a receiver of type @code{id} or @code{Class}. When this flag
2145is off (which is the default behavior), the compiler will omit such warnings
2146if any differences found are confined to types which share the same size
2147and alignment.
2148
1f676100
NP
2149@item -Wundeclared-selector
2150@opindex Wundeclared-selector
2151Warn if a @code{@@selector(@dots{})} expression referring to an
2152undeclared selector is found. A selector is considered undeclared if no
daf2f129 2153method with that name has been declared before the
9eff22bc
LG
2154@code{@@selector(@dots{})} expression, either explicitly in an
2155@code{@@interface} or @code{@@protocol} declaration, or implicitly in
2156an @code{@@implementation} section. This option always performs its
2157checks as soon as a @code{@@selector(@dots{})} expression is found,
4ec7afd7 2158while @option{-Wselector} only performs its checks in the final stage of
9eff22bc 2159compilation. This also enforces the coding style convention
1f676100 2160that methods and selectors must be declared before being used.
60de6385 2161
7989e4dc 2162@item -print-objc-runtime-info
5ad7ae7f 2163@opindex print-objc-runtime-info
7989e4dc
RO
2164Generate C header describing the largest structure that is passed by
2165value, if any.
60de6385
SS
2166
2167@end table
2168
764dbbf2
GDR
2169@node Language Independent Options
2170@section Options to Control Diagnostic Messages Formatting
2171@cindex options to control diagnostics formatting
2172@cindex diagnostic messages
2173@cindex message formatting
2174
b192711e 2175Traditionally, diagnostic messages have been formatted irrespective of
e979f9e8 2176the output device's aspect (e.g.@: its width, @dots{}). The options described
764dbbf2 2177below can be used to control the diagnostic messages formatting
e979f9e8 2178algorithm, e.g.@: how many characters per line, how often source location
6c0a4eab 2179information should be reported. Right now, only the C++ front end can
764dbbf2 2180honor these options. However it is expected, in the near future, that
6c0a4eab 2181the remaining front ends would be able to digest them correctly.
764dbbf2 2182
2642624b 2183@table @gcctabopt
764dbbf2 2184@item -fmessage-length=@var{n}
cd3bb277 2185@opindex fmessage-length
764dbbf2 2186Try to format error messages so that they fit on lines of about @var{n}
aee96fe9 2187characters. The default is 72 characters for @command{g++} and 0 for the rest of
161d7b59 2188the front ends supported by GCC@. If @var{n} is zero, then no
02f52e19 2189line-wrapping will be done; each error message will appear on a single
764dbbf2
GDR
2190line.
2191
cd3bb277 2192@opindex fdiagnostics-show-location
764dbbf2 2193@item -fdiagnostics-show-location=once
b192711e 2194Only meaningful in line-wrapping mode. Instructs the diagnostic messages
764dbbf2
GDR
2195reporter to emit @emph{once} source location information; that is, in
2196case the message is too long to fit on a single physical line and has to
2197be wrapped, the source location won't be emitted (as prefix) again,
2198over and over, in subsequent continuation lines. This is the default
c21cd8b1 2199behavior.
764dbbf2
GDR
2200
2201@item -fdiagnostics-show-location=every-line
2202Only meaningful in line-wrapping mode. Instructs the diagnostic
2203messages reporter to emit the same source location information (as
4fe9b91c 2204prefix) for physical lines that result from the process of breaking
b192711e 2205a message which is too long to fit on a single line.
764dbbf2 2206
ccf08a6e
DD
2207@item -fdiagnostics-show-options
2208@opindex fdiagnostics-show-options
2209This option instructs the diagnostic machinery to add text to each
2210diagnostic emitted, which indicates which command line option directly
2211controls that diagnostic, when such an option is known to the
2212diagnostic machinery.
2213
764dbbf2
GDR
2214@end table
2215
74291a4b
MM
2216@node Warning Options
2217@section Options to Request or Suppress Warnings
2218@cindex options to control warnings
2219@cindex warning messages
2220@cindex messages, warning
2221@cindex suppressing warnings
2222
2223Warnings are diagnostic messages that report constructions which
2224are not inherently erroneous but which are risky or suggest there
2225may have been an error.
2226
2227You can request many specific warnings with options beginning @samp{-W},
630d3d5a 2228for example @option{-Wimplicit} to request warnings on implicit
74291a4b
MM
2229declarations. Each of these specific warning options also has a
2230negative form beginning @samp{-Wno-} to turn off warnings;
630d3d5a 2231for example, @option{-Wno-implicit}. This manual lists only one of the
74291a4b
MM
2232two forms, whichever is not the default.
2233
62aaa62c
GP
2234The following options control the amount and kinds of warnings produced
2235by GCC; for further, language-specific options also refer to
46e34f96
ZL
2236@ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2237Options}.
74291a4b 2238
2642624b 2239@table @gcctabopt
74291a4b
MM
2240@cindex syntax checking
2241@item -fsyntax-only
cd3bb277 2242@opindex fsyntax-only
74291a4b
MM
2243Check the code for syntax errors, but don't do anything beyond that.
2244
2245@item -pedantic
cd3bb277 2246@opindex pedantic
074e95e3
JM
2247Issue all the warnings demanded by strict ISO C and ISO C++;
2248reject all programs that use forbidden extensions, and some other
2249programs that do not follow ISO C and ISO C++. For ISO C, follows the
630d3d5a 2250version of the ISO C standard specified by any @option{-std} option used.
74291a4b 2251
074e95e3 2252Valid ISO C and ISO C++ programs should compile properly with or without
5490d604 2253this option (though a rare few will require @option{-ansi} or a
161d7b59 2254@option{-std} option specifying the required version of ISO C)@. However,
b1d16193
JL
2255without this option, certain GNU extensions and traditional C and C++
2256features are supported as well. With this option, they are rejected.
74291a4b 2257
630d3d5a 2258@option{-pedantic} does not cause warning messages for use of the
74291a4b
MM
2259alternate keywords whose names begin and end with @samp{__}. Pedantic
2260warnings are also disabled in the expression that follows
2261@code{__extension__}. However, only system header files should use
2262these escape routes; application programs should avoid them.
2263@xref{Alternate Keywords}.
2264
630d3d5a 2265Some users try to use @option{-pedantic} to check programs for strict ISO
74291a4b 2266C conformance. They soon find that it does not do quite what they want:
c1030c7c 2267it finds some non-ISO practices, but not all---only those for which
074e95e3
JM
2268ISO C @emph{requires} a diagnostic, and some others for which
2269diagnostics have been added.
74291a4b 2270
074e95e3 2271A feature to report any failure to conform to ISO C might be useful in
74291a4b 2272some instances, but would require considerable additional work and would
630d3d5a 2273be quite different from @option{-pedantic}. We don't have plans to
892d0a6d 2274support such a feature in the near future.
74291a4b 2275
91ea548a
JM
2276Where the standard specified with @option{-std} represents a GNU
2277extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2278corresponding @dfn{base standard}, the version of ISO C on which the GNU
2279extended dialect is based. Warnings from @option{-pedantic} are given
2280where they are required by the base standard. (It would not make sense
2281for such warnings to be given only for features not in the specified GNU
2282C dialect, since by definition the GNU dialects of C include all
2283features the compiler supports with the given option, and there would be
2284nothing to warn about.)
2285
74291a4b 2286@item -pedantic-errors
cd3bb277 2287@opindex pedantic-errors
630d3d5a 2288Like @option{-pedantic}, except that errors are produced rather than
74291a4b
MM
2289warnings.
2290
2291@item -w
cd3bb277 2292@opindex w
74291a4b
MM
2293Inhibit all warning messages.
2294
2295@item -Wno-import
cd3bb277 2296@opindex Wno-import
74291a4b
MM
2297Inhibit warning messages about the use of @samp{#import}.
2298
2299@item -Wchar-subscripts
cd3bb277 2300@opindex Wchar-subscripts
74291a4b
MM
2301Warn if an array subscript has type @code{char}. This is a common cause
2302of error, as programmers often forget that this type is signed on some
2303machines.
69cdf050 2304This warning is enabled by @option{-Wall}.
74291a4b
MM
2305
2306@item -Wcomment
cd3bb277 2307@opindex Wcomment
74291a4b
MM
2308Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2309comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
69cdf050 2310This warning is enabled by @option{-Wall}.
74291a4b 2311
c65a01af
RG
2312@item -Wfatal-errors
2313@opindex Wfatal-errors
2314This option causes the compiler to abort compilation on the first error
2315occurred rather than trying to keep going and printing further error
2316messages.
2317
74291a4b 2318@item -Wformat
cd3bb277 2319@opindex Wformat
e6e931b7
JM
2320@opindex ffreestanding
2321@opindex fno-builtin
74291a4b
MM
2322Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2323the arguments supplied have types appropriate to the format string
26f6672d
JM
2324specified, and that the conversions specified in the format string make
2325sense. This includes standard functions, and others specified by format
2326attributes (@pxref{Function Attributes}), in the @code{printf},
2327@code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
a2bec818 2328not in the C standard) families (or other target-specific families).
e6e931b7
JM
2329Which functions are checked without format attributes having been
2330specified depends on the standard version selected, and such checks of
2331functions without the attribute specified are disabled by
2332@option{-ffreestanding} or @option{-fno-builtin}.
74291a4b 2333
8308e0b7 2334The formats are checked against the format features supported by GNU
3764f879 2335libc version 2.2. These include all ISO C90 and C99 features, as well
8308e0b7
JM
2336as features from the Single Unix Specification and some BSD and GNU
2337extensions. Other library implementations may not support all these
2338features; GCC does not support warning about features that go beyond a
630d3d5a
JM
2339particular library's limitations. However, if @option{-pedantic} is used
2340with @option{-Wformat}, warnings will be given about format features not
26f6672d
JM
2341in the selected standard version (but not for @code{strfmon} formats,
2342since those are not in any version of the C standard). @xref{C Dialect
2343Options,,Options Controlling C Dialect}.
8308e0b7 2344
b34c7881
JT
2345Since @option{-Wformat} also checks for null format arguments for
2346several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2347
630d3d5a 2348@option{-Wformat} is included in @option{-Wall}. For more control over some
c76f4e8e 2349aspects of format checking, the options @option{-Wformat-y2k},
e964a556
JT
2350@option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2351@option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2352@option{-Wformat=2} are available, but are not included in @option{-Wall}.
4d808927 2353
c76f4e8e
JM
2354@item -Wformat-y2k
2355@opindex Wformat-y2k
2356If @option{-Wformat} is specified, also warn about @code{strftime}
4d808927
JM
2357formats which may yield only a two-digit year.
2358
2359@item -Wno-format-extra-args
cd3bb277 2360@opindex Wno-format-extra-args
630d3d5a 2361If @option{-Wformat} is specified, do not warn about excess arguments to a
4d808927
JM
2362@code{printf} or @code{scanf} format function. The C standard specifies
2363that such arguments are ignored.
2364
7e5fb12f
JM
2365Where the unused arguments lie between used arguments that are
2366specified with @samp{$} operand number specifications, normally
2367warnings are still given, since the implementation could not know what
2368type to pass to @code{va_arg} to skip the unused arguments. However,
2369in the case of @code{scanf} formats, this option will suppress the
2370warning if the unused arguments are all pointers, since the Single
2371Unix Specification says that such unused arguments are allowed.
2372
e964a556
JT
2373@item -Wno-format-zero-length
2374@opindex Wno-format-zero-length
2375If @option{-Wformat} is specified, do not warn about zero-length formats.
2376The C standard specifies that zero-length formats are allowed.
2377
4d808927 2378@item -Wformat-nonliteral
cd3bb277 2379@opindex Wformat-nonliteral
630d3d5a 2380If @option{-Wformat} is specified, also warn if the format string is not a
4d808927
JM
2381string literal and so cannot be checked, unless the format function
2382takes its format arguments as a @code{va_list}.
2383
c907e684 2384@item -Wformat-security
cd3bb277 2385@opindex Wformat-security
630d3d5a 2386If @option{-Wformat} is specified, also warn about uses of format
c907e684
JM
2387functions that represent possible security problems. At present, this
2388warns about calls to @code{printf} and @code{scanf} functions where the
2389format string is not a string literal and there are no format arguments,
2390as in @code{printf (foo);}. This may be a security hole if the format
2391string came from untrusted input and contains @samp{%n}. (This is
630d3d5a
JM
2392currently a subset of what @option{-Wformat-nonliteral} warns about, but
2393in future warnings may be added to @option{-Wformat-security} that are not
2394included in @option{-Wformat-nonliteral}.)
c907e684 2395
4d808927 2396@item -Wformat=2
cd3bb277 2397@opindex Wformat=2
630d3d5a
JM
2398Enable @option{-Wformat} plus format checks not included in
2399@option{-Wformat}. Currently equivalent to @samp{-Wformat
c76f4e8e 2400-Wformat-nonliteral -Wformat-security -Wformat-y2k}.
4d808927 2401
b34c7881
JT
2402@item -Wnonnull
2403@opindex Wnonnull
f6d9224f 2404Warn about passing a null pointer for arguments marked as
b34c7881
JT
2405requiring a non-null value by the @code{nonnull} function attribute.
2406
2407@option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
2408can be disabled with the @option{-Wno-nonnull} option.
2409
46e34f96 2410@item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3390f9c9 2411@opindex Winit-self
f6d9224f
GP
2412Warn about uninitialized variables which are initialized with themselves.
2413Note this option can only be used with the @option{-Wuninitialized} option,
2414which in turn only works with @option{-O1} and above.
3390f9c9 2415
f6d9224f
GP
2416For example, GCC will warn about @code{i} being uninitialized in the
2417following snippet only when @option{-Winit-self} has been specified:
3390f9c9
AP
2418@smallexample
2419@group
2420int f()
2421@{
2422 int i = i;
2423 return i;
2424@}
2425@end group
2426@end smallexample
2427
e9a25f70 2428@item -Wimplicit-int
cd3bb277 2429@opindex Wimplicit-int
e9a25f70 2430Warn when a declaration does not specify a type.
69cdf050 2431This warning is enabled by @option{-Wall}.
e9a25f70 2432
f5963e61
JL
2433@item -Wimplicit-function-declaration
2434@itemx -Werror-implicit-function-declaration
cd3bb277
JM
2435@opindex Wimplicit-function-declaration
2436@opindex Werror-implicit-function-declaration
f5963e61 2437Give a warning (or error) whenever a function is used before being
b99cfc22
JM
2438declared. The form @option{-Wno-error-implicit-function-declaration}
2439is not supported.
69cdf050 2440This warning is enabled by @option{-Wall} (as a warning, not an error).
e9a25f70 2441
74291a4b 2442@item -Wimplicit
cd3bb277 2443@opindex Wimplicit
630d3d5a 2444Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
69cdf050 2445This warning is enabled by @option{-Wall}.
861bb6c1
JL
2446
2447@item -Wmain
cd3bb277 2448@opindex Wmain
861bb6c1
JL
2449Warn if the type of @samp{main} is suspicious. @samp{main} should be a
2450function with external linkage, returning int, taking either zero
2451arguments, two, or three arguments of appropriate types.
69cdf050 2452This warning is enabled by @option{-Wall}.
4a870dba 2453
1f0c3120 2454@item -Wmissing-braces
cd3bb277 2455@opindex Wmissing-braces
1f0c3120
JM
2456Warn if an aggregate or union initializer is not fully bracketed. In
2457the following example, the initializer for @samp{a} is not fully
2458bracketed, but that for @samp{b} is fully bracketed.
2459
2460@smallexample
2461int a[2][2] = @{ 0, 1, 2, 3 @};
2462int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2463@end smallexample
2464
69cdf050
JM
2465This warning is enabled by @option{-Wall}.
2466
46e34f96 2467@item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
b02398bd
BE
2468@opindex Wmissing-include-dirs
2469Warn if a user-supplied include directory does not exist.
2470
74291a4b 2471@item -Wparentheses
cd3bb277 2472@opindex Wparentheses
74291a4b
MM
2473Warn if parentheses are omitted in certain contexts, such
2474as when there is an assignment in a context where a truth value
2475is expected, or when operators are nested whose precedence people
3e3970a2
JM
2476often get confused about. Only the warning for an assignment used as
2477a truth value is supported when compiling C++; the other warnings are
2478only supported when compiling C@.
2479
2480Also warn if a comparison like @samp{x<=y<=z} appears; this is
2481equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2482interpretation from that of ordinary mathematical notation.
74291a4b 2483
e9a25f70
JL
2484Also warn about constructions where there may be confusion to which
2485@code{if} statement an @code{else} branch belongs. Here is an example of
2486such a case:
2487
2488@smallexample
aee96fe9 2489@group
e9a25f70
JL
2490@{
2491 if (a)
2492 if (b)
2493 foo ();
2494 else
2495 bar ();
2496@}
aee96fe9 2497@end group
e9a25f70
JL
2498@end smallexample
2499
2500In C, every @code{else} branch belongs to the innermost possible @code{if}
2501statement, which in this example is @code{if (b)}. This is often not
2502what the programmer expected, as illustrated in the above example by
2503indentation the programmer chose. When there is the potential for this
f0523f02 2504confusion, GCC will issue a warning when this flag is specified.
e9a25f70
JL
2505To eliminate the warning, add explicit braces around the innermost
2506@code{if} statement so there is no way the @code{else} could belong to
2507the enclosing @code{if}. The resulting code would look like this:
2508
2509@smallexample
aee96fe9 2510@group
e9a25f70
JL
2511@{
2512 if (a)
2513 @{
2514 if (b)
2515 foo ();
2516 else
2517 bar ();
2518 @}
2519@}
aee96fe9 2520@end group
e9a25f70
JL
2521@end smallexample
2522
69cdf050
JM
2523This warning is enabled by @option{-Wall}.
2524
bb58bec5 2525@item -Wsequence-point
cd3bb277 2526@opindex Wsequence-point
bb58bec5
JM
2527Warn about code that may have undefined semantics because of violations
2528of sequence point rules in the C standard.
2529
2530The C standard defines the order in which expressions in a C program are
2531evaluated in terms of @dfn{sequence points}, which represent a partial
2532ordering between the execution of parts of the program: those executed
2533before the sequence point, and those executed after it. These occur
2534after the evaluation of a full expression (one which is not part of a
2535larger expression), after the evaluation of the first operand of a
2536@code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2537function is called (but after the evaluation of its arguments and the
2538expression denoting the called function), and in certain other places.
2539Other than as expressed by the sequence point rules, the order of
2540evaluation of subexpressions of an expression is not specified. All
2541these rules describe only a partial order rather than a total order,
2542since, for example, if two functions are called within one expression
2543with no sequence point between them, the order in which the functions
2544are called is not specified. However, the standards committee have
2545ruled that function calls do not overlap.
2546
2547It is not specified when between sequence points modifications to the
2548values of objects take effect. Programs whose behavior depends on this
2549have undefined behavior; the C standard specifies that ``Between the
2550previous and next sequence point an object shall have its stored value
2551modified at most once by the evaluation of an expression. Furthermore,
2552the prior value shall be read only to determine the value to be
2553stored.''. If a program breaks these rules, the results on any
2554particular implementation are entirely unpredictable.
2555
2556Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2557= b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2558diagnosed by this option, and it may give an occasional false positive
2559result, but in general it has been found fairly effective at detecting
2560this sort of problem in programs.
2561
2562The present implementation of this option only works for C programs. A
2563future implementation may also work for C++ programs.
2564
9c34dbbf
ZW
2565The C standard is worded confusingly, therefore there is some debate
2566over the precise meaning of the sequence point rules in subtle cases.
2567Links to discussions of the problem, including proposed formal
962e6e00 2568definitions, may be found on the GCC readings page, at
c5122d75 2569@w{@uref{http://gcc.gnu.org/readings.html}}.
bb58bec5 2570
69cdf050
JM
2571This warning is enabled by @option{-Wall}.
2572
74291a4b 2573@item -Wreturn-type
cd3bb277 2574@opindex Wreturn-type
32c4c36c
ML
2575Warn whenever a function is defined with a return-type that defaults to
2576@code{int}. Also warn about any @code{return} statement with no
02f52e19 2577return-value in a function whose return-type is not @code{void}.
32c4c36c 2578
e508a019
JM
2579For C, also warn if the return type of a function has a type qualifier
2580such as @code{const}. Such a type qualifier has no effect, since the
2581value returned by a function is not an lvalue. ISO C prohibits
2582qualified @code{void} return types on function definitions, so such
2583return types always receive a warning even without this option.
2584
32c4c36c 2585For C++, a function without return type always produces a diagnostic
767094dd 2586message, even when @option{-Wno-return-type} is specified. The only
32c4c36c 2587exceptions are @samp{main} and functions defined in system headers.
74291a4b 2588
69cdf050
JM
2589This warning is enabled by @option{-Wall}.
2590
74291a4b 2591@item -Wswitch
cd3bb277 2592@opindex Wswitch
2eac577f 2593Warn whenever a @code{switch} statement has an index of enumerated type
74291a4b
MM
2594and lacks a @code{case} for one or more of the named codes of that
2595enumeration. (The presence of a @code{default} label prevents this
2596warning.) @code{case} labels outside the enumeration range also
2597provoke warnings when this option is used.
69cdf050 2598This warning is enabled by @option{-Wall}.
74291a4b 2599
d6961341
AC
2600@item -Wswitch-default
2601@opindex Wswitch-switch
2602Warn whenever a @code{switch} statement does not have a @code{default}
2603case.
2604
173028e5
AC
2605@item -Wswitch-enum
2606@opindex Wswitch-enum
2eac577f 2607Warn whenever a @code{switch} statement has an index of enumerated type
173028e5
AC
2608and lacks a @code{case} for one or more of the named codes of that
2609enumeration. @code{case} labels outside the enumeration range also
2610provoke warnings when this option is used.
2611
74291a4b 2612@item -Wtrigraphs
cd3bb277 2613@opindex Wtrigraphs
f2ecb02d
JM
2614Warn if any trigraphs are encountered that might change the meaning of
2615the program (trigraphs within comments are not warned about).
69cdf050 2616This warning is enabled by @option{-Wall}.
74291a4b 2617
078721e1 2618@item -Wunused-function
cd3bb277 2619@opindex Wunused-function
078721e1 2620Warn whenever a static function is declared but not defined or a
aa58883c 2621non-inline static function is unused.
69cdf050 2622This warning is enabled by @option{-Wall}.
74291a4b 2623
078721e1 2624@item -Wunused-label
cd3bb277 2625@opindex Wunused-label
078721e1 2626Warn whenever a label is declared but not used.
69cdf050 2627This warning is enabled by @option{-Wall}.
078721e1
AC
2628
2629To suppress this warning use the @samp{unused} attribute
2630(@pxref{Variable Attributes}).
2631
2632@item -Wunused-parameter
cd3bb277 2633@opindex Wunused-parameter
078721e1
AC
2634Warn whenever a function parameter is unused aside from its declaration.
2635
2636To suppress this warning use the @samp{unused} attribute
2637(@pxref{Variable Attributes}).
956d6950 2638
078721e1 2639@item -Wunused-variable
cd3bb277 2640@opindex Wunused-variable
078721e1
AC
2641Warn whenever a local variable or non-constant static variable is unused
2642aside from its declaration
69cdf050 2643This warning is enabled by @option{-Wall}.
078721e1
AC
2644
2645To suppress this warning use the @samp{unused} attribute
74291a4b
MM
2646(@pxref{Variable Attributes}).
2647
078721e1 2648@item -Wunused-value
cd3bb277 2649@opindex Wunused-value
078721e1 2650Warn whenever a statement computes a result that is explicitly not used.
69cdf050 2651This warning is enabled by @option{-Wall}.
078721e1
AC
2652
2653To suppress this warning cast the expression to @samp{void}.
2654
2655@item -Wunused
cd3bb277 2656@opindex Wunused
d3075b6c 2657All the above @option{-Wunused} options combined.
078721e1
AC
2658
2659In order to get a warning about an unused function parameter, you must
65ca2d60
PE
2660either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2661@samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
078721e1 2662
74291a4b 2663@item -Wuninitialized
cd3bb277 2664@opindex Wuninitialized
c5c76735
JL
2665Warn if an automatic variable is used without first being initialized or
2666if a variable may be clobbered by a @code{setjmp} call.
74291a4b
MM
2667
2668These warnings are possible only in optimizing compilation,
2669because they require data flow information that is computed only
630d3d5a 2670when optimizing. If you don't specify @option{-O}, you simply won't
74291a4b
MM
2671get these warnings.
2672
3390f9c9
AP
2673If you want to warn about code which uses the uninitialized value of the
2674variable in its own initializer, use the @option{-Winit-self} option.
2675
8ceac9f8
JM
2676These warnings occur for individual uninitialized or clobbered
2677elements of structure, union or array variables as well as for
2678variables which are uninitialized or clobbered as a whole. They do
2679not occur for variables or elements declared @code{volatile}. Because
2680these warnings depend on optimization, the exact variables or elements
2681for which there are warnings will depend on the precise optimization
2682options and version of GCC used.
74291a4b
MM
2683
2684Note that there may be no warning about a variable that is used only
2685to compute a value that itself is never used, because such
2686computations may be deleted by data flow analysis before the warnings
2687are printed.
2688
0c2d1a2a 2689These warnings are made optional because GCC is not smart
74291a4b
MM
2690enough to see all the reasons why the code might be correct
2691despite appearing to have an error. Here is one example of how
2692this can happen:
2693
2694@smallexample
aee96fe9 2695@group
74291a4b
MM
2696@{
2697 int x;
2698 switch (y)
2699 @{
2700 case 1: x = 1;
2701 break;
2702 case 2: x = 4;
2703 break;
2704 case 3: x = 5;
2705 @}
2706 foo (x);
2707@}
aee96fe9 2708@end group
74291a4b
MM
2709@end smallexample
2710
2711@noindent
2712If the value of @code{y} is always 1, 2 or 3, then @code{x} is
0c2d1a2a 2713always initialized, but GCC doesn't know this. Here is
74291a4b
MM
2714another common case:
2715
2716@smallexample
2717@{
2718 int save_y;
2719 if (change_y) save_y = y, y = new_y;
2720 @dots{}
2721 if (change_y) y = save_y;
2722@}
2723@end smallexample
2724
2725@noindent
2726This has no bug because @code{save_y} is used only if it is set.
2727
20300b05 2728@cindex @code{longjmp} warnings
b192711e 2729This option also warns when a non-volatile automatic variable might be
c5c76735
JL
2730changed by a call to @code{longjmp}. These warnings as well are possible
2731only in optimizing compilation.
20300b05
GK
2732
2733The compiler sees only the calls to @code{setjmp}. It cannot know
2734where @code{longjmp} will be called; in fact, a signal handler could
2735call it at any point in the code. As a result, you may get a warning
2736even when there is in fact no problem because @code{longjmp} cannot
2737in fact be called at the place which would cause a problem.
2738
74291a4b
MM
2739Some spurious warnings can be avoided if you declare all the functions
2740you use that never return as @code{noreturn}. @xref{Function
2741Attributes}.
2742
69cdf050
JM
2743This warning is enabled by @option{-Wall}.
2744
d300e551 2745@item -Wunknown-pragmas
cd3bb277 2746@opindex Wunknown-pragmas
d300e551
NC
2747@cindex warning for unknown pragmas
2748@cindex unknown pragmas, warning
2749@cindex pragmas, warning of unknown
2750Warn when a #pragma directive is encountered which is not understood by
161d7b59 2751GCC@. If this command line option is used, warnings will even be issued
d300e551 2752for unknown pragmas in system header files. This is not the case if
630d3d5a 2753the warnings were only enabled by the @option{-Wall} command line option.
d300e551 2754
b9b8dde3
DD
2755@item -Wno-pragmas
2756@opindex Wno-pragmas
2757@opindex Wpragmas
2758Do not warn about misuses of pragmas, such as incorrect parameters,
2759invalid syntax, or conflicts between pragmas. See also
2760@samp{-Wunknown-pragmas}.
2761
bf52f899
NS
2762@item -Wstrict-aliasing
2763@opindex Wstrict-aliasing
2764This option is only active when @option{-fstrict-aliasing} is active.
2765It warns about code which might break the strict aliasing rules that the
8a36672b
JM
2766compiler is using for optimization. The warning does not catch all
2767cases, but does attempt to catch the more common pitfalls. It is
bf52f899
NS
2768included in @option{-Wall}.
2769
5399d643
JW
2770@item -Wstrict-aliasing=2
2771@opindex Wstrict-aliasing=2
2772This option is only active when @option{-fstrict-aliasing} is active.
66f33c03
JW
2773It warns about code which might break the strict aliasing rules that the
2774compiler is using for optimization. This warning catches more cases than
2775@option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2776cases that are safe.
5399d643 2777
74291a4b 2778@item -Wall
cd3bb277 2779@opindex Wall
74291a4b
MM
2780All of the above @samp{-W} options combined. This enables all the
2781warnings about constructions that some users consider questionable, and
2782that are easy to avoid (or modify to prevent the warning), even in
bd8f9aec
SP
2783conjunction with macros. This also enables some language-specific
2784warnings described in @ref{C++ Dialect Options} and
46e34f96 2785@ref{Objective-C and Objective-C++ Dialect Options}.
74291a4b
MM
2786@end table
2787
630d3d5a 2788The following @option{-W@dots{}} options are not implied by @option{-Wall}.
74291a4b
MM
2789Some of them warn about constructions that users generally do not
2790consider questionable, but which occasionally you might wish to check
2791for; others warn about constructions that are necessary or hard to avoid
2792in some cases, and there is no simple way to modify the code to suppress
2793the warning.
2794
2642624b 2795@table @gcctabopt
65ca2d60 2796@item -Wextra
cd3bb277 2797@opindex W
65ca2d60
PE
2798@opindex Wextra
2799(This option used to be called @option{-W}. The older name is still
2800supported, but the newer name is more descriptive.) Print extra warning
2801messages for these events:
74291a4b
MM
2802
2803@itemize @bullet
74291a4b
MM
2804@item
2805A function can return either with or without a value. (Falling
2806off the end of the function body is considered returning without
2807a value.) For example, this function would evoke such a
2808warning:
2809
2810@smallexample
2811@group
2812foo (a)
2813@{
2814 if (a > 0)
2815 return a;
2816@}
2817@end group
2818@end smallexample
2819
2820@item
2821An expression-statement or the left-hand side of a comma expression
2822contains no side effects.
2823To suppress the warning, cast the unused expression to void.
2824For example, an expression such as @samp{x[i,j]} will cause a warning,
2825but @samp{x[(void)i,j]} will not.
2826
2827@item
65ca2d60 2828An unsigned value is compared against zero with @samp{<} or @samp{>=}.
74291a4b 2829
74291a4b
MM
2830@item
2831Storage-class specifiers like @code{static} are not the first things in
2832a declaration. According to the C Standard, this usage is obsolescent.
2833
2834@item
630d3d5a 2835If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
74291a4b
MM
2836arguments.
2837
e9a25f70
JL
2838@item
2839A comparison between signed and unsigned values could produce an
2840incorrect result when the signed value is converted to unsigned.
630d3d5a 2841(But don't warn if @option{-Wno-sign-compare} is also specified.)
e9a25f70 2842
dbde0d5d
BH
2843@item
2844An aggregate has an initializer which does not initialize all members.
eaac4679
RS
2845This warning can be independently controlled by
2846@option{-Wmissing-field-initializers}.
65ca2d60
PE
2847
2848@item
2849A function parameter is declared without a type specifier in K&R-style
2850functions:
2851
2852@smallexample
2853void foo(bar) @{ @}
2854@end smallexample
2855
2856@item
2857An empty body occurs in an @samp{if} or @samp{else} statement.
2858
2859@item
2860A pointer is compared against integer zero with @samp{<}, @samp{<=},
2861@samp{>}, or @samp{>=}.
2862
2863@item
2864A variable might be changed by @samp{longjmp} or @samp{vfork}.
2865
2866@item
2867Any of several floating-point events that often indicate errors, such as
2868overflow, underflow, loss of precision, etc.
2869
2870@item @r{(C++ only)}
2871An enumerator and a non-enumerator both appear in a conditional expression.
2872
2873@item @r{(C++ only)}
2874A non-static reference or non-static @samp{const} member appears in a
2875class without constructors.
2876
2877@item @r{(C++ only)}
2878Ambiguous virtual bases.
2879
2880@item @r{(C++ only)}
2881Subscripting an array which has been declared @samp{register}.
2882
2883@item @r{(C++ only)}
2884Taking the address of a variable which has been declared @samp{register}.
2885
2886@item @r{(C++ only)}
62b9c42c 2887A base class is not initialized in a derived class' copy constructor.
74291a4b
MM
2888@end itemize
2889
75227a33
GK
2890@item -Wno-div-by-zero
2891@opindex Wno-div-by-zero
2892@opindex Wdiv-by-zero
2893Do not warn about compile-time integer division by zero. Floating point
2894division by zero is not warned about, as it can be a legitimate way of
2895obtaining infinities and NaNs.
2896
2897@item -Wsystem-headers
2898@opindex Wsystem-headers
2899@cindex warnings from system headers
2900@cindex system headers, warnings from
2901Print warning messages for constructs found in system header files.
2902Warnings from system headers are normally suppressed, on the assumption
2903that they usually do not indicate real problems and would only make the
2904compiler output harder to read. Using this command line option tells
2905GCC to emit warnings from system headers as if they occurred in user
2906code. However, note that using @option{-Wall} in conjunction with this
2907option will @emph{not} warn about unknown pragmas in system
2908headers---for that, @option{-Wunknown-pragmas} must also be used.
2909
f793a95e 2910@item -Wfloat-equal
cd3bb277 2911@opindex Wfloat-equal
f793a95e
JL
2912Warn if floating point values are used in equality comparisons.
2913
488d3985
GK
2914The idea behind this is that sometimes it is convenient (for the
2915programmer) to consider floating-point values as approximations to
2916infinitely precise real numbers. If you are doing this, then you need
c0478a66 2917to compute (by analyzing the code, or in some other way) the maximum or
488d3985
GK
2918likely maximum error that the computation introduces, and allow for it
2919when performing comparisons (and when producing output, but that's a
2920different problem). In particular, instead of testing for equality, you
2921would check to see whether the two values have ranges that overlap; and
2922this is done with the relational operators, so equality comparisons are
2923probably mistaken.
2924
aee96fe9 2925@item -Wtraditional @r{(C only)}
cd3bb277 2926@opindex Wtraditional
74291a4b 2927Warn about certain constructs that behave differently in traditional and
161d7b59 2928ISO C@. Also warn about ISO C constructs that have no traditional C
c8abc684 2929equivalent, and/or problematic constructs which should be avoided.
74291a4b
MM
2930
2931@itemize @bullet
2932@item
da312b55
NB
2933Macro parameters that appear within string literals in the macro body.
2934In traditional C macro replacement takes place within string literals,
161d7b59 2935but does not in ISO C@.
da312b55
NB
2936
2937@item
2938In traditional C, some preprocessor directives did not exist.
2939Traditional preprocessors would only consider a line to be a directive
2940if the @samp{#} appeared in column 1 on the line. Therefore
630d3d5a 2941@option{-Wtraditional} warns about directives that traditional C
da312b55
NB
2942understands but would ignore because the @samp{#} does not appear as the
2943first character on the line. It also suggests you hide directives like
2944@samp{#pragma} not understood by traditional C by indenting them. Some
c21cd8b1 2945traditional implementations would not recognize @samp{#elif}, so it
da312b55
NB
2946suggests avoiding it altogether.
2947
2948@item
2949A function-like macro that appears without arguments.
2950
2951@item
2952The unary plus operator.
2953
2954@item
c771326b
JM
2955The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2956constant suffixes. (Traditional C does support the @samp{L} suffix on integer
da312b55 2957constants.) Note, these suffixes appear in macros defined in the system
e979f9e8 2958headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
c8abc684 2959Use of these macros in user code might normally lead to spurious
2dd76960 2960warnings, however GCC's integrated preprocessor has enough context to
c8abc684 2961avoid warning in these cases.
74291a4b
MM
2962
2963@item
2964A function declared external in one block and then used after the end of
2965the block.
2966
2967@item
2968A @code{switch} statement has an operand of type @code{long}.
db838bb8
KG
2969
2970@item
2971A non-@code{static} function declaration follows a @code{static} one.
2972This construct is not accepted by some traditional C compilers.
48776cde
KG
2973
2974@item
c1030c7c 2975The ISO type of an integer constant has a different width or
48776cde 2976signedness from its traditional type. This warning is only issued if
e979f9e8 2977the base of the constant is ten. I.e.@: hexadecimal or octal values, which
48776cde 2978typically represent bit patterns, are not warned about.
bb66adca
KG
2979
2980@item
c1030c7c 2981Usage of ISO string concatenation is detected.
7f094a94 2982
895ea614
KG
2983@item
2984Initialization of automatic aggregates.
2985
2986@item
2987Identifier conflicts with labels. Traditional C lacks a separate
2988namespace for labels.
253b6b82
KG
2989
2990@item
2991Initialization of unions. If the initializer is zero, the warning is
2992omitted. This is done under the assumption that the zero initializer in
e979f9e8 2993user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
253b6b82
KG
2994initializer warnings and relies on default initialization to zero in the
2995traditional C case.
03829ad2
KG
2996
2997@item
3ed56f8a
KG
2998Conversions by prototypes between fixed/floating point values and vice
2999versa. The absence of these prototypes when compiling with traditional
3000C would cause serious problems. This is a subset of the possible
630d3d5a 3001conversion warnings, for the full set use @option{-Wconversion}.
622d3731
KG
3002
3003@item
3004Use of ISO C style function definitions. This warning intentionally is
3005@emph{not} issued for prototype declarations or variadic functions
3006because these ISO C features will appear in your code when using
3007libiberty's traditional C compatibility macros, @code{PARAMS} and
3008@code{VPARAMS}. This warning is also bypassed for nested functions
2dd76960 3009because that feature is already a GCC extension and thus not relevant to
622d3731 3010traditional C compatibility.
74291a4b
MM
3011@end itemize
3012
85617eba
HPN
3013@item -Wdeclaration-after-statement @r{(C only)}
3014@opindex Wdeclaration-after-statement
3015Warn when a declaration is found after a statement in a block. This
3016construct, known from C++, was introduced with ISO C99 and is by default
3017allowed in GCC@. It is not supported by ISO C90 and was not supported by
3018GCC versions before GCC 3.0. @xref{Mixed Declarations}.
3019
861bb6c1 3020@item -Wundef
cd3bb277 3021@opindex Wundef
861bb6c1
JL
3022Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3023
90689ae1
JM
3024@item -Wno-endif-labels
3025@opindex Wno-endif-labels
909de5da 3026@opindex Wendif-labels
90689ae1 3027Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
909de5da 3028
74291a4b 3029@item -Wshadow
cd3bb277 3030@opindex Wshadow
d773df5a
DB
3031Warn whenever a local variable shadows another local variable, parameter or
3032global variable or whenever a built-in function is shadowed.
74291a4b 3033
74291a4b 3034@item -Wlarger-than-@var{len}
cd3bb277 3035@opindex Wlarger-than
74291a4b
MM
3036Warn whenever an object of larger than @var{len} bytes is defined.
3037
f9cc1a70
PB
3038@item -Wunsafe-loop-optimizations
3039@opindex Wunsafe-loop-optimizations
3040Warn if the loop cannot be optimized because the compiler could not
3041assume anything on the bounds of the loop indices. With
3042@option{-funsafe-loop-optimizations} warn if the compiler made
3043such assumptions.
3044
74291a4b 3045@item -Wpointer-arith
cd3bb277 3046@opindex Wpointer-arith
74291a4b
MM
3047Warn about anything that depends on the ``size of'' a function type or
3048of @code{void}. GNU C assigns these types a size of 1, for
3049convenience in calculations with @code{void *} pointers and pointers
3050to functions.
3051
aee96fe9 3052@item -Wbad-function-cast @r{(C only)}
cd3bb277 3053@opindex Wbad-function-cast
74291a4b
MM
3054Warn whenever a function call is cast to a non-matching type.
3055For example, warn if @code{int malloc()} is cast to @code{anything *}.
3056
b7e20b53
GDR
3057@item -Wc++-compat
3058Warn about ISO C constructs that are outside of the common subset of
3059ISO C and ISO C++, e.g.@: request for implicit conversion from
3060@code{void *} to a pointer to non-@code{void} type.
3061
74291a4b 3062@item -Wcast-qual
cd3bb277 3063@opindex Wcast-qual
74291a4b
MM
3064Warn whenever a pointer is cast so as to remove a type qualifier from
3065the target type. For example, warn if a @code{const char *} is cast
3066to an ordinary @code{char *}.
3067
3068@item -Wcast-align
cd3bb277 3069@opindex Wcast-align
74291a4b
MM
3070Warn whenever a pointer is cast such that the required alignment of the
3071target is increased. For example, warn if a @code{char *} is cast to
3072an @code{int *} on machines where integers can only be accessed at
3073two- or four-byte boundaries.
3074
3075@item -Wwrite-strings
cd3bb277 3076@opindex Wwrite-strings
aee96fe9
JM
3077When compiling C, give string constants the type @code{const
3078char[@var{length}]} so that
74291a4b 3079copying the address of one into a non-@code{const} @code{char *}
aee96fe9
JM
3080pointer will get a warning; when compiling C++, warn about the
3081deprecated conversion from string constants to @code{char *}.
3082These warnings will help you find at
74291a4b
MM
3083compile time code that can try to write into a string constant, but
3084only if you have been very careful about using @code{const} in
3085declarations and prototypes. Otherwise, it will just be a nuisance;
630d3d5a 3086this is why we did not make @option{-Wall} request these warnings.
74291a4b
MM
3087
3088@item -Wconversion
cd3bb277 3089@opindex Wconversion
74291a4b
MM
3090Warn if a prototype causes a type conversion that is different from what
3091would happen to the same argument in the absence of a prototype. This
3092includes conversions of fixed point to floating and vice versa, and
3093conversions changing the width or signedness of a fixed point argument
3094except when the same as the default promotion.
3095
3096Also, warn if a negative integer constant expression is implicitly
3097converted to an unsigned type. For example, warn about the assignment
3098@code{x = -1} if @code{x} is unsigned. But do not warn about explicit
3099casts like @code{(unsigned) -1}.
3100
e9a25f70 3101@item -Wsign-compare
cd3bb277 3102@opindex Wsign-compare
e9a25f70
JL
3103@cindex warning for comparison of signed and unsigned values
3104@cindex comparison of signed and unsigned values, warning
3105@cindex signed and unsigned values, comparison warning
3106Warn when a comparison between signed and unsigned values could produce
3107an incorrect result when the signed value is converted to unsigned.
65ca2d60
PE
3108This warning is also enabled by @option{-Wextra}; to get the other warnings
3109of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
e9a25f70 3110
74291a4b 3111@item -Waggregate-return
cd3bb277 3112@opindex Waggregate-return
74291a4b
MM
3113Warn if any functions that return structures or unions are defined or
3114called. (In languages where you can return an array, this also elicits
3115a warning.)
3116
690a704a
BE
3117@item -Walways-true
3118@opindex Walways-true
03237161
BE
3119Warn about comparisons which are always true such as testing if
3120unsigned values are greater than or equal to zero. This warning is
3121enabled by @option{-Wall}.
690a704a 3122
5c498b10
DD
3123@item -Wno-attributes
3124@opindex Wno-attributes
3125@opindex Wattributes
3126Do not warn if an unexpected @code{__attribute__} is used, such as
3127unrecognized attributes, function attributes applied to variables,
3128etc. This will not stop errors for incorrect use of supported
3129attributes.
3130
aee96fe9 3131@item -Wstrict-prototypes @r{(C only)}
cd3bb277 3132@opindex Wstrict-prototypes
74291a4b
MM
3133Warn if a function is declared or defined without specifying the
3134argument types. (An old-style function definition is permitted without
3135a warning if preceded by a declaration which specifies the argument
3136types.)
3137
c034f121
AJ
3138@item -Wold-style-definition @r{(C only)}
3139@opindex Wold-style-definition
3140Warn if an old-style function definition is used. A warning is given
3141even if there is a previous prototype.
3142
aee96fe9 3143@item -Wmissing-prototypes @r{(C only)}
cd3bb277 3144@opindex Wmissing-prototypes
74291a4b
MM
3145Warn if a global function is defined without a previous prototype
3146declaration. This warning is issued even if the definition itself
3147provides a prototype. The aim is to detect global functions that fail
3148to be declared in header files.
3149
da635858 3150@item -Wmissing-declarations @r{(C only)}
cd3bb277 3151@opindex Wmissing-declarations
74291a4b
MM
3152Warn if a global function is defined without a previous declaration.
3153Do so even if the definition itself provides a prototype.
3154Use this option to detect global functions that are not declared in
3155header files.
3156
eaac4679
RS
3157@item -Wmissing-field-initializers
3158@opindex Wmissing-field-initializers
3159@opindex W
3160@opindex Wextra
3161Warn if a structure's initializer has some fields missing. For
3162example, the following code would cause such a warning, because
3163@code{x.h} is implicitly zero:
3164
3165@smallexample
3166struct s @{ int f, g, h; @};
3167struct s x = @{ 3, 4 @};
3168@end smallexample
3169
3170This option does not warn about designated initializers, so the following
3171modification would not trigger a warning:
3172
3173@smallexample
3174struct s @{ int f, g, h; @};
3175struct s x = @{ .f = 3, .g = 4 @};
3176@end smallexample
3177
3178This warning is included in @option{-Wextra}. To get other @option{-Wextra}
3179warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3180
0ca3fb0a 3181@item -Wmissing-noreturn
cd3bb277 3182@opindex Wmissing-noreturn
0ca3fb0a
KG
3183Warn about functions which might be candidates for attribute @code{noreturn}.
3184Note these are only possible candidates, not absolute ones. Care should
3185be taken to manually verify functions actually do not ever return before
3186adding the @code{noreturn} attribute, otherwise subtle code generation
21c7361e
AJ
3187bugs could be introduced. You will not get a warning for @code{main} in
3188hosted C environments.
0ca3fb0a 3189
74ff4629 3190@item -Wmissing-format-attribute
cd3bb277
JM
3191@opindex Wmissing-format-attribute
3192@opindex Wformat
7876a414
KG
3193Warn about function pointers which might be candidates for @code{format}
3194attributes. Note these are only possible candidates, not absolute ones.
3195GCC will guess that function pointers with @code{format} attributes that
3196are used in assignment, initialization, parameter passing or return
3197statements should have a corresponding @code{format} attribute in the
3198resulting type. I.e.@: the left-hand side of the assignment or
3199initialization, the type of the parameter variable, or the return type
3200of the containing function respectively should also have a @code{format}
3201attribute to avoid the warning.
3202
3203GCC will also warn about function definitions which might be
3204candidates for @code{format} attributes. Again, these are only
3205possible candidates. GCC will guess that @code{format} attributes
3206might be appropriate for any function that calls a function like
3207@code{vprintf} or @code{vscanf}, but this might not always be the
74ff4629 3208case, and some functions for which @code{format} attributes are
7876a414 3209appropriate may not be detected.
74ff4629 3210
75227a33
GK
3211@item -Wno-multichar
3212@opindex Wno-multichar
3213@opindex Wmultichar
3214Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3215Usually they indicate a typo in the user's code, as they have
3216implementation-defined values, and should not be used in portable code.
3217
50668cf6
GK
3218@item -Wnormalized=<none|id|nfc|nfkc>
3219@opindex Wnormalized
3220@cindex NFC
3221@cindex NFKC
3222@cindex character set, input normalization
3223In ISO C and ISO C++, two identifiers are different if they are
3224different sequences of characters. However, sometimes when characters
3225outside the basic ASCII character set are used, you can have two
3226different character sequences that look the same. To avoid confusion,
3227the ISO 10646 standard sets out some @dfn{normalization rules} which
3228when applied ensure that two sequences that look the same are turned into
3229the same sequence. GCC can warn you if you are using identifiers which
3230have not been normalized; this option controls that warning.
3231
3232There are four levels of warning that GCC supports. The default is
3233@option{-Wnormalized=nfc}, which warns about any identifier which is
3234not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the
3235recommended form for most uses.
3236
3237Unfortunately, there are some characters which ISO C and ISO C++ allow
3238in identifiers that when turned into NFC aren't allowable as
3239identifiers. That is, there's no way to use these symbols in portable
3240ISO C or C++ and have all your identifiers in NFC.
3241@option{-Wnormalized=id} suppresses the warning for these characters.
3242It is hoped that future versions of the standards involved will correct
3243this, which is why this option is not the default.
3244
3245You can switch the warning off for all characters by writing
3246@option{-Wnormalized=none}. You would only want to do this if you
3247were using some other normalization scheme (like ``D''), because
3248otherwise you can easily create bugs that are literally impossible to see.
3249
3250Some characters in ISO 10646 have distinct meanings but look identical
3251in some fonts or display methodologies, especially once formatting has
3252been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3253LETTER N'', will display just like a regular @code{n} which has been
3254placed in a superscript. ISO 10646 defines the @dfn{NFKC}
3255normalisation scheme to convert all these into a standard form as
3256well, and GCC will warn if your code is not in NFKC if you use
3257@option{-Wnormalized=nfkc}. This warning is comparable to warning
3258about every identifier that contains the letter O because it might be
3259confused with the digit 0, and so is not the default, but may be
3260useful as a local coding convention if the programming environment is
3261unable to be fixed to display these characters distinctly.
3262
e23bd218
IR
3263@item -Wno-deprecated-declarations
3264@opindex Wno-deprecated-declarations
3265Do not warn about uses of functions, variables, and types marked as
f282ffb3 3266deprecated by using the @code{deprecated} attribute.
e23bd218
IR
3267(@pxref{Function Attributes}, @pxref{Variable Attributes},
3268@pxref{Type Attributes}.)
3269
3c12fcc2 3270@item -Wpacked
cd3bb277 3271@opindex Wpacked
3c12fcc2 3272Warn if a structure is given the packed attribute, but the packed
02f52e19 3273attribute has no effect on the layout or size of the structure.
3c12fcc2
GM
3274Such structures may be mis-aligned for little benefit. For
3275instance, in this code, the variable @code{f.x} in @code{struct bar}
3276will be misaligned even though @code{struct bar} does not itself
3277have the packed attribute:
3278
3279@smallexample
3280@group
3281struct foo @{
3282 int x;
3283 char a, b, c, d;
3284@} __attribute__((packed));
3285struct bar @{
3286 char z;
3287 struct foo f;
3288@};
3289@end group
3290@end smallexample
3291
3292@item -Wpadded
cd3bb277 3293@opindex Wpadded
3c12fcc2
GM
3294Warn if padding is included in a structure, either to align an element
3295of the structure or to align the whole structure. Sometimes when this
3296happens it is possible to rearrange the fields of the structure to
3297reduce the padding and so make the structure smaller.
3298
74291a4b 3299@item -Wredundant-decls
cd3bb277 3300@opindex Wredundant-decls
74291a4b
MM
3301Warn if anything is declared more than once in the same scope, even in
3302cases where multiple declaration is valid and changes nothing.
3303
aee96fe9 3304@item -Wnested-externs @r{(C only)}
cd3bb277 3305@opindex Wnested-externs
252215a7 3306Warn if an @code{extern} declaration is encountered within a function.
74291a4b 3307
312f6255 3308@item -Wunreachable-code
cd3bb277 3309@opindex Wunreachable-code
312f6255
GK
3310Warn if the compiler detects that code will never be executed.
3311
3312This option is intended to warn when the compiler detects that at
3313least a whole line of source code will never be executed, because
3314some condition is never satisfied or because it is after a
3315procedure that never returns.
3316
3317It is possible for this option to produce a warning even though there
3318are circumstances under which part of the affected line can be executed,
3319so care should be taken when removing apparently-unreachable code.
3320
3321For instance, when a function is inlined, a warning may mean that the
02f52e19 3322line is unreachable in only one inlined copy of the function.
312f6255 3323
630d3d5a 3324This option is not made part of @option{-Wall} because in a debugging
312f6255
GK
3325version of a program there is often substantial code which checks
3326correct functioning of the program and is, hopefully, unreachable
3327because the program does work. Another common use of unreachable
c21cd8b1 3328code is to provide behavior which is selectable at compile-time.
312f6255 3329
74291a4b 3330@item -Winline
cd3bb277 3331@opindex Winline
c5c76735 3332Warn if a function can not be inlined and it was declared as inline.
ae4a7155 3333Even with this option, the compiler will not warn about failures to
daf2f129 3334inline functions declared in system headers.
ae4a7155
MM
3335
3336The compiler uses a variety of heuristics to determine whether or not
3337to inline a function. For example, the compiler takes into account
0bdcd332 3338the size of the function being inlined and the amount of inlining
ae4a7155
MM
3339that has already been done in the current function. Therefore,
3340seemingly insignificant changes in the source program can cause the
3341warnings produced by @option{-Winline} to appear or disappear.
74291a4b 3342
a01fff59
MA
3343@item -Wno-invalid-offsetof @r{(C++ only)}
3344@opindex Wno-invalid-offsetof
3345Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3346type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
3347to a non-POD type is undefined. In existing C++ implementations,
3348however, @samp{offsetof} typically gives meaningful results even when
3349applied to certain kinds of non-POD types. (Such as a simple
3350@samp{struct} that fails to be a POD type only by virtue of having a
3351constructor.) This flag is for users who are aware that they are
3352writing nonportable code and who have deliberately chosen to ignore the
3353warning about it.
3354
3355The restrictions on @samp{offsetof} may be relaxed in a future version
3356of the C++ standard.
3357
53a2494e
JM
3358@item -Wno-int-to-pointer-cast @r{(C only)}
3359@opindex Wno-int-to-pointer-cast
3360Suppress warnings from casts to pointer type of an integer of a
3361different size.
3362
3363@item -Wno-pointer-to-int-cast @r{(C only)}
3364@opindex Wno-pointer-to-int-cast
3365Suppress warnings from casts from a pointer to an integer type of a
3366different size.
3367
17211ab5
GK
3368@item -Winvalid-pch
3369@opindex Winvalid-pch
3370Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3371the search path but can't be used.
3372
795add94 3373@item -Wlong-long
cd3bb277
JM
3374@opindex Wlong-long
3375@opindex Wno-long-long
795add94 3376Warn if @samp{long long} type is used. This is default. To inhibit
630d3d5a
JM
3377the warning messages, use @option{-Wno-long-long}. Flags
3378@option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3379only when @option{-pedantic} flag is used.
795add94 3380
7c4d376d
RH
3381@item -Wvariadic-macros
3382@opindex Wvariadic-macros
3383@opindex Wno-variadic-macros
3384Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3385alternate syntax when in pedantic ISO C99 mode. This is default.
3386To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3387
d35a40fc
DE
3388@item -Wvolatile-register-var
3389@opindex Wvolatile-register-var
3390@opindex Wno-volatile-register-var
3391Warn if a register variable is declared volatile. The volatile
3392modifier does not inhibit all optimizations that may eliminate reads
3393and/or writes to register variables.
3394
18424ae1 3395@item -Wdisabled-optimization
cd3bb277 3396@opindex Wdisabled-optimization
18424ae1
BL
3397Warn if a requested optimization pass is disabled. This warning does
3398not generally indicate that there is anything wrong with your code; it
3399merely indicates that GCC's optimizers were unable to handle the code
3400effectively. Often, the problem is that your code is too big or too
3401complex; GCC will refuse to optimize programs when the optimization
3402itself is likely to take inordinate amounts of time.
3403
f2fd3821
AJ
3404@item -Wno-pointer-sign
3405@opindex Wno-pointer-sign
3406Don't warn for pointer argument passing or assignment with different signedness.
3407Only useful in the negative form since this warning is enabled by default.
3408This option is only supported for C and Objective-C@.
3409
74291a4b 3410@item -Werror
cd3bb277 3411@opindex Werror
74291a4b 3412Make all warnings into errors.
0aca9021
JW
3413
3414@item -Wstack-protector
d77314ec 3415@opindex Wstack-protector
0aca9021
JW
3416This option is only active when @option{-fstack-protector} is active. It
3417warns about functions that will not be protected against stack smashing.
3418
d77314ec
RS
3419@item -Wstring-literal-comparison
3420@opindex Wstring-literal-comparison
3421Warn about suspicious comparisons to string literal constants. In C,
3422direct comparisons against the memory address of a string literal, such
3423as @code{if (x == "abc")}, typically indicate a programmer error, and
3424even when intentional, result in unspecified behavior and are not portable.
3425Usually these warnings alert that the programmer intended to use
3426@code{strcmp}. This warning is enabled by @option{-Wall}.
3427
74291a4b
MM
3428@end table
3429
3430@node Debugging Options
0c2d1a2a 3431@section Options for Debugging Your Program or GCC
74291a4b
MM
3432@cindex options, debugging
3433@cindex debugging information options
3434
0c2d1a2a 3435GCC has various special options that are used for debugging
74291a4b
MM
3436either your program or GCC:
3437
2642624b 3438@table @gcctabopt
74291a4b 3439@item -g
cd3bb277 3440@opindex g
74291a4b 3441Produce debugging information in the operating system's native format
f8ca7e49 3442(stabs, COFF, XCOFF, or DWARF 2)@. GDB can work with this debugging
74291a4b
MM
3443information.
3444
630d3d5a 3445On most systems that use stabs format, @option{-g} enables use of extra
74291a4b
MM
3446debugging information that only GDB can use; this extra information
3447makes debugging work better in GDB but will probably make other debuggers
3448crash or
3449refuse to read the program. If you want to control for certain whether
630d3d5a 3450to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
def66b10 3451@option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
74291a4b 3452
f8ca7e49 3453GCC allows you to use @option{-g} with
630d3d5a 3454@option{-O}. The shortcuts taken by optimized code may occasionally
74291a4b
MM
3455produce surprising results: some variables you declared may not exist
3456at all; flow of control may briefly move where you did not expect it;
3457some statements may not be executed because they compute constant
3458results or their values were already at hand; some statements may
3459execute in different places because they were moved out of loops.
3460
3461Nevertheless it proves possible to debug optimized output. This makes
3462it reasonable to use the optimizer for programs that might have bugs.
3463
0c2d1a2a 3464The following options are useful when GCC is generated with the
74291a4b
MM
3465capability for more than one debugging format.
3466
3467@item -ggdb
cd3bb277 3468@opindex ggdb
161d7b59 3469Produce debugging information for use by GDB@. This means to use the
861bb6c1
JL
3470most expressive format available (DWARF 2, stabs, or the native format
3471if neither of those are supported), including GDB extensions if at all
3472possible.
74291a4b
MM
3473
3474@item -gstabs
cd3bb277 3475@opindex gstabs
74291a4b
MM
3476Produce debugging information in stabs format (if that is supported),
3477without GDB extensions. This is the format used by DBX on most BSD
3478systems. On MIPS, Alpha and System V Release 4 systems this option
161d7b59 3479produces stabs debugging output which is not understood by DBX or SDB@.
74291a4b
MM
3480On System V Release 4 systems this option requires the GNU assembler.
3481
6a08f7b3
DP
3482@item -feliminate-unused-debug-symbols
3483@opindex feliminate-unused-debug-symbols
3484Produce debugging information in stabs format (if that is supported),
c0cbdbd9 3485for only symbols that are actually used.
6a08f7b3 3486
74291a4b 3487@item -gstabs+
cd3bb277 3488@opindex gstabs+
74291a4b 3489Produce debugging information in stabs format (if that is supported),
161d7b59 3490using GNU extensions understood only by the GNU debugger (GDB)@. The
74291a4b
MM
3491use of these extensions is likely to make other debuggers crash or
3492refuse to read the program.
3493
3494@item -gcoff
cd3bb277 3495@opindex gcoff
74291a4b
MM
3496Produce debugging information in COFF format (if that is supported).
3497This is the format used by SDB on most System V systems prior to
3498System V Release 4.
3499
3500@item -gxcoff
cd3bb277 3501@opindex gxcoff
74291a4b
MM
3502Produce debugging information in XCOFF format (if that is supported).
3503This is the format used by the DBX debugger on IBM RS/6000 systems.
3504
3505@item -gxcoff+
cd3bb277 3506@opindex gxcoff+
74291a4b 3507Produce debugging information in XCOFF format (if that is supported),
161d7b59 3508using GNU extensions understood only by the GNU debugger (GDB)@. The
74291a4b
MM
3509use of these extensions is likely to make other debuggers crash or
3510refuse to read the program, and may cause assemblers other than the GNU
3511assembler (GAS) to fail with an error.
3512
861bb6c1 3513@item -gdwarf-2
cd3bb277 3514@opindex gdwarf-2
861bb6c1 3515Produce debugging information in DWARF version 2 format (if that is
f8ca7e49
ZW
3516supported). This is the format used by DBX on IRIX 6. With this
3517option, GCC uses features of DWARF version 3 when they are useful;
3518version 3 is upward compatible with version 2, but may still cause
3519problems for older debuggers.
74291a4b 3520
5f98259a
RK
3521@item -gvms
3522@opindex gvms
3523Produce debugging information in VMS debug format (if that is
3524supported). This is the format used by DEBUG on VMS systems.
3525
74291a4b
MM
3526@item -g@var{level}
3527@itemx -ggdb@var{level}
3528@itemx -gstabs@var{level}
3529@itemx -gcoff@var{level}
3530@itemx -gxcoff@var{level}
5f98259a 3531@itemx -gvms@var{level}
74291a4b
MM
3532Request debugging information and also use @var{level} to specify how
3533much information. The default level is 2.
3534
3535Level 1 produces minimal information, enough for making backtraces in
3536parts of the program that you don't plan to debug. This includes
3537descriptions of functions and external variables, but no information
3538about local variables and no line numbers.
3539
3540Level 3 includes extra information, such as all the macro definitions
3541present in the program. Some debuggers support macro expansion when
630d3d5a 3542you use @option{-g3}.
74291a4b 3543
f8ca7e49
ZW
3544@option{-gdwarf-2} does not accept a concatenated debug level, because
3545GCC used to support an option @option{-gdwarf} that meant to generate
3546debug information in version 1 of the DWARF format (which is very
3547different from version 2), and it would have been too confusing. That
3548debug format is long obsolete, but the option cannot be changed now.
3549Instead use an additional @option{-g@var{level}} option to change the
3550debug level for DWARF2.
eb7715a4 3551
e03b7153
RS
3552@item -feliminate-dwarf2-dups
3553@opindex feliminate-dwarf2-dups
3554Compress DWARF2 debugging information by eliminating duplicated
3555information about each symbol. This option only makes sense when
3556generating DWARF2 debugging information with @option{-gdwarf-2}.
3557
05739753 3558@cindex @command{prof}
74291a4b 3559@item -p
cd3bb277 3560@opindex p
74291a4b 3561Generate extra code to write profile information suitable for the
05739753 3562analysis program @command{prof}. You must use this option when compiling
74291a4b
MM
3563the source files you want data about, and you must also use it when
3564linking.
3565
05739753 3566@cindex @command{gprof}
74291a4b 3567@item -pg
cd3bb277 3568@opindex pg
74291a4b 3569Generate extra code to write profile information suitable for the
05739753 3570analysis program @command{gprof}. You must use this option when compiling
74291a4b
MM
3571the source files you want data about, and you must also use it when
3572linking.
3573
898f531b 3574@item -Q
cd3bb277 3575@opindex Q
898f531b
JL
3576Makes the compiler print out each function name as it is compiled, and
3577print some statistics about each pass when it finishes.
3578
1f0c3120 3579@item -ftime-report
cd3bb277 3580@opindex ftime-report
1f0c3120
JM
3581Makes the compiler print some statistics about the time consumed by each
3582pass when it finishes.
3583
3584@item -fmem-report
cd3bb277 3585@opindex fmem-report
1f0c3120
JM
3586Makes the compiler print some statistics about permanent memory
3587allocation when it finishes.
3588
861bb6c1 3589@item -fprofile-arcs
cd3bb277 3590@opindex fprofile-arcs
23af32e6
NS
3591Add code so that program flow @dfn{arcs} are instrumented. During
3592execution the program records how many times each branch and call is
3593executed and how many times it is taken or returns. When the compiled
3594program exits it saves this data to a file called
8a36672b 3595@file{@var{auxname}.gcda} for each source file. The data may be used for
23af32e6 3596profile-directed optimizations (@option{-fbranch-probabilities}), or for
8a36672b 3597test coverage analysis (@option{-ftest-coverage}). Each object file's
23af32e6
NS
3598@var{auxname} is generated from the name of the output file, if
3599explicitly specified and it is not the final executable, otherwise it is
8a36672b 3600the basename of the source file. In both cases any suffix is removed
431ae0bf 3601(e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
a4878735 3602@file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
992f396f 3603@xref{Cross-profiling}.
23af32e6 3604
ee4c708e
BE
3605@cindex @command{gcov}
3606@item --coverage
3607@opindex coverage
3608
3609This option is used to compile and link code instrumented for coverage
3610analysis. The option is a synonym for @option{-fprofile-arcs}
3611@option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3612linking). See the documentation for those options for more details.
3613
23af32e6
NS
3614@itemize
3615
3616@item
3617Compile the source files with @option{-fprofile-arcs} plus optimization
8a36672b
JM
3618and code generation options. For test coverage analysis, use the
3619additional @option{-ftest-coverage} option. You do not need to profile
23af32e6
NS
3620every source file in a program.
3621
3622@item
8555daff
NS
3623Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3624(the latter implies the former).
23af32e6
NS
3625
3626@item
3627Run the program on a representative workload to generate the arc profile
8a36672b 3628information. This may be repeated any number of times. You can run
8555daff 3629concurrent instances of your program, and provided that the file system
8a36672b 3630supports locking, the data files will be correctly updated. Also
8555daff
NS
3631@code{fork} calls are detected and correctly handled (double counting
3632will not happen).
23af32e6
NS
3633
3634@item
3635For profile-directed optimizations, compile the source files again with
3636the same optimization and code generation options plus
630d3d5a 3637@option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3de87bf2
JJ
3638Control Optimization}).
3639
23af32e6
NS
3640@item
3641For test coverage analysis, use @command{gcov} to produce human readable
8a36672b 3642information from the @file{.gcno} and @file{.gcda} files. Refer to the
23af32e6
NS
3643@command{gcov} documentation for further information.
3644
3645@end itemize
3de87bf2
JJ
3646
3647With @option{-fprofile-arcs}, for each function of your program GCC
3648creates a program flow graph, then finds a spanning tree for the graph.
3649Only arcs that are not on the spanning tree have to be instrumented: the
3650compiler adds code to count the number of times that these arcs are
3651executed. When an arc is the only exit or only entrance to a block, the
3652instrumentation code can be added to the block; otherwise, a new basic
3653block must be created to hold the instrumentation code.
3654
861bb6c1
JL
3655@need 2000
3656@item -ftest-coverage
cd3bb277 3657@opindex ftest-coverage
a4878735 3658Produce a notes file that the @command{gcov} code-coverage utility
23af32e6 3659(@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
8a36672b
JM
3660show program coverage. Each source file's note file is called
3661@file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
23af32e6 3662above for a description of @var{auxname} and instructions on how to
8a36672b 3663generate test coverage data. Coverage data will match the source files
23af32e6 3664more closely, if you do not optimize.
3de87bf2 3665
74291a4b 3666@item -d@var{letters}
9f8628ba 3667@item -fdump-rtl-@var{pass}
cd3bb277 3668@opindex d
74291a4b 3669Says to make debugging dumps during compilation at times specified by
9f8628ba
PB
3670@var{letters}. This is used for debugging the RTL-based passes of the
3671compiler. The file names for most of the dumps are made by appending a
3672pass number and a word to the @var{dumpname}. @var{dumpname} is generated
3673from the name of the output file, if explicitly specified and it is not
3674an executable, otherwise it is the basename of the source file.
74291a4b 3675
9f8628ba
PB
3676Most debug dumps can be enabled either passing a letter to the @option{-d}
3677option, or with a long @option{-fdump-rtl} switch; here are the possible
3678letters for use in @var{letters} and @var{pass}, and their meanings:
3679
3680@table @gcctabopt
3681@item -dA
cd3bb277 3682@opindex dA
375e2d5c 3683Annotate the assembler output with miscellaneous debugging information.
9f8628ba
PB
3684
3685@item -db
3686@itemx -fdump-rtl-bp
cd3bb277 3687@opindex db
9f8628ba
PB
3688@opindex fdump-rtl-bp
3689Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3690
3691@item -dB
3692@itemx -fdump-rtl-bbro
cd3bb277 3693@opindex dB
9f8628ba
PB
3694@opindex fdump-rtl-bbro
3695Dump after block reordering, to @file{@var{file}.30.bbro}.
3696
3697@item -dc
3698@itemx -fdump-rtl-combine
cd3bb277 3699@opindex dc
9f8628ba
PB
3700@opindex fdump-rtl-combine
3701Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3702
3703@item -dC
3704@itemx -fdump-rtl-ce1
3705@itemx -fdump-rtl-ce2
cd3bb277 3706@opindex dC
9f8628ba
PB
3707@opindex fdump-rtl-ce1
3708@opindex fdump-rtl-ce2
3709@option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3710first if conversion, to the file @file{@var{file}.11.ce1}. @option{-dC}
3711and @option{-fdump-rtl-ce2} enable dumping after the second if
3712conversion, to the file @file{@var{file}.18.ce2}.
3713
3714@item -dd
3715@itemx -fdump-rtl-btl
3716@itemx -fdump-rtl-dbr
cd3bb277 3717@opindex dd
9f8628ba
PB
3718@opindex fdump-rtl-btl
3719@opindex fdump-rtl-dbr
3720@option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
0bdcd332 3721target load optimization, to @file{@var{file}.31.btl}. @option{-dd}
9f8628ba
PB
3722and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3723scheduling, to @file{@var{file}.36.dbr}.
3724
3725@item -dD
cd3bb277 3726@opindex dD
f5963e61
JL
3727Dump all macro definitions, at the end of preprocessing, in addition to
3728normal output.
9f8628ba
PB
3729
3730@item -dE
3731@itemx -fdump-rtl-ce3
cd3bb277 3732@opindex dE
9f8628ba
PB
3733@opindex fdump-rtl-ce3
3734Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3735
3736@item -df
3737@itemx -fdump-rtl-cfg
3738@itemx -fdump-rtl-life
cd3bb277 3739@opindex df
9f8628ba
PB
3740@opindex fdump-rtl-cfg
3741@opindex fdump-rtl-life
3742@option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3743and data flow analysis, to @file{@var{file}.08.cfg}. @option{-df}
3744and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3745to @file{@var{file}.16.life}.
3746
3747@item -dg
3748@itemx -fdump-rtl-greg
cd3bb277 3749@opindex dg
9f8628ba
PB
3750@opindex fdump-rtl-greg
3751Dump after global register allocation, to @file{@var{file}.23.greg}.
3752
3753@item -dG
3754@itemx -fdump-rtl-gcse
3755@itemx -fdump-rtl-bypass
cd3bb277 3756@opindex dG
9f8628ba
PB
3757@opindex fdump-rtl-gcse
3758@opindex fdump-rtl-bypass
3759@option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3760@file{@var{file}.05.gcse}. @option{-dG} and @option{-fdump-rtl-bypass}
3761enable dumping after jump bypassing and control flow optimizations, to
3762@file{@var{file}.07.bypass}.
3763
3764@item -dh
3765@itemx -fdump-rtl-eh
7fedea11 3766@opindex dh
9f8628ba
PB
3767@opindex fdump-rtl-eh
3768Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3769
3770@item -di
3771@itemx -fdump-rtl-sibling
cd3bb277 3772@opindex di
9f8628ba
PB
3773@opindex fdump-rtl-sibling
3774Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3775
3776@item -dj
3777@itemx -fdump-rtl-jump
cd3bb277 3778@opindex dj
9f8628ba
PB
3779@opindex fdump-rtl-jump
3780Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3781
3782@item -dk
3783@itemx -fdump-rtl-stack
cd3bb277 3784@opindex dk
9f8628ba
PB
3785@opindex fdump-rtl-stack
3786Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3787
3788@item -dl
3789@itemx -fdump-rtl-lreg
cd3bb277 3790@opindex dl
9f8628ba
PB
3791@opindex fdump-rtl-lreg
3792Dump after local register allocation, to @file{@var{file}.22.lreg}.
3793
3794@item -dL
3795@itemx -fdump-rtl-loop
3796@itemx -fdump-rtl-loop2
cd3bb277 3797@opindex dL
9f8628ba
PB
3798@opindex fdump-rtl-loop
3799@opindex fdump-rtl-loop2
3800@option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3801loop optimization pass, to @file{@var{file}.06.loop}. @option{-dL} and
3802@option{-fdump-rtl-loop2} enable dumping after the second pass, to
3803@file{@var{file}.13.loop2}.
3804
3805@item -dm
3806@itemx -fdump-rtl-sms
e5626198 3807@opindex dm
9f8628ba 3808@opindex fdump-rtl-sms
f0eb93a8 3809Dump after modulo scheduling, to @file{@var{file}.20.sms}.
9f8628ba
PB
3810
3811@item -dM
3812@itemx -fdump-rtl-mach
cd3bb277 3813@opindex dM
9f8628ba 3814@opindex fdump-rtl-mach
c0478a66 3815Dump after performing the machine dependent reorganization pass, to
9f8628ba
PB
3816@file{@var{file}.35.mach}.
3817
3818@item -dn
3819@itemx -fdump-rtl-rnreg
cd3bb277 3820@opindex dn
9f8628ba
PB
3821@opindex fdump-rtl-rnreg
3822Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3823
3824@item -dN
3825@itemx -fdump-rtl-regmove
cd3bb277 3826@opindex dN
9f8628ba
PB
3827@opindex fdump-rtl-regmove
3828Dump after the register move pass, to @file{@var{file}.19.regmove}.
3829
3830@item -do
3831@itemx -fdump-rtl-postreload
7fedea11 3832@opindex do
9f8628ba
PB
3833@opindex fdump-rtl-postreload
3834Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3835
3836@item -dr
3837@itemx -fdump-rtl-expand
cd3bb277 3838@opindex dr
9f8628ba
PB
3839@opindex fdump-rtl-expand
3840Dump after RTL generation, to @file{@var{file}.00.expand}.
3841
3842@item -dR
3843@itemx -fdump-rtl-sched2
cd3bb277 3844@opindex dR
9f8628ba
PB
3845@opindex fdump-rtl-sched2
3846Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3847
3848@item -ds
3849@itemx -fdump-rtl-cse
cd3bb277 3850@opindex ds
9f8628ba 3851@opindex fdump-rtl-cse
032713aa 3852Dump after CSE (including the jump optimization that sometimes follows
9f8628ba
PB
3853CSE), to @file{@var{file}.04.cse}.
3854
3855@item -dS
3856@itemx -fdump-rtl-sched
cd3bb277 3857@opindex dS
9f8628ba
PB
3858@opindex fdump-rtl-sched
3859Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3860
3861@item -dt
3862@itemx -fdump-rtl-cse2
cd3bb277 3863@opindex dt
9f8628ba 3864@opindex fdump-rtl-cse2
032713aa 3865Dump after the second CSE pass (including the jump optimization that
9f8628ba
PB
3866sometimes follows CSE), to @file{@var{file}.15.cse2}.
3867
3868@item -dT
3869@itemx -fdump-rtl-tracer
4319ef2a 3870@opindex dT
9f8628ba
PB
3871@opindex fdump-rtl-tracer
3872Dump after running tracer, to @file{@var{file}.12.tracer}.
3873
3874@item -dV
3875@itemx -fdump-rtl-vpt
3876@itemx -fdump-rtl-vartrack
9313cfdd 3877@opindex dV
9f8628ba
PB
3878@opindex fdump-rtl-vpt
3879@opindex fdump-rtl-vartrack
3880@option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3881profile transformations, to @file{@var{file}.10.vpt}. @option{-dV}
3882and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3883to @file{@var{file}.34.vartrack}.
3884
3885@item -dw
3886@itemx -fdump-rtl-flow2
cd3bb277 3887@opindex dw
9f8628ba
PB
3888@opindex fdump-rtl-flow2
3889Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3890
3891@item -dz
3892@itemx -fdump-rtl-peephole2
cd3bb277 3893@opindex dz
9f8628ba
PB
3894@opindex fdump-rtl-peephole2
3895Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3896
3897@item -dZ
3898@itemx -fdump-rtl-web
9313cfdd 3899@opindex dZ
9f8628ba
PB
3900@opindex fdump-rtl-web
3901Dump after live range splitting, to @file{@var{file}.14.web}.
3902
3903@item -da
3904@itemx -fdump-rtl-all
cd3bb277 3905@opindex da
9f8628ba 3906@opindex fdump-rtl-all
74291a4b 3907Produce all the dumps listed above.
9f8628ba
PB
3908
3909@item -dH
886e0865
GK
3910@opindex dH
3911Produce a core dump whenever an error occurs.
9f8628ba
PB
3912
3913@item -dm
cd3bb277 3914@opindex dm
74291a4b
MM
3915Print statistics on memory usage, at the end of the run, to
3916standard error.
9f8628ba
PB
3917
3918@item -dp
cd3bb277 3919@opindex dp
74291a4b 3920Annotate the assembler output with a comment indicating which
f20b5577
MM
3921pattern and alternative was used. The length of each instruction is
3922also printed.
9f8628ba
PB
3923
3924@item -dP
cd3bb277 3925@opindex dP
2856c3e3 3926Dump the RTL in the assembler output as a comment before each instruction.
630d3d5a 3927Also turns on @option{-dp} annotation.
9f8628ba
PB
3928
3929@item -dv
cd3bb277 3930@opindex dv
9f8628ba
PB
3931For each of the other indicated dump files (either with @option{-d} or
3932@option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3933graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3934
3935@item -dx
cd3bb277 3936@opindex dx
62a1403d 3937Just generate RTL for a function instead of compiling it. Usually used
9f8628ba
PB
3938with @samp{r} (@option{-fdump-rtl-expand}).
3939
3940@item -dy
cd3bb277 3941@opindex dy
032713aa 3942Dump debugging information during parsing, to standard error.
74291a4b
MM
3943@end table
3944
b707b450 3945@item -fdump-unnumbered
cd3bb277 3946@opindex fdump-unnumbered
695ac33f 3947When doing debugging dumps (see @option{-d} option above), suppress instruction
b707b450 3948numbers and line number note output. This makes it more feasible to
b192711e 3949use diff on debugging dumps for compiler invocations with different
695ac33f 3950options, in particular with and without @option{-g}.
b707b450 3951
223dcf1c
AN
3952@item -fdump-translation-unit @r{(C++ only)}
3953@itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
f70a54cb
CR
3954@opindex fdump-translation-unit
3955Dump a representation of the tree structure for the entire translation
3956unit to a file. The file name is made by appending @file{.tu} to the
3957source file name. If the @samp{-@var{options}} form is used, @var{options}
3958controls the details of the dump as described for the
3959@option{-fdump-tree} options.
3960
aee96fe9 3961@item -fdump-class-hierarchy @r{(C++ only)}
22367161 3962@itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
cd3bb277 3963@opindex fdump-class-hierarchy
e76b4820 3964Dump a representation of each class's hierarchy and virtual function
767094dd 3965table layout to a file. The file name is made by appending @file{.class}
22367161
NS
3966to the source file name. If the @samp{-@var{options}} form is used,
3967@var{options} controls the details of the dump as described for the
3968@option{-fdump-tree} options.
3969
9b3e897d
PB
3970@item -fdump-ipa-@var{switch}
3971@opindex fdump-ipa
83c99486 3972Control the dumping at various stages of inter-procedural analysis
9b3e897d 3973language tree to a file. The file name is generated by appending a switch
8a36672b 3974specific suffix to the source file name. The following dumps are possible:
9b3e897d
PB
3975
3976@table @samp
3977@item all
3978Enables all inter-procedural analysis dumps; currently the only produced
3979dump is the @samp{cgraph} dump.
3980
3981@item cgraph
3982Dumps information about call-graph optimization, unused function removal,
3983and inlining decisions.
3984@end table
3985
0c8c236b
JJ
3986@item -fdump-tree-@var{switch}
3987@itemx -fdump-tree-@var{switch}-@var{options}
22367161
NS
3988@opindex fdump-tree
3989Control the dumping at various stages of processing the intermediate
3990language tree to a file. The file name is generated by appending a switch
3991specific suffix to the source file name. If the @samp{-@var{options}}
3992form is used, @var{options} is a list of @samp{-} separated options that
8a36672b
JM
3993control the details of the dump. Not all options are applicable to all
3994dumps, those which are not meaningful will be ignored. The following
22367161 3995options are available
f71f87f9 3996
e76b4820 3997@table @samp
22367161 3998@item address
767094dd 3999Print the address of each node. Usually this is not meaningful as it
8a36672b 4000changes according to the environment and source file. Its primary use
22367161
NS
4001is for tying up a dump file with a debug environment.
4002@item slim
4003Inhibit dumping of members of a scope or body of a function merely
6de9cd9a
DN
4004because that scope has been reached. Only dump such items when they
4005are directly reachable by some other path. When dumping pretty-printed
4006trees, this option inhibits dumping the bodies of control structures.
4007@item raw
4008Print a raw representation of the tree. By default, trees are
4009pretty-printed into a C-like representation.
4010@item details
4011Enable more detailed dumps (not honored by every dump option).
4012@item stats
4013Enable dumping various statistics about the pass (not honored by every dump
4014option).
4015@item blocks
4016Enable showing basic block boundaries (disabled in raw dumps).
4017@item vops
4018Enable showing virtual operands for every statement.
4019@item lineno
4020Enable showing line numbers for statements.
4021@item uid
4022Enable showing the unique ID (@code{DECL_UID}) for each variable.
22367161 4023@item all
6de9cd9a 4024Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
e76b4820
NS
4025@end table
4026
4027The following tree dumps are possible:
4028@table @samp
6de9cd9a 4029
e76b4820
NS
4030@item original
4031Dump before any tree based optimization, to @file{@var{file}.original}.
6de9cd9a 4032
e76b4820
NS
4033@item optimized
4034Dump after all tree based optimization, to @file{@var{file}.optimized}.
6de9cd9a 4035
6be77748 4036@item inlined
9c34dbbf 4037Dump after function inlining, to @file{@var{file}.inlined}.
6de9cd9a
DN
4038
4039@item gimple
4040@opindex fdump-tree-gimple
4041Dump each function before and after the gimplification pass to a file. The
4042file name is made by appending @file{.gimple} to the source file name.
4043
4044@item cfg
4045@opindex fdump-tree-cfg
4046Dump the control flow graph of each function to a file. The file name is
4047made by appending @file{.cfg} to the source file name.
4048
4049@item vcg
4050@opindex fdump-tree-vcg
4051Dump the control flow graph of each function to a file in VCG format. The
4052file name is made by appending @file{.vcg} to the source file name. Note
4053that if the file contains more than one function, the generated file cannot
8a36672b 4054be used directly by VCG@. You will need to cut and paste each function's
6de9cd9a
DN
4055graph into its own separate file first.
4056
4057@item ch
4058@opindex fdump-tree-ch
4059Dump each function after copying loop headers. The file name is made by
4060appending @file{.ch} to the source file name.
4061
4062@item ssa
4063@opindex fdump-tree-ssa
4064Dump SSA related information to a file. The file name is made by appending
4065@file{.ssa} to the source file name.
4066
c75ab022
DB
4067@item salias
4068@opindex fdump-tree-salias
4069Dump structure aliasing variable information to a file. This file name
4070is made by appending @file{.salias} to the source file name.
4071
6de9cd9a
DN
4072@item alias
4073@opindex fdump-tree-alias
4074Dump aliasing information for each function. The file name is made by
4075appending @file{.alias} to the source file name.
4076
4077@item ccp
4078@opindex fdump-tree-ccp
8a36672b 4079Dump each function after CCP@. The file name is made by appending
6de9cd9a
DN
4080@file{.ccp} to the source file name.
4081
0bca51f0
DN
4082@item storeccp
4083@opindex fdump-tree-storeccp
4084Dump each function after STORE-CCP. The file name is made by appending
4085@file{.storeccp} to the source file name.
4086
6de9cd9a
DN
4087@item pre
4088@opindex fdump-tree-pre
4089Dump trees after partial redundancy elimination. The file name is made
4090by appending @file{.pre} to the source file name.
4091
ff2ad0f7
DN
4092@item fre
4093@opindex fdump-tree-fre
4094Dump trees after full redundancy elimination. The file name is made
4095by appending @file{.fre} to the source file name.
4096
0bca51f0
DN
4097@item copyprop
4098@opindex fdump-tree-copyprop
4099Dump trees after copy propagation. The file name is made
4100by appending @file{.copyprop} to the source file name.
4101
4102@item store_copyprop
4103@opindex fdump-tree-store_copyprop
4104Dump trees after store copy-propagation. The file name is made
4105by appending @file{.store_copyprop} to the source file name.
4106
6de9cd9a
DN
4107@item dce
4108@opindex fdump-tree-dce
4109Dump each function after dead code elimination. The file name is made by
4110appending @file{.dce} to the source file name.
4111
4112@item mudflap
4113@opindex fdump-tree-mudflap
4114Dump each function after adding mudflap instrumentation. The file name is
4115made by appending @file{.mudflap} to the source file name.
4116
4117@item sra
4118@opindex fdump-tree-sra
4119Dump each function after performing scalar replacement of aggregates. The
4120file name is made by appending @file{.sra} to the source file name.
4121
fa555252
DB
4122@item sink
4123@opindex fdump-tree-sink
4124Dump each function after performing code sinking. The file name is made
4125by appending @file{.sink} to the source file name.
4126
6de9cd9a
DN
4127@item dom
4128@opindex fdump-tree-dom
4129Dump each function after applying dominator tree optimizations. The file
4130name is made by appending @file{.dom} to the source file name.
4131
4132@item dse
4133@opindex fdump-tree-dse
4134Dump each function after applying dead store elimination. The file
4135name is made by appending @file{.dse} to the source file name.
4136
4137@item phiopt
4138@opindex fdump-tree-phiopt
4139Dump each function after optimizing PHI nodes into straightline code. The file
4140name is made by appending @file{.phiopt} to the source file name.
4141
4142@item forwprop
4143@opindex fdump-tree-forwprop
4144Dump each function after forward propagating single use variables. The file
4145name is made by appending @file{.forwprop} to the source file name.
4146
4147@item copyrename
4148@opindex fdump-tree-copyrename
4149Dump each function after applying the copy rename optimization. The file
4150name is made by appending @file{.copyrename} to the source file name.
4151
4152@item nrv
4153@opindex fdump-tree-nrv
4154Dump each function after applying the named return value optimization on
4155generic trees. The file name is made by appending @file{.nrv} to the source
4156file name.
4157
79fe1b3b
DN
4158@item vect
4159@opindex fdump-tree-vect
f0eb93a8 4160Dump each function after applying vectorization of loops. The file name is
79fe1b3b
DN
4161made by appending @file{.vect} to the source file name.
4162
08873e96
DN
4163@item vrp
4164@opindex fdump-tree-vrp
4165Dump each function after Value Range Propagation (VRP). The file name
4166is made by appending @file{.vrp} to the source file name.
4167
6de9cd9a
DN
4168@item all
4169@opindex fdump-tree-all
4170Enable all the available tree dumps with the flags provided in this option.
e76b4820 4171@end table
9965d119 4172
c866976a
LB
4173@item -ftree-vectorizer-verbose=@var{n}
4174@opindex ftree-vectorizer-verbose
4175This option controls the amount of debugging output the vectorizer prints.
4176This information is written to standard error, unless @option{-fdump-tree-all}
4177or @option{-fdump-tree-vect} is specified, in which case it is output to the
4178usual dump listing file, @file{.vect}.
4179
a37db56b
GK
4180@item -frandom-seed=@var{string}
4181@opindex frandom-string
4182This option provides a seed that GCC uses when it would otherwise use
e61a2eb7 4183random numbers. It is used to generate certain symbol names
8a36672b 4184that have to be different in every compiled file. It is also used to
e61a2eb7 4185place unique stamps in coverage data files and the object files that
8a36672b 4186produce them. You can use the @option{-frandom-seed} option to produce
e61a2eb7 4187reproducibly identical object files.
a37db56b
GK
4188
4189The @var{string} should be different for every file you compile.
4190
e03b7153
RS
4191@item -fsched-verbose=@var{n}
4192@opindex fsched-verbose
4193On targets that use instruction scheduling, this option controls the
4194amount of debugging output the scheduler prints. This information is
4195written to standard error, unless @option{-dS} or @option{-dR} is
4196specified, in which case it is output to the usual dump
4197listing file, @file{.sched} or @file{.sched2} respectively. However
4198for @var{n} greater than nine, the output is always printed to standard
4199error.
4200
4201For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4202same information as @option{-dRS}. For @var{n} greater than one, it
4203also output basic block probabilities, detailed ready list information
4204and unit/insn info. For @var{n} greater than two, it includes RTL
4205at abort point, control-flow and regions info. And for @var{n} over
4206four, @option{-fsched-verbose} also includes dependence info.
4207
74291a4b 4208@item -save-temps
cd3bb277 4209@opindex save-temps
74291a4b
MM
4210Store the usual ``temporary'' intermediate files permanently; place them
4211in the current directory and name them based on the source file. Thus,
4212compiling @file{foo.c} with @samp{-c -save-temps} would produce files
f2ecb02d
JM
4213@file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
4214preprocessed @file{foo.i} output file even though the compiler now
4215normally uses an integrated preprocessor.
74291a4b 4216
1f7edb8b
RS
4217When used in combination with the @option{-x} command line option,
4218@option{-save-temps} is sensible enough to avoid over writing an
4219input source file with the same extension as an intermediate file.
4220The corresponding intermediate file may be obtained by renaming the
4221source file before using @option{-save-temps}.
4222
03c41c05 4223@item -time
cd3bb277 4224@opindex time
03c41c05 4225Report the CPU time taken by each subprocess in the compilation
f2ecb02d
JM
4226sequence. For C source files, this is the compiler proper and assembler
4227(plus the linker if linking is done). The output looks like this:
03c41c05
ZW
4228
4229@smallexample
03c41c05
ZW
4230# cc1 0.12 0.01
4231# as 0.00 0.01
4232@end smallexample
4233
d78aa55c
JM
4234The first number on each line is the ``user time'', that is time spent
4235executing the program itself. The second number is ``system time'',
03c41c05
ZW
4236time spent executing operating system routines on behalf of the program.
4237Both numbers are in seconds.
4238
014a1138
JZ
4239@item -fvar-tracking
4240@opindex fvar-tracking
8a36672b
JM
4241Run variable tracking pass. It computes where variables are stored at each
4242position in code. Better debugging information is then generated
014a1138
JZ
4243(if the debugging information format supports this information).
4244
4245It is enabled by default when compiling with optimization (@option{-Os},
4246@option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4247the debug info format supports it.
4248
74291a4b 4249@item -print-file-name=@var{library}
cd3bb277 4250@opindex print-file-name
74291a4b
MM
4251Print the full absolute name of the library file @var{library} that
4252would be used when linking---and don't do anything else. With this
0c2d1a2a 4253option, GCC does not compile or link anything; it just prints the
74291a4b
MM
4254file name.
4255
b1018de6
AO
4256@item -print-multi-directory
4257@opindex print-multi-directory
4258Print the directory name corresponding to the multilib selected by any
4259other switches present in the command line. This directory is supposed
4260to exist in @env{GCC_EXEC_PREFIX}.
4261
4262@item -print-multi-lib
4263@opindex print-multi-lib
4264Print the mapping from multilib directory names to compiler switches
4265that enable them. The directory name is separated from the switches by
4266@samp{;}, and each switch starts with an @samp{@@} instead of the
4267@samp{-}, without spaces between multiple switches. This is supposed to
4268ease shell-processing.
4269
74291a4b 4270@item -print-prog-name=@var{program}
cd3bb277 4271@opindex print-prog-name
630d3d5a 4272Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
74291a4b
MM
4273
4274@item -print-libgcc-file-name
cd3bb277 4275@opindex print-libgcc-file-name
630d3d5a 4276Same as @option{-print-file-name=libgcc.a}.
74291a4b 4277
630d3d5a 4278This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
74291a4b
MM
4279but you do want to link with @file{libgcc.a}. You can do
4280
3ab51846 4281@smallexample
74291a4b 4282gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3ab51846 4283@end smallexample
74291a4b
MM
4284
4285@item -print-search-dirs
cd3bb277 4286@opindex print-search-dirs
74291a4b 4287Print the name of the configured installation directory and a list of
2dd76960 4288program and library directories @command{gcc} will search---and don't do anything else.
74291a4b 4289
2dd76960 4290This is useful when @command{gcc} prints the error message
3c0b7970
JM
4291@samp{installation problem, cannot exec cpp0: No such file or directory}.
4292To resolve this you either need to put @file{cpp0} and the other compiler
2dd76960 4293components where @command{gcc} expects to find them, or you can set the environment
bedc7537 4294variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
78466c0e 4295Don't forget the trailing @samp{/}.
74291a4b 4296@xref{Environment Variables}.
1f0c3120
JM
4297
4298@item -dumpmachine
cd3bb277 4299@opindex dumpmachine
1f0c3120
JM
4300Print the compiler's target machine (for example,
4301@samp{i686-pc-linux-gnu})---and don't do anything else.
4302
4303@item -dumpversion
cd3bb277 4304@opindex dumpversion
1f0c3120
JM
4305Print the compiler version (for example, @samp{3.0})---and don't do
4306anything else.
4307
4308@item -dumpspecs
cd3bb277 4309@opindex dumpspecs
1f0c3120
JM
4310Print the compiler's built-in specs---and don't do anything else. (This
4311is used when GCC itself is being built.) @xref{Spec Files}.
73c68f61
SS
4312
4313@item -feliminate-unused-debug-types
4314@opindex feliminate-unused-debug-types
4315Normally, when producing DWARF2 output, GCC will emit debugging
4316information for all types declared in a compilation
4317unit, regardless of whether or not they are actually used
4318in that compilation unit. Sometimes this is useful, such as
4319if, in the debugger, you want to cast a value to a type that is
4320not actually used in your program (but is declared). More often,
4321however, this results in a significant amount of wasted space.
4322With this option, GCC will avoid producing debug symbol output
4323for types that are nowhere used in the source file being compiled.
74291a4b
MM
4324@end table
4325
4326@node Optimize Options
4327@section Options That Control Optimization
4328@cindex optimize options
4329@cindex options, optimization
4330
147d1cd3
JQ
4331These options control various sorts of optimizations.
4332
4333Without any optimization option, the compiler's goal is to reduce the
4334cost of compilation and to make debugging produce the expected
4335results. Statements are independent: if you stop the program with a
4336breakpoint between statements, you can then assign a new value to any
4337variable or change the program counter to any other statement in the
4338function and get exactly the results you would expect from the source
4339code.
4340
4341Turning on optimization flags makes the compiler attempt to improve
4342the performance and/or code size at the expense of compilation time
4343and possibly the ability to debug the program.
4344
a451b0bd 4345The compiler performs optimization based on the knowledge it has of
7797ff53
PB
4346the program. Optimization levels @option{-O2} and above, in
4347particular, enable @emph{unit-at-a-time} mode, which allows the
4348compiler to consider information gained from later functions in
4349the file when compiling a function. Compiling multiple files at
4350once to a single output file in @emph{unit-at-a-time} mode allows
d1bd0ded
GK
4351the compiler to use information gained from all of the files when
4352compiling each of them.
4353
147d1cd3
JQ
4354Not all optimizations are controlled directly by a flag. Only
4355optimizations that have a flag are listed.
74291a4b 4356
2642624b 4357@table @gcctabopt
74291a4b
MM
4358@item -O
4359@itemx -O1
cd3bb277
JM
4360@opindex O
4361@opindex O1
74291a4b
MM
4362Optimize. Optimizing compilation takes somewhat more time, and a lot
4363more memory for a large function.
4364
630d3d5a 4365With @option{-O}, the compiler tries to reduce code size and execution
9c34dbbf
ZW
4366time, without performing any optimizations that take a great deal of
4367compilation time.
74291a4b 4368
daf2f129 4369@option{-O} turns on the following optimization flags:
9a94f7f3 4370@gccoptlist{-fdefer-pop @gol
08711fdf
SB
4371-fdelayed-branch @gol
4372-fguess-branch-probability @gol
4373-fcprop-registers @gol
9a94f7f3 4374-floop-optimize @gol
9a94f7f3
JM
4375-fif-conversion @gol
4376-fif-conversion2 @gol
08711fdf
SB
4377-ftree-ccp @gol
4378-ftree-dce @gol
ec7dea0a 4379-ftree-dominator-opts @gol
08711fdf
SB
4380-ftree-dse @gol
4381-ftree-ter @gol
3c632d89 4382-ftree-lrs @gol
08711fdf
SB
4383-ftree-sra @gol
4384-ftree-copyrename @gol
4385-ftree-fre @gol
4386-ftree-ch @gol
4387-fmerge-constants}
fad893da
JQ
4388
4389@option{-O} also turns on @option{-fomit-frame-pointer} on machines
4390where doing so does not interfere with debugging.
4391
74291a4b 4392@item -O2
cd3bb277 4393@opindex O2
0c2d1a2a 4394Optimize even more. GCC performs nearly all supported optimizations
74291a4b 4395that do not involve a space-speed tradeoff. The compiler does not
630d3d5a
JM
4396perform loop unrolling or function inlining when you specify @option{-O2}.
4397As compared to @option{-O}, this option increases both compilation time
74291a4b
MM
4398and the performance of the generated code.
4399
fad893da
JQ
4400@option{-O2} turns on all optimization flags specified by @option{-O}. It
4401also turns on the following optimization flags:
08711fdf
SB
4402@gccoptlist{-fthread-jumps @gol
4403-fcrossjumping @gol
9a94f7f3 4404-foptimize-sibling-calls @gol
9a94f7f3 4405-fcse-follow-jumps -fcse-skip-blocks @gol
08711fdf 4406-fgcse -fgcse-lm @gol
9a94f7f3 4407-fexpensive-optimizations @gol
08711fdf
SB
4408-fstrength-reduce @gol
4409-frerun-cse-after-loop -frerun-loop-opt @gol
9a94f7f3
JM
4410-fcaller-saves @gol
4411-fpeephole2 @gol
08711fdf
SB
4412-fschedule-insns -fschedule-insns2 @gol
4413-fsched-interblock -fsched-spec @gol
4414-fregmove @gol
9a94f7f3 4415-fstrict-aliasing @gol
08711fdf
SB
4416-fdelete-null-pointer-checks @gol
4417-freorder-blocks -freorder-functions @gol
23a44080 4418-funit-at-a-time @gol
9a94f7f3 4419-falign-functions -falign-jumps @gol
b684a3df 4420-falign-loops -falign-labels @gol
08873e96 4421-ftree-vrp @gol
08711fdf 4422-ftree-pre}
74291a4b 4423
081ca317
BL
4424Please note the warning under @option{-fgcse} about
4425invoking @option{-O2} on programs that use computed gotos.
4426
74291a4b 4427@item -O3
cd3bb277 4428@opindex O3
630d3d5a 4429Optimize yet more. @option{-O3} turns on all optimizations specified by
dafc5b82 4430@option{-O2} and also turns on the @option{-finline-functions},
08711fdf 4431@option{-funswitch-loops} and @option{-fgcse-after-reload} options.
74291a4b
MM
4432
4433@item -O0
cd3bb277 4434@opindex O0
fad893da 4435Do not optimize. This is the default.
74291a4b 4436
c6aded7c 4437@item -Os
cd3bb277 4438@opindex Os
630d3d5a 4439Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
c6aded7c
AG
4440do not typically increase code size. It also performs further
4441optimizations designed to reduce code size.
4442
fad893da 4443@option{-Os} disables the following optimization flags:
9a94f7f3 4444@gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
c12cc930
KB
4445-falign-labels -freorder-blocks -freorder-blocks-and-partition @gol
4446-fprefetch-loop-arrays -ftree-vect-loop-version}
fad893da 4447
630d3d5a 4448If you use multiple @option{-O} options, with or without level numbers,
74291a4b
MM
4449the last such option is the one that is effective.
4450@end table
4451
630d3d5a 4452Options of the form @option{-f@var{flag}} specify machine-independent
74291a4b 4453flags. Most flags have both positive and negative forms; the negative
147d1cd3
JQ
4454form of @option{-ffoo} would be @option{-fno-foo}. In the table
4455below, only one of the forms is listed---the one you typically will
4456use. You can figure out the other form by either removing @samp{no-}
4457or adding it.
4458
4459The following options control specific optimizations. They are either
4460activated by @option{-O} options or are related to ones that are. You
4461can use the following flags in the rare cases when ``fine-tuning'' of
4462optimizations to be performed is desired.
74291a4b 4463
2642624b 4464@table @gcctabopt
74291a4b 4465@item -fno-default-inline
cd3bb277 4466@opindex fno-default-inline
74291a4b
MM
4467Do not make member functions inline by default merely because they are
4468defined inside the class scope (C++ only). Otherwise, when you specify
630d3d5a 4469@w{@option{-O}}, member functions defined inside class scope are compiled
74291a4b
MM
4470inline by default; i.e., you don't need to add @samp{inline} in front of
4471the member function name.
4472
4473@item -fno-defer-pop
cd3bb277 4474@opindex fno-defer-pop
74291a4b
MM
4475Always pop the arguments to each function call as soon as that function
4476returns. For machines which must pop arguments after a function call,
4477the compiler normally lets arguments accumulate on the stack for several
4478function calls and pops them all at once.
4479
38df970e
JQ
4480Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4481
74291a4b 4482@item -fforce-mem
cd3bb277 4483@opindex fforce-mem
74291a4b
MM
4484Force memory operands to be copied into registers before doing
4485arithmetic on them. This produces better code by making all memory
4486references potential common subexpressions. When they are not common
4487subexpressions, instruction combination should eliminate the separate
1d8eeb63 4488register-load. This option is now a nop and will be removed in 4.2.
74291a4b
MM
4489
4490@item -fforce-addr
cd3bb277 4491@opindex fforce-addr
74291a4b 4492Force memory address constants to be copied into registers before
1d8eeb63 4493doing arithmetic on them.
74291a4b
MM
4494
4495@item -fomit-frame-pointer
cd3bb277 4496@opindex fomit-frame-pointer
74291a4b
MM
4497Don't keep the frame pointer in a register for functions that
4498don't need one. This avoids the instructions to save, set up and
4499restore frame pointers; it also makes an extra register available
4500in many functions. @strong{It also makes debugging impossible on
4501some machines.}
4502
8aeea6e6 4503On some machines, such as the VAX, this flag has no effect, because
74291a4b
MM
4504the standard calling sequence automatically handles the frame pointer
4505and nothing is saved by pretending it doesn't exist. The
4506machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4507whether a target machine supports this flag. @xref{Registers,,Register
b11cc610 4508Usage, gccint, GNU Compiler Collection (GCC) Internals}.
74291a4b 4509
38df970e
JQ
4510Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4511
1aaef9c1 4512@item -foptimize-sibling-calls
cd3bb277 4513@opindex foptimize-sibling-calls
1aaef9c1
JH
4514Optimize sibling and tail recursive calls.
4515
38df970e
JQ
4516Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4517
74291a4b 4518@item -fno-inline
cd3bb277 4519@opindex fno-inline
74291a4b
MM
4520Don't pay attention to the @code{inline} keyword. Normally this option
4521is used to keep the compiler from expanding any functions inline.
4522Note that if you are not optimizing, no functions can be expanded inline.
4523
4524@item -finline-functions
cd3bb277 4525@opindex finline-functions
74291a4b
MM
4526Integrate all simple functions into their callers. The compiler
4527heuristically decides which functions are simple enough to be worth
4528integrating in this way.
4529
4530If all calls to a given function are integrated, and the function is
4531declared @code{static}, then the function is normally not output as
4532assembler code in its own right.
4533
38df970e 4534Enabled at level @option{-O3}.
355866de
RG
4535
4536@item -finline-functions-called-once
4537@opindex finline-functions-called-once
4538Consider all @code{static} functions called once for inlining into their
4539caller even if they are not marked @code{inline}. If a call to a given
4540function is integrated, then the function is not output as assembler code
4541in its own right.
4542
4543Enabled if @option{-funit-at-a-time} is enabled.
38df970e 4544
d63db217
JH
4545@item -fearly-inlining
4546@opindex fearly-inlining
4547Inline functions marked by @code{always_inline} and functions whose body seems
4548smaller than the function call overhead early before doing
4549@option{-fprofile-generate} instrumentation and real inlining pass. Doing so
4550makes profiling significantly cheaper and usually inlining faster on programs
4551having large chains of nested wrapper functions.
4552
4553Enabled by default.
4554
efa3896a 4555@item -finline-limit=@var{n}
cd3bb277 4556@opindex finline-limit
2dd76960 4557By default, GCC limits the size of functions that can be inlined. This flag
f9e814f1 4558allows the control of this limit for functions that are explicitly marked as
3364c33b 4559inline (i.e., marked with the inline keyword or defined within the class
02f52e19 4560definition in c++). @var{n} is the size of functions that can be inlined in
f9e814f1 4561number of pseudo instructions (not counting parameter handling). The default
93ee12c4
GP
4562value of @var{n} is 600.
4563Increasing this value can result in more inlined code at
f9e814f1 4564the cost of compilation time and memory consumption. Decreasing usually makes
02f52e19
AJ
4565the compilation faster and less code will be inlined (which presumably
4566means slower programs). This option is particularly useful for programs that
aee96fe9 4567use inlining heavily such as those based on recursive templates with C++.
f9e814f1 4568
bc522472
KG
4569Inlining is actually controlled by a number of parameters, which may be
4570specified individually by using @option{--param @var{name}=@var{value}}.
daf2f129 4571The @option{-finline-limit=@var{n}} option sets some of these parameters
bc522472
KG
4572as follows:
4573
4574@table @gcctabopt
bc522472
KG
4575 @item max-inline-insns-single
4576 is set to @var{n}/2.
6d7fe8b3 4577 @item max-inline-insns-auto
bc522472
KG
4578 is set to @var{n}/2.
4579 @item min-inline-insns
4580 is set to 130 or @var{n}/4, whichever is smaller.
4581 @item max-inline-insns-rtl
4582 is set to @var{n}.
4583@end table
4584
f7a01847 4585See below for a documentation of the individual
bc522472
KG
4586parameters controlling inlining.
4587
f9e814f1 4588@emph{Note:} pseudo instruction represents, in this particular context, an
0fa2e4df 4589abstract measurement of function's size. In no way does it represent a count
f9e814f1
TP
4590of assembly instructions and as such its exact meaning might change from one
4591release to an another.
4592
74291a4b 4593@item -fkeep-inline-functions
cd3bb277 4594@opindex fkeep-inline-functions
1a10290c
MM
4595In C, emit @code{static} functions that are declared @code{inline}
4596into the object file, even if the function has been inlined into all
4597of its callers. This switch does not affect functions using the
8a36672b 4598@code{extern inline} extension in GNU C@. In C++, emit any and all
1a10290c 4599inline functions into the object file.
74291a4b
MM
4600
4601@item -fkeep-static-consts
cd3bb277 4602@opindex fkeep-static-consts
74291a4b
MM
4603Emit variables declared @code{static const} when optimization isn't turned
4604on, even if the variables aren't referenced.
4605
0c2d1a2a 4606GCC enables this option by default. If you want to force the compiler to
74291a4b 4607check if the variable was referenced, regardless of whether or not
630d3d5a 4608optimization is turned on, use the @option{-fno-keep-static-consts} option.
74291a4b 4609
201556f0
JJ
4610@item -fmerge-constants
4611Attempt to merge identical constants (string constants and floating point
3364c33b 4612constants) across compilation units.
201556f0 4613
3364c33b
JQ
4614This option is the default for optimized compilation if the assembler and
4615linker support it. Use @option{-fno-merge-constants} to inhibit this
4616behavior.
201556f0 4617
38df970e
JQ
4618Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4619
201556f0
JJ
4620@item -fmerge-all-constants
4621Attempt to merge identical constants and identical variables.
4622
4623This option implies @option{-fmerge-constants}. In addition to
431ae0bf 4624@option{-fmerge-constants} this considers e.g.@: even constant initialized
201556f0
JJ
4625arrays or initialized constant variables with integral or floating point
4626types. Languages like C or C++ require each non-automatic variable to
4627have distinct location, so using this option will result in non-conforming
c21cd8b1 4628behavior.
201556f0 4629
e5626198
AZ
4630@item -fmodulo-sched
4631@opindex fmodulo-sched
4632Perform swing modulo scheduling immediately before the first scheduling
4633pass. This pass looks at innermost loops and reorders their
4634instructions by overlapping different iterations.
4635
e03b7153
RS
4636@item -fno-branch-count-reg
4637@opindex fno-branch-count-reg
4638Do not use ``decrement and branch'' instructions on a count register,
4639but instead generate a sequence of instructions that decrement a
4640register, compare it against zero, then branch based upon the result.
4641This option is only meaningful on architectures that support such
4642instructions, which include x86, PowerPC, IA-64 and S/390.
4643
38df970e
JQ
4644The default is @option{-fbranch-count-reg}, enabled when
4645@option{-fstrength-reduce} is enabled.
4646
74291a4b 4647@item -fno-function-cse
cd3bb277 4648@opindex fno-function-cse
74291a4b
MM
4649Do not put function addresses in registers; make each instruction that
4650calls a constant function contain the function's address explicitly.
4651
4652This option results in less efficient code, but some strange hacks
4653that alter the assembler output may be confused by the optimizations
4654performed when this option is not used.
4655
38df970e
JQ
4656The default is @option{-ffunction-cse}
4657
27b41650
KG
4658@item -fno-zero-initialized-in-bss
4659@opindex fno-zero-initialized-in-bss
4660If the target supports a BSS section, GCC by default puts variables that
4661are initialized to zero into BSS@. This can save space in the resulting
4662code.
4663
4664This option turns off this behavior because some programs explicitly
4665rely on variables going to the data section. E.g., so that the
4666resulting executable can find the beginning of that section and/or make
4667assumptions based on that.
4668
4669The default is @option{-fzero-initialized-in-bss}.
e03b7153 4670
6de9cd9a
DN
4671@item -fbounds-check
4672@opindex fbounds-check
4673For front-ends that support it, generate additional code to check that
4674indices used to access arrays are within the declared range. This is
4675currently only supported by the Java and Fortran front-ends, where
4676this option defaults to true and false respectively.
4677
4678@item -fmudflap -fmudflapth -fmudflapir
4679@opindex fmudflap
4680@opindex fmudflapth
4681@opindex fmudflapir
4682@cindex bounds checking
4683@cindex mudflap
4684For front-ends that support it (C and C++), instrument all risky
4685pointer/array dereferencing operations, some standard library
4686string/heap functions, and some other associated constructs with
4687range/validity tests. Modules so instrumented should be immune to
4688buffer overflows, invalid heap use, and some other classes of C/C++
4689programming errors. The instrumentation relies on a separate runtime
4690library (@file{libmudflap}), which will be linked into a program if
4691@option{-fmudflap} is given at link time. Run-time behavior of the
4692instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4693environment variable. See @code{env MUDFLAP_OPTIONS=-help a.out}
4694for its options.
4695
4696Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4697link if your program is multi-threaded. Use @option{-fmudflapir}, in
4698addition to @option{-fmudflap} or @option{-fmudflapth}, if
4699instrumentation should ignore pointer reads. This produces less
4700instrumentation (and therefore faster execution) and still provides
4701some protection against outright memory corrupting writes, but allows
4702erroneously read data to propagate within a program.
4703
953ff289
DN
4704@item -fopenmp
4705@opindex fopenmp
4706@cindex openmp parallel
4707Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
4708@code{!$omp} in Fortran. When @option{-fopenmp} is specified, the
4709compiler generates parallel code according to the OpenMP Application
4710Program Interface v2.5. To generate the final exectuable, the runtime
4711library @code{libgomp} must be linked in using @option{-lgomp}.
4712
74291a4b 4713@item -fstrength-reduce
cd3bb277 4714@opindex fstrength-reduce
74291a4b
MM
4715Perform the optimizations of loop strength reduction and
4716elimination of iteration variables.
4717
38df970e
JQ
4718Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4719
74291a4b 4720@item -fthread-jumps
cd3bb277 4721@opindex fthread-jumps
74291a4b
MM
4722Perform optimizations where we check to see if a jump branches to a
4723location where another comparison subsumed by the first is found. If
4724so, the first branch is redirected to either the destination of the
4725second branch or a point immediately following it, depending on whether
4726the condition is known to be true or false.
4727
08711fdf 4728Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
38df970e 4729
74291a4b 4730@item -fcse-follow-jumps
cd3bb277 4731@opindex fcse-follow-jumps
74291a4b
MM
4732In common subexpression elimination, scan through jump instructions
4733when the target of the jump is not reached by any other path. For
4734example, when CSE encounters an @code{if} statement with an
4735@code{else} clause, CSE will follow the jump when the condition
4736tested is false.
4737
38df970e
JQ
4738Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4739
74291a4b 4740@item -fcse-skip-blocks
cd3bb277 4741@opindex fcse-skip-blocks
630d3d5a 4742This is similar to @option{-fcse-follow-jumps}, but causes CSE to
74291a4b
MM
4743follow jumps which conditionally skip over blocks. When CSE
4744encounters a simple @code{if} statement with no else clause,
630d3d5a 4745@option{-fcse-skip-blocks} causes CSE to follow the jump around the
74291a4b
MM
4746body of the @code{if}.
4747
38df970e
JQ
4748Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4749
74291a4b 4750@item -frerun-cse-after-loop
cd3bb277 4751@opindex frerun-cse-after-loop
74291a4b
MM
4752Re-run common subexpression elimination after loop optimizations has been
4753performed.
4754
38df970e
JQ
4755Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4756
6d6d0fa0 4757@item -frerun-loop-opt
cd3bb277 4758@opindex frerun-loop-opt
6d6d0fa0
JL
4759Run the loop optimizer twice.
4760
38df970e
JQ
4761Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4762
7506f491 4763@item -fgcse
cd3bb277 4764@opindex fgcse
7506f491
DE
4765Perform a global common subexpression elimination pass.
4766This pass also performs global constant and copy propagation.
4767
081ca317
BL
4768@emph{Note:} When compiling a program using computed gotos, a GCC
4769extension, you may get better runtime performance if you disable
3364c33b 4770the global common subexpression elimination pass by adding
081ca317
BL
4771@option{-fno-gcse} to the command line.
4772
38df970e
JQ
4773Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4774
a13d4ebf 4775@item -fgcse-lm
cd3bb277 4776@opindex fgcse-lm
695ac33f 4777When @option{-fgcse-lm} is enabled, global common subexpression elimination will
767094dd 4778attempt to move loads which are only killed by stores into themselves. This
a13d4ebf 4779allows a loop containing a load/store sequence to be changed to a load outside
02f52e19 4780the loop, and a copy/store within the loop.
a13d4ebf 4781
38df970e
JQ
4782Enabled by default when gcse is enabled.
4783
a13d4ebf 4784@item -fgcse-sm
cd3bb277 4785@opindex fgcse-sm
f5f2e3cd
MH
4786When @option{-fgcse-sm} is enabled, a store motion pass is run after
4787global common subexpression elimination. This pass will attempt to move
4788stores out of loops. When used in conjunction with @option{-fgcse-lm},
4789loops containing a load/store sequence can be changed to a load before
4790the loop and a store after the loop.
4791
08711fdf 4792Not enabled at any optimization level.
f5f2e3cd
MH
4793
4794@item -fgcse-las
4795@opindex fgcse-las
4796When @option{-fgcse-las} is enabled, the global common subexpression
4797elimination pass eliminates redundant loads that come after stores to the
2206e783 4798same memory location (both partial and full redundancies).
a13d4ebf 4799
08711fdf 4800Not enabled at any optimization level.
38df970e 4801
db643b91
SH
4802@item -fgcse-after-reload
4803@opindex fgcse-after-reload
4804When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8a36672b 4805pass is performed after reload. The purpose of this pass is to cleanup
db643b91
SH
4806redundant spilling.
4807
96327cdc
JH
4808@item -floop-optimize
4809@opindex floop-optimize
4810Perform loop optimizations: move constant expressions out of loops, simplify
c94583fe 4811exit test conditions and optionally do strength-reduction as well.
96327cdc 4812
38df970e
JQ
4813Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4814
5e962776
ZD
4815@item -floop-optimize2
4816@opindex floop-optimize2
4817Perform loop optimizations using the new loop optimizer. The optimizations
4818(loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4819by separate flags.
4820
f9cc1a70
PB
4821@item -funsafe-loop-optimizations
4822@opindex funsafe-loop-optimizations
4823If given, the loop optimizer will assume that loop indices do not
4824overflow, and that the loops with nontrivial exit condition are not
4825infinite. This enables a wider range of loop optimizations even if
4826the loop optimizer itself cannot prove that these assumptions are valid.
4827Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4828if it finds this kind of loop.
4829
96327cdc
JH
4830@item -fcrossjumping
4831@opindex crossjumping
8a36672b 4832Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
96327cdc
JH
4833resulting code may or may not perform better than without cross-jumping.
4834
53071270 4835Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
38df970e 4836
2c4b77f3
JH
4837@item -fif-conversion
4838@opindex if-conversion
4839Attempt to transform conditional jumps into branch-less equivalents. This
4840include use of conditional moves, min, max, set flags and abs instructions, and
4841some tricks doable by standard arithmetics. The use of conditional execution
4842on chips where it is available is controlled by @code{if-conversion2}.
4843
38df970e
JQ
4844Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4845
2c4b77f3
JH
4846@item -fif-conversion2
4847@opindex if-conversion2
4848Use conditional execution (where available) to transform conditional jumps into
4849branch-less equivalents.
4850
38df970e
JQ
4851Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4852
b6d24183 4853@item -fdelete-null-pointer-checks
cd3bb277 4854@opindex fdelete-null-pointer-checks
9c34dbbf
ZW
4855Use global dataflow analysis to identify and eliminate useless checks
4856for null pointers. The compiler assumes that dereferencing a null
4857pointer would have halted the program. If a pointer is checked after
4858it has already been dereferenced, it cannot be null.
4859
4860In some environments, this assumption is not true, and programs can
4861safely dereference null pointers. Use
4862@option{-fno-delete-null-pointer-checks} to disable this optimization
4863for programs which depend on that behavior.
b6d24183 4864
38df970e
JQ
4865Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4866
74291a4b 4867@item -fexpensive-optimizations
cd3bb277 4868@opindex fexpensive-optimizations
74291a4b
MM
4869Perform a number of minor optimizations that are relatively expensive.
4870
38df970e
JQ
4871Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4872
639726ba 4873@item -foptimize-register-move
59d40964 4874@itemx -fregmove
cd3bb277
JM
4875@opindex foptimize-register-move
4876@opindex fregmove
9ec36da5
JL
4877Attempt to reassign register numbers in move instructions and as
4878operands of other simple instructions in order to maximize the amount of
56159047 4879register tying. This is especially helpful on machines with two-operand
38df970e 4880instructions.
9ec36da5 4881
bedc7537 4882Note @option{-fregmove} and @option{-foptimize-register-move} are the same
9ec36da5
JL
4883optimization.
4884
38df970e
JQ
4885Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4886
74291a4b 4887@item -fdelayed-branch
cd3bb277 4888@opindex fdelayed-branch
74291a4b
MM
4889If supported for the target machine, attempt to reorder instructions
4890to exploit instruction slots available after delayed branch
4891instructions.
4892
38df970e
JQ
4893Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4894
74291a4b 4895@item -fschedule-insns
cd3bb277 4896@opindex fschedule-insns
74291a4b
MM
4897If supported for the target machine, attempt to reorder instructions to
4898eliminate execution stalls due to required data being unavailable. This
4899helps machines that have slow floating point or memory load instructions
4900by allowing other instructions to be issued until the result of the load
4901or floating point instruction is required.
4902
38df970e
JQ
4903Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4904
74291a4b 4905@item -fschedule-insns2
cd3bb277 4906@opindex fschedule-insns2
630d3d5a 4907Similar to @option{-fschedule-insns}, but requests an additional pass of
74291a4b
MM
4908instruction scheduling after register allocation has been done. This is
4909especially useful on machines with a relatively small number of
4910registers and where memory load instructions take more than one cycle.
4911
38df970e
JQ
4912Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4913
e03b7153
RS
4914@item -fno-sched-interblock
4915@opindex fno-sched-interblock
4916Don't schedule instructions across basic blocks. This is normally
4917enabled by default when scheduling before register allocation, i.e.@:
4918with @option{-fschedule-insns} or at @option{-O2} or higher.
4919
4920@item -fno-sched-spec
4921@opindex fno-sched-spec
4922Don't allow speculative motion of non-load instructions. This is normally
4923enabled by default when scheduling before register allocation, i.e.@:
4924with @option{-fschedule-insns} or at @option{-O2} or higher.
4925
4926@item -fsched-spec-load
4927@opindex fsched-spec-load
4928Allow speculative motion of some load instructions. This only makes
4929sense when scheduling before register allocation, i.e.@: with
4930@option{-fschedule-insns} or at @option{-O2} or higher.
4931
4932@item -fsched-spec-load-dangerous
4933@opindex fsched-spec-load-dangerous
4934Allow speculative motion of more load instructions. This only makes
4935sense when scheduling before register allocation, i.e.@: with
4936@option{-fschedule-insns} or at @option{-O2} or higher.
4937
569fa502
DN
4938@item -fsched-stalled-insns=@var{n}
4939@opindex fsched-stalled-insns
4940Define how many insns (if any) can be moved prematurely from the queue
4941of stalled insns into the ready list, during the second scheduling pass.
4942
4943@item -fsched-stalled-insns-dep=@var{n}
4944@opindex fsched-stalled-insns-dep
daf2f129
JM
4945Define how many insn groups (cycles) will be examined for a dependency
4946on a stalled insn that is candidate for premature removal from the queue
4947of stalled insns. Has an effect only during the second scheduling pass,
569fa502
DN
4948and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4949
b9422b69
JH
4950@item -fsched2-use-superblocks
4951@opindex fsched2-use-superblocks
61aeb06f 4952When scheduling after register allocation, do use superblock scheduling
62b9c42c 4953algorithm. Superblock scheduling allows motion across basic block boundaries
b9422b69 4954resulting on faster schedules. This option is experimental, as not all machine
62b9c42c 4955descriptions used by GCC model the CPU closely enough to avoid unreliable
daf2f129 4956results from the algorithm.
b9422b69
JH
4957
4958This only makes sense when scheduling after register allocation, i.e.@: with
4959@option{-fschedule-insns2} or at @option{-O2} or higher.
4960
4961@item -fsched2-use-traces
4962@opindex fsched2-use-traces
4963Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4964allocation and additionally perform code duplication in order to increase the
4965size of superblocks using tracer pass. See @option{-ftracer} for details on
4966trace formation.
4967
62b9c42c 4968This mode should produce faster but significantly longer programs. Also
4ec7afd7
KH
4969without @option{-fbranch-probabilities} the traces constructed may not
4970match the reality and hurt the performance. This only makes
b9422b69
JH
4971sense when scheduling after register allocation, i.e.@: with
4972@option{-fschedule-insns2} or at @option{-O2} or higher.
4973
d72372e4
MH
4974@item -freschedule-modulo-scheduled-loops
4975@opindex fscheduling-in-modulo-scheduled-loops
4976The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4977we may want to prevent the later scheduling passes from changing its schedule, we use this
4978option to control that.
4979
74291a4b 4980@item -fcaller-saves
cd3bb277 4981@opindex fcaller-saves
74291a4b
MM
4982Enable values to be allocated in registers that will be clobbered by
4983function calls, by emitting extra instructions to save and restore the
4984registers around such calls. Such allocation is done only when it
4985seems to result in better code than would otherwise be produced.
4986
81610a0d
HPN
4987This option is always enabled by default on certain machines, usually
4988those which have no call-preserved registers to use instead.
4989
38df970e 4990Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
74291a4b 4991
6de9cd9a
DN
4992@item -ftree-pre
4993Perform Partial Redundancy Elimination (PRE) on trees. This flag is
08711fdf 4994enabled by default at @option{-O2} and @option{-O3}.
ff2ad0f7
DN
4995
4996@item -ftree-fre
4997Perform Full Redundancy Elimination (FRE) on trees. The difference
4998between FRE and PRE is that FRE only considers expressions
4999that are computed on all paths leading to the redundant computation.
5000This analysis faster than PRE, though it exposes fewer redundancies.
4ec7afd7 5001This flag is enabled by default at @option{-O} and higher.
6de9cd9a 5002
0bca51f0
DN
5003@item -ftree-copy-prop
5004Perform copy propagation on trees. This pass eliminates unnecessary
5005copy operations. This flag is enabled by default at @option{-O} and
5006higher.
5007
5008@item -ftree-store-copy-prop
5009Perform copy propagation of memory loads and stores. This pass
5010eliminates unnecessary copy operations in memory references
5011(structures, global variables, arrays, etc). This flag is enabled by
5012default at @option{-O2} and higher.
5013
c75ab022
DB
5014@item -ftree-salias
5015Perform structural alias analysis on trees. This flag
5016is enabled by default at @option{-O} and higher.
5017
fa555252
DB
5018@item -ftree-sink
5019Perform forward store motion on trees. This flag is
5020enabled by default at @option{-O} and higher.
5021
6de9cd9a 5022@item -ftree-ccp
0bca51f0
DN
5023Perform sparse conditional constant propagation (CCP) on trees. This
5024pass only operates on local scalar variables and is enabled by default
5025at @option{-O} and higher.
5026
5027@item -ftree-store-ccp
5028Perform sparse conditional constant propagation (CCP) on trees. This
5029pass operates on both local scalar variables and memory stores and
5030loads (global variables, structures, arrays, etc). This flag is
5031enabled by default at @option{-O2} and higher.
6de9cd9a
DN
5032
5033@item -ftree-dce
5034Perform dead code elimination (DCE) on trees. This flag is enabled by
4ec7afd7 5035default at @option{-O} and higher.
6de9cd9a
DN
5036
5037@item -ftree-dominator-opts
5c1c631e
DN
5038Perform a variety of simple scalar cleanups (constant/copy
5039propagation, redundancy elimination, range propagation and expression
5040simplification) based on a dominator tree traversal. This also
5041performs jump threading (to reduce jumps to jumps). This flag is
5042enabled by default at @option{-O} and higher.
6de9cd9a
DN
5043
5044@item -ftree-ch
5045Perform loop header copying on trees. This is beneficial since it increases
83c99486 5046effectiveness of code motion optimizations. It also saves one jump. This flag
4ec7afd7
KH
5047is enabled by default at @option{-O} and higher. It is not enabled
5048for @option{-Os}, since it usually increases code size.
6de9cd9a 5049
c66b6c66 5050@item -ftree-loop-optimize
4ec7afd7
KH
5051Perform loop optimizations on trees. This flag is enabled by default
5052at @option{-O} and higher.
c66b6c66 5053
599eabdb 5054@item -ftree-loop-linear
8a36672b 5055Perform linear loop transformations on tree. This flag can improve cache
599eabdb
DB
5056performance and allow further loop optimizations to take place.
5057
3450cbc4
DJ
5058@item -ftree-loop-im
5059Perform loop invariant motion on trees. This pass moves only invariants that
ec7dea0a 5060would be hard to handle at RTL level (function calls, operations that expand to
a7e5372d
ZD
5061nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
5062operands of conditions that are invariant out of the loop, so that we can use
5063just trivial invariantness analysis in loop unswitching. The pass also includes
5064store motion.
5065
3450cbc4 5066@item -ftree-loop-ivcanon
82b85a85
ZD
5067Create a canonical counter for number of iterations in the loop for that
5068determining number of iterations requires complicated analysis. Later
5069optimizations then may determine the number easily. Useful especially
5070in connection with unrolling.
5071
8b11a64c
ZD
5072@item -fivopts
5073Perform induction variable optimizations (strength reduction, induction
5074variable merging and induction variable elimination) on trees.
5075
6de9cd9a
DN
5076@item -ftree-sra
5077Perform scalar replacement of aggregates. This pass replaces structure
5078references with scalars to prevent committing structures to memory too
4ec7afd7 5079early. This flag is enabled by default at @option{-O} and higher.
6de9cd9a
DN
5080
5081@item -ftree-copyrename
f26c1794
EC
5082Perform copy renaming on trees. This pass attempts to rename compiler
5083temporaries to other variables at copy locations, usually resulting in
5084variable names which more closely resemble the original variables. This flag
4ec7afd7 5085is enabled by default at @option{-O} and higher.
6de9cd9a
DN
5086
5087@item -ftree-ter
5088Perform temporary expression replacement during the SSA->normal phase. Single
f26c1794
EC
5089use/single def temporaries are replaced at their use location with their
5090defining expression. This results in non-GIMPLE code, but gives the expanders
6de9cd9a 5091much more complex trees to work on resulting in better RTL generation. This is
4ec7afd7 5092enabled by default at @option{-O} and higher.
6de9cd9a
DN
5093
5094@item -ftree-lrs
f26c1794
EC
5095Perform live range splitting during the SSA->normal phase. Distinct live
5096ranges of a variable are split into unique variables, allowing for better
4ec7afd7 5097optimization later. This is enabled by default at @option{-O} and higher.
6de9cd9a 5098
79fe1b3b
DN
5099@item -ftree-vectorize
5100Perform loop vectorization on trees.
5101
c12cc930
KB
5102@item -ftree-vect-loop-version
5103@opindex ftree-vect-loop-version
5104Perform loop versioning when doing loop vectorization on trees. When a loop
5105appears to be vectorizable except that data alignment or data dependence cannot
5106be determined at compile time then vectorized and non-vectorized versions of
5107the loop are generated along with runtime checks for alignment or dependence
5108to control which version is executed. This option is enabled by default
5109except at level @option{-Os} where it is disabled.
5110
08873e96
DN
5111@item -ftree-vrp
5112Perform Value Range Propagation on trees. This is similar to the
5113constant propagation pass, but instead of values, ranges of values are
5114propagated. This allows the optimizers to remove unnecessary range
5115checks like array bound checks and null pointer checks. This is
5116enabled by default at @option{-O2} and higher. Null pointer check
5117elimination is only done if @option{-fdelete-null-pointer-checks} is
5118enabled.
5119
6de9cd9a
DN
5120@item -ftracer
5121@opindex ftracer
8a36672b 5122Perform tail duplication to enlarge superblock size. This transformation
6de9cd9a
DN
5123simplifies the control flow of the function allowing other optimizations to do
5124better job.
5125
5126@item -funroll-loops
5127@opindex funroll-loops
5128Unroll loops whose number of iterations can be determined at compile
5129time or upon entry to the loop. @option{-funroll-loops} implies both
5130@option{-fstrength-reduce} and @option{-frerun-cse-after-loop}. This
5131option makes code larger, and may or may not make it run faster.
5132
5133@item -funroll-all-loops
5134@opindex funroll-all-loops
5135Unroll all loops, even if their number of iterations is uncertain when
5136the loop is entered. This usually makes programs run more slowly.
5137@option{-funroll-all-loops} implies the same options as
5138@option{-funroll-loops},
5139
113d659a
ZD
5140@item -fsplit-ivs-in-unroller
5141@opindex -fsplit-ivs-in-unroller
5142Enables expressing of values of induction variables in later iterations
5143of the unrolled loop using the value in the first iteration. This breaks
7869fe47 5144long dependency chains, thus improving efficiency of the scheduling passes.
113d659a
ZD
5145
5146Combination of @option{-fweb} and CSE is often sufficient to obtain the
8a36672b 5147same effect. However in cases the loop body is more complicated than
113d659a
ZD
5148a single basic block, this is not reliable. It also does not work at all
5149on some of the architectures due to restrictions in the CSE pass.
5150
5151This optimization is enabled by default.
5152
f37a4f14
RE
5153@item -fvariable-expansion-in-unroller
5154@opindex -fvariable-expansion-in-unroller
f0eb93a8 5155With this option, the compiler will create multiple copies of some
f37a4f14
RE
5156local variables when unrolling a loop which can result in superior code.
5157
6de9cd9a
DN
5158@item -fprefetch-loop-arrays
5159@opindex fprefetch-loop-arrays
5160If supported by the target machine, generate instructions to prefetch
5161memory to improve the performance of loops that access large arrays.
5162
e5eb27e5
JL
5163These options may generate better or worse code; results are highly
5164dependent on the structure of loops within the source code.
5165
74291a4b 5166@item -fno-peephole
6cfc0341 5167@itemx -fno-peephole2
cd3bb277 5168@opindex fno-peephole
6cfc0341
RH
5169@opindex fno-peephole2
5170Disable any machine-specific peephole optimizations. The difference
630d3d5a 5171between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6cfc0341
RH
5172are implemented in the compiler; some targets use one, some use the
5173other, a few use both.
861bb6c1 5174
38df970e
JQ
5175@option{-fpeephole} is enabled by default.
5176@option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5177
454d0cc7 5178@item -fno-guess-branch-probability
cd3bb277 5179@opindex fno-guess-branch-probability
ddd8e3ca
JW
5180Do not guess branch probabilities using heuristics.
5181
5182GCC will use heuristics to guess branch probabilities if they are
5183not provided by profiling feedback (@option{-fprofile-arcs}). These
5184heuristics are based on the control flow graph. If some branch probabilities
5185are specified by @samp{__builtin_expect}, then the heuristics will be
5186used to guess branch probabilities for the rest of the control flow graph,
5187taking the @samp{__builtin_expect} info into account. The interactions
5188between the heuristics and @samp{__builtin_expect} can be complex, and in
5189some cases, it may be useful to disable the heuristics so that the effects
5190of @samp{__builtin_expect} are easier to understand.
454d0cc7 5191
38df970e
JQ
5192The default is @option{-fguess-branch-probability} at levels
5193@option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5194
194734e9
JH
5195@item -freorder-blocks
5196@opindex freorder-blocks
5197Reorder basic blocks in the compiled function in order to reduce number of
5198taken branches and improve code locality.
5199
3f8b659d 5200Enabled at levels @option{-O2}, @option{-O3}.
38df970e 5201
750054a2
CT
5202@item -freorder-blocks-and-partition
5203@opindex freorder-blocks-and-partition
5204In addition to reordering basic blocks in the compiled function, in order
5205to reduce number of taken branches, partitions hot and cold basic blocks
5206into separate sections of the assembly and .o files, to improve
5207paging and cache locality performance.
5208
8e8d5162
CT
5209This optimization is automatically turned off in the presence of
5210exception handling, for linkonce sections, for functions with a user-defined
5211section attribute and on any architecture that does not support named
5212sections.
5213
194734e9
JH
5214@item -freorder-functions
5215@opindex freorder-functions
3e8cb558
JM
5216Reorder functions in the object file in order to
5217improve code locality. This is implemented by using special
3a4bdd05
RH
5218subsections @code{.text.hot} for most frequently executed functions and
5219@code{.text.unlikely} for unlikely executed functions. Reordering is done by
194734e9 5220the linker so object file format must support named sections and linker must
3364c33b 5221place them in a reasonable way.
194734e9
JH
5222
5223Also profile feedback must be available in to make this option effective. See
5224@option{-fprofile-arcs} for details.
5225
38df970e
JQ
5226Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5227
41472af8 5228@item -fstrict-aliasing
cd3bb277 5229@opindex fstrict-aliasing
41472af8
MM
5230Allows the compiler to assume the strictest aliasing rules applicable to
5231the language being compiled. For C (and C++), this activates
5232optimizations based on the type of expressions. In particular, an
5233object of one type is assumed never to reside at the same address as an
5234object of a different type, unless the types are almost the same. For
5235example, an @code{unsigned int} can alias an @code{int}, but not a
5236@code{void*} or a @code{double}. A character type may alias any other
02f52e19 5237type.
41472af8
MM
5238
5239Pay special attention to code like this:
3ab51846 5240@smallexample
02f52e19 5241union a_union @{
41472af8
MM
5242 int i;
5243 double d;
5244@};
5245
5246int f() @{
5247 a_union t;
5248 t.d = 3.0;
5249 return t.i;
5250@}
3ab51846 5251@end smallexample
41472af8
MM
5252The practice of reading from a different union member than the one most
5253recently written to (called ``type-punning'') is common. Even with
630d3d5a 5254@option{-fstrict-aliasing}, type-punning is allowed, provided the memory
41472af8
MM
5255is accessed through the union type. So, the code above will work as
5256expected. However, this code might not:
3ab51846 5257@smallexample
02f52e19 5258int f() @{
41472af8
MM
5259 a_union t;
5260 int* ip;
5261 t.d = 3.0;
5262 ip = &t.i;
5263 return *ip;
5264@}
3ab51846 5265@end smallexample
41472af8 5266
41472af8
MM
5267Every language that wishes to perform language-specific alias analysis
5268should define a function that computes, given an @code{tree}
5269node, an alias set for the node. Nodes in different alias sets are not
5270allowed to alias. For an example, see the C front-end function
5271@code{c_get_alias_set}.
41472af8 5272
38df970e 5273Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
852b81bb 5274
efa3896a
GK
5275@item -falign-functions
5276@itemx -falign-functions=@var{n}
cd3bb277 5277@opindex falign-functions
efa3896a
GK
5278Align the start of functions to the next power-of-two greater than
5279@var{n}, skipping up to @var{n} bytes. For instance,
630d3d5a
JM
5280@option{-falign-functions=32} aligns functions to the next 32-byte
5281boundary, but @option{-falign-functions=24} would align to the next
efa3896a
GK
528232-byte boundary only if this can be done by skipping 23 bytes or less.
5283
630d3d5a 5284@option{-fno-align-functions} and @option{-falign-functions=1} are
efa3896a
GK
5285equivalent and mean that functions will not be aligned.
5286
5287Some assemblers only support this flag when @var{n} is a power of two;
5288in that case, it is rounded up.
5289
561913cb 5290If @var{n} is not specified or is zero, use a machine-dependent default.
efa3896a 5291
38df970e
JQ
5292Enabled at levels @option{-O2}, @option{-O3}.
5293
efa3896a
GK
5294@item -falign-labels
5295@itemx -falign-labels=@var{n}
cd3bb277 5296@opindex falign-labels
efa3896a 5297Align all branch targets to a power-of-two boundary, skipping up to
630d3d5a 5298@var{n} bytes like @option{-falign-functions}. This option can easily
efa3896a
GK
5299make code slower, because it must insert dummy operations for when the
5300branch target is reached in the usual flow of the code.
5301
561913cb
AP
5302@option{-fno-align-labels} and @option{-falign-labels=1} are
5303equivalent and mean that labels will not be aligned.
5304
630d3d5a 5305If @option{-falign-loops} or @option{-falign-jumps} are applicable and
efa3896a
GK
5306are greater than this value, then their values are used instead.
5307
561913cb
AP
5308If @var{n} is not specified or is zero, use a machine-dependent default
5309which is very likely to be @samp{1}, meaning no alignment.
efa3896a 5310
38df970e
JQ
5311Enabled at levels @option{-O2}, @option{-O3}.
5312
efa3896a
GK
5313@item -falign-loops
5314@itemx -falign-loops=@var{n}
cd3bb277 5315@opindex falign-loops
efa3896a 5316Align loops to a power-of-two boundary, skipping up to @var{n} bytes
630d3d5a 5317like @option{-falign-functions}. The hope is that the loop will be
efa3896a
GK
5318executed many times, which will make up for any execution of the dummy
5319operations.
5320
561913cb
AP
5321@option{-fno-align-loops} and @option{-falign-loops=1} are
5322equivalent and mean that loops will not be aligned.
5323
5324If @var{n} is not specified or is zero, use a machine-dependent default.
efa3896a 5325
38df970e
JQ
5326Enabled at levels @option{-O2}, @option{-O3}.
5327
efa3896a
GK
5328@item -falign-jumps
5329@itemx -falign-jumps=@var{n}
cd3bb277 5330@opindex falign-jumps
efa3896a
GK
5331Align branch targets to a power-of-two boundary, for branch targets
5332where the targets can only be reached by jumping, skipping up to @var{n}
630d3d5a 5333bytes like @option{-falign-functions}. In this case, no dummy operations
efa3896a
GK
5334need be executed.
5335
561913cb
AP
5336@option{-fno-align-jumps} and @option{-falign-jumps=1} are
5337equivalent and mean that loops will not be aligned.
5338
5339If @var{n} is not specified or is zero, use a machine-dependent default.
efa3896a 5340
38df970e
JQ
5341Enabled at levels @option{-O2}, @option{-O3}.
5342
7797ff53
PB
5343@item -funit-at-a-time
5344@opindex funit-at-a-time
5345Parse the whole compilation unit before starting to produce code.
5346This allows some extra optimizations to take place but consumes
5347more memory (in general). There are some compatibility issues
474eccc6 5348with @emph{unit-at-a-time} mode:
7797ff53
PB
5349@itemize @bullet
5350@item
5351enabling @emph{unit-at-a-time} mode may change the order
5352in which functions, variables, and top-level @code{asm} statements
5353are emitted, and will likely break code relying on some particular
5354ordering. The majority of such top-level @code{asm} statements,
474eccc6
ILT
5355though, can be replaced by @code{section} attributes. The
5356@option{fno-toplevel-reorder} option may be used to keep the ordering
5357used in the input file, at the cost of some optimizations.
7797ff53
PB
5358
5359@item
5360@emph{unit-at-a-time} mode removes unreferenced static variables
60d436c9 5361and functions. This may result in undefined references
7797ff53
PB
5362when an @code{asm} statement refers directly to variables or functions
5363that are otherwise unused. In that case either the variable/function
5364shall be listed as an operand of the @code{asm} statement operand or,
5365in the case of top-level @code{asm} statements the attribute @code{used}
5366shall be used on the declaration.
5367
5368@item
5369Static functions now can use non-standard passing conventions that
8a36672b 5370may break @code{asm} statements calling functions directly. Again,
7797ff53
PB
5371attribute @code{used} will prevent this behavior.
5372@end itemize
5373
5374As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
8a36672b 5375but this scheme may not be supported by future releases of GCC@.
7797ff53
PB
5376
5377Enabled at levels @option{-O2}, @option{-O3}.
5378
474eccc6
ILT
5379@item -fno-toplevel-reorder
5380Do not reorder top-level functions, variables, and @code{asm}
5381statements. Output them in the same order that they appear in the
5382input file. When this option is used, unreferenced static variables
5383will not be removed. This option is intended to support existing code
5384which relies on a particular ordering. For new code, it is better to
5385use attributes.
5386
7260e9a0
JH
5387@item -fweb
5388@opindex fweb
5389Constructs webs as commonly used for register allocation purposes and assign
962e6e00 5390each web individual pseudo register. This allows the register allocation pass
7260e9a0
JH
5391to operate on pseudos directly, but also strengthens several other optimization
5392passes, such as CSE, loop optimizer and trivial dead code remover. It can,
5393however, make debugging impossible, since variables will no longer stay in a
5394``home register''.
5395
7869fe47 5396Enabled by default with @option{-funroll-loops}.
d4463dfc 5397
ce91e74c
JH
5398@item -fwhole-program
5399@opindex fwhole-program
5400Assume that the current compilation unit represents whole program being
5401compiled. All public functions and variables with the exception of @code{main}
f341de7b
KH
5402and those merged by attribute @code{externally_visible} become static functions
5403and in a affect gets more aggressively optimized by interprocedural optimizers.
ce91e74c 5404While this option is equivalent to proper use of @code{static} keyword for
f341de7b 5405programs consisting of single file, in combination with option
ce91e74c
JH
5406@option{--combine} this flag can be used to compile most of smaller scale C
5407programs since the functions and variables become local for the whole combined
5408compilation unit, not for the single source file itself.
5409
5410
d4463dfc
JQ
5411@item -fno-cprop-registers
5412@opindex fno-cprop-registers
5413After register allocation and post-register allocation instruction splitting,
5414we perform a copy-propagation pass to try to reduce scheduling dependencies
5415and occasionally eliminate the copy.
5416
5417Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5418
a8a5f53a
JH
5419@item -fprofile-generate
5420@opindex fprofile-generate
a8a5f53a 5421
33adcb6c
MM
5422Enable options usually used for instrumenting application to produce
5423profile useful for later recompilation with profile feedback based
4ec7afd7 5424optimization. You must use @option{-fprofile-generate} both when
33adcb6c
MM
5425compiling and when linking your program.
5426
5427The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
a8a5f53a
JH
5428
5429@item -fprofile-use
5430@opindex fprofile-use
5431Enable profile feedback directed optimizations, and optimizations
5432generally profitable only with profile feedback available.
5433
8a76829c
JH
5434The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5435@code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5436@code{-fno-loop-optimize}.
a8a5f53a 5437
d4463dfc
JQ
5438@end table
5439
5440The following options control compiler behavior regarding floating
5441point arithmetic. These options trade off between speed and
5442correctness. All must be specifically enabled.
5443
5444@table @gcctabopt
5445@item -ffloat-store
5446@opindex ffloat-store
5447Do not store floating point variables in registers, and inhibit other
5448options that might change whether a floating point value is taken from a
5449register or memory.
5450
5451@cindex floating point precision
5452This option prevents undesirable excess precision on machines such as
5453the 68000 where the floating registers (of the 68881) keep more
5454precision than a @code{double} is supposed to have. Similarly for the
5455x86 architecture. For most programs, the excess precision does only
5456good, but a few programs rely on the precise definition of IEEE floating
5457point. Use @option{-ffloat-store} for such programs, after modifying
5458them to store all pertinent intermediate computations into variables.
5459
5460@item -ffast-math
5461@opindex ffast-math
5462Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
039c3d42 5463@option{-fno-trapping-math}, @option{-ffinite-math-only},
c7463669
RH
5464@option{-fno-rounding-math}, @option{-fno-signaling-nans}
5465and @option{fcx-limited-range}.
d4463dfc
JQ
5466
5467This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5468
5469This option should never be turned on by any @option{-O} option since
5470it can result in incorrect output for programs which depend on
5471an exact implementation of IEEE or ISO rules/specifications for
5472math functions.
5473
5474@item -fno-math-errno
5475@opindex fno-math-errno
5476Do not set ERRNO after calling math functions that are executed
5477with a single instruction, e.g., sqrt. A program that relies on
5478IEEE exceptions for math error handling may want to use this flag
5479for speed while maintaining IEEE arithmetic compatibility.
5480
5481This option should never be turned on by any @option{-O} option since
5482it can result in incorrect output for programs which depend on
5483an exact implementation of IEEE or ISO rules/specifications for
5484math functions.
5485
5486The default is @option{-fmath-errno}.
5487
2e3f0db6
DJ
5488On Darwin systems, the math library never sets @code{errno}. There is therefore
5489no reason for the compiler to consider the possibility that it might,
5490and @option{-fno-math-errno} is the default.
5491
d4463dfc
JQ
5492@item -funsafe-math-optimizations
5493@opindex funsafe-math-optimizations
5494Allow optimizations for floating-point arithmetic that (a) assume
5495that arguments and results are valid and (b) may violate IEEE or
5496ANSI standards. When used at link-time, it may include libraries
5497or startup files that change the default FPU control word or other
5498similar optimizations.
5499
5500This option should never be turned on by any @option{-O} option since
5501it can result in incorrect output for programs which depend on
5502an exact implementation of IEEE or ISO rules/specifications for
5503math functions.
5504
5505The default is @option{-fno-unsafe-math-optimizations}.
5506
5507@item -ffinite-math-only
5508@opindex ffinite-math-only
5509Allow optimizations for floating-point arithmetic that assume
5510that arguments and results are not NaNs or +-Infs.
5511
5512This option should never be turned on by any @option{-O} option since
5513it can result in incorrect output for programs which depend on
5514an exact implementation of IEEE or ISO rules/specifications.
5515
5516The default is @option{-fno-finite-math-only}.
5517
5518@item -fno-trapping-math
5519@opindex fno-trapping-math
5520Compile code assuming that floating-point operations cannot generate
5521user-visible traps. These traps include division by zero, overflow,
5522underflow, inexact result and invalid operation. This option implies
5523@option{-fno-signaling-nans}. Setting this option may allow faster
5524code if one relies on ``non-stop'' IEEE arithmetic, for example.
5525
5526This option should never be turned on by any @option{-O} option since
5527it can result in incorrect output for programs which depend on
5528an exact implementation of IEEE or ISO rules/specifications for
5529math functions.
5530
5531The default is @option{-ftrapping-math}.
5532
039c3d42
RS
5533@item -frounding-math
5534@opindex frounding-math
5535Disable transformations and optimizations that assume default floating
5536point rounding behavior. This is round-to-zero for all floating point
5537to integer conversions, and round-to-nearest for all other arithmetic
5538truncations. This option should be specified for programs that change
5539the FP rounding mode dynamically, or that may be executed with a
5540non-default rounding mode. This option disables constant folding of
5541floating point expressions at compile-time (which may be affected by
5542rounding mode) and arithmetic transformations that are unsafe in the
5543presence of sign-dependent rounding modes.
5544
5545The default is @option{-fno-rounding-math}.
5546
5547This option is experimental and does not currently guarantee to
5548disable all GCC optimizations that are affected by rounding mode.
2dd76960 5549Future versions of GCC may provide finer control of this setting
039c3d42
RS
5550using C99's @code{FENV_ACCESS} pragma. This command line option
5551will be used to specify the default state for @code{FENV_ACCESS}.
5552
38109dab
GL
5553@item -frtl-abstract-sequences
5554@opindex frtl-abstract-sequences
5555It is a size optimization method. This option is to find identical
5556sequences of code, which can be turned into pseudo-procedures and
5557then replace all occurrences with calls to the newly created
5558subroutine. It is kind of an opposite of @option{-finline-functions}.
5559This optimization runs at RTL level.
5560
d4463dfc
JQ
5561@item -fsignaling-nans
5562@opindex fsignaling-nans
5563Compile code assuming that IEEE signaling NaNs may generate user-visible
5564traps during floating-point operations. Setting this option disables
5565optimizations that may change the number of exceptions visible with
5566signaling NaNs. This option implies @option{-ftrapping-math}.
5567
5568This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5569be defined.
5570
5571The default is @option{-fno-signaling-nans}.
5572
5573This option is experimental and does not currently guarantee to
5574disable all GCC optimizations that affect signaling NaN behavior.
5575
5576@item -fsingle-precision-constant
5577@opindex fsingle-precision-constant
5578Treat floating point constant as single precision constant instead of
5579implicitly converting it to double precision constant.
5580
c7463669
RH
5581@item -fcx-limited-range
5582@itemx -fno-cx-limited-range
5583@opindex fcx-limited-range
5584@opindex fno-cx-limited-range
5585When enabled, this option states that a range reduction step is not
5586needed when performing complex division. The default is
5587@option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5588
5589This option controls the default setting of the ISO C99
5590@code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
5591all languages.
d4463dfc
JQ
5592
5593@end table
5594
5595The following options control optimizations that may improve
5596performance, but are not enabled by any @option{-O} options. This
5597section includes experimental options that may produce broken code.
5598
5599@table @gcctabopt
5600@item -fbranch-probabilities
5601@opindex fbranch-probabilities
5602After running a program compiled with @option{-fprofile-arcs}
5603(@pxref{Debugging Options,, Options for Debugging Your Program or
5604@command{gcc}}), you can compile it a second time using
5605@option{-fbranch-probabilities}, to improve optimizations based on
5606the number of times each branch was taken. When the program
5607compiled with @option{-fprofile-arcs} exits it saves arc execution
a4878735 5608counts to a file called @file{@var{sourcename}.gcda} for each source
d4463dfc
JQ
5609file The information in this data file is very dependent on the
5610structure of the generated code, so you must use the same source code
5611and the same optimization options for both compilations.
5612
daf2f129 5613With @option{-fbranch-probabilities}, GCC puts a
d4463dfc
JQ
5614@samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5615These can be used to improve optimization. Currently, they are only
5616used in one place: in @file{reorg.c}, instead of guessing which path a
5617branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5618exactly determine which path is taken more often.
5619
fc5eb4a1
ZD
5620@item -fprofile-values
5621@opindex fprofile-values
5622If combined with @option{-fprofile-arcs}, it adds code so that some
5623data about values of expressions in the program is gathered.
5624
6e885ee3
ZD
5625With @option{-fbranch-probabilities}, it reads back the data gathered
5626from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5627notes to instructions for their later usage in optimizations.
5628
7797ff53 5629Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
8d3b3fb7 5630
fca9dc00
ZD
5631@item -fvpt
5632@opindex fvpt
5633If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5634a code to gather information about values of expressions.
5635
5636With @option{-fbranch-probabilities}, it reads back the data gathered
5637and actually performs the optimizations based on them.
5638Currently the optimizations include specialization of division operation
5639using the knowledge about the value of the denominator.
5640
a7b1dc36
PB
5641@item -frename-registers
5642@opindex frename-registers
5643Attempt to avoid false dependencies in scheduled code by making use
5644of registers left over after register allocation. This optimization
5645will most benefit processors with lots of registers. Depending on the
5646debug information format adopted by the target, however, it can
5647make debugging impossible, since variables will no longer stay in
5648a ``home register''.
5649
7869fe47 5650Enabled by default with @option{-funroll-loops}.
a7b1dc36 5651
d4463dfc
JQ
5652@item -ftracer
5653@opindex ftracer
8a36672b 5654Perform tail duplication to enlarge superblock size. This transformation
d4463dfc
JQ
5655simplifies the control flow of the function allowing other optimizations to do
5656better job.
5657
7797ff53 5658Enabled with @option{-fprofile-use}.
8d3b3fb7 5659
d4463dfc
JQ
5660@item -funroll-loops
5661@opindex funroll-loops
b17d5d7c
ZD
5662Unroll loops whose number of iterations can be determined at compile time or
5663upon entry to the loop. @option{-funroll-loops} implies
7869fe47
ZD
5664@option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
5665It also turns on complete loop peeling (i.e.@: complete removal of loops with
5666small constant number of iterations). This option makes code larger, and may
5667or may not make it run faster.
d4463dfc 5668
7797ff53 5669Enabled with @option{-fprofile-use}.
8d3b3fb7 5670
d4463dfc
JQ
5671@item -funroll-all-loops
5672@opindex funroll-all-loops
5673Unroll all loops, even if their number of iterations is uncertain when
5674the loop is entered. This usually makes programs run more slowly.
5675@option{-funroll-all-loops} implies the same options as
b17d5d7c
ZD
5676@option{-funroll-loops}.
5677
5678@item -fpeel-loops
5679@opindex fpeel-loops
5680Peels the loops for that there is enough information that they do not
5681roll much (from profile feedback). It also turns on complete loop peeling
431ae0bf 5682(i.e.@: complete removal of loops with small constant number of iterations).
b17d5d7c 5683
7797ff53 5684Enabled with @option{-fprofile-use}.
8d3b3fb7 5685
5e962776
ZD
5686@item -fmove-loop-invariants
5687@opindex fmove-loop-invariants
5688Enables the loop invariant motion pass in the new loop optimizer. Enabled
5689at level @option{-O1}
5690
b17d5d7c
ZD
5691@item -funswitch-loops
5692@opindex funswitch-loops
5693Move branches with loop invariant conditions out of the loop, with duplicates
5694of the loop on both branches (modified according to result of the condition).
5695
d4463dfc
JQ
5696@item -fprefetch-loop-arrays
5697@opindex fprefetch-loop-arrays
5698If supported by the target machine, generate instructions to prefetch
5699memory to improve the performance of loops that access large arrays.
5700
5701Disabled at level @option{-Os}.
5702
5703@item -ffunction-sections
5704@itemx -fdata-sections
5705@opindex ffunction-sections
5706@opindex fdata-sections
5707Place each function or data item into its own section in the output
5708file if the target supports arbitrary sections. The name of the
5709function or the name of the data item determines the section's name
5710in the output file.
5711
5712Use these options on systems where the linker can perform optimizations
f401d0f5
JDA
5713to improve locality of reference in the instruction space. Most systems
5714using the ELF object format and SPARC processors running Solaris 2 have
5715linkers with such optimizations. AIX may have these optimizations in
5716the future.
d4463dfc
JQ
5717
5718Only use these options when there are significant benefits from doing
5719so. When you specify these options, the assembler and linker will
5720create larger object and executable files and will also be slower.
5721You will not be able to use @code{gprof} on all systems if you
5722specify this option and you may have problems with debugging if
5723you specify both this option and @option{-g}.
5724
fe3ad572
SC
5725@item -fbranch-target-load-optimize
5726@opindex fbranch-target-load-optimize
5727Perform branch target register load optimization before prologue / epilogue
5728threading.
5729The use of target registers can typically be exposed only during reload,
5730thus hoisting loads out of loops and doing inter-block scheduling needs
5731a separate optimization pass.
5732
5733@item -fbranch-target-load-optimize2
5734@opindex fbranch-target-load-optimize2
5735Perform branch target register load optimization after prologue / epilogue
5736threading.
5737
1194fc79
R
5738@item -fbtr-bb-exclusive
5739@opindex fbtr-bb-exclusive
8d3b3fb7 5740When performing branch target register load optimization, don't reuse
1194fc79
R
5741branch target registers in within any basic block.
5742
0aca9021
JW
5743@item -fstack-protector
5744Emit extra code to check for buffer overflows, such as stack smashing
5745attacks. This is done by adding a guard variable to functions with
5746vulnerable objects. This includes functions that call alloca, and
5747functions with buffers larger than 8 bytes. The guards are initialized
5748when a function is entered and then checked when the function exits.
5749If a guard check fails, an error message is printed and the program exits.
5750
5751@item -fstack-protector-all
5752Like @option{-fstack-protector} except that all functions are protected.
5753
3af64fd6 5754@item --param @var{name}=@var{value}
cd3bb277 5755@opindex param
3af64fd6
MM
5756In some places, GCC uses various constants to control the amount of
5757optimization that is done. For example, GCC will not inline functions
5758that contain more that a certain number of instructions. You can
5759control some of these constants on the command-line using the
630d3d5a 5760@option{--param} option.
3af64fd6 5761
b00567b0
ILT
5762The names of specific parameters, and the meaning of the values, are
5763tied to the internals of the compiler, and are subject to change
5764without notice in future releases.
5765
4fe9b91c 5766In each case, the @var{value} is an integer. The allowable choices for
3af64fd6
MM
5767@var{name} are given in the following table:
5768
5769@table @gcctabopt
31617ef1
DB
5770@item salias-max-implicit-fields
5771The maximum number of fields in a variable without direct
5772structure accesses for which structure aliasing will consider trying
5773to track each field. The default is 5
5774
a916f21d
RG
5775@item salias-max-array-elements
5776The maximum number of elements an array can have and its elements
5777still be tracked individually by structure aliasing. The default is 4
5778
61b58001
BE
5779@item sra-max-structure-size
5780The maximum structure size, in bytes, at which the scalar replacement
5781of aggregates (SRA) optimization will perform block copies. The
5782default value, 0, implies that GCC will select the most appropriate
5783size itself.
5784
5785@item sra-field-structure-ratio
1c170b5e 5786The threshold ratio (as a percentage) between instantiated fields and
61b58001
BE
5787the complete structure size. We say that if the ratio of the number
5788of bytes in instantiated fields to the number of bytes in the complete
5789structure exceeds this parameter, then block copies are not used. The
5790default is 75.
5791
5f24e0dc
RH
5792@item max-crossjump-edges
5793The maximum number of incoming edges to consider for crossjumping.
d203738b 5794The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5f24e0dc
RH
5795the number of edges incoming to each block. Increasing values mean
5796more aggressive optimization, making the compile time increase with
5797probably small improvement in executable size.
5798
12183e0f
PH
5799@item min-crossjump-insns
5800The minimum number of instructions which must be matched at the end
5801of two blocks before crossjumping will be performed on them. This
5802value is ignored in the case where all instructions in the block being
5803crossjumped from are matched. The default value is 5.
5804
f935b9e0
DE
5805@item max-grow-copy-bb-insns
5806The maximum code size expansion factor when copying basic blocks
5807instead of jumping. The expansion is relative to a jump instruction.
5808The default value is 8.
5809
bbcb0c05
SB
5810@item max-goto-duplication-insns
5811The maximum number of instructions to duplicate to a block that jumps
5812to a computed goto. To avoid @math{O(N^2)} behavior in a number of
5813passes, GCC factors computed gotos early in the compilation process,
5814and unfactors them as late as possible. Only computed jumps at the
5815end of a basic blocks with no more than max-goto-duplication-insns are
5816unfactored. The default value is 8.
5817
1c4c47db
JO
5818@item max-delay-slot-insn-search
5819The maximum number of instructions to consider when looking for an
5820instruction to fill a delay slot. If more than this arbitrary number of
5821instructions is searched, the time savings from filling the delay slot
5822will be minimal so stop searching. Increasing values mean more
5823aggressive optimization, making the compile time increase with probably
5824small improvement in executable run time.
5825
5826@item max-delay-slot-live-search
5827When trying to fill delay slots, the maximum number of instructions to
5828consider when searching for a block with valid live register
5829information. Increasing this arbitrarily chosen value means more
5830aggressive optimization, increasing the compile time. This parameter
5831should be removed when the delay slot code is rewritten to maintain the
5832control-flow graph.
33d3b05b
MM
5833
5834@item max-gcse-memory
5835The approximate maximum amount of memory that will be allocated in
5836order to perform the global common subexpression elimination
5837optimization. If more memory than specified is required, the
5838optimization will not be done.
3af64fd6 5839
740f35a0 5840@item max-gcse-passes
8d3b3fb7 5841The maximum number of passes of GCSE to run. The default is 1.
740f35a0 5842
4a121cc3 5843@item max-pending-list-length
0c688a7d 5844The maximum number of pending dependencies scheduling will allow
4a121cc3
AM
5845before flushing the current state and starting over. Large functions
5846with few branches or calls can create excessively large lists which
5847needlessly consume memory and resources.
5848
bc522472
KG
5849@item max-inline-insns-single
5850Several parameters control the tree inliner used in gcc.
2dd76960 5851This number sets the maximum number of instructions (counted in GCC's
daf2f129 5852internal representation) in a single function that the tree inliner
bc522472
KG
5853will consider for inlining. This only affects functions declared
5854inline and methods implemented in a class declaration (C++).
e5c4f28a 5855The default value is 450.
bc522472
KG
5856
5857@item max-inline-insns-auto
5858When you use @option{-finline-functions} (included in @option{-O3}),
5859a lot of functions that would otherwise not be considered for inlining
5860by the compiler will be investigated. To those functions, a different
5861(more restrictive) limit compared to functions declared inline can
5862be applied.
e5c4f28a 5863The default value is 90.
bc522472 5864
b58b1157 5865@item large-function-insns
74515a0a
RG
5866The limit specifying really large functions. For functions larger than this
5867limit after inlining inlining is constrained by
5868@option{--param large-function-growth}. This parameter is useful primarily
5869to avoid extreme compilation time caused by non-linear algorithms used by the
5870backend.
b58b1157 5871This parameter is ignored when @option{-funit-at-a-time} is not used.
e5c4f28a 5872The default value is 2700.
b58b1157
JH
5873
5874@item large-function-growth
e53e0c56 5875Specifies maximal growth of large function caused by inlining in percents.
b58b1157 5876This parameter is ignored when @option{-funit-at-a-time} is not used.
74515a0a
RG
5877The default value is 100 which limits large function growth to 2.0 times
5878the original size.
b58b1157 5879
b4f32d07
JH
5880@item large-unit-insns
5881The limit specifying large translation unit. Growth caused by inlining of
5882units larger than this limit is limited by @option{--param inline-unit-growth}.
5883For small units this might be too tight (consider unit consisting of function A
5884that is inline and B that just calls A three time. If B is small relative to
5885A, the growth of unit is 300\% and yet such inlining is very sane. For very
5886large units consisting of small inlininable functions however the overall unit
5887growth limit is needed to avoid exponential explosion of code size. Thus for
5888smaller units, the size is increased to @option{--param large-unit-insns}
6416ae7f 5889before applying @option{--param inline-unit-growth}. The default is 10000
b4f32d07 5890
b58b1157
JH
5891@item inline-unit-growth
5892Specifies maximal overall growth of the compilation unit caused by inlining.
5893This parameter is ignored when @option{-funit-at-a-time} is not used.
74515a0a
RG
5894The default value is 50 which limits unit growth to 1.5 times the original
5895size.
b58b1157 5896
6de9cd9a
DN
5897@item max-inline-insns-recursive
5898@itemx max-inline-insns-recursive-auto
5899Specifies maximum number of instructions out-of-line copy of self recursive inline
5900function can grow into by performing recursive inlining.
5901
5902For functions declared inline @option{--param max-inline-insns-recursive} is
5903taken into acount. For function not declared inline, recursive inlining
5904happens only when @option{-finline-functions} (included in @option{-O3}) is
5905enabled and @option{--param max-inline-insns-recursive-auto} is used. The
e5c4f28a 5906default value is 450.
6de9cd9a
DN
5907
5908@item max-inline-recursive-depth
5909@itemx max-inline-recursive-depth-auto
5910Specifies maximum recursion depth used by the recursive inlining.
5911
5912For functions declared inline @option{--param max-inline-recursive-depth} is
5913taken into acount. For function not declared inline, recursive inlining
5914happens only when @option{-finline-functions} (included in @option{-O3}) is
5915enabled and @option{--param max-inline-recursive-depth-auto} is used. The
e5c4f28a
RG
5916default value is 450.
5917
c5a4444c
JH
5918@item min-inline-recursive-probability
5919Recursive inlining is profitable only for function having deep recursion
5920in average and can hurt for function having little recursion depth by
5921increasing the prologue size or complexity of function body to other
5922optimizers.
5923
5924When profile feedback is available (see @option{-fprofile-generate}) the actual
5925recursion depth can be guessed from probability that function will recurse via
5926given call expression. This parameter limits inlining only to call expression
5927whose probability exceeds given threshold (in percents). The default value is
592810.
5929
e5c4f28a
RG
5930@item inline-call-cost
5931Specify cost of call instruction relative to simple arithmetics operations
2e0ea515
KH
5932(having cost of 1). Increasing this cost disqualifies inlining of non-leaf
5933functions and at the same time increases size of leaf function that is believed to
5934reduce function size by being inlined. In effect it increases amount of
e5c4f28a 5935inlining for code having large abstraction penalty (many functions that just
2e0ea515
KH
5936pass the arguments to other functions) and decrease inlining for code with low
5937abstraction penalty. The default value is 16.
6de9cd9a 5938
03e9dbc9
MM
5939@item max-unrolled-insns
5940The maximum number of instructions that a loop should have if that loop
5941is unrolled, and if the loop is unrolled, it determines how many times
5942the loop code is unrolled.
5943
b17d5d7c
ZD
5944@item max-average-unrolled-insns
5945The maximum number of instructions biased by probabilities of their execution
5946that a loop should have if that loop is unrolled, and if the loop is unrolled,
5947it determines how many times the loop code is unrolled.
5948
5949@item max-unroll-times
5950The maximum number of unrollings of a single loop.
5951
5952@item max-peeled-insns
5953The maximum number of instructions that a loop should have if that loop
5954is peeled, and if the loop is peeled, it determines how many times
5955the loop code is peeled.
5956
5957@item max-peel-times
5958The maximum number of peelings of a single loop.
5959
5960@item max-completely-peeled-insns
5961The maximum number of insns of a completely peeled loop.
5962
5963@item max-completely-peel-times
5964The maximum number of iterations of a loop to be suitable for complete peeling.
5965
01a132bb
ZD
5966@item max-unswitch-insns
5967The maximum number of insns of an unswitched loop.
5968
5969@item max-unswitch-level
5970The maximum number of branches unswitched in a single loop.
5971
a7e5372d
ZD
5972@item lim-expensive
5973The minimum cost of an expensive expression in the loop invariant motion.
5974
8b11a64c
ZD
5975@item iv-consider-all-candidates-bound
5976Bound on number of candidates for induction variables below that
5977all candidates are considered for each use in induction variable
5978optimizations. Only the most relevant candidates are considered
5979if there are more candidates, to avoid quadratic time complexity.
5980
5981@item iv-max-considered-uses
5982The induction variable optimizations give up on loops that contain more
5983induction variable uses.
5984
36f5ada1
ZD
5985@item iv-always-prune-cand-set-bound
5986If number of candidates in the set is smaller than this value,
5987we always try to remove unnecessary ivs from the set during its
5988optimization when a new iv is added to the set.
5989
2412d35c
SP
5990@item scev-max-expr-size
5991Bound on size of expressions used in the scalar evolutions analyzer.
5992Large expressions slow the analyzer.
5993
c12cc930 5994@item vect-max-version-checks
5116a5d2 5995The maximum number of runtime checks that can be performed when doing
c12cc930
KB
5996loop versioning in the vectorizer. See option ftree-vect-loop-version
5997for more information.
5998
e9eb809d
ZD
5999@item max-iterations-to-track
6000
6001The maximum number of iterations of a loop the brute force algorithm
6002for analysis of # of iterations of the loop tries to evaluate.
6003
194734e9
JH
6004@item hot-bb-count-fraction
6005Select fraction of the maximal count of repetitions of basic block in program
6006given basic block needs to have to be considered hot.
6007
6008@item hot-bb-frequency-fraction
6009Select fraction of the maximal frequency of executions of basic block in
6010function given basic block needs to have to be considered hot
5c856b23 6011
95b9a3a5
JH
6012@item max-predicted-iterations
6013The maximum number of loop iterations we predict statically. This is useful
6014in cases where function contain single loop with known bound and other loop
6015with unknown. We predict the known number of iterations correctly, while
c83eecad
KH
6016the unknown number of iterations average to roughly 10. This means that the
6017loop without bounds would appear artificially cold relative to the other one.
95b9a3a5 6018
5c856b23
JH
6019@item tracer-dynamic-coverage
6020@itemx tracer-dynamic-coverage-feedback
6021
3364c33b
JQ
6022This value is used to limit superblock formation once the given percentage of
6023executed instructions is covered. This limits unnecessary code size
6024expansion.
5c856b23
JH
6025
6026The @option{tracer-dynamic-coverage-feedback} is used only when profile
6027feedback is available. The real profiles (as opposed to statically estimated
6028ones) are much less balanced allowing the threshold to be larger value.
6029
6030@item tracer-max-code-growth
6031Stop tail duplication once code growth has reached given percentage. This is
3364c33b 6032rather hokey argument, as most of the duplicates will be eliminated later in
5c856b23
JH
6033cross jumping, so it may be set to much higher values than is the desired code
6034growth.
6035
6036@item tracer-min-branch-ratio
6037
6038Stop reverse growth when the reverse probability of best edge is less than this
6039threshold (in percent).
6040
6041@item tracer-min-branch-ratio
6042@itemx tracer-min-branch-ratio-feedback
6043
6044Stop forward growth if the best edge do have probability lower than this
6045threshold.
6046
3364c33b 6047Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5c856b23
JH
6048compilation for profile feedback and one for compilation without. The value
6049for compilation with profile feedback needs to be more conservative (higher) in
6050order to make tracer effective.
6051
c48ec590
ZD
6052@item max-cse-path-length
6053
8d3b3fb7 6054Maximum number of basic blocks on path that cse considers. The default is 10.
c48ec590 6055
95b9a3a5
JH
6056@item max-cse-insns
6057The maximum instructions CSE process before flushing. The default is 1000.
6058
6de9cd9a
DN
6059@item global-var-threshold
6060
8a36672b
JM
6061Counts the number of function calls (@var{n}) and the number of
6062call-clobbered variables (@var{v}). If @var{n}x@var{v} is larger than this limit, a
6de9cd9a
DN
6063single artificial variable will be created to represent all the
6064call-clobbered variables at function call sites. This artificial
6065variable will then be made to alias every call-clobbered variable.
8a36672b 6066(done as @code{int * size_t} on the host machine; beware overflow).
6de9cd9a
DN
6067
6068@item max-aliased-vops
6069
27ef2cdd 6070Maximum number of virtual operands allowed to represent aliases
6de9cd9a
DN
6071before triggering the alias grouping heuristic. Alias grouping
6072reduces compile times and memory consumption needed for aliasing at
6073the expense of precision loss in alias information.
6074
3788cc17
ZW
6075@item ggc-min-expand
6076
6077GCC uses a garbage collector to manage its own memory allocation. This
6078parameter specifies the minimum percentage by which the garbage
6079collector's heap should be allowed to expand between collections.
6080Tuning this may improve compilation speed; it has no effect on code
6081generation.
6082
9ac121af 6083The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8a36672b
JM
6084RAM >= 1GB@. If @code{getrlimit} is available, the notion of "RAM" is
6085the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
16226f1e
KG
6086GCC is not able to calculate RAM on a particular platform, the lower
6087bound of 30% is used. Setting this parameter and
737c38d1
GK
6088@option{ggc-min-heapsize} to zero causes a full collection to occur at
6089every opportunity. This is extremely slow, but can be useful for
6090debugging.
3788cc17
ZW
6091
6092@item ggc-min-heapsize
6093
6094Minimum size of the garbage collector's heap before it begins bothering
6095to collect garbage. The first collection occurs after the heap expands
6096by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
6097tuning this may improve compilation speed, and has no effect on code
6098generation.
6099
d37e6b50
GK
6100The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6101tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6102with a lower bound of 4096 (four megabytes) and an upper bound of
6103131072 (128 megabytes). If GCC is not able to calculate RAM on a
6104particular platform, the lower bound is used. Setting this parameter
6105very large effectively disables garbage collection. Setting this
6106parameter and @option{ggc-min-expand} to zero causes a full collection
6107to occur at every opportunity.
3788cc17 6108
0bcf8261
JH
6109@item max-reload-search-insns
6110The maximum number of instruction reload should look backward for equivalent
6111register. Increasing values mean more aggressive optimization, making the
6112compile time increase with probably slightly better performance. The default
6113value is 100.
6114
c65ecebc
JH
6115@item max-cselib-memory-location
6116The maximum number of memory locations cselib should take into acount.
6117Increasing values mean more aggressive optimization, making the compile time
6118increase with probably slightly better performance. The default value is 500.
6119
95b9a3a5
JH
6120@item max-flow-memory-location
6121Similar as @option{max-cselib-memory-location} but for dataflow liveness.
6122The default value is 100.
6123
26f74aa3
JH
6124@item reorder-blocks-duplicate
6125@itemx reorder-blocks-duplicate-feedback
6126
65d2d764 6127Used by basic block reordering pass to decide whether to use unconditional
b222f49a 6128branch or duplicate the code on its destination. Code is duplicated when its
26f74aa3 6129estimated size is smaller than this value multiplied by the estimated size of
65d2d764 6130unconditional jump in the hot spots of the program.
26f74aa3
JH
6131
6132The @option{reorder-block-duplicate-feedback} is used only when profile
6133feedback is available and may be set to higher values than
6134@option{reorder-block-duplicate} since information about the hot spots is more
6135accurate.
f72c6b56
DE
6136
6137@item max-sched-region-blocks
6138The maximum number of blocks in a region to be considered for
6139interblock scheduling. The default value is 10.
6140
fbce7685 6141@item max-sched-region-insns
f72c6b56
DE
6142The maximum number of insns in a region to be considered for
6143interblock scheduling. The default value is 100.
31ebd7c8 6144
6f48c21a
PS
6145@item min-sched-prob
6146The minimum probability of reaching a source block for interblock
6147speculative scheduling. The default value is 40.
6148
49c3b9a8
JJ
6149@item max-last-value-rtl
6150
6151The maximum size measured as number of RTLs that can be recorded in an expression
6152in combiner for a pseudo register as last known value of that register. The default
6153is 10000.
6154
31ebd7c8
NS
6155@item integer-share-limit
6156Small integer constants can use a shared data structure, reducing the
6157compiler's memory usage and increasing its speed. This sets the maximum
6158value of a shared integer constant's. The default value is 256.
6159
84d65814
DN
6160@item min-virtual-mappings
6161Specifies the minimum number of virtual mappings in the incremental
6162SSA updater that should be registered to trigger the virtual mappings
6163heuristic defined by virtual-mappings-ratio. The default value is
6164100.
6165
6166@item virtual-mappings-ratio
6167If the number of virtual mappings is virtual-mappings-ratio bigger
6168than the number of virtual symbols to be updated, then the incremental
6169SSA updater switches to a full update for those symbols. The default
6170ratio is 3.
6171
0aca9021
JW
6172@item ssp-buffer-size
6173The minimum size of buffers (i.e. arrays) that will receive stack smashing
6174protection when @option{-fstack-protection} is used.
6175
43f31be5
JL
6176@item max-jump-thread-duplication-stmts
6177Maximum number of statements allowed in a block that needs to be
6178duplicated when threading jumps.
1c4c47db 6179@end table
74291a4b
MM
6180@end table
6181
6182@node Preprocessor Options
6183@section Options Controlling the Preprocessor
6184@cindex preprocessor options
6185@cindex options, preprocessor
6186
6187These options control the C preprocessor, which is run on each C source
6188file before actual compilation.
6189
630d3d5a
JM
6190If you use the @option{-E} option, nothing is done except preprocessing.
6191Some of these options make sense only together with @option{-E} because
74291a4b
MM
6192they cause the preprocessor output to be unsuitable for actual
6193compilation.
6194
4977bab6 6195@table @gcctabopt
cd3bb277 6196@opindex Wp
40adaa27
NB
6197You can use @option{-Wp,@var{option}} to bypass the compiler driver
6198and pass @var{option} directly through to the preprocessor. If
6199@var{option} contains commas, it is split into multiple options at the
6200commas. However, many options are modified, translated or interpreted
6201by the compiler driver before being passed to the preprocessor, and
6202@option{-Wp} forcibly bypasses this phase. The preprocessor's direct
6203interface is undocumented and subject to change, so whenever possible
6204you should avoid using @option{-Wp} and let the driver handle the
6205options instead.
6206
4977bab6
ZW
6207@item -Xpreprocessor @var{option}
6208@opindex preprocessor
6209Pass @var{option} as an option to the preprocessor. You can use this to
6210supply system-specific preprocessor options which GCC does not know how to
6211recognize.
6212
6213If you want to pass an option that takes an argument, you must use
6214@option{-Xpreprocessor} twice, once for the option and once for the argument.
6215@end table
6216
40adaa27 6217@include cppopts.texi
74291a4b
MM
6218
6219@node Assembler Options
6220@section Passing Options to the Assembler
6221
6222@c prevent bad page break with this line
6223You can pass options to the assembler.
6224
2642624b 6225@table @gcctabopt
aee96fe9 6226@item -Wa,@var{option}
cd3bb277 6227@opindex Wa
74291a4b
MM
6228Pass @var{option} as an option to the assembler. If @var{option}
6229contains commas, it is split into multiple options at the commas.
4977bab6
ZW
6230
6231@item -Xassembler @var{option}
6232@opindex Xassembler
6233Pass @var{option} as an option to the assembler. You can use this to
6234supply system-specific assembler options which GCC does not know how to
6235recognize.
6236
6237If you want to pass an option that takes an argument, you must use
6238@option{-Xassembler} twice, once for the option and once for the argument.
6239
74291a4b
MM
6240@end table
6241
6242@node Link Options
6243@section Options for Linking
6244@cindex link options
6245@cindex options, linking
6246
6247These options come into play when the compiler links object files into
6248an executable output file. They are meaningless if the compiler is
6249not doing a link step.
6250
2642624b 6251@table @gcctabopt
74291a4b
MM
6252@cindex file names
6253@item @var{object-file-name}
6254A file name that does not end in a special recognized suffix is
6255considered to name an object file or library. (Object files are
6256distinguished from libraries by the linker according to the file
6257contents.) If linking is done, these object files are used as input
6258to the linker.
6259
6260@item -c
6261@itemx -S
6262@itemx -E
cd3bb277
JM
6263@opindex c
6264@opindex S
6265@opindex E
74291a4b
MM
6266If any of these options is used, then the linker is not run, and
6267object file names should not be used as arguments. @xref{Overall
6268Options}.
6269
6270@cindex Libraries
6271@item -l@var{library}
4275c4c4 6272@itemx -l @var{library}
cd3bb277 6273@opindex l
4275c4c4
JS
6274Search the library named @var{library} when linking. (The second
6275alternative with the library as a separate argument is only for
6276POSIX compliance and is not recommended.)
74291a4b
MM
6277
6278It makes a difference where in the command you write this option; the
4275c4c4 6279linker searches and processes libraries and object files in the order they
74291a4b
MM
6280are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6281after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
6282to functions in @samp{z}, those functions may not be loaded.
6283
6284The linker searches a standard list of directories for the library,
6285which is actually a file named @file{lib@var{library}.a}. The linker
6286then uses this file as if it had been specified precisely by name.
6287
6288The directories searched include several standard system directories
630d3d5a 6289plus any that you specify with @option{-L}.
74291a4b
MM
6290
6291Normally the files found this way are library files---archive files
6292whose members are object files. The linker handles an archive file by
6293scanning through it for members which define symbols that have so far
6294been referenced but not defined. But if the file that is found is an
6295ordinary object file, it is linked in the usual fashion. The only
630d3d5a
JM
6296difference between using an @option{-l} option and specifying a file name
6297is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
74291a4b
MM
6298and searches several directories.
6299
6300@item -lobjc
cd3bb277 6301@opindex lobjc
630d3d5a 6302You need this special case of the @option{-l} option in order to
46e34f96 6303link an Objective-C or Objective-C++ program.
74291a4b
MM
6304
6305@item -nostartfiles
cd3bb277 6306@opindex nostartfiles
74291a4b 6307Do not use the standard system startup files when linking.
bedc7537
NC
6308The standard system libraries are used normally, unless @option{-nostdlib}
6309or @option{-nodefaultlibs} is used.
74291a4b
MM
6310
6311@item -nodefaultlibs
cd3bb277 6312@opindex nodefaultlibs
74291a4b
MM
6313Do not use the standard system libraries when linking.
6314Only the libraries you specify will be passed to the linker.
bedc7537 6315The standard startup files are used normally, unless @option{-nostartfiles}
8f99553f
JM
6316is used. The compiler may generate calls to @code{memcmp},
6317@code{memset}, @code{memcpy} and @code{memmove}.
6318These entries are usually resolved by entries in
4754172c
CM
6319libc. These entry points should be supplied through some other
6320mechanism when this option is specified.
74291a4b
MM
6321
6322@item -nostdlib
cd3bb277 6323@opindex nostdlib
74291a4b
MM
6324Do not use the standard system startup files or libraries when linking.
6325No startup files and only the libraries you specify will be passed to
8f99553f
JM
6326the linker. The compiler may generate calls to @code{memcmp}, @code{memset},
6327@code{memcpy} and @code{memmove}.
6328These entries are usually resolved by entries in
4754172c
CM
6329libc. These entry points should be supplied through some other
6330mechanism when this option is specified.
74291a4b 6331
630d3d5a
JM
6332@cindex @option{-lgcc}, use with @option{-nostdlib}
6333@cindex @option{-nostdlib} and unresolved references
6334@cindex unresolved references and @option{-nostdlib}
6335@cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6336@cindex @option{-nodefaultlibs} and unresolved references
6337@cindex unresolved references and @option{-nodefaultlibs}
6338One of the standard libraries bypassed by @option{-nostdlib} and
6339@option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
0c2d1a2a 6340that GCC uses to overcome shortcomings of particular machines, or special
74291a4b 6341needs for some languages.
b11cc610
JM
6342(@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6343Collection (GCC) Internals},
74291a4b 6344for more discussion of @file{libgcc.a}.)
74291a4b 6345In most cases, you need @file{libgcc.a} even when you want to avoid
630d3d5a
JM
6346other standard libraries. In other words, when you specify @option{-nostdlib}
6347or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
0c2d1a2a 6348This ensures that you have no unresolved references to internal GCC
74291a4b 6349library subroutines. (For example, @samp{__main}, used to ensure C++
b11cc610
JM
6350constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6351GNU Compiler Collection (GCC) Internals}.)
74291a4b 6352
24a4dd31
JJ
6353@item -pie
6354@opindex pie
6355Produce a position independent executable on targets which support it.
6356For predictable results, you must also specify the same set of options
6357that were used to generate code (@option{-fpie}, @option{-fPIE},
6358or model suboptions) when you specify this option.
6359
0cbc4d77
WB
6360@item -rdynamic
6361@opindex rdynamic
6362Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6363that support it. This instructs the linker to add all symbols, not
6364only used ones, to the dynamic symbol table. This option is needed
6365for some uses of @code{dlopen} or to allow obtaining backtraces
6366from within a program.
6367
74291a4b 6368@item -s
cd3bb277 6369@opindex s
74291a4b
MM
6370Remove all symbol table and relocation information from the executable.
6371
6372@item -static
cd3bb277 6373@opindex static
74291a4b
MM
6374On systems that support dynamic linking, this prevents linking with the shared
6375libraries. On other systems, this option has no effect.
6376
6377@item -shared
cd3bb277 6378@opindex shared
74291a4b 6379Produce a shared object which can then be linked with other objects to
1d3b0e2c 6380form an executable. Not all systems support this option. For predictable
02f52e19 6381results, you must also specify the same set of options that were used to
630d3d5a 6382generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
2642624b 6383when you specify this option.@footnote{On some systems, @samp{gcc -shared}
767094dd 6384needs to build supplementary stub code for constructors to work. On
2642624b 6385multi-libbed systems, @samp{gcc -shared} must select the correct support
1d3b0e2c 6386libraries to link against. Failing to supply the correct flags may lead
767094dd 6387to subtle defects. Supplying them in cases where they are not necessary
1d3b0e2c 6388is innocuous.}
74291a4b 6389
9db0819e
RH
6390@item -shared-libgcc
6391@itemx -static-libgcc
cd3bb277
JM
6392@opindex shared-libgcc
6393@opindex static-libgcc
9db0819e
RH
6394On systems that provide @file{libgcc} as a shared library, these options
6395force the use of either the shared or static version respectively.
6396If no shared version of @file{libgcc} was built when the compiler was
6397configured, these options have no effect.
6398
6399There are several situations in which an application should use the
6400shared @file{libgcc} instead of the static version. The most common
6401of these is when the application wishes to throw and catch exceptions
6402across different shared libraries. In that case, each of the libraries
6403as well as the application itself should use the shared @file{libgcc}.
6404
5c181756
AO
6405Therefore, the G++ and GCJ drivers automatically add
6406@option{-shared-libgcc} whenever you build a shared library or a main
6407executable, because C++ and Java programs typically use exceptions, so
6408this is the right thing to do.
6409
6410If, instead, you use the GCC driver to create shared libraries, you may
6411find that they will not always be linked with the shared @file{libgcc}.
d3144423
EB
6412If GCC finds, at its configuration time, that you have a non-GNU linker
6413or a GNU linker that does not support option @option{--eh-frame-hdr},
6414it will link the shared version of @file{libgcc} into shared libraries
6415by default. Otherwise, it will take advantage of the linker and optimize
6416away the linking with the shared version of @file{libgcc}, linking with
6417the static version of libgcc by default. This allows exceptions to
6418propagate through such shared libraries, without incurring relocation
6419costs at library load time.
5c181756
AO
6420
6421However, if a library or main executable is supposed to throw or catch
6422exceptions, you must link it using the G++ or GCJ driver, as appropriate
6423for the languages used in the program, or using the option
6424@option{-shared-libgcc}, such that it is linked with the shared
049f6ec9 6425@file{libgcc}.
9db0819e 6426
74291a4b 6427@item -symbolic
cd3bb277 6428@opindex symbolic
74291a4b
MM
6429Bind references to global symbols when building a shared object. Warn
6430about any unresolved references (unless overridden by the link editor
6431option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
6432this option.
6433
6434@item -Xlinker @var{option}
cd3bb277 6435@opindex Xlinker
74291a4b 6436Pass @var{option} as an option to the linker. You can use this to
0c2d1a2a 6437supply system-specific linker options which GCC does not know how to
74291a4b
MM
6438recognize.
6439
6440If you want to pass an option that takes an argument, you must use
630d3d5a
JM
6441@option{-Xlinker} twice, once for the option and once for the argument.
6442For example, to pass @option{-assert definitions}, you must write
74291a4b 6443@samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
630d3d5a 6444@option{-Xlinker "-assert definitions"}, because this passes the entire
74291a4b
MM
6445string as a single argument, which is not what the linker expects.
6446
aee96fe9 6447@item -Wl,@var{option}
cd3bb277 6448@opindex Wl
74291a4b
MM
6449Pass @var{option} as an option to the linker. If @var{option} contains
6450commas, it is split into multiple options at the commas.
6451
6452@item -u @var{symbol}
cd3bb277 6453@opindex u
74291a4b 6454Pretend the symbol @var{symbol} is undefined, to force linking of
630d3d5a 6455library modules to define it. You can use @option{-u} multiple times with
74291a4b
MM
6456different symbols to force loading of additional library modules.
6457@end table
6458
6459@node Directory Options
6460@section Options for Directory Search
6461@cindex directory options
6462@cindex options, directory search
6463@cindex search path
6464
6465These options specify directories to search for header files, for
6466libraries and for parts of the compiler:
6467
2642624b 6468@table @gcctabopt
74291a4b 6469@item -I@var{dir}
cd3bb277 6470@opindex I
861bb6c1
JL
6471Add the directory @var{dir} to the head of the list of directories to be
6472searched for header files. This can be used to override a system header
6473file, substituting your own version, since these directories are
d0a5eb32
RK
6474searched before the system header file directories. However, you should
6475not use this option to add directories that contain vendor-supplied
767094dd 6476system header files (use @option{-isystem} for that). If you use more than
630d3d5a 6477one @option{-I} option, the directories are scanned in left-to-right
74291a4b
MM
6478order; the standard system directories come after.
6479
dbead49c 6480If a standard system include directory, or a directory specified with
48209ce5
JDA
6481@option{-isystem}, is also specified with @option{-I}, the @option{-I}
6482option will be ignored. The directory will still be searched but as a
6483system directory at its normal position in the system include chain.
6484This is to ensure that GCC's procedure to fix buggy system headers and
3364c33b 6485the ordering for the include_next directive are not inadvertently changed.
48209ce5
JDA
6486If you really need to change the search order for system directories,
6487use the @option{-nostdinc} and/or @option{-isystem} options.
dbead49c 6488
4bed3787
MS
6489@item -iquote@var{dir}
6490@opindex iquote
6491Add the directory @var{dir} to the head of the list of directories to
6492be searched for header files only for the case of @samp{#include
6493"@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6494otherwise just like @option{-I}.
74291a4b
MM
6495
6496@item -L@var{dir}
cd3bb277 6497@opindex L
74291a4b 6498Add directory @var{dir} to the list of directories to be searched
630d3d5a 6499for @option{-l}.
74291a4b
MM
6500
6501@item -B@var{prefix}
cd3bb277 6502@opindex B
74291a4b
MM
6503This option specifies where to find the executables, libraries,
6504include files, and data files of the compiler itself.
6505
6506The compiler driver program runs one or more of the subprograms
6507@file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
6508@var{prefix} as a prefix for each program it tries to run, both with and
6509without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6510
6511For each subprogram to be run, the compiler driver first tries the
630d3d5a 6512@option{-B} prefix, if any. If that name is not found, or if @option{-B}
74291a4b 6513was not specified, the driver tries two standard prefixes, which are
8e5f33ff 6514@file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
74291a4b
MM
6515those results in a file name that is found, the unmodified program
6516name is searched for using the directories specified in your
bedc7537 6517@env{PATH} environment variable.
74291a4b 6518
07804c3b
NC
6519The compiler will check to see if the path provided by the @option{-B}
6520refers to a directory, and if necessary it will add a directory
6521separator character at the end of the path.
6522
630d3d5a 6523@option{-B} prefixes that effectively specify directory names also apply
74291a4b 6524to libraries in the linker, because the compiler translates these
630d3d5a 6525options into @option{-L} options for the linker. They also apply to
74291a4b 6526includes files in the preprocessor, because the compiler translates these
630d3d5a 6527options into @option{-isystem} options for the preprocessor. In this case,
74291a4b
MM
6528the compiler appends @samp{include} to the prefix.
6529
6530The run-time support file @file{libgcc.a} can also be searched for using
630d3d5a 6531the @option{-B} prefix, if needed. If it is not found there, the two
74291a4b
MM
6532standard prefixes above are tried, and that is all. The file is left
6533out of the link if it is not found by those means.
6534
630d3d5a 6535Another way to specify a prefix much like the @option{-B} prefix is to use
bedc7537 6536the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
74291a4b 6537Variables}.
861bb6c1 6538
07804c3b 6539As a special kludge, if the path provided by @option{-B} is
bf4eebe0
NC
6540@file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
65419, then it will be replaced by @file{[dir/]include}. This is to help
7dac2f89 6542with boot-strapping the compiler.
07804c3b 6543
861bb6c1 6544@item -specs=@var{file}
cd3bb277 6545@opindex specs
861bb6c1
JL
6546Process @var{file} after the compiler reads in the standard @file{specs}
6547file, in order to override the defaults that the @file{gcc} driver
6548program uses when determining what switches to pass to @file{cc1},
6549@file{cc1plus}, @file{as}, @file{ld}, etc. More than one
630d3d5a 6550@option{-specs=@var{file}} can be specified on the command line, and they
861bb6c1 6551are processed in order, from left to right.
4bed3787 6552
160633c6
MM
6553@item --sysroot=@var{dir}
6554@opindex sysroot
6555Use @var{dir} as the logical root directory for headers and libraries.
6556For example, if the compiler would normally search for headers in
6557@file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6558search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
6559
6560If you use both this option and the @option{-isysroot} option, then
6561the @option{--sysroot} option will apply to libraries, but the
6562@option{-isysroot} option will apply to header files.
6563
6564The GNU linker (beginning with version 2.16) has the necessary support
6565for this option. If your linker does not support this option, the
6566header file aspect of @option{--sysroot} will still work, but the
6567library aspect will not.
6568
4bed3787
MS
6569@item -I-
6570@opindex I-
6571This option has been deprecated. Please use @option{-iquote} instead for
6572@option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6573Any directories you specify with @option{-I} options before the @option{-I-}
6574option are searched only for the case of @samp{#include "@var{file}"};
6575they are not searched for @samp{#include <@var{file}>}.
6576
6577If additional directories are specified with @option{-I} options after
6578the @option{-I-}, these directories are searched for all @samp{#include}
6579directives. (Ordinarily @emph{all} @option{-I} directories are used
6580this way.)
6581
6582In addition, the @option{-I-} option inhibits the use of the current
6583directory (where the current input file came from) as the first search
6584directory for @samp{#include "@var{file}"}. There is no way to
6585override this effect of @option{-I-}. With @option{-I.} you can specify
6586searching the directory which was current when the compiler was
6587invoked. That is not exactly the same as what the preprocessor does
6588by default, but it is often satisfactory.
6589
6590@option{-I-} does not inhibit the use of the standard system directories
6591for header files. Thus, @option{-I-} and @option{-nostdinc} are
6592independent.
74291a4b
MM
6593@end table
6594
ee457005
JM
6595@c man end
6596
a743d340
NC
6597@node Spec Files
6598@section Specifying subprocesses and the switches to pass to them
6599@cindex Spec Files
d2d42a91 6600
bedc7537 6601@command{gcc} is a driver program. It performs its job by invoking a
a743d340
NC
6602sequence of other programs to do the work of compiling, assembling and
6603linking. GCC interprets its command-line parameters and uses these to
6604deduce which programs it should invoke, and which command-line options
c21cd8b1 6605it ought to place on their command lines. This behavior is controlled
a743d340
NC
6606by @dfn{spec strings}. In most cases there is one spec string for each
6607program that GCC can invoke, but a few programs have multiple spec
c21cd8b1 6608strings to control their behavior. The spec strings built into GCC can
630d3d5a 6609be overridden by using the @option{-specs=} command-line switch to specify
a743d340
NC
6610a spec file.
6611
6612@dfn{Spec files} are plaintext files that are used to construct spec
6613strings. They consist of a sequence of directives separated by blank
6614lines. The type of directive is determined by the first non-whitespace
6615character on the line and it can be one of the following:
6616
6617@table @code
6618@item %@var{command}
6619Issues a @var{command} to the spec file processor. The commands that can
02f52e19 6620appear here are:
a743d340
NC
6621
6622@table @code
6623@item %include <@var{file}>
6624@cindex %include
6625Search for @var{file} and insert its text at the current point in the
6626specs file.
6627
6628@item %include_noerr <@var{file}>
6629@cindex %include_noerr
6630Just like @samp{%include}, but do not generate an error message if the include
6631file cannot be found.
6632
6633@item %rename @var{old_name} @var{new_name}
6634@cindex %rename
6635Rename the spec string @var{old_name} to @var{new_name}.
6636
6637@end table
6638
6639@item *[@var{spec_name}]:
6640This tells the compiler to create, override or delete the named spec
6641string. All lines after this directive up to the next directive or
6642blank line are considered to be the text for the spec string. If this
6643results in an empty string then the spec will be deleted. (Or, if the
6644spec did not exist, then nothing will happened.) Otherwise, if the spec
6645does not currently exist a new spec will be created. If the spec does
6646exist then its contents will be overridden by the text of this
6647directive, unless the first character of that text is the @samp{+}
6648character, in which case the text will be appended to the spec.
6649
6650@item [@var{suffix}]:
6651Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
6652and up to the next directive or blank line are considered to make up the
02f52e19 6653spec string for the indicated suffix. When the compiler encounters an
a743d340
NC
6654input file with the named suffix, it will processes the spec string in
6655order to work out how to compile that file. For example:
6656
6657@smallexample
6658.ZZ:
6659z-compile -input %i
6660@end smallexample
6661
6662This says that any input file whose name ends in @samp{.ZZ} should be
6663passed to the program @samp{z-compile}, which should be invoked with the
630d3d5a 6664command-line switch @option{-input} and with the result of performing the
a743d340
NC
6665@samp{%i} substitution. (See below.)
6666
6667As an alternative to providing a spec string, the text that follows a
6668suffix directive can be one of the following:
6669
6670@table @code
6671@item @@@var{language}
6672This says that the suffix is an alias for a known @var{language}. This is
bedc7537 6673similar to using the @option{-x} command-line switch to GCC to specify a
a743d340
NC
6674language explicitly. For example:
6675
6676@smallexample
6677.ZZ:
6678@@c++
6679@end smallexample
6680
6681Says that .ZZ files are, in fact, C++ source files.
6682
6683@item #@var{name}
6684This causes an error messages saying:
6685
6686@smallexample
6687@var{name} compiler not installed on this system.
6688@end smallexample
6689@end table
6690
6691GCC already has an extensive list of suffixes built into it.
6692This directive will add an entry to the end of the list of suffixes, but
6693since the list is searched from the end backwards, it is effectively
6694possible to override earlier entries using this technique.
6695
6696@end table
6697
6698GCC has the following spec strings built into it. Spec files can
6699override these strings or create their own. Note that individual
02f52e19 6700targets can also add their own spec strings to this list.
a743d340
NC
6701
6702@smallexample
6703asm Options to pass to the assembler
6704asm_final Options to pass to the assembler post-processor
6705cpp Options to pass to the C preprocessor
6706cc1 Options to pass to the C compiler
6707cc1plus Options to pass to the C++ compiler
6708endfile Object files to include at the end of the link
6709link Options to pass to the linker
6710lib Libraries to include on the command line to the linker
6711libgcc Decides which GCC support library to pass to the linker
6712linker Sets the name of the linker
6713predefines Defines to be passed to the C preprocessor
310668e8
JM
6714signed_char Defines to pass to CPP to say whether @code{char} is signed
6715 by default
a743d340
NC
6716startfile Object files to include at the start of the link
6717@end smallexample
6718
6719Here is a small example of a spec file:
6720
6721@smallexample
6722%rename lib old_lib
6723
6724*lib:
6725--start-group -lgcc -lc -leval1 --end-group %(old_lib)
6726@end smallexample
6727
6728This example renames the spec called @samp{lib} to @samp{old_lib} and
6729then overrides the previous definition of @samp{lib} with a new one.
6730The new definition adds in some extra command-line options before
6731including the text of the old definition.
6732
6733@dfn{Spec strings} are a list of command-line options to be passed to their
6734corresponding program. In addition, the spec strings can contain
6735@samp{%}-prefixed sequences to substitute variable text or to
6736conditionally insert text into the command line. Using these constructs
6737it is possible to generate quite complex command lines.
6738
6739Here is a table of all defined @samp{%}-sequences for spec
6740strings. Note that spaces are not generated automatically around the
6741results of expanding these sequences. Therefore you can concatenate them
02f52e19 6742together or combine them with constant text in a single argument.
a743d340
NC
6743
6744@table @code
6745@item %%
6746Substitute one @samp{%} into the program name or argument.
6747
6748@item %i
6749Substitute the name of the input file being processed.
6750
6751@item %b
6752Substitute the basename of the input file being processed.
6753This is the substring up to (and not including) the last period
6754and not including the directory.
6755
371e300b
NC
6756@item %B
6757This is the same as @samp{%b}, but include the file suffix (text after
6758the last period).
6759
a743d340
NC
6760@item %d
6761Marks the argument containing or following the @samp{%d} as a
6762temporary file name, so that that file will be deleted if GCC exits
6763successfully. Unlike @samp{%g}, this contributes no text to the
02f52e19 6764argument.
a743d340
NC
6765
6766@item %g@var{suffix}
6767Substitute a file name that has suffix @var{suffix} and is chosen
6768once per compilation, and mark the argument in the same way as
6769@samp{%d}. To reduce exposure to denial-of-service attacks, the file
02f52e19 6770name is now chosen in a way that is hard to predict even when previously
695ac33f 6771chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
a743d340
NC
6772might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
6773the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6774treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
6775was simply substituted with a file name chosen once per compilation,
6776without regard to any appended suffix (which was therefore treated
6777just like ordinary text), making such attacks more likely to succeed.
6778
6779@item %u@var{suffix}
6780Like @samp{%g}, but generates a new temporary file name even if
6781@samp{%u@var{suffix}} was already seen.
6782
6783@item %U@var{suffix}
6784Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6785new one if there is no such last file name. In the absence of any
6786@samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
695ac33f 6787the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
a743d340
NC
6788would involve the generation of two distinct file names, one
6789for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
6790simply substituted with a file name chosen for the previous @samp{%u},
6791without regard to any appended suffix.
6792
4977bab6 6793@item %j@var{suffix}
aee96fe9 6794Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
371e300b
NC
6795writable, and if save-temps is off; otherwise, substitute the name
6796of a temporary file, just like @samp{%u}. This temporary file is not
6797meant for communication between processes, but rather as a junk
6798disposal mechanism.
6799
4977bab6
ZW
6800@item %|@var{suffix}
6801@itemx %m@var{suffix}
6802Like @samp{%g}, except if @option{-pipe} is in effect. In that case
6803@samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6804all. These are the two most common ways to instruct a program that it
6805should read from standard input or write to standard output. If you
6806need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6807construct: see for example @file{f/lang-specs.h}.
6808
371e300b
NC
6809@item %.@var{SUFFIX}
6810Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
767094dd 6811when it is subsequently output with @samp{%*}. @var{SUFFIX} is
371e300b
NC
6812terminated by the next space or %.
6813
a743d340
NC
6814@item %w
6815Marks the argument containing or following the @samp{%w} as the
6816designated output file of this compilation. This puts the argument
6817into the sequence of arguments that @samp{%o} will substitute later.
6818
6819@item %o
6820Substitutes the names of all the output files, with spaces
6821automatically placed around them. You should write spaces
6822around the @samp{%o} as well or the results are undefined.
6823@samp{%o} is for use in the specs for running the linker.
6824Input files whose names have no recognized suffix are not compiled
6825at all, but they are included among the output files, so they will
6826be linked.
6827
6828@item %O
6829Substitutes the suffix for object files. Note that this is
6830handled specially when it immediately follows @samp{%g, %u, or %U},
6831because of the need for those to form complete file names. The
6832handling is such that @samp{%O} is treated exactly as if it had already
6833been substituted, except that @samp{%g, %u, and %U} do not currently
6834support additional @var{suffix} characters following @samp{%O} as they would
6835following, for example, @samp{.o}.
6836
6837@item %p
6838Substitutes the standard macro predefinitions for the
6839current target machine. Use this when running @code{cpp}.
6840
6841@item %P
6842Like @samp{%p}, but puts @samp{__} before and after the name of each
6843predefined macro, except for macros that start with @samp{__} or with
c1030c7c 6844@samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
161d7b59 6845C@.
a743d340
NC
6846
6847@item %I
047d636f
DJ
6848Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6849@option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6850@option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6851as necessary.
a743d340
NC
6852
6853@item %s
6854Current argument is the name of a library or startup file of some sort.
6855Search for that file in a standard list of directories and substitute
02f52e19 6856the full name found.
a743d340
NC
6857
6858@item %e@var{str}
6859Print @var{str} as an error message. @var{str} is terminated by a newline.
6860Use this when inconsistent options are detected.
6861
a743d340
NC
6862@item %(@var{name})
6863Substitute the contents of spec string @var{name} at this point.
6864
6865@item %[@var{name}]
630d3d5a 6866Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
a743d340
NC
6867
6868@item %x@{@var{option}@}
6869Accumulate an option for @samp{%X}.
6870
6871@item %X
630d3d5a 6872Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
a743d340
NC
6873spec string.
6874
6875@item %Y
630d3d5a 6876Output the accumulated assembler options specified by @option{-Wa}.
a743d340
NC
6877
6878@item %Z
630d3d5a 6879Output the accumulated preprocessor options specified by @option{-Wp}.
a743d340 6880
a743d340
NC
6881@item %a
6882Process the @code{asm} spec. This is used to compute the
6883switches to be passed to the assembler.
6884
6885@item %A
6886Process the @code{asm_final} spec. This is a spec string for
6887passing switches to an assembler post-processor, if such a program is
6888needed.
6889
6890@item %l
6891Process the @code{link} spec. This is the spec for computing the
6892command line passed to the linker. Typically it will make use of the
6893@samp{%L %G %S %D and %E} sequences.
6894
6895@item %D
630d3d5a 6896Dump out a @option{-L} option for each directory that GCC believes might
a743d340 6897contain startup files. If the target supports multilibs then the
02f52e19 6898current multilib directory will be prepended to each of these paths.
a743d340
NC
6899
6900@item %L
6901Process the @code{lib} spec. This is a spec string for deciding which
02f52e19 6902libraries should be included on the command line to the linker.
a743d340
NC
6903
6904@item %G
6905Process the @code{libgcc} spec. This is a spec string for deciding
02f52e19 6906which GCC support library should be included on the command line to the linker.
a743d340
NC
6907
6908@item %S
6909Process the @code{startfile} spec. This is a spec for deciding which
6910object files should be the first ones passed to the linker. Typically
02f52e19 6911this might be a file named @file{crt0.o}.
a743d340
NC
6912
6913@item %E
6914Process the @code{endfile} spec. This is a spec string that specifies
02f52e19 6915the last object files that will be passed to the linker.
a743d340
NC
6916
6917@item %C
6918Process the @code{cpp} spec. This is used to construct the arguments
6919to be passed to the C preprocessor.
6920
a743d340
NC
6921@item %1
6922Process the @code{cc1} spec. This is used to construct the options to be
6923passed to the actual C compiler (@samp{cc1}).
6924
6925@item %2
6926Process the @code{cc1plus} spec. This is used to construct the options to be
6927passed to the actual C++ compiler (@samp{cc1plus}).
6928
6929@item %*
6930Substitute the variable part of a matched option. See below.
6931Note that each comma in the substituted string is replaced by
6932a single space.
6933
4977bab6
ZW
6934@item %<@code{S}
6935Remove all occurrences of @code{-S} from the command line. Note---this
6936command is position dependent. @samp{%} commands in the spec string
6937before this one will see @code{-S}, @samp{%} commands in the spec string
6938after this one will not.
6939
f3226a90
JT
6940@item %:@var{function}(@var{args})
6941Call the named function @var{function}, passing it @var{args}.
6942@var{args} is first processed as a nested spec string, then split
6943into an argument vector in the usual fashion. The function returns
6944a string which is processed as if it had appeared literally as part
6945of the current spec.
6946
6947The following built-in spec functions are provided:
6948
6949@table @code
6950@item @code{if-exists}
6951The @code{if-exists} spec function takes one argument, an absolute
6952pathname to a file. If the file exists, @code{if-exists} returns the
6953pathname. Here is a small example of its usage:
6954
6955@smallexample
6956*startfile:
6957crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6958@end smallexample
152a5a9c
JT
6959
6960@item @code{if-exists-else}
6961The @code{if-exists-else} spec function is similar to the @code{if-exists}
6962spec function, except that it takes two arguments. The first argument is
6963an absolute pathname to a file. If the file exists, @code{if-exists-else}
6964returns the pathname. If it does not exist, it returns the second argument.
6965This way, @code{if-exists-else} can be used to select one file or another,
6966based on the existence of the first. Here is a small example of its usage:
6967
daf2f129 6968@smallexample
152a5a9c 6969*startfile:
f5034c5e
JM
6970crt0%O%s %:if-exists(crti%O%s) \
6971%:if-exists-else(crtbeginT%O%s crtbegin%O%s)
152a5a9c 6972@end smallexample
3dd53121
AP
6973
6974@item @code{replace-outfile}
6975The @code{replace-outfile} spec function takes two arguments. It looks for the
6976first argument in the outfiles array and replaces it with the second argument. Here
6977is a small example of its usage:
6978
6979@smallexample
6980%@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6981@end smallexample
6982
daf2f129 6983@end table
f3226a90 6984
a743d340 6985@item %@{@code{S}@}
161d7b59 6986Substitutes the @code{-S} switch, if that switch was given to GCC@.
a743d340
NC
6987If that switch was not specified, this substitutes nothing. Note that
6988the leading dash is omitted when specifying this option, and it is
6989automatically inserted if the substitution is performed. Thus the spec
630d3d5a
JM
6990string @samp{%@{foo@}} would match the command-line option @option{-foo}
6991and would output the command line option @option{-foo}.
a743d340
NC
6992
6993@item %W@{@code{S}@}
6994Like %@{@code{S}@} but mark last argument supplied within as a file to be
02f52e19 6995deleted on failure.
a743d340
NC
6996
6997@item %@{@code{S}*@}
6998Substitutes all the switches specified to GCC whose names start
6999with @code{-S}, but which also take an argument. This is used for
695ac33f 7000switches like @option{-o}, @option{-D}, @option{-I}, etc.
630d3d5a 7001GCC considers @option{-o foo} as being
a743d340 7002one switch whose names starts with @samp{o}. %@{o*@} would substitute this
02f52e19 7003text, including the space. Thus two arguments would be generated.
a743d340 7004
371e300b
NC
7005@item %@{@code{S}*&@code{T}*@}
7006Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7007(the order of @code{S} and @code{T} in the spec is not significant).
7008There can be any number of ampersand-separated variables; for each the
7009wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
7010
a743d340 7011@item %@{@code{S}:@code{X}@}
4977bab6 7012Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
a743d340
NC
7013
7014@item %@{!@code{S}:@code{X}@}
4977bab6 7015Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
a743d340 7016
4977bab6
ZW
7017@item %@{@code{S}*:@code{X}@}
7018Substitutes @code{X} if one or more switches whose names start with
7019@code{-S} are specified to GCC@. Normally @code{X} is substituted only
7020once, no matter how many such switches appeared. However, if @code{%*}
7021appears somewhere in @code{X}, then @code{X} will be substituted once
7022for each matching switch, with the @code{%*} replaced by the part of
7023that switch that matched the @code{*}.
a743d340
NC
7024
7025@item %@{.@code{S}:@code{X}@}
4977bab6 7026Substitutes @code{X}, if processing a file with suffix @code{S}.
a743d340
NC
7027
7028@item %@{!.@code{S}:@code{X}@}
4977bab6 7029Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
a743d340
NC
7030
7031@item %@{@code{S}|@code{P}:@code{X}@}
4977bab6
ZW
7032Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7033This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7034although they have a stronger binding than the @samp{|}. If @code{%*}
7035appears in @code{X}, all of the alternatives must be starred, and only
7036the first matching alternative is substituted.
7037
7038For example, a spec string like this:
a743d340
NC
7039
7040@smallexample
7041%@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7042@end smallexample
7043
7044will output the following command-line options from the following input
7045command-line options:
7046
7047@smallexample
7048fred.c -foo -baz
7049jim.d -bar -boggle
7050-d fred.c -foo -baz -boggle
7051-d jim.d -bar -baz -boggle
7052@end smallexample
7053
4977bab6
ZW
7054@item %@{S:X; T:Y; :D@}
7055
c0cbdbd9
KH
7056If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7057given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
daf2f129 7058be as many clauses as you need. This may be combined with @code{.},
4977bab6
ZW
7059@code{!}, @code{|}, and @code{*} as needed.
7060
7061
a743d340
NC
7062@end table
7063
4977bab6
ZW
7064The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7065construct may contain other nested @samp{%} constructs or spaces, or
7066even newlines. They are processed as usual, as described above.
7067Trailing white space in @code{X} is ignored. White space may also
7068appear anywhere on the left side of the colon in these constructs,
7069except between @code{.} or @code{*} and the corresponding word.
a743d340 7070
4977bab6
ZW
7071The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7072handled specifically in these constructs. If another value of
7073@option{-O} or the negated form of a @option{-f}, @option{-m}, or
7074@option{-W} switch is found later in the command line, the earlier
7075switch value is ignored, except with @{@code{S}*@} where @code{S} is
7076just one letter, which passes all matching options.
a743d340 7077
4977bab6
ZW
7078The character @samp{|} at the beginning of the predicate text is used to
7079indicate that a command should be piped to the following command, but
7080only if @option{-pipe} is specified.
a743d340
NC
7081
7082It is built into GCC which switches take arguments and which do not.
7083(You might think it would be useful to generalize this to allow each
7084compiler's spec to say which switches take arguments. But this cannot
7085be done in a consistent fashion. GCC cannot even decide which input
7086files have been specified without knowing which switches take arguments,
7087and it must know which input files to compile in order to tell which
02f52e19 7088compilers to run).
a743d340 7089
630d3d5a 7090GCC also knows implicitly that arguments starting in @option{-l} are to be
a743d340
NC
7091treated as compiler output files, and passed to the linker in their
7092proper position among the other output files.
7093
ee457005
JM
7094@c man begin OPTIONS
7095
74291a4b
MM
7096@node Target Options
7097@section Specifying Target Machine and Compiler Version
7098@cindex target options
7099@cindex cross compiling
7100@cindex specifying machine version
7101@cindex specifying compiler version and target machine
7102@cindex compiler version, specifying
7103@cindex target machine, specifying
7104
37a4aa31
GK
7105The usual way to run GCC is to run the executable called @file{gcc}, or
7106@file{<machine>-gcc} when cross-compiling, or
7107@file{<machine>-gcc-<version>} to run a version other than the one that
7108was installed last. Sometimes this is inconvenient, so GCC provides
7109options that will switch to another cross-compiler or version.
74291a4b 7110
2642624b 7111@table @gcctabopt
74291a4b 7112@item -b @var{machine}
cd3bb277 7113@opindex b
74291a4b 7114The argument @var{machine} specifies the target machine for compilation.
74291a4b
MM
7115
7116The value to use for @var{machine} is the same as was specified as the
0c2d1a2a 7117machine type when configuring GCC as a cross-compiler. For
74291a4b 7118example, if a cross-compiler was configured with @samp{configure
3300bf07
PG
7119arm-elf}, meaning to compile for an arm processor with elf binaries,
7120then you would specify @option{-b arm-elf} to run that cross compiler.
7121Because there are other options beginning with @option{-b}, the
7122configuration must contain a hyphen.
74291a4b 7123
37a4aa31
GK
7124@item -V @var{version}
7125@opindex V
7126The argument @var{version} specifies which version of GCC to run.
7127This is useful when multiple versions are installed. For example,
3300bf07 7128@var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
74291a4b
MM
7129@end table
7130
37a4aa31
GK
7131The @option{-V} and @option{-b} options work by running the
7132@file{<machine>-gcc-<version>} executable, so there's no real reason to
7133use them if you can just run that directly.
74291a4b
MM
7134
7135@node Submodel Options
7136@section Hardware Models and Configurations
7137@cindex submodel options
7138@cindex specifying hardware config
7139@cindex hardware models and configurations, specifying
7140@cindex machine dependent options
7141
630d3d5a 7142Earlier we discussed the standard option @option{-b} which chooses among
74291a4b 7143different installed compilers for completely different target
8aeea6e6 7144machines, such as VAX vs.@: 68000 vs.@: 80386.
74291a4b
MM
7145
7146In addition, each of these target machine types can have its own
7147special options, starting with @samp{-m}, to choose among various
7148hardware models or configurations---for example, 68010 vs 68020,
7149floating coprocessor or none. A single installed version of the
7150compiler can compile for any model or configuration, according to the
7151options specified.
7152
7153Some configurations of the compiler also support additional special
7154options, usually for compatibility with other compilers on the same
7155platform.
7156
39bc1876
NS
7157@c This list is ordered alphanumerically by subsection name.
7158@c It should be the same order and spelling as these options are listed
7159@c in Machine Dependent Options
7160
74291a4b 7161@menu
39bc1876 7162* ARC Options::
74291a4b 7163* ARM Options::
39bc1876 7164* AVR Options::
0d4a78eb 7165* Blackfin Options::
39bc1876 7166* CRIS Options::
53054e77 7167* CRX Options::
48aec0bc 7168* Darwin Options::
74291a4b 7169* DEC Alpha Options::
d7c23cdc 7170* DEC Alpha/VMS Options::
39bc1876 7171* FRV Options::
74291a4b 7172* H8/300 Options::
39bc1876
NS
7173* HPPA Options::
7174* i386 and x86-64 Options::
7175* IA-64 Options::
38b2d076 7176* M32C Options::
39bc1876
NS
7177* M32R/D Options::
7178* M680x0 Options::
7179* M68hc1x Options::
7180* MCore Options::
7181* MIPS Options::
7182* MMIX Options::
7183* MN10300 Options::
6c9ac67a 7184* MT Options::
39bc1876
NS
7185* PDP-11 Options::
7186* PowerPC Options::
7187* RS/6000 and PowerPC Options::
7188* S/390 and zSeries Options::
74291a4b 7189* SH Options::
39bc1876 7190* SPARC Options::
74291a4b 7191* System V Options::
282a61e6 7192* TMS320C3x/C4x Options::
f84271d9 7193* V850 Options::
39bc1876
NS
7194* VAX Options::
7195* x86-64 Options::
69a0611f 7196* Xstormy16 Options::
03984308 7197* Xtensa Options::
39bc1876 7198* zSeries Options::
74291a4b
MM
7199@end menu
7200
39bc1876
NS
7201@node ARC Options
7202@subsection ARC Options
7203@cindex ARC Options
74291a4b 7204
39bc1876 7205These options are defined for ARC implementations:
74291a4b 7206
2642624b 7207@table @gcctabopt
39bc1876
NS
7208@item -EL
7209@opindex EL
7210Compile code for little endian mode. This is the default.
74cf1c6d 7211
39bc1876
NS
7212@item -EB
7213@opindex EB
7214Compile code for big endian mode.
74291a4b 7215
39bc1876
NS
7216@item -mmangle-cpu
7217@opindex mmangle-cpu
7218Prepend the name of the cpu to all public symbol names.
7219In multiple-processor systems, there are many ARC variants with different
7220instruction and register set characteristics. This flag prevents code
7221compiled for one cpu to be linked with code compiled for another.
7222No facility exists for handling variants that are ``almost identical''.
7223This is an all or nothing option.
74291a4b 7224
39bc1876
NS
7225@item -mcpu=@var{cpu}
7226@opindex mcpu
7227Compile code for ARC variant @var{cpu}.
7228Which variants are supported depend on the configuration.
7229All variants support @option{-mcpu=base}, this is the default.
74291a4b 7230
39bc1876
NS
7231@item -mtext=@var{text-section}
7232@itemx -mdata=@var{data-section}
7233@itemx -mrodata=@var{readonly-data-section}
7234@opindex mtext
7235@opindex mdata
7236@opindex mrodata
7237Put functions, data, and readonly data in @var{text-section},
7238@var{data-section}, and @var{readonly-data-section} respectively
7239by default. This can be overridden with the @code{section} attribute.
7240@xref{Variable Attributes}.
74291a4b 7241
39bc1876 7242@end table
74291a4b 7243
39bc1876
NS
7244@node ARM Options
7245@subsection ARM Options
7246@cindex ARM options
74291a4b 7247
39bc1876
NS
7248These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7249architectures:
74cf1c6d 7250
39bc1876
NS
7251@table @gcctabopt
7252@item -mabi=@var{name}
7253@opindex mabi
8a36672b 7254Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
077fc835 7255@samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
74cf1c6d 7256
39bc1876
NS
7257@item -mapcs-frame
7258@opindex mapcs-frame
7259Generate a stack frame that is compliant with the ARM Procedure Call
7260Standard for all functions, even if this is not strictly necessary for
7261correct execution of the code. Specifying @option{-fomit-frame-pointer}
7262with this option will cause the stack frames not to be generated for
7263leaf functions. The default is @option{-mno-apcs-frame}.
74291a4b 7264
39bc1876
NS
7265@item -mapcs
7266@opindex mapcs
7267This is a synonym for @option{-mapcs-frame}.
74291a4b 7268
39bc1876
NS
7269@ignore
7270@c not currently implemented
7271@item -mapcs-stack-check
7272@opindex mapcs-stack-check
7273Generate code to check the amount of stack space available upon entry to
7274every function (that actually uses some stack space). If there is
7275insufficient space available then either the function
7276@samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7277called, depending upon the amount of stack space required. The run time
7278system is required to provide these functions. The default is
7279@option{-mno-apcs-stack-check}, since this produces smaller code.
74cf1c6d 7280
39bc1876
NS
7281@c not currently implemented
7282@item -mapcs-float
7283@opindex mapcs-float
7284Pass floating point arguments using the float point registers. This is
7285one of the variants of the APCS@. This option is recommended if the
7286target hardware has a floating point unit or if a lot of floating point
7287arithmetic is going to be performed by the code. The default is
7288@option{-mno-apcs-float}, since integer only code is slightly increased in
7289size if @option{-mapcs-float} is used.
74291a4b 7290
39bc1876
NS
7291@c not currently implemented
7292@item -mapcs-reentrant
7293@opindex mapcs-reentrant
7294Generate reentrant, position independent code. The default is
7295@option{-mno-apcs-reentrant}.
7296@end ignore
74291a4b 7297
39bc1876
NS
7298@item -mthumb-interwork
7299@opindex mthumb-interwork
7300Generate code which supports calling between the ARM and Thumb
7301instruction sets. Without this option the two instruction sets cannot
7302be reliably used inside one program. The default is
7303@option{-mno-thumb-interwork}, since slightly larger code is generated
7304when @option{-mthumb-interwork} is specified.
7305
7306@item -mno-sched-prolog
7307@opindex mno-sched-prolog
7308Prevent the reordering of instructions in the function prolog, or the
7309merging of those instruction with the instructions in the function's
7310body. This means that all functions will start with a recognizable set
7311of instructions (or in fact one of a choice from a small set of
7312different function prologues), and this information can be used to
7313locate the start if functions inside an executable piece of code. The
7314default is @option{-msched-prolog}.
7315
7316@item -mhard-float
7317@opindex mhard-float
7318Generate output containing floating point instructions. This is the
7319default.
861bb6c1 7320
74291a4b 7321@item -msoft-float
cd3bb277 7322@opindex msoft-float
74291a4b 7323Generate output containing library calls for floating point.
39bc1876 7324@strong{Warning:} the requisite libraries are not available for all ARM
74291a4b 7325targets. Normally the facilities of the machine's usual C compiler are
39bc1876
NS
7326used, but this cannot be done directly in cross-compilation. You must make
7327your own arrangements to provide suitable library functions for
7328cross-compilation.
74291a4b 7329
39bc1876
NS
7330@option{-msoft-float} changes the calling convention in the output file;
7331therefore, it is only useful if you compile @emph{all} of a program with
7332this option. In particular, you need to compile @file{libgcc.a}, the
7333library that comes with GCC, with @option{-msoft-float} in order for
7334this to work.
74291a4b 7335
39bc1876
NS
7336@item -mfloat-abi=@var{name}
7337@opindex mfloat-abi
7338Specifies which ABI to use for floating point values. Permissible values
7339are: @samp{soft}, @samp{softfp} and @samp{hard}.
74291a4b 7340
39bc1876
NS
7341@samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7342and @option{-mhard-float} respectively. @samp{softfp} allows the generation
7343of floating point instructions, but still uses the soft-float calling
7344conventions.
74291a4b 7345
39bc1876
NS
7346@item -mlittle-endian
7347@opindex mlittle-endian
7348Generate code for a processor running in little-endian mode. This is
7349the default for all standard configurations.
74291a4b 7350
39bc1876
NS
7351@item -mbig-endian
7352@opindex mbig-endian
7353Generate code for a processor running in big-endian mode; the default is
7354to compile code for a little-endian processor.
74291a4b 7355
39bc1876
NS
7356@item -mwords-little-endian
7357@opindex mwords-little-endian
7358This option only applies when generating code for big-endian processors.
7359Generate code for a little-endian word order but a big-endian byte
7360order. That is, a byte order of the form @samp{32107654}. Note: this
7361option should only be used if you require compatibility with code for
7362big-endian ARM processors generated by versions of the compiler prior to
73632.8.
74291a4b 7364
39bc1876
NS
7365@item -mcpu=@var{name}
7366@opindex mcpu
7367This specifies the name of the target ARM processor. GCC uses this name
7368to determine what kind of instructions it can emit when generating
7369assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
7370@samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7371@samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7372@samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7373@samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
d98a72fd
RE
7374@samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7375@samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
39bc1876 7376@samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
d98a72fd
RE
7377@samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7378@samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7379@samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
f9e8581a 7380@samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
fa91adc6
PB
7381@samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7382@samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
39bc1876 7383@samp{ep9312}.
74291a4b 7384
39bc1876
NS
7385@itemx -mtune=@var{name}
7386@opindex mtune
7387This option is very similar to the @option{-mcpu=} option, except that
7388instead of specifying the actual target processor type, and hence
7389restricting which instructions can be used, it specifies that GCC should
7390tune the performance of the code as if the target were of the type
7391specified in this option, but still choosing the instructions that it
7392will generate based on the cpu specified by a @option{-mcpu=} option.
7393For some ARM implementations better performance can be obtained by using
7394this option.
861bb6c1 7395
39bc1876
NS
7396@item -march=@var{name}
7397@opindex march
7398This specifies the name of the target ARM architecture. GCC uses this
7399name to determine what kind of instructions it can emit when generating
7400assembly code. This option can be used in conjunction with or instead
7401of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
7402@samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7403@samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7404@samp{iwmmxt}, @samp{ep9312}.
861bb6c1 7405
39bc1876
NS
7406@item -mfpu=@var{name}
7407@itemx -mfpe=@var{number}
7408@itemx -mfp=@var{number}
7409@opindex mfpu
7410@opindex mfpe
7411@opindex mfp
7412This specifies what floating point hardware (or hardware emulation) is
7413available on the target. Permissible names are: @samp{fpa}, @samp{fpe2},
7414@samp{fpe3}, @samp{maverick}, @samp{vfp}. @option{-mfp} and @option{-mfpe}
7415are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7416with older versions of GCC@.
861bb6c1 7417
39bc1876
NS
7418If @option{-msoft-float} is specified this specifies the format of
7419floating point values.
fb868474 7420
39bc1876
NS
7421@item -mstructure-size-boundary=@var{n}
7422@opindex mstructure-size-boundary
7423The size of all structures and unions will be rounded up to a multiple
7424of the number of bits set by this option. Permissible values are 8, 32
7425and 64. The default value varies for different toolchains. For the COFF
7426targeted toolchain the default value is 8. A value of 64 is only allowed
7427if the underlying ABI supports it.
b71733d5 7428
39bc1876
NS
7429Specifying the larger number can produce faster, more efficient code, but
7430can also increase the size of the program. Different values are potentially
7431incompatible. Code compiled with one value cannot necessarily expect to
7432work with code or libraries compiled with another value, if they exchange
7433information using structures or unions.
24f9c4df 7434
39bc1876
NS
7435@item -mabort-on-noreturn
7436@opindex mabort-on-noreturn
7437Generate a call to the function @code{abort} at the end of a
7438@code{noreturn} function. It will be executed if the function tries to
7439return.
24f9c4df 7440
39bc1876
NS
7441@item -mlong-calls
7442@itemx -mno-long-calls
7443@opindex mlong-calls
7444@opindex mno-long-calls
7445Tells the compiler to perform function calls by first loading the
7446address of the function into a register and then performing a subroutine
7447call on this register. This switch is needed if the target function
7448will lie outside of the 64 megabyte addressing range of the offset based
7449version of subroutine call instruction.
24f9c4df 7450
39bc1876
NS
7451Even if this switch is enabled, not all function calls will be turned
7452into long calls. The heuristic is that static functions, functions
7453which have the @samp{short-call} attribute, functions that are inside
7454the scope of a @samp{#pragma no_long_calls} directive and functions whose
7455definitions have already been compiled within the current compilation
7456unit, will not be turned into long calls. The exception to this rule is
7457that weak function definitions, functions with the @samp{long-call}
7458attribute or the @samp{section} attribute, and functions that are within
7459the scope of a @samp{#pragma long_calls} directive, will always be
7460turned into long calls.
24f9c4df 7461
39bc1876
NS
7462This feature is not enabled by default. Specifying
7463@option{-mno-long-calls} will restore the default behavior, as will
7464placing the function calls within the scope of a @samp{#pragma
7465long_calls_off} directive. Note these switches have no effect on how
7466the compiler generates code to handle function calls via function
7467pointers.
24f9c4df 7468
39bc1876
NS
7469@item -mnop-fun-dllimport
7470@opindex mnop-fun-dllimport
7471Disable support for the @code{dllimport} attribute.
74291a4b 7472
39bc1876
NS
7473@item -msingle-pic-base
7474@opindex msingle-pic-base
7475Treat the register used for PIC addressing as read-only, rather than
7476loading it in the prologue for each function. The run-time system is
7477responsible for initializing this register with an appropriate value
7478before execution begins.
2856c3e3 7479
39bc1876
NS
7480@item -mpic-register=@var{reg}
7481@opindex mpic-register
7482Specify the register to be used for PIC addressing. The default is R10
7483unless stack-checking is enabled, when R9 is used.
2856c3e3 7484
39bc1876
NS
7485@item -mcirrus-fix-invalid-insns
7486@opindex mcirrus-fix-invalid-insns
7487@opindex mno-cirrus-fix-invalid-insns
7488Insert NOPs into the instruction stream to in order to work around
7489problems with invalid Maverick instruction combinations. This option
7490is only valid if the @option{-mcpu=ep9312} option has been used to
7491enable generation of instructions for the Cirrus Maverick floating
7492point co-processor. This option is not enabled by default, since the
7493problem is only present in older Maverick implementations. The default
7494can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7495switch.
2856c3e3 7496
39bc1876
NS
7497@item -mpoke-function-name
7498@opindex mpoke-function-name
7499Write the name of each function into the text section, directly
7500preceding the function prologue. The generated code is similar to this:
2856c3e3 7501
39bc1876
NS
7502@smallexample
7503 t0
7504 .ascii "arm_poke_function_name", 0
7505 .align
7506 t1
7507 .word 0xff000000 + (t1 - t0)
7508 arm_poke_function_name
7509 mov ip, sp
7510 stmfd sp!, @{fp, ip, lr, pc@}
7511 sub fp, ip, #4
7512@end smallexample
f077f169 7513
39bc1876
NS
7514When performing a stack backtrace, code can inspect the value of
7515@code{pc} stored at @code{fp + 0}. If the trace function then looks at
7516location @code{pc - 12} and the top 8 bits are set, then we know that
7517there is a function name embedded immediately preceding this location
7518and has length @code{((pc[-3]) & 0xff000000)}.
2856c3e3 7519
39bc1876
NS
7520@item -mthumb
7521@opindex mthumb
7522Generate code for the 16-bit Thumb instruction set. The default is to
7523use the 32-bit ARM instruction set.
8a0b86f5 7524
39bc1876
NS
7525@item -mtpcs-frame
7526@opindex mtpcs-frame
7527Generate a stack frame that is compliant with the Thumb Procedure Call
7528Standard for all non-leaf functions. (A leaf function is one that does
7529not call any other functions.) The default is @option{-mno-tpcs-frame}.
058edcdb 7530
39bc1876
NS
7531@item -mtpcs-leaf-frame
7532@opindex mtpcs-leaf-frame
7533Generate a stack frame that is compliant with the Thumb Procedure Call
7534Standard for all leaf functions. (A leaf function is one that does
7535not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
2856c3e3 7536
39bc1876
NS
7537@item -mcallee-super-interworking
7538@opindex mcallee-super-interworking
7539Gives all externally visible functions in the file being compiled an ARM
7540instruction set header which switches to Thumb mode before executing the
7541rest of the function. This allows these functions to be called from
7542non-interworking code.
7543
7544@item -mcaller-super-interworking
7545@opindex mcaller-super-interworking
7546Allows calls via function pointers (including virtual functions) to
7547execute correctly regardless of whether the target code has been
7548compiled for interworking or not. There is a small overhead in the cost
7549of executing a function pointer if this option is enabled.
2856c3e3 7550
d3585b76
DJ
7551@item -mtp=@var{name}
7552@opindex mtp
7553Specify the access model for the thread local storage pointer. The valid
7554models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7555@option{cp15}, which fetches the thread pointer from @code{cp15} directly
7556(supported in the arm6k architecture), and @option{auto}, which uses the
7557best available method for the selected processor. The default setting is
7558@option{auto}.
7559
2856c3e3
SC
7560@end table
7561
39bc1876
NS
7562@node AVR Options
7563@subsection AVR Options
7564@cindex AVR Options
74291a4b 7565
39bc1876 7566These options are defined for AVR implementations:
74291a4b 7567
2642624b 7568@table @gcctabopt
39bc1876
NS
7569@item -mmcu=@var{mcu}
7570@opindex mmcu
7571Specify ATMEL AVR instruction set or MCU type.
74291a4b 7572
39bc1876
NS
7573Instruction set avr1 is for the minimal AVR core, not supported by the C
7574compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7575attiny11, attiny12, attiny15, attiny28).
74291a4b 7576
39bc1876
NS
7577Instruction set avr2 (default) is for the classic AVR core with up to
75788K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7579at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7580at90c8534, at90s8535).
74291a4b 7581
39bc1876
NS
7582Instruction set avr3 is for the classic AVR core with up to 128K program
7583memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
74291a4b 7584
39bc1876
NS
7585Instruction set avr4 is for the enhanced AVR core with up to 8K program
7586memory space (MCU types: atmega8, atmega83, atmega85).
74291a4b 7587
39bc1876
NS
7588Instruction set avr5 is for the enhanced AVR core with up to 128K program
7589memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7590atmega64, atmega128, at43usb355, at94k).
74291a4b 7591
39bc1876
NS
7592@item -msize
7593@opindex msize
7594Output instruction sizes to the asm file.
74291a4b 7595
39bc1876
NS
7596@item -minit-stack=@var{N}
7597@opindex minit-stack
7598Specify the initial stack address, which may be a symbol or numeric value,
7599@samp{__stack} is the default.
74291a4b 7600
39bc1876
NS
7601@item -mno-interrupts
7602@opindex mno-interrupts
7603Generated code is not compatible with hardware interrupts.
7604Code size will be smaller.
74291a4b 7605
39bc1876
NS
7606@item -mcall-prologues
7607@opindex mcall-prologues
7608Functions prologues/epilogues expanded as call to appropriate
7609subroutines. Code size will be smaller.
74291a4b 7610
39bc1876
NS
7611@item -mno-tablejump
7612@opindex mno-tablejump
7613Do not generate tablejump insns which sometimes increase code size.
74291a4b 7614
39bc1876
NS
7615@item -mtiny-stack
7616@opindex mtiny-stack
7617Change only the low 8 bits of the stack pointer.
74291a4b 7618
39bc1876
NS
7619@item -mint8
7620@opindex mint8
8a36672b 7621Assume int to be 8 bit integer. This affects the sizes of all types: A
39bc1876 7622char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
8a36672b 7623and long long will be 4 bytes. Please note that this option does not
39bc1876
NS
7624comply to the C standards, but it will provide you with smaller code
7625size.
7626@end table
74291a4b 7627
0d4a78eb
BS
7628@node Blackfin Options
7629@subsection Blackfin Options
7630@cindex Blackfin Options
7631
7632@table @gcctabopt
7633@item -momit-leaf-frame-pointer
7634@opindex momit-leaf-frame-pointer
7635Don't keep the frame pointer in a register for leaf functions. This
7636avoids the instructions to save, set up and restore frame pointers and
7637makes an extra register available in leaf functions. The option
7638@option{-fomit-frame-pointer} removes the frame pointer for all functions
7639which might make debugging harder.
7640
3fb192d2
BS
7641@item -mspecld-anomaly
7642@opindex mspecld-anomaly
0d4a78eb
BS
7643When enabled, the compiler will ensure that the generated code does not
7644contain speculative loads after jump instructions. This option is enabled
7645by default.
7646
3fb192d2
BS
7647@item -mno-specld-anomaly
7648@opindex mno-specld-anomaly
0d4a78eb
BS
7649Don't generate extra code to prevent speculative loads from occurring.
7650
3fb192d2 7651@item -mcsync-anomaly
161c21b6 7652@opindex mcsync-anomaly
3fb192d2
BS
7653When enabled, the compiler will ensure that the generated code does not
7654contain CSYNC or SSYNC instructions too soon after conditional branches.
7655This option is enabled by default.
7656
7657@item -mno-csync-anomaly
161c21b6 7658@opindex mno-csync-anomaly
3fb192d2
BS
7659Don't generate extra code to prevent CSYNC or SSYNC instructions from
7660occurring too soon after a conditional branch.
7661
0d4a78eb 7662@item -mlow-64k
9821b257 7663@opindex mlow-64k
0d4a78eb
BS
7664When enabled, the compiler is free to take advantage of the knowledge that
7665the entire program fits into the low 64k of memory.
7666
7667@item -mno-low-64k
7668@opindex mno-low-64k
7669Assume that the program is arbitrarily large. This is the default.
7670
7671@item -mid-shared-library
7672@opindex mid-shared-library
7673Generate code that supports shared libraries via the library ID method.
7674This allows for execute in place and shared libraries in an environment
7675without virtual memory management. This option implies @option{-fPIC}.
7676
7677@item -mno-id-shared-library
7678@opindex mno-id-shared-library
7679Generate code that doesn't assume ID based shared libraries are being used.
7680This is the default.
7681
7682@item -mshared-library-id=n
7683@opindex mshared-library-id
7684Specified the identification number of the ID based shared library being
7685compiled. Specifying a value of 0 will generate more compact code, specifying
7686other values will force the allocation of that number to the current
7687library but is no more space or time efficient than omitting this option.
b6877196
BS
7688
7689@item -mlong-calls
7690@itemx -mno-long-calls
7691@opindex mlong-calls
7692@opindex mno-long-calls
7693Tells the compiler to perform function calls by first loading the
7694address of the function into a register and then performing a subroutine
7695call on this register. This switch is needed if the target function
7696will lie outside of the 24 bit addressing range of the offset based
7697version of subroutine call instruction.
7698
7699This feature is not enabled by default. Specifying
7700@option{-mno-long-calls} will restore the default behavior. Note these
7701switches have no effect on how the compiler generates code to handle
7702function calls via function pointers.
0d4a78eb
BS
7703@end table
7704
39bc1876
NS
7705@node CRIS Options
7706@subsection CRIS Options
7707@cindex CRIS Options
74291a4b 7708
39bc1876 7709These options are defined specifically for the CRIS ports.
74291a4b 7710
39bc1876
NS
7711@table @gcctabopt
7712@item -march=@var{architecture-type}
7713@itemx -mcpu=@var{architecture-type}
7714@opindex march
7715@opindex mcpu
7716Generate code for the specified architecture. The choices for
7717@var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
8a36672b 7718respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
39bc1876
NS
7719Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7720@samp{v10}.
c219ddf7 7721
39bc1876
NS
7722@item -mtune=@var{architecture-type}
7723@opindex mtune
7724Tune to @var{architecture-type} everything applicable about the generated
7725code, except for the ABI and the set of available instructions. The
7726choices for @var{architecture-type} are the same as for
7727@option{-march=@var{architecture-type}}.
54284728 7728
39bc1876
NS
7729@item -mmax-stack-frame=@var{n}
7730@opindex mmax-stack-frame
7731Warn when the stack frame of a function exceeds @var{n} bytes.
54284728 7732
39bc1876
NS
7733@item -melinux-stacksize=@var{n}
7734@opindex melinux-stacksize
7735Only available with the @samp{cris-axis-aout} target. Arranges for
7736indications in the program to the kernel loader that the stack of the
7737program should be set to @var{n} bytes.
54284728 7738
39bc1876
NS
7739@item -metrax4
7740@itemx -metrax100
7741@opindex metrax4
7742@opindex metrax100
7743The options @option{-metrax4} and @option{-metrax100} are synonyms for
7744@option{-march=v3} and @option{-march=v8} respectively.
c0498f43 7745
39bc1876
NS
7746@item -mmul-bug-workaround
7747@itemx -mno-mul-bug-workaround
7748@opindex mmul-bug-workaround
7749@opindex mno-mul-bug-workaround
7750Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7751models where it applies. This option is active by default.
c0498f43 7752
39bc1876
NS
7753@item -mpdebug
7754@opindex mpdebug
7755Enable CRIS-specific verbose debug-related information in the assembly
7756code. This option also has the effect to turn off the @samp{#NO_APP}
7757formatted-code indicator to the assembler at the beginning of the
7758assembly file.
c0498f43 7759
39bc1876
NS
7760@item -mcc-init
7761@opindex mcc-init
7762Do not use condition-code results from previous instruction; always emit
7763compare and test instructions before use of condition codes.
74291a4b 7764
39bc1876
NS
7765@item -mno-side-effects
7766@opindex mno-side-effects
7767Do not emit instructions with side-effects in addressing modes other than
7768post-increment.
238b11b5 7769
39bc1876
NS
7770@item -mstack-align
7771@itemx -mno-stack-align
7772@itemx -mdata-align
7773@itemx -mno-data-align
7774@itemx -mconst-align
7775@itemx -mno-const-align
7776@opindex mstack-align
7777@opindex mno-stack-align
7778@opindex mdata-align
7779@opindex mno-data-align
7780@opindex mconst-align
7781@opindex mno-const-align
7782These options (no-options) arranges (eliminate arrangements) for the
7783stack-frame, individual data and constants to be aligned for the maximum
7784single data access size for the chosen CPU model. The default is to
7785arrange for 32-bit alignment. ABI details such as structure layout are
7786not affected by these options.
238b11b5 7787
39bc1876
NS
7788@item -m32-bit
7789@itemx -m16-bit
7790@itemx -m8-bit
7791@opindex m32-bit
7792@opindex m16-bit
7793@opindex m8-bit
7794Similar to the stack- data- and const-align options above, these options
7795arrange for stack-frame, writable data and constants to all be 32-bit,
779616-bit or 8-bit aligned. The default is 32-bit alignment.
238b11b5 7797
39bc1876
NS
7798@item -mno-prologue-epilogue
7799@itemx -mprologue-epilogue
7800@opindex mno-prologue-epilogue
7801@opindex mprologue-epilogue
7802With @option{-mno-prologue-epilogue}, the normal function prologue and
7803epilogue that sets up the stack-frame are omitted and no return
7804instructions or return sequences are generated in the code. Use this
7805option only together with visual inspection of the compiled code: no
7806warnings or errors are generated when call-saved registers must be saved,
7807or storage for local variable needs to be allocated.
238b11b5 7808
39bc1876
NS
7809@item -mno-gotplt
7810@itemx -mgotplt
7811@opindex mno-gotplt
7812@opindex mgotplt
7813With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7814instruction sequences that load addresses for functions from the PLT part
7815of the GOT rather than (traditional on other architectures) calls to the
8a36672b 7816PLT@. The default is @option{-mgotplt}.
238b11b5 7817
39bc1876
NS
7818@item -maout
7819@opindex maout
7820Legacy no-op option only recognized with the cris-axis-aout target.
c0498f43 7821
39bc1876
NS
7822@item -melf
7823@opindex melf
7824Legacy no-op option only recognized with the cris-axis-elf and
7825cris-axis-linux-gnu targets.
74291a4b 7826
39bc1876
NS
7827@item -melinux
7828@opindex melinux
7829Only recognized with the cris-axis-aout target, where it selects a
7830GNU/linux-like multilib, include files and instruction set for
7831@option{-march=v8}.
ded17aad 7832
39bc1876
NS
7833@item -mlinux
7834@opindex mlinux
7835Legacy no-op option only recognized with the cris-axis-linux-gnu target.
ded17aad 7836
39bc1876
NS
7837@item -sim
7838@opindex sim
7839This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7840to link with input-output functions from a simulator library. Code,
7841initialized data and zero-initialized data are allocated consecutively.
74291a4b 7842
39bc1876
NS
7843@item -sim2
7844@opindex sim2
7845Like @option{-sim}, but pass linker options to locate initialized data at
78460x40000000 and zero-initialized data at 0x80000000.
74291a4b
MM
7847@end table
7848
53054e77
PW
7849@node CRX Options
7850@subsection CRX Options
7851@cindex CRX Options
7852
7853These options are defined specifically for the CRX ports.
7854
7855@table @gcctabopt
7856
7857@item -mmac
7858@opindex mmac
7859Enable the use of multiply-accumulate instructions. Disabled by default.
7860
7861@item -mpush-args
7862@opindex mpush-args
7863Push instructions will be used to pass outgoing arguments when functions
7864are called. Enabled by default.
7865@end table
7866
39bc1876
NS
7867@node Darwin Options
7868@subsection Darwin Options
7869@cindex Darwin options
74291a4b 7870
39bc1876 7871These options are defined for all architectures running the Darwin operating
965a7e90
GK
7872system.
7873
7874FSF GCC on Darwin does not create ``fat'' object files; it will create
7875an object file for the single architecture that it was built to
7876target. Apple's GCC on Darwin does create ``fat'' files if multiple
46bfe5e3
GK
7877@option{-arch} options are used; it does so by running the compiler or
7878linker multiple times and joining the results together with
7879@file{lipo}.
965a7e90 7880
46bfe5e3
GK
7881The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7882@samp{i686}) is determined by the flags that specify the ISA
7883that GCC is targetting, like @option{-mcpu} or @option{-march}. The
965a7e90 7884@option{-force_cpusubtype_ALL} option can be used to override this.
74291a4b 7885
38b974a6 7886The Darwin tools vary in their behavior when presented with an ISA
46bfe5e3
GK
7887mismatch. The assembler, @file{as}, will only permit instructions to
7888be used that are valid for the subtype of the file it is generating,
7889so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7890The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7891and print an error if asked to create a shared library with a less
7892restrictive subtype than its input files (for instance, trying to put
7893a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
7894for executables, @file{ld}, will quietly give the executable the most
7895restrictive subtype of any of its input files.
7896
2642624b 7897@table @gcctabopt
39bc1876
NS
7898@item -F@var{dir}
7899@opindex F
7900Add the framework directory @var{dir} to the head of the list of
7901directories to be searched for header files. These directories are
7902interleaved with those specified by @option{-I} options and are
7903scanned in a left-to-right order.
5848830f 7904
39bc1876
NS
7905A framework directory is a directory with frameworks in it. A
7906framework is a directory with a @samp{"Headers"} and/or
7907@samp{"PrivateHeaders"} directory contained directly in it that ends
7908in @samp{".framework"}. The name of a framework is the name of this
7909directory excluding the @samp{".framework"}. Headers associated with
7910the framework are found in one of those two directories, with
7911@samp{"Headers"} being searched first. A subframework is a framework
7912directory that is in a framework's @samp{"Frameworks"} directory.
7913Includes of subframework headers can only appear in a header of a
7914framework that contains the subframework, or in a sibling subframework
7915header. Two subframeworks are siblings if they occur in the same
7916framework. A subframework should not have the same name as a
7917framework, a warning will be issued if this is violated. Currently a
7918subframework cannot have subframeworks, in the future, the mechanism
7919may be extended to support this. The standard frameworks can be found
3e558e80
MS
7920in @samp{"/System/Library/Frameworks"} and
7921@samp{"/Library/Frameworks"}. An example include looks like
39bc1876
NS
7922@code{#include <Framework/header.h>}, where @samp{Framework} denotes
7923the name of the framework and header.h is found in the
7924@samp{"PrivateHeaders"} or @samp{"Headers"} directory.
157a620e 7925
7aded944
DP
7926@item -gused
7927@opindex -gused
8a36672b 7928Emit debugging information for symbols that are used. For STABS
7aded944 7929debugging format, this enables @option{-feliminate-unused-debug-symbols}.
8a36672b 7930This is by default ON@.
7aded944
DP
7931
7932@item -gfull
7933@opindex -gfull
7934Emit debugging information for all symbols and types.
7935
ed5b9f96
GK
7936@item -mmacosx-version-min=@var{version}
7937The earliest version of MacOS X that this executable will run on
7938is @var{version}. Typical values of @var{version} include @code{10.1},
7939@code{10.2}, and @code{10.3.9}.
7940
7941The default for this option is to make choices that seem to be most
7942useful.
7943
8f4220dc
MA
7944@item -mone-byte-bool
7945@opindex -mone-byte-bool
7946Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
f0eb93a8 7947By default @samp{sizeof(bool)} is @samp{4} when compiling for
8f4220dc
MA
7948Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7949option has no effect on x86.
7950
7951@strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7952to generate code that is not binary compatible with code generated
7953without that switch. Using this switch may require recompiling all
f0eb93a8 7954other modules in a program, including system libraries. Use this
8f4220dc
MA
7955switch to conform to a non-default data model.
7956
699c914a
MS
7957@item -mfix-and-continue
7958@itemx -ffix-and-continue
7959@itemx -findirect-data
7960@opindex mfix-and-continue
7961@opindex ffix-and-continue
7962@opindex findirect-data
7963Generate code suitable for fast turn around development. Needed to
7964enable gdb to dynamically load @code{.o} files into already running
7965programs. @option{-findirect-data} and @option{-ffix-and-continue}
7966are provided for backwards compatibility.
7967
39bc1876
NS
7968@item -all_load
7969@opindex all_load
7970Loads all members of static archive libraries.
7971See man ld(1) for more information.
74291a4b 7972
39bc1876
NS
7973@item -arch_errors_fatal
7974@opindex arch_errors_fatal
7975Cause the errors having to do with files that have the wrong architecture
7976to be fatal.
157a620e 7977
39bc1876
NS
7978@item -bind_at_load
7979@opindex bind_at_load
7980Causes the output file to be marked such that the dynamic linker will
7981bind all undefined references when the file is loaded or launched.
157a620e 7982
39bc1876
NS
7983@item -bundle
7984@opindex bundle
7985Produce a Mach-o bundle format file.
7986See man ld(1) for more information.
157a620e 7987
39bc1876
NS
7988@item -bundle_loader @var{executable}
7989@opindex bundle_loader
965a7e90 7990This option specifies the @var{executable} that will be loading the build
8a36672b 7991output file being linked. See man ld(1) for more information.
157a620e 7992
965a7e90
GK
7993@item -dynamiclib
7994@opindex -dynamiclib
7995When passed this option, GCC will produce a dynamic library instead of
7996an executable when linking, using the Darwin @file{libtool} command.
157a620e 7997
965a7e90
GK
7998@item -force_cpusubtype_ALL
7999@opindex -force_cpusubtype_ALL
8000This causes GCC's output file to have the @var{ALL} subtype, instead of
8001one controlled by the @option{-mcpu} or @option{-march} option.
8002
8003@item -allowable_client @var{client_name}
39bc1876
NS
8004@itemx -client_name
8005@itemx -compatibility_version
8006@itemx -current_version
5079843a 8007@itemx -dead_strip
39bc1876
NS
8008@itemx -dependency-file
8009@itemx -dylib_file
8010@itemx -dylinker_install_name
8011@itemx -dynamic
39bc1876
NS
8012@itemx -exported_symbols_list
8013@itemx -filelist
8014@itemx -flat_namespace
39bc1876
NS
8015@itemx -force_flat_namespace
8016@itemx -headerpad_max_install_names
8017@itemx -image_base
8018@itemx -init
8019@itemx -install_name
8020@itemx -keep_private_externs
8021@itemx -multi_module
8022@itemx -multiply_defined
8023@itemx -multiply_defined_unused
8024@itemx -noall_load
89aa5a20 8025@itemx -no_dead_strip_inits_and_terms
39bc1876
NS
8026@itemx -nofixprebinding
8027@itemx -nomultidefs
8028@itemx -noprebind
8029@itemx -noseglinkedit
8030@itemx -pagezero_size
8031@itemx -prebind
8032@itemx -prebind_all_twolevel_modules
8033@itemx -private_bundle
8034@itemx -read_only_relocs
8035@itemx -sectalign
8036@itemx -sectobjectsymbols
8037@itemx -whyload
8038@itemx -seg1addr
8039@itemx -sectcreate
8040@itemx -sectobjectsymbols
8041@itemx -sectorder
5826770c
DP
8042@itemx -segaddr
8043@itemx -segs_read_only_addr
8044@itemx -segs_read_write_addr
39bc1876
NS
8045@itemx -seg_addr_table
8046@itemx -seg_addr_table_filename
8047@itemx -seglinkedit
8048@itemx -segprot
8049@itemx -segs_read_only_addr
8050@itemx -segs_read_write_addr
8051@itemx -single_module
8052@itemx -static
8053@itemx -sub_library
8054@itemx -sub_umbrella
8055@itemx -twolevel_namespace
8056@itemx -umbrella
8057@itemx -undefined
8058@itemx -unexported_symbols_list
8059@itemx -weak_reference_mismatches
8060@itemx -whatsloaded
74291a4b 8061
39bc1876 8062@opindex allowable_client
39bc1876
NS
8063@opindex client_name
8064@opindex compatibility_version
8065@opindex current_version
5079843a 8066@opindex dead_strip
39bc1876
NS
8067@opindex dependency-file
8068@opindex dylib_file
8069@opindex dylinker_install_name
8070@opindex dynamic
39bc1876
NS
8071@opindex exported_symbols_list
8072@opindex filelist
8073@opindex flat_namespace
39bc1876
NS
8074@opindex force_flat_namespace
8075@opindex headerpad_max_install_names
8076@opindex image_base
8077@opindex init
8078@opindex install_name
8079@opindex keep_private_externs
8080@opindex multi_module
8081@opindex multiply_defined
8082@opindex multiply_defined_unused
8083@opindex noall_load
5079843a 8084@opindex no_dead_strip_inits_and_terms
39bc1876
NS
8085@opindex nofixprebinding
8086@opindex nomultidefs
8087@opindex noprebind
8088@opindex noseglinkedit
8089@opindex pagezero_size
8090@opindex prebind
8091@opindex prebind_all_twolevel_modules
8092@opindex private_bundle
8093@opindex read_only_relocs
8094@opindex sectalign
8095@opindex sectobjectsymbols
8096@opindex whyload
8097@opindex seg1addr
8098@opindex sectcreate
8099@opindex sectobjectsymbols
8100@opindex sectorder
5826770c
DP
8101@opindex segaddr
8102@opindex segs_read_only_addr
8103@opindex segs_read_write_addr
39bc1876
NS
8104@opindex seg_addr_table
8105@opindex seg_addr_table_filename
8106@opindex seglinkedit
8107@opindex segprot
8108@opindex segs_read_only_addr
8109@opindex segs_read_write_addr
8110@opindex single_module
8111@opindex static
8112@opindex sub_library
8113@opindex sub_umbrella
8114@opindex twolevel_namespace
8115@opindex umbrella
8116@opindex undefined
8117@opindex unexported_symbols_list
8118@opindex weak_reference_mismatches
8119@opindex whatsloaded
8120
965a7e90 8121These options are passed to the Darwin linker. The Darwin linker man page
39bc1876
NS
8122describes them in detail.
8123@end table
8124
8125@node DEC Alpha Options
8126@subsection DEC Alpha Options
8127
8128These @samp{-m} options are defined for the DEC Alpha implementations:
8129
8130@table @gcctabopt
8131@item -mno-soft-float
8132@itemx -msoft-float
8133@opindex mno-soft-float
cd3bb277 8134@opindex msoft-float
39bc1876
NS
8135Use (do not use) the hardware floating-point instructions for
8136floating-point operations. When @option{-msoft-float} is specified,
8137functions in @file{libgcc.a} will be used to perform floating-point
8138operations. Unless they are replaced by routines that emulate the
8139floating-point operations, or compiled in such a way as to call such
8140emulations routines, these routines will issue floating-point
8141operations. If you are compiling for an Alpha without floating-point
8142operations, you must ensure that the library is built so as not to call
8143them.
74291a4b 8144
39bc1876
NS
8145Note that Alpha implementations without floating-point operations are
8146required to have floating-point registers.
74291a4b 8147
39bc1876
NS
8148@item -mfp-reg
8149@itemx -mno-fp-regs
8150@opindex mfp-reg
8151@opindex mno-fp-regs
8152Generate code that uses (does not use) the floating-point register set.
8153@option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
8154register set is not used, floating point operands are passed in integer
8155registers as if they were integers and floating-point results are passed
8156in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
8157so any function with a floating-point argument or return value called by code
8158compiled with @option{-mno-fp-regs} must also be compiled with that
8159option.
9b66ebb1 8160
39bc1876
NS
8161A typical use of this option is building a kernel that does not use,
8162and hence need not save and restore, any floating-point registers.
9b66ebb1 8163
39bc1876
NS
8164@item -mieee
8165@opindex mieee
8166The Alpha architecture implements floating-point hardware optimized for
8167maximum performance. It is mostly compliant with the IEEE floating
8168point standard. However, for full compliance, software assistance is
8169required. This option generates code fully IEEE compliant code
8170@emph{except} that the @var{inexact-flag} is not maintained (see below).
8171If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8172defined during compilation. The resulting code is less efficient but is
8173able to correctly support denormalized numbers and exceptional IEEE
8174values such as not-a-number and plus/minus infinity. Other Alpha
8175compilers call this option @option{-ieee_with_no_inexact}.
74291a4b 8176
39bc1876
NS
8177@item -mieee-with-inexact
8178@opindex mieee-with-inexact
8179This is like @option{-mieee} except the generated code also maintains
8180the IEEE @var{inexact-flag}. Turning on this option causes the
8181generated code to implement fully-compliant IEEE math. In addition to
8182@code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8183macro. On some Alpha implementations the resulting code may execute
8184significantly slower than the code generated by default. Since there is
8185very little code that depends on the @var{inexact-flag}, you should
8186normally not specify this option. Other Alpha compilers call this
8187option @option{-ieee_with_inexact}.
74291a4b 8188
39bc1876
NS
8189@item -mfp-trap-mode=@var{trap-mode}
8190@opindex mfp-trap-mode
8191This option controls what floating-point related traps are enabled.
8192Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8193The trap mode can be set to one of four values:
74291a4b 8194
39bc1876
NS
8195@table @samp
8196@item n
8197This is the default (normal) setting. The only traps that are enabled
8198are the ones that cannot be disabled in software (e.g., division by zero
8199trap).
62b10bbc 8200
39bc1876
NS
8201@item u
8202In addition to the traps enabled by @samp{n}, underflow traps are enabled
8203as well.
157a620e 8204
39bc1876
NS
8205@item su
8206Like @samp{su}, but the instructions are marked to be safe for software
8207completion (see Alpha architecture manual for details).
157a620e 8208
39bc1876
NS
8209@item sui
8210Like @samp{su}, but inexact traps are enabled as well.
8211@end table
9b66ebb1 8212
39bc1876
NS
8213@item -mfp-rounding-mode=@var{rounding-mode}
8214@opindex mfp-rounding-mode
8215Selects the IEEE rounding mode. Other Alpha compilers call this option
8216@option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
8217of:
157a620e 8218
39bc1876
NS
8219@table @samp
8220@item n
8221Normal IEEE rounding mode. Floating point numbers are rounded towards
8222the nearest machine number or towards the even machine number in case
8223of a tie.
5848830f 8224
39bc1876
NS
8225@item m
8226Round towards minus infinity.
157a620e 8227
39bc1876
NS
8228@item c
8229Chopped rounding mode. Floating point numbers are rounded towards zero.
f5a1b0d2 8230
39bc1876
NS
8231@item d
8232Dynamic rounding mode. A field in the floating point control register
8233(@var{fpcr}, see Alpha architecture reference manual) controls the
8234rounding mode in effect. The C library initializes this register for
8235rounding towards plus infinity. Thus, unless your program modifies the
8236@var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8237@end table
c27ba912 8238
39bc1876
NS
8239@item -mtrap-precision=@var{trap-precision}
8240@opindex mtrap-precision
8241In the Alpha architecture, floating point traps are imprecise. This
8242means without software assistance it is impossible to recover from a
8243floating trap and program execution normally needs to be terminated.
8244GCC can generate code that can assist operating system trap handlers
8245in determining the exact location that caused a floating point trap.
8246Depending on the requirements of an application, different levels of
8247precisions can be selected:
c27ba912 8248
39bc1876
NS
8249@table @samp
8250@item p
8251Program precision. This option is the default and means a trap handler
8252can only identify which program caused a floating point exception.
c27ba912 8253
39bc1876
NS
8254@item f
8255Function precision. The trap handler can determine the function that
8256caused a floating point exception.
62b10bbc 8257
39bc1876
NS
8258@item i
8259Instruction precision. The trap handler can determine the exact
8260instruction that caused a floating point exception.
8261@end table
ed0e6530 8262
39bc1876
NS
8263Other Alpha compilers provide the equivalent options called
8264@option{-scope_safe} and @option{-resumption_safe}.
ed0e6530 8265
39bc1876
NS
8266@item -mieee-conformant
8267@opindex mieee-conformant
8268This option marks the generated code as IEEE conformant. You must not
8269use this option unless you also specify @option{-mtrap-precision=i} and either
8270@option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
8271is to emit the line @samp{.eflag 48} in the function prologue of the
8272generated assembly file. Under DEC Unix, this has the effect that
8273IEEE-conformant math library routines will be linked in.
9b6b54e2 8274
39bc1876
NS
8275@item -mbuild-constants
8276@opindex mbuild-constants
8277Normally GCC examines a 32- or 64-bit integer constant to
8278see if it can construct it from smaller constants in two or three
8279instructions. If it cannot, it will output the constant as a literal and
8280generate code to load it from the data segment at runtime.
74291a4b 8281
39bc1876
NS
8282Use this option to require GCC to construct @emph{all} integer constants
8283using code, even if it takes more instructions (the maximum is six).
157a620e 8284
39bc1876
NS
8285You would typically use this option to build a shared library dynamic
8286loader. Itself a shared library, it must relocate itself in memory
8287before it can find the variables and constants in its own data segment.
8288
8289@item -malpha-as
8290@itemx -mgas
8291@opindex malpha-as
8292@opindex mgas
8293Select whether to generate code to be assembled by the vendor-supplied
8294assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8295
8296@item -mbwx
8297@itemx -mno-bwx
8298@itemx -mcix
8299@itemx -mno-cix
8300@itemx -mfix
8301@itemx -mno-fix
8302@itemx -mmax
8303@itemx -mno-max
8304@opindex mbwx
8305@opindex mno-bwx
8306@opindex mcix
8307@opindex mno-cix
8308@opindex mfix
8309@opindex mno-fix
8310@opindex mmax
8311@opindex mno-max
8312Indicate whether GCC should generate code to use the optional BWX,
8313CIX, FIX and MAX instruction sets. The default is to use the instruction
8314sets supported by the CPU type specified via @option{-mcpu=} option or that
8315of the CPU on which GCC was built if none was specified.
157a620e 8316
39bc1876
NS
8317@item -mfloat-vax
8318@itemx -mfloat-ieee
8319@opindex mfloat-vax
8320@opindex mfloat-ieee
8321Generate code that uses (does not use) VAX F and G floating point
8322arithmetic instead of IEEE single and double precision.
157a620e 8323
39bc1876
NS
8324@item -mexplicit-relocs
8325@itemx -mno-explicit-relocs
8326@opindex mexplicit-relocs
8327@opindex mno-explicit-relocs
8328Older Alpha assemblers provided no way to generate symbol relocations
8329except via assembler macros. Use of these macros does not allow
8330optimal instruction scheduling. GNU binutils as of version 2.12
8331supports a new syntax that allows the compiler to explicitly mark
8332which relocations should apply to which instructions. This option
8333is mostly useful for debugging, as GCC detects the capabilities of
8334the assembler when it is built and sets the default accordingly.
157a620e 8335
39bc1876
NS
8336@item -msmall-data
8337@itemx -mlarge-data
8338@opindex msmall-data
8339@opindex mlarge-data
8340When @option{-mexplicit-relocs} is in effect, static data is
8341accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
8342is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8343(the @code{.sdata} and @code{.sbss} sections) and are accessed via
834416-bit relocations off of the @code{$gp} register. This limits the
8345size of the small data area to 64KB, but allows the variables to be
8346directly accessed via a single instruction.
62b10bbc 8347
39bc1876 8348The default is @option{-mlarge-data}. With this option the data area
8a36672b 8349is limited to just below 2GB@. Programs that require more than 2GB of
39bc1876
NS
8350data must use @code{malloc} or @code{mmap} to allocate the data in the
8351heap instead of in the program's data segment.
62b10bbc 8352
39bc1876
NS
8353When generating code for shared libraries, @option{-fpic} implies
8354@option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
4bdc1ac7 8355
39bc1876
NS
8356@item -msmall-text
8357@itemx -mlarge-text
8358@opindex msmall-text
8359@opindex mlarge-text
8360When @option{-msmall-text} is used, the compiler assumes that the
8361code of the entire program (or shared library) fits in 4MB, and is
8362thus reachable with a branch instruction. When @option{-msmall-data}
8363is used, the compiler can assume that all local symbols share the
8364same @code{$gp} value, and thus reduce the number of instructions
8365required for a function call from 4 to 1.
157a620e 8366
39bc1876 8367The default is @option{-mlarge-text}.
d2d42a91 8368
39bc1876
NS
8369@item -mcpu=@var{cpu_type}
8370@opindex mcpu
8371Set the instruction set and instruction scheduling parameters for
8372machine type @var{cpu_type}. You can specify either the @samp{EV}
8373style name or the corresponding chip number. GCC supports scheduling
8374parameters for the EV4, EV5 and EV6 family of processors and will
8375choose the default values for the instruction set from the processor
8376you specify. If you do not specify a processor type, GCC will default
8377to the processor on which the compiler was built.
6d6d0fa0 8378
39bc1876 8379Supported values for @var{cpu_type} are
6d6d0fa0 8380
39bc1876
NS
8381@table @samp
8382@item ev4
8383@itemx ev45
8384@itemx 21064
8385Schedules as an EV4 and has no instruction set extensions.
ecff22ab 8386
39bc1876
NS
8387@item ev5
8388@itemx 21164
8389Schedules as an EV5 and has no instruction set extensions.
705ac34f 8390
39bc1876
NS
8391@item ev56
8392@itemx 21164a
8393Schedules as an EV5 and supports the BWX extension.
705ac34f 8394
39bc1876
NS
8395@item pca56
8396@itemx 21164pc
8397@itemx 21164PC
8398Schedules as an EV5 and supports the BWX and MAX extensions.
c474f76b 8399
39bc1876
NS
8400@item ev6
8401@itemx 21264
8402Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
ecff22ab 8403
39bc1876
NS
8404@item ev67
8405@itemx 21264a
8406Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
6d6d0fa0
JL
8407@end table
8408
39bc1876
NS
8409@item -mtune=@var{cpu_type}
8410@opindex mtune
8411Set only the instruction scheduling parameters for machine type
8412@var{cpu_type}. The instruction set is not changed.
ecff22ab 8413
39bc1876
NS
8414@item -mmemory-latency=@var{time}
8415@opindex mmemory-latency
8416Sets the latency the scheduler should assume for typical memory
8417references as seen by the application. This number is highly
8418dependent on the memory access patterns used by the application
8419and the size of the external cache on the machine.
861bb6c1 8420
39bc1876 8421Valid options for @var{time} are
6975bd2c 8422
39bc1876
NS
8423@table @samp
8424@item @var{number}
8425A decimal number representing clock cycles.
98180123 8426
39bc1876
NS
8427@item L1
8428@itemx L2
8429@itemx L3
8430@itemx main
8431The compiler contains estimates of the number of clock cycles for
8432``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8433(also called Dcache, Scache, and Bcache), as well as to main memory.
8434Note that L3 is only valid for EV5.
de41e41c 8435
39bc1876
NS
8436@end table
8437@end table
861bb6c1 8438
39bc1876
NS
8439@node DEC Alpha/VMS Options
8440@subsection DEC Alpha/VMS Options
861bb6c1 8441
39bc1876 8442These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
861bb6c1 8443
39bc1876
NS
8444@table @gcctabopt
8445@item -mvms-return-codes
8446@opindex mvms-return-codes
8447Return VMS condition codes from main. The default is to return POSIX
8448style condition (e.g.@ error) codes.
8449@end table
861bb6c1 8450
39bc1876
NS
8451@node FRV Options
8452@subsection FRV Options
8453@cindex FRV Options
861bb6c1 8454
39bc1876
NS
8455@table @gcctabopt
8456@item -mgpr-32
8457@opindex mgpr-32
861bb6c1 8458
39bc1876 8459Only use the first 32 general purpose registers.
861bb6c1 8460
39bc1876
NS
8461@item -mgpr-64
8462@opindex mgpr-64
861bb6c1 8463
39bc1876 8464Use all 64 general purpose registers.
861bb6c1 8465
39bc1876
NS
8466@item -mfpr-32
8467@opindex mfpr-32
861bb6c1 8468
39bc1876 8469Use only the first 32 floating point registers.
ad126521 8470
39bc1876
NS
8471@item -mfpr-64
8472@opindex mfpr-64
ad126521 8473
39bc1876 8474Use all 64 floating point registers
ad126521 8475
39bc1876
NS
8476@item -mhard-float
8477@opindex mhard-float
ad126521 8478
39bc1876 8479Use hardware instructions for floating point operations.
ad126521 8480
39bc1876
NS
8481@item -msoft-float
8482@opindex msoft-float
ad126521 8483
39bc1876 8484Use library routines for floating point operations.
ad126521 8485
39bc1876
NS
8486@item -malloc-cc
8487@opindex malloc-cc
ad126521 8488
39bc1876 8489Dynamically allocate condition code registers.
ad126521 8490
39bc1876
NS
8491@item -mfixed-cc
8492@opindex mfixed-cc
861bb6c1 8493
39bc1876
NS
8494Do not try to dynamically allocate condition code registers, only
8495use @code{icc0} and @code{fcc0}.
74291a4b 8496
39bc1876
NS
8497@item -mdword
8498@opindex mdword
74291a4b 8499
39bc1876 8500Change ABI to use double word insns.
74291a4b 8501
39bc1876
NS
8502@item -mno-dword
8503@opindex mno-dword
74291a4b 8504
39bc1876 8505Do not use double word instructions.
74291a4b 8506
39bc1876
NS
8507@item -mdouble
8508@opindex mdouble
74291a4b 8509
39bc1876 8510Use floating point double instructions.
7fe90e7b 8511
39bc1876
NS
8512@item -mno-double
8513@opindex mno-double
74291a4b 8514
39bc1876 8515Do not use floating point double instructions.
74291a4b 8516
39bc1876
NS
8517@item -mmedia
8518@opindex mmedia
74291a4b 8519
39bc1876 8520Use media instructions.
9c34dbbf 8521
39bc1876
NS
8522@item -mno-media
8523@opindex mno-media
74291a4b 8524
39bc1876 8525Do not use media instructions.
74291a4b 8526
39bc1876
NS
8527@item -mmuladd
8528@opindex mmuladd
9c34dbbf 8529
39bc1876 8530Use multiply and add/subtract instructions.
66188a7e 8531
39bc1876
NS
8532@item -mno-muladd
8533@opindex mno-muladd
74291a4b 8534
39bc1876 8535Do not use multiply and add/subtract instructions.
74291a4b 8536
d711cf67
JDA
8537@item -mfdpic
8538@opindex mfdpic
8539
8540Select the FDPIC ABI, that uses function descriptors to represent
8541pointers to functions. Without any PIC/PIE-related options, it
8542implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
8543assumes GOT entries and small data are within a 12-bit range from the
8544GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8545are computed with 32 bits.
8546
8547@item -minline-plt
8548@opindex minline-plt
8549
8550Enable inlining of PLT entries in function calls to functions that are
8551not known to bind locally. It has no effect without @option{-mfdpic}.
8552It's enabled by default if optimizing for speed and compiling for
8553shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8554optimization option such as @option{-O3} or above is present in the
8555command line.
8556
e4dd71de
AH
8557@item -mTLS
8558@opindex TLS
8559
8560Assume a large TLS segment when generating thread-local code.
8561
8562@item -mtls
8563@opindex tls
8564
8565Do not assume a large TLS segment when generating thread-local code.
8566
d711cf67
JDA
8567@item -mgprel-ro
8568@opindex mgprel-ro
8569
8570Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8571that is known to be in read-only sections. It's enabled by default,
8572except for @option{-fpic} or @option{-fpie}: even though it may help
8573make the global offset table smaller, it trades 1 instruction for 4.
8574With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8575one of which may be shared by multiple symbols, and it avoids the need
8576for a GOT entry for the referenced symbol, so it's more likely to be a
8577win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
8578
8579@item -multilib-library-pic
8580@opindex multilib-library-pic
8581
8582Link with the (library, not FD) pic libraries. It's implied by
8583@option{-mlibrary-pic}, as well as by @option{-fPIC} and
8584@option{-fpic} without @option{-mfdpic}. You should never have to use
8585it explicitly.
8586
8587@item -mlinked-fp
8588@opindex mlinked-fp
8589
8590Follow the EABI requirement of always creating a frame pointer whenever
8591a stack frame is allocated. This option is enabled by default and can
8592be disabled with @option{-mno-linked-fp}.
8593
c557edf4
RS
8594@item -mlong-calls
8595@opindex mlong-calls
8596
8597Use indirect addressing to call functions outside the current
8598compilation unit. This allows the functions to be placed anywhere
8599within the 32-bit address space.
8600
8601@item -malign-labels
8602@opindex malign-labels
8603
8604Try to align labels to an 8-byte boundary by inserting nops into the
8605previous packet. This option only has an effect when VLIW packing
8606is enabled. It doesn't create new packets; it merely adds nops to
8607existing ones.
8608
39bc1876
NS
8609@item -mlibrary-pic
8610@opindex mlibrary-pic
0ac081f6 8611
39bc1876 8612Generate position-independent EABI code.
6c8875e5 8613
39bc1876
NS
8614@item -macc-4
8615@opindex macc-4
6c8875e5 8616
39bc1876 8617Use only the first four media accumulator registers.
6c8875e5 8618
39bc1876
NS
8619@item -macc-8
8620@opindex macc-8
993f19a8 8621
39bc1876 8622Use all eight media accumulator registers.
5da702b1 8623
39bc1876
NS
8624@item -mpack
8625@opindex mpack
74291a4b 8626
39bc1876 8627Pack VLIW instructions.
74291a4b 8628
39bc1876
NS
8629@item -mno-pack
8630@opindex mno-pack
74291a4b 8631
39bc1876 8632Do not pack VLIW instructions.
7fe90e7b 8633
39bc1876
NS
8634@item -mno-eflags
8635@opindex mno-eflags
74291a4b 8636
39bc1876 8637Do not mark ABI switches in e_flags.
861bb6c1 8638
39bc1876
NS
8639@item -mcond-move
8640@opindex mcond-move
6184e8a4 8641
39bc1876 8642Enable the use of conditional-move instructions (default).
74291a4b 8643
39bc1876
NS
8644This switch is mainly for debugging the compiler and will likely be removed
8645in a future version.
74291a4b 8646
39bc1876
NS
8647@item -mno-cond-move
8648@opindex mno-cond-move
74291a4b 8649
39bc1876 8650Disable the use of conditional-move instructions.
861bb6c1 8651
39bc1876
NS
8652This switch is mainly for debugging the compiler and will likely be removed
8653in a future version.
861bb6c1 8654
39bc1876
NS
8655@item -mscc
8656@opindex mscc
74291a4b 8657
39bc1876 8658Enable the use of conditional set instructions (default).
74291a4b 8659
39bc1876
NS
8660This switch is mainly for debugging the compiler and will likely be removed
8661in a future version.
74291a4b 8662
39bc1876
NS
8663@item -mno-scc
8664@opindex mno-scc
74291a4b 8665
39bc1876 8666Disable the use of conditional set instructions.
74291a4b 8667
39bc1876
NS
8668This switch is mainly for debugging the compiler and will likely be removed
8669in a future version.
74291a4b 8670
39bc1876
NS
8671@item -mcond-exec
8672@opindex mcond-exec
74291a4b 8673
39bc1876 8674Enable the use of conditional execution (default).
74291a4b 8675
39bc1876
NS
8676This switch is mainly for debugging the compiler and will likely be removed
8677in a future version.
ab82a49f 8678
39bc1876
NS
8679@item -mno-cond-exec
8680@opindex mno-cond-exec
79ae11c4 8681
39bc1876 8682Disable the use of conditional execution.
daf2f129 8683
39bc1876
NS
8684This switch is mainly for debugging the compiler and will likely be removed
8685in a future version.
cbe26ab8 8686
39bc1876
NS
8687@item -mvliw-branch
8688@opindex mvliw-branch
8689
8690Run a pass to pack branches into VLIW instructions (default).
8691
8692This switch is mainly for debugging the compiler and will likely be removed
8693in a future version.
8694
8695@item -mno-vliw-branch
8696@opindex mno-vliw-branch
8697
8698Do not run a pass to pack branches into VLIW instructions.
8699
8700This switch is mainly for debugging the compiler and will likely be removed
8701in a future version.
74291a4b 8702
39bc1876
NS
8703@item -mmulti-cond-exec
8704@opindex mmulti-cond-exec
74291a4b 8705
39bc1876
NS
8706Enable optimization of @code{&&} and @code{||} in conditional execution
8707(default).
74291a4b 8708
39bc1876
NS
8709This switch is mainly for debugging the compiler and will likely be removed
8710in a future version.
74291a4b 8711
39bc1876
NS
8712@item -mno-multi-cond-exec
8713@opindex mno-multi-cond-exec
74291a4b 8714
39bc1876 8715Disable optimization of @code{&&} and @code{||} in conditional execution.
48180d68 8716
39bc1876
NS
8717This switch is mainly for debugging the compiler and will likely be removed
8718in a future version.
edf1b3f3 8719
39bc1876
NS
8720@item -mnested-cond-exec
8721@opindex mnested-cond-exec
9904592e 8722
39bc1876 8723Enable nested conditional execution optimizations (default).
9904592e 8724
39bc1876
NS
8725This switch is mainly for debugging the compiler and will likely be removed
8726in a future version.
0ac081f6 8727
39bc1876
NS
8728@item -mno-nested-cond-exec
8729@opindex mno-nested-cond-exec
76a773f3 8730
39bc1876 8731Disable nested conditional execution optimizations.
74291a4b 8732
39bc1876
NS
8733This switch is mainly for debugging the compiler and will likely be removed
8734in a future version.
74291a4b 8735
38c28a25
AH
8736@item -moptimize-membar
8737@opindex moptimize-membar
8738
8739This switch removes redundant @code{membar} instructions from the
8740compiler generated code. It is enabled by default.
8741
8742@item -mno-optimize-membar
8743@opindex mno-optimize-membar
8744
8745This switch disables the automatic removal of redundant @code{membar}
8746instructions from the generated code.
8747
39bc1876
NS
8748@item -mtomcat-stats
8749@opindex mtomcat-stats
e9a25f70 8750
39bc1876 8751Cause gas to print out tomcat statistics.
e9a25f70 8752
39bc1876
NS
8753@item -mcpu=@var{cpu}
8754@opindex mcpu
74291a4b 8755
39bc1876 8756Select the processor type for which to generate code. Possible values are
c557edf4
RS
8757@samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8758@samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
bff46771 8759
39bc1876 8760@end table
8d8269fa 8761
39bc1876
NS
8762@node H8/300 Options
8763@subsection H8/300 Options
74291a4b 8764
39bc1876 8765These @samp{-m} options are defined for the H8/300 implementations:
74291a4b 8766
39bc1876
NS
8767@table @gcctabopt
8768@item -mrelax
8769@opindex mrelax
8770Shorten some address references at link time, when possible; uses the
8771linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
8772ld, Using ld}, for a fuller description.
74291a4b 8773
39bc1876
NS
8774@item -mh
8775@opindex mh
8776Generate code for the H8/300H@.
74291a4b 8777
39bc1876
NS
8778@item -ms
8779@opindex ms
8780Generate code for the H8S@.
74291a4b 8781
39bc1876
NS
8782@item -mn
8783@opindex mn
8784Generate code for the H8S and H8/300H in the normal mode. This switch
4ec7afd7 8785must be used either with @option{-mh} or @option{-ms}.
74291a4b 8786
39bc1876
NS
8787@item -ms2600
8788@opindex ms2600
8789Generate code for the H8S/2600. This switch must be used with @option{-ms}.
74291a4b 8790
39bc1876
NS
8791@item -mint32
8792@opindex mint32
8793Make @code{int} data 32 bits by default.
74291a4b 8794
39bc1876
NS
8795@item -malign-300
8796@opindex malign-300
8797On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8798The default for the H8/300H and H8S is to align longs and floats on 4
8799byte boundaries.
8800@option{-malign-300} causes them to be aligned on 2 byte boundaries.
8801This option has no effect on the H8/300.
8802@end table
f5a1b0d2 8803
39bc1876
NS
8804@node HPPA Options
8805@subsection HPPA Options
8806@cindex HPPA Options
a5c76ee6 8807
39bc1876 8808These @samp{-m} options are defined for the HPPA family of computers:
a5c76ee6 8809
39bc1876
NS
8810@table @gcctabopt
8811@item -march=@var{architecture-type}
8812@opindex march
8813Generate code for the specified architecture. The choices for
8814@var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
88151.1, and @samp{2.0} for PA 2.0 processors. Refer to
8816@file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8817architecture option for your machine. Code compiled for lower numbered
8818architectures will run on higher numbered architectures, but not the
8819other way around.
8820
39bc1876
NS
8821@item -mpa-risc-1-0
8822@itemx -mpa-risc-1-1
8823@itemx -mpa-risc-2-0
8824@opindex mpa-risc-1-0
8825@opindex mpa-risc-1-1
8826@opindex mpa-risc-2-0
8827Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
5a26b329 8828
39bc1876
NS
8829@item -mbig-switch
8830@opindex mbig-switch
8831Generate code suitable for big switch tables. Use this option only if
8832the assembler/linker complain about out of range branches within a switch
8833table.
efdba735 8834
39bc1876
NS
8835@item -mjump-in-delay
8836@opindex mjump-in-delay
8837Fill delay slots of function calls with unconditional jump instructions
8838by modifying the return pointer for the function call to be the target
8839of the conditional jump.
a5c76ee6 8840
39bc1876
NS
8841@item -mdisable-fpregs
8842@opindex mdisable-fpregs
8843Prevent floating point registers from being used in any manner. This is
8844necessary for compiling kernels which perform lazy context switching of
8845floating point registers. If you use this option and attempt to perform
8846floating point operations, the compiler will abort.
0a379b7a 8847
39bc1876
NS
8848@item -mdisable-indexing
8849@opindex mdisable-indexing
8850Prevent the compiler from using indexing address modes. This avoids some
8851rather obscure problems when compiling MIG generated code under MACH@.
f5a1b0d2 8852
39bc1876
NS
8853@item -mno-space-regs
8854@opindex mno-space-regs
8855Generate code that assumes the target has no space registers. This allows
8856GCC to generate faster indirect calls and use unscaled index address modes.
d2d42a91 8857
39bc1876 8858Such code is suitable for level 0 PA systems and kernels.
d2d42a91 8859
39bc1876
NS
8860@item -mfast-indirect-calls
8861@opindex mfast-indirect-calls
8862Generate code that assumes calls never cross space boundaries. This
8863allows GCC to emit code which performs faster indirect calls.
f08a3544 8864
39bc1876
NS
8865This option will not work in the presence of shared libraries or nested
8866functions.
f08a3544 8867
a2017852
JDA
8868@item -mfixed-range=@var{register-range}
8869@opindex mfixed-range
8870Generate code treating the given register range as fixed registers.
8871A fixed register is one that the register allocator can not use. This is
8872useful when compiling kernel code. A register range is specified as
8873two registers separated by a dash. Multiple register ranges can be
8874specified separated by a comma.
8875
39bc1876
NS
8876@item -mlong-load-store
8877@opindex mlong-load-store
8878Generate 3-instruction load and store sequences as sometimes required by
8879the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
8880the HP compilers.
61c85ff1 8881
39bc1876
NS
8882@item -mportable-runtime
8883@opindex mportable-runtime
8884Use the portable calling conventions proposed by HP for ELF systems.
61c85ff1 8885
39bc1876
NS
8886@item -mgas
8887@opindex mgas
8888Enable the use of assembler directives only GAS understands.
61c85ff1 8889
39bc1876
NS
8890@item -mschedule=@var{cpu-type}
8891@opindex mschedule
8892Schedule code according to the constraints for the machine type
8893@var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
8894@samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
8895to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8896proper scheduling option for your machine. The default scheduling is
8897@samp{8000}.
61c85ff1 8898
39bc1876
NS
8899@item -mlinker-opt
8900@opindex mlinker-opt
8901Enable the optimization pass in the HP-UX linker. Note this makes symbolic
8902debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
8903linkers in which they give bogus error messages when linking some programs.
61c85ff1 8904
39bc1876
NS
8905@item -msoft-float
8906@opindex msoft-float
8907Generate output containing library calls for floating point.
8908@strong{Warning:} the requisite libraries are not available for all HPPA
8909targets. Normally the facilities of the machine's usual C compiler are
8910used, but this cannot be done directly in cross-compilation. You must make
8911your own arrangements to provide suitable library functions for
8912cross-compilation. The embedded target @samp{hppa1.1-*-pro}
8913does provide software floating point support.
31775d31 8914
39bc1876
NS
8915@option{-msoft-float} changes the calling convention in the output file;
8916therefore, it is only useful if you compile @emph{all} of a program with
8917this option. In particular, you need to compile @file{libgcc.a}, the
8918library that comes with GCC, with @option{-msoft-float} in order for
8919this to work.
61c85ff1 8920
39bc1876
NS
8921@item -msio
8922@opindex msio
8a36672b 8923Generate the predefine, @code{_SIO}, for server IO@. The default is
39bc1876 8924@option{-mwsio}. This generates the predefines, @code{__hp9000s700},
8a36672b
JM
8925@code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
8926options are available under HP-UX and HI-UX@.
39bc1876
NS
8927
8928@item -mgnu-ld
8929@opindex gnu-ld
8930Use GNU ld specific options. This passes @option{-shared} to ld when
8931building a shared library. It is the default when GCC is configured,
8932explicitly or implicitly, with the GNU linker. This option does not
8933have any affect on which ld is called, it only changes what parameters
8934are passed to that ld. The ld that is called is determined by the
8935@option{--with-ld} configure option, GCC's program search path, and
8936finally by the user's @env{PATH}. The linker used by GCC can be printed
a73035ae
SE
8937using @samp{which `gcc -print-prog-name=ld`}. This option is only available
8938on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
48aec0bc 8939
39bc1876
NS
8940@item -mhp-ld
8941@opindex hp-ld
8942Use HP ld specific options. This passes @option{-b} to ld when building
8943a shared library and passes @option{+Accept TypeMismatch} to ld on all
8944links. It is the default when GCC is configured, explicitly or
8945implicitly, with the HP linker. This option does not have any affect on
8946which ld is called, it only changes what parameters are passed to that
8947ld. The ld that is called is determined by the @option{--with-ld}
8948configure option, GCC's program search path, and finally by the user's
8949@env{PATH}. The linker used by GCC can be printed using @samp{which
a73035ae
SE
8950`gcc -print-prog-name=ld`}. This option is only available on the 64 bit
8951HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
48aec0bc 8952
39bc1876
NS
8953@item -mlong-calls
8954@opindex mno-long-calls
8955Generate code that uses long call sequences. This ensures that a call
8956is always able to reach linker generated stubs. The default is to generate
8957long calls only when the distance from the call site to the beginning
8958of the function or translation unit, as the case may be, exceeds a
8959predefined limit set by the branch type being used. The limits for
8960normal calls are 7,600,000 and 240,000 bytes, respectively for the
8961PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
8962240,000 bytes.
a27fb29b 8963
39bc1876
NS
8964Distances are measured from the beginning of functions when using the
8965@option{-ffunction-sections} option, or when using the @option{-mgas}
8966and @option{-mno-portable-runtime} options together under HP-UX with
8967the SOM linker.
7dac2f89 8968
39bc1876
NS
8969It is normally not desirable to use this option as it will degrade
8970performance. However, it may be useful in large applications,
8971particularly when partial linking is used to build the application.
74291a4b 8972
39bc1876
NS
8973The types of long calls used depends on the capabilities of the
8974assembler and linker, and the type of code being generated. The
8975impact on systems that support long absolute calls, and long pic
8976symbol-difference or pc-relative calls should be relatively small.
8977However, an indirect call is used on 32-bit ELF systems in pic code
8978and it is quite long.
74291a4b 8979
d711cf67
JDA
8980@item -munix=@var{unix-std}
8981@opindex march
8982Generate compiler predefines and select a startfile for the specified
8983UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
8984and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
8985is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
898611.11 and later. The default values are @samp{93} for HP-UX 10.00,
8987@samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8988and later.
8989
8990@option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8991@option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8992and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8993@option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8994@code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8995@code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8996
8997It is @emph{important} to note that this option changes the interfaces
8998for various library routines. It also affects the operational behavior
8999of the C library. Thus, @emph{extreme} care is needed in using this
9000option.
9001
9002Library code that is intended to operate with more than one UNIX
9003standard must test, set and restore the variable @var{__xpg4_extended_mask}
9004as appropriate. Most GNU software doesn't provide this capability.
9005
39bc1876
NS
9006@item -nolibdld
9007@opindex nolibdld
9008Suppress the generation of link options to search libdld.sl when the
9009@option{-static} option is specified on HP-UX 10 and later.
9010
9011@item -static
9012@opindex static
9013The HP-UX implementation of setlocale in libc has a dependency on
9014libdld.sl. There isn't an archive version of libdld.sl. Thus,
9015when the @option{-static} option is specified, special link options
9016are needed to resolve this dependency.
9017
9018On HP-UX 10 and later, the GCC driver adds the necessary options to
9019link with libdld.sl when the @option{-static} option is specified.
9020This causes the resulting binary to be dynamic. On the 64-bit port,
9021the linkers generate dynamic binaries by default in any case. The
9022@option{-nolibdld} option can be used to prevent the GCC driver from
9023adding these link options.
9024
9025@item -threads
9026@opindex threads
9027Add support for multithreading with the @dfn{dce thread} library
8a36672b 9028under HP-UX@. This option sets flags for both the preprocessor and
39bc1876
NS
9029linker.
9030@end table
9031
9032@node i386 and x86-64 Options
9033@subsection Intel 386 and AMD x86-64 Options
9034@cindex i386 Options
9035@cindex x86-64 Options
9036@cindex Intel 386 Options
9037@cindex AMD x86-64 Options
9038
9039These @samp{-m} options are defined for the i386 and x86-64 family of
9040computers:
9041
9042@table @gcctabopt
9043@item -mtune=@var{cpu-type}
9044@opindex mtune
9045Tune to @var{cpu-type} everything applicable about the generated code, except
9046for the ABI and the set of available instructions. The choices for
9047@var{cpu-type} are:
9048@table @emph
9049@item i386
8a36672b 9050Original Intel's i386 CPU@.
39bc1876 9051@item i486
8a36672b 9052Intel's i486 CPU@. (No scheduling is implemented for this chip.)
39bc1876
NS
9053@item i586, pentium
9054Intel Pentium CPU with no MMX support.
9055@item pentium-mmx
9056Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9057@item i686, pentiumpro
8a36672b 9058Intel PentiumPro CPU@.
39bc1876
NS
9059@item pentium2
9060Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9061@item pentium3, pentium3m
9062Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9063support.
9064@item pentium-m
9065Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9066support. Used by Centrino notebooks.
9067@item pentium4, pentium4m
9068Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9069@item prescott
9070Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9071set support.
9072@item nocona
9073Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9074SSE2 and SSE3 instruction set support.
9075@item k6
9076AMD K6 CPU with MMX instruction set support.
9077@item k6-2, k6-3
9078Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9079@item athlon, athlon-tbird
9080AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9081support.
9082@item athlon-4, athlon-xp, athlon-mp
9083Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9084instruction set support.
9085@item k8, opteron, athlon64, athlon-fx
9086AMD K8 core based CPUs with x86-64 instruction set support. (This supersets
9087MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9088@item winchip-c6
9089IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9090set support.
9091@item winchip2
9092IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9093instruction set support.
9094@item c3
8a36672b 9095Via C3 CPU with MMX and 3dNOW! instruction set support. (No scheduling is
39bc1876
NS
9096implemented for this chip.)
9097@item c3-2
9098Via C3-2 CPU with MMX and SSE instruction set support. (No scheduling is
9099implemented for this chip.)
9100@end table
9101
9102While picking a specific @var{cpu-type} will schedule things appropriately
9103for that particular chip, the compiler will not generate any code that
9104does not run on the i386 without the @option{-march=@var{cpu-type}} option
9105being used.
9106
9107@item -march=@var{cpu-type}
9108@opindex march
9109Generate instructions for the machine type @var{cpu-type}. The choices
9110for @var{cpu-type} are the same as for @option{-mtune}. Moreover,
9111specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
74291a4b 9112
39bc1876
NS
9113@item -mcpu=@var{cpu-type}
9114@opindex mcpu
9115A deprecated synonym for @option{-mtune}.
3398f47f 9116
39bc1876
NS
9117@item -m386
9118@itemx -m486
9119@itemx -mpentium
9120@itemx -mpentiumpro
9121@opindex m386
9122@opindex m486
9123@opindex mpentium
9124@opindex mpentiumpro
9125These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9126@option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9127These synonyms are deprecated.
74291a4b 9128
39bc1876
NS
9129@item -mfpmath=@var{unit}
9130@opindex march
9131Generate floating point arithmetics for selected unit @var{unit}. The choices
9132for @var{unit} are:
2d2a50c3 9133
39bc1876
NS
9134@table @samp
9135@item 387
9136Use the standard 387 floating point coprocessor present majority of chips and
9137emulated otherwise. Code compiled with this option will run almost everywhere.
9138The temporary results are computed in 80bit precision instead of precision
9139specified by the type resulting in slightly different results compared to most
8a36672b 9140of other chips. See @option{-ffloat-store} for more detailed description.
74291a4b 9141
39bc1876 9142This is the default choice for i386 compiler.
74291a4b 9143
39bc1876
NS
9144@item sse
9145Use scalar floating point instructions present in the SSE instruction set.
9146This instruction set is supported by Pentium3 and newer chips, in the AMD line
9147by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
9148instruction set supports only single precision arithmetics, thus the double and
9149extended precision arithmetics is still done using 387. Later version, present
9150only in Pentium4 and the future AMD x86-64 chips supports double precision
9151arithmetics too.
a27fb29b 9152
c2b43d7a
UB
9153For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9154or @option{-msse2} switches to enable SSE extensions and make this option
9155effective. For the x86-64 compiler, these extensions are enabled by default.
3398f47f 9156
39bc1876
NS
9157The resulting code should be considerably faster in the majority of cases and avoid
9158the numerical instability problems of 387 code, but may break some existing
9159code that expects temporaries to be 80bit.
cd3f11a6 9160
39bc1876 9161This is the default choice for the x86-64 compiler.
74291a4b 9162
39bc1876
NS
9163@item sse,387
9164Attempt to utilize both instruction sets at once. This effectively double the
9165amount of available registers and on chips with separate execution units for
9166387 and SSE the execution resources too. Use this option with care, as it is
9167still experimental, because the GCC register allocator does not model separate
9168functional units well resulting in instable performance.
9169@end table
ee692410 9170
39bc1876
NS
9171@item -masm=@var{dialect}
9172@opindex masm=@var{dialect}
1f4c2c57
MS
9173Output asm instructions using selected @var{dialect}. Supported
9174choices are @samp{intel} or @samp{att} (the default one). Darwin does
13b3c362 9175not support @samp{intel}.
ee692410 9176
39bc1876
NS
9177@item -mieee-fp
9178@itemx -mno-ieee-fp
9179@opindex mieee-fp
9180@opindex mno-ieee-fp
9181Control whether or not the compiler uses IEEE floating point
9182comparisons. These handle correctly the case where the result of a
9183comparison is unordered.
ee692410 9184
39bc1876
NS
9185@item -msoft-float
9186@opindex msoft-float
9187Generate output containing library calls for floating point.
9188@strong{Warning:} the requisite libraries are not part of GCC@.
9189Normally the facilities of the machine's usual C compiler are used, but
9190this can't be done directly in cross-compilation. You must make your
9191own arrangements to provide suitable library functions for
9192cross-compilation.
ee692410 9193
39bc1876
NS
9194On machines where a function returns floating point results in the 80387
9195register stack, some floating point opcodes may be emitted even if
9196@option{-msoft-float} is used.
ee692410 9197
39bc1876
NS
9198@item -mno-fp-ret-in-387
9199@opindex mno-fp-ret-in-387
9200Do not use the FPU registers for return values of functions.
ee692410 9201
39bc1876
NS
9202The usual calling convention has functions return values of types
9203@code{float} and @code{double} in an FPU register, even if there
9204is no FPU@. The idea is that the operating system should emulate
9205an FPU@.
5a4b3afd 9206
39bc1876
NS
9207The option @option{-mno-fp-ret-in-387} causes such values to be returned
9208in ordinary CPU registers instead.
5a4b3afd 9209
39bc1876
NS
9210@item -mno-fancy-math-387
9211@opindex mno-fancy-math-387
9212Some 387 emulators do not support the @code{sin}, @code{cos} and
9213@code{sqrt} instructions for the 387. Specify this option to avoid
9214generating those instructions. This option is the default on FreeBSD,
9215OpenBSD and NetBSD@. This option is overridden when @option{-march}
9216indicates that the target cpu will always have an FPU and so the
9217instruction will not need emulation. As of revision 2.6.1, these
9218instructions are not generated unless you also use the
9219@option{-funsafe-math-optimizations} switch.
5a4b3afd 9220
39bc1876
NS
9221@item -malign-double
9222@itemx -mno-align-double
9223@opindex malign-double
9224@opindex mno-align-double
9225Control whether GCC aligns @code{double}, @code{long double}, and
9226@code{long long} variables on a two word boundary or a one word
9227boundary. Aligning @code{double} variables on a two word boundary will
9228produce code that runs somewhat faster on a @samp{Pentium} at the
9229expense of more memory.
5a4b3afd 9230
39bc1876
NS
9231@strong{Warning:} if you use the @option{-malign-double} switch,
9232structures containing the above types will be aligned differently than
9233the published application binary interface specifications for the 386
9234and will not be binary compatible with structures in code compiled
9235without that switch.
5a4b3afd 9236
39bc1876
NS
9237@item -m96bit-long-double
9238@itemx -m128bit-long-double
9239@opindex m96bit-long-double
9240@opindex m128bit-long-double
8a36672b 9241These switches control the size of @code{long double} type. The i386
39bc1876
NS
9242application binary interface specifies the size to be 96 bits,
9243so @option{-m96bit-long-double} is the default in 32 bit mode.
5a4b3afd 9244
39bc1876
NS
9245Modern architectures (Pentium and newer) would prefer @code{long double}
9246to be aligned to an 8 or 16 byte boundary. In arrays or structures
9247conforming to the ABI, this would not be possible. So specifying a
9248@option{-m128bit-long-double} will align @code{long double}
9249to a 16 byte boundary by padding the @code{long double} with an additional
925032 bit zero.
5a4b3afd 9251
39bc1876
NS
9252In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9253its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
5a4b3afd 9254
39bc1876
NS
9255Notice that neither of these options enable any extra precision over the x87
9256standard of 80 bits for a @code{long double}.
5a4b3afd 9257
39bc1876
NS
9258@strong{Warning:} if you override the default value for your target ABI, the
9259structures and arrays containing @code{long double} variables will change
9260their size as well as function calling convention for function taking
9261@code{long double} will be modified. Hence they will not be binary
9262compatible with arrays or structures in code compiled without that switch.
5a4b3afd 9263
7dcbf659
JH
9264@item -mmlarge-data-threshold=@var{number}
9265@opindex mlarge-data-threshold=@var{number}
9266When @option{-mcmodel=medium} is specified, the data greater than
9267@var{threshold} are placed in large data section. This value must be the
a4d05547 9268same across all object linked into the binary and defaults to 65535.
5a4b3afd 9269
39bc1876
NS
9270@item -msvr3-shlib
9271@itemx -mno-svr3-shlib
9272@opindex msvr3-shlib
9273@opindex mno-svr3-shlib
9274Control whether GCC places uninitialized local variables into the
9275@code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
9276into @code{bss}. These options are meaningful only on System V Release 3.
5a4b3afd 9277
39bc1876
NS
9278@item -mrtd
9279@opindex mrtd
9280Use a different function-calling convention, in which functions that
9281take a fixed number of arguments return with the @code{ret} @var{num}
9282instruction, which pops their arguments while returning. This saves one
9283instruction in the caller since there is no need to pop the arguments
9284there.
5a4b3afd 9285
39bc1876
NS
9286You can specify that an individual function is called with this calling
9287sequence with the function attribute @samp{stdcall}. You can also
9288override the @option{-mrtd} option by using the function attribute
9289@samp{cdecl}. @xref{Function Attributes}.
74291a4b 9290
39bc1876
NS
9291@strong{Warning:} this calling convention is incompatible with the one
9292normally used on Unix, so you cannot use it if you need to call
9293libraries compiled with the Unix compiler.
74291a4b 9294
39bc1876
NS
9295Also, you must provide function prototypes for all functions that
9296take variable numbers of arguments (including @code{printf});
9297otherwise incorrect code will be generated for calls to those
9298functions.
02f52e19 9299
39bc1876
NS
9300In addition, seriously incorrect code will result if you call a
9301function with too many arguments. (Normally, extra arguments are
9302harmlessly ignored.)
1cf959cb 9303
39bc1876
NS
9304@item -mregparm=@var{num}
9305@opindex mregparm
9306Control how many registers are used to pass integer arguments. By
9307default, no registers are used to pass arguments, and at most 3
9308registers can be used. You can control this behavior for a specific
9309function by using the function attribute @samp{regparm}.
9310@xref{Function Attributes}.
1cf959cb 9311
39bc1876
NS
9312@strong{Warning:} if you use this switch, and
9313@var{num} is nonzero, then you must build all modules with the same
9314value, including any libraries. This includes the system libraries and
9315startup modules.
5a4b3afd 9316
1f97667f
RG
9317@item -msseregparm
9318@opindex msseregparm
9319Use SSE register passing conventions for float and double arguments
9320and return values. You can control this behavior for a specific
9321function by using the function attribute @samp{sseregparm}.
9322@xref{Function Attributes}.
9323
9324@strong{Warning:} if you use this switch then you must build all
9325modules with the same value, including any libraries. This includes
9326the system libraries and startup modules.
9327
39bc1876
NS
9328@item -mpreferred-stack-boundary=@var{num}
9329@opindex mpreferred-stack-boundary
9330Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9331byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
9332the default is 4 (16 bytes or 128 bits), except when optimizing for code
9333size (@option{-Os}), in which case the default is the minimum correct
9334alignment (4 bytes for x86, and 8 bytes for x86-64).
5a4b3afd 9335
39bc1876
NS
9336On Pentium and PentiumPro, @code{double} and @code{long double} values
9337should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9338suffer significant run time performance penalties. On Pentium III, the
9339Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9340penalties if it is not 16 byte aligned.
5a4b3afd 9341
39bc1876
NS
9342To ensure proper alignment of this values on the stack, the stack boundary
9343must be as aligned as that required by any value stored on the stack.
9344Further, every function must be generated such that it keeps the stack
9345aligned. Thus calling a function compiled with a higher preferred
9346stack boundary from a function compiled with a lower preferred stack
9347boundary will most likely misalign the stack. It is recommended that
9348libraries that use callbacks always use the default setting.
5a4b3afd 9349
39bc1876
NS
9350This extra alignment does consume extra stack space, and generally
9351increases code size. Code that is sensitive to stack space usage, such
9352as embedded systems and operating system kernels, may want to reduce the
9353preferred alignment to @option{-mpreferred-stack-boundary=2}.
5a4b3afd 9354
39bc1876
NS
9355@item -mmmx
9356@itemx -mno-mmx
9357@item -msse
9358@itemx -mno-sse
9359@item -msse2
9360@itemx -mno-sse2
9361@item -msse3
9362@itemx -mno-sse3
9363@item -m3dnow
9364@itemx -mno-3dnow
9365@opindex mmmx
9366@opindex mno-mmx
9367@opindex msse
9368@opindex mno-sse
9369@opindex m3dnow
9370@opindex mno-3dnow
75576871
BB
9371These switches enable or disable the use of instructions in the MMX,
9372SSE, SSE2 or 3DNow! extended instruction sets. These extensions are
9373also available as built-in functions: see @ref{X86 Built-in Functions},
9374for details of the functions enabled and disabled by these switches.
74291a4b 9375
39bc1876 9376To have SSE/SSE2 instructions generated automatically from floating-point
75576871
BB
9377code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9378
9379These options will enable GCC to use these extended instructions in
9380generated code, even without @option{-mfpmath=sse}. Applications which
9381perform runtime CPU detection must compile separate files for each
9382supported architecture, using the appropriate flags. In particular,
9383the file containing the CPU detection code should be compiled without
9384these options.
74291a4b 9385
39bc1876
NS
9386@item -mpush-args
9387@itemx -mno-push-args
9388@opindex mpush-args
9389@opindex mno-push-args
9390Use PUSH operations to store outgoing parameters. This method is shorter
9391and usually equally fast as method using SUB/MOV operations and is enabled
9392by default. In some cases disabling it may improve performance because of
9393improved scheduling and reduced dependencies.
74291a4b 9394
39bc1876
NS
9395@item -maccumulate-outgoing-args
9396@opindex maccumulate-outgoing-args
9397If enabled, the maximum amount of space required for outgoing arguments will be
9398computed in the function prologue. This is faster on most modern CPUs
9399because of reduced dependencies, improved scheduling and reduced stack usage
9400when preferred stack boundary is not equal to 2. The drawback is a notable
9401increase in code size. This switch implies @option{-mno-push-args}.
63357d93 9402
39bc1876
NS
9403@item -mthreads
9404@opindex mthreads
9405Support thread-safe exception handling on @samp{Mingw32}. Code that relies
9406on thread-safe exception handling must compile and link all code with the
9407@option{-mthreads} option. When compiling, @option{-mthreads} defines
9408@option{-D_MT}; when linking, it links in a special thread helper library
9409@option{-lmingwthrd} which cleans up per thread exception handling data.
5ef1a99d 9410
39bc1876
NS
9411@item -mno-align-stringops
9412@opindex mno-align-stringops
9413Do not align destination of inlined string operations. This switch reduces
9414code size and improves performance in case the destination is already aligned,
9415but GCC doesn't know about it.
46490403 9416
39bc1876
NS
9417@item -minline-all-stringops
9418@opindex minline-all-stringops
9419By default GCC inlines string operations only when destination is known to be
9420aligned at least to 4 byte boundary. This enables more inlining, increase code
9421size, but may improve performance of code that depends on fast memcpy, strlen
9422and memset for short lengths.
c235ddf2 9423
39bc1876
NS
9424@item -momit-leaf-frame-pointer
9425@opindex momit-leaf-frame-pointer
9426Don't keep the frame pointer in a register for leaf functions. This
9427avoids the instructions to save, set up and restore frame pointers and
9428makes an extra register available in leaf functions. The option
9429@option{-fomit-frame-pointer} removes the frame pointer for all functions
9430which might make debugging harder.
c235ddf2 9431
39bc1876
NS
9432@item -mtls-direct-seg-refs
9433@itemx -mno-tls-direct-seg-refs
9434@opindex mtls-direct-seg-refs
9435Controls whether TLS variables may be accessed with offsets from the
9436TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9437or whether the thread base pointer must be added. Whether or not this
9438is legal depends on the operating system, and whether it maps the
9439segment to cover the entire TLS area.
beadc644 9440
39bc1876
NS
9441For systems that use GNU libc, the default is on.
9442@end table
af34e51e 9443
39bc1876
NS
9444These @samp{-m} switches are supported in addition to the above
9445on AMD x86-64 processors in 64-bit environments.
50d32cf6 9446
39bc1876
NS
9447@table @gcctabopt
9448@item -m32
9449@itemx -m64
9450@opindex m32
9451@opindex m64
9452Generate code for a 32-bit or 64-bit environment.
9453The 32-bit environment sets int, long and pointer to 32 bits and
9454generates code that runs on any i386 system.
9455The 64-bit environment sets int to 32 bits and long and pointer
9456to 64 bits and generates code for AMD's x86-64 architecture.
50d32cf6 9457
39bc1876
NS
9458@item -mno-red-zone
9459@opindex no-red-zone
9460Do not use a so called red zone for x86-64 code. The red zone is mandated
9461by the x86-64 ABI, it is a 128-byte area beyond the location of the
9462stack pointer that will not be modified by signal or interrupt handlers
9463and therefore can be used for temporary data without adjusting the stack
9464pointer. The flag @option{-mno-red-zone} disables this red zone.
dc884a86 9465
39bc1876
NS
9466@item -mcmodel=small
9467@opindex mcmodel=small
9468Generate code for the small code model: the program and its symbols must
9469be linked in the lower 2 GB of the address space. Pointers are 64 bits.
9470Programs can be statically or dynamically linked. This is the default
9471code model.
dc884a86 9472
39bc1876
NS
9473@item -mcmodel=kernel
9474@opindex mcmodel=kernel
9475Generate code for the kernel code model. The kernel runs in the
9476negative 2 GB of the address space.
9477This model has to be used for Linux kernel code.
9478
9479@item -mcmodel=medium
9480@opindex mcmodel=medium
9481Generate code for the medium model: The program is linked in the lower 2
9482GB of the address space but symbols can be located anywhere in the
9483address space. Programs can be statically or dynamically linked, but
9484building of shared libraries are not supported with the medium model.
9485
9486@item -mcmodel=large
9487@opindex mcmodel=large
9488Generate code for the large model: This model makes no assumptions
9489about addresses and sizes of sections. Currently GCC does not implement
9490this model.
74291a4b
MM
9491@end table
9492
39bc1876
NS
9493@node IA-64 Options
9494@subsection IA-64 Options
9495@cindex IA-64 Options
74291a4b 9496
39bc1876 9497These are the @samp{-m} options defined for the Intel IA-64 architecture.
74291a4b 9498
2642624b 9499@table @gcctabopt
39bc1876
NS
9500@item -mbig-endian
9501@opindex mbig-endian
9502Generate code for a big endian target. This is the default for HP-UX@.
6f670fde 9503
39bc1876
NS
9504@item -mlittle-endian
9505@opindex mlittle-endian
9506Generate code for a little endian target. This is the default for AIX5
9507and GNU/Linux.
a9f3e1a4 9508
39bc1876
NS
9509@item -mgnu-as
9510@itemx -mno-gnu-as
9511@opindex mgnu-as
9512@opindex mno-gnu-as
9513Generate (or don't) code for the GNU assembler. This is the default.
9514@c Also, this is the default if the configure option @option{--with-gnu-as}
9515@c is used.
9d913bbf 9516
39bc1876
NS
9517@item -mgnu-ld
9518@itemx -mno-gnu-ld
9519@opindex mgnu-ld
9520@opindex mno-gnu-ld
9521Generate (or don't) code for the GNU linker. This is the default.
9522@c Also, this is the default if the configure option @option{--with-gnu-ld}
9523@c is used.
a9f3e1a4 9524
39bc1876
NS
9525@item -mno-pic
9526@opindex mno-pic
9527Generate code that does not use a global pointer register. The result
9528is not position independent code, and violates the IA-64 ABI@.
74291a4b 9529
39bc1876
NS
9530@item -mvolatile-asm-stop
9531@itemx -mno-volatile-asm-stop
9532@opindex mvolatile-asm-stop
9533@opindex mno-volatile-asm-stop
9534Generate (or don't) a stop bit immediately before and after volatile asm
9535statements.
965f5423 9536
39bc1876
NS
9537@item -mregister-names
9538@itemx -mno-register-names
9539@opindex mregister-names
9540@opindex mno-register-names
9541Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9542the stacked registers. This may make assembler output more readable.
965f5423 9543
39bc1876
NS
9544@item -mno-sdata
9545@itemx -msdata
9546@opindex mno-sdata
9547@opindex msdata
9548Disable (or enable) optimizations that use the small data section. This may
9549be useful for working around optimizer bugs.
9550
9551@item -mconstant-gp
9552@opindex mconstant-gp
9553Generate code that uses a single constant global pointer value. This is
9554useful when compiling kernel code.
9555
9556@item -mauto-pic
9557@opindex mauto-pic
9558Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
9559This is useful when compiling firmware code.
9560
9561@item -minline-float-divide-min-latency
9562@opindex minline-float-divide-min-latency
9563Generate code for inline divides of floating point values
9564using the minimum latency algorithm.
965f5423 9565
39bc1876
NS
9566@item -minline-float-divide-max-throughput
9567@opindex minline-float-divide-max-throughput
9568Generate code for inline divides of floating point values
9569using the maximum throughput algorithm.
965f5423 9570
39bc1876
NS
9571@item -minline-int-divide-min-latency
9572@opindex minline-int-divide-min-latency
9573Generate code for inline divides of integer values
9574using the minimum latency algorithm.
965f5423 9575
39bc1876
NS
9576@item -minline-int-divide-max-throughput
9577@opindex minline-int-divide-max-throughput
9578Generate code for inline divides of integer values
9579using the maximum throughput algorithm.
965f5423 9580
28b43def
SE
9581@item -minline-sqrt-min-latency
9582@opindex minline-sqrt-min-latency
9583Generate code for inline square roots
9584using the minimum latency algorithm.
9585
9586@item -minline-sqrt-max-throughput
9587@opindex minline-sqrt-max-throughput
9588Generate code for inline square roots
9589using the maximum throughput algorithm.
9590
39bc1876
NS
9591@item -mno-dwarf2-asm
9592@itemx -mdwarf2-asm
9593@opindex mno-dwarf2-asm
9594@opindex mdwarf2-asm
9595Don't (or do) generate assembler code for the DWARF2 line number debugging
9596info. This may be useful when not using the GNU assembler.
965f5423 9597
28b43def
SE
9598@item -mearly-stop-bits
9599@itemx -mno-early-stop-bits
9600@opindex mearly-stop-bits
9601@opindex mno-early-stop-bits
9602Allow stop bits to be placed earlier than immediately preceding the
9603instruction that triggered the stop bit. This can improve instruction
9604scheduling, but does not always do so.
9605
39bc1876
NS
9606@item -mfixed-range=@var{register-range}
9607@opindex mfixed-range
9608Generate code treating the given register range as fixed registers.
9609A fixed register is one that the register allocator can not use. This is
9610useful when compiling kernel code. A register range is specified as
9611two registers separated by a dash. Multiple register ranges can be
9612specified separated by a comma.
04e149ab 9613
28b43def
SE
9614@item -mtls-size=@var{tls-size}
9615@opindex mtls-size
9616Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
961764.
9618
7f9dc823
JW
9619@item -mtune=@var{cpu-type}
9620@opindex mtune
28b43def
SE
9621Tune the instruction scheduling for a particular CPU, Valid values are
9622itanium, itanium1, merced, itanium2, and mckinley.
9623
9624@item -mt
9625@itemx -pthread
9626@opindex mt
9627@opindex pthread
9628Add support for multithreading using the POSIX threads library. This
9629option sets flags for both the preprocessor and linker. It does
9630not affect the thread safety of object code produced by the compiler or
9631that of libraries supplied with it. These are HP-UX specific flags.
9632
9633@item -milp32
9634@itemx -mlp64
9635@opindex milp32
9636@opindex mlp64
9637Generate code for a 32-bit or 64-bit environment.
9638The 32-bit environment sets int, long and pointer to 32 bits.
9639The 64-bit environment sets int to 32 bits and long and pointer
9640to 64 bits. These are HP-UX specific flags.
9641
39bc1876 9642@end table
74291a4b 9643
38b2d076
DD
9644@node M32C Options
9645@subsection M32C Options
9646@cindex M32C options
9647
9648@table @gcctabopt
9649@item -mcpu=@var{name}
9650@opindex mcpu=
9651Select the CPU for which code is generated. @var{name} may be one of
9652@samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9653/60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9654the M32C/80 series.
9655
9656@item -msim
9657@opindex msim
9658Specifies that the program will be run on the simulator. This causes
9659an alternate runtime library to be linked in which supports, for
9660example, file I/O. You must not use this option when generating
9661programs that will run on real hardware; you must provide your own
9662runtime library for whatever I/O functions are needed.
9663
9664@item -memregs=@var{number}
9665@opindex memregs=
9666Specifies the number of memory-based pseudo-registers GCC will use
9667during code generation. These pseudo-registers will be used like real
9668registers, so there is a tradeoff between GCC's ability to fit the
9669code into available registers, and the performance penalty of using
9670memory instead of registers. Note that all modules in a program must
9671be compiled with the same value for this option. Because of that, you
9672must not use this option with the default runtime libraries gcc
9673builds.
9674
9675@end table
9676
39bc1876
NS
9677@node M32R/D Options
9678@subsection M32R/D Options
9679@cindex M32R/D options
74291a4b 9680
39bc1876 9681These @option{-m} options are defined for Renesas M32R/D architectures:
74291a4b 9682
39bc1876
NS
9683@table @gcctabopt
9684@item -m32r2
9685@opindex m32r2
9686Generate code for the M32R/2@.
74291a4b 9687
39bc1876
NS
9688@item -m32rx
9689@opindex m32rx
9690Generate code for the M32R/X@.
74291a4b 9691
39bc1876
NS
9692@item -m32r
9693@opindex m32r
9694Generate code for the M32R@. This is the default.
74291a4b 9695
39bc1876
NS
9696@item -mmodel=small
9697@opindex mmodel=small
9698Assume all objects live in the lower 16MB of memory (so that their addresses
9699can be loaded with the @code{ld24} instruction), and assume all subroutines
9700are reachable with the @code{bl} instruction.
9701This is the default.
74291a4b 9702
39bc1876
NS
9703The addressability of a particular object can be set with the
9704@code{model} attribute.
74291a4b 9705
39bc1876
NS
9706@item -mmodel=medium
9707@opindex mmodel=medium
9708Assume objects may be anywhere in the 32-bit address space (the compiler
9709will generate @code{seth/add3} instructions to load their addresses), and
9710assume all subroutines are reachable with the @code{bl} instruction.
194734e9 9711
39bc1876
NS
9712@item -mmodel=large
9713@opindex mmodel=large
9714Assume objects may be anywhere in the 32-bit address space (the compiler
9715will generate @code{seth/add3} instructions to load their addresses), and
9716assume subroutines may not be reachable with the @code{bl} instruction
9717(the compiler will generate the much slower @code{seth/add3/jl}
9718instruction sequence).
a5f3dd66 9719
39bc1876
NS
9720@item -msdata=none
9721@opindex msdata=none
9722Disable use of the small data area. Variables will be put into
9723one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9724@code{section} attribute has been specified).
9725This is the default.
a5f3dd66 9726
39bc1876
NS
9727The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9728Objects may be explicitly put in the small data area with the
9729@code{section} attribute using one of these sections.
daf2f129 9730
39bc1876
NS
9731@item -msdata=sdata
9732@opindex msdata=sdata
9733Put small global and static data in the small data area, but do not
9734generate special code to reference them.
2b589241 9735
39bc1876
NS
9736@item -msdata=use
9737@opindex msdata=use
9738Put small global and static data in the small data area, and generate
9739special instructions to reference them.
2b589241 9740
39bc1876
NS
9741@item -G @var{num}
9742@opindex G
9743@cindex smaller data references
9744Put global and static objects less than or equal to @var{num} bytes
9745into the small data or bss sections instead of the normal data or bss
9746sections. The default value of @var{num} is 8.
9747The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9748for this option to have any effect.
74291a4b 9749
39bc1876
NS
9750All modules should be compiled with the same @option{-G @var{num}} value.
9751Compiling with different values of @var{num} may or may not work; if it
9752doesn't the linker will give an error message---incorrect code will not be
9753generated.
74291a4b 9754
39bc1876
NS
9755@item -mdebug
9756@opindex mdebug
9757Makes the M32R specific code in the compiler display some statistics
9758that might help in debugging programs.
74291a4b 9759
39bc1876
NS
9760@item -malign-loops
9761@opindex malign-loops
9762Align all loops to a 32-byte boundary.
74291a4b 9763
39bc1876
NS
9764@item -mno-align-loops
9765@opindex mno-align-loops
9766Do not enforce a 32-byte alignment for loops. This is the default.
74291a4b 9767
39bc1876
NS
9768@item -missue-rate=@var{number}
9769@opindex missue-rate=@var{number}
9770Issue @var{number} instructions per cycle. @var{number} can only be 1
9771or 2.
74291a4b 9772
39bc1876
NS
9773@item -mbranch-cost=@var{number}
9774@opindex mbranch-cost=@var{number}
9775@var{number} can only be 1 or 2. If it is 1 then branches will be
9776preferred over conditional code, if it is 2, then the opposite will
9777apply.
74291a4b 9778
39bc1876
NS
9779@item -mflush-trap=@var{number}
9780@opindex mflush-trap=@var{number}
9781Specifies the trap number to use to flush the cache. The default is
978212. Valid numbers are between 0 and 15 inclusive.
74291a4b 9783
39bc1876
NS
9784@item -mno-flush-trap
9785@opindex mno-flush-trap
9786Specifies that the cache cannot be flushed by using a trap.
74291a4b 9787
39bc1876
NS
9788@item -mflush-func=@var{name}
9789@opindex mflush-func=@var{name}
9790Specifies the name of the operating system function to call to flush
9791the cache. The default is @emph{_flush_cache}, but a function call
9792will only be used if a trap is not available.
3af4bd89 9793
39bc1876
NS
9794@item -mno-flush-func
9795@opindex mno-flush-func
9796Indicates that there is no OS function for flushing the cache.
3af4bd89 9797
39bc1876 9798@end table
3af4bd89 9799
39bc1876
NS
9800@node M680x0 Options
9801@subsection M680x0 Options
9802@cindex M680x0 options
f22a97d2 9803
39bc1876
NS
9804These are the @samp{-m} options defined for the 68000 series. The default
9805values for these options depends on which style of 68000 was selected when
9806the compiler was configured; the defaults for the most common choices are
9807given below.
1255c85c 9808
39bc1876
NS
9809@table @gcctabopt
9810@item -m68000
9811@itemx -mc68000
9812@opindex m68000
9813@opindex mc68000
9814Generate output for a 68000. This is the default
9815when the compiler is configured for 68000-based systems.
1255c85c 9816
39bc1876
NS
9817Use this option for microcontrollers with a 68000 or EC000 core,
9818including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
7eafc329 9819
39bc1876
NS
9820@item -m68020
9821@itemx -mc68020
9822@opindex m68020
9823@opindex mc68020
9824Generate output for a 68020. This is the default
9825when the compiler is configured for 68020-based systems.
f73ad30e 9826
39bc1876
NS
9827@item -m68881
9828@opindex m68881
9829Generate output containing 68881 instructions for floating point.
9830This is the default for most 68020 systems unless @option{--nfp} was
9831specified when the compiler was configured.
f73ad30e 9832
39bc1876
NS
9833@item -m68030
9834@opindex m68030
9835Generate output for a 68030. This is the default when the compiler is
9836configured for 68030-based systems.
79f05c19 9837
39bc1876
NS
9838@item -m68040
9839@opindex m68040
9840Generate output for a 68040. This is the default when the compiler is
9841configured for 68040-based systems.
79f05c19 9842
39bc1876
NS
9843This option inhibits the use of 68881/68882 instructions that have to be
9844emulated by software on the 68040. Use this option if your 68040 does not
9845have code to emulate those instructions.
762e166b 9846
39bc1876
NS
9847@item -m68060
9848@opindex m68060
9849Generate output for a 68060. This is the default when the compiler is
9850configured for 68060-based systems.
74dc3e94 9851
39bc1876
NS
9852This option inhibits the use of 68020 and 68881/68882 instructions that
9853have to be emulated by software on the 68060. Use this option if your 68060
9854does not have code to emulate those instructions.
74dc3e94 9855
39bc1876
NS
9856@item -mcpu32
9857@opindex mcpu32
9858Generate output for a CPU32. This is the default
9859when the compiler is configured for CPU32-based systems.
3af4bd89 9860
39bc1876
NS
9861Use this option for microcontrollers with a
9862CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
986368336, 68340, 68341, 68349 and 68360.
14f73b5a 9864
39bc1876
NS
9865@item -m5200
9866@opindex m5200
9867Generate output for a 520X ``coldfire'' family cpu. This is the default
9868when the compiler is configured for 520X-based systems.
14f73b5a 9869
39bc1876
NS
9870Use this option for microcontroller with a 5200 core, including
9871the MCF5202, MCF5203, MCF5204 and MCF5202.
a7701995 9872
a7701995 9873
39bc1876
NS
9874@item -m68020-40
9875@opindex m68020-40
9876Generate output for a 68040, without using any of the new instructions.
9877This results in code which can run relatively efficiently on either a
987868020/68881 or a 68030 or a 68040. The generated code does use the
987968881 instructions that are emulated on the 68040.
a7701995 9880
39bc1876
NS
9881@item -m68020-60
9882@opindex m68020-60
9883Generate output for a 68060, without using any of the new instructions.
9884This results in code which can run relatively efficiently on either a
988568020/68881 or a 68030 or a 68040. The generated code does use the
988668881 instructions that are emulated on the 68060.
a7701995 9887
39bc1876
NS
9888@item -msoft-float
9889@opindex msoft-float
9890Generate output containing library calls for floating point.
9891@strong{Warning:} the requisite libraries are not available for all m68k
9892targets. Normally the facilities of the machine's usual C compiler are
9893used, but this can't be done directly in cross-compilation. You must
9894make your own arrangements to provide suitable library functions for
9895cross-compilation. The embedded targets @samp{m68k-*-aout} and
9896@samp{m68k-*-coff} do provide software floating point support.
14f73b5a 9897
39bc1876
NS
9898@item -mshort
9899@opindex mshort
9900Consider type @code{int} to be 16 bits wide, like @code{short int}.
9901Additionally, parameters passed on the stack are also aligned to a
990216-bit boundary even on targets whose API mandates promotion to 32-bit.
74291a4b 9903
39bc1876
NS
9904@item -mnobitfield
9905@opindex mnobitfield
9906Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
9907and @option{-m5200} options imply @w{@option{-mnobitfield}}.
74291a4b 9908
39bc1876
NS
9909@item -mbitfield
9910@opindex mbitfield
9911Do use the bit-field instructions. The @option{-m68020} option implies
9912@option{-mbitfield}. This is the default if you use a configuration
9913designed for a 68020.
9914
9915@item -mrtd
9916@opindex mrtd
9917Use a different function-calling convention, in which functions
9918that take a fixed number of arguments return with the @code{rtd}
9919instruction, which pops their arguments while returning. This
9920saves one instruction in the caller since there is no need to pop
9921the arguments there.
ea3bfbfe 9922
39bc1876
NS
9923This calling convention is incompatible with the one normally
9924used on Unix, so you cannot use it if you need to call libraries
9925compiled with the Unix compiler.
74291a4b 9926
39bc1876
NS
9927Also, you must provide function prototypes for all functions that
9928take variable numbers of arguments (including @code{printf});
9929otherwise incorrect code will be generated for calls to those
9930functions.
861bb6c1 9931
39bc1876
NS
9932In addition, seriously incorrect code will result if you call a
9933function with too many arguments. (Normally, extra arguments are
9934harmlessly ignored.)
74291a4b 9935
39bc1876
NS
9936The @code{rtd} instruction is supported by the 68010, 68020, 68030,
993768040, 68060 and CPU32 processors, but not by the 68000 or 5200.
74291a4b 9938
39bc1876
NS
9939@item -malign-int
9940@itemx -mno-align-int
9941@opindex malign-int
9942@opindex mno-align-int
9943Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9944@code{float}, @code{double}, and @code{long double} variables on a 32-bit
9945boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9946Aligning variables on 32-bit boundaries produces code that runs somewhat
9947faster on processors with 32-bit busses at the expense of more memory.
74291a4b 9948
39bc1876
NS
9949@strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9950align structures containing the above types differently than
9951most published application binary interface specifications for the m68k.
74291a4b 9952
39bc1876
NS
9953@item -mpcrel
9954@opindex mpcrel
9955Use the pc-relative addressing mode of the 68000 directly, instead of
9956using a global offset table. At present, this option implies @option{-fpic},
9957allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
9958not presently supported with @option{-mpcrel}, though this could be supported for
995968020 and higher processors.
74291a4b 9960
39bc1876
NS
9961@item -mno-strict-align
9962@itemx -mstrict-align
9963@opindex mno-strict-align
9964@opindex mstrict-align
9965Do not (do) assume that unaligned memory references will be handled by
9966the system.
74291a4b 9967
39bc1876
NS
9968@item -msep-data
9969Generate code that allows the data segment to be located in a different
9970area of memory from the text segment. This allows for execute in place in
4ec7afd7
KH
9971an environment without virtual memory management. This option implies
9972@option{-fPIC}.
74291a4b 9973
39bc1876
NS
9974@item -mno-sep-data
9975Generate code that assumes that the data segment follows the text segment.
9976This is the default.
74291a4b 9977
39bc1876
NS
9978@item -mid-shared-library
9979Generate code that supports shared libraries via the library ID method.
9980This allows for execute in place and shared libraries in an environment
4ec7afd7 9981without virtual memory management. This option implies @option{-fPIC}.
74291a4b 9982
39bc1876
NS
9983@item -mno-id-shared-library
9984Generate code that doesn't assume ID based shared libraries are being used.
9985This is the default.
74291a4b 9986
39bc1876
NS
9987@item -mshared-library-id=n
9988Specified the identification number of the ID based shared library being
9989compiled. Specifying a value of 0 will generate more compact code, specifying
9990other values will force the allocation of that number to the current
9991library but is no more space or time efficient than omitting this option.
74291a4b 9992
39bc1876 9993@end table
74291a4b 9994
39bc1876
NS
9995@node M68hc1x Options
9996@subsection M68hc1x Options
9997@cindex M68hc1x options
74291a4b 9998
39bc1876
NS
9999These are the @samp{-m} options defined for the 68hc11 and 68hc12
10000microcontrollers. The default values for these options depends on
10001which style of microcontroller was selected when the compiler was configured;
10002the defaults for the most common choices are given below.
c219e1da 10003
39bc1876
NS
10004@table @gcctabopt
10005@item -m6811
10006@itemx -m68hc11
10007@opindex m6811
10008@opindex m68hc11
10009Generate output for a 68HC11. This is the default
10010when the compiler is configured for 68HC11-based systems.
c5d3d49b 10011
39bc1876
NS
10012@item -m6812
10013@itemx -m68hc12
10014@opindex m6812
10015@opindex m68hc12
10016Generate output for a 68HC12. This is the default
10017when the compiler is configured for 68HC12-based systems.
c5d3d49b 10018
39bc1876
NS
10019@item -m68S12
10020@itemx -m68hcs12
10021@opindex m68S12
10022@opindex m68hcs12
10023Generate output for a 68HCS12.
c5d3d49b 10024
39bc1876
NS
10025@item -mauto-incdec
10026@opindex mauto-incdec
10027Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10028addressing modes.
34208acf 10029
39bc1876
NS
10030@item -minmax
10031@itemx -nominmax
10032@opindex minmax
10033@opindex mnominmax
10034Enable the use of 68HC12 min and max instructions.
34208acf 10035
39bc1876
NS
10036@item -mlong-calls
10037@itemx -mno-long-calls
10038@opindex mlong-calls
10039@opindex mno-long-calls
10040Treat all calls as being far away (near). If calls are assumed to be
10041far away, the compiler will use the @code{call} instruction to
10042call a function and the @code{rtc} instruction for returning.
34208acf 10043
39bc1876
NS
10044@item -mshort
10045@opindex mshort
10046Consider type @code{int} to be 16 bits wide, like @code{short int}.
34208acf 10047
39bc1876
NS
10048@item -msoft-reg-count=@var{count}
10049@opindex msoft-reg-count
10050Specify the number of pseudo-soft registers which are used for the
10051code generation. The maximum number is 32. Using more pseudo-soft
10052register may or may not result in better code depending on the program.
10053The default is 4 for 68HC11 and 2 for 68HC12.
34208acf 10054
39bc1876 10055@end table
34208acf 10056
39bc1876
NS
10057@node MCore Options
10058@subsection MCore Options
10059@cindex MCore options
34208acf 10060
39bc1876
NS
10061These are the @samp{-m} options defined for the Motorola M*Core
10062processors.
34208acf 10063
39bc1876 10064@table @gcctabopt
34208acf 10065
39bc1876
NS
10066@item -mhardlit
10067@itemx -mno-hardlit
10068@opindex mhardlit
10069@opindex mno-hardlit
10070Inline constants into the code stream if it can be done in two
10071instructions or less.
34208acf 10072
39bc1876
NS
10073@item -mdiv
10074@itemx -mno-div
10075@opindex mdiv
10076@opindex mno-div
10077Use the divide instruction. (Enabled by default).
a02aa5b0 10078
39bc1876
NS
10079@item -mrelax-immediate
10080@itemx -mno-relax-immediate
10081@opindex mrelax-immediate
10082@opindex mno-relax-immediate
10083Allow arbitrary sized immediates in bit operations.
a02aa5b0 10084
39bc1876
NS
10085@item -mwide-bitfields
10086@itemx -mno-wide-bitfields
10087@opindex mwide-bitfields
10088@opindex mno-wide-bitfields
10089Always treat bit-fields as int-sized.
a02aa5b0 10090
39bc1876
NS
10091@item -m4byte-functions
10092@itemx -mno-4byte-functions
10093@opindex m4byte-functions
10094@opindex mno-4byte-functions
10095Force all functions to be aligned to a four byte boundary.
a02aa5b0 10096
39bc1876
NS
10097@item -mcallgraph-data
10098@itemx -mno-callgraph-data
10099@opindex mcallgraph-data
10100@opindex mno-callgraph-data
10101Emit callgraph information.
f401d0f5 10102
39bc1876
NS
10103@item -mslow-bytes
10104@itemx -mno-slow-bytes
10105@opindex mslow-bytes
10106@opindex mno-slow-bytes
10107Prefer word access when reading byte quantities.
f401d0f5 10108
39bc1876
NS
10109@item -mlittle-endian
10110@itemx -mbig-endian
10111@opindex mlittle-endian
10112@opindex mbig-endian
10113Generate code for a little endian target.
f401d0f5 10114
39bc1876
NS
10115@item -m210
10116@itemx -m340
10117@opindex m210
10118@opindex m340
10119Generate code for the 210 processor.
74291a4b
MM
10120@end table
10121
39bc1876
NS
10122@node MIPS Options
10123@subsection MIPS Options
10124@cindex MIPS options
74291a4b 10125
2642624b 10126@table @gcctabopt
74291a4b 10127
39bc1876
NS
10128@item -EB
10129@opindex EB
10130Generate big-endian code.
74291a4b 10131
39bc1876
NS
10132@item -EL
10133@opindex EL
10134Generate little-endian code. This is the default for @samp{mips*el-*-*}
10135configurations.
74291a4b 10136
39bc1876
NS
10137@item -march=@var{arch}
10138@opindex march
10139Generate code that will run on @var{arch}, which can be the name of a
10140generic MIPS ISA, or the name of a particular processor.
10141The ISA names are:
10142@samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10143@samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10144The processor names are:
79dad081
DU
10145@samp{4kc}, @samp{4km}, @samp{4kp},
10146@samp{5kc}, @samp{5kf},
10147@samp{20kc},
10148@samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
39bc1876 10149@samp{m4k},
39bc1876 10150@samp{orion},
79dad081
DU
10151@samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10152@samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10153@samp{rm7000}, @samp{rm9000},
39bc1876 10154@samp{sb1},
79dad081 10155@samp{sr71000},
39bc1876
NS
10156@samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10157@samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10158The special value @samp{from-abi} selects the
10159most compatible architecture for the selected ABI (that is,
10160@samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
74291a4b 10161
39bc1876
NS
10162In processor names, a final @samp{000} can be abbreviated as @samp{k}
10163(for example, @samp{-march=r2k}). Prefixes are optional, and
10164@samp{vr} may be written @samp{r}.
74291a4b 10165
39bc1876
NS
10166GCC defines two macros based on the value of this option. The first
10167is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10168a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
10169where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10170For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10171to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
74291a4b 10172
39bc1876
NS
10173Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10174above. In other words, it will have the full prefix and will not
10175abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
10176the macro names the resolved architecture (either @samp{"mips1"} or
10177@samp{"mips3"}). It names the default architecture when no
10178@option{-march} option is given.
74291a4b 10179
39bc1876
NS
10180@item -mtune=@var{arch}
10181@opindex mtune
10182Optimize for @var{arch}. Among other things, this option controls
10183the way instructions are scheduled, and the perceived cost of arithmetic
10184operations. The list of @var{arch} values is the same as for
10185@option{-march}.
74291a4b 10186
39bc1876
NS
10187When this option is not used, GCC will optimize for the processor
10188specified by @option{-march}. By using @option{-march} and
10189@option{-mtune} together, it is possible to generate code that will
10190run on a family of processors, but optimize the code for one
10191particular member of that family.
74291a4b 10192
39bc1876
NS
10193@samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10194@samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10195@samp{-march} ones described above.
74291a4b 10196
39bc1876
NS
10197@item -mips1
10198@opindex mips1
10199Equivalent to @samp{-march=mips1}.
74291a4b 10200
39bc1876
NS
10201@item -mips2
10202@opindex mips2
10203Equivalent to @samp{-march=mips2}.
74291a4b 10204
39bc1876
NS
10205@item -mips3
10206@opindex mips3
10207Equivalent to @samp{-march=mips3}.
74291a4b 10208
39bc1876
NS
10209@item -mips4
10210@opindex mips4
10211Equivalent to @samp{-march=mips4}.
10212
10213@item -mips32
10214@opindex mips32
10215Equivalent to @samp{-march=mips32}.
74291a4b 10216
39bc1876
NS
10217@item -mips32r2
10218@opindex mips32r2
10219Equivalent to @samp{-march=mips32r2}.
74291a4b 10220
39bc1876
NS
10221@item -mips64
10222@opindex mips64
10223Equivalent to @samp{-march=mips64}.
74291a4b 10224
39bc1876
NS
10225@item -mips16
10226@itemx -mno-mips16
10227@opindex mips16
10228@opindex mno-mips16
7cc63a88 10229Generate (do not generate) MIPS16 code. If GCC is targetting a
71cb39e6 10230MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
74291a4b 10231
39bc1876
NS
10232@item -mabi=32
10233@itemx -mabi=o64
10234@itemx -mabi=n32
10235@itemx -mabi=64
10236@itemx -mabi=eabi
10237@opindex mabi=32
10238@opindex mabi=o64
10239@opindex mabi=n32
10240@opindex mabi=64
10241@opindex mabi=eabi
10242Generate code for the given ABI@.
74291a4b 10243
39bc1876
NS
10244Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
10245generates 64-bit code when you select a 64-bit architecture, but you
10246can use @option{-mgp32} to get 32-bit code instead.
74291a4b 10247
39bc1876
NS
10248For information about the O64 ABI, see
10249@w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
74291a4b 10250
39bc1876
NS
10251@item -mabicalls
10252@itemx -mno-abicalls
10253@opindex mabicalls
10254@opindex mno-abicalls
10255Generate (do not generate) SVR4-style position-independent code.
10256@option{-mabicalls} is the default for SVR4-based systems.
74291a4b 10257
39bc1876
NS
10258@item -mxgot
10259@itemx -mno-xgot
10260@opindex mxgot
10261@opindex mno-xgot
10262Lift (do not lift) the usual restrictions on the size of the global
10263offset table.
74291a4b 10264
8a36672b 10265GCC normally uses a single instruction to load values from the GOT@.
39bc1876
NS
10266While this is relatively efficient, it will only work if the GOT
10267is smaller than about 64k. Anything larger will cause the linker
10268to report an error such as:
74291a4b 10269
39bc1876
NS
10270@cindex relocation truncated to fit (MIPS)
10271@smallexample
10272relocation truncated to fit: R_MIPS_GOT16 foobar
10273@end smallexample
74291a4b 10274
39bc1876
NS
10275If this happens, you should recompile your code with @option{-mxgot}.
10276It should then work with very large GOTs, although it will also be
10277less efficient, since it will take three instructions to fetch the
10278value of a global symbol.
956d6950 10279
39bc1876
NS
10280Note that some linkers can create multiple GOTs. If you have such a
10281linker, you should only need to use @option{-mxgot} when a single object
10282file accesses more than 64k's worth of GOT entries. Very few do.
956d6950 10283
39bc1876
NS
10284These options have no effect unless GCC is generating position
10285independent code.
956d6950 10286
39bc1876
NS
10287@item -mgp32
10288@opindex mgp32
10289Assume that general-purpose registers are 32 bits wide.
58605ba0 10290
39bc1876
NS
10291@item -mgp64
10292@opindex mgp64
10293Assume that general-purpose registers are 64 bits wide.
58605ba0 10294
39bc1876
NS
10295@item -mfp32
10296@opindex mfp32
10297Assume that floating-point registers are 32 bits wide.
58605ba0 10298
39bc1876
NS
10299@item -mfp64
10300@opindex mfp64
10301Assume that floating-point registers are 64 bits wide.
58605ba0 10302
39bc1876
NS
10303@item -mhard-float
10304@opindex mhard-float
10305Use floating-point coprocessor instructions.
58605ba0 10306
39bc1876
NS
10307@item -msoft-float
10308@opindex msoft-float
10309Do not use floating-point coprocessor instructions. Implement
10310floating-point calculations using library calls instead.
3094247f 10311
39bc1876
NS
10312@item -msingle-float
10313@opindex msingle-float
10314Assume that the floating-point coprocessor only supports single-precision
10315operations.
3094247f 10316
39bc1876
NS
10317@itemx -mdouble-float
10318@opindex mdouble-float
10319Assume that the floating-point coprocessor supports double-precision
10320operations. This is the default.
956d6950 10321
118ea793
CF
10322@itemx -mdsp
10323@itemx -mno-dsp
10324@opindex mdsp
10325@opindex mno-dsp
10326Use (do not use) the MIPS DSP ASE. @xref{MIPS DSP Built-in Functions}.
10327
06a4ab70
CF
10328@itemx -mpaired-single
10329@itemx -mno-paired-single
10330@opindex mpaired-single
10331@opindex mno-paired-single
d840bfd3
CF
10332Use (do not use) paired-single floating-point instructions.
10333@xref{MIPS Paired-Single Support}. This option can only be used
10334when generating 64-bit code and requires hardware floating-point
10335support to be enabled.
06a4ab70
CF
10336
10337@itemx -mips3d
10338@itemx -mno-mips3d
10339@opindex mips3d
10340@opindex mno-mips3d
8a36672b 10341Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
d840bfd3 10342The option @option{-mips3d} implies @option{-mpaired-single}.
06a4ab70 10343
39bc1876
NS
10344@item -mlong64
10345@opindex mlong64
10346Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
10347an explanation of the default and the way that the pointer size is
10348determined.
956d6950 10349
39bc1876
NS
10350@item -mlong32
10351@opindex mlong32
10352Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
956d6950 10353
39bc1876
NS
10354The default size of @code{int}s, @code{long}s and pointers depends on
10355the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
10356uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
1035732-bit @code{long}s. Pointers are the same size as @code{long}s,
10358or the same size as integer registers, whichever is smaller.
956d6950 10359
acda0e26
RS
10360@item -msym32
10361@itemx -mno-sym32
10362@opindex msym32
10363@opindex mno-sym32
10364Assume (do not assume) that all symbols have 32-bit values, regardless
10365of the selected ABI@. This option is useful in combination with
10366@option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10367to generate shorter and faster references to symbolic addresses.
10368
39bc1876
NS
10369@item -G @var{num}
10370@opindex G
10371@cindex smaller data references (MIPS)
10372@cindex gp-relative references (MIPS)
10373Put global and static items less than or equal to @var{num} bytes into
10374the small data or bss section instead of the normal data or bss section.
10375This allows the data to be accessed using a single instruction.
10376
10377All modules should be compiled with the same @option{-G @var{num}}
10378value.
956d6950 10379
39bc1876
NS
10380@item -membedded-data
10381@itemx -mno-embedded-data
10382@opindex membedded-data
10383@opindex mno-embedded-data
10384Allocate variables to the read-only data section first if possible, then
10385next in the small data section if possible, otherwise in data. This gives
10386slightly slower code than the default, but reduces the amount of RAM required
10387when executing, and thus may be preferred for some embedded systems.
58605ba0 10388
39bc1876
NS
10389@item -muninit-const-in-rodata
10390@itemx -mno-uninit-const-in-rodata
10391@opindex muninit-const-in-rodata
10392@opindex mno-uninit-const-in-rodata
10393Put uninitialized @code{const} variables in the read-only data section.
10394This option is only meaningful in conjunction with @option{-membedded-data}.
4f69985c 10395
39bc1876
NS
10396@item -msplit-addresses
10397@itemx -mno-split-addresses
10398@opindex msplit-addresses
10399@opindex mno-split-addresses
10400Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
38b974a6 10401relocation operators. This option has been superseded by
39bc1876 10402@option{-mexplicit-relocs} but is retained for backwards compatibility.
58605ba0 10403
39bc1876
NS
10404@item -mexplicit-relocs
10405@itemx -mno-explicit-relocs
10406@opindex mexplicit-relocs
10407@opindex mno-explicit-relocs
10408Use (do not use) assembler relocation operators when dealing with symbolic
10409addresses. The alternative, selected by @option{-mno-explicit-relocs},
10410is to use assembler macros instead.
4f69985c 10411
12e4afe4
RS
10412@option{-mexplicit-relocs} is the default if GCC was configured
10413to use an assembler that supports relocation operators.
4f69985c 10414
39bc1876
NS
10415@item -mcheck-zero-division
10416@itemx -mno-check-zero-division
10417@opindex mcheck-zero-division
10418@opindex mno-check-zero-division
10419Trap (do not trap) on integer division by zero. The default is
10420@option{-mcheck-zero-division}.
4f69985c 10421
9f0df97a
DD
10422@item -mdivide-traps
10423@itemx -mdivide-breaks
10424@opindex mdivide-traps
10425@opindex mdivide-breaks
10426MIPS systems check for division by zero by generating either a
10427conditional trap or a break instruction. Using traps results in
10428smaller code, but is only supported on MIPS II and later. Also, some
10429versions of the Linux kernel have a bug that prevents trap from
8a36672b 10430generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
9f0df97a
DD
10431allow conditional traps on architectures that support them and
10432@option{-mdivide-breaks} to force the use of breaks.
10433
10434The default is usually @option{-mdivide-traps}, but this can be
10435overridden at configure time using @option{--with-divide=breaks}.
10436Divide-by-zero checks can be completely disabled using
10437@option{-mno-check-zero-division}.
10438
39bc1876
NS
10439@item -mmemcpy
10440@itemx -mno-memcpy
10441@opindex mmemcpy
10442@opindex mno-memcpy
10443Force (do not force) the use of @code{memcpy()} for non-trivial block
10444moves. The default is @option{-mno-memcpy}, which allows GCC to inline
10445most constant-sized copies.
74291a4b 10446
39bc1876
NS
10447@item -mlong-calls
10448@itemx -mno-long-calls
10449@opindex mlong-calls
10450@opindex mno-long-calls
10451Disable (do not disable) use of the @code{jal} instruction. Calling
10452functions using @code{jal} is more efficient but requires the caller
10453and callee to be in the same 256 megabyte segment.
d7c23cdc 10454
39bc1876
NS
10455This option has no effect on abicalls code. The default is
10456@option{-mno-long-calls}.
d7c23cdc 10457
39bc1876
NS
10458@item -mmad
10459@itemx -mno-mad
10460@opindex mmad
10461@opindex mno-mad
10462Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
8a36672b 10463instructions, as provided by the R4650 ISA@.
d7c23cdc 10464
39bc1876
NS
10465@item -mfused-madd
10466@itemx -mno-fused-madd
10467@opindex mfused-madd
10468@opindex mno-fused-madd
10469Enable (disable) use of the floating point multiply-accumulate
10470instructions, when they are available. The default is
10471@option{-mfused-madd}.
74291a4b 10472
39bc1876
NS
10473When multiply-accumulate instructions are used, the intermediate
10474product is calculated to infinite precision and is not subject to
10475the FCSR Flush to Zero bit. This may be undesirable in some
10476circumstances.
74291a4b 10477
39bc1876
NS
10478@item -nocpp
10479@opindex nocpp
10480Tell the MIPS assembler to not run its preprocessor over user
10481assembler files (with a @samp{.s} suffix) when assembling them.
74291a4b 10482
39bc1876
NS
10483@item -mfix-r4000
10484@itemx -mno-fix-r4000
10485@opindex mfix-r4000
10486@opindex mno-fix-r4000
10487Work around certain R4000 CPU errata:
10488@itemize @minus
10489@item
10490A double-word or a variable shift may give an incorrect result if executed
10491immediately after starting an integer division.
10492@item
10493A double-word or a variable shift may give an incorrect result if executed
10494while an integer multiplication is in progress.
10495@item
10496An integer division may give an incorrect result if started in a delay slot
10497of a taken branch or a jump.
10498@end itemize
74291a4b 10499
39bc1876
NS
10500@item -mfix-r4400
10501@itemx -mno-fix-r4400
10502@opindex mfix-r4400
10503@opindex mno-fix-r4400
10504Work around certain R4400 CPU errata:
10505@itemize @minus
10506@item
10507A double-word or a variable shift may give an incorrect result if executed
10508immediately after starting an integer division.
10509@end itemize
dcb9d1f0 10510
39bc1876
NS
10511@item -mfix-vr4120
10512@itemx -mno-fix-vr4120
10513@opindex mfix-vr4120
10514Work around certain VR4120 errata:
10515@itemize @minus
10516@item
10517@code{dmultu} does not always produce the correct result.
10518@item
10519@code{div} and @code{ddiv} do not always produce the correct result if one
10520of the operands is negative.
10521@end itemize
10522The workarounds for the division errata rely on special functions in
10523@file{libgcc.a}. At present, these functions are only provided by
10524the @code{mips64vr*-elf} configurations.
39ba95b5 10525
39bc1876
NS
10526Other VR4120 errata require a nop to be inserted between certain pairs of
10527instructions. These errata are handled by the assembler, not by GCC itself.
17f0f8fa 10528
0ac40e7a
RS
10529@item -mfix-vr4130
10530@opindex mfix-vr4130
10531Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
10532workarounds are implemented by the assembler rather than by GCC,
10533although GCC will avoid using @code{mflo} and @code{mfhi} if the
10534VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10535instructions are available instead.
10536
39bc1876
NS
10537@item -mfix-sb1
10538@itemx -mno-fix-sb1
10539@opindex mfix-sb1
10540Work around certain SB-1 CPU core errata.
10541(This flag currently works around the SB-1 revision 2
10542``F1'' and ``F2'' floating point errata.)
74291a4b 10543
39bc1876
NS
10544@item -mflush-func=@var{func}
10545@itemx -mno-flush-func
10546@opindex mflush-func
10547Specifies the function to call to flush the I and D caches, or to not
10548call any such function. If called, the function must take the same
10549arguments as the common @code{_flush_func()}, that is, the address of the
10550memory range for which the cache is being flushed, the size of the
10551memory range, and the number 3 (to flush both caches). The default
10552depends on the target GCC was configured for, but commonly is either
10553@samp{_flush_func} or @samp{__cpu_flush}.
74291a4b 10554
39bc1876
NS
10555@item -mbranch-likely
10556@itemx -mno-branch-likely
10557@opindex mbranch-likely
10558@opindex mno-branch-likely
10559Enable or disable use of Branch Likely instructions, regardless of the
10560default for the selected architecture. By default, Branch Likely
10561instructions may be generated if they are supported by the selected
10562architecture. An exception is for the MIPS32 and MIPS64 architectures
10563and processors which implement those architectures; for those, Branch
10564Likely instructions will not be generated by default because the MIPS32
10565and MIPS64 architectures specifically deprecate their use.
74291a4b 10566
39bc1876
NS
10567@item -mfp-exceptions
10568@itemx -mno-fp-exceptions
10569@opindex mfp-exceptions
10570Specifies whether FP exceptions are enabled. This affects how we schedule
10571FP instructions for some processors. The default is that FP exceptions are
10572enabled.
74291a4b 10573
39bc1876
NS
10574For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
1057564-bit code, then we can use both FP pipes. Otherwise, we can only use one
10576FP pipe.
74291a4b 10577
39bc1876
NS
10578@item -mvr4130-align
10579@itemx -mno-vr4130-align
10580@opindex mvr4130-align
10581The VR4130 pipeline is two-way superscalar, but can only issue two
10582instructions together if the first one is 8-byte aligned. When this
10583option is enabled, GCC will align pairs of instructions that it
10584thinks should execute in parallel.
74291a4b 10585
39bc1876
NS
10586This option only has an effect when optimizing for the VR4130.
10587It normally makes code faster, but at the expense of making it bigger.
10588It is enabled by default at optimization level @option{-O3}.
10589@end table
3a8699c7 10590
39bc1876
NS
10591@node MMIX Options
10592@subsection MMIX Options
10593@cindex MMIX Options
74291a4b 10594
39bc1876 10595These options are defined for the MMIX:
74291a4b 10596
39bc1876
NS
10597@table @gcctabopt
10598@item -mlibfuncs
10599@itemx -mno-libfuncs
10600@opindex mlibfuncs
10601@opindex mno-libfuncs
10602Specify that intrinsic library functions are being compiled, passing all
10603values in registers, no matter the size.
3cadd778 10604
39bc1876
NS
10605@item -mepsilon
10606@itemx -mno-epsilon
10607@opindex mepsilon
10608@opindex mno-epsilon
10609Generate floating-point comparison instructions that compare with respect
10610to the @code{rE} epsilon register.
3cadd778 10611
39bc1876
NS
10612@item -mabi=mmixware
10613@itemx -mabi=gnu
10614@opindex mabi-mmixware
10615@opindex mabi=gnu
10616Generate code that passes function parameters and return values that (in
10617the called function) are seen as registers @code{$0} and up, as opposed to
10618the GNU ABI which uses global registers @code{$231} and up.
3cadd778 10619
39bc1876
NS
10620@item -mzero-extend
10621@itemx -mno-zero-extend
10622@opindex mzero-extend
10623@opindex mno-zero-extend
10624When reading data from memory in sizes shorter than 64 bits, use (do not
10625use) zero-extending load instructions by default, rather than
10626sign-extending ones.
3cadd778 10627
39bc1876
NS
10628@item -mknuthdiv
10629@itemx -mno-knuthdiv
10630@opindex mknuthdiv
10631@opindex mno-knuthdiv
10632Make the result of a division yielding a remainder have the same sign as
10633the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
10634remainder follows the sign of the dividend. Both methods are
10635arithmetically valid, the latter being almost exclusively used.
74291a4b 10636
39bc1876
NS
10637@item -mtoplevel-symbols
10638@itemx -mno-toplevel-symbols
10639@opindex mtoplevel-symbols
10640@opindex mno-toplevel-symbols
10641Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10642code can be used with the @code{PREFIX} assembly directive.
74291a4b 10643
39bc1876
NS
10644@item -melf
10645@opindex melf
10646Generate an executable in the ELF format, rather than the default
10647@samp{mmo} format used by the @command{mmix} simulator.
3d5a0820 10648
39bc1876
NS
10649@item -mbranch-predict
10650@itemx -mno-branch-predict
10651@opindex mbranch-predict
10652@opindex mno-branch-predict
10653Use (do not use) the probable-branch instructions, when static branch
10654prediction indicates a probable branch.
3cadd778 10655
39bc1876
NS
10656@item -mbase-addresses
10657@itemx -mno-base-addresses
10658@opindex mbase-addresses
10659@opindex mno-base-addresses
10660Generate (do not generate) code that uses @emph{base addresses}. Using a
10661base address automatically generates a request (handled by the assembler
10662and the linker) for a constant to be set up in a global register. The
10663register is used for one or more base address requests within the range 0
10664to 255 from the value held in the register. The generally leads to short
10665and fast code, but the number of different data items that can be
10666addressed is limited. This means that a program that uses lots of static
10667data may require @option{-mno-base-addresses}.
3cadd778 10668
39bc1876
NS
10669@item -msingle-exit
10670@itemx -mno-single-exit
10671@opindex msingle-exit
10672@opindex mno-single-exit
10673Force (do not force) generated code to have a single exit point in each
10674function.
10675@end table
3cadd778 10676
39bc1876
NS
10677@node MN10300 Options
10678@subsection MN10300 Options
10679@cindex MN10300 options
3cadd778 10680
39bc1876 10681These @option{-m} options are defined for Matsushita MN10300 architectures:
3cadd778 10682
39bc1876
NS
10683@table @gcctabopt
10684@item -mmult-bug
10685@opindex mmult-bug
10686Generate code to avoid bugs in the multiply instructions for the MN10300
10687processors. This is the default.
c474f76b 10688
39bc1876
NS
10689@item -mno-mult-bug
10690@opindex mno-mult-bug
10691Do not generate code to avoid bugs in the multiply instructions for the
10692MN10300 processors.
3cadd778 10693
39bc1876
NS
10694@item -mam33
10695@opindex mam33
10696Generate code which uses features specific to the AM33 processor.
3cadd778 10697
39bc1876
NS
10698@item -mno-am33
10699@opindex mno-am33
10700Do not generate code which uses features specific to the AM33 processor. This
10701is the default.
1a66cd67 10702
b1eb8119
DD
10703@item -mreturn-pointer-on-d0
10704@opindex mreturn-pointer-on-d0
10705When generating a function which returns a pointer, return the pointer
10706in both @code{a0} and @code{d0}. Otherwise, the pointer is returned
10707only in a0, and attempts to call such functions without a prototype
10708would result in errors. Note that this option is on by default; use
10709@option{-mno-return-pointer-on-d0} to disable it.
10710
39bc1876
NS
10711@item -mno-crt0
10712@opindex mno-crt0
10713Do not link in the C run-time initialization object file.
93ca1662 10714
39bc1876
NS
10715@item -mrelax
10716@opindex mrelax
10717Indicate to the linker that it should perform a relaxation optimization pass
10718to shorten branches, calls and absolute memory addresses. This option only
10719has an effect when used on the command line for the final link step.
10720
10721This option makes symbolic debugging impossible.
74291a4b
MM
10722@end table
10723
6c9ac67a
NS
10724@node MT Options
10725@subsection MT Options
10726@cindex MT options
c85ba4fb 10727
6c9ac67a 10728These @option{-m} options are defined for Morpho MT architectures:
c85ba4fb
AH
10729
10730@table @gcctabopt
10731
10732@item -march=@var{cpu-type}
10733@opindex march
10734Generate code that will run on @var{cpu-type}, which is the name of a system
10735representing a certain processor type. Possible values for
6c9ac67a
NS
10736@var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
10737@samp{ms1-16-003} and @samp{ms2}.
c85ba4fb 10738
6c9ac67a 10739When this option is not used, the default is @option{-march=ms1-16-002}.
c85ba4fb
AH
10740
10741@item -mbacc
10742@opindex mbacc
10743Use byte loads and stores when generating code.
10744
10745@item -mno-bacc
10746@opindex mno-bacc
10747Do not use byte loads and stores when generating code.
10748
10749@item -msim
10750@opindex msim
10751Use simulator runtime
10752
10753@item -mno-crt0
10754@opindex mno-crt0
10755Do not link in the C run-time initialization object file
57b51d4d 10756@file{crti.o}. Other run-time initialization and termination files
c85ba4fb
AH
10757such as @file{startup.o} and @file{exit.o} are still included on the
10758linker command line.
10759
10760@end table
10761
39bc1876
NS
10762@node PDP-11 Options
10763@subsection PDP-11 Options
10764@cindex PDP-11 Options
f84271d9 10765
39bc1876 10766These options are defined for the PDP-11:
f84271d9 10767
2642624b 10768@table @gcctabopt
39bc1876
NS
10769@item -mfpu
10770@opindex mfpu
10771Use hardware FPP floating point. This is the default. (FIS floating
10772point on the PDP-11/40 is not supported.)
f84271d9 10773
39bc1876
NS
10774@item -msoft-float
10775@opindex msoft-float
10776Do not use hardware floating point.
f84271d9 10777
39bc1876
NS
10778@item -mac0
10779@opindex mac0
10780Return floating-point results in ac0 (fr0 in Unix assembler syntax).
f84271d9 10781
39bc1876
NS
10782@item -mno-ac0
10783@opindex mno-ac0
10784Return floating-point results in memory. This is the default.
10785
10786@item -m40
10787@opindex m40
10788Generate code for a PDP-11/40.
10789
10790@item -m45
10791@opindex m45
10792Generate code for a PDP-11/45. This is the default.
f84271d9 10793
39bc1876
NS
10794@item -m10
10795@opindex m10
10796Generate code for a PDP-11/10.
f84271d9 10797
39bc1876
NS
10798@item -mbcopy-builtin
10799@opindex bcopy-builtin
70128ad9 10800Use inline @code{movmemhi} patterns for copying memory. This is the
39bc1876 10801default.
f84271d9 10802
39bc1876
NS
10803@item -mbcopy
10804@opindex mbcopy
70128ad9 10805Do not use inline @code{movmemhi} patterns for copying memory.
02f52e19 10806
39bc1876
NS
10807@item -mint16
10808@itemx -mno-int32
10809@opindex mint16
10810@opindex mno-int32
10811Use 16-bit @code{int}. This is the default.
48f0be1b 10812
39bc1876
NS
10813@item -mint32
10814@itemx -mno-int16
10815@opindex mint32
10816@opindex mno-int16
10817Use 32-bit @code{int}.
b4378319 10818
39bc1876
NS
10819@item -mfloat64
10820@itemx -mno-float32
10821@opindex mfloat64
10822@opindex mno-float32
10823Use 64-bit @code{float}. This is the default.
b4378319 10824
39bc1876
NS
10825@item -mfloat32
10826@itemx -mno-float64
10827@opindex mfloat32
10828@opindex mno-float64
10829Use 32-bit @code{float}.
daf2f129 10830
39bc1876
NS
10831@item -mabshi
10832@opindex mabshi
10833Use @code{abshi2} pattern. This is the default.
232830b7 10834
39bc1876
NS
10835@item -mno-abshi
10836@opindex mno-abshi
10837Do not use @code{abshi2} pattern.
b4378319 10838
39bc1876
NS
10839@item -mbranch-expensive
10840@opindex mbranch-expensive
10841Pretend that branches are expensive. This is for experimenting with
10842code generation only.
b4378319 10843
39bc1876
NS
10844@item -mbranch-cheap
10845@opindex mbranch-cheap
10846Do not pretend that branches are expensive. This is the default.
b4378319 10847
39bc1876
NS
10848@item -msplit
10849@opindex msplit
8a36672b 10850Generate code for a system with split I&D@.
b4378319 10851
39bc1876
NS
10852@item -mno-split
10853@opindex mno-split
8a36672b 10854Generate code for a system without split I&D@. This is the default.
f84271d9 10855
39bc1876
NS
10856@item -munix-asm
10857@opindex munix-asm
10858Use Unix assembler syntax. This is the default when configured for
10859@samp{pdp11-*-bsd}.
56b2d7a7 10860
39bc1876
NS
10861@item -mdec-asm
10862@opindex mdec-asm
10863Use DEC assembler syntax. This is the default when configured for any
10864PDP-11 target other than @samp{pdp11-*-bsd}.
10865@end table
56b2d7a7 10866
39bc1876
NS
10867@node PowerPC Options
10868@subsection PowerPC Options
10869@cindex PowerPC options
56b2d7a7 10870
39bc1876 10871These are listed under @xref{RS/6000 and PowerPC Options}.
56b2d7a7 10872
39bc1876
NS
10873@node RS/6000 and PowerPC Options
10874@subsection IBM RS/6000 and PowerPC Options
10875@cindex RS/6000 and PowerPC Options
10876@cindex IBM RS/6000 and PowerPC Options
56b2d7a7 10877
39bc1876
NS
10878These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10879@table @gcctabopt
10880@item -mpower
10881@itemx -mno-power
10882@itemx -mpower2
10883@itemx -mno-power2
10884@itemx -mpowerpc
10885@itemx -mno-powerpc
10886@itemx -mpowerpc-gpopt
10887@itemx -mno-powerpc-gpopt
10888@itemx -mpowerpc-gfxopt
10889@itemx -mno-powerpc-gfxopt
10890@itemx -mpowerpc64
10891@itemx -mno-powerpc64
9719f3b7
DE
10892@itemx -mmfcrf
10893@itemx -mno-mfcrf
10894@itemx -mpopcntb
10895@itemx -mno-popcntb
10896@itemx -mfprnd
10897@itemx -mno-fprnd
39bc1876
NS
10898@opindex mpower
10899@opindex mno-power
10900@opindex mpower2
10901@opindex mno-power2
10902@opindex mpowerpc
10903@opindex mno-powerpc
10904@opindex mpowerpc-gpopt
10905@opindex mno-powerpc-gpopt
10906@opindex mpowerpc-gfxopt
10907@opindex mno-powerpc-gfxopt
10908@opindex mpowerpc64
10909@opindex mno-powerpc64
9719f3b7
DE
10910@opindex mmfcrf
10911@opindex mno-mfcrf
10912@opindex mpopcntb
10913@opindex mno-popcntb
10914@opindex mfprnd
10915@opindex mno-fprnd
39bc1876
NS
10916GCC supports two related instruction set architectures for the
10917RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
10918instructions supported by the @samp{rios} chip set used in the original
10919RS/6000 systems and the @dfn{PowerPC} instruction set is the
9719f3b7
DE
10920architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
10921the IBM 4xx, 6xx, and follow-on microprocessors.
56b2d7a7 10922
39bc1876
NS
10923Neither architecture is a subset of the other. However there is a
10924large common subset of instructions supported by both. An MQ
10925register is included in processors supporting the POWER architecture.
56b2d7a7 10926
39bc1876
NS
10927You use these options to specify which instructions are available on the
10928processor you are using. The default value of these options is
10929determined when configuring GCC@. Specifying the
10930@option{-mcpu=@var{cpu_type}} overrides the specification of these
10931options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
10932rather than the options listed above.
56b2d7a7 10933
39bc1876
NS
10934The @option{-mpower} option allows GCC to generate instructions that
10935are found only in the POWER architecture and to use the MQ register.
10936Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10937to generate instructions that are present in the POWER2 architecture but
10938not the original POWER architecture.
83575957 10939
39bc1876
NS
10940The @option{-mpowerpc} option allows GCC to generate instructions that
10941are found only in the 32-bit subset of the PowerPC architecture.
10942Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10943GCC to use the optional PowerPC architecture instructions in the
10944General Purpose group, including floating-point square root. Specifying
10945@option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10946use the optional PowerPC architecture instructions in the Graphics
10947group, including floating-point select.
83575957 10948
9719f3b7
DE
10949The @option{-mmfcrf} option allows GCC to generate the move from
10950condition register field instruction implemented on the POWER4
10951processor and other processors that support the PowerPC V2.01
10952architecture.
10953The @option{-mpopcntb} option allows GCC to generate the popcount and
10954double precision FP reciprocal estimate instruction implemented on the
10955POWER5 processor and other processors that support the PowerPC V2.02
10956architecture.
10957The @option{-mfprnd} option allows GCC to generate the FP round to
10958integer instructions implemented on the POWER5+ processor and other
10959processors that support the PowerPC V2.03 architecture.
10960
39bc1876
NS
10961The @option{-mpowerpc64} option allows GCC to generate the additional
1096264-bit instructions that are found in the full PowerPC64 architecture
10963and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
10964@option{-mno-powerpc64}.
83575957 10965
39bc1876
NS
10966If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10967will use only the instructions in the common subset of both
10968architectures plus some special AIX common-mode calls, and will not use
10969the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
10970permits GCC to use any instruction from either architecture and to
10971allow use of the MQ register; specify this for the Motorola MPC601.
83575957 10972
39bc1876
NS
10973@item -mnew-mnemonics
10974@itemx -mold-mnemonics
10975@opindex mnew-mnemonics
10976@opindex mold-mnemonics
10977Select which mnemonics to use in the generated assembler code. With
10978@option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10979the PowerPC architecture. With @option{-mold-mnemonics} it uses the
10980assembler mnemonics defined for the POWER architecture. Instructions
10981defined in only one architecture have only one mnemonic; GCC uses that
10982mnemonic irrespective of which of these options is specified.
83575957 10983
39bc1876
NS
10984GCC defaults to the mnemonics appropriate for the architecture in
10985use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10986value of these option. Unless you are building a cross-compiler, you
10987should normally not specify either @option{-mnew-mnemonics} or
10988@option{-mold-mnemonics}, but should instead accept the default.
83575957 10989
39bc1876
NS
10990@item -mcpu=@var{cpu_type}
10991@opindex mcpu
10992Set architecture type, register usage, choice of mnemonics, and
10993instruction scheduling parameters for machine type @var{cpu_type}.
10994Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10995@samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10996@samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10997@samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10998@samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
9719f3b7 10999@samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
39bc1876 11000@samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
9719f3b7
DE
11001@samp{power4}, @samp{power5}, @samp{power5+},
11002@samp{common}, @samp{powerpc}, @samp{powerpc64},
98c41d98 11003@samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
83575957 11004
39bc1876
NS
11005@option{-mcpu=common} selects a completely generic processor. Code
11006generated under this option will run on any POWER or PowerPC processor.
11007GCC will use only the instructions in the common subset of both
11008architectures, and will not use the MQ register. GCC assumes a generic
11009processor model for scheduling purposes.
83575957 11010
39bc1876
NS
11011@option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11012@option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11013PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11014types, with an appropriate, generic processor model assumed for
11015scheduling purposes.
83575957 11016
39bc1876
NS
11017The other options specify a specific processor. Code generated under
11018those options will run best on that processor, and may not run at all on
11019others.
83575957 11020
39bc1876 11021The @option{-mcpu} options automatically enable or disable the
9719f3b7
DE
11022following options: @option{-maltivec}, @option{-mfprnd},
11023@option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
11024@option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
11025@option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
131aeb82
JM
11026@option{-mpowerpc-gfxopt}, @option{-mstring}, @option{-mmulhw}.
11027The particular options
9719f3b7
DE
11028set for any particular CPU will vary between compiler versions,
11029depending on what setting seems to produce optimal code for that CPU;
11030it doesn't necessarily reflect the actual hardware's capabilities. If
11031you wish to set an individual option to a particular value, you may
11032specify it after the @option{-mcpu} option, like @samp{-mcpu=970
11033-mno-altivec}.
5d7c2819 11034
39bc1876 11035On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
9719f3b7 11036not enabled or disabled by the @option{-mcpu} option at present because
39bc1876
NS
11037AIX does not have full support for these options. You may still
11038enable or disable them individually if you're sure it'll work in your
11039environment.
83575957 11040
39bc1876
NS
11041@item -mtune=@var{cpu_type}
11042@opindex mtune
11043Set the instruction scheduling parameters for machine type
11044@var{cpu_type}, but do not set the architecture type, register usage, or
11045choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
11046values for @var{cpu_type} are used for @option{-mtune} as for
11047@option{-mcpu}. If both are specified, the code generated will use the
11048architecture, registers, and mnemonics set by @option{-mcpu}, but the
11049scheduling parameters set by @option{-mtune}.
83575957 11050
ef765ea9
DE
11051@item -mswdiv
11052@itemx -mno-swdiv
11053@opindex mswdiv
11054@opindex mno-swdiv
11055Generate code to compute division as reciprocal estimate and iterative
11056refinement, creating opportunities for increased throughput. This
11057feature requires: optional PowerPC Graphics instruction set for single
11058precision and FRE instruction for double precision, assuming divides
11059cannot generate user-visible traps, and the domain values not include
11060Infinities, denormals or zero denominator.
11061
39bc1876
NS
11062@item -maltivec
11063@itemx -mno-altivec
11064@opindex maltivec
11065@opindex mno-altivec
7088c6e4
GK
11066Generate code that uses (does not use) AltiVec instructions, and also
11067enable the use of built-in functions that allow more direct access to
11068the AltiVec instruction set. You may also need to set
39bc1876
NS
11069@option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11070enhancements.
83575957 11071
78f5898b
AH
11072@item -mvrsave
11073@item -mno-vrsave
11074@opindex mvrsave
11075@opindex mno-vrsave
11076Generate VRSAVE instructions when generating AltiVec code.
11077
39bc1876
NS
11078@item -mabi=spe
11079@opindex mabi=spe
11080Extend the current ABI with SPE ABI extensions. This does not change
11081the default ABI, instead it adds the SPE ABI extensions to the current
11082ABI@.
83575957 11083
39bc1876
NS
11084@item -mabi=no-spe
11085@opindex mabi=no-spe
8a36672b 11086Disable Booke SPE ABI extensions for the current ABI@.
83575957 11087
7f970b70
AM
11088@item -msecure-plt
11089@opindex msecure-plt
11090Generate code that allows ld and ld.so to build executables and shared
11091libraries with non-exec .plt and .got sections. This is a PowerPC
1109232-bit SYSV ABI option.
11093
11094@item -mbss-plt
11095@opindex mbss-plt
11096Generate code that uses a BSS .plt section that ld.so fills in, and
11097requires .plt and .got sections that are both writable and executable.
11098This is a PowerPC 32-bit SYSV ABI option.
11099
78f5898b
AH
11100@item -misel
11101@itemx -mno-isel
39bc1876 11102@opindex misel
78f5898b 11103@opindex mno-isel
39bc1876 11104This switch enables or disables the generation of ISEL instructions.
83575957 11105
78f5898b
AH
11106@item -misel=@var{yes/no}
11107This switch has been deprecated. Use @option{-misel} and
11108@option{-mno-isel} instead.
11109
11110@item -mspe
11111@itemx -mno-isel
39bc1876 11112@opindex mspe
78f5898b 11113@opindex mno-spe
39bc1876
NS
11114This switch enables or disables the generation of SPE simd
11115instructions.
83575957 11116
78f5898b
AH
11117@item -mspe=@var{yes/no}
11118This option has been deprecated. Use @option{-mspe} and
11119@option{-mno-spe} instead.
11120
4d4cbc0e 11121@item -mfloat-gprs=@var{yes/single/double/no}
39bc1876
NS
11122@itemx -mfloat-gprs
11123@opindex mfloat-gprs
11124This switch enables or disables the generation of floating point
11125operations on the general purpose registers for architectures that
4d4cbc0e
AH
11126support it.
11127
11128The argument @var{yes} or @var{single} enables the use of
11129single-precision floating point operations.
11130
11131The argument @var{double} enables the use of single and
11132double-precision floating point operations.
11133
11134The argument @var{no} disables floating point operations on the
11135general purpose registers.
11136
11137This option is currently only available on the MPC854x.
83575957 11138
49bd1d27
SS
11139@item -m32
11140@itemx -m64
11141@opindex m32
11142@opindex m64
11143Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11144targets (including GNU/Linux). The 32-bit environment sets int, long
11145and pointer to 32 bits and generates code that runs on any PowerPC
11146variant. The 64-bit environment sets int to 32 bits and long and
11147pointer to 64 bits, and generates code for PowerPC64, as for
11148@option{-mpowerpc64}.
11149
39bc1876
NS
11150@item -mfull-toc
11151@itemx -mno-fp-in-toc
11152@itemx -mno-sum-in-toc
11153@itemx -mminimal-toc
11154@opindex mfull-toc
11155@opindex mno-fp-in-toc
11156@opindex mno-sum-in-toc
11157@opindex mminimal-toc
11158Modify generation of the TOC (Table Of Contents), which is created for
11159every executable file. The @option{-mfull-toc} option is selected by
11160default. In that case, GCC will allocate at least one TOC entry for
11161each unique non-automatic variable reference in your program. GCC
11162will also place floating-point constants in the TOC@. However, only
1116316,384 entries are available in the TOC@.
83575957 11164
39bc1876
NS
11165If you receive a linker error message that saying you have overflowed
11166the available TOC space, you can reduce the amount of TOC space used
11167with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11168@option{-mno-fp-in-toc} prevents GCC from putting floating-point
11169constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11170generate code to calculate the sum of an address and a constant at
11171run-time instead of putting that sum into the TOC@. You may specify one
11172or both of these options. Each causes GCC to produce very slightly
11173slower and larger code at the expense of conserving TOC space.
83575957 11174
39bc1876
NS
11175If you still run out of space in the TOC even when you specify both of
11176these options, specify @option{-mminimal-toc} instead. This option causes
11177GCC to make only one TOC entry for every file. When you specify this
11178option, GCC will produce code that is slower and larger but which
11179uses extremely little TOC space. You may wish to use this option
11180only on files that contain less frequently executed code.
83575957 11181
39bc1876
NS
11182@item -maix64
11183@itemx -maix32
11184@opindex maix64
11185@opindex maix32
11186Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11187@code{long} type, and the infrastructure needed to support them.
11188Specifying @option{-maix64} implies @option{-mpowerpc64} and
11189@option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11190implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
83575957 11191
de17c25f
DE
11192@item -mxl-compat
11193@itemx -mno-xl-compat
11194@opindex mxl-compat
11195@opindex mno-xl-compat
11196Produce code that conforms more closely to IBM XLC semantics when using
11197AIX-compatible ABI. Pass floating-point arguments to prototyped
11198functions beyond the register save area (RSA) on the stack in addition
11199to argument FPRs. Do not assume that most significant double in 128
11200bit long double value is properly rounded when comparing values.
11201
11202The AIX calling convention was extended but not initially documented to
39bc1876
NS
11203handle an obscure K&R C case of calling a function that takes the
11204address of its arguments with fewer arguments than declared. AIX XL
11205compilers access floating point arguments which do not fit in the
11206RSA from the stack when a subroutine is compiled without
11207optimization. Because always storing floating-point arguments on the
11208stack is inefficient and rarely needed, this option is not enabled by
11209default and only is necessary when calling subroutines compiled by AIX
11210XL compilers without optimization.
83575957 11211
39bc1876
NS
11212@item -mpe
11213@opindex mpe
11214Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
11215application written to use message passing with special startup code to
11216enable the application to run. The system must have PE installed in the
11217standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11218must be overridden with the @option{-specs=} option to specify the
11219appropriate directory location. The Parallel Environment does not
11220support threads, so the @option{-mpe} option and the @option{-pthread}
11221option are incompatible.
83575957 11222
39bc1876
NS
11223@item -malign-natural
11224@itemx -malign-power
11225@opindex malign-natural
11226@opindex malign-power
d9168963 11227On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
39bc1876
NS
11228@option{-malign-natural} overrides the ABI-defined alignment of larger
11229types, such as floating-point doubles, on their natural size-based boundary.
11230The option @option{-malign-power} instructs GCC to follow the ABI-specified
8a36672b 11231alignment rules. GCC defaults to the standard alignment defined in the ABI@.
83575957 11232
d9168963
SS
11233On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11234is not supported.
11235
39bc1876
NS
11236@item -msoft-float
11237@itemx -mhard-float
11238@opindex msoft-float
11239@opindex mhard-float
11240Generate code that does not use (uses) the floating-point register set.
11241Software floating point emulation is provided if you use the
11242@option{-msoft-float} option, and pass the option to GCC when linking.
83575957 11243
39bc1876
NS
11244@item -mmultiple
11245@itemx -mno-multiple
11246@opindex mmultiple
11247@opindex mno-multiple
11248Generate code that uses (does not use) the load multiple word
11249instructions and the store multiple word instructions. These
11250instructions are generated by default on POWER systems, and not
11251generated on PowerPC systems. Do not use @option{-mmultiple} on little
11252endian PowerPC systems, since those instructions do not work when the
11253processor is in little endian mode. The exceptions are PPC740 and
11254PPC750 which permit the instructions usage in little endian mode.
83575957 11255
39bc1876
NS
11256@item -mstring
11257@itemx -mno-string
11258@opindex mstring
11259@opindex mno-string
11260Generate code that uses (does not use) the load string instructions
11261and the store string word instructions to save multiple registers and
11262do small block moves. These instructions are generated by default on
11263POWER systems, and not generated on PowerPC systems. Do not use
11264@option{-mstring} on little endian PowerPC systems, since those
11265instructions do not work when the processor is in little endian mode.
11266The exceptions are PPC740 and PPC750 which permit the instructions
11267usage in little endian mode.
052a4b28 11268
39bc1876
NS
11269@item -mupdate
11270@itemx -mno-update
11271@opindex mupdate
11272@opindex mno-update
11273Generate code that uses (does not use) the load or store instructions
11274that update the base register to the address of the calculated memory
11275location. These instructions are generated by default. If you use
11276@option{-mno-update}, there is a small window between the time that the
11277stack pointer is updated and the address of the previous frame is
11278stored, which means code that walks the stack frame across interrupts or
11279signals may get corrupted data.
052a4b28 11280
39bc1876
NS
11281@item -mfused-madd
11282@itemx -mno-fused-madd
11283@opindex mfused-madd
11284@opindex mno-fused-madd
11285Generate code that uses (does not use) the floating point multiply and
11286accumulate instructions. These instructions are generated by default if
11287hardware floating is used.
3a69a7d5 11288
131aeb82
JM
11289@item -mmulhw
11290@itemx -mno-mulhw
11291@opindex mmulhw
11292@opindex mno-mulhw
11293Generate code that uses (does not use) the half-word multiply and
11294multiply-accumulate instructions on the IBM 405 and 440 processors.
11295These instructions are generated by default when targetting those
11296processors.
11297
39bc1876
NS
11298@item -mno-bit-align
11299@itemx -mbit-align
11300@opindex mno-bit-align
11301@opindex mbit-align
11302On System V.4 and embedded PowerPC systems do not (do) force structures
11303and unions that contain bit-fields to be aligned to the base type of the
11304bit-field.
3a69a7d5 11305
39bc1876
NS
11306For example, by default a structure containing nothing but 8
11307@code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11308boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
11309the structure would be aligned to a 1 byte boundary and be one byte in
11310size.
3a69a7d5 11311
39bc1876
NS
11312@item -mno-strict-align
11313@itemx -mstrict-align
11314@opindex mno-strict-align
11315@opindex mstrict-align
11316On System V.4 and embedded PowerPC systems do not (do) assume that
11317unaligned memory references will be handled by the system.
3a69a7d5 11318
39bc1876
NS
11319@item -mrelocatable
11320@itemx -mno-relocatable
11321@opindex mrelocatable
11322@opindex mno-relocatable
11323On embedded PowerPC systems generate code that allows (does not allow)
11324the program to be relocated to a different address at runtime. If you
11325use @option{-mrelocatable} on any module, all objects linked together must
11326be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
3a69a7d5 11327
39bc1876
NS
11328@item -mrelocatable-lib
11329@itemx -mno-relocatable-lib
11330@opindex mrelocatable-lib
11331@opindex mno-relocatable-lib
11332On embedded PowerPC systems generate code that allows (does not allow)
11333the program to be relocated to a different address at runtime. Modules
11334compiled with @option{-mrelocatable-lib} can be linked with either modules
11335compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11336with modules compiled with the @option{-mrelocatable} options.
052a4b28 11337
39bc1876
NS
11338@item -mno-toc
11339@itemx -mtoc
11340@opindex mno-toc
11341@opindex mtoc
11342On System V.4 and embedded PowerPC systems do not (do) assume that
11343register 2 contains a pointer to a global area pointing to the addresses
11344used in the program.
052a4b28 11345
39bc1876
NS
11346@item -mlittle
11347@itemx -mlittle-endian
11348@opindex mlittle
11349@opindex mlittle-endian
11350On System V.4 and embedded PowerPC systems compile code for the
11351processor in little endian mode. The @option{-mlittle-endian} option is
11352the same as @option{-mlittle}.
052a4b28 11353
39bc1876
NS
11354@item -mbig
11355@itemx -mbig-endian
11356@opindex mbig
11357@opindex mbig-endian
11358On System V.4 and embedded PowerPC systems compile code for the
11359processor in big endian mode. The @option{-mbig-endian} option is
11360the same as @option{-mbig}.
052a4b28 11361
39bc1876
NS
11362@item -mdynamic-no-pic
11363@opindex mdynamic-no-pic
11364On Darwin and Mac OS X systems, compile code so that it is not
11365relocatable, but that its external references are relocatable. The
11366resulting code is suitable for applications, but not shared
11367libraries.
3a69a7d5 11368
39bc1876
NS
11369@item -mprioritize-restricted-insns=@var{priority}
11370@opindex mprioritize-restricted-insns
11371This option controls the priority that is assigned to
11372dispatch-slot restricted instructions during the second scheduling
11373pass. The argument @var{priority} takes the value @var{0/1/2} to assign
11374@var{no/highest/second-highest} priority to dispatch slot restricted
11375instructions.
3a69a7d5 11376
39bc1876
NS
11377@item -msched-costly-dep=@var{dependence_type}
11378@opindex msched-costly-dep
11379This option controls which dependences are considered costly
11380by the target during instruction scheduling. The argument
11381@var{dependence_type} takes one of the following values:
11382@var{no}: no dependence is costly,
11383@var{all}: all dependences are costly,
11384@var{true_store_to_load}: a true dependence from store to load is costly,
11385@var{store_to_load}: any dependence from store to load is costly,
11386@var{number}: any dependence which latency >= @var{number} is costly.
11338cda 11387
39bc1876
NS
11388@item -minsert-sched-nops=@var{scheme}
11389@opindex minsert-sched-nops
11390This option controls which nop insertion scheme will be used during
8a36672b 11391the second scheduling pass. The argument @var{scheme} takes one of the
39bc1876
NS
11392following values:
11393@var{no}: Don't insert nops.
11394@var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11395according to the scheduler's grouping.
11396@var{regroup_exact}: Insert nops to force costly dependent insns into
11397separate groups. Insert exactly as many nops as needed to force an insn
11398to a new group, according to the estimated processor grouping.
11399@var{number}: Insert nops to force costly dependent insns into
11400separate groups. Insert @var{number} nops to force an insn to a new group.
052a4b28 11401
39bc1876
NS
11402@item -mcall-sysv
11403@opindex mcall-sysv
11404On System V.4 and embedded PowerPC systems compile code using calling
11405conventions that adheres to the March 1995 draft of the System V
11406Application Binary Interface, PowerPC processor supplement. This is the
11407default unless you configured GCC using @samp{powerpc-*-eabiaix}.
789a3090 11408
39bc1876
NS
11409@item -mcall-sysv-eabi
11410@opindex mcall-sysv-eabi
11411Specify both @option{-mcall-sysv} and @option{-meabi} options.
789a3090 11412
39bc1876
NS
11413@item -mcall-sysv-noeabi
11414@opindex mcall-sysv-noeabi
11415Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
789a3090 11416
39bc1876
NS
11417@item -mcall-solaris
11418@opindex mcall-solaris
11419On System V.4 and embedded PowerPC systems compile code for the Solaris
11420operating system.
789a3090 11421
39bc1876
NS
11422@item -mcall-linux
11423@opindex mcall-linux
11424On System V.4 and embedded PowerPC systems compile code for the
11425Linux-based GNU system.
789a3090 11426
39bc1876
NS
11427@item -mcall-gnu
11428@opindex mcall-gnu
11429On System V.4 and embedded PowerPC systems compile code for the
11430Hurd-based GNU system.
789a3090 11431
39bc1876
NS
11432@item -mcall-netbsd
11433@opindex mcall-netbsd
11434On System V.4 and embedded PowerPC systems compile code for the
11435NetBSD operating system.
789a3090 11436
39bc1876
NS
11437@item -maix-struct-return
11438@opindex maix-struct-return
11439Return all structures in memory (as specified by the AIX ABI)@.
789a3090 11440
39bc1876
NS
11441@item -msvr4-struct-return
11442@opindex msvr4-struct-return
11443Return structures smaller than 8 bytes in registers (as specified by the
11444SVR4 ABI)@.
789a3090 11445
78f5898b
AH
11446@item -mabi=@var{abi-type}
11447@opindex mabi
11448Extend the current ABI with a particular extension, or remove such extension.
11449Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11450@var{no-spe}@.
789a3090 11451
39bc1876
NS
11452@item -mprototype
11453@itemx -mno-prototype
11454@opindex mprototype
11455@opindex mno-prototype
11456On System V.4 and embedded PowerPC systems assume that all calls to
11457variable argument functions are properly prototyped. Otherwise, the
11458compiler must insert an instruction before every non prototyped call to
11459set or clear bit 6 of the condition code register (@var{CR}) to
11460indicate whether floating point values were passed in the floating point
11461registers in case the function takes a variable arguments. With
11462@option{-mprototype}, only calls to prototyped variable argument functions
11463will set or clear the bit.
83575957 11464
39bc1876
NS
11465@item -msim
11466@opindex msim
11467On embedded PowerPC systems, assume that the startup module is called
11468@file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11469@file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
11470configurations.
df6194d4 11471
39bc1876
NS
11472@item -mmvme
11473@opindex mmvme
11474On embedded PowerPC systems, assume that the startup module is called
11475@file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11476@file{libc.a}.
df6194d4 11477
39bc1876
NS
11478@item -mads
11479@opindex mads
11480On embedded PowerPC systems, assume that the startup module is called
11481@file{crt0.o} and the standard C libraries are @file{libads.a} and
11482@file{libc.a}.
df6194d4 11483
39bc1876
NS
11484@item -myellowknife
11485@opindex myellowknife
11486On embedded PowerPC systems, assume that the startup module is called
11487@file{crt0.o} and the standard C libraries are @file{libyk.a} and
11488@file{libc.a}.
df6194d4 11489
39bc1876
NS
11490@item -mvxworks
11491@opindex mvxworks
11492On System V.4 and embedded PowerPC systems, specify that you are
11493compiling for a VxWorks system.
df6194d4 11494
39bc1876
NS
11495@item -mwindiss
11496@opindex mwindiss
11497Specify that you are compiling for the WindISS simulation environment.
df6194d4 11498
39bc1876
NS
11499@item -memb
11500@opindex memb
11501On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11502header to indicate that @samp{eabi} extended relocations are used.
df6194d4 11503
39bc1876
NS
11504@item -meabi
11505@itemx -mno-eabi
11506@opindex meabi
11507@opindex mno-eabi
11508On System V.4 and embedded PowerPC systems do (do not) adhere to the
11509Embedded Applications Binary Interface (eabi) which is a set of
11510modifications to the System V.4 specifications. Selecting @option{-meabi}
11511means that the stack is aligned to an 8 byte boundary, a function
11512@code{__eabi} is called to from @code{main} to set up the eabi
11513environment, and the @option{-msdata} option can use both @code{r2} and
11514@code{r13} to point to two separate small data areas. Selecting
11515@option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11516do not call an initialization function from @code{main}, and the
11517@option{-msdata} option will only use @code{r13} to point to a single
11518small data area. The @option{-meabi} option is on by default if you
11519configured GCC using one of the @samp{powerpc*-*-eabi*} options.
df6194d4 11520
39bc1876
NS
11521@item -msdata=eabi
11522@opindex msdata=eabi
11523On System V.4 and embedded PowerPC systems, put small initialized
11524@code{const} global and static data in the @samp{.sdata2} section, which
11525is pointed to by register @code{r2}. Put small initialized
11526non-@code{const} global and static data in the @samp{.sdata} section,
11527which is pointed to by register @code{r13}. Put small uninitialized
11528global and static data in the @samp{.sbss} section, which is adjacent to
11529the @samp{.sdata} section. The @option{-msdata=eabi} option is
11530incompatible with the @option{-mrelocatable} option. The
11531@option{-msdata=eabi} option also sets the @option{-memb} option.
df6194d4 11532
39bc1876
NS
11533@item -msdata=sysv
11534@opindex msdata=sysv
11535On System V.4 and embedded PowerPC systems, put small global and static
11536data in the @samp{.sdata} section, which is pointed to by register
11537@code{r13}. Put small uninitialized global and static data in the
11538@samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11539The @option{-msdata=sysv} option is incompatible with the
11540@option{-mrelocatable} option.
df6194d4 11541
39bc1876 11542@item -msdata=default
df6194d4 11543@itemx -msdata
39bc1876 11544@opindex msdata=default
cd3bb277 11545@opindex msdata
39bc1876
NS
11546On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11547compile code the same as @option{-msdata=eabi}, otherwise compile code the
11548same as @option{-msdata=sysv}.
df6194d4 11549
39bc1876
NS
11550@item -msdata-data
11551@opindex msdata-data
05f25017
AM
11552On System V.4 and embedded PowerPC systems, put small global
11553data in the @samp{.sdata} section. Put small uninitialized global
11554data in the @samp{.sbss} section. Do not use register @code{r13}
39bc1876
NS
11555to address small data however. This is the default behavior unless
11556other @option{-msdata} options are used.
df6194d4 11557
39bc1876
NS
11558@item -msdata=none
11559@itemx -mno-sdata
11560@opindex msdata=none
11561@opindex mno-sdata
11562On embedded PowerPC systems, put all initialized global and static data
11563in the @samp{.data} section, and all uninitialized data in the
11564@samp{.bss} section.
df6194d4 11565
39bc1876
NS
11566@item -G @var{num}
11567@opindex G
11568@cindex smaller data references (PowerPC)
11569@cindex .sdata/.sdata2 references (PowerPC)
11570On embedded PowerPC systems, put global and static items less than or
11571equal to @var{num} bytes into the small data or bss sections instead of
11572the normal data or bss section. By default, @var{num} is 8. The
11573@option{-G @var{num}} switch is also passed to the linker.
11574All modules should be compiled with the same @option{-G @var{num}} value.
dcffbade 11575
39bc1876
NS
11576@item -mregnames
11577@itemx -mno-regnames
11578@opindex mregnames
11579@opindex mno-regnames
11580On System V.4 and embedded PowerPC systems do (do not) emit register
11581names in the assembly language output using symbolic forms.
dcffbade 11582
39bc1876
NS
11583@item -mlongcall
11584@itemx -mno-longcall
11585@opindex mlongcall
11586@opindex mno-longcall
11587Default to making all function calls indirectly, using a register, so
11588that functions which reside further than 32 megabytes (33,554,432
11589bytes) from the current location can be called. This setting can be
11590overridden by the @code{shortcall} function attribute, or by
11591@code{#pragma longcall(0)}.
dcffbade 11592
39bc1876
NS
11593Some linkers are capable of detecting out-of-range calls and generating
11594glue code on the fly. On these systems, long calls are unnecessary and
11595generate slower code. As of this writing, the AIX linker can do this,
11596as can the GNU linker for PowerPC/64. It is planned to add this feature
11597to the GNU linker for 32-bit PowerPC systems as well.
df6194d4 11598
39bc1876
NS
11599On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11600callee, L42'', plus a ``branch island'' (glue code). The two target
d78aa55c 11601addresses represent the callee and the ``branch island''. The
39bc1876
NS
11602Darwin/PPC linker will prefer the first address and generate a ``bl
11603callee'' if the PPC ``bl'' instruction will reach the callee directly;
11604otherwise, the linker will generate ``bl L42'' to call the ``branch
d78aa55c 11605island''. The ``branch island'' is appended to the body of the
39bc1876
NS
11606calling function; it computes the full 32-bit address of the callee
11607and jumps to it.
df6194d4 11608
39bc1876
NS
11609On Mach-O (Darwin) systems, this option directs the compiler emit to
11610the glue for every direct call, and the Darwin linker decides whether
11611to use or discard it.
11612
11613In the future, we may cause GCC to ignore all longcall specifications
11614when the linker is known to generate glue.
11615
11616@item -pthread
11617@opindex pthread
11618Adds support for multithreading with the @dfn{pthreads} library.
11619This option sets flags for both the preprocessor and linker.
30028c85 11620
df6194d4
JW
11621@end table
11622
91abf72d
HP
11623@node S/390 and zSeries Options
11624@subsection S/390 and zSeries Options
11625@cindex S/390 and zSeries Options
11626
11627These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11628
11629@table @gcctabopt
11630@item -mhard-float
11631@itemx -msoft-float
11632@opindex mhard-float
11633@opindex msoft-float
11634Use (do not use) the hardware floating-point instructions and registers
11635for floating-point operations. When @option{-msoft-float} is specified,
11636functions in @file{libgcc.a} will be used to perform floating-point
11637operations. When @option{-mhard-float} is specified, the compiler
11638generates IEEE floating-point instructions. This is the default.
11639
11640@item -mbackchain
11641@itemx -mno-backchain
11642@opindex mbackchain
11643@opindex mno-backchain
b3d31392
AK
11644Store (do not store) the address of the caller's frame as backchain pointer
11645into the callee's stack frame.
adf39f8f
AK
11646A backchain may be needed to allow debugging using tools that do not understand
11647DWARF-2 call frame information.
b3d31392
AK
11648When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11649at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11650the backchain is placed into the topmost word of the 96/160 byte register
11651save area.
11652
11653In general, code compiled with @option{-mbackchain} is call-compatible with
11654code compiled with @option{-mmo-backchain}; however, use of the backchain
11655for debugging purposes usually requires that the whole binary is built with
6b78f6be
AK
11656@option{-mbackchain}. Note that the combination of @option{-mbackchain},
11657@option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11658to build a linux kernel use @option{-msoft-float}.
b3d31392
AK
11659
11660The default is to not maintain the backchain.
11661
11662@item -mpacked-stack
11663@item -mno-packed-stack
11664@opindex mpacked-stack
11665@opindex mno-packed-stack
11666Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
11667specified, the compiler uses the all fields of the 96/160 byte register save
11668area only for their default purpose; unused fields still take up stack space.
11669When @option{-mpacked-stack} is specified, register save slots are densely
11670packed at the top of the register save area; unused space is reused for other
11671purposes, allowing for more efficient use of the available stack space.
11672However, when @option{-mbackchain} is also in effect, the topmost word of
11673the save area is always used to store the backchain, and the return address
11674register is always saved two words below the backchain.
11675
f2fd3821 11676As long as the stack frame backchain is not used, code generated with
b3d31392
AK
11677@option{-mpacked-stack} is call-compatible with code generated with
11678@option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
11679S/390 or zSeries generated code that uses the stack frame backchain at run
11680time, not just for debugging purposes. Such code is not call-compatible
11681with code compiled with @option{-mpacked-stack}. Also, note that the
6b78f6be
AK
11682combination of @option{-mbackchain},
11683@option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11684to build a linux kernel use @option{-msoft-float}.
b3d31392
AK
11685
11686The default is to not use the packed stack layout.
91abf72d
HP
11687
11688@item -msmall-exec
11689@itemx -mno-small-exec
11690@opindex msmall-exec
11691@opindex mno-small-exec
f282ffb3
JM
11692Generate (or do not generate) code using the @code{bras} instruction
11693to do subroutine calls.
91abf72d
HP
11694This only works reliably if the total executable size does not
11695exceed 64k. The default is to use the @code{basr} instruction instead,
11696which does not have this limitation.
11697
11698@item -m64
11699@itemx -m31
11700@opindex m64
11701@opindex m31
11702When @option{-m31} is specified, generate code compliant to the
95fef11f
JM
11703GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
11704code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
91abf72d 11705particular to generate 64-bit instructions. For the @samp{s390}
f282ffb3 11706targets, the default is @option{-m31}, while the @samp{s390x}
91abf72d
HP
11707targets default to @option{-m64}.
11708
1fec52be
HP
11709@item -mzarch
11710@itemx -mesa
11711@opindex mzarch
11712@opindex mesa
daf2f129
JM
11713When @option{-mzarch} is specified, generate code using the
11714instructions available on z/Architecture.
11715When @option{-mesa} is specified, generate code using the
8a36672b 11716instructions available on ESA/390. Note that @option{-mesa} is
1fec52be 11717not possible with @option{-m64}.
95fef11f 11718When generating code compliant to the GNU/Linux for S/390 ABI,
f13e0d4e 11719the default is @option{-mesa}. When generating code compliant
95fef11f 11720to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
1fec52be 11721
91abf72d
HP
11722@item -mmvcle
11723@itemx -mno-mvcle
11724@opindex mmvcle
11725@opindex mno-mvcle
f282ffb3 11726Generate (or do not generate) code using the @code{mvcle} instruction
3364c33b 11727to perform block moves. When @option{-mno-mvcle} is specified,
8daf098e
AS
11728use a @code{mvc} loop instead. This is the default unless optimizing for
11729size.
91abf72d
HP
11730
11731@item -mdebug
11732@itemx -mno-debug
11733@opindex mdebug
11734@opindex mno-debug
11735Print (or do not print) additional debug information when compiling.
11736The default is to not print debug information.
11737
f13e0d4e 11738@item -march=@var{cpu-type}
1fec52be 11739@opindex march
f13e0d4e 11740Generate code that will run on @var{cpu-type}, which is the name of a system
8a36672b 11741representing a certain processor type. Possible values for
f13e0d4e
UW
11742@var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11743When generating code using the instructions available on z/Architecture,
11744the default is @option{-march=z900}. Otherwise, the default is
11745@option{-march=g5}.
1fec52be 11746
f13e0d4e 11747@item -mtune=@var{cpu-type}
35082351 11748@opindex mtune
1fec52be 11749Tune to @var{cpu-type} everything applicable about the generated code,
f13e0d4e
UW
11750except for the ABI and the set of available instructions.
11751The list of @var{cpu-type} values is the same as for @option{-march}.
11752The default is the value used for @option{-march}.
1fec52be 11753
f26c1794
EC
11754@item -mtpf-trace
11755@itemx -mno-tpf-trace
11756@opindex mtpf-trace
11757@opindex mno-tpf-trace
11758Generate code that adds (does not add) in TPF OS specific branches to trace
11759routines in the operating system. This option is off by default, even
8a36672b 11760when compiling for the TPF OS@.
f26c1794 11761
f2d226e1
AK
11762@item -mfused-madd
11763@itemx -mno-fused-madd
11764@opindex mfused-madd
11765@opindex mno-fused-madd
11766Generate code that uses (does not use) the floating point multiply and
11767accumulate instructions. These instructions are generated by default if
11768hardware floating point is used.
d75f90f1
AK
11769
11770@item -mwarn-framesize=@var{framesize}
11771@opindex mwarn-framesize
11772Emit a warning if the current function exceeds the given frame size. Because
11773this is a compile time check it doesn't need to be a real problem when the program
f0eb93a8
JM
11774runs. It is intended to identify functions which most probably cause
11775a stack overflow. It is useful to be used in an environment with limited stack
431ae0bf 11776size e.g.@: the linux kernel.
d75f90f1
AK
11777
11778@item -mwarn-dynamicstack
11779@opindex mwarn-dynamicstack
11780Emit a warning if the function calls alloca or uses dynamically
11781sized arrays. This is generally a bad idea with a limited stack size.
11782
11783@item -mstack-guard=@var{stack-guard}
11784@item -mstack-size=@var{stack-size}
11785@opindex mstack-guard
11786@opindex mstack-size
11787These arguments always have to be used in conjunction. If they are present the s390
11788back end emits additional instructions in the function prologue which trigger a trap
f0eb93a8
JM
11789if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11790(remember that the stack on s390 grows downward). These options are intended to
11791be used to help debugging stack overflow problems. The additionally emitted code
f695eccf 11792causes only little overhead and hence can also be used in production like systems
f0eb93a8 11793without greater performance degradation. The given values have to be exact
f695eccf
AK
11794powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11795exceeding 64k.
d75f90f1
AK
11796In order to be efficient the extra code makes the assumption that the stack starts
11797at an address aligned to the value given by @var{stack-size}.
91abf72d
HP
11798@end table
11799
39bc1876
NS
11800@node SH Options
11801@subsection SH Options
bcf684c7 11802
39bc1876 11803These @samp{-m} options are defined for the SH implementations:
bcf684c7 11804
5d22c1a5 11805@table @gcctabopt
39bc1876
NS
11806@item -m1
11807@opindex m1
11808Generate code for the SH1.
9f85bca7 11809
39bc1876
NS
11810@item -m2
11811@opindex m2
11812Generate code for the SH2.
9f85bca7 11813
39bc1876
NS
11814@item -m2e
11815Generate code for the SH2e.
9f85bca7 11816
39bc1876
NS
11817@item -m3
11818@opindex m3
11819Generate code for the SH3.
9f85bca7 11820
39bc1876
NS
11821@item -m3e
11822@opindex m3e
11823Generate code for the SH3e.
9f85bca7 11824
39bc1876
NS
11825@item -m4-nofpu
11826@opindex m4-nofpu
11827Generate code for the SH4 without a floating-point unit.
9f85bca7 11828
39bc1876
NS
11829@item -m4-single-only
11830@opindex m4-single-only
11831Generate code for the SH4 with a floating-point unit that only
11832supports single-precision arithmetic.
9f85bca7 11833
39bc1876
NS
11834@item -m4-single
11835@opindex m4-single
11836Generate code for the SH4 assuming the floating-point unit is in
11837single-precision mode by default.
9f85bca7 11838
39bc1876
NS
11839@item -m4
11840@opindex m4
11841Generate code for the SH4.
9f85bca7 11842
312209c6
AO
11843@item -m4a-nofpu
11844@opindex m4a-nofpu
11845Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11846floating-point unit is not used.
11847
11848@item -m4a-single-only
11849@opindex m4a-single-only
11850Generate code for the SH4a, in such a way that no double-precision
11851floating point operations are used.
11852
11853@item -m4a-single
11854@opindex m4a-single
11855Generate code for the SH4a assuming the floating-point unit is in
11856single-precision mode by default.
11857
11858@item -m4a
11859@opindex m4a
11860Generate code for the SH4a.
11861
11862@item -m4al
11863@opindex m4al
11864Same as @option{-m4a-nofpu}, except that it implicitly passes
11865@option{-dsp} to the assembler. GCC doesn't generate any DSP
11866instructions at the moment.
11867
39bc1876
NS
11868@item -mb
11869@opindex mb
11870Compile code for the processor in big endian mode.
9f85bca7 11871
39bc1876
NS
11872@item -ml
11873@opindex ml
11874Compile code for the processor in little endian mode.
9f85bca7 11875
39bc1876
NS
11876@item -mdalign
11877@opindex mdalign
11878Align doubles at 64-bit boundaries. Note that this changes the calling
11879conventions, and thus some functions from the standard C library will
11880not work unless you recompile it first with @option{-mdalign}.
9f85bca7 11881
39bc1876
NS
11882@item -mrelax
11883@opindex mrelax
11884Shorten some address references at link time, when possible; uses the
11885linker option @option{-relax}.
9f85bca7 11886
39bc1876
NS
11887@item -mbigtable
11888@opindex mbigtable
11889Use 32-bit offsets in @code{switch} tables. The default is to use
1189016-bit offsets.
9f85bca7 11891
39bc1876
NS
11892@item -mfmovd
11893@opindex mfmovd
11894Enable the use of the instruction @code{fmovd}.
9f85bca7 11895
39bc1876
NS
11896@item -mhitachi
11897@opindex mhitachi
11898Comply with the calling conventions defined by Renesas.
9f85bca7 11899
2acc29bd
NC
11900@item -mrenesas
11901@opindex mhitachi
11902Comply with the calling conventions defined by Renesas.
11903
11904@item -mno-renesas
11905@opindex mhitachi
11906Comply with the calling conventions defined for GCC before the Renesas
11907conventions were available. This option is the default for all
11908targets of the SH toolchain except for @samp{sh-symbianelf}.
11909
39bc1876
NS
11910@item -mnomacsave
11911@opindex mnomacsave
11912Mark the @code{MAC} register as call-clobbered, even if
11913@option{-mhitachi} is given.
9f85bca7 11914
39bc1876
NS
11915@item -mieee
11916@opindex mieee
11917Increase IEEE-compliance of floating-point code.
73a4d10b
R
11918At the moment, this is equivalent to @option{-fno-finite-math-only}.
11919When generating 16 bit SH opcodes, getting IEEE-conforming results for
11920comparisons of NANs / infinities incurs extra overhead in every
11921floating point comparison, therefore the default is set to
11922@option{-ffinite-math-only}.
9f85bca7 11923
39bc1876
NS
11924@item -misize
11925@opindex misize
11926Dump instruction size and location in the assembly code.
9f85bca7 11927
39bc1876
NS
11928@item -mpadstruct
11929@opindex mpadstruct
11930This option is deprecated. It pads structures to multiple of 4 bytes,
11931which is incompatible with the SH ABI@.
9f85bca7 11932
39bc1876
NS
11933@item -mspace
11934@opindex mspace
11935Optimize for space instead of speed. Implied by @option{-Os}.
9f85bca7 11936
39bc1876
NS
11937@item -mprefergot
11938@opindex mprefergot
11939When generating position-independent code, emit function calls using
11940the Global Offset Table instead of the Procedure Linkage Table.
9f85bca7 11941
39bc1876
NS
11942@item -musermode
11943@opindex musermode
11944Generate a library function call to invalidate instruction cache
11945entries, after fixing up a trampoline. This library function call
11946doesn't assume it can write to the whole memory address space. This
11947is the default when the target is @code{sh-*-linux*}.
73a4d10b
R
11948
11949@item -multcost=@var{number}
11950@opindex multcost=@var{number}
11951Set the cost to assume for a multiply insn.
11952
11953@item -mdiv=@var{strategy}
11954@opindex mdiv=@var{strategy}
11955Set the division strategy to use for SHmedia code. @var{strategy} must be
11956one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11957inv:call2, inv:fp .
11958"fp" performs the operation in floating point. This has a very high latency,
11959but needs only a few instructions, so it might be a good choice if
30dc60c7 11960your code has enough easily exploitable ILP to allow the compiler to
73a4d10b
R
11961schedule the floating point instructions together with other instructions.
11962Division by zero causes a floating point exception.
11963"inv" uses integer operations to calculate the inverse of the divisor,
30dc60c7 11964and then multiplies the dividend with the inverse. This strategy allows
73a4d10b
R
11965cse and hoisting of the inverse calculation. Division by zero calculates
11966an unspecified result, but does not trap.
11967"inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11968have been found, or if the entire operation has been hoisted to the same
11969place, the last stages of the inverse calculation are intertwined with the
11970final multiply to reduce the overall latency, at the expense of using a few
11971more instructions, and thus offering fewer scheduling opportunities with
11972other code.
11973"call" calls a library function that usually implements the inv:minlat
11974strategy.
11975This gives high code density for m5-*media-nofpu compilations.
11976"call2" uses a different entry point of the same library function, where it
11977assumes that a pointer to a lookup table has already been set up, which
11978exposes the pointer load to cse / code hoisting optimizations.
11979"inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11980code generation, but if the code stays unoptimized, revert to the "call",
30dc60c7 11981"call2", or "fp" strategies, respectively. Note that the
73a4d10b
R
11982potentially-trapping side effect of division by zero is carried by a
11983separate instruction, so it is possible that all the integer instructions
11984are hoisted out, but the marker for the side effect stays where it is.
11985A recombination to fp operations or a call is not possible in that case.
11986"inv20u" and "inv20l" are variants of the "inv:minlat" strategy. In the case
11987that the inverse calculation was nor separated from the multiply, they speed
11988up division where the dividend fits into 20 bits (plus sign where applicable),
11989by inserting a test to skip a number of operations in this case; this test
30dc60c7 11990slows down the case of larger dividends. inv20u assumes the case of a such
73a4d10b
R
11991a small dividend to be unlikely, and inv20l assumes it to be likely.
11992
11993@item -mdivsi3_libfunc=@var{name}
11994@opindex mdivsi3_libfunc=@var{name}
11995Set the name of the library function used for 32 bit signed division to
11996@var{name}. This only affect the name used in the call and inv:call
11997division strategies, and the compiler will still expect the same
11998sets of input/output/clobbered registers as if this option was not present.
11999
12000@item -madjust-unroll
12001@opindex madjust-unroll
12002Throttle unrolling to avoid thrashing target registers.
12003This option only has an effect if the gcc code base supports the
12004TARGET_ADJUST_UNROLL_MAX target hook.
12005
12006@item -mindexed-addressing
12007@opindex mindexed-addressing
12008Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12009This is only safe if the hardware and/or OS implement 32 bit wrap-around
12010semantics for the indexed addressing mode. The architecture allows the
12011implementation of processors with 64 bit MMU, which the OS could use to
30dc60c7 12012get 32 bit addressing, but since no current hardware implementation supports
73a4d10b
R
12013this or any other way to make the indexed addressing mode safe to use in
12014the 32 bit ABI, the default is -mno-indexed-addressing.
12015
12016@item -mgettrcost=@var{number}
12017@opindex mgettrcost=@var{number}
12018Set the cost assumed for the gettr instruction to @var{number}.
12019The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12020
12021@item -mpt-fixed
12022@opindex mpt-fixed
12023Assume pt* instructions won't trap. This will generally generate better
12024scheduled code, but is unsafe on current hardware. The current architecture
12025definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12026This has the unintentional effect of making it unsafe to schedule ptabs /
12027ptrel before a branch, or hoist it out of a loop. For example,
12028__do_global_ctors, a part of libgcc that runs constructors at program
12029startup, calls functions in a list which is delimited by -1. With the
12030-mpt-fixed option, the ptabs will be done before testing against -1.
12031That means that all the constructors will be run a bit quicker, but when
30dc60c7 12032the loop comes to the end of the list, the program crashes because ptabs
73a4d10b
R
12033loads -1 into a target register. Since this option is unsafe for any
12034hardware implementing the current architecture specification, the default
12035is -mno-pt-fixed. Unless the user specifies a specific cost with
12036@option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12037this deters register allocation using target registers for storing
12038ordinary integers.
12039
12040@item -minvalid-symbols
12041@opindex minvalid-symbols
12042Assume symbols might be invalid. Ordinary function symbols generated by
12043the compiler will always be valid to load with movi/shori/ptabs or
12044movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12045to generate symbols that will cause ptabs / ptrel to trap.
12046This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12047It will then prevent cross-basic-block cse, hoisting and most scheduling
12048of symbol loads. The default is @option{-mno-invalid-symbols}.
9f85bca7
JM
12049@end table
12050
39bc1876
NS
12051@node SPARC Options
12052@subsection SPARC Options
12053@cindex SPARC options
69a0611f 12054
39bc1876 12055These @samp{-m} options are supported on the SPARC:
69a0611f
GK
12056
12057@table @gcctabopt
39bc1876
NS
12058@item -mno-app-regs
12059@itemx -mapp-regs
12060@opindex mno-app-regs
12061@opindex mapp-regs
12062Specify @option{-mapp-regs} to generate output using the global registers
120632 through 4, which the SPARC SVR4 ABI reserves for applications. This
d14f5ecb 12064is the default.
69a0611f 12065
39bc1876
NS
12066To be fully SVR4 ABI compliant at the cost of some performance loss,
12067specify @option{-mno-app-regs}. You should compile libraries and system
12068software with this option.
70899148 12069
39bc1876
NS
12070@item -mfpu
12071@itemx -mhard-float
12072@opindex mfpu
12073@opindex mhard-float
12074Generate output containing floating point instructions. This is the
12075default.
70899148 12076
39bc1876
NS
12077@item -mno-fpu
12078@itemx -msoft-float
12079@opindex mno-fpu
12080@opindex msoft-float
12081Generate output containing library calls for floating point.
12082@strong{Warning:} the requisite libraries are not available for all SPARC
12083targets. Normally the facilities of the machine's usual C compiler are
12084used, but this cannot be done directly in cross-compilation. You must make
12085your own arrangements to provide suitable library functions for
12086cross-compilation. The embedded targets @samp{sparc-*-aout} and
12087@samp{sparclite-*-*} do provide software floating point support.
70899148 12088
39bc1876
NS
12089@option{-msoft-float} changes the calling convention in the output file;
12090therefore, it is only useful if you compile @emph{all} of a program with
12091this option. In particular, you need to compile @file{libgcc.a}, the
12092library that comes with GCC, with @option{-msoft-float} in order for
12093this to work.
70899148 12094
39bc1876
NS
12095@item -mhard-quad-float
12096@opindex mhard-quad-float
12097Generate output containing quad-word (long double) floating point
12098instructions.
70899148 12099
39bc1876
NS
12100@item -msoft-quad-float
12101@opindex msoft-quad-float
12102Generate output containing library calls for quad-word (long double)
12103floating point instructions. The functions called are those specified
12104in the SPARC ABI@. This is the default.
70899148 12105
39bc1876
NS
12106As of this writing, there are no SPARC implementations that have hardware
12107support for the quad-word floating point instructions. They all invoke
12108a trap handler for one of these instructions, and then the trap handler
12109emulates the effect of the instruction. Because of the trap handler overhead,
12110this is much slower than calling the ABI library routines. Thus the
12111@option{-msoft-quad-float} option is the default.
70899148 12112
39bc1876
NS
12113@item -mno-unaligned-doubles
12114@itemx -munaligned-doubles
12115@opindex mno-unaligned-doubles
12116@opindex munaligned-doubles
12117Assume that doubles have 8 byte alignment. This is the default.
70899148 12118
39bc1876
NS
12119With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12120alignment only if they are contained in another type, or if they have an
12121absolute address. Otherwise, it assumes they have 4 byte alignment.
12122Specifying this option avoids some rare compatibility problems with code
12123generated by other compilers. It is not the default because it results
12124in a performance loss, especially for floating point code.
70899148 12125
39bc1876
NS
12126@item -mno-faster-structs
12127@itemx -mfaster-structs
12128@opindex mno-faster-structs
12129@opindex mfaster-structs
12130With @option{-mfaster-structs}, the compiler assumes that structures
12131should have 8 byte alignment. This enables the use of pairs of
12132@code{ldd} and @code{std} instructions for copies in structure
12133assignment, in place of twice as many @code{ld} and @code{st} pairs.
12134However, the use of this changed alignment directly violates the SPARC
12135ABI@. Thus, it's intended only for use on targets where the developer
12136acknowledges that their resulting code will not be directly in line with
12137the rules of the ABI@.
70899148 12138
39bc1876
NS
12139@item -mimpure-text
12140@opindex mimpure-text
12141@option{-mimpure-text}, used in addition to @option{-shared}, tells
12142the compiler to not pass @option{-z text} to the linker when linking a
12143shared object. Using this option, you can link position-dependent
12144code into a shared object.
70899148 12145
39bc1876
NS
12146@option{-mimpure-text} suppresses the ``relocations remain against
12147allocatable but non-writable sections'' linker error message.
12148However, the necessary relocations will trigger copy-on-write, and the
12149shared object is not actually shared across processes. Instead of
12150using @option{-mimpure-text}, you should compile all source code with
12151@option{-fpic} or @option{-fPIC}.
12152
12153This option is only available on SunOS and Solaris.
12154
12155@item -mcpu=@var{cpu_type}
12156@opindex mcpu
12157Set the instruction set, register set, and instruction scheduling parameters
12158for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
12159@samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12160@samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12161@samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
12162@samp{ultrasparc3}.
70899148 12163
39bc1876
NS
12164Default instruction scheduling parameters are used for values that select
12165an architecture and not an implementation. These are @samp{v7}, @samp{v8},
12166@samp{sparclite}, @samp{sparclet}, @samp{v9}.
70899148 12167
39bc1876
NS
12168Here is a list of each supported architecture and their supported
12169implementations.
70899148 12170
39bc1876
NS
12171@smallexample
12172 v7: cypress
12173 v8: supersparc, hypersparc
12174 sparclite: f930, f934, sparclite86x
12175 sparclet: tsc701
12176 v9: ultrasparc, ultrasparc3
12177@end smallexample
70899148 12178
39bc1876
NS
12179By default (unless configured otherwise), GCC generates code for the V7
12180variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
12181additionally optimizes it for the Cypress CY7C602 chip, as used in the
12182SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
12183SPARCStation 1, 2, IPX etc.
70899148 12184
39bc1876
NS
12185With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12186architecture. The only difference from V7 code is that the compiler emits
12187the integer multiply and integer divide instructions which exist in SPARC-V8
12188but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
12189optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
121902000 series.
70899148 12191
39bc1876
NS
12192With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12193the SPARC architecture. This adds the integer multiply, integer divide step
12194and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12195With @option{-mcpu=f930}, the compiler additionally optimizes it for the
8a36672b 12196Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
39bc1876 12197@option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
8a36672b 12198MB86934 chip, which is the more recent SPARClite with FPU@.
70899148 12199
39bc1876
NS
12200With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12201the SPARC architecture. This adds the integer multiply, multiply/accumulate,
12202integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12203but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
12204optimizes it for the TEMIC SPARClet chip.
70899148 12205
39bc1876
NS
12206With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12207architecture. This adds 64-bit integer and floating-point move instructions,
122083 additional floating-point condition code registers and conditional move
12209instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
12210optimizes it for the Sun UltraSPARC I/II chips. With
12211@option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12212Sun UltraSPARC III chip.
70899148 12213
39bc1876
NS
12214@item -mtune=@var{cpu_type}
12215@opindex mtune
12216Set the instruction scheduling parameters for machine type
12217@var{cpu_type}, but do not set the instruction set or register set that the
12218option @option{-mcpu=@var{cpu_type}} would.
70899148 12219
39bc1876
NS
12220The same values for @option{-mcpu=@var{cpu_type}} can be used for
12221@option{-mtune=@var{cpu_type}}, but the only useful values are those
12222that select a particular cpu implementation. Those are @samp{cypress},
12223@samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12224@samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12225@samp{ultrasparc3}.
70899148 12226
39bc1876
NS
12227@item -mv8plus
12228@itemx -mno-v8plus
12229@opindex mv8plus
12230@opindex mno-v8plus
8a36672b 12231With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
39bc1876
NS
12232difference from the V8 ABI is that the global and out registers are
12233considered 64-bit wide. This is enabled by default on Solaris in 32-bit
12234mode for all SPARC-V9 processors.
70899148 12235
39bc1876
NS
12236@item -mvis
12237@itemx -mno-vis
12238@opindex mvis
12239@opindex mno-vis
12240With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12241Visual Instruction Set extensions. The default is @option{-mno-vis}.
12242@end table
70899148 12243
39bc1876
NS
12244These @samp{-m} options are supported in addition to the above
12245on SPARC-V9 processors in 64-bit environments:
70899148 12246
39bc1876
NS
12247@table @gcctabopt
12248@item -mlittle-endian
12249@opindex mlittle-endian
8a36672b 12250Generate code for a processor running in little-endian mode. It is only
d4e1591f 12251available for a few configurations and most notably not on Solaris and Linux.
70899148 12252
39bc1876
NS
12253@item -m32
12254@itemx -m64
12255@opindex m32
12256@opindex m64
12257Generate code for a 32-bit or 64-bit environment.
12258The 32-bit environment sets int, long and pointer to 32 bits.
12259The 64-bit environment sets int to 32 bits and long and pointer
12260to 64 bits.
70899148 12261
39bc1876
NS
12262@item -mcmodel=medlow
12263@opindex mcmodel=medlow
12264Generate code for the Medium/Low code model: 64-bit addresses, programs
12265must be linked in the low 32 bits of memory. Programs can be statically
12266or dynamically linked.
70899148 12267
39bc1876
NS
12268@item -mcmodel=medmid
12269@opindex mcmodel=medmid
12270Generate code for the Medium/Middle code model: 64-bit addresses, programs
12271must be linked in the low 44 bits of memory, the text and data segments must
12272be less than 2GB in size and the data segment must be located within 2GB of
12273the text segment.
70899148 12274
39bc1876
NS
12275@item -mcmodel=medany
12276@opindex mcmodel=medany
12277Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12278may be linked anywhere in memory, the text and data segments must be less
12279than 2GB in size and the data segment must be located within 2GB of the
12280text segment.
70899148 12281
39bc1876
NS
12282@item -mcmodel=embmedany
12283@opindex mcmodel=embmedany
12284Generate code for the Medium/Anywhere code model for embedded systems:
1228564-bit addresses, the text and data segments must be less than 2GB in
12286size, both starting anywhere in memory (determined at link time). The
12287global register %g4 points to the base of the data segment. Programs
12288are statically linked and PIC is not supported.
70899148 12289
39bc1876
NS
12290@item -mstack-bias
12291@itemx -mno-stack-bias
12292@opindex mstack-bias
12293@opindex mno-stack-bias
12294With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12295frame pointer if present, are offset by @minus{}2047 which must be added back
12296when making stack frame references. This is the default in 64-bit mode.
12297Otherwise, assume no such offset is present.
12298@end table
70899148 12299
6bfb2f93
EB
12300These switches are supported in addition to the above on Solaris:
12301
12302@table @gcctabopt
12303@item -threads
12304@opindex threads
12305Add support for multithreading using the Solaris threads library. This
12306option sets flags for both the preprocessor and linker. This option does
12307not affect the thread safety of object code produced by the compiler or
12308that of libraries supplied with it.
12309
12310@item -pthreads
12311@opindex pthreads
12312Add support for multithreading using the POSIX threads library. This
12313option sets flags for both the preprocessor and linker. This option does
12314not affect the thread safety of object code produced by the compiler or
12315that of libraries supplied with it.
12316@end table
12317
39bc1876
NS
12318@node System V Options
12319@subsection Options for System V
70899148 12320
39bc1876
NS
12321These additional options are available on System V Release 4 for
12322compatibility with other compilers on those systems:
70899148 12323
39bc1876
NS
12324@table @gcctabopt
12325@item -G
12326@opindex G
12327Create a shared object.
12328It is recommended that @option{-symbolic} or @option{-shared} be used instead.
70899148 12329
39bc1876
NS
12330@item -Qy
12331@opindex Qy
12332Identify the versions of each tool used by the compiler, in a
12333@code{.ident} assembler directive in the output.
70899148 12334
39bc1876
NS
12335@item -Qn
12336@opindex Qn
12337Refrain from adding @code{.ident} directives to the output file (this is
12338the default).
70899148 12339
39bc1876
NS
12340@item -YP,@var{dirs}
12341@opindex YP
12342Search the directories @var{dirs}, and no others, for libraries
12343specified with @option{-l}.
70899148 12344
39bc1876
NS
12345@item -Ym,@var{dir}
12346@opindex Ym
12347Look in the directory @var{dir} to find the M4 preprocessor.
12348The assembler uses this option.
12349@c This is supposed to go with a -Yd for predefined M4 macro files, but
12350@c the generic assembler that comes with Solaris takes just -Ym.
12351@end table
70899148 12352
39bc1876
NS
12353@node TMS320C3x/C4x Options
12354@subsection TMS320C3x/C4x Options
12355@cindex TMS320C3x/C4x Options
70899148 12356
39bc1876 12357These @samp{-m} options are defined for TMS320C3x/C4x implementations:
70899148 12358
39bc1876 12359@table @gcctabopt
70899148 12360
39bc1876
NS
12361@item -mcpu=@var{cpu_type}
12362@opindex mcpu
12363Set the instruction set, register set, and instruction scheduling
12364parameters for machine type @var{cpu_type}. Supported values for
12365@var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12366@samp{c44}. The default is @samp{c40} to generate code for the
12367TMS320C40.
70899148 12368
39bc1876
NS
12369@item -mbig-memory
12370@itemx -mbig
12371@itemx -msmall-memory
12372@itemx -msmall
12373@opindex mbig-memory
12374@opindex mbig
12375@opindex msmall-memory
12376@opindex msmall
12377Generates code for the big or small memory model. The small memory
12378model assumed that all data fits into one 64K word page. At run-time
12379the data page (DP) register must be set to point to the 64K page
12380containing the .bss and .data program sections. The big memory model is
12381the default and requires reloading of the DP register for every direct
12382memory access.
70899148 12383
39bc1876
NS
12384@item -mbk
12385@itemx -mno-bk
12386@opindex mbk
12387@opindex mno-bk
12388Allow (disallow) allocation of general integer operands into the block
12389count register BK@.
70899148 12390
39bc1876
NS
12391@item -mdb
12392@itemx -mno-db
12393@opindex mdb
12394@opindex mno-db
12395Enable (disable) generation of code using decrement and branch,
12396DBcond(D), instructions. This is enabled by default for the C4x. To be
12397on the safe side, this is disabled for the C3x, since the maximum
12398iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12399@math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
12400that it can utilize the decrement and branch instruction, but will give
12401up if there is more than one memory reference in the loop. Thus a loop
12402where the loop counter is decremented can generate slightly more
12403efficient code, in cases where the RPTB instruction cannot be utilized.
70899148 12404
39bc1876
NS
12405@item -mdp-isr-reload
12406@itemx -mparanoid
12407@opindex mdp-isr-reload
12408@opindex mparanoid
12409Force the DP register to be saved on entry to an interrupt service
12410routine (ISR), reloaded to point to the data section, and restored on
12411exit from the ISR@. This should not be required unless someone has
12412violated the small memory model by modifying the DP register, say within
12413an object library.
70899148 12414
39bc1876
NS
12415@item -mmpyi
12416@itemx -mno-mpyi
12417@opindex mmpyi
12418@opindex mno-mpyi
12419For the C3x use the 24-bit MPYI instruction for integer multiplies
12420instead of a library call to guarantee 32-bit results. Note that if one
12421of the operands is a constant, then the multiplication will be performed
12422using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
12423then squaring operations are performed inline instead of a library call.
70899148 12424
39bc1876
NS
12425@item -mfast-fix
12426@itemx -mno-fast-fix
12427@opindex mfast-fix
12428@opindex mno-fast-fix
12429The C3x/C4x FIX instruction to convert a floating point value to an
12430integer value chooses the nearest integer less than or equal to the
12431floating point value rather than to the nearest integer. Thus if the
12432floating point number is negative, the result will be incorrectly
12433truncated an additional code is necessary to detect and correct this
12434case. This option can be used to disable generation of the additional
12435code required to correct the result.
70899148 12436
39bc1876
NS
12437@item -mrptb
12438@itemx -mno-rptb
12439@opindex mrptb
12440@opindex mno-rptb
12441Enable (disable) generation of repeat block sequences using the RPTB
12442instruction for zero overhead looping. The RPTB construct is only used
12443for innermost loops that do not call functions or jump across the loop
12444boundaries. There is no advantage having nested RPTB loops due to the
12445overhead required to save and restore the RC, RS, and RE registers.
12446This is enabled by default with @option{-O2}.
70899148 12447
39bc1876
NS
12448@item -mrpts=@var{count}
12449@itemx -mno-rpts
12450@opindex mrpts
12451@opindex mno-rpts
12452Enable (disable) the use of the single instruction repeat instruction
12453RPTS@. If a repeat block contains a single instruction, and the loop
12454count can be guaranteed to be less than the value @var{count}, GCC will
12455emit a RPTS instruction instead of a RPTB@. If no value is specified,
12456then a RPTS will be emitted even if the loop count cannot be determined
12457at compile time. Note that the repeated instruction following RPTS does
12458not have to be reloaded from memory each iteration, thus freeing up the
12459CPU buses for operands. However, since interrupts are blocked by this
12460instruction, it is disabled by default.
70899148 12461
39bc1876
NS
12462@item -mloop-unsigned
12463@itemx -mno-loop-unsigned
12464@opindex mloop-unsigned
12465@opindex mno-loop-unsigned
12466The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12467is @math{2^{31} + 1} since these instructions test if the iteration count is
12468negative to terminate the loop. If the iteration count is unsigned
12469there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12470exceeded. This switch allows an unsigned iteration count.
70899148 12471
39bc1876
NS
12472@item -mti
12473@opindex mti
12474Try to emit an assembler syntax that the TI assembler (asm30) is happy
12475with. This also enforces compatibility with the API employed by the TI
12476C3x C compiler. For example, long doubles are passed as structures
12477rather than in floating point registers.
70899148 12478
39bc1876
NS
12479@item -mregparm
12480@itemx -mmemparm
12481@opindex mregparm
12482@opindex mmemparm
12483Generate code that uses registers (stack) for passing arguments to functions.
12484By default, arguments are passed in registers where possible rather
12485than by pushing arguments on to the stack.
70899148 12486
39bc1876
NS
12487@item -mparallel-insns
12488@itemx -mno-parallel-insns
12489@opindex mparallel-insns
12490@opindex mno-parallel-insns
12491Allow the generation of parallel instructions. This is enabled by
12492default with @option{-O2}.
70899148 12493
39bc1876
NS
12494@item -mparallel-mpy
12495@itemx -mno-parallel-mpy
12496@opindex mparallel-mpy
12497@opindex mno-parallel-mpy
12498Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12499provided @option{-mparallel-insns} is also specified. These instructions have
12500tight register constraints which can pessimize the code generation
12501of large functions.
70899148 12502
39bc1876 12503@end table
70899148 12504
39bc1876
NS
12505@node V850 Options
12506@subsection V850 Options
12507@cindex V850 Options
70899148 12508
39bc1876 12509These @samp{-m} options are defined for V850 implementations:
70899148 12510
39bc1876
NS
12511@table @gcctabopt
12512@item -mlong-calls
12513@itemx -mno-long-calls
12514@opindex mlong-calls
12515@opindex mno-long-calls
12516Treat all calls as being far away (near). If calls are assumed to be
12517far away, the compiler will always load the functions address up into a
12518register, and call indirect through the pointer.
70899148 12519
39bc1876
NS
12520@item -mno-ep
12521@itemx -mep
12522@opindex mno-ep
12523@opindex mep
12524Do not optimize (do optimize) basic blocks that use the same index
12525pointer 4 or more times to copy pointer into the @code{ep} register, and
12526use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
12527option is on by default if you optimize.
70899148 12528
39bc1876
NS
12529@item -mno-prolog-function
12530@itemx -mprolog-function
12531@opindex mno-prolog-function
12532@opindex mprolog-function
12533Do not use (do use) external functions to save and restore registers
12534at the prologue and epilogue of a function. The external functions
12535are slower, but use less code space if more than one function saves
12536the same number of registers. The @option{-mprolog-function} option
12537is on by default if you optimize.
70899148 12538
39bc1876
NS
12539@item -mspace
12540@opindex mspace
12541Try to make the code as small as possible. At present, this just turns
12542on the @option{-mep} and @option{-mprolog-function} options.
70899148 12543
39bc1876
NS
12544@item -mtda=@var{n}
12545@opindex mtda
12546Put static or global variables whose size is @var{n} bytes or less into
12547the tiny data area that register @code{ep} points to. The tiny data
12548area can hold up to 256 bytes in total (128 bytes for byte references).
70899148 12549
39bc1876
NS
12550@item -msda=@var{n}
12551@opindex msda
12552Put static or global variables whose size is @var{n} bytes or less into
12553the small data area that register @code{gp} points to. The small data
12554area can hold up to 64 kilobytes.
70899148 12555
39bc1876
NS
12556@item -mzda=@var{n}
12557@opindex mzda
12558Put static or global variables whose size is @var{n} bytes or less into
12559the first 32 kilobytes of memory.
70899148 12560
39bc1876
NS
12561@item -mv850
12562@opindex mv850
12563Specify that the target processor is the V850.
70899148 12564
39bc1876
NS
12565@item -mbig-switch
12566@opindex mbig-switch
12567Generate code suitable for big switch tables. Use this option only if
12568the assembler/linker complain about out of range branches within a switch
12569table.
70899148 12570
39bc1876
NS
12571@item -mapp-regs
12572@opindex mapp-regs
12573This option will cause r2 and r5 to be used in the code generated by
12574the compiler. This setting is the default.
70899148 12575
39bc1876
NS
12576@item -mno-app-regs
12577@opindex mno-app-regs
12578This option will cause r2 and r5 to be treated as fixed registers.
70899148 12579
39bc1876
NS
12580@item -mv850e1
12581@opindex mv850e1
12582Specify that the target processor is the V850E1. The preprocessor
12583constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12584this option is used.
70899148 12585
39bc1876
NS
12586@item -mv850e
12587@opindex mv850e
8a36672b 12588Specify that the target processor is the V850E@. The preprocessor
39bc1876 12589constant @samp{__v850e__} will be defined if this option is used.
70899148 12590
39bc1876
NS
12591If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12592are defined then a default target processor will be chosen and the
12593relevant @samp{__v850*__} preprocessor constant will be defined.
70899148 12594
39bc1876
NS
12595The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12596defined, regardless of which processor variant is the target.
70899148 12597
39bc1876
NS
12598@item -mdisable-callt
12599@opindex mdisable-callt
12600This option will suppress generation of the CALLT instruction for the
12601v850e and v850e1 flavors of the v850 architecture. The default is
12602@option{-mno-disable-callt} which allows the CALLT instruction to be used.
70899148 12603
39bc1876 12604@end table
70899148 12605
39bc1876
NS
12606@node VAX Options
12607@subsection VAX Options
12608@cindex VAX options
70899148 12609
39bc1876 12610These @samp{-m} options are defined for the VAX:
70899148 12611
39bc1876
NS
12612@table @gcctabopt
12613@item -munix
12614@opindex munix
12615Do not output certain jump instructions (@code{aobleq} and so on)
12616that the Unix assembler for the VAX cannot handle across long
12617ranges.
70899148 12618
39bc1876
NS
12619@item -mgnu
12620@opindex mgnu
12621Do output those jump instructions, on the assumption that you
12622will assemble with the GNU assembler.
70899148 12623
39bc1876
NS
12624@item -mg
12625@opindex mg
12626Output code for g-format floating point numbers instead of d-format.
12627@end table
70899148 12628
39bc1876
NS
12629@node x86-64 Options
12630@subsection x86-64 Options
12631@cindex x86-64 options
70899148 12632
39bc1876 12633These are listed under @xref{i386 and x86-64 Options}.
70899148 12634
39bc1876
NS
12635@node Xstormy16 Options
12636@subsection Xstormy16 Options
12637@cindex Xstormy16 Options
70899148 12638
39bc1876 12639These options are defined for Xstormy16:
70899148 12640
39bc1876
NS
12641@table @gcctabopt
12642@item -msim
12643@opindex msim
12644Choose startup files and linker script suitable for the simulator.
70899148
BS
12645@end table
12646
03984308
BW
12647@node Xtensa Options
12648@subsection Xtensa Options
12649@cindex Xtensa Options
12650
6cedbe44 12651These options are supported for Xtensa targets:
03984308
BW
12652
12653@table @gcctabopt
f42f5a1b
BW
12654@item -mconst16
12655@itemx -mno-const16
12656@opindex mconst16
12657@opindex mno-const16
6c2e8d1c
BW
12658Enable or disable use of @code{CONST16} instructions for loading
12659constant values. The @code{CONST16} instruction is currently not a
12660standard option from Tensilica. When enabled, @code{CONST16}
12661instructions are always used in place of the standard @code{L32R}
12662instructions. The use of @code{CONST16} is enabled by default only if
12663the @code{L32R} instruction is not available.
12664
03984308
BW
12665@item -mfused-madd
12666@itemx -mno-fused-madd
12667@opindex mfused-madd
12668@opindex mno-fused-madd
12669Enable or disable use of fused multiply/add and multiply/subtract
12670instructions in the floating-point option. This has no effect if the
12671floating-point option is not also enabled. Disabling fused multiply/add
12672and multiply/subtract instructions forces the compiler to use separate
12673instructions for the multiply and add/subtract operations. This may be
12674desirable in some cases where strict IEEE 754-compliant results are
12675required: the fused multiply add/subtract instructions do not round the
12676intermediate result, thereby producing results with @emph{more} bits of
12677precision than specified by the IEEE standard. Disabling fused multiply
12678add/subtract instructions also ensures that the program output is not
12679sensitive to the compiler's ability to combine multiply and add/subtract
12680operations.
12681
03984308
BW
12682@item -mtext-section-literals
12683@itemx -mno-text-section-literals
12684@opindex mtext-section-literals
12685@opindex mno-text-section-literals
12686Control the treatment of literal pools. The default is
12687@option{-mno-text-section-literals}, which places literals in a separate
12688section in the output file. This allows the literal pool to be placed
12689in a data RAM/ROM, and it also allows the linker to combine literal
12690pools from separate object files to remove redundant literals and
12691improve code size. With @option{-mtext-section-literals}, the literals
12692are interspersed in the text section in order to keep them as close as
12693possible to their references. This may be necessary for large assembly
12694files.
12695
12696@item -mtarget-align
12697@itemx -mno-target-align
12698@opindex mtarget-align
12699@opindex mno-target-align
12700When this option is enabled, GCC instructs the assembler to
12701automatically align instructions to reduce branch penalties at the
12702expense of some code density. The assembler attempts to widen density
12703instructions to align branch targets and the instructions following call
12704instructions. If there are not enough preceding safe density
12705instructions to align a target, no widening will be performed. The
12706default is @option{-mtarget-align}. These options do not affect the
12707treatment of auto-aligned instructions like @code{LOOP}, which the
12708assembler will always align, either by widening density instructions or
12709by inserting no-op instructions.
12710
12711@item -mlongcalls
12712@itemx -mno-longcalls
12713@opindex mlongcalls
12714@opindex mno-longcalls
12715When this option is enabled, GCC instructs the assembler to translate
12716direct calls to indirect calls unless it can determine that the target
12717of a direct call is in the range allowed by the call instruction. This
12718translation typically occurs for calls to functions in other source
12719files. Specifically, the assembler translates a direct @code{CALL}
12720instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12721The default is @option{-mno-longcalls}. This option should be used in
12722programs where the call target can potentially be out of range. This
12723option is implemented in the assembler, not the compiler, so the
12724assembly code generated by GCC will still show direct call
12725instructions---look at the disassembled object code to see the actual
12726instructions. Note that the assembler will use an indirect call for
12727every cross-file call, not just those that really will be out of range.
12728@end table
12729
39bc1876
NS
12730@node zSeries Options
12731@subsection zSeries Options
12732@cindex zSeries options
12733
12734These are listed under @xref{S/390 and zSeries Options}.
12735
74291a4b
MM
12736@node Code Gen Options
12737@section Options for Code Generation Conventions
12738@cindex code generation conventions
12739@cindex options, code generation
12740@cindex run-time options
12741
12742These machine-independent options control the interface conventions
12743used in code generation.
12744
12745Most of them have both positive and negative forms; the negative form
630d3d5a 12746of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
74291a4b
MM
12747one of the forms is listed---the one which is not the default. You
12748can figure out the other form by either removing @samp{no-} or adding
12749it.
12750
2642624b 12751@table @gcctabopt
d4463dfc
JQ
12752@item -fbounds-check
12753@opindex fbounds-check
12754For front-ends that support it, generate additional code to check that
12755indices used to access arrays are within the declared range. This is
12756currently only supported by the Java and Fortran 77 front-ends, where
12757this option defaults to true and false respectively.
12758
12759@item -ftrapv
12760@opindex ftrapv
12761This option generates traps for signed overflow on addition, subtraction,
12762multiplication operations.
12763
4fa26a60
RS
12764@item -fwrapv
12765@opindex fwrapv
12766This option instructs the compiler to assume that signed arithmetic
12767overflow of addition, subtraction and multiplication wraps around
c0cbdbd9 12768using twos-complement representation. This flag enables some optimizations
aa58883c 12769and disables others. This option is enabled by default for the Java
4fa26a60
RS
12770front-end, as required by the Java language specification.
12771
956d6950 12772@item -fexceptions
cd3bb277 12773@opindex fexceptions
767094dd 12774Enable exception handling. Generates extra code needed to propagate
f0523f02 12775exceptions. For some targets, this implies GCC will generate frame
c5c76735
JL
12776unwind information for all functions, which can produce significant data
12777size overhead, although it does not affect execution. If you do not
f0523f02 12778specify this option, GCC will enable it by default for languages like
90ecce3e 12779C++ which normally require exception handling, and disable it for
c5c76735
JL
12780languages like C that do not normally require it. However, you may need
12781to enable this option when compiling C code that needs to interoperate
12782properly with exception handlers written in C++. You may also wish to
12783disable this option if you are compiling older C++ programs that don't
12784use exception handling.
956d6950 12785
6cfc0341
RH
12786@item -fnon-call-exceptions
12787@opindex fnon-call-exceptions
12788Generate code that allows trapping instructions to throw exceptions.
12789Note that this requires platform-specific runtime support that does
12790not exist everywhere. Moreover, it only allows @emph{trapping}
e979f9e8 12791instructions to throw exceptions, i.e.@: memory references or floating
6cfc0341
RH
12792point instructions. It does not allow exceptions to be thrown from
12793arbitrary signal handlers such as @code{SIGALRM}.
12794
14a774a9 12795@item -funwind-tables
cd3bb277 12796@opindex funwind-tables
bedc7537 12797Similar to @option{-fexceptions}, except that it will just generate any needed
14a774a9
RK
12798static data, but will not affect the generated code in any other way.
12799You will normally not enable this option; instead, a language processor
12800that needs this handling would enable it on your behalf.
12801
b932f770 12802@item -fasynchronous-unwind-tables
2a9dc917 12803@opindex fasynchronous-unwind-tables
b932f770
JH
12804Generate unwind table in dwarf2 format, if supported by target machine. The
12805table is exact at each instruction boundary, so it can be used for stack
12806unwinding from asynchronous events (such as debugger or garbage collector).
12807
74291a4b 12808@item -fpcc-struct-return
cd3bb277 12809@opindex fpcc-struct-return
74291a4b
MM
12810Return ``short'' @code{struct} and @code{union} values in memory like
12811longer ones, rather than in registers. This convention is less
12812efficient, but it has the advantage of allowing intercallability between
a9c60612
JJ
12813GCC-compiled files and files compiled with other compilers, particularly
12814the Portable C Compiler (pcc).
74291a4b
MM
12815
12816The precise convention for returning structures in memory depends
12817on the target configuration macros.
12818
12819Short structures and unions are those whose size and alignment match
12820that of some integer type.
12821
a9c60612
JJ
12822@strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12823switch is not binary compatible with code compiled with the
12824@option{-freg-struct-return} switch.
12825Use it to conform to a non-default application binary interface.
12826
74291a4b 12827@item -freg-struct-return
cd3bb277 12828@opindex freg-struct-return
9c34dbbf
ZW
12829Return @code{struct} and @code{union} values in registers when possible.
12830This is more efficient for small structures than
12831@option{-fpcc-struct-return}.
74291a4b 12832
9c34dbbf 12833If you specify neither @option{-fpcc-struct-return} nor
630d3d5a 12834@option{-freg-struct-return}, GCC defaults to whichever convention is
0c2d1a2a 12835standard for the target. If there is no standard convention, GCC
9c34dbbf
ZW
12836defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12837the principal compiler. In those cases, we can choose the standard, and
12838we chose the more efficient register return alternative.
74291a4b 12839
a9c60612
JJ
12840@strong{Warning:} code compiled with the @option{-freg-struct-return}
12841switch is not binary compatible with code compiled with the
12842@option{-fpcc-struct-return} switch.
12843Use it to conform to a non-default application binary interface.
12844
74291a4b 12845@item -fshort-enums
cd3bb277 12846@opindex fshort-enums
74291a4b
MM
12847Allocate to an @code{enum} type only as many bytes as it needs for the
12848declared range of possible values. Specifically, the @code{enum} type
12849will be equivalent to the smallest integer type which has enough room.
12850
a9c60612
JJ
12851@strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12852code that is not binary compatible with code generated without that switch.
12853Use it to conform to a non-default application binary interface.
12854
74291a4b 12855@item -fshort-double
cd3bb277 12856@opindex fshort-double
74291a4b
MM
12857Use the same size for @code{double} as for @code{float}.
12858
a9c60612
JJ
12859@strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12860code that is not binary compatible with code generated without that switch.
12861Use it to conform to a non-default application binary interface.
12862
12863@item -fshort-wchar
12864@opindex fshort-wchar
12865Override the underlying type for @samp{wchar_t} to be @samp{short
12866unsigned int} instead of the default for the target. This option is
12867useful for building programs to run under WINE@.
12868
12869@strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12870code that is not binary compatible with code generated without that switch.
12871Use it to conform to a non-default application binary interface.
12872
74291a4b 12873@item -fshared-data
cd3bb277 12874@opindex fshared-data
74291a4b
MM
12875Requests that the data and non-@code{const} variables of this
12876compilation be shared data rather than private data. The distinction
12877makes sense only on certain operating systems, where shared data is
12878shared between processes running the same program, while private data
12879exists in one copy per process.
12880
12881@item -fno-common
cd3bb277 12882@opindex fno-common
90ecce3e 12883In C, allocate even uninitialized global variables in the data section of the
74291a4b
MM
12884object file, rather than generating them as common blocks. This has the
12885effect that if the same variable is declared (without @code{extern}) in
12886two different compilations, you will get an error when you link them.
12887The only reason this might be useful is if you wish to verify that the
12888program will work on other systems which always work this way.
12889
12890@item -fno-ident
cd3bb277 12891@opindex fno-ident
74291a4b
MM
12892Ignore the @samp{#ident} directive.
12893
74291a4b 12894@item -finhibit-size-directive
cd3bb277 12895@opindex finhibit-size-directive
74291a4b
MM
12896Don't output a @code{.size} assembler directive, or anything else that
12897would cause trouble if the function is split in the middle, and the
12898two halves are placed at locations far apart in memory. This option is
12899used when compiling @file{crtstuff.c}; you should not need to use it
12900for anything else.
12901
12902@item -fverbose-asm
cd3bb277 12903@opindex fverbose-asm
74291a4b
MM
12904Put extra commentary information in the generated assembly code to
12905make it more readable. This option is generally only of use to those
12906who actually need to read the generated assembly code (perhaps while
12907debugging the compiler itself).
12908
630d3d5a 12909@option{-fno-verbose-asm}, the default, causes the
74291a4b
MM
12910extra information to be omitted and is useful when comparing two assembler
12911files.
12912
74291a4b 12913@item -fpic
cd3bb277 12914@opindex fpic
74291a4b
MM
12915@cindex global offset table
12916@cindex PIC
12917Generate position-independent code (PIC) suitable for use in a shared
12918library, if supported for the target machine. Such code accesses all
161d7b59 12919constant addresses through a global offset table (GOT)@. The dynamic
861bb6c1 12920loader resolves the GOT entries when the program starts (the dynamic
0c2d1a2a 12921loader is not part of GCC; it is part of the operating system). If
861bb6c1
JL
12922the GOT size for the linked executable exceeds a machine-specific
12923maximum size, you get an error message from the linker indicating that
630d3d5a 12924@option{-fpic} does not work; in that case, recompile with @option{-fPIC}
b6e69d94 12925instead. (These maximums are 8k on the SPARC and 32k
861bb6c1 12926on the m68k and RS/6000. The 386 has no such limit.)
74291a4b
MM
12927
12928Position-independent code requires special support, and therefore works
0c2d1a2a 12929only on certain machines. For the 386, GCC supports PIC for System V
74291a4b
MM
12930but not for the Sun 386i. Code generated for the IBM RS/6000 is always
12931position-independent.
12932
3d119f8f
KG
12933When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12934are defined to 1.
12935
74291a4b 12936@item -fPIC
cd3bb277 12937@opindex fPIC
74291a4b
MM
12938If supported for the target machine, emit position-independent code,
12939suitable for dynamic linking and avoiding any limit on the size of the
068d4f38
BE
12940global offset table. This option makes a difference on the m68k,
12941PowerPC and SPARC@.
74291a4b
MM
12942
12943Position-independent code requires special support, and therefore works
12944only on certain machines.
12945
3d119f8f
KG
12946When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12947are defined to 2.
12948
24a4dd31
JJ
12949@item -fpie
12950@itemx -fPIE
12951@opindex fpie
12952@opindex fPIE
12953These options are similar to @option{-fpic} and @option{-fPIC}, but
12954generated position independent code can be only linked into executables.
12955Usually these options are used when @option{-pie} GCC option will be
12956used during linking.
12957
82c0180d
JM
12958@item -fno-jump-tables
12959@opindex fno-jump-tables
12960Do not use jump tables for switch statements even where it would be
12961more efficient than other code generation strategies. This option is
12962of use in conjunction with @option{-fpic} or @option{-fPIC} for
12963building code which forms part of a dynamic linker and cannot
12964reference the address of a jump table. On some targets, jump tables
12965do not require a GOT and this option is not needed.
12966
74291a4b 12967@item -ffixed-@var{reg}
cd3bb277 12968@opindex ffixed
74291a4b
MM
12969Treat the register named @var{reg} as a fixed register; generated code
12970should never refer to it (except perhaps as a stack pointer, frame
12971pointer or in some other fixed role).
12972
12973@var{reg} must be the name of a register. The register names accepted
12974are machine-specific and are defined in the @code{REGISTER_NAMES}
12975macro in the machine description macro file.
12976
12977This flag does not have a negative form, because it specifies a
12978three-way choice.
12979
12980@item -fcall-used-@var{reg}
cd3bb277 12981@opindex fcall-used
956d6950 12982Treat the register named @var{reg} as an allocable register that is
74291a4b
MM
12983clobbered by function calls. It may be allocated for temporaries or
12984variables that do not live across a call. Functions compiled this way
12985will not save and restore the register @var{reg}.
12986
cb2fdc84
GRK
12987It is an error to used this flag with the frame pointer or stack pointer.
12988Use of this flag for other registers that have fixed pervasive roles in
12989the machine's execution model will produce disastrous results.
74291a4b
MM
12990
12991This flag does not have a negative form, because it specifies a
12992three-way choice.
12993
12994@item -fcall-saved-@var{reg}
cd3bb277 12995@opindex fcall-saved
956d6950 12996Treat the register named @var{reg} as an allocable register saved by
74291a4b
MM
12997functions. It may be allocated even for temporaries or variables that
12998live across a call. Functions compiled this way will save and restore
12999the register @var{reg} if they use it.
13000
cb2fdc84
GRK
13001It is an error to used this flag with the frame pointer or stack pointer.
13002Use of this flag for other registers that have fixed pervasive roles in
13003the machine's execution model will produce disastrous results.
74291a4b
MM
13004
13005A different sort of disaster will result from the use of this flag for
13006a register in which function values may be returned.
13007
13008This flag does not have a negative form, because it specifies a
13009three-way choice.
13010
467cecf3 13011@item -fpack-struct[=@var{n}]
cd3bb277 13012@opindex fpack-struct
467cecf3 13013Without a value specified, pack all structure members together without
8a36672b 13014holes. When a value is specified (which must be a small power of two), pack
467cecf3
JB
13015structure members according to this value, representing the maximum
13016alignment (that is, objects with default alignment requirements larger than
13017this will be output potentially unaligned at the next fitting location.
a9c60612
JJ
13018
13019@strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13020code that is not binary compatible with code generated without that switch.
3364c33b 13021Additionally, it makes the code suboptimal.
a9c60612 13022Use it to conform to a non-default application binary interface.
74291a4b 13023
07417085 13024@item -finstrument-functions
cd3bb277 13025@opindex finstrument-functions
07417085
KR
13026Generate instrumentation calls for entry and exit to functions. Just
13027after function entry and just before function exit, the following
13028profiling functions will be called with the address of the current
13029function and its call site. (On some platforms,
13030@code{__builtin_return_address} does not work beyond the current
13031function, so the call site information may not be available to the
13032profiling functions otherwise.)
13033
3ab51846 13034@smallexample
310668e8
JM
13035void __cyg_profile_func_enter (void *this_fn,
13036 void *call_site);
13037void __cyg_profile_func_exit (void *this_fn,
13038 void *call_site);
3ab51846 13039@end smallexample
07417085
KR
13040
13041The first argument is the address of the start of the current function,
13042which may be looked up exactly in the symbol table.
13043
13044This instrumentation is also done for functions expanded inline in other
13045functions. The profiling calls will indicate where, conceptually, the
13046inline function is entered and exited. This means that addressable
13047versions of such functions must be available. If all your uses of a
13048function are expanded inline, this may mean an additional expansion of
13049code size. If you use @samp{extern inline} in your C code, an
13050addressable version of such functions must be provided. (This is
13051normally the case anyways, but if you get lucky and the optimizer always
13052expands the functions inline, you might have gotten away without
13053providing static copies.)
13054
13055A function may be given the attribute @code{no_instrument_function}, in
13056which case this instrumentation will not be done. This can be used, for
13057example, for the profiling functions listed above, high-priority
13058interrupt routines, and any functions from which the profiling functions
13059cannot safely be called (perhaps signal handlers, if the profiling
13060routines generate output or allocate memory).
13061
861bb6c1 13062@item -fstack-check
cd3bb277 13063@opindex fstack-check
861bb6c1
JL
13064Generate code to verify that you do not go beyond the boundary of the
13065stack. You should specify this flag if you are running in an
13066environment with multiple threads, but only rarely need to specify it in
13067a single-threaded environment since stack overflow is automatically
13068detected on nearly all systems if there is only one stack.
13069
a157febd
GK
13070Note that this switch does not actually cause checking to be done; the
13071operating system must do that. The switch causes generation of code
13072to ensure that the operating system sees the stack being extended.
13073
13074@item -fstack-limit-register=@var{reg}
13075@itemx -fstack-limit-symbol=@var{sym}
13076@itemx -fno-stack-limit
cd3bb277
JM
13077@opindex fstack-limit-register
13078@opindex fstack-limit-symbol
13079@opindex fno-stack-limit
a157febd
GK
13080Generate code to ensure that the stack does not grow beyond a certain value,
13081either the value of a register or the address of a symbol. If the stack
13082would grow beyond the value, a signal is raised. For most targets,
13083the signal is raised before the stack overruns the boundary, so
13084it is possible to catch the signal without taking special precautions.
13085
9c34dbbf
ZW
13086For instance, if the stack starts at absolute address @samp{0x80000000}
13087and grows downwards, you can use the flags
13088@option{-fstack-limit-symbol=__stack_limit} and
13089@option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13090of 128KB@. Note that this may only work with the GNU linker.
a157febd 13091
e5eb27e5
JL
13092@cindex aliasing of parameters
13093@cindex parameters, aliased
13094@item -fargument-alias
04afd9d6
JL
13095@itemx -fargument-noalias
13096@itemx -fargument-noalias-global
cd3bb277
JM
13097@opindex fargument-alias
13098@opindex fargument-noalias
13099@opindex fargument-noalias-global
e5eb27e5
JL
13100Specify the possible relationships among parameters and between
13101parameters and global data.
13102
630d3d5a 13103@option{-fargument-alias} specifies that arguments (parameters) may
9c34dbbf 13104alias each other and may alias global storage.@*
630d3d5a 13105@option{-fargument-noalias} specifies that arguments do not alias
9c34dbbf 13106each other, but may alias global storage.@*
630d3d5a 13107@option{-fargument-noalias-global} specifies that arguments do not
e5eb27e5
JL
13108alias each other and do not alias global storage.
13109
13110Each language will automatically use whatever option is required by
13111the language standard. You should not need to use these options yourself.
19283265
RH
13112
13113@item -fleading-underscore
cd3bb277 13114@opindex fleading-underscore
695ac33f 13115This option and its counterpart, @option{-fno-leading-underscore}, forcibly
19283265
RH
13116change the way C symbols are represented in the object file. One use
13117is to help link with legacy assembly code.
13118
a9c60612
JJ
13119@strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13120generate code that is not binary compatible with code generated without that
13121switch. Use it to conform to a non-default application binary interface.
13122Not all targets provide complete support for this switch.
3d78f2e9
RH
13123
13124@item -ftls-model=@var{model}
13125Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13126The @var{model} argument should be one of @code{global-dynamic},
13127@code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13128
13129The default without @option{-fpic} is @code{initial-exec}; with
13130@option{-fpic} the default is @code{global-dynamic}.
d7afec4b
ND
13131
13132@item -fvisibility=@var{default|internal|hidden|protected}
13133@opindex fvisibility
78466c0e 13134Set the default ELF image symbol visibility to the specified option---all
27ef2cdd 13135symbols will be marked with this unless overridden within the code.
d7afec4b 13136Using this feature can very substantially improve linking and
27ef2cdd 13137load times of shared object libraries, produce more optimized
d7afec4b
ND
13138code, provide near-perfect API export and prevent symbol clashes.
13139It is @strong{strongly} recommended that you use this in any shared objects
13140you distribute.
f0eb93a8 13141
d7afec4b
ND
13142Despite the nomenclature, @code{default} always means public ie;
13143available to be linked against from outside the shared object.
13144@code{protected} and @code{internal} are pretty useless in real-world
13145usage so the only other commonly used option will be @code{hidden}.
78466c0e
JM
13146The default if @option{-fvisibility} isn't specified is
13147@code{default}, i.e., make every
13148symbol public---this causes the same behavior as previous versions of
8a36672b 13149GCC@.
f0eb93a8 13150
d7afec4b
ND
13151A good explanation of the benefits offered by ensuring ELF
13152symbols have the correct visibility is given by ``How To Write
13153Shared Libraries'' by Ulrich Drepper (which can be found at
78466c0e 13154@w{@uref{http://people.redhat.com/~drepper/}})---however a superior
d7afec4b
ND
13155solution made possible by this option to marking things hidden when
13156the default is public is to make the default hidden and mark things
8a36672b 13157public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
d7afec4b
ND
13158and @code{__attribute__ ((visibility("default")))} instead of
13159@code{__declspec(dllexport)} you get almost identical semantics with
8a36672b 13160identical syntax. This is a great boon to those working with
d7afec4b
ND
13161cross-platform projects.
13162
13163For those adding visibility support to existing code, you may find
8a36672b 13164@samp{#pragma GCC visibility} of use. This works by you enclosing
d7afec4b
ND
13165the declarations you wish to set visibility for with (for example)
13166@samp{#pragma GCC visibility push(hidden)} and
be1b1c9b
L
13167@samp{#pragma GCC visibility pop}.
13168Bear in mind that symbol visibility should be viewed @strong{as
d7afec4b
ND
13169part of the API interface contract} and thus all new code should
13170always specify visibility when it is not the default ie; declarations
13171only for use within the local DSO should @strong{always} be marked explicitly
78466c0e 13172as hidden as so to avoid PLT indirection overheads---making this
d7afec4b
ND
13173abundantly clear also aids readability and self-documentation of the code.
13174Note that due to ISO C++ specification requirements, operator new and
13175operator delete must always be of default visibility.
13176
ce84fa41
DP
13177An overview of these techniques, their benefits and how to use them
13178is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13179
74291a4b
MM
13180@end table
13181
ee457005
JM
13182@c man end
13183
74291a4b 13184@node Environment Variables
0c2d1a2a 13185@section Environment Variables Affecting GCC
74291a4b
MM
13186@cindex environment variables
13187
ee457005 13188@c man begin ENVIRONMENT
0c2d1a2a
JB
13189This section describes several environment variables that affect how GCC
13190operates. Some of them work by specifying directories or prefixes to use
767094dd 13191when searching for various kinds of files. Some are used to specify other
46103ab4 13192aspects of the compilation environment.
74291a4b 13193
74291a4b 13194Note that you can also specify places to search using options such as
630d3d5a 13195@option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
74291a4b 13196take precedence over places specified using environment variables, which
161d7b59 13197in turn take precedence over those specified by the configuration of GCC@.
b11cc610
JM
13198@xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13199GNU Compiler Collection (GCC) Internals}.
74291a4b 13200
bedc7537 13201@table @env
ab87f8c8
JL
13202@item LANG
13203@itemx LC_CTYPE
13204@c @itemx LC_COLLATE
13205@itemx LC_MESSAGES
13206@c @itemx LC_MONETARY
13207@c @itemx LC_NUMERIC
13208@c @itemx LC_TIME
13209@itemx LC_ALL
13210@findex LANG
13211@findex LC_CTYPE
13212@c @findex LC_COLLATE
13213@findex LC_MESSAGES
13214@c @findex LC_MONETARY
13215@c @findex LC_NUMERIC
13216@c @findex LC_TIME
13217@findex LC_ALL
13218@cindex locale
0c2d1a2a
JB
13219These environment variables control the way that GCC uses
13220localization information that allow GCC to work with different
13221national conventions. GCC inspects the locale categories
bedc7537 13222@env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
ab87f8c8 13223so. These locale categories can be set to any value supported by your
0e6d31fb
JM
13224installation. A typical value is @samp{en_GB.UTF-8} for English in the United
13225Kingdom encoded in UTF-8.
ab87f8c8 13226
bedc7537 13227The @env{LC_CTYPE} environment variable specifies character
0c2d1a2a 13228classification. GCC uses it to determine the character boundaries in
ab87f8c8
JL
13229a string; this is needed for some multibyte encodings that contain quote
13230and escape characters that would otherwise be interpreted as a string
13231end or escape.
13232
bedc7537 13233The @env{LC_MESSAGES} environment variable specifies the language to
ab87f8c8
JL
13234use in diagnostic messages.
13235
bedc7537
NC
13236If the @env{LC_ALL} environment variable is set, it overrides the value
13237of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13238and @env{LC_MESSAGES} default to the value of the @env{LANG}
0c2d1a2a 13239environment variable. If none of these variables are set, GCC
ab87f8c8
JL
13240defaults to traditional C English behavior.
13241
74291a4b
MM
13242@item TMPDIR
13243@findex TMPDIR
bedc7537 13244If @env{TMPDIR} is set, it specifies the directory to use for temporary
0c2d1a2a 13245files. GCC uses temporary files to hold the output of one stage of
74291a4b
MM
13246compilation which is to be used as input to the next stage: for example,
13247the output of the preprocessor, which is the input to the compiler
13248proper.
13249
13250@item GCC_EXEC_PREFIX
13251@findex GCC_EXEC_PREFIX
bedc7537 13252If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
74291a4b
MM
13253names of the subprograms executed by the compiler. No slash is added
13254when this prefix is combined with the name of a subprogram, but you can
13255specify a prefix that ends with a slash if you wish.
13256
f0523f02 13257If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
0deb20df
TT
13258an appropriate prefix to use based on the pathname it was invoked with.
13259
0c2d1a2a 13260If GCC cannot find the subprogram using the specified prefix, it
74291a4b
MM
13261tries looking in the usual places for the subprogram.
13262
bedc7537 13263The default value of @env{GCC_EXEC_PREFIX} is
8e5f33ff 13264@file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
74291a4b
MM
13265of @code{prefix} when you ran the @file{configure} script.
13266
630d3d5a 13267Other prefixes specified with @option{-B} take precedence over this prefix.
74291a4b
MM
13268
13269This prefix is also used for finding files such as @file{crt0.o} that are
13270used for linking.
13271
13272In addition, the prefix is used in an unusual way in finding the
13273directories to search for header files. For each of the standard
8e5f33ff 13274directories whose name normally begins with @samp{/usr/local/lib/gcc}
bedc7537 13275(more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
74291a4b 13276replacing that beginning with the specified prefix to produce an
630d3d5a 13277alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
74291a4b
MM
13278@file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13279These alternate directories are searched first; the standard directories
13280come next.
13281
13282@item COMPILER_PATH
13283@findex COMPILER_PATH
bedc7537
NC
13284The value of @env{COMPILER_PATH} is a colon-separated list of
13285directories, much like @env{PATH}. GCC tries the directories thus
74291a4b 13286specified when searching for subprograms, if it can't find the
bedc7537 13287subprograms using @env{GCC_EXEC_PREFIX}.
74291a4b
MM
13288
13289@item LIBRARY_PATH
13290@findex LIBRARY_PATH
bedc7537
NC
13291The value of @env{LIBRARY_PATH} is a colon-separated list of
13292directories, much like @env{PATH}. When configured as a native compiler,
0c2d1a2a 13293GCC tries the directories thus specified when searching for special
bedc7537 13294linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
0c2d1a2a 13295using GCC also uses these directories when searching for ordinary
630d3d5a
JM
13296libraries for the @option{-l} option (but directories specified with
13297@option{-L} come first).
74291a4b 13298
56f48ce9
DB
13299@item LANG
13300@findex LANG
13301@cindex locale definition
767094dd 13302This variable is used to pass locale information to the compiler. One way in
56f48ce9
DB
13303which this information is used is to determine the character set to be used
13304when character literals, string literals and comments are parsed in C and C++.
13305When the compiler is configured to allow multibyte characters,
bedc7537 13306the following values for @env{LANG} are recognized:
56f48ce9 13307
2642624b 13308@table @samp
56f48ce9
DB
13309@item C-JIS
13310Recognize JIS characters.
13311@item C-SJIS
13312Recognize SJIS characters.
13313@item C-EUCJP
13314Recognize EUCJP characters.
13315@end table
13316
bedc7537 13317If @env{LANG} is not defined, or if it has some other value, then the
56f48ce9
DB
13318compiler will use mblen and mbtowc as defined by the default locale to
13319recognize and translate multibyte characters.
74291a4b
MM
13320@end table
13321
40adaa27
NB
13322@noindent
13323Some additional environments variables affect the behavior of the
13324preprocessor.
13325
13326@include cppenv.texi
13327
9d86bffc
JM
13328@c man end
13329
17211ab5
GK
13330@node Precompiled Headers
13331@section Using Precompiled Headers
13332@cindex precompiled headers
13333@cindex speed of compilation
13334
13335Often large projects have many header files that are included in every
13336source file. The time the compiler takes to process these header files
13337over and over again can account for nearly all of the time required to
13338build the project. To make builds faster, GCC allows users to
13339`precompile' a header file; then, if builds can use the precompiled
13340header file they will be much faster.
13341
13342To create a precompiled header file, simply compile it as you would any
13343other file, if necessary using the @option{-x} option to make the driver
13344treat it as a C or C++ header file. You will probably want to use a
13345tool like @command{make} to keep the precompiled header up-to-date when
13346the headers it contains change.
13347
13348A precompiled header file will be searched for when @code{#include} is
13349seen in the compilation. As it searches for the included file
24726b96 13350(@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
17211ab5
GK
13351compiler looks for a precompiled header in each directory just before it
13352looks for the include file in that directory. The name searched for is
d8fad4ea 13353the name specified in the @code{#include} with @samp{.gch} appended. If
17211ab5
GK
13354the precompiled header file can't be used, it is ignored.
13355
13356For instance, if you have @code{#include "all.h"}, and you have
d8fad4ea 13357@file{all.h.gch} in the same directory as @file{all.h}, then the
17211ab5
GK
13358precompiled header file will be used if possible, and the original
13359header will be used otherwise.
13360
13361Alternatively, you might decide to put the precompiled header file in a
13362directory and use @option{-I} to ensure that directory is searched
13363before (or instead of) the directory containing the original header.
13364Then, if you want to check that the precompiled header file is always
13365used, you can put a file of the same name as the original header in this
13366directory containing an @code{#error} command.
13367
13368This also works with @option{-include}. So yet another way to use
13369precompiled headers, good for projects not designed with precompiled
13370header files in mind, is to simply take most of the header files used by
13371a project, include them from another header file, precompile that header
13372file, and @option{-include} the precompiled header. If the header files
13373have guards against multiple inclusion, they will be skipped because
13374they've already been included (in the precompiled header).
13375
13376If you need to precompile the same header file for different
13377languages, targets, or compiler options, you can instead make a
d8fad4ea 13378@emph{directory} named like @file{all.h.gch}, and put each precompiled
54e109ed
GK
13379header in the directory, perhaps using @option{-o}. It doesn't matter
13380what you call the files in the directory, every precompiled header in
13381the directory will be considered. The first precompiled header
13382encountered in the directory that is valid for this compilation will
13383be used; they're searched in no particular order.
17211ab5
GK
13384
13385There are many other possibilities, limited only by your imagination,
13386good sense, and the constraints of your build system.
13387
13388A precompiled header file can be used only when these conditions apply:
13389
13390@itemize
13391@item
13392Only one precompiled header can be used in a particular compilation.
54e109ed 13393
17211ab5
GK
13394@item
13395A precompiled header can't be used once the first C token is seen. You
13396can have preprocessor directives before a precompiled header; you can
13397even include a precompiled header from inside another header, so long as
13398there are no C tokens before the @code{#include}.
54e109ed 13399
17211ab5
GK
13400@item
13401The precompiled header file must be produced for the same language as
13402the current compilation. You can't use a C precompiled header for a C++
13403compilation.
54e109ed 13404
17211ab5 13405@item
3fd30b88
GK
13406The precompiled header file must have been produced by the same compiler
13407binary as the current compilation is using.
54e109ed 13408
17211ab5 13409@item
54e109ed
GK
13410Any macros defined before the precompiled header is included must
13411either be defined in the same way as when the precompiled header was
13412generated, or must not affect the precompiled header, which usually
0bdcd332 13413means that they don't appear in the precompiled header at all.
54e109ed
GK
13414
13415The @option{-D} option is one way to define a macro before a
13416precompiled header is included; using a @code{#define} can also do it.
13417There are also some options that define macros implicitly, like
13418@option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13419defined this way.
13420
13421@item If debugging information is output when using the precompiled
13422header, using @option{-g} or similar, the same kind of debugging information
13423must have been output when building the precompiled header. However,
13424a precompiled header built using @option{-g} can be used in a compilation
13425when no debugging information is being output.
13426
13427@item The same @option{-m} options must generally be used when building
13428and using the precompiled header. @xref{Submodel Options},
13429for any cases where this rule is relaxed.
13430
13431@item Each of the following options must be the same when building and using
13432the precompiled header:
13433
13434@gccoptlist{-fexceptions -funit-at-a-time}
13435
17211ab5 13436@item
54e109ed
GK
13437Some other command-line options starting with @option{-f},
13438@option{-p}, or @option{-O} must be defined in the same way as when
13439the precompiled header was generated. At present, it's not clear
13440which options are safe to change and which are not; the safest choice
13441is to use exactly the same options when generating and using the
13442precompiled header. The following are known to be safe:
13443
17ccdd2c 13444@gccoptlist{-fmessage-length= -fpreprocessed
3fd30b88 13445-fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
17ccdd2c 13446-fsched-verbose=<number> -fschedule-insns -fvisibility=
3fd30b88 13447-pedantic-errors}
54e109ed 13448
17211ab5
GK
13449@end itemize
13450
54e109ed
GK
13451For all of these except the last, the compiler will automatically
13452ignore the precompiled header if the conditions aren't met. If you
13453find an option combination that doesn't work and doesn't cause the
13454precompiled header to be ignored, please consider filing a bug report,
13455see @ref{Bugs}.
17211ab5 13456
c0d578e6 13457If you do use differing options when generating and using the
83c99486
KH
13458precompiled header, the actual behavior will be a mixture of the
13459behavior for the options. For instance, if you use @option{-g} to
c0d578e6
GK
13460generate the precompiled header but not when using it, you may or may
13461not get debugging information for routines in the precompiled header.
13462
74291a4b
MM
13463@node Running Protoize
13464@section Running Protoize
13465
161d7b59 13466The program @code{protoize} is an optional part of GCC@. You can use
c1030c7c 13467it to add prototypes to a program, thus converting the program to ISO
74291a4b
MM
13468C in one respect. The companion program @code{unprotoize} does the
13469reverse: it removes argument types from any prototypes that are found.
13470
13471When you run these programs, you must specify a set of source files as
13472command line arguments. The conversion programs start out by compiling
13473these files to see what functions they define. The information gathered
13474about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13475
13476After scanning comes actual conversion. The specified files are all
13477eligible to be converted; any files they include (whether sources or
13478just headers) are eligible as well.
13479
13480But not all the eligible files are converted. By default,
13481@code{protoize} and @code{unprotoize} convert only source and header
13482files in the current directory. You can specify additional directories
630d3d5a 13483whose files should be converted with the @option{-d @var{directory}}
74291a4b 13484option. You can also specify particular files to exclude with the
630d3d5a 13485@option{-x @var{file}} option. A file is converted if it is eligible, its
74291a4b
MM
13486directory name matches one of the specified directory names, and its
13487name within the directory has not been excluded.
13488
13489Basic conversion with @code{protoize} consists of rewriting most
13490function definitions and function declarations to specify the types of
13491the arguments. The only ones not rewritten are those for varargs
13492functions.
13493
13494@code{protoize} optionally inserts prototype declarations at the
13495beginning of the source file, to make them available for any calls that
13496precede the function's definition. Or it can insert prototype
13497declarations with block scope in the blocks where undeclared functions
13498are called.
13499
13500Basic conversion with @code{unprotoize} consists of rewriting most
13501function declarations to remove any argument types, and rewriting
c1030c7c 13502function definitions to the old-style pre-ISO form.
74291a4b
MM
13503
13504Both conversion programs print a warning for any function declaration or
13505definition that they can't convert. You can suppress these warnings
630d3d5a 13506with @option{-q}.
74291a4b
MM
13507
13508The output from @code{protoize} or @code{unprotoize} replaces the
13509original source file. The original file is renamed to a name ending
02f52e19 13510with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
a7db8bbb
MK
13511without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
13512for DOS) file already exists, then the source file is simply discarded.
74291a4b 13513
0c2d1a2a 13514@code{protoize} and @code{unprotoize} both depend on GCC itself to
74291a4b 13515scan the program and collect information about the functions it uses.
0c2d1a2a 13516So neither of these programs will work until GCC is installed.
74291a4b
MM
13517
13518Here is a table of the options you can use with @code{protoize} and
13519@code{unprotoize}. Each option works with both programs unless
13520otherwise stated.
13521
13522@table @code
13523@item -B @var{directory}
13524Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13525usual directory (normally @file{/usr/local/lib}). This file contains
13526prototype information about standard system functions. This option
13527applies only to @code{protoize}.
13528
13529@item -c @var{compilation-options}
05739753 13530Use @var{compilation-options} as the options when running @command{gcc} to
630d3d5a 13531produce the @samp{.X} files. The special option @option{-aux-info} is
05739753 13532always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
74291a4b
MM
13533
13534Note that the compilation options must be given as a single argument to
13535@code{protoize} or @code{unprotoize}. If you want to specify several
05739753 13536@command{gcc} options, you must quote the entire set of compilation options
74291a4b
MM
13537to make them a single word in the shell.
13538
05739753 13539There are certain @command{gcc} arguments that you cannot use, because they
630d3d5a
JM
13540would produce the wrong kind of output. These include @option{-g},
13541@option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
74291a4b
MM
13542the @var{compilation-options}, they are ignored.
13543
13544@item -C
a7db8bbb 13545Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
02f52e19 13546systems) instead of @samp{.c}. This is convenient if you are converting
ee77eda5 13547a C program to C++. This option applies only to @code{protoize}.
74291a4b
MM
13548
13549@item -g
13550Add explicit global declarations. This means inserting explicit
13551declarations at the beginning of each source file for each function
13552that is called in the file and was not declared. These declarations
13553precede the first function definition that contains a call to an
13554undeclared function. This option applies only to @code{protoize}.
13555
13556@item -i @var{string}
13557Indent old-style parameter declarations with the string @var{string}.
13558This option applies only to @code{protoize}.
13559
13560@code{unprotoize} converts prototyped function definitions to old-style
13561function definitions, where the arguments are declared between the
13562argument list and the initial @samp{@{}. By default, @code{unprotoize}
13563uses five spaces as the indentation. If you want to indent with just
630d3d5a 13564one space instead, use @option{-i " "}.
74291a4b
MM
13565
13566@item -k
13567Keep the @samp{.X} files. Normally, they are deleted after conversion
13568is finished.
13569
13570@item -l
630d3d5a 13571Add explicit local declarations. @code{protoize} with @option{-l} inserts
74291a4b
MM
13572a prototype declaration for each function in each block which calls the
13573function without any declaration. This option applies only to
13574@code{protoize}.
13575
13576@item -n
13577Make no real changes. This mode just prints information about the conversions
630d3d5a 13578that would have been done without @option{-n}.
74291a4b
MM
13579
13580@item -N
13581Make no @samp{.save} files. The original files are simply deleted.
13582Use this option with caution.
13583
13584@item -p @var{program}
13585Use the program @var{program} as the compiler. Normally, the name
13586@file{gcc} is used.
13587
13588@item -q
13589Work quietly. Most warnings are suppressed.
13590
13591@item -v
05739753 13592Print the version number, just like @option{-v} for @command{gcc}.
74291a4b
MM
13593@end table
13594
13595If you need special compiler options to compile one of your program's
13596source files, then you should generate that file's @samp{.X} file
05739753 13597specially, by running @command{gcc} on that source file with the
630d3d5a 13598appropriate options and the option @option{-aux-info}. Then run
74291a4b
MM
13599@code{protoize} on the entire set of files. @code{protoize} will use
13600the existing @samp{.X} file because it is newer than the source file.
13601For example:
13602
3ab51846 13603@smallexample
b1018de6 13604gcc -Dfoo=bar file1.c -aux-info file1.X
74291a4b 13605protoize *.c
3ab51846 13606@end smallexample
74291a4b
MM
13607
13608@noindent
13609You need to include the special files along with the rest in the
13610@code{protoize} command, even though their @samp{.X} files already
13611exist, because otherwise they won't get converted.
13612
13613@xref{Protoize Caveats}, for more information on how to use
13614@code{protoize} successfully.