OSDN Git Service

* doc/invoke.texi (Optimize Options): Reword introduction a bit.
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
3 @c Free Software Foundation, Inc.
4 @c This is part of the GCC manual.
5 @c For copying conditions, see the file gcc.texi.
6
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
11
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
14 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
15 Free Software Foundation, Inc.
16
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.2 or
19 any later version published by the Free Software Foundation; with the
20 Invariant Sections being ``GNU General Public License'' and ``Funding
21 Free Software'', the Front-Cover texts being (a) (see below), and with
22 the Back-Cover Texts being (b) (see below).  A copy of the license is
23 included in the gfdl(7) man page.
24
25 (a) The FSF's Front-Cover Text is:
26
27      A GNU Manual
28
29 (b) The FSF's Back-Cover Text is:
30
31      You have freedom to copy and modify this GNU Manual, like GNU
32      software.  Copies published by the Free Software Foundation raise
33      funds for GNU development.
34 @c man end
35 @c Set file name and title for the man page.
36 @setfilename gcc
37 @settitle GNU project C and C++ compiler
38 @c man begin SYNOPSIS
39 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
40     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
41     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
42     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
43     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
44     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
45     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
46
47 Only the most useful options are listed here; see below for the
48 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
49 @c man end
50 @c man begin SEEALSO
51 gpl(7), gfdl(7), fsf-funding(7),
52 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
53 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
54 @file{ld}, @file{binutils} and @file{gdb}.
55 @c man end
56 @c man begin BUGS
57 For instructions on reporting bugs, see
58 @w{@value{BUGURL}}.
59 @c man end
60 @c man begin AUTHOR
61 See the Info entry for @command{gcc}, or
62 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
63 for contributors to GCC@.
64 @c man end
65 @end ignore
66
67 @node Invoking GCC
68 @chapter GCC Command Options
69 @cindex GCC command options
70 @cindex command options
71 @cindex options, GCC command
72
73 @c man begin DESCRIPTION
74 When you invoke GCC, it normally does preprocessing, compilation,
75 assembly and linking.  The ``overall options'' allow you to stop this
76 process at an intermediate stage.  For example, the @option{-c} option
77 says not to run the linker.  Then the output consists of object files
78 output by the assembler.
79
80 Other options are passed on to one stage of processing.  Some options
81 control the preprocessor and others the compiler itself.  Yet other
82 options control the assembler and linker; most of these are not
83 documented here, since you rarely need to use any of them.
84
85 @cindex C compilation options
86 Most of the command line options that you can use with GCC are useful
87 for C programs; when an option is only useful with another language
88 (usually C++), the explanation says so explicitly.  If the description
89 for a particular option does not mention a source language, you can use
90 that option with all supported languages.
91
92 @cindex C++ compilation options
93 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
94 options for compiling C++ programs.
95
96 @cindex grouping options
97 @cindex options, grouping
98 The @command{gcc} program accepts options and file names as operands.  Many
99 options have multi-letter names; therefore multiple single-letter options
100 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
101 -v}}.
102
103 @cindex order of options
104 @cindex options, order
105 You can mix options and other arguments.  For the most part, the order
106 you use doesn't matter.  Order does matter when you use several
107 options of the same kind; for example, if you specify @option{-L} more
108 than once, the directories are searched in the order specified.  Also,
109 the placement of the @option{-l} option is significant.
110
111 Many options have long names starting with @samp{-f} or with
112 @samp{-W}---for example,
113 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
114 these have both positive and negative forms; the negative form of
115 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
116 only one of these two forms, whichever one is not the default.
117
118 @c man end
119
120 @xref{Option Index}, for an index to GCC's options.
121
122 @menu
123 * Option Summary::      Brief list of all options, without explanations.
124 * Overall Options::     Controlling the kind of output:
125                         an executable, object files, assembler files,
126                         or preprocessed source.
127 * Invoking G++::        Compiling C++ programs.
128 * C Dialect Options::   Controlling the variant of C language compiled.
129 * C++ Dialect Options:: Variations on C++.
130 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
131                         and Objective-C++.
132 * Language Independent Options:: Controlling how diagnostics should be
133                         formatted.
134 * Warning Options::     How picky should the compiler be?
135 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
136 * Optimize Options::    How much optimization?
137 * Preprocessor Options:: Controlling header files and macro definitions.
138                          Also, getting dependency information for Make.
139 * Assembler Options::   Passing options to the assembler.
140 * Link Options::        Specifying libraries and so on.
141 * Directory Options::   Where to find header files and libraries.
142                         Where to find the compiler executable files.
143 * Spec Files::          How to pass switches to sub-processes.
144 * Target Options::      Running a cross-compiler, or an old version of GCC.
145 * Submodel Options::    Specifying minor hardware or convention variations,
146                         such as 68010 vs 68020.
147 * Code Gen Options::    Specifying conventions for function calls, data layout
148                         and register usage.
149 * Environment Variables:: Env vars that affect GCC.
150 * Precompiled Headers:: Compiling a header once, and using it many times.
151 @end menu
152
153 @c man begin OPTIONS
154
155 @node Option Summary
156 @section Option Summary
157
158 Here is a summary of all the options, grouped by type.  Explanations are
159 in the following sections.
160
161 @table @emph
162 @item Overall Options
163 @xref{Overall Options,,Options Controlling the Kind of Output}.
164 @gccoptlist{-c  -S  -E  -o @var{file}  -combine  -no-canonical-prefixes  @gol
165 -pipe  -pass-exit-codes  @gol
166 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
167 --version -wrapper@@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}}
168
169 @item C Language Options
170 @xref{C Dialect Options,,Options Controlling C Dialect}.
171 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
172 -aux-info @var{filename} @gol
173 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
174 -fhosted  -ffreestanding -fopenmp -fms-extensions @gol
175 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
176 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
177 -fsigned-bitfields  -fsigned-char @gol
178 -funsigned-bitfields  -funsigned-char}
179
180 @item C++ Language Options
181 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
182 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
183 -fconserve-space  -ffriend-injection @gol
184 -fno-elide-constructors @gol
185 -fno-enforce-eh-specs @gol
186 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
187 -fno-implicit-templates @gol
188 -fno-implicit-inline-templates @gol
189 -fno-implement-inlines  -fms-extensions @gol
190 -fno-nonansi-builtins  -fno-operator-names @gol
191 -fno-optional-diags  -fpermissive @gol
192 -fno-pretty-templates @gol
193 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
194 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
195 -fno-default-inline  -fvisibility-inlines-hidden @gol
196 -fvisibility-ms-compat @gol
197 -Wabi  -Wctor-dtor-privacy @gol
198 -Wnon-virtual-dtor  -Wreorder @gol
199 -Weffc++  -Wstrict-null-sentinel @gol
200 -Wno-non-template-friend  -Wold-style-cast @gol
201 -Woverloaded-virtual  -Wno-pmf-conversions @gol
202 -Wsign-promo}
203
204 @item Objective-C and Objective-C++ Language Options
205 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
206 Objective-C and Objective-C++ Dialects}.
207 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
208 -fgnu-runtime  -fnext-runtime @gol
209 -fno-nil-receivers @gol
210 -fobjc-call-cxx-cdtors @gol
211 -fobjc-direct-dispatch @gol
212 -fobjc-exceptions @gol
213 -fobjc-gc @gol
214 -freplace-objc-classes @gol
215 -fzero-link @gol
216 -gen-decls @gol
217 -Wassign-intercept @gol
218 -Wno-protocol  -Wselector @gol
219 -Wstrict-selector-match @gol
220 -Wundeclared-selector}
221
222 @item Language Independent Options
223 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
224 @gccoptlist{-fmessage-length=@var{n}  @gol
225 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
226 -fdiagnostics-show-option}
227
228 @item Warning Options
229 @xref{Warning Options,,Options to Request or Suppress Warnings}.
230 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
231 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
232 -Wno-attributes -Wno-builtin-macro-redefined @gol
233 -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
234 -Wchar-subscripts -Wclobbered  -Wcomment @gol
235 -Wconversion  -Wcoverage-mismatch  -Wno-deprecated  @gol
236 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
237 -Wno-div-by-zero -Wempty-body  -Wenum-compare -Wno-endif-labels @gol
238 -Werror  -Werror=* @gol
239 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
240 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
241 -Wformat-security  -Wformat-y2k @gol
242 -Wframe-larger-than=@var{len} -Wjump-misses-init -Wignored-qualifiers @gol
243 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
244 -Winit-self  -Winline @gol
245 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
246 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
247 -Wlogical-op -Wlong-long @gol
248 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
249 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
250 -Wmissing-noreturn  -Wno-mudflap @gol
251 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
252 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
253 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
254 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
255 -Wredundant-decls @gol
256 -Wreturn-type  -Wsequence-point  -Wshadow @gol
257 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
258 -Wstrict-aliasing -Wstrict-aliasing=n @gol
259 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
260 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
261 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
262 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
263 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
264 -Wunused-label  -Wunused-parameter -Wno-unused-result -Wunused-value  -Wunused-variable @gol
265 -Wvariadic-macros -Wvla @gol
266 -Wvolatile-register-var  -Wwrite-strings}
267
268 @item C and Objective-C-only Warning Options
269 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
270 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
271 -Wold-style-declaration  -Wold-style-definition @gol
272 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
273 -Wdeclaration-after-statement -Wpointer-sign}
274
275 @item Debugging Options
276 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
277 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
278 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
279 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
280 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
281 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
282 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
283 -fdump-statistics @gol
284 -fdump-tree-all @gol
285 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
286 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
288 -fdump-tree-ch @gol
289 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-nrv -fdump-tree-vect @gol
299 -fdump-tree-sink @gol
300 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
301 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
302 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
303 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
304 -ftree-vectorizer-verbose=@var{n} @gol
305 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
306 -fdump-final-insns=@var{file} @gol
307 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
308 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
309 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
310 -fenable-icf-debug @gol
311 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
312 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
313 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
314 -ftest-coverage  -ftime-report -fvar-tracking @gol
315 -fvar-tracking-assigments  -fvar-tracking-assignments-toggle @gol
316 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
317 -ggdb  -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
318 -gvms  -gxcoff  -gxcoff+ @gol
319 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
320 -fdebug-prefix-map=@var{old}=@var{new} @gol
321 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
322 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
323 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
324 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
325 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
326 -print-sysroot -print-sysroot-headers-suffix @gol
327 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
328
329 @item Optimization Options
330 @xref{Optimize Options,,Options that Control Optimization}.
331 @gccoptlist{
332 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
333 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
334 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
335 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
336 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
337 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
338 -fdata-sections -fdce -fdce @gol
339 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
340 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffast-math @gol
341 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
342 -fforward-propagate -ffunction-sections @gol
343 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
344 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
345 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
346 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg -fipa-pta @gol
347 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
348 -fipa-type-escape -fira-algorithm=@var{algorithm} @gol
349 -fira-region=@var{region} -fira-coalesce @gol
350 -fira-loop-pressure -fno-ira-share-save-slots @gol
351 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
352 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
353 -floop-block -floop-interchange -floop-strip-mine -fgraphite-identity @gol
354 -floop-parallelize-all -flto -flto-compression-level -flto-report -fltrans @gol
355 -fltrans-output-list -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
356 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
357 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
358 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
359 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
360 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
361 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
362 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
363 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
364 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
365 -fprofile-generate=@var{path} @gol
366 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
367 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
368 -freorder-blocks-and-partition -freorder-functions @gol
369 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
370 -frounding-math -fsched2-use-superblocks @gol
371 -fsched2-use-traces -fsched-pressure @gol
372 -fsched-spec-load -fsched-spec-load-dangerous @gol
373 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
374 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
375 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
376 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
377 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
378 -fselective-scheduling -fselective-scheduling2 @gol
379 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
380 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
381 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
382 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
383 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
384 -ftree-copyrename -ftree-dce @gol
385 -ftree-dominator-opts -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-im @gol
386 -ftree-phiprop -ftree-loop-distribution @gol
387 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
388 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
389 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
390 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
391 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
392 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
393 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
394 -fwhole-program -fwhopr -fwpa -fuse-linker-plugin @gol
395 --param @var{name}=@var{value}
396 -O  -O0  -O1  -O2  -O3  -Os}
397
398 @item Preprocessor Options
399 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
400 @gccoptlist{-A@var{question}=@var{answer} @gol
401 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
402 -C  -dD  -dI  -dM  -dN @gol
403 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
404 -idirafter @var{dir} @gol
405 -include @var{file}  -imacros @var{file} @gol
406 -iprefix @var{file}  -iwithprefix @var{dir} @gol
407 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
408 -imultilib @var{dir} -isysroot @var{dir} @gol
409 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
410 -P  -fworking-directory  -remap @gol
411 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
412 -Xpreprocessor @var{option}}
413
414 @item Assembler Option
415 @xref{Assembler Options,,Passing Options to the Assembler}.
416 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
417
418 @item Linker Options
419 @xref{Link Options,,Options for Linking}.
420 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
421 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
422 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
423 -shared-libgcc  -symbolic @gol
424 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
425 -u @var{symbol}}
426
427 @item Directory Options
428 @xref{Directory Options,,Options for Directory Search}.
429 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
430 -specs=@var{file}  -I- --sysroot=@var{dir}}
431
432 @item Target Options
433 @c I wrote this xref this way to avoid overfull hbox. -- rms
434 @xref{Target Options}.
435 @gccoptlist{-V @var{version}  -b @var{machine}}
436
437 @item Machine Dependent Options
438 @xref{Submodel Options,,Hardware Models and Configurations}.
439 @c This list is ordered alphanumerically by subsection name.
440 @c Try and put the significant identifier (CPU or system) first,
441 @c so users have a clue at guessing where the ones they want will be.
442
443 @emph{ARC Options}
444 @gccoptlist{-EB  -EL @gol
445 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
446 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
447
448 @emph{ARM Options}
449 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
450 -mabi=@var{name} @gol
451 -mapcs-stack-check  -mno-apcs-stack-check @gol
452 -mapcs-float  -mno-apcs-float @gol
453 -mapcs-reentrant  -mno-apcs-reentrant @gol
454 -msched-prolog  -mno-sched-prolog @gol
455 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
456 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
457 -mfp16-format=@var{name}
458 -mthumb-interwork  -mno-thumb-interwork @gol
459 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
460 -mstructure-size-boundary=@var{n} @gol
461 -mabort-on-noreturn @gol
462 -mlong-calls  -mno-long-calls @gol
463 -msingle-pic-base  -mno-single-pic-base @gol
464 -mpic-register=@var{reg} @gol
465 -mnop-fun-dllimport @gol
466 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
467 -mpoke-function-name @gol
468 -mthumb  -marm @gol
469 -mtpcs-frame  -mtpcs-leaf-frame @gol
470 -mcaller-super-interworking  -mcallee-super-interworking @gol
471 -mtp=@var{name} @gol
472 -mword-relocations @gol
473 -mfix-cortex-m3-ldrd}
474
475 @emph{AVR Options}
476 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
477 -mcall-prologues  -mtiny-stack  -mint8}
478
479 @emph{Blackfin Options}
480 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
481 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
482 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
483 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
484 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
485 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
486 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
487 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
488 -micplb}
489
490 @emph{CRIS Options}
491 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
492 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
493 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
494 -mstack-align  -mdata-align  -mconst-align @gol
495 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
496 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
497 -mmul-bug-workaround  -mno-mul-bug-workaround}
498
499 @emph{CRX Options}
500 @gccoptlist{-mmac -mpush-args}
501
502 @emph{Darwin Options}
503 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
504 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
505 -client_name  -compatibility_version  -current_version @gol
506 -dead_strip @gol
507 -dependency-file  -dylib_file  -dylinker_install_name @gol
508 -dynamic  -dynamiclib  -exported_symbols_list @gol
509 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
510 -force_flat_namespace  -headerpad_max_install_names @gol
511 -iframework @gol
512 -image_base  -init  -install_name  -keep_private_externs @gol
513 -multi_module  -multiply_defined  -multiply_defined_unused @gol
514 -noall_load   -no_dead_strip_inits_and_terms @gol
515 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
516 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
517 -private_bundle  -read_only_relocs  -sectalign @gol
518 -sectobjectsymbols  -whyload  -seg1addr @gol
519 -sectcreate  -sectobjectsymbols  -sectorder @gol
520 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
521 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
522 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
523 -single_module  -static  -sub_library  -sub_umbrella @gol
524 -twolevel_namespace  -umbrella  -undefined @gol
525 -unexported_symbols_list  -weak_reference_mismatches @gol
526 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
527 -mkernel -mone-byte-bool}
528
529 @emph{DEC Alpha Options}
530 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
531 -mieee  -mieee-with-inexact  -mieee-conformant @gol
532 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
533 -mtrap-precision=@var{mode}  -mbuild-constants @gol
534 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
535 -mbwx  -mmax  -mfix  -mcix @gol
536 -mfloat-vax  -mfloat-ieee @gol
537 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
538 -msmall-text  -mlarge-text @gol
539 -mmemory-latency=@var{time}}
540
541 @emph{DEC Alpha/VMS Options}
542 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
543
544 @emph{FR30 Options}
545 @gccoptlist{-msmall-model -mno-lsim}
546
547 @emph{FRV Options}
548 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
549 -mhard-float  -msoft-float @gol
550 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
551 -mdouble  -mno-double @gol
552 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
553 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
554 -mlinked-fp  -mlong-calls  -malign-labels @gol
555 -mlibrary-pic  -macc-4  -macc-8 @gol
556 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
557 -moptimize-membar -mno-optimize-membar @gol
558 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
559 -mvliw-branch  -mno-vliw-branch @gol
560 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
561 -mno-nested-cond-exec  -mtomcat-stats @gol
562 -mTLS -mtls @gol
563 -mcpu=@var{cpu}}
564
565 @emph{GNU/Linux Options}
566 @gccoptlist{-muclibc}
567
568 @emph{H8/300 Options}
569 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
570
571 @emph{HPPA Options}
572 @gccoptlist{-march=@var{architecture-type} @gol
573 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
574 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
575 -mfixed-range=@var{register-range} @gol
576 -mjump-in-delay -mlinker-opt -mlong-calls @gol
577 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
578 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
579 -mno-jump-in-delay  -mno-long-load-store @gol
580 -mno-portable-runtime  -mno-soft-float @gol
581 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
582 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
583 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
584 -munix=@var{unix-std}  -nolibdld  -static  -threads}
585
586 @emph{i386 and x86-64 Options}
587 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
588 -mfpmath=@var{unit} @gol
589 -masm=@var{dialect}  -mno-fancy-math-387 @gol
590 -mno-fp-ret-in-387  -msoft-float @gol
591 -mno-wide-multiply  -mrtd  -malign-double @gol
592 -mpreferred-stack-boundary=@var{num}
593 -mincoming-stack-boundary=@var{num}
594 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
595 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
596 -maes -mpclmul -mfused-madd @gol
597 -msse4a -m3dnow -mpopcnt -mabm -mfma4 -mxop -mlwp @gol
598 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
599 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
600 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
601 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
602 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
603 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
604 -mcmodel=@var{code-model} -mabi=@var{name} @gol
605 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
606 -msse2avx}
607
608 @emph{IA-64 Options}
609 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
610 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
611 -mconstant-gp  -mauto-pic  -mfused-madd @gol
612 -minline-float-divide-min-latency @gol
613 -minline-float-divide-max-throughput @gol
614 -mno-inline-float-divide @gol
615 -minline-int-divide-min-latency @gol
616 -minline-int-divide-max-throughput  @gol
617 -mno-inline-int-divide @gol
618 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
619 -mno-inline-sqrt @gol
620 -mdwarf2-asm -mearly-stop-bits @gol
621 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
622 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
623 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
624 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
625 -msched-spec-ldc -msched-spec-control-ldc @gol
626 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
627 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
628 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
629 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
630
631 @emph{IA-64/VMS Options}
632 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
633
634 @emph{LM32 Options}
635 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
636 -msign-extend-enabled -muser-enabled}
637
638 @emph{M32R/D Options}
639 @gccoptlist{-m32r2 -m32rx -m32r @gol
640 -mdebug @gol
641 -malign-loops -mno-align-loops @gol
642 -missue-rate=@var{number} @gol
643 -mbranch-cost=@var{number} @gol
644 -mmodel=@var{code-size-model-type} @gol
645 -msdata=@var{sdata-type} @gol
646 -mno-flush-func -mflush-func=@var{name} @gol
647 -mno-flush-trap -mflush-trap=@var{number} @gol
648 -G @var{num}}
649
650 @emph{M32C Options}
651 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
652
653 @emph{M680x0 Options}
654 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
655 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
656 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
657 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
658 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
659 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
660 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
661 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
662 -mxgot -mno-xgot}
663
664 @emph{M68hc1x Options}
665 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
666 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
667 -msoft-reg-count=@var{count}}
668
669 @emph{MCore Options}
670 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
671 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
672 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
673 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
674 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
675
676 @emph{MeP Options}
677 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
678 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
679 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
680 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
681 -mtiny=@var{n}}
682
683 @emph{MIPS Options}
684 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
685 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
686 -mips64  -mips64r2 @gol
687 -mips16  -mno-mips16  -mflip-mips16 @gol
688 -minterlink-mips16  -mno-interlink-mips16 @gol
689 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
690 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
691 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
692 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
693 -mfpu=@var{fpu-type} @gol
694 -msmartmips  -mno-smartmips @gol
695 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
696 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
697 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
698 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
699 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
700 -membedded-data  -mno-embedded-data @gol
701 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
702 -mcode-readable=@var{setting} @gol
703 -msplit-addresses  -mno-split-addresses @gol
704 -mexplicit-relocs  -mno-explicit-relocs @gol
705 -mcheck-zero-division  -mno-check-zero-division @gol
706 -mdivide-traps  -mdivide-breaks @gol
707 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
708 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
709 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
710 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
711 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
712 -mflush-func=@var{func}  -mno-flush-func @gol
713 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
714 -mfp-exceptions -mno-fp-exceptions @gol
715 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
716 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
717
718 @emph{MMIX Options}
719 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
720 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
721 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
722 -mno-base-addresses  -msingle-exit  -mno-single-exit}
723
724 @emph{MN10300 Options}
725 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
726 -mam33  -mno-am33 @gol
727 -mam33-2  -mno-am33-2 @gol
728 -mreturn-pointer-on-d0 @gol
729 -mno-crt0  -mrelax}
730
731 @emph{PDP-11 Options}
732 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
733 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
734 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
735 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
736 -mbranch-expensive  -mbranch-cheap @gol
737 -msplit  -mno-split  -munix-asm  -mdec-asm}
738
739 @emph{picoChip Options}
740 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
741 -msymbol-as-address -mno-inefficient-warnings}
742
743 @emph{PowerPC Options}
744 See RS/6000 and PowerPC Options.
745
746 @emph{RS/6000 and PowerPC Options}
747 @gccoptlist{-mcpu=@var{cpu-type} @gol
748 -mtune=@var{cpu-type} @gol
749 -mpower  -mno-power  -mpower2  -mno-power2 @gol
750 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
751 -maltivec  -mno-altivec @gol
752 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
753 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
754 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
755 -mfprnd  -mno-fprnd @gol
756 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
757 -mnew-mnemonics  -mold-mnemonics @gol
758 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
759 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
760 -malign-power  -malign-natural @gol
761 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
762 -msingle-float -mdouble-float -msimple-fpu @gol
763 -mstring  -mno-string  -mupdate  -mno-update @gol
764 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
765 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
766 -mstrict-align  -mno-strict-align  -mrelocatable @gol
767 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
768 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
769 -mdynamic-no-pic  -maltivec -mswdiv @gol
770 -mprioritize-restricted-insns=@var{priority} @gol
771 -msched-costly-dep=@var{dependence_type} @gol
772 -minsert-sched-nops=@var{scheme} @gol
773 -mcall-sysv  -mcall-netbsd @gol
774 -maix-struct-return  -msvr4-struct-return @gol
775 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
776 -misel -mno-isel @gol
777 -misel=yes  -misel=no @gol
778 -mspe -mno-spe @gol
779 -mspe=yes  -mspe=no @gol
780 -mpaired @gol
781 -mgen-cell-microcode -mwarn-cell-microcode @gol
782 -mvrsave -mno-vrsave @gol
783 -mmulhw -mno-mulhw @gol
784 -mdlmzb -mno-dlmzb @gol
785 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
786 -mprototype  -mno-prototype @gol
787 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
788 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
789
790 @emph{RX Options}
791 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
792 -mcpu= -patch=@gol
793 -mbig-endian-data -mlittle-endian-data @gol
794 -msmall-data @gol
795 -msim  -mno-sim@gol
796 -mas100-syntax -mno-as100-syntax@gol
797 -mrelax@gol
798 -mmax-constant-size=@gol
799 -mint-register=@gol
800 -msave-acc-in-interrupts}
801
802 @emph{S/390 and zSeries Options}
803 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
804 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
805 -mlong-double-64 -mlong-double-128 @gol
806 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
807 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
808 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
809 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
810 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
811
812 @emph{Score Options}
813 @gccoptlist{-meb -mel @gol
814 -mnhwloop @gol
815 -muls @gol
816 -mmac @gol
817 -mscore5 -mscore5u -mscore7 -mscore7d}
818
819 @emph{SH Options}
820 @gccoptlist{-m1  -m2  -m2e @gol
821 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
822 -m3  -m3e @gol
823 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
824 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
825 -m5-64media  -m5-64media-nofpu @gol
826 -m5-32media  -m5-32media-nofpu @gol
827 -m5-compact  -m5-compact-nofpu @gol
828 -mb  -ml  -mdalign  -mrelax @gol
829 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
830 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
831 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
832 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
833 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
834 -minvalid-symbols}
835
836 @emph{SPARC Options}
837 @gccoptlist{-mcpu=@var{cpu-type} @gol
838 -mtune=@var{cpu-type} @gol
839 -mcmodel=@var{code-model} @gol
840 -m32  -m64  -mapp-regs  -mno-app-regs @gol
841 -mfaster-structs  -mno-faster-structs @gol
842 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
843 -mhard-quad-float  -msoft-quad-float @gol
844 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
845 -mstack-bias  -mno-stack-bias @gol
846 -munaligned-doubles  -mno-unaligned-doubles @gol
847 -mv8plus  -mno-v8plus  -mvis  -mno-vis
848 -threads -pthreads -pthread}
849
850 @emph{SPU Options}
851 @gccoptlist{-mwarn-reloc -merror-reloc @gol
852 -msafe-dma -munsafe-dma @gol
853 -mbranch-hints @gol
854 -msmall-mem -mlarge-mem -mstdmain @gol
855 -mfixed-range=@var{register-range} @gol
856 -mea32 -mea64 @gol
857 -maddress-space-conversion -mno-address-space-conversion @gol
858 -mcache-size=@var{cache-size} @gol
859 -matomic-updates -mno-atomic-updates}
860
861 @emph{System V Options}
862 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
863
864 @emph{V850 Options}
865 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
866 -mprolog-function  -mno-prolog-function  -mspace @gol
867 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
868 -mapp-regs  -mno-app-regs @gol
869 -mdisable-callt  -mno-disable-callt @gol
870 -mv850e1 @gol
871 -mv850e @gol
872 -mv850  -mbig-switch}
873
874 @emph{VAX Options}
875 @gccoptlist{-mg  -mgnu  -munix}
876
877 @emph{VxWorks Options}
878 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
879 -Xbind-lazy  -Xbind-now}
880
881 @emph{x86-64 Options}
882 See i386 and x86-64 Options.
883
884 @emph{i386 and x86-64 Windows Options}
885 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
886 -mnop-fun-dllimport -mthread -municode -mwin32 -mwindows
887 -fno-set-stack-executable}
888
889 @emph{Xstormy16 Options}
890 @gccoptlist{-msim}
891
892 @emph{Xtensa Options}
893 @gccoptlist{-mconst16 -mno-const16 @gol
894 -mfused-madd  -mno-fused-madd @gol
895 -mserialize-volatile  -mno-serialize-volatile @gol
896 -mtext-section-literals  -mno-text-section-literals @gol
897 -mtarget-align  -mno-target-align @gol
898 -mlongcalls  -mno-longcalls}
899
900 @emph{zSeries Options}
901 See S/390 and zSeries Options.
902
903 @item Code Generation Options
904 @xref{Code Gen Options,,Options for Code Generation Conventions}.
905 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
906 -ffixed-@var{reg}  -fexceptions @gol
907 -fnon-call-exceptions  -funwind-tables @gol
908 -fasynchronous-unwind-tables @gol
909 -finhibit-size-directive  -finstrument-functions @gol
910 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
911 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
912 -fno-common  -fno-ident @gol
913 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
914 -fno-jump-tables @gol
915 -frecord-gcc-switches @gol
916 -freg-struct-return  -fshort-enums @gol
917 -fshort-double  -fshort-wchar @gol
918 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
919 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
920 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
921 -fargument-noalias-global  -fargument-noalias-anything @gol
922 -fleading-underscore  -ftls-model=@var{model} @gol
923 -ftrapv  -fwrapv  -fbounds-check @gol
924 -fvisibility}
925 @end table
926
927 @menu
928 * Overall Options::     Controlling the kind of output:
929                         an executable, object files, assembler files,
930                         or preprocessed source.
931 * C Dialect Options::   Controlling the variant of C language compiled.
932 * C++ Dialect Options:: Variations on C++.
933 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
934                         and Objective-C++.
935 * Language Independent Options:: Controlling how diagnostics should be
936                         formatted.
937 * Warning Options::     How picky should the compiler be?
938 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
939 * Optimize Options::    How much optimization?
940 * Preprocessor Options:: Controlling header files and macro definitions.
941                          Also, getting dependency information for Make.
942 * Assembler Options::   Passing options to the assembler.
943 * Link Options::        Specifying libraries and so on.
944 * Directory Options::   Where to find header files and libraries.
945                         Where to find the compiler executable files.
946 * Spec Files::          How to pass switches to sub-processes.
947 * Target Options::      Running a cross-compiler, or an old version of GCC.
948 @end menu
949
950 @node Overall Options
951 @section Options Controlling the Kind of Output
952
953 Compilation can involve up to four stages: preprocessing, compilation
954 proper, assembly and linking, always in that order.  GCC is capable of
955 preprocessing and compiling several files either into several
956 assembler input files, or into one assembler input file; then each
957 assembler input file produces an object file, and linking combines all
958 the object files (those newly compiled, and those specified as input)
959 into an executable file.
960
961 @cindex file name suffix
962 For any given input file, the file name suffix determines what kind of
963 compilation is done:
964
965 @table @gcctabopt
966 @item @var{file}.c
967 C source code which must be preprocessed.
968
969 @item @var{file}.i
970 C source code which should not be preprocessed.
971
972 @item @var{file}.ii
973 C++ source code which should not be preprocessed.
974
975 @item @var{file}.m
976 Objective-C source code.  Note that you must link with the @file{libobjc}
977 library to make an Objective-C program work.
978
979 @item @var{file}.mi
980 Objective-C source code which should not be preprocessed.
981
982 @item @var{file}.mm
983 @itemx @var{file}.M
984 Objective-C++ source code.  Note that you must link with the @file{libobjc}
985 library to make an Objective-C++ program work.  Note that @samp{.M} refers
986 to a literal capital M@.
987
988 @item @var{file}.mii
989 Objective-C++ source code which should not be preprocessed.
990
991 @item @var{file}.h
992 C, C++, Objective-C or Objective-C++ header file to be turned into a
993 precompiled header.
994
995 @item @var{file}.cc
996 @itemx @var{file}.cp
997 @itemx @var{file}.cxx
998 @itemx @var{file}.cpp
999 @itemx @var{file}.CPP
1000 @itemx @var{file}.c++
1001 @itemx @var{file}.C
1002 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
1003 the last two letters must both be literally @samp{x}.  Likewise,
1004 @samp{.C} refers to a literal capital C@.
1005
1006 @item @var{file}.mm
1007 @itemx @var{file}.M
1008 Objective-C++ source code which must be preprocessed.
1009
1010 @item @var{file}.mii
1011 Objective-C++ source code which should not be preprocessed.
1012
1013 @item @var{file}.hh
1014 @itemx @var{file}.H
1015 @itemx @var{file}.hp
1016 @itemx @var{file}.hxx
1017 @itemx @var{file}.hpp
1018 @itemx @var{file}.HPP
1019 @itemx @var{file}.h++
1020 @itemx @var{file}.tcc
1021 C++ header file to be turned into a precompiled header.
1022
1023 @item @var{file}.f
1024 @itemx @var{file}.for
1025 @itemx @var{file}.ftn
1026 Fixed form Fortran source code which should not be preprocessed.
1027
1028 @item @var{file}.F
1029 @itemx @var{file}.FOR
1030 @itemx @var{file}.fpp
1031 @itemx @var{file}.FPP
1032 @itemx @var{file}.FTN
1033 Fixed form Fortran source code which must be preprocessed (with the traditional
1034 preprocessor).
1035
1036 @item @var{file}.f90
1037 @itemx @var{file}.f95
1038 @itemx @var{file}.f03
1039 @itemx @var{file}.f08
1040 Free form Fortran source code which should not be preprocessed.
1041
1042 @item @var{file}.F90
1043 @itemx @var{file}.F95
1044 @itemx @var{file}.F03
1045 @itemx @var{file}.F08
1046 Free form Fortran source code which must be preprocessed (with the
1047 traditional preprocessor).
1048
1049 @c FIXME: Descriptions of Java file types.
1050 @c @var{file}.java
1051 @c @var{file}.class
1052 @c @var{file}.zip
1053 @c @var{file}.jar
1054
1055 @item @var{file}.ads
1056 Ada source code file which contains a library unit declaration (a
1057 declaration of a package, subprogram, or generic, or a generic
1058 instantiation), or a library unit renaming declaration (a package,
1059 generic, or subprogram renaming declaration).  Such files are also
1060 called @dfn{specs}.
1061
1062 @item @var{file}.adb
1063 Ada source code file containing a library unit body (a subprogram or
1064 package body).  Such files are also called @dfn{bodies}.
1065
1066 @c GCC also knows about some suffixes for languages not yet included:
1067 @c Pascal:
1068 @c @var{file}.p
1069 @c @var{file}.pas
1070 @c Ratfor:
1071 @c @var{file}.r
1072
1073 @item @var{file}.s
1074 Assembler code.
1075
1076 @item @var{file}.S
1077 @itemx @var{file}.sx
1078 Assembler code which must be preprocessed.
1079
1080 @item @var{other}
1081 An object file to be fed straight into linking.
1082 Any file name with no recognized suffix is treated this way.
1083 @end table
1084
1085 @opindex x
1086 You can specify the input language explicitly with the @option{-x} option:
1087
1088 @table @gcctabopt
1089 @item -x @var{language}
1090 Specify explicitly the @var{language} for the following input files
1091 (rather than letting the compiler choose a default based on the file
1092 name suffix).  This option applies to all following input files until
1093 the next @option{-x} option.  Possible values for @var{language} are:
1094 @smallexample
1095 c  c-header  c-cpp-output
1096 c++  c++-header  c++-cpp-output
1097 objective-c  objective-c-header  objective-c-cpp-output
1098 objective-c++ objective-c++-header objective-c++-cpp-output
1099 assembler  assembler-with-cpp
1100 ada
1101 f77  f77-cpp-input f95  f95-cpp-input
1102 java
1103 @end smallexample
1104
1105 @item -x none
1106 Turn off any specification of a language, so that subsequent files are
1107 handled according to their file name suffixes (as they are if @option{-x}
1108 has not been used at all).
1109
1110 @item -pass-exit-codes
1111 @opindex pass-exit-codes
1112 Normally the @command{gcc} program will exit with the code of 1 if any
1113 phase of the compiler returns a non-success return code.  If you specify
1114 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1115 numerically highest error produced by any phase that returned an error
1116 indication.  The C, C++, and Fortran frontends return 4, if an internal
1117 compiler error is encountered.
1118 @end table
1119
1120 If you only want some of the stages of compilation, you can use
1121 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1122 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1123 @command{gcc} is to stop.  Note that some combinations (for example,
1124 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1125
1126 @table @gcctabopt
1127 @item -c
1128 @opindex c
1129 Compile or assemble the source files, but do not link.  The linking
1130 stage simply is not done.  The ultimate output is in the form of an
1131 object file for each source file.
1132
1133 By default, the object file name for a source file is made by replacing
1134 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1135
1136 Unrecognized input files, not requiring compilation or assembly, are
1137 ignored.
1138
1139 @item -S
1140 @opindex S
1141 Stop after the stage of compilation proper; do not assemble.  The output
1142 is in the form of an assembler code file for each non-assembler input
1143 file specified.
1144
1145 By default, the assembler file name for a source file is made by
1146 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1147
1148 Input files that don't require compilation are ignored.
1149
1150 @item -E
1151 @opindex E
1152 Stop after the preprocessing stage; do not run the compiler proper.  The
1153 output is in the form of preprocessed source code, which is sent to the
1154 standard output.
1155
1156 Input files which don't require preprocessing are ignored.
1157
1158 @cindex output file option
1159 @item -o @var{file}
1160 @opindex o
1161 Place output in file @var{file}.  This applies regardless to whatever
1162 sort of output is being produced, whether it be an executable file,
1163 an object file, an assembler file or preprocessed C code.
1164
1165 If @option{-o} is not specified, the default is to put an executable
1166 file in @file{a.out}, the object file for
1167 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1168 assembler file in @file{@var{source}.s}, a precompiled header file in
1169 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1170 standard output.
1171
1172 @item -v
1173 @opindex v
1174 Print (on standard error output) the commands executed to run the stages
1175 of compilation.  Also print the version number of the compiler driver
1176 program and of the preprocessor and the compiler proper.
1177
1178 @item -###
1179 @opindex ###
1180 Like @option{-v} except the commands are not executed and all command
1181 arguments are quoted.  This is useful for shell scripts to capture the
1182 driver-generated command lines.
1183
1184 @item -pipe
1185 @opindex pipe
1186 Use pipes rather than temporary files for communication between the
1187 various stages of compilation.  This fails to work on some systems where
1188 the assembler is unable to read from a pipe; but the GNU assembler has
1189 no trouble.
1190
1191 @item -combine
1192 @opindex combine
1193 If you are compiling multiple source files, this option tells the driver
1194 to pass all the source files to the compiler at once (for those
1195 languages for which the compiler can handle this).  This will allow
1196 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1197 language for which this is supported is C@.  If you pass source files for
1198 multiple languages to the driver, using this option, the driver will invoke
1199 the compiler(s) that support IMA once each, passing each compiler all the
1200 source files appropriate for it.  For those languages that do not support
1201 IMA this option will be ignored, and the compiler will be invoked once for
1202 each source file in that language.  If you use this option in conjunction
1203 with @option{-save-temps}, the compiler will generate multiple
1204 pre-processed files
1205 (one for each source file), but only one (combined) @file{.o} or
1206 @file{.s} file.
1207
1208 @item --help
1209 @opindex help
1210 Print (on the standard output) a description of the command line options
1211 understood by @command{gcc}.  If the @option{-v} option is also specified
1212 then @option{--help} will also be passed on to the various processes
1213 invoked by @command{gcc}, so that they can display the command line options
1214 they accept.  If the @option{-Wextra} option has also been specified
1215 (prior to the @option{--help} option), then command line options which
1216 have no documentation associated with them will also be displayed.
1217
1218 @item --target-help
1219 @opindex target-help
1220 Print (on the standard output) a description of target-specific command
1221 line options for each tool.  For some targets extra target-specific
1222 information may also be printed.
1223
1224 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1225 Print (on the standard output) a description of the command line
1226 options understood by the compiler that fit into all specified classes
1227 and qualifiers.  These are the supported classes:
1228
1229 @table @asis
1230 @item @samp{optimizers}
1231 This will display all of the optimization options supported by the
1232 compiler.
1233
1234 @item @samp{warnings}
1235 This will display all of the options controlling warning messages
1236 produced by the compiler.
1237
1238 @item @samp{target}
1239 This will display target-specific options.  Unlike the
1240 @option{--target-help} option however, target-specific options of the
1241 linker and assembler will not be displayed.  This is because those
1242 tools do not currently support the extended @option{--help=} syntax.
1243
1244 @item @samp{params}
1245 This will display the values recognized by the @option{--param}
1246 option.
1247
1248 @item @var{language}
1249 This will display the options supported for @var{language}, where
1250 @var{language} is the name of one of the languages supported in this
1251 version of GCC.
1252
1253 @item @samp{common}
1254 This will display the options that are common to all languages.
1255 @end table
1256
1257 These are the supported qualifiers:
1258
1259 @table @asis
1260 @item @samp{undocumented}
1261 Display only those options which are undocumented.
1262
1263 @item @samp{joined}
1264 Display options which take an argument that appears after an equal
1265 sign in the same continuous piece of text, such as:
1266 @samp{--help=target}.
1267
1268 @item @samp{separate}
1269 Display options which take an argument that appears as a separate word
1270 following the original option, such as: @samp{-o output-file}.
1271 @end table
1272
1273 Thus for example to display all the undocumented target-specific
1274 switches supported by the compiler the following can be used:
1275
1276 @smallexample
1277 --help=target,undocumented
1278 @end smallexample
1279
1280 The sense of a qualifier can be inverted by prefixing it with the
1281 @samp{^} character, so for example to display all binary warning
1282 options (i.e., ones that are either on or off and that do not take an
1283 argument), which have a description the following can be used:
1284
1285 @smallexample
1286 --help=warnings,^joined,^undocumented
1287 @end smallexample
1288
1289 The argument to @option{--help=} should not consist solely of inverted
1290 qualifiers.
1291
1292 Combining several classes is possible, although this usually
1293 restricts the output by so much that there is nothing to display.  One
1294 case where it does work however is when one of the classes is
1295 @var{target}.  So for example to display all the target-specific
1296 optimization options the following can be used:
1297
1298 @smallexample
1299 --help=target,optimizers
1300 @end smallexample
1301
1302 The @option{--help=} option can be repeated on the command line.  Each
1303 successive use will display its requested class of options, skipping
1304 those that have already been displayed.
1305
1306 If the @option{-Q} option appears on the command line before the
1307 @option{--help=} option, then the descriptive text displayed by
1308 @option{--help=} is changed.  Instead of describing the displayed
1309 options, an indication is given as to whether the option is enabled,
1310 disabled or set to a specific value (assuming that the compiler
1311 knows this at the point where the @option{--help=} option is used).
1312
1313 Here is a truncated example from the ARM port of @command{gcc}:
1314
1315 @smallexample
1316   % gcc -Q -mabi=2 --help=target -c
1317   The following options are target specific:
1318   -mabi=                                2
1319   -mabort-on-noreturn                   [disabled]
1320   -mapcs                                [disabled]
1321 @end smallexample
1322
1323 The output is sensitive to the effects of previous command line
1324 options, so for example it is possible to find out which optimizations
1325 are enabled at @option{-O2} by using:
1326
1327 @smallexample
1328 -Q -O2 --help=optimizers
1329 @end smallexample
1330
1331 Alternatively you can discover which binary optimizations are enabled
1332 by @option{-O3} by using:
1333
1334 @smallexample
1335 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1336 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1337 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1338 @end smallexample
1339
1340 @item -no-canonical-prefixes
1341 @opindex no-canonical-prefixes
1342 Do not expand any symbolic links, resolve references to @samp{/../}
1343 or @samp{/./}, or make the path absolute when generating a relative
1344 prefix.
1345
1346 @item --version
1347 @opindex version
1348 Display the version number and copyrights of the invoked GCC@.
1349
1350 @item -wrapper
1351 @opindex wrapper
1352 Invoke all subcommands under a wrapper program. It takes a single
1353 comma separated list as an argument, which will be used to invoke
1354 the wrapper:
1355
1356 @smallexample
1357 gcc -c t.c -wrapper gdb,--args
1358 @end smallexample
1359
1360 This will invoke all subprograms of gcc under "gdb --args",
1361 thus cc1 invocation will be "gdb --args cc1 ...".
1362
1363 @item -fplugin=@var{name}.so
1364 Load the plugin code in file @var{name}.so, assumed to be a
1365 shared object to be dlopen'd by the compiler.  The base name of
1366 the shared object file is used to identify the plugin for the
1367 purposes of argument parsing (See
1368 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1369 Each plugin should define the callback functions specified in the
1370 Plugins API.
1371
1372 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1373 Define an argument called @var{key} with a value of @var{value}
1374 for the plugin called @var{name}.
1375
1376 @include @value{srcdir}/../libiberty/at-file.texi
1377 @end table
1378
1379 @node Invoking G++
1380 @section Compiling C++ Programs
1381
1382 @cindex suffixes for C++ source
1383 @cindex C++ source file suffixes
1384 C++ source files conventionally use one of the suffixes @samp{.C},
1385 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1386 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1387 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1388 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1389 files with these names and compiles them as C++ programs even if you
1390 call the compiler the same way as for compiling C programs (usually
1391 with the name @command{gcc}).
1392
1393 @findex g++
1394 @findex c++
1395 However, the use of @command{gcc} does not add the C++ library.
1396 @command{g++} is a program that calls GCC and treats @samp{.c},
1397 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1398 files unless @option{-x} is used, and automatically specifies linking
1399 against the C++ library.  This program is also useful when
1400 precompiling a C header file with a @samp{.h} extension for use in C++
1401 compilations.  On many systems, @command{g++} is also installed with
1402 the name @command{c++}.
1403
1404 @cindex invoking @command{g++}
1405 When you compile C++ programs, you may specify many of the same
1406 command-line options that you use for compiling programs in any
1407 language; or command-line options meaningful for C and related
1408 languages; or options that are meaningful only for C++ programs.
1409 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1410 explanations of options for languages related to C@.
1411 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1412 explanations of options that are meaningful only for C++ programs.
1413
1414 @node C Dialect Options
1415 @section Options Controlling C Dialect
1416 @cindex dialect options
1417 @cindex language dialect options
1418 @cindex options, dialect
1419
1420 The following options control the dialect of C (or languages derived
1421 from C, such as C++, Objective-C and Objective-C++) that the compiler
1422 accepts:
1423
1424 @table @gcctabopt
1425 @cindex ANSI support
1426 @cindex ISO support
1427 @item -ansi
1428 @opindex ansi
1429 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1430 equivalent to @samp{-std=c++98}.
1431
1432 This turns off certain features of GCC that are incompatible with ISO
1433 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1434 such as the @code{asm} and @code{typeof} keywords, and
1435 predefined macros such as @code{unix} and @code{vax} that identify the
1436 type of system you are using.  It also enables the undesirable and
1437 rarely used ISO trigraph feature.  For the C compiler,
1438 it disables recognition of C++ style @samp{//} comments as well as
1439 the @code{inline} keyword.
1440
1441 The alternate keywords @code{__asm__}, @code{__extension__},
1442 @code{__inline__} and @code{__typeof__} continue to work despite
1443 @option{-ansi}.  You would not want to use them in an ISO C program, of
1444 course, but it is useful to put them in header files that might be included
1445 in compilations done with @option{-ansi}.  Alternate predefined macros
1446 such as @code{__unix__} and @code{__vax__} are also available, with or
1447 without @option{-ansi}.
1448
1449 The @option{-ansi} option does not cause non-ISO programs to be
1450 rejected gratuitously.  For that, @option{-pedantic} is required in
1451 addition to @option{-ansi}.  @xref{Warning Options}.
1452
1453 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1454 option is used.  Some header files may notice this macro and refrain
1455 from declaring certain functions or defining certain macros that the
1456 ISO standard doesn't call for; this is to avoid interfering with any
1457 programs that might use these names for other things.
1458
1459 Functions that would normally be built in but do not have semantics
1460 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1461 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1462 built-in functions provided by GCC}, for details of the functions
1463 affected.
1464
1465 @item -std=
1466 @opindex std
1467 Determine the language standard. @xref{Standards,,Language Standards
1468 Supported by GCC}, for details of these standard versions.  This option
1469 is currently only supported when compiling C or C++.
1470
1471 The compiler can accept several base standards, such as @samp{c89} or
1472 @samp{c++98}, and GNU dialects of those standards, such as
1473 @samp{gnu89} or @samp{gnu++98}.  By specifying a base standard, the
1474 compiler will accept all programs following that standard and those
1475 using GNU extensions that do not contradict it.  For example,
1476 @samp{-std=c89} turns off certain features of GCC that are
1477 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1478 keywords, but not other GNU extensions that do not have a meaning in
1479 ISO C90, such as omitting the middle term of a @code{?:}
1480 expression. On the other hand, by specifying a GNU dialect of a
1481 standard, all features the compiler support are enabled, even when
1482 those features change the meaning of the base standard and some
1483 strict-conforming programs may be rejected.  The particular standard
1484 is used by @option{-pedantic} to identify which features are GNU
1485 extensions given that version of the standard. For example
1486 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1487 comments, while @samp{-std=gnu99 -pedantic} would not.
1488
1489 A value for this option must be provided; possible values are
1490
1491 @table @samp
1492 @item c89
1493 @itemx iso9899:1990
1494 Support all ISO C90 programs (certain GNU extensions that conflict
1495 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1496
1497 @item iso9899:199409
1498 ISO C90 as modified in amendment 1.
1499
1500 @item c99
1501 @itemx c9x
1502 @itemx iso9899:1999
1503 @itemx iso9899:199x
1504 ISO C99.  Note that this standard is not yet fully supported; see
1505 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1506 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1507
1508 @item gnu89
1509 GNU dialect of ISO C90 (including some C99 features). This
1510 is the default for C code.
1511
1512 @item gnu99
1513 @itemx gnu9x
1514 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1515 this will become the default.  The name @samp{gnu9x} is deprecated.
1516
1517 @item c++98
1518 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1519 C++ code.
1520
1521 @item gnu++98
1522 GNU dialect of @option{-std=c++98}.  This is the default for
1523 C++ code.
1524
1525 @item c++0x
1526 The working draft of the upcoming ISO C++0x standard. This option
1527 enables experimental features that are likely to be included in
1528 C++0x. The working draft is constantly changing, and any feature that is
1529 enabled by this flag may be removed from future versions of GCC if it is
1530 not part of the C++0x standard.
1531
1532 @item gnu++0x
1533 GNU dialect of @option{-std=c++0x}. This option enables
1534 experimental features that may be removed in future versions of GCC.
1535 @end table
1536
1537 @item -fgnu89-inline
1538 @opindex fgnu89-inline
1539 The option @option{-fgnu89-inline} tells GCC to use the traditional
1540 GNU semantics for @code{inline} functions when in C99 mode.
1541 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1542 is accepted and ignored by GCC versions 4.1.3 up to but not including
1543 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1544 C99 mode.  Using this option is roughly equivalent to adding the
1545 @code{gnu_inline} function attribute to all inline functions
1546 (@pxref{Function Attributes}).
1547
1548 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1549 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1550 specifies the default behavior).  This option was first supported in
1551 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1552
1553 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1554 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1555 in effect for @code{inline} functions.  @xref{Common Predefined
1556 Macros,,,cpp,The C Preprocessor}.
1557
1558 @item -aux-info @var{filename}
1559 @opindex aux-info
1560 Output to the given filename prototyped declarations for all functions
1561 declared and/or defined in a translation unit, including those in header
1562 files.  This option is silently ignored in any language other than C@.
1563
1564 Besides declarations, the file indicates, in comments, the origin of
1565 each declaration (source file and line), whether the declaration was
1566 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1567 @samp{O} for old, respectively, in the first character after the line
1568 number and the colon), and whether it came from a declaration or a
1569 definition (@samp{C} or @samp{F}, respectively, in the following
1570 character).  In the case of function definitions, a K&R-style list of
1571 arguments followed by their declarations is also provided, inside
1572 comments, after the declaration.
1573
1574 @item -fno-asm
1575 @opindex fno-asm
1576 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1577 keyword, so that code can use these words as identifiers.  You can use
1578 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1579 instead.  @option{-ansi} implies @option{-fno-asm}.
1580
1581 In C++, this switch only affects the @code{typeof} keyword, since
1582 @code{asm} and @code{inline} are standard keywords.  You may want to
1583 use the @option{-fno-gnu-keywords} flag instead, which has the same
1584 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1585 switch only affects the @code{asm} and @code{typeof} keywords, since
1586 @code{inline} is a standard keyword in ISO C99.
1587
1588 @item -fno-builtin
1589 @itemx -fno-builtin-@var{function}
1590 @opindex fno-builtin
1591 @cindex built-in functions
1592 Don't recognize built-in functions that do not begin with
1593 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1594 functions provided by GCC}, for details of the functions affected,
1595 including those which are not built-in functions when @option{-ansi} or
1596 @option{-std} options for strict ISO C conformance are used because they
1597 do not have an ISO standard meaning.
1598
1599 GCC normally generates special code to handle certain built-in functions
1600 more efficiently; for instance, calls to @code{alloca} may become single
1601 instructions that adjust the stack directly, and calls to @code{memcpy}
1602 may become inline copy loops.  The resulting code is often both smaller
1603 and faster, but since the function calls no longer appear as such, you
1604 cannot set a breakpoint on those calls, nor can you change the behavior
1605 of the functions by linking with a different library.  In addition,
1606 when a function is recognized as a built-in function, GCC may use
1607 information about that function to warn about problems with calls to
1608 that function, or to generate more efficient code, even if the
1609 resulting code still contains calls to that function.  For example,
1610 warnings are given with @option{-Wformat} for bad calls to
1611 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1612 known not to modify global memory.
1613
1614 With the @option{-fno-builtin-@var{function}} option
1615 only the built-in function @var{function} is
1616 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1617 function is named that is not built-in in this version of GCC, this
1618 option is ignored.  There is no corresponding
1619 @option{-fbuiltin-@var{function}} option; if you wish to enable
1620 built-in functions selectively when using @option{-fno-builtin} or
1621 @option{-ffreestanding}, you may define macros such as:
1622
1623 @smallexample
1624 #define abs(n)          __builtin_abs ((n))
1625 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1626 @end smallexample
1627
1628 @item -fhosted
1629 @opindex fhosted
1630 @cindex hosted environment
1631
1632 Assert that compilation takes place in a hosted environment.  This implies
1633 @option{-fbuiltin}.  A hosted environment is one in which the
1634 entire standard library is available, and in which @code{main} has a return
1635 type of @code{int}.  Examples are nearly everything except a kernel.
1636 This is equivalent to @option{-fno-freestanding}.
1637
1638 @item -ffreestanding
1639 @opindex ffreestanding
1640 @cindex hosted environment
1641
1642 Assert that compilation takes place in a freestanding environment.  This
1643 implies @option{-fno-builtin}.  A freestanding environment
1644 is one in which the standard library may not exist, and program startup may
1645 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1646 This is equivalent to @option{-fno-hosted}.
1647
1648 @xref{Standards,,Language Standards Supported by GCC}, for details of
1649 freestanding and hosted environments.
1650
1651 @item -fopenmp
1652 @opindex fopenmp
1653 @cindex openmp parallel
1654 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1655 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1656 compiler generates parallel code according to the OpenMP Application
1657 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1658 implies @option{-pthread}, and thus is only supported on targets that
1659 have support for @option{-pthread}.
1660
1661 @item -fms-extensions
1662 @opindex fms-extensions
1663 Accept some non-standard constructs used in Microsoft header files.
1664
1665 Some cases of unnamed fields in structures and unions are only
1666 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1667 fields within structs/unions}, for details.
1668
1669 @item -trigraphs
1670 @opindex trigraphs
1671 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1672 options for strict ISO C conformance) implies @option{-trigraphs}.
1673
1674 @item -no-integrated-cpp
1675 @opindex no-integrated-cpp
1676 Performs a compilation in two passes: preprocessing and compiling.  This
1677 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1678 @option{-B} option.  The user supplied compilation step can then add in
1679 an additional preprocessing step after normal preprocessing but before
1680 compiling.  The default is to use the integrated cpp (internal cpp)
1681
1682 The semantics of this option will change if "cc1", "cc1plus", and
1683 "cc1obj" are merged.
1684
1685 @cindex traditional C language
1686 @cindex C language, traditional
1687 @item -traditional
1688 @itemx -traditional-cpp
1689 @opindex traditional-cpp
1690 @opindex traditional
1691 Formerly, these options caused GCC to attempt to emulate a pre-standard
1692 C compiler.  They are now only supported with the @option{-E} switch.
1693 The preprocessor continues to support a pre-standard mode.  See the GNU
1694 CPP manual for details.
1695
1696 @item -fcond-mismatch
1697 @opindex fcond-mismatch
1698 Allow conditional expressions with mismatched types in the second and
1699 third arguments.  The value of such an expression is void.  This option
1700 is not supported for C++.
1701
1702 @item -flax-vector-conversions
1703 @opindex flax-vector-conversions
1704 Allow implicit conversions between vectors with differing numbers of
1705 elements and/or incompatible element types.  This option should not be
1706 used for new code.
1707
1708 @item -funsigned-char
1709 @opindex funsigned-char
1710 Let the type @code{char} be unsigned, like @code{unsigned char}.
1711
1712 Each kind of machine has a default for what @code{char} should
1713 be.  It is either like @code{unsigned char} by default or like
1714 @code{signed char} by default.
1715
1716 Ideally, a portable program should always use @code{signed char} or
1717 @code{unsigned char} when it depends on the signedness of an object.
1718 But many programs have been written to use plain @code{char} and
1719 expect it to be signed, or expect it to be unsigned, depending on the
1720 machines they were written for.  This option, and its inverse, let you
1721 make such a program work with the opposite default.
1722
1723 The type @code{char} is always a distinct type from each of
1724 @code{signed char} or @code{unsigned char}, even though its behavior
1725 is always just like one of those two.
1726
1727 @item -fsigned-char
1728 @opindex fsigned-char
1729 Let the type @code{char} be signed, like @code{signed char}.
1730
1731 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1732 the negative form of @option{-funsigned-char}.  Likewise, the option
1733 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1734
1735 @item -fsigned-bitfields
1736 @itemx -funsigned-bitfields
1737 @itemx -fno-signed-bitfields
1738 @itemx -fno-unsigned-bitfields
1739 @opindex fsigned-bitfields
1740 @opindex funsigned-bitfields
1741 @opindex fno-signed-bitfields
1742 @opindex fno-unsigned-bitfields
1743 These options control whether a bit-field is signed or unsigned, when the
1744 declaration does not use either @code{signed} or @code{unsigned}.  By
1745 default, such a bit-field is signed, because this is consistent: the
1746 basic integer types such as @code{int} are signed types.
1747 @end table
1748
1749 @node C++ Dialect Options
1750 @section Options Controlling C++ Dialect
1751
1752 @cindex compiler options, C++
1753 @cindex C++ options, command line
1754 @cindex options, C++
1755 This section describes the command-line options that are only meaningful
1756 for C++ programs; but you can also use most of the GNU compiler options
1757 regardless of what language your program is in.  For example, you
1758 might compile a file @code{firstClass.C} like this:
1759
1760 @smallexample
1761 g++ -g -frepo -O -c firstClass.C
1762 @end smallexample
1763
1764 @noindent
1765 In this example, only @option{-frepo} is an option meant
1766 only for C++ programs; you can use the other options with any
1767 language supported by GCC@.
1768
1769 Here is a list of options that are @emph{only} for compiling C++ programs:
1770
1771 @table @gcctabopt
1772
1773 @item -fabi-version=@var{n}
1774 @opindex fabi-version
1775 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1776 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1777 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1778 the version that conforms most closely to the C++ ABI specification.
1779 Therefore, the ABI obtained using version 0 will change as ABI bugs
1780 are fixed.
1781
1782 The default is version 2.
1783
1784 @item -fno-access-control
1785 @opindex fno-access-control
1786 Turn off all access checking.  This switch is mainly useful for working
1787 around bugs in the access control code.
1788
1789 @item -fcheck-new
1790 @opindex fcheck-new
1791 Check that the pointer returned by @code{operator new} is non-null
1792 before attempting to modify the storage allocated.  This check is
1793 normally unnecessary because the C++ standard specifies that
1794 @code{operator new} will only return @code{0} if it is declared
1795 @samp{throw()}, in which case the compiler will always check the
1796 return value even without this option.  In all other cases, when
1797 @code{operator new} has a non-empty exception specification, memory
1798 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1799 @samp{new (nothrow)}.
1800
1801 @item -fconserve-space
1802 @opindex fconserve-space
1803 Put uninitialized or runtime-initialized global variables into the
1804 common segment, as C does.  This saves space in the executable at the
1805 cost of not diagnosing duplicate definitions.  If you compile with this
1806 flag and your program mysteriously crashes after @code{main()} has
1807 completed, you may have an object that is being destroyed twice because
1808 two definitions were merged.
1809
1810 This option is no longer useful on most targets, now that support has
1811 been added for putting variables into BSS without making them common.
1812
1813 @item -fno-deduce-init-list
1814 @opindex fno-deduce-init-list
1815 Disable deduction of a template type parameter as
1816 std::initializer_list from a brace-enclosed initializer list, i.e.
1817
1818 @smallexample
1819 template <class T> auto forward(T t) -> decltype (realfn (t))
1820 @{
1821   return realfn (t);
1822 @}
1823
1824 void f()
1825 @{
1826   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1827 @}
1828 @end smallexample
1829
1830 This option is present because this deduction is an extension to the
1831 current specification in the C++0x working draft, and there was
1832 some concern about potential overload resolution problems.
1833
1834 @item -ffriend-injection
1835 @opindex ffriend-injection
1836 Inject friend functions into the enclosing namespace, so that they are
1837 visible outside the scope of the class in which they are declared.
1838 Friend functions were documented to work this way in the old Annotated
1839 C++ Reference Manual, and versions of G++ before 4.1 always worked
1840 that way.  However, in ISO C++ a friend function which is not declared
1841 in an enclosing scope can only be found using argument dependent
1842 lookup.  This option causes friends to be injected as they were in
1843 earlier releases.
1844
1845 This option is for compatibility, and may be removed in a future
1846 release of G++.
1847
1848 @item -fno-elide-constructors
1849 @opindex fno-elide-constructors
1850 The C++ standard allows an implementation to omit creating a temporary
1851 which is only used to initialize another object of the same type.
1852 Specifying this option disables that optimization, and forces G++ to
1853 call the copy constructor in all cases.
1854
1855 @item -fno-enforce-eh-specs
1856 @opindex fno-enforce-eh-specs
1857 Don't generate code to check for violation of exception specifications
1858 at runtime.  This option violates the C++ standard, but may be useful
1859 for reducing code size in production builds, much like defining
1860 @samp{NDEBUG}.  This does not give user code permission to throw
1861 exceptions in violation of the exception specifications; the compiler
1862 will still optimize based on the specifications, so throwing an
1863 unexpected exception will result in undefined behavior.
1864
1865 @item -ffor-scope
1866 @itemx -fno-for-scope
1867 @opindex ffor-scope
1868 @opindex fno-for-scope
1869 If @option{-ffor-scope} is specified, the scope of variables declared in
1870 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1871 as specified by the C++ standard.
1872 If @option{-fno-for-scope} is specified, the scope of variables declared in
1873 a @i{for-init-statement} extends to the end of the enclosing scope,
1874 as was the case in old versions of G++, and other (traditional)
1875 implementations of C++.
1876
1877 The default if neither flag is given to follow the standard,
1878 but to allow and give a warning for old-style code that would
1879 otherwise be invalid, or have different behavior.
1880
1881 @item -fno-gnu-keywords
1882 @opindex fno-gnu-keywords
1883 Do not recognize @code{typeof} as a keyword, so that code can use this
1884 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1885 @option{-ansi} implies @option{-fno-gnu-keywords}.
1886
1887 @item -fno-implicit-templates
1888 @opindex fno-implicit-templates
1889 Never emit code for non-inline templates which are instantiated
1890 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1891 @xref{Template Instantiation}, for more information.
1892
1893 @item -fno-implicit-inline-templates
1894 @opindex fno-implicit-inline-templates
1895 Don't emit code for implicit instantiations of inline templates, either.
1896 The default is to handle inlines differently so that compiles with and
1897 without optimization will need the same set of explicit instantiations.
1898
1899 @item -fno-implement-inlines
1900 @opindex fno-implement-inlines
1901 To save space, do not emit out-of-line copies of inline functions
1902 controlled by @samp{#pragma implementation}.  This will cause linker
1903 errors if these functions are not inlined everywhere they are called.
1904
1905 @item -fms-extensions
1906 @opindex fms-extensions
1907 Disable pedantic warnings about constructs used in MFC, such as implicit
1908 int and getting a pointer to member function via non-standard syntax.
1909
1910 @item -fno-nonansi-builtins
1911 @opindex fno-nonansi-builtins
1912 Disable built-in declarations of functions that are not mandated by
1913 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1914 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1915
1916 @item -fno-operator-names
1917 @opindex fno-operator-names
1918 Do not treat the operator name keywords @code{and}, @code{bitand},
1919 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1920 synonyms as keywords.
1921
1922 @item -fno-optional-diags
1923 @opindex fno-optional-diags
1924 Disable diagnostics that the standard says a compiler does not need to
1925 issue.  Currently, the only such diagnostic issued by G++ is the one for
1926 a name having multiple meanings within a class.
1927
1928 @item -fpermissive
1929 @opindex fpermissive
1930 Downgrade some diagnostics about nonconformant code from errors to
1931 warnings.  Thus, using @option{-fpermissive} will allow some
1932 nonconforming code to compile.
1933
1934 @item -fno-pretty-templates
1935 @opindex fno-pretty-templates
1936 When an error message refers to a specialization of a function
1937 template, the compiler will normally print the signature of the
1938 template followed by the template arguments and any typedefs or
1939 typenames in the signature (e.g. @code{void f(T) [with T = int]}
1940 rather than @code{void f(int)}) so that it's clear which template is
1941 involved.  When an error message refers to a specialization of a class
1942 template, the compiler will omit any template arguments which match
1943 the default template arguments for that template.  If either of these
1944 behaviors make it harder to understand the error message rather than
1945 easier, using @option{-fno-pretty-templates} will disable them.
1946
1947 @item -frepo
1948 @opindex frepo
1949 Enable automatic template instantiation at link time.  This option also
1950 implies @option{-fno-implicit-templates}.  @xref{Template
1951 Instantiation}, for more information.
1952
1953 @item -fno-rtti
1954 @opindex fno-rtti
1955 Disable generation of information about every class with virtual
1956 functions for use by the C++ runtime type identification features
1957 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1958 of the language, you can save some space by using this flag.  Note that
1959 exception handling uses the same information, but it will generate it as
1960 needed. The @samp{dynamic_cast} operator can still be used for casts that
1961 do not require runtime type information, i.e.@: casts to @code{void *} or to
1962 unambiguous base classes.
1963
1964 @item -fstats
1965 @opindex fstats
1966 Emit statistics about front-end processing at the end of the compilation.
1967 This information is generally only useful to the G++ development team.
1968
1969 @item -ftemplate-depth-@var{n}
1970 @opindex ftemplate-depth
1971 Set the maximum instantiation depth for template classes to @var{n}.
1972 A limit on the template instantiation depth is needed to detect
1973 endless recursions during template class instantiation.  ANSI/ISO C++
1974 conforming programs must not rely on a maximum depth greater than 17
1975 (changed to 1024 in C++0x).
1976
1977 @item -fno-threadsafe-statics
1978 @opindex fno-threadsafe-statics
1979 Do not emit the extra code to use the routines specified in the C++
1980 ABI for thread-safe initialization of local statics.  You can use this
1981 option to reduce code size slightly in code that doesn't need to be
1982 thread-safe.
1983
1984 @item -fuse-cxa-atexit
1985 @opindex fuse-cxa-atexit
1986 Register destructors for objects with static storage duration with the
1987 @code{__cxa_atexit} function rather than the @code{atexit} function.
1988 This option is required for fully standards-compliant handling of static
1989 destructors, but will only work if your C library supports
1990 @code{__cxa_atexit}.
1991
1992 @item -fno-use-cxa-get-exception-ptr
1993 @opindex fno-use-cxa-get-exception-ptr
1994 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1995 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1996 if the runtime routine is not available.
1997
1998 @item -fvisibility-inlines-hidden
1999 @opindex fvisibility-inlines-hidden
2000 This switch declares that the user does not attempt to compare
2001 pointers to inline methods where the addresses of the two functions
2002 were taken in different shared objects.
2003
2004 The effect of this is that GCC may, effectively, mark inline methods with
2005 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2006 appear in the export table of a DSO and do not require a PLT indirection
2007 when used within the DSO@.  Enabling this option can have a dramatic effect
2008 on load and link times of a DSO as it massively reduces the size of the
2009 dynamic export table when the library makes heavy use of templates.
2010
2011 The behavior of this switch is not quite the same as marking the
2012 methods as hidden directly, because it does not affect static variables
2013 local to the function or cause the compiler to deduce that
2014 the function is defined in only one shared object.
2015
2016 You may mark a method as having a visibility explicitly to negate the
2017 effect of the switch for that method.  For example, if you do want to
2018 compare pointers to a particular inline method, you might mark it as
2019 having default visibility.  Marking the enclosing class with explicit
2020 visibility will have no effect.
2021
2022 Explicitly instantiated inline methods are unaffected by this option
2023 as their linkage might otherwise cross a shared library boundary.
2024 @xref{Template Instantiation}.
2025
2026 @item -fvisibility-ms-compat
2027 @opindex fvisibility-ms-compat
2028 This flag attempts to use visibility settings to make GCC's C++
2029 linkage model compatible with that of Microsoft Visual Studio.
2030
2031 The flag makes these changes to GCC's linkage model:
2032
2033 @enumerate
2034 @item
2035 It sets the default visibility to @code{hidden}, like
2036 @option{-fvisibility=hidden}.
2037
2038 @item
2039 Types, but not their members, are not hidden by default.
2040
2041 @item
2042 The One Definition Rule is relaxed for types without explicit
2043 visibility specifications which are defined in more than one different
2044 shared object: those declarations are permitted if they would have
2045 been permitted when this option was not used.
2046 @end enumerate
2047
2048 In new code it is better to use @option{-fvisibility=hidden} and
2049 export those classes which are intended to be externally visible.
2050 Unfortunately it is possible for code to rely, perhaps accidentally,
2051 on the Visual Studio behavior.
2052
2053 Among the consequences of these changes are that static data members
2054 of the same type with the same name but defined in different shared
2055 objects will be different, so changing one will not change the other;
2056 and that pointers to function members defined in different shared
2057 objects may not compare equal.  When this flag is given, it is a
2058 violation of the ODR to define types with the same name differently.
2059
2060 @item -fno-weak
2061 @opindex fno-weak
2062 Do not use weak symbol support, even if it is provided by the linker.
2063 By default, G++ will use weak symbols if they are available.  This
2064 option exists only for testing, and should not be used by end-users;
2065 it will result in inferior code and has no benefits.  This option may
2066 be removed in a future release of G++.
2067
2068 @item -nostdinc++
2069 @opindex nostdinc++
2070 Do not search for header files in the standard directories specific to
2071 C++, but do still search the other standard directories.  (This option
2072 is used when building the C++ library.)
2073 @end table
2074
2075 In addition, these optimization, warning, and code generation options
2076 have meanings only for C++ programs:
2077
2078 @table @gcctabopt
2079 @item -fno-default-inline
2080 @opindex fno-default-inline
2081 Do not assume @samp{inline} for functions defined inside a class scope.
2082 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2083 functions will have linkage like inline functions; they just won't be
2084 inlined by default.
2085
2086 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2087 @opindex Wabi
2088 @opindex Wno-abi
2089 Warn when G++ generates code that is probably not compatible with the
2090 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2091 all such cases, there are probably some cases that are not warned about,
2092 even though G++ is generating incompatible code.  There may also be
2093 cases where warnings are emitted even though the code that is generated
2094 will be compatible.
2095
2096 You should rewrite your code to avoid these warnings if you are
2097 concerned about the fact that code generated by G++ may not be binary
2098 compatible with code generated by other compilers.
2099
2100 The known incompatibilities at this point include:
2101
2102 @itemize @bullet
2103
2104 @item
2105 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2106 pack data into the same byte as a base class.  For example:
2107
2108 @smallexample
2109 struct A @{ virtual void f(); int f1 : 1; @};
2110 struct B : public A @{ int f2 : 1; @};
2111 @end smallexample
2112
2113 @noindent
2114 In this case, G++ will place @code{B::f2} into the same byte
2115 as@code{A::f1}; other compilers will not.  You can avoid this problem
2116 by explicitly padding @code{A} so that its size is a multiple of the
2117 byte size on your platform; that will cause G++ and other compilers to
2118 layout @code{B} identically.
2119
2120 @item
2121 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2122 tail padding when laying out virtual bases.  For example:
2123
2124 @smallexample
2125 struct A @{ virtual void f(); char c1; @};
2126 struct B @{ B(); char c2; @};
2127 struct C : public A, public virtual B @{@};
2128 @end smallexample
2129
2130 @noindent
2131 In this case, G++ will not place @code{B} into the tail-padding for
2132 @code{A}; other compilers will.  You can avoid this problem by
2133 explicitly padding @code{A} so that its size is a multiple of its
2134 alignment (ignoring virtual base classes); that will cause G++ and other
2135 compilers to layout @code{C} identically.
2136
2137 @item
2138 Incorrect handling of bit-fields with declared widths greater than that
2139 of their underlying types, when the bit-fields appear in a union.  For
2140 example:
2141
2142 @smallexample
2143 union U @{ int i : 4096; @};
2144 @end smallexample
2145
2146 @noindent
2147 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2148 union too small by the number of bits in an @code{int}.
2149
2150 @item
2151 Empty classes can be placed at incorrect offsets.  For example:
2152
2153 @smallexample
2154 struct A @{@};
2155
2156 struct B @{
2157   A a;
2158   virtual void f ();
2159 @};
2160
2161 struct C : public B, public A @{@};
2162 @end smallexample
2163
2164 @noindent
2165 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2166 it should be placed at offset zero.  G++ mistakenly believes that the
2167 @code{A} data member of @code{B} is already at offset zero.
2168
2169 @item
2170 Names of template functions whose types involve @code{typename} or
2171 template template parameters can be mangled incorrectly.
2172
2173 @smallexample
2174 template <typename Q>
2175 void f(typename Q::X) @{@}
2176
2177 template <template <typename> class Q>
2178 void f(typename Q<int>::X) @{@}
2179 @end smallexample
2180
2181 @noindent
2182 Instantiations of these templates may be mangled incorrectly.
2183
2184 @end itemize
2185
2186 It also warns psABI related changes.  The known psABI changes at this
2187 point include:
2188
2189 @itemize @bullet
2190
2191 @item
2192 For SYSV/x86-64, when passing union with long double, it is changed to
2193 pass in memory as specified in psABI.  For example:
2194
2195 @smallexample
2196 union U @{
2197   long double ld;
2198   int i;
2199 @};
2200 @end smallexample
2201
2202 @noindent
2203 @code{union U} will always be passed in memory.
2204
2205 @end itemize
2206
2207 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2208 @opindex Wctor-dtor-privacy
2209 @opindex Wno-ctor-dtor-privacy
2210 Warn when a class seems unusable because all the constructors or
2211 destructors in that class are private, and it has neither friends nor
2212 public static member functions.
2213
2214 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2215 @opindex Wnon-virtual-dtor
2216 @opindex Wno-non-virtual-dtor
2217 Warn when a class has virtual functions and accessible non-virtual
2218 destructor, in which case it would be possible but unsafe to delete
2219 an instance of a derived class through a pointer to the base class.
2220 This warning is also enabled if -Weffc++ is specified.
2221
2222 @item -Wreorder @r{(C++ and Objective-C++ only)}
2223 @opindex Wreorder
2224 @opindex Wno-reorder
2225 @cindex reordering, warning
2226 @cindex warning for reordering of member initializers
2227 Warn when the order of member initializers given in the code does not
2228 match the order in which they must be executed.  For instance:
2229
2230 @smallexample
2231 struct A @{
2232   int i;
2233   int j;
2234   A(): j (0), i (1) @{ @}
2235 @};
2236 @end smallexample
2237
2238 The compiler will rearrange the member initializers for @samp{i}
2239 and @samp{j} to match the declaration order of the members, emitting
2240 a warning to that effect.  This warning is enabled by @option{-Wall}.
2241 @end table
2242
2243 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2244
2245 @table @gcctabopt
2246 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2247 @opindex Weffc++
2248 @opindex Wno-effc++
2249 Warn about violations of the following style guidelines from Scott Meyers'
2250 @cite{Effective C++} book:
2251
2252 @itemize @bullet
2253 @item
2254 Item 11:  Define a copy constructor and an assignment operator for classes
2255 with dynamically allocated memory.
2256
2257 @item
2258 Item 12:  Prefer initialization to assignment in constructors.
2259
2260 @item
2261 Item 14:  Make destructors virtual in base classes.
2262
2263 @item
2264 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2265
2266 @item
2267 Item 23:  Don't try to return a reference when you must return an object.
2268
2269 @end itemize
2270
2271 Also warn about violations of the following style guidelines from
2272 Scott Meyers' @cite{More Effective C++} book:
2273
2274 @itemize @bullet
2275 @item
2276 Item 6:  Distinguish between prefix and postfix forms of increment and
2277 decrement operators.
2278
2279 @item
2280 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2281
2282 @end itemize
2283
2284 When selecting this option, be aware that the standard library
2285 headers do not obey all of these guidelines; use @samp{grep -v}
2286 to filter out those warnings.
2287
2288 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2289 @opindex Wstrict-null-sentinel
2290 @opindex Wno-strict-null-sentinel
2291 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2292 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2293 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2294 it is guaranteed to be of the same size as a pointer.  But this use is
2295 not portable across different compilers.
2296
2297 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2298 @opindex Wno-non-template-friend
2299 @opindex Wnon-template-friend
2300 Disable warnings when non-templatized friend functions are declared
2301 within a template.  Since the advent of explicit template specification
2302 support in G++, if the name of the friend is an unqualified-id (i.e.,
2303 @samp{friend foo(int)}), the C++ language specification demands that the
2304 friend declare or define an ordinary, nontemplate function.  (Section
2305 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2306 could be interpreted as a particular specialization of a templatized
2307 function.  Because this non-conforming behavior is no longer the default
2308 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2309 check existing code for potential trouble spots and is on by default.
2310 This new compiler behavior can be turned off with
2311 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2312 but disables the helpful warning.
2313
2314 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2315 @opindex Wold-style-cast
2316 @opindex Wno-old-style-cast
2317 Warn if an old-style (C-style) cast to a non-void type is used within
2318 a C++ program.  The new-style casts (@samp{dynamic_cast},
2319 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2320 less vulnerable to unintended effects and much easier to search for.
2321
2322 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2323 @opindex Woverloaded-virtual
2324 @opindex Wno-overloaded-virtual
2325 @cindex overloaded virtual fn, warning
2326 @cindex warning for overloaded virtual fn
2327 Warn when a function declaration hides virtual functions from a
2328 base class.  For example, in:
2329
2330 @smallexample
2331 struct A @{
2332   virtual void f();
2333 @};
2334
2335 struct B: public A @{
2336   void f(int);
2337 @};
2338 @end smallexample
2339
2340 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2341 like:
2342
2343 @smallexample
2344 B* b;
2345 b->f();
2346 @end smallexample
2347
2348 will fail to compile.
2349
2350 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2351 @opindex Wno-pmf-conversions
2352 @opindex Wpmf-conversions
2353 Disable the diagnostic for converting a bound pointer to member function
2354 to a plain pointer.
2355
2356 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2357 @opindex Wsign-promo
2358 @opindex Wno-sign-promo
2359 Warn when overload resolution chooses a promotion from unsigned or
2360 enumerated type to a signed type, over a conversion to an unsigned type of
2361 the same size.  Previous versions of G++ would try to preserve
2362 unsignedness, but the standard mandates the current behavior.
2363
2364 @smallexample
2365 struct A @{
2366   operator int ();
2367   A& operator = (int);
2368 @};
2369
2370 main ()
2371 @{
2372   A a,b;
2373   a = b;
2374 @}
2375 @end smallexample
2376
2377 In this example, G++ will synthesize a default @samp{A& operator =
2378 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2379 @end table
2380
2381 @node Objective-C and Objective-C++ Dialect Options
2382 @section Options Controlling Objective-C and Objective-C++ Dialects
2383
2384 @cindex compiler options, Objective-C and Objective-C++
2385 @cindex Objective-C and Objective-C++ options, command line
2386 @cindex options, Objective-C and Objective-C++
2387 (NOTE: This manual does not describe the Objective-C and Objective-C++
2388 languages themselves.  See @xref{Standards,,Language Standards
2389 Supported by GCC}, for references.)
2390
2391 This section describes the command-line options that are only meaningful
2392 for Objective-C and Objective-C++ programs, but you can also use most of
2393 the language-independent GNU compiler options.
2394 For example, you might compile a file @code{some_class.m} like this:
2395
2396 @smallexample
2397 gcc -g -fgnu-runtime -O -c some_class.m
2398 @end smallexample
2399
2400 @noindent
2401 In this example, @option{-fgnu-runtime} is an option meant only for
2402 Objective-C and Objective-C++ programs; you can use the other options with
2403 any language supported by GCC@.
2404
2405 Note that since Objective-C is an extension of the C language, Objective-C
2406 compilations may also use options specific to the C front-end (e.g.,
2407 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2408 C++-specific options (e.g., @option{-Wabi}).
2409
2410 Here is a list of options that are @emph{only} for compiling Objective-C
2411 and Objective-C++ programs:
2412
2413 @table @gcctabopt
2414 @item -fconstant-string-class=@var{class-name}
2415 @opindex fconstant-string-class
2416 Use @var{class-name} as the name of the class to instantiate for each
2417 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2418 class name is @code{NXConstantString} if the GNU runtime is being used, and
2419 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2420 @option{-fconstant-cfstrings} option, if also present, will override the
2421 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2422 to be laid out as constant CoreFoundation strings.
2423
2424 @item -fgnu-runtime
2425 @opindex fgnu-runtime
2426 Generate object code compatible with the standard GNU Objective-C
2427 runtime.  This is the default for most types of systems.
2428
2429 @item -fnext-runtime
2430 @opindex fnext-runtime
2431 Generate output compatible with the NeXT runtime.  This is the default
2432 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2433 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2434 used.
2435
2436 @item -fno-nil-receivers
2437 @opindex fno-nil-receivers
2438 Assume that all Objective-C message dispatches (e.g.,
2439 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2440 is not @code{nil}.  This allows for more efficient entry points in the runtime
2441 to be used.  Currently, this option is only available in conjunction with
2442 the NeXT runtime on Mac OS X 10.3 and later.
2443
2444 @item -fobjc-call-cxx-cdtors
2445 @opindex fobjc-call-cxx-cdtors
2446 For each Objective-C class, check if any of its instance variables is a
2447 C++ object with a non-trivial default constructor.  If so, synthesize a
2448 special @code{- (id) .cxx_construct} instance method that will run
2449 non-trivial default constructors on any such instance variables, in order,
2450 and then return @code{self}.  Similarly, check if any instance variable
2451 is a C++ object with a non-trivial destructor, and if so, synthesize a
2452 special @code{- (void) .cxx_destruct} method that will run
2453 all such default destructors, in reverse order.
2454
2455 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2456 thusly generated will only operate on instance variables declared in the
2457 current Objective-C class, and not those inherited from superclasses.  It
2458 is the responsibility of the Objective-C runtime to invoke all such methods
2459 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2460 will be invoked by the runtime immediately after a new object
2461 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2462 be invoked immediately before the runtime deallocates an object instance.
2463
2464 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2465 support for invoking the @code{- (id) .cxx_construct} and
2466 @code{- (void) .cxx_destruct} methods.
2467
2468 @item -fobjc-direct-dispatch
2469 @opindex fobjc-direct-dispatch
2470 Allow fast jumps to the message dispatcher.  On Darwin this is
2471 accomplished via the comm page.
2472
2473 @item -fobjc-exceptions
2474 @opindex fobjc-exceptions
2475 Enable syntactic support for structured exception handling in Objective-C,
2476 similar to what is offered by C++ and Java.  This option is
2477 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2478 earlier.
2479
2480 @smallexample
2481   @@try @{
2482     @dots{}
2483        @@throw expr;
2484     @dots{}
2485   @}
2486   @@catch (AnObjCClass *exc) @{
2487     @dots{}
2488       @@throw expr;
2489     @dots{}
2490       @@throw;
2491     @dots{}
2492   @}
2493   @@catch (AnotherClass *exc) @{
2494     @dots{}
2495   @}
2496   @@catch (id allOthers) @{
2497     @dots{}
2498   @}
2499   @@finally @{
2500     @dots{}
2501       @@throw expr;
2502     @dots{}
2503   @}
2504 @end smallexample
2505
2506 The @code{@@throw} statement may appear anywhere in an Objective-C or
2507 Objective-C++ program; when used inside of a @code{@@catch} block, the
2508 @code{@@throw} may appear without an argument (as shown above), in which case
2509 the object caught by the @code{@@catch} will be rethrown.
2510
2511 Note that only (pointers to) Objective-C objects may be thrown and
2512 caught using this scheme.  When an object is thrown, it will be caught
2513 by the nearest @code{@@catch} clause capable of handling objects of that type,
2514 analogously to how @code{catch} blocks work in C++ and Java.  A
2515 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2516 any and all Objective-C exceptions not caught by previous @code{@@catch}
2517 clauses (if any).
2518
2519 The @code{@@finally} clause, if present, will be executed upon exit from the
2520 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2521 regardless of whether any exceptions are thrown, caught or rethrown
2522 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2523 of the @code{finally} clause in Java.
2524
2525 There are several caveats to using the new exception mechanism:
2526
2527 @itemize @bullet
2528 @item
2529 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2530 idioms provided by the @code{NSException} class, the new
2531 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2532 systems, due to additional functionality needed in the (NeXT) Objective-C
2533 runtime.
2534
2535 @item
2536 As mentioned above, the new exceptions do not support handling
2537 types other than Objective-C objects.   Furthermore, when used from
2538 Objective-C++, the Objective-C exception model does not interoperate with C++
2539 exceptions at this time.  This means you cannot @code{@@throw} an exception
2540 from Objective-C and @code{catch} it in C++, or vice versa
2541 (i.e., @code{throw @dots{} @@catch}).
2542 @end itemize
2543
2544 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2545 blocks for thread-safe execution:
2546
2547 @smallexample
2548   @@synchronized (ObjCClass *guard) @{
2549     @dots{}
2550   @}
2551 @end smallexample
2552
2553 Upon entering the @code{@@synchronized} block, a thread of execution shall
2554 first check whether a lock has been placed on the corresponding @code{guard}
2555 object by another thread.  If it has, the current thread shall wait until
2556 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2557 the current thread will place its own lock on it, execute the code contained in
2558 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2559 making @code{guard} available to other threads).
2560
2561 Unlike Java, Objective-C does not allow for entire methods to be marked
2562 @code{@@synchronized}.  Note that throwing exceptions out of
2563 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2564 to be unlocked properly.
2565
2566 @item -fobjc-gc
2567 @opindex fobjc-gc
2568 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2569
2570 @item -freplace-objc-classes
2571 @opindex freplace-objc-classes
2572 Emit a special marker instructing @command{ld(1)} not to statically link in
2573 the resulting object file, and allow @command{dyld(1)} to load it in at
2574 run time instead.  This is used in conjunction with the Fix-and-Continue
2575 debugging mode, where the object file in question may be recompiled and
2576 dynamically reloaded in the course of program execution, without the need
2577 to restart the program itself.  Currently, Fix-and-Continue functionality
2578 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2579 and later.
2580
2581 @item -fzero-link
2582 @opindex fzero-link
2583 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2584 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2585 compile time) with static class references that get initialized at load time,
2586 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2587 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2588 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2589 for individual class implementations to be modified during program execution.
2590
2591 @item -gen-decls
2592 @opindex gen-decls
2593 Dump interface declarations for all classes seen in the source file to a
2594 file named @file{@var{sourcename}.decl}.
2595
2596 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2597 @opindex Wassign-intercept
2598 @opindex Wno-assign-intercept
2599 Warn whenever an Objective-C assignment is being intercepted by the
2600 garbage collector.
2601
2602 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2603 @opindex Wno-protocol
2604 @opindex Wprotocol
2605 If a class is declared to implement a protocol, a warning is issued for
2606 every method in the protocol that is not implemented by the class.  The
2607 default behavior is to issue a warning for every method not explicitly
2608 implemented in the class, even if a method implementation is inherited
2609 from the superclass.  If you use the @option{-Wno-protocol} option, then
2610 methods inherited from the superclass are considered to be implemented,
2611 and no warning is issued for them.
2612
2613 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2614 @opindex Wselector
2615 @opindex Wno-selector
2616 Warn if multiple methods of different types for the same selector are
2617 found during compilation.  The check is performed on the list of methods
2618 in the final stage of compilation.  Additionally, a check is performed
2619 for each selector appearing in a @code{@@selector(@dots{})}
2620 expression, and a corresponding method for that selector has been found
2621 during compilation.  Because these checks scan the method table only at
2622 the end of compilation, these warnings are not produced if the final
2623 stage of compilation is not reached, for example because an error is
2624 found during compilation, or because the @option{-fsyntax-only} option is
2625 being used.
2626
2627 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2628 @opindex Wstrict-selector-match
2629 @opindex Wno-strict-selector-match
2630 Warn if multiple methods with differing argument and/or return types are
2631 found for a given selector when attempting to send a message using this
2632 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2633 is off (which is the default behavior), the compiler will omit such warnings
2634 if any differences found are confined to types which share the same size
2635 and alignment.
2636
2637 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2638 @opindex Wundeclared-selector
2639 @opindex Wno-undeclared-selector
2640 Warn if a @code{@@selector(@dots{})} expression referring to an
2641 undeclared selector is found.  A selector is considered undeclared if no
2642 method with that name has been declared before the
2643 @code{@@selector(@dots{})} expression, either explicitly in an
2644 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2645 an @code{@@implementation} section.  This option always performs its
2646 checks as soon as a @code{@@selector(@dots{})} expression is found,
2647 while @option{-Wselector} only performs its checks in the final stage of
2648 compilation.  This also enforces the coding style convention
2649 that methods and selectors must be declared before being used.
2650
2651 @item -print-objc-runtime-info
2652 @opindex print-objc-runtime-info
2653 Generate C header describing the largest structure that is passed by
2654 value, if any.
2655
2656 @end table
2657
2658 @node Language Independent Options
2659 @section Options to Control Diagnostic Messages Formatting
2660 @cindex options to control diagnostics formatting
2661 @cindex diagnostic messages
2662 @cindex message formatting
2663
2664 Traditionally, diagnostic messages have been formatted irrespective of
2665 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2666 below can be used to control the diagnostic messages formatting
2667 algorithm, e.g.@: how many characters per line, how often source location
2668 information should be reported.  Right now, only the C++ front end can
2669 honor these options.  However it is expected, in the near future, that
2670 the remaining front ends would be able to digest them correctly.
2671
2672 @table @gcctabopt
2673 @item -fmessage-length=@var{n}
2674 @opindex fmessage-length
2675 Try to format error messages so that they fit on lines of about @var{n}
2676 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2677 the front ends supported by GCC@.  If @var{n} is zero, then no
2678 line-wrapping will be done; each error message will appear on a single
2679 line.
2680
2681 @opindex fdiagnostics-show-location
2682 @item -fdiagnostics-show-location=once
2683 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2684 reporter to emit @emph{once} source location information; that is, in
2685 case the message is too long to fit on a single physical line and has to
2686 be wrapped, the source location won't be emitted (as prefix) again,
2687 over and over, in subsequent continuation lines.  This is the default
2688 behavior.
2689
2690 @item -fdiagnostics-show-location=every-line
2691 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2692 messages reporter to emit the same source location information (as
2693 prefix) for physical lines that result from the process of breaking
2694 a message which is too long to fit on a single line.
2695
2696 @item -fdiagnostics-show-option
2697 @opindex fdiagnostics-show-option
2698 This option instructs the diagnostic machinery to add text to each
2699 diagnostic emitted, which indicates which command line option directly
2700 controls that diagnostic, when such an option is known to the
2701 diagnostic machinery.
2702
2703 @item -Wcoverage-mismatch
2704 @opindex Wcoverage-mismatch
2705 Warn if feedback profiles do not match when using the
2706 @option{-fprofile-use} option.
2707 If a source file was changed between @option{-fprofile-gen} and
2708 @option{-fprofile-use}, the files with the profile feedback can fail
2709 to match the source file and GCC can not use the profile feedback
2710 information.  By default, GCC emits an error message in this case.
2711 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2712 error.  GCC does not use appropriate feedback profiles, so using this
2713 option can result in poorly optimized code.  This option is useful
2714 only in the case of very minor changes such as bug fixes to an
2715 existing code-base.
2716
2717 @end table
2718
2719 @node Warning Options
2720 @section Options to Request or Suppress Warnings
2721 @cindex options to control warnings
2722 @cindex warning messages
2723 @cindex messages, warning
2724 @cindex suppressing warnings
2725
2726 Warnings are diagnostic messages that report constructions which
2727 are not inherently erroneous but which are risky or suggest there
2728 may have been an error.
2729
2730 The following language-independent options do not enable specific
2731 warnings but control the kinds of diagnostics produced by GCC.
2732
2733 @table @gcctabopt
2734 @cindex syntax checking
2735 @item -fsyntax-only
2736 @opindex fsyntax-only
2737 Check the code for syntax errors, but don't do anything beyond that.
2738
2739 @item -w
2740 @opindex w
2741 Inhibit all warning messages.
2742
2743 @item -Werror
2744 @opindex Werror
2745 @opindex Wno-error
2746 Make all warnings into errors.
2747
2748 @item -Werror=
2749 @opindex Werror=
2750 @opindex Wno-error=
2751 Make the specified warning into an error.  The specifier for a warning
2752 is appended, for example @option{-Werror=switch} turns the warnings
2753 controlled by @option{-Wswitch} into errors.  This switch takes a
2754 negative form, to be used to negate @option{-Werror} for specific
2755 warnings, for example @option{-Wno-error=switch} makes
2756 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2757 is in effect.  You can use the @option{-fdiagnostics-show-option}
2758 option to have each controllable warning amended with the option which
2759 controls it, to determine what to use with this option.
2760
2761 Note that specifying @option{-Werror=}@var{foo} automatically implies
2762 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2763 imply anything.
2764
2765 @item -Wfatal-errors
2766 @opindex Wfatal-errors
2767 @opindex Wno-fatal-errors
2768 This option causes the compiler to abort compilation on the first error
2769 occurred rather than trying to keep going and printing further error
2770 messages.
2771
2772 @end table
2773
2774 You can request many specific warnings with options beginning
2775 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2776 implicit declarations.  Each of these specific warning options also
2777 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2778 example, @option{-Wno-implicit}.  This manual lists only one of the
2779 two forms, whichever is not the default.  For further,
2780 language-specific options also refer to @ref{C++ Dialect Options} and
2781 @ref{Objective-C and Objective-C++ Dialect Options}.
2782
2783 @table @gcctabopt
2784 @item -pedantic
2785 @opindex pedantic
2786 Issue all the warnings demanded by strict ISO C and ISO C++;
2787 reject all programs that use forbidden extensions, and some other
2788 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2789 version of the ISO C standard specified by any @option{-std} option used.
2790
2791 Valid ISO C and ISO C++ programs should compile properly with or without
2792 this option (though a rare few will require @option{-ansi} or a
2793 @option{-std} option specifying the required version of ISO C)@.  However,
2794 without this option, certain GNU extensions and traditional C and C++
2795 features are supported as well.  With this option, they are rejected.
2796
2797 @option{-pedantic} does not cause warning messages for use of the
2798 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2799 warnings are also disabled in the expression that follows
2800 @code{__extension__}.  However, only system header files should use
2801 these escape routes; application programs should avoid them.
2802 @xref{Alternate Keywords}.
2803
2804 Some users try to use @option{-pedantic} to check programs for strict ISO
2805 C conformance.  They soon find that it does not do quite what they want:
2806 it finds some non-ISO practices, but not all---only those for which
2807 ISO C @emph{requires} a diagnostic, and some others for which
2808 diagnostics have been added.
2809
2810 A feature to report any failure to conform to ISO C might be useful in
2811 some instances, but would require considerable additional work and would
2812 be quite different from @option{-pedantic}.  We don't have plans to
2813 support such a feature in the near future.
2814
2815 Where the standard specified with @option{-std} represents a GNU
2816 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2817 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2818 extended dialect is based.  Warnings from @option{-pedantic} are given
2819 where they are required by the base standard.  (It would not make sense
2820 for such warnings to be given only for features not in the specified GNU
2821 C dialect, since by definition the GNU dialects of C include all
2822 features the compiler supports with the given option, and there would be
2823 nothing to warn about.)
2824
2825 @item -pedantic-errors
2826 @opindex pedantic-errors
2827 Like @option{-pedantic}, except that errors are produced rather than
2828 warnings.
2829
2830 @item -Wall
2831 @opindex Wall
2832 @opindex Wno-all
2833 This enables all the warnings about constructions that some users
2834 consider questionable, and that are easy to avoid (or modify to
2835 prevent the warning), even in conjunction with macros.  This also
2836 enables some language-specific warnings described in @ref{C++ Dialect
2837 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2838
2839 @option{-Wall} turns on the following warning flags:
2840
2841 @gccoptlist{-Waddress   @gol
2842 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2843 -Wc++0x-compat  @gol
2844 -Wchar-subscripts  @gol
2845 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2846 -Wimplicit-int  @gol
2847 -Wimplicit-function-declaration  @gol
2848 -Wcomment  @gol
2849 -Wformat   @gol
2850 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2851 -Wmissing-braces  @gol
2852 -Wnonnull  @gol
2853 -Wparentheses  @gol
2854 -Wpointer-sign  @gol
2855 -Wreorder   @gol
2856 -Wreturn-type  @gol
2857 -Wsequence-point  @gol
2858 -Wsign-compare @r{(only in C++)}  @gol
2859 -Wstrict-aliasing  @gol
2860 -Wstrict-overflow=1  @gol
2861 -Wswitch  @gol
2862 -Wtrigraphs  @gol
2863 -Wuninitialized  @gol
2864 -Wunknown-pragmas  @gol
2865 -Wunused-function  @gol
2866 -Wunused-label     @gol
2867 -Wunused-value     @gol
2868 -Wunused-variable  @gol
2869 -Wvolatile-register-var @gol
2870 }
2871
2872 Note that some warning flags are not implied by @option{-Wall}.  Some of
2873 them warn about constructions that users generally do not consider
2874 questionable, but which occasionally you might wish to check for;
2875 others warn about constructions that are necessary or hard to avoid in
2876 some cases, and there is no simple way to modify the code to suppress
2877 the warning. Some of them are enabled by @option{-Wextra} but many of
2878 them must be enabled individually.
2879
2880 @item -Wextra
2881 @opindex W
2882 @opindex Wextra
2883 @opindex Wno-extra
2884 This enables some extra warning flags that are not enabled by
2885 @option{-Wall}. (This option used to be called @option{-W}.  The older
2886 name is still supported, but the newer name is more descriptive.)
2887
2888 @gccoptlist{-Wclobbered  @gol
2889 -Wempty-body  @gol
2890 -Wignored-qualifiers @gol
2891 -Wmissing-field-initializers  @gol
2892 -Wmissing-parameter-type @r{(C only)}  @gol
2893 -Wold-style-declaration @r{(C only)}  @gol
2894 -Woverride-init  @gol
2895 -Wsign-compare  @gol
2896 -Wtype-limits  @gol
2897 -Wuninitialized  @gol
2898 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2899 }
2900
2901 The option @option{-Wextra} also prints warning messages for the
2902 following cases:
2903
2904 @itemize @bullet
2905
2906 @item
2907 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2908 @samp{>}, or @samp{>=}.
2909
2910 @item
2911 (C++ only) An enumerator and a non-enumerator both appear in a
2912 conditional expression.
2913
2914 @item
2915 (C++ only) Ambiguous virtual bases.
2916
2917 @item
2918 (C++ only) Subscripting an array which has been declared @samp{register}.
2919
2920 @item
2921 (C++ only) Taking the address of a variable which has been declared
2922 @samp{register}.
2923
2924 @item
2925 (C++ only) A base class is not initialized in a derived class' copy
2926 constructor.
2927
2928 @end itemize
2929
2930 @item -Wchar-subscripts
2931 @opindex Wchar-subscripts
2932 @opindex Wno-char-subscripts
2933 Warn if an array subscript has type @code{char}.  This is a common cause
2934 of error, as programmers often forget that this type is signed on some
2935 machines.
2936 This warning is enabled by @option{-Wall}.
2937
2938 @item -Wcomment
2939 @opindex Wcomment
2940 @opindex Wno-comment
2941 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2942 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2943 This warning is enabled by @option{-Wall}.
2944
2945 @item -Wformat
2946 @opindex Wformat
2947 @opindex Wno-format
2948 @opindex ffreestanding
2949 @opindex fno-builtin
2950 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2951 the arguments supplied have types appropriate to the format string
2952 specified, and that the conversions specified in the format string make
2953 sense.  This includes standard functions, and others specified by format
2954 attributes (@pxref{Function Attributes}), in the @code{printf},
2955 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2956 not in the C standard) families (or other target-specific families).
2957 Which functions are checked without format attributes having been
2958 specified depends on the standard version selected, and such checks of
2959 functions without the attribute specified are disabled by
2960 @option{-ffreestanding} or @option{-fno-builtin}.
2961
2962 The formats are checked against the format features supported by GNU
2963 libc version 2.2.  These include all ISO C90 and C99 features, as well
2964 as features from the Single Unix Specification and some BSD and GNU
2965 extensions.  Other library implementations may not support all these
2966 features; GCC does not support warning about features that go beyond a
2967 particular library's limitations.  However, if @option{-pedantic} is used
2968 with @option{-Wformat}, warnings will be given about format features not
2969 in the selected standard version (but not for @code{strfmon} formats,
2970 since those are not in any version of the C standard).  @xref{C Dialect
2971 Options,,Options Controlling C Dialect}.
2972
2973 Since @option{-Wformat} also checks for null format arguments for
2974 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2975
2976 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2977 aspects of format checking, the options @option{-Wformat-y2k},
2978 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2979 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2980 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2981
2982 @item -Wformat-y2k
2983 @opindex Wformat-y2k
2984 @opindex Wno-format-y2k
2985 If @option{-Wformat} is specified, also warn about @code{strftime}
2986 formats which may yield only a two-digit year.
2987
2988 @item -Wno-format-contains-nul
2989 @opindex Wno-format-contains-nul
2990 @opindex Wformat-contains-nul
2991 If @option{-Wformat} is specified, do not warn about format strings that
2992 contain NUL bytes.
2993
2994 @item -Wno-format-extra-args
2995 @opindex Wno-format-extra-args
2996 @opindex Wformat-extra-args
2997 If @option{-Wformat} is specified, do not warn about excess arguments to a
2998 @code{printf} or @code{scanf} format function.  The C standard specifies
2999 that such arguments are ignored.
3000
3001 Where the unused arguments lie between used arguments that are
3002 specified with @samp{$} operand number specifications, normally
3003 warnings are still given, since the implementation could not know what
3004 type to pass to @code{va_arg} to skip the unused arguments.  However,
3005 in the case of @code{scanf} formats, this option will suppress the
3006 warning if the unused arguments are all pointers, since the Single
3007 Unix Specification says that such unused arguments are allowed.
3008
3009 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3010 @opindex Wno-format-zero-length
3011 @opindex Wformat-zero-length
3012 If @option{-Wformat} is specified, do not warn about zero-length formats.
3013 The C standard specifies that zero-length formats are allowed.
3014
3015 @item -Wformat-nonliteral
3016 @opindex Wformat-nonliteral
3017 @opindex Wno-format-nonliteral
3018 If @option{-Wformat} is specified, also warn if the format string is not a
3019 string literal and so cannot be checked, unless the format function
3020 takes its format arguments as a @code{va_list}.
3021
3022 @item -Wformat-security
3023 @opindex Wformat-security
3024 @opindex Wno-format-security
3025 If @option{-Wformat} is specified, also warn about uses of format
3026 functions that represent possible security problems.  At present, this
3027 warns about calls to @code{printf} and @code{scanf} functions where the
3028 format string is not a string literal and there are no format arguments,
3029 as in @code{printf (foo);}.  This may be a security hole if the format
3030 string came from untrusted input and contains @samp{%n}.  (This is
3031 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3032 in future warnings may be added to @option{-Wformat-security} that are not
3033 included in @option{-Wformat-nonliteral}.)
3034
3035 @item -Wformat=2
3036 @opindex Wformat=2
3037 @opindex Wno-format=2
3038 Enable @option{-Wformat} plus format checks not included in
3039 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3040 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3041
3042 @item -Wnonnull @r{(C and Objective-C only)}
3043 @opindex Wnonnull
3044 @opindex Wno-nonnull
3045 Warn about passing a null pointer for arguments marked as
3046 requiring a non-null value by the @code{nonnull} function attribute.
3047
3048 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3049 can be disabled with the @option{-Wno-nonnull} option.
3050
3051 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3052 @opindex Winit-self
3053 @opindex Wno-init-self
3054 Warn about uninitialized variables which are initialized with themselves.
3055 Note this option can only be used with the @option{-Wuninitialized} option.
3056
3057 For example, GCC will warn about @code{i} being uninitialized in the
3058 following snippet only when @option{-Winit-self} has been specified:
3059 @smallexample
3060 @group
3061 int f()
3062 @{
3063   int i = i;
3064   return i;
3065 @}
3066 @end group
3067 @end smallexample
3068
3069 @item -Wimplicit-int @r{(C and Objective-C only)}
3070 @opindex Wimplicit-int
3071 @opindex Wno-implicit-int
3072 Warn when a declaration does not specify a type.
3073 This warning is enabled by @option{-Wall}.
3074
3075 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3076 @opindex Wimplicit-function-declaration
3077 @opindex Wno-implicit-function-declaration
3078 Give a warning whenever a function is used before being declared. In
3079 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3080 enabled by default and it is made into an error by
3081 @option{-pedantic-errors}. This warning is also enabled by
3082 @option{-Wall}.
3083
3084 @item -Wimplicit
3085 @opindex Wimplicit
3086 @opindex Wno-implicit
3087 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3088 This warning is enabled by @option{-Wall}.
3089
3090 @item -Wignored-qualifiers @r{(C and C++ only)}
3091 @opindex Wignored-qualifiers
3092 @opindex Wno-ignored-qualifiers
3093 Warn if the return type of a function has a type qualifier
3094 such as @code{const}.  For ISO C such a type qualifier has no effect,
3095 since the value returned by a function is not an lvalue.
3096 For C++, the warning is only emitted for scalar types or @code{void}.
3097 ISO C prohibits qualified @code{void} return types on function
3098 definitions, so such return types always receive a warning
3099 even without this option.
3100
3101 This warning is also enabled by @option{-Wextra}.
3102
3103 @item -Wmain
3104 @opindex Wmain
3105 @opindex Wno-main
3106 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3107 a function with external linkage, returning int, taking either zero
3108 arguments, two, or three arguments of appropriate types.  This warning
3109 is enabled by default in C++ and is enabled by either @option{-Wall}
3110 or @option{-pedantic}.
3111
3112 @item -Wmissing-braces
3113 @opindex Wmissing-braces
3114 @opindex Wno-missing-braces
3115 Warn if an aggregate or union initializer is not fully bracketed.  In
3116 the following example, the initializer for @samp{a} is not fully
3117 bracketed, but that for @samp{b} is fully bracketed.
3118
3119 @smallexample
3120 int a[2][2] = @{ 0, 1, 2, 3 @};
3121 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3122 @end smallexample
3123
3124 This warning is enabled by @option{-Wall}.
3125
3126 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3127 @opindex Wmissing-include-dirs
3128 @opindex Wno-missing-include-dirs
3129 Warn if a user-supplied include directory does not exist.
3130
3131 @item -Wparentheses
3132 @opindex Wparentheses
3133 @opindex Wno-parentheses
3134 Warn if parentheses are omitted in certain contexts, such
3135 as when there is an assignment in a context where a truth value
3136 is expected, or when operators are nested whose precedence people
3137 often get confused about.
3138
3139 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3140 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3141 interpretation from that of ordinary mathematical notation.
3142
3143 Also warn about constructions where there may be confusion to which
3144 @code{if} statement an @code{else} branch belongs.  Here is an example of
3145 such a case:
3146
3147 @smallexample
3148 @group
3149 @{
3150   if (a)
3151     if (b)
3152       foo ();
3153   else
3154     bar ();
3155 @}
3156 @end group
3157 @end smallexample
3158
3159 In C/C++, every @code{else} branch belongs to the innermost possible
3160 @code{if} statement, which in this example is @code{if (b)}.  This is
3161 often not what the programmer expected, as illustrated in the above
3162 example by indentation the programmer chose.  When there is the
3163 potential for this confusion, GCC will issue a warning when this flag
3164 is specified.  To eliminate the warning, add explicit braces around
3165 the innermost @code{if} statement so there is no way the @code{else}
3166 could belong to the enclosing @code{if}.  The resulting code would
3167 look like this:
3168
3169 @smallexample
3170 @group
3171 @{
3172   if (a)
3173     @{
3174       if (b)
3175         foo ();
3176       else
3177         bar ();
3178     @}
3179 @}
3180 @end group
3181 @end smallexample
3182
3183 This warning is enabled by @option{-Wall}.
3184
3185 @item -Wsequence-point
3186 @opindex Wsequence-point
3187 @opindex Wno-sequence-point
3188 Warn about code that may have undefined semantics because of violations
3189 of sequence point rules in the C and C++ standards.
3190
3191 The C and C++ standards defines the order in which expressions in a C/C++
3192 program are evaluated in terms of @dfn{sequence points}, which represent
3193 a partial ordering between the execution of parts of the program: those
3194 executed before the sequence point, and those executed after it.  These
3195 occur after the evaluation of a full expression (one which is not part
3196 of a larger expression), after the evaluation of the first operand of a
3197 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3198 function is called (but after the evaluation of its arguments and the
3199 expression denoting the called function), and in certain other places.
3200 Other than as expressed by the sequence point rules, the order of
3201 evaluation of subexpressions of an expression is not specified.  All
3202 these rules describe only a partial order rather than a total order,
3203 since, for example, if two functions are called within one expression
3204 with no sequence point between them, the order in which the functions
3205 are called is not specified.  However, the standards committee have
3206 ruled that function calls do not overlap.
3207
3208 It is not specified when between sequence points modifications to the
3209 values of objects take effect.  Programs whose behavior depends on this
3210 have undefined behavior; the C and C++ standards specify that ``Between
3211 the previous and next sequence point an object shall have its stored
3212 value modified at most once by the evaluation of an expression.
3213 Furthermore, the prior value shall be read only to determine the value
3214 to be stored.''.  If a program breaks these rules, the results on any
3215 particular implementation are entirely unpredictable.
3216
3217 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3218 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3219 diagnosed by this option, and it may give an occasional false positive
3220 result, but in general it has been found fairly effective at detecting
3221 this sort of problem in programs.
3222
3223 The standard is worded confusingly, therefore there is some debate
3224 over the precise meaning of the sequence point rules in subtle cases.
3225 Links to discussions of the problem, including proposed formal
3226 definitions, may be found on the GCC readings page, at
3227 @w{@uref{http://gcc.gnu.org/readings.html}}.
3228
3229 This warning is enabled by @option{-Wall} for C and C++.
3230
3231 @item -Wreturn-type
3232 @opindex Wreturn-type
3233 @opindex Wno-return-type
3234 Warn whenever a function is defined with a return-type that defaults
3235 to @code{int}.  Also warn about any @code{return} statement with no
3236 return-value in a function whose return-type is not @code{void}
3237 (falling off the end of the function body is considered returning
3238 without a value), and about a @code{return} statement with an
3239 expression in a function whose return-type is @code{void}.
3240
3241 For C++, a function without return type always produces a diagnostic
3242 message, even when @option{-Wno-return-type} is specified.  The only
3243 exceptions are @samp{main} and functions defined in system headers.
3244
3245 This warning is enabled by @option{-Wall}.
3246
3247 @item -Wswitch
3248 @opindex Wswitch
3249 @opindex Wno-switch
3250 Warn whenever a @code{switch} statement has an index of enumerated type
3251 and lacks a @code{case} for one or more of the named codes of that
3252 enumeration.  (The presence of a @code{default} label prevents this
3253 warning.)  @code{case} labels outside the enumeration range also
3254 provoke warnings when this option is used (even if there is a
3255 @code{default} label).
3256 This warning is enabled by @option{-Wall}.
3257
3258 @item -Wswitch-default
3259 @opindex Wswitch-default
3260 @opindex Wno-switch-default
3261 Warn whenever a @code{switch} statement does not have a @code{default}
3262 case.
3263
3264 @item -Wswitch-enum
3265 @opindex Wswitch-enum
3266 @opindex Wno-switch-enum
3267 Warn whenever a @code{switch} statement has an index of enumerated type
3268 and lacks a @code{case} for one or more of the named codes of that
3269 enumeration.  @code{case} labels outside the enumeration range also
3270 provoke warnings when this option is used.  The only difference
3271 between @option{-Wswitch} and this option is that this option gives a
3272 warning about an omitted enumeration code even if there is a
3273 @code{default} label.
3274
3275 @item -Wsync-nand @r{(C and C++ only)}
3276 @opindex Wsync-nand
3277 @opindex Wno-sync-nand
3278 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3279 built-in functions are used.  These functions changed semantics in GCC 4.4.
3280
3281 @item -Wtrigraphs
3282 @opindex Wtrigraphs
3283 @opindex Wno-trigraphs
3284 Warn if any trigraphs are encountered that might change the meaning of
3285 the program (trigraphs within comments are not warned about).
3286 This warning is enabled by @option{-Wall}.
3287
3288 @item -Wunused-function
3289 @opindex Wunused-function
3290 @opindex Wno-unused-function
3291 Warn whenever a static function is declared but not defined or a
3292 non-inline static function is unused.
3293 This warning is enabled by @option{-Wall}.
3294
3295 @item -Wunused-label
3296 @opindex Wunused-label
3297 @opindex Wno-unused-label
3298 Warn whenever a label is declared but not used.
3299 This warning is enabled by @option{-Wall}.
3300
3301 To suppress this warning use the @samp{unused} attribute
3302 (@pxref{Variable Attributes}).
3303
3304 @item -Wunused-parameter
3305 @opindex Wunused-parameter
3306 @opindex Wno-unused-parameter
3307 Warn whenever a function parameter is unused aside from its declaration.
3308
3309 To suppress this warning use the @samp{unused} attribute
3310 (@pxref{Variable Attributes}).
3311
3312 @item -Wno-unused-result
3313 @opindex Wunused-result
3314 @opindex Wno-unused-result
3315 Do not warn if a caller of a function marked with attribute
3316 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3317 its return value. The default is @option{-Wunused-result}.
3318
3319 @item -Wunused-variable
3320 @opindex Wunused-variable
3321 @opindex Wno-unused-variable
3322 Warn whenever a local variable or non-constant static variable is unused
3323 aside from its declaration.
3324 This warning is enabled by @option{-Wall}.
3325
3326 To suppress this warning use the @samp{unused} attribute
3327 (@pxref{Variable Attributes}).
3328
3329 @item -Wunused-value
3330 @opindex Wunused-value
3331 @opindex Wno-unused-value
3332 Warn whenever a statement computes a result that is explicitly not
3333 used. To suppress this warning cast the unused expression to
3334 @samp{void}. This includes an expression-statement or the left-hand
3335 side of a comma expression that contains no side effects. For example,
3336 an expression such as @samp{x[i,j]} will cause a warning, while
3337 @samp{x[(void)i,j]} will not.
3338
3339 This warning is enabled by @option{-Wall}.
3340
3341 @item -Wunused
3342 @opindex Wunused
3343 @opindex Wno-unused
3344 All the above @option{-Wunused} options combined.
3345
3346 In order to get a warning about an unused function parameter, you must
3347 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3348 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3349
3350 @item -Wuninitialized
3351 @opindex Wuninitialized
3352 @opindex Wno-uninitialized
3353 Warn if an automatic variable is used without first being initialized
3354 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3355 warn if a non-static reference or non-static @samp{const} member
3356 appears in a class without constructors.
3357
3358 If you want to warn about code which uses the uninitialized value of the
3359 variable in its own initializer, use the @option{-Winit-self} option.
3360
3361 These warnings occur for individual uninitialized or clobbered
3362 elements of structure, union or array variables as well as for
3363 variables which are uninitialized or clobbered as a whole.  They do
3364 not occur for variables or elements declared @code{volatile}.  Because
3365 these warnings depend on optimization, the exact variables or elements
3366 for which there are warnings will depend on the precise optimization
3367 options and version of GCC used.
3368
3369 Note that there may be no warning about a variable that is used only
3370 to compute a value that itself is never used, because such
3371 computations may be deleted by data flow analysis before the warnings
3372 are printed.
3373
3374 These warnings are made optional because GCC is not smart
3375 enough to see all the reasons why the code might be correct
3376 despite appearing to have an error.  Here is one example of how
3377 this can happen:
3378
3379 @smallexample
3380 @group
3381 @{
3382   int x;
3383   switch (y)
3384     @{
3385     case 1: x = 1;
3386       break;
3387     case 2: x = 4;
3388       break;
3389     case 3: x = 5;
3390     @}
3391   foo (x);
3392 @}
3393 @end group
3394 @end smallexample
3395
3396 @noindent
3397 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3398 always initialized, but GCC doesn't know this.  Here is
3399 another common case:
3400
3401 @smallexample
3402 @{
3403   int save_y;
3404   if (change_y) save_y = y, y = new_y;
3405   @dots{}
3406   if (change_y) y = save_y;
3407 @}
3408 @end smallexample
3409
3410 @noindent
3411 This has no bug because @code{save_y} is used only if it is set.
3412
3413 @cindex @code{longjmp} warnings
3414 This option also warns when a non-volatile automatic variable might be
3415 changed by a call to @code{longjmp}.  These warnings as well are possible
3416 only in optimizing compilation.
3417
3418 The compiler sees only the calls to @code{setjmp}.  It cannot know
3419 where @code{longjmp} will be called; in fact, a signal handler could
3420 call it at any point in the code.  As a result, you may get a warning
3421 even when there is in fact no problem because @code{longjmp} cannot
3422 in fact be called at the place which would cause a problem.
3423
3424 Some spurious warnings can be avoided if you declare all the functions
3425 you use that never return as @code{noreturn}.  @xref{Function
3426 Attributes}.
3427
3428 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3429
3430 @item -Wunknown-pragmas
3431 @opindex Wunknown-pragmas
3432 @opindex Wno-unknown-pragmas
3433 @cindex warning for unknown pragmas
3434 @cindex unknown pragmas, warning
3435 @cindex pragmas, warning of unknown
3436 Warn when a #pragma directive is encountered which is not understood by
3437 GCC@.  If this command line option is used, warnings will even be issued
3438 for unknown pragmas in system header files.  This is not the case if
3439 the warnings were only enabled by the @option{-Wall} command line option.
3440
3441 @item -Wno-pragmas
3442 @opindex Wno-pragmas
3443 @opindex Wpragmas
3444 Do not warn about misuses of pragmas, such as incorrect parameters,
3445 invalid syntax, or conflicts between pragmas.  See also
3446 @samp{-Wunknown-pragmas}.
3447
3448 @item -Wstrict-aliasing
3449 @opindex Wstrict-aliasing
3450 @opindex Wno-strict-aliasing
3451 This option is only active when @option{-fstrict-aliasing} is active.
3452 It warns about code which might break the strict aliasing rules that the
3453 compiler is using for optimization.  The warning does not catch all
3454 cases, but does attempt to catch the more common pitfalls.  It is
3455 included in @option{-Wall}.
3456 It is equivalent to @option{-Wstrict-aliasing=3}
3457
3458 @item -Wstrict-aliasing=n
3459 @opindex Wstrict-aliasing=n
3460 @opindex Wno-strict-aliasing=n
3461 This option is only active when @option{-fstrict-aliasing} is active.
3462 It warns about code which might break the strict aliasing rules that the
3463 compiler is using for optimization.
3464 Higher levels correspond to higher accuracy (fewer false positives).
3465 Higher levels also correspond to more effort, similar to the way -O works.
3466 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3467 with n=3.
3468
3469 Level 1: Most aggressive, quick, least accurate.
3470 Possibly useful when higher levels
3471 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3472 false negatives.  However, it has many false positives.
3473 Warns for all pointer conversions between possibly incompatible types,
3474 even if never dereferenced.  Runs in the frontend only.
3475
3476 Level 2: Aggressive, quick, not too precise.
3477 May still have many false positives (not as many as level 1 though),
3478 and few false negatives (but possibly more than level 1).
3479 Unlike level 1, it only warns when an address is taken.  Warns about
3480 incomplete types.  Runs in the frontend only.
3481
3482 Level 3 (default for @option{-Wstrict-aliasing}):
3483 Should have very few false positives and few false
3484 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3485 Takes care of the common punn+dereference pattern in the frontend:
3486 @code{*(int*)&some_float}.
3487 If optimization is enabled, it also runs in the backend, where it deals
3488 with multiple statement cases using flow-sensitive points-to information.
3489 Only warns when the converted pointer is dereferenced.
3490 Does not warn about incomplete types.
3491
3492 @item -Wstrict-overflow
3493 @itemx -Wstrict-overflow=@var{n}
3494 @opindex Wstrict-overflow
3495 @opindex Wno-strict-overflow
3496 This option is only active when @option{-fstrict-overflow} is active.
3497 It warns about cases where the compiler optimizes based on the
3498 assumption that signed overflow does not occur.  Note that it does not
3499 warn about all cases where the code might overflow: it only warns
3500 about cases where the compiler implements some optimization.  Thus
3501 this warning depends on the optimization level.
3502
3503 An optimization which assumes that signed overflow does not occur is
3504 perfectly safe if the values of the variables involved are such that
3505 overflow never does, in fact, occur.  Therefore this warning can
3506 easily give a false positive: a warning about code which is not
3507 actually a problem.  To help focus on important issues, several
3508 warning levels are defined.  No warnings are issued for the use of
3509 undefined signed overflow when estimating how many iterations a loop
3510 will require, in particular when determining whether a loop will be
3511 executed at all.
3512
3513 @table @gcctabopt
3514 @item -Wstrict-overflow=1
3515 Warn about cases which are both questionable and easy to avoid.  For
3516 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3517 compiler will simplify this to @code{1}.  This level of
3518 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3519 are not, and must be explicitly requested.
3520
3521 @item -Wstrict-overflow=2
3522 Also warn about other cases where a comparison is simplified to a
3523 constant.  For example: @code{abs (x) >= 0}.  This can only be
3524 simplified when @option{-fstrict-overflow} is in effect, because
3525 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3526 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3527 @option{-Wstrict-overflow=2}.
3528
3529 @item -Wstrict-overflow=3
3530 Also warn about other cases where a comparison is simplified.  For
3531 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3532
3533 @item -Wstrict-overflow=4
3534 Also warn about other simplifications not covered by the above cases.
3535 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3536
3537 @item -Wstrict-overflow=5
3538 Also warn about cases where the compiler reduces the magnitude of a
3539 constant involved in a comparison.  For example: @code{x + 2 > y} will
3540 be simplified to @code{x + 1 >= y}.  This is reported only at the
3541 highest warning level because this simplification applies to many
3542 comparisons, so this warning level will give a very large number of
3543 false positives.
3544 @end table
3545
3546 @item -Warray-bounds
3547 @opindex Wno-array-bounds
3548 @opindex Warray-bounds
3549 This option is only active when @option{-ftree-vrp} is active
3550 (default for -O2 and above). It warns about subscripts to arrays
3551 that are always out of bounds. This warning is enabled by @option{-Wall}.
3552
3553 @item -Wno-div-by-zero
3554 @opindex Wno-div-by-zero
3555 @opindex Wdiv-by-zero
3556 Do not warn about compile-time integer division by zero.  Floating point
3557 division by zero is not warned about, as it can be a legitimate way of
3558 obtaining infinities and NaNs.
3559
3560 @item -Wsystem-headers
3561 @opindex Wsystem-headers
3562 @opindex Wno-system-headers
3563 @cindex warnings from system headers
3564 @cindex system headers, warnings from
3565 Print warning messages for constructs found in system header files.
3566 Warnings from system headers are normally suppressed, on the assumption
3567 that they usually do not indicate real problems and would only make the
3568 compiler output harder to read.  Using this command line option tells
3569 GCC to emit warnings from system headers as if they occurred in user
3570 code.  However, note that using @option{-Wall} in conjunction with this
3571 option will @emph{not} warn about unknown pragmas in system
3572 headers---for that, @option{-Wunknown-pragmas} must also be used.
3573
3574 @item -Wfloat-equal
3575 @opindex Wfloat-equal
3576 @opindex Wno-float-equal
3577 Warn if floating point values are used in equality comparisons.
3578
3579 The idea behind this is that sometimes it is convenient (for the
3580 programmer) to consider floating-point values as approximations to
3581 infinitely precise real numbers.  If you are doing this, then you need
3582 to compute (by analyzing the code, or in some other way) the maximum or
3583 likely maximum error that the computation introduces, and allow for it
3584 when performing comparisons (and when producing output, but that's a
3585 different problem).  In particular, instead of testing for equality, you
3586 would check to see whether the two values have ranges that overlap; and
3587 this is done with the relational operators, so equality comparisons are
3588 probably mistaken.
3589
3590 @item -Wtraditional @r{(C and Objective-C only)}
3591 @opindex Wtraditional
3592 @opindex Wno-traditional
3593 Warn about certain constructs that behave differently in traditional and
3594 ISO C@.  Also warn about ISO C constructs that have no traditional C
3595 equivalent, and/or problematic constructs which should be avoided.
3596
3597 @itemize @bullet
3598 @item
3599 Macro parameters that appear within string literals in the macro body.
3600 In traditional C macro replacement takes place within string literals,
3601 but does not in ISO C@.
3602
3603 @item
3604 In traditional C, some preprocessor directives did not exist.
3605 Traditional preprocessors would only consider a line to be a directive
3606 if the @samp{#} appeared in column 1 on the line.  Therefore
3607 @option{-Wtraditional} warns about directives that traditional C
3608 understands but would ignore because the @samp{#} does not appear as the
3609 first character on the line.  It also suggests you hide directives like
3610 @samp{#pragma} not understood by traditional C by indenting them.  Some
3611 traditional implementations would not recognize @samp{#elif}, so it
3612 suggests avoiding it altogether.
3613
3614 @item
3615 A function-like macro that appears without arguments.
3616
3617 @item
3618 The unary plus operator.
3619
3620 @item
3621 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3622 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3623 constants.)  Note, these suffixes appear in macros defined in the system
3624 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3625 Use of these macros in user code might normally lead to spurious
3626 warnings, however GCC's integrated preprocessor has enough context to
3627 avoid warning in these cases.
3628
3629 @item
3630 A function declared external in one block and then used after the end of
3631 the block.
3632
3633 @item
3634 A @code{switch} statement has an operand of type @code{long}.
3635
3636 @item
3637 A non-@code{static} function declaration follows a @code{static} one.
3638 This construct is not accepted by some traditional C compilers.
3639
3640 @item
3641 The ISO type of an integer constant has a different width or
3642 signedness from its traditional type.  This warning is only issued if
3643 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3644 typically represent bit patterns, are not warned about.
3645
3646 @item
3647 Usage of ISO string concatenation is detected.
3648
3649 @item
3650 Initialization of automatic aggregates.
3651
3652 @item
3653 Identifier conflicts with labels.  Traditional C lacks a separate
3654 namespace for labels.
3655
3656 @item
3657 Initialization of unions.  If the initializer is zero, the warning is
3658 omitted.  This is done under the assumption that the zero initializer in
3659 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3660 initializer warnings and relies on default initialization to zero in the
3661 traditional C case.
3662
3663 @item
3664 Conversions by prototypes between fixed/floating point values and vice
3665 versa.  The absence of these prototypes when compiling with traditional
3666 C would cause serious problems.  This is a subset of the possible
3667 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3668
3669 @item
3670 Use of ISO C style function definitions.  This warning intentionally is
3671 @emph{not} issued for prototype declarations or variadic functions
3672 because these ISO C features will appear in your code when using
3673 libiberty's traditional C compatibility macros, @code{PARAMS} and
3674 @code{VPARAMS}.  This warning is also bypassed for nested functions
3675 because that feature is already a GCC extension and thus not relevant to
3676 traditional C compatibility.
3677 @end itemize
3678
3679 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3680 @opindex Wtraditional-conversion
3681 @opindex Wno-traditional-conversion
3682 Warn if a prototype causes a type conversion that is different from what
3683 would happen to the same argument in the absence of a prototype.  This
3684 includes conversions of fixed point to floating and vice versa, and
3685 conversions changing the width or signedness of a fixed point argument
3686 except when the same as the default promotion.
3687
3688 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3689 @opindex Wdeclaration-after-statement
3690 @opindex Wno-declaration-after-statement
3691 Warn when a declaration is found after a statement in a block.  This
3692 construct, known from C++, was introduced with ISO C99 and is by default
3693 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3694 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3695
3696 @item -Wundef
3697 @opindex Wundef
3698 @opindex Wno-undef
3699 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3700
3701 @item -Wno-endif-labels
3702 @opindex Wno-endif-labels
3703 @opindex Wendif-labels
3704 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3705
3706 @item -Wshadow
3707 @opindex Wshadow
3708 @opindex Wno-shadow
3709 Warn whenever a local variable shadows another local variable, parameter or
3710 global variable or whenever a built-in function is shadowed.
3711
3712 @item -Wlarger-than=@var{len}
3713 @opindex Wlarger-than=@var{len}
3714 @opindex Wlarger-than-@var{len}
3715 Warn whenever an object of larger than @var{len} bytes is defined.
3716
3717 @item -Wframe-larger-than=@var{len}
3718 @opindex Wframe-larger-than
3719 Warn if the size of a function frame is larger than @var{len} bytes.
3720 The computation done to determine the stack frame size is approximate
3721 and not conservative.
3722 The actual requirements may be somewhat greater than @var{len}
3723 even if you do not get a warning.  In addition, any space allocated
3724 via @code{alloca}, variable-length arrays, or related constructs
3725 is not included by the compiler when determining
3726 whether or not to issue a warning.
3727
3728 @item -Wunsafe-loop-optimizations
3729 @opindex Wunsafe-loop-optimizations
3730 @opindex Wno-unsafe-loop-optimizations
3731 Warn if the loop cannot be optimized because the compiler could not
3732 assume anything on the bounds of the loop indices.  With
3733 @option{-funsafe-loop-optimizations} warn if the compiler made
3734 such assumptions.
3735
3736 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3737 @opindex Wno-pedantic-ms-format
3738 @opindex Wpedantic-ms-format
3739 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3740 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3741 depending on the MS runtime, when you are using the options @option{-Wformat}
3742 and @option{-pedantic} without gnu-extensions.
3743
3744 @item -Wpointer-arith
3745 @opindex Wpointer-arith
3746 @opindex Wno-pointer-arith
3747 Warn about anything that depends on the ``size of'' a function type or
3748 of @code{void}.  GNU C assigns these types a size of 1, for
3749 convenience in calculations with @code{void *} pointers and pointers
3750 to functions.  In C++, warn also when an arithmetic operation involves
3751 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3752
3753 @item -Wtype-limits
3754 @opindex Wtype-limits
3755 @opindex Wno-type-limits
3756 Warn if a comparison is always true or always false due to the limited
3757 range of the data type, but do not warn for constant expressions.  For
3758 example, warn if an unsigned variable is compared against zero with
3759 @samp{<} or @samp{>=}.  This warning is also enabled by
3760 @option{-Wextra}.
3761
3762 @item -Wbad-function-cast @r{(C and Objective-C only)}
3763 @opindex Wbad-function-cast
3764 @opindex Wno-bad-function-cast
3765 Warn whenever a function call is cast to a non-matching type.
3766 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3767
3768 @item -Wc++-compat @r{(C and Objective-C only)}
3769 Warn about ISO C constructs that are outside of the common subset of
3770 ISO C and ISO C++, e.g.@: request for implicit conversion from
3771 @code{void *} to a pointer to non-@code{void} type.
3772
3773 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3774 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3775 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3776 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3777
3778 @item -Wcast-qual
3779 @opindex Wcast-qual
3780 @opindex Wno-cast-qual
3781 Warn whenever a pointer is cast so as to remove a type qualifier from
3782 the target type.  For example, warn if a @code{const char *} is cast
3783 to an ordinary @code{char *}.
3784
3785 Also warn when making a cast which introduces a type qualifier in an
3786 unsafe way.  For example, casting @code{char **} to @code{const char **}
3787 is unsafe, as in this example:
3788
3789 @smallexample
3790   /* p is char ** value.  */
3791   const char **q = (const char **) p;
3792   /* Assignment of readonly string to const char * is OK.  */
3793   *q = "string";
3794   /* Now char** pointer points to read-only memory.  */
3795   **p = 'b';
3796 @end smallexample
3797
3798 @item -Wcast-align
3799 @opindex Wcast-align
3800 @opindex Wno-cast-align
3801 Warn whenever a pointer is cast such that the required alignment of the
3802 target is increased.  For example, warn if a @code{char *} is cast to
3803 an @code{int *} on machines where integers can only be accessed at
3804 two- or four-byte boundaries.
3805
3806 @item -Wwrite-strings
3807 @opindex Wwrite-strings
3808 @opindex Wno-write-strings
3809 When compiling C, give string constants the type @code{const
3810 char[@var{length}]} so that copying the address of one into a
3811 non-@code{const} @code{char *} pointer will get a warning.  These
3812 warnings will help you find at compile time code that can try to write
3813 into a string constant, but only if you have been very careful about
3814 using @code{const} in declarations and prototypes.  Otherwise, it will
3815 just be a nuisance. This is why we did not make @option{-Wall} request
3816 these warnings.
3817
3818 When compiling C++, warn about the deprecated conversion from string
3819 literals to @code{char *}.  This warning is enabled by default for C++
3820 programs.
3821
3822 @item -Wclobbered
3823 @opindex Wclobbered
3824 @opindex Wno-clobbered
3825 Warn for variables that might be changed by @samp{longjmp} or
3826 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3827
3828 @item -Wconversion
3829 @opindex Wconversion
3830 @opindex Wno-conversion
3831 Warn for implicit conversions that may alter a value. This includes
3832 conversions between real and integer, like @code{abs (x)} when
3833 @code{x} is @code{double}; conversions between signed and unsigned,
3834 like @code{unsigned ui = -1}; and conversions to smaller types, like
3835 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3836 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3837 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3838 conversions between signed and unsigned integers can be disabled by
3839 using @option{-Wno-sign-conversion}.
3840
3841 For C++, also warn for conversions between @code{NULL} and non-pointer
3842 types; confusing overload resolution for user-defined conversions; and
3843 conversions that will never use a type conversion operator:
3844 conversions to @code{void}, the same type, a base class or a reference
3845 to them. Warnings about conversions between signed and unsigned
3846 integers are disabled by default in C++ unless
3847 @option{-Wsign-conversion} is explicitly enabled.
3848
3849 @item -Wempty-body
3850 @opindex Wempty-body
3851 @opindex Wno-empty-body
3852 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3853 while} statement.  This warning is also enabled by @option{-Wextra}.
3854
3855 @item -Wenum-compare
3856 @opindex Wenum-compare
3857 @opindex Wno-enum-compare
3858 Warn about a comparison between values of different enum types. In C++
3859 this warning is enabled by default.  In C this warning is enabled by
3860 @option{-Wall}.
3861
3862 @item -Wjump-misses-init @r{(C, Objective-C only)}
3863 @opindex Wjump-misses-init
3864 @opindex Wno-jump-misses-init
3865 Warn if a @code{goto} statement or a @code{switch} statement jumps
3866 forward across the initialization of a variable, or jumps backward to a
3867 label after the variable has been initialized.  This only warns about
3868 variables which are initialized when they are declared.  This warning is
3869 only supported for C and Objective C; in C++ this sort of branch is an
3870 error in any case.
3871
3872 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
3873 can be disabled with the @option{-Wno-jump-misses-init} option.
3874
3875 @item -Wsign-compare
3876 @opindex Wsign-compare
3877 @opindex Wno-sign-compare
3878 @cindex warning for comparison of signed and unsigned values
3879 @cindex comparison of signed and unsigned values, warning
3880 @cindex signed and unsigned values, comparison warning
3881 Warn when a comparison between signed and unsigned values could produce
3882 an incorrect result when the signed value is converted to unsigned.
3883 This warning is also enabled by @option{-Wextra}; to get the other warnings
3884 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3885
3886 @item -Wsign-conversion
3887 @opindex Wsign-conversion
3888 @opindex Wno-sign-conversion
3889 Warn for implicit conversions that may change the sign of an integer
3890 value, like assigning a signed integer expression to an unsigned
3891 integer variable. An explicit cast silences the warning. In C, this
3892 option is enabled also by @option{-Wconversion}.
3893
3894 @item -Waddress
3895 @opindex Waddress
3896 @opindex Wno-address
3897 Warn about suspicious uses of memory addresses. These include using
3898 the address of a function in a conditional expression, such as
3899 @code{void func(void); if (func)}, and comparisons against the memory
3900 address of a string literal, such as @code{if (x == "abc")}.  Such
3901 uses typically indicate a programmer error: the address of a function
3902 always evaluates to true, so their use in a conditional usually
3903 indicate that the programmer forgot the parentheses in a function
3904 call; and comparisons against string literals result in unspecified
3905 behavior and are not portable in C, so they usually indicate that the
3906 programmer intended to use @code{strcmp}.  This warning is enabled by
3907 @option{-Wall}.
3908
3909 @item -Wlogical-op
3910 @opindex Wlogical-op
3911 @opindex Wno-logical-op
3912 Warn about suspicious uses of logical operators in expressions.
3913 This includes using logical operators in contexts where a
3914 bit-wise operator is likely to be expected.
3915
3916 @item -Waggregate-return
3917 @opindex Waggregate-return
3918 @opindex Wno-aggregate-return
3919 Warn if any functions that return structures or unions are defined or
3920 called.  (In languages where you can return an array, this also elicits
3921 a warning.)
3922
3923 @item -Wno-attributes
3924 @opindex Wno-attributes
3925 @opindex Wattributes
3926 Do not warn if an unexpected @code{__attribute__} is used, such as
3927 unrecognized attributes, function attributes applied to variables,
3928 etc.  This will not stop errors for incorrect use of supported
3929 attributes.
3930
3931 @item -Wno-builtin-macro-redefined
3932 @opindex Wno-builtin-macro-redefined
3933 @opindex Wbuiltin-macro-redefined
3934 Do not warn if certain built-in macros are redefined.  This suppresses
3935 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
3936 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
3937
3938 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3939 @opindex Wstrict-prototypes
3940 @opindex Wno-strict-prototypes
3941 Warn if a function is declared or defined without specifying the
3942 argument types.  (An old-style function definition is permitted without
3943 a warning if preceded by a declaration which specifies the argument
3944 types.)
3945
3946 @item -Wold-style-declaration @r{(C and Objective-C only)}
3947 @opindex Wold-style-declaration
3948 @opindex Wno-old-style-declaration
3949 Warn for obsolescent usages, according to the C Standard, in a
3950 declaration. For example, warn if storage-class specifiers like
3951 @code{static} are not the first things in a declaration.  This warning
3952 is also enabled by @option{-Wextra}.
3953
3954 @item -Wold-style-definition @r{(C and Objective-C only)}
3955 @opindex Wold-style-definition
3956 @opindex Wno-old-style-definition
3957 Warn if an old-style function definition is used.  A warning is given
3958 even if there is a previous prototype.
3959
3960 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3961 @opindex Wmissing-parameter-type
3962 @opindex Wno-missing-parameter-type
3963 A function parameter is declared without a type specifier in K&R-style
3964 functions:
3965
3966 @smallexample
3967 void foo(bar) @{ @}
3968 @end smallexample
3969
3970 This warning is also enabled by @option{-Wextra}.
3971
3972 @item -Wmissing-prototypes @r{(C and Objective-C only)}
3973 @opindex Wmissing-prototypes
3974 @opindex Wno-missing-prototypes
3975 Warn if a global function is defined without a previous prototype
3976 declaration.  This warning is issued even if the definition itself
3977 provides a prototype.  The aim is to detect global functions that fail
3978 to be declared in header files.
3979
3980 @item -Wmissing-declarations
3981 @opindex Wmissing-declarations
3982 @opindex Wno-missing-declarations
3983 Warn if a global function is defined without a previous declaration.
3984 Do so even if the definition itself provides a prototype.
3985 Use this option to detect global functions that are not declared in
3986 header files.  In C++, no warnings are issued for function templates,
3987 or for inline functions, or for functions in anonymous namespaces.
3988
3989 @item -Wmissing-field-initializers
3990 @opindex Wmissing-field-initializers
3991 @opindex Wno-missing-field-initializers
3992 @opindex W
3993 @opindex Wextra
3994 @opindex Wno-extra
3995 Warn if a structure's initializer has some fields missing.  For
3996 example, the following code would cause such a warning, because
3997 @code{x.h} is implicitly zero:
3998
3999 @smallexample
4000 struct s @{ int f, g, h; @};
4001 struct s x = @{ 3, 4 @};
4002 @end smallexample
4003
4004 This option does not warn about designated initializers, so the following
4005 modification would not trigger a warning:
4006
4007 @smallexample
4008 struct s @{ int f, g, h; @};
4009 struct s x = @{ .f = 3, .g = 4 @};
4010 @end smallexample
4011
4012 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4013 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4014
4015 @item -Wmissing-noreturn
4016 @opindex Wmissing-noreturn
4017 @opindex Wno-missing-noreturn
4018 Warn about functions which might be candidates for attribute @code{noreturn}.
4019 Note these are only possible candidates, not absolute ones.  Care should
4020 be taken to manually verify functions actually do not ever return before
4021 adding the @code{noreturn} attribute, otherwise subtle code generation
4022 bugs could be introduced.  You will not get a warning for @code{main} in
4023 hosted C environments.
4024
4025 @item -Wmissing-format-attribute
4026 @opindex Wmissing-format-attribute
4027 @opindex Wno-missing-format-attribute
4028 @opindex Wformat
4029 @opindex Wno-format
4030 Warn about function pointers which might be candidates for @code{format}
4031 attributes.  Note these are only possible candidates, not absolute ones.
4032 GCC will guess that function pointers with @code{format} attributes that
4033 are used in assignment, initialization, parameter passing or return
4034 statements should have a corresponding @code{format} attribute in the
4035 resulting type.  I.e.@: the left-hand side of the assignment or
4036 initialization, the type of the parameter variable, or the return type
4037 of the containing function respectively should also have a @code{format}
4038 attribute to avoid the warning.
4039
4040 GCC will also warn about function definitions which might be
4041 candidates for @code{format} attributes.  Again, these are only
4042 possible candidates.  GCC will guess that @code{format} attributes
4043 might be appropriate for any function that calls a function like
4044 @code{vprintf} or @code{vscanf}, but this might not always be the
4045 case, and some functions for which @code{format} attributes are
4046 appropriate may not be detected.
4047
4048 @item -Wno-multichar
4049 @opindex Wno-multichar
4050 @opindex Wmultichar
4051 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4052 Usually they indicate a typo in the user's code, as they have
4053 implementation-defined values, and should not be used in portable code.
4054
4055 @item -Wnormalized=<none|id|nfc|nfkc>
4056 @opindex Wnormalized=
4057 @cindex NFC
4058 @cindex NFKC
4059 @cindex character set, input normalization
4060 In ISO C and ISO C++, two identifiers are different if they are
4061 different sequences of characters.  However, sometimes when characters
4062 outside the basic ASCII character set are used, you can have two
4063 different character sequences that look the same.  To avoid confusion,
4064 the ISO 10646 standard sets out some @dfn{normalization rules} which
4065 when applied ensure that two sequences that look the same are turned into
4066 the same sequence.  GCC can warn you if you are using identifiers which
4067 have not been normalized; this option controls that warning.
4068
4069 There are four levels of warning that GCC supports.  The default is
4070 @option{-Wnormalized=nfc}, which warns about any identifier which is
4071 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4072 recommended form for most uses.
4073
4074 Unfortunately, there are some characters which ISO C and ISO C++ allow
4075 in identifiers that when turned into NFC aren't allowable as
4076 identifiers.  That is, there's no way to use these symbols in portable
4077 ISO C or C++ and have all your identifiers in NFC@.
4078 @option{-Wnormalized=id} suppresses the warning for these characters.
4079 It is hoped that future versions of the standards involved will correct
4080 this, which is why this option is not the default.
4081
4082 You can switch the warning off for all characters by writing
4083 @option{-Wnormalized=none}.  You would only want to do this if you
4084 were using some other normalization scheme (like ``D''), because
4085 otherwise you can easily create bugs that are literally impossible to see.
4086
4087 Some characters in ISO 10646 have distinct meanings but look identical
4088 in some fonts or display methodologies, especially once formatting has
4089 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4090 LETTER N'', will display just like a regular @code{n} which has been
4091 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4092 normalization scheme to convert all these into a standard form as
4093 well, and GCC will warn if your code is not in NFKC if you use
4094 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4095 about every identifier that contains the letter O because it might be
4096 confused with the digit 0, and so is not the default, but may be
4097 useful as a local coding convention if the programming environment is
4098 unable to be fixed to display these characters distinctly.
4099
4100 @item -Wno-deprecated
4101 @opindex Wno-deprecated
4102 @opindex Wdeprecated
4103 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4104
4105 @item -Wno-deprecated-declarations
4106 @opindex Wno-deprecated-declarations
4107 @opindex Wdeprecated-declarations
4108 Do not warn about uses of functions (@pxref{Function Attributes}),
4109 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4110 Attributes}) marked as deprecated by using the @code{deprecated}
4111 attribute.
4112
4113 @item -Wno-overflow
4114 @opindex Wno-overflow
4115 @opindex Woverflow
4116 Do not warn about compile-time overflow in constant expressions.
4117
4118 @item -Woverride-init @r{(C and Objective-C only)}
4119 @opindex Woverride-init
4120 @opindex Wno-override-init
4121 @opindex W
4122 @opindex Wextra
4123 @opindex Wno-extra
4124 Warn if an initialized field without side effects is overridden when
4125 using designated initializers (@pxref{Designated Inits, , Designated
4126 Initializers}).
4127
4128 This warning is included in @option{-Wextra}.  To get other
4129 @option{-Wextra} warnings without this one, use @samp{-Wextra
4130 -Wno-override-init}.
4131
4132 @item -Wpacked
4133 @opindex Wpacked
4134 @opindex Wno-packed
4135 Warn if a structure is given the packed attribute, but the packed
4136 attribute has no effect on the layout or size of the structure.
4137 Such structures may be mis-aligned for little benefit.  For
4138 instance, in this code, the variable @code{f.x} in @code{struct bar}
4139 will be misaligned even though @code{struct bar} does not itself
4140 have the packed attribute:
4141
4142 @smallexample
4143 @group
4144 struct foo @{
4145   int x;
4146   char a, b, c, d;
4147 @} __attribute__((packed));
4148 struct bar @{
4149   char z;
4150   struct foo f;
4151 @};
4152 @end group
4153 @end smallexample
4154
4155 @item -Wpacked-bitfield-compat
4156 @opindex Wpacked-bitfield-compat
4157 @opindex Wno-packed-bitfield-compat
4158 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4159 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4160 the change can lead to differences in the structure layout.  GCC
4161 informs you when the offset of such a field has changed in GCC 4.4.
4162 For example there is no longer a 4-bit padding between field @code{a}
4163 and @code{b} in this structure:
4164
4165 @smallexample
4166 struct foo
4167 @{
4168   char a:4;
4169   char b:8;
4170 @} __attribute__ ((packed));
4171 @end smallexample
4172
4173 This warning is enabled by default.  Use
4174 @option{-Wno-packed-bitfield-compat} to disable this warning.
4175
4176 @item -Wpadded
4177 @opindex Wpadded
4178 @opindex Wno-padded
4179 Warn if padding is included in a structure, either to align an element
4180 of the structure or to align the whole structure.  Sometimes when this
4181 happens it is possible to rearrange the fields of the structure to
4182 reduce the padding and so make the structure smaller.
4183
4184 @item -Wredundant-decls
4185 @opindex Wredundant-decls
4186 @opindex Wno-redundant-decls
4187 Warn if anything is declared more than once in the same scope, even in
4188 cases where multiple declaration is valid and changes nothing.
4189
4190 @item -Wnested-externs @r{(C and Objective-C only)}
4191 @opindex Wnested-externs
4192 @opindex Wno-nested-externs
4193 Warn if an @code{extern} declaration is encountered within a function.
4194
4195 @item -Wunreachable-code
4196 @opindex Wunreachable-code
4197 @opindex Wno-unreachable-code
4198 Warn if the compiler detects that code will never be executed.
4199
4200 This option is intended to warn when the compiler detects that at
4201 least a whole line of source code will never be executed, because
4202 some condition is never satisfied or because it is after a
4203 procedure that never returns.
4204
4205 It is possible for this option to produce a warning even though there
4206 are circumstances under which part of the affected line can be executed,
4207 so care should be taken when removing apparently-unreachable code.
4208
4209 For instance, when a function is inlined, a warning may mean that the
4210 line is unreachable in only one inlined copy of the function.
4211
4212 This option is not made part of @option{-Wall} because in a debugging
4213 version of a program there is often substantial code which checks
4214 correct functioning of the program and is, hopefully, unreachable
4215 because the program does work.  Another common use of unreachable
4216 code is to provide behavior which is selectable at compile-time.
4217
4218 @item -Winline
4219 @opindex Winline
4220 @opindex Wno-inline
4221 Warn if a function can not be inlined and it was declared as inline.
4222 Even with this option, the compiler will not warn about failures to
4223 inline functions declared in system headers.
4224
4225 The compiler uses a variety of heuristics to determine whether or not
4226 to inline a function.  For example, the compiler takes into account
4227 the size of the function being inlined and the amount of inlining
4228 that has already been done in the current function.  Therefore,
4229 seemingly insignificant changes in the source program can cause the
4230 warnings produced by @option{-Winline} to appear or disappear.
4231
4232 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4233 @opindex Wno-invalid-offsetof
4234 @opindex Winvalid-offsetof
4235 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4236 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4237 to a non-POD type is undefined.  In existing C++ implementations,
4238 however, @samp{offsetof} typically gives meaningful results even when
4239 applied to certain kinds of non-POD types. (Such as a simple
4240 @samp{struct} that fails to be a POD type only by virtue of having a
4241 constructor.)  This flag is for users who are aware that they are
4242 writing nonportable code and who have deliberately chosen to ignore the
4243 warning about it.
4244
4245 The restrictions on @samp{offsetof} may be relaxed in a future version
4246 of the C++ standard.
4247
4248 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4249 @opindex Wno-int-to-pointer-cast
4250 @opindex Wint-to-pointer-cast
4251 Suppress warnings from casts to pointer type of an integer of a
4252 different size.
4253
4254 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4255 @opindex Wno-pointer-to-int-cast
4256 @opindex Wpointer-to-int-cast
4257 Suppress warnings from casts from a pointer to an integer type of a
4258 different size.
4259
4260 @item -Winvalid-pch
4261 @opindex Winvalid-pch
4262 @opindex Wno-invalid-pch
4263 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4264 the search path but can't be used.
4265
4266 @item -Wlong-long
4267 @opindex Wlong-long
4268 @opindex Wno-long-long
4269 Warn if @samp{long long} type is used.  This is enabled by either
4270 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4271 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4272
4273 @item -Wvariadic-macros
4274 @opindex Wvariadic-macros
4275 @opindex Wno-variadic-macros
4276 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4277 alternate syntax when in pedantic ISO C99 mode.  This is default.
4278 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4279
4280 @item -Wvla
4281 @opindex Wvla
4282 @opindex Wno-vla
4283 Warn if variable length array is used in the code.
4284 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4285 the variable length array.
4286
4287 @item -Wvolatile-register-var
4288 @opindex Wvolatile-register-var
4289 @opindex Wno-volatile-register-var
4290 Warn if a register variable is declared volatile.  The volatile
4291 modifier does not inhibit all optimizations that may eliminate reads
4292 and/or writes to register variables.  This warning is enabled by
4293 @option{-Wall}.
4294
4295 @item -Wdisabled-optimization
4296 @opindex Wdisabled-optimization
4297 @opindex Wno-disabled-optimization
4298 Warn if a requested optimization pass is disabled.  This warning does
4299 not generally indicate that there is anything wrong with your code; it
4300 merely indicates that GCC's optimizers were unable to handle the code
4301 effectively.  Often, the problem is that your code is too big or too
4302 complex; GCC will refuse to optimize programs when the optimization
4303 itself is likely to take inordinate amounts of time.
4304
4305 @item -Wpointer-sign @r{(C and Objective-C only)}
4306 @opindex Wpointer-sign
4307 @opindex Wno-pointer-sign
4308 Warn for pointer argument passing or assignment with different signedness.
4309 This option is only supported for C and Objective-C@.  It is implied by
4310 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4311 @option{-Wno-pointer-sign}.
4312
4313 @item -Wstack-protector
4314 @opindex Wstack-protector
4315 @opindex Wno-stack-protector
4316 This option is only active when @option{-fstack-protector} is active.  It
4317 warns about functions that will not be protected against stack smashing.
4318
4319 @item -Wno-mudflap
4320 @opindex Wno-mudflap
4321 Suppress warnings about constructs that cannot be instrumented by
4322 @option{-fmudflap}.
4323
4324 @item -Woverlength-strings
4325 @opindex Woverlength-strings
4326 @opindex Wno-overlength-strings
4327 Warn about string constants which are longer than the ``minimum
4328 maximum'' length specified in the C standard.  Modern compilers
4329 generally allow string constants which are much longer than the
4330 standard's minimum limit, but very portable programs should avoid
4331 using longer strings.
4332
4333 The limit applies @emph{after} string constant concatenation, and does
4334 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4335 C99, it was raised to 4095.  C++98 does not specify a normative
4336 minimum maximum, so we do not diagnose overlength strings in C++@.
4337
4338 This option is implied by @option{-pedantic}, and can be disabled with
4339 @option{-Wno-overlength-strings}.
4340
4341 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4342 @opindex Wunsuffixed-float-constants
4343
4344 GCC will issue a warning for any floating constant that does not have
4345 a suffix.  When used together with @option{-Wsystem-headers} it will
4346 warn about such constants in system header files.  This can be useful
4347 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4348 from the decimal floating-point extension to C99.
4349 @end table
4350
4351 @node Debugging Options
4352 @section Options for Debugging Your Program or GCC
4353 @cindex options, debugging
4354 @cindex debugging information options
4355
4356 GCC has various special options that are used for debugging
4357 either your program or GCC:
4358
4359 @table @gcctabopt
4360 @item -g
4361 @opindex g
4362 Produce debugging information in the operating system's native format
4363 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4364 information.
4365
4366 On most systems that use stabs format, @option{-g} enables use of extra
4367 debugging information that only GDB can use; this extra information
4368 makes debugging work better in GDB but will probably make other debuggers
4369 crash or
4370 refuse to read the program.  If you want to control for certain whether
4371 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4372 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4373
4374 GCC allows you to use @option{-g} with
4375 @option{-O}.  The shortcuts taken by optimized code may occasionally
4376 produce surprising results: some variables you declared may not exist
4377 at all; flow of control may briefly move where you did not expect it;
4378 some statements may not be executed because they compute constant
4379 results or their values were already at hand; some statements may
4380 execute in different places because they were moved out of loops.
4381
4382 Nevertheless it proves possible to debug optimized output.  This makes
4383 it reasonable to use the optimizer for programs that might have bugs.
4384
4385 The following options are useful when GCC is generated with the
4386 capability for more than one debugging format.
4387
4388 @item -ggdb
4389 @opindex ggdb
4390 Produce debugging information for use by GDB@.  This means to use the
4391 most expressive format available (DWARF 2, stabs, or the native format
4392 if neither of those are supported), including GDB extensions if at all
4393 possible.
4394
4395 @item -gstabs
4396 @opindex gstabs
4397 Produce debugging information in stabs format (if that is supported),
4398 without GDB extensions.  This is the format used by DBX on most BSD
4399 systems.  On MIPS, Alpha and System V Release 4 systems this option
4400 produces stabs debugging output which is not understood by DBX or SDB@.
4401 On System V Release 4 systems this option requires the GNU assembler.
4402
4403 @item -feliminate-unused-debug-symbols
4404 @opindex feliminate-unused-debug-symbols
4405 Produce debugging information in stabs format (if that is supported),
4406 for only symbols that are actually used.
4407
4408 @item -femit-class-debug-always
4409 Instead of emitting debugging information for a C++ class in only one
4410 object file, emit it in all object files using the class.  This option
4411 should be used only with debuggers that are unable to handle the way GCC
4412 normally emits debugging information for classes because using this
4413 option will increase the size of debugging information by as much as a
4414 factor of two.
4415
4416 @item -gstabs+
4417 @opindex gstabs+
4418 Produce debugging information in stabs format (if that is supported),
4419 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4420 use of these extensions is likely to make other debuggers crash or
4421 refuse to read the program.
4422
4423 @item -gcoff
4424 @opindex gcoff
4425 Produce debugging information in COFF format (if that is supported).
4426 This is the format used by SDB on most System V systems prior to
4427 System V Release 4.
4428
4429 @item -gxcoff
4430 @opindex gxcoff
4431 Produce debugging information in XCOFF format (if that is supported).
4432 This is the format used by the DBX debugger on IBM RS/6000 systems.
4433
4434 @item -gxcoff+
4435 @opindex gxcoff+
4436 Produce debugging information in XCOFF format (if that is supported),
4437 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4438 use of these extensions is likely to make other debuggers crash or
4439 refuse to read the program, and may cause assemblers other than the GNU
4440 assembler (GAS) to fail with an error.
4441
4442 @item -gdwarf-@var{version}
4443 @opindex gdwarf-@var{version}
4444 Produce debugging information in DWARF format (if that is
4445 supported).  This is the format used by DBX on IRIX 6.  The value
4446 of @var{version} may be either 2, 3 or 4; the default version is 2.
4447
4448 Note that with DWARF version 2 some ports require, and will always
4449 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4450
4451 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4452 for maximum benefit.
4453
4454 @item -gstrict-dwarf
4455 @opindex gstrict-dwarf
4456 Disallow using extensions of later DWARF standard version than selected
4457 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4458 DWARF extensions from later standard versions is allowed.
4459
4460 @item -gno-strict-dwarf
4461 @opindex gno-strict-dwarf
4462 Allow using extensions of later DWARF standard version than selected with
4463 @option{-gdwarf-@var{version}}.
4464
4465 @item -gvms
4466 @opindex gvms
4467 Produce debugging information in VMS debug format (if that is
4468 supported).  This is the format used by DEBUG on VMS systems.
4469
4470 @item -g@var{level}
4471 @itemx -ggdb@var{level}
4472 @itemx -gstabs@var{level}
4473 @itemx -gcoff@var{level}
4474 @itemx -gxcoff@var{level}
4475 @itemx -gvms@var{level}
4476 Request debugging information and also use @var{level} to specify how
4477 much information.  The default level is 2.
4478
4479 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4480 @option{-g}.
4481
4482 Level 1 produces minimal information, enough for making backtraces in
4483 parts of the program that you don't plan to debug.  This includes
4484 descriptions of functions and external variables, but no information
4485 about local variables and no line numbers.
4486
4487 Level 3 includes extra information, such as all the macro definitions
4488 present in the program.  Some debuggers support macro expansion when
4489 you use @option{-g3}.
4490
4491 @option{-gdwarf-2} does not accept a concatenated debug level, because
4492 GCC used to support an option @option{-gdwarf} that meant to generate
4493 debug information in version 1 of the DWARF format (which is very
4494 different from version 2), and it would have been too confusing.  That
4495 debug format is long obsolete, but the option cannot be changed now.
4496 Instead use an additional @option{-g@var{level}} option to change the
4497 debug level for DWARF.
4498
4499 @item -gtoggle
4500 @opindex gtoggle
4501 Turn off generation of debug info, if leaving out this option would have
4502 generated it, or turn it on at level 2 otherwise.  The position of this
4503 argument in the command line does not matter, it takes effect after all
4504 other options are processed, and it does so only once, no matter how
4505 many times it is given.  This is mainly intended to be used with
4506 @option{-fcompare-debug}.
4507
4508 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4509 @opindex fdump-final-insns
4510 Dump the final internal representation (RTL) to @var{file}.  If the
4511 optional argument is omitted (or if @var{file} is @code{.}), the name
4512 of the dump file will be determined by appending @code{.gkd} to the
4513 compilation output file name.
4514
4515 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4516 @opindex fcompare-debug
4517 @opindex fno-compare-debug
4518 If no error occurs during compilation, run the compiler a second time,
4519 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4520 passed to the second compilation.  Dump the final internal
4521 representation in both compilations, and print an error if they differ.
4522
4523 If the equal sign is omitted, the default @option{-gtoggle} is used.
4524
4525 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4526 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4527 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4528 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4529 is used.
4530
4531 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4532 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4533 of the final representation and the second compilation, preventing even
4534 @env{GCC_COMPARE_DEBUG} from taking effect.
4535
4536 To verify full coverage during @option{-fcompare-debug} testing, set
4537 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4538 which GCC will reject as an invalid option in any actual compilation
4539 (rather than preprocessing, assembly or linking).  To get just a
4540 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4541 not overridden} will do.
4542
4543 @item -fcompare-debug-second
4544 @opindex fcompare-debug-second
4545 This option is implicitly passed to the compiler for the second
4546 compilation requested by @option{-fcompare-debug}, along with options to
4547 silence warnings, and omitting other options that would cause
4548 side-effect compiler outputs to files or to the standard output.  Dump
4549 files and preserved temporary files are renamed so as to contain the
4550 @code{.gk} additional extension during the second compilation, to avoid
4551 overwriting those generated by the first.
4552
4553 When this option is passed to the compiler driver, it causes the
4554 @emph{first} compilation to be skipped, which makes it useful for little
4555 other than debugging the compiler proper.
4556
4557 @item -feliminate-dwarf2-dups
4558 @opindex feliminate-dwarf2-dups
4559 Compress DWARF2 debugging information by eliminating duplicated
4560 information about each symbol.  This option only makes sense when
4561 generating DWARF2 debugging information with @option{-gdwarf-2}.
4562
4563 @item -femit-struct-debug-baseonly
4564 Emit debug information for struct-like types
4565 only when the base name of the compilation source file
4566 matches the base name of file in which the struct was defined.
4567
4568 This option substantially reduces the size of debugging information,
4569 but at significant potential loss in type information to the debugger.
4570 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4571 See @option{-femit-struct-debug-detailed} for more detailed control.
4572
4573 This option works only with DWARF 2.
4574
4575 @item -femit-struct-debug-reduced
4576 Emit debug information for struct-like types
4577 only when the base name of the compilation source file
4578 matches the base name of file in which the type was defined,
4579 unless the struct is a template or defined in a system header.
4580
4581 This option significantly reduces the size of debugging information,
4582 with some potential loss in type information to the debugger.
4583 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4584 See @option{-femit-struct-debug-detailed} for more detailed control.
4585
4586 This option works only with DWARF 2.
4587
4588 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4589 Specify the struct-like types
4590 for which the compiler will generate debug information.
4591 The intent is to reduce duplicate struct debug information
4592 between different object files within the same program.
4593
4594 This option is a detailed version of
4595 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4596 which will serve for most needs.
4597
4598 A specification has the syntax
4599 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4600
4601 The optional first word limits the specification to
4602 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4603 A struct type is used directly when it is the type of a variable, member.
4604 Indirect uses arise through pointers to structs.
4605 That is, when use of an incomplete struct would be legal, the use is indirect.
4606 An example is
4607 @samp{struct one direct; struct two * indirect;}.
4608
4609 The optional second word limits the specification to
4610 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4611 Generic structs are a bit complicated to explain.
4612 For C++, these are non-explicit specializations of template classes,
4613 or non-template classes within the above.
4614 Other programming languages have generics,
4615 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4616
4617 The third word specifies the source files for those
4618 structs for which the compiler will emit debug information.
4619 The values @samp{none} and @samp{any} have the normal meaning.
4620 The value @samp{base} means that
4621 the base of name of the file in which the type declaration appears
4622 must match the base of the name of the main compilation file.
4623 In practice, this means that
4624 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4625 but types declared in other header will not.
4626 The value @samp{sys} means those types satisfying @samp{base}
4627 or declared in system or compiler headers.
4628
4629 You may need to experiment to determine the best settings for your application.
4630
4631 The default is @samp{-femit-struct-debug-detailed=all}.
4632
4633 This option works only with DWARF 2.
4634
4635 @item -fenable-icf-debug
4636 @opindex fenable-icf-debug
4637 Generate additional debug information to support identical code folding (ICF).
4638 This option only works with DWARF version 2 or higher.
4639
4640 @item -fno-merge-debug-strings
4641 @opindex fmerge-debug-strings
4642 @opindex fno-merge-debug-strings
4643 Direct the linker to not merge together strings in the debugging
4644 information which are identical in different object files.  Merging is
4645 not supported by all assemblers or linkers.  Merging decreases the size
4646 of the debug information in the output file at the cost of increasing
4647 link processing time.  Merging is enabled by default.
4648
4649 @item -fdebug-prefix-map=@var{old}=@var{new}
4650 @opindex fdebug-prefix-map
4651 When compiling files in directory @file{@var{old}}, record debugging
4652 information describing them as in @file{@var{new}} instead.
4653
4654 @item -fno-dwarf2-cfi-asm
4655 @opindex fdwarf2-cfi-asm
4656 @opindex fno-dwarf2-cfi-asm
4657 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4658 instead of using GAS @code{.cfi_*} directives.
4659
4660 @cindex @command{prof}
4661 @item -p
4662 @opindex p
4663 Generate extra code to write profile information suitable for the
4664 analysis program @command{prof}.  You must use this option when compiling
4665 the source files you want data about, and you must also use it when
4666 linking.
4667
4668 @cindex @command{gprof}
4669 @item -pg
4670 @opindex pg
4671 Generate extra code to write profile information suitable for the
4672 analysis program @command{gprof}.  You must use this option when compiling
4673 the source files you want data about, and you must also use it when
4674 linking.
4675
4676 @item -Q
4677 @opindex Q
4678 Makes the compiler print out each function name as it is compiled, and
4679 print some statistics about each pass when it finishes.
4680
4681 @item -ftime-report
4682 @opindex ftime-report
4683 Makes the compiler print some statistics about the time consumed by each
4684 pass when it finishes.
4685
4686 @item -fmem-report
4687 @opindex fmem-report
4688 Makes the compiler print some statistics about permanent memory
4689 allocation when it finishes.
4690
4691 @item -fpre-ipa-mem-report
4692 @opindex fpre-ipa-mem-report
4693 @item -fpost-ipa-mem-report
4694 @opindex fpost-ipa-mem-report
4695 Makes the compiler print some statistics about permanent memory
4696 allocation before or after interprocedural optimization.
4697
4698 @item -fprofile-arcs
4699 @opindex fprofile-arcs
4700 Add code so that program flow @dfn{arcs} are instrumented.  During
4701 execution the program records how many times each branch and call is
4702 executed and how many times it is taken or returns.  When the compiled
4703 program exits it saves this data to a file called
4704 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4705 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4706 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4707 @var{auxname} is generated from the name of the output file, if
4708 explicitly specified and it is not the final executable, otherwise it is
4709 the basename of the source file.  In both cases any suffix is removed
4710 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4711 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4712 @xref{Cross-profiling}.
4713
4714 @cindex @command{gcov}
4715 @item --coverage
4716 @opindex coverage
4717
4718 This option is used to compile and link code instrumented for coverage
4719 analysis.  The option is a synonym for @option{-fprofile-arcs}
4720 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4721 linking).  See the documentation for those options for more details.
4722
4723 @itemize
4724
4725 @item
4726 Compile the source files with @option{-fprofile-arcs} plus optimization
4727 and code generation options.  For test coverage analysis, use the
4728 additional @option{-ftest-coverage} option.  You do not need to profile
4729 every source file in a program.
4730
4731 @item
4732 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4733 (the latter implies the former).
4734
4735 @item
4736 Run the program on a representative workload to generate the arc profile
4737 information.  This may be repeated any number of times.  You can run
4738 concurrent instances of your program, and provided that the file system
4739 supports locking, the data files will be correctly updated.  Also
4740 @code{fork} calls are detected and correctly handled (double counting
4741 will not happen).
4742
4743 @item
4744 For profile-directed optimizations, compile the source files again with
4745 the same optimization and code generation options plus
4746 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4747 Control Optimization}).
4748
4749 @item
4750 For test coverage analysis, use @command{gcov} to produce human readable
4751 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4752 @command{gcov} documentation for further information.
4753
4754 @end itemize
4755
4756 With @option{-fprofile-arcs}, for each function of your program GCC
4757 creates a program flow graph, then finds a spanning tree for the graph.
4758 Only arcs that are not on the spanning tree have to be instrumented: the
4759 compiler adds code to count the number of times that these arcs are
4760 executed.  When an arc is the only exit or only entrance to a block, the
4761 instrumentation code can be added to the block; otherwise, a new basic
4762 block must be created to hold the instrumentation code.
4763
4764 @need 2000
4765 @item -ftest-coverage
4766 @opindex ftest-coverage
4767 Produce a notes file that the @command{gcov} code-coverage utility
4768 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4769 show program coverage.  Each source file's note file is called
4770 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4771 above for a description of @var{auxname} and instructions on how to
4772 generate test coverage data.  Coverage data will match the source files
4773 more closely, if you do not optimize.
4774
4775 @item -fdbg-cnt-list
4776 @opindex fdbg-cnt-list
4777 Print the name and the counter upperbound for all debug counters.
4778
4779 @item -fdbg-cnt=@var{counter-value-list}
4780 @opindex fdbg-cnt
4781 Set the internal debug counter upperbound. @var{counter-value-list}
4782 is a comma-separated list of @var{name}:@var{value} pairs
4783 which sets the upperbound of each debug counter @var{name} to @var{value}.
4784 All debug counters have the initial upperbound of @var{UINT_MAX},
4785 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4786 e.g. With -fdbg-cnt=dce:10,tail_call:0
4787 dbg_cnt(dce) will return true only for first 10 invocations
4788 and dbg_cnt(tail_call) will return false always.
4789
4790 @item -d@var{letters}
4791 @itemx -fdump-rtl-@var{pass}
4792 @opindex d
4793 Says to make debugging dumps during compilation at times specified by
4794 @var{letters}.  This is used for debugging the RTL-based passes of the
4795 compiler.  The file names for most of the dumps are made by appending
4796 a pass number and a word to the @var{dumpname}, and the files are
4797 created in the directory of the output file.  @var{dumpname} is
4798 generated from the name of the output file, if explicitly specified
4799 and it is not an executable, otherwise it is the basename of the
4800 source file. These switches may have different effects when
4801 @option{-E} is used for preprocessing.
4802
4803 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4804 @option{-d} option @var{letters}.  Here are the possible
4805 letters for use in @var{pass} and @var{letters}, and their meanings:
4806
4807 @table @gcctabopt
4808
4809 @item -fdump-rtl-alignments
4810 @opindex fdump-rtl-alignments
4811 Dump after branch alignments have been computed.
4812
4813 @item -fdump-rtl-asmcons
4814 @opindex fdump-rtl-asmcons
4815 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4816
4817 @item -fdump-rtl-auto_inc_dec
4818 @opindex fdump-rtl-auto_inc_dec
4819 Dump after auto-inc-dec discovery.  This pass is only run on
4820 architectures that have auto inc or auto dec instructions.
4821
4822 @item -fdump-rtl-barriers
4823 @opindex fdump-rtl-barriers
4824 Dump after cleaning up the barrier instructions.
4825
4826 @item -fdump-rtl-bbpart
4827 @opindex fdump-rtl-bbpart
4828 Dump after partitioning hot and cold basic blocks.
4829
4830 @item -fdump-rtl-bbro
4831 @opindex fdump-rtl-bbro
4832 Dump after block reordering.
4833
4834 @item -fdump-rtl-btl1
4835 @itemx -fdump-rtl-btl2
4836 @opindex fdump-rtl-btl2
4837 @opindex fdump-rtl-btl2
4838 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4839 after the two branch
4840 target load optimization passes.
4841
4842 @item -fdump-rtl-bypass
4843 @opindex fdump-rtl-bypass
4844 Dump after jump bypassing and control flow optimizations.
4845
4846 @item -fdump-rtl-combine
4847 @opindex fdump-rtl-combine
4848 Dump after the RTL instruction combination pass.
4849
4850 @item -fdump-rtl-compgotos
4851 @opindex fdump-rtl-compgotos
4852 Dump after duplicating the computed gotos.
4853
4854 @item -fdump-rtl-ce1
4855 @itemx -fdump-rtl-ce2
4856 @itemx -fdump-rtl-ce3
4857 @opindex fdump-rtl-ce1
4858 @opindex fdump-rtl-ce2
4859 @opindex fdump-rtl-ce3
4860 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
4861 @option{-fdump-rtl-ce3} enable dumping after the three
4862 if conversion passes.
4863
4864 @itemx -fdump-rtl-cprop_hardreg
4865 @opindex fdump-rtl-cprop_hardreg
4866 Dump after hard register copy propagation.
4867
4868 @itemx -fdump-rtl-csa
4869 @opindex fdump-rtl-csa
4870 Dump after combining stack adjustments.
4871
4872 @item -fdump-rtl-cse1
4873 @itemx -fdump-rtl-cse2
4874 @opindex fdump-rtl-cse1
4875 @opindex fdump-rtl-cse2
4876 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
4877 the two common sub-expression elimination passes.
4878
4879 @itemx -fdump-rtl-dce
4880 @opindex fdump-rtl-dce
4881 Dump after the standalone dead code elimination passes.
4882
4883 @itemx -fdump-rtl-dbr
4884 @opindex fdump-rtl-dbr
4885 Dump after delayed branch scheduling.
4886
4887 @item -fdump-rtl-dce1
4888 @itemx -fdump-rtl-dce2
4889 @opindex fdump-rtl-dce1
4890 @opindex fdump-rtl-dce2
4891 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
4892 the two dead store elimination passes.
4893
4894 @item -fdump-rtl-eh
4895 @opindex fdump-rtl-eh
4896 Dump after finalization of EH handling code.
4897
4898 @item -fdump-rtl-eh_ranges
4899 @opindex fdump-rtl-eh_ranges
4900 Dump after conversion of EH handling range regions.
4901
4902 @item -fdump-rtl-expand
4903 @opindex fdump-rtl-expand
4904 Dump after RTL generation.
4905
4906 @item -fdump-rtl-fwprop1
4907 @itemx -fdump-rtl-fwprop2
4908 @opindex fdump-rtl-fwprop1
4909 @opindex fdump-rtl-fwprop2
4910 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
4911 dumping after the two forward propagation passes.
4912
4913 @item -fdump-rtl-gcse1
4914 @itemx -fdump-rtl-gcse2
4915 @opindex fdump-rtl-gcse1
4916 @opindex fdump-rtl-gcse2
4917 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
4918 after global common subexpression elimination.
4919
4920 @item -fdump-rtl-init-regs
4921 @opindex fdump-rtl-init-regs
4922 Dump after the initialization of the registers.
4923
4924 @item -fdump-rtl-initvals
4925 @opindex fdump-rtl-initvals
4926 Dump after the computation of the initial value sets.
4927
4928 @itemx -fdump-rtl-into_cfglayout
4929 @opindex fdump-rtl-into_cfglayout
4930 Dump after converting to cfglayout mode.
4931
4932 @item -fdump-rtl-ira
4933 @opindex fdump-rtl-ira
4934 Dump after iterated register allocation.
4935
4936 @item -fdump-rtl-jump
4937 @opindex fdump-rtl-jump
4938 Dump after the second jump optimization.
4939
4940 @item -fdump-rtl-loop2
4941 @opindex fdump-rtl-loop2
4942 @option{-fdump-rtl-loop2} enables dumping after the rtl
4943 loop optimization passes.
4944
4945 @item -fdump-rtl-mach
4946 @opindex fdump-rtl-mach
4947 Dump after performing the machine dependent reorganization pass, if that
4948 pass exists.
4949
4950 @item -fdump-rtl-mode_sw
4951 @opindex fdump-rtl-mode_sw
4952 Dump after removing redundant mode switches.
4953
4954 @item -fdump-rtl-rnreg
4955 @opindex fdump-rtl-rnreg
4956 Dump after register renumbering.
4957
4958 @itemx -fdump-rtl-outof_cfglayout
4959 @opindex fdump-rtl-outof_cfglayout
4960 Dump after converting from cfglayout mode.
4961
4962 @item -fdump-rtl-peephole2
4963 @opindex fdump-rtl-peephole2
4964 Dump after the peephole pass.
4965
4966 @item -fdump-rtl-postreload
4967 @opindex fdump-rtl-postreload
4968 Dump after post-reload optimizations.
4969
4970 @itemx -fdump-rtl-pro_and_epilogue
4971 @opindex fdump-rtl-pro_and_epilogue
4972 Dump after generating the function pro and epilogues.
4973
4974 @item -fdump-rtl-regmove
4975 @opindex fdump-rtl-regmove
4976 Dump after the register move pass.
4977
4978 @item -fdump-rtl-sched1
4979 @itemx -fdump-rtl-sched2
4980 @opindex fdump-rtl-sched1
4981 @opindex fdump-rtl-sched2
4982 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
4983 after the basic block scheduling passes.
4984
4985 @item -fdump-rtl-see
4986 @opindex fdump-rtl-see
4987 Dump after sign extension elimination.
4988
4989 @item -fdump-rtl-seqabstr
4990 @opindex fdump-rtl-seqabstr
4991 Dump after common sequence discovery.
4992
4993 @item -fdump-rtl-shorten
4994 @opindex fdump-rtl-shorten
4995 Dump after shortening branches.
4996
4997 @item -fdump-rtl-sibling
4998 @opindex fdump-rtl-sibling
4999 Dump after sibling call optimizations.
5000
5001 @item -fdump-rtl-split1
5002 @itemx -fdump-rtl-split2
5003 @itemx -fdump-rtl-split3
5004 @itemx -fdump-rtl-split4
5005 @itemx -fdump-rtl-split5
5006 @opindex fdump-rtl-split1
5007 @opindex fdump-rtl-split2
5008 @opindex fdump-rtl-split3
5009 @opindex fdump-rtl-split4
5010 @opindex fdump-rtl-split5
5011 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5012 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5013 @option{-fdump-rtl-split5} enable dumping after five rounds of
5014 instruction splitting.
5015
5016 @item -fdump-rtl-sms
5017 @opindex fdump-rtl-sms
5018 Dump after modulo scheduling.  This pass is only run on some
5019 architectures.
5020
5021 @item -fdump-rtl-stack
5022 @opindex fdump-rtl-stack
5023 Dump after conversion from GCC's "flat register file" registers to the
5024 x87's stack-like registers.  This pass is only run on x86 variants.
5025
5026 @item -fdump-rtl-subreg1
5027 @itemx -fdump-rtl-subreg2
5028 @opindex fdump-rtl-subreg1
5029 @opindex fdump-rtl-subreg2
5030 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5031 the two subreg expansion passes.
5032
5033 @item -fdump-rtl-unshare
5034 @opindex fdump-rtl-unshare
5035 Dump after all rtl has been unshared.
5036
5037 @item -fdump-rtl-vartrack
5038 @opindex fdump-rtl-vartrack
5039 Dump after variable tracking.
5040
5041 @item -fdump-rtl-vregs
5042 @opindex fdump-rtl-vregs
5043 Dump after converting virtual registers to hard registers.
5044
5045 @item -fdump-rtl-web
5046 @opindex fdump-rtl-web
5047 Dump after live range splitting.
5048
5049 @item -fdump-rtl-regclass
5050 @itemx -fdump-rtl-subregs_of_mode_init
5051 @itemx -fdump-rtl-subregs_of_mode_finish
5052 @itemx -fdump-rtl-dfinit
5053 @itemx -fdump-rtl-dfinish
5054 @opindex fdump-rtl-regclass
5055 @opindex fdump-rtl-subregs_of_mode_init
5056 @opindex fdump-rtl-subregs_of_mode_finish
5057 @opindex fdump-rtl-dfinit
5058 @opindex fdump-rtl-dfinish
5059 These dumps are defined but always produce empty files.
5060
5061 @item -fdump-rtl-all
5062 @opindex fdump-rtl-all
5063 Produce all the dumps listed above.
5064
5065 @item -dA
5066 @opindex dA
5067 Annotate the assembler output with miscellaneous debugging information.
5068
5069 @item -dD
5070 @opindex dD
5071 Dump all macro definitions, at the end of preprocessing, in addition to
5072 normal output.
5073
5074 @item -dH
5075 @opindex dH
5076 Produce a core dump whenever an error occurs.
5077
5078 @item -dm
5079 @opindex dm
5080 Print statistics on memory usage, at the end of the run, to
5081 standard error.
5082
5083 @item -dp
5084 @opindex dp
5085 Annotate the assembler output with a comment indicating which
5086 pattern and alternative was used.  The length of each instruction is
5087 also printed.
5088
5089 @item -dP
5090 @opindex dP
5091 Dump the RTL in the assembler output as a comment before each instruction.
5092 Also turns on @option{-dp} annotation.
5093
5094 @item -dv
5095 @opindex dv
5096 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5097 dump a representation of the control flow graph suitable for viewing with VCG
5098 to @file{@var{file}.@var{pass}.vcg}.
5099
5100 @item -dx
5101 @opindex dx
5102 Just generate RTL for a function instead of compiling it.  Usually used
5103 with @option{-fdump-rtl-expand}.
5104
5105 @item -dy
5106 @opindex dy
5107 Dump debugging information during parsing, to standard error.
5108 @end table
5109
5110 @item -fdump-noaddr
5111 @opindex fdump-noaddr
5112 When doing debugging dumps, suppress address output.  This makes it more
5113 feasible to use diff on debugging dumps for compiler invocations with
5114 different compiler binaries and/or different
5115 text / bss / data / heap / stack / dso start locations.
5116
5117 @item -fdump-unnumbered
5118 @opindex fdump-unnumbered
5119 When doing debugging dumps, suppress instruction numbers and address output.
5120 This makes it more feasible to use diff on debugging dumps for compiler
5121 invocations with different options, in particular with and without
5122 @option{-g}.
5123
5124 @item -fdump-unnumbered-links
5125 @opindex fdump-unnumbered-links
5126 When doing debugging dumps (see @option{-d} option above), suppress
5127 instruction numbers for the links to the previous and next instructions
5128 in a sequence.
5129
5130 @item -fdump-translation-unit @r{(C++ only)}
5131 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5132 @opindex fdump-translation-unit
5133 Dump a representation of the tree structure for the entire translation
5134 unit to a file.  The file name is made by appending @file{.tu} to the
5135 source file name, and the file is created in the same directory as the
5136 output file.  If the @samp{-@var{options}} form is used, @var{options}
5137 controls the details of the dump as described for the
5138 @option{-fdump-tree} options.
5139
5140 @item -fdump-class-hierarchy @r{(C++ only)}
5141 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5142 @opindex fdump-class-hierarchy
5143 Dump a representation of each class's hierarchy and virtual function
5144 table layout to a file.  The file name is made by appending
5145 @file{.class} to the source file name, and the file is created in the
5146 same directory as the output file.  If the @samp{-@var{options}} form
5147 is used, @var{options} controls the details of the dump as described
5148 for the @option{-fdump-tree} options.
5149
5150 @item -fdump-ipa-@var{switch}
5151 @opindex fdump-ipa
5152 Control the dumping at various stages of inter-procedural analysis
5153 language tree to a file.  The file name is generated by appending a
5154 switch specific suffix to the source file name, and the file is created
5155 in the same directory as the output file.  The following dumps are
5156 possible:
5157
5158 @table @samp
5159 @item all
5160 Enables all inter-procedural analysis dumps.
5161
5162 @item cgraph
5163 Dumps information about call-graph optimization, unused function removal,
5164 and inlining decisions.
5165
5166 @item inline
5167 Dump after function inlining.
5168
5169 @end table
5170
5171 @item -fdump-statistics-@var{option}
5172 @opindex fdump-statistics
5173 Enable and control dumping of pass statistics in a separate file.  The
5174 file name is generated by appending a suffix ending in
5175 @samp{.statistics} to the source file name, and the file is created in
5176 the same directory as the output file.  If the @samp{-@var{option}}
5177 form is used, @samp{-stats} will cause counters to be summed over the
5178 whole compilation unit while @samp{-details} will dump every event as
5179 the passes generate them.  The default with no option is to sum
5180 counters for each function compiled.
5181
5182 @item -fdump-tree-@var{switch}
5183 @itemx -fdump-tree-@var{switch}-@var{options}
5184 @opindex fdump-tree
5185 Control the dumping at various stages of processing the intermediate
5186 language tree to a file.  The file name is generated by appending a
5187 switch specific suffix to the source file name, and the file is
5188 created in the same directory as the output file.  If the
5189 @samp{-@var{options}} form is used, @var{options} is a list of
5190 @samp{-} separated options that control the details of the dump.  Not
5191 all options are applicable to all dumps, those which are not
5192 meaningful will be ignored.  The following options are available
5193
5194 @table @samp
5195 @item address
5196 Print the address of each node.  Usually this is not meaningful as it
5197 changes according to the environment and source file.  Its primary use
5198 is for tying up a dump file with a debug environment.
5199 @item asmname
5200 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5201 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5202 use working backward from mangled names in the assembly file.
5203 @item slim
5204 Inhibit dumping of members of a scope or body of a function merely
5205 because that scope has been reached.  Only dump such items when they
5206 are directly reachable by some other path.  When dumping pretty-printed
5207 trees, this option inhibits dumping the bodies of control structures.
5208 @item raw
5209 Print a raw representation of the tree.  By default, trees are
5210 pretty-printed into a C-like representation.
5211 @item details
5212 Enable more detailed dumps (not honored by every dump option).
5213 @item stats
5214 Enable dumping various statistics about the pass (not honored by every dump
5215 option).
5216 @item blocks
5217 Enable showing basic block boundaries (disabled in raw dumps).
5218 @item vops
5219 Enable showing virtual operands for every statement.
5220 @item lineno
5221 Enable showing line numbers for statements.
5222 @item uid
5223 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5224 @item verbose
5225 Enable showing the tree dump for each statement.
5226 @item eh
5227 Enable showing the EH region number holding each statement.
5228 @item all
5229 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5230 and @option{lineno}.
5231 @end table
5232
5233 The following tree dumps are possible:
5234 @table @samp
5235
5236 @item original
5237 @opindex fdump-tree-original
5238 Dump before any tree based optimization, to @file{@var{file}.original}.
5239
5240 @item optimized
5241 @opindex fdump-tree-optimized
5242 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5243
5244 @item gimple
5245 @opindex fdump-tree-gimple
5246 Dump each function before and after the gimplification pass to a file.  The
5247 file name is made by appending @file{.gimple} to the source file name.
5248
5249 @item cfg
5250 @opindex fdump-tree-cfg
5251 Dump the control flow graph of each function to a file.  The file name is
5252 made by appending @file{.cfg} to the source file name.
5253
5254 @item vcg
5255 @opindex fdump-tree-vcg
5256 Dump the control flow graph of each function to a file in VCG format.  The
5257 file name is made by appending @file{.vcg} to the source file name.  Note
5258 that if the file contains more than one function, the generated file cannot
5259 be used directly by VCG@.  You will need to cut and paste each function's
5260 graph into its own separate file first.
5261
5262 @item ch
5263 @opindex fdump-tree-ch
5264 Dump each function after copying loop headers.  The file name is made by
5265 appending @file{.ch} to the source file name.
5266
5267 @item ssa
5268 @opindex fdump-tree-ssa
5269 Dump SSA related information to a file.  The file name is made by appending
5270 @file{.ssa} to the source file name.
5271
5272 @item alias
5273 @opindex fdump-tree-alias
5274 Dump aliasing information for each function.  The file name is made by
5275 appending @file{.alias} to the source file name.
5276
5277 @item ccp
5278 @opindex fdump-tree-ccp
5279 Dump each function after CCP@.  The file name is made by appending
5280 @file{.ccp} to the source file name.
5281
5282 @item storeccp
5283 @opindex fdump-tree-storeccp
5284 Dump each function after STORE-CCP@.  The file name is made by appending
5285 @file{.storeccp} to the source file name.
5286
5287 @item pre
5288 @opindex fdump-tree-pre
5289 Dump trees after partial redundancy elimination.  The file name is made
5290 by appending @file{.pre} to the source file name.
5291
5292 @item fre
5293 @opindex fdump-tree-fre
5294 Dump trees after full redundancy elimination.  The file name is made
5295 by appending @file{.fre} to the source file name.
5296
5297 @item copyprop
5298 @opindex fdump-tree-copyprop
5299 Dump trees after copy propagation.  The file name is made
5300 by appending @file{.copyprop} to the source file name.
5301
5302 @item store_copyprop
5303 @opindex fdump-tree-store_copyprop
5304 Dump trees after store copy-propagation.  The file name is made
5305 by appending @file{.store_copyprop} to the source file name.
5306
5307 @item dce
5308 @opindex fdump-tree-dce
5309 Dump each function after dead code elimination.  The file name is made by
5310 appending @file{.dce} to the source file name.
5311
5312 @item mudflap
5313 @opindex fdump-tree-mudflap
5314 Dump each function after adding mudflap instrumentation.  The file name is
5315 made by appending @file{.mudflap} to the source file name.
5316
5317 @item sra
5318 @opindex fdump-tree-sra
5319 Dump each function after performing scalar replacement of aggregates.  The
5320 file name is made by appending @file{.sra} to the source file name.
5321
5322 @item sink
5323 @opindex fdump-tree-sink
5324 Dump each function after performing code sinking.  The file name is made
5325 by appending @file{.sink} to the source file name.
5326
5327 @item dom
5328 @opindex fdump-tree-dom
5329 Dump each function after applying dominator tree optimizations.  The file
5330 name is made by appending @file{.dom} to the source file name.
5331
5332 @item dse
5333 @opindex fdump-tree-dse
5334 Dump each function after applying dead store elimination.  The file
5335 name is made by appending @file{.dse} to the source file name.
5336
5337 @item phiopt
5338 @opindex fdump-tree-phiopt
5339 Dump each function after optimizing PHI nodes into straightline code.  The file
5340 name is made by appending @file{.phiopt} to the source file name.
5341
5342 @item forwprop
5343 @opindex fdump-tree-forwprop
5344 Dump each function after forward propagating single use variables.  The file
5345 name is made by appending @file{.forwprop} to the source file name.
5346
5347 @item copyrename
5348 @opindex fdump-tree-copyrename
5349 Dump each function after applying the copy rename optimization.  The file
5350 name is made by appending @file{.copyrename} to the source file name.
5351
5352 @item nrv
5353 @opindex fdump-tree-nrv
5354 Dump each function after applying the named return value optimization on
5355 generic trees.  The file name is made by appending @file{.nrv} to the source
5356 file name.
5357
5358 @item vect
5359 @opindex fdump-tree-vect
5360 Dump each function after applying vectorization of loops.  The file name is
5361 made by appending @file{.vect} to the source file name.
5362
5363 @item slp
5364 @opindex fdump-tree-slp
5365 Dump each function after applying vectorization of basic blocks.  The file name
5366 is made by appending @file{.slp} to the source file name.
5367
5368 @item vrp
5369 @opindex fdump-tree-vrp
5370 Dump each function after Value Range Propagation (VRP).  The file name
5371 is made by appending @file{.vrp} to the source file name.
5372
5373 @item all
5374 @opindex fdump-tree-all
5375 Enable all the available tree dumps with the flags provided in this option.
5376 @end table
5377
5378 @item -ftree-vectorizer-verbose=@var{n}
5379 @opindex ftree-vectorizer-verbose
5380 This option controls the amount of debugging output the vectorizer prints.
5381 This information is written to standard error, unless
5382 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5383 in which case it is output to the usual dump listing file, @file{.vect}.
5384 For @var{n}=0 no diagnostic information is reported.
5385 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5386 and the total number of loops that got vectorized.
5387 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5388 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5389 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5390 level that @option{-fdump-tree-vect-stats} uses.
5391 Higher verbosity levels mean either more information dumped for each
5392 reported loop, or same amount of information reported for more loops:
5393 if @var{n}=3, vectorizer cost model information is reported.
5394 If @var{n}=4, alignment related information is added to the reports.
5395 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5396 memory access-patterns) is added to the reports.
5397 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5398 that did not pass the first analysis phase (i.e., may not be countable, or
5399 may have complicated control-flow).
5400 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5401 If @var{n}=8, SLP related information is added to the reports.
5402 For @var{n}=9, all the information the vectorizer generates during its
5403 analysis and transformation is reported.  This is the same verbosity level
5404 that @option{-fdump-tree-vect-details} uses.
5405
5406 @item -frandom-seed=@var{string}
5407 @opindex frandom-seed
5408 This option provides a seed that GCC uses when it would otherwise use
5409 random numbers.  It is used to generate certain symbol names
5410 that have to be different in every compiled file.  It is also used to
5411 place unique stamps in coverage data files and the object files that
5412 produce them.  You can use the @option{-frandom-seed} option to produce
5413 reproducibly identical object files.
5414
5415 The @var{string} should be different for every file you compile.
5416
5417 @item -fsched-verbose=@var{n}
5418 @opindex fsched-verbose
5419 On targets that use instruction scheduling, this option controls the
5420 amount of debugging output the scheduler prints.  This information is
5421 written to standard error, unless @option{-fdump-rtl-sched1} or
5422 @option{-fdump-rtl-sched2} is specified, in which case it is output
5423 to the usual dump listing file, @file{.sched} or @file{.sched2}
5424 respectively.  However for @var{n} greater than nine, the output is
5425 always printed to standard error.
5426
5427 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5428 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5429 For @var{n} greater than one, it also output basic block probabilities,
5430 detailed ready list information and unit/insn info.  For @var{n} greater
5431 than two, it includes RTL at abort point, control-flow and regions info.
5432 And for @var{n} over four, @option{-fsched-verbose} also includes
5433 dependence info.
5434
5435 @item -save-temps
5436 @itemx -save-temps=cwd
5437 @opindex save-temps
5438 Store the usual ``temporary'' intermediate files permanently; place them
5439 in the current directory and name them based on the source file.  Thus,
5440 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5441 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5442 preprocessed @file{foo.i} output file even though the compiler now
5443 normally uses an integrated preprocessor.
5444
5445 When used in combination with the @option{-x} command line option,
5446 @option{-save-temps} is sensible enough to avoid over writing an
5447 input source file with the same extension as an intermediate file.
5448 The corresponding intermediate file may be obtained by renaming the
5449 source file before using @option{-save-temps}.
5450
5451 If you invoke GCC in parallel, compiling several different source
5452 files that share a common base name in different subdirectories or the
5453 same source file compiled for multiple output destinations, it is
5454 likely that the different parallel compilers will interfere with each
5455 other, and overwrite the temporary files.  For instance:
5456
5457 @smallexample
5458 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5459 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5460 @end smallexample
5461
5462 may result in @file{foo.i} and @file{foo.o} being written to
5463 simultaneously by both compilers.
5464
5465 @item -save-temps=obj
5466 @opindex save-temps=obj
5467 Store the usual ``temporary'' intermediate files permanently.  If the
5468 @option{-o} option is used, the temporary files are based on the
5469 object file.  If the @option{-o} option is not used, the
5470 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5471
5472 For example:
5473
5474 @smallexample
5475 gcc -save-temps=obj -c foo.c
5476 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5477 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5478 @end smallexample
5479
5480 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5481 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5482 @file{dir2/yfoobar.o}.
5483
5484 @item -time@r{[}=@var{file}@r{]}
5485 @opindex time
5486 Report the CPU time taken by each subprocess in the compilation
5487 sequence.  For C source files, this is the compiler proper and assembler
5488 (plus the linker if linking is done).
5489
5490 Without the specification of an output file, the output looks like this:
5491
5492 @smallexample
5493 # cc1 0.12 0.01
5494 # as 0.00 0.01
5495 @end smallexample
5496
5497 The first number on each line is the ``user time'', that is time spent
5498 executing the program itself.  The second number is ``system time'',
5499 time spent executing operating system routines on behalf of the program.
5500 Both numbers are in seconds.
5501
5502 With the specification of an output file, the output is appended to the
5503 named file, and it looks like this:
5504
5505 @smallexample
5506 0.12 0.01 cc1 @var{options}
5507 0.00 0.01 as @var{options}
5508 @end smallexample
5509
5510 The ``user time'' and the ``system time'' are moved before the program
5511 name, and the options passed to the program are displayed, so that one
5512 can later tell what file was being compiled, and with which options.
5513
5514 @item -fvar-tracking
5515 @opindex fvar-tracking
5516 Run variable tracking pass.  It computes where variables are stored at each
5517 position in code.  Better debugging information is then generated
5518 (if the debugging information format supports this information).
5519
5520 It is enabled by default when compiling with optimization (@option{-Os},
5521 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5522 the debug info format supports it.
5523
5524 @item -fvar-tracking-assignments
5525 @opindex fvar-tracking-assignments
5526 @opindex fno-var-tracking-assignments
5527 Annotate assignments to user variables early in the compilation and
5528 attempt to carry the annotations over throughout the compilation all the
5529 way to the end, in an attempt to improve debug information while
5530 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5531
5532 It can be enabled even if var-tracking is disabled, in which case
5533 annotations will be created and maintained, but discarded at the end.
5534
5535 @item -fvar-tracking-assignments-toggle
5536 @opindex fvar-tracking-assignments-toggle
5537 @opindex fno-var-tracking-assignments-toggle
5538 Toggle @option{-fvar-tracking-assignments}, in the same way that
5539 @option{-gtoggle} toggles @option{-g}.
5540
5541 @item -print-file-name=@var{library}
5542 @opindex print-file-name
5543 Print the full absolute name of the library file @var{library} that
5544 would be used when linking---and don't do anything else.  With this
5545 option, GCC does not compile or link anything; it just prints the
5546 file name.
5547
5548 @item -print-multi-directory
5549 @opindex print-multi-directory
5550 Print the directory name corresponding to the multilib selected by any
5551 other switches present in the command line.  This directory is supposed
5552 to exist in @env{GCC_EXEC_PREFIX}.
5553
5554 @item -print-multi-lib
5555 @opindex print-multi-lib
5556 Print the mapping from multilib directory names to compiler switches
5557 that enable them.  The directory name is separated from the switches by
5558 @samp{;}, and each switch starts with an @samp{@@} instead of the
5559 @samp{-}, without spaces between multiple switches.  This is supposed to
5560 ease shell-processing.
5561
5562 @item -print-multi-os-directory
5563 @opindex print-multi-os-directory
5564 Print the path to OS libraries for the selected
5565 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
5566 present in the @file{lib} subdirectory and no multilibs are used, this is
5567 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
5568 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
5569 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
5570 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
5571
5572 @item -print-prog-name=@var{program}
5573 @opindex print-prog-name
5574 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5575
5576 @item -print-libgcc-file-name
5577 @opindex print-libgcc-file-name
5578 Same as @option{-print-file-name=libgcc.a}.
5579
5580 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5581 but you do want to link with @file{libgcc.a}.  You can do
5582
5583 @smallexample
5584 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5585 @end smallexample
5586
5587 @item -print-search-dirs
5588 @opindex print-search-dirs
5589 Print the name of the configured installation directory and a list of
5590 program and library directories @command{gcc} will search---and don't do anything else.
5591
5592 This is useful when @command{gcc} prints the error message
5593 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5594 To resolve this you either need to put @file{cpp0} and the other compiler
5595 components where @command{gcc} expects to find them, or you can set the environment
5596 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5597 Don't forget the trailing @samp{/}.
5598 @xref{Environment Variables}.
5599
5600 @item -print-sysroot
5601 @opindex print-sysroot
5602 Print the target sysroot directory that will be used during
5603 compilation.  This is the target sysroot specified either at configure
5604 time or using the @option{--sysroot} option, possibly with an extra
5605 suffix that depends on compilation options.  If no target sysroot is
5606 specified, the option prints nothing.
5607
5608 @item -print-sysroot-headers-suffix
5609 @opindex print-sysroot-headers-suffix
5610 Print the suffix added to the target sysroot when searching for
5611 headers, or give an error if the compiler is not configured with such
5612 a suffix---and don't do anything else.
5613
5614 @item -dumpmachine
5615 @opindex dumpmachine
5616 Print the compiler's target machine (for example,
5617 @samp{i686-pc-linux-gnu})---and don't do anything else.
5618
5619 @item -dumpversion
5620 @opindex dumpversion
5621 Print the compiler version (for example, @samp{3.0})---and don't do
5622 anything else.
5623
5624 @item -dumpspecs
5625 @opindex dumpspecs
5626 Print the compiler's built-in specs---and don't do anything else.  (This
5627 is used when GCC itself is being built.)  @xref{Spec Files}.
5628
5629 @item -feliminate-unused-debug-types
5630 @opindex feliminate-unused-debug-types
5631 Normally, when producing DWARF2 output, GCC will emit debugging
5632 information for all types declared in a compilation
5633 unit, regardless of whether or not they are actually used
5634 in that compilation unit.  Sometimes this is useful, such as
5635 if, in the debugger, you want to cast a value to a type that is
5636 not actually used in your program (but is declared).  More often,
5637 however, this results in a significant amount of wasted space.
5638 With this option, GCC will avoid producing debug symbol output
5639 for types that are nowhere used in the source file being compiled.
5640 @end table
5641
5642 @node Optimize Options
5643 @section Options That Control Optimization
5644 @cindex optimize options
5645 @cindex options, optimization
5646
5647 These options control various sorts of optimizations.
5648
5649 Without any optimization option, the compiler's goal is to reduce the
5650 cost of compilation and to make debugging produce the expected
5651 results.  Statements are independent: if you stop the program with a
5652 breakpoint between statements, you can then assign a new value to any
5653 variable or change the program counter to any other statement in the
5654 function and get exactly the results you would expect from the source
5655 code.
5656
5657 Turning on optimization flags makes the compiler attempt to improve
5658 the performance and/or code size at the expense of compilation time
5659 and possibly the ability to debug the program.
5660
5661 The compiler performs optimization based on the knowledge it has of the
5662 program.  Compiling multiple files at once to a single output file mode allows
5663 the compiler to use information gained from all of the files when compiling
5664 each of them.
5665
5666 Not all optimizations are controlled directly by a flag.  Only
5667 optimizations that have a flag are listed in this section.
5668
5669 Most optimizations are only enabled if an @option{-O} level is set on
5670 the command line.  Otherwise they are disabled, even if individual             
5671 optimization flags are specified.
5672
5673 Depending on the target and how GCC was configured, a slightly different
5674 set of optimizations may be enabled at each @option{-O} level than
5675 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
5676 to find out the exact set of optimizations that are enabled at each level.
5677 @xref{Overall Options}, for examples.
5678
5679 @table @gcctabopt
5680 @item -O
5681 @itemx -O1
5682 @opindex O
5683 @opindex O1
5684 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5685 more memory for a large function.
5686
5687 With @option{-O}, the compiler tries to reduce code size and execution
5688 time, without performing any optimizations that take a great deal of
5689 compilation time.
5690
5691 @option{-O} turns on the following optimization flags:
5692 @gccoptlist{
5693 -fauto-inc-dec @gol
5694 -fcprop-registers @gol
5695 -fdce @gol
5696 -fdefer-pop @gol
5697 -fdelayed-branch @gol
5698 -fdse @gol
5699 -fguess-branch-probability @gol
5700 -fif-conversion2 @gol
5701 -fif-conversion @gol
5702 -fipa-pure-const @gol
5703 -fipa-reference @gol
5704 -fmerge-constants
5705 -fsplit-wide-types @gol
5706 -ftree-builtin-call-dce @gol
5707 -ftree-ccp @gol
5708 -ftree-ch @gol
5709 -ftree-copyrename @gol
5710 -ftree-dce @gol
5711 -ftree-dominator-opts @gol
5712 -ftree-dse @gol
5713 -ftree-forwprop @gol
5714 -ftree-fre @gol
5715 -ftree-phiprop @gol
5716 -ftree-sra @gol
5717 -ftree-pta @gol
5718 -ftree-ter @gol
5719 -funit-at-a-time}
5720
5721 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5722 where doing so does not interfere with debugging.
5723
5724 @item -O2
5725 @opindex O2
5726 Optimize even more.  GCC performs nearly all supported optimizations
5727 that do not involve a space-speed tradeoff.
5728 As compared to @option{-O}, this option increases both compilation time
5729 and the performance of the generated code.
5730
5731 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5732 also turns on the following optimization flags:
5733 @gccoptlist{-fthread-jumps @gol
5734 -falign-functions  -falign-jumps @gol
5735 -falign-loops  -falign-labels @gol
5736 -fcaller-saves @gol
5737 -fcrossjumping @gol
5738 -fcse-follow-jumps  -fcse-skip-blocks @gol
5739 -fdelete-null-pointer-checks @gol
5740 -fexpensive-optimizations @gol
5741 -fgcse  -fgcse-lm  @gol
5742 -finline-small-functions @gol
5743 -findirect-inlining @gol
5744 -fipa-sra @gol
5745 -foptimize-sibling-calls @gol
5746 -fpeephole2 @gol
5747 -fregmove @gol
5748 -freorder-blocks  -freorder-functions @gol
5749 -frerun-cse-after-loop  @gol
5750 -fsched-interblock  -fsched-spec @gol
5751 -fschedule-insns  -fschedule-insns2 @gol
5752 -fstrict-aliasing -fstrict-overflow @gol
5753 -ftree-switch-conversion @gol
5754 -ftree-pre @gol
5755 -ftree-vrp}
5756
5757 Please note the warning under @option{-fgcse} about
5758 invoking @option{-O2} on programs that use computed gotos.
5759
5760 @item -O3
5761 @opindex O3
5762 Optimize yet more.  @option{-O3} turns on all optimizations specified
5763 by @option{-O2} and also turns on the @option{-finline-functions},
5764 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5765 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5766
5767 @item -O0
5768 @opindex O0
5769 Reduce compilation time and make debugging produce the expected
5770 results.  This is the default.
5771
5772 @item -Os
5773 @opindex Os
5774 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5775 do not typically increase code size.  It also performs further
5776 optimizations designed to reduce code size.
5777
5778 @option{-Os} disables the following optimization flags:
5779 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5780 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5781 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5782
5783 If you use multiple @option{-O} options, with or without level numbers,
5784 the last such option is the one that is effective.
5785 @end table
5786
5787 Options of the form @option{-f@var{flag}} specify machine-independent
5788 flags.  Most flags have both positive and negative forms; the negative
5789 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5790 below, only one of the forms is listed---the one you typically will
5791 use.  You can figure out the other form by either removing @samp{no-}
5792 or adding it.
5793
5794 The following options control specific optimizations.  They are either
5795 activated by @option{-O} options or are related to ones that are.  You
5796 can use the following flags in the rare cases when ``fine-tuning'' of
5797 optimizations to be performed is desired.
5798
5799 @table @gcctabopt
5800 @item -fno-default-inline
5801 @opindex fno-default-inline
5802 Do not make member functions inline by default merely because they are
5803 defined inside the class scope (C++ only).  Otherwise, when you specify
5804 @w{@option{-O}}, member functions defined inside class scope are compiled
5805 inline by default; i.e., you don't need to add @samp{inline} in front of
5806 the member function name.
5807
5808 @item -fno-defer-pop
5809 @opindex fno-defer-pop
5810 Always pop the arguments to each function call as soon as that function
5811 returns.  For machines which must pop arguments after a function call,
5812 the compiler normally lets arguments accumulate on the stack for several
5813 function calls and pops them all at once.
5814
5815 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5816
5817 @item -fforward-propagate
5818 @opindex fforward-propagate
5819 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5820 instructions and checks if the result can be simplified.  If loop unrolling
5821 is active, two passes are performed and the second is scheduled after
5822 loop unrolling.
5823
5824 This option is enabled by default at optimization levels @option{-O},
5825 @option{-O2}, @option{-O3}, @option{-Os}.
5826
5827 @item -fomit-frame-pointer
5828 @opindex fomit-frame-pointer
5829 Don't keep the frame pointer in a register for functions that
5830 don't need one.  This avoids the instructions to save, set up and
5831 restore frame pointers; it also makes an extra register available
5832 in many functions.  @strong{It also makes debugging impossible on
5833 some machines.}
5834
5835 On some machines, such as the VAX, this flag has no effect, because
5836 the standard calling sequence automatically handles the frame pointer
5837 and nothing is saved by pretending it doesn't exist.  The
5838 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5839 whether a target machine supports this flag.  @xref{Registers,,Register
5840 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5841
5842 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5843
5844 @item -foptimize-sibling-calls
5845 @opindex foptimize-sibling-calls
5846 Optimize sibling and tail recursive calls.
5847
5848 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5849
5850 @item -fno-inline
5851 @opindex fno-inline
5852 Don't pay attention to the @code{inline} keyword.  Normally this option
5853 is used to keep the compiler from expanding any functions inline.
5854 Note that if you are not optimizing, no functions can be expanded inline.
5855
5856 @item -finline-small-functions
5857 @opindex finline-small-functions
5858 Integrate functions into their callers when their body is smaller than expected
5859 function call code (so overall size of program gets smaller).  The compiler
5860 heuristically decides which functions are simple enough to be worth integrating
5861 in this way.
5862
5863 Enabled at level @option{-O2}.
5864
5865 @item -findirect-inlining
5866 @opindex findirect-inlining
5867 Inline also indirect calls that are discovered to be known at compile
5868 time thanks to previous inlining.  This option has any effect only
5869 when inlining itself is turned on by the @option{-finline-functions}
5870 or @option{-finline-small-functions} options.
5871
5872 Enabled at level @option{-O2}.
5873
5874 @item -finline-functions
5875 @opindex finline-functions
5876 Integrate all simple functions into their callers.  The compiler
5877 heuristically decides which functions are simple enough to be worth
5878 integrating in this way.
5879
5880 If all calls to a given function are integrated, and the function is
5881 declared @code{static}, then the function is normally not output as
5882 assembler code in its own right.
5883
5884 Enabled at level @option{-O3}.
5885
5886 @item -finline-functions-called-once
5887 @opindex finline-functions-called-once
5888 Consider all @code{static} functions called once for inlining into their
5889 caller even if they are not marked @code{inline}.  If a call to a given
5890 function is integrated, then the function is not output as assembler code
5891 in its own right.
5892
5893 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
5894
5895 @item -fearly-inlining
5896 @opindex fearly-inlining
5897 Inline functions marked by @code{always_inline} and functions whose body seems
5898 smaller than the function call overhead early before doing
5899 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5900 makes profiling significantly cheaper and usually inlining faster on programs
5901 having large chains of nested wrapper functions.
5902
5903 Enabled by default.
5904
5905 @item -fipa-sra
5906 @opindex fipa-sra
5907 Perform interprocedural scalar replacement of aggregates, removal of
5908 unused parameters and replacement of parameters passed by reference
5909 by parameters passed by value.
5910
5911 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
5912
5913 @item -finline-limit=@var{n}
5914 @opindex finline-limit
5915 By default, GCC limits the size of functions that can be inlined.  This flag
5916 allows coarse control of this limit.  @var{n} is the size of functions that
5917 can be inlined in number of pseudo instructions.
5918
5919 Inlining is actually controlled by a number of parameters, which may be
5920 specified individually by using @option{--param @var{name}=@var{value}}.
5921 The @option{-finline-limit=@var{n}} option sets some of these parameters
5922 as follows:
5923
5924 @table @gcctabopt
5925 @item max-inline-insns-single
5926 is set to @var{n}/2.
5927 @item max-inline-insns-auto
5928 is set to @var{n}/2.
5929 @end table
5930
5931 See below for a documentation of the individual
5932 parameters controlling inlining and for the defaults of these parameters.
5933
5934 @emph{Note:} there may be no value to @option{-finline-limit} that results
5935 in default behavior.
5936
5937 @emph{Note:} pseudo instruction represents, in this particular context, an
5938 abstract measurement of function's size.  In no way does it represent a count
5939 of assembly instructions and as such its exact meaning might change from one
5940 release to an another.
5941
5942 @item -fkeep-inline-functions
5943 @opindex fkeep-inline-functions
5944 In C, emit @code{static} functions that are declared @code{inline}
5945 into the object file, even if the function has been inlined into all
5946 of its callers.  This switch does not affect functions using the
5947 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5948 inline functions into the object file.
5949
5950 @item -fkeep-static-consts
5951 @opindex fkeep-static-consts
5952 Emit variables declared @code{static const} when optimization isn't turned
5953 on, even if the variables aren't referenced.
5954
5955 GCC enables this option by default.  If you want to force the compiler to
5956 check if the variable was referenced, regardless of whether or not
5957 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5958
5959 @item -fmerge-constants
5960 @opindex fmerge-constants
5961 Attempt to merge identical constants (string constants and floating point
5962 constants) across compilation units.
5963
5964 This option is the default for optimized compilation if the assembler and
5965 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5966 behavior.
5967
5968 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5969
5970 @item -fmerge-all-constants
5971 @opindex fmerge-all-constants
5972 Attempt to merge identical constants and identical variables.
5973
5974 This option implies @option{-fmerge-constants}.  In addition to
5975 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5976 arrays or initialized constant variables with integral or floating point
5977 types.  Languages like C or C++ require each variable, including multiple
5978 instances of the same variable in recursive calls, to have distinct locations,
5979 so using this option will result in non-conforming
5980 behavior.
5981
5982 @item -fmodulo-sched
5983 @opindex fmodulo-sched
5984 Perform swing modulo scheduling immediately before the first scheduling
5985 pass.  This pass looks at innermost loops and reorders their
5986 instructions by overlapping different iterations.
5987
5988 @item -fmodulo-sched-allow-regmoves
5989 @opindex fmodulo-sched-allow-regmoves
5990 Perform more aggressive SMS based modulo scheduling with register moves
5991 allowed.  By setting this flag certain anti-dependences edges will be
5992 deleted which will trigger the generation of reg-moves based on the
5993 life-range analysis.  This option is effective only with
5994 @option{-fmodulo-sched} enabled.
5995
5996 @item -fno-branch-count-reg
5997 @opindex fno-branch-count-reg
5998 Do not use ``decrement and branch'' instructions on a count register,
5999 but instead generate a sequence of instructions that decrement a
6000 register, compare it against zero, then branch based upon the result.
6001 This option is only meaningful on architectures that support such
6002 instructions, which include x86, PowerPC, IA-64 and S/390.
6003
6004 The default is @option{-fbranch-count-reg}.
6005
6006 @item -fno-function-cse
6007 @opindex fno-function-cse
6008 Do not put function addresses in registers; make each instruction that
6009 calls a constant function contain the function's address explicitly.
6010
6011 This option results in less efficient code, but some strange hacks
6012 that alter the assembler output may be confused by the optimizations
6013 performed when this option is not used.
6014
6015 The default is @option{-ffunction-cse}
6016
6017 @item -fno-zero-initialized-in-bss
6018 @opindex fno-zero-initialized-in-bss
6019 If the target supports a BSS section, GCC by default puts variables that
6020 are initialized to zero into BSS@.  This can save space in the resulting
6021 code.
6022
6023 This option turns off this behavior because some programs explicitly
6024 rely on variables going to the data section.  E.g., so that the
6025 resulting executable can find the beginning of that section and/or make
6026 assumptions based on that.
6027
6028 The default is @option{-fzero-initialized-in-bss}.
6029
6030 @item -fmudflap -fmudflapth -fmudflapir
6031 @opindex fmudflap
6032 @opindex fmudflapth
6033 @opindex fmudflapir
6034 @cindex bounds checking
6035 @cindex mudflap
6036 For front-ends that support it (C and C++), instrument all risky
6037 pointer/array dereferencing operations, some standard library
6038 string/heap functions, and some other associated constructs with
6039 range/validity tests.  Modules so instrumented should be immune to
6040 buffer overflows, invalid heap use, and some other classes of C/C++
6041 programming errors.  The instrumentation relies on a separate runtime
6042 library (@file{libmudflap}), which will be linked into a program if
6043 @option{-fmudflap} is given at link time.  Run-time behavior of the
6044 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6045 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6046 for its options.
6047
6048 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6049 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6050 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6051 instrumentation should ignore pointer reads.  This produces less
6052 instrumentation (and therefore faster execution) and still provides
6053 some protection against outright memory corrupting writes, but allows
6054 erroneously read data to propagate within a program.
6055
6056 @item -fthread-jumps
6057 @opindex fthread-jumps
6058 Perform optimizations where we check to see if a jump branches to a
6059 location where another comparison subsumed by the first is found.  If
6060 so, the first branch is redirected to either the destination of the
6061 second branch or a point immediately following it, depending on whether
6062 the condition is known to be true or false.
6063
6064 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6065
6066 @item -fsplit-wide-types
6067 @opindex fsplit-wide-types
6068 When using a type that occupies multiple registers, such as @code{long
6069 long} on a 32-bit system, split the registers apart and allocate them
6070 independently.  This normally generates better code for those types,
6071 but may make debugging more difficult.
6072
6073 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6074 @option{-Os}.
6075
6076 @item -fcse-follow-jumps
6077 @opindex fcse-follow-jumps
6078 In common subexpression elimination (CSE), scan through jump instructions
6079 when the target of the jump is not reached by any other path.  For
6080 example, when CSE encounters an @code{if} statement with an
6081 @code{else} clause, CSE will follow the jump when the condition
6082 tested is false.
6083
6084 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6085
6086 @item -fcse-skip-blocks
6087 @opindex fcse-skip-blocks
6088 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6089 follow jumps which conditionally skip over blocks.  When CSE
6090 encounters a simple @code{if} statement with no else clause,
6091 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6092 body of the @code{if}.
6093
6094 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6095
6096 @item -frerun-cse-after-loop
6097 @opindex frerun-cse-after-loop
6098 Re-run common subexpression elimination after loop optimizations has been
6099 performed.
6100
6101 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6102
6103 @item -fgcse
6104 @opindex fgcse
6105 Perform a global common subexpression elimination pass.
6106 This pass also performs global constant and copy propagation.
6107
6108 @emph{Note:} When compiling a program using computed gotos, a GCC
6109 extension, you may get better runtime performance if you disable
6110 the global common subexpression elimination pass by adding
6111 @option{-fno-gcse} to the command line.
6112
6113 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6114
6115 @item -fgcse-lm
6116 @opindex fgcse-lm
6117 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6118 attempt to move loads which are only killed by stores into themselves.  This
6119 allows a loop containing a load/store sequence to be changed to a load outside
6120 the loop, and a copy/store within the loop.
6121
6122 Enabled by default when gcse is enabled.
6123
6124 @item -fgcse-sm
6125 @opindex fgcse-sm
6126 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6127 global common subexpression elimination.  This pass will attempt to move
6128 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6129 loops containing a load/store sequence can be changed to a load before
6130 the loop and a store after the loop.
6131
6132 Not enabled at any optimization level.
6133
6134 @item -fgcse-las
6135 @opindex fgcse-las
6136 When @option{-fgcse-las} is enabled, the global common subexpression
6137 elimination pass eliminates redundant loads that come after stores to the
6138 same memory location (both partial and full redundancies).
6139
6140 Not enabled at any optimization level.
6141
6142 @item -fgcse-after-reload
6143 @opindex fgcse-after-reload
6144 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6145 pass is performed after reload.  The purpose of this pass is to cleanup
6146 redundant spilling.
6147
6148 @item -funsafe-loop-optimizations
6149 @opindex funsafe-loop-optimizations
6150 If given, the loop optimizer will assume that loop indices do not
6151 overflow, and that the loops with nontrivial exit condition are not
6152 infinite.  This enables a wider range of loop optimizations even if
6153 the loop optimizer itself cannot prove that these assumptions are valid.
6154 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6155 if it finds this kind of loop.
6156
6157 @item -fcrossjumping
6158 @opindex fcrossjumping
6159 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6160 resulting code may or may not perform better than without cross-jumping.
6161
6162 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6163
6164 @item -fauto-inc-dec
6165 @opindex fauto-inc-dec
6166 Combine increments or decrements of addresses with memory accesses.
6167 This pass is always skipped on architectures that do not have
6168 instructions to support this.  Enabled by default at @option{-O} and
6169 higher on architectures that support this.
6170
6171 @item -fdce
6172 @opindex fdce
6173 Perform dead code elimination (DCE) on RTL@.
6174 Enabled by default at @option{-O} and higher.
6175
6176 @item -fdse
6177 @opindex fdse
6178 Perform dead store elimination (DSE) on RTL@.
6179 Enabled by default at @option{-O} and higher.
6180
6181 @item -fif-conversion
6182 @opindex fif-conversion
6183 Attempt to transform conditional jumps into branch-less equivalents.  This
6184 include use of conditional moves, min, max, set flags and abs instructions, and
6185 some tricks doable by standard arithmetics.  The use of conditional execution
6186 on chips where it is available is controlled by @code{if-conversion2}.
6187
6188 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6189
6190 @item -fif-conversion2
6191 @opindex fif-conversion2
6192 Use conditional execution (where available) to transform conditional jumps into
6193 branch-less equivalents.
6194
6195 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6196
6197 @item -fdelete-null-pointer-checks
6198 @opindex fdelete-null-pointer-checks
6199 Assume that programs cannot safely dereference null pointers, and that
6200 no code or data element resides there.  This enables simple constant
6201 folding optimizations at all optimization levels.  In addition, other
6202 optimization passes in GCC use this flag to control global dataflow
6203 analyses that eliminate useless checks for null pointers; these assume
6204 that if a pointer is checked after it has already been dereferenced,
6205 it cannot be null.
6206
6207 Note however that in some environments this assumption is not true.
6208 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6209 for programs which depend on that behavior.
6210
6211 Some targets, especially embedded ones, disable this option at all levels.
6212 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6213 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6214 are enabled independently at different optimization levels.
6215
6216 @item -fexpensive-optimizations
6217 @opindex fexpensive-optimizations
6218 Perform a number of minor optimizations that are relatively expensive.
6219
6220 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6221
6222 @item -foptimize-register-move
6223 @itemx -fregmove
6224 @opindex foptimize-register-move
6225 @opindex fregmove
6226 Attempt to reassign register numbers in move instructions and as
6227 operands of other simple instructions in order to maximize the amount of
6228 register tying.  This is especially helpful on machines with two-operand
6229 instructions.
6230
6231 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6232 optimization.
6233
6234 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6235
6236 @item -fira-algorithm=@var{algorithm}
6237 Use specified coloring algorithm for the integrated register
6238 allocator.  The @var{algorithm} argument should be @code{priority} or
6239 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6240 the second one specifies Chaitin-Briggs coloring.  The second
6241 algorithm can be unimplemented for some architectures.  If it is
6242 implemented, it is the default because Chaitin-Briggs coloring as a
6243 rule generates a better code.
6244
6245 @item -fira-region=@var{region}
6246 Use specified regions for the integrated register allocator.  The
6247 @var{region} argument should be one of @code{all}, @code{mixed}, or
6248 @code{one}.  The first value means using all loops as register
6249 allocation regions, the second value which is the default means using
6250 all loops except for loops with small register pressure as the
6251 regions, and third one means using all function as a single region.
6252 The first value can give best result for machines with small size and
6253 irregular register set, the third one results in faster and generates
6254 decent code and the smallest size code, and the default value usually
6255 give the best results in most cases and for most architectures.
6256
6257 @item -fira-coalesce
6258 @opindex fira-coalesce
6259 Do optimistic register coalescing.  This option might be profitable for
6260 architectures with big regular register files.
6261
6262 @item -fira-loop-pressure
6263 @opindex fira-loop-pressure
6264 Use IRA to evaluate register pressure in loops for decision to move
6265 loop invariants.  Usage of this option usually results in generation
6266 of faster and smaller code on machines with big register files (>= 32
6267 registers) but it can slow compiler down.
6268
6269 This option is enabled at level @option{-O3} for some targets.
6270
6271 @item -fno-ira-share-save-slots
6272 @opindex fno-ira-share-save-slots
6273 Switch off sharing stack slots used for saving call used hard
6274 registers living through a call.  Each hard register will get a
6275 separate stack slot and as a result function stack frame will be
6276 bigger.
6277
6278 @item -fno-ira-share-spill-slots
6279 @opindex fno-ira-share-spill-slots
6280 Switch off sharing stack slots allocated for pseudo-registers.  Each
6281 pseudo-register which did not get a hard register will get a separate
6282 stack slot and as a result function stack frame will be bigger.
6283
6284 @item -fira-verbose=@var{n}
6285 @opindex fira-verbose
6286 Set up how verbose dump file for the integrated register allocator
6287 will be.  Default value is 5.  If the value is greater or equal to 10,
6288 the dump file will be stderr as if the value were @var{n} minus 10.
6289
6290 @item -fdelayed-branch
6291 @opindex fdelayed-branch
6292 If supported for the target machine, attempt to reorder instructions
6293 to exploit instruction slots available after delayed branch
6294 instructions.
6295
6296 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6297
6298 @item -fschedule-insns
6299 @opindex fschedule-insns
6300 If supported for the target machine, attempt to reorder instructions to
6301 eliminate execution stalls due to required data being unavailable.  This
6302 helps machines that have slow floating point or memory load instructions
6303 by allowing other instructions to be issued until the result of the load
6304 or floating point instruction is required.
6305
6306 Enabled at levels @option{-O2}, @option{-O3}.
6307
6308 @item -fschedule-insns2
6309 @opindex fschedule-insns2
6310 Similar to @option{-fschedule-insns}, but requests an additional pass of
6311 instruction scheduling after register allocation has been done.  This is
6312 especially useful on machines with a relatively small number of
6313 registers and where memory load instructions take more than one cycle.
6314
6315 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6316
6317 @item -fno-sched-interblock
6318 @opindex fno-sched-interblock
6319 Don't schedule instructions across basic blocks.  This is normally
6320 enabled by default when scheduling before register allocation, i.e.@:
6321 with @option{-fschedule-insns} or at @option{-O2} or higher.
6322
6323 @item -fno-sched-spec
6324 @opindex fno-sched-spec
6325 Don't allow speculative motion of non-load instructions.  This is normally
6326 enabled by default when scheduling before register allocation, i.e.@:
6327 with @option{-fschedule-insns} or at @option{-O2} or higher.
6328
6329 @item -fsched-pressure
6330 @opindex fsched-pressure
6331 Enable register pressure sensitive insn scheduling before the register
6332 allocation.  This only makes sense when scheduling before register
6333 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6334 @option{-O2} or higher.  Usage of this option can improve the
6335 generated code and decrease its size by preventing register pressure
6336 increase above the number of available hard registers and as a
6337 consequence register spills in the register allocation.
6338
6339 @item -fsched-spec-load
6340 @opindex fsched-spec-load
6341 Allow speculative motion of some load instructions.  This only makes
6342 sense when scheduling before register allocation, i.e.@: with
6343 @option{-fschedule-insns} or at @option{-O2} or higher.
6344
6345 @item -fsched-spec-load-dangerous
6346 @opindex fsched-spec-load-dangerous
6347 Allow speculative motion of more load instructions.  This only makes
6348 sense when scheduling before register allocation, i.e.@: with
6349 @option{-fschedule-insns} or at @option{-O2} or higher.
6350
6351 @item -fsched-stalled-insns
6352 @itemx -fsched-stalled-insns=@var{n}
6353 @opindex fsched-stalled-insns
6354 Define how many insns (if any) can be moved prematurely from the queue
6355 of stalled insns into the ready list, during the second scheduling pass.
6356 @option{-fno-sched-stalled-insns} means that no insns will be moved
6357 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6358 on how many queued insns can be moved prematurely.
6359 @option{-fsched-stalled-insns} without a value is equivalent to
6360 @option{-fsched-stalled-insns=1}.
6361
6362 @item -fsched-stalled-insns-dep
6363 @itemx -fsched-stalled-insns-dep=@var{n}
6364 @opindex fsched-stalled-insns-dep
6365 Define how many insn groups (cycles) will be examined for a dependency
6366 on a stalled insn that is candidate for premature removal from the queue
6367 of stalled insns.  This has an effect only during the second scheduling pass,
6368 and only if @option{-fsched-stalled-insns} is used.
6369 @option{-fno-sched-stalled-insns-dep} is equivalent to
6370 @option{-fsched-stalled-insns-dep=0}.
6371 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6372 @option{-fsched-stalled-insns-dep=1}.
6373
6374 @item -fsched2-use-superblocks
6375 @opindex fsched2-use-superblocks
6376 When scheduling after register allocation, do use superblock scheduling
6377 algorithm.  Superblock scheduling allows motion across basic block boundaries
6378 resulting on faster schedules.  This option is experimental, as not all machine
6379 descriptions used by GCC model the CPU closely enough to avoid unreliable
6380 results from the algorithm.
6381
6382 This only makes sense when scheduling after register allocation, i.e.@: with
6383 @option{-fschedule-insns2} or at @option{-O2} or higher.
6384
6385 @item -fsched-group-heuristic
6386 @opindex fsched-group-heuristic
6387 Enable the group heuristic in the scheduler.  This heuristic favors 
6388 the instruction that belongs to a schedule group.  This is enabled 
6389 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6390 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6391
6392 @item -fsched-critical-path-heuristic
6393 @opindex fsched-critical-path-heuristic
6394 Enable the critical-path heuristic in the scheduler.  This heuristic favors 
6395 instructions on the critical path.  This is enabled by default when 
6396 scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6397 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6398
6399 @item -fsched-spec-insn-heuristic
6400 @opindex fsched-spec-insn-heuristic
6401 Enable the speculative instruction heuristic in the scheduler.  This 
6402 heuristic favors speculative instructions with greater dependency weakness.  
6403 This is enabled by default when scheduling is enabled, i.e.@: 
6404 with @option{-fschedule-insns} or @option{-fschedule-insns2} 
6405 or at @option{-O2} or higher.
6406
6407 @item -fsched-rank-heuristic
6408 @opindex fsched-rank-heuristic
6409 Enable the rank heuristic in the scheduler.  This heuristic favors 
6410 the instruction belonging to a basic block with greater size or frequency.  
6411 This is enabled by default when scheduling is enabled, i.e.@: 
6412 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6413 at @option{-O2} or higher.
6414
6415 @item -fsched-last-insn-heuristic
6416 @opindex fsched-last-insn-heuristic
6417 Enable the last-instruction heuristic in the scheduler.  This heuristic 
6418 favors the instruction that is less dependent on the last instruction
6419 scheduled.  This is enabled by default when scheduling is enabled, 
6420 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6421 at @option{-O2} or higher.
6422
6423 @item -fsched-dep-count-heuristic
6424 @opindex fsched-dep-count-heuristic
6425 Enable the dependent-count heuristic in the scheduler.  This heuristic 
6426 favors the instruction that has more instructions depending on it.  
6427 This is enabled by default when scheduling is enabled, i.e.@: 
6428 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6429 at @option{-O2} or higher.
6430
6431 @item -fsched2-use-traces
6432 @opindex fsched2-use-traces
6433 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
6434 allocation and additionally perform code duplication in order to increase the
6435 size of superblocks using tracer pass.  See @option{-ftracer} for details on
6436 trace formation.
6437
6438 This mode should produce faster but significantly longer programs.  Also
6439 without @option{-fbranch-probabilities} the traces constructed may not
6440 match the reality and hurt the performance.  This only makes
6441 sense when scheduling after register allocation, i.e.@: with
6442 @option{-fschedule-insns2} or at @option{-O2} or higher.
6443
6444 @item -freschedule-modulo-scheduled-loops
6445 @opindex freschedule-modulo-scheduled-loops
6446 The modulo scheduling comes before the traditional scheduling, if a loop
6447 was modulo scheduled we may want to prevent the later scheduling passes
6448 from changing its schedule, we use this option to control that.
6449
6450 @item -fselective-scheduling
6451 @opindex fselective-scheduling
6452 Schedule instructions using selective scheduling algorithm.  Selective
6453 scheduling runs instead of the first scheduler pass.
6454
6455 @item -fselective-scheduling2
6456 @opindex fselective-scheduling2
6457 Schedule instructions using selective scheduling algorithm.  Selective
6458 scheduling runs instead of the second scheduler pass.
6459
6460 @item -fsel-sched-pipelining
6461 @opindex fsel-sched-pipelining
6462 Enable software pipelining of innermost loops during selective scheduling.
6463 This option has no effect until one of @option{-fselective-scheduling} or
6464 @option{-fselective-scheduling2} is turned on.
6465
6466 @item -fsel-sched-pipelining-outer-loops
6467 @opindex fsel-sched-pipelining-outer-loops
6468 When pipelining loops during selective scheduling, also pipeline outer loops.
6469 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6470
6471 @item -fcaller-saves
6472 @opindex fcaller-saves
6473 Enable values to be allocated in registers that will be clobbered by
6474 function calls, by emitting extra instructions to save and restore the
6475 registers around such calls.  Such allocation is done only when it
6476 seems to result in better code than would otherwise be produced.
6477
6478 This option is always enabled by default on certain machines, usually
6479 those which have no call-preserved registers to use instead.
6480
6481 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6482
6483 @item -fconserve-stack
6484 @opindex fconserve-stack
6485 Attempt to minimize stack usage.  The compiler will attempt to use less
6486 stack space, even if that makes the program slower.  This option
6487 implies setting the @option{large-stack-frame} parameter to 100
6488 and the @option{large-stack-frame-growth} parameter to 400.
6489
6490 @item -ftree-reassoc
6491 @opindex ftree-reassoc
6492 Perform reassociation on trees.  This flag is enabled by default
6493 at @option{-O} and higher.
6494
6495 @item -ftree-pre
6496 @opindex ftree-pre
6497 Perform partial redundancy elimination (PRE) on trees.  This flag is
6498 enabled by default at @option{-O2} and @option{-O3}.
6499
6500 @item -ftree-forwprop
6501 @opindex ftree-forwprop
6502 Perform forward propagation on trees.  This flag is enabled by default
6503 at @option{-O} and higher.
6504
6505 @item -ftree-fre
6506 @opindex ftree-fre
6507 Perform full redundancy elimination (FRE) on trees.  The difference
6508 between FRE and PRE is that FRE only considers expressions
6509 that are computed on all paths leading to the redundant computation.
6510 This analysis is faster than PRE, though it exposes fewer redundancies.
6511 This flag is enabled by default at @option{-O} and higher.
6512
6513 @item -ftree-phiprop
6514 @opindex ftree-phiprop
6515 Perform hoisting of loads from conditional pointers on trees.  This
6516 pass is enabled by default at @option{-O} and higher.
6517
6518 @item -ftree-copy-prop
6519 @opindex ftree-copy-prop
6520 Perform copy propagation on trees.  This pass eliminates unnecessary
6521 copy operations.  This flag is enabled by default at @option{-O} and
6522 higher.
6523
6524 @item -fipa-pure-const
6525 @opindex fipa-pure-const
6526 Discover which functions are pure or constant.
6527 Enabled by default at @option{-O} and higher.
6528
6529 @item -fipa-reference
6530 @opindex fipa-reference
6531 Discover which static variables do not escape cannot escape the
6532 compilation unit.
6533 Enabled by default at @option{-O} and higher.
6534
6535 @item -fipa-struct-reorg
6536 @opindex fipa-struct-reorg
6537 Perform structure reorganization optimization, that change C-like structures
6538 layout in order to better utilize spatial locality.  This transformation is
6539 affective for programs containing arrays of structures.  Available in two
6540 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6541 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
6542 to provide the safety of this transformation.  It works only in whole program
6543 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
6544 enabled.  Structures considered @samp{cold} by this transformation are not
6545 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6546
6547 With this flag, the program debug info reflects a new structure layout.
6548
6549 @item -fipa-pta
6550 @opindex fipa-pta
6551 Perform interprocedural pointer analysis.  This option is experimental
6552 and does not affect generated code.
6553
6554 @item -fipa-cp
6555 @opindex fipa-cp
6556 Perform interprocedural constant propagation.
6557 This optimization analyzes the program to determine when values passed
6558 to functions are constants and then optimizes accordingly.
6559 This optimization can substantially increase performance
6560 if the application has constants passed to functions.
6561 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6562
6563 @item -fipa-cp-clone
6564 @opindex fipa-cp-clone
6565 Perform function cloning to make interprocedural constant propagation stronger.
6566 When enabled, interprocedural constant propagation will perform function cloning
6567 when externally visible function can be called with constant arguments.
6568 Because this optimization can create multiple copies of functions,
6569 it may significantly increase code size
6570 (see @option{--param ipcp-unit-growth=@var{value}}).
6571 This flag is enabled by default at @option{-O3}.
6572
6573 @item -fipa-matrix-reorg
6574 @opindex fipa-matrix-reorg
6575 Perform matrix flattening and transposing.
6576 Matrix flattening tries to replace an @math{m}-dimensional matrix
6577 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6578 This reduces the level of indirection needed for accessing the elements
6579 of the matrix. The second optimization is matrix transposing that
6580 attempts to change the order of the matrix's dimensions in order to
6581 improve cache locality.
6582 Both optimizations need the @option{-fwhole-program} flag.
6583 Transposing is enabled only if profiling information is available.
6584
6585 @item -ftree-sink
6586 @opindex ftree-sink
6587 Perform forward store motion  on trees.  This flag is
6588 enabled by default at @option{-O} and higher.
6589
6590 @item -ftree-ccp
6591 @opindex ftree-ccp
6592 Perform sparse conditional constant propagation (CCP) on trees.  This
6593 pass only operates on local scalar variables and is enabled by default
6594 at @option{-O} and higher.
6595
6596 @item -ftree-switch-conversion
6597 Perform conversion of simple initializations in a switch to
6598 initializations from a scalar array.  This flag is enabled by default
6599 at @option{-O2} and higher.
6600
6601 @item -ftree-dce
6602 @opindex ftree-dce
6603 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6604 default at @option{-O} and higher.
6605
6606 @item -ftree-builtin-call-dce
6607 @opindex ftree-builtin-call-dce
6608 Perform conditional dead code elimination (DCE) for calls to builtin functions
6609 that may set @code{errno} but are otherwise side-effect free.  This flag is
6610 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6611 specified.
6612
6613 @item -ftree-dominator-opts
6614 @opindex ftree-dominator-opts
6615 Perform a variety of simple scalar cleanups (constant/copy
6616 propagation, redundancy elimination, range propagation and expression
6617 simplification) based on a dominator tree traversal.  This also
6618 performs jump threading (to reduce jumps to jumps). This flag is
6619 enabled by default at @option{-O} and higher.
6620
6621 @item -ftree-dse
6622 @opindex ftree-dse
6623 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6624 a memory location which will later be overwritten by another store without
6625 any intervening loads.  In this case the earlier store can be deleted.  This
6626 flag is enabled by default at @option{-O} and higher.
6627
6628 @item -ftree-ch
6629 @opindex ftree-ch
6630 Perform loop header copying on trees.  This is beneficial since it increases
6631 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6632 is enabled by default at @option{-O} and higher.  It is not enabled
6633 for @option{-Os}, since it usually increases code size.
6634
6635 @item -ftree-loop-optimize
6636 @opindex ftree-loop-optimize
6637 Perform loop optimizations on trees.  This flag is enabled by default
6638 at @option{-O} and higher.
6639
6640 @item -ftree-loop-linear
6641 @opindex ftree-loop-linear
6642 Perform linear loop transformations on tree.  This flag can improve cache
6643 performance and allow further loop optimizations to take place.
6644
6645 @item -floop-interchange
6646 Perform loop interchange transformations on loops.  Interchanging two
6647 nested loops switches the inner and outer loops.  For example, given a
6648 loop like:
6649 @smallexample
6650 DO J = 1, M
6651   DO I = 1, N
6652     A(J, I) = A(J, I) * C
6653   ENDDO
6654 ENDDO
6655 @end smallexample
6656 loop interchange will transform the loop as if the user had written:
6657 @smallexample
6658 DO I = 1, N
6659   DO J = 1, M
6660     A(J, I) = A(J, I) * C
6661   ENDDO
6662 ENDDO
6663 @end smallexample
6664 which can be beneficial when @code{N} is larger than the caches,
6665 because in Fortran, the elements of an array are stored in memory
6666 contiguously by column, and the original loop iterates over rows,
6667 potentially creating at each access a cache miss.  This optimization
6668 applies to all the languages supported by GCC and is not limited to
6669 Fortran.  To use this code transformation, GCC has to be configured
6670 with @option{--with-ppl} and @option{--with-cloog} to enable the
6671 Graphite loop transformation infrastructure.
6672
6673 @item -floop-strip-mine
6674 Perform loop strip mining transformations on loops.  Strip mining
6675 splits a loop into two nested loops.  The outer loop has strides
6676 equal to the strip size and the inner loop has strides of the
6677 original loop within a strip.  For example, given a loop like:
6678 @smallexample
6679 DO I = 1, N
6680   A(I) = A(I) + C
6681 ENDDO
6682 @end smallexample
6683 loop strip mining will transform the loop as if the user had written:
6684 @smallexample
6685 DO II = 1, N, 4
6686   DO I = II, min (II + 3, N)
6687     A(I) = A(I) + C
6688   ENDDO
6689 ENDDO
6690 @end smallexample
6691 This optimization applies to all the languages supported by GCC and is
6692 not limited to Fortran.  To use this code transformation, GCC has to
6693 be configured with @option{--with-ppl} and @option{--with-cloog} to
6694 enable the Graphite loop transformation infrastructure.
6695
6696 @item -floop-block
6697 Perform loop blocking transformations on loops.  Blocking strip mines
6698 each loop in the loop nest such that the memory accesses of the
6699 element loops fit inside caches.  For example, given a loop like:
6700 @smallexample
6701 DO I = 1, N
6702   DO J = 1, M
6703     A(J, I) = B(I) + C(J)
6704   ENDDO
6705 ENDDO
6706 @end smallexample
6707 loop blocking will transform the loop as if the user had written:
6708 @smallexample
6709 DO II = 1, N, 64
6710   DO JJ = 1, M, 64
6711     DO I = II, min (II + 63, N)
6712       DO J = JJ, min (JJ + 63, M)
6713         A(J, I) = B(I) + C(J)
6714       ENDDO
6715     ENDDO
6716   ENDDO
6717 ENDDO
6718 @end smallexample
6719 which can be beneficial when @code{M} is larger than the caches,
6720 because the innermost loop will iterate over a smaller amount of data
6721 that can be kept in the caches.  This optimization applies to all the
6722 languages supported by GCC and is not limited to Fortran.  To use this
6723 code transformation, GCC has to be configured with @option{--with-ppl}
6724 and @option{--with-cloog} to enable the Graphite loop transformation
6725 infrastructure.
6726
6727 @item -fgraphite-identity
6728 @opindex fgraphite-identity
6729 Enable the identity transformation for graphite.  For every SCoP we generate
6730 the polyhedral representation and transform it back to gimple.  Using
6731 @option{-fgraphite-identity} we can check the costs or benefits of the
6732 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
6733 are also performed by the code generator CLooG, like index splitting and
6734 dead code elimination in loops.
6735
6736 @item -floop-parallelize-all
6737 Use the Graphite data dependence analysis to identify loops that can
6738 be parallelized.  Parallelize all the loops that can be analyzed to
6739 not contain loop carried dependences without checking that it is
6740 profitable to parallelize the loops.
6741
6742 @item -fcheck-data-deps
6743 @opindex fcheck-data-deps
6744 Compare the results of several data dependence analyzers.  This option
6745 is used for debugging the data dependence analyzers.
6746
6747 @item -ftree-loop-distribution
6748 Perform loop distribution.  This flag can improve cache performance on
6749 big loop bodies and allow further loop optimizations, like
6750 parallelization or vectorization, to take place.  For example, the loop
6751 @smallexample
6752 DO I = 1, N
6753   A(I) = B(I) + C
6754   D(I) = E(I) * F
6755 ENDDO
6756 @end smallexample
6757 is transformed to
6758 @smallexample
6759 DO I = 1, N
6760    A(I) = B(I) + C
6761 ENDDO
6762 DO I = 1, N
6763    D(I) = E(I) * F
6764 ENDDO
6765 @end smallexample
6766
6767 @item -ftree-loop-im
6768 @opindex ftree-loop-im
6769 Perform loop invariant motion on trees.  This pass moves only invariants that
6770 would be hard to handle at RTL level (function calls, operations that expand to
6771 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6772 operands of conditions that are invariant out of the loop, so that we can use
6773 just trivial invariantness analysis in loop unswitching.  The pass also includes
6774 store motion.
6775
6776 @item -ftree-loop-ivcanon
6777 @opindex ftree-loop-ivcanon
6778 Create a canonical counter for number of iterations in the loop for that
6779 determining number of iterations requires complicated analysis.  Later
6780 optimizations then may determine the number easily.  Useful especially
6781 in connection with unrolling.
6782
6783 @item -fivopts
6784 @opindex fivopts
6785 Perform induction variable optimizations (strength reduction, induction
6786 variable merging and induction variable elimination) on trees.
6787
6788 @item -ftree-parallelize-loops=n
6789 @opindex ftree-parallelize-loops
6790 Parallelize loops, i.e., split their iteration space to run in n threads.
6791 This is only possible for loops whose iterations are independent
6792 and can be arbitrarily reordered.  The optimization is only
6793 profitable on multiprocessor machines, for loops that are CPU-intensive,
6794 rather than constrained e.g.@: by memory bandwidth.  This option
6795 implies @option{-pthread}, and thus is only supported on targets
6796 that have support for @option{-pthread}.
6797
6798 @item -ftree-pta
6799 @opindex ftree-pta
6800 Perform function-local points-to analysis on trees.  This flag is
6801 enabled by default at @option{-O} and higher.
6802
6803 @item -ftree-sra
6804 @opindex ftree-sra
6805 Perform scalar replacement of aggregates.  This pass replaces structure
6806 references with scalars to prevent committing structures to memory too
6807 early.  This flag is enabled by default at @option{-O} and higher.
6808
6809 @item -ftree-copyrename
6810 @opindex ftree-copyrename
6811 Perform copy renaming on trees.  This pass attempts to rename compiler
6812 temporaries to other variables at copy locations, usually resulting in
6813 variable names which more closely resemble the original variables.  This flag
6814 is enabled by default at @option{-O} and higher.
6815
6816 @item -ftree-ter
6817 @opindex ftree-ter
6818 Perform temporary expression replacement during the SSA->normal phase.  Single
6819 use/single def temporaries are replaced at their use location with their
6820 defining expression.  This results in non-GIMPLE code, but gives the expanders
6821 much more complex trees to work on resulting in better RTL generation.  This is
6822 enabled by default at @option{-O} and higher.
6823
6824 @item -ftree-vectorize
6825 @opindex ftree-vectorize
6826 Perform loop vectorization on trees. This flag is enabled by default at
6827 @option{-O3}.
6828
6829 @item -ftree-slp-vectorize
6830 @opindex ftree-slp-vectorize
6831 Perform basic block vectorization on trees. This flag is enabled by default at
6832 @option{-O3} and when @option{-ftree-vectorize} is enabled.
6833
6834 @item -ftree-vect-loop-version
6835 @opindex ftree-vect-loop-version
6836 Perform loop versioning when doing loop vectorization on trees.  When a loop
6837 appears to be vectorizable except that data alignment or data dependence cannot
6838 be determined at compile time then vectorized and non-vectorized versions of
6839 the loop are generated along with runtime checks for alignment or dependence
6840 to control which version is executed.  This option is enabled by default
6841 except at level @option{-Os} where it is disabled.
6842
6843 @item -fvect-cost-model
6844 @opindex fvect-cost-model
6845 Enable cost model for vectorization.
6846
6847 @item -ftree-vrp
6848 @opindex ftree-vrp
6849 Perform Value Range Propagation on trees.  This is similar to the
6850 constant propagation pass, but instead of values, ranges of values are
6851 propagated.  This allows the optimizers to remove unnecessary range
6852 checks like array bound checks and null pointer checks.  This is
6853 enabled by default at @option{-O2} and higher.  Null pointer check
6854 elimination is only done if @option{-fdelete-null-pointer-checks} is
6855 enabled.
6856
6857 @item -ftracer
6858 @opindex ftracer
6859 Perform tail duplication to enlarge superblock size.  This transformation
6860 simplifies the control flow of the function allowing other optimizations to do
6861 better job.
6862
6863 @item -funroll-loops
6864 @opindex funroll-loops
6865 Unroll loops whose number of iterations can be determined at compile
6866 time or upon entry to the loop.  @option{-funroll-loops} implies
6867 @option{-frerun-cse-after-loop}.  This option makes code larger,
6868 and may or may not make it run faster.
6869
6870 @item -funroll-all-loops
6871 @opindex funroll-all-loops
6872 Unroll all loops, even if their number of iterations is uncertain when
6873 the loop is entered.  This usually makes programs run more slowly.
6874 @option{-funroll-all-loops} implies the same options as
6875 @option{-funroll-loops},
6876
6877 @item -fsplit-ivs-in-unroller
6878 @opindex fsplit-ivs-in-unroller
6879 Enables expressing of values of induction variables in later iterations
6880 of the unrolled loop using the value in the first iteration.  This breaks
6881 long dependency chains, thus improving efficiency of the scheduling passes.
6882
6883 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6884 same effect.  However in cases the loop body is more complicated than
6885 a single basic block, this is not reliable.  It also does not work at all
6886 on some of the architectures due to restrictions in the CSE pass.
6887
6888 This optimization is enabled by default.
6889
6890 @item -fvariable-expansion-in-unroller
6891 @opindex fvariable-expansion-in-unroller
6892 With this option, the compiler will create multiple copies of some
6893 local variables when unrolling a loop which can result in superior code.
6894
6895 @item -fpredictive-commoning
6896 @opindex fpredictive-commoning
6897 Perform predictive commoning optimization, i.e., reusing computations
6898 (especially memory loads and stores) performed in previous
6899 iterations of loops.
6900
6901 This option is enabled at level @option{-O3}.
6902
6903 @item -fprefetch-loop-arrays
6904 @opindex fprefetch-loop-arrays
6905 If supported by the target machine, generate instructions to prefetch
6906 memory to improve the performance of loops that access large arrays.
6907
6908 This option may generate better or worse code; results are highly
6909 dependent on the structure of loops within the source code.
6910
6911 Disabled at level @option{-Os}.
6912
6913 @item -fno-peephole
6914 @itemx -fno-peephole2
6915 @opindex fno-peephole
6916 @opindex fno-peephole2
6917 Disable any machine-specific peephole optimizations.  The difference
6918 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6919 are implemented in the compiler; some targets use one, some use the
6920 other, a few use both.
6921
6922 @option{-fpeephole} is enabled by default.
6923 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6924
6925 @item -fno-guess-branch-probability
6926 @opindex fno-guess-branch-probability
6927 Do not guess branch probabilities using heuristics.
6928
6929 GCC will use heuristics to guess branch probabilities if they are
6930 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6931 heuristics are based on the control flow graph.  If some branch probabilities
6932 are specified by @samp{__builtin_expect}, then the heuristics will be
6933 used to guess branch probabilities for the rest of the control flow graph,
6934 taking the @samp{__builtin_expect} info into account.  The interactions
6935 between the heuristics and @samp{__builtin_expect} can be complex, and in
6936 some cases, it may be useful to disable the heuristics so that the effects
6937 of @samp{__builtin_expect} are easier to understand.
6938
6939 The default is @option{-fguess-branch-probability} at levels
6940 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6941
6942 @item -freorder-blocks
6943 @opindex freorder-blocks
6944 Reorder basic blocks in the compiled function in order to reduce number of
6945 taken branches and improve code locality.
6946
6947 Enabled at levels @option{-O2}, @option{-O3}.
6948
6949 @item -freorder-blocks-and-partition
6950 @opindex freorder-blocks-and-partition
6951 In addition to reordering basic blocks in the compiled function, in order
6952 to reduce number of taken branches, partitions hot and cold basic blocks
6953 into separate sections of the assembly and .o files, to improve
6954 paging and cache locality performance.
6955
6956 This optimization is automatically turned off in the presence of
6957 exception handling, for linkonce sections, for functions with a user-defined
6958 section attribute and on any architecture that does not support named
6959 sections.
6960
6961 @item -freorder-functions
6962 @opindex freorder-functions
6963 Reorder functions in the object file in order to
6964 improve code locality.  This is implemented by using special
6965 subsections @code{.text.hot} for most frequently executed functions and
6966 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6967 the linker so object file format must support named sections and linker must
6968 place them in a reasonable way.
6969
6970 Also profile feedback must be available in to make this option effective.  See
6971 @option{-fprofile-arcs} for details.
6972
6973 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6974
6975 @item -fstrict-aliasing
6976 @opindex fstrict-aliasing
6977 Allow the compiler to assume the strictest aliasing rules applicable to
6978 the language being compiled.  For C (and C++), this activates
6979 optimizations based on the type of expressions.  In particular, an
6980 object of one type is assumed never to reside at the same address as an
6981 object of a different type, unless the types are almost the same.  For
6982 example, an @code{unsigned int} can alias an @code{int}, but not a
6983 @code{void*} or a @code{double}.  A character type may alias any other
6984 type.
6985
6986 @anchor{Type-punning}Pay special attention to code like this:
6987 @smallexample
6988 union a_union @{
6989   int i;
6990   double d;
6991 @};
6992
6993 int f() @{
6994   union a_union t;
6995   t.d = 3.0;
6996   return t.i;
6997 @}
6998 @end smallexample
6999 The practice of reading from a different union member than the one most
7000 recently written to (called ``type-punning'') is common.  Even with
7001 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7002 is accessed through the union type.  So, the code above will work as
7003 expected.  @xref{Structures unions enumerations and bit-fields
7004 implementation}.  However, this code might not:
7005 @smallexample
7006 int f() @{
7007   union a_union t;
7008   int* ip;
7009   t.d = 3.0;
7010   ip = &t.i;
7011   return *ip;
7012 @}
7013 @end smallexample
7014
7015 Similarly, access by taking the address, casting the resulting pointer
7016 and dereferencing the result has undefined behavior, even if the cast
7017 uses a union type, e.g.:
7018 @smallexample
7019 int f() @{
7020   double d = 3.0;
7021   return ((union a_union *) &d)->i;
7022 @}
7023 @end smallexample
7024
7025 The @option{-fstrict-aliasing} option is enabled at levels
7026 @option{-O2}, @option{-O3}, @option{-Os}.
7027
7028 @item -fstrict-overflow
7029 @opindex fstrict-overflow
7030 Allow the compiler to assume strict signed overflow rules, depending
7031 on the language being compiled.  For C (and C++) this means that
7032 overflow when doing arithmetic with signed numbers is undefined, which
7033 means that the compiler may assume that it will not happen.  This
7034 permits various optimizations.  For example, the compiler will assume
7035 that an expression like @code{i + 10 > i} will always be true for
7036 signed @code{i}.  This assumption is only valid if signed overflow is
7037 undefined, as the expression is false if @code{i + 10} overflows when
7038 using twos complement arithmetic.  When this option is in effect any
7039 attempt to determine whether an operation on signed numbers will
7040 overflow must be written carefully to not actually involve overflow.
7041
7042 This option also allows the compiler to assume strict pointer
7043 semantics: given a pointer to an object, if adding an offset to that
7044 pointer does not produce a pointer to the same object, the addition is
7045 undefined.  This permits the compiler to conclude that @code{p + u >
7046 p} is always true for a pointer @code{p} and unsigned integer
7047 @code{u}.  This assumption is only valid because pointer wraparound is
7048 undefined, as the expression is false if @code{p + u} overflows using
7049 twos complement arithmetic.
7050
7051 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7052 that integer signed overflow is fully defined: it wraps.  When
7053 @option{-fwrapv} is used, there is no difference between
7054 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7055 integers.  With @option{-fwrapv} certain types of overflow are
7056 permitted.  For example, if the compiler gets an overflow when doing
7057 arithmetic on constants, the overflowed value can still be used with
7058 @option{-fwrapv}, but not otherwise.
7059
7060 The @option{-fstrict-overflow} option is enabled at levels
7061 @option{-O2}, @option{-O3}, @option{-Os}.
7062
7063 @item -falign-functions
7064 @itemx -falign-functions=@var{n}
7065 @opindex falign-functions
7066 Align the start of functions to the next power-of-two greater than
7067 @var{n}, skipping up to @var{n} bytes.  For instance,
7068 @option{-falign-functions=32} aligns functions to the next 32-byte
7069 boundary, but @option{-falign-functions=24} would align to the next
7070 32-byte boundary only if this can be done by skipping 23 bytes or less.
7071
7072 @option{-fno-align-functions} and @option{-falign-functions=1} are
7073 equivalent and mean that functions will not be aligned.
7074
7075 Some assemblers only support this flag when @var{n} is a power of two;
7076 in that case, it is rounded up.
7077
7078 If @var{n} is not specified or is zero, use a machine-dependent default.
7079
7080 Enabled at levels @option{-O2}, @option{-O3}.
7081
7082 @item -falign-labels
7083 @itemx -falign-labels=@var{n}
7084 @opindex falign-labels
7085 Align all branch targets to a power-of-two boundary, skipping up to
7086 @var{n} bytes like @option{-falign-functions}.  This option can easily
7087 make code slower, because it must insert dummy operations for when the
7088 branch target is reached in the usual flow of the code.
7089
7090 @option{-fno-align-labels} and @option{-falign-labels=1} are
7091 equivalent and mean that labels will not be aligned.
7092
7093 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7094 are greater than this value, then their values are used instead.
7095
7096 If @var{n} is not specified or is zero, use a machine-dependent default
7097 which is very likely to be @samp{1}, meaning no alignment.
7098
7099 Enabled at levels @option{-O2}, @option{-O3}.
7100
7101 @item -falign-loops
7102 @itemx -falign-loops=@var{n}
7103 @opindex falign-loops
7104 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7105 like @option{-falign-functions}.  The hope is that the loop will be
7106 executed many times, which will make up for any execution of the dummy
7107 operations.
7108
7109 @option{-fno-align-loops} and @option{-falign-loops=1} are
7110 equivalent and mean that loops will not be aligned.
7111
7112 If @var{n} is not specified or is zero, use a machine-dependent default.
7113
7114 Enabled at levels @option{-O2}, @option{-O3}.
7115
7116 @item -falign-jumps
7117 @itemx -falign-jumps=@var{n}
7118 @opindex falign-jumps
7119 Align branch targets to a power-of-two boundary, for branch targets
7120 where the targets can only be reached by jumping, skipping up to @var{n}
7121 bytes like @option{-falign-functions}.  In this case, no dummy operations
7122 need be executed.
7123
7124 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7125 equivalent and mean that loops will not be aligned.
7126
7127 If @var{n} is not specified or is zero, use a machine-dependent default.
7128
7129 Enabled at levels @option{-O2}, @option{-O3}.
7130
7131 @item -funit-at-a-time
7132 @opindex funit-at-a-time
7133 This option is left for compatibility reasons. @option{-funit-at-a-time}
7134 has no effect, while @option{-fno-unit-at-a-time} implies
7135 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7136
7137 Enabled by default.
7138
7139 @item -fno-toplevel-reorder
7140 @opindex fno-toplevel-reorder
7141 Do not reorder top-level functions, variables, and @code{asm}
7142 statements.  Output them in the same order that they appear in the
7143 input file.  When this option is used, unreferenced static variables
7144 will not be removed.  This option is intended to support existing code
7145 which relies on a particular ordering.  For new code, it is better to
7146 use attributes.
7147
7148 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7149 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7150 targets.
7151
7152 @item -fweb
7153 @opindex fweb
7154 Constructs webs as commonly used for register allocation purposes and assign
7155 each web individual pseudo register.  This allows the register allocation pass
7156 to operate on pseudos directly, but also strengthens several other optimization
7157 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7158 however, make debugging impossible, since variables will no longer stay in a
7159 ``home register''.
7160
7161 Enabled by default with @option{-funroll-loops}.
7162
7163 @item -fwhole-program
7164 @opindex fwhole-program
7165 Assume that the current compilation unit represents the whole program being
7166 compiled.  All public functions and variables with the exception of @code{main}
7167 and those merged by attribute @code{externally_visible} become static functions
7168 and in effect are optimized more aggressively by interprocedural optimizers.
7169 While this option is equivalent to proper use of the @code{static} keyword for
7170 programs consisting of a single file, in combination with option
7171 @option{-combine}, @option{-flto} or @option{-fwhopr} this flag can be used to
7172 compile many smaller scale programs since the functions and variables become
7173 local for the whole combined compilation unit, not for the single source file
7174 itself.
7175
7176 This option implies @option{-fwhole-file} for Fortran programs.
7177
7178 @item -flto
7179 @opindex flto
7180 This option runs the standard link-time optimizer.  When invoked
7181 with source code, it generates GIMPLE (one of GCC's internal
7182 representations) and writes it to special ELF sections in the object
7183 file.  When the object files are linked together, all the function
7184 bodies are read from these ELF sections and instantiated as if they
7185 had been part of the same translation unit.
7186
7187 To use the link-timer optimizer, @option{-flto} needs to be specified at
7188 compile time and during the final link.  For example,
7189
7190 @smallexample
7191 gcc -c -O2 -flto foo.c
7192 gcc -c -O2 -flto bar.c
7193 gcc -o myprog -flto -O2 foo.o bar.o
7194 @end smallexample
7195
7196 The first two invocations to GCC will save a bytecode representation
7197 of GIMPLE into special ELF sections inside @file{foo.o} and
7198 @file{bar.o}.  The final invocation will read the GIMPLE bytecode from
7199 @file{foo.o} and @file{bar.o}, merge the two files into a single
7200 internal image, and compile the result as usual.  Since both
7201 @file{foo.o} and @file{bar.o} are merged into a single image, this
7202 causes all the inter-procedural analyses and optimizations in GCC to
7203 work across the two files as if they were a single one.  This means,
7204 for example, that the inliner will be able to inline functions in
7205 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7206
7207 Another (simpler) way to enable link-time optimization is,
7208
7209 @smallexample
7210 gcc -o myprog -flto -O2 foo.c bar.c
7211 @end smallexample
7212
7213 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7214 merge them together into a single GIMPLE representation and optimize
7215 them as usual to produce @file{myprog}.
7216
7217 The only important thing to keep in mind is that to enable link-time
7218 optimizations the @option{-flto} flag needs to be passed to both the
7219 compile and the link commands.
7220
7221 Note that when a file is compiled with @option{-flto}, the generated
7222 object file will be larger than a regular object file because it will
7223 contain GIMPLE bytecodes and the usual final code.  This means that
7224 object files with LTO information can be linked as a normal object
7225 file.  So, in the previous example, if the final link is done with
7226
7227 @smallexample
7228 gcc -o myprog foo.o bar.o
7229 @end smallexample
7230
7231 The only difference will be that no inter-procedural optimizations
7232 will be applied to produce @file{myprog}.  The two object files
7233 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7234 linker.
7235
7236 Additionally, the optimization flags used to compile individual files
7237 are not necessarily related to those used at link-time.  For instance,
7238
7239 @smallexample
7240 gcc -c -O0 -flto foo.c
7241 gcc -c -O0 -flto bar.c
7242 gcc -o myprog -flto -O3 foo.o bar.o
7243 @end smallexample
7244
7245 This will produce individual object files with unoptimized assembler
7246 code, but the resulting binary @file{myprog} will be optimized at
7247 @option{-O3}.  Now, if the final binary is generated without
7248 @option{-flto}, then @file{myprog} will not be optimized.
7249
7250 When producing the final binary with @option{-flto}, GCC will only
7251 apply link-time optimizations to those files that contain bytecode.
7252 Therefore, you can mix and match object files and libraries with
7253 GIMPLE bytecodes and final object code.  GCC will automatically select
7254 which files to optimize in LTO mode and which files to link without
7255 further processing.
7256
7257 There are some code generation flags that GCC will preserve when
7258 generating bytecodes, as they need to be used during the final link
7259 stage.  Currently, the following options are saved into the GIMPLE
7260 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7261 @option{-m} target flags.
7262
7263 At link time, these options are read-in and reapplied.  Note that the
7264 current implementation makes no attempt at recognizing conflicting
7265 values for these options.  If two or more files have a conflicting
7266 value (e.g., one file is compiled with @option{-fPIC} and another
7267 isn't), the compiler will simply use the last value read from the
7268 bytecode files.  It is recommended, then, that all the files
7269 participating in the same link be compiled with the same options.
7270
7271 Another feature of LTO is that it is possible to apply interprocedural
7272 optimizations on files written in different languages.  This requires
7273 some support in the language front end.  Currently, the C, C++ and
7274 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7275 something like this should work
7276
7277 @smallexample
7278 gcc -c -flto foo.c
7279 g++ -c -flto bar.cc
7280 gfortran -c -flto baz.f90
7281 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7282 @end smallexample
7283
7284 Notice that the final link is done with @command{g++} to get the C++
7285 runtime libraries and @option{-lgfortran} is added to get the Fortran
7286 runtime libraries.  In general, when mixing languages in LTO mode, you
7287 should use the same link command used when mixing languages in a
7288 regular (non-LTO) compilation.  This means that if your build process
7289 was mixing languages before, all you need to add is @option{-flto} to
7290 all the compile and link commands.
7291
7292 If object files containing GIMPLE bytecode are stored in a library
7293 archive, say @file{libfoo.a}, it is possible to extract and use them
7294 in an LTO link if you are using @command{gold} as the linker (which,
7295 in turn requires GCC to be configured with @option{--enable-gold}).
7296 To enable this feature, use the flag @option{-fuse-linker-plugin} at
7297 link-time:
7298
7299 @smallexample
7300 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7301 @end smallexample
7302
7303 With the linker plugin enabled, @command{gold} will extract the needed
7304 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7305 to make them part of the aggregated GIMPLE image to be optimized.
7306
7307 If you are not using @command{gold} and/or do not specify
7308 @option{-fuse-linker-plugin} then the objects inside @file{libfoo.a}
7309 will be extracted and linked as usual, but they will not participate
7310 in the LTO optimization process.
7311
7312 Link time optimizations do not require the presence of the whole
7313 program to operate.  If the program does not require any symbols to
7314 be exported, it is possible to combine @option{-flto} and
7315 @option{-fwhopr} with @option{-fwhole-program} to allow the
7316 interprocedural optimizers to use more aggressive assumptions which
7317 may lead to improved optimization opportunities.
7318
7319 Regarding portability: the current implementation of LTO makes no
7320 attempt at generating bytecode that can be ported between different
7321 types of hosts.  The bytecode files are versioned and there is a
7322 strict version check, so bytecode files generated in one version of
7323 GCC will not work with an older/newer version of GCC.
7324
7325 Link time optimization does not play well with generating debugging
7326 information.  Combining @option{-flto} or @option{-fwhopr} with
7327 @option{-g} is experimental.
7328
7329 This option is disabled by default.
7330
7331 @item -fwhopr
7332 @opindex fwhopr
7333 This option is identical in functionality to @option{-flto} but it
7334 differs in how the final link stage is executed.  Instead of loading
7335 all the function bodies in memory, the callgraph is analyzed and
7336 optimization decisions are made (whole program analysis or WPA). Once
7337 optimization decisions are made, the callgraph is partitioned and the
7338 different sections are compiled separately (local transformations or
7339 LTRANS)@.  This process allows optimizations on very large programs
7340 that otherwise would not fit in memory.  This option enables
7341 @option{-fwpa} and @option{-fltrans} automatically.
7342
7343 Disabled by default.
7344
7345 This option is experimental.
7346
7347 @item -fwpa
7348 @opindex fwpa
7349 This is an internal option used by GCC when compiling with
7350 @option{-fwhopr}.  You should never need to use it.
7351
7352 This option runs the link-time optimizer in the whole-program-analysis
7353 (WPA) mode, which reads in summary information from all inputs and
7354 performs a whole-program analysis based on summary information only.
7355 It generates object files for subsequent runs of the link-time
7356 optimizer where individual object files are optimized using both
7357 summary information from the WPA mode and the actual function bodies.
7358 It then drives the LTRANS phase.
7359
7360 Disabled by default.
7361
7362 @item -fltrans
7363 @opindex fltrans
7364 This is an internal option used by GCC when compiling with
7365 @option{-fwhopr}.  You should never need to use it.
7366
7367 This option runs the link-time optimizer in the local-transformation (LTRANS)
7368 mode, which reads in output from a previous run of the LTO in WPA mode.
7369 In the LTRANS mode, LTO optimizes an object and produces the final assembly.
7370
7371 Disabled by default.
7372
7373 @item -fltrans-output-list=@var{file}
7374 @opindex fltrans-output-list
7375 This is an internal option used by GCC when compiling with
7376 @option{-fwhopr}.  You should never need to use it.
7377
7378 This option specifies a file to which the names of LTRANS output files are
7379 written.  This option is only meaningful in conjunction with @option{-fwpa}.
7380
7381 Disabled by default.
7382
7383 @item -flto-compression-level=@var{n}
7384 This option specifies the level of compression used for intermediate
7385 language written to LTO object files, and is only meaningful in
7386 conjunction with LTO mode (@option{-fwhopr}, @option{-flto}).  Valid
7387 values are 0 (no compression) to 9 (maximum compression).  Values
7388 outside this range are clamped to either 0 or 9.  If the option is not
7389 given, a default balanced compression setting is used.
7390
7391 @item -flto-report
7392 Prints a report with internal details on the workings of the link-time
7393 optimizer.  The contents of this report vary from version to version,
7394 it is meant to be useful to GCC developers when processing object
7395 files in LTO mode (via @option{-fwhopr} or @option{-flto}).
7396
7397 Disabled by default.
7398
7399 @item -fuse-linker-plugin
7400 Enables the extraction of objects with GIMPLE bytecode information
7401 from library archives.  This option relies on features available only
7402 in @command{gold}, so to use this you must configure GCC with
7403 @option{--enable-gold}.  See @option{-flto} for a description on the
7404 effect of this flag and how to use it.
7405
7406 Disabled by default.
7407
7408 @item -fcprop-registers
7409 @opindex fcprop-registers
7410 After register allocation and post-register allocation instruction splitting,
7411 we perform a copy-propagation pass to try to reduce scheduling dependencies
7412 and occasionally eliminate the copy.
7413
7414 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7415
7416 @item -fprofile-correction
7417 @opindex fprofile-correction
7418 Profiles collected using an instrumented binary for multi-threaded programs may
7419 be inconsistent due to missed counter updates. When this option is specified,
7420 GCC will use heuristics to correct or smooth out such inconsistencies. By
7421 default, GCC will emit an error message when an inconsistent profile is detected.
7422
7423 @item -fprofile-dir=@var{path}
7424 @opindex fprofile-dir
7425
7426 Set the directory to search the profile data files in to @var{path}.
7427 This option affects only the profile data generated by
7428 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7429 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7430 and its related options.
7431 By default, GCC will use the current directory as @var{path}
7432 thus the profile data file will appear in the same directory as the object file.
7433
7434 @item -fprofile-generate
7435 @itemx -fprofile-generate=@var{path}
7436 @opindex fprofile-generate
7437
7438 Enable options usually used for instrumenting application to produce
7439 profile useful for later recompilation with profile feedback based
7440 optimization.  You must use @option{-fprofile-generate} both when
7441 compiling and when linking your program.
7442
7443 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7444
7445 If @var{path} is specified, GCC will look at the @var{path} to find
7446 the profile feedback data files. See @option{-fprofile-dir}.
7447
7448 @item -fprofile-use
7449 @itemx -fprofile-use=@var{path}
7450 @opindex fprofile-use
7451 Enable profile feedback directed optimizations, and optimizations
7452 generally profitable only with profile feedback available.
7453
7454 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7455 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7456
7457 By default, GCC emits an error message if the feedback profiles do not
7458 match the source code.  This error can be turned into a warning by using
7459 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7460 code.
7461
7462 If @var{path} is specified, GCC will look at the @var{path} to find
7463 the profile feedback data files. See @option{-fprofile-dir}.
7464 @end table
7465
7466 The following options control compiler behavior regarding floating
7467 point arithmetic.  These options trade off between speed and
7468 correctness.  All must be specifically enabled.
7469
7470 @table @gcctabopt
7471 @item -ffloat-store
7472 @opindex ffloat-store
7473 Do not store floating point variables in registers, and inhibit other
7474 options that might change whether a floating point value is taken from a
7475 register or memory.
7476
7477 @cindex floating point precision
7478 This option prevents undesirable excess precision on machines such as
7479 the 68000 where the floating registers (of the 68881) keep more
7480 precision than a @code{double} is supposed to have.  Similarly for the
7481 x86 architecture.  For most programs, the excess precision does only
7482 good, but a few programs rely on the precise definition of IEEE floating
7483 point.  Use @option{-ffloat-store} for such programs, after modifying
7484 them to store all pertinent intermediate computations into variables.
7485
7486 @item -fexcess-precision=@var{style}
7487 @opindex fexcess-precision
7488 This option allows further control over excess precision on machines
7489 where floating-point registers have more precision than the IEEE
7490 @code{float} and @code{double} types and the processor does not
7491 support operations rounding to those types.  By default,
7492 @option{-fexcess-precision=fast} is in effect; this means that
7493 operations are carried out in the precision of the registers and that
7494 it is unpredictable when rounding to the types specified in the source
7495 code takes place.  When compiling C, if
7496 @option{-fexcess-precision=standard} is specified then excess
7497 precision will follow the rules specified in ISO C99; in particular,
7498 both casts and assignments cause values to be rounded to their
7499 semantic types (whereas @option{-ffloat-store} only affects
7500 assignments).  This option is enabled by default for C if a strict
7501 conformance option such as @option{-std=c99} is used.
7502
7503 @opindex mfpmath
7504 @option{-fexcess-precision=standard} is not implemented for languages
7505 other than C, and has no effect if
7506 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7507 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7508 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7509 semantics apply without excess precision, and in the latter, rounding
7510 is unpredictable.
7511
7512 @item -ffast-math
7513 @opindex ffast-math
7514 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7515 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7516 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7517
7518 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7519
7520 This option is not turned on by any @option{-O} option since
7521 it can result in incorrect output for programs which depend on
7522 an exact implementation of IEEE or ISO rules/specifications for
7523 math functions. It may, however, yield faster code for programs
7524 that do not require the guarantees of these specifications.
7525
7526 @item -fno-math-errno
7527 @opindex fno-math-errno
7528 Do not set ERRNO after calling math functions that are executed
7529 with a single instruction, e.g., sqrt.  A program that relies on
7530 IEEE exceptions for math error handling may want to use this flag
7531 for speed while maintaining IEEE arithmetic compatibility.
7532
7533 This option is not turned on by any @option{-O} option since
7534 it can result in incorrect output for programs which depend on
7535 an exact implementation of IEEE or ISO rules/specifications for
7536 math functions. It may, however, yield faster code for programs
7537 that do not require the guarantees of these specifications.
7538
7539 The default is @option{-fmath-errno}.
7540
7541 On Darwin systems, the math library never sets @code{errno}.  There is
7542 therefore no reason for the compiler to consider the possibility that
7543 it might, and @option{-fno-math-errno} is the default.
7544
7545 @item -funsafe-math-optimizations
7546 @opindex funsafe-math-optimizations
7547
7548 Allow optimizations for floating-point arithmetic that (a) assume
7549 that arguments and results are valid and (b) may violate IEEE or
7550 ANSI standards.  When used at link-time, it may include libraries
7551 or startup files that change the default FPU control word or other
7552 similar optimizations.
7553
7554 This option is not turned on by any @option{-O} option since
7555 it can result in incorrect output for programs which depend on
7556 an exact implementation of IEEE or ISO rules/specifications for
7557 math functions. It may, however, yield faster code for programs
7558 that do not require the guarantees of these specifications.
7559 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7560 @option{-fassociative-math} and @option{-freciprocal-math}.
7561
7562 The default is @option{-fno-unsafe-math-optimizations}.
7563
7564 @item -fassociative-math
7565 @opindex fassociative-math
7566
7567 Allow re-association of operands in series of floating-point operations.
7568 This violates the ISO C and C++ language standard by possibly changing
7569 computation result.  NOTE: re-ordering may change the sign of zero as
7570 well as ignore NaNs and inhibit or create underflow or overflow (and
7571 thus cannot be used on a code which relies on rounding behavior like
7572 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
7573 and thus may not be used when ordered comparisons are required.
7574 This option requires that both @option{-fno-signed-zeros} and
7575 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
7576 much sense with @option{-frounding-math}.
7577
7578 The default is @option{-fno-associative-math}.
7579
7580 @item -freciprocal-math
7581 @opindex freciprocal-math
7582
7583 Allow the reciprocal of a value to be used instead of dividing by
7584 the value if this enables optimizations.  For example @code{x / y}
7585 can be replaced with @code{x * (1/y)} which is useful if @code{(1/y)}
7586 is subject to common subexpression elimination.  Note that this loses
7587 precision and increases the number of flops operating on the value.
7588
7589 The default is @option{-fno-reciprocal-math}.
7590
7591 @item -ffinite-math-only
7592 @opindex ffinite-math-only
7593 Allow optimizations for floating-point arithmetic that assume
7594 that arguments and results are not NaNs or +-Infs.
7595
7596 This option is not turned on by any @option{-O} option since
7597 it can result in incorrect output for programs which depend on
7598 an exact implementation of IEEE or ISO rules/specifications for
7599 math functions. It may, however, yield faster code for programs
7600 that do not require the guarantees of these specifications.
7601
7602 The default is @option{-fno-finite-math-only}.
7603
7604 @item -fno-signed-zeros
7605 @opindex fno-signed-zeros
7606 Allow optimizations for floating point arithmetic that ignore the
7607 signedness of zero.  IEEE arithmetic specifies the behavior of
7608 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
7609 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
7610 This option implies that the sign of a zero result isn't significant.
7611
7612 The default is @option{-fsigned-zeros}.
7613
7614 @item -fno-trapping-math
7615 @opindex fno-trapping-math
7616 Compile code assuming that floating-point operations cannot generate
7617 user-visible traps.  These traps include division by zero, overflow,
7618 underflow, inexact result and invalid operation.  This option requires
7619 that @option{-fno-signaling-nans} be in effect.  Setting this option may
7620 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
7621
7622 This option should never be turned on by any @option{-O} option since
7623 it can result in incorrect output for programs which depend on
7624 an exact implementation of IEEE or ISO rules/specifications for
7625 math functions.
7626
7627 The default is @option{-ftrapping-math}.
7628
7629 @item -frounding-math
7630 @opindex frounding-math
7631 Disable transformations and optimizations that assume default floating
7632 point rounding behavior.  This is round-to-zero for all floating point
7633 to integer conversions, and round-to-nearest for all other arithmetic
7634 truncations.  This option should be specified for programs that change
7635 the FP rounding mode dynamically, or that may be executed with a
7636 non-default rounding mode.  This option disables constant folding of
7637 floating point expressions at compile-time (which may be affected by
7638 rounding mode) and arithmetic transformations that are unsafe in the
7639 presence of sign-dependent rounding modes.
7640
7641 The default is @option{-fno-rounding-math}.
7642
7643 This option is experimental and does not currently guarantee to
7644 disable all GCC optimizations that are affected by rounding mode.
7645 Future versions of GCC may provide finer control of this setting
7646 using C99's @code{FENV_ACCESS} pragma.  This command line option
7647 will be used to specify the default state for @code{FENV_ACCESS}.
7648
7649 @item -fsignaling-nans
7650 @opindex fsignaling-nans
7651 Compile code assuming that IEEE signaling NaNs may generate user-visible
7652 traps during floating-point operations.  Setting this option disables
7653 optimizations that may change the number of exceptions visible with
7654 signaling NaNs.  This option implies @option{-ftrapping-math}.
7655
7656 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
7657 be defined.
7658
7659 The default is @option{-fno-signaling-nans}.
7660
7661 This option is experimental and does not currently guarantee to
7662 disable all GCC optimizations that affect signaling NaN behavior.
7663
7664 @item -fsingle-precision-constant
7665 @opindex fsingle-precision-constant
7666 Treat floating point constant as single precision constant instead of
7667 implicitly converting it to double precision constant.
7668
7669 @item -fcx-limited-range
7670 @opindex fcx-limited-range
7671 When enabled, this option states that a range reduction step is not
7672 needed when performing complex division.  Also, there is no checking
7673 whether the result of a complex multiplication or division is @code{NaN
7674 + I*NaN}, with an attempt to rescue the situation in that case.  The
7675 default is @option{-fno-cx-limited-range}, but is enabled by
7676 @option{-ffast-math}.
7677
7678 This option controls the default setting of the ISO C99
7679 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
7680 all languages.
7681
7682 @item -fcx-fortran-rules
7683 @opindex fcx-fortran-rules
7684 Complex multiplication and division follow Fortran rules.  Range
7685 reduction is done as part of complex division, but there is no checking
7686 whether the result of a complex multiplication or division is @code{NaN
7687 + I*NaN}, with an attempt to rescue the situation in that case.
7688
7689 The default is @option{-fno-cx-fortran-rules}.
7690
7691 @end table
7692
7693 The following options control optimizations that may improve
7694 performance, but are not enabled by any @option{-O} options.  This
7695 section includes experimental options that may produce broken code.
7696
7697 @table @gcctabopt
7698 @item -fbranch-probabilities
7699 @opindex fbranch-probabilities
7700 After running a program compiled with @option{-fprofile-arcs}
7701 (@pxref{Debugging Options,, Options for Debugging Your Program or
7702 @command{gcc}}), you can compile it a second time using
7703 @option{-fbranch-probabilities}, to improve optimizations based on
7704 the number of times each branch was taken.  When the program
7705 compiled with @option{-fprofile-arcs} exits it saves arc execution
7706 counts to a file called @file{@var{sourcename}.gcda} for each source
7707 file.  The information in this data file is very dependent on the
7708 structure of the generated code, so you must use the same source code
7709 and the same optimization options for both compilations.
7710
7711 With @option{-fbranch-probabilities}, GCC puts a
7712 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
7713 These can be used to improve optimization.  Currently, they are only
7714 used in one place: in @file{reorg.c}, instead of guessing which path a
7715 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
7716 exactly determine which path is taken more often.
7717
7718 @item -fprofile-values
7719 @opindex fprofile-values
7720 If combined with @option{-fprofile-arcs}, it adds code so that some
7721 data about values of expressions in the program is gathered.
7722
7723 With @option{-fbranch-probabilities}, it reads back the data gathered
7724 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
7725 notes to instructions for their later usage in optimizations.
7726
7727 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
7728
7729 @item -fvpt
7730 @opindex fvpt
7731 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
7732 a code to gather information about values of expressions.
7733
7734 With @option{-fbranch-probabilities}, it reads back the data gathered
7735 and actually performs the optimizations based on them.
7736 Currently the optimizations include specialization of division operation
7737 using the knowledge about the value of the denominator.
7738
7739 @item -frename-registers
7740 @opindex frename-registers
7741 Attempt to avoid false dependencies in scheduled code by making use
7742 of registers left over after register allocation.  This optimization
7743 will most benefit processors with lots of registers.  Depending on the
7744 debug information format adopted by the target, however, it can
7745 make debugging impossible, since variables will no longer stay in
7746 a ``home register''.
7747
7748 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
7749
7750 @item -ftracer
7751 @opindex ftracer
7752 Perform tail duplication to enlarge superblock size.  This transformation
7753 simplifies the control flow of the function allowing other optimizations to do
7754 better job.
7755
7756 Enabled with @option{-fprofile-use}.
7757
7758 @item -funroll-loops
7759 @opindex funroll-loops
7760 Unroll loops whose number of iterations can be determined at compile time or
7761 upon entry to the loop.  @option{-funroll-loops} implies
7762 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
7763 It also turns on complete loop peeling (i.e.@: complete removal of loops with
7764 small constant number of iterations).  This option makes code larger, and may
7765 or may not make it run faster.
7766
7767 Enabled with @option{-fprofile-use}.
7768
7769 @item -funroll-all-loops
7770 @opindex funroll-all-loops
7771 Unroll all loops, even if their number of iterations is uncertain when
7772 the loop is entered.  This usually makes programs run more slowly.
7773 @option{-funroll-all-loops} implies the same options as
7774 @option{-funroll-loops}.
7775
7776 @item -fpeel-loops
7777 @opindex fpeel-loops
7778 Peels the loops for that there is enough information that they do not
7779 roll much (from profile feedback).  It also turns on complete loop peeling
7780 (i.e.@: complete removal of loops with small constant number of iterations).
7781
7782 Enabled with @option{-fprofile-use}.
7783
7784 @item -fmove-loop-invariants
7785 @opindex fmove-loop-invariants
7786 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
7787 at level @option{-O1}
7788
7789 @item -funswitch-loops
7790 @opindex funswitch-loops
7791 Move branches with loop invariant conditions out of the loop, with duplicates
7792 of the loop on both branches (modified according to result of the condition).
7793
7794 @item -ffunction-sections
7795 @itemx -fdata-sections
7796 @opindex ffunction-sections
7797 @opindex fdata-sections
7798 Place each function or data item into its own section in the output
7799 file if the target supports arbitrary sections.  The name of the
7800 function or the name of the data item determines the section's name
7801 in the output file.
7802
7803 Use these options on systems where the linker can perform optimizations
7804 to improve locality of reference in the instruction space.  Most systems
7805 using the ELF object format and SPARC processors running Solaris 2 have
7806 linkers with such optimizations.  AIX may have these optimizations in
7807 the future.
7808
7809 Only use these options when there are significant benefits from doing
7810 so.  When you specify these options, the assembler and linker will
7811 create larger object and executable files and will also be slower.
7812 You will not be able to use @code{gprof} on all systems if you
7813 specify this option and you may have problems with debugging if
7814 you specify both this option and @option{-g}.
7815
7816 @item -fbranch-target-load-optimize
7817 @opindex fbranch-target-load-optimize
7818 Perform branch target register load optimization before prologue / epilogue
7819 threading.
7820 The use of target registers can typically be exposed only during reload,
7821 thus hoisting loads out of loops and doing inter-block scheduling needs
7822 a separate optimization pass.
7823
7824 @item -fbranch-target-load-optimize2
7825 @opindex fbranch-target-load-optimize2
7826 Perform branch target register load optimization after prologue / epilogue
7827 threading.
7828
7829 @item -fbtr-bb-exclusive
7830 @opindex fbtr-bb-exclusive
7831 When performing branch target register load optimization, don't reuse
7832 branch target registers in within any basic block.
7833
7834 @item -fstack-protector
7835 @opindex fstack-protector
7836 Emit extra code to check for buffer overflows, such as stack smashing
7837 attacks.  This is done by adding a guard variable to functions with
7838 vulnerable objects.  This includes functions that call alloca, and
7839 functions with buffers larger than 8 bytes.  The guards are initialized
7840 when a function is entered and then checked when the function exits.
7841 If a guard check fails, an error message is printed and the program exits.
7842
7843 @item -fstack-protector-all
7844 @opindex fstack-protector-all
7845 Like @option{-fstack-protector} except that all functions are protected.
7846
7847 @item -fsection-anchors
7848 @opindex fsection-anchors
7849 Try to reduce the number of symbolic address calculations by using
7850 shared ``anchor'' symbols to address nearby objects.  This transformation
7851 can help to reduce the number of GOT entries and GOT accesses on some
7852 targets.
7853
7854 For example, the implementation of the following function @code{foo}:
7855
7856 @smallexample
7857 static int a, b, c;
7858 int foo (void) @{ return a + b + c; @}
7859 @end smallexample
7860
7861 would usually calculate the addresses of all three variables, but if you
7862 compile it with @option{-fsection-anchors}, it will access the variables
7863 from a common anchor point instead.  The effect is similar to the
7864 following pseudocode (which isn't valid C):
7865
7866 @smallexample
7867 int foo (void)
7868 @{
7869   register int *xr = &x;
7870   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
7871 @}
7872 @end smallexample
7873
7874 Not all targets support this option.
7875
7876 @item --param @var{name}=@var{value}
7877 @opindex param
7878 In some places, GCC uses various constants to control the amount of
7879 optimization that is done.  For example, GCC will not inline functions
7880 that contain more that a certain number of instructions.  You can
7881 control some of these constants on the command-line using the
7882 @option{--param} option.
7883
7884 The names of specific parameters, and the meaning of the values, are
7885 tied to the internals of the compiler, and are subject to change
7886 without notice in future releases.
7887
7888 In each case, the @var{value} is an integer.  The allowable choices for
7889 @var{name} are given in the following table:
7890
7891 @table @gcctabopt
7892 @item struct-reorg-cold-struct-ratio
7893 The threshold ratio (as a percentage) between a structure frequency
7894 and the frequency of the hottest structure in the program.  This parameter
7895 is used by struct-reorg optimization enabled by @option{-fipa-struct-reorg}.
7896 We say that if the ratio of a structure frequency, calculated by profiling,
7897 to the hottest structure frequency in the program is less than this
7898 parameter, then structure reorganization is not applied to this structure.
7899 The default is 10.
7900
7901 @item predictable-branch-outcome
7902 When branch is predicted to be taken with probability lower than this threshold
7903 (in percent), then it is considered well predictable. The default is 10.
7904
7905 @item max-crossjump-edges
7906 The maximum number of incoming edges to consider for crossjumping.
7907 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
7908 the number of edges incoming to each block.  Increasing values mean
7909 more aggressive optimization, making the compile time increase with
7910 probably small improvement in executable size.
7911
7912 @item min-crossjump-insns
7913 The minimum number of instructions which must be matched at the end
7914 of two blocks before crossjumping will be performed on them.  This
7915 value is ignored in the case where all instructions in the block being
7916 crossjumped from are matched.  The default value is 5.
7917
7918 @item max-grow-copy-bb-insns
7919 The maximum code size expansion factor when copying basic blocks
7920 instead of jumping.  The expansion is relative to a jump instruction.
7921 The default value is 8.
7922
7923 @item max-goto-duplication-insns
7924 The maximum number of instructions to duplicate to a block that jumps
7925 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
7926 passes, GCC factors computed gotos early in the compilation process,
7927 and unfactors them as late as possible.  Only computed jumps at the
7928 end of a basic blocks with no more than max-goto-duplication-insns are
7929 unfactored.  The default value is 8.
7930
7931 @item max-delay-slot-insn-search
7932 The maximum number of instructions to consider when looking for an
7933 instruction to fill a delay slot.  If more than this arbitrary number of
7934 instructions is searched, the time savings from filling the delay slot
7935 will be minimal so stop searching.  Increasing values mean more
7936 aggressive optimization, making the compile time increase with probably
7937 small improvement in executable run time.
7938
7939 @item max-delay-slot-live-search
7940 When trying to fill delay slots, the maximum number of instructions to
7941 consider when searching for a block with valid live register
7942 information.  Increasing this arbitrarily chosen value means more
7943 aggressive optimization, increasing the compile time.  This parameter
7944 should be removed when the delay slot code is rewritten to maintain the
7945 control-flow graph.
7946
7947 @item max-gcse-memory
7948 The approximate maximum amount of memory that will be allocated in
7949 order to perform the global common subexpression elimination
7950 optimization.  If more memory than specified is required, the
7951 optimization will not be done.
7952
7953 @item max-pending-list-length
7954 The maximum number of pending dependencies scheduling will allow
7955 before flushing the current state and starting over.  Large functions
7956 with few branches or calls can create excessively large lists which
7957 needlessly consume memory and resources.
7958
7959 @item max-inline-insns-single
7960 Several parameters control the tree inliner used in gcc.
7961 This number sets the maximum number of instructions (counted in GCC's
7962 internal representation) in a single function that the tree inliner
7963 will consider for inlining.  This only affects functions declared
7964 inline and methods implemented in a class declaration (C++).
7965 The default value is 300.
7966
7967 @item max-inline-insns-auto
7968 When you use @option{-finline-functions} (included in @option{-O3}),
7969 a lot of functions that would otherwise not be considered for inlining
7970 by the compiler will be investigated.  To those functions, a different
7971 (more restrictive) limit compared to functions declared inline can
7972 be applied.
7973 The default value is 50.
7974
7975 @item large-function-insns
7976 The limit specifying really large functions.  For functions larger than this
7977 limit after inlining, inlining is constrained by
7978 @option{--param large-function-growth}.  This parameter is useful primarily
7979 to avoid extreme compilation time caused by non-linear algorithms used by the
7980 backend.
7981 The default value is 2700.
7982
7983 @item large-function-growth
7984 Specifies maximal growth of large function caused by inlining in percents.
7985 The default value is 100 which limits large function growth to 2.0 times
7986 the original size.
7987
7988 @item large-unit-insns
7989 The limit specifying large translation unit.  Growth caused by inlining of
7990 units larger than this limit is limited by @option{--param inline-unit-growth}.
7991 For small units this might be too tight (consider unit consisting of function A
7992 that is inline and B that just calls A three time.  If B is small relative to
7993 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
7994 large units consisting of small inlineable functions however the overall unit
7995 growth limit is needed to avoid exponential explosion of code size.  Thus for
7996 smaller units, the size is increased to @option{--param large-unit-insns}
7997 before applying @option{--param inline-unit-growth}.  The default is 10000
7998
7999 @item inline-unit-growth
8000 Specifies maximal overall growth of the compilation unit caused by inlining.
8001 The default value is 30 which limits unit growth to 1.3 times the original
8002 size.
8003
8004 @item ipcp-unit-growth
8005 Specifies maximal overall growth of the compilation unit caused by
8006 interprocedural constant propagation.  The default value is 10 which limits
8007 unit growth to 1.1 times the original size.
8008
8009 @item large-stack-frame
8010 The limit specifying large stack frames.  While inlining the algorithm is trying
8011 to not grow past this limit too much.  Default value is 256 bytes.
8012
8013 @item large-stack-frame-growth
8014 Specifies maximal growth of large stack frames caused by inlining in percents.
8015 The default value is 1000 which limits large stack frame growth to 11 times
8016 the original size.
8017
8018 @item max-inline-insns-recursive
8019 @itemx max-inline-insns-recursive-auto
8020 Specifies maximum number of instructions out-of-line copy of self recursive inline
8021 function can grow into by performing recursive inlining.
8022
8023 For functions declared inline @option{--param max-inline-insns-recursive} is
8024 taken into account.  For function not declared inline, recursive inlining
8025 happens only when @option{-finline-functions} (included in @option{-O3}) is
8026 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
8027 default value is 450.
8028
8029 @item max-inline-recursive-depth
8030 @itemx max-inline-recursive-depth-auto
8031 Specifies maximum recursion depth used by the recursive inlining.
8032
8033 For functions declared inline @option{--param max-inline-recursive-depth} is
8034 taken into account.  For function not declared inline, recursive inlining
8035 happens only when @option{-finline-functions} (included in @option{-O3}) is
8036 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
8037 default value is 8.
8038
8039 @item min-inline-recursive-probability
8040 Recursive inlining is profitable only for function having deep recursion
8041 in average and can hurt for function having little recursion depth by
8042 increasing the prologue size or complexity of function body to other
8043 optimizers.
8044
8045 When profile feedback is available (see @option{-fprofile-generate}) the actual
8046 recursion depth can be guessed from probability that function will recurse via
8047 given call expression.  This parameter limits inlining only to call expression
8048 whose probability exceeds given threshold (in percents).  The default value is
8049 10.
8050
8051 @item early-inlining-insns
8052 Specify growth that early inliner can make.  In effect it increases amount of
8053 inlining for code having large abstraction penalty.  The default value is 8.
8054
8055 @item max-early-inliner-iterations
8056 @itemx max-early-inliner-iterations
8057 Limit of iterations of early inliner.  This basically bounds number of nested
8058 indirect calls early inliner can resolve.  Deeper chains are still handled by
8059 late inlining.
8060
8061 @item min-vect-loop-bound
8062 The minimum number of iterations under which a loop will not get vectorized
8063 when @option{-ftree-vectorize} is used.  The number of iterations after
8064 vectorization needs to be greater than the value specified by this option
8065 to allow vectorization.  The default value is 0.
8066
8067 @item max-unrolled-insns
8068 The maximum number of instructions that a loop should have if that loop
8069 is unrolled, and if the loop is unrolled, it determines how many times
8070 the loop code is unrolled.
8071
8072 @item max-average-unrolled-insns
8073 The maximum number of instructions biased by probabilities of their execution
8074 that a loop should have if that loop is unrolled, and if the loop is unrolled,
8075 it determines how many times the loop code is unrolled.
8076
8077 @item max-unroll-times
8078 The maximum number of unrollings of a single loop.
8079
8080 @item max-peeled-insns
8081 The maximum number of instructions that a loop should have if that loop
8082 is peeled, and if the loop is peeled, it determines how many times
8083 the loop code is peeled.
8084
8085 @item max-peel-times
8086 The maximum number of peelings of a single loop.
8087
8088 @item max-completely-peeled-insns
8089 The maximum number of insns of a completely peeled loop.
8090
8091 @item max-completely-peel-times
8092 The maximum number of iterations of a loop to be suitable for complete peeling.
8093
8094 @item max-unswitch-insns
8095 The maximum number of insns of an unswitched loop.
8096
8097 @item max-unswitch-level
8098 The maximum number of branches unswitched in a single loop.
8099
8100 @item lim-expensive
8101 The minimum cost of an expensive expression in the loop invariant motion.
8102
8103 @item iv-consider-all-candidates-bound
8104 Bound on number of candidates for induction variables below that
8105 all candidates are considered for each use in induction variable
8106 optimizations.  Only the most relevant candidates are considered
8107 if there are more candidates, to avoid quadratic time complexity.
8108
8109 @item iv-max-considered-uses
8110 The induction variable optimizations give up on loops that contain more
8111 induction variable uses.
8112
8113 @item iv-always-prune-cand-set-bound
8114 If number of candidates in the set is smaller than this value,
8115 we always try to remove unnecessary ivs from the set during its
8116 optimization when a new iv is added to the set.
8117
8118 @item scev-max-expr-size
8119 Bound on size of expressions used in the scalar evolutions analyzer.
8120 Large expressions slow the analyzer.
8121
8122 @item omega-max-vars
8123 The maximum number of variables in an Omega constraint system.
8124 The default value is 128.
8125
8126 @item omega-max-geqs
8127 The maximum number of inequalities in an Omega constraint system.
8128 The default value is 256.
8129
8130 @item omega-max-eqs
8131 The maximum number of equalities in an Omega constraint system.
8132 The default value is 128.
8133
8134 @item omega-max-wild-cards
8135 The maximum number of wildcard variables that the Omega solver will
8136 be able to insert.  The default value is 18.
8137
8138 @item omega-hash-table-size
8139 The size of the hash table in the Omega solver.  The default value is
8140 550.
8141
8142 @item omega-max-keys
8143 The maximal number of keys used by the Omega solver.  The default
8144 value is 500.
8145
8146 @item omega-eliminate-redundant-constraints
8147 When set to 1, use expensive methods to eliminate all redundant
8148 constraints.  The default value is 0.
8149
8150 @item vect-max-version-for-alignment-checks
8151 The maximum number of runtime checks that can be performed when
8152 doing loop versioning for alignment in the vectorizer.  See option
8153 ftree-vect-loop-version for more information.
8154
8155 @item vect-max-version-for-alias-checks
8156 The maximum number of runtime checks that can be performed when
8157 doing loop versioning for alias in the vectorizer.  See option
8158 ftree-vect-loop-version for more information.
8159
8160 @item max-iterations-to-track
8161
8162 The maximum number of iterations of a loop the brute force algorithm
8163 for analysis of # of iterations of the loop tries to evaluate.
8164
8165 @item hot-bb-count-fraction
8166 Select fraction of the maximal count of repetitions of basic block in program
8167 given basic block needs to have to be considered hot.
8168
8169 @item hot-bb-frequency-fraction
8170 Select fraction of the maximal frequency of executions of basic block in
8171 function given basic block needs to have to be considered hot
8172
8173 @item max-predicted-iterations
8174 The maximum number of loop iterations we predict statically.  This is useful
8175 in cases where function contain single loop with known bound and other loop
8176 with unknown.  We predict the known number of iterations correctly, while
8177 the unknown number of iterations average to roughly 10.  This means that the
8178 loop without bounds would appear artificially cold relative to the other one.
8179
8180 @item align-threshold
8181
8182 Select fraction of the maximal frequency of executions of basic block in
8183 function given basic block will get aligned.
8184
8185 @item align-loop-iterations
8186
8187 A loop expected to iterate at lest the selected number of iterations will get
8188 aligned.
8189
8190 @item tracer-dynamic-coverage
8191 @itemx tracer-dynamic-coverage-feedback
8192
8193 This value is used to limit superblock formation once the given percentage of
8194 executed instructions is covered.  This limits unnecessary code size
8195 expansion.
8196
8197 The @option{tracer-dynamic-coverage-feedback} is used only when profile
8198 feedback is available.  The real profiles (as opposed to statically estimated
8199 ones) are much less balanced allowing the threshold to be larger value.
8200
8201 @item tracer-max-code-growth
8202 Stop tail duplication once code growth has reached given percentage.  This is
8203 rather hokey argument, as most of the duplicates will be eliminated later in
8204 cross jumping, so it may be set to much higher values than is the desired code
8205 growth.
8206
8207 @item tracer-min-branch-ratio
8208
8209 Stop reverse growth when the reverse probability of best edge is less than this
8210 threshold (in percent).
8211
8212 @item tracer-min-branch-ratio
8213 @itemx tracer-min-branch-ratio-feedback
8214
8215 Stop forward growth if the best edge do have probability lower than this
8216 threshold.
8217
8218 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
8219 compilation for profile feedback and one for compilation without.  The value
8220 for compilation with profile feedback needs to be more conservative (higher) in
8221 order to make tracer effective.
8222
8223 @item max-cse-path-length
8224
8225 Maximum number of basic blocks on path that cse considers.  The default is 10.
8226
8227 @item max-cse-insns
8228 The maximum instructions CSE process before flushing. The default is 1000.
8229
8230 @item ggc-min-expand
8231
8232 GCC uses a garbage collector to manage its own memory allocation.  This
8233 parameter specifies the minimum percentage by which the garbage
8234 collector's heap should be allowed to expand between collections.
8235 Tuning this may improve compilation speed; it has no effect on code
8236 generation.
8237
8238 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
8239 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
8240 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
8241 GCC is not able to calculate RAM on a particular platform, the lower
8242 bound of 30% is used.  Setting this parameter and
8243 @option{ggc-min-heapsize} to zero causes a full collection to occur at
8244 every opportunity.  This is extremely slow, but can be useful for
8245 debugging.
8246
8247 @item ggc-min-heapsize
8248
8249 Minimum size of the garbage collector's heap before it begins bothering
8250 to collect garbage.  The first collection occurs after the heap expands
8251 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
8252 tuning this may improve compilation speed, and has no effect on code
8253 generation.
8254
8255 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
8256 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
8257 with a lower bound of 4096 (four megabytes) and an upper bound of
8258 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
8259 particular platform, the lower bound is used.  Setting this parameter
8260 very large effectively disables garbage collection.  Setting this
8261 parameter and @option{ggc-min-expand} to zero causes a full collection
8262 to occur at every opportunity.
8263
8264 @item max-reload-search-insns
8265 The maximum number of instruction reload should look backward for equivalent
8266 register.  Increasing values mean more aggressive optimization, making the
8267 compile time increase with probably slightly better performance.  The default
8268 value is 100.
8269
8270 @item max-cselib-memory-locations
8271 The maximum number of memory locations cselib should take into account.
8272 Increasing values mean more aggressive optimization, making the compile time
8273 increase with probably slightly better performance.  The default value is 500.
8274
8275 @item reorder-blocks-duplicate
8276 @itemx reorder-blocks-duplicate-feedback
8277
8278 Used by basic block reordering pass to decide whether to use unconditional
8279 branch or duplicate the code on its destination.  Code is duplicated when its
8280 estimated size is smaller than this value multiplied by the estimated size of
8281 unconditional jump in the hot spots of the program.
8282
8283 The @option{reorder-block-duplicate-feedback} is used only when profile
8284 feedback is available and may be set to higher values than
8285 @option{reorder-block-duplicate} since information about the hot spots is more
8286 accurate.
8287
8288 @item max-sched-ready-insns
8289 The maximum number of instructions ready to be issued the scheduler should
8290 consider at any given time during the first scheduling pass.  Increasing
8291 values mean more thorough searches, making the compilation time increase
8292 with probably little benefit.  The default value is 100.
8293
8294 @item max-sched-region-blocks
8295 The maximum number of blocks in a region to be considered for
8296 interblock scheduling.  The default value is 10.
8297
8298 @item max-pipeline-region-blocks
8299 The maximum number of blocks in a region to be considered for
8300 pipelining in the selective scheduler.  The default value is 15.
8301
8302 @item max-sched-region-insns
8303 The maximum number of insns in a region to be considered for
8304 interblock scheduling.  The default value is 100.
8305
8306 @item max-pipeline-region-insns
8307 The maximum number of insns in a region to be considered for
8308 pipelining in the selective scheduler.  The default value is 200.
8309
8310 @item min-spec-prob
8311 The minimum probability (in percents) of reaching a source block
8312 for interblock speculative scheduling.  The default value is 40.
8313
8314 @item max-sched-extend-regions-iters
8315 The maximum number of iterations through CFG to extend regions.
8316 0 - disable region extension,
8317 N - do at most N iterations.
8318 The default value is 0.
8319
8320 @item max-sched-insn-conflict-delay
8321 The maximum conflict delay for an insn to be considered for speculative motion.
8322 The default value is 3.
8323
8324 @item sched-spec-prob-cutoff
8325 The minimal probability of speculation success (in percents), so that
8326 speculative insn will be scheduled.
8327 The default value is 40.
8328
8329 @item sched-mem-true-dep-cost
8330 Minimal distance (in CPU cycles) between store and load targeting same
8331 memory locations.  The default value is 1.
8332
8333 @item selsched-max-lookahead
8334 The maximum size of the lookahead window of selective scheduling.  It is a
8335 depth of search for available instructions.
8336 The default value is 50.
8337
8338 @item selsched-max-sched-times
8339 The maximum number of times that an instruction will be scheduled during
8340 selective scheduling.  This is the limit on the number of iterations
8341 through which the instruction may be pipelined.  The default value is 2.
8342
8343 @item selsched-max-insns-to-rename
8344 The maximum number of best instructions in the ready list that are considered
8345 for renaming in the selective scheduler.  The default value is 2.
8346
8347 @item max-last-value-rtl
8348 The maximum size measured as number of RTLs that can be recorded in an expression
8349 in combiner for a pseudo register as last known value of that register.  The default
8350 is 10000.
8351
8352 @item integer-share-limit
8353 Small integer constants can use a shared data structure, reducing the
8354 compiler's memory usage and increasing its speed.  This sets the maximum
8355 value of a shared integer constant.  The default value is 256.
8356
8357 @item min-virtual-mappings
8358 Specifies the minimum number of virtual mappings in the incremental
8359 SSA updater that should be registered to trigger the virtual mappings
8360 heuristic defined by virtual-mappings-ratio.  The default value is
8361 100.
8362
8363 @item virtual-mappings-ratio
8364 If the number of virtual mappings is virtual-mappings-ratio bigger
8365 than the number of virtual symbols to be updated, then the incremental
8366 SSA updater switches to a full update for those symbols.  The default
8367 ratio is 3.
8368
8369 @item ssp-buffer-size
8370 The minimum size of buffers (i.e.@: arrays) that will receive stack smashing
8371 protection when @option{-fstack-protection} is used.
8372
8373 @item max-jump-thread-duplication-stmts
8374 Maximum number of statements allowed in a block that needs to be
8375 duplicated when threading jumps.
8376
8377 @item max-fields-for-field-sensitive
8378 Maximum number of fields in a structure we will treat in
8379 a field sensitive manner during pointer analysis.  The default is zero
8380 for -O0, and -O1 and 100 for -Os, -O2, and -O3.
8381
8382 @item prefetch-latency
8383 Estimate on average number of instructions that are executed before
8384 prefetch finishes.  The distance we prefetch ahead is proportional
8385 to this constant.  Increasing this number may also lead to less
8386 streams being prefetched (see @option{simultaneous-prefetches}).
8387
8388 @item simultaneous-prefetches
8389 Maximum number of prefetches that can run at the same time.
8390
8391 @item l1-cache-line-size
8392 The size of cache line in L1 cache, in bytes.
8393
8394 @item l1-cache-size
8395 The size of L1 cache, in kilobytes.
8396
8397 @item l2-cache-size
8398 The size of L2 cache, in kilobytes.
8399
8400 @item min-insn-to-prefetch-ratio
8401 The minimum ratio between the number of instructions and the
8402 number of prefetches to enable prefetching in a loop with an
8403 unknown trip count.
8404
8405 @item prefetch-min-insn-to-mem-ratio
8406 The minimum ratio between the number of instructions and the
8407 number of memory references to enable prefetching in a loop.
8408
8409 @item use-canonical-types
8410 Whether the compiler should use the ``canonical'' type system.  By
8411 default, this should always be 1, which uses a more efficient internal
8412 mechanism for comparing types in C++ and Objective-C++.  However, if
8413 bugs in the canonical type system are causing compilation failures,
8414 set this value to 0 to disable canonical types.
8415
8416 @item switch-conversion-max-branch-ratio
8417 Switch initialization conversion will refuse to create arrays that are
8418 bigger than @option{switch-conversion-max-branch-ratio} times the number of
8419 branches in the switch.
8420
8421 @item max-partial-antic-length
8422 Maximum length of the partial antic set computed during the tree
8423 partial redundancy elimination optimization (@option{-ftree-pre}) when
8424 optimizing at @option{-O3} and above.  For some sorts of source code
8425 the enhanced partial redundancy elimination optimization can run away,
8426 consuming all of the memory available on the host machine.  This
8427 parameter sets a limit on the length of the sets that are computed,
8428 which prevents the runaway behavior.  Setting a value of 0 for
8429 this parameter will allow an unlimited set length.
8430
8431 @item sccvn-max-scc-size
8432 Maximum size of a strongly connected component (SCC) during SCCVN
8433 processing.  If this limit is hit, SCCVN processing for the whole
8434 function will not be done and optimizations depending on it will
8435 be disabled.  The default maximum SCC size is 10000.
8436
8437 @item ira-max-loops-num
8438 IRA uses a regional register allocation by default.  If a function
8439 contains loops more than number given by the parameter, only at most
8440 given number of the most frequently executed loops will form regions
8441 for the regional register allocation.  The default value of the
8442 parameter is 100.
8443
8444 @item ira-max-conflict-table-size
8445 Although IRA uses a sophisticated algorithm of compression conflict
8446 table, the table can be still big for huge functions.  If the conflict
8447 table for a function could be more than size in MB given by the
8448 parameter, the conflict table is not built and faster, simpler, and
8449 lower quality register allocation algorithm will be used.  The
8450 algorithm do not use pseudo-register conflicts.  The default value of
8451 the parameter is 2000.
8452
8453 @item ira-loop-reserved-regs
8454 IRA can be used to evaluate more accurate register pressure in loops
8455 for decision to move loop invariants (see @option{-O3}).  The number
8456 of available registers reserved for some other purposes is described
8457 by this parameter.  The default value of the parameter is 2 which is
8458 minimal number of registers needed for execution of typical
8459 instruction.  This value is the best found from numerous experiments.
8460
8461 @item loop-invariant-max-bbs-in-loop
8462 Loop invariant motion can be very expensive, both in compile time and
8463 in amount of needed compile time memory, with very large loops.  Loops
8464 with more basic blocks than this parameter won't have loop invariant
8465 motion optimization performed on them.  The default value of the
8466 parameter is 1000 for -O1 and 10000 for -O2 and above.
8467
8468 @item min-nondebug-insn-uid
8469 Use uids starting at this parameter for nondebug insns.  The range below
8470 the parameter is reserved exclusively for debug insns created by
8471 @option{-fvar-tracking-assignments}, but debug insns may get
8472 (non-overlapping) uids above it if the reserved range is exhausted.
8473
8474 @item ipa-sra-ptr-growth-factor
8475 IPA-SRA will replace a pointer to an aggregate with one or more new
8476 parameters only when their cumulative size is less or equal to
8477 @option{ipa-sra-ptr-growth-factor} times the size of the original
8478 pointer parameter.
8479
8480 @end table
8481 @end table
8482
8483 @node Preprocessor Options
8484 @section Options Controlling the Preprocessor
8485 @cindex preprocessor options
8486 @cindex options, preprocessor
8487
8488 These options control the C preprocessor, which is run on each C source
8489 file before actual compilation.
8490
8491 If you use the @option{-E} option, nothing is done except preprocessing.
8492 Some of these options make sense only together with @option{-E} because
8493 they cause the preprocessor output to be unsuitable for actual
8494 compilation.
8495
8496 @table @gcctabopt
8497 @item -Wp,@var{option}
8498 @opindex Wp
8499 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8500 and pass @var{option} directly through to the preprocessor.  If
8501 @var{option} contains commas, it is split into multiple options at the
8502 commas.  However, many options are modified, translated or interpreted
8503 by the compiler driver before being passed to the preprocessor, and
8504 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
8505 interface is undocumented and subject to change, so whenever possible
8506 you should avoid using @option{-Wp} and let the driver handle the
8507 options instead.
8508
8509 @item -Xpreprocessor @var{option}
8510 @opindex Xpreprocessor
8511 Pass @var{option} as an option to the preprocessor.  You can use this to
8512 supply system-specific preprocessor options which GCC does not know how to
8513 recognize.
8514
8515 If you want to pass an option that takes an argument, you must use
8516 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8517 @end table
8518
8519 @include cppopts.texi
8520
8521 @node Assembler Options
8522 @section Passing Options to the Assembler
8523
8524 @c prevent bad page break with this line
8525 You can pass options to the assembler.
8526
8527 @table @gcctabopt
8528 @item -Wa,@var{option}
8529 @opindex Wa
8530 Pass @var{option} as an option to the assembler.  If @var{option}
8531 contains commas, it is split into multiple options at the commas.
8532
8533 @item -Xassembler @var{option}
8534 @opindex Xassembler
8535 Pass @var{option} as an option to the assembler.  You can use this to
8536 supply system-specific assembler options which GCC does not know how to
8537 recognize.
8538
8539 If you want to pass an option that takes an argument, you must use
8540 @option{-Xassembler} twice, once for the option and once for the argument.
8541
8542 @end table
8543
8544 @node Link Options
8545 @section Options for Linking
8546 @cindex link options
8547 @cindex options, linking
8548
8549 These options come into play when the compiler links object files into
8550 an executable output file.  They are meaningless if the compiler is
8551 not doing a link step.
8552
8553 @table @gcctabopt
8554 @cindex file names
8555 @item @var{object-file-name}
8556 A file name that does not end in a special recognized suffix is
8557 considered to name an object file or library.  (Object files are
8558 distinguished from libraries by the linker according to the file
8559 contents.)  If linking is done, these object files are used as input
8560 to the linker.
8561
8562 @item -c
8563 @itemx -S
8564 @itemx -E
8565 @opindex c
8566 @opindex S
8567 @opindex E
8568 If any of these options is used, then the linker is not run, and
8569 object file names should not be used as arguments.  @xref{Overall
8570 Options}.
8571
8572 @cindex Libraries
8573 @item -l@var{library}
8574 @itemx -l @var{library}
8575 @opindex l
8576 Search the library named @var{library} when linking.  (The second
8577 alternative with the library as a separate argument is only for
8578 POSIX compliance and is not recommended.)
8579
8580 It makes a difference where in the command you write this option; the
8581 linker searches and processes libraries and object files in the order they
8582 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8583 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
8584 to functions in @samp{z}, those functions may not be loaded.
8585
8586 The linker searches a standard list of directories for the library,
8587 which is actually a file named @file{lib@var{library}.a}.  The linker
8588 then uses this file as if it had been specified precisely by name.
8589
8590 The directories searched include several standard system directories
8591 plus any that you specify with @option{-L}.
8592
8593 Normally the files found this way are library files---archive files
8594 whose members are object files.  The linker handles an archive file by
8595 scanning through it for members which define symbols that have so far
8596 been referenced but not defined.  But if the file that is found is an
8597 ordinary object file, it is linked in the usual fashion.  The only
8598 difference between using an @option{-l} option and specifying a file name
8599 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8600 and searches several directories.
8601
8602 @item -lobjc
8603 @opindex lobjc
8604 You need this special case of the @option{-l} option in order to
8605 link an Objective-C or Objective-C++ program.
8606
8607 @item -nostartfiles
8608 @opindex nostartfiles
8609 Do not use the standard system startup files when linking.
8610 The standard system libraries are used normally, unless @option{-nostdlib}
8611 or @option{-nodefaultlibs} is used.
8612
8613 @item -nodefaultlibs
8614 @opindex nodefaultlibs
8615 Do not use the standard system libraries when linking.
8616 Only the libraries you specify will be passed to the linker, options
8617 specifying linkage of the system libraries, such as @code{-static-libgcc}
8618 or @code{-shared-libgcc}, will be ignored.
8619 The standard startup files are used normally, unless @option{-nostartfiles}
8620 is used.  The compiler may generate calls to @code{memcmp},
8621 @code{memset}, @code{memcpy} and @code{memmove}.
8622 These entries are usually resolved by entries in
8623 libc.  These entry points should be supplied through some other
8624 mechanism when this option is specified.
8625
8626 @item -nostdlib
8627 @opindex nostdlib
8628 Do not use the standard system startup files or libraries when linking.
8629 No startup files and only the libraries you specify will be passed to
8630 the linker, options specifying linkage of the system libraries, such as
8631 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
8632 The compiler may generate calls to @code{memcmp}, @code{memset},
8633 @code{memcpy} and @code{memmove}.
8634 These entries are usually resolved by entries in
8635 libc.  These entry points should be supplied through some other
8636 mechanism when this option is specified.
8637
8638 @cindex @option{-lgcc}, use with @option{-nostdlib}
8639 @cindex @option{-nostdlib} and unresolved references
8640 @cindex unresolved references and @option{-nostdlib}
8641 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
8642 @cindex @option{-nodefaultlibs} and unresolved references
8643 @cindex unresolved references and @option{-nodefaultlibs}
8644 One of the standard libraries bypassed by @option{-nostdlib} and
8645 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
8646 that GCC uses to overcome shortcomings of particular machines, or special
8647 needs for some languages.
8648 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
8649 Collection (GCC) Internals},
8650 for more discussion of @file{libgcc.a}.)
8651 In most cases, you need @file{libgcc.a} even when you want to avoid
8652 other standard libraries.  In other words, when you specify @option{-nostdlib}
8653 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
8654 This ensures that you have no unresolved references to internal GCC
8655 library subroutines.  (For example, @samp{__main}, used to ensure C++
8656 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
8657 GNU Compiler Collection (GCC) Internals}.)
8658
8659 @item -pie
8660 @opindex pie
8661 Produce a position independent executable on targets which support it.
8662 For predictable results, you must also specify the same set of options
8663 that were used to generate code (@option{-fpie}, @option{-fPIE},
8664 or model suboptions) when you specify this option.
8665
8666 @item -rdynamic
8667 @opindex rdynamic
8668 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
8669 that support it. This instructs the linker to add all symbols, not
8670 only used ones, to the dynamic symbol table. This option is needed
8671 for some uses of @code{dlopen} or to allow obtaining backtraces
8672 from within a program.
8673
8674 @item -s
8675 @opindex s
8676 Remove all symbol table and relocation information from the executable.
8677
8678 @item -static
8679 @opindex static
8680 On systems that support dynamic linking, this prevents linking with the shared
8681 libraries.  On other systems, this option has no effect.
8682
8683 @item -shared
8684 @opindex shared
8685 Produce a shared object which can then be linked with other objects to
8686 form an executable.  Not all systems support this option.  For predictable
8687 results, you must also specify the same set of options that were used to
8688 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
8689 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
8690 needs to build supplementary stub code for constructors to work.  On
8691 multi-libbed systems, @samp{gcc -shared} must select the correct support
8692 libraries to link against.  Failing to supply the correct flags may lead
8693 to subtle defects.  Supplying them in cases where they are not necessary
8694 is innocuous.}
8695
8696 @item -shared-libgcc
8697 @itemx -static-libgcc
8698 @opindex shared-libgcc
8699 @opindex static-libgcc
8700 On systems that provide @file{libgcc} as a shared library, these options
8701 force the use of either the shared or static version respectively.
8702 If no shared version of @file{libgcc} was built when the compiler was
8703 configured, these options have no effect.
8704
8705 There are several situations in which an application should use the
8706 shared @file{libgcc} instead of the static version.  The most common
8707 of these is when the application wishes to throw and catch exceptions
8708 across different shared libraries.  In that case, each of the libraries
8709 as well as the application itself should use the shared @file{libgcc}.
8710
8711 Therefore, the G++ and GCJ drivers automatically add
8712 @option{-shared-libgcc} whenever you build a shared library or a main
8713 executable, because C++ and Java programs typically use exceptions, so
8714 this is the right thing to do.
8715
8716 If, instead, you use the GCC driver to create shared libraries, you may
8717 find that they will not always be linked with the shared @file{libgcc}.
8718 If GCC finds, at its configuration time, that you have a non-GNU linker
8719 or a GNU linker that does not support option @option{--eh-frame-hdr},
8720 it will link the shared version of @file{libgcc} into shared libraries
8721 by default.  Otherwise, it will take advantage of the linker and optimize
8722 away the linking with the shared version of @file{libgcc}, linking with
8723 the static version of libgcc by default.  This allows exceptions to
8724 propagate through such shared libraries, without incurring relocation
8725 costs at library load time.
8726
8727 However, if a library or main executable is supposed to throw or catch
8728 exceptions, you must link it using the G++ or GCJ driver, as appropriate
8729 for the languages used in the program, or using the option
8730 @option{-shared-libgcc}, such that it is linked with the shared
8731 @file{libgcc}.
8732
8733 @item -static-libstdc++
8734 When the @command{g++} program is used to link a C++ program, it will
8735 normally automatically link against @option{libstdc++}.  If
8736 @file{libstdc++} is available as a shared library, and the
8737 @option{-static} option is not used, then this will link against the
8738 shared version of @file{libstdc++}.  That is normally fine.  However, it
8739 is sometimes useful to freeze the version of @file{libstdc++} used by
8740 the program without going all the way to a fully static link.  The
8741 @option{-static-libstdc++} option directs the @command{g++} driver to
8742 link @file{libstdc++} statically, without necessarily linking other
8743 libraries statically.
8744
8745 @item -symbolic
8746 @opindex symbolic
8747 Bind references to global symbols when building a shared object.  Warn
8748 about any unresolved references (unless overridden by the link editor
8749 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
8750 this option.
8751
8752 @item -T @var{script}
8753 @opindex T
8754 @cindex linker script
8755 Use @var{script} as the linker script.  This option is supported by most
8756 systems using the GNU linker.  On some targets, such as bare-board
8757 targets without an operating system, the @option{-T} option may be required
8758 when linking to avoid references to undefined symbols.
8759
8760 @item -Xlinker @var{option}
8761 @opindex Xlinker
8762 Pass @var{option} as an option to the linker.  You can use this to
8763 supply system-specific linker options which GCC does not know how to
8764 recognize.
8765
8766 If you want to pass an option that takes a separate argument, you must use
8767 @option{-Xlinker} twice, once for the option and once for the argument.
8768 For example, to pass @option{-assert definitions}, you must write
8769 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
8770 @option{-Xlinker "-assert definitions"}, because this passes the entire
8771 string as a single argument, which is not what the linker expects.
8772
8773 When using the GNU linker, it is usually more convenient to pass
8774 arguments to linker options using the @option{@var{option}=@var{value}}
8775 syntax than as separate arguments.  For example, you can specify
8776 @samp{-Xlinker -Map=output.map} rather than
8777 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
8778 this syntax for command-line options.
8779
8780 @item -Wl,@var{option}
8781 @opindex Wl
8782 Pass @var{option} as an option to the linker.  If @var{option} contains
8783 commas, it is split into multiple options at the commas.  You can use this
8784 syntax to pass an argument to the option.
8785 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
8786 linker.  When using the GNU linker, you can also get the same effect with
8787 @samp{-Wl,-Map=output.map}.
8788
8789 @item -u @var{symbol}
8790 @opindex u
8791 Pretend the symbol @var{symbol} is undefined, to force linking of
8792 library modules to define it.  You can use @option{-u} multiple times with
8793 different symbols to force loading of additional library modules.
8794 @end table
8795
8796 @node Directory Options
8797 @section Options for Directory Search
8798 @cindex directory options
8799 @cindex options, directory search
8800 @cindex search path
8801
8802 These options specify directories to search for header files, for
8803 libraries and for parts of the compiler:
8804
8805 @table @gcctabopt
8806 @item -I@var{dir}
8807 @opindex I
8808 Add the directory @var{dir} to the head of the list of directories to be
8809 searched for header files.  This can be used to override a system header
8810 file, substituting your own version, since these directories are
8811 searched before the system header file directories.  However, you should
8812 not use this option to add directories that contain vendor-supplied
8813 system header files (use @option{-isystem} for that).  If you use more than
8814 one @option{-I} option, the directories are scanned in left-to-right
8815 order; the standard system directories come after.
8816
8817 If a standard system include directory, or a directory specified with
8818 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
8819 option will be ignored.  The directory will still be searched but as a
8820 system directory at its normal position in the system include chain.
8821 This is to ensure that GCC's procedure to fix buggy system headers and
8822 the ordering for the include_next directive are not inadvertently changed.
8823 If you really need to change the search order for system directories,
8824 use the @option{-nostdinc} and/or @option{-isystem} options.
8825
8826 @item -iquote@var{dir}
8827 @opindex iquote
8828 Add the directory @var{dir} to the head of the list of directories to
8829 be searched for header files only for the case of @samp{#include
8830 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
8831 otherwise just like @option{-I}.
8832
8833 @item -L@var{dir}
8834 @opindex L
8835 Add directory @var{dir} to the list of directories to be searched
8836 for @option{-l}.
8837
8838 @item -B@var{prefix}
8839 @opindex B
8840 This option specifies where to find the executables, libraries,
8841 include files, and data files of the compiler itself.
8842
8843 The compiler driver program runs one or more of the subprograms
8844 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
8845 @var{prefix} as a prefix for each program it tries to run, both with and
8846 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
8847
8848 For each subprogram to be run, the compiler driver first tries the
8849 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
8850 was not specified, the driver tries two standard prefixes, which are
8851 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
8852 those results in a file name that is found, the unmodified program
8853 name is searched for using the directories specified in your
8854 @env{PATH} environment variable.
8855
8856 The compiler will check to see if the path provided by the @option{-B}
8857 refers to a directory, and if necessary it will add a directory
8858 separator character at the end of the path.
8859
8860 @option{-B} prefixes that effectively specify directory names also apply
8861 to libraries in the linker, because the compiler translates these
8862 options into @option{-L} options for the linker.  They also apply to
8863 includes files in the preprocessor, because the compiler translates these
8864 options into @option{-isystem} options for the preprocessor.  In this case,
8865 the compiler appends @samp{include} to the prefix.
8866
8867 The run-time support file @file{libgcc.a} can also be searched for using
8868 the @option{-B} prefix, if needed.  If it is not found there, the two
8869 standard prefixes above are tried, and that is all.  The file is left
8870 out of the link if it is not found by those means.
8871
8872 Another way to specify a prefix much like the @option{-B} prefix is to use
8873 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
8874 Variables}.
8875
8876 As a special kludge, if the path provided by @option{-B} is
8877 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
8878 9, then it will be replaced by @file{[dir/]include}.  This is to help
8879 with boot-strapping the compiler.
8880
8881 @item -specs=@var{file}
8882 @opindex specs
8883 Process @var{file} after the compiler reads in the standard @file{specs}
8884 file, in order to override the defaults that the @file{gcc} driver
8885 program uses when determining what switches to pass to @file{cc1},
8886 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
8887 @option{-specs=@var{file}} can be specified on the command line, and they
8888 are processed in order, from left to right.
8889
8890 @item --sysroot=@var{dir}
8891 @opindex sysroot
8892 Use @var{dir} as the logical root directory for headers and libraries.
8893 For example, if the compiler would normally search for headers in
8894 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
8895 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
8896
8897 If you use both this option and the @option{-isysroot} option, then
8898 the @option{--sysroot} option will apply to libraries, but the
8899 @option{-isysroot} option will apply to header files.
8900
8901 The GNU linker (beginning with version 2.16) has the necessary support
8902 for this option.  If your linker does not support this option, the
8903 header file aspect of @option{--sysroot} will still work, but the
8904 library aspect will not.
8905
8906 @item -I-
8907 @opindex I-
8908 This option has been deprecated.  Please use @option{-iquote} instead for
8909 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
8910 Any directories you specify with @option{-I} options before the @option{-I-}
8911 option are searched only for the case of @samp{#include "@var{file}"};
8912 they are not searched for @samp{#include <@var{file}>}.
8913
8914 If additional directories are specified with @option{-I} options after
8915 the @option{-I-}, these directories are searched for all @samp{#include}
8916 directives.  (Ordinarily @emph{all} @option{-I} directories are used
8917 this way.)
8918
8919 In addition, the @option{-I-} option inhibits the use of the current
8920 directory (where the current input file came from) as the first search
8921 directory for @samp{#include "@var{file}"}.  There is no way to
8922 override this effect of @option{-I-}.  With @option{-I.} you can specify
8923 searching the directory which was current when the compiler was
8924 invoked.  That is not exactly the same as what the preprocessor does
8925 by default, but it is often satisfactory.
8926
8927 @option{-I-} does not inhibit the use of the standard system directories
8928 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
8929 independent.
8930 @end table
8931
8932 @c man end
8933
8934 @node Spec Files
8935 @section Specifying subprocesses and the switches to pass to them
8936 @cindex Spec Files
8937
8938 @command{gcc} is a driver program.  It performs its job by invoking a
8939 sequence of other programs to do the work of compiling, assembling and
8940 linking.  GCC interprets its command-line parameters and uses these to
8941 deduce which programs it should invoke, and which command-line options
8942 it ought to place on their command lines.  This behavior is controlled
8943 by @dfn{spec strings}.  In most cases there is one spec string for each
8944 program that GCC can invoke, but a few programs have multiple spec
8945 strings to control their behavior.  The spec strings built into GCC can
8946 be overridden by using the @option{-specs=} command-line switch to specify
8947 a spec file.
8948
8949 @dfn{Spec files} are plaintext files that are used to construct spec
8950 strings.  They consist of a sequence of directives separated by blank
8951 lines.  The type of directive is determined by the first non-whitespace
8952 character on the line and it can be one of the following:
8953
8954 @table @code
8955 @item %@var{command}
8956 Issues a @var{command} to the spec file processor.  The commands that can
8957 appear here are:
8958
8959 @table @code
8960 @item %include <@var{file}>
8961 @cindex %include
8962 Search for @var{file} and insert its text at the current point in the
8963 specs file.
8964
8965 @item %include_noerr <@var{file}>
8966 @cindex %include_noerr
8967 Just like @samp{%include}, but do not generate an error message if the include
8968 file cannot be found.
8969
8970 @item %rename @var{old_name} @var{new_name}
8971 @cindex %rename
8972 Rename the spec string @var{old_name} to @var{new_name}.
8973
8974 @end table
8975
8976 @item *[@var{spec_name}]:
8977 This tells the compiler to create, override or delete the named spec
8978 string.  All lines after this directive up to the next directive or
8979 blank line are considered to be the text for the spec string.  If this
8980 results in an empty string then the spec will be deleted.  (Or, if the
8981 spec did not exist, then nothing will happened.)  Otherwise, if the spec
8982 does not currently exist a new spec will be created.  If the spec does
8983 exist then its contents will be overridden by the text of this
8984 directive, unless the first character of that text is the @samp{+}
8985 character, in which case the text will be appended to the spec.
8986
8987 @item [@var{suffix}]:
8988 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
8989 and up to the next directive or blank line are considered to make up the
8990 spec string for the indicated suffix.  When the compiler encounters an
8991 input file with the named suffix, it will processes the spec string in
8992 order to work out how to compile that file.  For example:
8993
8994 @smallexample
8995 .ZZ:
8996 z-compile -input %i
8997 @end smallexample
8998
8999 This says that any input file whose name ends in @samp{.ZZ} should be
9000 passed to the program @samp{z-compile}, which should be invoked with the
9001 command-line switch @option{-input} and with the result of performing the
9002 @samp{%i} substitution.  (See below.)
9003
9004 As an alternative to providing a spec string, the text that follows a
9005 suffix directive can be one of the following:
9006
9007 @table @code
9008 @item @@@var{language}
9009 This says that the suffix is an alias for a known @var{language}.  This is
9010 similar to using the @option{-x} command-line switch to GCC to specify a
9011 language explicitly.  For example:
9012
9013 @smallexample
9014 .ZZ:
9015 @@c++
9016 @end smallexample
9017
9018 Says that .ZZ files are, in fact, C++ source files.
9019
9020 @item #@var{name}
9021 This causes an error messages saying:
9022
9023 @smallexample
9024 @var{name} compiler not installed on this system.
9025 @end smallexample
9026 @end table
9027
9028 GCC already has an extensive list of suffixes built into it.
9029 This directive will add an entry to the end of the list of suffixes, but
9030 since the list is searched from the end backwards, it is effectively
9031 possible to override earlier entries using this technique.
9032
9033 @end table
9034
9035 GCC has the following spec strings built into it.  Spec files can
9036 override these strings or create their own.  Note that individual
9037 targets can also add their own spec strings to this list.
9038
9039 @smallexample
9040 asm          Options to pass to the assembler
9041 asm_final    Options to pass to the assembler post-processor
9042 cpp          Options to pass to the C preprocessor
9043 cc1          Options to pass to the C compiler
9044 cc1plus      Options to pass to the C++ compiler
9045 endfile      Object files to include at the end of the link
9046 link         Options to pass to the linker
9047 lib          Libraries to include on the command line to the linker
9048 libgcc       Decides which GCC support library to pass to the linker
9049 linker       Sets the name of the linker
9050 predefines   Defines to be passed to the C preprocessor
9051 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9052              by default
9053 startfile    Object files to include at the start of the link
9054 @end smallexample
9055
9056 Here is a small example of a spec file:
9057
9058 @smallexample
9059 %rename lib                 old_lib
9060
9061 *lib:
9062 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9063 @end smallexample
9064
9065 This example renames the spec called @samp{lib} to @samp{old_lib} and
9066 then overrides the previous definition of @samp{lib} with a new one.
9067 The new definition adds in some extra command-line options before
9068 including the text of the old definition.
9069
9070 @dfn{Spec strings} are a list of command-line options to be passed to their
9071 corresponding program.  In addition, the spec strings can contain
9072 @samp{%}-prefixed sequences to substitute variable text or to
9073 conditionally insert text into the command line.  Using these constructs
9074 it is possible to generate quite complex command lines.
9075
9076 Here is a table of all defined @samp{%}-sequences for spec
9077 strings.  Note that spaces are not generated automatically around the
9078 results of expanding these sequences.  Therefore you can concatenate them
9079 together or combine them with constant text in a single argument.
9080
9081 @table @code
9082 @item %%
9083 Substitute one @samp{%} into the program name or argument.
9084
9085 @item %i
9086 Substitute the name of the input file being processed.
9087
9088 @item %b
9089 Substitute the basename of the input file being processed.
9090 This is the substring up to (and not including) the last period
9091 and not including the directory.
9092
9093 @item %B
9094 This is the same as @samp{%b}, but include the file suffix (text after
9095 the last period).
9096
9097 @item %d
9098 Marks the argument containing or following the @samp{%d} as a
9099 temporary file name, so that that file will be deleted if GCC exits
9100 successfully.  Unlike @samp{%g}, this contributes no text to the
9101 argument.
9102
9103 @item %g@var{suffix}
9104 Substitute a file name that has suffix @var{suffix} and is chosen
9105 once per compilation, and mark the argument in the same way as
9106 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9107 name is now chosen in a way that is hard to predict even when previously
9108 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9109 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9110 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9111 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9112 was simply substituted with a file name chosen once per compilation,
9113 without regard to any appended suffix (which was therefore treated
9114 just like ordinary text), making such attacks more likely to succeed.
9115
9116 @item %u@var{suffix}
9117 Like @samp{%g}, but generates a new temporary file name even if
9118 @samp{%u@var{suffix}} was already seen.
9119
9120 @item %U@var{suffix}
9121 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9122 new one if there is no such last file name.  In the absence of any
9123 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9124 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9125 would involve the generation of two distinct file names, one
9126 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9127 simply substituted with a file name chosen for the previous @samp{%u},
9128 without regard to any appended suffix.
9129
9130 @item %j@var{suffix}
9131 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9132 writable, and if save-temps is off; otherwise, substitute the name
9133 of a temporary file, just like @samp{%u}.  This temporary file is not
9134 meant for communication between processes, but rather as a junk
9135 disposal mechanism.
9136
9137 @item %|@var{suffix}
9138 @itemx %m@var{suffix}
9139 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9140 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9141 all.  These are the two most common ways to instruct a program that it
9142 should read from standard input or write to standard output.  If you
9143 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9144 construct: see for example @file{f/lang-specs.h}.
9145
9146 @item %.@var{SUFFIX}
9147 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9148 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9149 terminated by the next space or %.
9150
9151 @item %w
9152 Marks the argument containing or following the @samp{%w} as the
9153 designated output file of this compilation.  This puts the argument
9154 into the sequence of arguments that @samp{%o} will substitute later.
9155
9156 @item %o
9157 Substitutes the names of all the output files, with spaces
9158 automatically placed around them.  You should write spaces
9159 around the @samp{%o} as well or the results are undefined.
9160 @samp{%o} is for use in the specs for running the linker.
9161 Input files whose names have no recognized suffix are not compiled
9162 at all, but they are included among the output files, so they will
9163 be linked.
9164
9165 @item %O
9166 Substitutes the suffix for object files.  Note that this is
9167 handled specially when it immediately follows @samp{%g, %u, or %U},
9168 because of the need for those to form complete file names.  The
9169 handling is such that @samp{%O} is treated exactly as if it had already
9170 been substituted, except that @samp{%g, %u, and %U} do not currently
9171 support additional @var{suffix} characters following @samp{%O} as they would
9172 following, for example, @samp{.o}.
9173
9174 @item %p
9175 Substitutes the standard macro predefinitions for the
9176 current target machine.  Use this when running @code{cpp}.
9177
9178 @item %P
9179 Like @samp{%p}, but puts @samp{__} before and after the name of each
9180 predefined macro, except for macros that start with @samp{__} or with
9181 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9182 C@.
9183
9184 @item %I
9185 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9186 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9187 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9188 and @option{-imultilib} as necessary.
9189
9190 @item %s
9191 Current argument is the name of a library or startup file of some sort.
9192 Search for that file in a standard list of directories and substitute
9193 the full name found.  The current working directory is included in the
9194 list of directories scanned.
9195
9196 @item %T
9197 Current argument is the name of a linker script.  Search for that file
9198 in the current list of directories to scan for libraries. If the file
9199 is located insert a @option{--script} option into the command line
9200 followed by the full path name found.  If the file is not found then
9201 generate an error message.  Note: the current working directory is not
9202 searched.
9203
9204 @item %e@var{str}
9205 Print @var{str} as an error message.  @var{str} is terminated by a newline.
9206 Use this when inconsistent options are detected.
9207
9208 @item %(@var{name})
9209 Substitute the contents of spec string @var{name} at this point.
9210
9211 @item %[@var{name}]
9212 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
9213
9214 @item %x@{@var{option}@}
9215 Accumulate an option for @samp{%X}.
9216
9217 @item %X
9218 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9219 spec string.
9220
9221 @item %Y
9222 Output the accumulated assembler options specified by @option{-Wa}.
9223
9224 @item %Z
9225 Output the accumulated preprocessor options specified by @option{-Wp}.
9226
9227 @item %a
9228 Process the @code{asm} spec.  This is used to compute the
9229 switches to be passed to the assembler.
9230
9231 @item %A
9232 Process the @code{asm_final} spec.  This is a spec string for
9233 passing switches to an assembler post-processor, if such a program is
9234 needed.
9235
9236 @item %l
9237 Process the @code{link} spec.  This is the spec for computing the
9238 command line passed to the linker.  Typically it will make use of the
9239 @samp{%L %G %S %D and %E} sequences.
9240
9241 @item %D
9242 Dump out a @option{-L} option for each directory that GCC believes might
9243 contain startup files.  If the target supports multilibs then the
9244 current multilib directory will be prepended to each of these paths.
9245
9246 @item %L
9247 Process the @code{lib} spec.  This is a spec string for deciding which
9248 libraries should be included on the command line to the linker.
9249
9250 @item %G
9251 Process the @code{libgcc} spec.  This is a spec string for deciding
9252 which GCC support library should be included on the command line to the linker.
9253
9254 @item %S
9255 Process the @code{startfile} spec.  This is a spec for deciding which
9256 object files should be the first ones passed to the linker.  Typically
9257 this might be a file named @file{crt0.o}.
9258
9259 @item %E
9260 Process the @code{endfile} spec.  This is a spec string that specifies
9261 the last object files that will be passed to the linker.
9262
9263 @item %C
9264 Process the @code{cpp} spec.  This is used to construct the arguments
9265 to be passed to the C preprocessor.
9266
9267 @item %1
9268 Process the @code{cc1} spec.  This is used to construct the options to be
9269 passed to the actual C compiler (@samp{cc1}).
9270
9271 @item %2
9272 Process the @code{cc1plus} spec.  This is used to construct the options to be
9273 passed to the actual C++ compiler (@samp{cc1plus}).
9274
9275 @item %*
9276 Substitute the variable part of a matched option.  See below.
9277 Note that each comma in the substituted string is replaced by
9278 a single space.
9279
9280 @item %<@code{S}
9281 Remove all occurrences of @code{-S} from the command line.  Note---this
9282 command is position dependent.  @samp{%} commands in the spec string
9283 before this one will see @code{-S}, @samp{%} commands in the spec string
9284 after this one will not.
9285
9286 @item %:@var{function}(@var{args})
9287 Call the named function @var{function}, passing it @var{args}.
9288 @var{args} is first processed as a nested spec string, then split
9289 into an argument vector in the usual fashion.  The function returns
9290 a string which is processed as if it had appeared literally as part
9291 of the current spec.
9292
9293 The following built-in spec functions are provided:
9294
9295 @table @code
9296 @item @code{getenv}
9297 The @code{getenv} spec function takes two arguments: an environment
9298 variable name and a string.  If the environment variable is not
9299 defined, a fatal error is issued.  Otherwise, the return value is the
9300 value of the environment variable concatenated with the string.  For
9301 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9302
9303 @smallexample
9304 %:getenv(TOPDIR /include)
9305 @end smallexample
9306
9307 expands to @file{/path/to/top/include}.
9308
9309 @item @code{if-exists}
9310 The @code{if-exists} spec function takes one argument, an absolute
9311 pathname to a file.  If the file exists, @code{if-exists} returns the
9312 pathname.  Here is a small example of its usage:
9313
9314 @smallexample
9315 *startfile:
9316 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9317 @end smallexample
9318
9319 @item @code{if-exists-else}
9320 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9321 spec function, except that it takes two arguments.  The first argument is
9322 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
9323 returns the pathname.  If it does not exist, it returns the second argument.
9324 This way, @code{if-exists-else} can be used to select one file or another,
9325 based on the existence of the first.  Here is a small example of its usage:
9326
9327 @smallexample
9328 *startfile:
9329 crt0%O%s %:if-exists(crti%O%s) \
9330 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9331 @end smallexample
9332
9333 @item @code{replace-outfile}
9334 The @code{replace-outfile} spec function takes two arguments.  It looks for the
9335 first argument in the outfiles array and replaces it with the second argument.  Here
9336 is a small example of its usage:
9337
9338 @smallexample
9339 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9340 @end smallexample
9341
9342 @item @code{print-asm-header}
9343 The @code{print-asm-header} function takes no arguments and simply
9344 prints a banner like:
9345
9346 @smallexample
9347 Assembler options
9348 =================
9349
9350 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9351 @end smallexample
9352
9353 It is used to separate compiler options from assembler options
9354 in the @option{--target-help} output.
9355 @end table
9356
9357 @item %@{@code{S}@}
9358 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9359 If that switch was not specified, this substitutes nothing.  Note that
9360 the leading dash is omitted when specifying this option, and it is
9361 automatically inserted if the substitution is performed.  Thus the spec
9362 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9363 and would output the command line option @option{-foo}.
9364
9365 @item %W@{@code{S}@}
9366 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9367 deleted on failure.
9368
9369 @item %@{@code{S}*@}
9370 Substitutes all the switches specified to GCC whose names start
9371 with @code{-S}, but which also take an argument.  This is used for
9372 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9373 GCC considers @option{-o foo} as being
9374 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
9375 text, including the space.  Thus two arguments would be generated.
9376
9377 @item %@{@code{S}*&@code{T}*@}
9378 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9379 (the order of @code{S} and @code{T} in the spec is not significant).
9380 There can be any number of ampersand-separated variables; for each the
9381 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
9382
9383 @item %@{@code{S}:@code{X}@}
9384 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9385
9386 @item %@{!@code{S}:@code{X}@}
9387 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9388
9389 @item %@{@code{S}*:@code{X}@}
9390 Substitutes @code{X} if one or more switches whose names start with
9391 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
9392 once, no matter how many such switches appeared.  However, if @code{%*}
9393 appears somewhere in @code{X}, then @code{X} will be substituted once
9394 for each matching switch, with the @code{%*} replaced by the part of
9395 that switch that matched the @code{*}.
9396
9397 @item %@{.@code{S}:@code{X}@}
9398 Substitutes @code{X}, if processing a file with suffix @code{S}.
9399
9400 @item %@{!.@code{S}:@code{X}@}
9401 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9402
9403 @item %@{,@code{S}:@code{X}@}
9404 Substitutes @code{X}, if processing a file for language @code{S}.
9405
9406 @item %@{!,@code{S}:@code{X}@}
9407 Substitutes @code{X}, if not processing a file for language @code{S}.
9408
9409 @item %@{@code{S}|@code{P}:@code{X}@}
9410 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9411 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9412 @code{*} sequences as well, although they have a stronger binding than
9413 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9414 alternatives must be starred, and only the first matching alternative
9415 is substituted.
9416
9417 For example, a spec string like this:
9418
9419 @smallexample
9420 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9421 @end smallexample
9422
9423 will output the following command-line options from the following input
9424 command-line options:
9425
9426 @smallexample
9427 fred.c        -foo -baz
9428 jim.d         -bar -boggle
9429 -d fred.c     -foo -baz -boggle
9430 -d jim.d      -bar -baz -boggle
9431 @end smallexample
9432
9433 @item %@{S:X; T:Y; :D@}
9434
9435 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9436 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
9437 be as many clauses as you need.  This may be combined with @code{.},
9438 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9439
9440
9441 @end table
9442
9443 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9444 construct may contain other nested @samp{%} constructs or spaces, or
9445 even newlines.  They are processed as usual, as described above.
9446 Trailing white space in @code{X} is ignored.  White space may also
9447 appear anywhere on the left side of the colon in these constructs,
9448 except between @code{.} or @code{*} and the corresponding word.
9449
9450 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9451 handled specifically in these constructs.  If another value of
9452 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9453 @option{-W} switch is found later in the command line, the earlier
9454 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9455 just one letter, which passes all matching options.
9456
9457 The character @samp{|} at the beginning of the predicate text is used to
9458 indicate that a command should be piped to the following command, but
9459 only if @option{-pipe} is specified.
9460
9461 It is built into GCC which switches take arguments and which do not.
9462 (You might think it would be useful to generalize this to allow each
9463 compiler's spec to say which switches take arguments.  But this cannot
9464 be done in a consistent fashion.  GCC cannot even decide which input
9465 files have been specified without knowing which switches take arguments,
9466 and it must know which input files to compile in order to tell which
9467 compilers to run).
9468
9469 GCC also knows implicitly that arguments starting in @option{-l} are to be
9470 treated as compiler output files, and passed to the linker in their
9471 proper position among the other output files.
9472
9473 @c man begin OPTIONS
9474
9475 @node Target Options
9476 @section Specifying Target Machine and Compiler Version
9477 @cindex target options
9478 @cindex cross compiling
9479 @cindex specifying machine version
9480 @cindex specifying compiler version and target machine
9481 @cindex compiler version, specifying
9482 @cindex target machine, specifying
9483
9484 The usual way to run GCC is to run the executable called @file{gcc}, or
9485 @file{<machine>-gcc} when cross-compiling, or
9486 @file{<machine>-gcc-<version>} to run a version other than the one that
9487 was installed last.  Sometimes this is inconvenient, so GCC provides
9488 options that will switch to another cross-compiler or version.
9489
9490 @table @gcctabopt
9491 @item -b @var{machine}
9492 @opindex b
9493 The argument @var{machine} specifies the target machine for compilation.
9494
9495 The value to use for @var{machine} is the same as was specified as the
9496 machine type when configuring GCC as a cross-compiler.  For
9497 example, if a cross-compiler was configured with @samp{configure
9498 arm-elf}, meaning to compile for an arm processor with elf binaries,
9499 then you would specify @option{-b arm-elf} to run that cross compiler.
9500 Because there are other options beginning with @option{-b}, the
9501 configuration must contain a hyphen, or @option{-b} alone should be one
9502 argument followed by the configuration in the next argument.
9503
9504 @item -V @var{version}
9505 @opindex V
9506 The argument @var{version} specifies which version of GCC to run.
9507 This is useful when multiple versions are installed.  For example,
9508 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
9509 @end table
9510
9511 The @option{-V} and @option{-b} options work by running the
9512 @file{<machine>-gcc-<version>} executable, so there's no real reason to
9513 use them if you can just run that directly.
9514
9515 @node Submodel Options
9516 @section Hardware Models and Configurations
9517 @cindex submodel options
9518 @cindex specifying hardware config
9519 @cindex hardware models and configurations, specifying
9520 @cindex machine dependent options
9521
9522 Earlier we discussed the standard option @option{-b} which chooses among
9523 different installed compilers for completely different target
9524 machines, such as VAX vs.@: 68000 vs.@: 80386.
9525
9526 In addition, each of these target machine types can have its own
9527 special options, starting with @samp{-m}, to choose among various
9528 hardware models or configurations---for example, 68010 vs 68020,
9529 floating coprocessor or none.  A single installed version of the
9530 compiler can compile for any model or configuration, according to the
9531 options specified.
9532
9533 Some configurations of the compiler also support additional special
9534 options, usually for compatibility with other compilers on the same
9535 platform.
9536
9537 @c This list is ordered alphanumerically by subsection name.
9538 @c It should be the same order and spelling as these options are listed
9539 @c in Machine Dependent Options
9540
9541 @menu
9542 * ARC Options::
9543 * ARM Options::
9544 * AVR Options::
9545 * Blackfin Options::
9546 * CRIS Options::
9547 * CRX Options::
9548 * Darwin Options::
9549 * DEC Alpha Options::
9550 * DEC Alpha/VMS Options::
9551 * FR30 Options::
9552 * FRV Options::
9553 * GNU/Linux Options::
9554 * H8/300 Options::
9555 * HPPA Options::
9556 * i386 and x86-64 Options::
9557 * i386 and x86-64 Windows Options::
9558 * IA-64 Options::
9559 * IA-64/VMS Options::
9560 * LM32 Options::
9561 * M32C Options::
9562 * M32R/D Options::
9563 * M680x0 Options::
9564 * M68hc1x Options::
9565 * MCore Options::
9566 * MeP Options::
9567 * MIPS Options::
9568 * MMIX Options::
9569 * MN10300 Options::
9570 * PDP-11 Options::
9571 * picoChip Options::
9572 * PowerPC Options::
9573 * RS/6000 and PowerPC Options::
9574 * RX Options::
9575 * S/390 and zSeries Options::
9576 * Score Options::
9577 * SH Options::
9578 * SPARC Options::
9579 * SPU Options::
9580 * System V Options::
9581 * V850 Options::
9582 * VAX Options::
9583 * VxWorks Options::
9584 * x86-64 Options::
9585 * Xstormy16 Options::
9586 * Xtensa Options::
9587 * zSeries Options::
9588 @end menu
9589
9590 @node ARC Options
9591 @subsection ARC Options
9592 @cindex ARC Options
9593
9594 These options are defined for ARC implementations:
9595
9596 @table @gcctabopt
9597 @item -EL
9598 @opindex EL
9599 Compile code for little endian mode.  This is the default.
9600
9601 @item -EB
9602 @opindex EB
9603 Compile code for big endian mode.
9604
9605 @item -mmangle-cpu
9606 @opindex mmangle-cpu
9607 Prepend the name of the cpu to all public symbol names.
9608 In multiple-processor systems, there are many ARC variants with different
9609 instruction and register set characteristics.  This flag prevents code
9610 compiled for one cpu to be linked with code compiled for another.
9611 No facility exists for handling variants that are ``almost identical''.
9612 This is an all or nothing option.
9613
9614 @item -mcpu=@var{cpu}
9615 @opindex mcpu
9616 Compile code for ARC variant @var{cpu}.
9617 Which variants are supported depend on the configuration.
9618 All variants support @option{-mcpu=base}, this is the default.
9619
9620 @item -mtext=@var{text-section}
9621 @itemx -mdata=@var{data-section}
9622 @itemx -mrodata=@var{readonly-data-section}
9623 @opindex mtext
9624 @opindex mdata
9625 @opindex mrodata
9626 Put functions, data, and readonly data in @var{text-section},
9627 @var{data-section}, and @var{readonly-data-section} respectively
9628 by default.  This can be overridden with the @code{section} attribute.
9629 @xref{Variable Attributes}.
9630
9631 @item -mfix-cortex-m3-ldrd
9632 @opindex mfix-cortex-m3-ldrd
9633 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
9634 with overlapping destination and base registers are used.  This option avoids
9635 generating these instructions.  This option is enabled by default when
9636 @option{-mcpu=cortex-m3} is specified.
9637
9638 @end table
9639
9640 @node ARM Options
9641 @subsection ARM Options
9642 @cindex ARM options
9643
9644 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
9645 architectures:
9646
9647 @table @gcctabopt
9648 @item -mabi=@var{name}
9649 @opindex mabi
9650 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
9651 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
9652
9653 @item -mapcs-frame
9654 @opindex mapcs-frame
9655 Generate a stack frame that is compliant with the ARM Procedure Call
9656 Standard for all functions, even if this is not strictly necessary for
9657 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
9658 with this option will cause the stack frames not to be generated for
9659 leaf functions.  The default is @option{-mno-apcs-frame}.
9660
9661 @item -mapcs
9662 @opindex mapcs
9663 This is a synonym for @option{-mapcs-frame}.
9664
9665 @ignore
9666 @c not currently implemented
9667 @item -mapcs-stack-check
9668 @opindex mapcs-stack-check
9669 Generate code to check the amount of stack space available upon entry to
9670 every function (that actually uses some stack space).  If there is
9671 insufficient space available then either the function
9672 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
9673 called, depending upon the amount of stack space required.  The run time
9674 system is required to provide these functions.  The default is
9675 @option{-mno-apcs-stack-check}, since this produces smaller code.
9676
9677 @c not currently implemented
9678 @item -mapcs-float
9679 @opindex mapcs-float
9680 Pass floating point arguments using the float point registers.  This is
9681 one of the variants of the APCS@.  This option is recommended if the
9682 target hardware has a floating point unit or if a lot of floating point
9683 arithmetic is going to be performed by the code.  The default is
9684 @option{-mno-apcs-float}, since integer only code is slightly increased in
9685 size if @option{-mapcs-float} is used.
9686
9687 @c not currently implemented
9688 @item -mapcs-reentrant
9689 @opindex mapcs-reentrant
9690 Generate reentrant, position independent code.  The default is
9691 @option{-mno-apcs-reentrant}.
9692 @end ignore
9693
9694 @item -mthumb-interwork
9695 @opindex mthumb-interwork
9696 Generate code which supports calling between the ARM and Thumb
9697 instruction sets.  Without this option the two instruction sets cannot
9698 be reliably used inside one program.  The default is
9699 @option{-mno-thumb-interwork}, since slightly larger code is generated
9700 when @option{-mthumb-interwork} is specified.
9701
9702 @item -mno-sched-prolog
9703 @opindex mno-sched-prolog
9704 Prevent the reordering of instructions in the function prolog, or the
9705 merging of those instruction with the instructions in the function's
9706 body.  This means that all functions will start with a recognizable set
9707 of instructions (or in fact one of a choice from a small set of
9708 different function prologues), and this information can be used to
9709 locate the start if functions inside an executable piece of code.  The
9710 default is @option{-msched-prolog}.
9711
9712 @item -mfloat-abi=@var{name}
9713 @opindex mfloat-abi
9714 Specifies which floating-point ABI to use.  Permissible values
9715 are: @samp{soft}, @samp{softfp} and @samp{hard}.
9716
9717 Specifying @samp{soft} causes GCC to generate output containing
9718 library calls for floating-point operations.
9719 @samp{softfp} allows the generation of code using hardware floating-point
9720 instructions, but still uses the soft-float calling conventions.
9721 @samp{hard} allows generation of floating-point instructions
9722 and uses FPU-specific calling conventions.
9723
9724 The default depends on the specific target configuration.  Note that
9725 the hard-float and soft-float ABIs are not link-compatible; you must
9726 compile your entire program with the same ABI, and link with a
9727 compatible set of libraries.
9728
9729 @item -mhard-float
9730 @opindex mhard-float
9731 Equivalent to @option{-mfloat-abi=hard}.
9732
9733 @item -msoft-float
9734 @opindex msoft-float
9735 Equivalent to @option{-mfloat-abi=soft}.
9736
9737 @item -mlittle-endian
9738 @opindex mlittle-endian
9739 Generate code for a processor running in little-endian mode.  This is
9740 the default for all standard configurations.
9741
9742 @item -mbig-endian
9743 @opindex mbig-endian
9744 Generate code for a processor running in big-endian mode; the default is
9745 to compile code for a little-endian processor.
9746
9747 @item -mwords-little-endian
9748 @opindex mwords-little-endian
9749 This option only applies when generating code for big-endian processors.
9750 Generate code for a little-endian word order but a big-endian byte
9751 order.  That is, a byte order of the form @samp{32107654}.  Note: this
9752 option should only be used if you require compatibility with code for
9753 big-endian ARM processors generated by versions of the compiler prior to
9754 2.8.
9755
9756 @item -mcpu=@var{name}
9757 @opindex mcpu
9758 This specifies the name of the target ARM processor.  GCC uses this name
9759 to determine what kind of instructions it can emit when generating
9760 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
9761 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
9762 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
9763 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
9764 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
9765 @samp{arm720},
9766 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
9767 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
9768 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
9769 @samp{strongarm1110},
9770 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
9771 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
9772 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
9773 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
9774 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
9775 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
9776 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
9777 @samp{cortex-a5}, @samp{cortex-a8}, @samp{cortex-a9},
9778 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m3},
9779 @samp{cortex-m1},
9780 @samp{cortex-m0},
9781 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9782
9783 @item -mtune=@var{name}
9784 @opindex mtune
9785 This option is very similar to the @option{-mcpu=} option, except that
9786 instead of specifying the actual target processor type, and hence
9787 restricting which instructions can be used, it specifies that GCC should
9788 tune the performance of the code as if the target were of the type
9789 specified in this option, but still choosing the instructions that it
9790 will generate based on the cpu specified by a @option{-mcpu=} option.
9791 For some ARM implementations better performance can be obtained by using
9792 this option.
9793
9794 @item -march=@var{name}
9795 @opindex march
9796 This specifies the name of the target ARM architecture.  GCC uses this
9797 name to determine what kind of instructions it can emit when generating
9798 assembly code.  This option can be used in conjunction with or instead
9799 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
9800 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
9801 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
9802 @samp{armv6}, @samp{armv6j},
9803 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
9804 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
9805 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9806
9807 @item -mfpu=@var{name}
9808 @itemx -mfpe=@var{number}
9809 @itemx -mfp=@var{number}
9810 @opindex mfpu
9811 @opindex mfpe
9812 @opindex mfp
9813 This specifies what floating point hardware (or hardware emulation) is
9814 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
9815 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
9816 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
9817 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
9818 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
9819 @option{-mfp} and @option{-mfpe} are synonyms for
9820 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
9821 of GCC@.
9822
9823 If @option{-msoft-float} is specified this specifies the format of
9824 floating point values.
9825
9826 @item -mfp16-format=@var{name}
9827 @opindex mfp16-format
9828 Specify the format of the @code{__fp16} half-precision floating-point type.
9829 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
9830 the default is @samp{none}, in which case the @code{__fp16} type is not
9831 defined.  @xref{Half-Precision}, for more information.
9832
9833 @item -mstructure-size-boundary=@var{n}
9834 @opindex mstructure-size-boundary
9835 The size of all structures and unions will be rounded up to a multiple
9836 of the number of bits set by this option.  Permissible values are 8, 32
9837 and 64.  The default value varies for different toolchains.  For the COFF
9838 targeted toolchain the default value is 8.  A value of 64 is only allowed
9839 if the underlying ABI supports it.
9840
9841 Specifying the larger number can produce faster, more efficient code, but
9842 can also increase the size of the program.  Different values are potentially
9843 incompatible.  Code compiled with one value cannot necessarily expect to
9844 work with code or libraries compiled with another value, if they exchange
9845 information using structures or unions.
9846
9847 @item -mabort-on-noreturn
9848 @opindex mabort-on-noreturn
9849 Generate a call to the function @code{abort} at the end of a
9850 @code{noreturn} function.  It will be executed if the function tries to
9851 return.
9852
9853 @item -mlong-calls
9854 @itemx -mno-long-calls
9855 @opindex mlong-calls
9856 @opindex mno-long-calls
9857 Tells the compiler to perform function calls by first loading the
9858 address of the function into a register and then performing a subroutine
9859 call on this register.  This switch is needed if the target function
9860 will lie outside of the 64 megabyte addressing range of the offset based
9861 version of subroutine call instruction.
9862
9863 Even if this switch is enabled, not all function calls will be turned
9864 into long calls.  The heuristic is that static functions, functions
9865 which have the @samp{short-call} attribute, functions that are inside
9866 the scope of a @samp{#pragma no_long_calls} directive and functions whose
9867 definitions have already been compiled within the current compilation
9868 unit, will not be turned into long calls.  The exception to this rule is
9869 that weak function definitions, functions with the @samp{long-call}
9870 attribute or the @samp{section} attribute, and functions that are within
9871 the scope of a @samp{#pragma long_calls} directive, will always be
9872 turned into long calls.
9873
9874 This feature is not enabled by default.  Specifying
9875 @option{-mno-long-calls} will restore the default behavior, as will
9876 placing the function calls within the scope of a @samp{#pragma
9877 long_calls_off} directive.  Note these switches have no effect on how
9878 the compiler generates code to handle function calls via function
9879 pointers.
9880
9881 @item -msingle-pic-base
9882 @opindex msingle-pic-base
9883 Treat the register used for PIC addressing as read-only, rather than
9884 loading it in the prologue for each function.  The run-time system is
9885 responsible for initializing this register with an appropriate value
9886 before execution begins.
9887
9888 @item -mpic-register=@var{reg}
9889 @opindex mpic-register
9890 Specify the register to be used for PIC addressing.  The default is R10
9891 unless stack-checking is enabled, when R9 is used.
9892
9893 @item -mcirrus-fix-invalid-insns
9894 @opindex mcirrus-fix-invalid-insns
9895 @opindex mno-cirrus-fix-invalid-insns
9896 Insert NOPs into the instruction stream to in order to work around
9897 problems with invalid Maverick instruction combinations.  This option
9898 is only valid if the @option{-mcpu=ep9312} option has been used to
9899 enable generation of instructions for the Cirrus Maverick floating
9900 point co-processor.  This option is not enabled by default, since the
9901 problem is only present in older Maverick implementations.  The default
9902 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
9903 switch.
9904
9905 @item -mpoke-function-name
9906 @opindex mpoke-function-name
9907 Write the name of each function into the text section, directly
9908 preceding the function prologue.  The generated code is similar to this:
9909
9910 @smallexample
9911      t0
9912          .ascii "arm_poke_function_name", 0
9913          .align
9914      t1
9915          .word 0xff000000 + (t1 - t0)
9916      arm_poke_function_name
9917          mov     ip, sp
9918          stmfd   sp!, @{fp, ip, lr, pc@}
9919          sub     fp, ip, #4
9920 @end smallexample
9921
9922 When performing a stack backtrace, code can inspect the value of
9923 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
9924 location @code{pc - 12} and the top 8 bits are set, then we know that
9925 there is a function name embedded immediately preceding this location
9926 and has length @code{((pc[-3]) & 0xff000000)}.
9927
9928 @item -mthumb
9929 @opindex mthumb
9930 Generate code for the Thumb instruction set.  The default is to
9931 use the 32-bit ARM instruction set.
9932 This option automatically enables either 16-bit Thumb-1 or
9933 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
9934 and @option{-march=@var{name}} options.  This option is not passed to the
9935 assembler. If you want to force assembler files to be interpreted as Thumb code,
9936 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
9937 option directly to the assembler by prefixing it with @option{-Wa}.
9938
9939 @item -mtpcs-frame
9940 @opindex mtpcs-frame
9941 Generate a stack frame that is compliant with the Thumb Procedure Call
9942 Standard for all non-leaf functions.  (A leaf function is one that does
9943 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
9944
9945 @item -mtpcs-leaf-frame
9946 @opindex mtpcs-leaf-frame
9947 Generate a stack frame that is compliant with the Thumb Procedure Call
9948 Standard for all leaf functions.  (A leaf function is one that does
9949 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
9950
9951 @item -mcallee-super-interworking
9952 @opindex mcallee-super-interworking
9953 Gives all externally visible functions in the file being compiled an ARM
9954 instruction set header which switches to Thumb mode before executing the
9955 rest of the function.  This allows these functions to be called from
9956 non-interworking code.  This option is not valid in AAPCS configurations
9957 because interworking is enabled by default.
9958
9959 @item -mcaller-super-interworking
9960 @opindex mcaller-super-interworking
9961 Allows calls via function pointers (including virtual functions) to
9962 execute correctly regardless of whether the target code has been
9963 compiled for interworking or not.  There is a small overhead in the cost
9964 of executing a function pointer if this option is enabled.  This option
9965 is not valid in AAPCS configurations because interworking is enabled
9966 by default.
9967
9968 @item -mtp=@var{name}
9969 @opindex mtp
9970 Specify the access model for the thread local storage pointer.  The valid
9971 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
9972 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
9973 (supported in the arm6k architecture), and @option{auto}, which uses the
9974 best available method for the selected processor.  The default setting is
9975 @option{auto}.
9976
9977 @item -mword-relocations
9978 @opindex mword-relocations
9979 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
9980 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
9981 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
9982 is specified.
9983
9984 @end table
9985
9986 @node AVR Options
9987 @subsection AVR Options
9988 @cindex AVR Options
9989
9990 These options are defined for AVR implementations:
9991
9992 @table @gcctabopt
9993 @item -mmcu=@var{mcu}
9994 @opindex mmcu
9995 Specify ATMEL AVR instruction set or MCU type.
9996
9997 Instruction set avr1 is for the minimal AVR core, not supported by the C
9998 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
9999 attiny11, attiny12, attiny15, attiny28).
10000
10001 Instruction set avr2 (default) is for the classic AVR core with up to
10002 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10003 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10004 at90c8534, at90s8535).
10005
10006 Instruction set avr3 is for the classic AVR core with up to 128K program
10007 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10008
10009 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10010 memory space (MCU types: atmega8, atmega83, atmega85).
10011
10012 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10013 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10014 atmega64, atmega128, at43usb355, at94k).
10015
10016 @item -mno-interrupts
10017 @opindex mno-interrupts
10018 Generated code is not compatible with hardware interrupts.
10019 Code size will be smaller.
10020
10021 @item -mcall-prologues
10022 @opindex mcall-prologues
10023 Functions prologues/epilogues expanded as call to appropriate
10024 subroutines.  Code size will be smaller.
10025
10026 @item -mtiny-stack
10027 @opindex mtiny-stack
10028 Change only the low 8 bits of the stack pointer.
10029
10030 @item -mint8
10031 @opindex mint8
10032 Assume int to be 8 bit integer.  This affects the sizes of all types: A
10033 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10034 and long long will be 4 bytes.  Please note that this option does not
10035 comply to the C standards, but it will provide you with smaller code
10036 size.
10037 @end table
10038
10039 @node Blackfin Options
10040 @subsection Blackfin Options
10041 @cindex Blackfin Options
10042
10043 @table @gcctabopt
10044 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
10045 @opindex mcpu=
10046 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
10047 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
10048 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
10049 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
10050 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
10051 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
10052 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
10053 @samp{bf561}.
10054 The optional @var{sirevision} specifies the silicon revision of the target
10055 Blackfin processor.  Any workarounds available for the targeted silicon revision
10056 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
10057 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
10058 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
10059 hexadecimal digits representing the major and minor numbers in the silicon
10060 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
10061 is not defined.  If @var{sirevision} is @samp{any}, the
10062 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
10063 If this optional @var{sirevision} is not used, GCC assumes the latest known
10064 silicon revision of the targeted Blackfin processor.
10065
10066 Support for @samp{bf561} is incomplete.  For @samp{bf561},
10067 Only the processor macro is defined.
10068 Without this option, @samp{bf532} is used as the processor by default.
10069 The corresponding predefined processor macros for @var{cpu} is to
10070 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
10071 provided by libgloss to be linked in if @option{-msim} is not given.
10072
10073 @item -msim
10074 @opindex msim
10075 Specifies that the program will be run on the simulator.  This causes
10076 the simulator BSP provided by libgloss to be linked in.  This option
10077 has effect only for @samp{bfin-elf} toolchain.
10078 Certain other options, such as @option{-mid-shared-library} and
10079 @option{-mfdpic}, imply @option{-msim}.
10080
10081 @item -momit-leaf-frame-pointer
10082 @opindex momit-leaf-frame-pointer
10083 Don't keep the frame pointer in a register for leaf functions.  This
10084 avoids the instructions to save, set up and restore frame pointers and
10085 makes an extra register available in leaf functions.  The option
10086 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10087 which might make debugging harder.
10088
10089 @item -mspecld-anomaly
10090 @opindex mspecld-anomaly
10091 When enabled, the compiler will ensure that the generated code does not
10092 contain speculative loads after jump instructions. If this option is used,
10093 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
10094
10095 @item -mno-specld-anomaly
10096 @opindex mno-specld-anomaly
10097 Don't generate extra code to prevent speculative loads from occurring.
10098
10099 @item -mcsync-anomaly
10100 @opindex mcsync-anomaly
10101 When enabled, the compiler will ensure that the generated code does not
10102 contain CSYNC or SSYNC instructions too soon after conditional branches.
10103 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
10104
10105 @item -mno-csync-anomaly
10106 @opindex mno-csync-anomaly
10107 Don't generate extra code to prevent CSYNC or SSYNC instructions from
10108 occurring too soon after a conditional branch.
10109
10110 @item -mlow-64k
10111 @opindex mlow-64k
10112 When enabled, the compiler is free to take advantage of the knowledge that
10113 the entire program fits into the low 64k of memory.
10114
10115 @item -mno-low-64k
10116 @opindex mno-low-64k
10117 Assume that the program is arbitrarily large.  This is the default.
10118
10119 @item -mstack-check-l1
10120 @opindex mstack-check-l1
10121 Do stack checking using information placed into L1 scratchpad memory by the
10122 uClinux kernel.
10123
10124 @item -mid-shared-library
10125 @opindex mid-shared-library
10126 Generate code that supports shared libraries via the library ID method.
10127 This allows for execute in place and shared libraries in an environment
10128 without virtual memory management.  This option implies @option{-fPIC}.
10129 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10130
10131 @item -mno-id-shared-library
10132 @opindex mno-id-shared-library
10133 Generate code that doesn't assume ID based shared libraries are being used.
10134 This is the default.
10135
10136 @item -mleaf-id-shared-library
10137 @opindex mleaf-id-shared-library
10138 Generate code that supports shared libraries via the library ID method,
10139 but assumes that this library or executable won't link against any other
10140 ID shared libraries.  That allows the compiler to use faster code for jumps
10141 and calls.
10142
10143 @item -mno-leaf-id-shared-library
10144 @opindex mno-leaf-id-shared-library
10145 Do not assume that the code being compiled won't link against any ID shared
10146 libraries.  Slower code will be generated for jump and call insns.
10147
10148 @item -mshared-library-id=n
10149 @opindex mshared-library-id
10150 Specified the identification number of the ID based shared library being
10151 compiled.  Specifying a value of 0 will generate more compact code, specifying
10152 other values will force the allocation of that number to the current
10153 library but is no more space or time efficient than omitting this option.
10154
10155 @item -msep-data
10156 @opindex msep-data
10157 Generate code that allows the data segment to be located in a different
10158 area of memory from the text segment.  This allows for execute in place in
10159 an environment without virtual memory management by eliminating relocations
10160 against the text section.
10161
10162 @item -mno-sep-data
10163 @opindex mno-sep-data
10164 Generate code that assumes that the data segment follows the text segment.
10165 This is the default.
10166
10167 @item -mlong-calls
10168 @itemx -mno-long-calls
10169 @opindex mlong-calls
10170 @opindex mno-long-calls
10171 Tells the compiler to perform function calls by first loading the
10172 address of the function into a register and then performing a subroutine
10173 call on this register.  This switch is needed if the target function
10174 will lie outside of the 24 bit addressing range of the offset based
10175 version of subroutine call instruction.
10176
10177 This feature is not enabled by default.  Specifying
10178 @option{-mno-long-calls} will restore the default behavior.  Note these
10179 switches have no effect on how the compiler generates code to handle
10180 function calls via function pointers.
10181
10182 @item -mfast-fp
10183 @opindex mfast-fp
10184 Link with the fast floating-point library. This library relaxes some of
10185 the IEEE floating-point standard's rules for checking inputs against
10186 Not-a-Number (NAN), in the interest of performance.
10187
10188 @item -minline-plt
10189 @opindex minline-plt
10190 Enable inlining of PLT entries in function calls to functions that are
10191 not known to bind locally.  It has no effect without @option{-mfdpic}.
10192
10193 @item -mmulticore
10194 @opindex mmulticore
10195 Build standalone application for multicore Blackfin processor. Proper
10196 start files and link scripts will be used to support multicore.
10197 This option defines @code{__BFIN_MULTICORE}. It can only be used with
10198 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
10199 @option{-mcorea} or @option{-mcoreb}. If it's used without
10200 @option{-mcorea} or @option{-mcoreb}, single application/dual core
10201 programming model is used. In this model, the main function of Core B
10202 should be named as coreb_main. If it's used with @option{-mcorea} or
10203 @option{-mcoreb}, one application per core programming model is used.
10204 If this option is not used, single core application programming
10205 model is used.
10206
10207 @item -mcorea
10208 @opindex mcorea
10209 Build standalone application for Core A of BF561 when using
10210 one application per core programming model. Proper start files
10211 and link scripts will be used to support Core A. This option
10212 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
10213
10214 @item -mcoreb
10215 @opindex mcoreb
10216 Build standalone application for Core B of BF561 when using
10217 one application per core programming model. Proper start files
10218 and link scripts will be used to support Core B. This option
10219 defines @code{__BFIN_COREB}. When this option is used, coreb_main
10220 should be used instead of main. It must be used with
10221 @option{-mmulticore}.
10222
10223 @item -msdram
10224 @opindex msdram
10225 Build standalone application for SDRAM. Proper start files and
10226 link scripts will be used to put the application into SDRAM.
10227 Loader should initialize SDRAM before loading the application
10228 into SDRAM. This option defines @code{__BFIN_SDRAM}.
10229
10230 @item -micplb
10231 @opindex micplb
10232 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
10233 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
10234 are enabled; for standalone applications the default is off.
10235 @end table
10236
10237 @node CRIS Options
10238 @subsection CRIS Options
10239 @cindex CRIS Options
10240
10241 These options are defined specifically for the CRIS ports.
10242
10243 @table @gcctabopt
10244 @item -march=@var{architecture-type}
10245 @itemx -mcpu=@var{architecture-type}
10246 @opindex march
10247 @opindex mcpu
10248 Generate code for the specified architecture.  The choices for
10249 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10250 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
10251 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10252 @samp{v10}.
10253
10254 @item -mtune=@var{architecture-type}
10255 @opindex mtune
10256 Tune to @var{architecture-type} everything applicable about the generated
10257 code, except for the ABI and the set of available instructions.  The
10258 choices for @var{architecture-type} are the same as for
10259 @option{-march=@var{architecture-type}}.
10260
10261 @item -mmax-stack-frame=@var{n}
10262 @opindex mmax-stack-frame
10263 Warn when the stack frame of a function exceeds @var{n} bytes.
10264
10265 @item -metrax4
10266 @itemx -metrax100
10267 @opindex metrax4
10268 @opindex metrax100
10269 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10270 @option{-march=v3} and @option{-march=v8} respectively.
10271
10272 @item -mmul-bug-workaround
10273 @itemx -mno-mul-bug-workaround
10274 @opindex mmul-bug-workaround
10275 @opindex mno-mul-bug-workaround
10276 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10277 models where it applies.  This option is active by default.
10278
10279 @item -mpdebug
10280 @opindex mpdebug
10281 Enable CRIS-specific verbose debug-related information in the assembly
10282 code.  This option also has the effect to turn off the @samp{#NO_APP}
10283 formatted-code indicator to the assembler at the beginning of the
10284 assembly file.
10285
10286 @item -mcc-init
10287 @opindex mcc-init
10288 Do not use condition-code results from previous instruction; always emit
10289 compare and test instructions before use of condition codes.
10290
10291 @item -mno-side-effects
10292 @opindex mno-side-effects
10293 Do not emit instructions with side-effects in addressing modes other than
10294 post-increment.
10295
10296 @item -mstack-align
10297 @itemx -mno-stack-align
10298 @itemx -mdata-align
10299 @itemx -mno-data-align
10300 @itemx -mconst-align
10301 @itemx -mno-const-align
10302 @opindex mstack-align
10303 @opindex mno-stack-align
10304 @opindex mdata-align
10305 @opindex mno-data-align
10306 @opindex mconst-align
10307 @opindex mno-const-align
10308 These options (no-options) arranges (eliminate arrangements) for the
10309 stack-frame, individual data and constants to be aligned for the maximum
10310 single data access size for the chosen CPU model.  The default is to
10311 arrange for 32-bit alignment.  ABI details such as structure layout are
10312 not affected by these options.
10313
10314 @item -m32-bit
10315 @itemx -m16-bit
10316 @itemx -m8-bit
10317 @opindex m32-bit
10318 @opindex m16-bit
10319 @opindex m8-bit
10320 Similar to the stack- data- and const-align options above, these options
10321 arrange for stack-frame, writable data and constants to all be 32-bit,
10322 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10323
10324 @item -mno-prologue-epilogue
10325 @itemx -mprologue-epilogue
10326 @opindex mno-prologue-epilogue
10327 @opindex mprologue-epilogue
10328 With @option{-mno-prologue-epilogue}, the normal function prologue and
10329 epilogue that sets up the stack-frame are omitted and no return
10330 instructions or return sequences are generated in the code.  Use this
10331 option only together with visual inspection of the compiled code: no
10332 warnings or errors are generated when call-saved registers must be saved,
10333 or storage for local variable needs to be allocated.
10334
10335 @item -mno-gotplt
10336 @itemx -mgotplt
10337 @opindex mno-gotplt
10338 @opindex mgotplt
10339 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10340 instruction sequences that load addresses for functions from the PLT part
10341 of the GOT rather than (traditional on other architectures) calls to the
10342 PLT@.  The default is @option{-mgotplt}.
10343
10344 @item -melf
10345 @opindex melf
10346 Legacy no-op option only recognized with the cris-axis-elf and
10347 cris-axis-linux-gnu targets.
10348
10349 @item -mlinux
10350 @opindex mlinux
10351 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10352
10353 @item -sim
10354 @opindex sim
10355 This option, recognized for the cris-axis-elf arranges
10356 to link with input-output functions from a simulator library.  Code,
10357 initialized data and zero-initialized data are allocated consecutively.
10358
10359 @item -sim2
10360 @opindex sim2
10361 Like @option{-sim}, but pass linker options to locate initialized data at
10362 0x40000000 and zero-initialized data at 0x80000000.
10363 @end table
10364
10365 @node CRX Options
10366 @subsection CRX Options
10367 @cindex CRX Options
10368
10369 These options are defined specifically for the CRX ports.
10370
10371 @table @gcctabopt
10372
10373 @item -mmac
10374 @opindex mmac
10375 Enable the use of multiply-accumulate instructions. Disabled by default.
10376
10377 @item -mpush-args
10378 @opindex mpush-args
10379 Push instructions will be used to pass outgoing arguments when functions
10380 are called. Enabled by default.
10381 @end table
10382
10383 @node Darwin Options
10384 @subsection Darwin Options
10385 @cindex Darwin options
10386
10387 These options are defined for all architectures running the Darwin operating
10388 system.
10389
10390 FSF GCC on Darwin does not create ``fat'' object files; it will create
10391 an object file for the single architecture that it was built to
10392 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
10393 @option{-arch} options are used; it does so by running the compiler or
10394 linker multiple times and joining the results together with
10395 @file{lipo}.
10396
10397 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10398 @samp{i686}) is determined by the flags that specify the ISA
10399 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
10400 @option{-force_cpusubtype_ALL} option can be used to override this.
10401
10402 The Darwin tools vary in their behavior when presented with an ISA
10403 mismatch.  The assembler, @file{as}, will only permit instructions to
10404 be used that are valid for the subtype of the file it is generating,
10405 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10406 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10407 and print an error if asked to create a shared library with a less
10408 restrictive subtype than its input files (for instance, trying to put
10409 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10410 for executables, @file{ld}, will quietly give the executable the most
10411 restrictive subtype of any of its input files.
10412
10413 @table @gcctabopt
10414 @item -F@var{dir}
10415 @opindex F
10416 Add the framework directory @var{dir} to the head of the list of
10417 directories to be searched for header files.  These directories are
10418 interleaved with those specified by @option{-I} options and are
10419 scanned in a left-to-right order.
10420
10421 A framework directory is a directory with frameworks in it.  A
10422 framework is a directory with a @samp{"Headers"} and/or
10423 @samp{"PrivateHeaders"} directory contained directly in it that ends
10424 in @samp{".framework"}.  The name of a framework is the name of this
10425 directory excluding the @samp{".framework"}.  Headers associated with
10426 the framework are found in one of those two directories, with
10427 @samp{"Headers"} being searched first.  A subframework is a framework
10428 directory that is in a framework's @samp{"Frameworks"} directory.
10429 Includes of subframework headers can only appear in a header of a
10430 framework that contains the subframework, or in a sibling subframework
10431 header.  Two subframeworks are siblings if they occur in the same
10432 framework.  A subframework should not have the same name as a
10433 framework, a warning will be issued if this is violated.  Currently a
10434 subframework cannot have subframeworks, in the future, the mechanism
10435 may be extended to support this.  The standard frameworks can be found
10436 in @samp{"/System/Library/Frameworks"} and
10437 @samp{"/Library/Frameworks"}.  An example include looks like
10438 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10439 the name of the framework and header.h is found in the
10440 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10441
10442 @item -iframework@var{dir}
10443 @opindex iframework
10444 Like @option{-F} except the directory is a treated as a system
10445 directory.  The main difference between this @option{-iframework} and
10446 @option{-F} is that with @option{-iframework} the compiler does not
10447 warn about constructs contained within header files found via
10448 @var{dir}.  This option is valid only for the C family of languages.
10449
10450 @item -gused
10451 @opindex gused
10452 Emit debugging information for symbols that are used.  For STABS
10453 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10454 This is by default ON@.
10455
10456 @item -gfull
10457 @opindex gfull
10458 Emit debugging information for all symbols and types.
10459
10460 @item -mmacosx-version-min=@var{version}
10461 The earliest version of MacOS X that this executable will run on
10462 is @var{version}.  Typical values of @var{version} include @code{10.1},
10463 @code{10.2}, and @code{10.3.9}.
10464
10465 If the compiler was built to use the system's headers by default,
10466 then the default for this option is the system version on which the
10467 compiler is running, otherwise the default is to make choices which
10468 are compatible with as many systems and code bases as possible.
10469
10470 @item -mkernel
10471 @opindex mkernel
10472 Enable kernel development mode.  The @option{-mkernel} option sets
10473 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10474 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10475 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10476 applicable.  This mode also sets @option{-mno-altivec},
10477 @option{-msoft-float}, @option{-fno-builtin} and
10478 @option{-mlong-branch} for PowerPC targets.
10479
10480 @item -mone-byte-bool
10481 @opindex mone-byte-bool
10482 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10483 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10484 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10485 option has no effect on x86.
10486
10487 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10488 to generate code that is not binary compatible with code generated
10489 without that switch.  Using this switch may require recompiling all
10490 other modules in a program, including system libraries.  Use this
10491 switch to conform to a non-default data model.
10492
10493 @item -mfix-and-continue
10494 @itemx -ffix-and-continue
10495 @itemx -findirect-data
10496 @opindex mfix-and-continue
10497 @opindex ffix-and-continue
10498 @opindex findirect-data
10499 Generate code suitable for fast turn around development.  Needed to
10500 enable gdb to dynamically load @code{.o} files into already running
10501 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10502 are provided for backwards compatibility.
10503
10504 @item -all_load
10505 @opindex all_load
10506 Loads all members of static archive libraries.
10507 See man ld(1) for more information.
10508
10509 @item -arch_errors_fatal
10510 @opindex arch_errors_fatal
10511 Cause the errors having to do with files that have the wrong architecture
10512 to be fatal.
10513
10514 @item -bind_at_load
10515 @opindex bind_at_load
10516 Causes the output file to be marked such that the dynamic linker will
10517 bind all undefined references when the file is loaded or launched.
10518
10519 @item -bundle
10520 @opindex bundle
10521 Produce a Mach-o bundle format file.
10522 See man ld(1) for more information.
10523
10524 @item -bundle_loader @var{executable}
10525 @opindex bundle_loader
10526 This option specifies the @var{executable} that will be loading the build
10527 output file being linked.  See man ld(1) for more information.
10528
10529 @item -dynamiclib
10530 @opindex dynamiclib
10531 When passed this option, GCC will produce a dynamic library instead of
10532 an executable when linking, using the Darwin @file{libtool} command.
10533
10534 @item -force_cpusubtype_ALL
10535 @opindex force_cpusubtype_ALL
10536 This causes GCC's output file to have the @var{ALL} subtype, instead of
10537 one controlled by the @option{-mcpu} or @option{-march} option.
10538
10539 @item -allowable_client  @var{client_name}
10540 @itemx -client_name
10541 @itemx -compatibility_version
10542 @itemx -current_version
10543 @itemx -dead_strip
10544 @itemx -dependency-file
10545 @itemx -dylib_file
10546 @itemx -dylinker_install_name
10547 @itemx -dynamic
10548 @itemx -exported_symbols_list
10549 @itemx -filelist
10550 @itemx -flat_namespace
10551 @itemx -force_flat_namespace
10552 @itemx -headerpad_max_install_names
10553 @itemx -image_base
10554 @itemx -init
10555 @itemx -install_name
10556 @itemx -keep_private_externs
10557 @itemx -multi_module
10558 @itemx -multiply_defined
10559 @itemx -multiply_defined_unused
10560 @itemx -noall_load
10561 @itemx -no_dead_strip_inits_and_terms
10562 @itemx -nofixprebinding
10563 @itemx -nomultidefs
10564 @itemx -noprebind
10565 @itemx -noseglinkedit
10566 @itemx -pagezero_size
10567 @itemx -prebind
10568 @itemx -prebind_all_twolevel_modules
10569 @itemx -private_bundle
10570 @itemx -read_only_relocs
10571 @itemx -sectalign
10572 @itemx -sectobjectsymbols
10573 @itemx -whyload
10574 @itemx -seg1addr
10575 @itemx -sectcreate
10576 @itemx -sectobjectsymbols
10577 @itemx -sectorder
10578 @itemx -segaddr
10579 @itemx -segs_read_only_addr
10580 @itemx -segs_read_write_addr
10581 @itemx -seg_addr_table
10582 @itemx -seg_addr_table_filename
10583 @itemx -seglinkedit
10584 @itemx -segprot
10585 @itemx -segs_read_only_addr
10586 @itemx -segs_read_write_addr
10587 @itemx -single_module
10588 @itemx -static
10589 @itemx -sub_library
10590 @itemx -sub_umbrella
10591 @itemx -twolevel_namespace
10592 @itemx -umbrella
10593 @itemx -undefined
10594 @itemx -unexported_symbols_list
10595 @itemx -weak_reference_mismatches
10596 @itemx -whatsloaded
10597 @opindex allowable_client
10598 @opindex client_name
10599 @opindex compatibility_version
10600 @opindex current_version
10601 @opindex dead_strip
10602 @opindex dependency-file
10603 @opindex dylib_file
10604 @opindex dylinker_install_name
10605 @opindex dynamic
10606 @opindex exported_symbols_list
10607 @opindex filelist
10608 @opindex flat_namespace
10609 @opindex force_flat_namespace
10610 @opindex headerpad_max_install_names
10611 @opindex image_base
10612 @opindex init
10613 @opindex install_name
10614 @opindex keep_private_externs
10615 @opindex multi_module
10616 @opindex multiply_defined
10617 @opindex multiply_defined_unused
10618 @opindex noall_load
10619 @opindex no_dead_strip_inits_and_terms
10620 @opindex nofixprebinding
10621 @opindex nomultidefs
10622 @opindex noprebind
10623 @opindex noseglinkedit
10624 @opindex pagezero_size
10625 @opindex prebind
10626 @opindex prebind_all_twolevel_modules
10627 @opindex private_bundle
10628 @opindex read_only_relocs
10629 @opindex sectalign
10630 @opindex sectobjectsymbols
10631 @opindex whyload
10632 @opindex seg1addr
10633 @opindex sectcreate
10634 @opindex sectobjectsymbols
10635 @opindex sectorder
10636 @opindex segaddr
10637 @opindex segs_read_only_addr
10638 @opindex segs_read_write_addr
10639 @opindex seg_addr_table
10640 @opindex seg_addr_table_filename
10641 @opindex seglinkedit
10642 @opindex segprot
10643 @opindex segs_read_only_addr
10644 @opindex segs_read_write_addr
10645 @opindex single_module
10646 @opindex static
10647 @opindex sub_library
10648 @opindex sub_umbrella
10649 @opindex twolevel_namespace
10650 @opindex umbrella
10651 @opindex undefined
10652 @opindex unexported_symbols_list
10653 @opindex weak_reference_mismatches
10654 @opindex whatsloaded
10655 These options are passed to the Darwin linker.  The Darwin linker man page
10656 describes them in detail.
10657 @end table
10658
10659 @node DEC Alpha Options
10660 @subsection DEC Alpha Options
10661
10662 These @samp{-m} options are defined for the DEC Alpha implementations:
10663
10664 @table @gcctabopt
10665 @item -mno-soft-float
10666 @itemx -msoft-float
10667 @opindex mno-soft-float
10668 @opindex msoft-float
10669 Use (do not use) the hardware floating-point instructions for
10670 floating-point operations.  When @option{-msoft-float} is specified,
10671 functions in @file{libgcc.a} will be used to perform floating-point
10672 operations.  Unless they are replaced by routines that emulate the
10673 floating-point operations, or compiled in such a way as to call such
10674 emulations routines, these routines will issue floating-point
10675 operations.   If you are compiling for an Alpha without floating-point
10676 operations, you must ensure that the library is built so as not to call
10677 them.
10678
10679 Note that Alpha implementations without floating-point operations are
10680 required to have floating-point registers.
10681
10682 @item -mfp-reg
10683 @itemx -mno-fp-regs
10684 @opindex mfp-reg
10685 @opindex mno-fp-regs
10686 Generate code that uses (does not use) the floating-point register set.
10687 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
10688 register set is not used, floating point operands are passed in integer
10689 registers as if they were integers and floating-point results are passed
10690 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
10691 so any function with a floating-point argument or return value called by code
10692 compiled with @option{-mno-fp-regs} must also be compiled with that
10693 option.
10694
10695 A typical use of this option is building a kernel that does not use,
10696 and hence need not save and restore, any floating-point registers.
10697
10698 @item -mieee
10699 @opindex mieee
10700 The Alpha architecture implements floating-point hardware optimized for
10701 maximum performance.  It is mostly compliant with the IEEE floating
10702 point standard.  However, for full compliance, software assistance is
10703 required.  This option generates code fully IEEE compliant code
10704 @emph{except} that the @var{inexact-flag} is not maintained (see below).
10705 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
10706 defined during compilation.  The resulting code is less efficient but is
10707 able to correctly support denormalized numbers and exceptional IEEE
10708 values such as not-a-number and plus/minus infinity.  Other Alpha
10709 compilers call this option @option{-ieee_with_no_inexact}.
10710
10711 @item -mieee-with-inexact
10712 @opindex mieee-with-inexact
10713 This is like @option{-mieee} except the generated code also maintains
10714 the IEEE @var{inexact-flag}.  Turning on this option causes the
10715 generated code to implement fully-compliant IEEE math.  In addition to
10716 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
10717 macro.  On some Alpha implementations the resulting code may execute
10718 significantly slower than the code generated by default.  Since there is
10719 very little code that depends on the @var{inexact-flag}, you should
10720 normally not specify this option.  Other Alpha compilers call this
10721 option @option{-ieee_with_inexact}.
10722
10723 @item -mfp-trap-mode=@var{trap-mode}
10724 @opindex mfp-trap-mode
10725 This option controls what floating-point related traps are enabled.
10726 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
10727 The trap mode can be set to one of four values:
10728
10729 @table @samp
10730 @item n
10731 This is the default (normal) setting.  The only traps that are enabled
10732 are the ones that cannot be disabled in software (e.g., division by zero
10733 trap).
10734
10735 @item u
10736 In addition to the traps enabled by @samp{n}, underflow traps are enabled
10737 as well.
10738
10739 @item su
10740 Like @samp{u}, but the instructions are marked to be safe for software
10741 completion (see Alpha architecture manual for details).
10742
10743 @item sui
10744 Like @samp{su}, but inexact traps are enabled as well.
10745 @end table
10746
10747 @item -mfp-rounding-mode=@var{rounding-mode}
10748 @opindex mfp-rounding-mode
10749 Selects the IEEE rounding mode.  Other Alpha compilers call this option
10750 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
10751 of:
10752
10753 @table @samp
10754 @item n
10755 Normal IEEE rounding mode.  Floating point numbers are rounded towards
10756 the nearest machine number or towards the even machine number in case
10757 of a tie.
10758
10759 @item m
10760 Round towards minus infinity.
10761
10762 @item c
10763 Chopped rounding mode.  Floating point numbers are rounded towards zero.
10764
10765 @item d
10766 Dynamic rounding mode.  A field in the floating point control register
10767 (@var{fpcr}, see Alpha architecture reference manual) controls the
10768 rounding mode in effect.  The C library initializes this register for
10769 rounding towards plus infinity.  Thus, unless your program modifies the
10770 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
10771 @end table
10772
10773 @item -mtrap-precision=@var{trap-precision}
10774 @opindex mtrap-precision
10775 In the Alpha architecture, floating point traps are imprecise.  This
10776 means without software assistance it is impossible to recover from a
10777 floating trap and program execution normally needs to be terminated.
10778 GCC can generate code that can assist operating system trap handlers
10779 in determining the exact location that caused a floating point trap.
10780 Depending on the requirements of an application, different levels of
10781 precisions can be selected:
10782
10783 @table @samp
10784 @item p
10785 Program precision.  This option is the default and means a trap handler
10786 can only identify which program caused a floating point exception.
10787
10788 @item f
10789 Function precision.  The trap handler can determine the function that
10790 caused a floating point exception.
10791
10792 @item i
10793 Instruction precision.  The trap handler can determine the exact
10794 instruction that caused a floating point exception.
10795 @end table
10796
10797 Other Alpha compilers provide the equivalent options called
10798 @option{-scope_safe} and @option{-resumption_safe}.
10799
10800 @item -mieee-conformant
10801 @opindex mieee-conformant
10802 This option marks the generated code as IEEE conformant.  You must not
10803 use this option unless you also specify @option{-mtrap-precision=i} and either
10804 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
10805 is to emit the line @samp{.eflag 48} in the function prologue of the
10806 generated assembly file.  Under DEC Unix, this has the effect that
10807 IEEE-conformant math library routines will be linked in.
10808
10809 @item -mbuild-constants
10810 @opindex mbuild-constants
10811 Normally GCC examines a 32- or 64-bit integer constant to
10812 see if it can construct it from smaller constants in two or three
10813 instructions.  If it cannot, it will output the constant as a literal and
10814 generate code to load it from the data segment at runtime.
10815
10816 Use this option to require GCC to construct @emph{all} integer constants
10817 using code, even if it takes more instructions (the maximum is six).
10818
10819 You would typically use this option to build a shared library dynamic
10820 loader.  Itself a shared library, it must relocate itself in memory
10821 before it can find the variables and constants in its own data segment.
10822
10823 @item -malpha-as
10824 @itemx -mgas
10825 @opindex malpha-as
10826 @opindex mgas
10827 Select whether to generate code to be assembled by the vendor-supplied
10828 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
10829
10830 @item -mbwx
10831 @itemx -mno-bwx
10832 @itemx -mcix
10833 @itemx -mno-cix
10834 @itemx -mfix
10835 @itemx -mno-fix
10836 @itemx -mmax
10837 @itemx -mno-max
10838 @opindex mbwx
10839 @opindex mno-bwx
10840 @opindex mcix
10841 @opindex mno-cix
10842 @opindex mfix
10843 @opindex mno-fix
10844 @opindex mmax
10845 @opindex mno-max
10846 Indicate whether GCC should generate code to use the optional BWX,
10847 CIX, FIX and MAX instruction sets.  The default is to use the instruction
10848 sets supported by the CPU type specified via @option{-mcpu=} option or that
10849 of the CPU on which GCC was built if none was specified.
10850
10851 @item -mfloat-vax
10852 @itemx -mfloat-ieee
10853 @opindex mfloat-vax
10854 @opindex mfloat-ieee
10855 Generate code that uses (does not use) VAX F and G floating point
10856 arithmetic instead of IEEE single and double precision.
10857
10858 @item -mexplicit-relocs
10859 @itemx -mno-explicit-relocs
10860 @opindex mexplicit-relocs
10861 @opindex mno-explicit-relocs
10862 Older Alpha assemblers provided no way to generate symbol relocations
10863 except via assembler macros.  Use of these macros does not allow
10864 optimal instruction scheduling.  GNU binutils as of version 2.12
10865 supports a new syntax that allows the compiler to explicitly mark
10866 which relocations should apply to which instructions.  This option
10867 is mostly useful for debugging, as GCC detects the capabilities of
10868 the assembler when it is built and sets the default accordingly.
10869
10870 @item -msmall-data
10871 @itemx -mlarge-data
10872 @opindex msmall-data
10873 @opindex mlarge-data
10874 When @option{-mexplicit-relocs} is in effect, static data is
10875 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
10876 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
10877 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
10878 16-bit relocations off of the @code{$gp} register.  This limits the
10879 size of the small data area to 64KB, but allows the variables to be
10880 directly accessed via a single instruction.
10881
10882 The default is @option{-mlarge-data}.  With this option the data area
10883 is limited to just below 2GB@.  Programs that require more than 2GB of
10884 data must use @code{malloc} or @code{mmap} to allocate the data in the
10885 heap instead of in the program's data segment.
10886
10887 When generating code for shared libraries, @option{-fpic} implies
10888 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
10889
10890 @item -msmall-text
10891 @itemx -mlarge-text
10892 @opindex msmall-text
10893 @opindex mlarge-text
10894 When @option{-msmall-text} is used, the compiler assumes that the
10895 code of the entire program (or shared library) fits in 4MB, and is
10896 thus reachable with a branch instruction.  When @option{-msmall-data}
10897 is used, the compiler can assume that all local symbols share the
10898 same @code{$gp} value, and thus reduce the number of instructions
10899 required for a function call from 4 to 1.
10900
10901 The default is @option{-mlarge-text}.
10902
10903 @item -mcpu=@var{cpu_type}
10904 @opindex mcpu
10905 Set the instruction set and instruction scheduling parameters for
10906 machine type @var{cpu_type}.  You can specify either the @samp{EV}
10907 style name or the corresponding chip number.  GCC supports scheduling
10908 parameters for the EV4, EV5 and EV6 family of processors and will
10909 choose the default values for the instruction set from the processor
10910 you specify.  If you do not specify a processor type, GCC will default
10911 to the processor on which the compiler was built.
10912
10913 Supported values for @var{cpu_type} are
10914
10915 @table @samp
10916 @item ev4
10917 @itemx ev45
10918 @itemx 21064
10919 Schedules as an EV4 and has no instruction set extensions.
10920
10921 @item ev5
10922 @itemx 21164
10923 Schedules as an EV5 and has no instruction set extensions.
10924
10925 @item ev56
10926 @itemx 21164a
10927 Schedules as an EV5 and supports the BWX extension.
10928
10929 @item pca56
10930 @itemx 21164pc
10931 @itemx 21164PC
10932 Schedules as an EV5 and supports the BWX and MAX extensions.
10933
10934 @item ev6
10935 @itemx 21264
10936 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
10937
10938 @item ev67
10939 @itemx 21264a
10940 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
10941 @end table
10942
10943 Native Linux/GNU toolchains also support the value @samp{native},
10944 which selects the best architecture option for the host processor.
10945 @option{-mcpu=native} has no effect if GCC does not recognize
10946 the processor.
10947
10948 @item -mtune=@var{cpu_type}
10949 @opindex mtune
10950 Set only the instruction scheduling parameters for machine type
10951 @var{cpu_type}.  The instruction set is not changed.
10952
10953 Native Linux/GNU toolchains also support the value @samp{native},
10954 which selects the best architecture option for the host processor.
10955 @option{-mtune=native} has no effect if GCC does not recognize
10956 the processor.
10957
10958 @item -mmemory-latency=@var{time}
10959 @opindex mmemory-latency
10960 Sets the latency the scheduler should assume for typical memory
10961 references as seen by the application.  This number is highly
10962 dependent on the memory access patterns used by the application
10963 and the size of the external cache on the machine.
10964
10965 Valid options for @var{time} are
10966
10967 @table @samp
10968 @item @var{number}
10969 A decimal number representing clock cycles.
10970
10971 @item L1
10972 @itemx L2
10973 @itemx L3
10974 @itemx main
10975 The compiler contains estimates of the number of clock cycles for
10976 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
10977 (also called Dcache, Scache, and Bcache), as well as to main memory.
10978 Note that L3 is only valid for EV5.
10979
10980 @end table
10981 @end table
10982
10983 @node DEC Alpha/VMS Options
10984 @subsection DEC Alpha/VMS Options
10985
10986 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
10987
10988 @table @gcctabopt
10989 @item -mvms-return-codes
10990 @opindex mvms-return-codes
10991 Return VMS condition codes from main.  The default is to return POSIX
10992 style condition (e.g.@: error) codes.
10993
10994 @item -mdebug-main=@var{prefix}
10995 @opindex mdebug-main=@var{prefix}
10996 Flag the first routine whose name starts with @var{prefix} as the main
10997 routine for the debugger.
10998
10999 @item -mmalloc64
11000 @opindex mmalloc64
11001 Default to 64bit memory allocation routines.
11002 @end table
11003
11004 @node FR30 Options
11005 @subsection FR30 Options
11006 @cindex FR30 Options
11007
11008 These options are defined specifically for the FR30 port.
11009
11010 @table @gcctabopt
11011
11012 @item -msmall-model
11013 @opindex msmall-model
11014 Use the small address space model.  This can produce smaller code, but
11015 it does assume that all symbolic values and addresses will fit into a
11016 20-bit range.
11017
11018 @item -mno-lsim
11019 @opindex mno-lsim
11020 Assume that run-time support has been provided and so there is no need
11021 to include the simulator library (@file{libsim.a}) on the linker
11022 command line.
11023
11024 @end table
11025
11026 @node FRV Options
11027 @subsection FRV Options
11028 @cindex FRV Options
11029
11030 @table @gcctabopt
11031 @item -mgpr-32
11032 @opindex mgpr-32
11033
11034 Only use the first 32 general purpose registers.
11035
11036 @item -mgpr-64
11037 @opindex mgpr-64
11038
11039 Use all 64 general purpose registers.
11040
11041 @item -mfpr-32
11042 @opindex mfpr-32
11043
11044 Use only the first 32 floating point registers.
11045
11046 @item -mfpr-64
11047 @opindex mfpr-64
11048
11049 Use all 64 floating point registers
11050
11051 @item -mhard-float
11052 @opindex mhard-float
11053
11054 Use hardware instructions for floating point operations.
11055
11056 @item -msoft-float
11057 @opindex msoft-float
11058
11059 Use library routines for floating point operations.
11060
11061 @item -malloc-cc
11062 @opindex malloc-cc
11063
11064 Dynamically allocate condition code registers.
11065
11066 @item -mfixed-cc
11067 @opindex mfixed-cc
11068
11069 Do not try to dynamically allocate condition code registers, only
11070 use @code{icc0} and @code{fcc0}.
11071
11072 @item -mdword
11073 @opindex mdword
11074
11075 Change ABI to use double word insns.
11076
11077 @item -mno-dword
11078 @opindex mno-dword
11079
11080 Do not use double word instructions.
11081
11082 @item -mdouble
11083 @opindex mdouble
11084
11085 Use floating point double instructions.
11086
11087 @item -mno-double
11088 @opindex mno-double
11089
11090 Do not use floating point double instructions.
11091
11092 @item -mmedia
11093 @opindex mmedia
11094
11095 Use media instructions.
11096
11097 @item -mno-media
11098 @opindex mno-media
11099
11100 Do not use media instructions.
11101
11102 @item -mmuladd
11103 @opindex mmuladd
11104
11105 Use multiply and add/subtract instructions.
11106
11107 @item -mno-muladd
11108 @opindex mno-muladd
11109
11110 Do not use multiply and add/subtract instructions.
11111
11112 @item -mfdpic
11113 @opindex mfdpic
11114
11115 Select the FDPIC ABI, that uses function descriptors to represent
11116 pointers to functions.  Without any PIC/PIE-related options, it
11117 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
11118 assumes GOT entries and small data are within a 12-bit range from the
11119 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
11120 are computed with 32 bits.
11121 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11122
11123 @item -minline-plt
11124 @opindex minline-plt
11125
11126 Enable inlining of PLT entries in function calls to functions that are
11127 not known to bind locally.  It has no effect without @option{-mfdpic}.
11128 It's enabled by default if optimizing for speed and compiling for
11129 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
11130 optimization option such as @option{-O3} or above is present in the
11131 command line.
11132
11133 @item -mTLS
11134 @opindex mTLS
11135
11136 Assume a large TLS segment when generating thread-local code.
11137
11138 @item -mtls
11139 @opindex mtls
11140
11141 Do not assume a large TLS segment when generating thread-local code.
11142
11143 @item -mgprel-ro
11144 @opindex mgprel-ro
11145
11146 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
11147 that is known to be in read-only sections.  It's enabled by default,
11148 except for @option{-fpic} or @option{-fpie}: even though it may help
11149 make the global offset table smaller, it trades 1 instruction for 4.
11150 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
11151 one of which may be shared by multiple symbols, and it avoids the need
11152 for a GOT entry for the referenced symbol, so it's more likely to be a
11153 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
11154
11155 @item -multilib-library-pic
11156 @opindex multilib-library-pic
11157
11158 Link with the (library, not FD) pic libraries.  It's implied by
11159 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
11160 @option{-fpic} without @option{-mfdpic}.  You should never have to use
11161 it explicitly.
11162
11163 @item -mlinked-fp
11164 @opindex mlinked-fp
11165
11166 Follow the EABI requirement of always creating a frame pointer whenever
11167 a stack frame is allocated.  This option is enabled by default and can
11168 be disabled with @option{-mno-linked-fp}.
11169
11170 @item -mlong-calls
11171 @opindex mlong-calls
11172
11173 Use indirect addressing to call functions outside the current
11174 compilation unit.  This allows the functions to be placed anywhere
11175 within the 32-bit address space.
11176
11177 @item -malign-labels
11178 @opindex malign-labels
11179
11180 Try to align labels to an 8-byte boundary by inserting nops into the
11181 previous packet.  This option only has an effect when VLIW packing
11182 is enabled.  It doesn't create new packets; it merely adds nops to
11183 existing ones.
11184
11185 @item -mlibrary-pic
11186 @opindex mlibrary-pic
11187
11188 Generate position-independent EABI code.
11189
11190 @item -macc-4
11191 @opindex macc-4
11192
11193 Use only the first four media accumulator registers.
11194
11195 @item -macc-8
11196 @opindex macc-8
11197
11198 Use all eight media accumulator registers.
11199
11200 @item -mpack
11201 @opindex mpack
11202
11203 Pack VLIW instructions.
11204
11205 @item -mno-pack
11206 @opindex mno-pack
11207
11208 Do not pack VLIW instructions.
11209
11210 @item -mno-eflags
11211 @opindex mno-eflags
11212
11213 Do not mark ABI switches in e_flags.
11214
11215 @item -mcond-move
11216 @opindex mcond-move
11217
11218 Enable the use of conditional-move instructions (default).
11219
11220 This switch is mainly for debugging the compiler and will likely be removed
11221 in a future version.
11222
11223 @item -mno-cond-move
11224 @opindex mno-cond-move
11225
11226 Disable the use of conditional-move instructions.
11227
11228 This switch is mainly for debugging the compiler and will likely be removed
11229 in a future version.
11230
11231 @item -mscc
11232 @opindex mscc
11233
11234 Enable the use of conditional set instructions (default).
11235
11236 This switch is mainly for debugging the compiler and will likely be removed
11237 in a future version.
11238
11239 @item -mno-scc
11240 @opindex mno-scc
11241
11242 Disable the use of conditional set instructions.
11243
11244 This switch is mainly for debugging the compiler and will likely be removed
11245 in a future version.
11246
11247 @item -mcond-exec
11248 @opindex mcond-exec
11249
11250 Enable the use of conditional execution (default).
11251
11252 This switch is mainly for debugging the compiler and will likely be removed
11253 in a future version.
11254
11255 @item -mno-cond-exec
11256 @opindex mno-cond-exec
11257
11258 Disable the use of conditional execution.
11259
11260 This switch is mainly for debugging the compiler and will likely be removed
11261 in a future version.
11262
11263 @item -mvliw-branch
11264 @opindex mvliw-branch
11265
11266 Run a pass to pack branches into VLIW instructions (default).
11267
11268 This switch is mainly for debugging the compiler and will likely be removed
11269 in a future version.
11270
11271 @item -mno-vliw-branch
11272 @opindex mno-vliw-branch
11273
11274 Do not run a pass to pack branches into VLIW instructions.
11275
11276 This switch is mainly for debugging the compiler and will likely be removed
11277 in a future version.
11278
11279 @item -mmulti-cond-exec
11280 @opindex mmulti-cond-exec
11281
11282 Enable optimization of @code{&&} and @code{||} in conditional execution
11283 (default).
11284
11285 This switch is mainly for debugging the compiler and will likely be removed
11286 in a future version.
11287
11288 @item -mno-multi-cond-exec
11289 @opindex mno-multi-cond-exec
11290
11291 Disable optimization of @code{&&} and @code{||} in conditional execution.
11292
11293 This switch is mainly for debugging the compiler and will likely be removed
11294 in a future version.
11295
11296 @item -mnested-cond-exec
11297 @opindex mnested-cond-exec
11298
11299 Enable nested conditional execution optimizations (default).
11300
11301 This switch is mainly for debugging the compiler and will likely be removed
11302 in a future version.
11303
11304 @item -mno-nested-cond-exec
11305 @opindex mno-nested-cond-exec
11306
11307 Disable nested conditional execution optimizations.
11308
11309 This switch is mainly for debugging the compiler and will likely be removed
11310 in a future version.
11311
11312 @item -moptimize-membar
11313 @opindex moptimize-membar
11314
11315 This switch removes redundant @code{membar} instructions from the
11316 compiler generated code.  It is enabled by default.
11317
11318 @item -mno-optimize-membar
11319 @opindex mno-optimize-membar
11320
11321 This switch disables the automatic removal of redundant @code{membar}
11322 instructions from the generated code.
11323
11324 @item -mtomcat-stats
11325 @opindex mtomcat-stats
11326
11327 Cause gas to print out tomcat statistics.
11328
11329 @item -mcpu=@var{cpu}
11330 @opindex mcpu
11331
11332 Select the processor type for which to generate code.  Possible values are
11333 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11334 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11335
11336 @end table
11337
11338 @node GNU/Linux Options
11339 @subsection GNU/Linux Options
11340
11341 These @samp{-m} options are defined for GNU/Linux targets:
11342
11343 @table @gcctabopt
11344 @item -mglibc
11345 @opindex mglibc
11346 Use the GNU C library instead of uClibc.  This is the default except
11347 on @samp{*-*-linux-*uclibc*} targets.
11348
11349 @item -muclibc
11350 @opindex muclibc
11351 Use uClibc instead of the GNU C library.  This is the default on
11352 @samp{*-*-linux-*uclibc*} targets.
11353 @end table
11354
11355 @node H8/300 Options
11356 @subsection H8/300 Options
11357
11358 These @samp{-m} options are defined for the H8/300 implementations:
11359
11360 @table @gcctabopt
11361 @item -mrelax
11362 @opindex mrelax
11363 Shorten some address references at link time, when possible; uses the
11364 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
11365 ld, Using ld}, for a fuller description.
11366
11367 @item -mh
11368 @opindex mh
11369 Generate code for the H8/300H@.
11370
11371 @item -ms
11372 @opindex ms
11373 Generate code for the H8S@.
11374
11375 @item -mn
11376 @opindex mn
11377 Generate code for the H8S and H8/300H in the normal mode.  This switch
11378 must be used either with @option{-mh} or @option{-ms}.
11379
11380 @item -ms2600
11381 @opindex ms2600
11382 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
11383
11384 @item -mint32
11385 @opindex mint32
11386 Make @code{int} data 32 bits by default.
11387
11388 @item -malign-300
11389 @opindex malign-300
11390 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11391 The default for the H8/300H and H8S is to align longs and floats on 4
11392 byte boundaries.
11393 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11394 This option has no effect on the H8/300.
11395 @end table
11396
11397 @node HPPA Options
11398 @subsection HPPA Options
11399 @cindex HPPA Options
11400
11401 These @samp{-m} options are defined for the HPPA family of computers:
11402
11403 @table @gcctabopt
11404 @item -march=@var{architecture-type}
11405 @opindex march
11406 Generate code for the specified architecture.  The choices for
11407 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11408 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
11409 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11410 architecture option for your machine.  Code compiled for lower numbered
11411 architectures will run on higher numbered architectures, but not the
11412 other way around.
11413
11414 @item -mpa-risc-1-0
11415 @itemx -mpa-risc-1-1
11416 @itemx -mpa-risc-2-0
11417 @opindex mpa-risc-1-0
11418 @opindex mpa-risc-1-1
11419 @opindex mpa-risc-2-0
11420 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11421
11422 @item -mbig-switch
11423 @opindex mbig-switch
11424 Generate code suitable for big switch tables.  Use this option only if
11425 the assembler/linker complain about out of range branches within a switch
11426 table.
11427
11428 @item -mjump-in-delay
11429 @opindex mjump-in-delay
11430 Fill delay slots of function calls with unconditional jump instructions
11431 by modifying the return pointer for the function call to be the target
11432 of the conditional jump.
11433
11434 @item -mdisable-fpregs
11435 @opindex mdisable-fpregs
11436 Prevent floating point registers from being used in any manner.  This is
11437 necessary for compiling kernels which perform lazy context switching of
11438 floating point registers.  If you use this option and attempt to perform
11439 floating point operations, the compiler will abort.
11440
11441 @item -mdisable-indexing
11442 @opindex mdisable-indexing
11443 Prevent the compiler from using indexing address modes.  This avoids some
11444 rather obscure problems when compiling MIG generated code under MACH@.
11445
11446 @item -mno-space-regs
11447 @opindex mno-space-regs
11448 Generate code that assumes the target has no space registers.  This allows
11449 GCC to generate faster indirect calls and use unscaled index address modes.
11450
11451 Such code is suitable for level 0 PA systems and kernels.
11452
11453 @item -mfast-indirect-calls
11454 @opindex mfast-indirect-calls
11455 Generate code that assumes calls never cross space boundaries.  This
11456 allows GCC to emit code which performs faster indirect calls.
11457
11458 This option will not work in the presence of shared libraries or nested
11459 functions.
11460
11461 @item -mfixed-range=@var{register-range}
11462 @opindex mfixed-range
11463 Generate code treating the given register range as fixed registers.
11464 A fixed register is one that the register allocator can not use.  This is
11465 useful when compiling kernel code.  A register range is specified as
11466 two registers separated by a dash.  Multiple register ranges can be
11467 specified separated by a comma.
11468
11469 @item -mlong-load-store
11470 @opindex mlong-load-store
11471 Generate 3-instruction load and store sequences as sometimes required by
11472 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11473 the HP compilers.
11474
11475 @item -mportable-runtime
11476 @opindex mportable-runtime
11477 Use the portable calling conventions proposed by HP for ELF systems.
11478
11479 @item -mgas
11480 @opindex mgas
11481 Enable the use of assembler directives only GAS understands.
11482
11483 @item -mschedule=@var{cpu-type}
11484 @opindex mschedule
11485 Schedule code according to the constraints for the machine type
11486 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
11487 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
11488 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11489 proper scheduling option for your machine.  The default scheduling is
11490 @samp{8000}.
11491
11492 @item -mlinker-opt
11493 @opindex mlinker-opt
11494 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
11495 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
11496 linkers in which they give bogus error messages when linking some programs.
11497
11498 @item -msoft-float
11499 @opindex msoft-float
11500 Generate output containing library calls for floating point.
11501 @strong{Warning:} the requisite libraries are not available for all HPPA
11502 targets.  Normally the facilities of the machine's usual C compiler are
11503 used, but this cannot be done directly in cross-compilation.  You must make
11504 your own arrangements to provide suitable library functions for
11505 cross-compilation.
11506
11507 @option{-msoft-float} changes the calling convention in the output file;
11508 therefore, it is only useful if you compile @emph{all} of a program with
11509 this option.  In particular, you need to compile @file{libgcc.a}, the
11510 library that comes with GCC, with @option{-msoft-float} in order for
11511 this to work.
11512
11513 @item -msio
11514 @opindex msio
11515 Generate the predefine, @code{_SIO}, for server IO@.  The default is
11516 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
11517 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
11518 options are available under HP-UX and HI-UX@.
11519
11520 @item -mgnu-ld
11521 @opindex mgnu-ld
11522 Use GNU ld specific options.  This passes @option{-shared} to ld when
11523 building a shared library.  It is the default when GCC is configured,
11524 explicitly or implicitly, with the GNU linker.  This option does not
11525 have any affect on which ld is called, it only changes what parameters
11526 are passed to that ld.  The ld that is called is determined by the
11527 @option{--with-ld} configure option, GCC's program search path, and
11528 finally by the user's @env{PATH}.  The linker used by GCC can be printed
11529 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
11530 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11531
11532 @item -mhp-ld
11533 @opindex mhp-ld
11534 Use HP ld specific options.  This passes @option{-b} to ld when building
11535 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11536 links.  It is the default when GCC is configured, explicitly or
11537 implicitly, with the HP linker.  This option does not have any affect on
11538 which ld is called, it only changes what parameters are passed to that
11539 ld.  The ld that is called is determined by the @option{--with-ld}
11540 configure option, GCC's program search path, and finally by the user's
11541 @env{PATH}.  The linker used by GCC can be printed using @samp{which
11542 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
11543 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11544
11545 @item -mlong-calls
11546 @opindex mno-long-calls
11547 Generate code that uses long call sequences.  This ensures that a call
11548 is always able to reach linker generated stubs.  The default is to generate
11549 long calls only when the distance from the call site to the beginning
11550 of the function or translation unit, as the case may be, exceeds a
11551 predefined limit set by the branch type being used.  The limits for
11552 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11553 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
11554 240,000 bytes.
11555
11556 Distances are measured from the beginning of functions when using the
11557 @option{-ffunction-sections} option, or when using the @option{-mgas}
11558 and @option{-mno-portable-runtime} options together under HP-UX with
11559 the SOM linker.
11560
11561 It is normally not desirable to use this option as it will degrade
11562 performance.  However, it may be useful in large applications,
11563 particularly when partial linking is used to build the application.
11564
11565 The types of long calls used depends on the capabilities of the
11566 assembler and linker, and the type of code being generated.  The
11567 impact on systems that support long absolute calls, and long pic
11568 symbol-difference or pc-relative calls should be relatively small.
11569 However, an indirect call is used on 32-bit ELF systems in pic code
11570 and it is quite long.
11571
11572 @item -munix=@var{unix-std}
11573 @opindex march
11574 Generate compiler predefines and select a startfile for the specified
11575 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
11576 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
11577 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
11578 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
11579 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11580 and later.
11581
11582 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11583 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11584 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11585 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11586 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11587 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11588
11589 It is @emph{important} to note that this option changes the interfaces
11590 for various library routines.  It also affects the operational behavior
11591 of the C library.  Thus, @emph{extreme} care is needed in using this
11592 option.
11593
11594 Library code that is intended to operate with more than one UNIX
11595 standard must test, set and restore the variable @var{__xpg4_extended_mask}
11596 as appropriate.  Most GNU software doesn't provide this capability.
11597
11598 @item -nolibdld
11599 @opindex nolibdld
11600 Suppress the generation of link options to search libdld.sl when the
11601 @option{-static} option is specified on HP-UX 10 and later.
11602
11603 @item -static
11604 @opindex static
11605 The HP-UX implementation of setlocale in libc has a dependency on
11606 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
11607 when the @option{-static} option is specified, special link options
11608 are needed to resolve this dependency.
11609
11610 On HP-UX 10 and later, the GCC driver adds the necessary options to
11611 link with libdld.sl when the @option{-static} option is specified.
11612 This causes the resulting binary to be dynamic.  On the 64-bit port,
11613 the linkers generate dynamic binaries by default in any case.  The
11614 @option{-nolibdld} option can be used to prevent the GCC driver from
11615 adding these link options.
11616
11617 @item -threads
11618 @opindex threads
11619 Add support for multithreading with the @dfn{dce thread} library
11620 under HP-UX@.  This option sets flags for both the preprocessor and
11621 linker.
11622 @end table
11623
11624 @node i386 and x86-64 Options
11625 @subsection Intel 386 and AMD x86-64 Options
11626 @cindex i386 Options
11627 @cindex x86-64 Options
11628 @cindex Intel 386 Options
11629 @cindex AMD x86-64 Options
11630
11631 These @samp{-m} options are defined for the i386 and x86-64 family of
11632 computers:
11633
11634 @table @gcctabopt
11635 @item -mtune=@var{cpu-type}
11636 @opindex mtune
11637 Tune to @var{cpu-type} everything applicable about the generated code, except
11638 for the ABI and the set of available instructions.  The choices for
11639 @var{cpu-type} are:
11640 @table @emph
11641 @item generic
11642 Produce code optimized for the most common IA32/AMD64/EM64T processors.
11643 If you know the CPU on which your code will run, then you should use
11644 the corresponding @option{-mtune} option instead of
11645 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
11646 of your application will have, then you should use this option.
11647
11648 As new processors are deployed in the marketplace, the behavior of this
11649 option will change.  Therefore, if you upgrade to a newer version of
11650 GCC, the code generated option will change to reflect the processors
11651 that were most common when that version of GCC was released.
11652
11653 There is no @option{-march=generic} option because @option{-march}
11654 indicates the instruction set the compiler can use, and there is no
11655 generic instruction set applicable to all processors.  In contrast,
11656 @option{-mtune} indicates the processor (or, in this case, collection of
11657 processors) for which the code is optimized.
11658 @item native
11659 This selects the CPU to tune for at compilation time by determining
11660 the processor type of the compiling machine.  Using @option{-mtune=native}
11661 will produce code optimized for the local machine under the constraints
11662 of the selected instruction set.  Using @option{-march=native} will
11663 enable all instruction subsets supported by the local machine (hence
11664 the result might not run on different machines).
11665 @item i386
11666 Original Intel's i386 CPU@.
11667 @item i486
11668 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
11669 @item i586, pentium
11670 Intel Pentium CPU with no MMX support.
11671 @item pentium-mmx
11672 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
11673 @item pentiumpro
11674 Intel PentiumPro CPU@.
11675 @item i686
11676 Same as @code{generic}, but when used as @code{march} option, PentiumPro
11677 instruction set will be used, so the code will run on all i686 family chips.
11678 @item pentium2
11679 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
11680 @item pentium3, pentium3m
11681 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
11682 support.
11683 @item pentium-m
11684 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
11685 support.  Used by Centrino notebooks.
11686 @item pentium4, pentium4m
11687 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
11688 @item prescott
11689 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
11690 set support.
11691 @item nocona
11692 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
11693 SSE2 and SSE3 instruction set support.
11694 @item core2
11695 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11696 instruction set support.
11697 @item atom
11698 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11699 instruction set support.
11700 @item k6
11701 AMD K6 CPU with MMX instruction set support.
11702 @item k6-2, k6-3
11703 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
11704 @item athlon, athlon-tbird
11705 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
11706 support.
11707 @item athlon-4, athlon-xp, athlon-mp
11708 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
11709 instruction set support.
11710 @item k8, opteron, athlon64, athlon-fx
11711 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
11712 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
11713 @item k8-sse3, opteron-sse3, athlon64-sse3
11714 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
11715 @item amdfam10, barcelona
11716 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
11717 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
11718 instruction set extensions.)
11719 @item winchip-c6
11720 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
11721 set support.
11722 @item winchip2
11723 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
11724 instruction set support.
11725 @item c3
11726 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
11727 implemented for this chip.)
11728 @item c3-2
11729 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
11730 implemented for this chip.)
11731 @item geode
11732 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
11733 @end table
11734
11735 While picking a specific @var{cpu-type} will schedule things appropriately
11736 for that particular chip, the compiler will not generate any code that
11737 does not run on the i386 without the @option{-march=@var{cpu-type}} option
11738 being used.
11739
11740 @item -march=@var{cpu-type}
11741 @opindex march
11742 Generate instructions for the machine type @var{cpu-type}.  The choices
11743 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
11744 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
11745
11746 @item -mcpu=@var{cpu-type}
11747 @opindex mcpu
11748 A deprecated synonym for @option{-mtune}.
11749
11750 @item -mfpmath=@var{unit}
11751 @opindex mfpmath
11752 Generate floating point arithmetics for selected unit @var{unit}.  The choices
11753 for @var{unit} are:
11754
11755 @table @samp
11756 @item 387
11757 Use the standard 387 floating point coprocessor present majority of chips and
11758 emulated otherwise.  Code compiled with this option will run almost everywhere.
11759 The temporary results are computed in 80bit precision instead of precision
11760 specified by the type resulting in slightly different results compared to most
11761 of other chips.  See @option{-ffloat-store} for more detailed description.
11762
11763 This is the default choice for i386 compiler.
11764
11765 @item sse
11766 Use scalar floating point instructions present in the SSE instruction set.
11767 This instruction set is supported by Pentium3 and newer chips, in the AMD line
11768 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
11769 instruction set supports only single precision arithmetics, thus the double and
11770 extended precision arithmetics is still done using 387.  Later version, present
11771 only in Pentium4 and the future AMD x86-64 chips supports double precision
11772 arithmetics too.
11773
11774 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
11775 or @option{-msse2} switches to enable SSE extensions and make this option
11776 effective.  For the x86-64 compiler, these extensions are enabled by default.
11777
11778 The resulting code should be considerably faster in the majority of cases and avoid
11779 the numerical instability problems of 387 code, but may break some existing
11780 code that expects temporaries to be 80bit.
11781
11782 This is the default choice for the x86-64 compiler.
11783
11784 @item sse,387
11785 @itemx sse+387
11786 @itemx both
11787 Attempt to utilize both instruction sets at once.  This effectively double the
11788 amount of available registers and on chips with separate execution units for
11789 387 and SSE the execution resources too.  Use this option with care, as it is
11790 still experimental, because the GCC register allocator does not model separate
11791 functional units well resulting in instable performance.
11792 @end table
11793
11794 @item -masm=@var{dialect}
11795 @opindex masm=@var{dialect}
11796 Output asm instructions using selected @var{dialect}.  Supported
11797 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
11798 not support @samp{intel}.
11799
11800 @item -mieee-fp
11801 @itemx -mno-ieee-fp
11802 @opindex mieee-fp
11803 @opindex mno-ieee-fp
11804 Control whether or not the compiler uses IEEE floating point
11805 comparisons.  These handle correctly the case where the result of a
11806 comparison is unordered.
11807
11808 @item -msoft-float
11809 @opindex msoft-float
11810 Generate output containing library calls for floating point.
11811 @strong{Warning:} the requisite libraries are not part of GCC@.
11812 Normally the facilities of the machine's usual C compiler are used, but
11813 this can't be done directly in cross-compilation.  You must make your
11814 own arrangements to provide suitable library functions for
11815 cross-compilation.
11816
11817 On machines where a function returns floating point results in the 80387
11818 register stack, some floating point opcodes may be emitted even if
11819 @option{-msoft-float} is used.
11820
11821 @item -mno-fp-ret-in-387
11822 @opindex mno-fp-ret-in-387
11823 Do not use the FPU registers for return values of functions.
11824
11825 The usual calling convention has functions return values of types
11826 @code{float} and @code{double} in an FPU register, even if there
11827 is no FPU@.  The idea is that the operating system should emulate
11828 an FPU@.
11829
11830 The option @option{-mno-fp-ret-in-387} causes such values to be returned
11831 in ordinary CPU registers instead.
11832
11833 @item -mno-fancy-math-387
11834 @opindex mno-fancy-math-387
11835 Some 387 emulators do not support the @code{sin}, @code{cos} and
11836 @code{sqrt} instructions for the 387.  Specify this option to avoid
11837 generating those instructions.  This option is the default on FreeBSD,
11838 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
11839 indicates that the target cpu will always have an FPU and so the
11840 instruction will not need emulation.  As of revision 2.6.1, these
11841 instructions are not generated unless you also use the
11842 @option{-funsafe-math-optimizations} switch.
11843
11844 @item -malign-double
11845 @itemx -mno-align-double
11846 @opindex malign-double
11847 @opindex mno-align-double
11848 Control whether GCC aligns @code{double}, @code{long double}, and
11849 @code{long long} variables on a two word boundary or a one word
11850 boundary.  Aligning @code{double} variables on a two word boundary will
11851 produce code that runs somewhat faster on a @samp{Pentium} at the
11852 expense of more memory.
11853
11854 On x86-64, @option{-malign-double} is enabled by default.
11855
11856 @strong{Warning:} if you use the @option{-malign-double} switch,
11857 structures containing the above types will be aligned differently than
11858 the published application binary interface specifications for the 386
11859 and will not be binary compatible with structures in code compiled
11860 without that switch.
11861
11862 @item -m96bit-long-double
11863 @itemx -m128bit-long-double
11864 @opindex m96bit-long-double
11865 @opindex m128bit-long-double
11866 These switches control the size of @code{long double} type.  The i386
11867 application binary interface specifies the size to be 96 bits,
11868 so @option{-m96bit-long-double} is the default in 32 bit mode.
11869
11870 Modern architectures (Pentium and newer) would prefer @code{long double}
11871 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
11872 conforming to the ABI, this would not be possible.  So specifying a
11873 @option{-m128bit-long-double} will align @code{long double}
11874 to a 16 byte boundary by padding the @code{long double} with an additional
11875 32 bit zero.
11876
11877 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
11878 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
11879
11880 Notice that neither of these options enable any extra precision over the x87
11881 standard of 80 bits for a @code{long double}.
11882
11883 @strong{Warning:} if you override the default value for your target ABI, the
11884 structures and arrays containing @code{long double} variables will change
11885 their size as well as function calling convention for function taking
11886 @code{long double} will be modified.  Hence they will not be binary
11887 compatible with arrays or structures in code compiled without that switch.
11888
11889 @item -mlarge-data-threshold=@var{number}
11890 @opindex mlarge-data-threshold=@var{number}
11891 When @option{-mcmodel=medium} is specified, the data greater than
11892 @var{threshold} are placed in large data section.  This value must be the
11893 same across all object linked into the binary and defaults to 65535.
11894
11895 @item -mrtd
11896 @opindex mrtd
11897 Use a different function-calling convention, in which functions that
11898 take a fixed number of arguments return with the @code{ret} @var{num}
11899 instruction, which pops their arguments while returning.  This saves one
11900 instruction in the caller since there is no need to pop the arguments
11901 there.
11902
11903 You can specify that an individual function is called with this calling
11904 sequence with the function attribute @samp{stdcall}.  You can also
11905 override the @option{-mrtd} option by using the function attribute
11906 @samp{cdecl}.  @xref{Function Attributes}.
11907
11908 @strong{Warning:} this calling convention is incompatible with the one
11909 normally used on Unix, so you cannot use it if you need to call
11910 libraries compiled with the Unix compiler.
11911
11912 Also, you must provide function prototypes for all functions that
11913 take variable numbers of arguments (including @code{printf});
11914 otherwise incorrect code will be generated for calls to those
11915 functions.
11916
11917 In addition, seriously incorrect code will result if you call a
11918 function with too many arguments.  (Normally, extra arguments are
11919 harmlessly ignored.)
11920
11921 @item -mregparm=@var{num}
11922 @opindex mregparm
11923 Control how many registers are used to pass integer arguments.  By
11924 default, no registers are used to pass arguments, and at most 3
11925 registers can be used.  You can control this behavior for a specific
11926 function by using the function attribute @samp{regparm}.
11927 @xref{Function Attributes}.
11928
11929 @strong{Warning:} if you use this switch, and
11930 @var{num} is nonzero, then you must build all modules with the same
11931 value, including any libraries.  This includes the system libraries and
11932 startup modules.
11933
11934 @item -msseregparm
11935 @opindex msseregparm
11936 Use SSE register passing conventions for float and double arguments
11937 and return values.  You can control this behavior for a specific
11938 function by using the function attribute @samp{sseregparm}.
11939 @xref{Function Attributes}.
11940
11941 @strong{Warning:} if you use this switch then you must build all
11942 modules with the same value, including any libraries.  This includes
11943 the system libraries and startup modules.
11944
11945 @item -mpc32
11946 @itemx -mpc64
11947 @itemx -mpc80
11948 @opindex mpc32
11949 @opindex mpc64
11950 @opindex mpc80
11951
11952 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
11953 is specified, the significands of results of floating-point operations are
11954 rounded to 24 bits (single precision); @option{-mpc64} rounds the
11955 significands of results of floating-point operations to 53 bits (double
11956 precision) and @option{-mpc80} rounds the significands of results of
11957 floating-point operations to 64 bits (extended double precision), which is
11958 the default.  When this option is used, floating-point operations in higher
11959 precisions are not available to the programmer without setting the FPU
11960 control word explicitly.
11961
11962 Setting the rounding of floating-point operations to less than the default
11963 80 bits can speed some programs by 2% or more.  Note that some mathematical
11964 libraries assume that extended precision (80 bit) floating-point operations
11965 are enabled by default; routines in such libraries could suffer significant
11966 loss of accuracy, typically through so-called "catastrophic cancellation",
11967 when this option is used to set the precision to less than extended precision.
11968
11969 @item -mstackrealign
11970 @opindex mstackrealign
11971 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
11972 option will generate an alternate prologue and epilogue that realigns the
11973 runtime stack if necessary.  This supports mixing legacy codes that keep
11974 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
11975 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
11976 applicable to individual functions.
11977
11978 @item -mpreferred-stack-boundary=@var{num}
11979 @opindex mpreferred-stack-boundary
11980 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
11981 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
11982 the default is 4 (16 bytes or 128 bits).
11983
11984 @item -mincoming-stack-boundary=@var{num}
11985 @opindex mincoming-stack-boundary
11986 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
11987 boundary.  If @option{-mincoming-stack-boundary} is not specified,
11988 the one specified by @option{-mpreferred-stack-boundary} will be used.
11989
11990 On Pentium and PentiumPro, @code{double} and @code{long double} values
11991 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
11992 suffer significant run time performance penalties.  On Pentium III, the
11993 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
11994 properly if it is not 16 byte aligned.
11995
11996 To ensure proper alignment of this values on the stack, the stack boundary
11997 must be as aligned as that required by any value stored on the stack.
11998 Further, every function must be generated such that it keeps the stack
11999 aligned.  Thus calling a function compiled with a higher preferred
12000 stack boundary from a function compiled with a lower preferred stack
12001 boundary will most likely misalign the stack.  It is recommended that
12002 libraries that use callbacks always use the default setting.
12003
12004 This extra alignment does consume extra stack space, and generally
12005 increases code size.  Code that is sensitive to stack space usage, such
12006 as embedded systems and operating system kernels, may want to reduce the
12007 preferred alignment to @option{-mpreferred-stack-boundary=2}.
12008
12009 @item -mmmx
12010 @itemx -mno-mmx
12011 @itemx -msse
12012 @itemx -mno-sse
12013 @itemx -msse2
12014 @itemx -mno-sse2
12015 @itemx -msse3
12016 @itemx -mno-sse3
12017 @itemx -mssse3
12018 @itemx -mno-ssse3
12019 @itemx -msse4.1
12020 @itemx -mno-sse4.1
12021 @itemx -msse4.2
12022 @itemx -mno-sse4.2
12023 @itemx -msse4
12024 @itemx -mno-sse4
12025 @itemx -mavx
12026 @itemx -mno-avx
12027 @itemx -maes
12028 @itemx -mno-aes
12029 @itemx -mpclmul
12030 @itemx -mno-pclmul
12031 @itemx -msse4a
12032 @itemx -mno-sse4a
12033 @itemx -mfma4
12034 @itemx -mno-fma4
12035 @itemx -mxop
12036 @itemx -mno-xop
12037 @itemx -mlwp
12038 @itemx -mno-lwp
12039 @itemx -m3dnow
12040 @itemx -mno-3dnow
12041 @itemx -mpopcnt
12042 @itemx -mno-popcnt
12043 @itemx -mabm
12044 @itemx -mno-abm
12045 @opindex mmmx
12046 @opindex mno-mmx
12047 @opindex msse
12048 @opindex mno-sse
12049 @opindex m3dnow
12050 @opindex mno-3dnow
12051 These switches enable or disable the use of instructions in the MMX,
12052 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, SSE4A, FMA4, XOP,
12053 LWP, ABM or 3DNow!@: extended instruction sets.
12054 These extensions are also available as built-in functions: see
12055 @ref{X86 Built-in Functions}, for details of the functions enabled and
12056 disabled by these switches.
12057
12058 To have SSE/SSE2 instructions generated automatically from floating-point
12059 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
12060
12061 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
12062 generates new AVX instructions or AVX equivalence for all SSEx instructions
12063 when needed.
12064
12065 These options will enable GCC to use these extended instructions in
12066 generated code, even without @option{-mfpmath=sse}.  Applications which
12067 perform runtime CPU detection must compile separate files for each
12068 supported architecture, using the appropriate flags.  In particular,
12069 the file containing the CPU detection code should be compiled without
12070 these options.
12071
12072 @item -mfused-madd
12073 @itemx -mno-fused-madd
12074 @opindex mfused-madd
12075 @opindex mno-fused-madd
12076 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12077 instructions.  The default is to use these instructions.
12078
12079 @item -mcld
12080 @opindex mcld
12081 This option instructs GCC to emit a @code{cld} instruction in the prologue
12082 of functions that use string instructions.  String instructions depend on
12083 the DF flag to select between autoincrement or autodecrement mode.  While the
12084 ABI specifies the DF flag to be cleared on function entry, some operating
12085 systems violate this specification by not clearing the DF flag in their
12086 exception dispatchers.  The exception handler can be invoked with the DF flag
12087 set which leads to wrong direction mode, when string instructions are used.
12088 This option can be enabled by default on 32-bit x86 targets by configuring
12089 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
12090 instructions can be suppressed with the @option{-mno-cld} compiler option
12091 in this case.
12092
12093 @item -mcx16
12094 @opindex mcx16
12095 This option will enable GCC to use CMPXCHG16B instruction in generated code.
12096 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
12097 data types.  This is useful for high resolution counters that could be updated
12098 by multiple processors (or cores).  This instruction is generated as part of
12099 atomic built-in functions: see @ref{Atomic Builtins} for details.
12100
12101 @item -msahf
12102 @opindex msahf
12103 This option will enable GCC to use SAHF instruction in generated 64-bit code.
12104 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
12105 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
12106 SAHF are load and store instructions, respectively, for certain status flags.
12107 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
12108 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
12109
12110 @item -mmovbe
12111 @opindex mmovbe
12112 This option will enable GCC to use movbe instruction to implement
12113 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
12114
12115 @item -mcrc32
12116 @opindex mcrc32
12117 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
12118 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
12119 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
12120
12121 @item -mrecip
12122 @opindex mrecip
12123 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
12124 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
12125 to increase precision instead of DIVSS and SQRTSS (and their vectorized
12126 variants) for single precision floating point arguments.  These instructions
12127 are generated only when @option{-funsafe-math-optimizations} is enabled
12128 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
12129 Note that while the throughput of the sequence is higher than the throughput
12130 of the non-reciprocal instruction, the precision of the sequence can be
12131 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
12132
12133 Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
12134 already with @option{-ffast-math} (or the above option combination), and
12135 doesn't need @option{-mrecip}.
12136
12137 @item -mveclibabi=@var{type}
12138 @opindex mveclibabi
12139 Specifies the ABI type to use for vectorizing intrinsics using an
12140 external library.  Supported types are @code{svml} for the Intel short
12141 vector math library and @code{acml} for the AMD math core library style
12142 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
12143 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
12144 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
12145 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
12146 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
12147 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
12148 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
12149 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
12150 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
12151 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
12152 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
12153 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
12154 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
12155 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
12156 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
12157 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
12158 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
12159 compatible library will have to be specified at link time.
12160
12161 @item -mabi=@var{name}
12162 @opindex mabi
12163 Generate code for the specified calling convention.  Permissible values
12164 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
12165 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
12166 ABI when targeting Windows.  On all other systems, the default is the
12167 SYSV ABI.  You can control this behavior for a specific function by
12168 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
12169 @xref{Function Attributes}.
12170
12171 @item -mpush-args
12172 @itemx -mno-push-args
12173 @opindex mpush-args
12174 @opindex mno-push-args
12175 Use PUSH operations to store outgoing parameters.  This method is shorter
12176 and usually equally fast as method using SUB/MOV operations and is enabled
12177 by default.  In some cases disabling it may improve performance because of
12178 improved scheduling and reduced dependencies.
12179
12180 @item -maccumulate-outgoing-args
12181 @opindex maccumulate-outgoing-args
12182 If enabled, the maximum amount of space required for outgoing arguments will be
12183 computed in the function prologue.  This is faster on most modern CPUs
12184 because of reduced dependencies, improved scheduling and reduced stack usage
12185 when preferred stack boundary is not equal to 2.  The drawback is a notable
12186 increase in code size.  This switch implies @option{-mno-push-args}.
12187
12188 @item -mthreads
12189 @opindex mthreads
12190 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
12191 on thread-safe exception handling must compile and link all code with the
12192 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
12193 @option{-D_MT}; when linking, it links in a special thread helper library
12194 @option{-lmingwthrd} which cleans up per thread exception handling data.
12195
12196 @item -mno-align-stringops
12197 @opindex mno-align-stringops
12198 Do not align destination of inlined string operations.  This switch reduces
12199 code size and improves performance in case the destination is already aligned,
12200 but GCC doesn't know about it.
12201
12202 @item -minline-all-stringops
12203 @opindex minline-all-stringops
12204 By default GCC inlines string operations only when destination is known to be
12205 aligned at least to 4 byte boundary.  This enables more inlining, increase code
12206 size, but may improve performance of code that depends on fast memcpy, strlen
12207 and memset for short lengths.
12208
12209 @item -minline-stringops-dynamically
12210 @opindex minline-stringops-dynamically
12211 For string operation of unknown size, inline runtime checks so for small
12212 blocks inline code is used, while for large blocks library call is used.
12213
12214 @item -mstringop-strategy=@var{alg}
12215 @opindex mstringop-strategy=@var{alg}
12216 Overwrite internal decision heuristic about particular algorithm to inline
12217 string operation with.  The allowed values are @code{rep_byte},
12218 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
12219 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
12220 expanding inline loop, @code{libcall} for always expanding library call.
12221
12222 @item -momit-leaf-frame-pointer
12223 @opindex momit-leaf-frame-pointer
12224 Don't keep the frame pointer in a register for leaf functions.  This
12225 avoids the instructions to save, set up and restore frame pointers and
12226 makes an extra register available in leaf functions.  The option
12227 @option{-fomit-frame-pointer} removes the frame pointer for all functions
12228 which might make debugging harder.
12229
12230 @item -mtls-direct-seg-refs
12231 @itemx -mno-tls-direct-seg-refs
12232 @opindex mtls-direct-seg-refs
12233 Controls whether TLS variables may be accessed with offsets from the
12234 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
12235 or whether the thread base pointer must be added.  Whether or not this
12236 is legal depends on the operating system, and whether it maps the
12237 segment to cover the entire TLS area.
12238
12239 For systems that use GNU libc, the default is on.
12240
12241 @item -msse2avx
12242 @itemx -mno-sse2avx
12243 @opindex msse2avx
12244 Specify that the assembler should encode SSE instructions with VEX
12245 prefix.  The option @option{-mavx} turns this on by default.
12246 @end table
12247
12248 These @samp{-m} switches are supported in addition to the above
12249 on AMD x86-64 processors in 64-bit environments.
12250
12251 @table @gcctabopt
12252 @item -m32
12253 @itemx -m64
12254 @opindex m32
12255 @opindex m64
12256 Generate code for a 32-bit or 64-bit environment.
12257 The 32-bit environment sets int, long and pointer to 32 bits and
12258 generates code that runs on any i386 system.
12259 The 64-bit environment sets int to 32 bits and long and pointer
12260 to 64 bits and generates code for AMD's x86-64 architecture. For
12261 darwin only the -m64 option turns off the @option{-fno-pic} and
12262 @option{-mdynamic-no-pic} options.
12263
12264 @item -mno-red-zone
12265 @opindex mno-red-zone
12266 Do not use a so called red zone for x86-64 code.  The red zone is mandated
12267 by the x86-64 ABI, it is a 128-byte area beyond the location of the
12268 stack pointer that will not be modified by signal or interrupt handlers
12269 and therefore can be used for temporary data without adjusting the stack
12270 pointer.  The flag @option{-mno-red-zone} disables this red zone.
12271
12272 @item -mcmodel=small
12273 @opindex mcmodel=small
12274 Generate code for the small code model: the program and its symbols must
12275 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
12276 Programs can be statically or dynamically linked.  This is the default
12277 code model.
12278
12279 @item -mcmodel=kernel
12280 @opindex mcmodel=kernel
12281 Generate code for the kernel code model.  The kernel runs in the
12282 negative 2 GB of the address space.
12283 This model has to be used for Linux kernel code.
12284
12285 @item -mcmodel=medium
12286 @opindex mcmodel=medium
12287 Generate code for the medium model: The program is linked in the lower 2
12288 GB of the address space.  Small symbols are also placed there.  Symbols
12289 with sizes larger than @option{-mlarge-data-threshold} are put into
12290 large data or bss sections and can be located above 2GB.  Programs can
12291 be statically or dynamically linked.
12292
12293 @item -mcmodel=large
12294 @opindex mcmodel=large
12295 Generate code for the large model: This model makes no assumptions
12296 about addresses and sizes of sections.
12297 @end table
12298
12299 @node IA-64 Options
12300 @subsection IA-64 Options
12301 @cindex IA-64 Options
12302
12303 These are the @samp{-m} options defined for the Intel IA-64 architecture.
12304
12305 @table @gcctabopt
12306 @item -mbig-endian
12307 @opindex mbig-endian
12308 Generate code for a big endian target.  This is the default for HP-UX@.
12309
12310 @item -mlittle-endian
12311 @opindex mlittle-endian
12312 Generate code for a little endian target.  This is the default for AIX5
12313 and GNU/Linux.
12314
12315 @item -mgnu-as
12316 @itemx -mno-gnu-as
12317 @opindex mgnu-as
12318 @opindex mno-gnu-as
12319 Generate (or don't) code for the GNU assembler.  This is the default.
12320 @c Also, this is the default if the configure option @option{--with-gnu-as}
12321 @c is used.
12322
12323 @item -mgnu-ld
12324 @itemx -mno-gnu-ld
12325 @opindex mgnu-ld
12326 @opindex mno-gnu-ld
12327 Generate (or don't) code for the GNU linker.  This is the default.
12328 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12329 @c is used.
12330
12331 @item -mno-pic
12332 @opindex mno-pic
12333 Generate code that does not use a global pointer register.  The result
12334 is not position independent code, and violates the IA-64 ABI@.
12335
12336 @item -mvolatile-asm-stop
12337 @itemx -mno-volatile-asm-stop
12338 @opindex mvolatile-asm-stop
12339 @opindex mno-volatile-asm-stop
12340 Generate (or don't) a stop bit immediately before and after volatile asm
12341 statements.
12342
12343 @item -mregister-names
12344 @itemx -mno-register-names
12345 @opindex mregister-names
12346 @opindex mno-register-names
12347 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
12348 the stacked registers.  This may make assembler output more readable.
12349
12350 @item -mno-sdata
12351 @itemx -msdata
12352 @opindex mno-sdata
12353 @opindex msdata
12354 Disable (or enable) optimizations that use the small data section.  This may
12355 be useful for working around optimizer bugs.
12356
12357 @item -mconstant-gp
12358 @opindex mconstant-gp
12359 Generate code that uses a single constant global pointer value.  This is
12360 useful when compiling kernel code.
12361
12362 @item -mauto-pic
12363 @opindex mauto-pic
12364 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
12365 This is useful when compiling firmware code.
12366
12367 @item -minline-float-divide-min-latency
12368 @opindex minline-float-divide-min-latency
12369 Generate code for inline divides of floating point values
12370 using the minimum latency algorithm.
12371
12372 @item -minline-float-divide-max-throughput
12373 @opindex minline-float-divide-max-throughput
12374 Generate code for inline divides of floating point values
12375 using the maximum throughput algorithm.
12376
12377 @item -mno-inline-float-divide
12378 @opindex mno-inline-float-divide
12379 Do not generate inline code for divides of floating point values.
12380
12381 @item -minline-int-divide-min-latency
12382 @opindex minline-int-divide-min-latency
12383 Generate code for inline divides of integer values
12384 using the minimum latency algorithm.
12385
12386 @item -minline-int-divide-max-throughput
12387 @opindex minline-int-divide-max-throughput
12388 Generate code for inline divides of integer values
12389 using the maximum throughput algorithm.
12390
12391 @item -mno-inline-int-divide
12392 @opindex mno-inline-int-divide
12393 Do not generate inline code for divides of integer values.
12394
12395 @item -minline-sqrt-min-latency
12396 @opindex minline-sqrt-min-latency
12397 Generate code for inline square roots
12398 using the minimum latency algorithm.
12399
12400 @item -minline-sqrt-max-throughput
12401 @opindex minline-sqrt-max-throughput
12402 Generate code for inline square roots
12403 using the maximum throughput algorithm.
12404
12405 @item -mno-inline-sqrt
12406 @opindex mno-inline-sqrt
12407 Do not generate inline code for sqrt.
12408
12409 @item -mfused-madd
12410 @itemx -mno-fused-madd
12411 @opindex mfused-madd
12412 @opindex mno-fused-madd
12413 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12414 instructions.  The default is to use these instructions.
12415
12416 @item -mno-dwarf2-asm
12417 @itemx -mdwarf2-asm
12418 @opindex mno-dwarf2-asm
12419 @opindex mdwarf2-asm
12420 Don't (or do) generate assembler code for the DWARF2 line number debugging
12421 info.  This may be useful when not using the GNU assembler.
12422
12423 @item -mearly-stop-bits
12424 @itemx -mno-early-stop-bits
12425 @opindex mearly-stop-bits
12426 @opindex mno-early-stop-bits
12427 Allow stop bits to be placed earlier than immediately preceding the
12428 instruction that triggered the stop bit.  This can improve instruction
12429 scheduling, but does not always do so.
12430
12431 @item -mfixed-range=@var{register-range}
12432 @opindex mfixed-range
12433 Generate code treating the given register range as fixed registers.
12434 A fixed register is one that the register allocator can not use.  This is
12435 useful when compiling kernel code.  A register range is specified as
12436 two registers separated by a dash.  Multiple register ranges can be
12437 specified separated by a comma.
12438
12439 @item -mtls-size=@var{tls-size}
12440 @opindex mtls-size
12441 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
12442 64.
12443
12444 @item -mtune=@var{cpu-type}
12445 @opindex mtune
12446 Tune the instruction scheduling for a particular CPU, Valid values are
12447 itanium, itanium1, merced, itanium2, and mckinley.
12448
12449 @item -milp32
12450 @itemx -mlp64
12451 @opindex milp32
12452 @opindex mlp64
12453 Generate code for a 32-bit or 64-bit environment.
12454 The 32-bit environment sets int, long and pointer to 32 bits.
12455 The 64-bit environment sets int to 32 bits and long and pointer
12456 to 64 bits.  These are HP-UX specific flags.
12457
12458 @item -mno-sched-br-data-spec
12459 @itemx -msched-br-data-spec
12460 @opindex mno-sched-br-data-spec
12461 @opindex msched-br-data-spec
12462 (Dis/En)able data speculative scheduling before reload.
12463 This will result in generation of the ld.a instructions and
12464 the corresponding check instructions (ld.c / chk.a).
12465 The default is 'disable'.
12466
12467 @item -msched-ar-data-spec
12468 @itemx -mno-sched-ar-data-spec
12469 @opindex msched-ar-data-spec
12470 @opindex mno-sched-ar-data-spec
12471 (En/Dis)able data speculative scheduling after reload.
12472 This will result in generation of the ld.a instructions and
12473 the corresponding check instructions (ld.c / chk.a).
12474 The default is 'enable'.
12475
12476 @item -mno-sched-control-spec
12477 @itemx -msched-control-spec
12478 @opindex mno-sched-control-spec
12479 @opindex msched-control-spec
12480 (Dis/En)able control speculative scheduling.  This feature is
12481 available only during region scheduling (i.e.@: before reload).
12482 This will result in generation of the ld.s instructions and
12483 the corresponding check instructions chk.s .
12484 The default is 'disable'.
12485
12486 @item -msched-br-in-data-spec
12487 @itemx -mno-sched-br-in-data-spec
12488 @opindex msched-br-in-data-spec
12489 @opindex mno-sched-br-in-data-spec
12490 (En/Dis)able speculative scheduling of the instructions that
12491 are dependent on the data speculative loads before reload.
12492 This is effective only with @option{-msched-br-data-spec} enabled.
12493 The default is 'enable'.
12494
12495 @item -msched-ar-in-data-spec
12496 @itemx -mno-sched-ar-in-data-spec
12497 @opindex msched-ar-in-data-spec
12498 @opindex mno-sched-ar-in-data-spec
12499 (En/Dis)able speculative scheduling of the instructions that
12500 are dependent on the data speculative loads after reload.
12501 This is effective only with @option{-msched-ar-data-spec} enabled.
12502 The default is 'enable'.
12503
12504 @item -msched-in-control-spec
12505 @itemx -mno-sched-in-control-spec
12506 @opindex msched-in-control-spec
12507 @opindex mno-sched-in-control-spec
12508 (En/Dis)able speculative scheduling of the instructions that
12509 are dependent on the control speculative loads.
12510 This is effective only with @option{-msched-control-spec} enabled.
12511 The default is 'enable'.
12512
12513 @item -mno-sched-prefer-non-data-spec-insns
12514 @itemx -msched-prefer-non-data-spec-insns
12515 @opindex mno-sched-prefer-non-data-spec-insns
12516 @opindex msched-prefer-non-data-spec-insns
12517 If enabled, data speculative instructions will be chosen for schedule
12518 only if there are no other choices at the moment.  This will make
12519 the use of the data speculation much more conservative.
12520 The default is 'disable'.
12521
12522 @item -mno-sched-prefer-non-control-spec-insns
12523 @itemx -msched-prefer-non-control-spec-insns
12524 @opindex mno-sched-prefer-non-control-spec-insns
12525 @opindex msched-prefer-non-control-spec-insns
12526 If enabled, control speculative instructions will be chosen for schedule
12527 only if there are no other choices at the moment.  This will make
12528 the use of the control speculation much more conservative.
12529 The default is 'disable'.
12530
12531 @item -mno-sched-count-spec-in-critical-path
12532 @itemx -msched-count-spec-in-critical-path
12533 @opindex mno-sched-count-spec-in-critical-path
12534 @opindex msched-count-spec-in-critical-path
12535 If enabled, speculative dependencies will be considered during
12536 computation of the instructions priorities.  This will make the use of the
12537 speculation a bit more conservative.
12538 The default is 'disable'.
12539
12540 @item -msched-spec-ldc
12541 @opindex msched-spec-ldc
12542 Use a simple data speculation check.  This option is on by default.
12543
12544 @item -msched-control-spec-ldc
12545 @opindex msched-spec-ldc
12546 Use a simple check for control speculation.  This option is on by default.
12547
12548 @item -msched-stop-bits-after-every-cycle
12549 @opindex msched-stop-bits-after-every-cycle
12550 Place a stop bit after every cycle when scheduling.  This option is on
12551 by default.
12552
12553 @item -msched-fp-mem-deps-zero-cost
12554 @opindex msched-fp-mem-deps-zero-cost
12555 Assume that floating-point stores and loads are not likely to cause a conflict
12556 when placed into the same instruction group.  This option is disabled by
12557 default.
12558
12559 @item -msel-sched-dont-check-control-spec
12560 @opindex msel-sched-dont-check-control-spec
12561 Generate checks for control speculation in selective scheduling.
12562 This flag is disabled by default.
12563
12564 @item -msched-max-memory-insns=@var{max-insns}
12565 @opindex msched-max-memory-insns
12566 Limit on the number of memory insns per instruction group, giving lower
12567 priority to subsequent memory insns attempting to schedule in the same
12568 instruction group. Frequently useful to prevent cache bank conflicts.
12569 The default value is 1.
12570
12571 @item -msched-max-memory-insns-hard-limit
12572 @opindex msched-max-memory-insns-hard-limit
12573 Disallow more than `msched-max-memory-insns' in instruction group.
12574 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
12575 when limit is reached but may still schedule memory operations.
12576
12577 @end table
12578
12579 @node IA-64/VMS Options
12580 @subsection IA-64/VMS Options
12581
12582 These @samp{-m} options are defined for the IA-64/VMS implementations:
12583
12584 @table @gcctabopt
12585 @item -mvms-return-codes
12586 @opindex mvms-return-codes
12587 Return VMS condition codes from main. The default is to return POSIX
12588 style condition (e.g.@ error) codes.
12589
12590 @item -mdebug-main=@var{prefix}
12591 @opindex mdebug-main=@var{prefix}
12592 Flag the first routine whose name starts with @var{prefix} as the main
12593 routine for the debugger.
12594
12595 @item -mmalloc64
12596 @opindex mmalloc64
12597 Default to 64bit memory allocation routines.
12598 @end table
12599
12600 @node LM32 Options
12601 @subsection LM32 Options
12602 @cindex LM32 options
12603
12604 These @option{-m} options are defined for the Lattice Mico32 architecture:
12605
12606 @table @gcctabopt
12607 @item -mbarrel-shift-enabled
12608 @opindex mbarrel-shift-enabled
12609 Enable barrel-shift instructions.
12610
12611 @item -mdivide-enabled
12612 @opindex mdivide-enabled
12613 Enable divide and modulus instructions.
12614
12615 @item -mmultiply-enabled
12616 @opindex multiply-enabled
12617 Enable multiply instructions.
12618
12619 @item -msign-extend-enabled
12620 @opindex msign-extend-enabled
12621 Enable sign extend instructions.
12622
12623 @item -muser-enabled
12624 @opindex muser-enabled
12625 Enable user-defined instructions.
12626
12627 @end table
12628
12629 @node M32C Options
12630 @subsection M32C Options
12631 @cindex M32C options
12632
12633 @table @gcctabopt
12634 @item -mcpu=@var{name}
12635 @opindex mcpu=
12636 Select the CPU for which code is generated.  @var{name} may be one of
12637 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
12638 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
12639 the M32C/80 series.
12640
12641 @item -msim
12642 @opindex msim
12643 Specifies that the program will be run on the simulator.  This causes
12644 an alternate runtime library to be linked in which supports, for
12645 example, file I/O@.  You must not use this option when generating
12646 programs that will run on real hardware; you must provide your own
12647 runtime library for whatever I/O functions are needed.
12648
12649 @item -memregs=@var{number}
12650 @opindex memregs=
12651 Specifies the number of memory-based pseudo-registers GCC will use
12652 during code generation.  These pseudo-registers will be used like real
12653 registers, so there is a tradeoff between GCC's ability to fit the
12654 code into available registers, and the performance penalty of using
12655 memory instead of registers.  Note that all modules in a program must
12656 be compiled with the same value for this option.  Because of that, you
12657 must not use this option with the default runtime libraries gcc
12658 builds.
12659
12660 @end table
12661
12662 @node M32R/D Options
12663 @subsection M32R/D Options
12664 @cindex M32R/D options
12665
12666 These @option{-m} options are defined for Renesas M32R/D architectures:
12667
12668 @table @gcctabopt
12669 @item -m32r2
12670 @opindex m32r2
12671 Generate code for the M32R/2@.
12672
12673 @item -m32rx
12674 @opindex m32rx
12675 Generate code for the M32R/X@.
12676
12677 @item -m32r
12678 @opindex m32r
12679 Generate code for the M32R@.  This is the default.
12680
12681 @item -mmodel=small
12682 @opindex mmodel=small
12683 Assume all objects live in the lower 16MB of memory (so that their addresses
12684 can be loaded with the @code{ld24} instruction), and assume all subroutines
12685 are reachable with the @code{bl} instruction.
12686 This is the default.
12687
12688 The addressability of a particular object can be set with the
12689 @code{model} attribute.
12690
12691 @item -mmodel=medium
12692 @opindex mmodel=medium
12693 Assume objects may be anywhere in the 32-bit address space (the compiler
12694 will generate @code{seth/add3} instructions to load their addresses), and
12695 assume all subroutines are reachable with the @code{bl} instruction.
12696
12697 @item -mmodel=large
12698 @opindex mmodel=large
12699 Assume objects may be anywhere in the 32-bit address space (the compiler
12700 will generate @code{seth/add3} instructions to load their addresses), and
12701 assume subroutines may not be reachable with the @code{bl} instruction
12702 (the compiler will generate the much slower @code{seth/add3/jl}
12703 instruction sequence).
12704
12705 @item -msdata=none
12706 @opindex msdata=none
12707 Disable use of the small data area.  Variables will be put into
12708 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
12709 @code{section} attribute has been specified).
12710 This is the default.
12711
12712 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
12713 Objects may be explicitly put in the small data area with the
12714 @code{section} attribute using one of these sections.
12715
12716 @item -msdata=sdata
12717 @opindex msdata=sdata
12718 Put small global and static data in the small data area, but do not
12719 generate special code to reference them.
12720
12721 @item -msdata=use
12722 @opindex msdata=use
12723 Put small global and static data in the small data area, and generate
12724 special instructions to reference them.
12725
12726 @item -G @var{num}
12727 @opindex G
12728 @cindex smaller data references
12729 Put global and static objects less than or equal to @var{num} bytes
12730 into the small data or bss sections instead of the normal data or bss
12731 sections.  The default value of @var{num} is 8.
12732 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
12733 for this option to have any effect.
12734
12735 All modules should be compiled with the same @option{-G @var{num}} value.
12736 Compiling with different values of @var{num} may or may not work; if it
12737 doesn't the linker will give an error message---incorrect code will not be
12738 generated.
12739
12740 @item -mdebug
12741 @opindex mdebug
12742 Makes the M32R specific code in the compiler display some statistics
12743 that might help in debugging programs.
12744
12745 @item -malign-loops
12746 @opindex malign-loops
12747 Align all loops to a 32-byte boundary.
12748
12749 @item -mno-align-loops
12750 @opindex mno-align-loops
12751 Do not enforce a 32-byte alignment for loops.  This is the default.
12752
12753 @item -missue-rate=@var{number}
12754 @opindex missue-rate=@var{number}
12755 Issue @var{number} instructions per cycle.  @var{number} can only be 1
12756 or 2.
12757
12758 @item -mbranch-cost=@var{number}
12759 @opindex mbranch-cost=@var{number}
12760 @var{number} can only be 1 or 2.  If it is 1 then branches will be
12761 preferred over conditional code, if it is 2, then the opposite will
12762 apply.
12763
12764 @item -mflush-trap=@var{number}
12765 @opindex mflush-trap=@var{number}
12766 Specifies the trap number to use to flush the cache.  The default is
12767 12.  Valid numbers are between 0 and 15 inclusive.
12768
12769 @item -mno-flush-trap
12770 @opindex mno-flush-trap
12771 Specifies that the cache cannot be flushed by using a trap.
12772
12773 @item -mflush-func=@var{name}
12774 @opindex mflush-func=@var{name}
12775 Specifies the name of the operating system function to call to flush
12776 the cache.  The default is @emph{_flush_cache}, but a function call
12777 will only be used if a trap is not available.
12778
12779 @item -mno-flush-func
12780 @opindex mno-flush-func
12781 Indicates that there is no OS function for flushing the cache.
12782
12783 @end table
12784
12785 @node M680x0 Options
12786 @subsection M680x0 Options
12787 @cindex M680x0 options
12788
12789 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
12790 The default settings depend on which architecture was selected when
12791 the compiler was configured; the defaults for the most common choices
12792 are given below.
12793
12794 @table @gcctabopt
12795 @item -march=@var{arch}
12796 @opindex march
12797 Generate code for a specific M680x0 or ColdFire instruction set
12798 architecture.  Permissible values of @var{arch} for M680x0
12799 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
12800 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
12801 architectures are selected according to Freescale's ISA classification
12802 and the permissible values are: @samp{isaa}, @samp{isaaplus},
12803 @samp{isab} and @samp{isac}.
12804
12805 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
12806 code for a ColdFire target.  The @var{arch} in this macro is one of the
12807 @option{-march} arguments given above.
12808
12809 When used together, @option{-march} and @option{-mtune} select code
12810 that runs on a family of similar processors but that is optimized
12811 for a particular microarchitecture.
12812
12813 @item -mcpu=@var{cpu}
12814 @opindex mcpu
12815 Generate code for a specific M680x0 or ColdFire processor.
12816 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
12817 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
12818 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
12819 below, which also classifies the CPUs into families:
12820
12821 @multitable @columnfractions 0.20 0.80
12822 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
12823 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
12824 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
12825 @item @samp{5206e} @tab @samp{5206e}
12826 @item @samp{5208} @tab @samp{5207} @samp{5208}
12827 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
12828 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
12829 @item @samp{5216} @tab @samp{5214} @samp{5216}
12830 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
12831 @item @samp{5225} @tab @samp{5224} @samp{5225}
12832 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
12833 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
12834 @item @samp{5249} @tab @samp{5249}
12835 @item @samp{5250} @tab @samp{5250}
12836 @item @samp{5271} @tab @samp{5270} @samp{5271}
12837 @item @samp{5272} @tab @samp{5272}
12838 @item @samp{5275} @tab @samp{5274} @samp{5275}
12839 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
12840 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
12841 @item @samp{5307} @tab @samp{5307}
12842 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
12843 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
12844 @item @samp{5407} @tab @samp{5407}
12845 @item @samp{5475} @tab @samp{5470} @samp{5471} @samp{5472} @samp{5473} @samp{5474} @samp{5475} @samp{547x} @samp{5480} @samp{5481} @samp{5482} @samp{5483} @samp{5484} @samp{5485}
12846 @end multitable
12847
12848 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
12849 @var{arch} is compatible with @var{cpu}.  Other combinations of
12850 @option{-mcpu} and @option{-march} are rejected.
12851
12852 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
12853 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
12854 where the value of @var{family} is given by the table above.
12855
12856 @item -mtune=@var{tune}
12857 @opindex mtune
12858 Tune the code for a particular microarchitecture, within the
12859 constraints set by @option{-march} and @option{-mcpu}.
12860 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
12861 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
12862 and @samp{cpu32}.  The ColdFire microarchitectures
12863 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
12864
12865 You can also use @option{-mtune=68020-40} for code that needs
12866 to run relatively well on 68020, 68030 and 68040 targets.
12867 @option{-mtune=68020-60} is similar but includes 68060 targets
12868 as well.  These two options select the same tuning decisions as
12869 @option{-m68020-40} and @option{-m68020-60} respectively.
12870
12871 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
12872 when tuning for 680x0 architecture @var{arch}.  It also defines
12873 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
12874 option is used.  If gcc is tuning for a range of architectures,
12875 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
12876 it defines the macros for every architecture in the range.
12877
12878 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
12879 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
12880 of the arguments given above.
12881
12882 @item -m68000
12883 @itemx -mc68000
12884 @opindex m68000
12885 @opindex mc68000
12886 Generate output for a 68000.  This is the default
12887 when the compiler is configured for 68000-based systems.
12888 It is equivalent to @option{-march=68000}.
12889
12890 Use this option for microcontrollers with a 68000 or EC000 core,
12891 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
12892
12893 @item -m68010
12894 @opindex m68010
12895 Generate output for a 68010.  This is the default
12896 when the compiler is configured for 68010-based systems.
12897 It is equivalent to @option{-march=68010}.
12898
12899 @item -m68020
12900 @itemx -mc68020
12901 @opindex m68020
12902 @opindex mc68020
12903 Generate output for a 68020.  This is the default
12904 when the compiler is configured for 68020-based systems.
12905 It is equivalent to @option{-march=68020}.
12906
12907 @item -m68030
12908 @opindex m68030
12909 Generate output for a 68030.  This is the default when the compiler is
12910 configured for 68030-based systems.  It is equivalent to
12911 @option{-march=68030}.
12912
12913 @item -m68040
12914 @opindex m68040
12915 Generate output for a 68040.  This is the default when the compiler is
12916 configured for 68040-based systems.  It is equivalent to
12917 @option{-march=68040}.
12918
12919 This option inhibits the use of 68881/68882 instructions that have to be
12920 emulated by software on the 68040.  Use this option if your 68040 does not
12921 have code to emulate those instructions.
12922
12923 @item -m68060
12924 @opindex m68060
12925 Generate output for a 68060.  This is the default when the compiler is
12926 configured for 68060-based systems.  It is equivalent to
12927 @option{-march=68060}.
12928
12929 This option inhibits the use of 68020 and 68881/68882 instructions that
12930 have to be emulated by software on the 68060.  Use this option if your 68060
12931 does not have code to emulate those instructions.
12932
12933 @item -mcpu32
12934 @opindex mcpu32
12935 Generate output for a CPU32.  This is the default
12936 when the compiler is configured for CPU32-based systems.
12937 It is equivalent to @option{-march=cpu32}.
12938
12939 Use this option for microcontrollers with a
12940 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
12941 68336, 68340, 68341, 68349 and 68360.
12942
12943 @item -m5200
12944 @opindex m5200
12945 Generate output for a 520X ColdFire CPU@.  This is the default
12946 when the compiler is configured for 520X-based systems.
12947 It is equivalent to @option{-mcpu=5206}, and is now deprecated
12948 in favor of that option.
12949
12950 Use this option for microcontroller with a 5200 core, including
12951 the MCF5202, MCF5203, MCF5204 and MCF5206.
12952
12953 @item -m5206e
12954 @opindex m5206e
12955 Generate output for a 5206e ColdFire CPU@.  The option is now
12956 deprecated in favor of the equivalent @option{-mcpu=5206e}.
12957
12958 @item -m528x
12959 @opindex m528x
12960 Generate output for a member of the ColdFire 528X family.
12961 The option is now deprecated in favor of the equivalent
12962 @option{-mcpu=528x}.
12963
12964 @item -m5307
12965 @opindex m5307
12966 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
12967 in favor of the equivalent @option{-mcpu=5307}.
12968
12969 @item -m5407
12970 @opindex m5407
12971 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
12972 in favor of the equivalent @option{-mcpu=5407}.
12973
12974 @item -mcfv4e
12975 @opindex mcfv4e
12976 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
12977 This includes use of hardware floating point instructions.
12978 The option is equivalent to @option{-mcpu=547x}, and is now
12979 deprecated in favor of that option.
12980
12981 @item -m68020-40
12982 @opindex m68020-40
12983 Generate output for a 68040, without using any of the new instructions.
12984 This results in code which can run relatively efficiently on either a
12985 68020/68881 or a 68030 or a 68040.  The generated code does use the
12986 68881 instructions that are emulated on the 68040.
12987
12988 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
12989
12990 @item -m68020-60
12991 @opindex m68020-60
12992 Generate output for a 68060, without using any of the new instructions.
12993 This results in code which can run relatively efficiently on either a
12994 68020/68881 or a 68030 or a 68040.  The generated code does use the
12995 68881 instructions that are emulated on the 68060.
12996
12997 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
12998
12999 @item -mhard-float
13000 @itemx -m68881
13001 @opindex mhard-float
13002 @opindex m68881
13003 Generate floating-point instructions.  This is the default for 68020
13004 and above, and for ColdFire devices that have an FPU@.  It defines the
13005 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
13006 on ColdFire targets.
13007
13008 @item -msoft-float
13009 @opindex msoft-float
13010 Do not generate floating-point instructions; use library calls instead.
13011 This is the default for 68000, 68010, and 68832 targets.  It is also
13012 the default for ColdFire devices that have no FPU.
13013
13014 @item -mdiv
13015 @itemx -mno-div
13016 @opindex mdiv
13017 @opindex mno-div
13018 Generate (do not generate) ColdFire hardware divide and remainder
13019 instructions.  If @option{-march} is used without @option{-mcpu},
13020 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
13021 architectures.  Otherwise, the default is taken from the target CPU
13022 (either the default CPU, or the one specified by @option{-mcpu}).  For
13023 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
13024 @option{-mcpu=5206e}.
13025
13026 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
13027
13028 @item -mshort
13029 @opindex mshort
13030 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13031 Additionally, parameters passed on the stack are also aligned to a
13032 16-bit boundary even on targets whose API mandates promotion to 32-bit.
13033
13034 @item -mno-short
13035 @opindex mno-short
13036 Do not consider type @code{int} to be 16 bits wide.  This is the default.
13037
13038 @item -mnobitfield
13039 @itemx -mno-bitfield
13040 @opindex mnobitfield
13041 @opindex mno-bitfield
13042 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
13043 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
13044
13045 @item -mbitfield
13046 @opindex mbitfield
13047 Do use the bit-field instructions.  The @option{-m68020} option implies
13048 @option{-mbitfield}.  This is the default if you use a configuration
13049 designed for a 68020.
13050
13051 @item -mrtd
13052 @opindex mrtd
13053 Use a different function-calling convention, in which functions
13054 that take a fixed number of arguments return with the @code{rtd}
13055 instruction, which pops their arguments while returning.  This
13056 saves one instruction in the caller since there is no need to pop
13057 the arguments there.
13058
13059 This calling convention is incompatible with the one normally
13060 used on Unix, so you cannot use it if you need to call libraries
13061 compiled with the Unix compiler.
13062
13063 Also, you must provide function prototypes for all functions that
13064 take variable numbers of arguments (including @code{printf});
13065 otherwise incorrect code will be generated for calls to those
13066 functions.
13067
13068 In addition, seriously incorrect code will result if you call a
13069 function with too many arguments.  (Normally, extra arguments are
13070 harmlessly ignored.)
13071
13072 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
13073 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
13074
13075 @item -mno-rtd
13076 @opindex mno-rtd
13077 Do not use the calling conventions selected by @option{-mrtd}.
13078 This is the default.
13079
13080 @item -malign-int
13081 @itemx -mno-align-int
13082 @opindex malign-int
13083 @opindex mno-align-int
13084 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
13085 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
13086 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
13087 Aligning variables on 32-bit boundaries produces code that runs somewhat
13088 faster on processors with 32-bit busses at the expense of more memory.
13089
13090 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
13091 align structures containing the above types  differently than
13092 most published application binary interface specifications for the m68k.
13093
13094 @item -mpcrel
13095 @opindex mpcrel
13096 Use the pc-relative addressing mode of the 68000 directly, instead of
13097 using a global offset table.  At present, this option implies @option{-fpic},
13098 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
13099 not presently supported with @option{-mpcrel}, though this could be supported for
13100 68020 and higher processors.
13101
13102 @item -mno-strict-align
13103 @itemx -mstrict-align
13104 @opindex mno-strict-align
13105 @opindex mstrict-align
13106 Do not (do) assume that unaligned memory references will be handled by
13107 the system.
13108
13109 @item -msep-data
13110 Generate code that allows the data segment to be located in a different
13111 area of memory from the text segment.  This allows for execute in place in
13112 an environment without virtual memory management.  This option implies
13113 @option{-fPIC}.
13114
13115 @item -mno-sep-data
13116 Generate code that assumes that the data segment follows the text segment.
13117 This is the default.
13118
13119 @item -mid-shared-library
13120 Generate code that supports shared libraries via the library ID method.
13121 This allows for execute in place and shared libraries in an environment
13122 without virtual memory management.  This option implies @option{-fPIC}.
13123
13124 @item -mno-id-shared-library
13125 Generate code that doesn't assume ID based shared libraries are being used.
13126 This is the default.
13127
13128 @item -mshared-library-id=n
13129 Specified the identification number of the ID based shared library being
13130 compiled.  Specifying a value of 0 will generate more compact code, specifying
13131 other values will force the allocation of that number to the current
13132 library but is no more space or time efficient than omitting this option.
13133
13134 @item -mxgot
13135 @itemx -mno-xgot
13136 @opindex mxgot
13137 @opindex mno-xgot
13138 When generating position-independent code for ColdFire, generate code
13139 that works if the GOT has more than 8192 entries.  This code is
13140 larger and slower than code generated without this option.  On M680x0
13141 processors, this option is not needed; @option{-fPIC} suffices.
13142
13143 GCC normally uses a single instruction to load values from the GOT@.
13144 While this is relatively efficient, it only works if the GOT
13145 is smaller than about 64k.  Anything larger causes the linker
13146 to report an error such as:
13147
13148 @cindex relocation truncated to fit (ColdFire)
13149 @smallexample
13150 relocation truncated to fit: R_68K_GOT16O foobar
13151 @end smallexample
13152
13153 If this happens, you should recompile your code with @option{-mxgot}.
13154 It should then work with very large GOTs.  However, code generated with
13155 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
13156 the value of a global symbol.
13157
13158 Note that some linkers, including newer versions of the GNU linker,
13159 can create multiple GOTs and sort GOT entries.  If you have such a linker,
13160 you should only need to use @option{-mxgot} when compiling a single
13161 object file that accesses more than 8192 GOT entries.  Very few do.
13162
13163 These options have no effect unless GCC is generating
13164 position-independent code.
13165
13166 @end table
13167
13168 @node M68hc1x Options
13169 @subsection M68hc1x Options
13170 @cindex M68hc1x options
13171
13172 These are the @samp{-m} options defined for the 68hc11 and 68hc12
13173 microcontrollers.  The default values for these options depends on
13174 which style of microcontroller was selected when the compiler was configured;
13175 the defaults for the most common choices are given below.
13176
13177 @table @gcctabopt
13178 @item -m6811
13179 @itemx -m68hc11
13180 @opindex m6811
13181 @opindex m68hc11
13182 Generate output for a 68HC11.  This is the default
13183 when the compiler is configured for 68HC11-based systems.
13184
13185 @item -m6812
13186 @itemx -m68hc12
13187 @opindex m6812
13188 @opindex m68hc12
13189 Generate output for a 68HC12.  This is the default
13190 when the compiler is configured for 68HC12-based systems.
13191
13192 @item -m68S12
13193 @itemx -m68hcs12
13194 @opindex m68S12
13195 @opindex m68hcs12
13196 Generate output for a 68HCS12.
13197
13198 @item -mauto-incdec
13199 @opindex mauto-incdec
13200 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
13201 addressing modes.
13202
13203 @item -minmax
13204 @itemx -mnominmax
13205 @opindex minmax
13206 @opindex mnominmax
13207 Enable the use of 68HC12 min and max instructions.
13208
13209 @item -mlong-calls
13210 @itemx -mno-long-calls
13211 @opindex mlong-calls
13212 @opindex mno-long-calls
13213 Treat all calls as being far away (near).  If calls are assumed to be
13214 far away, the compiler will use the @code{call} instruction to
13215 call a function and the @code{rtc} instruction for returning.
13216
13217 @item -mshort
13218 @opindex mshort
13219 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13220
13221 @item -msoft-reg-count=@var{count}
13222 @opindex msoft-reg-count
13223 Specify the number of pseudo-soft registers which are used for the
13224 code generation.  The maximum number is 32.  Using more pseudo-soft
13225 register may or may not result in better code depending on the program.
13226 The default is 4 for 68HC11 and 2 for 68HC12.
13227
13228 @end table
13229
13230 @node MCore Options
13231 @subsection MCore Options
13232 @cindex MCore options
13233
13234 These are the @samp{-m} options defined for the Motorola M*Core
13235 processors.
13236
13237 @table @gcctabopt
13238
13239 @item -mhardlit
13240 @itemx -mno-hardlit
13241 @opindex mhardlit
13242 @opindex mno-hardlit
13243 Inline constants into the code stream if it can be done in two
13244 instructions or less.
13245
13246 @item -mdiv
13247 @itemx -mno-div
13248 @opindex mdiv
13249 @opindex mno-div
13250 Use the divide instruction.  (Enabled by default).
13251
13252 @item -mrelax-immediate
13253 @itemx -mno-relax-immediate
13254 @opindex mrelax-immediate
13255 @opindex mno-relax-immediate
13256 Allow arbitrary sized immediates in bit operations.
13257
13258 @item -mwide-bitfields
13259 @itemx -mno-wide-bitfields
13260 @opindex mwide-bitfields
13261 @opindex mno-wide-bitfields
13262 Always treat bit-fields as int-sized.
13263
13264 @item -m4byte-functions
13265 @itemx -mno-4byte-functions
13266 @opindex m4byte-functions
13267 @opindex mno-4byte-functions
13268 Force all functions to be aligned to a four byte boundary.
13269
13270 @item -mcallgraph-data
13271 @itemx -mno-callgraph-data
13272 @opindex mcallgraph-data
13273 @opindex mno-callgraph-data
13274 Emit callgraph information.
13275
13276 @item -mslow-bytes
13277 @itemx -mno-slow-bytes
13278 @opindex mslow-bytes
13279 @opindex mno-slow-bytes
13280 Prefer word access when reading byte quantities.
13281
13282 @item -mlittle-endian
13283 @itemx -mbig-endian
13284 @opindex mlittle-endian
13285 @opindex mbig-endian
13286 Generate code for a little endian target.
13287
13288 @item -m210
13289 @itemx -m340
13290 @opindex m210
13291 @opindex m340
13292 Generate code for the 210 processor.
13293
13294 @item -mno-lsim
13295 @opindex mno-lsim
13296 Assume that run-time support has been provided and so omit the
13297 simulator library (@file{libsim.a)} from the linker command line.
13298
13299 @item -mstack-increment=@var{size}
13300 @opindex mstack-increment
13301 Set the maximum amount for a single stack increment operation.  Large
13302 values can increase the speed of programs which contain functions
13303 that need a large amount of stack space, but they can also trigger a
13304 segmentation fault if the stack is extended too much.  The default
13305 value is 0x1000.
13306
13307 @end table
13308
13309 @node MeP Options
13310 @subsection MeP Options
13311 @cindex MeP options
13312
13313 @table @gcctabopt
13314
13315 @item -mabsdiff
13316 @opindex mabsdiff
13317 Enables the @code{abs} instruction, which is the absolute difference
13318 between two registers.
13319
13320 @item -mall-opts
13321 @opindex mall-opts
13322 Enables all the optional instructions - average, multiply, divide, bit
13323 operations, leading zero, absolute difference, min/max, clip, and
13324 saturation.
13325
13326
13327 @item -maverage
13328 @opindex maverage
13329 Enables the @code{ave} instruction, which computes the average of two
13330 registers.
13331
13332 @item -mbased=@var{n}
13333 @opindex mbased=
13334 Variables of size @var{n} bytes or smaller will be placed in the
13335 @code{.based} section by default.  Based variables use the @code{$tp}
13336 register as a base register, and there is a 128 byte limit to the
13337 @code{.based} section.
13338
13339 @item -mbitops
13340 @opindex mbitops
13341 Enables the bit operation instructions - bit test (@code{btstm}), set
13342 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
13343 test-and-set (@code{tas}).
13344
13345 @item -mc=@var{name}
13346 @opindex mc=
13347 Selects which section constant data will be placed in.  @var{name} may
13348 be @code{tiny}, @code{near}, or @code{far}.
13349
13350 @item -mclip
13351 @opindex mclip
13352 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
13353 useful unless you also provide @code{-mminmax}.
13354
13355 @item -mconfig=@var{name}
13356 @opindex mconfig=
13357 Selects one of the build-in core configurations.  Each MeP chip has
13358 one or more modules in it; each module has a core CPU and a variety of
13359 coprocessors, optional instructions, and peripherals.  The
13360 @code{MeP-Integrator} tool, not part of GCC, provides these
13361 configurations through this option; using this option is the same as
13362 using all the corresponding command line options.  The default
13363 configuration is @code{default}.
13364
13365 @item -mcop
13366 @opindex mcop
13367 Enables the coprocessor instructions.  By default, this is a 32-bit
13368 coprocessor.  Note that the coprocessor is normally enabled via the
13369 @code{-mconfig=} option.
13370
13371 @item -mcop32
13372 @opindex mcop32
13373 Enables the 32-bit coprocessor's instructions.
13374
13375 @item -mcop64
13376 @opindex mcop64
13377 Enables the 64-bit coprocessor's instructions.
13378
13379 @item -mivc2
13380 @opindex mivc2
13381 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
13382
13383 @item -mdc
13384 @opindex mdc
13385 Causes constant variables to be placed in the @code{.near} section.
13386
13387 @item -mdiv
13388 @opindex mdiv
13389 Enables the @code{div} and @code{divu} instructions.
13390
13391 @item -meb
13392 @opindex meb
13393 Generate big-endian code.
13394
13395 @item -mel
13396 @opindex mel
13397 Generate little-endian code.
13398
13399 @item -mio-volatile
13400 @opindex mio-volatile
13401 Tells the compiler that any variable marked with the @code{io}
13402 attribute is to be considered volatile.
13403
13404 @item -ml
13405 @opindex ml
13406 Causes variables to be assigned to the @code{.far} section by default.
13407
13408 @item -mleadz
13409 @opindex mleadz
13410 Enables the @code{leadz} (leading zero) instruction.
13411
13412 @item -mm
13413 @opindex mm
13414 Causes variables to be assigned to the @code{.near} section by default.
13415
13416 @item -mminmax
13417 @opindex mminmax
13418 Enables the @code{min} and @code{max} instructions.
13419
13420 @item -mmult
13421 @opindex mmult
13422 Enables the multiplication and multiply-accumulate instructions.
13423
13424 @item -mno-opts
13425 @opindex mno-opts
13426 Disables all the optional instructions enabled by @code{-mall-opts}.
13427
13428 @item -mrepeat
13429 @opindex mrepeat
13430 Enables the @code{repeat} and @code{erepeat} instructions, used for
13431 low-overhead looping.
13432
13433 @item -ms
13434 @opindex ms
13435 Causes all variables to default to the @code{.tiny} section.  Note
13436 that there is a 65536 byte limit to this section.  Accesses to these
13437 variables use the @code{%gp} base register.
13438
13439 @item -msatur
13440 @opindex msatur
13441 Enables the saturation instructions.  Note that the compiler does not
13442 currently generate these itself, but this option is included for
13443 compatibility with other tools, like @code{as}.
13444
13445 @item -msdram
13446 @opindex msdram
13447 Link the SDRAM-based runtime instead of the default ROM-based runtime.
13448
13449 @item -msim
13450 @opindex msim
13451 Link the simulator runtime libraries.
13452
13453 @item -msimnovec
13454 @opindex msimnovec
13455 Link the simulator runtime libraries, excluding built-in support
13456 for reset and exception vectors and tables.
13457
13458 @item -mtf
13459 @opindex mtf
13460 Causes all functions to default to the @code{.far} section.  Without
13461 this option, functions default to the @code{.near} section.
13462
13463 @item -mtiny=@var{n}
13464 @opindex mtiny=
13465 Variables that are @var{n} bytes or smaller will be allocated to the
13466 @code{.tiny} section.  These variables use the @code{$gp} base
13467 register.  The default for this option is 4, but note that there's a
13468 65536 byte limit to the @code{.tiny} section.
13469
13470 @end table
13471
13472 @node MIPS Options
13473 @subsection MIPS Options
13474 @cindex MIPS options
13475
13476 @table @gcctabopt
13477
13478 @item -EB
13479 @opindex EB
13480 Generate big-endian code.
13481
13482 @item -EL
13483 @opindex EL
13484 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
13485 configurations.
13486
13487 @item -march=@var{arch}
13488 @opindex march
13489 Generate code that will run on @var{arch}, which can be the name of a
13490 generic MIPS ISA, or the name of a particular processor.
13491 The ISA names are:
13492 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
13493 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
13494 The processor names are:
13495 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
13496 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
13497 @samp{5kc}, @samp{5kf},
13498 @samp{20kc},
13499 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
13500 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
13501 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
13502 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
13503 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
13504 @samp{loongson2e}, @samp{loongson2f},
13505 @samp{m4k},
13506 @samp{octeon},
13507 @samp{orion},
13508 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
13509 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
13510 @samp{rm7000}, @samp{rm9000},
13511 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
13512 @samp{sb1},
13513 @samp{sr71000},
13514 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
13515 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
13516 and @samp{xlr}.
13517 The special value @samp{from-abi} selects the
13518 most compatible architecture for the selected ABI (that is,
13519 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
13520
13521 Native Linux/GNU toolchains also support the value @samp{native},
13522 which selects the best architecture option for the host processor.
13523 @option{-march=native} has no effect if GCC does not recognize
13524 the processor.
13525
13526 In processor names, a final @samp{000} can be abbreviated as @samp{k}
13527 (for example, @samp{-march=r2k}).  Prefixes are optional, and
13528 @samp{vr} may be written @samp{r}.
13529
13530 Names of the form @samp{@var{n}f2_1} refer to processors with
13531 FPUs clocked at half the rate of the core, names of the form
13532 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
13533 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
13534 processors with FPUs clocked a ratio of 3:2 with respect to the core.
13535 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
13536 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
13537 accepted as synonyms for @samp{@var{n}f1_1}.
13538
13539 GCC defines two macros based on the value of this option.  The first
13540 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
13541 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
13542 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
13543 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
13544 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
13545
13546 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
13547 above.  In other words, it will have the full prefix and will not
13548 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
13549 the macro names the resolved architecture (either @samp{"mips1"} or
13550 @samp{"mips3"}).  It names the default architecture when no
13551 @option{-march} option is given.
13552
13553 @item -mtune=@var{arch}
13554 @opindex mtune
13555 Optimize for @var{arch}.  Among other things, this option controls
13556 the way instructions are scheduled, and the perceived cost of arithmetic
13557 operations.  The list of @var{arch} values is the same as for
13558 @option{-march}.
13559
13560 When this option is not used, GCC will optimize for the processor
13561 specified by @option{-march}.  By using @option{-march} and
13562 @option{-mtune} together, it is possible to generate code that will
13563 run on a family of processors, but optimize the code for one
13564 particular member of that family.
13565
13566 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
13567 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
13568 @samp{-march} ones described above.
13569
13570 @item -mips1
13571 @opindex mips1
13572 Equivalent to @samp{-march=mips1}.
13573
13574 @item -mips2
13575 @opindex mips2
13576 Equivalent to @samp{-march=mips2}.
13577
13578 @item -mips3
13579 @opindex mips3
13580 Equivalent to @samp{-march=mips3}.
13581
13582 @item -mips4
13583 @opindex mips4
13584 Equivalent to @samp{-march=mips4}.
13585
13586 @item -mips32
13587 @opindex mips32
13588 Equivalent to @samp{-march=mips32}.
13589
13590 @item -mips32r2
13591 @opindex mips32r2
13592 Equivalent to @samp{-march=mips32r2}.
13593
13594 @item -mips64
13595 @opindex mips64
13596 Equivalent to @samp{-march=mips64}.
13597
13598 @item -mips64r2
13599 @opindex mips64r2
13600 Equivalent to @samp{-march=mips64r2}.
13601
13602 @item -mips16
13603 @itemx -mno-mips16
13604 @opindex mips16
13605 @opindex mno-mips16
13606 Generate (do not generate) MIPS16 code.  If GCC is targetting a
13607 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
13608
13609 MIPS16 code generation can also be controlled on a per-function basis
13610 by means of @code{mips16} and @code{nomips16} attributes.
13611 @xref{Function Attributes}, for more information.
13612
13613 @item -mflip-mips16
13614 @opindex mflip-mips16
13615 Generate MIPS16 code on alternating functions.  This option is provided
13616 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
13617 not intended for ordinary use in compiling user code.
13618
13619 @item -minterlink-mips16
13620 @itemx -mno-interlink-mips16
13621 @opindex minterlink-mips16
13622 @opindex mno-interlink-mips16
13623 Require (do not require) that non-MIPS16 code be link-compatible with
13624 MIPS16 code.
13625
13626 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
13627 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
13628 therefore disables direct jumps unless GCC knows that the target of the
13629 jump is not MIPS16.
13630
13631 @item -mabi=32
13632 @itemx -mabi=o64
13633 @itemx -mabi=n32
13634 @itemx -mabi=64
13635 @itemx -mabi=eabi
13636 @opindex mabi=32
13637 @opindex mabi=o64
13638 @opindex mabi=n32
13639 @opindex mabi=64
13640 @opindex mabi=eabi
13641 Generate code for the given ABI@.
13642
13643 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
13644 generates 64-bit code when you select a 64-bit architecture, but you
13645 can use @option{-mgp32} to get 32-bit code instead.
13646
13647 For information about the O64 ABI, see
13648 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
13649
13650 GCC supports a variant of the o32 ABI in which floating-point registers
13651 are 64 rather than 32 bits wide.  You can select this combination with
13652 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
13653 and @samp{mfhc1} instructions and is therefore only supported for
13654 MIPS32R2 processors.
13655
13656 The register assignments for arguments and return values remain the
13657 same, but each scalar value is passed in a single 64-bit register
13658 rather than a pair of 32-bit registers.  For example, scalar
13659 floating-point values are returned in @samp{$f0} only, not a
13660 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
13661 remains the same, but all 64 bits are saved.
13662
13663 @item -mabicalls
13664 @itemx -mno-abicalls
13665 @opindex mabicalls
13666 @opindex mno-abicalls
13667 Generate (do not generate) code that is suitable for SVR4-style
13668 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
13669 systems.
13670
13671 @item -mshared
13672 @itemx -mno-shared
13673 Generate (do not generate) code that is fully position-independent,
13674 and that can therefore be linked into shared libraries.  This option
13675 only affects @option{-mabicalls}.
13676
13677 All @option{-mabicalls} code has traditionally been position-independent,
13678 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
13679 as an extension, the GNU toolchain allows executables to use absolute
13680 accesses for locally-binding symbols.  It can also use shorter GP
13681 initialization sequences and generate direct calls to locally-defined
13682 functions.  This mode is selected by @option{-mno-shared}.
13683
13684 @option{-mno-shared} depends on binutils 2.16 or higher and generates
13685 objects that can only be linked by the GNU linker.  However, the option
13686 does not affect the ABI of the final executable; it only affects the ABI
13687 of relocatable objects.  Using @option{-mno-shared} will generally make
13688 executables both smaller and quicker.
13689
13690 @option{-mshared} is the default.
13691
13692 @item -mplt
13693 @itemx -mno-plt
13694 @opindex mplt
13695 @opindex mno-plt
13696 Assume (do not assume) that the static and dynamic linkers
13697 support PLTs and copy relocations.  This option only affects
13698 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
13699 has no effect without @samp{-msym32}.
13700
13701 You can make @option{-mplt} the default by configuring
13702 GCC with @option{--with-mips-plt}.  The default is
13703 @option{-mno-plt} otherwise.
13704
13705 @item -mxgot
13706 @itemx -mno-xgot
13707 @opindex mxgot
13708 @opindex mno-xgot
13709 Lift (do not lift) the usual restrictions on the size of the global
13710 offset table.
13711
13712 GCC normally uses a single instruction to load values from the GOT@.
13713 While this is relatively efficient, it will only work if the GOT
13714 is smaller than about 64k.  Anything larger will cause the linker
13715 to report an error such as:
13716
13717 @cindex relocation truncated to fit (MIPS)
13718 @smallexample
13719 relocation truncated to fit: R_MIPS_GOT16 foobar
13720 @end smallexample
13721
13722 If this happens, you should recompile your code with @option{-mxgot}.
13723 It should then work with very large GOTs, although it will also be
13724 less efficient, since it will take three instructions to fetch the
13725 value of a global symbol.
13726
13727 Note that some linkers can create multiple GOTs.  If you have such a
13728 linker, you should only need to use @option{-mxgot} when a single object
13729 file accesses more than 64k's worth of GOT entries.  Very few do.
13730
13731 These options have no effect unless GCC is generating position
13732 independent code.
13733
13734 @item -mgp32
13735 @opindex mgp32
13736 Assume that general-purpose registers are 32 bits wide.
13737
13738 @item -mgp64
13739 @opindex mgp64
13740 Assume that general-purpose registers are 64 bits wide.
13741
13742 @item -mfp32
13743 @opindex mfp32
13744 Assume that floating-point registers are 32 bits wide.
13745
13746 @item -mfp64
13747 @opindex mfp64
13748 Assume that floating-point registers are 64 bits wide.
13749
13750 @item -mhard-float
13751 @opindex mhard-float
13752 Use floating-point coprocessor instructions.
13753
13754 @item -msoft-float
13755 @opindex msoft-float
13756 Do not use floating-point coprocessor instructions.  Implement
13757 floating-point calculations using library calls instead.
13758
13759 @item -msingle-float
13760 @opindex msingle-float
13761 Assume that the floating-point coprocessor only supports single-precision
13762 operations.
13763
13764 @item -mdouble-float
13765 @opindex mdouble-float
13766 Assume that the floating-point coprocessor supports double-precision
13767 operations.  This is the default.
13768
13769 @item -mllsc
13770 @itemx -mno-llsc
13771 @opindex mllsc
13772 @opindex mno-llsc
13773 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
13774 implement atomic memory built-in functions.  When neither option is
13775 specified, GCC will use the instructions if the target architecture
13776 supports them.
13777
13778 @option{-mllsc} is useful if the runtime environment can emulate the
13779 instructions and @option{-mno-llsc} can be useful when compiling for
13780 nonstandard ISAs.  You can make either option the default by
13781 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
13782 respectively.  @option{--with-llsc} is the default for some
13783 configurations; see the installation documentation for details.
13784
13785 @item -mdsp
13786 @itemx -mno-dsp
13787 @opindex mdsp
13788 @opindex mno-dsp
13789 Use (do not use) revision 1 of the MIPS DSP ASE@.
13790 @xref{MIPS DSP Built-in Functions}.  This option defines the
13791 preprocessor macro @samp{__mips_dsp}.  It also defines
13792 @samp{__mips_dsp_rev} to 1.
13793
13794 @item -mdspr2
13795 @itemx -mno-dspr2
13796 @opindex mdspr2
13797 @opindex mno-dspr2
13798 Use (do not use) revision 2 of the MIPS DSP ASE@.
13799 @xref{MIPS DSP Built-in Functions}.  This option defines the
13800 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
13801 It also defines @samp{__mips_dsp_rev} to 2.
13802
13803 @item -msmartmips
13804 @itemx -mno-smartmips
13805 @opindex msmartmips
13806 @opindex mno-smartmips
13807 Use (do not use) the MIPS SmartMIPS ASE.
13808
13809 @item -mpaired-single
13810 @itemx -mno-paired-single
13811 @opindex mpaired-single
13812 @opindex mno-paired-single
13813 Use (do not use) paired-single floating-point instructions.
13814 @xref{MIPS Paired-Single Support}.  This option requires
13815 hardware floating-point support to be enabled.
13816
13817 @item -mdmx
13818 @itemx -mno-mdmx
13819 @opindex mdmx
13820 @opindex mno-mdmx
13821 Use (do not use) MIPS Digital Media Extension instructions.
13822 This option can only be used when generating 64-bit code and requires
13823 hardware floating-point support to be enabled.
13824
13825 @item -mips3d
13826 @itemx -mno-mips3d
13827 @opindex mips3d
13828 @opindex mno-mips3d
13829 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
13830 The option @option{-mips3d} implies @option{-mpaired-single}.
13831
13832 @item -mmt
13833 @itemx -mno-mt
13834 @opindex mmt
13835 @opindex mno-mt
13836 Use (do not use) MT Multithreading instructions.
13837
13838 @item -mlong64
13839 @opindex mlong64
13840 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
13841 an explanation of the default and the way that the pointer size is
13842 determined.
13843
13844 @item -mlong32
13845 @opindex mlong32
13846 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
13847
13848 The default size of @code{int}s, @code{long}s and pointers depends on
13849 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
13850 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
13851 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
13852 or the same size as integer registers, whichever is smaller.
13853
13854 @item -msym32
13855 @itemx -mno-sym32
13856 @opindex msym32
13857 @opindex mno-sym32
13858 Assume (do not assume) that all symbols have 32-bit values, regardless
13859 of the selected ABI@.  This option is useful in combination with
13860 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
13861 to generate shorter and faster references to symbolic addresses.
13862
13863 @item -G @var{num}
13864 @opindex G
13865 Put definitions of externally-visible data in a small data section
13866 if that data is no bigger than @var{num} bytes.  GCC can then access
13867 the data more efficiently; see @option{-mgpopt} for details.
13868
13869 The default @option{-G} option depends on the configuration.
13870
13871 @item -mlocal-sdata
13872 @itemx -mno-local-sdata
13873 @opindex mlocal-sdata
13874 @opindex mno-local-sdata
13875 Extend (do not extend) the @option{-G} behavior to local data too,
13876 such as to static variables in C@.  @option{-mlocal-sdata} is the
13877 default for all configurations.
13878
13879 If the linker complains that an application is using too much small data,
13880 you might want to try rebuilding the less performance-critical parts with
13881 @option{-mno-local-sdata}.  You might also want to build large
13882 libraries with @option{-mno-local-sdata}, so that the libraries leave
13883 more room for the main program.
13884
13885 @item -mextern-sdata
13886 @itemx -mno-extern-sdata
13887 @opindex mextern-sdata
13888 @opindex mno-extern-sdata
13889 Assume (do not assume) that externally-defined data will be in
13890 a small data section if that data is within the @option{-G} limit.
13891 @option{-mextern-sdata} is the default for all configurations.
13892
13893 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
13894 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
13895 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
13896 is placed in a small data section.  If @var{Var} is defined by another
13897 module, you must either compile that module with a high-enough
13898 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
13899 definition.  If @var{Var} is common, you must link the application
13900 with a high-enough @option{-G} setting.
13901
13902 The easiest way of satisfying these restrictions is to compile
13903 and link every module with the same @option{-G} option.  However,
13904 you may wish to build a library that supports several different
13905 small data limits.  You can do this by compiling the library with
13906 the highest supported @option{-G} setting and additionally using
13907 @option{-mno-extern-sdata} to stop the library from making assumptions
13908 about externally-defined data.
13909
13910 @item -mgpopt
13911 @itemx -mno-gpopt
13912 @opindex mgpopt
13913 @opindex mno-gpopt
13914 Use (do not use) GP-relative accesses for symbols that are known to be
13915 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
13916 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
13917 configurations.
13918
13919 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
13920 might not hold the value of @code{_gp}.  For example, if the code is
13921 part of a library that might be used in a boot monitor, programs that
13922 call boot monitor routines will pass an unknown value in @code{$gp}.
13923 (In such situations, the boot monitor itself would usually be compiled
13924 with @option{-G0}.)
13925
13926 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
13927 @option{-mno-extern-sdata}.
13928
13929 @item -membedded-data
13930 @itemx -mno-embedded-data
13931 @opindex membedded-data
13932 @opindex mno-embedded-data
13933 Allocate variables to the read-only data section first if possible, then
13934 next in the small data section if possible, otherwise in data.  This gives
13935 slightly slower code than the default, but reduces the amount of RAM required
13936 when executing, and thus may be preferred for some embedded systems.
13937
13938 @item -muninit-const-in-rodata
13939 @itemx -mno-uninit-const-in-rodata
13940 @opindex muninit-const-in-rodata
13941 @opindex mno-uninit-const-in-rodata
13942 Put uninitialized @code{const} variables in the read-only data section.
13943 This option is only meaningful in conjunction with @option{-membedded-data}.
13944
13945 @item -mcode-readable=@var{setting}
13946 @opindex mcode-readable
13947 Specify whether GCC may generate code that reads from executable sections.
13948 There are three possible settings:
13949
13950 @table @gcctabopt
13951 @item -mcode-readable=yes
13952 Instructions may freely access executable sections.  This is the
13953 default setting.
13954
13955 @item -mcode-readable=pcrel
13956 MIPS16 PC-relative load instructions can access executable sections,
13957 but other instructions must not do so.  This option is useful on 4KSc
13958 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
13959 It is also useful on processors that can be configured to have a dual
13960 instruction/data SRAM interface and that, like the M4K, automatically
13961 redirect PC-relative loads to the instruction RAM.
13962
13963 @item -mcode-readable=no
13964 Instructions must not access executable sections.  This option can be
13965 useful on targets that are configured to have a dual instruction/data
13966 SRAM interface but that (unlike the M4K) do not automatically redirect
13967 PC-relative loads to the instruction RAM.
13968 @end table
13969
13970 @item -msplit-addresses
13971 @itemx -mno-split-addresses
13972 @opindex msplit-addresses
13973 @opindex mno-split-addresses
13974 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
13975 relocation operators.  This option has been superseded by
13976 @option{-mexplicit-relocs} but is retained for backwards compatibility.
13977
13978 @item -mexplicit-relocs
13979 @itemx -mno-explicit-relocs
13980 @opindex mexplicit-relocs
13981 @opindex mno-explicit-relocs
13982 Use (do not use) assembler relocation operators when dealing with symbolic
13983 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
13984 is to use assembler macros instead.
13985
13986 @option{-mexplicit-relocs} is the default if GCC was configured
13987 to use an assembler that supports relocation operators.
13988
13989 @item -mcheck-zero-division
13990 @itemx -mno-check-zero-division
13991 @opindex mcheck-zero-division
13992 @opindex mno-check-zero-division
13993 Trap (do not trap) on integer division by zero.
13994
13995 The default is @option{-mcheck-zero-division}.
13996
13997 @item -mdivide-traps
13998 @itemx -mdivide-breaks
13999 @opindex mdivide-traps
14000 @opindex mdivide-breaks
14001 MIPS systems check for division by zero by generating either a
14002 conditional trap or a break instruction.  Using traps results in
14003 smaller code, but is only supported on MIPS II and later.  Also, some
14004 versions of the Linux kernel have a bug that prevents trap from
14005 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
14006 allow conditional traps on architectures that support them and
14007 @option{-mdivide-breaks} to force the use of breaks.
14008
14009 The default is usually @option{-mdivide-traps}, but this can be
14010 overridden at configure time using @option{--with-divide=breaks}.
14011 Divide-by-zero checks can be completely disabled using
14012 @option{-mno-check-zero-division}.
14013
14014 @item -mmemcpy
14015 @itemx -mno-memcpy
14016 @opindex mmemcpy
14017 @opindex mno-memcpy
14018 Force (do not force) the use of @code{memcpy()} for non-trivial block
14019 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
14020 most constant-sized copies.
14021
14022 @item -mlong-calls
14023 @itemx -mno-long-calls
14024 @opindex mlong-calls
14025 @opindex mno-long-calls
14026 Disable (do not disable) use of the @code{jal} instruction.  Calling
14027 functions using @code{jal} is more efficient but requires the caller
14028 and callee to be in the same 256 megabyte segment.
14029
14030 This option has no effect on abicalls code.  The default is
14031 @option{-mno-long-calls}.
14032
14033 @item -mmad
14034 @itemx -mno-mad
14035 @opindex mmad
14036 @opindex mno-mad
14037 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
14038 instructions, as provided by the R4650 ISA@.
14039
14040 @item -mfused-madd
14041 @itemx -mno-fused-madd
14042 @opindex mfused-madd
14043 @opindex mno-fused-madd
14044 Enable (disable) use of the floating point multiply-accumulate
14045 instructions, when they are available.  The default is
14046 @option{-mfused-madd}.
14047
14048 When multiply-accumulate instructions are used, the intermediate
14049 product is calculated to infinite precision and is not subject to
14050 the FCSR Flush to Zero bit.  This may be undesirable in some
14051 circumstances.
14052
14053 @item -nocpp
14054 @opindex nocpp
14055 Tell the MIPS assembler to not run its preprocessor over user
14056 assembler files (with a @samp{.s} suffix) when assembling them.
14057
14058 @item -mfix-r4000
14059 @itemx -mno-fix-r4000
14060 @opindex mfix-r4000
14061 @opindex mno-fix-r4000
14062 Work around certain R4000 CPU errata:
14063 @itemize @minus
14064 @item
14065 A double-word or a variable shift may give an incorrect result if executed
14066 immediately after starting an integer division.
14067 @item
14068 A double-word or a variable shift may give an incorrect result if executed
14069 while an integer multiplication is in progress.
14070 @item
14071 An integer division may give an incorrect result if started in a delay slot
14072 of a taken branch or a jump.
14073 @end itemize
14074
14075 @item -mfix-r4400
14076 @itemx -mno-fix-r4400
14077 @opindex mfix-r4400
14078 @opindex mno-fix-r4400
14079 Work around certain R4400 CPU errata:
14080 @itemize @minus
14081 @item
14082 A double-word or a variable shift may give an incorrect result if executed
14083 immediately after starting an integer division.
14084 @end itemize
14085
14086 @item -mfix-r10000
14087 @itemx -mno-fix-r10000
14088 @opindex mfix-r10000
14089 @opindex mno-fix-r10000
14090 Work around certain R10000 errata:
14091 @itemize @minus
14092 @item
14093 @code{ll}/@code{sc} sequences may not behave atomically on revisions
14094 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
14095 @end itemize
14096
14097 This option can only be used if the target architecture supports
14098 branch-likely instructions.  @option{-mfix-r10000} is the default when
14099 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
14100 otherwise.
14101
14102 @item -mfix-vr4120
14103 @itemx -mno-fix-vr4120
14104 @opindex mfix-vr4120
14105 Work around certain VR4120 errata:
14106 @itemize @minus
14107 @item
14108 @code{dmultu} does not always produce the correct result.
14109 @item
14110 @code{div} and @code{ddiv} do not always produce the correct result if one
14111 of the operands is negative.
14112 @end itemize
14113 The workarounds for the division errata rely on special functions in
14114 @file{libgcc.a}.  At present, these functions are only provided by
14115 the @code{mips64vr*-elf} configurations.
14116
14117 Other VR4120 errata require a nop to be inserted between certain pairs of
14118 instructions.  These errata are handled by the assembler, not by GCC itself.
14119
14120 @item -mfix-vr4130
14121 @opindex mfix-vr4130
14122 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
14123 workarounds are implemented by the assembler rather than by GCC,
14124 although GCC will avoid using @code{mflo} and @code{mfhi} if the
14125 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
14126 instructions are available instead.
14127
14128 @item -mfix-sb1
14129 @itemx -mno-fix-sb1
14130 @opindex mfix-sb1
14131 Work around certain SB-1 CPU core errata.
14132 (This flag currently works around the SB-1 revision 2
14133 ``F1'' and ``F2'' floating point errata.)
14134
14135 @item -mr10k-cache-barrier=@var{setting}
14136 @opindex mr10k-cache-barrier
14137 Specify whether GCC should insert cache barriers to avoid the
14138 side-effects of speculation on R10K processors.
14139
14140 In common with many processors, the R10K tries to predict the outcome
14141 of a conditional branch and speculatively executes instructions from
14142 the ``taken'' branch.  It later aborts these instructions if the
14143 predicted outcome was wrong.  However, on the R10K, even aborted
14144 instructions can have side effects.
14145
14146 This problem only affects kernel stores and, depending on the system,
14147 kernel loads.  As an example, a speculatively-executed store may load
14148 the target memory into cache and mark the cache line as dirty, even if
14149 the store itself is later aborted.  If a DMA operation writes to the
14150 same area of memory before the ``dirty'' line is flushed, the cached
14151 data will overwrite the DMA-ed data.  See the R10K processor manual
14152 for a full description, including other potential problems.
14153
14154 One workaround is to insert cache barrier instructions before every memory
14155 access that might be speculatively executed and that might have side
14156 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
14157 controls GCC's implementation of this workaround.  It assumes that
14158 aborted accesses to any byte in the following regions will not have
14159 side effects:
14160
14161 @enumerate
14162 @item
14163 the memory occupied by the current function's stack frame;
14164
14165 @item
14166 the memory occupied by an incoming stack argument;
14167
14168 @item
14169 the memory occupied by an object with a link-time-constant address.
14170 @end enumerate
14171
14172 It is the kernel's responsibility to ensure that speculative
14173 accesses to these regions are indeed safe.
14174
14175 If the input program contains a function declaration such as:
14176
14177 @smallexample
14178 void foo (void);
14179 @end smallexample
14180
14181 then the implementation of @code{foo} must allow @code{j foo} and
14182 @code{jal foo} to be executed speculatively.  GCC honors this
14183 restriction for functions it compiles itself.  It expects non-GCC
14184 functions (such as hand-written assembly code) to do the same.
14185
14186 The option has three forms:
14187
14188 @table @gcctabopt
14189 @item -mr10k-cache-barrier=load-store
14190 Insert a cache barrier before a load or store that might be
14191 speculatively executed and that might have side effects even
14192 if aborted.
14193
14194 @item -mr10k-cache-barrier=store
14195 Insert a cache barrier before a store that might be speculatively
14196 executed and that might have side effects even if aborted.
14197
14198 @item -mr10k-cache-barrier=none
14199 Disable the insertion of cache barriers.  This is the default setting.
14200 @end table
14201
14202 @item -mflush-func=@var{func}
14203 @itemx -mno-flush-func
14204 @opindex mflush-func
14205 Specifies the function to call to flush the I and D caches, or to not
14206 call any such function.  If called, the function must take the same
14207 arguments as the common @code{_flush_func()}, that is, the address of the
14208 memory range for which the cache is being flushed, the size of the
14209 memory range, and the number 3 (to flush both caches).  The default
14210 depends on the target GCC was configured for, but commonly is either
14211 @samp{_flush_func} or @samp{__cpu_flush}.
14212
14213 @item mbranch-cost=@var{num}
14214 @opindex mbranch-cost
14215 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14216 This cost is only a heuristic and is not guaranteed to produce
14217 consistent results across releases.  A zero cost redundantly selects
14218 the default, which is based on the @option{-mtune} setting.
14219
14220 @item -mbranch-likely
14221 @itemx -mno-branch-likely
14222 @opindex mbranch-likely
14223 @opindex mno-branch-likely
14224 Enable or disable use of Branch Likely instructions, regardless of the
14225 default for the selected architecture.  By default, Branch Likely
14226 instructions may be generated if they are supported by the selected
14227 architecture.  An exception is for the MIPS32 and MIPS64 architectures
14228 and processors which implement those architectures; for those, Branch
14229 Likely instructions will not be generated by default because the MIPS32
14230 and MIPS64 architectures specifically deprecate their use.
14231
14232 @item -mfp-exceptions
14233 @itemx -mno-fp-exceptions
14234 @opindex mfp-exceptions
14235 Specifies whether FP exceptions are enabled.  This affects how we schedule
14236 FP instructions for some processors.  The default is that FP exceptions are
14237 enabled.
14238
14239 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
14240 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
14241 FP pipe.
14242
14243 @item -mvr4130-align
14244 @itemx -mno-vr4130-align
14245 @opindex mvr4130-align
14246 The VR4130 pipeline is two-way superscalar, but can only issue two
14247 instructions together if the first one is 8-byte aligned.  When this
14248 option is enabled, GCC will align pairs of instructions that it
14249 thinks should execute in parallel.
14250
14251 This option only has an effect when optimizing for the VR4130.
14252 It normally makes code faster, but at the expense of making it bigger.
14253 It is enabled by default at optimization level @option{-O3}.
14254
14255 @item -msynci
14256 @itemx -mno-synci
14257 @opindex msynci
14258 Enable (disable) generation of @code{synci} instructions on
14259 architectures that support it.  The @code{synci} instructions (if
14260 enabled) will be generated when @code{__builtin___clear_cache()} is
14261 compiled.
14262
14263 This option defaults to @code{-mno-synci}, but the default can be
14264 overridden by configuring with @code{--with-synci}.
14265
14266 When compiling code for single processor systems, it is generally safe
14267 to use @code{synci}.  However, on many multi-core (SMP) systems, it
14268 will not invalidate the instruction caches on all cores and may lead
14269 to undefined behavior.
14270
14271 @item -mrelax-pic-calls
14272 @itemx -mno-relax-pic-calls
14273 @opindex mrelax-pic-calls
14274 Try to turn PIC calls that are normally dispatched via register
14275 @code{$25} into direct calls.  This is only possible if the linker can
14276 resolve the destination at link-time and if the destination is within
14277 range for a direct call.
14278
14279 @option{-mrelax-pic-calls} is the default if GCC was configured to use
14280 an assembler and a linker that supports the @code{.reloc} assembly
14281 directive and @code{-mexplicit-relocs} is in effect.  With
14282 @code{-mno-explicit-relocs}, this optimization can be performed by the
14283 assembler and the linker alone without help from the compiler.
14284
14285 @item -mmcount-ra-address
14286 @itemx -mno-mcount-ra-address
14287 @opindex mmcount-ra-address
14288 @opindex mno-mcount-ra-address
14289 Emit (do not emit) code that allows @code{_mcount} to modify the
14290 calling function's return address.  When enabled, this option extends
14291 the usual @code{_mcount} interface with a new @var{ra-address}
14292 parameter, which has type @code{intptr_t *} and is passed in register
14293 @code{$12}.  @code{_mcount} can then modify the return address by
14294 doing both of the following:
14295 @itemize
14296 @item
14297 Returning the new address in register @code{$31}.
14298 @item
14299 Storing the new address in @code{*@var{ra-address}},
14300 if @var{ra-address} is nonnull.
14301 @end itemize
14302
14303 The default is @option{-mno-mcount-ra-address}.
14304
14305 @end table
14306
14307 @node MMIX Options
14308 @subsection MMIX Options
14309 @cindex MMIX Options
14310
14311 These options are defined for the MMIX:
14312
14313 @table @gcctabopt
14314 @item -mlibfuncs
14315 @itemx -mno-libfuncs
14316 @opindex mlibfuncs
14317 @opindex mno-libfuncs
14318 Specify that intrinsic library functions are being compiled, passing all
14319 values in registers, no matter the size.
14320
14321 @item -mepsilon
14322 @itemx -mno-epsilon
14323 @opindex mepsilon
14324 @opindex mno-epsilon
14325 Generate floating-point comparison instructions that compare with respect
14326 to the @code{rE} epsilon register.
14327
14328 @item -mabi=mmixware
14329 @itemx -mabi=gnu
14330 @opindex mabi=mmixware
14331 @opindex mabi=gnu
14332 Generate code that passes function parameters and return values that (in
14333 the called function) are seen as registers @code{$0} and up, as opposed to
14334 the GNU ABI which uses global registers @code{$231} and up.
14335
14336 @item -mzero-extend
14337 @itemx -mno-zero-extend
14338 @opindex mzero-extend
14339 @opindex mno-zero-extend
14340 When reading data from memory in sizes shorter than 64 bits, use (do not
14341 use) zero-extending load instructions by default, rather than
14342 sign-extending ones.
14343
14344 @item -mknuthdiv
14345 @itemx -mno-knuthdiv
14346 @opindex mknuthdiv
14347 @opindex mno-knuthdiv
14348 Make the result of a division yielding a remainder have the same sign as
14349 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
14350 remainder follows the sign of the dividend.  Both methods are
14351 arithmetically valid, the latter being almost exclusively used.
14352
14353 @item -mtoplevel-symbols
14354 @itemx -mno-toplevel-symbols
14355 @opindex mtoplevel-symbols
14356 @opindex mno-toplevel-symbols
14357 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
14358 code can be used with the @code{PREFIX} assembly directive.
14359
14360 @item -melf
14361 @opindex melf
14362 Generate an executable in the ELF format, rather than the default
14363 @samp{mmo} format used by the @command{mmix} simulator.
14364
14365 @item -mbranch-predict
14366 @itemx -mno-branch-predict
14367 @opindex mbranch-predict
14368 @opindex mno-branch-predict
14369 Use (do not use) the probable-branch instructions, when static branch
14370 prediction indicates a probable branch.
14371
14372 @item -mbase-addresses
14373 @itemx -mno-base-addresses
14374 @opindex mbase-addresses
14375 @opindex mno-base-addresses
14376 Generate (do not generate) code that uses @emph{base addresses}.  Using a
14377 base address automatically generates a request (handled by the assembler
14378 and the linker) for a constant to be set up in a global register.  The
14379 register is used for one or more base address requests within the range 0
14380 to 255 from the value held in the register.  The generally leads to short
14381 and fast code, but the number of different data items that can be
14382 addressed is limited.  This means that a program that uses lots of static
14383 data may require @option{-mno-base-addresses}.
14384
14385 @item -msingle-exit
14386 @itemx -mno-single-exit
14387 @opindex msingle-exit
14388 @opindex mno-single-exit
14389 Force (do not force) generated code to have a single exit point in each
14390 function.
14391 @end table
14392
14393 @node MN10300 Options
14394 @subsection MN10300 Options
14395 @cindex MN10300 options
14396
14397 These @option{-m} options are defined for Matsushita MN10300 architectures:
14398
14399 @table @gcctabopt
14400 @item -mmult-bug
14401 @opindex mmult-bug
14402 Generate code to avoid bugs in the multiply instructions for the MN10300
14403 processors.  This is the default.
14404
14405 @item -mno-mult-bug
14406 @opindex mno-mult-bug
14407 Do not generate code to avoid bugs in the multiply instructions for the
14408 MN10300 processors.
14409
14410 @item -mam33
14411 @opindex mam33
14412 Generate code which uses features specific to the AM33 processor.
14413
14414 @item -mno-am33
14415 @opindex mno-am33
14416 Do not generate code which uses features specific to the AM33 processor.  This
14417 is the default.
14418
14419 @item -mreturn-pointer-on-d0
14420 @opindex mreturn-pointer-on-d0
14421 When generating a function which returns a pointer, return the pointer
14422 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
14423 only in a0, and attempts to call such functions without a prototype
14424 would result in errors.  Note that this option is on by default; use
14425 @option{-mno-return-pointer-on-d0} to disable it.
14426
14427 @item -mno-crt0
14428 @opindex mno-crt0
14429 Do not link in the C run-time initialization object file.
14430
14431 @item -mrelax
14432 @opindex mrelax
14433 Indicate to the linker that it should perform a relaxation optimization pass
14434 to shorten branches, calls and absolute memory addresses.  This option only
14435 has an effect when used on the command line for the final link step.
14436
14437 This option makes symbolic debugging impossible.
14438 @end table
14439
14440 @node PDP-11 Options
14441 @subsection PDP-11 Options
14442 @cindex PDP-11 Options
14443
14444 These options are defined for the PDP-11:
14445
14446 @table @gcctabopt
14447 @item -mfpu
14448 @opindex mfpu
14449 Use hardware FPP floating point.  This is the default.  (FIS floating
14450 point on the PDP-11/40 is not supported.)
14451
14452 @item -msoft-float
14453 @opindex msoft-float
14454 Do not use hardware floating point.
14455
14456 @item -mac0
14457 @opindex mac0
14458 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
14459
14460 @item -mno-ac0
14461 @opindex mno-ac0
14462 Return floating-point results in memory.  This is the default.
14463
14464 @item -m40
14465 @opindex m40
14466 Generate code for a PDP-11/40.
14467
14468 @item -m45
14469 @opindex m45
14470 Generate code for a PDP-11/45.  This is the default.
14471
14472 @item -m10
14473 @opindex m10
14474 Generate code for a PDP-11/10.
14475
14476 @item -mbcopy-builtin
14477 @opindex mbcopy-builtin
14478 Use inline @code{movmemhi} patterns for copying memory.  This is the
14479 default.
14480
14481 @item -mbcopy
14482 @opindex mbcopy
14483 Do not use inline @code{movmemhi} patterns for copying memory.
14484
14485 @item -mint16
14486 @itemx -mno-int32
14487 @opindex mint16
14488 @opindex mno-int32
14489 Use 16-bit @code{int}.  This is the default.
14490
14491 @item -mint32
14492 @itemx -mno-int16
14493 @opindex mint32
14494 @opindex mno-int16
14495 Use 32-bit @code{int}.
14496
14497 @item -mfloat64
14498 @itemx -mno-float32
14499 @opindex mfloat64
14500 @opindex mno-float32
14501 Use 64-bit @code{float}.  This is the default.
14502
14503 @item -mfloat32
14504 @itemx -mno-float64
14505 @opindex mfloat32
14506 @opindex mno-float64
14507 Use 32-bit @code{float}.
14508
14509 @item -mabshi
14510 @opindex mabshi
14511 Use @code{abshi2} pattern.  This is the default.
14512
14513 @item -mno-abshi
14514 @opindex mno-abshi
14515 Do not use @code{abshi2} pattern.
14516
14517 @item -mbranch-expensive
14518 @opindex mbranch-expensive
14519 Pretend that branches are expensive.  This is for experimenting with
14520 code generation only.
14521
14522 @item -mbranch-cheap
14523 @opindex mbranch-cheap
14524 Do not pretend that branches are expensive.  This is the default.
14525
14526 @item -msplit
14527 @opindex msplit
14528 Generate code for a system with split I&D@.
14529
14530 @item -mno-split
14531 @opindex mno-split
14532 Generate code for a system without split I&D@.  This is the default.
14533
14534 @item -munix-asm
14535 @opindex munix-asm
14536 Use Unix assembler syntax.  This is the default when configured for
14537 @samp{pdp11-*-bsd}.
14538
14539 @item -mdec-asm
14540 @opindex mdec-asm
14541 Use DEC assembler syntax.  This is the default when configured for any
14542 PDP-11 target other than @samp{pdp11-*-bsd}.
14543 @end table
14544
14545 @node picoChip Options
14546 @subsection picoChip Options
14547 @cindex picoChip options
14548
14549 These @samp{-m} options are defined for picoChip implementations:
14550
14551 @table @gcctabopt
14552
14553 @item -mae=@var{ae_type}
14554 @opindex mcpu
14555 Set the instruction set, register set, and instruction scheduling
14556 parameters for array element type @var{ae_type}.  Supported values
14557 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
14558
14559 @option{-mae=ANY} selects a completely generic AE type.  Code
14560 generated with this option will run on any of the other AE types.  The
14561 code will not be as efficient as it would be if compiled for a specific
14562 AE type, and some types of operation (e.g., multiplication) will not
14563 work properly on all types of AE.
14564
14565 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
14566 for compiled code, and is the default.
14567
14568 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
14569 option may suffer from poor performance of byte (char) manipulation,
14570 since the DSP AE does not provide hardware support for byte load/stores.
14571
14572 @item -msymbol-as-address
14573 Enable the compiler to directly use a symbol name as an address in a
14574 load/store instruction, without first loading it into a
14575 register.  Typically, the use of this option will generate larger
14576 programs, which run faster than when the option isn't used.  However, the
14577 results vary from program to program, so it is left as a user option,
14578 rather than being permanently enabled.
14579
14580 @item -mno-inefficient-warnings
14581 Disables warnings about the generation of inefficient code.  These
14582 warnings can be generated, for example, when compiling code which
14583 performs byte-level memory operations on the MAC AE type.  The MAC AE has
14584 no hardware support for byte-level memory operations, so all byte
14585 load/stores must be synthesized from word load/store operations.  This is
14586 inefficient and a warning will be generated indicating to the programmer
14587 that they should rewrite the code to avoid byte operations, or to target
14588 an AE type which has the necessary hardware support.  This option enables
14589 the warning to be turned off.
14590
14591 @end table
14592
14593 @node PowerPC Options
14594 @subsection PowerPC Options
14595 @cindex PowerPC options
14596
14597 These are listed under @xref{RS/6000 and PowerPC Options}.
14598
14599 @node RS/6000 and PowerPC Options
14600 @subsection IBM RS/6000 and PowerPC Options
14601 @cindex RS/6000 and PowerPC Options
14602 @cindex IBM RS/6000 and PowerPC Options
14603
14604 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
14605 @table @gcctabopt
14606 @item -mpower
14607 @itemx -mno-power
14608 @itemx -mpower2
14609 @itemx -mno-power2
14610 @itemx -mpowerpc
14611 @itemx -mno-powerpc
14612 @itemx -mpowerpc-gpopt
14613 @itemx -mno-powerpc-gpopt
14614 @itemx -mpowerpc-gfxopt
14615 @itemx -mno-powerpc-gfxopt
14616 @itemx -mpowerpc64
14617 @itemx -mno-powerpc64
14618 @itemx -mmfcrf
14619 @itemx -mno-mfcrf
14620 @itemx -mpopcntb
14621 @itemx -mno-popcntb
14622 @itemx -mpopcntd
14623 @itemx -mno-popcntd
14624 @itemx -mfprnd
14625 @itemx -mno-fprnd
14626 @itemx -mcmpb
14627 @itemx -mno-cmpb
14628 @itemx -mmfpgpr
14629 @itemx -mno-mfpgpr
14630 @itemx -mhard-dfp
14631 @itemx -mno-hard-dfp
14632 @opindex mpower
14633 @opindex mno-power
14634 @opindex mpower2
14635 @opindex mno-power2
14636 @opindex mpowerpc
14637 @opindex mno-powerpc
14638 @opindex mpowerpc-gpopt
14639 @opindex mno-powerpc-gpopt
14640 @opindex mpowerpc-gfxopt
14641 @opindex mno-powerpc-gfxopt
14642 @opindex mpowerpc64
14643 @opindex mno-powerpc64
14644 @opindex mmfcrf
14645 @opindex mno-mfcrf
14646 @opindex mpopcntb
14647 @opindex mno-popcntb
14648 @opindex mpopcntd
14649 @opindex mno-popcntd
14650 @opindex mfprnd
14651 @opindex mno-fprnd
14652 @opindex mcmpb
14653 @opindex mno-cmpb
14654 @opindex mmfpgpr
14655 @opindex mno-mfpgpr
14656 @opindex mhard-dfp
14657 @opindex mno-hard-dfp
14658 GCC supports two related instruction set architectures for the
14659 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
14660 instructions supported by the @samp{rios} chip set used in the original
14661 RS/6000 systems and the @dfn{PowerPC} instruction set is the
14662 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
14663 the IBM 4xx, 6xx, and follow-on microprocessors.
14664
14665 Neither architecture is a subset of the other.  However there is a
14666 large common subset of instructions supported by both.  An MQ
14667 register is included in processors supporting the POWER architecture.
14668
14669 You use these options to specify which instructions are available on the
14670 processor you are using.  The default value of these options is
14671 determined when configuring GCC@.  Specifying the
14672 @option{-mcpu=@var{cpu_type}} overrides the specification of these
14673 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
14674 rather than the options listed above.
14675
14676 The @option{-mpower} option allows GCC to generate instructions that
14677 are found only in the POWER architecture and to use the MQ register.
14678 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
14679 to generate instructions that are present in the POWER2 architecture but
14680 not the original POWER architecture.
14681
14682 The @option{-mpowerpc} option allows GCC to generate instructions that
14683 are found only in the 32-bit subset of the PowerPC architecture.
14684 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
14685 GCC to use the optional PowerPC architecture instructions in the
14686 General Purpose group, including floating-point square root.  Specifying
14687 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
14688 use the optional PowerPC architecture instructions in the Graphics
14689 group, including floating-point select.
14690
14691 The @option{-mmfcrf} option allows GCC to generate the move from
14692 condition register field instruction implemented on the POWER4
14693 processor and other processors that support the PowerPC V2.01
14694 architecture.
14695 The @option{-mpopcntb} option allows GCC to generate the popcount and
14696 double precision FP reciprocal estimate instruction implemented on the
14697 POWER5 processor and other processors that support the PowerPC V2.02
14698 architecture.
14699 The @option{-mpopcntd} option allows GCC to generate the popcount
14700 instruction implemented on the POWER7 processor and other processors
14701 that support the PowerPC V2.06 architecture.
14702 The @option{-mfprnd} option allows GCC to generate the FP round to
14703 integer instructions implemented on the POWER5+ processor and other
14704 processors that support the PowerPC V2.03 architecture.
14705 The @option{-mcmpb} option allows GCC to generate the compare bytes
14706 instruction implemented on the POWER6 processor and other processors
14707 that support the PowerPC V2.05 architecture.
14708 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
14709 general purpose register instructions implemented on the POWER6X
14710 processor and other processors that support the extended PowerPC V2.05
14711 architecture.
14712 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
14713 point instructions implemented on some POWER processors.
14714
14715 The @option{-mpowerpc64} option allows GCC to generate the additional
14716 64-bit instructions that are found in the full PowerPC64 architecture
14717 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
14718 @option{-mno-powerpc64}.
14719
14720 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
14721 will use only the instructions in the common subset of both
14722 architectures plus some special AIX common-mode calls, and will not use
14723 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
14724 permits GCC to use any instruction from either architecture and to
14725 allow use of the MQ register; specify this for the Motorola MPC601.
14726
14727 @item -mnew-mnemonics
14728 @itemx -mold-mnemonics
14729 @opindex mnew-mnemonics
14730 @opindex mold-mnemonics
14731 Select which mnemonics to use in the generated assembler code.  With
14732 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
14733 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
14734 assembler mnemonics defined for the POWER architecture.  Instructions
14735 defined in only one architecture have only one mnemonic; GCC uses that
14736 mnemonic irrespective of which of these options is specified.
14737
14738 GCC defaults to the mnemonics appropriate for the architecture in
14739 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
14740 value of these option.  Unless you are building a cross-compiler, you
14741 should normally not specify either @option{-mnew-mnemonics} or
14742 @option{-mold-mnemonics}, but should instead accept the default.
14743
14744 @item -mcpu=@var{cpu_type}
14745 @opindex mcpu
14746 Set architecture type, register usage, choice of mnemonics, and
14747 instruction scheduling parameters for machine type @var{cpu_type}.
14748 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
14749 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
14750 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
14751 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
14752 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
14753 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
14754 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
14755 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
14756 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
14757 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
14758 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
14759
14760 @option{-mcpu=common} selects a completely generic processor.  Code
14761 generated under this option will run on any POWER or PowerPC processor.
14762 GCC will use only the instructions in the common subset of both
14763 architectures, and will not use the MQ register.  GCC assumes a generic
14764 processor model for scheduling purposes.
14765
14766 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
14767 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
14768 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
14769 types, with an appropriate, generic processor model assumed for
14770 scheduling purposes.
14771
14772 The other options specify a specific processor.  Code generated under
14773 those options will run best on that processor, and may not run at all on
14774 others.
14775
14776 The @option{-mcpu} options automatically enable or disable the
14777 following options:
14778
14779 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
14780 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
14781 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
14782 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
14783
14784 The particular options set for any particular CPU will vary between
14785 compiler versions, depending on what setting seems to produce optimal
14786 code for that CPU; it doesn't necessarily reflect the actual hardware's
14787 capabilities.  If you wish to set an individual option to a particular
14788 value, you may specify it after the @option{-mcpu} option, like
14789 @samp{-mcpu=970 -mno-altivec}.
14790
14791 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
14792 not enabled or disabled by the @option{-mcpu} option at present because
14793 AIX does not have full support for these options.  You may still
14794 enable or disable them individually if you're sure it'll work in your
14795 environment.
14796
14797 @item -mtune=@var{cpu_type}
14798 @opindex mtune
14799 Set the instruction scheduling parameters for machine type
14800 @var{cpu_type}, but do not set the architecture type, register usage, or
14801 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
14802 values for @var{cpu_type} are used for @option{-mtune} as for
14803 @option{-mcpu}.  If both are specified, the code generated will use the
14804 architecture, registers, and mnemonics set by @option{-mcpu}, but the
14805 scheduling parameters set by @option{-mtune}.
14806
14807 @item -mswdiv
14808 @itemx -mno-swdiv
14809 @opindex mswdiv
14810 @opindex mno-swdiv
14811 Generate code to compute division as reciprocal estimate and iterative
14812 refinement, creating opportunities for increased throughput.  This
14813 feature requires: optional PowerPC Graphics instruction set for single
14814 precision and FRE instruction for double precision, assuming divides
14815 cannot generate user-visible traps, and the domain values not include
14816 Infinities, denormals or zero denominator.
14817
14818 @item -maltivec
14819 @itemx -mno-altivec
14820 @opindex maltivec
14821 @opindex mno-altivec
14822 Generate code that uses (does not use) AltiVec instructions, and also
14823 enable the use of built-in functions that allow more direct access to
14824 the AltiVec instruction set.  You may also need to set
14825 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
14826 enhancements.
14827
14828 @item -mvrsave
14829 @itemx -mno-vrsave
14830 @opindex mvrsave
14831 @opindex mno-vrsave
14832 Generate VRSAVE instructions when generating AltiVec code.
14833
14834 @item -mgen-cell-microcode
14835 @opindex mgen-cell-microcode
14836 Generate Cell microcode instructions
14837
14838 @item -mwarn-cell-microcode
14839 @opindex mwarn-cell-microcode
14840 Warning when a Cell microcode instruction is going to emitted.  An example
14841 of a Cell microcode instruction is a variable shift.
14842
14843 @item -msecure-plt
14844 @opindex msecure-plt
14845 Generate code that allows ld and ld.so to build executables and shared
14846 libraries with non-exec .plt and .got sections.  This is a PowerPC
14847 32-bit SYSV ABI option.
14848
14849 @item -mbss-plt
14850 @opindex mbss-plt
14851 Generate code that uses a BSS .plt section that ld.so fills in, and
14852 requires .plt and .got sections that are both writable and executable.
14853 This is a PowerPC 32-bit SYSV ABI option.
14854
14855 @item -misel
14856 @itemx -mno-isel
14857 @opindex misel
14858 @opindex mno-isel
14859 This switch enables or disables the generation of ISEL instructions.
14860
14861 @item -misel=@var{yes/no}
14862 This switch has been deprecated.  Use @option{-misel} and
14863 @option{-mno-isel} instead.
14864
14865 @item -mspe
14866 @itemx -mno-spe
14867 @opindex mspe
14868 @opindex mno-spe
14869 This switch enables or disables the generation of SPE simd
14870 instructions.
14871
14872 @item -mpaired
14873 @itemx -mno-paired
14874 @opindex mpaired
14875 @opindex mno-paired
14876 This switch enables or disables the generation of PAIRED simd
14877 instructions.
14878
14879 @item -mspe=@var{yes/no}
14880 This option has been deprecated.  Use @option{-mspe} and
14881 @option{-mno-spe} instead.
14882
14883 @item -mvsx
14884 @itemx -mno-vsx
14885 @opindex mvsx
14886 @opindex mno-vsx
14887 Generate code that uses (does not use) vector/scalar (VSX)
14888 instructions, and also enable the use of built-in functions that allow
14889 more direct access to the VSX instruction set.
14890
14891 @item -mfloat-gprs=@var{yes/single/double/no}
14892 @itemx -mfloat-gprs
14893 @opindex mfloat-gprs
14894 This switch enables or disables the generation of floating point
14895 operations on the general purpose registers for architectures that
14896 support it.
14897
14898 The argument @var{yes} or @var{single} enables the use of
14899 single-precision floating point operations.
14900
14901 The argument @var{double} enables the use of single and
14902 double-precision floating point operations.
14903
14904 The argument @var{no} disables floating point operations on the
14905 general purpose registers.
14906
14907 This option is currently only available on the MPC854x.
14908
14909 @item -m32
14910 @itemx -m64
14911 @opindex m32
14912 @opindex m64
14913 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
14914 targets (including GNU/Linux).  The 32-bit environment sets int, long
14915 and pointer to 32 bits and generates code that runs on any PowerPC
14916 variant.  The 64-bit environment sets int to 32 bits and long and
14917 pointer to 64 bits, and generates code for PowerPC64, as for
14918 @option{-mpowerpc64}.
14919
14920 @item -mfull-toc
14921 @itemx -mno-fp-in-toc
14922 @itemx -mno-sum-in-toc
14923 @itemx -mminimal-toc
14924 @opindex mfull-toc
14925 @opindex mno-fp-in-toc
14926 @opindex mno-sum-in-toc
14927 @opindex mminimal-toc
14928 Modify generation of the TOC (Table Of Contents), which is created for
14929 every executable file.  The @option{-mfull-toc} option is selected by
14930 default.  In that case, GCC will allocate at least one TOC entry for
14931 each unique non-automatic variable reference in your program.  GCC
14932 will also place floating-point constants in the TOC@.  However, only
14933 16,384 entries are available in the TOC@.
14934
14935 If you receive a linker error message that saying you have overflowed
14936 the available TOC space, you can reduce the amount of TOC space used
14937 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
14938 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
14939 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
14940 generate code to calculate the sum of an address and a constant at
14941 run-time instead of putting that sum into the TOC@.  You may specify one
14942 or both of these options.  Each causes GCC to produce very slightly
14943 slower and larger code at the expense of conserving TOC space.
14944
14945 If you still run out of space in the TOC even when you specify both of
14946 these options, specify @option{-mminimal-toc} instead.  This option causes
14947 GCC to make only one TOC entry for every file.  When you specify this
14948 option, GCC will produce code that is slower and larger but which
14949 uses extremely little TOC space.  You may wish to use this option
14950 only on files that contain less frequently executed code.
14951
14952 @item -maix64
14953 @itemx -maix32
14954 @opindex maix64
14955 @opindex maix32
14956 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
14957 @code{long} type, and the infrastructure needed to support them.
14958 Specifying @option{-maix64} implies @option{-mpowerpc64} and
14959 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
14960 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
14961
14962 @item -mxl-compat
14963 @itemx -mno-xl-compat
14964 @opindex mxl-compat
14965 @opindex mno-xl-compat
14966 Produce code that conforms more closely to IBM XL compiler semantics
14967 when using AIX-compatible ABI@.  Pass floating-point arguments to
14968 prototyped functions beyond the register save area (RSA) on the stack
14969 in addition to argument FPRs.  Do not assume that most significant
14970 double in 128-bit long double value is properly rounded when comparing
14971 values and converting to double.  Use XL symbol names for long double
14972 support routines.
14973
14974 The AIX calling convention was extended but not initially documented to
14975 handle an obscure K&R C case of calling a function that takes the
14976 address of its arguments with fewer arguments than declared.  IBM XL
14977 compilers access floating point arguments which do not fit in the
14978 RSA from the stack when a subroutine is compiled without
14979 optimization.  Because always storing floating-point arguments on the
14980 stack is inefficient and rarely needed, this option is not enabled by
14981 default and only is necessary when calling subroutines compiled by IBM
14982 XL compilers without optimization.
14983
14984 @item -mpe
14985 @opindex mpe
14986 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
14987 application written to use message passing with special startup code to
14988 enable the application to run.  The system must have PE installed in the
14989 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
14990 must be overridden with the @option{-specs=} option to specify the
14991 appropriate directory location.  The Parallel Environment does not
14992 support threads, so the @option{-mpe} option and the @option{-pthread}
14993 option are incompatible.
14994
14995 @item -malign-natural
14996 @itemx -malign-power
14997 @opindex malign-natural
14998 @opindex malign-power
14999 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
15000 @option{-malign-natural} overrides the ABI-defined alignment of larger
15001 types, such as floating-point doubles, on their natural size-based boundary.
15002 The option @option{-malign-power} instructs GCC to follow the ABI-specified
15003 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
15004
15005 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
15006 is not supported.
15007
15008 @item -msoft-float
15009 @itemx -mhard-float
15010 @opindex msoft-float
15011 @opindex mhard-float
15012 Generate code that does not use (uses) the floating-point register set.
15013 Software floating point emulation is provided if you use the
15014 @option{-msoft-float} option, and pass the option to GCC when linking.
15015
15016 @item -msingle-float
15017 @itemx -mdouble-float
15018 @opindex msingle-float
15019 @opindex mdouble-float
15020 Generate code for single or double-precision floating point operations.
15021 @option{-mdouble-float} implies @option{-msingle-float}.
15022
15023 @item -msimple-fpu
15024 @opindex msimple-fpu
15025 Do not generate sqrt and div instructions for hardware floating point unit.
15026
15027 @item -mfpu
15028 @opindex mfpu
15029 Specify type of floating point unit.  Valid values are @var{sp_lite}
15030 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
15031 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
15032 and @var{dp_full} (equivalent to -mdouble-float).
15033
15034 @item -mxilinx-fpu
15035 @opindex mxilinx-fpu
15036 Perform optimizations for floating point unit on Xilinx PPC 405/440.
15037
15038 @item -mmultiple
15039 @itemx -mno-multiple
15040 @opindex mmultiple
15041 @opindex mno-multiple
15042 Generate code that uses (does not use) the load multiple word
15043 instructions and the store multiple word instructions.  These
15044 instructions are generated by default on POWER systems, and not
15045 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
15046 endian PowerPC systems, since those instructions do not work when the
15047 processor is in little endian mode.  The exceptions are PPC740 and
15048 PPC750 which permit the instructions usage in little endian mode.
15049
15050 @item -mstring
15051 @itemx -mno-string
15052 @opindex mstring
15053 @opindex mno-string
15054 Generate code that uses (does not use) the load string instructions
15055 and the store string word instructions to save multiple registers and
15056 do small block moves.  These instructions are generated by default on
15057 POWER systems, and not generated on PowerPC systems.  Do not use
15058 @option{-mstring} on little endian PowerPC systems, since those
15059 instructions do not work when the processor is in little endian mode.
15060 The exceptions are PPC740 and PPC750 which permit the instructions
15061 usage in little endian mode.
15062
15063 @item -mupdate
15064 @itemx -mno-update
15065 @opindex mupdate
15066 @opindex mno-update
15067 Generate code that uses (does not use) the load or store instructions
15068 that update the base register to the address of the calculated memory
15069 location.  These instructions are generated by default.  If you use
15070 @option{-mno-update}, there is a small window between the time that the
15071 stack pointer is updated and the address of the previous frame is
15072 stored, which means code that walks the stack frame across interrupts or
15073 signals may get corrupted data.
15074
15075 @item -mavoid-indexed-addresses
15076 @itemx -mno-avoid-indexed-addresses
15077 @opindex mavoid-indexed-addresses
15078 @opindex mno-avoid-indexed-addresses
15079 Generate code that tries to avoid (not avoid) the use of indexed load
15080 or store instructions. These instructions can incur a performance
15081 penalty on Power6 processors in certain situations, such as when
15082 stepping through large arrays that cross a 16M boundary.  This option
15083 is enabled by default when targetting Power6 and disabled otherwise.
15084
15085 @item -mfused-madd
15086 @itemx -mno-fused-madd
15087 @opindex mfused-madd
15088 @opindex mno-fused-madd
15089 Generate code that uses (does not use) the floating point multiply and
15090 accumulate instructions.  These instructions are generated by default if
15091 hardware floating is used.
15092
15093 @item -mmulhw
15094 @itemx -mno-mulhw
15095 @opindex mmulhw
15096 @opindex mno-mulhw
15097 Generate code that uses (does not use) the half-word multiply and
15098 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
15099 These instructions are generated by default when targetting those
15100 processors.
15101
15102 @item -mdlmzb
15103 @itemx -mno-dlmzb
15104 @opindex mdlmzb
15105 @opindex mno-dlmzb
15106 Generate code that uses (does not use) the string-search @samp{dlmzb}
15107 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
15108 generated by default when targetting those processors.
15109
15110 @item -mno-bit-align
15111 @itemx -mbit-align
15112 @opindex mno-bit-align
15113 @opindex mbit-align
15114 On System V.4 and embedded PowerPC systems do not (do) force structures
15115 and unions that contain bit-fields to be aligned to the base type of the
15116 bit-field.
15117
15118 For example, by default a structure containing nothing but 8
15119 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
15120 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
15121 the structure would be aligned to a 1 byte boundary and be one byte in
15122 size.
15123
15124 @item -mno-strict-align
15125 @itemx -mstrict-align
15126 @opindex mno-strict-align
15127 @opindex mstrict-align
15128 On System V.4 and embedded PowerPC systems do not (do) assume that
15129 unaligned memory references will be handled by the system.
15130
15131 @item -mrelocatable
15132 @itemx -mno-relocatable
15133 @opindex mrelocatable
15134 @opindex mno-relocatable
15135 On embedded PowerPC systems generate code that allows (does not allow)
15136 the program to be relocated to a different address at runtime.  If you
15137 use @option{-mrelocatable} on any module, all objects linked together must
15138 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
15139
15140 @item -mrelocatable-lib
15141 @itemx -mno-relocatable-lib
15142 @opindex mrelocatable-lib
15143 @opindex mno-relocatable-lib
15144 On embedded PowerPC systems generate code that allows (does not allow)
15145 the program to be relocated to a different address at runtime.  Modules
15146 compiled with @option{-mrelocatable-lib} can be linked with either modules
15147 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
15148 with modules compiled with the @option{-mrelocatable} options.
15149
15150 @item -mno-toc
15151 @itemx -mtoc
15152 @opindex mno-toc
15153 @opindex mtoc
15154 On System V.4 and embedded PowerPC systems do not (do) assume that
15155 register 2 contains a pointer to a global area pointing to the addresses
15156 used in the program.
15157
15158 @item -mlittle
15159 @itemx -mlittle-endian
15160 @opindex mlittle
15161 @opindex mlittle-endian
15162 On System V.4 and embedded PowerPC systems compile code for the
15163 processor in little endian mode.  The @option{-mlittle-endian} option is
15164 the same as @option{-mlittle}.
15165
15166 @item -mbig
15167 @itemx -mbig-endian
15168 @opindex mbig
15169 @opindex mbig-endian
15170 On System V.4 and embedded PowerPC systems compile code for the
15171 processor in big endian mode.  The @option{-mbig-endian} option is
15172 the same as @option{-mbig}.
15173
15174 @item -mdynamic-no-pic
15175 @opindex mdynamic-no-pic
15176 On Darwin and Mac OS X systems, compile code so that it is not
15177 relocatable, but that its external references are relocatable.  The
15178 resulting code is suitable for applications, but not shared
15179 libraries.
15180
15181 @item -mprioritize-restricted-insns=@var{priority}
15182 @opindex mprioritize-restricted-insns
15183 This option controls the priority that is assigned to
15184 dispatch-slot restricted instructions during the second scheduling
15185 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
15186 @var{no/highest/second-highest} priority to dispatch slot restricted
15187 instructions.
15188
15189 @item -msched-costly-dep=@var{dependence_type}
15190 @opindex msched-costly-dep
15191 This option controls which dependences are considered costly
15192 by the target during instruction scheduling.  The argument
15193 @var{dependence_type} takes one of the following values:
15194 @var{no}: no dependence is costly,
15195 @var{all}: all dependences are costly,
15196 @var{true_store_to_load}: a true dependence from store to load is costly,
15197 @var{store_to_load}: any dependence from store to load is costly,
15198 @var{number}: any dependence which latency >= @var{number} is costly.
15199
15200 @item -minsert-sched-nops=@var{scheme}
15201 @opindex minsert-sched-nops
15202 This option controls which nop insertion scheme will be used during
15203 the second scheduling pass.  The argument @var{scheme} takes one of the
15204 following values:
15205 @var{no}: Don't insert nops.
15206 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
15207 according to the scheduler's grouping.
15208 @var{regroup_exact}: Insert nops to force costly dependent insns into
15209 separate groups.  Insert exactly as many nops as needed to force an insn
15210 to a new group, according to the estimated processor grouping.
15211 @var{number}: Insert nops to force costly dependent insns into
15212 separate groups.  Insert @var{number} nops to force an insn to a new group.
15213
15214 @item -mcall-sysv
15215 @opindex mcall-sysv
15216 On System V.4 and embedded PowerPC systems compile code using calling
15217 conventions that adheres to the March 1995 draft of the System V
15218 Application Binary Interface, PowerPC processor supplement.  This is the
15219 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
15220
15221 @item -mcall-sysv-eabi
15222 @itemx -mcall-eabi
15223 @opindex mcall-sysv-eabi
15224 @opindex mcall-eabi
15225 Specify both @option{-mcall-sysv} and @option{-meabi} options.
15226
15227 @item -mcall-sysv-noeabi
15228 @opindex mcall-sysv-noeabi
15229 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
15230
15231 @item -mcall-aixdesc
15232 @opindex m
15233 On System V.4 and embedded PowerPC systems compile code for the AIX
15234 operating system.
15235
15236 @item -mcall-linux
15237 @opindex mcall-linux
15238 On System V.4 and embedded PowerPC systems compile code for the
15239 Linux-based GNU system.
15240
15241 @item -mcall-gnu
15242 @opindex mcall-gnu
15243 On System V.4 and embedded PowerPC systems compile code for the
15244 Hurd-based GNU system.
15245
15246 @item -mcall-freebsd
15247 @opindex mcall-freebsd
15248 On System V.4 and embedded PowerPC systems compile code for the
15249 FreeBSD operating system.
15250
15251 @item -mcall-netbsd
15252 @opindex mcall-netbsd
15253 On System V.4 and embedded PowerPC systems compile code for the
15254 NetBSD operating system.
15255
15256 @item -mcall-openbsd
15257 @opindex mcall-netbsd
15258 On System V.4 and embedded PowerPC systems compile code for the
15259 OpenBSD operating system.
15260
15261 @item -maix-struct-return
15262 @opindex maix-struct-return
15263 Return all structures in memory (as specified by the AIX ABI)@.
15264
15265 @item -msvr4-struct-return
15266 @opindex msvr4-struct-return
15267 Return structures smaller than 8 bytes in registers (as specified by the
15268 SVR4 ABI)@.
15269
15270 @item -mabi=@var{abi-type}
15271 @opindex mabi
15272 Extend the current ABI with a particular extension, or remove such extension.
15273 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
15274 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
15275
15276 @item -mabi=spe
15277 @opindex mabi=spe
15278 Extend the current ABI with SPE ABI extensions.  This does not change
15279 the default ABI, instead it adds the SPE ABI extensions to the current
15280 ABI@.
15281
15282 @item -mabi=no-spe
15283 @opindex mabi=no-spe
15284 Disable Booke SPE ABI extensions for the current ABI@.
15285
15286 @item -mabi=ibmlongdouble
15287 @opindex mabi=ibmlongdouble
15288 Change the current ABI to use IBM extended precision long double.
15289 This is a PowerPC 32-bit SYSV ABI option.
15290
15291 @item -mabi=ieeelongdouble
15292 @opindex mabi=ieeelongdouble
15293 Change the current ABI to use IEEE extended precision long double.
15294 This is a PowerPC 32-bit Linux ABI option.
15295
15296 @item -mprototype
15297 @itemx -mno-prototype
15298 @opindex mprototype
15299 @opindex mno-prototype
15300 On System V.4 and embedded PowerPC systems assume that all calls to
15301 variable argument functions are properly prototyped.  Otherwise, the
15302 compiler must insert an instruction before every non prototyped call to
15303 set or clear bit 6 of the condition code register (@var{CR}) to
15304 indicate whether floating point values were passed in the floating point
15305 registers in case the function takes a variable arguments.  With
15306 @option{-mprototype}, only calls to prototyped variable argument functions
15307 will set or clear the bit.
15308
15309 @item -msim
15310 @opindex msim
15311 On embedded PowerPC systems, assume that the startup module is called
15312 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
15313 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
15314 configurations.
15315
15316 @item -mmvme
15317 @opindex mmvme
15318 On embedded PowerPC systems, assume that the startup module is called
15319 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
15320 @file{libc.a}.
15321
15322 @item -mads
15323 @opindex mads
15324 On embedded PowerPC systems, assume that the startup module is called
15325 @file{crt0.o} and the standard C libraries are @file{libads.a} and
15326 @file{libc.a}.
15327
15328 @item -myellowknife
15329 @opindex myellowknife
15330 On embedded PowerPC systems, assume that the startup module is called
15331 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
15332 @file{libc.a}.
15333
15334 @item -mvxworks
15335 @opindex mvxworks
15336 On System V.4 and embedded PowerPC systems, specify that you are
15337 compiling for a VxWorks system.
15338
15339 @item -memb
15340 @opindex memb
15341 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
15342 header to indicate that @samp{eabi} extended relocations are used.
15343
15344 @item -meabi
15345 @itemx -mno-eabi
15346 @opindex meabi
15347 @opindex mno-eabi
15348 On System V.4 and embedded PowerPC systems do (do not) adhere to the
15349 Embedded Applications Binary Interface (eabi) which is a set of
15350 modifications to the System V.4 specifications.  Selecting @option{-meabi}
15351 means that the stack is aligned to an 8 byte boundary, a function
15352 @code{__eabi} is called to from @code{main} to set up the eabi
15353 environment, and the @option{-msdata} option can use both @code{r2} and
15354 @code{r13} to point to two separate small data areas.  Selecting
15355 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
15356 do not call an initialization function from @code{main}, and the
15357 @option{-msdata} option will only use @code{r13} to point to a single
15358 small data area.  The @option{-meabi} option is on by default if you
15359 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
15360
15361 @item -msdata=eabi
15362 @opindex msdata=eabi
15363 On System V.4 and embedded PowerPC systems, put small initialized
15364 @code{const} global and static data in the @samp{.sdata2} section, which
15365 is pointed to by register @code{r2}.  Put small initialized
15366 non-@code{const} global and static data in the @samp{.sdata} section,
15367 which is pointed to by register @code{r13}.  Put small uninitialized
15368 global and static data in the @samp{.sbss} section, which is adjacent to
15369 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
15370 incompatible with the @option{-mrelocatable} option.  The
15371 @option{-msdata=eabi} option also sets the @option{-memb} option.
15372
15373 @item -msdata=sysv
15374 @opindex msdata=sysv
15375 On System V.4 and embedded PowerPC systems, put small global and static
15376 data in the @samp{.sdata} section, which is pointed to by register
15377 @code{r13}.  Put small uninitialized global and static data in the
15378 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
15379 The @option{-msdata=sysv} option is incompatible with the
15380 @option{-mrelocatable} option.
15381
15382 @item -msdata=default
15383 @itemx -msdata
15384 @opindex msdata=default
15385 @opindex msdata
15386 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
15387 compile code the same as @option{-msdata=eabi}, otherwise compile code the
15388 same as @option{-msdata=sysv}.
15389
15390 @item -msdata=data
15391 @opindex msdata=data
15392 On System V.4 and embedded PowerPC systems, put small global
15393 data in the @samp{.sdata} section.  Put small uninitialized global
15394 data in the @samp{.sbss} section.  Do not use register @code{r13}
15395 to address small data however.  This is the default behavior unless
15396 other @option{-msdata} options are used.
15397
15398 @item -msdata=none
15399 @itemx -mno-sdata
15400 @opindex msdata=none
15401 @opindex mno-sdata
15402 On embedded PowerPC systems, put all initialized global and static data
15403 in the @samp{.data} section, and all uninitialized data in the
15404 @samp{.bss} section.
15405
15406 @item -G @var{num}
15407 @opindex G
15408 @cindex smaller data references (PowerPC)
15409 @cindex .sdata/.sdata2 references (PowerPC)
15410 On embedded PowerPC systems, put global and static items less than or
15411 equal to @var{num} bytes into the small data or bss sections instead of
15412 the normal data or bss section.  By default, @var{num} is 8.  The
15413 @option{-G @var{num}} switch is also passed to the linker.
15414 All modules should be compiled with the same @option{-G @var{num}} value.
15415
15416 @item -mregnames
15417 @itemx -mno-regnames
15418 @opindex mregnames
15419 @opindex mno-regnames
15420 On System V.4 and embedded PowerPC systems do (do not) emit register
15421 names in the assembly language output using symbolic forms.
15422
15423 @item -mlongcall
15424 @itemx -mno-longcall
15425 @opindex mlongcall
15426 @opindex mno-longcall
15427 By default assume that all calls are far away so that a longer more
15428 expensive calling sequence is required.  This is required for calls
15429 further than 32 megabytes (33,554,432 bytes) from the current location.
15430 A short call will be generated if the compiler knows
15431 the call cannot be that far away.  This setting can be overridden by
15432 the @code{shortcall} function attribute, or by @code{#pragma
15433 longcall(0)}.
15434
15435 Some linkers are capable of detecting out-of-range calls and generating
15436 glue code on the fly.  On these systems, long calls are unnecessary and
15437 generate slower code.  As of this writing, the AIX linker can do this,
15438 as can the GNU linker for PowerPC/64.  It is planned to add this feature
15439 to the GNU linker for 32-bit PowerPC systems as well.
15440
15441 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
15442 callee, L42'', plus a ``branch island'' (glue code).  The two target
15443 addresses represent the callee and the ``branch island''.  The
15444 Darwin/PPC linker will prefer the first address and generate a ``bl
15445 callee'' if the PPC ``bl'' instruction will reach the callee directly;
15446 otherwise, the linker will generate ``bl L42'' to call the ``branch
15447 island''.  The ``branch island'' is appended to the body of the
15448 calling function; it computes the full 32-bit address of the callee
15449 and jumps to it.
15450
15451 On Mach-O (Darwin) systems, this option directs the compiler emit to
15452 the glue for every direct call, and the Darwin linker decides whether
15453 to use or discard it.
15454
15455 In the future, we may cause GCC to ignore all longcall specifications
15456 when the linker is known to generate glue.
15457
15458 @item -mtls-markers
15459 @itemx -mno-tls-markers
15460 @opindex mtls-markers
15461 @opindex mno-tls-markers
15462 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
15463 specifying the function argument.  The relocation allows ld to
15464 reliably associate function call with argument setup instructions for
15465 TLS optimization, which in turn allows gcc to better schedule the
15466 sequence.
15467
15468 @item -pthread
15469 @opindex pthread
15470 Adds support for multithreading with the @dfn{pthreads} library.
15471 This option sets flags for both the preprocessor and linker.
15472
15473 @end table
15474
15475 @node RX Options
15476 @subsection RX Options
15477 @cindex RX Options
15478
15479 These @option{-m} options are defined for RX implementations:
15480
15481 @table @gcctabopt
15482 @item -m64bit-doubles
15483 @itemx -m32bit-doubles
15484 @itemx -fpu
15485 @itemx -nofpu
15486 @opindex m64bit-doubles
15487 @opindex m32bit-doubles
15488 @opindex fpu
15489 @opindex nofpu
15490 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
15491 or 32-bits (@option{-m32bit-doubles}) in size.  The default is
15492 @option{-m64bit-doubles}.  @emph{Note} the RX's hardware floating
15493 point instructions are only used for 32-bit floating point values, and
15494 then only if @option{-ffast-math} has been specified on the command
15495 line.  This is because the RX FPU instructions do not properly support
15496 denormal (or sub-normal) values.
15497
15498 The options @option{-fpu} and @option{-nofpu} have been provided at
15499 the request of Rensas for compatibility with their toolchain.  The
15500 @option{-mfpu} option enables the use of RX FPU instructions by
15501 selecting 32-bit doubles and enabling unsafe math optimizations.  The
15502 @option{-mnofpu} option disables the use of RX FPU instructions, even
15503 if @option{-m32bit-doubles} is active and unsafe math optimizations
15504 have been enabled.
15505
15506 @item -mcpu=@var{name}
15507 @itemx -patch=@var{name}
15508 @opindex -mcpu
15509 @opindex -patch
15510 Selects the type of RX CPU to be targeted.  Currently on two types are
15511 supported, the generic @var{RX600} and the specific @var{RX610}.  The
15512 only difference between them is that the @var{RX610} does not support
15513 the @code{MVTIPL} instruction.
15514
15515 @item -mbig-endian-data
15516 @itemx -mlittle-endian-data
15517 @opindex mbig-endian-data
15518 @opindex mlittle-endian-data
15519 Store data (but not code) in the big-endian format.  The default is
15520 @option{-mlittle-endian-data}, ie to store data in the little endian
15521 format.
15522
15523 @item -msmall-data-limit=@var{N}
15524 @opindex msmall-data-limit
15525 Specifies the maximum size in bytes of global and static variables
15526 which can be placed into the small data area.  Using the small data
15527 area can lead to smaller and faster code, but the size of area is
15528 limited and it is up to the programmer to ensure that the area does
15529 not overflow.  Also when the small data area is used one of the RX's
15530 registers (@code{r13}) is reserved for use pointing to this area, so
15531 it is no longer available for use by the compiler.  This could result
15532 in slower and/or larger code if variables which once could have been
15533 held in @code{r13} are now pushed onto the stack.
15534
15535 Note, common variables (variables which have not been initialised) and
15536 constants are not placed into the small data area as they are assigned
15537 to other sections in the output executable.
15538
15539 The default value is zero, which disables this feature.  Note, this
15540 feature is not enabled by default with higher optimization levels
15541 (@option{-O2} etc) because of the potentially detrimental effects of
15542 reserving register @code{r13}.  It is up to the programmer to
15543 experiment and discover whether this feature is of benefit to their
15544 program.
15545
15546 @item -msim
15547 @itemx -mno-sim
15548 @opindex msim
15549 @opindex mno-sim
15550 Use the simulator runtime.  The default is to use the libgloss board
15551 specific runtime.
15552
15553 @item -mas100-syntax
15554 @itemx -mno-as100-syntax
15555 @opindex mas100-syntax
15556 @opindex mno-as100-syntax
15557 When generating assembler output use a syntax that is compatible with
15558 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
15559 assembler but it has some restrictions so generating it is not the
15560 default option.
15561
15562 @item -mmax-constant-size=@var{N}
15563 @opindex mmax-constant-size
15564 Specifies the maxium size, in bytes, of a constant that can be used as
15565 an operand in a RX instruction.  Although the RX instruction set does
15566 allow constants of up to 4 bytes in length to be used in instructions,
15567 a longer value equates to a longer instruction.  Thus in some
15568 circumstances it can be beneficial to restrict the size of constants
15569 that are used in instructions.  Constants that are too big are instead
15570 placed into a constant pool and referenced via register indirection.
15571
15572 The value @var{N} can be between 0 and 3.  A value of 0, the default,
15573 means that constants of any size are allowed.
15574
15575 @item -mrelax
15576 @opindex mrelax
15577 Enable linker relaxation.  Linker relaxation is a process whereby the
15578 linker will attempt to reduce the size of a program by finding shorter
15579 versions of various instructions.  Disabled by default.
15580
15581 @item -mint-register=@var{N}
15582 @opindex mint-register
15583 Specify the number of registers to reserve for fast interrupt handler
15584 functions.  The value @var{N} can be between 0 and 4.  A value of 1
15585 means that register @code{r13} will be reserved for ther exclusive use
15586 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
15587 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
15588 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
15589 A value of 0, the default, does not reserve any registers.
15590
15591 @item -msave-acc-in-interrupts
15592 @opindex msave-acc-in-interrupts
15593 Specifies that interrupt handler functions should preserve the
15594 accumulator register.  This is only necessary if normal code might use
15595 the accumulator register, for example because it performs 64-bit
15596 multiplications.  The default is to ignore the accumulator as this
15597 makes the interrupt handlers faster.
15598
15599 @end table
15600
15601 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
15602 has special significance to the RX port when used with the
15603 @code{interrupt} function attribute.  This attribute indicates a
15604 function intended to process fast interrupts.  GCC will will ensure
15605 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
15606 and/or @code{r13} and only provided that the normal use of the
15607 corresponding registers have been restricted via the
15608 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
15609 options.
15610
15611 @node S/390 and zSeries Options
15612 @subsection S/390 and zSeries Options
15613 @cindex S/390 and zSeries Options
15614
15615 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
15616
15617 @table @gcctabopt
15618 @item -mhard-float
15619 @itemx -msoft-float
15620 @opindex mhard-float
15621 @opindex msoft-float
15622 Use (do not use) the hardware floating-point instructions and registers
15623 for floating-point operations.  When @option{-msoft-float} is specified,
15624 functions in @file{libgcc.a} will be used to perform floating-point
15625 operations.  When @option{-mhard-float} is specified, the compiler
15626 generates IEEE floating-point instructions.  This is the default.
15627
15628 @item -mhard-dfp
15629 @itemx -mno-hard-dfp
15630 @opindex mhard-dfp
15631 @opindex mno-hard-dfp
15632 Use (do not use) the hardware decimal-floating-point instructions for
15633 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
15634 specified, functions in @file{libgcc.a} will be used to perform
15635 decimal-floating-point operations.  When @option{-mhard-dfp} is
15636 specified, the compiler generates decimal-floating-point hardware
15637 instructions.  This is the default for @option{-march=z9-ec} or higher.
15638
15639 @item -mlong-double-64
15640 @itemx -mlong-double-128
15641 @opindex mlong-double-64
15642 @opindex mlong-double-128
15643 These switches control the size of @code{long double} type. A size
15644 of 64bit makes the @code{long double} type equivalent to the @code{double}
15645 type. This is the default.
15646
15647 @item -mbackchain
15648 @itemx -mno-backchain
15649 @opindex mbackchain
15650 @opindex mno-backchain
15651 Store (do not store) the address of the caller's frame as backchain pointer
15652 into the callee's stack frame.
15653 A backchain may be needed to allow debugging using tools that do not understand
15654 DWARF-2 call frame information.
15655 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
15656 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
15657 the backchain is placed into the topmost word of the 96/160 byte register
15658 save area.
15659
15660 In general, code compiled with @option{-mbackchain} is call-compatible with
15661 code compiled with @option{-mmo-backchain}; however, use of the backchain
15662 for debugging purposes usually requires that the whole binary is built with
15663 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
15664 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15665 to build a linux kernel use @option{-msoft-float}.
15666
15667 The default is to not maintain the backchain.
15668
15669 @item -mpacked-stack
15670 @itemx -mno-packed-stack
15671 @opindex mpacked-stack
15672 @opindex mno-packed-stack
15673 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
15674 specified, the compiler uses the all fields of the 96/160 byte register save
15675 area only for their default purpose; unused fields still take up stack space.
15676 When @option{-mpacked-stack} is specified, register save slots are densely
15677 packed at the top of the register save area; unused space is reused for other
15678 purposes, allowing for more efficient use of the available stack space.
15679 However, when @option{-mbackchain} is also in effect, the topmost word of
15680 the save area is always used to store the backchain, and the return address
15681 register is always saved two words below the backchain.
15682
15683 As long as the stack frame backchain is not used, code generated with
15684 @option{-mpacked-stack} is call-compatible with code generated with
15685 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
15686 S/390 or zSeries generated code that uses the stack frame backchain at run
15687 time, not just for debugging purposes.  Such code is not call-compatible
15688 with code compiled with @option{-mpacked-stack}.  Also, note that the
15689 combination of @option{-mbackchain},
15690 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15691 to build a linux kernel use @option{-msoft-float}.
15692
15693 The default is to not use the packed stack layout.
15694
15695 @item -msmall-exec
15696 @itemx -mno-small-exec
15697 @opindex msmall-exec
15698 @opindex mno-small-exec
15699 Generate (or do not generate) code using the @code{bras} instruction
15700 to do subroutine calls.
15701 This only works reliably if the total executable size does not
15702 exceed 64k.  The default is to use the @code{basr} instruction instead,
15703 which does not have this limitation.
15704
15705 @item -m64
15706 @itemx -m31
15707 @opindex m64
15708 @opindex m31
15709 When @option{-m31} is specified, generate code compliant to the
15710 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
15711 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
15712 particular to generate 64-bit instructions.  For the @samp{s390}
15713 targets, the default is @option{-m31}, while the @samp{s390x}
15714 targets default to @option{-m64}.
15715
15716 @item -mzarch
15717 @itemx -mesa
15718 @opindex mzarch
15719 @opindex mesa
15720 When @option{-mzarch} is specified, generate code using the
15721 instructions available on z/Architecture.
15722 When @option{-mesa} is specified, generate code using the
15723 instructions available on ESA/390.  Note that @option{-mesa} is
15724 not possible with @option{-m64}.
15725 When generating code compliant to the GNU/Linux for S/390 ABI,
15726 the default is @option{-mesa}.  When generating code compliant
15727 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
15728
15729 @item -mmvcle
15730 @itemx -mno-mvcle
15731 @opindex mmvcle
15732 @opindex mno-mvcle
15733 Generate (or do not generate) code using the @code{mvcle} instruction
15734 to perform block moves.  When @option{-mno-mvcle} is specified,
15735 use a @code{mvc} loop instead.  This is the default unless optimizing for
15736 size.
15737
15738 @item -mdebug
15739 @itemx -mno-debug
15740 @opindex mdebug
15741 @opindex mno-debug
15742 Print (or do not print) additional debug information when compiling.
15743 The default is to not print debug information.
15744
15745 @item -march=@var{cpu-type}
15746 @opindex march
15747 Generate code that will run on @var{cpu-type}, which is the name of a system
15748 representing a certain processor type.  Possible values for
15749 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
15750 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
15751 When generating code using the instructions available on z/Architecture,
15752 the default is @option{-march=z900}.  Otherwise, the default is
15753 @option{-march=g5}.
15754
15755 @item -mtune=@var{cpu-type}
15756 @opindex mtune
15757 Tune to @var{cpu-type} everything applicable about the generated code,
15758 except for the ABI and the set of available instructions.
15759 The list of @var{cpu-type} values is the same as for @option{-march}.
15760 The default is the value used for @option{-march}.
15761
15762 @item -mtpf-trace
15763 @itemx -mno-tpf-trace
15764 @opindex mtpf-trace
15765 @opindex mno-tpf-trace
15766 Generate code that adds (does not add) in TPF OS specific branches to trace
15767 routines in the operating system.  This option is off by default, even
15768 when compiling for the TPF OS@.
15769
15770 @item -mfused-madd
15771 @itemx -mno-fused-madd
15772 @opindex mfused-madd
15773 @opindex mno-fused-madd
15774 Generate code that uses (does not use) the floating point multiply and
15775 accumulate instructions.  These instructions are generated by default if
15776 hardware floating point is used.
15777
15778 @item -mwarn-framesize=@var{framesize}
15779 @opindex mwarn-framesize
15780 Emit a warning if the current function exceeds the given frame size.  Because
15781 this is a compile time check it doesn't need to be a real problem when the program
15782 runs.  It is intended to identify functions which most probably cause
15783 a stack overflow.  It is useful to be used in an environment with limited stack
15784 size e.g.@: the linux kernel.
15785
15786 @item -mwarn-dynamicstack
15787 @opindex mwarn-dynamicstack
15788 Emit a warning if the function calls alloca or uses dynamically
15789 sized arrays.  This is generally a bad idea with a limited stack size.
15790
15791 @item -mstack-guard=@var{stack-guard}
15792 @itemx -mstack-size=@var{stack-size}
15793 @opindex mstack-guard
15794 @opindex mstack-size
15795 If these options are provided the s390 back end emits additional instructions in
15796 the function prologue which trigger a trap if the stack size is @var{stack-guard}
15797 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
15798 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
15799 the frame size of the compiled function is chosen.
15800 These options are intended to be used to help debugging stack overflow problems.
15801 The additionally emitted code causes only little overhead and hence can also be
15802 used in production like systems without greater performance degradation.  The given
15803 values have to be exact powers of 2 and @var{stack-size} has to be greater than
15804 @var{stack-guard} without exceeding 64k.
15805 In order to be efficient the extra code makes the assumption that the stack starts
15806 at an address aligned to the value given by @var{stack-size}.
15807 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
15808 @end table
15809
15810 @node Score Options
15811 @subsection Score Options
15812 @cindex Score Options
15813
15814 These options are defined for Score implementations:
15815
15816 @table @gcctabopt
15817 @item -meb
15818 @opindex meb
15819 Compile code for big endian mode.  This is the default.
15820
15821 @item -mel
15822 @opindex mel
15823 Compile code for little endian mode.
15824
15825 @item -mnhwloop
15826 @opindex mnhwloop
15827 Disable generate bcnz instruction.
15828
15829 @item -muls
15830 @opindex muls
15831 Enable generate unaligned load and store instruction.
15832
15833 @item -mmac
15834 @opindex mmac
15835 Enable the use of multiply-accumulate instructions. Disabled by default.
15836
15837 @item -mscore5
15838 @opindex mscore5
15839 Specify the SCORE5 as the target architecture.
15840
15841 @item -mscore5u
15842 @opindex mscore5u
15843 Specify the SCORE5U of the target architecture.
15844
15845 @item -mscore7
15846 @opindex mscore7
15847 Specify the SCORE7 as the target architecture. This is the default.
15848
15849 @item -mscore7d
15850 @opindex mscore7d
15851 Specify the SCORE7D as the target architecture.
15852 @end table
15853
15854 @node SH Options
15855 @subsection SH Options
15856
15857 These @samp{-m} options are defined for the SH implementations:
15858
15859 @table @gcctabopt
15860 @item -m1
15861 @opindex m1
15862 Generate code for the SH1.
15863
15864 @item -m2
15865 @opindex m2
15866 Generate code for the SH2.
15867
15868 @item -m2e
15869 Generate code for the SH2e.
15870
15871 @item -m2a-nofpu
15872 @opindex m2a-nofpu
15873 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
15874 that the floating-point unit is not used.
15875
15876 @item -m2a-single-only
15877 @opindex m2a-single-only
15878 Generate code for the SH2a-FPU, in such a way that no double-precision
15879 floating point operations are used.
15880
15881 @item -m2a-single
15882 @opindex m2a-single
15883 Generate code for the SH2a-FPU assuming the floating-point unit is in
15884 single-precision mode by default.
15885
15886 @item -m2a
15887 @opindex m2a
15888 Generate code for the SH2a-FPU assuming the floating-point unit is in
15889 double-precision mode by default.
15890
15891 @item -m3
15892 @opindex m3
15893 Generate code for the SH3.
15894
15895 @item -m3e
15896 @opindex m3e
15897 Generate code for the SH3e.
15898
15899 @item -m4-nofpu
15900 @opindex m4-nofpu
15901 Generate code for the SH4 without a floating-point unit.
15902
15903 @item -m4-single-only
15904 @opindex m4-single-only
15905 Generate code for the SH4 with a floating-point unit that only
15906 supports single-precision arithmetic.
15907
15908 @item -m4-single
15909 @opindex m4-single
15910 Generate code for the SH4 assuming the floating-point unit is in
15911 single-precision mode by default.
15912
15913 @item -m4
15914 @opindex m4
15915 Generate code for the SH4.
15916
15917 @item -m4a-nofpu
15918 @opindex m4a-nofpu
15919 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
15920 floating-point unit is not used.
15921
15922 @item -m4a-single-only
15923 @opindex m4a-single-only
15924 Generate code for the SH4a, in such a way that no double-precision
15925 floating point operations are used.
15926
15927 @item -m4a-single
15928 @opindex m4a-single
15929 Generate code for the SH4a assuming the floating-point unit is in
15930 single-precision mode by default.
15931
15932 @item -m4a
15933 @opindex m4a
15934 Generate code for the SH4a.
15935
15936 @item -m4al
15937 @opindex m4al
15938 Same as @option{-m4a-nofpu}, except that it implicitly passes
15939 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
15940 instructions at the moment.
15941
15942 @item -mb
15943 @opindex mb
15944 Compile code for the processor in big endian mode.
15945
15946 @item -ml
15947 @opindex ml
15948 Compile code for the processor in little endian mode.
15949
15950 @item -mdalign
15951 @opindex mdalign
15952 Align doubles at 64-bit boundaries.  Note that this changes the calling
15953 conventions, and thus some functions from the standard C library will
15954 not work unless you recompile it first with @option{-mdalign}.
15955
15956 @item -mrelax
15957 @opindex mrelax
15958 Shorten some address references at link time, when possible; uses the
15959 linker option @option{-relax}.
15960
15961 @item -mbigtable
15962 @opindex mbigtable
15963 Use 32-bit offsets in @code{switch} tables.  The default is to use
15964 16-bit offsets.
15965
15966 @item -mbitops
15967 @opindex mbitops
15968 Enable the use of bit manipulation instructions on SH2A.
15969
15970 @item -mfmovd
15971 @opindex mfmovd
15972 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
15973 alignment constraints.
15974
15975 @item -mhitachi
15976 @opindex mhitachi
15977 Comply with the calling conventions defined by Renesas.
15978
15979 @item -mrenesas
15980 @opindex mhitachi
15981 Comply with the calling conventions defined by Renesas.
15982
15983 @item -mno-renesas
15984 @opindex mhitachi
15985 Comply with the calling conventions defined for GCC before the Renesas
15986 conventions were available.  This option is the default for all
15987 targets of the SH toolchain except for @samp{sh-symbianelf}.
15988
15989 @item -mnomacsave
15990 @opindex mnomacsave
15991 Mark the @code{MAC} register as call-clobbered, even if
15992 @option{-mhitachi} is given.
15993
15994 @item -mieee
15995 @opindex mieee
15996 Increase IEEE-compliance of floating-point code.
15997 At the moment, this is equivalent to @option{-fno-finite-math-only}.
15998 When generating 16 bit SH opcodes, getting IEEE-conforming results for
15999 comparisons of NANs / infinities incurs extra overhead in every
16000 floating point comparison, therefore the default is set to
16001 @option{-ffinite-math-only}.
16002
16003 @item -minline-ic_invalidate
16004 @opindex minline-ic_invalidate
16005 Inline code to invalidate instruction cache entries after setting up
16006 nested function trampolines.
16007 This option has no effect if -musermode is in effect and the selected
16008 code generation option (e.g. -m4) does not allow the use of the icbi
16009 instruction.
16010 If the selected code generation option does not allow the use of the icbi
16011 instruction, and -musermode is not in effect, the inlined code will
16012 manipulate the instruction cache address array directly with an associative
16013 write.  This not only requires privileged mode, but it will also
16014 fail if the cache line had been mapped via the TLB and has become unmapped.
16015
16016 @item -misize
16017 @opindex misize
16018 Dump instruction size and location in the assembly code.
16019
16020 @item -mpadstruct
16021 @opindex mpadstruct
16022 This option is deprecated.  It pads structures to multiple of 4 bytes,
16023 which is incompatible with the SH ABI@.
16024
16025 @item -mspace
16026 @opindex mspace
16027 Optimize for space instead of speed.  Implied by @option{-Os}.
16028
16029 @item -mprefergot
16030 @opindex mprefergot
16031 When generating position-independent code, emit function calls using
16032 the Global Offset Table instead of the Procedure Linkage Table.
16033
16034 @item -musermode
16035 @opindex musermode
16036 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
16037 if the inlined code would not work in user mode.
16038 This is the default when the target is @code{sh-*-linux*}.
16039
16040 @item -multcost=@var{number}
16041 @opindex multcost=@var{number}
16042 Set the cost to assume for a multiply insn.
16043
16044 @item -mdiv=@var{strategy}
16045 @opindex mdiv=@var{strategy}
16046 Set the division strategy to use for SHmedia code.  @var{strategy} must be
16047 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
16048 inv:call2, inv:fp .
16049 "fp" performs the operation in floating point.  This has a very high latency,
16050 but needs only a few instructions, so it might be a good choice if
16051 your code has enough easily exploitable ILP to allow the compiler to
16052 schedule the floating point instructions together with other instructions.
16053 Division by zero causes a floating point exception.
16054 "inv" uses integer operations to calculate the inverse of the divisor,
16055 and then multiplies the dividend with the inverse.  This strategy allows
16056 cse and hoisting of the inverse calculation.  Division by zero calculates
16057 an unspecified result, but does not trap.
16058 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
16059 have been found, or if the entire operation has been hoisted to the same
16060 place, the last stages of the inverse calculation are intertwined with the
16061 final multiply to reduce the overall latency, at the expense of using a few
16062 more instructions, and thus offering fewer scheduling opportunities with
16063 other code.
16064 "call" calls a library function that usually implements the inv:minlat
16065 strategy.
16066 This gives high code density for m5-*media-nofpu compilations.
16067 "call2" uses a different entry point of the same library function, where it
16068 assumes that a pointer to a lookup table has already been set up, which
16069 exposes the pointer load to cse / code hoisting optimizations.
16070 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
16071 code generation, but if the code stays unoptimized, revert to the "call",
16072 "call2", or "fp" strategies, respectively.  Note that the
16073 potentially-trapping side effect of division by zero is carried by a
16074 separate instruction, so it is possible that all the integer instructions
16075 are hoisted out, but the marker for the side effect stays where it is.
16076 A recombination to fp operations or a call is not possible in that case.
16077 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
16078 that the inverse calculation was nor separated from the multiply, they speed
16079 up division where the dividend fits into 20 bits (plus sign where applicable),
16080 by inserting a test to skip a number of operations in this case; this test
16081 slows down the case of larger dividends.  inv20u assumes the case of a such
16082 a small dividend to be unlikely, and inv20l assumes it to be likely.
16083
16084 @item -mdivsi3_libfunc=@var{name}
16085 @opindex mdivsi3_libfunc=@var{name}
16086 Set the name of the library function used for 32 bit signed division to
16087 @var{name}.  This only affect the name used in the call and inv:call
16088 division strategies, and the compiler will still expect the same
16089 sets of input/output/clobbered registers as if this option was not present.
16090
16091 @item -mfixed-range=@var{register-range}
16092 @opindex mfixed-range
16093 Generate code treating the given register range as fixed registers.
16094 A fixed register is one that the register allocator can not use.  This is
16095 useful when compiling kernel code.  A register range is specified as
16096 two registers separated by a dash.  Multiple register ranges can be
16097 specified separated by a comma.
16098
16099 @item -madjust-unroll
16100 @opindex madjust-unroll
16101 Throttle unrolling to avoid thrashing target registers.
16102 This option only has an effect if the gcc code base supports the
16103 TARGET_ADJUST_UNROLL_MAX target hook.
16104
16105 @item -mindexed-addressing
16106 @opindex mindexed-addressing
16107 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
16108 This is only safe if the hardware and/or OS implement 32 bit wrap-around
16109 semantics for the indexed addressing mode.  The architecture allows the
16110 implementation of processors with 64 bit MMU, which the OS could use to
16111 get 32 bit addressing, but since no current hardware implementation supports
16112 this or any other way to make the indexed addressing mode safe to use in
16113 the 32 bit ABI, the default is -mno-indexed-addressing.
16114
16115 @item -mgettrcost=@var{number}
16116 @opindex mgettrcost=@var{number}
16117 Set the cost assumed for the gettr instruction to @var{number}.
16118 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
16119
16120 @item -mpt-fixed
16121 @opindex mpt-fixed
16122 Assume pt* instructions won't trap.  This will generally generate better
16123 scheduled code, but is unsafe on current hardware.  The current architecture
16124 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
16125 This has the unintentional effect of making it unsafe to schedule ptabs /
16126 ptrel before a branch, or hoist it out of a loop.  For example,
16127 __do_global_ctors, a part of libgcc that runs constructors at program
16128 startup, calls functions in a list which is delimited by @minus{}1.  With the
16129 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
16130 That means that all the constructors will be run a bit quicker, but when
16131 the loop comes to the end of the list, the program crashes because ptabs
16132 loads @minus{}1 into a target register.  Since this option is unsafe for any
16133 hardware implementing the current architecture specification, the default
16134 is -mno-pt-fixed.  Unless the user specifies a specific cost with
16135 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
16136 this deters register allocation using target registers for storing
16137 ordinary integers.
16138
16139 @item -minvalid-symbols
16140 @opindex minvalid-symbols
16141 Assume symbols might be invalid.  Ordinary function symbols generated by
16142 the compiler will always be valid to load with movi/shori/ptabs or
16143 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
16144 to generate symbols that will cause ptabs / ptrel to trap.
16145 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
16146 It will then prevent cross-basic-block cse, hoisting and most scheduling
16147 of symbol loads.  The default is @option{-mno-invalid-symbols}.
16148 @end table
16149
16150 @node SPARC Options
16151 @subsection SPARC Options
16152 @cindex SPARC options
16153
16154 These @samp{-m} options are supported on the SPARC:
16155
16156 @table @gcctabopt
16157 @item -mno-app-regs
16158 @itemx -mapp-regs
16159 @opindex mno-app-regs
16160 @opindex mapp-regs
16161 Specify @option{-mapp-regs} to generate output using the global registers
16162 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
16163 is the default.
16164
16165 To be fully SVR4 ABI compliant at the cost of some performance loss,
16166 specify @option{-mno-app-regs}.  You should compile libraries and system
16167 software with this option.
16168
16169 @item -mfpu
16170 @itemx -mhard-float
16171 @opindex mfpu
16172 @opindex mhard-float
16173 Generate output containing floating point instructions.  This is the
16174 default.
16175
16176 @item -mno-fpu
16177 @itemx -msoft-float
16178 @opindex mno-fpu
16179 @opindex msoft-float
16180 Generate output containing library calls for floating point.
16181 @strong{Warning:} the requisite libraries are not available for all SPARC
16182 targets.  Normally the facilities of the machine's usual C compiler are
16183 used, but this cannot be done directly in cross-compilation.  You must make
16184 your own arrangements to provide suitable library functions for
16185 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
16186 @samp{sparclite-*-*} do provide software floating point support.
16187
16188 @option{-msoft-float} changes the calling convention in the output file;
16189 therefore, it is only useful if you compile @emph{all} of a program with
16190 this option.  In particular, you need to compile @file{libgcc.a}, the
16191 library that comes with GCC, with @option{-msoft-float} in order for
16192 this to work.
16193
16194 @item -mhard-quad-float
16195 @opindex mhard-quad-float
16196 Generate output containing quad-word (long double) floating point
16197 instructions.
16198
16199 @item -msoft-quad-float
16200 @opindex msoft-quad-float
16201 Generate output containing library calls for quad-word (long double)
16202 floating point instructions.  The functions called are those specified
16203 in the SPARC ABI@.  This is the default.
16204
16205 As of this writing, there are no SPARC implementations that have hardware
16206 support for the quad-word floating point instructions.  They all invoke
16207 a trap handler for one of these instructions, and then the trap handler
16208 emulates the effect of the instruction.  Because of the trap handler overhead,
16209 this is much slower than calling the ABI library routines.  Thus the
16210 @option{-msoft-quad-float} option is the default.
16211
16212 @item -mno-unaligned-doubles
16213 @itemx -munaligned-doubles
16214 @opindex mno-unaligned-doubles
16215 @opindex munaligned-doubles
16216 Assume that doubles have 8 byte alignment.  This is the default.
16217
16218 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
16219 alignment only if they are contained in another type, or if they have an
16220 absolute address.  Otherwise, it assumes they have 4 byte alignment.
16221 Specifying this option avoids some rare compatibility problems with code
16222 generated by other compilers.  It is not the default because it results
16223 in a performance loss, especially for floating point code.
16224
16225 @item -mno-faster-structs
16226 @itemx -mfaster-structs
16227 @opindex mno-faster-structs
16228 @opindex mfaster-structs
16229 With @option{-mfaster-structs}, the compiler assumes that structures
16230 should have 8 byte alignment.  This enables the use of pairs of
16231 @code{ldd} and @code{std} instructions for copies in structure
16232 assignment, in place of twice as many @code{ld} and @code{st} pairs.
16233 However, the use of this changed alignment directly violates the SPARC
16234 ABI@.  Thus, it's intended only for use on targets where the developer
16235 acknowledges that their resulting code will not be directly in line with
16236 the rules of the ABI@.
16237
16238 @item -mimpure-text
16239 @opindex mimpure-text
16240 @option{-mimpure-text}, used in addition to @option{-shared}, tells
16241 the compiler to not pass @option{-z text} to the linker when linking a
16242 shared object.  Using this option, you can link position-dependent
16243 code into a shared object.
16244
16245 @option{-mimpure-text} suppresses the ``relocations remain against
16246 allocatable but non-writable sections'' linker error message.
16247 However, the necessary relocations will trigger copy-on-write, and the
16248 shared object is not actually shared across processes.  Instead of
16249 using @option{-mimpure-text}, you should compile all source code with
16250 @option{-fpic} or @option{-fPIC}.
16251
16252 This option is only available on SunOS and Solaris.
16253
16254 @item -mcpu=@var{cpu_type}
16255 @opindex mcpu
16256 Set the instruction set, register set, and instruction scheduling parameters
16257 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
16258 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
16259 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
16260 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
16261 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
16262
16263 Default instruction scheduling parameters are used for values that select
16264 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
16265 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
16266
16267 Here is a list of each supported architecture and their supported
16268 implementations.
16269
16270 @smallexample
16271     v7:             cypress
16272     v8:             supersparc, hypersparc
16273     sparclite:      f930, f934, sparclite86x
16274     sparclet:       tsc701
16275     v9:             ultrasparc, ultrasparc3, niagara, niagara2
16276 @end smallexample
16277
16278 By default (unless configured otherwise), GCC generates code for the V7
16279 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
16280 additionally optimizes it for the Cypress CY7C602 chip, as used in the
16281 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
16282 SPARCStation 1, 2, IPX etc.
16283
16284 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
16285 architecture.  The only difference from V7 code is that the compiler emits
16286 the integer multiply and integer divide instructions which exist in SPARC-V8
16287 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
16288 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
16289 2000 series.
16290
16291 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
16292 the SPARC architecture.  This adds the integer multiply, integer divide step
16293 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
16294 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
16295 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
16296 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
16297 MB86934 chip, which is the more recent SPARClite with FPU@.
16298
16299 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
16300 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
16301 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
16302 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
16303 optimizes it for the TEMIC SPARClet chip.
16304
16305 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
16306 architecture.  This adds 64-bit integer and floating-point move instructions,
16307 3 additional floating-point condition code registers and conditional move
16308 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
16309 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
16310 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
16311 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
16312 @option{-mcpu=niagara}, the compiler additionally optimizes it for
16313 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
16314 additionally optimizes it for Sun UltraSPARC T2 chips.
16315
16316 @item -mtune=@var{cpu_type}
16317 @opindex mtune
16318 Set the instruction scheduling parameters for machine type
16319 @var{cpu_type}, but do not set the instruction set or register set that the
16320 option @option{-mcpu=@var{cpu_type}} would.
16321
16322 The same values for @option{-mcpu=@var{cpu_type}} can be used for
16323 @option{-mtune=@var{cpu_type}}, but the only useful values are those
16324 that select a particular cpu implementation.  Those are @samp{cypress},
16325 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
16326 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
16327 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
16328
16329 @item -mv8plus
16330 @itemx -mno-v8plus
16331 @opindex mv8plus
16332 @opindex mno-v8plus
16333 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
16334 difference from the V8 ABI is that the global and out registers are
16335 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
16336 mode for all SPARC-V9 processors.
16337
16338 @item -mvis
16339 @itemx -mno-vis
16340 @opindex mvis
16341 @opindex mno-vis
16342 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
16343 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
16344 @end table
16345
16346 These @samp{-m} options are supported in addition to the above
16347 on SPARC-V9 processors in 64-bit environments:
16348
16349 @table @gcctabopt
16350 @item -mlittle-endian
16351 @opindex mlittle-endian
16352 Generate code for a processor running in little-endian mode.  It is only
16353 available for a few configurations and most notably not on Solaris and Linux.
16354
16355 @item -m32
16356 @itemx -m64
16357 @opindex m32
16358 @opindex m64
16359 Generate code for a 32-bit or 64-bit environment.
16360 The 32-bit environment sets int, long and pointer to 32 bits.
16361 The 64-bit environment sets int to 32 bits and long and pointer
16362 to 64 bits.
16363
16364 @item -mcmodel=medlow
16365 @opindex mcmodel=medlow
16366 Generate code for the Medium/Low code model: 64-bit addresses, programs
16367 must be linked in the low 32 bits of memory.  Programs can be statically
16368 or dynamically linked.
16369
16370 @item -mcmodel=medmid
16371 @opindex mcmodel=medmid
16372 Generate code for the Medium/Middle code model: 64-bit addresses, programs
16373 must be linked in the low 44 bits of memory, the text and data segments must
16374 be less than 2GB in size and the data segment must be located within 2GB of
16375 the text segment.
16376
16377 @item -mcmodel=medany
16378 @opindex mcmodel=medany
16379 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
16380 may be linked anywhere in memory, the text and data segments must be less
16381 than 2GB in size and the data segment must be located within 2GB of the
16382 text segment.
16383
16384 @item -mcmodel=embmedany
16385 @opindex mcmodel=embmedany
16386 Generate code for the Medium/Anywhere code model for embedded systems:
16387 64-bit addresses, the text and data segments must be less than 2GB in
16388 size, both starting anywhere in memory (determined at link time).  The
16389 global register %g4 points to the base of the data segment.  Programs
16390 are statically linked and PIC is not supported.
16391
16392 @item -mstack-bias
16393 @itemx -mno-stack-bias
16394 @opindex mstack-bias
16395 @opindex mno-stack-bias
16396 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
16397 frame pointer if present, are offset by @minus{}2047 which must be added back
16398 when making stack frame references.  This is the default in 64-bit mode.
16399 Otherwise, assume no such offset is present.
16400 @end table
16401
16402 These switches are supported in addition to the above on Solaris:
16403
16404 @table @gcctabopt
16405 @item -threads
16406 @opindex threads
16407 Add support for multithreading using the Solaris threads library.  This
16408 option sets flags for both the preprocessor and linker.  This option does
16409 not affect the thread safety of object code produced by the compiler or
16410 that of libraries supplied with it.
16411
16412 @item -pthreads
16413 @opindex pthreads
16414 Add support for multithreading using the POSIX threads library.  This
16415 option sets flags for both the preprocessor and linker.  This option does
16416 not affect the thread safety of object code produced  by the compiler or
16417 that of libraries supplied with it.
16418
16419 @item -pthread
16420 @opindex pthread
16421 This is a synonym for @option{-pthreads}.
16422 @end table
16423
16424 @node SPU Options
16425 @subsection SPU Options
16426 @cindex SPU options
16427
16428 These @samp{-m} options are supported on the SPU:
16429
16430 @table @gcctabopt
16431 @item -mwarn-reloc
16432 @itemx -merror-reloc
16433 @opindex mwarn-reloc
16434 @opindex merror-reloc
16435
16436 The loader for SPU does not handle dynamic relocations.  By default, GCC
16437 will give an error when it generates code that requires a dynamic
16438 relocation.  @option{-mno-error-reloc} disables the error,
16439 @option{-mwarn-reloc} will generate a warning instead.
16440
16441 @item -msafe-dma
16442 @itemx -munsafe-dma
16443 @opindex msafe-dma
16444 @opindex munsafe-dma
16445
16446 Instructions which initiate or test completion of DMA must not be
16447 reordered with respect to loads and stores of the memory which is being
16448 accessed.  Users typically address this problem using the volatile
16449 keyword, but that can lead to inefficient code in places where the
16450 memory is known to not change.  Rather than mark the memory as volatile
16451 we treat the DMA instructions as potentially effecting all memory.  With
16452 @option{-munsafe-dma} users must use the volatile keyword to protect
16453 memory accesses.
16454
16455 @item -mbranch-hints
16456 @opindex mbranch-hints
16457
16458 By default, GCC will generate a branch hint instruction to avoid
16459 pipeline stalls for always taken or probably taken branches.  A hint
16460 will not be generated closer than 8 instructions away from its branch.
16461 There is little reason to disable them, except for debugging purposes,
16462 or to make an object a little bit smaller.
16463
16464 @item -msmall-mem
16465 @itemx -mlarge-mem
16466 @opindex msmall-mem
16467 @opindex mlarge-mem
16468
16469 By default, GCC generates code assuming that addresses are never larger
16470 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
16471 a full 32 bit address.
16472
16473 @item -mstdmain
16474 @opindex mstdmain
16475
16476 By default, GCC links against startup code that assumes the SPU-style
16477 main function interface (which has an unconventional parameter list).
16478 With @option{-mstdmain}, GCC will link your program against startup
16479 code that assumes a C99-style interface to @code{main}, including a
16480 local copy of @code{argv} strings.
16481
16482 @item -mfixed-range=@var{register-range}
16483 @opindex mfixed-range
16484 Generate code treating the given register range as fixed registers.
16485 A fixed register is one that the register allocator can not use.  This is
16486 useful when compiling kernel code.  A register range is specified as
16487 two registers separated by a dash.  Multiple register ranges can be
16488 specified separated by a comma.
16489
16490 @item -mea32
16491 @itemx -mea64
16492 @opindex mea32
16493 @opindex mea64
16494 Compile code assuming that pointers to the PPU address space accessed
16495 via the @code{__ea} named address space qualifier are either 32 or 64
16496 bits wide.  The default is 32 bits.  As this is an ABI changing option,
16497 all object code in an executable must be compiled with the same setting.
16498
16499 @item -maddress-space-conversion
16500 @itemx -mno-address-space-conversion
16501 @opindex maddress-space-conversion
16502 @opindex mno-address-space-conversion
16503 Allow/disallow treating the @code{__ea} address space as superset
16504 of the generic address space.  This enables explicit type casts
16505 between @code{__ea} and generic pointer as well as implicit
16506 conversions of generic pointers to @code{__ea} pointers.  The
16507 default is to allow address space pointer conversions.
16508
16509 @item -mcache-size=@var{cache-size}
16510 @opindex mcache-size
16511 This option controls the version of libgcc that the compiler links to an
16512 executable and selects a software-managed cache for accessing variables
16513 in the @code{__ea} address space with a particular cache size.  Possible
16514 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
16515 and @samp{128}.  The default cache size is 64KB.
16516
16517 @item -matomic-updates
16518 @itemx -mno-atomic-updates
16519 @opindex matomic-updates
16520 @opindex mno-atomic-updates
16521 This option controls the version of libgcc that the compiler links to an
16522 executable and selects whether atomic updates to the software-managed
16523 cache of PPU-side variables are used.  If you use atomic updates, changes
16524 to a PPU variable from SPU code using the @code{__ea} named address space
16525 qualifier will not interfere with changes to other PPU variables residing
16526 in the same cache line from PPU code.  If you do not use atomic updates,
16527 such interference may occur; however, writing back cache lines will be
16528 more efficient.  The default behavior is to use atomic updates.
16529
16530 @item -mdual-nops
16531 @itemx -mdual-nops=@var{n}
16532 @opindex mdual-nops
16533 By default, GCC will insert nops to increase dual issue when it expects
16534 it to increase performance.  @var{n} can be a value from 0 to 10.  A
16535 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
16536 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
16537
16538 @item -mhint-max-nops=@var{n}
16539 @opindex mhint-max-nops
16540 Maximum number of nops to insert for a branch hint.  A branch hint must
16541 be at least 8 instructions away from the branch it is effecting.  GCC
16542 will insert up to @var{n} nops to enforce this, otherwise it will not
16543 generate the branch hint.
16544
16545 @item -mhint-max-distance=@var{n}
16546 @opindex mhint-max-distance
16547 The encoding of the branch hint instruction limits the hint to be within
16548 256 instructions of the branch it is effecting.  By default, GCC makes
16549 sure it is within 125.
16550
16551 @item -msafe-hints
16552 @opindex msafe-hints
16553 Work around a hardware bug which causes the SPU to stall indefinitely.
16554 By default, GCC will insert the @code{hbrp} instruction to make sure
16555 this stall won't happen.
16556
16557 @end table
16558
16559 @node System V Options
16560 @subsection Options for System V
16561
16562 These additional options are available on System V Release 4 for
16563 compatibility with other compilers on those systems:
16564
16565 @table @gcctabopt
16566 @item -G
16567 @opindex G
16568 Create a shared object.
16569 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
16570
16571 @item -Qy
16572 @opindex Qy
16573 Identify the versions of each tool used by the compiler, in a
16574 @code{.ident} assembler directive in the output.
16575
16576 @item -Qn
16577 @opindex Qn
16578 Refrain from adding @code{.ident} directives to the output file (this is
16579 the default).
16580
16581 @item -YP,@var{dirs}
16582 @opindex YP
16583 Search the directories @var{dirs}, and no others, for libraries
16584 specified with @option{-l}.
16585
16586 @item -Ym,@var{dir}
16587 @opindex Ym
16588 Look in the directory @var{dir} to find the M4 preprocessor.
16589 The assembler uses this option.
16590 @c This is supposed to go with a -Yd for predefined M4 macro files, but
16591 @c the generic assembler that comes with Solaris takes just -Ym.
16592 @end table
16593
16594 @node V850 Options
16595 @subsection V850 Options
16596 @cindex V850 Options
16597
16598 These @samp{-m} options are defined for V850 implementations:
16599
16600 @table @gcctabopt
16601 @item -mlong-calls
16602 @itemx -mno-long-calls
16603 @opindex mlong-calls
16604 @opindex mno-long-calls
16605 Treat all calls as being far away (near).  If calls are assumed to be
16606 far away, the compiler will always load the functions address up into a
16607 register, and call indirect through the pointer.
16608
16609 @item -mno-ep
16610 @itemx -mep
16611 @opindex mno-ep
16612 @opindex mep
16613 Do not optimize (do optimize) basic blocks that use the same index
16614 pointer 4 or more times to copy pointer into the @code{ep} register, and
16615 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
16616 option is on by default if you optimize.
16617
16618 @item -mno-prolog-function
16619 @itemx -mprolog-function
16620 @opindex mno-prolog-function
16621 @opindex mprolog-function
16622 Do not use (do use) external functions to save and restore registers
16623 at the prologue and epilogue of a function.  The external functions
16624 are slower, but use less code space if more than one function saves
16625 the same number of registers.  The @option{-mprolog-function} option
16626 is on by default if you optimize.
16627
16628 @item -mspace
16629 @opindex mspace
16630 Try to make the code as small as possible.  At present, this just turns
16631 on the @option{-mep} and @option{-mprolog-function} options.
16632
16633 @item -mtda=@var{n}
16634 @opindex mtda
16635 Put static or global variables whose size is @var{n} bytes or less into
16636 the tiny data area that register @code{ep} points to.  The tiny data
16637 area can hold up to 256 bytes in total (128 bytes for byte references).
16638
16639 @item -msda=@var{n}
16640 @opindex msda
16641 Put static or global variables whose size is @var{n} bytes or less into
16642 the small data area that register @code{gp} points to.  The small data
16643 area can hold up to 64 kilobytes.
16644
16645 @item -mzda=@var{n}
16646 @opindex mzda
16647 Put static or global variables whose size is @var{n} bytes or less into
16648 the first 32 kilobytes of memory.
16649
16650 @item -mv850
16651 @opindex mv850
16652 Specify that the target processor is the V850.
16653
16654 @item -mbig-switch
16655 @opindex mbig-switch
16656 Generate code suitable for big switch tables.  Use this option only if
16657 the assembler/linker complain about out of range branches within a switch
16658 table.
16659
16660 @item -mapp-regs
16661 @opindex mapp-regs
16662 This option will cause r2 and r5 to be used in the code generated by
16663 the compiler.  This setting is the default.
16664
16665 @item -mno-app-regs
16666 @opindex mno-app-regs
16667 This option will cause r2 and r5 to be treated as fixed registers.
16668
16669 @item -mv850e1
16670 @opindex mv850e1
16671 Specify that the target processor is the V850E1.  The preprocessor
16672 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
16673 this option is used.
16674
16675 @item -mv850e
16676 @opindex mv850e
16677 Specify that the target processor is the V850E@.  The preprocessor
16678 constant @samp{__v850e__} will be defined if this option is used.
16679
16680 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
16681 are defined then a default target processor will be chosen and the
16682 relevant @samp{__v850*__} preprocessor constant will be defined.
16683
16684 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
16685 defined, regardless of which processor variant is the target.
16686
16687 @item -mdisable-callt
16688 @opindex mdisable-callt
16689 This option will suppress generation of the CALLT instruction for the
16690 v850e and v850e1 flavors of the v850 architecture.  The default is
16691 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
16692
16693 @end table
16694
16695 @node VAX Options
16696 @subsection VAX Options
16697 @cindex VAX options
16698
16699 These @samp{-m} options are defined for the VAX:
16700
16701 @table @gcctabopt
16702 @item -munix
16703 @opindex munix
16704 Do not output certain jump instructions (@code{aobleq} and so on)
16705 that the Unix assembler for the VAX cannot handle across long
16706 ranges.
16707
16708 @item -mgnu
16709 @opindex mgnu
16710 Do output those jump instructions, on the assumption that you
16711 will assemble with the GNU assembler.
16712
16713 @item -mg
16714 @opindex mg
16715 Output code for g-format floating point numbers instead of d-format.
16716 @end table
16717
16718 @node VxWorks Options
16719 @subsection VxWorks Options
16720 @cindex VxWorks Options
16721
16722 The options in this section are defined for all VxWorks targets.
16723 Options specific to the target hardware are listed with the other
16724 options for that target.
16725
16726 @table @gcctabopt
16727 @item -mrtp
16728 @opindex mrtp
16729 GCC can generate code for both VxWorks kernels and real time processes
16730 (RTPs).  This option switches from the former to the latter.  It also
16731 defines the preprocessor macro @code{__RTP__}.
16732
16733 @item -non-static
16734 @opindex non-static
16735 Link an RTP executable against shared libraries rather than static
16736 libraries.  The options @option{-static} and @option{-shared} can
16737 also be used for RTPs (@pxref{Link Options}); @option{-static}
16738 is the default.
16739
16740 @item -Bstatic
16741 @itemx -Bdynamic
16742 @opindex Bstatic
16743 @opindex Bdynamic
16744 These options are passed down to the linker.  They are defined for
16745 compatibility with Diab.
16746
16747 @item -Xbind-lazy
16748 @opindex Xbind-lazy
16749 Enable lazy binding of function calls.  This option is equivalent to
16750 @option{-Wl,-z,now} and is defined for compatibility with Diab.
16751
16752 @item -Xbind-now
16753 @opindex Xbind-now
16754 Disable lazy binding of function calls.  This option is the default and
16755 is defined for compatibility with Diab.
16756 @end table
16757
16758 @node x86-64 Options
16759 @subsection x86-64 Options
16760 @cindex x86-64 options
16761
16762 These are listed under @xref{i386 and x86-64 Options}.
16763
16764 @node i386 and x86-64 Windows Options
16765 @subsection i386 and x86-64 Windows Options
16766 @cindex i386 and x86-64 Windows Options
16767
16768 These additional options are available for Windows targets:
16769
16770 @table @gcctabopt
16771 @item -mconsole
16772 @opindex mconsole
16773 This option is available for Cygwin and MinGW targets.  It
16774 specifies that a console application is to be generated, by
16775 instructing the linker to set the PE header subsystem type
16776 required for console applications.
16777 This is the default behavior for Cygwin and MinGW targets.
16778
16779 @item -mcygwin
16780 @opindex mcygwin
16781 This option is available for Cygwin targets.  It specifies that
16782 the Cygwin internal interface is to be used for predefined
16783 preprocessor macros, C runtime libraries and related linker
16784 paths and options.  For Cygwin targets this is the default behavior.
16785 This option is deprecated and will be removed in a future release.
16786
16787 @item -mno-cygwin
16788 @opindex mno-cygwin
16789 This option is available for Cygwin targets.  It specifies that
16790 the MinGW internal interface is to be used instead of Cygwin's, by
16791 setting MinGW-related predefined macros and linker paths and default
16792 library options.
16793 This option is deprecated and will be removed in a future release.
16794
16795 @item -mdll
16796 @opindex mdll
16797 This option is available for Cygwin and MinGW targets.  It
16798 specifies that a DLL - a dynamic link library - is to be
16799 generated, enabling the selection of the required runtime
16800 startup object and entry point.
16801
16802 @item -mnop-fun-dllimport
16803 @opindex mnop-fun-dllimport
16804 This option is available for Cygwin and MinGW targets.  It
16805 specifies that the dllimport attribute should be ignored.
16806
16807 @item -mthread
16808 @opindex mthread
16809 This option is available for MinGW targets. It specifies
16810 that MinGW-specific thread support is to be used.
16811
16812 @item -municode
16813 @opindex municode
16814 This option is available for mingw-w64 targets.  It specifies
16815 that the UNICODE macro is getting pre-defined and that the
16816 unicode capable runtime startup code is chosen.
16817
16818 @item -mwin32
16819 @opindex mwin32
16820 This option is available for Cygwin and MinGW targets.  It
16821 specifies that the typical Windows pre-defined macros are to
16822 be set in the pre-processor, but does not influence the choice
16823 of runtime library/startup code.
16824
16825 @item -mwindows
16826 @opindex mwindows
16827 This option is available for Cygwin and MinGW targets.  It
16828 specifies that a GUI application is to be generated by
16829 instructing the linker to set the PE header subsystem type
16830 appropriately.
16831
16832 @item -fno-set-stack-executable
16833 @opindex fno-set-stack-executable
16834 This option is available for MinGW targets. It specifies that
16835 the executable flag for stack used by nested functions isn't
16836 set. This is necessary for binaries running in kernel mode of
16837 Windows, as there the user32 API, which is used to set executable
16838 privileges, isn't available.
16839
16840 @item -mpe-aligned-commons
16841 @opindex mpe-aligned-commons
16842 This option is available for Cygwin and MinGW targets.  It
16843 specifies that the GNU extension to the PE file format that
16844 permits the correct alignment of COMMON variables should be
16845 used when generating code.  It will be enabled by default if
16846 GCC detects that the target assembler found during configuration
16847 supports the feature.
16848 @end table
16849
16850 See also under @ref{i386 and x86-64 Options} for standard options.
16851
16852 @node Xstormy16 Options
16853 @subsection Xstormy16 Options
16854 @cindex Xstormy16 Options
16855
16856 These options are defined for Xstormy16:
16857
16858 @table @gcctabopt
16859 @item -msim
16860 @opindex msim
16861 Choose startup files and linker script suitable for the simulator.
16862 @end table
16863
16864 @node Xtensa Options
16865 @subsection Xtensa Options
16866 @cindex Xtensa Options
16867
16868 These options are supported for Xtensa targets:
16869
16870 @table @gcctabopt
16871 @item -mconst16
16872 @itemx -mno-const16
16873 @opindex mconst16
16874 @opindex mno-const16
16875 Enable or disable use of @code{CONST16} instructions for loading
16876 constant values.  The @code{CONST16} instruction is currently not a
16877 standard option from Tensilica.  When enabled, @code{CONST16}
16878 instructions are always used in place of the standard @code{L32R}
16879 instructions.  The use of @code{CONST16} is enabled by default only if
16880 the @code{L32R} instruction is not available.
16881
16882 @item -mfused-madd
16883 @itemx -mno-fused-madd
16884 @opindex mfused-madd
16885 @opindex mno-fused-madd
16886 Enable or disable use of fused multiply/add and multiply/subtract
16887 instructions in the floating-point option.  This has no effect if the
16888 floating-point option is not also enabled.  Disabling fused multiply/add
16889 and multiply/subtract instructions forces the compiler to use separate
16890 instructions for the multiply and add/subtract operations.  This may be
16891 desirable in some cases where strict IEEE 754-compliant results are
16892 required: the fused multiply add/subtract instructions do not round the
16893 intermediate result, thereby producing results with @emph{more} bits of
16894 precision than specified by the IEEE standard.  Disabling fused multiply
16895 add/subtract instructions also ensures that the program output is not
16896 sensitive to the compiler's ability to combine multiply and add/subtract
16897 operations.
16898
16899 @item -mserialize-volatile
16900 @itemx -mno-serialize-volatile
16901 @opindex mserialize-volatile
16902 @opindex mno-serialize-volatile
16903 When this option is enabled, GCC inserts @code{MEMW} instructions before
16904 @code{volatile} memory references to guarantee sequential consistency.
16905 The default is @option{-mserialize-volatile}.  Use
16906 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
16907
16908 @item -mtext-section-literals
16909 @itemx -mno-text-section-literals
16910 @opindex mtext-section-literals
16911 @opindex mno-text-section-literals
16912 Control the treatment of literal pools.  The default is
16913 @option{-mno-text-section-literals}, which places literals in a separate
16914 section in the output file.  This allows the literal pool to be placed
16915 in a data RAM/ROM, and it also allows the linker to combine literal
16916 pools from separate object files to remove redundant literals and
16917 improve code size.  With @option{-mtext-section-literals}, the literals
16918 are interspersed in the text section in order to keep them as close as
16919 possible to their references.  This may be necessary for large assembly
16920 files.
16921
16922 @item -mtarget-align
16923 @itemx -mno-target-align
16924 @opindex mtarget-align
16925 @opindex mno-target-align
16926 When this option is enabled, GCC instructs the assembler to
16927 automatically align instructions to reduce branch penalties at the
16928 expense of some code density.  The assembler attempts to widen density
16929 instructions to align branch targets and the instructions following call
16930 instructions.  If there are not enough preceding safe density
16931 instructions to align a target, no widening will be performed.  The
16932 default is @option{-mtarget-align}.  These options do not affect the
16933 treatment of auto-aligned instructions like @code{LOOP}, which the
16934 assembler will always align, either by widening density instructions or
16935 by inserting no-op instructions.
16936
16937 @item -mlongcalls
16938 @itemx -mno-longcalls
16939 @opindex mlongcalls
16940 @opindex mno-longcalls
16941 When this option is enabled, GCC instructs the assembler to translate
16942 direct calls to indirect calls unless it can determine that the target
16943 of a direct call is in the range allowed by the call instruction.  This
16944 translation typically occurs for calls to functions in other source
16945 files.  Specifically, the assembler translates a direct @code{CALL}
16946 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
16947 The default is @option{-mno-longcalls}.  This option should be used in
16948 programs where the call target can potentially be out of range.  This
16949 option is implemented in the assembler, not the compiler, so the
16950 assembly code generated by GCC will still show direct call
16951 instructions---look at the disassembled object code to see the actual
16952 instructions.  Note that the assembler will use an indirect call for
16953 every cross-file call, not just those that really will be out of range.
16954 @end table
16955
16956 @node zSeries Options
16957 @subsection zSeries Options
16958 @cindex zSeries options
16959
16960 These are listed under @xref{S/390 and zSeries Options}.
16961
16962 @node Code Gen Options
16963 @section Options for Code Generation Conventions
16964 @cindex code generation conventions
16965 @cindex options, code generation
16966 @cindex run-time options
16967
16968 These machine-independent options control the interface conventions
16969 used in code generation.
16970
16971 Most of them have both positive and negative forms; the negative form
16972 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
16973 one of the forms is listed---the one which is not the default.  You
16974 can figure out the other form by either removing @samp{no-} or adding
16975 it.
16976
16977 @table @gcctabopt
16978 @item -fbounds-check
16979 @opindex fbounds-check
16980 For front-ends that support it, generate additional code to check that
16981 indices used to access arrays are within the declared range.  This is
16982 currently only supported by the Java and Fortran front-ends, where
16983 this option defaults to true and false respectively.
16984
16985 @item -ftrapv
16986 @opindex ftrapv
16987 This option generates traps for signed overflow on addition, subtraction,
16988 multiplication operations.
16989
16990 @item -fwrapv
16991 @opindex fwrapv
16992 This option instructs the compiler to assume that signed arithmetic
16993 overflow of addition, subtraction and multiplication wraps around
16994 using twos-complement representation.  This flag enables some optimizations
16995 and disables others.  This option is enabled by default for the Java
16996 front-end, as required by the Java language specification.
16997
16998 @item -fexceptions
16999 @opindex fexceptions
17000 Enable exception handling.  Generates extra code needed to propagate
17001 exceptions.  For some targets, this implies GCC will generate frame
17002 unwind information for all functions, which can produce significant data
17003 size overhead, although it does not affect execution.  If you do not
17004 specify this option, GCC will enable it by default for languages like
17005 C++ which normally require exception handling, and disable it for
17006 languages like C that do not normally require it.  However, you may need
17007 to enable this option when compiling C code that needs to interoperate
17008 properly with exception handlers written in C++.  You may also wish to
17009 disable this option if you are compiling older C++ programs that don't
17010 use exception handling.
17011
17012 @item -fnon-call-exceptions
17013 @opindex fnon-call-exceptions
17014 Generate code that allows trapping instructions to throw exceptions.
17015 Note that this requires platform-specific runtime support that does
17016 not exist everywhere.  Moreover, it only allows @emph{trapping}
17017 instructions to throw exceptions, i.e.@: memory references or floating
17018 point instructions.  It does not allow exceptions to be thrown from
17019 arbitrary signal handlers such as @code{SIGALRM}.
17020
17021 @item -funwind-tables
17022 @opindex funwind-tables
17023 Similar to @option{-fexceptions}, except that it will just generate any needed
17024 static data, but will not affect the generated code in any other way.
17025 You will normally not enable this option; instead, a language processor
17026 that needs this handling would enable it on your behalf.
17027
17028 @item -fasynchronous-unwind-tables
17029 @opindex fasynchronous-unwind-tables
17030 Generate unwind table in dwarf2 format, if supported by target machine.  The
17031 table is exact at each instruction boundary, so it can be used for stack
17032 unwinding from asynchronous events (such as debugger or garbage collector).
17033
17034 @item -fpcc-struct-return
17035 @opindex fpcc-struct-return
17036 Return ``short'' @code{struct} and @code{union} values in memory like
17037 longer ones, rather than in registers.  This convention is less
17038 efficient, but it has the advantage of allowing intercallability between
17039 GCC-compiled files and files compiled with other compilers, particularly
17040 the Portable C Compiler (pcc).
17041
17042 The precise convention for returning structures in memory depends
17043 on the target configuration macros.
17044
17045 Short structures and unions are those whose size and alignment match
17046 that of some integer type.
17047
17048 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
17049 switch is not binary compatible with code compiled with the
17050 @option{-freg-struct-return} switch.
17051 Use it to conform to a non-default application binary interface.
17052
17053 @item -freg-struct-return
17054 @opindex freg-struct-return
17055 Return @code{struct} and @code{union} values in registers when possible.
17056 This is more efficient for small structures than
17057 @option{-fpcc-struct-return}.
17058
17059 If you specify neither @option{-fpcc-struct-return} nor
17060 @option{-freg-struct-return}, GCC defaults to whichever convention is
17061 standard for the target.  If there is no standard convention, GCC
17062 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
17063 the principal compiler.  In those cases, we can choose the standard, and
17064 we chose the more efficient register return alternative.
17065
17066 @strong{Warning:} code compiled with the @option{-freg-struct-return}
17067 switch is not binary compatible with code compiled with the
17068 @option{-fpcc-struct-return} switch.
17069 Use it to conform to a non-default application binary interface.
17070
17071 @item -fshort-enums
17072 @opindex fshort-enums
17073 Allocate to an @code{enum} type only as many bytes as it needs for the
17074 declared range of possible values.  Specifically, the @code{enum} type
17075 will be equivalent to the smallest integer type which has enough room.
17076
17077 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
17078 code that is not binary compatible with code generated without that switch.
17079 Use it to conform to a non-default application binary interface.
17080
17081 @item -fshort-double
17082 @opindex fshort-double
17083 Use the same size for @code{double} as for @code{float}.
17084
17085 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
17086 code that is not binary compatible with code generated without that switch.
17087 Use it to conform to a non-default application binary interface.
17088
17089 @item -fshort-wchar
17090 @opindex fshort-wchar
17091 Override the underlying type for @samp{wchar_t} to be @samp{short
17092 unsigned int} instead of the default for the target.  This option is
17093 useful for building programs to run under WINE@.
17094
17095 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
17096 code that is not binary compatible with code generated without that switch.
17097 Use it to conform to a non-default application binary interface.
17098
17099 @item -fno-common
17100 @opindex fno-common
17101 In C code, controls the placement of uninitialized global variables.
17102 Unix C compilers have traditionally permitted multiple definitions of
17103 such variables in different compilation units by placing the variables
17104 in a common block.
17105 This is the behavior specified by @option{-fcommon}, and is the default
17106 for GCC on most targets.
17107 On the other hand, this behavior is not required by ISO C, and on some
17108 targets may carry a speed or code size penalty on variable references.
17109 The @option{-fno-common} option specifies that the compiler should place
17110 uninitialized global variables in the data section of the object file,
17111 rather than generating them as common blocks.
17112 This has the effect that if the same variable is declared
17113 (without @code{extern}) in two different compilations,
17114 you will get a multiple-definition error when you link them.
17115 In this case, you must compile with @option{-fcommon} instead.
17116 Compiling with @option{-fno-common} is useful on targets for which
17117 it provides better performance, or if you wish to verify that the
17118 program will work on other systems which always treat uninitialized
17119 variable declarations this way.
17120
17121 @item -fno-ident
17122 @opindex fno-ident
17123 Ignore the @samp{#ident} directive.
17124
17125 @item -finhibit-size-directive
17126 @opindex finhibit-size-directive
17127 Don't output a @code{.size} assembler directive, or anything else that
17128 would cause trouble if the function is split in the middle, and the
17129 two halves are placed at locations far apart in memory.  This option is
17130 used when compiling @file{crtstuff.c}; you should not need to use it
17131 for anything else.
17132
17133 @item -fverbose-asm
17134 @opindex fverbose-asm
17135 Put extra commentary information in the generated assembly code to
17136 make it more readable.  This option is generally only of use to those
17137 who actually need to read the generated assembly code (perhaps while
17138 debugging the compiler itself).
17139
17140 @option{-fno-verbose-asm}, the default, causes the
17141 extra information to be omitted and is useful when comparing two assembler
17142 files.
17143
17144 @item -frecord-gcc-switches
17145 @opindex frecord-gcc-switches
17146 This switch causes the command line that was used to invoke the
17147 compiler to be recorded into the object file that is being created.
17148 This switch is only implemented on some targets and the exact format
17149 of the recording is target and binary file format dependent, but it
17150 usually takes the form of a section containing ASCII text.  This
17151 switch is related to the @option{-fverbose-asm} switch, but that
17152 switch only records information in the assembler output file as
17153 comments, so it never reaches the object file.
17154
17155 @item -fpic
17156 @opindex fpic
17157 @cindex global offset table
17158 @cindex PIC
17159 Generate position-independent code (PIC) suitable for use in a shared
17160 library, if supported for the target machine.  Such code accesses all
17161 constant addresses through a global offset table (GOT)@.  The dynamic
17162 loader resolves the GOT entries when the program starts (the dynamic
17163 loader is not part of GCC; it is part of the operating system).  If
17164 the GOT size for the linked executable exceeds a machine-specific
17165 maximum size, you get an error message from the linker indicating that
17166 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
17167 instead.  (These maximums are 8k on the SPARC and 32k
17168 on the m68k and RS/6000.  The 386 has no such limit.)
17169
17170 Position-independent code requires special support, and therefore works
17171 only on certain machines.  For the 386, GCC supports PIC for System V
17172 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
17173 position-independent.
17174
17175 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17176 are defined to 1.
17177
17178 @item -fPIC
17179 @opindex fPIC
17180 If supported for the target machine, emit position-independent code,
17181 suitable for dynamic linking and avoiding any limit on the size of the
17182 global offset table.  This option makes a difference on the m68k,
17183 PowerPC and SPARC@.
17184
17185 Position-independent code requires special support, and therefore works
17186 only on certain machines.
17187
17188 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17189 are defined to 2.
17190
17191 @item -fpie
17192 @itemx -fPIE
17193 @opindex fpie
17194 @opindex fPIE
17195 These options are similar to @option{-fpic} and @option{-fPIC}, but
17196 generated position independent code can be only linked into executables.
17197 Usually these options are used when @option{-pie} GCC option will be
17198 used during linking.
17199
17200 @option{-fpie} and @option{-fPIE} both define the macros
17201 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
17202 for @option{-fpie} and 2 for @option{-fPIE}.
17203
17204 @item -fno-jump-tables
17205 @opindex fno-jump-tables
17206 Do not use jump tables for switch statements even where it would be
17207 more efficient than other code generation strategies.  This option is
17208 of use in conjunction with @option{-fpic} or @option{-fPIC} for
17209 building code which forms part of a dynamic linker and cannot
17210 reference the address of a jump table.  On some targets, jump tables
17211 do not require a GOT and this option is not needed.
17212
17213 @item -ffixed-@var{reg}
17214 @opindex ffixed
17215 Treat the register named @var{reg} as a fixed register; generated code
17216 should never refer to it (except perhaps as a stack pointer, frame
17217 pointer or in some other fixed role).
17218
17219 @var{reg} must be the name of a register.  The register names accepted
17220 are machine-specific and are defined in the @code{REGISTER_NAMES}
17221 macro in the machine description macro file.
17222
17223 This flag does not have a negative form, because it specifies a
17224 three-way choice.
17225
17226 @item -fcall-used-@var{reg}
17227 @opindex fcall-used
17228 Treat the register named @var{reg} as an allocable register that is
17229 clobbered by function calls.  It may be allocated for temporaries or
17230 variables that do not live across a call.  Functions compiled this way
17231 will not save and restore the register @var{reg}.
17232
17233 It is an error to used this flag with the frame pointer or stack pointer.
17234 Use of this flag for other registers that have fixed pervasive roles in
17235 the machine's execution model will produce disastrous results.
17236
17237 This flag does not have a negative form, because it specifies a
17238 three-way choice.
17239
17240 @item -fcall-saved-@var{reg}
17241 @opindex fcall-saved
17242 Treat the register named @var{reg} as an allocable register saved by
17243 functions.  It may be allocated even for temporaries or variables that
17244 live across a call.  Functions compiled this way will save and restore
17245 the register @var{reg} if they use it.
17246
17247 It is an error to used this flag with the frame pointer or stack pointer.
17248 Use of this flag for other registers that have fixed pervasive roles in
17249 the machine's execution model will produce disastrous results.
17250
17251 A different sort of disaster will result from the use of this flag for
17252 a register in which function values may be returned.
17253
17254 This flag does not have a negative form, because it specifies a
17255 three-way choice.
17256
17257 @item -fpack-struct[=@var{n}]
17258 @opindex fpack-struct
17259 Without a value specified, pack all structure members together without
17260 holes.  When a value is specified (which must be a small power of two), pack
17261 structure members according to this value, representing the maximum
17262 alignment (that is, objects with default alignment requirements larger than
17263 this will be output potentially unaligned at the next fitting location.
17264
17265 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
17266 code that is not binary compatible with code generated without that switch.
17267 Additionally, it makes the code suboptimal.
17268 Use it to conform to a non-default application binary interface.
17269
17270 @item -finstrument-functions
17271 @opindex finstrument-functions
17272 Generate instrumentation calls for entry and exit to functions.  Just
17273 after function entry and just before function exit, the following
17274 profiling functions will be called with the address of the current
17275 function and its call site.  (On some platforms,
17276 @code{__builtin_return_address} does not work beyond the current
17277 function, so the call site information may not be available to the
17278 profiling functions otherwise.)
17279
17280 @smallexample
17281 void __cyg_profile_func_enter (void *this_fn,
17282                                void *call_site);
17283 void __cyg_profile_func_exit  (void *this_fn,
17284                                void *call_site);
17285 @end smallexample
17286
17287 The first argument is the address of the start of the current function,
17288 which may be looked up exactly in the symbol table.
17289
17290 This instrumentation is also done for functions expanded inline in other
17291 functions.  The profiling calls will indicate where, conceptually, the
17292 inline function is entered and exited.  This means that addressable
17293 versions of such functions must be available.  If all your uses of a
17294 function are expanded inline, this may mean an additional expansion of
17295 code size.  If you use @samp{extern inline} in your C code, an
17296 addressable version of such functions must be provided.  (This is
17297 normally the case anyways, but if you get lucky and the optimizer always
17298 expands the functions inline, you might have gotten away without
17299 providing static copies.)
17300
17301 A function may be given the attribute @code{no_instrument_function}, in
17302 which case this instrumentation will not be done.  This can be used, for
17303 example, for the profiling functions listed above, high-priority
17304 interrupt routines, and any functions from which the profiling functions
17305 cannot safely be called (perhaps signal handlers, if the profiling
17306 routines generate output or allocate memory).
17307
17308 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
17309 @opindex finstrument-functions-exclude-file-list
17310
17311 Set the list of functions that are excluded from instrumentation (see
17312 the description of @code{-finstrument-functions}).  If the file that
17313 contains a function definition matches with one of @var{file}, then
17314 that function is not instrumented.  The match is done on substrings:
17315 if the @var{file} parameter is a substring of the file name, it is
17316 considered to be a match.
17317
17318 For example,
17319 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
17320 will exclude any inline function defined in files whose pathnames
17321 contain @code{/bits/stl} or @code{include/sys}.
17322
17323 If, for some reason, you want to include letter @code{','} in one of
17324 @var{sym}, write @code{'\,'}. For example,
17325 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
17326 (note the single quote surrounding the option).
17327
17328 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
17329 @opindex finstrument-functions-exclude-function-list
17330
17331 This is similar to @code{-finstrument-functions-exclude-file-list},
17332 but this option sets the list of function names to be excluded from
17333 instrumentation.  The function name to be matched is its user-visible
17334 name, such as @code{vector<int> blah(const vector<int> &)}, not the
17335 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
17336 match is done on substrings: if the @var{sym} parameter is a substring
17337 of the function name, it is considered to be a match.  For C99 and C++
17338 extended identifiers, the function name must be given in UTF-8, not
17339 using universal character names.
17340
17341 @item -fstack-check
17342 @opindex fstack-check
17343 Generate code to verify that you do not go beyond the boundary of the
17344 stack.  You should specify this flag if you are running in an
17345 environment with multiple threads, but only rarely need to specify it in
17346 a single-threaded environment since stack overflow is automatically
17347 detected on nearly all systems if there is only one stack.
17348
17349 Note that this switch does not actually cause checking to be done; the
17350 operating system or the language runtime must do that.  The switch causes
17351 generation of code to ensure that they see the stack being extended.
17352
17353 You can additionally specify a string parameter: @code{no} means no
17354 checking, @code{generic} means force the use of old-style checking,
17355 @code{specific} means use the best checking method and is equivalent
17356 to bare @option{-fstack-check}.
17357
17358 Old-style checking is a generic mechanism that requires no specific
17359 target support in the compiler but comes with the following drawbacks:
17360
17361 @enumerate
17362 @item
17363 Modified allocation strategy for large objects: they will always be
17364 allocated dynamically if their size exceeds a fixed threshold.
17365
17366 @item
17367 Fixed limit on the size of the static frame of functions: when it is
17368 topped by a particular function, stack checking is not reliable and
17369 a warning is issued by the compiler.
17370
17371 @item
17372 Inefficiency: because of both the modified allocation strategy and the
17373 generic implementation, the performances of the code are hampered.
17374 @end enumerate
17375
17376 Note that old-style stack checking is also the fallback method for
17377 @code{specific} if no target support has been added in the compiler.
17378
17379 @item -fstack-limit-register=@var{reg}
17380 @itemx -fstack-limit-symbol=@var{sym}
17381 @itemx -fno-stack-limit
17382 @opindex fstack-limit-register
17383 @opindex fstack-limit-symbol
17384 @opindex fno-stack-limit
17385 Generate code to ensure that the stack does not grow beyond a certain value,
17386 either the value of a register or the address of a symbol.  If the stack
17387 would grow beyond the value, a signal is raised.  For most targets,
17388 the signal is raised before the stack overruns the boundary, so
17389 it is possible to catch the signal without taking special precautions.
17390
17391 For instance, if the stack starts at absolute address @samp{0x80000000}
17392 and grows downwards, you can use the flags
17393 @option{-fstack-limit-symbol=__stack_limit} and
17394 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
17395 of 128KB@.  Note that this may only work with the GNU linker.
17396
17397 @cindex aliasing of parameters
17398 @cindex parameters, aliased
17399 @item -fargument-alias
17400 @itemx -fargument-noalias
17401 @itemx -fargument-noalias-global
17402 @itemx -fargument-noalias-anything
17403 @opindex fargument-alias
17404 @opindex fargument-noalias
17405 @opindex fargument-noalias-global
17406 @opindex fargument-noalias-anything
17407 Specify the possible relationships among parameters and between
17408 parameters and global data.
17409
17410 @option{-fargument-alias} specifies that arguments (parameters) may
17411 alias each other and may alias global storage.@*
17412 @option{-fargument-noalias} specifies that arguments do not alias
17413 each other, but may alias global storage.@*
17414 @option{-fargument-noalias-global} specifies that arguments do not
17415 alias each other and do not alias global storage.
17416 @option{-fargument-noalias-anything} specifies that arguments do not
17417 alias any other storage.
17418
17419 Each language will automatically use whatever option is required by
17420 the language standard.  You should not need to use these options yourself.
17421
17422 @item -fleading-underscore
17423 @opindex fleading-underscore
17424 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
17425 change the way C symbols are represented in the object file.  One use
17426 is to help link with legacy assembly code.
17427
17428 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
17429 generate code that is not binary compatible with code generated without that
17430 switch.  Use it to conform to a non-default application binary interface.
17431 Not all targets provide complete support for this switch.
17432
17433 @item -ftls-model=@var{model}
17434 @opindex ftls-model
17435 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
17436 The @var{model} argument should be one of @code{global-dynamic},
17437 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
17438
17439 The default without @option{-fpic} is @code{initial-exec}; with
17440 @option{-fpic} the default is @code{global-dynamic}.
17441
17442 @item -fvisibility=@var{default|internal|hidden|protected}
17443 @opindex fvisibility
17444 Set the default ELF image symbol visibility to the specified option---all
17445 symbols will be marked with this unless overridden within the code.
17446 Using this feature can very substantially improve linking and
17447 load times of shared object libraries, produce more optimized
17448 code, provide near-perfect API export and prevent symbol clashes.
17449 It is @strong{strongly} recommended that you use this in any shared objects
17450 you distribute.
17451
17452 Despite the nomenclature, @code{default} always means public ie;
17453 available to be linked against from outside the shared object.
17454 @code{protected} and @code{internal} are pretty useless in real-world
17455 usage so the only other commonly used option will be @code{hidden}.
17456 The default if @option{-fvisibility} isn't specified is
17457 @code{default}, i.e., make every
17458 symbol public---this causes the same behavior as previous versions of
17459 GCC@.
17460
17461 A good explanation of the benefits offered by ensuring ELF
17462 symbols have the correct visibility is given by ``How To Write
17463 Shared Libraries'' by Ulrich Drepper (which can be found at
17464 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
17465 solution made possible by this option to marking things hidden when
17466 the default is public is to make the default hidden and mark things
17467 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
17468 and @code{__attribute__ ((visibility("default")))} instead of
17469 @code{__declspec(dllexport)} you get almost identical semantics with
17470 identical syntax.  This is a great boon to those working with
17471 cross-platform projects.
17472
17473 For those adding visibility support to existing code, you may find
17474 @samp{#pragma GCC visibility} of use.  This works by you enclosing
17475 the declarations you wish to set visibility for with (for example)
17476 @samp{#pragma GCC visibility push(hidden)} and
17477 @samp{#pragma GCC visibility pop}.
17478 Bear in mind that symbol visibility should be viewed @strong{as
17479 part of the API interface contract} and thus all new code should
17480 always specify visibility when it is not the default ie; declarations
17481 only for use within the local DSO should @strong{always} be marked explicitly
17482 as hidden as so to avoid PLT indirection overheads---making this
17483 abundantly clear also aids readability and self-documentation of the code.
17484 Note that due to ISO C++ specification requirements, operator new and
17485 operator delete must always be of default visibility.
17486
17487 Be aware that headers from outside your project, in particular system
17488 headers and headers from any other library you use, may not be
17489 expecting to be compiled with visibility other than the default.  You
17490 may need to explicitly say @samp{#pragma GCC visibility push(default)}
17491 before including any such headers.
17492
17493 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
17494 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
17495 no modifications.  However, this means that calls to @samp{extern}
17496 functions with no explicit visibility will use the PLT, so it is more
17497 effective to use @samp{__attribute ((visibility))} and/or
17498 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
17499 declarations should be treated as hidden.
17500
17501 Note that @samp{-fvisibility} does affect C++ vague linkage
17502 entities. This means that, for instance, an exception class that will
17503 be thrown between DSOs must be explicitly marked with default
17504 visibility so that the @samp{type_info} nodes will be unified between
17505 the DSOs.
17506
17507 An overview of these techniques, their benefits and how to use them
17508 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
17509
17510 @end table
17511
17512 @c man end
17513
17514 @node Environment Variables
17515 @section Environment Variables Affecting GCC
17516 @cindex environment variables
17517
17518 @c man begin ENVIRONMENT
17519 This section describes several environment variables that affect how GCC
17520 operates.  Some of them work by specifying directories or prefixes to use
17521 when searching for various kinds of files.  Some are used to specify other
17522 aspects of the compilation environment.
17523
17524 Note that you can also specify places to search using options such as
17525 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
17526 take precedence over places specified using environment variables, which
17527 in turn take precedence over those specified by the configuration of GCC@.
17528 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
17529 GNU Compiler Collection (GCC) Internals}.
17530
17531 @table @env
17532 @item LANG
17533 @itemx LC_CTYPE
17534 @c @itemx LC_COLLATE
17535 @itemx LC_MESSAGES
17536 @c @itemx LC_MONETARY
17537 @c @itemx LC_NUMERIC
17538 @c @itemx LC_TIME
17539 @itemx LC_ALL
17540 @findex LANG
17541 @findex LC_CTYPE
17542 @c @findex LC_COLLATE
17543 @findex LC_MESSAGES
17544 @c @findex LC_MONETARY
17545 @c @findex LC_NUMERIC
17546 @c @findex LC_TIME
17547 @findex LC_ALL
17548 @cindex locale
17549 These environment variables control the way that GCC uses
17550 localization information that allow GCC to work with different
17551 national conventions.  GCC inspects the locale categories
17552 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
17553 so.  These locale categories can be set to any value supported by your
17554 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
17555 Kingdom encoded in UTF-8.
17556
17557 The @env{LC_CTYPE} environment variable specifies character
17558 classification.  GCC uses it to determine the character boundaries in
17559 a string; this is needed for some multibyte encodings that contain quote
17560 and escape characters that would otherwise be interpreted as a string
17561 end or escape.
17562
17563 The @env{LC_MESSAGES} environment variable specifies the language to
17564 use in diagnostic messages.
17565
17566 If the @env{LC_ALL} environment variable is set, it overrides the value
17567 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
17568 and @env{LC_MESSAGES} default to the value of the @env{LANG}
17569 environment variable.  If none of these variables are set, GCC
17570 defaults to traditional C English behavior.
17571
17572 @item TMPDIR
17573 @findex TMPDIR
17574 If @env{TMPDIR} is set, it specifies the directory to use for temporary
17575 files.  GCC uses temporary files to hold the output of one stage of
17576 compilation which is to be used as input to the next stage: for example,
17577 the output of the preprocessor, which is the input to the compiler
17578 proper.
17579
17580 @item GCC_EXEC_PREFIX
17581 @findex GCC_EXEC_PREFIX
17582 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
17583 names of the subprograms executed by the compiler.  No slash is added
17584 when this prefix is combined with the name of a subprogram, but you can
17585 specify a prefix that ends with a slash if you wish.
17586
17587 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
17588 an appropriate prefix to use based on the pathname it was invoked with.
17589
17590 If GCC cannot find the subprogram using the specified prefix, it
17591 tries looking in the usual places for the subprogram.
17592
17593 The default value of @env{GCC_EXEC_PREFIX} is
17594 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
17595 the installed compiler. In many cases @var{prefix} is the value
17596 of @code{prefix} when you ran the @file{configure} script.
17597
17598 Other prefixes specified with @option{-B} take precedence over this prefix.
17599
17600 This prefix is also used for finding files such as @file{crt0.o} that are
17601 used for linking.
17602
17603 In addition, the prefix is used in an unusual way in finding the
17604 directories to search for header files.  For each of the standard
17605 directories whose name normally begins with @samp{/usr/local/lib/gcc}
17606 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
17607 replacing that beginning with the specified prefix to produce an
17608 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
17609 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
17610 These alternate directories are searched first; the standard directories
17611 come next. If a standard directory begins with the configured
17612 @var{prefix} then the value of @var{prefix} is replaced by
17613 @env{GCC_EXEC_PREFIX} when looking for header files.
17614
17615 @item COMPILER_PATH
17616 @findex COMPILER_PATH
17617 The value of @env{COMPILER_PATH} is a colon-separated list of
17618 directories, much like @env{PATH}.  GCC tries the directories thus
17619 specified when searching for subprograms, if it can't find the
17620 subprograms using @env{GCC_EXEC_PREFIX}.
17621
17622 @item LIBRARY_PATH
17623 @findex LIBRARY_PATH
17624 The value of @env{LIBRARY_PATH} is a colon-separated list of
17625 directories, much like @env{PATH}.  When configured as a native compiler,
17626 GCC tries the directories thus specified when searching for special
17627 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
17628 using GCC also uses these directories when searching for ordinary
17629 libraries for the @option{-l} option (but directories specified with
17630 @option{-L} come first).
17631
17632 @item LANG
17633 @findex LANG
17634 @cindex locale definition
17635 This variable is used to pass locale information to the compiler.  One way in
17636 which this information is used is to determine the character set to be used
17637 when character literals, string literals and comments are parsed in C and C++.
17638 When the compiler is configured to allow multibyte characters,
17639 the following values for @env{LANG} are recognized:
17640
17641 @table @samp
17642 @item C-JIS
17643 Recognize JIS characters.
17644 @item C-SJIS
17645 Recognize SJIS characters.
17646 @item C-EUCJP
17647 Recognize EUCJP characters.
17648 @end table
17649
17650 If @env{LANG} is not defined, or if it has some other value, then the
17651 compiler will use mblen and mbtowc as defined by the default locale to
17652 recognize and translate multibyte characters.
17653 @end table
17654
17655 @noindent
17656 Some additional environments variables affect the behavior of the
17657 preprocessor.
17658
17659 @include cppenv.texi
17660
17661 @c man end
17662
17663 @node Precompiled Headers
17664 @section Using Precompiled Headers
17665 @cindex precompiled headers
17666 @cindex speed of compilation
17667
17668 Often large projects have many header files that are included in every
17669 source file.  The time the compiler takes to process these header files
17670 over and over again can account for nearly all of the time required to
17671 build the project.  To make builds faster, GCC allows users to
17672 `precompile' a header file; then, if builds can use the precompiled
17673 header file they will be much faster.
17674
17675 To create a precompiled header file, simply compile it as you would any
17676 other file, if necessary using the @option{-x} option to make the driver
17677 treat it as a C or C++ header file.  You will probably want to use a
17678 tool like @command{make} to keep the precompiled header up-to-date when
17679 the headers it contains change.
17680
17681 A precompiled header file will be searched for when @code{#include} is
17682 seen in the compilation.  As it searches for the included file
17683 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
17684 compiler looks for a precompiled header in each directory just before it
17685 looks for the include file in that directory.  The name searched for is
17686 the name specified in the @code{#include} with @samp{.gch} appended.  If
17687 the precompiled header file can't be used, it is ignored.
17688
17689 For instance, if you have @code{#include "all.h"}, and you have
17690 @file{all.h.gch} in the same directory as @file{all.h}, then the
17691 precompiled header file will be used if possible, and the original
17692 header will be used otherwise.
17693
17694 Alternatively, you might decide to put the precompiled header file in a
17695 directory and use @option{-I} to ensure that directory is searched
17696 before (or instead of) the directory containing the original header.
17697 Then, if you want to check that the precompiled header file is always
17698 used, you can put a file of the same name as the original header in this
17699 directory containing an @code{#error} command.
17700
17701 This also works with @option{-include}.  So yet another way to use
17702 precompiled headers, good for projects not designed with precompiled
17703 header files in mind, is to simply take most of the header files used by
17704 a project, include them from another header file, precompile that header
17705 file, and @option{-include} the precompiled header.  If the header files
17706 have guards against multiple inclusion, they will be skipped because
17707 they've already been included (in the precompiled header).
17708
17709 If you need to precompile the same header file for different
17710 languages, targets, or compiler options, you can instead make a
17711 @emph{directory} named like @file{all.h.gch}, and put each precompiled
17712 header in the directory, perhaps using @option{-o}.  It doesn't matter
17713 what you call the files in the directory, every precompiled header in
17714 the directory will be considered.  The first precompiled header
17715 encountered in the directory that is valid for this compilation will
17716 be used; they're searched in no particular order.
17717
17718 There are many other possibilities, limited only by your imagination,
17719 good sense, and the constraints of your build system.
17720
17721 A precompiled header file can be used only when these conditions apply:
17722
17723 @itemize
17724 @item
17725 Only one precompiled header can be used in a particular compilation.
17726
17727 @item
17728 A precompiled header can't be used once the first C token is seen.  You
17729 can have preprocessor directives before a precompiled header; you can
17730 even include a precompiled header from inside another header, so long as
17731 there are no C tokens before the @code{#include}.
17732
17733 @item
17734 The precompiled header file must be produced for the same language as
17735 the current compilation.  You can't use a C precompiled header for a C++
17736 compilation.
17737
17738 @item
17739 The precompiled header file must have been produced by the same compiler
17740 binary as the current compilation is using.
17741
17742 @item
17743 Any macros defined before the precompiled header is included must
17744 either be defined in the same way as when the precompiled header was
17745 generated, or must not affect the precompiled header, which usually
17746 means that they don't appear in the precompiled header at all.
17747
17748 The @option{-D} option is one way to define a macro before a
17749 precompiled header is included; using a @code{#define} can also do it.
17750 There are also some options that define macros implicitly, like
17751 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
17752 defined this way.
17753
17754 @item If debugging information is output when using the precompiled
17755 header, using @option{-g} or similar, the same kind of debugging information
17756 must have been output when building the precompiled header.  However,
17757 a precompiled header built using @option{-g} can be used in a compilation
17758 when no debugging information is being output.
17759
17760 @item The same @option{-m} options must generally be used when building
17761 and using the precompiled header.  @xref{Submodel Options},
17762 for any cases where this rule is relaxed.
17763
17764 @item Each of the following options must be the same when building and using
17765 the precompiled header:
17766
17767 @gccoptlist{-fexceptions}
17768
17769 @item
17770 Some other command-line options starting with @option{-f},
17771 @option{-p}, or @option{-O} must be defined in the same way as when
17772 the precompiled header was generated.  At present, it's not clear
17773 which options are safe to change and which are not; the safest choice
17774 is to use exactly the same options when generating and using the
17775 precompiled header.  The following are known to be safe:
17776
17777 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
17778 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
17779 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
17780 -pedantic-errors}
17781
17782 @end itemize
17783
17784 For all of these except the last, the compiler will automatically
17785 ignore the precompiled header if the conditions aren't met.  If you
17786 find an option combination that doesn't work and doesn't cause the
17787 precompiled header to be ignored, please consider filing a bug report,
17788 see @ref{Bugs}.
17789
17790 If you do use differing options when generating and using the
17791 precompiled header, the actual behavior will be a mixture of the
17792 behavior for the options.  For instance, if you use @option{-g} to
17793 generate the precompiled header but not when using it, you may or may
17794 not get debugging information for routines in the precompiled header.