OSDN Git Service

* doc/invoke.texi (-fvar-tracking-assignments): Fix typo.
[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, 2010
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, 2010
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  -Wconversion-null  -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 @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-assignments  -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 -fsched-pressure @gol
371 -fsched-spec-load -fsched-spec-load-dangerous @gol
372 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
373 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
374 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
375 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
376 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
377 -fselective-scheduling -fselective-scheduling2 @gol
378 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
379 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
380 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
381 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
382 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
383 -ftree-copyrename -ftree-dce @gol
384 -ftree-dominator-opts -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-im @gol
385 -ftree-phiprop -ftree-loop-distribution @gol
386 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
387 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
388 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
389 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
390 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
391 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
392 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
393 -fwhole-program -fwhopr -fwpa -fuse-linker-plugin @gol
394 --param @var{name}=@var{value}
395 -O  -O0  -O1  -O2  -O3  -Os}
396
397 @item Preprocessor Options
398 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
399 @gccoptlist{-A@var{question}=@var{answer} @gol
400 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
401 -C  -dD  -dI  -dM  -dN @gol
402 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
403 -idirafter @var{dir} @gol
404 -include @var{file}  -imacros @var{file} @gol
405 -iprefix @var{file}  -iwithprefix @var{dir} @gol
406 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
407 -imultilib @var{dir} -isysroot @var{dir} @gol
408 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
409 -P  -fworking-directory  -remap @gol
410 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
411 -Xpreprocessor @var{option}}
412
413 @item Assembler Option
414 @xref{Assembler Options,,Passing Options to the Assembler}.
415 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
416
417 @item Linker Options
418 @xref{Link Options,,Options for Linking}.
419 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
420 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
421 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
422 -shared-libgcc  -symbolic @gol
423 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
424 -u @var{symbol}}
425
426 @item Directory Options
427 @xref{Directory Options,,Options for Directory Search}.
428 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
429 -specs=@var{file}  -I- --sysroot=@var{dir}}
430
431 @item Target Options
432 @c I wrote this xref this way to avoid overfull hbox. -- rms
433 @xref{Target Options}.
434 @gccoptlist{-V @var{version}  -b @var{machine}}
435
436 @item Machine Dependent Options
437 @xref{Submodel Options,,Hardware Models and Configurations}.
438 @c This list is ordered alphanumerically by subsection name.
439 @c Try and put the significant identifier (CPU or system) first,
440 @c so users have a clue at guessing where the ones they want will be.
441
442 @emph{ARC Options}
443 @gccoptlist{-EB  -EL @gol
444 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
445 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
446
447 @emph{ARM Options}
448 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
449 -mabi=@var{name} @gol
450 -mapcs-stack-check  -mno-apcs-stack-check @gol
451 -mapcs-float  -mno-apcs-float @gol
452 -mapcs-reentrant  -mno-apcs-reentrant @gol
453 -msched-prolog  -mno-sched-prolog @gol
454 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
455 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
456 -mfp16-format=@var{name}
457 -mthumb-interwork  -mno-thumb-interwork @gol
458 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
459 -mstructure-size-boundary=@var{n} @gol
460 -mabort-on-noreturn @gol
461 -mlong-calls  -mno-long-calls @gol
462 -msingle-pic-base  -mno-single-pic-base @gol
463 -mpic-register=@var{reg} @gol
464 -mnop-fun-dllimport @gol
465 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
466 -mpoke-function-name @gol
467 -mthumb  -marm @gol
468 -mtpcs-frame  -mtpcs-leaf-frame @gol
469 -mcaller-super-interworking  -mcallee-super-interworking @gol
470 -mtp=@var{name} @gol
471 -mword-relocations @gol
472 -mfix-cortex-m3-ldrd}
473
474 @emph{AVR Options}
475 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
476 -mcall-prologues  -mtiny-stack  -mint8}
477
478 @emph{Blackfin Options}
479 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
480 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
481 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
482 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
483 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
484 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
485 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
486 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
487 -micplb}
488
489 @emph{CRIS Options}
490 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
491 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
492 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
493 -mstack-align  -mdata-align  -mconst-align @gol
494 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
495 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
496 -mmul-bug-workaround  -mno-mul-bug-workaround}
497
498 @emph{CRX Options}
499 @gccoptlist{-mmac -mpush-args}
500
501 @emph{Darwin Options}
502 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
503 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
504 -client_name  -compatibility_version  -current_version @gol
505 -dead_strip @gol
506 -dependency-file  -dylib_file  -dylinker_install_name @gol
507 -dynamic  -dynamiclib  -exported_symbols_list @gol
508 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
509 -force_flat_namespace  -headerpad_max_install_names @gol
510 -iframework @gol
511 -image_base  -init  -install_name  -keep_private_externs @gol
512 -multi_module  -multiply_defined  -multiply_defined_unused @gol
513 -noall_load   -no_dead_strip_inits_and_terms @gol
514 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
515 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
516 -private_bundle  -read_only_relocs  -sectalign @gol
517 -sectobjectsymbols  -whyload  -seg1addr @gol
518 -sectcreate  -sectobjectsymbols  -sectorder @gol
519 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
520 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
521 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
522 -single_module  -static  -sub_library  -sub_umbrella @gol
523 -twolevel_namespace  -umbrella  -undefined @gol
524 -unexported_symbols_list  -weak_reference_mismatches @gol
525 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
526 -mkernel -mone-byte-bool}
527
528 @emph{DEC Alpha Options}
529 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
530 -mieee  -mieee-with-inexact  -mieee-conformant @gol
531 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
532 -mtrap-precision=@var{mode}  -mbuild-constants @gol
533 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
534 -mbwx  -mmax  -mfix  -mcix @gol
535 -mfloat-vax  -mfloat-ieee @gol
536 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
537 -msmall-text  -mlarge-text @gol
538 -mmemory-latency=@var{time}}
539
540 @emph{DEC Alpha/VMS Options}
541 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
542
543 @emph{FR30 Options}
544 @gccoptlist{-msmall-model -mno-lsim}
545
546 @emph{FRV Options}
547 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
548 -mhard-float  -msoft-float @gol
549 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
550 -mdouble  -mno-double @gol
551 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
552 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
553 -mlinked-fp  -mlong-calls  -malign-labels @gol
554 -mlibrary-pic  -macc-4  -macc-8 @gol
555 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
556 -moptimize-membar -mno-optimize-membar @gol
557 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
558 -mvliw-branch  -mno-vliw-branch @gol
559 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
560 -mno-nested-cond-exec  -mtomcat-stats @gol
561 -mTLS -mtls @gol
562 -mcpu=@var{cpu}}
563
564 @emph{GNU/Linux Options}
565 @gccoptlist{-muclibc}
566
567 @emph{H8/300 Options}
568 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
569
570 @emph{HPPA Options}
571 @gccoptlist{-march=@var{architecture-type} @gol
572 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
573 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
574 -mfixed-range=@var{register-range} @gol
575 -mjump-in-delay -mlinker-opt -mlong-calls @gol
576 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
577 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
578 -mno-jump-in-delay  -mno-long-load-store @gol
579 -mno-portable-runtime  -mno-soft-float @gol
580 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
581 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
582 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
583 -munix=@var{unix-std}  -nolibdld  -static  -threads}
584
585 @emph{i386 and x86-64 Options}
586 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
587 -mfpmath=@var{unit} @gol
588 -masm=@var{dialect}  -mno-fancy-math-387 @gol
589 -mno-fp-ret-in-387  -msoft-float @gol
590 -mno-wide-multiply  -mrtd  -malign-double @gol
591 -mpreferred-stack-boundary=@var{num}
592 -mincoming-stack-boundary=@var{num}
593 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
594 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
595 -maes -mpclmul -mfused-madd @gol
596 -msse4a -m3dnow -mpopcnt -mabm -mfma4 -mxop -mlwp @gol
597 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
598 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
599 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
600 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
601 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
602 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
603 -mcmodel=@var{code-model} -mabi=@var{name} @gol
604 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
605 -msse2avx}
606
607 @emph{IA-64 Options}
608 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
609 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
610 -mconstant-gp  -mauto-pic  -mfused-madd @gol
611 -minline-float-divide-min-latency @gol
612 -minline-float-divide-max-throughput @gol
613 -mno-inline-float-divide @gol
614 -minline-int-divide-min-latency @gol
615 -minline-int-divide-max-throughput  @gol
616 -mno-inline-int-divide @gol
617 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
618 -mno-inline-sqrt @gol
619 -mdwarf2-asm -mearly-stop-bits @gol
620 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
621 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
622 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
623 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
624 -msched-spec-ldc -msched-spec-control-ldc @gol
625 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
626 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
627 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
628 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
629
630 @emph{IA-64/VMS Options}
631 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
632
633 @emph{LM32 Options}
634 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
635 -msign-extend-enabled -muser-enabled}
636
637 @emph{M32R/D Options}
638 @gccoptlist{-m32r2 -m32rx -m32r @gol
639 -mdebug @gol
640 -malign-loops -mno-align-loops @gol
641 -missue-rate=@var{number} @gol
642 -mbranch-cost=@var{number} @gol
643 -mmodel=@var{code-size-model-type} @gol
644 -msdata=@var{sdata-type} @gol
645 -mno-flush-func -mflush-func=@var{name} @gol
646 -mno-flush-trap -mflush-trap=@var{number} @gol
647 -G @var{num}}
648
649 @emph{M32C Options}
650 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
651
652 @emph{M680x0 Options}
653 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
654 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
655 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
656 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
657 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
658 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
659 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
660 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
661 -mxgot -mno-xgot}
662
663 @emph{M68hc1x Options}
664 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
665 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
666 -msoft-reg-count=@var{count}}
667
668 @emph{MCore Options}
669 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
670 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
671 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
672 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
673 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
674
675 @emph{MeP Options}
676 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
677 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
678 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
679 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
680 -mtiny=@var{n}}
681
682 @emph{MIPS Options}
683 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
684 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
685 -mips64  -mips64r2 @gol
686 -mips16  -mno-mips16  -mflip-mips16 @gol
687 -minterlink-mips16  -mno-interlink-mips16 @gol
688 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
689 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
690 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
691 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
692 -mfpu=@var{fpu-type} @gol
693 -msmartmips  -mno-smartmips @gol
694 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
695 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
696 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
697 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
698 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
699 -membedded-data  -mno-embedded-data @gol
700 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
701 -mcode-readable=@var{setting} @gol
702 -msplit-addresses  -mno-split-addresses @gol
703 -mexplicit-relocs  -mno-explicit-relocs @gol
704 -mcheck-zero-division  -mno-check-zero-division @gol
705 -mdivide-traps  -mdivide-breaks @gol
706 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
707 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
708 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
709 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
710 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
711 -mflush-func=@var{func}  -mno-flush-func @gol
712 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
713 -mfp-exceptions -mno-fp-exceptions @gol
714 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
715 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
716
717 @emph{MMIX Options}
718 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
719 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
720 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
721 -mno-base-addresses  -msingle-exit  -mno-single-exit}
722
723 @emph{MN10300 Options}
724 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
725 -mam33  -mno-am33 @gol
726 -mam33-2  -mno-am33-2 @gol
727 -mreturn-pointer-on-d0 @gol
728 -mno-crt0  -mrelax}
729
730 @emph{PDP-11 Options}
731 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
732 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
733 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
734 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
735 -mbranch-expensive  -mbranch-cheap @gol
736 -msplit  -mno-split  -munix-asm  -mdec-asm}
737
738 @emph{picoChip Options}
739 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
740 -msymbol-as-address -mno-inefficient-warnings}
741
742 @emph{PowerPC Options}
743 See RS/6000 and PowerPC Options.
744
745 @emph{RS/6000 and PowerPC Options}
746 @gccoptlist{-mcpu=@var{cpu-type} @gol
747 -mtune=@var{cpu-type} @gol
748 -mpower  -mno-power  -mpower2  -mno-power2 @gol
749 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
750 -maltivec  -mno-altivec @gol
751 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
752 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
753 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
754 -mfprnd  -mno-fprnd @gol
755 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
756 -mnew-mnemonics  -mold-mnemonics @gol
757 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
758 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
759 -malign-power  -malign-natural @gol
760 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
761 -msingle-float -mdouble-float -msimple-fpu @gol
762 -mstring  -mno-string  -mupdate  -mno-update @gol
763 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
764 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
765 -mstrict-align  -mno-strict-align  -mrelocatable @gol
766 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
767 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
768 -mdynamic-no-pic  -maltivec -mswdiv @gol
769 -mprioritize-restricted-insns=@var{priority} @gol
770 -msched-costly-dep=@var{dependence_type} @gol
771 -minsert-sched-nops=@var{scheme} @gol
772 -mcall-sysv  -mcall-netbsd @gol
773 -maix-struct-return  -msvr4-struct-return @gol
774 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
775 -misel -mno-isel @gol
776 -misel=yes  -misel=no @gol
777 -mspe -mno-spe @gol
778 -mspe=yes  -mspe=no @gol
779 -mpaired @gol
780 -mgen-cell-microcode -mwarn-cell-microcode @gol
781 -mvrsave -mno-vrsave @gol
782 -mmulhw -mno-mulhw @gol
783 -mdlmzb -mno-dlmzb @gol
784 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
785 -mprototype  -mno-prototype @gol
786 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
787 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
788
789 @emph{RX Options}
790 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
791 -mcpu= -patch=@gol
792 -mbig-endian-data -mlittle-endian-data @gol
793 -msmall-data @gol
794 -msim  -mno-sim@gol
795 -mas100-syntax -mno-as100-syntax@gol
796 -mrelax@gol
797 -mmax-constant-size=@gol
798 -mint-register=@gol
799 -msave-acc-in-interrupts}
800
801 @emph{S/390 and zSeries Options}
802 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
803 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
804 -mlong-double-64 -mlong-double-128 @gol
805 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
806 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
807 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
808 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
809 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
810
811 @emph{Score Options}
812 @gccoptlist{-meb -mel @gol
813 -mnhwloop @gol
814 -muls @gol
815 -mmac @gol
816 -mscore5 -mscore5u -mscore7 -mscore7d}
817
818 @emph{SH Options}
819 @gccoptlist{-m1  -m2  -m2e @gol
820 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
821 -m3  -m3e @gol
822 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
823 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
824 -m5-64media  -m5-64media-nofpu @gol
825 -m5-32media  -m5-32media-nofpu @gol
826 -m5-compact  -m5-compact-nofpu @gol
827 -mb  -ml  -mdalign  -mrelax @gol
828 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
829 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
830 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
831 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
832 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
833 -minvalid-symbols}
834
835 @emph{SPARC Options}
836 @gccoptlist{-mcpu=@var{cpu-type} @gol
837 -mtune=@var{cpu-type} @gol
838 -mcmodel=@var{code-model} @gol
839 -m32  -m64  -mapp-regs  -mno-app-regs @gol
840 -mfaster-structs  -mno-faster-structs @gol
841 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
842 -mhard-quad-float  -msoft-quad-float @gol
843 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
844 -mstack-bias  -mno-stack-bias @gol
845 -munaligned-doubles  -mno-unaligned-doubles @gol
846 -mv8plus  -mno-v8plus  -mvis  -mno-vis
847 -threads -pthreads -pthread}
848
849 @emph{SPU Options}
850 @gccoptlist{-mwarn-reloc -merror-reloc @gol
851 -msafe-dma -munsafe-dma @gol
852 -mbranch-hints @gol
853 -msmall-mem -mlarge-mem -mstdmain @gol
854 -mfixed-range=@var{register-range} @gol
855 -mea32 -mea64 @gol
856 -maddress-space-conversion -mno-address-space-conversion @gol
857 -mcache-size=@var{cache-size} @gol
858 -matomic-updates -mno-atomic-updates}
859
860 @emph{System V Options}
861 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
862
863 @emph{V850 Options}
864 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
865 -mprolog-function  -mno-prolog-function  -mspace @gol
866 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
867 -mapp-regs  -mno-app-regs @gol
868 -mdisable-callt  -mno-disable-callt @gol
869 -mv850e1 @gol
870 -mv850e @gol
871 -mv850  -mbig-switch}
872
873 @emph{VAX Options}
874 @gccoptlist{-mg  -mgnu  -munix}
875
876 @emph{VxWorks Options}
877 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
878 -Xbind-lazy  -Xbind-now}
879
880 @emph{x86-64 Options}
881 See i386 and x86-64 Options.
882
883 @emph{i386 and x86-64 Windows Options}
884 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
885 -mnop-fun-dllimport -mthread -municode -mwin32 -mwindows
886 -fno-set-stack-executable}
887
888 @emph{Xstormy16 Options}
889 @gccoptlist{-msim}
890
891 @emph{Xtensa Options}
892 @gccoptlist{-mconst16 -mno-const16 @gol
893 -mfused-madd  -mno-fused-madd @gol
894 -mserialize-volatile  -mno-serialize-volatile @gol
895 -mtext-section-literals  -mno-text-section-literals @gol
896 -mtarget-align  -mno-target-align @gol
897 -mlongcalls  -mno-longcalls}
898
899 @emph{zSeries Options}
900 See S/390 and zSeries Options.
901
902 @item Code Generation Options
903 @xref{Code Gen Options,,Options for Code Generation Conventions}.
904 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
905 -ffixed-@var{reg}  -fexceptions @gol
906 -fnon-call-exceptions  -funwind-tables @gol
907 -fasynchronous-unwind-tables @gol
908 -finhibit-size-directive  -finstrument-functions @gol
909 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
910 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
911 -fno-common  -fno-ident @gol
912 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
913 -fno-jump-tables @gol
914 -frecord-gcc-switches @gol
915 -freg-struct-return  -fshort-enums @gol
916 -fshort-double  -fshort-wchar @gol
917 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
918 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
919 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
920 -fargument-noalias-global  -fargument-noalias-anything @gol
921 -fleading-underscore  -ftls-model=@var{model} @gol
922 -ftrapv  -fwrapv  -fbounds-check @gol
923 -fvisibility}
924 @end table
925
926 @menu
927 * Overall Options::     Controlling the kind of output:
928                         an executable, object files, assembler files,
929                         or preprocessed source.
930 * C Dialect Options::   Controlling the variant of C language compiled.
931 * C++ Dialect Options:: Variations on C++.
932 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
933                         and Objective-C++.
934 * Language Independent Options:: Controlling how diagnostics should be
935                         formatted.
936 * Warning Options::     How picky should the compiler be?
937 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
938 * Optimize Options::    How much optimization?
939 * Preprocessor Options:: Controlling header files and macro definitions.
940                          Also, getting dependency information for Make.
941 * Assembler Options::   Passing options to the assembler.
942 * Link Options::        Specifying libraries and so on.
943 * Directory Options::   Where to find header files and libraries.
944                         Where to find the compiler executable files.
945 * Spec Files::          How to pass switches to sub-processes.
946 * Target Options::      Running a cross-compiler, or an old version of GCC.
947 @end menu
948
949 @node Overall Options
950 @section Options Controlling the Kind of Output
951
952 Compilation can involve up to four stages: preprocessing, compilation
953 proper, assembly and linking, always in that order.  GCC is capable of
954 preprocessing and compiling several files either into several
955 assembler input files, or into one assembler input file; then each
956 assembler input file produces an object file, and linking combines all
957 the object files (those newly compiled, and those specified as input)
958 into an executable file.
959
960 @cindex file name suffix
961 For any given input file, the file name suffix determines what kind of
962 compilation is done:
963
964 @table @gcctabopt
965 @item @var{file}.c
966 C source code which must be preprocessed.
967
968 @item @var{file}.i
969 C source code which should not be preprocessed.
970
971 @item @var{file}.ii
972 C++ source code which should not be preprocessed.
973
974 @item @var{file}.m
975 Objective-C source code.  Note that you must link with the @file{libobjc}
976 library to make an Objective-C program work.
977
978 @item @var{file}.mi
979 Objective-C source code which should not be preprocessed.
980
981 @item @var{file}.mm
982 @itemx @var{file}.M
983 Objective-C++ source code.  Note that you must link with the @file{libobjc}
984 library to make an Objective-C++ program work.  Note that @samp{.M} refers
985 to a literal capital M@.
986
987 @item @var{file}.mii
988 Objective-C++ source code which should not be preprocessed.
989
990 @item @var{file}.h
991 C, C++, Objective-C or Objective-C++ header file to be turned into a
992 precompiled header.
993
994 @item @var{file}.cc
995 @itemx @var{file}.cp
996 @itemx @var{file}.cxx
997 @itemx @var{file}.cpp
998 @itemx @var{file}.CPP
999 @itemx @var{file}.c++
1000 @itemx @var{file}.C
1001 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
1002 the last two letters must both be literally @samp{x}.  Likewise,
1003 @samp{.C} refers to a literal capital C@.
1004
1005 @item @var{file}.mm
1006 @itemx @var{file}.M
1007 Objective-C++ source code which must be preprocessed.
1008
1009 @item @var{file}.mii
1010 Objective-C++ source code which should not be preprocessed.
1011
1012 @item @var{file}.hh
1013 @itemx @var{file}.H
1014 @itemx @var{file}.hp
1015 @itemx @var{file}.hxx
1016 @itemx @var{file}.hpp
1017 @itemx @var{file}.HPP
1018 @itemx @var{file}.h++
1019 @itemx @var{file}.tcc
1020 C++ header file to be turned into a precompiled header.
1021
1022 @item @var{file}.f
1023 @itemx @var{file}.for
1024 @itemx @var{file}.ftn
1025 Fixed form Fortran source code which should not be preprocessed.
1026
1027 @item @var{file}.F
1028 @itemx @var{file}.FOR
1029 @itemx @var{file}.fpp
1030 @itemx @var{file}.FPP
1031 @itemx @var{file}.FTN
1032 Fixed form Fortran source code which must be preprocessed (with the traditional
1033 preprocessor).
1034
1035 @item @var{file}.f90
1036 @itemx @var{file}.f95
1037 @itemx @var{file}.f03
1038 @itemx @var{file}.f08
1039 Free form Fortran source code which should not be preprocessed.
1040
1041 @item @var{file}.F90
1042 @itemx @var{file}.F95
1043 @itemx @var{file}.F03
1044 @itemx @var{file}.F08
1045 Free form Fortran source code which must be preprocessed (with the
1046 traditional preprocessor).
1047
1048 @c FIXME: Descriptions of Java file types.
1049 @c @var{file}.java
1050 @c @var{file}.class
1051 @c @var{file}.zip
1052 @c @var{file}.jar
1053
1054 @item @var{file}.ads
1055 Ada source code file which contains a library unit declaration (a
1056 declaration of a package, subprogram, or generic, or a generic
1057 instantiation), or a library unit renaming declaration (a package,
1058 generic, or subprogram renaming declaration).  Such files are also
1059 called @dfn{specs}.
1060
1061 @item @var{file}.adb
1062 Ada source code file containing a library unit body (a subprogram or
1063 package body).  Such files are also called @dfn{bodies}.
1064
1065 @c GCC also knows about some suffixes for languages not yet included:
1066 @c Pascal:
1067 @c @var{file}.p
1068 @c @var{file}.pas
1069 @c Ratfor:
1070 @c @var{file}.r
1071
1072 @item @var{file}.s
1073 Assembler code.
1074
1075 @item @var{file}.S
1076 @itemx @var{file}.sx
1077 Assembler code which must be preprocessed.
1078
1079 @item @var{other}
1080 An object file to be fed straight into linking.
1081 Any file name with no recognized suffix is treated this way.
1082 @end table
1083
1084 @opindex x
1085 You can specify the input language explicitly with the @option{-x} option:
1086
1087 @table @gcctabopt
1088 @item -x @var{language}
1089 Specify explicitly the @var{language} for the following input files
1090 (rather than letting the compiler choose a default based on the file
1091 name suffix).  This option applies to all following input files until
1092 the next @option{-x} option.  Possible values for @var{language} are:
1093 @smallexample
1094 c  c-header  c-cpp-output
1095 c++  c++-header  c++-cpp-output
1096 objective-c  objective-c-header  objective-c-cpp-output
1097 objective-c++ objective-c++-header objective-c++-cpp-output
1098 assembler  assembler-with-cpp
1099 ada
1100 f77  f77-cpp-input f95  f95-cpp-input
1101 java
1102 @end smallexample
1103
1104 @item -x none
1105 Turn off any specification of a language, so that subsequent files are
1106 handled according to their file name suffixes (as they are if @option{-x}
1107 has not been used at all).
1108
1109 @item -pass-exit-codes
1110 @opindex pass-exit-codes
1111 Normally the @command{gcc} program will exit with the code of 1 if any
1112 phase of the compiler returns a non-success return code.  If you specify
1113 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1114 numerically highest error produced by any phase that returned an error
1115 indication.  The C, C++, and Fortran frontends return 4, if an internal
1116 compiler error is encountered.
1117 @end table
1118
1119 If you only want some of the stages of compilation, you can use
1120 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1121 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1122 @command{gcc} is to stop.  Note that some combinations (for example,
1123 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1124
1125 @table @gcctabopt
1126 @item -c
1127 @opindex c
1128 Compile or assemble the source files, but do not link.  The linking
1129 stage simply is not done.  The ultimate output is in the form of an
1130 object file for each source file.
1131
1132 By default, the object file name for a source file is made by replacing
1133 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1134
1135 Unrecognized input files, not requiring compilation or assembly, are
1136 ignored.
1137
1138 @item -S
1139 @opindex S
1140 Stop after the stage of compilation proper; do not assemble.  The output
1141 is in the form of an assembler code file for each non-assembler input
1142 file specified.
1143
1144 By default, the assembler file name for a source file is made by
1145 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1146
1147 Input files that don't require compilation are ignored.
1148
1149 @item -E
1150 @opindex E
1151 Stop after the preprocessing stage; do not run the compiler proper.  The
1152 output is in the form of preprocessed source code, which is sent to the
1153 standard output.
1154
1155 Input files which don't require preprocessing are ignored.
1156
1157 @cindex output file option
1158 @item -o @var{file}
1159 @opindex o
1160 Place output in file @var{file}.  This applies regardless to whatever
1161 sort of output is being produced, whether it be an executable file,
1162 an object file, an assembler file or preprocessed C code.
1163
1164 If @option{-o} is not specified, the default is to put an executable
1165 file in @file{a.out}, the object file for
1166 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1167 assembler file in @file{@var{source}.s}, a precompiled header file in
1168 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1169 standard output.
1170
1171 @item -v
1172 @opindex v
1173 Print (on standard error output) the commands executed to run the stages
1174 of compilation.  Also print the version number of the compiler driver
1175 program and of the preprocessor and the compiler proper.
1176
1177 @item -###
1178 @opindex ###
1179 Like @option{-v} except the commands are not executed and all command
1180 arguments are quoted.  This is useful for shell scripts to capture the
1181 driver-generated command lines.
1182
1183 @item -pipe
1184 @opindex pipe
1185 Use pipes rather than temporary files for communication between the
1186 various stages of compilation.  This fails to work on some systems where
1187 the assembler is unable to read from a pipe; but the GNU assembler has
1188 no trouble.
1189
1190 @item -combine
1191 @opindex combine
1192 If you are compiling multiple source files, this option tells the driver
1193 to pass all the source files to the compiler at once (for those
1194 languages for which the compiler can handle this).  This will allow
1195 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1196 language for which this is supported is C@.  If you pass source files for
1197 multiple languages to the driver, using this option, the driver will invoke
1198 the compiler(s) that support IMA once each, passing each compiler all the
1199 source files appropriate for it.  For those languages that do not support
1200 IMA this option will be ignored, and the compiler will be invoked once for
1201 each source file in that language.  If you use this option in conjunction
1202 with @option{-save-temps}, the compiler will generate multiple
1203 pre-processed files
1204 (one for each source file), but only one (combined) @file{.o} or
1205 @file{.s} file.
1206
1207 @item --help
1208 @opindex help
1209 Print (on the standard output) a description of the command line options
1210 understood by @command{gcc}.  If the @option{-v} option is also specified
1211 then @option{--help} will also be passed on to the various processes
1212 invoked by @command{gcc}, so that they can display the command line options
1213 they accept.  If the @option{-Wextra} option has also been specified
1214 (prior to the @option{--help} option), then command line options which
1215 have no documentation associated with them will also be displayed.
1216
1217 @item --target-help
1218 @opindex target-help
1219 Print (on the standard output) a description of target-specific command
1220 line options for each tool.  For some targets extra target-specific
1221 information may also be printed.
1222
1223 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1224 Print (on the standard output) a description of the command line
1225 options understood by the compiler that fit into all specified classes
1226 and qualifiers.  These are the supported classes:
1227
1228 @table @asis
1229 @item @samp{optimizers}
1230 This will display all of the optimization options supported by the
1231 compiler.
1232
1233 @item @samp{warnings}
1234 This will display all of the options controlling warning messages
1235 produced by the compiler.
1236
1237 @item @samp{target}
1238 This will display target-specific options.  Unlike the
1239 @option{--target-help} option however, target-specific options of the
1240 linker and assembler will not be displayed.  This is because those
1241 tools do not currently support the extended @option{--help=} syntax.
1242
1243 @item @samp{params}
1244 This will display the values recognized by the @option{--param}
1245 option.
1246
1247 @item @var{language}
1248 This will display the options supported for @var{language}, where
1249 @var{language} is the name of one of the languages supported in this
1250 version of GCC.
1251
1252 @item @samp{common}
1253 This will display the options that are common to all languages.
1254 @end table
1255
1256 These are the supported qualifiers:
1257
1258 @table @asis
1259 @item @samp{undocumented}
1260 Display only those options which are undocumented.
1261
1262 @item @samp{joined}
1263 Display options which take an argument that appears after an equal
1264 sign in the same continuous piece of text, such as:
1265 @samp{--help=target}.
1266
1267 @item @samp{separate}
1268 Display options which take an argument that appears as a separate word
1269 following the original option, such as: @samp{-o output-file}.
1270 @end table
1271
1272 Thus for example to display all the undocumented target-specific
1273 switches supported by the compiler the following can be used:
1274
1275 @smallexample
1276 --help=target,undocumented
1277 @end smallexample
1278
1279 The sense of a qualifier can be inverted by prefixing it with the
1280 @samp{^} character, so for example to display all binary warning
1281 options (i.e., ones that are either on or off and that do not take an
1282 argument), which have a description the following can be used:
1283
1284 @smallexample
1285 --help=warnings,^joined,^undocumented
1286 @end smallexample
1287
1288 The argument to @option{--help=} should not consist solely of inverted
1289 qualifiers.
1290
1291 Combining several classes is possible, although this usually
1292 restricts the output by so much that there is nothing to display.  One
1293 case where it does work however is when one of the classes is
1294 @var{target}.  So for example to display all the target-specific
1295 optimization options the following can be used:
1296
1297 @smallexample
1298 --help=target,optimizers
1299 @end smallexample
1300
1301 The @option{--help=} option can be repeated on the command line.  Each
1302 successive use will display its requested class of options, skipping
1303 those that have already been displayed.
1304
1305 If the @option{-Q} option appears on the command line before the
1306 @option{--help=} option, then the descriptive text displayed by
1307 @option{--help=} is changed.  Instead of describing the displayed
1308 options, an indication is given as to whether the option is enabled,
1309 disabled or set to a specific value (assuming that the compiler
1310 knows this at the point where the @option{--help=} option is used).
1311
1312 Here is a truncated example from the ARM port of @command{gcc}:
1313
1314 @smallexample
1315   % gcc -Q -mabi=2 --help=target -c
1316   The following options are target specific:
1317   -mabi=                                2
1318   -mabort-on-noreturn                   [disabled]
1319   -mapcs                                [disabled]
1320 @end smallexample
1321
1322 The output is sensitive to the effects of previous command line
1323 options, so for example it is possible to find out which optimizations
1324 are enabled at @option{-O2} by using:
1325
1326 @smallexample
1327 -Q -O2 --help=optimizers
1328 @end smallexample
1329
1330 Alternatively you can discover which binary optimizations are enabled
1331 by @option{-O3} by using:
1332
1333 @smallexample
1334 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1335 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1336 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1337 @end smallexample
1338
1339 @item -no-canonical-prefixes
1340 @opindex no-canonical-prefixes
1341 Do not expand any symbolic links, resolve references to @samp{/../}
1342 or @samp{/./}, or make the path absolute when generating a relative
1343 prefix.
1344
1345 @item --version
1346 @opindex version
1347 Display the version number and copyrights of the invoked GCC@.
1348
1349 @item -wrapper
1350 @opindex wrapper
1351 Invoke all subcommands under a wrapper program. It takes a single
1352 comma separated list as an argument, which will be used to invoke
1353 the wrapper:
1354
1355 @smallexample
1356 gcc -c t.c -wrapper gdb,--args
1357 @end smallexample
1358
1359 This will invoke all subprograms of gcc under "gdb --args",
1360 thus cc1 invocation will be "gdb --args cc1 ...".
1361
1362 @item -fplugin=@var{name}.so
1363 Load the plugin code in file @var{name}.so, assumed to be a
1364 shared object to be dlopen'd by the compiler.  The base name of
1365 the shared object file is used to identify the plugin for the
1366 purposes of argument parsing (See
1367 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1368 Each plugin should define the callback functions specified in the
1369 Plugins API.
1370
1371 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1372 Define an argument called @var{key} with a value of @var{value}
1373 for the plugin called @var{name}.
1374
1375 @include @value{srcdir}/../libiberty/at-file.texi
1376 @end table
1377
1378 @node Invoking G++
1379 @section Compiling C++ Programs
1380
1381 @cindex suffixes for C++ source
1382 @cindex C++ source file suffixes
1383 C++ source files conventionally use one of the suffixes @samp{.C},
1384 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1385 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1386 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1387 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1388 files with these names and compiles them as C++ programs even if you
1389 call the compiler the same way as for compiling C programs (usually
1390 with the name @command{gcc}).
1391
1392 @findex g++
1393 @findex c++
1394 However, the use of @command{gcc} does not add the C++ library.
1395 @command{g++} is a program that calls GCC and treats @samp{.c},
1396 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1397 files unless @option{-x} is used, and automatically specifies linking
1398 against the C++ library.  This program is also useful when
1399 precompiling a C header file with a @samp{.h} extension for use in C++
1400 compilations.  On many systems, @command{g++} is also installed with
1401 the name @command{c++}.
1402
1403 @cindex invoking @command{g++}
1404 When you compile C++ programs, you may specify many of the same
1405 command-line options that you use for compiling programs in any
1406 language; or command-line options meaningful for C and related
1407 languages; or options that are meaningful only for C++ programs.
1408 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1409 explanations of options for languages related to C@.
1410 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1411 explanations of options that are meaningful only for C++ programs.
1412
1413 @node C Dialect Options
1414 @section Options Controlling C Dialect
1415 @cindex dialect options
1416 @cindex language dialect options
1417 @cindex options, dialect
1418
1419 The following options control the dialect of C (or languages derived
1420 from C, such as C++, Objective-C and Objective-C++) that the compiler
1421 accepts:
1422
1423 @table @gcctabopt
1424 @cindex ANSI support
1425 @cindex ISO support
1426 @item -ansi
1427 @opindex ansi
1428 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1429 equivalent to @samp{-std=c++98}.
1430
1431 This turns off certain features of GCC that are incompatible with ISO
1432 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1433 such as the @code{asm} and @code{typeof} keywords, and
1434 predefined macros such as @code{unix} and @code{vax} that identify the
1435 type of system you are using.  It also enables the undesirable and
1436 rarely used ISO trigraph feature.  For the C compiler,
1437 it disables recognition of C++ style @samp{//} comments as well as
1438 the @code{inline} keyword.
1439
1440 The alternate keywords @code{__asm__}, @code{__extension__},
1441 @code{__inline__} and @code{__typeof__} continue to work despite
1442 @option{-ansi}.  You would not want to use them in an ISO C program, of
1443 course, but it is useful to put them in header files that might be included
1444 in compilations done with @option{-ansi}.  Alternate predefined macros
1445 such as @code{__unix__} and @code{__vax__} are also available, with or
1446 without @option{-ansi}.
1447
1448 The @option{-ansi} option does not cause non-ISO programs to be
1449 rejected gratuitously.  For that, @option{-pedantic} is required in
1450 addition to @option{-ansi}.  @xref{Warning Options}.
1451
1452 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1453 option is used.  Some header files may notice this macro and refrain
1454 from declaring certain functions or defining certain macros that the
1455 ISO standard doesn't call for; this is to avoid interfering with any
1456 programs that might use these names for other things.
1457
1458 Functions that would normally be built in but do not have semantics
1459 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1460 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1461 built-in functions provided by GCC}, for details of the functions
1462 affected.
1463
1464 @item -std=
1465 @opindex std
1466 Determine the language standard. @xref{Standards,,Language Standards
1467 Supported by GCC}, for details of these standard versions.  This option
1468 is currently only supported when compiling C or C++.
1469
1470 The compiler can accept several base standards, such as @samp{c89} or
1471 @samp{c++98}, and GNU dialects of those standards, such as
1472 @samp{gnu89} or @samp{gnu++98}.  By specifying a base standard, the
1473 compiler will accept all programs following that standard and those
1474 using GNU extensions that do not contradict it.  For example,
1475 @samp{-std=c89} turns off certain features of GCC that are
1476 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1477 keywords, but not other GNU extensions that do not have a meaning in
1478 ISO C90, such as omitting the middle term of a @code{?:}
1479 expression. On the other hand, by specifying a GNU dialect of a
1480 standard, all features the compiler support are enabled, even when
1481 those features change the meaning of the base standard and some
1482 strict-conforming programs may be rejected.  The particular standard
1483 is used by @option{-pedantic} to identify which features are GNU
1484 extensions given that version of the standard. For example
1485 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1486 comments, while @samp{-std=gnu99 -pedantic} would not.
1487
1488 A value for this option must be provided; possible values are
1489
1490 @table @samp
1491 @item c89
1492 @itemx iso9899:1990
1493 Support all ISO C90 programs (certain GNU extensions that conflict
1494 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1495
1496 @item iso9899:199409
1497 ISO C90 as modified in amendment 1.
1498
1499 @item c99
1500 @itemx c9x
1501 @itemx iso9899:1999
1502 @itemx iso9899:199x
1503 ISO C99.  Note that this standard is not yet fully supported; see
1504 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1505 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1506
1507 @item gnu89
1508 GNU dialect of ISO C90 (including some C99 features). This
1509 is the default for C code.
1510
1511 @item gnu99
1512 @itemx gnu9x
1513 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1514 this will become the default.  The name @samp{gnu9x} is deprecated.
1515
1516 @item c++98
1517 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1518 C++ code.
1519
1520 @item gnu++98
1521 GNU dialect of @option{-std=c++98}.  This is the default for
1522 C++ code.
1523
1524 @item c++0x
1525 The working draft of the upcoming ISO C++0x standard. This option
1526 enables experimental features that are likely to be included in
1527 C++0x. The working draft is constantly changing, and any feature that is
1528 enabled by this flag may be removed from future versions of GCC if it is
1529 not part of the C++0x standard.
1530
1531 @item gnu++0x
1532 GNU dialect of @option{-std=c++0x}. This option enables
1533 experimental features that may be removed in future versions of GCC.
1534 @end table
1535
1536 @item -fgnu89-inline
1537 @opindex fgnu89-inline
1538 The option @option{-fgnu89-inline} tells GCC to use the traditional
1539 GNU semantics for @code{inline} functions when in C99 mode.
1540 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1541 is accepted and ignored by GCC versions 4.1.3 up to but not including
1542 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1543 C99 mode.  Using this option is roughly equivalent to adding the
1544 @code{gnu_inline} function attribute to all inline functions
1545 (@pxref{Function Attributes}).
1546
1547 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1548 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1549 specifies the default behavior).  This option was first supported in
1550 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1551
1552 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1553 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1554 in effect for @code{inline} functions.  @xref{Common Predefined
1555 Macros,,,cpp,The C Preprocessor}.
1556
1557 @item -aux-info @var{filename}
1558 @opindex aux-info
1559 Output to the given filename prototyped declarations for all functions
1560 declared and/or defined in a translation unit, including those in header
1561 files.  This option is silently ignored in any language other than C@.
1562
1563 Besides declarations, the file indicates, in comments, the origin of
1564 each declaration (source file and line), whether the declaration was
1565 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1566 @samp{O} for old, respectively, in the first character after the line
1567 number and the colon), and whether it came from a declaration or a
1568 definition (@samp{C} or @samp{F}, respectively, in the following
1569 character).  In the case of function definitions, a K&R-style list of
1570 arguments followed by their declarations is also provided, inside
1571 comments, after the declaration.
1572
1573 @item -fno-asm
1574 @opindex fno-asm
1575 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1576 keyword, so that code can use these words as identifiers.  You can use
1577 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1578 instead.  @option{-ansi} implies @option{-fno-asm}.
1579
1580 In C++, this switch only affects the @code{typeof} keyword, since
1581 @code{asm} and @code{inline} are standard keywords.  You may want to
1582 use the @option{-fno-gnu-keywords} flag instead, which has the same
1583 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1584 switch only affects the @code{asm} and @code{typeof} keywords, since
1585 @code{inline} is a standard keyword in ISO C99.
1586
1587 @item -fno-builtin
1588 @itemx -fno-builtin-@var{function}
1589 @opindex fno-builtin
1590 @cindex built-in functions
1591 Don't recognize built-in functions that do not begin with
1592 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1593 functions provided by GCC}, for details of the functions affected,
1594 including those which are not built-in functions when @option{-ansi} or
1595 @option{-std} options for strict ISO C conformance are used because they
1596 do not have an ISO standard meaning.
1597
1598 GCC normally generates special code to handle certain built-in functions
1599 more efficiently; for instance, calls to @code{alloca} may become single
1600 instructions that adjust the stack directly, and calls to @code{memcpy}
1601 may become inline copy loops.  The resulting code is often both smaller
1602 and faster, but since the function calls no longer appear as such, you
1603 cannot set a breakpoint on those calls, nor can you change the behavior
1604 of the functions by linking with a different library.  In addition,
1605 when a function is recognized as a built-in function, GCC may use
1606 information about that function to warn about problems with calls to
1607 that function, or to generate more efficient code, even if the
1608 resulting code still contains calls to that function.  For example,
1609 warnings are given with @option{-Wformat} for bad calls to
1610 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1611 known not to modify global memory.
1612
1613 With the @option{-fno-builtin-@var{function}} option
1614 only the built-in function @var{function} is
1615 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1616 function is named that is not built-in in this version of GCC, this
1617 option is ignored.  There is no corresponding
1618 @option{-fbuiltin-@var{function}} option; if you wish to enable
1619 built-in functions selectively when using @option{-fno-builtin} or
1620 @option{-ffreestanding}, you may define macros such as:
1621
1622 @smallexample
1623 #define abs(n)          __builtin_abs ((n))
1624 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1625 @end smallexample
1626
1627 @item -fhosted
1628 @opindex fhosted
1629 @cindex hosted environment
1630
1631 Assert that compilation takes place in a hosted environment.  This implies
1632 @option{-fbuiltin}.  A hosted environment is one in which the
1633 entire standard library is available, and in which @code{main} has a return
1634 type of @code{int}.  Examples are nearly everything except a kernel.
1635 This is equivalent to @option{-fno-freestanding}.
1636
1637 @item -ffreestanding
1638 @opindex ffreestanding
1639 @cindex hosted environment
1640
1641 Assert that compilation takes place in a freestanding environment.  This
1642 implies @option{-fno-builtin}.  A freestanding environment
1643 is one in which the standard library may not exist, and program startup may
1644 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1645 This is equivalent to @option{-fno-hosted}.
1646
1647 @xref{Standards,,Language Standards Supported by GCC}, for details of
1648 freestanding and hosted environments.
1649
1650 @item -fopenmp
1651 @opindex fopenmp
1652 @cindex openmp parallel
1653 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1654 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1655 compiler generates parallel code according to the OpenMP Application
1656 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1657 implies @option{-pthread}, and thus is only supported on targets that
1658 have support for @option{-pthread}.
1659
1660 @item -fms-extensions
1661 @opindex fms-extensions
1662 Accept some non-standard constructs used in Microsoft header files.
1663
1664 Some cases of unnamed fields in structures and unions are only
1665 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1666 fields within structs/unions}, for details.
1667
1668 @item -trigraphs
1669 @opindex trigraphs
1670 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1671 options for strict ISO C conformance) implies @option{-trigraphs}.
1672
1673 @item -no-integrated-cpp
1674 @opindex no-integrated-cpp
1675 Performs a compilation in two passes: preprocessing and compiling.  This
1676 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1677 @option{-B} option.  The user supplied compilation step can then add in
1678 an additional preprocessing step after normal preprocessing but before
1679 compiling.  The default is to use the integrated cpp (internal cpp)
1680
1681 The semantics of this option will change if "cc1", "cc1plus", and
1682 "cc1obj" are merged.
1683
1684 @cindex traditional C language
1685 @cindex C language, traditional
1686 @item -traditional
1687 @itemx -traditional-cpp
1688 @opindex traditional-cpp
1689 @opindex traditional
1690 Formerly, these options caused GCC to attempt to emulate a pre-standard
1691 C compiler.  They are now only supported with the @option{-E} switch.
1692 The preprocessor continues to support a pre-standard mode.  See the GNU
1693 CPP manual for details.
1694
1695 @item -fcond-mismatch
1696 @opindex fcond-mismatch
1697 Allow conditional expressions with mismatched types in the second and
1698 third arguments.  The value of such an expression is void.  This option
1699 is not supported for C++.
1700
1701 @item -flax-vector-conversions
1702 @opindex flax-vector-conversions
1703 Allow implicit conversions between vectors with differing numbers of
1704 elements and/or incompatible element types.  This option should not be
1705 used for new code.
1706
1707 @item -funsigned-char
1708 @opindex funsigned-char
1709 Let the type @code{char} be unsigned, like @code{unsigned char}.
1710
1711 Each kind of machine has a default for what @code{char} should
1712 be.  It is either like @code{unsigned char} by default or like
1713 @code{signed char} by default.
1714
1715 Ideally, a portable program should always use @code{signed char} or
1716 @code{unsigned char} when it depends on the signedness of an object.
1717 But many programs have been written to use plain @code{char} and
1718 expect it to be signed, or expect it to be unsigned, depending on the
1719 machines they were written for.  This option, and its inverse, let you
1720 make such a program work with the opposite default.
1721
1722 The type @code{char} is always a distinct type from each of
1723 @code{signed char} or @code{unsigned char}, even though its behavior
1724 is always just like one of those two.
1725
1726 @item -fsigned-char
1727 @opindex fsigned-char
1728 Let the type @code{char} be signed, like @code{signed char}.
1729
1730 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1731 the negative form of @option{-funsigned-char}.  Likewise, the option
1732 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1733
1734 @item -fsigned-bitfields
1735 @itemx -funsigned-bitfields
1736 @itemx -fno-signed-bitfields
1737 @itemx -fno-unsigned-bitfields
1738 @opindex fsigned-bitfields
1739 @opindex funsigned-bitfields
1740 @opindex fno-signed-bitfields
1741 @opindex fno-unsigned-bitfields
1742 These options control whether a bit-field is signed or unsigned, when the
1743 declaration does not use either @code{signed} or @code{unsigned}.  By
1744 default, such a bit-field is signed, because this is consistent: the
1745 basic integer types such as @code{int} are signed types.
1746 @end table
1747
1748 @node C++ Dialect Options
1749 @section Options Controlling C++ Dialect
1750
1751 @cindex compiler options, C++
1752 @cindex C++ options, command line
1753 @cindex options, C++
1754 This section describes the command-line options that are only meaningful
1755 for C++ programs; but you can also use most of the GNU compiler options
1756 regardless of what language your program is in.  For example, you
1757 might compile a file @code{firstClass.C} like this:
1758
1759 @smallexample
1760 g++ -g -frepo -O -c firstClass.C
1761 @end smallexample
1762
1763 @noindent
1764 In this example, only @option{-frepo} is an option meant
1765 only for C++ programs; you can use the other options with any
1766 language supported by GCC@.
1767
1768 Here is a list of options that are @emph{only} for compiling C++ programs:
1769
1770 @table @gcctabopt
1771
1772 @item -fabi-version=@var{n}
1773 @opindex fabi-version
1774 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1775 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1776 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1777 the version that conforms most closely to the C++ ABI specification.
1778 Therefore, the ABI obtained using version 0 will change as ABI bugs
1779 are fixed.
1780
1781 The default is version 2.
1782
1783 Version 3 corrects an error in mangling a constant address as a
1784 template argument.
1785
1786 Version 4 implements a standard mangling for vector types.
1787
1788 See also @option{-Wabi}.
1789
1790 @item -fno-access-control
1791 @opindex fno-access-control
1792 Turn off all access checking.  This switch is mainly useful for working
1793 around bugs in the access control code.
1794
1795 @item -fcheck-new
1796 @opindex fcheck-new
1797 Check that the pointer returned by @code{operator new} is non-null
1798 before attempting to modify the storage allocated.  This check is
1799 normally unnecessary because the C++ standard specifies that
1800 @code{operator new} will only return @code{0} if it is declared
1801 @samp{throw()}, in which case the compiler will always check the
1802 return value even without this option.  In all other cases, when
1803 @code{operator new} has a non-empty exception specification, memory
1804 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1805 @samp{new (nothrow)}.
1806
1807 @item -fconserve-space
1808 @opindex fconserve-space
1809 Put uninitialized or runtime-initialized global variables into the
1810 common segment, as C does.  This saves space in the executable at the
1811 cost of not diagnosing duplicate definitions.  If you compile with this
1812 flag and your program mysteriously crashes after @code{main()} has
1813 completed, you may have an object that is being destroyed twice because
1814 two definitions were merged.
1815
1816 This option is no longer useful on most targets, now that support has
1817 been added for putting variables into BSS without making them common.
1818
1819 @item -fno-deduce-init-list
1820 @opindex fno-deduce-init-list
1821 Disable deduction of a template type parameter as
1822 std::initializer_list from a brace-enclosed initializer list, i.e.
1823
1824 @smallexample
1825 template <class T> auto forward(T t) -> decltype (realfn (t))
1826 @{
1827   return realfn (t);
1828 @}
1829
1830 void f()
1831 @{
1832   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1833 @}
1834 @end smallexample
1835
1836 This option is present because this deduction is an extension to the
1837 current specification in the C++0x working draft, and there was
1838 some concern about potential overload resolution problems.
1839
1840 @item -ffriend-injection
1841 @opindex ffriend-injection
1842 Inject friend functions into the enclosing namespace, so that they are
1843 visible outside the scope of the class in which they are declared.
1844 Friend functions were documented to work this way in the old Annotated
1845 C++ Reference Manual, and versions of G++ before 4.1 always worked
1846 that way.  However, in ISO C++ a friend function which is not declared
1847 in an enclosing scope can only be found using argument dependent
1848 lookup.  This option causes friends to be injected as they were in
1849 earlier releases.
1850
1851 This option is for compatibility, and may be removed in a future
1852 release of G++.
1853
1854 @item -fno-elide-constructors
1855 @opindex fno-elide-constructors
1856 The C++ standard allows an implementation to omit creating a temporary
1857 which is only used to initialize another object of the same type.
1858 Specifying this option disables that optimization, and forces G++ to
1859 call the copy constructor in all cases.
1860
1861 @item -fno-enforce-eh-specs
1862 @opindex fno-enforce-eh-specs
1863 Don't generate code to check for violation of exception specifications
1864 at runtime.  This option violates the C++ standard, but may be useful
1865 for reducing code size in production builds, much like defining
1866 @samp{NDEBUG}.  This does not give user code permission to throw
1867 exceptions in violation of the exception specifications; the compiler
1868 will still optimize based on the specifications, so throwing an
1869 unexpected exception will result in undefined behavior.
1870
1871 @item -ffor-scope
1872 @itemx -fno-for-scope
1873 @opindex ffor-scope
1874 @opindex fno-for-scope
1875 If @option{-ffor-scope} is specified, the scope of variables declared in
1876 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1877 as specified by the C++ standard.
1878 If @option{-fno-for-scope} is specified, the scope of variables declared in
1879 a @i{for-init-statement} extends to the end of the enclosing scope,
1880 as was the case in old versions of G++, and other (traditional)
1881 implementations of C++.
1882
1883 The default if neither flag is given to follow the standard,
1884 but to allow and give a warning for old-style code that would
1885 otherwise be invalid, or have different behavior.
1886
1887 @item -fno-gnu-keywords
1888 @opindex fno-gnu-keywords
1889 Do not recognize @code{typeof} as a keyword, so that code can use this
1890 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1891 @option{-ansi} implies @option{-fno-gnu-keywords}.
1892
1893 @item -fno-implicit-templates
1894 @opindex fno-implicit-templates
1895 Never emit code for non-inline templates which are instantiated
1896 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1897 @xref{Template Instantiation}, for more information.
1898
1899 @item -fno-implicit-inline-templates
1900 @opindex fno-implicit-inline-templates
1901 Don't emit code for implicit instantiations of inline templates, either.
1902 The default is to handle inlines differently so that compiles with and
1903 without optimization will need the same set of explicit instantiations.
1904
1905 @item -fno-implement-inlines
1906 @opindex fno-implement-inlines
1907 To save space, do not emit out-of-line copies of inline functions
1908 controlled by @samp{#pragma implementation}.  This will cause linker
1909 errors if these functions are not inlined everywhere they are called.
1910
1911 @item -fms-extensions
1912 @opindex fms-extensions
1913 Disable pedantic warnings about constructs used in MFC, such as implicit
1914 int and getting a pointer to member function via non-standard syntax.
1915
1916 @item -fno-nonansi-builtins
1917 @opindex fno-nonansi-builtins
1918 Disable built-in declarations of functions that are not mandated by
1919 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1920 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1921
1922 @item -fno-operator-names
1923 @opindex fno-operator-names
1924 Do not treat the operator name keywords @code{and}, @code{bitand},
1925 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1926 synonyms as keywords.
1927
1928 @item -fno-optional-diags
1929 @opindex fno-optional-diags
1930 Disable diagnostics that the standard says a compiler does not need to
1931 issue.  Currently, the only such diagnostic issued by G++ is the one for
1932 a name having multiple meanings within a class.
1933
1934 @item -fpermissive
1935 @opindex fpermissive
1936 Downgrade some diagnostics about nonconformant code from errors to
1937 warnings.  Thus, using @option{-fpermissive} will allow some
1938 nonconforming code to compile.
1939
1940 @item -fno-pretty-templates
1941 @opindex fno-pretty-templates
1942 When an error message refers to a specialization of a function
1943 template, the compiler will normally print the signature of the
1944 template followed by the template arguments and any typedefs or
1945 typenames in the signature (e.g. @code{void f(T) [with T = int]}
1946 rather than @code{void f(int)}) so that it's clear which template is
1947 involved.  When an error message refers to a specialization of a class
1948 template, the compiler will omit any template arguments which match
1949 the default template arguments for that template.  If either of these
1950 behaviors make it harder to understand the error message rather than
1951 easier, using @option{-fno-pretty-templates} will disable them.
1952
1953 @item -frepo
1954 @opindex frepo
1955 Enable automatic template instantiation at link time.  This option also
1956 implies @option{-fno-implicit-templates}.  @xref{Template
1957 Instantiation}, for more information.
1958
1959 @item -fno-rtti
1960 @opindex fno-rtti
1961 Disable generation of information about every class with virtual
1962 functions for use by the C++ runtime type identification features
1963 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1964 of the language, you can save some space by using this flag.  Note that
1965 exception handling uses the same information, but it will generate it as
1966 needed. The @samp{dynamic_cast} operator can still be used for casts that
1967 do not require runtime type information, i.e.@: casts to @code{void *} or to
1968 unambiguous base classes.
1969
1970 @item -fstats
1971 @opindex fstats
1972 Emit statistics about front-end processing at the end of the compilation.
1973 This information is generally only useful to the G++ development team.
1974
1975 @item -ftemplate-depth=@var{n}
1976 @opindex ftemplate-depth
1977 Set the maximum instantiation depth for template classes to @var{n}.
1978 A limit on the template instantiation depth is needed to detect
1979 endless recursions during template class instantiation.  ANSI/ISO C++
1980 conforming programs must not rely on a maximum depth greater than 17
1981 (changed to 1024 in C++0x).
1982
1983 @item -fno-threadsafe-statics
1984 @opindex fno-threadsafe-statics
1985 Do not emit the extra code to use the routines specified in the C++
1986 ABI for thread-safe initialization of local statics.  You can use this
1987 option to reduce code size slightly in code that doesn't need to be
1988 thread-safe.
1989
1990 @item -fuse-cxa-atexit
1991 @opindex fuse-cxa-atexit
1992 Register destructors for objects with static storage duration with the
1993 @code{__cxa_atexit} function rather than the @code{atexit} function.
1994 This option is required for fully standards-compliant handling of static
1995 destructors, but will only work if your C library supports
1996 @code{__cxa_atexit}.
1997
1998 @item -fno-use-cxa-get-exception-ptr
1999 @opindex fno-use-cxa-get-exception-ptr
2000 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2001 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
2002 if the runtime routine is not available.
2003
2004 @item -fvisibility-inlines-hidden
2005 @opindex fvisibility-inlines-hidden
2006 This switch declares that the user does not attempt to compare
2007 pointers to inline methods where the addresses of the two functions
2008 were taken in different shared objects.
2009
2010 The effect of this is that GCC may, effectively, mark inline methods with
2011 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2012 appear in the export table of a DSO and do not require a PLT indirection
2013 when used within the DSO@.  Enabling this option can have a dramatic effect
2014 on load and link times of a DSO as it massively reduces the size of the
2015 dynamic export table when the library makes heavy use of templates.
2016
2017 The behavior of this switch is not quite the same as marking the
2018 methods as hidden directly, because it does not affect static variables
2019 local to the function or cause the compiler to deduce that
2020 the function is defined in only one shared object.
2021
2022 You may mark a method as having a visibility explicitly to negate the
2023 effect of the switch for that method.  For example, if you do want to
2024 compare pointers to a particular inline method, you might mark it as
2025 having default visibility.  Marking the enclosing class with explicit
2026 visibility will have no effect.
2027
2028 Explicitly instantiated inline methods are unaffected by this option
2029 as their linkage might otherwise cross a shared library boundary.
2030 @xref{Template Instantiation}.
2031
2032 @item -fvisibility-ms-compat
2033 @opindex fvisibility-ms-compat
2034 This flag attempts to use visibility settings to make GCC's C++
2035 linkage model compatible with that of Microsoft Visual Studio.
2036
2037 The flag makes these changes to GCC's linkage model:
2038
2039 @enumerate
2040 @item
2041 It sets the default visibility to @code{hidden}, like
2042 @option{-fvisibility=hidden}.
2043
2044 @item
2045 Types, but not their members, are not hidden by default.
2046
2047 @item
2048 The One Definition Rule is relaxed for types without explicit
2049 visibility specifications which are defined in more than one different
2050 shared object: those declarations are permitted if they would have
2051 been permitted when this option was not used.
2052 @end enumerate
2053
2054 In new code it is better to use @option{-fvisibility=hidden} and
2055 export those classes which are intended to be externally visible.
2056 Unfortunately it is possible for code to rely, perhaps accidentally,
2057 on the Visual Studio behavior.
2058
2059 Among the consequences of these changes are that static data members
2060 of the same type with the same name but defined in different shared
2061 objects will be different, so changing one will not change the other;
2062 and that pointers to function members defined in different shared
2063 objects may not compare equal.  When this flag is given, it is a
2064 violation of the ODR to define types with the same name differently.
2065
2066 @item -fno-weak
2067 @opindex fno-weak
2068 Do not use weak symbol support, even if it is provided by the linker.
2069 By default, G++ will use weak symbols if they are available.  This
2070 option exists only for testing, and should not be used by end-users;
2071 it will result in inferior code and has no benefits.  This option may
2072 be removed in a future release of G++.
2073
2074 @item -nostdinc++
2075 @opindex nostdinc++
2076 Do not search for header files in the standard directories specific to
2077 C++, but do still search the other standard directories.  (This option
2078 is used when building the C++ library.)
2079 @end table
2080
2081 In addition, these optimization, warning, and code generation options
2082 have meanings only for C++ programs:
2083
2084 @table @gcctabopt
2085 @item -fno-default-inline
2086 @opindex fno-default-inline
2087 Do not assume @samp{inline} for functions defined inside a class scope.
2088 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2089 functions will have linkage like inline functions; they just won't be
2090 inlined by default.
2091
2092 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2093 @opindex Wabi
2094 @opindex Wno-abi
2095 Warn when G++ generates code that is probably not compatible with the
2096 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2097 all such cases, there are probably some cases that are not warned about,
2098 even though G++ is generating incompatible code.  There may also be
2099 cases where warnings are emitted even though the code that is generated
2100 will be compatible.
2101
2102 You should rewrite your code to avoid these warnings if you are
2103 concerned about the fact that code generated by G++ may not be binary
2104 compatible with code generated by other compilers.
2105
2106 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2107
2108 @itemize @bullet
2109
2110 @item
2111 A template with a non-type template parameter of reference type is
2112 mangled incorrectly:
2113 @smallexample
2114 extern int N;
2115 template <int &> struct S @{@};
2116 void n (S<N>) @{2@}
2117 @end smallexample
2118
2119 This is fixed in @option{-fabi-version=3}.
2120
2121 @item
2122 SIMD vector types declared using @code{__attribute ((vector_size))} are
2123 mangled in a non-standard way that does not allow for overloading of
2124 functions taking vectors of different sizes.
2125
2126 The mangling is changed in @option{-fabi-version=4}.
2127 @end itemize
2128
2129 The known incompatibilities in @option{-fabi-version=1} include:
2130
2131 @itemize @bullet
2132
2133 @item
2134 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2135 pack data into the same byte as a base class.  For example:
2136
2137 @smallexample
2138 struct A @{ virtual void f(); int f1 : 1; @};
2139 struct B : public A @{ int f2 : 1; @};
2140 @end smallexample
2141
2142 @noindent
2143 In this case, G++ will place @code{B::f2} into the same byte
2144 as@code{A::f1}; other compilers will not.  You can avoid this problem
2145 by explicitly padding @code{A} so that its size is a multiple of the
2146 byte size on your platform; that will cause G++ and other compilers to
2147 layout @code{B} identically.
2148
2149 @item
2150 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2151 tail padding when laying out virtual bases.  For example:
2152
2153 @smallexample
2154 struct A @{ virtual void f(); char c1; @};
2155 struct B @{ B(); char c2; @};
2156 struct C : public A, public virtual B @{@};
2157 @end smallexample
2158
2159 @noindent
2160 In this case, G++ will not place @code{B} into the tail-padding for
2161 @code{A}; other compilers will.  You can avoid this problem by
2162 explicitly padding @code{A} so that its size is a multiple of its
2163 alignment (ignoring virtual base classes); that will cause G++ and other
2164 compilers to layout @code{C} identically.
2165
2166 @item
2167 Incorrect handling of bit-fields with declared widths greater than that
2168 of their underlying types, when the bit-fields appear in a union.  For
2169 example:
2170
2171 @smallexample
2172 union U @{ int i : 4096; @};
2173 @end smallexample
2174
2175 @noindent
2176 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2177 union too small by the number of bits in an @code{int}.
2178
2179 @item
2180 Empty classes can be placed at incorrect offsets.  For example:
2181
2182 @smallexample
2183 struct A @{@};
2184
2185 struct B @{
2186   A a;
2187   virtual void f ();
2188 @};
2189
2190 struct C : public B, public A @{@};
2191 @end smallexample
2192
2193 @noindent
2194 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2195 it should be placed at offset zero.  G++ mistakenly believes that the
2196 @code{A} data member of @code{B} is already at offset zero.
2197
2198 @item
2199 Names of template functions whose types involve @code{typename} or
2200 template template parameters can be mangled incorrectly.
2201
2202 @smallexample
2203 template <typename Q>
2204 void f(typename Q::X) @{@}
2205
2206 template <template <typename> class Q>
2207 void f(typename Q<int>::X) @{@}
2208 @end smallexample
2209
2210 @noindent
2211 Instantiations of these templates may be mangled incorrectly.
2212
2213 @end itemize
2214
2215 It also warns psABI related changes.  The known psABI changes at this
2216 point include:
2217
2218 @itemize @bullet
2219
2220 @item
2221 For SYSV/x86-64, when passing union with long double, it is changed to
2222 pass in memory as specified in psABI.  For example:
2223
2224 @smallexample
2225 union U @{
2226   long double ld;
2227   int i;
2228 @};
2229 @end smallexample
2230
2231 @noindent
2232 @code{union U} will always be passed in memory.
2233
2234 @end itemize
2235
2236 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2237 @opindex Wctor-dtor-privacy
2238 @opindex Wno-ctor-dtor-privacy
2239 Warn when a class seems unusable because all the constructors or
2240 destructors in that class are private, and it has neither friends nor
2241 public static member functions.
2242
2243 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2244 @opindex Wnon-virtual-dtor
2245 @opindex Wno-non-virtual-dtor
2246 Warn when a class has virtual functions and accessible non-virtual
2247 destructor, in which case it would be possible but unsafe to delete
2248 an instance of a derived class through a pointer to the base class.
2249 This warning is also enabled if -Weffc++ is specified.
2250
2251 @item -Wreorder @r{(C++ and Objective-C++ only)}
2252 @opindex Wreorder
2253 @opindex Wno-reorder
2254 @cindex reordering, warning
2255 @cindex warning for reordering of member initializers
2256 Warn when the order of member initializers given in the code does not
2257 match the order in which they must be executed.  For instance:
2258
2259 @smallexample
2260 struct A @{
2261   int i;
2262   int j;
2263   A(): j (0), i (1) @{ @}
2264 @};
2265 @end smallexample
2266
2267 The compiler will rearrange the member initializers for @samp{i}
2268 and @samp{j} to match the declaration order of the members, emitting
2269 a warning to that effect.  This warning is enabled by @option{-Wall}.
2270 @end table
2271
2272 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2273
2274 @table @gcctabopt
2275 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2276 @opindex Weffc++
2277 @opindex Wno-effc++
2278 Warn about violations of the following style guidelines from Scott Meyers'
2279 @cite{Effective C++} book:
2280
2281 @itemize @bullet
2282 @item
2283 Item 11:  Define a copy constructor and an assignment operator for classes
2284 with dynamically allocated memory.
2285
2286 @item
2287 Item 12:  Prefer initialization to assignment in constructors.
2288
2289 @item
2290 Item 14:  Make destructors virtual in base classes.
2291
2292 @item
2293 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2294
2295 @item
2296 Item 23:  Don't try to return a reference when you must return an object.
2297
2298 @end itemize
2299
2300 Also warn about violations of the following style guidelines from
2301 Scott Meyers' @cite{More Effective C++} book:
2302
2303 @itemize @bullet
2304 @item
2305 Item 6:  Distinguish between prefix and postfix forms of increment and
2306 decrement operators.
2307
2308 @item
2309 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2310
2311 @end itemize
2312
2313 When selecting this option, be aware that the standard library
2314 headers do not obey all of these guidelines; use @samp{grep -v}
2315 to filter out those warnings.
2316
2317 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2318 @opindex Wstrict-null-sentinel
2319 @opindex Wno-strict-null-sentinel
2320 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2321 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2322 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2323 it is guaranteed to be of the same size as a pointer.  But this use is
2324 not portable across different compilers.
2325
2326 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2327 @opindex Wno-non-template-friend
2328 @opindex Wnon-template-friend
2329 Disable warnings when non-templatized friend functions are declared
2330 within a template.  Since the advent of explicit template specification
2331 support in G++, if the name of the friend is an unqualified-id (i.e.,
2332 @samp{friend foo(int)}), the C++ language specification demands that the
2333 friend declare or define an ordinary, nontemplate function.  (Section
2334 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2335 could be interpreted as a particular specialization of a templatized
2336 function.  Because this non-conforming behavior is no longer the default
2337 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2338 check existing code for potential trouble spots and is on by default.
2339 This new compiler behavior can be turned off with
2340 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2341 but disables the helpful warning.
2342
2343 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2344 @opindex Wold-style-cast
2345 @opindex Wno-old-style-cast
2346 Warn if an old-style (C-style) cast to a non-void type is used within
2347 a C++ program.  The new-style casts (@samp{dynamic_cast},
2348 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2349 less vulnerable to unintended effects and much easier to search for.
2350
2351 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2352 @opindex Woverloaded-virtual
2353 @opindex Wno-overloaded-virtual
2354 @cindex overloaded virtual fn, warning
2355 @cindex warning for overloaded virtual fn
2356 Warn when a function declaration hides virtual functions from a
2357 base class.  For example, in:
2358
2359 @smallexample
2360 struct A @{
2361   virtual void f();
2362 @};
2363
2364 struct B: public A @{
2365   void f(int);
2366 @};
2367 @end smallexample
2368
2369 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2370 like:
2371
2372 @smallexample
2373 B* b;
2374 b->f();
2375 @end smallexample
2376
2377 will fail to compile.
2378
2379 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2380 @opindex Wno-pmf-conversions
2381 @opindex Wpmf-conversions
2382 Disable the diagnostic for converting a bound pointer to member function
2383 to a plain pointer.
2384
2385 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2386 @opindex Wsign-promo
2387 @opindex Wno-sign-promo
2388 Warn when overload resolution chooses a promotion from unsigned or
2389 enumerated type to a signed type, over a conversion to an unsigned type of
2390 the same size.  Previous versions of G++ would try to preserve
2391 unsignedness, but the standard mandates the current behavior.
2392
2393 @smallexample
2394 struct A @{
2395   operator int ();
2396   A& operator = (int);
2397 @};
2398
2399 main ()
2400 @{
2401   A a,b;
2402   a = b;
2403 @}
2404 @end smallexample
2405
2406 In this example, G++ will synthesize a default @samp{A& operator =
2407 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2408 @end table
2409
2410 @node Objective-C and Objective-C++ Dialect Options
2411 @section Options Controlling Objective-C and Objective-C++ Dialects
2412
2413 @cindex compiler options, Objective-C and Objective-C++
2414 @cindex Objective-C and Objective-C++ options, command line
2415 @cindex options, Objective-C and Objective-C++
2416 (NOTE: This manual does not describe the Objective-C and Objective-C++
2417 languages themselves.  See @xref{Standards,,Language Standards
2418 Supported by GCC}, for references.)
2419
2420 This section describes the command-line options that are only meaningful
2421 for Objective-C and Objective-C++ programs, but you can also use most of
2422 the language-independent GNU compiler options.
2423 For example, you might compile a file @code{some_class.m} like this:
2424
2425 @smallexample
2426 gcc -g -fgnu-runtime -O -c some_class.m
2427 @end smallexample
2428
2429 @noindent
2430 In this example, @option{-fgnu-runtime} is an option meant only for
2431 Objective-C and Objective-C++ programs; you can use the other options with
2432 any language supported by GCC@.
2433
2434 Note that since Objective-C is an extension of the C language, Objective-C
2435 compilations may also use options specific to the C front-end (e.g.,
2436 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2437 C++-specific options (e.g., @option{-Wabi}).
2438
2439 Here is a list of options that are @emph{only} for compiling Objective-C
2440 and Objective-C++ programs:
2441
2442 @table @gcctabopt
2443 @item -fconstant-string-class=@var{class-name}
2444 @opindex fconstant-string-class
2445 Use @var{class-name} as the name of the class to instantiate for each
2446 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2447 class name is @code{NXConstantString} if the GNU runtime is being used, and
2448 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2449 @option{-fconstant-cfstrings} option, if also present, will override the
2450 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2451 to be laid out as constant CoreFoundation strings.
2452
2453 @item -fgnu-runtime
2454 @opindex fgnu-runtime
2455 Generate object code compatible with the standard GNU Objective-C
2456 runtime.  This is the default for most types of systems.
2457
2458 @item -fnext-runtime
2459 @opindex fnext-runtime
2460 Generate output compatible with the NeXT runtime.  This is the default
2461 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2462 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2463 used.
2464
2465 @item -fno-nil-receivers
2466 @opindex fno-nil-receivers
2467 Assume that all Objective-C message dispatches (e.g.,
2468 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2469 is not @code{nil}.  This allows for more efficient entry points in the runtime
2470 to be used.  Currently, this option is only available in conjunction with
2471 the NeXT runtime on Mac OS X 10.3 and later.
2472
2473 @item -fobjc-call-cxx-cdtors
2474 @opindex fobjc-call-cxx-cdtors
2475 For each Objective-C class, check if any of its instance variables is a
2476 C++ object with a non-trivial default constructor.  If so, synthesize a
2477 special @code{- (id) .cxx_construct} instance method that will run
2478 non-trivial default constructors on any such instance variables, in order,
2479 and then return @code{self}.  Similarly, check if any instance variable
2480 is a C++ object with a non-trivial destructor, and if so, synthesize a
2481 special @code{- (void) .cxx_destruct} method that will run
2482 all such default destructors, in reverse order.
2483
2484 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2485 thusly generated will only operate on instance variables declared in the
2486 current Objective-C class, and not those inherited from superclasses.  It
2487 is the responsibility of the Objective-C runtime to invoke all such methods
2488 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2489 will be invoked by the runtime immediately after a new object
2490 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2491 be invoked immediately before the runtime deallocates an object instance.
2492
2493 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2494 support for invoking the @code{- (id) .cxx_construct} and
2495 @code{- (void) .cxx_destruct} methods.
2496
2497 @item -fobjc-direct-dispatch
2498 @opindex fobjc-direct-dispatch
2499 Allow fast jumps to the message dispatcher.  On Darwin this is
2500 accomplished via the comm page.
2501
2502 @item -fobjc-exceptions
2503 @opindex fobjc-exceptions
2504 Enable syntactic support for structured exception handling in Objective-C,
2505 similar to what is offered by C++ and Java.  This option is
2506 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2507 earlier.
2508
2509 @smallexample
2510   @@try @{
2511     @dots{}
2512        @@throw expr;
2513     @dots{}
2514   @}
2515   @@catch (AnObjCClass *exc) @{
2516     @dots{}
2517       @@throw expr;
2518     @dots{}
2519       @@throw;
2520     @dots{}
2521   @}
2522   @@catch (AnotherClass *exc) @{
2523     @dots{}
2524   @}
2525   @@catch (id allOthers) @{
2526     @dots{}
2527   @}
2528   @@finally @{
2529     @dots{}
2530       @@throw expr;
2531     @dots{}
2532   @}
2533 @end smallexample
2534
2535 The @code{@@throw} statement may appear anywhere in an Objective-C or
2536 Objective-C++ program; when used inside of a @code{@@catch} block, the
2537 @code{@@throw} may appear without an argument (as shown above), in which case
2538 the object caught by the @code{@@catch} will be rethrown.
2539
2540 Note that only (pointers to) Objective-C objects may be thrown and
2541 caught using this scheme.  When an object is thrown, it will be caught
2542 by the nearest @code{@@catch} clause capable of handling objects of that type,
2543 analogously to how @code{catch} blocks work in C++ and Java.  A
2544 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2545 any and all Objective-C exceptions not caught by previous @code{@@catch}
2546 clauses (if any).
2547
2548 The @code{@@finally} clause, if present, will be executed upon exit from the
2549 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2550 regardless of whether any exceptions are thrown, caught or rethrown
2551 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2552 of the @code{finally} clause in Java.
2553
2554 There are several caveats to using the new exception mechanism:
2555
2556 @itemize @bullet
2557 @item
2558 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2559 idioms provided by the @code{NSException} class, the new
2560 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2561 systems, due to additional functionality needed in the (NeXT) Objective-C
2562 runtime.
2563
2564 @item
2565 As mentioned above, the new exceptions do not support handling
2566 types other than Objective-C objects.   Furthermore, when used from
2567 Objective-C++, the Objective-C exception model does not interoperate with C++
2568 exceptions at this time.  This means you cannot @code{@@throw} an exception
2569 from Objective-C and @code{catch} it in C++, or vice versa
2570 (i.e., @code{throw @dots{} @@catch}).
2571 @end itemize
2572
2573 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2574 blocks for thread-safe execution:
2575
2576 @smallexample
2577   @@synchronized (ObjCClass *guard) @{
2578     @dots{}
2579   @}
2580 @end smallexample
2581
2582 Upon entering the @code{@@synchronized} block, a thread of execution shall
2583 first check whether a lock has been placed on the corresponding @code{guard}
2584 object by another thread.  If it has, the current thread shall wait until
2585 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2586 the current thread will place its own lock on it, execute the code contained in
2587 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2588 making @code{guard} available to other threads).
2589
2590 Unlike Java, Objective-C does not allow for entire methods to be marked
2591 @code{@@synchronized}.  Note that throwing exceptions out of
2592 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2593 to be unlocked properly.
2594
2595 @item -fobjc-gc
2596 @opindex fobjc-gc
2597 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2598
2599 @item -freplace-objc-classes
2600 @opindex freplace-objc-classes
2601 Emit a special marker instructing @command{ld(1)} not to statically link in
2602 the resulting object file, and allow @command{dyld(1)} to load it in at
2603 run time instead.  This is used in conjunction with the Fix-and-Continue
2604 debugging mode, where the object file in question may be recompiled and
2605 dynamically reloaded in the course of program execution, without the need
2606 to restart the program itself.  Currently, Fix-and-Continue functionality
2607 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2608 and later.
2609
2610 @item -fzero-link
2611 @opindex fzero-link
2612 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2613 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2614 compile time) with static class references that get initialized at load time,
2615 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2616 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2617 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2618 for individual class implementations to be modified during program execution.
2619
2620 @item -gen-decls
2621 @opindex gen-decls
2622 Dump interface declarations for all classes seen in the source file to a
2623 file named @file{@var{sourcename}.decl}.
2624
2625 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2626 @opindex Wassign-intercept
2627 @opindex Wno-assign-intercept
2628 Warn whenever an Objective-C assignment is being intercepted by the
2629 garbage collector.
2630
2631 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2632 @opindex Wno-protocol
2633 @opindex Wprotocol
2634 If a class is declared to implement a protocol, a warning is issued for
2635 every method in the protocol that is not implemented by the class.  The
2636 default behavior is to issue a warning for every method not explicitly
2637 implemented in the class, even if a method implementation is inherited
2638 from the superclass.  If you use the @option{-Wno-protocol} option, then
2639 methods inherited from the superclass are considered to be implemented,
2640 and no warning is issued for them.
2641
2642 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2643 @opindex Wselector
2644 @opindex Wno-selector
2645 Warn if multiple methods of different types for the same selector are
2646 found during compilation.  The check is performed on the list of methods
2647 in the final stage of compilation.  Additionally, a check is performed
2648 for each selector appearing in a @code{@@selector(@dots{})}
2649 expression, and a corresponding method for that selector has been found
2650 during compilation.  Because these checks scan the method table only at
2651 the end of compilation, these warnings are not produced if the final
2652 stage of compilation is not reached, for example because an error is
2653 found during compilation, or because the @option{-fsyntax-only} option is
2654 being used.
2655
2656 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2657 @opindex Wstrict-selector-match
2658 @opindex Wno-strict-selector-match
2659 Warn if multiple methods with differing argument and/or return types are
2660 found for a given selector when attempting to send a message using this
2661 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2662 is off (which is the default behavior), the compiler will omit such warnings
2663 if any differences found are confined to types which share the same size
2664 and alignment.
2665
2666 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2667 @opindex Wundeclared-selector
2668 @opindex Wno-undeclared-selector
2669 Warn if a @code{@@selector(@dots{})} expression referring to an
2670 undeclared selector is found.  A selector is considered undeclared if no
2671 method with that name has been declared before the
2672 @code{@@selector(@dots{})} expression, either explicitly in an
2673 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2674 an @code{@@implementation} section.  This option always performs its
2675 checks as soon as a @code{@@selector(@dots{})} expression is found,
2676 while @option{-Wselector} only performs its checks in the final stage of
2677 compilation.  This also enforces the coding style convention
2678 that methods and selectors must be declared before being used.
2679
2680 @item -print-objc-runtime-info
2681 @opindex print-objc-runtime-info
2682 Generate C header describing the largest structure that is passed by
2683 value, if any.
2684
2685 @end table
2686
2687 @node Language Independent Options
2688 @section Options to Control Diagnostic Messages Formatting
2689 @cindex options to control diagnostics formatting
2690 @cindex diagnostic messages
2691 @cindex message formatting
2692
2693 Traditionally, diagnostic messages have been formatted irrespective of
2694 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2695 below can be used to control the diagnostic messages formatting
2696 algorithm, e.g.@: how many characters per line, how often source location
2697 information should be reported.  Right now, only the C++ front end can
2698 honor these options.  However it is expected, in the near future, that
2699 the remaining front ends would be able to digest them correctly.
2700
2701 @table @gcctabopt
2702 @item -fmessage-length=@var{n}
2703 @opindex fmessage-length
2704 Try to format error messages so that they fit on lines of about @var{n}
2705 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2706 the front ends supported by GCC@.  If @var{n} is zero, then no
2707 line-wrapping will be done; each error message will appear on a single
2708 line.
2709
2710 @opindex fdiagnostics-show-location
2711 @item -fdiagnostics-show-location=once
2712 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2713 reporter to emit @emph{once} source location information; that is, in
2714 case the message is too long to fit on a single physical line and has to
2715 be wrapped, the source location won't be emitted (as prefix) again,
2716 over and over, in subsequent continuation lines.  This is the default
2717 behavior.
2718
2719 @item -fdiagnostics-show-location=every-line
2720 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2721 messages reporter to emit the same source location information (as
2722 prefix) for physical lines that result from the process of breaking
2723 a message which is too long to fit on a single line.
2724
2725 @item -fdiagnostics-show-option
2726 @opindex fdiagnostics-show-option
2727 This option instructs the diagnostic machinery to add text to each
2728 diagnostic emitted, which indicates which command line option directly
2729 controls that diagnostic, when such an option is known to the
2730 diagnostic machinery.
2731
2732 @item -Wcoverage-mismatch
2733 @opindex Wcoverage-mismatch
2734 Warn if feedback profiles do not match when using the
2735 @option{-fprofile-use} option.
2736 If a source file was changed between @option{-fprofile-gen} and
2737 @option{-fprofile-use}, the files with the profile feedback can fail
2738 to match the source file and GCC can not use the profile feedback
2739 information.  By default, GCC emits an error message in this case.
2740 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2741 error.  GCC does not use appropriate feedback profiles, so using this
2742 option can result in poorly optimized code.  This option is useful
2743 only in the case of very minor changes such as bug fixes to an
2744 existing code-base.
2745
2746 @end table
2747
2748 @node Warning Options
2749 @section Options to Request or Suppress Warnings
2750 @cindex options to control warnings
2751 @cindex warning messages
2752 @cindex messages, warning
2753 @cindex suppressing warnings
2754
2755 Warnings are diagnostic messages that report constructions which
2756 are not inherently erroneous but which are risky or suggest there
2757 may have been an error.
2758
2759 The following language-independent options do not enable specific
2760 warnings but control the kinds of diagnostics produced by GCC.
2761
2762 @table @gcctabopt
2763 @cindex syntax checking
2764 @item -fsyntax-only
2765 @opindex fsyntax-only
2766 Check the code for syntax errors, but don't do anything beyond that.
2767
2768 @item -w
2769 @opindex w
2770 Inhibit all warning messages.
2771
2772 @item -Werror
2773 @opindex Werror
2774 @opindex Wno-error
2775 Make all warnings into errors.
2776
2777 @item -Werror=
2778 @opindex Werror=
2779 @opindex Wno-error=
2780 Make the specified warning into an error.  The specifier for a warning
2781 is appended, for example @option{-Werror=switch} turns the warnings
2782 controlled by @option{-Wswitch} into errors.  This switch takes a
2783 negative form, to be used to negate @option{-Werror} for specific
2784 warnings, for example @option{-Wno-error=switch} makes
2785 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2786 is in effect.  You can use the @option{-fdiagnostics-show-option}
2787 option to have each controllable warning amended with the option which
2788 controls it, to determine what to use with this option.
2789
2790 Note that specifying @option{-Werror=}@var{foo} automatically implies
2791 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2792 imply anything.
2793
2794 @item -Wfatal-errors
2795 @opindex Wfatal-errors
2796 @opindex Wno-fatal-errors
2797 This option causes the compiler to abort compilation on the first error
2798 occurred rather than trying to keep going and printing further error
2799 messages.
2800
2801 @end table
2802
2803 You can request many specific warnings with options beginning
2804 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2805 implicit declarations.  Each of these specific warning options also
2806 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2807 example, @option{-Wno-implicit}.  This manual lists only one of the
2808 two forms, whichever is not the default.  For further,
2809 language-specific options also refer to @ref{C++ Dialect Options} and
2810 @ref{Objective-C and Objective-C++ Dialect Options}.
2811
2812 @table @gcctabopt
2813 @item -pedantic
2814 @opindex pedantic
2815 Issue all the warnings demanded by strict ISO C and ISO C++;
2816 reject all programs that use forbidden extensions, and some other
2817 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2818 version of the ISO C standard specified by any @option{-std} option used.
2819
2820 Valid ISO C and ISO C++ programs should compile properly with or without
2821 this option (though a rare few will require @option{-ansi} or a
2822 @option{-std} option specifying the required version of ISO C)@.  However,
2823 without this option, certain GNU extensions and traditional C and C++
2824 features are supported as well.  With this option, they are rejected.
2825
2826 @option{-pedantic} does not cause warning messages for use of the
2827 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2828 warnings are also disabled in the expression that follows
2829 @code{__extension__}.  However, only system header files should use
2830 these escape routes; application programs should avoid them.
2831 @xref{Alternate Keywords}.
2832
2833 Some users try to use @option{-pedantic} to check programs for strict ISO
2834 C conformance.  They soon find that it does not do quite what they want:
2835 it finds some non-ISO practices, but not all---only those for which
2836 ISO C @emph{requires} a diagnostic, and some others for which
2837 diagnostics have been added.
2838
2839 A feature to report any failure to conform to ISO C might be useful in
2840 some instances, but would require considerable additional work and would
2841 be quite different from @option{-pedantic}.  We don't have plans to
2842 support such a feature in the near future.
2843
2844 Where the standard specified with @option{-std} represents a GNU
2845 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2846 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2847 extended dialect is based.  Warnings from @option{-pedantic} are given
2848 where they are required by the base standard.  (It would not make sense
2849 for such warnings to be given only for features not in the specified GNU
2850 C dialect, since by definition the GNU dialects of C include all
2851 features the compiler supports with the given option, and there would be
2852 nothing to warn about.)
2853
2854 @item -pedantic-errors
2855 @opindex pedantic-errors
2856 Like @option{-pedantic}, except that errors are produced rather than
2857 warnings.
2858
2859 @item -Wall
2860 @opindex Wall
2861 @opindex Wno-all
2862 This enables all the warnings about constructions that some users
2863 consider questionable, and that are easy to avoid (or modify to
2864 prevent the warning), even in conjunction with macros.  This also
2865 enables some language-specific warnings described in @ref{C++ Dialect
2866 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2867
2868 @option{-Wall} turns on the following warning flags:
2869
2870 @gccoptlist{-Waddress   @gol
2871 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2872 -Wc++0x-compat  @gol
2873 -Wchar-subscripts  @gol
2874 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2875 -Wimplicit-int  @gol
2876 -Wimplicit-function-declaration  @gol
2877 -Wcomment  @gol
2878 -Wformat   @gol
2879 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2880 -Wmissing-braces  @gol
2881 -Wnonnull  @gol
2882 -Wparentheses  @gol
2883 -Wpointer-sign  @gol
2884 -Wreorder   @gol
2885 -Wreturn-type  @gol
2886 -Wsequence-point  @gol
2887 -Wsign-compare @r{(only in C++)}  @gol
2888 -Wstrict-aliasing  @gol
2889 -Wstrict-overflow=1  @gol
2890 -Wswitch  @gol
2891 -Wtrigraphs  @gol
2892 -Wuninitialized  @gol
2893 -Wunknown-pragmas  @gol
2894 -Wunused-function  @gol
2895 -Wunused-label     @gol
2896 -Wunused-value     @gol
2897 -Wunused-variable  @gol
2898 -Wvolatile-register-var @gol
2899 }
2900
2901 Note that some warning flags are not implied by @option{-Wall}.  Some of
2902 them warn about constructions that users generally do not consider
2903 questionable, but which occasionally you might wish to check for;
2904 others warn about constructions that are necessary or hard to avoid in
2905 some cases, and there is no simple way to modify the code to suppress
2906 the warning. Some of them are enabled by @option{-Wextra} but many of
2907 them must be enabled individually.
2908
2909 @item -Wextra
2910 @opindex W
2911 @opindex Wextra
2912 @opindex Wno-extra
2913 This enables some extra warning flags that are not enabled by
2914 @option{-Wall}. (This option used to be called @option{-W}.  The older
2915 name is still supported, but the newer name is more descriptive.)
2916
2917 @gccoptlist{-Wclobbered  @gol
2918 -Wempty-body  @gol
2919 -Wignored-qualifiers @gol
2920 -Wmissing-field-initializers  @gol
2921 -Wmissing-parameter-type @r{(C only)}  @gol
2922 -Wold-style-declaration @r{(C only)}  @gol
2923 -Woverride-init  @gol
2924 -Wsign-compare  @gol
2925 -Wtype-limits  @gol
2926 -Wuninitialized  @gol
2927 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2928 }
2929
2930 The option @option{-Wextra} also prints warning messages for the
2931 following cases:
2932
2933 @itemize @bullet
2934
2935 @item
2936 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2937 @samp{>}, or @samp{>=}.
2938
2939 @item
2940 (C++ only) An enumerator and a non-enumerator both appear in a
2941 conditional expression.
2942
2943 @item
2944 (C++ only) Ambiguous virtual bases.
2945
2946 @item
2947 (C++ only) Subscripting an array which has been declared @samp{register}.
2948
2949 @item
2950 (C++ only) Taking the address of a variable which has been declared
2951 @samp{register}.
2952
2953 @item
2954 (C++ only) A base class is not initialized in a derived class' copy
2955 constructor.
2956
2957 @end itemize
2958
2959 @item -Wchar-subscripts
2960 @opindex Wchar-subscripts
2961 @opindex Wno-char-subscripts
2962 Warn if an array subscript has type @code{char}.  This is a common cause
2963 of error, as programmers often forget that this type is signed on some
2964 machines.
2965 This warning is enabled by @option{-Wall}.
2966
2967 @item -Wcomment
2968 @opindex Wcomment
2969 @opindex Wno-comment
2970 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2971 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2972 This warning is enabled by @option{-Wall}.
2973
2974 @item -Wformat
2975 @opindex Wformat
2976 @opindex Wno-format
2977 @opindex ffreestanding
2978 @opindex fno-builtin
2979 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2980 the arguments supplied have types appropriate to the format string
2981 specified, and that the conversions specified in the format string make
2982 sense.  This includes standard functions, and others specified by format
2983 attributes (@pxref{Function Attributes}), in the @code{printf},
2984 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2985 not in the C standard) families (or other target-specific families).
2986 Which functions are checked without format attributes having been
2987 specified depends on the standard version selected, and such checks of
2988 functions without the attribute specified are disabled by
2989 @option{-ffreestanding} or @option{-fno-builtin}.
2990
2991 The formats are checked against the format features supported by GNU
2992 libc version 2.2.  These include all ISO C90 and C99 features, as well
2993 as features from the Single Unix Specification and some BSD and GNU
2994 extensions.  Other library implementations may not support all these
2995 features; GCC does not support warning about features that go beyond a
2996 particular library's limitations.  However, if @option{-pedantic} is used
2997 with @option{-Wformat}, warnings will be given about format features not
2998 in the selected standard version (but not for @code{strfmon} formats,
2999 since those are not in any version of the C standard).  @xref{C Dialect
3000 Options,,Options Controlling C Dialect}.
3001
3002 Since @option{-Wformat} also checks for null format arguments for
3003 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
3004
3005 @option{-Wformat} is included in @option{-Wall}.  For more control over some
3006 aspects of format checking, the options @option{-Wformat-y2k},
3007 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
3008 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
3009 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
3010
3011 @item -Wformat-y2k
3012 @opindex Wformat-y2k
3013 @opindex Wno-format-y2k
3014 If @option{-Wformat} is specified, also warn about @code{strftime}
3015 formats which may yield only a two-digit year.
3016
3017 @item -Wno-format-contains-nul
3018 @opindex Wno-format-contains-nul
3019 @opindex Wformat-contains-nul
3020 If @option{-Wformat} is specified, do not warn about format strings that
3021 contain NUL bytes.
3022
3023 @item -Wno-format-extra-args
3024 @opindex Wno-format-extra-args
3025 @opindex Wformat-extra-args
3026 If @option{-Wformat} is specified, do not warn about excess arguments to a
3027 @code{printf} or @code{scanf} format function.  The C standard specifies
3028 that such arguments are ignored.
3029
3030 Where the unused arguments lie between used arguments that are
3031 specified with @samp{$} operand number specifications, normally
3032 warnings are still given, since the implementation could not know what
3033 type to pass to @code{va_arg} to skip the unused arguments.  However,
3034 in the case of @code{scanf} formats, this option will suppress the
3035 warning if the unused arguments are all pointers, since the Single
3036 Unix Specification says that such unused arguments are allowed.
3037
3038 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3039 @opindex Wno-format-zero-length
3040 @opindex Wformat-zero-length
3041 If @option{-Wformat} is specified, do not warn about zero-length formats.
3042 The C standard specifies that zero-length formats are allowed.
3043
3044 @item -Wformat-nonliteral
3045 @opindex Wformat-nonliteral
3046 @opindex Wno-format-nonliteral
3047 If @option{-Wformat} is specified, also warn if the format string is not a
3048 string literal and so cannot be checked, unless the format function
3049 takes its format arguments as a @code{va_list}.
3050
3051 @item -Wformat-security
3052 @opindex Wformat-security
3053 @opindex Wno-format-security
3054 If @option{-Wformat} is specified, also warn about uses of format
3055 functions that represent possible security problems.  At present, this
3056 warns about calls to @code{printf} and @code{scanf} functions where the
3057 format string is not a string literal and there are no format arguments,
3058 as in @code{printf (foo);}.  This may be a security hole if the format
3059 string came from untrusted input and contains @samp{%n}.  (This is
3060 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3061 in future warnings may be added to @option{-Wformat-security} that are not
3062 included in @option{-Wformat-nonliteral}.)
3063
3064 @item -Wformat=2
3065 @opindex Wformat=2
3066 @opindex Wno-format=2
3067 Enable @option{-Wformat} plus format checks not included in
3068 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3069 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3070
3071 @item -Wnonnull @r{(C and Objective-C only)}
3072 @opindex Wnonnull
3073 @opindex Wno-nonnull
3074 Warn about passing a null pointer for arguments marked as
3075 requiring a non-null value by the @code{nonnull} function attribute.
3076
3077 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3078 can be disabled with the @option{-Wno-nonnull} option.
3079
3080 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3081 @opindex Winit-self
3082 @opindex Wno-init-self
3083 Warn about uninitialized variables which are initialized with themselves.
3084 Note this option can only be used with the @option{-Wuninitialized} option.
3085
3086 For example, GCC will warn about @code{i} being uninitialized in the
3087 following snippet only when @option{-Winit-self} has been specified:
3088 @smallexample
3089 @group
3090 int f()
3091 @{
3092   int i = i;
3093   return i;
3094 @}
3095 @end group
3096 @end smallexample
3097
3098 @item -Wimplicit-int @r{(C and Objective-C only)}
3099 @opindex Wimplicit-int
3100 @opindex Wno-implicit-int
3101 Warn when a declaration does not specify a type.
3102 This warning is enabled by @option{-Wall}.
3103
3104 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3105 @opindex Wimplicit-function-declaration
3106 @opindex Wno-implicit-function-declaration
3107 Give a warning whenever a function is used before being declared. In
3108 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3109 enabled by default and it is made into an error by
3110 @option{-pedantic-errors}. This warning is also enabled by
3111 @option{-Wall}.
3112
3113 @item -Wimplicit
3114 @opindex Wimplicit
3115 @opindex Wno-implicit
3116 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3117 This warning is enabled by @option{-Wall}.
3118
3119 @item -Wignored-qualifiers @r{(C and C++ only)}
3120 @opindex Wignored-qualifiers
3121 @opindex Wno-ignored-qualifiers
3122 Warn if the return type of a function has a type qualifier
3123 such as @code{const}.  For ISO C such a type qualifier has no effect,
3124 since the value returned by a function is not an lvalue.
3125 For C++, the warning is only emitted for scalar types or @code{void}.
3126 ISO C prohibits qualified @code{void} return types on function
3127 definitions, so such return types always receive a warning
3128 even without this option.
3129
3130 This warning is also enabled by @option{-Wextra}.
3131
3132 @item -Wmain
3133 @opindex Wmain
3134 @opindex Wno-main
3135 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3136 a function with external linkage, returning int, taking either zero
3137 arguments, two, or three arguments of appropriate types.  This warning
3138 is enabled by default in C++ and is enabled by either @option{-Wall}
3139 or @option{-pedantic}.
3140
3141 @item -Wmissing-braces
3142 @opindex Wmissing-braces
3143 @opindex Wno-missing-braces
3144 Warn if an aggregate or union initializer is not fully bracketed.  In
3145 the following example, the initializer for @samp{a} is not fully
3146 bracketed, but that for @samp{b} is fully bracketed.
3147
3148 @smallexample
3149 int a[2][2] = @{ 0, 1, 2, 3 @};
3150 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3151 @end smallexample
3152
3153 This warning is enabled by @option{-Wall}.
3154
3155 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3156 @opindex Wmissing-include-dirs
3157 @opindex Wno-missing-include-dirs
3158 Warn if a user-supplied include directory does not exist.
3159
3160 @item -Wparentheses
3161 @opindex Wparentheses
3162 @opindex Wno-parentheses
3163 Warn if parentheses are omitted in certain contexts, such
3164 as when there is an assignment in a context where a truth value
3165 is expected, or when operators are nested whose precedence people
3166 often get confused about.
3167
3168 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3169 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3170 interpretation from that of ordinary mathematical notation.
3171
3172 Also warn about constructions where there may be confusion to which
3173 @code{if} statement an @code{else} branch belongs.  Here is an example of
3174 such a case:
3175
3176 @smallexample
3177 @group
3178 @{
3179   if (a)
3180     if (b)
3181       foo ();
3182   else
3183     bar ();
3184 @}
3185 @end group
3186 @end smallexample
3187
3188 In C/C++, every @code{else} branch belongs to the innermost possible
3189 @code{if} statement, which in this example is @code{if (b)}.  This is
3190 often not what the programmer expected, as illustrated in the above
3191 example by indentation the programmer chose.  When there is the
3192 potential for this confusion, GCC will issue a warning when this flag
3193 is specified.  To eliminate the warning, add explicit braces around
3194 the innermost @code{if} statement so there is no way the @code{else}
3195 could belong to the enclosing @code{if}.  The resulting code would
3196 look like this:
3197
3198 @smallexample
3199 @group
3200 @{
3201   if (a)
3202     @{
3203       if (b)
3204         foo ();
3205       else
3206         bar ();
3207     @}
3208 @}
3209 @end group
3210 @end smallexample
3211
3212 This warning is enabled by @option{-Wall}.
3213
3214 @item -Wsequence-point
3215 @opindex Wsequence-point
3216 @opindex Wno-sequence-point
3217 Warn about code that may have undefined semantics because of violations
3218 of sequence point rules in the C and C++ standards.
3219
3220 The C and C++ standards defines the order in which expressions in a C/C++
3221 program are evaluated in terms of @dfn{sequence points}, which represent
3222 a partial ordering between the execution of parts of the program: those
3223 executed before the sequence point, and those executed after it.  These
3224 occur after the evaluation of a full expression (one which is not part
3225 of a larger expression), after the evaluation of the first operand of a
3226 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3227 function is called (but after the evaluation of its arguments and the
3228 expression denoting the called function), and in certain other places.
3229 Other than as expressed by the sequence point rules, the order of
3230 evaluation of subexpressions of an expression is not specified.  All
3231 these rules describe only a partial order rather than a total order,
3232 since, for example, if two functions are called within one expression
3233 with no sequence point between them, the order in which the functions
3234 are called is not specified.  However, the standards committee have
3235 ruled that function calls do not overlap.
3236
3237 It is not specified when between sequence points modifications to the
3238 values of objects take effect.  Programs whose behavior depends on this
3239 have undefined behavior; the C and C++ standards specify that ``Between
3240 the previous and next sequence point an object shall have its stored
3241 value modified at most once by the evaluation of an expression.
3242 Furthermore, the prior value shall be read only to determine the value
3243 to be stored.''.  If a program breaks these rules, the results on any
3244 particular implementation are entirely unpredictable.
3245
3246 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3247 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3248 diagnosed by this option, and it may give an occasional false positive
3249 result, but in general it has been found fairly effective at detecting
3250 this sort of problem in programs.
3251
3252 The standard is worded confusingly, therefore there is some debate
3253 over the precise meaning of the sequence point rules in subtle cases.
3254 Links to discussions of the problem, including proposed formal
3255 definitions, may be found on the GCC readings page, at
3256 @w{@uref{http://gcc.gnu.org/readings.html}}.
3257
3258 This warning is enabled by @option{-Wall} for C and C++.
3259
3260 @item -Wreturn-type
3261 @opindex Wreturn-type
3262 @opindex Wno-return-type
3263 Warn whenever a function is defined with a return-type that defaults
3264 to @code{int}.  Also warn about any @code{return} statement with no
3265 return-value in a function whose return-type is not @code{void}
3266 (falling off the end of the function body is considered returning
3267 without a value), and about a @code{return} statement with an
3268 expression in a function whose return-type is @code{void}.
3269
3270 For C++, a function without return type always produces a diagnostic
3271 message, even when @option{-Wno-return-type} is specified.  The only
3272 exceptions are @samp{main} and functions defined in system headers.
3273
3274 This warning is enabled by @option{-Wall}.
3275
3276 @item -Wswitch
3277 @opindex Wswitch
3278 @opindex Wno-switch
3279 Warn whenever a @code{switch} statement has an index of enumerated type
3280 and lacks a @code{case} for one or more of the named codes of that
3281 enumeration.  (The presence of a @code{default} label prevents this
3282 warning.)  @code{case} labels outside the enumeration range also
3283 provoke warnings when this option is used (even if there is a
3284 @code{default} label).
3285 This warning is enabled by @option{-Wall}.
3286
3287 @item -Wswitch-default
3288 @opindex Wswitch-default
3289 @opindex Wno-switch-default
3290 Warn whenever a @code{switch} statement does not have a @code{default}
3291 case.
3292
3293 @item -Wswitch-enum
3294 @opindex Wswitch-enum
3295 @opindex Wno-switch-enum
3296 Warn whenever a @code{switch} statement has an index of enumerated type
3297 and lacks a @code{case} for one or more of the named codes of that
3298 enumeration.  @code{case} labels outside the enumeration range also
3299 provoke warnings when this option is used.  The only difference
3300 between @option{-Wswitch} and this option is that this option gives a
3301 warning about an omitted enumeration code even if there is a
3302 @code{default} label.
3303
3304 @item -Wsync-nand @r{(C and C++ only)}
3305 @opindex Wsync-nand
3306 @opindex Wno-sync-nand
3307 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3308 built-in functions are used.  These functions changed semantics in GCC 4.4.
3309
3310 @item -Wtrigraphs
3311 @opindex Wtrigraphs
3312 @opindex Wno-trigraphs
3313 Warn if any trigraphs are encountered that might change the meaning of
3314 the program (trigraphs within comments are not warned about).
3315 This warning is enabled by @option{-Wall}.
3316
3317 @item -Wunused-function
3318 @opindex Wunused-function
3319 @opindex Wno-unused-function
3320 Warn whenever a static function is declared but not defined or a
3321 non-inline static function is unused.
3322 This warning is enabled by @option{-Wall}.
3323
3324 @item -Wunused-label
3325 @opindex Wunused-label
3326 @opindex Wno-unused-label
3327 Warn whenever a label is declared but not used.
3328 This warning is enabled by @option{-Wall}.
3329
3330 To suppress this warning use the @samp{unused} attribute
3331 (@pxref{Variable Attributes}).
3332
3333 @item -Wunused-parameter
3334 @opindex Wunused-parameter
3335 @opindex Wno-unused-parameter
3336 Warn whenever a function parameter is unused aside from its declaration.
3337
3338 To suppress this warning use the @samp{unused} attribute
3339 (@pxref{Variable Attributes}).
3340
3341 @item -Wno-unused-result
3342 @opindex Wunused-result
3343 @opindex Wno-unused-result
3344 Do not warn if a caller of a function marked with attribute
3345 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3346 its return value. The default is @option{-Wunused-result}.
3347
3348 @item -Wunused-variable
3349 @opindex Wunused-variable
3350 @opindex Wno-unused-variable
3351 Warn whenever a local variable or non-constant static variable is unused
3352 aside from its declaration.
3353 This warning is enabled by @option{-Wall}.
3354
3355 To suppress this warning use the @samp{unused} attribute
3356 (@pxref{Variable Attributes}).
3357
3358 @item -Wunused-value
3359 @opindex Wunused-value
3360 @opindex Wno-unused-value
3361 Warn whenever a statement computes a result that is explicitly not
3362 used. To suppress this warning cast the unused expression to
3363 @samp{void}. This includes an expression-statement or the left-hand
3364 side of a comma expression that contains no side effects. For example,
3365 an expression such as @samp{x[i,j]} will cause a warning, while
3366 @samp{x[(void)i,j]} will not.
3367
3368 This warning is enabled by @option{-Wall}.
3369
3370 @item -Wunused
3371 @opindex Wunused
3372 @opindex Wno-unused
3373 All the above @option{-Wunused} options combined.
3374
3375 In order to get a warning about an unused function parameter, you must
3376 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3377 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3378
3379 @item -Wuninitialized
3380 @opindex Wuninitialized
3381 @opindex Wno-uninitialized
3382 Warn if an automatic variable is used without first being initialized
3383 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3384 warn if a non-static reference or non-static @samp{const} member
3385 appears in a class without constructors.
3386
3387 If you want to warn about code which uses the uninitialized value of the
3388 variable in its own initializer, use the @option{-Winit-self} option.
3389
3390 These warnings occur for individual uninitialized or clobbered
3391 elements of structure, union or array variables as well as for
3392 variables which are uninitialized or clobbered as a whole.  They do
3393 not occur for variables or elements declared @code{volatile}.  Because
3394 these warnings depend on optimization, the exact variables or elements
3395 for which there are warnings will depend on the precise optimization
3396 options and version of GCC used.
3397
3398 Note that there may be no warning about a variable that is used only
3399 to compute a value that itself is never used, because such
3400 computations may be deleted by data flow analysis before the warnings
3401 are printed.
3402
3403 These warnings are made optional because GCC is not smart
3404 enough to see all the reasons why the code might be correct
3405 despite appearing to have an error.  Here is one example of how
3406 this can happen:
3407
3408 @smallexample
3409 @group
3410 @{
3411   int x;
3412   switch (y)
3413     @{
3414     case 1: x = 1;
3415       break;
3416     case 2: x = 4;
3417       break;
3418     case 3: x = 5;
3419     @}
3420   foo (x);
3421 @}
3422 @end group
3423 @end smallexample
3424
3425 @noindent
3426 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3427 always initialized, but GCC doesn't know this.  Here is
3428 another common case:
3429
3430 @smallexample
3431 @{
3432   int save_y;
3433   if (change_y) save_y = y, y = new_y;
3434   @dots{}
3435   if (change_y) y = save_y;
3436 @}
3437 @end smallexample
3438
3439 @noindent
3440 This has no bug because @code{save_y} is used only if it is set.
3441
3442 @cindex @code{longjmp} warnings
3443 This option also warns when a non-volatile automatic variable might be
3444 changed by a call to @code{longjmp}.  These warnings as well are possible
3445 only in optimizing compilation.
3446
3447 The compiler sees only the calls to @code{setjmp}.  It cannot know
3448 where @code{longjmp} will be called; in fact, a signal handler could
3449 call it at any point in the code.  As a result, you may get a warning
3450 even when there is in fact no problem because @code{longjmp} cannot
3451 in fact be called at the place which would cause a problem.
3452
3453 Some spurious warnings can be avoided if you declare all the functions
3454 you use that never return as @code{noreturn}.  @xref{Function
3455 Attributes}.
3456
3457 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3458
3459 @item -Wunknown-pragmas
3460 @opindex Wunknown-pragmas
3461 @opindex Wno-unknown-pragmas
3462 @cindex warning for unknown pragmas
3463 @cindex unknown pragmas, warning
3464 @cindex pragmas, warning of unknown
3465 Warn when a #pragma directive is encountered which is not understood by
3466 GCC@.  If this command line option is used, warnings will even be issued
3467 for unknown pragmas in system header files.  This is not the case if
3468 the warnings were only enabled by the @option{-Wall} command line option.
3469
3470 @item -Wno-pragmas
3471 @opindex Wno-pragmas
3472 @opindex Wpragmas
3473 Do not warn about misuses of pragmas, such as incorrect parameters,
3474 invalid syntax, or conflicts between pragmas.  See also
3475 @samp{-Wunknown-pragmas}.
3476
3477 @item -Wstrict-aliasing
3478 @opindex Wstrict-aliasing
3479 @opindex Wno-strict-aliasing
3480 This option is only active when @option{-fstrict-aliasing} is active.
3481 It warns about code which might break the strict aliasing rules that the
3482 compiler is using for optimization.  The warning does not catch all
3483 cases, but does attempt to catch the more common pitfalls.  It is
3484 included in @option{-Wall}.
3485 It is equivalent to @option{-Wstrict-aliasing=3}
3486
3487 @item -Wstrict-aliasing=n
3488 @opindex Wstrict-aliasing=n
3489 @opindex Wno-strict-aliasing=n
3490 This option is only active when @option{-fstrict-aliasing} is active.
3491 It warns about code which might break the strict aliasing rules that the
3492 compiler is using for optimization.
3493 Higher levels correspond to higher accuracy (fewer false positives).
3494 Higher levels also correspond to more effort, similar to the way -O works.
3495 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3496 with n=3.
3497
3498 Level 1: Most aggressive, quick, least accurate.
3499 Possibly useful when higher levels
3500 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3501 false negatives.  However, it has many false positives.
3502 Warns for all pointer conversions between possibly incompatible types,
3503 even if never dereferenced.  Runs in the frontend only.
3504
3505 Level 2: Aggressive, quick, not too precise.
3506 May still have many false positives (not as many as level 1 though),
3507 and few false negatives (but possibly more than level 1).
3508 Unlike level 1, it only warns when an address is taken.  Warns about
3509 incomplete types.  Runs in the frontend only.
3510
3511 Level 3 (default for @option{-Wstrict-aliasing}):
3512 Should have very few false positives and few false
3513 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3514 Takes care of the common punn+dereference pattern in the frontend:
3515 @code{*(int*)&some_float}.
3516 If optimization is enabled, it also runs in the backend, where it deals
3517 with multiple statement cases using flow-sensitive points-to information.
3518 Only warns when the converted pointer is dereferenced.
3519 Does not warn about incomplete types.
3520
3521 @item -Wstrict-overflow
3522 @itemx -Wstrict-overflow=@var{n}
3523 @opindex Wstrict-overflow
3524 @opindex Wno-strict-overflow
3525 This option is only active when @option{-fstrict-overflow} is active.
3526 It warns about cases where the compiler optimizes based on the
3527 assumption that signed overflow does not occur.  Note that it does not
3528 warn about all cases where the code might overflow: it only warns
3529 about cases where the compiler implements some optimization.  Thus
3530 this warning depends on the optimization level.
3531
3532 An optimization which assumes that signed overflow does not occur is
3533 perfectly safe if the values of the variables involved are such that
3534 overflow never does, in fact, occur.  Therefore this warning can
3535 easily give a false positive: a warning about code which is not
3536 actually a problem.  To help focus on important issues, several
3537 warning levels are defined.  No warnings are issued for the use of
3538 undefined signed overflow when estimating how many iterations a loop
3539 will require, in particular when determining whether a loop will be
3540 executed at all.
3541
3542 @table @gcctabopt
3543 @item -Wstrict-overflow=1
3544 Warn about cases which are both questionable and easy to avoid.  For
3545 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3546 compiler will simplify this to @code{1}.  This level of
3547 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3548 are not, and must be explicitly requested.
3549
3550 @item -Wstrict-overflow=2
3551 Also warn about other cases where a comparison is simplified to a
3552 constant.  For example: @code{abs (x) >= 0}.  This can only be
3553 simplified when @option{-fstrict-overflow} is in effect, because
3554 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3555 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3556 @option{-Wstrict-overflow=2}.
3557
3558 @item -Wstrict-overflow=3
3559 Also warn about other cases where a comparison is simplified.  For
3560 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3561
3562 @item -Wstrict-overflow=4
3563 Also warn about other simplifications not covered by the above cases.
3564 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3565
3566 @item -Wstrict-overflow=5
3567 Also warn about cases where the compiler reduces the magnitude of a
3568 constant involved in a comparison.  For example: @code{x + 2 > y} will
3569 be simplified to @code{x + 1 >= y}.  This is reported only at the
3570 highest warning level because this simplification applies to many
3571 comparisons, so this warning level will give a very large number of
3572 false positives.
3573 @end table
3574
3575 @item -Warray-bounds
3576 @opindex Wno-array-bounds
3577 @opindex Warray-bounds
3578 This option is only active when @option{-ftree-vrp} is active
3579 (default for -O2 and above). It warns about subscripts to arrays
3580 that are always out of bounds. This warning is enabled by @option{-Wall}.
3581
3582 @item -Wno-div-by-zero
3583 @opindex Wno-div-by-zero
3584 @opindex Wdiv-by-zero
3585 Do not warn about compile-time integer division by zero.  Floating point
3586 division by zero is not warned about, as it can be a legitimate way of
3587 obtaining infinities and NaNs.
3588
3589 @item -Wsystem-headers
3590 @opindex Wsystem-headers
3591 @opindex Wno-system-headers
3592 @cindex warnings from system headers
3593 @cindex system headers, warnings from
3594 Print warning messages for constructs found in system header files.
3595 Warnings from system headers are normally suppressed, on the assumption
3596 that they usually do not indicate real problems and would only make the
3597 compiler output harder to read.  Using this command line option tells
3598 GCC to emit warnings from system headers as if they occurred in user
3599 code.  However, note that using @option{-Wall} in conjunction with this
3600 option will @emph{not} warn about unknown pragmas in system
3601 headers---for that, @option{-Wunknown-pragmas} must also be used.
3602
3603 @item -Wfloat-equal
3604 @opindex Wfloat-equal
3605 @opindex Wno-float-equal
3606 Warn if floating point values are used in equality comparisons.
3607
3608 The idea behind this is that sometimes it is convenient (for the
3609 programmer) to consider floating-point values as approximations to
3610 infinitely precise real numbers.  If you are doing this, then you need
3611 to compute (by analyzing the code, or in some other way) the maximum or
3612 likely maximum error that the computation introduces, and allow for it
3613 when performing comparisons (and when producing output, but that's a
3614 different problem).  In particular, instead of testing for equality, you
3615 would check to see whether the two values have ranges that overlap; and
3616 this is done with the relational operators, so equality comparisons are
3617 probably mistaken.
3618
3619 @item -Wtraditional @r{(C and Objective-C only)}
3620 @opindex Wtraditional
3621 @opindex Wno-traditional
3622 Warn about certain constructs that behave differently in traditional and
3623 ISO C@.  Also warn about ISO C constructs that have no traditional C
3624 equivalent, and/or problematic constructs which should be avoided.
3625
3626 @itemize @bullet
3627 @item
3628 Macro parameters that appear within string literals in the macro body.
3629 In traditional C macro replacement takes place within string literals,
3630 but does not in ISO C@.
3631
3632 @item
3633 In traditional C, some preprocessor directives did not exist.
3634 Traditional preprocessors would only consider a line to be a directive
3635 if the @samp{#} appeared in column 1 on the line.  Therefore
3636 @option{-Wtraditional} warns about directives that traditional C
3637 understands but would ignore because the @samp{#} does not appear as the
3638 first character on the line.  It also suggests you hide directives like
3639 @samp{#pragma} not understood by traditional C by indenting them.  Some
3640 traditional implementations would not recognize @samp{#elif}, so it
3641 suggests avoiding it altogether.
3642
3643 @item
3644 A function-like macro that appears without arguments.
3645
3646 @item
3647 The unary plus operator.
3648
3649 @item
3650 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3651 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3652 constants.)  Note, these suffixes appear in macros defined in the system
3653 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3654 Use of these macros in user code might normally lead to spurious
3655 warnings, however GCC's integrated preprocessor has enough context to
3656 avoid warning in these cases.
3657
3658 @item
3659 A function declared external in one block and then used after the end of
3660 the block.
3661
3662 @item
3663 A @code{switch} statement has an operand of type @code{long}.
3664
3665 @item
3666 A non-@code{static} function declaration follows a @code{static} one.
3667 This construct is not accepted by some traditional C compilers.
3668
3669 @item
3670 The ISO type of an integer constant has a different width or
3671 signedness from its traditional type.  This warning is only issued if
3672 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
3673 typically represent bit patterns, are not warned about.
3674
3675 @item
3676 Usage of ISO string concatenation is detected.
3677
3678 @item
3679 Initialization of automatic aggregates.
3680
3681 @item
3682 Identifier conflicts with labels.  Traditional C lacks a separate
3683 namespace for labels.
3684
3685 @item
3686 Initialization of unions.  If the initializer is zero, the warning is
3687 omitted.  This is done under the assumption that the zero initializer in
3688 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3689 initializer warnings and relies on default initialization to zero in the
3690 traditional C case.
3691
3692 @item
3693 Conversions by prototypes between fixed/floating point values and vice
3694 versa.  The absence of these prototypes when compiling with traditional
3695 C would cause serious problems.  This is a subset of the possible
3696 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3697
3698 @item
3699 Use of ISO C style function definitions.  This warning intentionally is
3700 @emph{not} issued for prototype declarations or variadic functions
3701 because these ISO C features will appear in your code when using
3702 libiberty's traditional C compatibility macros, @code{PARAMS} and
3703 @code{VPARAMS}.  This warning is also bypassed for nested functions
3704 because that feature is already a GCC extension and thus not relevant to
3705 traditional C compatibility.
3706 @end itemize
3707
3708 @item -Wtraditional-conversion @r{(C and Objective-C only)}
3709 @opindex Wtraditional-conversion
3710 @opindex Wno-traditional-conversion
3711 Warn if a prototype causes a type conversion that is different from what
3712 would happen to the same argument in the absence of a prototype.  This
3713 includes conversions of fixed point to floating and vice versa, and
3714 conversions changing the width or signedness of a fixed point argument
3715 except when the same as the default promotion.
3716
3717 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
3718 @opindex Wdeclaration-after-statement
3719 @opindex Wno-declaration-after-statement
3720 Warn when a declaration is found after a statement in a block.  This
3721 construct, known from C++, was introduced with ISO C99 and is by default
3722 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3723 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3724
3725 @item -Wundef
3726 @opindex Wundef
3727 @opindex Wno-undef
3728 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3729
3730 @item -Wno-endif-labels
3731 @opindex Wno-endif-labels
3732 @opindex Wendif-labels
3733 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3734
3735 @item -Wshadow
3736 @opindex Wshadow
3737 @opindex Wno-shadow
3738 Warn whenever a local variable shadows another local variable, parameter or
3739 global variable or whenever a built-in function is shadowed.
3740
3741 @item -Wlarger-than=@var{len}
3742 @opindex Wlarger-than=@var{len}
3743 @opindex Wlarger-than-@var{len}
3744 Warn whenever an object of larger than @var{len} bytes is defined.
3745
3746 @item -Wframe-larger-than=@var{len}
3747 @opindex Wframe-larger-than
3748 Warn if the size of a function frame is larger than @var{len} bytes.
3749 The computation done to determine the stack frame size is approximate
3750 and not conservative.
3751 The actual requirements may be somewhat greater than @var{len}
3752 even if you do not get a warning.  In addition, any space allocated
3753 via @code{alloca}, variable-length arrays, or related constructs
3754 is not included by the compiler when determining
3755 whether or not to issue a warning.
3756
3757 @item -Wunsafe-loop-optimizations
3758 @opindex Wunsafe-loop-optimizations
3759 @opindex Wno-unsafe-loop-optimizations
3760 Warn if the loop cannot be optimized because the compiler could not
3761 assume anything on the bounds of the loop indices.  With
3762 @option{-funsafe-loop-optimizations} warn if the compiler made
3763 such assumptions.
3764
3765 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
3766 @opindex Wno-pedantic-ms-format
3767 @opindex Wpedantic-ms-format
3768 Disables the warnings about non-ISO @code{printf} / @code{scanf} format
3769 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets
3770 depending on the MS runtime, when you are using the options @option{-Wformat}
3771 and @option{-pedantic} without gnu-extensions.
3772
3773 @item -Wpointer-arith
3774 @opindex Wpointer-arith
3775 @opindex Wno-pointer-arith
3776 Warn about anything that depends on the ``size of'' a function type or
3777 of @code{void}.  GNU C assigns these types a size of 1, for
3778 convenience in calculations with @code{void *} pointers and pointers
3779 to functions.  In C++, warn also when an arithmetic operation involves
3780 @code{NULL}.  This warning is also enabled by @option{-pedantic}.
3781
3782 @item -Wtype-limits
3783 @opindex Wtype-limits
3784 @opindex Wno-type-limits
3785 Warn if a comparison is always true or always false due to the limited
3786 range of the data type, but do not warn for constant expressions.  For
3787 example, warn if an unsigned variable is compared against zero with
3788 @samp{<} or @samp{>=}.  This warning is also enabled by
3789 @option{-Wextra}.
3790
3791 @item -Wbad-function-cast @r{(C and Objective-C only)}
3792 @opindex Wbad-function-cast
3793 @opindex Wno-bad-function-cast
3794 Warn whenever a function call is cast to a non-matching type.
3795 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3796
3797 @item -Wc++-compat @r{(C and Objective-C only)}
3798 Warn about ISO C constructs that are outside of the common subset of
3799 ISO C and ISO C++, e.g.@: request for implicit conversion from
3800 @code{void *} to a pointer to non-@code{void} type.
3801
3802 @item -Wc++0x-compat @r{(C++ and Objective-C++ only)}
3803 Warn about C++ constructs whose meaning differs between ISO C++ 1998 and
3804 ISO C++ 200x, e.g., identifiers in ISO C++ 1998 that will become keywords
3805 in ISO C++ 200x.  This warning is enabled by @option{-Wall}.
3806
3807 @item -Wcast-qual
3808 @opindex Wcast-qual
3809 @opindex Wno-cast-qual
3810 Warn whenever a pointer is cast so as to remove a type qualifier from
3811 the target type.  For example, warn if a @code{const char *} is cast
3812 to an ordinary @code{char *}.
3813
3814 Also warn when making a cast which introduces a type qualifier in an
3815 unsafe way.  For example, casting @code{char **} to @code{const char **}
3816 is unsafe, as in this example:
3817
3818 @smallexample
3819   /* p is char ** value.  */
3820   const char **q = (const char **) p;
3821   /* Assignment of readonly string to const char * is OK.  */
3822   *q = "string";
3823   /* Now char** pointer points to read-only memory.  */
3824   **p = 'b';
3825 @end smallexample
3826
3827 @item -Wcast-align
3828 @opindex Wcast-align
3829 @opindex Wno-cast-align
3830 Warn whenever a pointer is cast such that the required alignment of the
3831 target is increased.  For example, warn if a @code{char *} is cast to
3832 an @code{int *} on machines where integers can only be accessed at
3833 two- or four-byte boundaries.
3834
3835 @item -Wwrite-strings
3836 @opindex Wwrite-strings
3837 @opindex Wno-write-strings
3838 When compiling C, give string constants the type @code{const
3839 char[@var{length}]} so that copying the address of one into a
3840 non-@code{const} @code{char *} pointer will get a warning.  These
3841 warnings will help you find at compile time code that can try to write
3842 into a string constant, but only if you have been very careful about
3843 using @code{const} in declarations and prototypes.  Otherwise, it will
3844 just be a nuisance. This is why we did not make @option{-Wall} request
3845 these warnings.
3846
3847 When compiling C++, warn about the deprecated conversion from string
3848 literals to @code{char *}.  This warning is enabled by default for C++
3849 programs.
3850
3851 @item -Wclobbered
3852 @opindex Wclobbered
3853 @opindex Wno-clobbered
3854 Warn for variables that might be changed by @samp{longjmp} or
3855 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
3856
3857 @item -Wconversion
3858 @opindex Wconversion
3859 @opindex Wno-conversion
3860 Warn for implicit conversions that may alter a value. This includes
3861 conversions between real and integer, like @code{abs (x)} when
3862 @code{x} is @code{double}; conversions between signed and unsigned,
3863 like @code{unsigned ui = -1}; and conversions to smaller types, like
3864 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3865 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3866 changed by the conversion like in @code{abs (2.0)}.  Warnings about
3867 conversions between signed and unsigned integers can be disabled by
3868 using @option{-Wno-sign-conversion}.
3869
3870 For C++, also warn for confusing overload resolution for user-defined
3871 conversions; and conversions that will never use a type conversion
3872 operator: conversions to @code{void}, the same type, a base class or a
3873 reference to them. Warnings about conversions between signed and
3874 unsigned integers are disabled by default in C++ unless
3875 @option{-Wsign-conversion} is explicitly enabled.
3876
3877 @item -Wno-conversion-null @r{(C++)}
3878 @opindex Wconversion-null
3879 @opindex Wno-conversion-null
3880 Do not warn for conversions between @code{NULL} and non-pointer
3881 types. @option{-Wconversion-null} is enabled by default.
3882
3883 @item -Wempty-body
3884 @opindex Wempty-body
3885 @opindex Wno-empty-body
3886 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
3887 while} statement.  This warning is also enabled by @option{-Wextra}.
3888
3889 @item -Wenum-compare
3890 @opindex Wenum-compare
3891 @opindex Wno-enum-compare
3892 Warn about a comparison between values of different enum types. In C++
3893 this warning is enabled by default.  In C this warning is enabled by
3894 @option{-Wall}.
3895
3896 @item -Wjump-misses-init @r{(C, Objective-C only)}
3897 @opindex Wjump-misses-init
3898 @opindex Wno-jump-misses-init
3899 Warn if a @code{goto} statement or a @code{switch} statement jumps
3900 forward across the initialization of a variable, or jumps backward to a
3901 label after the variable has been initialized.  This only warns about
3902 variables which are initialized when they are declared.  This warning is
3903 only supported for C and Objective C; in C++ this sort of branch is an
3904 error in any case.
3905
3906 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
3907 can be disabled with the @option{-Wno-jump-misses-init} option.
3908
3909 @item -Wsign-compare
3910 @opindex Wsign-compare
3911 @opindex Wno-sign-compare
3912 @cindex warning for comparison of signed and unsigned values
3913 @cindex comparison of signed and unsigned values, warning
3914 @cindex signed and unsigned values, comparison warning
3915 Warn when a comparison between signed and unsigned values could produce
3916 an incorrect result when the signed value is converted to unsigned.
3917 This warning is also enabled by @option{-Wextra}; to get the other warnings
3918 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3919
3920 @item -Wsign-conversion
3921 @opindex Wsign-conversion
3922 @opindex Wno-sign-conversion
3923 Warn for implicit conversions that may change the sign of an integer
3924 value, like assigning a signed integer expression to an unsigned
3925 integer variable. An explicit cast silences the warning. In C, this
3926 option is enabled also by @option{-Wconversion}.
3927
3928 @item -Waddress
3929 @opindex Waddress
3930 @opindex Wno-address
3931 Warn about suspicious uses of memory addresses. These include using
3932 the address of a function in a conditional expression, such as
3933 @code{void func(void); if (func)}, and comparisons against the memory
3934 address of a string literal, such as @code{if (x == "abc")}.  Such
3935 uses typically indicate a programmer error: the address of a function
3936 always evaluates to true, so their use in a conditional usually
3937 indicate that the programmer forgot the parentheses in a function
3938 call; and comparisons against string literals result in unspecified
3939 behavior and are not portable in C, so they usually indicate that the
3940 programmer intended to use @code{strcmp}.  This warning is enabled by
3941 @option{-Wall}.
3942
3943 @item -Wlogical-op
3944 @opindex Wlogical-op
3945 @opindex Wno-logical-op
3946 Warn about suspicious uses of logical operators in expressions.
3947 This includes using logical operators in contexts where a
3948 bit-wise operator is likely to be expected.
3949
3950 @item -Waggregate-return
3951 @opindex Waggregate-return
3952 @opindex Wno-aggregate-return
3953 Warn if any functions that return structures or unions are defined or
3954 called.  (In languages where you can return an array, this also elicits
3955 a warning.)
3956
3957 @item -Wno-attributes
3958 @opindex Wno-attributes
3959 @opindex Wattributes
3960 Do not warn if an unexpected @code{__attribute__} is used, such as
3961 unrecognized attributes, function attributes applied to variables,
3962 etc.  This will not stop errors for incorrect use of supported
3963 attributes.
3964
3965 @item -Wno-builtin-macro-redefined
3966 @opindex Wno-builtin-macro-redefined
3967 @opindex Wbuiltin-macro-redefined
3968 Do not warn if certain built-in macros are redefined.  This suppresses
3969 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
3970 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
3971
3972 @item -Wstrict-prototypes @r{(C and Objective-C only)}
3973 @opindex Wstrict-prototypes
3974 @opindex Wno-strict-prototypes
3975 Warn if a function is declared or defined without specifying the
3976 argument types.  (An old-style function definition is permitted without
3977 a warning if preceded by a declaration which specifies the argument
3978 types.)
3979
3980 @item -Wold-style-declaration @r{(C and Objective-C only)}
3981 @opindex Wold-style-declaration
3982 @opindex Wno-old-style-declaration
3983 Warn for obsolescent usages, according to the C Standard, in a
3984 declaration. For example, warn if storage-class specifiers like
3985 @code{static} are not the first things in a declaration.  This warning
3986 is also enabled by @option{-Wextra}.
3987
3988 @item -Wold-style-definition @r{(C and Objective-C only)}
3989 @opindex Wold-style-definition
3990 @opindex Wno-old-style-definition
3991 Warn if an old-style function definition is used.  A warning is given
3992 even if there is a previous prototype.
3993
3994 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
3995 @opindex Wmissing-parameter-type
3996 @opindex Wno-missing-parameter-type
3997 A function parameter is declared without a type specifier in K&R-style
3998 functions:
3999
4000 @smallexample
4001 void foo(bar) @{ @}
4002 @end smallexample
4003
4004 This warning is also enabled by @option{-Wextra}.
4005
4006 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4007 @opindex Wmissing-prototypes
4008 @opindex Wno-missing-prototypes
4009 Warn if a global function is defined without a previous prototype
4010 declaration.  This warning is issued even if the definition itself
4011 provides a prototype.  The aim is to detect global functions that fail
4012 to be declared in header files.
4013
4014 @item -Wmissing-declarations
4015 @opindex Wmissing-declarations
4016 @opindex Wno-missing-declarations
4017 Warn if a global function is defined without a previous declaration.
4018 Do so even if the definition itself provides a prototype.
4019 Use this option to detect global functions that are not declared in
4020 header files.  In C++, no warnings are issued for function templates,
4021 or for inline functions, or for functions in anonymous namespaces.
4022
4023 @item -Wmissing-field-initializers
4024 @opindex Wmissing-field-initializers
4025 @opindex Wno-missing-field-initializers
4026 @opindex W
4027 @opindex Wextra
4028 @opindex Wno-extra
4029 Warn if a structure's initializer has some fields missing.  For
4030 example, the following code would cause such a warning, because
4031 @code{x.h} is implicitly zero:
4032
4033 @smallexample
4034 struct s @{ int f, g, h; @};
4035 struct s x = @{ 3, 4 @};
4036 @end smallexample
4037
4038 This option does not warn about designated initializers, so the following
4039 modification would not trigger a warning:
4040
4041 @smallexample
4042 struct s @{ int f, g, h; @};
4043 struct s x = @{ .f = 3, .g = 4 @};
4044 @end smallexample
4045
4046 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4047 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
4048
4049 @item -Wmissing-noreturn
4050 @opindex Wmissing-noreturn
4051 @opindex Wno-missing-noreturn
4052 Warn about functions which might be candidates for attribute @code{noreturn}.
4053 Note these are only possible candidates, not absolute ones.  Care should
4054 be taken to manually verify functions actually do not ever return before
4055 adding the @code{noreturn} attribute, otherwise subtle code generation
4056 bugs could be introduced.  You will not get a warning for @code{main} in
4057 hosted C environments.
4058
4059 @item -Wmissing-format-attribute
4060 @opindex Wmissing-format-attribute
4061 @opindex Wno-missing-format-attribute
4062 @opindex Wformat
4063 @opindex Wno-format
4064 Warn about function pointers which might be candidates for @code{format}
4065 attributes.  Note these are only possible candidates, not absolute ones.
4066 GCC will guess that function pointers with @code{format} attributes that
4067 are used in assignment, initialization, parameter passing or return
4068 statements should have a corresponding @code{format} attribute in the
4069 resulting type.  I.e.@: the left-hand side of the assignment or
4070 initialization, the type of the parameter variable, or the return type
4071 of the containing function respectively should also have a @code{format}
4072 attribute to avoid the warning.
4073
4074 GCC will also warn about function definitions which might be
4075 candidates for @code{format} attributes.  Again, these are only
4076 possible candidates.  GCC will guess that @code{format} attributes
4077 might be appropriate for any function that calls a function like
4078 @code{vprintf} or @code{vscanf}, but this might not always be the
4079 case, and some functions for which @code{format} attributes are
4080 appropriate may not be detected.
4081
4082 @item -Wno-multichar
4083 @opindex Wno-multichar
4084 @opindex Wmultichar
4085 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4086 Usually they indicate a typo in the user's code, as they have
4087 implementation-defined values, and should not be used in portable code.
4088
4089 @item -Wnormalized=<none|id|nfc|nfkc>
4090 @opindex Wnormalized=
4091 @cindex NFC
4092 @cindex NFKC
4093 @cindex character set, input normalization
4094 In ISO C and ISO C++, two identifiers are different if they are
4095 different sequences of characters.  However, sometimes when characters
4096 outside the basic ASCII character set are used, you can have two
4097 different character sequences that look the same.  To avoid confusion,
4098 the ISO 10646 standard sets out some @dfn{normalization rules} which
4099 when applied ensure that two sequences that look the same are turned into
4100 the same sequence.  GCC can warn you if you are using identifiers which
4101 have not been normalized; this option controls that warning.
4102
4103 There are four levels of warning that GCC supports.  The default is
4104 @option{-Wnormalized=nfc}, which warns about any identifier which is
4105 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4106 recommended form for most uses.
4107
4108 Unfortunately, there are some characters which ISO C and ISO C++ allow
4109 in identifiers that when turned into NFC aren't allowable as
4110 identifiers.  That is, there's no way to use these symbols in portable
4111 ISO C or C++ and have all your identifiers in NFC@.
4112 @option{-Wnormalized=id} suppresses the warning for these characters.
4113 It is hoped that future versions of the standards involved will correct
4114 this, which is why this option is not the default.
4115
4116 You can switch the warning off for all characters by writing
4117 @option{-Wnormalized=none}.  You would only want to do this if you
4118 were using some other normalization scheme (like ``D''), because
4119 otherwise you can easily create bugs that are literally impossible to see.
4120
4121 Some characters in ISO 10646 have distinct meanings but look identical
4122 in some fonts or display methodologies, especially once formatting has
4123 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4124 LETTER N'', will display just like a regular @code{n} which has been
4125 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4126 normalization scheme to convert all these into a standard form as
4127 well, and GCC will warn if your code is not in NFKC if you use
4128 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4129 about every identifier that contains the letter O because it might be
4130 confused with the digit 0, and so is not the default, but may be
4131 useful as a local coding convention if the programming environment is
4132 unable to be fixed to display these characters distinctly.
4133
4134 @item -Wno-deprecated
4135 @opindex Wno-deprecated
4136 @opindex Wdeprecated
4137 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4138
4139 @item -Wno-deprecated-declarations
4140 @opindex Wno-deprecated-declarations
4141 @opindex Wdeprecated-declarations
4142 Do not warn about uses of functions (@pxref{Function Attributes}),
4143 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4144 Attributes}) marked as deprecated by using the @code{deprecated}
4145 attribute.
4146
4147 @item -Wno-overflow
4148 @opindex Wno-overflow
4149 @opindex Woverflow
4150 Do not warn about compile-time overflow in constant expressions.
4151
4152 @item -Woverride-init @r{(C and Objective-C only)}
4153 @opindex Woverride-init
4154 @opindex Wno-override-init
4155 @opindex W
4156 @opindex Wextra
4157 @opindex Wno-extra
4158 Warn if an initialized field without side effects is overridden when
4159 using designated initializers (@pxref{Designated Inits, , Designated
4160 Initializers}).
4161
4162 This warning is included in @option{-Wextra}.  To get other
4163 @option{-Wextra} warnings without this one, use @samp{-Wextra
4164 -Wno-override-init}.
4165
4166 @item -Wpacked
4167 @opindex Wpacked
4168 @opindex Wno-packed
4169 Warn if a structure is given the packed attribute, but the packed
4170 attribute has no effect on the layout or size of the structure.
4171 Such structures may be mis-aligned for little benefit.  For
4172 instance, in this code, the variable @code{f.x} in @code{struct bar}
4173 will be misaligned even though @code{struct bar} does not itself
4174 have the packed attribute:
4175
4176 @smallexample
4177 @group
4178 struct foo @{
4179   int x;
4180   char a, b, c, d;
4181 @} __attribute__((packed));
4182 struct bar @{
4183   char z;
4184   struct foo f;
4185 @};
4186 @end group
4187 @end smallexample
4188
4189 @item -Wpacked-bitfield-compat
4190 @opindex Wpacked-bitfield-compat
4191 @opindex Wno-packed-bitfield-compat
4192 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4193 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4194 the change can lead to differences in the structure layout.  GCC
4195 informs you when the offset of such a field has changed in GCC 4.4.
4196 For example there is no longer a 4-bit padding between field @code{a}
4197 and @code{b} in this structure:
4198
4199 @smallexample
4200 struct foo
4201 @{
4202   char a:4;
4203   char b:8;
4204 @} __attribute__ ((packed));
4205 @end smallexample
4206
4207 This warning is enabled by default.  Use
4208 @option{-Wno-packed-bitfield-compat} to disable this warning.
4209
4210 @item -Wpadded
4211 @opindex Wpadded
4212 @opindex Wno-padded
4213 Warn if padding is included in a structure, either to align an element
4214 of the structure or to align the whole structure.  Sometimes when this
4215 happens it is possible to rearrange the fields of the structure to
4216 reduce the padding and so make the structure smaller.
4217
4218 @item -Wredundant-decls
4219 @opindex Wredundant-decls
4220 @opindex Wno-redundant-decls
4221 Warn if anything is declared more than once in the same scope, even in
4222 cases where multiple declaration is valid and changes nothing.
4223
4224 @item -Wnested-externs @r{(C and Objective-C only)}
4225 @opindex Wnested-externs
4226 @opindex Wno-nested-externs
4227 Warn if an @code{extern} declaration is encountered within a function.
4228
4229 @item -Winline
4230 @opindex Winline
4231 @opindex Wno-inline
4232 Warn if a function can not be inlined and it was declared as inline.
4233 Even with this option, the compiler will not warn about failures to
4234 inline functions declared in system headers.
4235
4236 The compiler uses a variety of heuristics to determine whether or not
4237 to inline a function.  For example, the compiler takes into account
4238 the size of the function being inlined and the amount of inlining
4239 that has already been done in the current function.  Therefore,
4240 seemingly insignificant changes in the source program can cause the
4241 warnings produced by @option{-Winline} to appear or disappear.
4242
4243 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4244 @opindex Wno-invalid-offsetof
4245 @opindex Winvalid-offsetof
4246 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4247 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4248 to a non-POD type is undefined.  In existing C++ implementations,
4249 however, @samp{offsetof} typically gives meaningful results even when
4250 applied to certain kinds of non-POD types. (Such as a simple
4251 @samp{struct} that fails to be a POD type only by virtue of having a
4252 constructor.)  This flag is for users who are aware that they are
4253 writing nonportable code and who have deliberately chosen to ignore the
4254 warning about it.
4255
4256 The restrictions on @samp{offsetof} may be relaxed in a future version
4257 of the C++ standard.
4258
4259 @item -Wno-int-to-pointer-cast @r{(C and Objective-C only)}
4260 @opindex Wno-int-to-pointer-cast
4261 @opindex Wint-to-pointer-cast
4262 Suppress warnings from casts to pointer type of an integer of a
4263 different size.
4264
4265 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4266 @opindex Wno-pointer-to-int-cast
4267 @opindex Wpointer-to-int-cast
4268 Suppress warnings from casts from a pointer to an integer type of a
4269 different size.
4270
4271 @item -Winvalid-pch
4272 @opindex Winvalid-pch
4273 @opindex Wno-invalid-pch
4274 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4275 the search path but can't be used.
4276
4277 @item -Wlong-long
4278 @opindex Wlong-long
4279 @opindex Wno-long-long
4280 Warn if @samp{long long} type is used.  This is enabled by either
4281 @option{-pedantic} or @option{-Wtraditional} in ISO C90 and C++98
4282 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4283
4284 @item -Wvariadic-macros
4285 @opindex Wvariadic-macros
4286 @opindex Wno-variadic-macros
4287 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4288 alternate syntax when in pedantic ISO C99 mode.  This is default.
4289 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4290
4291 @item -Wvla
4292 @opindex Wvla
4293 @opindex Wno-vla
4294 Warn if variable length array is used in the code.
4295 @option{-Wno-vla} will prevent the @option{-pedantic} warning of
4296 the variable length array.
4297
4298 @item -Wvolatile-register-var
4299 @opindex Wvolatile-register-var
4300 @opindex Wno-volatile-register-var
4301 Warn if a register variable is declared volatile.  The volatile
4302 modifier does not inhibit all optimizations that may eliminate reads
4303 and/or writes to register variables.  This warning is enabled by
4304 @option{-Wall}.
4305
4306 @item -Wdisabled-optimization
4307 @opindex Wdisabled-optimization
4308 @opindex Wno-disabled-optimization
4309 Warn if a requested optimization pass is disabled.  This warning does
4310 not generally indicate that there is anything wrong with your code; it
4311 merely indicates that GCC's optimizers were unable to handle the code
4312 effectively.  Often, the problem is that your code is too big or too
4313 complex; GCC will refuse to optimize programs when the optimization
4314 itself is likely to take inordinate amounts of time.
4315
4316 @item -Wpointer-sign @r{(C and Objective-C only)}
4317 @opindex Wpointer-sign
4318 @opindex Wno-pointer-sign
4319 Warn for pointer argument passing or assignment with different signedness.
4320 This option is only supported for C and Objective-C@.  It is implied by
4321 @option{-Wall} and by @option{-pedantic}, which can be disabled with
4322 @option{-Wno-pointer-sign}.
4323
4324 @item -Wstack-protector
4325 @opindex Wstack-protector
4326 @opindex Wno-stack-protector
4327 This option is only active when @option{-fstack-protector} is active.  It
4328 warns about functions that will not be protected against stack smashing.
4329
4330 @item -Wno-mudflap
4331 @opindex Wno-mudflap
4332 Suppress warnings about constructs that cannot be instrumented by
4333 @option{-fmudflap}.
4334
4335 @item -Woverlength-strings
4336 @opindex Woverlength-strings
4337 @opindex Wno-overlength-strings
4338 Warn about string constants which are longer than the ``minimum
4339 maximum'' length specified in the C standard.  Modern compilers
4340 generally allow string constants which are much longer than the
4341 standard's minimum limit, but very portable programs should avoid
4342 using longer strings.
4343
4344 The limit applies @emph{after} string constant concatenation, and does
4345 not count the trailing NUL@.  In C89, the limit was 509 characters; in
4346 C99, it was raised to 4095.  C++98 does not specify a normative
4347 minimum maximum, so we do not diagnose overlength strings in C++@.
4348
4349 This option is implied by @option{-pedantic}, and can be disabled with
4350 @option{-Wno-overlength-strings}.
4351
4352 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
4353 @opindex Wunsuffixed-float-constants
4354
4355 GCC will issue a warning for any floating constant that does not have
4356 a suffix.  When used together with @option{-Wsystem-headers} it will
4357 warn about such constants in system header files.  This can be useful
4358 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
4359 from the decimal floating-point extension to C99.
4360 @end table
4361
4362 @node Debugging Options
4363 @section Options for Debugging Your Program or GCC
4364 @cindex options, debugging
4365 @cindex debugging information options
4366
4367 GCC has various special options that are used for debugging
4368 either your program or GCC:
4369
4370 @table @gcctabopt
4371 @item -g
4372 @opindex g
4373 Produce debugging information in the operating system's native format
4374 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
4375 information.
4376
4377 On most systems that use stabs format, @option{-g} enables use of extra
4378 debugging information that only GDB can use; this extra information
4379 makes debugging work better in GDB but will probably make other debuggers
4380 crash or
4381 refuse to read the program.  If you want to control for certain whether
4382 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
4383 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
4384
4385 GCC allows you to use @option{-g} with
4386 @option{-O}.  The shortcuts taken by optimized code may occasionally
4387 produce surprising results: some variables you declared may not exist
4388 at all; flow of control may briefly move where you did not expect it;
4389 some statements may not be executed because they compute constant
4390 results or their values were already at hand; some statements may
4391 execute in different places because they were moved out of loops.
4392
4393 Nevertheless it proves possible to debug optimized output.  This makes
4394 it reasonable to use the optimizer for programs that might have bugs.
4395
4396 The following options are useful when GCC is generated with the
4397 capability for more than one debugging format.
4398
4399 @item -ggdb
4400 @opindex ggdb
4401 Produce debugging information for use by GDB@.  This means to use the
4402 most expressive format available (DWARF 2, stabs, or the native format
4403 if neither of those are supported), including GDB extensions if at all
4404 possible.
4405
4406 @item -gstabs
4407 @opindex gstabs
4408 Produce debugging information in stabs format (if that is supported),
4409 without GDB extensions.  This is the format used by DBX on most BSD
4410 systems.  On MIPS, Alpha and System V Release 4 systems this option
4411 produces stabs debugging output which is not understood by DBX or SDB@.
4412 On System V Release 4 systems this option requires the GNU assembler.
4413
4414 @item -feliminate-unused-debug-symbols
4415 @opindex feliminate-unused-debug-symbols
4416 Produce debugging information in stabs format (if that is supported),
4417 for only symbols that are actually used.
4418
4419 @item -femit-class-debug-always
4420 Instead of emitting debugging information for a C++ class in only one
4421 object file, emit it in all object files using the class.  This option
4422 should be used only with debuggers that are unable to handle the way GCC
4423 normally emits debugging information for classes because using this
4424 option will increase the size of debugging information by as much as a
4425 factor of two.
4426
4427 @item -gstabs+
4428 @opindex gstabs+
4429 Produce debugging information in stabs format (if that is supported),
4430 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4431 use of these extensions is likely to make other debuggers crash or
4432 refuse to read the program.
4433
4434 @item -gcoff
4435 @opindex gcoff
4436 Produce debugging information in COFF format (if that is supported).
4437 This is the format used by SDB on most System V systems prior to
4438 System V Release 4.
4439
4440 @item -gxcoff
4441 @opindex gxcoff
4442 Produce debugging information in XCOFF format (if that is supported).
4443 This is the format used by the DBX debugger on IBM RS/6000 systems.
4444
4445 @item -gxcoff+
4446 @opindex gxcoff+
4447 Produce debugging information in XCOFF format (if that is supported),
4448 using GNU extensions understood only by the GNU debugger (GDB)@.  The
4449 use of these extensions is likely to make other debuggers crash or
4450 refuse to read the program, and may cause assemblers other than the GNU
4451 assembler (GAS) to fail with an error.
4452
4453 @item -gdwarf-@var{version}
4454 @opindex gdwarf-@var{version}
4455 Produce debugging information in DWARF format (if that is
4456 supported).  This is the format used by DBX on IRIX 6.  The value
4457 of @var{version} may be either 2, 3 or 4; the default version is 2.
4458
4459 Note that with DWARF version 2 some ports require, and will always
4460 use, some non-conflicting DWARF 3 extensions in the unwind tables.
4461
4462 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
4463 for maximum benefit.
4464
4465 @item -gstrict-dwarf
4466 @opindex gstrict-dwarf
4467 Disallow using extensions of later DWARF standard version than selected
4468 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
4469 DWARF extensions from later standard versions is allowed.
4470
4471 @item -gno-strict-dwarf
4472 @opindex gno-strict-dwarf
4473 Allow using extensions of later DWARF standard version than selected with
4474 @option{-gdwarf-@var{version}}.
4475
4476 @item -gvms
4477 @opindex gvms
4478 Produce debugging information in VMS debug format (if that is
4479 supported).  This is the format used by DEBUG on VMS systems.
4480
4481 @item -g@var{level}
4482 @itemx -ggdb@var{level}
4483 @itemx -gstabs@var{level}
4484 @itemx -gcoff@var{level}
4485 @itemx -gxcoff@var{level}
4486 @itemx -gvms@var{level}
4487 Request debugging information and also use @var{level} to specify how
4488 much information.  The default level is 2.
4489
4490 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
4491 @option{-g}.
4492
4493 Level 1 produces minimal information, enough for making backtraces in
4494 parts of the program that you don't plan to debug.  This includes
4495 descriptions of functions and external variables, but no information
4496 about local variables and no line numbers.
4497
4498 Level 3 includes extra information, such as all the macro definitions
4499 present in the program.  Some debuggers support macro expansion when
4500 you use @option{-g3}.
4501
4502 @option{-gdwarf-2} does not accept a concatenated debug level, because
4503 GCC used to support an option @option{-gdwarf} that meant to generate
4504 debug information in version 1 of the DWARF format (which is very
4505 different from version 2), and it would have been too confusing.  That
4506 debug format is long obsolete, but the option cannot be changed now.
4507 Instead use an additional @option{-g@var{level}} option to change the
4508 debug level for DWARF.
4509
4510 @item -gtoggle
4511 @opindex gtoggle
4512 Turn off generation of debug info, if leaving out this option would have
4513 generated it, or turn it on at level 2 otherwise.  The position of this
4514 argument in the command line does not matter, it takes effect after all
4515 other options are processed, and it does so only once, no matter how
4516 many times it is given.  This is mainly intended to be used with
4517 @option{-fcompare-debug}.
4518
4519 @item -fdump-final-insns@r{[}=@var{file}@r{]}
4520 @opindex fdump-final-insns
4521 Dump the final internal representation (RTL) to @var{file}.  If the
4522 optional argument is omitted (or if @var{file} is @code{.}), the name
4523 of the dump file will be determined by appending @code{.gkd} to the
4524 compilation output file name.
4525
4526 @item -fcompare-debug@r{[}=@var{opts}@r{]}
4527 @opindex fcompare-debug
4528 @opindex fno-compare-debug
4529 If no error occurs during compilation, run the compiler a second time,
4530 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
4531 passed to the second compilation.  Dump the final internal
4532 representation in both compilations, and print an error if they differ.
4533
4534 If the equal sign is omitted, the default @option{-gtoggle} is used.
4535
4536 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
4537 and nonzero, implicitly enables @option{-fcompare-debug}.  If
4538 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
4539 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
4540 is used.
4541
4542 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
4543 is equivalent to @option{-fno-compare-debug}, which disables the dumping
4544 of the final representation and the second compilation, preventing even
4545 @env{GCC_COMPARE_DEBUG} from taking effect.
4546
4547 To verify full coverage during @option{-fcompare-debug} testing, set
4548 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
4549 which GCC will reject as an invalid option in any actual compilation
4550 (rather than preprocessing, assembly or linking).  To get just a
4551 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
4552 not overridden} will do.
4553
4554 @item -fcompare-debug-second
4555 @opindex fcompare-debug-second
4556 This option is implicitly passed to the compiler for the second
4557 compilation requested by @option{-fcompare-debug}, along with options to
4558 silence warnings, and omitting other options that would cause
4559 side-effect compiler outputs to files or to the standard output.  Dump
4560 files and preserved temporary files are renamed so as to contain the
4561 @code{.gk} additional extension during the second compilation, to avoid
4562 overwriting those generated by the first.
4563
4564 When this option is passed to the compiler driver, it causes the
4565 @emph{first} compilation to be skipped, which makes it useful for little
4566 other than debugging the compiler proper.
4567
4568 @item -feliminate-dwarf2-dups
4569 @opindex feliminate-dwarf2-dups
4570 Compress DWARF2 debugging information by eliminating duplicated
4571 information about each symbol.  This option only makes sense when
4572 generating DWARF2 debugging information with @option{-gdwarf-2}.
4573
4574 @item -femit-struct-debug-baseonly
4575 Emit debug information for struct-like types
4576 only when the base name of the compilation source file
4577 matches the base name of file in which the struct was defined.
4578
4579 This option substantially reduces the size of debugging information,
4580 but at significant potential loss in type information to the debugger.
4581 See @option{-femit-struct-debug-reduced} for a less aggressive option.
4582 See @option{-femit-struct-debug-detailed} for more detailed control.
4583
4584 This option works only with DWARF 2.
4585
4586 @item -femit-struct-debug-reduced
4587 Emit debug information for struct-like types
4588 only when the base name of the compilation source file
4589 matches the base name of file in which the type was defined,
4590 unless the struct is a template or defined in a system header.
4591
4592 This option significantly reduces the size of debugging information,
4593 with some potential loss in type information to the debugger.
4594 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
4595 See @option{-femit-struct-debug-detailed} for more detailed control.
4596
4597 This option works only with DWARF 2.
4598
4599 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
4600 Specify the struct-like types
4601 for which the compiler will generate debug information.
4602 The intent is to reduce duplicate struct debug information
4603 between different object files within the same program.
4604
4605 This option is a detailed version of
4606 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
4607 which will serve for most needs.
4608
4609 A specification has the syntax
4610 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
4611
4612 The optional first word limits the specification to
4613 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
4614 A struct type is used directly when it is the type of a variable, member.
4615 Indirect uses arise through pointers to structs.
4616 That is, when use of an incomplete struct would be legal, the use is indirect.
4617 An example is
4618 @samp{struct one direct; struct two * indirect;}.
4619
4620 The optional second word limits the specification to
4621 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
4622 Generic structs are a bit complicated to explain.
4623 For C++, these are non-explicit specializations of template classes,
4624 or non-template classes within the above.
4625 Other programming languages have generics,
4626 but @samp{-femit-struct-debug-detailed} does not yet implement them.
4627
4628 The third word specifies the source files for those
4629 structs for which the compiler will emit debug information.
4630 The values @samp{none} and @samp{any} have the normal meaning.
4631 The value @samp{base} means that
4632 the base of name of the file in which the type declaration appears
4633 must match the base of the name of the main compilation file.
4634 In practice, this means that
4635 types declared in @file{foo.c} and @file{foo.h} will have debug information,
4636 but types declared in other header will not.
4637 The value @samp{sys} means those types satisfying @samp{base}
4638 or declared in system or compiler headers.
4639
4640 You may need to experiment to determine the best settings for your application.
4641
4642 The default is @samp{-femit-struct-debug-detailed=all}.
4643
4644 This option works only with DWARF 2.
4645
4646 @item -fenable-icf-debug
4647 @opindex fenable-icf-debug
4648 Generate additional debug information to support identical code folding (ICF).
4649 This option only works with DWARF version 2 or higher.
4650
4651 @item -fno-merge-debug-strings
4652 @opindex fmerge-debug-strings
4653 @opindex fno-merge-debug-strings
4654 Direct the linker to not merge together strings in the debugging
4655 information which are identical in different object files.  Merging is
4656 not supported by all assemblers or linkers.  Merging decreases the size
4657 of the debug information in the output file at the cost of increasing
4658 link processing time.  Merging is enabled by default.
4659
4660 @item -fdebug-prefix-map=@var{old}=@var{new}
4661 @opindex fdebug-prefix-map
4662 When compiling files in directory @file{@var{old}}, record debugging
4663 information describing them as in @file{@var{new}} instead.
4664
4665 @item -fno-dwarf2-cfi-asm
4666 @opindex fdwarf2-cfi-asm
4667 @opindex fno-dwarf2-cfi-asm
4668 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
4669 instead of using GAS @code{.cfi_*} directives.
4670
4671 @cindex @command{prof}
4672 @item -p
4673 @opindex p
4674 Generate extra code to write profile information suitable for the
4675 analysis program @command{prof}.  You must use this option when compiling
4676 the source files you want data about, and you must also use it when
4677 linking.
4678
4679 @cindex @command{gprof}
4680 @item -pg
4681 @opindex pg
4682 Generate extra code to write profile information suitable for the
4683 analysis program @command{gprof}.  You must use this option when compiling
4684 the source files you want data about, and you must also use it when
4685 linking.
4686
4687 @item -Q
4688 @opindex Q
4689 Makes the compiler print out each function name as it is compiled, and
4690 print some statistics about each pass when it finishes.
4691
4692 @item -ftime-report
4693 @opindex ftime-report
4694 Makes the compiler print some statistics about the time consumed by each
4695 pass when it finishes.
4696
4697 @item -fmem-report
4698 @opindex fmem-report
4699 Makes the compiler print some statistics about permanent memory
4700 allocation when it finishes.
4701
4702 @item -fpre-ipa-mem-report
4703 @opindex fpre-ipa-mem-report
4704 @item -fpost-ipa-mem-report
4705 @opindex fpost-ipa-mem-report
4706 Makes the compiler print some statistics about permanent memory
4707 allocation before or after interprocedural optimization.
4708
4709 @item -fprofile-arcs
4710 @opindex fprofile-arcs
4711 Add code so that program flow @dfn{arcs} are instrumented.  During
4712 execution the program records how many times each branch and call is
4713 executed and how many times it is taken or returns.  When the compiled
4714 program exits it saves this data to a file called
4715 @file{@var{auxname}.gcda} for each source file.  The data may be used for
4716 profile-directed optimizations (@option{-fbranch-probabilities}), or for
4717 test coverage analysis (@option{-ftest-coverage}).  Each object file's
4718 @var{auxname} is generated from the name of the output file, if
4719 explicitly specified and it is not the final executable, otherwise it is
4720 the basename of the source file.  In both cases any suffix is removed
4721 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
4722 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
4723 @xref{Cross-profiling}.
4724
4725 @cindex @command{gcov}
4726 @item --coverage
4727 @opindex coverage
4728
4729 This option is used to compile and link code instrumented for coverage
4730 analysis.  The option is a synonym for @option{-fprofile-arcs}
4731 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
4732 linking).  See the documentation for those options for more details.
4733
4734 @itemize
4735
4736 @item
4737 Compile the source files with @option{-fprofile-arcs} plus optimization
4738 and code generation options.  For test coverage analysis, use the
4739 additional @option{-ftest-coverage} option.  You do not need to profile
4740 every source file in a program.
4741
4742 @item
4743 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
4744 (the latter implies the former).
4745
4746 @item
4747 Run the program on a representative workload to generate the arc profile
4748 information.  This may be repeated any number of times.  You can run
4749 concurrent instances of your program, and provided that the file system
4750 supports locking, the data files will be correctly updated.  Also
4751 @code{fork} calls are detected and correctly handled (double counting
4752 will not happen).
4753
4754 @item
4755 For profile-directed optimizations, compile the source files again with
4756 the same optimization and code generation options plus
4757 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
4758 Control Optimization}).
4759
4760 @item
4761 For test coverage analysis, use @command{gcov} to produce human readable
4762 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
4763 @command{gcov} documentation for further information.
4764
4765 @end itemize
4766
4767 With @option{-fprofile-arcs}, for each function of your program GCC
4768 creates a program flow graph, then finds a spanning tree for the graph.
4769 Only arcs that are not on the spanning tree have to be instrumented: the
4770 compiler adds code to count the number of times that these arcs are
4771 executed.  When an arc is the only exit or only entrance to a block, the
4772 instrumentation code can be added to the block; otherwise, a new basic
4773 block must be created to hold the instrumentation code.
4774
4775 @need 2000
4776 @item -ftest-coverage
4777 @opindex ftest-coverage
4778 Produce a notes file that the @command{gcov} code-coverage utility
4779 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
4780 show program coverage.  Each source file's note file is called
4781 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
4782 above for a description of @var{auxname} and instructions on how to
4783 generate test coverage data.  Coverage data will match the source files
4784 more closely, if you do not optimize.
4785
4786 @item -fdbg-cnt-list
4787 @opindex fdbg-cnt-list
4788 Print the name and the counter upperbound for all debug counters.
4789
4790 @item -fdbg-cnt=@var{counter-value-list}
4791 @opindex fdbg-cnt
4792 Set the internal debug counter upperbound. @var{counter-value-list}
4793 is a comma-separated list of @var{name}:@var{value} pairs
4794 which sets the upperbound of each debug counter @var{name} to @var{value}.
4795 All debug counters have the initial upperbound of @var{UINT_MAX},
4796 thus dbg_cnt() returns true always unless the upperbound is set by this option.
4797 e.g. With -fdbg-cnt=dce:10,tail_call:0
4798 dbg_cnt(dce) will return true only for first 10 invocations
4799 and dbg_cnt(tail_call) will return false always.
4800
4801 @item -d@var{letters}
4802 @itemx -fdump-rtl-@var{pass}
4803 @opindex d
4804 Says to make debugging dumps during compilation at times specified by
4805 @var{letters}.  This is used for debugging the RTL-based passes of the
4806 compiler.  The file names for most of the dumps are made by appending
4807 a pass number and a word to the @var{dumpname}, and the files are
4808 created in the directory of the output file.  @var{dumpname} is
4809 generated from the name of the output file, if explicitly specified
4810 and it is not an executable, otherwise it is the basename of the
4811 source file. These switches may have different effects when
4812 @option{-E} is used for preprocessing.
4813
4814 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
4815 @option{-d} option @var{letters}.  Here are the possible
4816 letters for use in @var{pass} and @var{letters}, and their meanings:
4817
4818 @table @gcctabopt
4819
4820 @item -fdump-rtl-alignments
4821 @opindex fdump-rtl-alignments
4822 Dump after branch alignments have been computed.
4823
4824 @item -fdump-rtl-asmcons
4825 @opindex fdump-rtl-asmcons
4826 Dump after fixing rtl statements that have unsatisfied in/out constraints.
4827
4828 @item -fdump-rtl-auto_inc_dec
4829 @opindex fdump-rtl-auto_inc_dec
4830 Dump after auto-inc-dec discovery.  This pass is only run on
4831 architectures that have auto inc or auto dec instructions.
4832
4833 @item -fdump-rtl-barriers
4834 @opindex fdump-rtl-barriers
4835 Dump after cleaning up the barrier instructions.
4836
4837 @item -fdump-rtl-bbpart
4838 @opindex fdump-rtl-bbpart
4839 Dump after partitioning hot and cold basic blocks.
4840
4841 @item -fdump-rtl-bbro
4842 @opindex fdump-rtl-bbro
4843 Dump after block reordering.
4844
4845 @item -fdump-rtl-btl1
4846 @itemx -fdump-rtl-btl2
4847 @opindex fdump-rtl-btl2
4848 @opindex fdump-rtl-btl2
4849 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
4850 after the two branch
4851 target load optimization passes.
4852
4853 @item -fdump-rtl-bypass
4854 @opindex fdump-rtl-bypass
4855 Dump after jump bypassing and control flow optimizations.
4856
4857 @item -fdump-rtl-combine
4858 @opindex fdump-rtl-combine
4859 Dump after the RTL instruction combination pass.
4860
4861 @item -fdump-rtl-compgotos
4862 @opindex fdump-rtl-compgotos
4863 Dump after duplicating the computed gotos.
4864
4865 @item -fdump-rtl-ce1
4866 @itemx -fdump-rtl-ce2
4867 @itemx -fdump-rtl-ce3
4868 @opindex fdump-rtl-ce1
4869 @opindex fdump-rtl-ce2
4870 @opindex fdump-rtl-ce3
4871 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
4872 @option{-fdump-rtl-ce3} enable dumping after the three
4873 if conversion passes.
4874
4875 @itemx -fdump-rtl-cprop_hardreg
4876 @opindex fdump-rtl-cprop_hardreg
4877 Dump after hard register copy propagation.
4878
4879 @itemx -fdump-rtl-csa
4880 @opindex fdump-rtl-csa
4881 Dump after combining stack adjustments.
4882
4883 @item -fdump-rtl-cse1
4884 @itemx -fdump-rtl-cse2
4885 @opindex fdump-rtl-cse1
4886 @opindex fdump-rtl-cse2
4887 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
4888 the two common sub-expression elimination passes.
4889
4890 @itemx -fdump-rtl-dce
4891 @opindex fdump-rtl-dce
4892 Dump after the standalone dead code elimination passes.
4893
4894 @itemx -fdump-rtl-dbr
4895 @opindex fdump-rtl-dbr
4896 Dump after delayed branch scheduling.
4897
4898 @item -fdump-rtl-dce1
4899 @itemx -fdump-rtl-dce2
4900 @opindex fdump-rtl-dce1
4901 @opindex fdump-rtl-dce2
4902 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
4903 the two dead store elimination passes.
4904
4905 @item -fdump-rtl-eh
4906 @opindex fdump-rtl-eh
4907 Dump after finalization of EH handling code.
4908
4909 @item -fdump-rtl-eh_ranges
4910 @opindex fdump-rtl-eh_ranges
4911 Dump after conversion of EH handling range regions.
4912
4913 @item -fdump-rtl-expand
4914 @opindex fdump-rtl-expand
4915 Dump after RTL generation.
4916
4917 @item -fdump-rtl-fwprop1
4918 @itemx -fdump-rtl-fwprop2
4919 @opindex fdump-rtl-fwprop1
4920 @opindex fdump-rtl-fwprop2
4921 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
4922 dumping after the two forward propagation passes.
4923
4924 @item -fdump-rtl-gcse1
4925 @itemx -fdump-rtl-gcse2
4926 @opindex fdump-rtl-gcse1
4927 @opindex fdump-rtl-gcse2
4928 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
4929 after global common subexpression elimination.
4930
4931 @item -fdump-rtl-init-regs
4932 @opindex fdump-rtl-init-regs
4933 Dump after the initialization of the registers.
4934
4935 @item -fdump-rtl-initvals
4936 @opindex fdump-rtl-initvals
4937 Dump after the computation of the initial value sets.
4938
4939 @itemx -fdump-rtl-into_cfglayout
4940 @opindex fdump-rtl-into_cfglayout
4941 Dump after converting to cfglayout mode.
4942
4943 @item -fdump-rtl-ira
4944 @opindex fdump-rtl-ira
4945 Dump after iterated register allocation.
4946
4947 @item -fdump-rtl-jump
4948 @opindex fdump-rtl-jump
4949 Dump after the second jump optimization.
4950
4951 @item -fdump-rtl-loop2
4952 @opindex fdump-rtl-loop2
4953 @option{-fdump-rtl-loop2} enables dumping after the rtl
4954 loop optimization passes.
4955
4956 @item -fdump-rtl-mach
4957 @opindex fdump-rtl-mach
4958 Dump after performing the machine dependent reorganization pass, if that
4959 pass exists.
4960
4961 @item -fdump-rtl-mode_sw
4962 @opindex fdump-rtl-mode_sw
4963 Dump after removing redundant mode switches.
4964
4965 @item -fdump-rtl-rnreg
4966 @opindex fdump-rtl-rnreg
4967 Dump after register renumbering.
4968
4969 @itemx -fdump-rtl-outof_cfglayout
4970 @opindex fdump-rtl-outof_cfglayout
4971 Dump after converting from cfglayout mode.
4972
4973 @item -fdump-rtl-peephole2
4974 @opindex fdump-rtl-peephole2
4975 Dump after the peephole pass.
4976
4977 @item -fdump-rtl-postreload
4978 @opindex fdump-rtl-postreload
4979 Dump after post-reload optimizations.
4980
4981 @itemx -fdump-rtl-pro_and_epilogue
4982 @opindex fdump-rtl-pro_and_epilogue
4983 Dump after generating the function pro and epilogues.
4984
4985 @item -fdump-rtl-regmove
4986 @opindex fdump-rtl-regmove
4987 Dump after the register move pass.
4988
4989 @item -fdump-rtl-sched1
4990 @itemx -fdump-rtl-sched2
4991 @opindex fdump-rtl-sched1
4992 @opindex fdump-rtl-sched2
4993 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
4994 after the basic block scheduling passes.
4995
4996 @item -fdump-rtl-see
4997 @opindex fdump-rtl-see
4998 Dump after sign extension elimination.
4999
5000 @item -fdump-rtl-seqabstr
5001 @opindex fdump-rtl-seqabstr
5002 Dump after common sequence discovery.
5003
5004 @item -fdump-rtl-shorten
5005 @opindex fdump-rtl-shorten
5006 Dump after shortening branches.
5007
5008 @item -fdump-rtl-sibling
5009 @opindex fdump-rtl-sibling
5010 Dump after sibling call optimizations.
5011
5012 @item -fdump-rtl-split1
5013 @itemx -fdump-rtl-split2
5014 @itemx -fdump-rtl-split3
5015 @itemx -fdump-rtl-split4
5016 @itemx -fdump-rtl-split5
5017 @opindex fdump-rtl-split1
5018 @opindex fdump-rtl-split2
5019 @opindex fdump-rtl-split3
5020 @opindex fdump-rtl-split4
5021 @opindex fdump-rtl-split5
5022 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
5023 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
5024 @option{-fdump-rtl-split5} enable dumping after five rounds of
5025 instruction splitting.
5026
5027 @item -fdump-rtl-sms
5028 @opindex fdump-rtl-sms
5029 Dump after modulo scheduling.  This pass is only run on some
5030 architectures.
5031
5032 @item -fdump-rtl-stack
5033 @opindex fdump-rtl-stack
5034 Dump after conversion from GCC's "flat register file" registers to the
5035 x87's stack-like registers.  This pass is only run on x86 variants.
5036
5037 @item -fdump-rtl-subreg1
5038 @itemx -fdump-rtl-subreg2
5039 @opindex fdump-rtl-subreg1
5040 @opindex fdump-rtl-subreg2
5041 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
5042 the two subreg expansion passes.
5043
5044 @item -fdump-rtl-unshare
5045 @opindex fdump-rtl-unshare
5046 Dump after all rtl has been unshared.
5047
5048 @item -fdump-rtl-vartrack
5049 @opindex fdump-rtl-vartrack
5050 Dump after variable tracking.
5051
5052 @item -fdump-rtl-vregs
5053 @opindex fdump-rtl-vregs
5054 Dump after converting virtual registers to hard registers.
5055
5056 @item -fdump-rtl-web
5057 @opindex fdump-rtl-web
5058 Dump after live range splitting.
5059
5060 @item -fdump-rtl-regclass
5061 @itemx -fdump-rtl-subregs_of_mode_init
5062 @itemx -fdump-rtl-subregs_of_mode_finish
5063 @itemx -fdump-rtl-dfinit
5064 @itemx -fdump-rtl-dfinish
5065 @opindex fdump-rtl-regclass
5066 @opindex fdump-rtl-subregs_of_mode_init
5067 @opindex fdump-rtl-subregs_of_mode_finish
5068 @opindex fdump-rtl-dfinit
5069 @opindex fdump-rtl-dfinish
5070 These dumps are defined but always produce empty files.
5071
5072 @item -fdump-rtl-all
5073 @opindex fdump-rtl-all
5074 Produce all the dumps listed above.
5075
5076 @item -dA
5077 @opindex dA
5078 Annotate the assembler output with miscellaneous debugging information.
5079
5080 @item -dD
5081 @opindex dD
5082 Dump all macro definitions, at the end of preprocessing, in addition to
5083 normal output.
5084
5085 @item -dH
5086 @opindex dH
5087 Produce a core dump whenever an error occurs.
5088
5089 @item -dm
5090 @opindex dm
5091 Print statistics on memory usage, at the end of the run, to
5092 standard error.
5093
5094 @item -dp
5095 @opindex dp
5096 Annotate the assembler output with a comment indicating which
5097 pattern and alternative was used.  The length of each instruction is
5098 also printed.
5099
5100 @item -dP
5101 @opindex dP
5102 Dump the RTL in the assembler output as a comment before each instruction.
5103 Also turns on @option{-dp} annotation.
5104
5105 @item -dv
5106 @opindex dv
5107 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
5108 dump a representation of the control flow graph suitable for viewing with VCG
5109 to @file{@var{file}.@var{pass}.vcg}.
5110
5111 @item -dx
5112 @opindex dx
5113 Just generate RTL for a function instead of compiling it.  Usually used
5114 with @option{-fdump-rtl-expand}.
5115
5116 @item -dy
5117 @opindex dy
5118 Dump debugging information during parsing, to standard error.
5119 @end table
5120
5121 @item -fdump-noaddr
5122 @opindex fdump-noaddr
5123 When doing debugging dumps, suppress address output.  This makes it more
5124 feasible to use diff on debugging dumps for compiler invocations with
5125 different compiler binaries and/or different
5126 text / bss / data / heap / stack / dso start locations.
5127
5128 @item -fdump-unnumbered
5129 @opindex fdump-unnumbered
5130 When doing debugging dumps, suppress instruction numbers and address output.
5131 This makes it more feasible to use diff on debugging dumps for compiler
5132 invocations with different options, in particular with and without
5133 @option{-g}.
5134
5135 @item -fdump-unnumbered-links
5136 @opindex fdump-unnumbered-links
5137 When doing debugging dumps (see @option{-d} option above), suppress
5138 instruction numbers for the links to the previous and next instructions
5139 in a sequence.
5140
5141 @item -fdump-translation-unit @r{(C++ only)}
5142 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
5143 @opindex fdump-translation-unit
5144 Dump a representation of the tree structure for the entire translation
5145 unit to a file.  The file name is made by appending @file{.tu} to the
5146 source file name, and the file is created in the same directory as the
5147 output file.  If the @samp{-@var{options}} form is used, @var{options}
5148 controls the details of the dump as described for the
5149 @option{-fdump-tree} options.
5150
5151 @item -fdump-class-hierarchy @r{(C++ only)}
5152 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
5153 @opindex fdump-class-hierarchy
5154 Dump a representation of each class's hierarchy and virtual function
5155 table layout to a file.  The file name is made by appending
5156 @file{.class} to the source file name, and the file is created in the
5157 same directory as the output file.  If the @samp{-@var{options}} form
5158 is used, @var{options} controls the details of the dump as described
5159 for the @option{-fdump-tree} options.
5160
5161 @item -fdump-ipa-@var{switch}
5162 @opindex fdump-ipa
5163 Control the dumping at various stages of inter-procedural analysis
5164 language tree to a file.  The file name is generated by appending a
5165 switch specific suffix to the source file name, and the file is created
5166 in the same directory as the output file.  The following dumps are
5167 possible:
5168
5169 @table @samp
5170 @item all
5171 Enables all inter-procedural analysis dumps.
5172
5173 @item cgraph
5174 Dumps information about call-graph optimization, unused function removal,
5175 and inlining decisions.
5176
5177 @item inline
5178 Dump after function inlining.
5179
5180 @end table
5181
5182 @item -fdump-statistics-@var{option}
5183 @opindex fdump-statistics
5184 Enable and control dumping of pass statistics in a separate file.  The
5185 file name is generated by appending a suffix ending in
5186 @samp{.statistics} to the source file name, and the file is created in
5187 the same directory as the output file.  If the @samp{-@var{option}}
5188 form is used, @samp{-stats} will cause counters to be summed over the
5189 whole compilation unit while @samp{-details} will dump every event as
5190 the passes generate them.  The default with no option is to sum
5191 counters for each function compiled.
5192
5193 @item -fdump-tree-@var{switch}
5194 @itemx -fdump-tree-@var{switch}-@var{options}
5195 @opindex fdump-tree
5196 Control the dumping at various stages of processing the intermediate
5197 language tree to a file.  The file name is generated by appending a
5198 switch specific suffix to the source file name, and the file is
5199 created in the same directory as the output file.  If the
5200 @samp{-@var{options}} form is used, @var{options} is a list of
5201 @samp{-} separated options that control the details of the dump.  Not
5202 all options are applicable to all dumps, those which are not
5203 meaningful will be ignored.  The following options are available
5204
5205 @table @samp
5206 @item address
5207 Print the address of each node.  Usually this is not meaningful as it
5208 changes according to the environment and source file.  Its primary use
5209 is for tying up a dump file with a debug environment.
5210 @item asmname
5211 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
5212 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
5213 use working backward from mangled names in the assembly file.
5214 @item slim
5215 Inhibit dumping of members of a scope or body of a function merely
5216 because that scope has been reached.  Only dump such items when they
5217 are directly reachable by some other path.  When dumping pretty-printed
5218 trees, this option inhibits dumping the bodies of control structures.
5219 @item raw
5220 Print a raw representation of the tree.  By default, trees are
5221 pretty-printed into a C-like representation.
5222 @item details
5223 Enable more detailed dumps (not honored by every dump option).
5224 @item stats
5225 Enable dumping various statistics about the pass (not honored by every dump
5226 option).
5227 @item blocks
5228 Enable showing basic block boundaries (disabled in raw dumps).
5229 @item vops
5230 Enable showing virtual operands for every statement.
5231 @item lineno
5232 Enable showing line numbers for statements.
5233 @item uid
5234 Enable showing the unique ID (@code{DECL_UID}) for each variable.
5235 @item verbose
5236 Enable showing the tree dump for each statement.
5237 @item eh
5238 Enable showing the EH region number holding each statement.
5239 @item all
5240 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
5241 and @option{lineno}.
5242 @end table
5243
5244 The following tree dumps are possible:
5245 @table @samp
5246
5247 @item original
5248 @opindex fdump-tree-original
5249 Dump before any tree based optimization, to @file{@var{file}.original}.
5250
5251 @item optimized
5252 @opindex fdump-tree-optimized
5253 Dump after all tree based optimization, to @file{@var{file}.optimized}.
5254
5255 @item gimple
5256 @opindex fdump-tree-gimple
5257 Dump each function before and after the gimplification pass to a file.  The
5258 file name is made by appending @file{.gimple} to the source file name.
5259
5260 @item cfg
5261 @opindex fdump-tree-cfg
5262 Dump the control flow graph of each function to a file.  The file name is
5263 made by appending @file{.cfg} to the source file name.
5264
5265 @item vcg
5266 @opindex fdump-tree-vcg
5267 Dump the control flow graph of each function to a file in VCG format.  The
5268 file name is made by appending @file{.vcg} to the source file name.  Note
5269 that if the file contains more than one function, the generated file cannot
5270 be used directly by VCG@.  You will need to cut and paste each function's
5271 graph into its own separate file first.
5272
5273 @item ch
5274 @opindex fdump-tree-ch
5275 Dump each function after copying loop headers.  The file name is made by
5276 appending @file{.ch} to the source file name.
5277
5278 @item ssa
5279 @opindex fdump-tree-ssa
5280 Dump SSA related information to a file.  The file name is made by appending
5281 @file{.ssa} to the source file name.
5282
5283 @item alias
5284 @opindex fdump-tree-alias
5285 Dump aliasing information for each function.  The file name is made by
5286 appending @file{.alias} to the source file name.
5287
5288 @item ccp
5289 @opindex fdump-tree-ccp
5290 Dump each function after CCP@.  The file name is made by appending
5291 @file{.ccp} to the source file name.
5292
5293 @item storeccp
5294 @opindex fdump-tree-storeccp
5295 Dump each function after STORE-CCP@.  The file name is made by appending
5296 @file{.storeccp} to the source file name.
5297
5298 @item pre
5299 @opindex fdump-tree-pre
5300 Dump trees after partial redundancy elimination.  The file name is made
5301 by appending @file{.pre} to the source file name.
5302
5303 @item fre
5304 @opindex fdump-tree-fre
5305 Dump trees after full redundancy elimination.  The file name is made
5306 by appending @file{.fre} to the source file name.
5307
5308 @item copyprop
5309 @opindex fdump-tree-copyprop
5310 Dump trees after copy propagation.  The file name is made
5311 by appending @file{.copyprop} to the source file name.
5312
5313 @item store_copyprop
5314 @opindex fdump-tree-store_copyprop
5315 Dump trees after store copy-propagation.  The file name is made
5316 by appending @file{.store_copyprop} to the source file name.
5317
5318 @item dce
5319 @opindex fdump-tree-dce
5320 Dump each function after dead code elimination.  The file name is made by
5321 appending @file{.dce} to the source file name.
5322
5323 @item mudflap
5324 @opindex fdump-tree-mudflap
5325 Dump each function after adding mudflap instrumentation.  The file name is
5326 made by appending @file{.mudflap} to the source file name.
5327
5328 @item sra
5329 @opindex fdump-tree-sra
5330 Dump each function after performing scalar replacement of aggregates.  The
5331 file name is made by appending @file{.sra} to the source file name.
5332
5333 @item sink
5334 @opindex fdump-tree-sink
5335 Dump each function after performing code sinking.  The file name is made
5336 by appending @file{.sink} to the source file name.
5337
5338 @item dom
5339 @opindex fdump-tree-dom
5340 Dump each function after applying dominator tree optimizations.  The file
5341 name is made by appending @file{.dom} to the source file name.
5342
5343 @item dse
5344 @opindex fdump-tree-dse
5345 Dump each function after applying dead store elimination.  The file
5346 name is made by appending @file{.dse} to the source file name.
5347
5348 @item phiopt
5349 @opindex fdump-tree-phiopt
5350 Dump each function after optimizing PHI nodes into straightline code.  The file
5351 name is made by appending @file{.phiopt} to the source file name.
5352
5353 @item forwprop
5354 @opindex fdump-tree-forwprop
5355 Dump each function after forward propagating single use variables.  The file
5356 name is made by appending @file{.forwprop} to the source file name.
5357
5358 @item copyrename
5359 @opindex fdump-tree-copyrename
5360 Dump each function after applying the copy rename optimization.  The file
5361 name is made by appending @file{.copyrename} to the source file name.
5362
5363 @item nrv
5364 @opindex fdump-tree-nrv
5365 Dump each function after applying the named return value optimization on
5366 generic trees.  The file name is made by appending @file{.nrv} to the source
5367 file name.
5368
5369 @item vect
5370 @opindex fdump-tree-vect
5371 Dump each function after applying vectorization of loops.  The file name is
5372 made by appending @file{.vect} to the source file name.
5373
5374 @item slp
5375 @opindex fdump-tree-slp
5376 Dump each function after applying vectorization of basic blocks.  The file name
5377 is made by appending @file{.slp} to the source file name.
5378
5379 @item vrp
5380 @opindex fdump-tree-vrp
5381 Dump each function after Value Range Propagation (VRP).  The file name
5382 is made by appending @file{.vrp} to the source file name.
5383
5384 @item all
5385 @opindex fdump-tree-all
5386 Enable all the available tree dumps with the flags provided in this option.
5387 @end table
5388
5389 @item -ftree-vectorizer-verbose=@var{n}
5390 @opindex ftree-vectorizer-verbose
5391 This option controls the amount of debugging output the vectorizer prints.
5392 This information is written to standard error, unless
5393 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
5394 in which case it is output to the usual dump listing file, @file{.vect}.
5395 For @var{n}=0 no diagnostic information is reported.
5396 If @var{n}=1 the vectorizer reports each loop that got vectorized,
5397 and the total number of loops that got vectorized.
5398 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
5399 the first analysis phase (vect_analyze_loop_form) - i.e.@: countable,
5400 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity
5401 level that @option{-fdump-tree-vect-stats} uses.
5402 Higher verbosity levels mean either more information dumped for each
5403 reported loop, or same amount of information reported for more loops:
5404 if @var{n}=3, vectorizer cost model information is reported.
5405 If @var{n}=4, alignment related information is added to the reports.
5406 If @var{n}=5, data-references related information (e.g.@: memory dependences,
5407 memory access-patterns) is added to the reports.
5408 If @var{n}=6, the vectorizer reports also non-vectorized inner-most loops
5409 that did not pass the first analysis phase (i.e., may not be countable, or
5410 may have complicated control-flow).
5411 If @var{n}=7, the vectorizer reports also non-vectorized nested loops.
5412 If @var{n}=8, SLP related information is added to the reports.
5413 For @var{n}=9, all the information the vectorizer generates during its
5414 analysis and transformation is reported.  This is the same verbosity level
5415 that @option{-fdump-tree-vect-details} uses.
5416
5417 @item -frandom-seed=@var{string}
5418 @opindex frandom-seed
5419 This option provides a seed that GCC uses when it would otherwise use
5420 random numbers.  It is used to generate certain symbol names
5421 that have to be different in every compiled file.  It is also used to
5422 place unique stamps in coverage data files and the object files that
5423 produce them.  You can use the @option{-frandom-seed} option to produce
5424 reproducibly identical object files.
5425
5426 The @var{string} should be different for every file you compile.
5427
5428 @item -fsched-verbose=@var{n}
5429 @opindex fsched-verbose
5430 On targets that use instruction scheduling, this option controls the
5431 amount of debugging output the scheduler prints.  This information is
5432 written to standard error, unless @option{-fdump-rtl-sched1} or
5433 @option{-fdump-rtl-sched2} is specified, in which case it is output
5434 to the usual dump listing file, @file{.sched1} or @file{.sched2}
5435 respectively.  However for @var{n} greater than nine, the output is
5436 always printed to standard error.
5437
5438 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
5439 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
5440 For @var{n} greater than one, it also output basic block probabilities,
5441 detailed ready list information and unit/insn info.  For @var{n} greater
5442 than two, it includes RTL at abort point, control-flow and regions info.
5443 And for @var{n} over four, @option{-fsched-verbose} also includes
5444 dependence info.
5445
5446 @item -save-temps
5447 @itemx -save-temps=cwd
5448 @opindex save-temps
5449 Store the usual ``temporary'' intermediate files permanently; place them
5450 in the current directory and name them based on the source file.  Thus,
5451 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
5452 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
5453 preprocessed @file{foo.i} output file even though the compiler now
5454 normally uses an integrated preprocessor.
5455
5456 When used in combination with the @option{-x} command line option,
5457 @option{-save-temps} is sensible enough to avoid over writing an
5458 input source file with the same extension as an intermediate file.
5459 The corresponding intermediate file may be obtained by renaming the
5460 source file before using @option{-save-temps}.
5461
5462 If you invoke GCC in parallel, compiling several different source
5463 files that share a common base name in different subdirectories or the
5464 same source file compiled for multiple output destinations, it is
5465 likely that the different parallel compilers will interfere with each
5466 other, and overwrite the temporary files.  For instance:
5467
5468 @smallexample
5469 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
5470 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
5471 @end smallexample
5472
5473 may result in @file{foo.i} and @file{foo.o} being written to
5474 simultaneously by both compilers.
5475
5476 @item -save-temps=obj
5477 @opindex save-temps=obj
5478 Store the usual ``temporary'' intermediate files permanently.  If the
5479 @option{-o} option is used, the temporary files are based on the
5480 object file.  If the @option{-o} option is not used, the
5481 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
5482
5483 For example:
5484
5485 @smallexample
5486 gcc -save-temps=obj -c foo.c
5487 gcc -save-temps=obj -c bar.c -o dir/xbar.o
5488 gcc -save-temps=obj foobar.c -o dir2/yfoobar
5489 @end smallexample
5490
5491 would create @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
5492 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
5493 @file{dir2/yfoobar.o}.
5494
5495 @item -time@r{[}=@var{file}@r{]}
5496 @opindex time
5497 Report the CPU time taken by each subprocess in the compilation
5498 sequence.  For C source files, this is the compiler proper and assembler
5499 (plus the linker if linking is done).
5500
5501 Without the specification of an output file, the output looks like this:
5502
5503 @smallexample
5504 # cc1 0.12 0.01
5505 # as 0.00 0.01
5506 @end smallexample
5507
5508 The first number on each line is the ``user time'', that is time spent
5509 executing the program itself.  The second number is ``system time'',
5510 time spent executing operating system routines on behalf of the program.
5511 Both numbers are in seconds.
5512
5513 With the specification of an output file, the output is appended to the
5514 named file, and it looks like this:
5515
5516 @smallexample
5517 0.12 0.01 cc1 @var{options}
5518 0.00 0.01 as @var{options}
5519 @end smallexample
5520
5521 The ``user time'' and the ``system time'' are moved before the program
5522 name, and the options passed to the program are displayed, so that one
5523 can later tell what file was being compiled, and with which options.
5524
5525 @item -fvar-tracking
5526 @opindex fvar-tracking
5527 Run variable tracking pass.  It computes where variables are stored at each
5528 position in code.  Better debugging information is then generated
5529 (if the debugging information format supports this information).
5530
5531 It is enabled by default when compiling with optimization (@option{-Os},
5532 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
5533 the debug info format supports it.
5534
5535 @item -fvar-tracking-assignments
5536 @opindex fvar-tracking-assignments
5537 @opindex fno-var-tracking-assignments
5538 Annotate assignments to user variables early in the compilation and
5539 attempt to carry the annotations over throughout the compilation all the
5540 way to the end, in an attempt to improve debug information while
5541 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
5542
5543 It can be enabled even if var-tracking is disabled, in which case
5544 annotations will be created and maintained, but discarded at the end.
5545
5546 @item -fvar-tracking-assignments-toggle
5547 @opindex fvar-tracking-assignments-toggle
5548 @opindex fno-var-tracking-assignments-toggle
5549 Toggle @option{-fvar-tracking-assignments}, in the same way that
5550 @option{-gtoggle} toggles @option{-g}.
5551
5552 @item -print-file-name=@var{library}
5553 @opindex print-file-name
5554 Print the full absolute name of the library file @var{library} that
5555 would be used when linking---and don't do anything else.  With this
5556 option, GCC does not compile or link anything; it just prints the
5557 file name.
5558
5559 @item -print-multi-directory
5560 @opindex print-multi-directory
5561 Print the directory name corresponding to the multilib selected by any
5562 other switches present in the command line.  This directory is supposed
5563 to exist in @env{GCC_EXEC_PREFIX}.
5564
5565 @item -print-multi-lib
5566 @opindex print-multi-lib
5567 Print the mapping from multilib directory names to compiler switches
5568 that enable them.  The directory name is separated from the switches by
5569 @samp{;}, and each switch starts with an @samp{@@} instead of the
5570 @samp{-}, without spaces between multiple switches.  This is supposed to
5571 ease shell-processing.
5572
5573 @item -print-multi-os-directory
5574 @opindex print-multi-os-directory
5575 Print the path to OS libraries for the selected
5576 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
5577 present in the @file{lib} subdirectory and no multilibs are used, this is
5578 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
5579 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
5580 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
5581 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
5582
5583 @item -print-prog-name=@var{program}
5584 @opindex print-prog-name
5585 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
5586
5587 @item -print-libgcc-file-name
5588 @opindex print-libgcc-file-name
5589 Same as @option{-print-file-name=libgcc.a}.
5590
5591 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
5592 but you do want to link with @file{libgcc.a}.  You can do
5593
5594 @smallexample
5595 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
5596 @end smallexample
5597
5598 @item -print-search-dirs
5599 @opindex print-search-dirs
5600 Print the name of the configured installation directory and a list of
5601 program and library directories @command{gcc} will search---and don't do anything else.
5602
5603 This is useful when @command{gcc} prints the error message
5604 @samp{installation problem, cannot exec cpp0: No such file or directory}.
5605 To resolve this you either need to put @file{cpp0} and the other compiler
5606 components where @command{gcc} expects to find them, or you can set the environment
5607 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
5608 Don't forget the trailing @samp{/}.
5609 @xref{Environment Variables}.
5610
5611 @item -print-sysroot
5612 @opindex print-sysroot
5613 Print the target sysroot directory that will be used during
5614 compilation.  This is the target sysroot specified either at configure
5615 time or using the @option{--sysroot} option, possibly with an extra
5616 suffix that depends on compilation options.  If no target sysroot is
5617 specified, the option prints nothing.
5618
5619 @item -print-sysroot-headers-suffix
5620 @opindex print-sysroot-headers-suffix
5621 Print the suffix added to the target sysroot when searching for
5622 headers, or give an error if the compiler is not configured with such
5623 a suffix---and don't do anything else.
5624
5625 @item -dumpmachine
5626 @opindex dumpmachine
5627 Print the compiler's target machine (for example,
5628 @samp{i686-pc-linux-gnu})---and don't do anything else.
5629
5630 @item -dumpversion
5631 @opindex dumpversion
5632 Print the compiler version (for example, @samp{3.0})---and don't do
5633 anything else.
5634
5635 @item -dumpspecs
5636 @opindex dumpspecs
5637 Print the compiler's built-in specs---and don't do anything else.  (This
5638 is used when GCC itself is being built.)  @xref{Spec Files}.
5639
5640 @item -feliminate-unused-debug-types
5641 @opindex feliminate-unused-debug-types
5642 Normally, when producing DWARF2 output, GCC will emit debugging
5643 information for all types declared in a compilation
5644 unit, regardless of whether or not they are actually used
5645 in that compilation unit.  Sometimes this is useful, such as
5646 if, in the debugger, you want to cast a value to a type that is
5647 not actually used in your program (but is declared).  More often,
5648 however, this results in a significant amount of wasted space.
5649 With this option, GCC will avoid producing debug symbol output
5650 for types that are nowhere used in the source file being compiled.
5651 @end table
5652
5653 @node Optimize Options
5654 @section Options That Control Optimization
5655 @cindex optimize options
5656 @cindex options, optimization
5657
5658 These options control various sorts of optimizations.
5659
5660 Without any optimization option, the compiler's goal is to reduce the
5661 cost of compilation and to make debugging produce the expected
5662 results.  Statements are independent: if you stop the program with a
5663 breakpoint between statements, you can then assign a new value to any
5664 variable or change the program counter to any other statement in the
5665 function and get exactly the results you would expect from the source
5666 code.
5667
5668 Turning on optimization flags makes the compiler attempt to improve
5669 the performance and/or code size at the expense of compilation time
5670 and possibly the ability to debug the program.
5671
5672 The compiler performs optimization based on the knowledge it has of the
5673 program.  Compiling multiple files at once to a single output file mode allows
5674 the compiler to use information gained from all of the files when compiling
5675 each of them.
5676
5677 Not all optimizations are controlled directly by a flag.  Only
5678 optimizations that have a flag are listed in this section.
5679
5680 Most optimizations are only enabled if an @option{-O} level is set on
5681 the command line.  Otherwise they are disabled, even if individual             
5682 optimization flags are specified.
5683
5684 Depending on the target and how GCC was configured, a slightly different
5685 set of optimizations may be enabled at each @option{-O} level than
5686 those listed here.  You can invoke GCC with @samp{-Q --help=optimizers}
5687 to find out the exact set of optimizations that are enabled at each level.
5688 @xref{Overall Options}, for examples.
5689
5690 @table @gcctabopt
5691 @item -O
5692 @itemx -O1
5693 @opindex O
5694 @opindex O1
5695 Optimize.  Optimizing compilation takes somewhat more time, and a lot
5696 more memory for a large function.
5697
5698 With @option{-O}, the compiler tries to reduce code size and execution
5699 time, without performing any optimizations that take a great deal of
5700 compilation time.
5701
5702 @option{-O} turns on the following optimization flags:
5703 @gccoptlist{
5704 -fauto-inc-dec @gol
5705 -fcprop-registers @gol
5706 -fdce @gol
5707 -fdefer-pop @gol
5708 -fdelayed-branch @gol
5709 -fdse @gol
5710 -fguess-branch-probability @gol
5711 -fif-conversion2 @gol
5712 -fif-conversion @gol
5713 -fipa-pure-const @gol
5714 -fipa-reference @gol
5715 -fmerge-constants
5716 -fsplit-wide-types @gol
5717 -ftree-builtin-call-dce @gol
5718 -ftree-ccp @gol
5719 -ftree-ch @gol
5720 -ftree-copyrename @gol
5721 -ftree-dce @gol
5722 -ftree-dominator-opts @gol
5723 -ftree-dse @gol
5724 -ftree-forwprop @gol
5725 -ftree-fre @gol
5726 -ftree-phiprop @gol
5727 -ftree-sra @gol
5728 -ftree-pta @gol
5729 -ftree-ter @gol
5730 -funit-at-a-time}
5731
5732 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
5733 where doing so does not interfere with debugging.
5734
5735 @item -O2
5736 @opindex O2
5737 Optimize even more.  GCC performs nearly all supported optimizations
5738 that do not involve a space-speed tradeoff.
5739 As compared to @option{-O}, this option increases both compilation time
5740 and the performance of the generated code.
5741
5742 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
5743 also turns on the following optimization flags:
5744 @gccoptlist{-fthread-jumps @gol
5745 -falign-functions  -falign-jumps @gol
5746 -falign-loops  -falign-labels @gol
5747 -fcaller-saves @gol
5748 -fcrossjumping @gol
5749 -fcse-follow-jumps  -fcse-skip-blocks @gol
5750 -fdelete-null-pointer-checks @gol
5751 -fexpensive-optimizations @gol
5752 -fgcse  -fgcse-lm  @gol
5753 -finline-small-functions @gol
5754 -findirect-inlining @gol
5755 -fipa-sra @gol
5756 -foptimize-sibling-calls @gol
5757 -fpeephole2 @gol
5758 -fregmove @gol
5759 -freorder-blocks  -freorder-functions @gol
5760 -frerun-cse-after-loop  @gol
5761 -fsched-interblock  -fsched-spec @gol
5762 -fschedule-insns  -fschedule-insns2 @gol
5763 -fstrict-aliasing -fstrict-overflow @gol
5764 -ftree-switch-conversion @gol
5765 -ftree-pre @gol
5766 -ftree-vrp}
5767
5768 Please note the warning under @option{-fgcse} about
5769 invoking @option{-O2} on programs that use computed gotos.
5770
5771 @item -O3
5772 @opindex O3
5773 Optimize yet more.  @option{-O3} turns on all optimizations specified
5774 by @option{-O2} and also turns on the @option{-finline-functions},
5775 @option{-funswitch-loops}, @option{-fpredictive-commoning},
5776 @option{-fgcse-after-reload} and @option{-ftree-vectorize} options.
5777
5778 @item -O0
5779 @opindex O0
5780 Reduce compilation time and make debugging produce the expected
5781 results.  This is the default.
5782
5783 @item -Os
5784 @opindex Os
5785 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
5786 do not typically increase code size.  It also performs further
5787 optimizations designed to reduce code size.
5788
5789 @option{-Os} disables the following optimization flags:
5790 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
5791 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
5792 -fprefetch-loop-arrays  -ftree-vect-loop-version}
5793
5794 If you use multiple @option{-O} options, with or without level numbers,
5795 the last such option is the one that is effective.
5796 @end table
5797
5798 Options of the form @option{-f@var{flag}} specify machine-independent
5799 flags.  Most flags have both positive and negative forms; the negative
5800 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
5801 below, only one of the forms is listed---the one you typically will
5802 use.  You can figure out the other form by either removing @samp{no-}
5803 or adding it.
5804
5805 The following options control specific optimizations.  They are either
5806 activated by @option{-O} options or are related to ones that are.  You
5807 can use the following flags in the rare cases when ``fine-tuning'' of
5808 optimizations to be performed is desired.
5809
5810 @table @gcctabopt
5811 @item -fno-default-inline
5812 @opindex fno-default-inline
5813 Do not make member functions inline by default merely because they are
5814 defined inside the class scope (C++ only).  Otherwise, when you specify
5815 @w{@option{-O}}, member functions defined inside class scope are compiled
5816 inline by default; i.e., you don't need to add @samp{inline} in front of
5817 the member function name.
5818
5819 @item -fno-defer-pop
5820 @opindex fno-defer-pop
5821 Always pop the arguments to each function call as soon as that function
5822 returns.  For machines which must pop arguments after a function call,
5823 the compiler normally lets arguments accumulate on the stack for several
5824 function calls and pops them all at once.
5825
5826 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5827
5828 @item -fforward-propagate
5829 @opindex fforward-propagate
5830 Perform a forward propagation pass on RTL@.  The pass tries to combine two
5831 instructions and checks if the result can be simplified.  If loop unrolling
5832 is active, two passes are performed and the second is scheduled after
5833 loop unrolling.
5834
5835 This option is enabled by default at optimization levels @option{-O},
5836 @option{-O2}, @option{-O3}, @option{-Os}.
5837
5838 @item -fomit-frame-pointer
5839 @opindex fomit-frame-pointer
5840 Don't keep the frame pointer in a register for functions that
5841 don't need one.  This avoids the instructions to save, set up and
5842 restore frame pointers; it also makes an extra register available
5843 in many functions.  @strong{It also makes debugging impossible on
5844 some machines.}
5845
5846 On some machines, such as the VAX, this flag has no effect, because
5847 the standard calling sequence automatically handles the frame pointer
5848 and nothing is saved by pretending it doesn't exist.  The
5849 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
5850 whether a target machine supports this flag.  @xref{Registers,,Register
5851 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
5852
5853 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5854
5855 @item -foptimize-sibling-calls
5856 @opindex foptimize-sibling-calls
5857 Optimize sibling and tail recursive calls.
5858
5859 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5860
5861 @item -fno-inline
5862 @opindex fno-inline
5863 Don't pay attention to the @code{inline} keyword.  Normally this option
5864 is used to keep the compiler from expanding any functions inline.
5865 Note that if you are not optimizing, no functions can be expanded inline.
5866
5867 @item -finline-small-functions
5868 @opindex finline-small-functions
5869 Integrate functions into their callers when their body is smaller than expected
5870 function call code (so overall size of program gets smaller).  The compiler
5871 heuristically decides which functions are simple enough to be worth integrating
5872 in this way.
5873
5874 Enabled at level @option{-O2}.
5875
5876 @item -findirect-inlining
5877 @opindex findirect-inlining
5878 Inline also indirect calls that are discovered to be known at compile
5879 time thanks to previous inlining.  This option has any effect only
5880 when inlining itself is turned on by the @option{-finline-functions}
5881 or @option{-finline-small-functions} options.
5882
5883 Enabled at level @option{-O2}.
5884
5885 @item -finline-functions
5886 @opindex finline-functions
5887 Integrate all simple functions into their callers.  The compiler
5888 heuristically decides which functions are simple enough to be worth
5889 integrating in this way.
5890
5891 If all calls to a given function are integrated, and the function is
5892 declared @code{static}, then the function is normally not output as
5893 assembler code in its own right.
5894
5895 Enabled at level @option{-O3}.
5896
5897 @item -finline-functions-called-once
5898 @opindex finline-functions-called-once
5899 Consider all @code{static} functions called once for inlining into their
5900 caller even if they are not marked @code{inline}.  If a call to a given
5901 function is integrated, then the function is not output as assembler code
5902 in its own right.
5903
5904 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
5905
5906 @item -fearly-inlining
5907 @opindex fearly-inlining
5908 Inline functions marked by @code{always_inline} and functions whose body seems
5909 smaller than the function call overhead early before doing
5910 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
5911 makes profiling significantly cheaper and usually inlining faster on programs
5912 having large chains of nested wrapper functions.
5913
5914 Enabled by default.
5915
5916 @item -fipa-sra
5917 @opindex fipa-sra
5918 Perform interprocedural scalar replacement of aggregates, removal of
5919 unused parameters and replacement of parameters passed by reference
5920 by parameters passed by value.
5921
5922 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
5923
5924 @item -finline-limit=@var{n}
5925 @opindex finline-limit
5926 By default, GCC limits the size of functions that can be inlined.  This flag
5927 allows coarse control of this limit.  @var{n} is the size of functions that
5928 can be inlined in number of pseudo instructions.
5929
5930 Inlining is actually controlled by a number of parameters, which may be
5931 specified individually by using @option{--param @var{name}=@var{value}}.
5932 The @option{-finline-limit=@var{n}} option sets some of these parameters
5933 as follows:
5934
5935 @table @gcctabopt
5936 @item max-inline-insns-single
5937 is set to @var{n}/2.
5938 @item max-inline-insns-auto
5939 is set to @var{n}/2.
5940 @end table
5941
5942 See below for a documentation of the individual
5943 parameters controlling inlining and for the defaults of these parameters.
5944
5945 @emph{Note:} there may be no value to @option{-finline-limit} that results
5946 in default behavior.
5947
5948 @emph{Note:} pseudo instruction represents, in this particular context, an
5949 abstract measurement of function's size.  In no way does it represent a count
5950 of assembly instructions and as such its exact meaning might change from one
5951 release to an another.
5952
5953 @item -fkeep-inline-functions
5954 @opindex fkeep-inline-functions
5955 In C, emit @code{static} functions that are declared @code{inline}
5956 into the object file, even if the function has been inlined into all
5957 of its callers.  This switch does not affect functions using the
5958 @code{extern inline} extension in GNU C89@.  In C++, emit any and all
5959 inline functions into the object file.
5960
5961 @item -fkeep-static-consts
5962 @opindex fkeep-static-consts
5963 Emit variables declared @code{static const} when optimization isn't turned
5964 on, even if the variables aren't referenced.
5965
5966 GCC enables this option by default.  If you want to force the compiler to
5967 check if the variable was referenced, regardless of whether or not
5968 optimization is turned on, use the @option{-fno-keep-static-consts} option.
5969
5970 @item -fmerge-constants
5971 @opindex fmerge-constants
5972 Attempt to merge identical constants (string constants and floating point
5973 constants) across compilation units.
5974
5975 This option is the default for optimized compilation if the assembler and
5976 linker support it.  Use @option{-fno-merge-constants} to inhibit this
5977 behavior.
5978
5979 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5980
5981 @item -fmerge-all-constants
5982 @opindex fmerge-all-constants
5983 Attempt to merge identical constants and identical variables.
5984
5985 This option implies @option{-fmerge-constants}.  In addition to
5986 @option{-fmerge-constants} this considers e.g.@: even constant initialized
5987 arrays or initialized constant variables with integral or floating point
5988 types.  Languages like C or C++ require each variable, including multiple
5989 instances of the same variable in recursive calls, to have distinct locations,
5990 so using this option will result in non-conforming
5991 behavior.
5992
5993 @item -fmodulo-sched
5994 @opindex fmodulo-sched
5995 Perform swing modulo scheduling immediately before the first scheduling
5996 pass.  This pass looks at innermost loops and reorders their
5997 instructions by overlapping different iterations.
5998
5999 @item -fmodulo-sched-allow-regmoves
6000 @opindex fmodulo-sched-allow-regmoves
6001 Perform more aggressive SMS based modulo scheduling with register moves
6002 allowed.  By setting this flag certain anti-dependences edges will be
6003 deleted which will trigger the generation of reg-moves based on the
6004 life-range analysis.  This option is effective only with
6005 @option{-fmodulo-sched} enabled.
6006
6007 @item -fno-branch-count-reg
6008 @opindex fno-branch-count-reg
6009 Do not use ``decrement and branch'' instructions on a count register,
6010 but instead generate a sequence of instructions that decrement a
6011 register, compare it against zero, then branch based upon the result.
6012 This option is only meaningful on architectures that support such
6013 instructions, which include x86, PowerPC, IA-64 and S/390.
6014
6015 The default is @option{-fbranch-count-reg}.
6016
6017 @item -fno-function-cse
6018 @opindex fno-function-cse
6019 Do not put function addresses in registers; make each instruction that
6020 calls a constant function contain the function's address explicitly.
6021
6022 This option results in less efficient code, but some strange hacks
6023 that alter the assembler output may be confused by the optimizations
6024 performed when this option is not used.
6025
6026 The default is @option{-ffunction-cse}
6027
6028 @item -fno-zero-initialized-in-bss
6029 @opindex fno-zero-initialized-in-bss
6030 If the target supports a BSS section, GCC by default puts variables that
6031 are initialized to zero into BSS@.  This can save space in the resulting
6032 code.
6033
6034 This option turns off this behavior because some programs explicitly
6035 rely on variables going to the data section.  E.g., so that the
6036 resulting executable can find the beginning of that section and/or make
6037 assumptions based on that.
6038
6039 The default is @option{-fzero-initialized-in-bss}.
6040
6041 @item -fmudflap -fmudflapth -fmudflapir
6042 @opindex fmudflap
6043 @opindex fmudflapth
6044 @opindex fmudflapir
6045 @cindex bounds checking
6046 @cindex mudflap
6047 For front-ends that support it (C and C++), instrument all risky
6048 pointer/array dereferencing operations, some standard library
6049 string/heap functions, and some other associated constructs with
6050 range/validity tests.  Modules so instrumented should be immune to
6051 buffer overflows, invalid heap use, and some other classes of C/C++
6052 programming errors.  The instrumentation relies on a separate runtime
6053 library (@file{libmudflap}), which will be linked into a program if
6054 @option{-fmudflap} is given at link time.  Run-time behavior of the
6055 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
6056 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
6057 for its options.
6058
6059 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
6060 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
6061 addition to @option{-fmudflap} or @option{-fmudflapth}, if
6062 instrumentation should ignore pointer reads.  This produces less
6063 instrumentation (and therefore faster execution) and still provides
6064 some protection against outright memory corrupting writes, but allows
6065 erroneously read data to propagate within a program.
6066
6067 @item -fthread-jumps
6068 @opindex fthread-jumps
6069 Perform optimizations where we check to see if a jump branches to a
6070 location where another comparison subsumed by the first is found.  If
6071 so, the first branch is redirected to either the destination of the
6072 second branch or a point immediately following it, depending on whether
6073 the condition is known to be true or false.
6074
6075 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6076
6077 @item -fsplit-wide-types
6078 @opindex fsplit-wide-types
6079 When using a type that occupies multiple registers, such as @code{long
6080 long} on a 32-bit system, split the registers apart and allocate them
6081 independently.  This normally generates better code for those types,
6082 but may make debugging more difficult.
6083
6084 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
6085 @option{-Os}.
6086
6087 @item -fcse-follow-jumps
6088 @opindex fcse-follow-jumps
6089 In common subexpression elimination (CSE), scan through jump instructions
6090 when the target of the jump is not reached by any other path.  For
6091 example, when CSE encounters an @code{if} statement with an
6092 @code{else} clause, CSE will follow the jump when the condition
6093 tested is false.
6094
6095 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6096
6097 @item -fcse-skip-blocks
6098 @opindex fcse-skip-blocks
6099 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
6100 follow jumps which conditionally skip over blocks.  When CSE
6101 encounters a simple @code{if} statement with no else clause,
6102 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
6103 body of the @code{if}.
6104
6105 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6106
6107 @item -frerun-cse-after-loop
6108 @opindex frerun-cse-after-loop
6109 Re-run common subexpression elimination after loop optimizations has been
6110 performed.
6111
6112 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6113
6114 @item -fgcse
6115 @opindex fgcse
6116 Perform a global common subexpression elimination pass.
6117 This pass also performs global constant and copy propagation.
6118
6119 @emph{Note:} When compiling a program using computed gotos, a GCC
6120 extension, you may get better runtime performance if you disable
6121 the global common subexpression elimination pass by adding
6122 @option{-fno-gcse} to the command line.
6123
6124 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6125
6126 @item -fgcse-lm
6127 @opindex fgcse-lm
6128 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
6129 attempt to move loads which are only killed by stores into themselves.  This
6130 allows a loop containing a load/store sequence to be changed to a load outside
6131 the loop, and a copy/store within the loop.
6132
6133 Enabled by default when gcse is enabled.
6134
6135 @item -fgcse-sm
6136 @opindex fgcse-sm
6137 When @option{-fgcse-sm} is enabled, a store motion pass is run after
6138 global common subexpression elimination.  This pass will attempt to move
6139 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
6140 loops containing a load/store sequence can be changed to a load before
6141 the loop and a store after the loop.
6142
6143 Not enabled at any optimization level.
6144
6145 @item -fgcse-las
6146 @opindex fgcse-las
6147 When @option{-fgcse-las} is enabled, the global common subexpression
6148 elimination pass eliminates redundant loads that come after stores to the
6149 same memory location (both partial and full redundancies).
6150
6151 Not enabled at any optimization level.
6152
6153 @item -fgcse-after-reload
6154 @opindex fgcse-after-reload
6155 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
6156 pass is performed after reload.  The purpose of this pass is to cleanup
6157 redundant spilling.
6158
6159 @item -funsafe-loop-optimizations
6160 @opindex funsafe-loop-optimizations
6161 If given, the loop optimizer will assume that loop indices do not
6162 overflow, and that the loops with nontrivial exit condition are not
6163 infinite.  This enables a wider range of loop optimizations even if
6164 the loop optimizer itself cannot prove that these assumptions are valid.
6165 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
6166 if it finds this kind of loop.
6167
6168 @item -fcrossjumping
6169 @opindex fcrossjumping
6170 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
6171 resulting code may or may not perform better than without cross-jumping.
6172
6173 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6174
6175 @item -fauto-inc-dec
6176 @opindex fauto-inc-dec
6177 Combine increments or decrements of addresses with memory accesses.
6178 This pass is always skipped on architectures that do not have
6179 instructions to support this.  Enabled by default at @option{-O} and
6180 higher on architectures that support this.
6181
6182 @item -fdce
6183 @opindex fdce
6184 Perform dead code elimination (DCE) on RTL@.
6185 Enabled by default at @option{-O} and higher.
6186
6187 @item -fdse
6188 @opindex fdse
6189 Perform dead store elimination (DSE) on RTL@.
6190 Enabled by default at @option{-O} and higher.
6191
6192 @item -fif-conversion
6193 @opindex fif-conversion
6194 Attempt to transform conditional jumps into branch-less equivalents.  This
6195 include use of conditional moves, min, max, set flags and abs instructions, and
6196 some tricks doable by standard arithmetics.  The use of conditional execution
6197 on chips where it is available is controlled by @code{if-conversion2}.
6198
6199 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6200
6201 @item -fif-conversion2
6202 @opindex fif-conversion2
6203 Use conditional execution (where available) to transform conditional jumps into
6204 branch-less equivalents.
6205
6206 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6207
6208 @item -fdelete-null-pointer-checks
6209 @opindex fdelete-null-pointer-checks
6210 Assume that programs cannot safely dereference null pointers, and that
6211 no code or data element resides there.  This enables simple constant
6212 folding optimizations at all optimization levels.  In addition, other
6213 optimization passes in GCC use this flag to control global dataflow
6214 analyses that eliminate useless checks for null pointers; these assume
6215 that if a pointer is checked after it has already been dereferenced,
6216 it cannot be null.
6217
6218 Note however that in some environments this assumption is not true.
6219 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
6220 for programs which depend on that behavior.
6221
6222 Some targets, especially embedded ones, disable this option at all levels.
6223 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
6224 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
6225 are enabled independently at different optimization levels.
6226
6227 @item -fexpensive-optimizations
6228 @opindex fexpensive-optimizations
6229 Perform a number of minor optimizations that are relatively expensive.
6230
6231 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6232
6233 @item -foptimize-register-move
6234 @itemx -fregmove
6235 @opindex foptimize-register-move
6236 @opindex fregmove
6237 Attempt to reassign register numbers in move instructions and as
6238 operands of other simple instructions in order to maximize the amount of
6239 register tying.  This is especially helpful on machines with two-operand
6240 instructions.
6241
6242 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
6243 optimization.
6244
6245 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6246
6247 @item -fira-algorithm=@var{algorithm}
6248 Use specified coloring algorithm for the integrated register
6249 allocator.  The @var{algorithm} argument should be @code{priority} or
6250 @code{CB}.  The first algorithm specifies Chow's priority coloring,
6251 the second one specifies Chaitin-Briggs coloring.  The second
6252 algorithm can be unimplemented for some architectures.  If it is
6253 implemented, it is the default because Chaitin-Briggs coloring as a
6254 rule generates a better code.
6255
6256 @item -fira-region=@var{region}
6257 Use specified regions for the integrated register allocator.  The
6258 @var{region} argument should be one of @code{all}, @code{mixed}, or
6259 @code{one}.  The first value means using all loops as register
6260 allocation regions, the second value which is the default means using
6261 all loops except for loops with small register pressure as the
6262 regions, and third one means using all function as a single region.
6263 The first value can give best result for machines with small size and
6264 irregular register set, the third one results in faster and generates
6265 decent code and the smallest size code, and the default value usually
6266 give the best results in most cases and for most architectures.
6267
6268 @item -fira-coalesce
6269 @opindex fira-coalesce
6270 Do optimistic register coalescing.  This option might be profitable for
6271 architectures with big regular register files.
6272
6273 @item -fira-loop-pressure
6274 @opindex fira-loop-pressure
6275 Use IRA to evaluate register pressure in loops for decision to move
6276 loop invariants.  Usage of this option usually results in generation
6277 of faster and smaller code on machines with big register files (>= 32
6278 registers) but it can slow compiler down.
6279
6280 This option is enabled at level @option{-O3} for some targets.
6281
6282 @item -fno-ira-share-save-slots
6283 @opindex fno-ira-share-save-slots
6284 Switch off sharing stack slots used for saving call used hard
6285 registers living through a call.  Each hard register will get a
6286 separate stack slot and as a result function stack frame will be
6287 bigger.
6288
6289 @item -fno-ira-share-spill-slots
6290 @opindex fno-ira-share-spill-slots
6291 Switch off sharing stack slots allocated for pseudo-registers.  Each
6292 pseudo-register which did not get a hard register will get a separate
6293 stack slot and as a result function stack frame will be bigger.
6294
6295 @item -fira-verbose=@var{n}
6296 @opindex fira-verbose
6297 Set up how verbose dump file for the integrated register allocator
6298 will be.  Default value is 5.  If the value is greater or equal to 10,
6299 the dump file will be stderr as if the value were @var{n} minus 10.
6300
6301 @item -fdelayed-branch
6302 @opindex fdelayed-branch
6303 If supported for the target machine, attempt to reorder instructions
6304 to exploit instruction slots available after delayed branch
6305 instructions.
6306
6307 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6308
6309 @item -fschedule-insns
6310 @opindex fschedule-insns
6311 If supported for the target machine, attempt to reorder instructions to
6312 eliminate execution stalls due to required data being unavailable.  This
6313 helps machines that have slow floating point or memory load instructions
6314 by allowing other instructions to be issued until the result of the load
6315 or floating point instruction is required.
6316
6317 Enabled at levels @option{-O2}, @option{-O3}.
6318
6319 @item -fschedule-insns2
6320 @opindex fschedule-insns2
6321 Similar to @option{-fschedule-insns}, but requests an additional pass of
6322 instruction scheduling after register allocation has been done.  This is
6323 especially useful on machines with a relatively small number of
6324 registers and where memory load instructions take more than one cycle.
6325
6326 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6327
6328 @item -fno-sched-interblock
6329 @opindex fno-sched-interblock
6330 Don't schedule instructions across basic blocks.  This is normally
6331 enabled by default when scheduling before register allocation, i.e.@:
6332 with @option{-fschedule-insns} or at @option{-O2} or higher.
6333
6334 @item -fno-sched-spec
6335 @opindex fno-sched-spec
6336 Don't allow speculative motion of non-load instructions.  This is normally
6337 enabled by default when scheduling before register allocation, i.e.@:
6338 with @option{-fschedule-insns} or at @option{-O2} or higher.
6339
6340 @item -fsched-pressure
6341 @opindex fsched-pressure
6342 Enable register pressure sensitive insn scheduling before the register
6343 allocation.  This only makes sense when scheduling before register
6344 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
6345 @option{-O2} or higher.  Usage of this option can improve the
6346 generated code and decrease its size by preventing register pressure
6347 increase above the number of available hard registers and as a
6348 consequence register spills in the register allocation.
6349
6350 @item -fsched-spec-load
6351 @opindex fsched-spec-load
6352 Allow speculative motion of some load instructions.  This only makes
6353 sense when scheduling before register allocation, i.e.@: with
6354 @option{-fschedule-insns} or at @option{-O2} or higher.
6355
6356 @item -fsched-spec-load-dangerous
6357 @opindex fsched-spec-load-dangerous
6358 Allow speculative motion of more load instructions.  This only makes
6359 sense when scheduling before register allocation, i.e.@: with
6360 @option{-fschedule-insns} or at @option{-O2} or higher.
6361
6362 @item -fsched-stalled-insns
6363 @itemx -fsched-stalled-insns=@var{n}
6364 @opindex fsched-stalled-insns
6365 Define how many insns (if any) can be moved prematurely from the queue
6366 of stalled insns into the ready list, during the second scheduling pass.
6367 @option{-fno-sched-stalled-insns} means that no insns will be moved
6368 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
6369 on how many queued insns can be moved prematurely.
6370 @option{-fsched-stalled-insns} without a value is equivalent to
6371 @option{-fsched-stalled-insns=1}.
6372
6373 @item -fsched-stalled-insns-dep
6374 @itemx -fsched-stalled-insns-dep=@var{n}
6375 @opindex fsched-stalled-insns-dep
6376 Define how many insn groups (cycles) will be examined for a dependency
6377 on a stalled insn that is candidate for premature removal from the queue
6378 of stalled insns.  This has an effect only during the second scheduling pass,
6379 and only if @option{-fsched-stalled-insns} is used.
6380 @option{-fno-sched-stalled-insns-dep} is equivalent to
6381 @option{-fsched-stalled-insns-dep=0}.
6382 @option{-fsched-stalled-insns-dep} without a value is equivalent to
6383 @option{-fsched-stalled-insns-dep=1}.
6384
6385 @item -fsched2-use-superblocks
6386 @opindex fsched2-use-superblocks
6387 When scheduling after register allocation, do use superblock scheduling
6388 algorithm.  Superblock scheduling allows motion across basic block boundaries
6389 resulting on faster schedules.  This option is experimental, as not all machine
6390 descriptions used by GCC model the CPU closely enough to avoid unreliable
6391 results from the algorithm.
6392
6393 This only makes sense when scheduling after register allocation, i.e.@: with
6394 @option{-fschedule-insns2} or at @option{-O2} or higher.
6395
6396 @item -fsched-group-heuristic
6397 @opindex fsched-group-heuristic
6398 Enable the group heuristic in the scheduler.  This heuristic favors 
6399 the instruction that belongs to a schedule group.  This is enabled 
6400 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6401 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6402
6403 @item -fsched-critical-path-heuristic
6404 @opindex fsched-critical-path-heuristic
6405 Enable the critical-path heuristic in the scheduler.  This heuristic favors 
6406 instructions on the critical path.  This is enabled by default when 
6407 scheduling is enabled, i.e.@: with @option{-fschedule-insns} 
6408 or @option{-fschedule-insns2} or at @option{-O2} or higher.
6409
6410 @item -fsched-spec-insn-heuristic
6411 @opindex fsched-spec-insn-heuristic
6412 Enable the speculative instruction heuristic in the scheduler.  This 
6413 heuristic favors speculative instructions with greater dependency weakness.  
6414 This is enabled by default when scheduling is enabled, i.e.@: 
6415 with @option{-fschedule-insns} or @option{-fschedule-insns2} 
6416 or at @option{-O2} or higher.
6417
6418 @item -fsched-rank-heuristic
6419 @opindex fsched-rank-heuristic
6420 Enable the rank heuristic in the scheduler.  This heuristic favors 
6421 the instruction belonging to a basic block with greater size or frequency.  
6422 This is enabled by default when scheduling is enabled, i.e.@: 
6423 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6424 at @option{-O2} or higher.
6425
6426 @item -fsched-last-insn-heuristic
6427 @opindex fsched-last-insn-heuristic
6428 Enable the last-instruction heuristic in the scheduler.  This heuristic 
6429 favors the instruction that is less dependent on the last instruction
6430 scheduled.  This is enabled by default when scheduling is enabled, 
6431 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6432 at @option{-O2} or higher.
6433
6434 @item -fsched-dep-count-heuristic
6435 @opindex fsched-dep-count-heuristic
6436 Enable the dependent-count heuristic in the scheduler.  This heuristic 
6437 favors the instruction that has more instructions depending on it.  
6438 This is enabled by default when scheduling is enabled, i.e.@: 
6439 with @option{-fschedule-insns} or @option{-fschedule-insns2} or 
6440 at @option{-O2} or higher.
6441
6442 @item -freschedule-modulo-scheduled-loops
6443 @opindex freschedule-modulo-scheduled-loops
6444 The modulo scheduling comes before the traditional scheduling, if a loop
6445 was modulo scheduled we may want to prevent the later scheduling passes
6446 from changing its schedule, we use this option to control that.
6447
6448 @item -fselective-scheduling
6449 @opindex fselective-scheduling
6450 Schedule instructions using selective scheduling algorithm.  Selective
6451 scheduling runs instead of the first scheduler pass.
6452
6453 @item -fselective-scheduling2
6454 @opindex fselective-scheduling2
6455 Schedule instructions using selective scheduling algorithm.  Selective
6456 scheduling runs instead of the second scheduler pass.
6457
6458 @item -fsel-sched-pipelining
6459 @opindex fsel-sched-pipelining
6460 Enable software pipelining of innermost loops during selective scheduling.
6461 This option has no effect until one of @option{-fselective-scheduling} or
6462 @option{-fselective-scheduling2} is turned on.
6463
6464 @item -fsel-sched-pipelining-outer-loops
6465 @opindex fsel-sched-pipelining-outer-loops
6466 When pipelining loops during selective scheduling, also pipeline outer loops.
6467 This option has no effect until @option{-fsel-sched-pipelining} is turned on.
6468
6469 @item -fcaller-saves
6470 @opindex fcaller-saves
6471 Enable values to be allocated in registers that will be clobbered by
6472 function calls, by emitting extra instructions to save and restore the
6473 registers around such calls.  Such allocation is done only when it
6474 seems to result in better code than would otherwise be produced.
6475
6476 This option is always enabled by default on certain machines, usually
6477 those which have no call-preserved registers to use instead.
6478
6479 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6480
6481 @item -fconserve-stack
6482 @opindex fconserve-stack
6483 Attempt to minimize stack usage.  The compiler will attempt to use less
6484 stack space, even if that makes the program slower.  This option
6485 implies setting the @option{large-stack-frame} parameter to 100
6486 and the @option{large-stack-frame-growth} parameter to 400.
6487
6488 @item -ftree-reassoc
6489 @opindex ftree-reassoc
6490 Perform reassociation on trees.  This flag is enabled by default
6491 at @option{-O} and higher.
6492
6493 @item -ftree-pre
6494 @opindex ftree-pre
6495 Perform partial redundancy elimination (PRE) on trees.  This flag is
6496 enabled by default at @option{-O2} and @option{-O3}.
6497
6498 @item -ftree-forwprop
6499 @opindex ftree-forwprop
6500 Perform forward propagation on trees.  This flag is enabled by default
6501 at @option{-O} and higher.
6502
6503 @item -ftree-fre
6504 @opindex ftree-fre
6505 Perform full redundancy elimination (FRE) on trees.  The difference
6506 between FRE and PRE is that FRE only considers expressions
6507 that are computed on all paths leading to the redundant computation.
6508 This analysis is faster than PRE, though it exposes fewer redundancies.
6509 This flag is enabled by default at @option{-O} and higher.
6510
6511 @item -ftree-phiprop
6512 @opindex ftree-phiprop
6513 Perform hoisting of loads from conditional pointers on trees.  This
6514 pass is enabled by default at @option{-O} and higher.
6515
6516 @item -ftree-copy-prop
6517 @opindex ftree-copy-prop
6518 Perform copy propagation on trees.  This pass eliminates unnecessary
6519 copy operations.  This flag is enabled by default at @option{-O} and
6520 higher.
6521
6522 @item -fipa-pure-const
6523 @opindex fipa-pure-const
6524 Discover which functions are pure or constant.
6525 Enabled by default at @option{-O} and higher.
6526
6527 @item -fipa-reference
6528 @opindex fipa-reference
6529 Discover which static variables do not escape cannot escape the
6530 compilation unit.
6531 Enabled by default at @option{-O} and higher.
6532
6533 @item -fipa-struct-reorg
6534 @opindex fipa-struct-reorg
6535 Perform structure reorganization optimization, that change C-like structures
6536 layout in order to better utilize spatial locality.  This transformation is
6537 affective for programs containing arrays of structures.  Available in two
6538 compilation modes: profile-based (enabled with @option{-fprofile-generate})
6539 or static (which uses built-in heuristics).  Require @option{-fipa-type-escape}
6540 to provide the safety of this transformation.  It works only in whole program
6541 mode, so it requires @option{-fwhole-program} and @option{-combine} to be
6542 enabled.  Structures considered @samp{cold} by this transformation are not
6543 affected (see @option{--param struct-reorg-cold-struct-ratio=@var{value}}).
6544
6545 With this flag, the program debug info reflects a new structure layout.
6546
6547 @item -fipa-pta
6548 @opindex fipa-pta
6549 Perform interprocedural pointer analysis.  This option is experimental
6550 and does not affect generated code.
6551
6552 @item -fipa-cp
6553 @opindex fipa-cp
6554 Perform interprocedural constant propagation.
6555 This optimization analyzes the program to determine when values passed
6556 to functions are constants and then optimizes accordingly.
6557 This optimization can substantially increase performance
6558 if the application has constants passed to functions.
6559 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
6560
6561 @item -fipa-cp-clone
6562 @opindex fipa-cp-clone
6563 Perform function cloning to make interprocedural constant propagation stronger.
6564 When enabled, interprocedural constant propagation will perform function cloning
6565 when externally visible function can be called with constant arguments.
6566 Because this optimization can create multiple copies of functions,
6567 it may significantly increase code size
6568 (see @option{--param ipcp-unit-growth=@var{value}}).
6569 This flag is enabled by default at @option{-O3}.
6570
6571 @item -fipa-matrix-reorg
6572 @opindex fipa-matrix-reorg
6573 Perform matrix flattening and transposing.
6574 Matrix flattening tries to replace an @math{m}-dimensional matrix
6575 with its equivalent @math{n}-dimensional matrix, where @math{n < m}.
6576 This reduces the level of indirection needed for accessing the elements
6577 of the matrix. The second optimization is matrix transposing that
6578 attempts to change the order of the matrix's dimensions in order to
6579 improve cache locality.
6580 Both optimizations need the @option{-fwhole-program} flag.
6581 Transposing is enabled only if profiling information is available.
6582
6583 @item -ftree-sink
6584 @opindex ftree-sink
6585 Perform forward store motion  on trees.  This flag is
6586 enabled by default at @option{-O} and higher.
6587
6588 @item -ftree-ccp
6589 @opindex ftree-ccp
6590 Perform sparse conditional constant propagation (CCP) on trees.  This
6591 pass only operates on local scalar variables and is enabled by default
6592 at @option{-O} and higher.
6593
6594 @item -ftree-switch-conversion
6595 Perform conversion of simple initializations in a switch to
6596 initializations from a scalar array.  This flag is enabled by default
6597 at @option{-O2} and higher.
6598
6599 @item -ftree-dce
6600 @opindex ftree-dce
6601 Perform dead code elimination (DCE) on trees.  This flag is enabled by
6602 default at @option{-O} and higher.
6603
6604 @item -ftree-builtin-call-dce
6605 @opindex ftree-builtin-call-dce
6606 Perform conditional dead code elimination (DCE) for calls to builtin functions
6607 that may set @code{errno} but are otherwise side-effect free.  This flag is
6608 enabled by default at @option{-O2} and higher if @option{-Os} is not also
6609 specified.
6610
6611 @item -ftree-dominator-opts
6612 @opindex ftree-dominator-opts
6613 Perform a variety of simple scalar cleanups (constant/copy
6614 propagation, redundancy elimination, range propagation and expression
6615 simplification) based on a dominator tree traversal.  This also
6616 performs jump threading (to reduce jumps to jumps). This flag is
6617 enabled by default at @option{-O} and higher.
6618
6619 @item -ftree-dse
6620 @opindex ftree-dse
6621 Perform dead store elimination (DSE) on trees.  A dead store is a store into
6622 a memory location which will later be overwritten by another store without
6623 any intervening loads.  In this case the earlier store can be deleted.  This
6624 flag is enabled by default at @option{-O} and higher.
6625
6626 @item -ftree-ch
6627 @opindex ftree-ch
6628 Perform loop header copying on trees.  This is beneficial since it increases
6629 effectiveness of code motion optimizations.  It also saves one jump.  This flag
6630 is enabled by default at @option{-O} and higher.  It is not enabled
6631 for @option{-Os}, since it usually increases code size.
6632
6633 @item -ftree-loop-optimize
6634 @opindex ftree-loop-optimize
6635 Perform loop optimizations on trees.  This flag is enabled by default
6636 at @option{-O} and higher.
6637
6638 @item -ftree-loop-linear
6639 @opindex ftree-loop-linear
6640 Perform linear loop transformations on tree.  This flag can improve cache
6641 performance and allow further loop optimizations to take place.
6642
6643 @item -floop-interchange
6644 Perform loop interchange transformations on loops.  Interchanging two
6645 nested loops switches the inner and outer loops.  For example, given a
6646 loop like:
6647 @smallexample
6648 DO J = 1, M
6649   DO I = 1, N
6650     A(J, I) = A(J, I) * C
6651   ENDDO
6652 ENDDO
6653 @end smallexample
6654 loop interchange will transform the loop as if the user had written:
6655 @smallexample
6656 DO I = 1, N
6657   DO J = 1, M
6658     A(J, I) = A(J, I) * C
6659   ENDDO
6660 ENDDO
6661 @end smallexample
6662 which can be beneficial when @code{N} is larger than the caches,
6663 because in Fortran, the elements of an array are stored in memory
6664 contiguously by column, and the original loop iterates over rows,
6665 potentially creating at each access a cache miss.  This optimization
6666 applies to all the languages supported by GCC and is not limited to
6667 Fortran.  To use this code transformation, GCC has to be configured
6668 with @option{--with-ppl} and @option{--with-cloog} to enable the
6669 Graphite loop transformation infrastructure.
6670
6671 @item -floop-strip-mine
6672 Perform loop strip mining transformations on loops.  Strip mining
6673 splits a loop into two nested loops.  The outer loop has strides
6674 equal to the strip size and the inner loop has strides of the
6675 original loop within a strip.  For example, given a loop like:
6676 @smallexample
6677 DO I = 1, N
6678   A(I) = A(I) + C
6679 ENDDO
6680 @end smallexample
6681 loop strip mining will transform the loop as if the user had written:
6682 @smallexample
6683 DO II = 1, N, 4
6684   DO I = II, min (II + 3, N)
6685     A(I) = A(I) + C
6686   ENDDO
6687 ENDDO
6688 @end smallexample
6689 This optimization applies to all the languages supported by GCC and is
6690 not limited to Fortran.  To use this code transformation, GCC has to
6691 be configured with @option{--with-ppl} and @option{--with-cloog} to
6692 enable the Graphite loop transformation infrastructure.
6693
6694 @item -floop-block
6695 Perform loop blocking transformations on loops.  Blocking strip mines
6696 each loop in the loop nest such that the memory accesses of the
6697 element loops fit inside caches.  For example, given a loop like:
6698 @smallexample
6699 DO I = 1, N
6700   DO J = 1, M
6701     A(J, I) = B(I) + C(J)
6702   ENDDO
6703 ENDDO
6704 @end smallexample
6705 loop blocking will transform the loop as if the user had written:
6706 @smallexample
6707 DO II = 1, N, 64
6708   DO JJ = 1, M, 64
6709     DO I = II, min (II + 63, N)
6710       DO J = JJ, min (JJ + 63, M)
6711         A(J, I) = B(I) + C(J)
6712       ENDDO
6713     ENDDO
6714   ENDDO
6715 ENDDO
6716 @end smallexample
6717 which can be beneficial when @code{M} is larger than the caches,
6718 because the innermost loop will iterate over a smaller amount of data
6719 that can be kept in the caches.  This optimization applies to all the
6720 languages supported by GCC and is not limited to Fortran.  To use this
6721 code transformation, GCC has to be configured with @option{--with-ppl}
6722 and @option{--with-cloog} to enable the Graphite loop transformation
6723 infrastructure.
6724
6725 @item -fgraphite-identity
6726 @opindex fgraphite-identity
6727 Enable the identity transformation for graphite.  For every SCoP we generate
6728 the polyhedral representation and transform it back to gimple.  Using
6729 @option{-fgraphite-identity} we can check the costs or benefits of the
6730 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
6731 are also performed by the code generator CLooG, like index splitting and
6732 dead code elimination in loops.
6733
6734 @item -floop-parallelize-all
6735 Use the Graphite data dependence analysis to identify loops that can
6736 be parallelized.  Parallelize all the loops that can be analyzed to
6737 not contain loop carried dependences without checking that it is
6738 profitable to parallelize the loops.
6739
6740 @item -fcheck-data-deps
6741 @opindex fcheck-data-deps
6742 Compare the results of several data dependence analyzers.  This option
6743 is used for debugging the data dependence analyzers.
6744
6745 @item -ftree-loop-distribution
6746 Perform loop distribution.  This flag can improve cache performance on
6747 big loop bodies and allow further loop optimizations, like
6748 parallelization or vectorization, to take place.  For example, the loop
6749 @smallexample
6750 DO I = 1, N
6751   A(I) = B(I) + C
6752   D(I) = E(I) * F
6753 ENDDO
6754 @end smallexample
6755 is transformed to
6756 @smallexample
6757 DO I = 1, N
6758    A(I) = B(I) + C
6759 ENDDO
6760 DO I = 1, N
6761    D(I) = E(I) * F
6762 ENDDO
6763 @end smallexample
6764
6765 @item -ftree-loop-im
6766 @opindex ftree-loop-im
6767 Perform loop invariant motion on trees.  This pass moves only invariants that
6768 would be hard to handle at RTL level (function calls, operations that expand to
6769 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
6770 operands of conditions that are invariant out of the loop, so that we can use
6771 just trivial invariantness analysis in loop unswitching.  The pass also includes
6772 store motion.
6773
6774 @item -ftree-loop-ivcanon
6775 @opindex ftree-loop-ivcanon
6776 Create a canonical counter for number of iterations in the loop for that
6777 determining number of iterations requires complicated analysis.  Later
6778 optimizations then may determine the number easily.  Useful especially
6779 in connection with unrolling.
6780
6781 @item -fivopts
6782 @opindex fivopts
6783 Perform induction variable optimizations (strength reduction, induction
6784 variable merging and induction variable elimination) on trees.
6785
6786 @item -ftree-parallelize-loops=n
6787 @opindex ftree-parallelize-loops
6788 Parallelize loops, i.e., split their iteration space to run in n threads.
6789 This is only possible for loops whose iterations are independent
6790 and can be arbitrarily reordered.  The optimization is only
6791 profitable on multiprocessor machines, for loops that are CPU-intensive,
6792 rather than constrained e.g.@: by memory bandwidth.  This option
6793 implies @option{-pthread}, and thus is only supported on targets
6794 that have support for @option{-pthread}.
6795
6796 @item -ftree-pta
6797 @opindex ftree-pta
6798 Perform function-local points-to analysis on trees.  This flag is
6799 enabled by default at @option{-O} and higher.
6800
6801 @item -ftree-sra
6802 @opindex ftree-sra
6803 Perform scalar replacement of aggregates.  This pass replaces structure
6804 references with scalars to prevent committing structures to memory too
6805 early.  This flag is enabled by default at @option{-O} and higher.
6806
6807 @item -ftree-copyrename
6808 @opindex ftree-copyrename
6809 Perform copy renaming on trees.  This pass attempts to rename compiler
6810 temporaries to other variables at copy locations, usually resulting in
6811 variable names which more closely resemble the original variables.  This flag
6812 is enabled by default at @option{-O} and higher.
6813
6814 @item -ftree-ter
6815 @opindex ftree-ter
6816 Perform temporary expression replacement during the SSA->normal phase.  Single
6817 use/single def temporaries are replaced at their use location with their
6818 defining expression.  This results in non-GIMPLE code, but gives the expanders
6819 much more complex trees to work on resulting in better RTL generation.  This is
6820 enabled by default at @option{-O} and higher.
6821
6822 @item -ftree-vectorize
6823 @opindex ftree-vectorize
6824 Perform loop vectorization on trees. This flag is enabled by default at
6825 @option{-O3}.
6826
6827 @item -ftree-slp-vectorize
6828 @opindex ftree-slp-vectorize
6829 Perform basic block vectorization on trees. This flag is enabled by default at
6830 @option{-O3} and when @option{-ftree-vectorize} is enabled.
6831
6832 @item -ftree-vect-loop-version
6833 @opindex ftree-vect-loop-version
6834 Perform loop versioning when doing loop vectorization on trees.  When a loop
6835 appears to be vectorizable except that data alignment or data dependence cannot
6836 be determined at compile time then vectorized and non-vectorized versions of
6837 the loop are generated along with runtime checks for alignment or dependence
6838 to control which version is executed.  This option is enabled by default
6839 except at level @option{-Os} where it is disabled.
6840
6841 @item -fvect-cost-model
6842 @opindex fvect-cost-model
6843 Enable cost model for vectorization.
6844
6845 @item -ftree-vrp
6846 @opindex ftree-vrp
6847 Perform Value Range Propagation on trees.  This is similar to the
6848 constant propagation pass, but instead of values, ranges of values are
6849 propagated.  This allows the optimizers to remove unnecessary range
6850 checks like array bound checks and null pointer checks.  This is
6851 enabled by default at @option{-O2} and higher.  Null pointer check
6852 elimination is only done if @option{-fdelete-null-pointer-checks} is
6853 enabled.
6854
6855 @item -ftracer
6856 @opindex ftracer
6857 Perform tail duplication to enlarge superblock size.  This transformation
6858 simplifies the control flow of the function allowing other optimizations to do
6859 better job.
6860
6861 @item -funroll-loops
6862 @opindex funroll-loops
6863 Unroll loops whose number of iterations can be determined at compile
6864 time or upon entry to the loop.  @option{-funroll-loops} implies
6865 @option{-frerun-cse-after-loop}.  This option makes code larger,
6866 and may or may not make it run faster.
6867
6868 @item -funroll-all-loops
6869 @opindex funroll-all-loops
6870 Unroll all loops, even if their number of iterations is uncertain when
6871 the loop is entered.  This usually makes programs run more slowly.
6872 @option{-funroll-all-loops} implies the same options as
6873 @option{-funroll-loops},
6874
6875 @item -fsplit-ivs-in-unroller
6876 @opindex fsplit-ivs-in-unroller
6877 Enables expressing of values of induction variables in later iterations
6878 of the unrolled loop using the value in the first iteration.  This breaks
6879 long dependency chains, thus improving efficiency of the scheduling passes.
6880
6881 Combination of @option{-fweb} and CSE is often sufficient to obtain the
6882 same effect.  However in cases the loop body is more complicated than
6883 a single basic block, this is not reliable.  It also does not work at all
6884 on some of the architectures due to restrictions in the CSE pass.
6885
6886 This optimization is enabled by default.
6887
6888 @item -fvariable-expansion-in-unroller
6889 @opindex fvariable-expansion-in-unroller
6890 With this option, the compiler will create multiple copies of some
6891 local variables when unrolling a loop which can result in superior code.
6892
6893 @item -fpredictive-commoning
6894 @opindex fpredictive-commoning
6895 Perform predictive commoning optimization, i.e., reusing computations
6896 (especially memory loads and stores) performed in previous
6897 iterations of loops.
6898
6899 This option is enabled at level @option{-O3}.
6900
6901 @item -fprefetch-loop-arrays
6902 @opindex fprefetch-loop-arrays
6903 If supported by the target machine, generate instructions to prefetch
6904 memory to improve the performance of loops that access large arrays.
6905
6906 This option may generate better or worse code; results are highly
6907 dependent on the structure of loops within the source code.
6908
6909 Disabled at level @option{-Os}.
6910
6911 @item -fno-peephole
6912 @itemx -fno-peephole2
6913 @opindex fno-peephole
6914 @opindex fno-peephole2
6915 Disable any machine-specific peephole optimizations.  The difference
6916 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
6917 are implemented in the compiler; some targets use one, some use the
6918 other, a few use both.
6919
6920 @option{-fpeephole} is enabled by default.
6921 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6922
6923 @item -fno-guess-branch-probability
6924 @opindex fno-guess-branch-probability
6925 Do not guess branch probabilities using heuristics.
6926
6927 GCC will use heuristics to guess branch probabilities if they are
6928 not provided by profiling feedback (@option{-fprofile-arcs}).  These
6929 heuristics are based on the control flow graph.  If some branch probabilities
6930 are specified by @samp{__builtin_expect}, then the heuristics will be
6931 used to guess branch probabilities for the rest of the control flow graph,
6932 taking the @samp{__builtin_expect} info into account.  The interactions
6933 between the heuristics and @samp{__builtin_expect} can be complex, and in
6934 some cases, it may be useful to disable the heuristics so that the effects
6935 of @samp{__builtin_expect} are easier to understand.
6936
6937 The default is @option{-fguess-branch-probability} at levels
6938 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6939
6940 @item -freorder-blocks
6941 @opindex freorder-blocks
6942 Reorder basic blocks in the compiled function in order to reduce number of
6943 taken branches and improve code locality.
6944
6945 Enabled at levels @option{-O2}, @option{-O3}.
6946
6947 @item -freorder-blocks-and-partition
6948 @opindex freorder-blocks-and-partition
6949 In addition to reordering basic blocks in the compiled function, in order
6950 to reduce number of taken branches, partitions hot and cold basic blocks
6951 into separate sections of the assembly and .o files, to improve
6952 paging and cache locality performance.
6953
6954 This optimization is automatically turned off in the presence of
6955 exception handling, for linkonce sections, for functions with a user-defined
6956 section attribute and on any architecture that does not support named
6957 sections.
6958
6959 @item -freorder-functions
6960 @opindex freorder-functions
6961 Reorder functions in the object file in order to
6962 improve code locality.  This is implemented by using special
6963 subsections @code{.text.hot} for most frequently executed functions and
6964 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
6965 the linker so object file format must support named sections and linker must
6966 place them in a reasonable way.
6967
6968 Also profile feedback must be available in to make this option effective.  See
6969 @option{-fprofile-arcs} for details.
6970
6971 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
6972
6973 @item -fstrict-aliasing
6974 @opindex fstrict-aliasing
6975 Allow the compiler to assume the strictest aliasing rules applicable to
6976 the language being compiled.  For C (and C++), this activates
6977 optimizations based on the type of expressions.  In particular, an
6978 object of one type is assumed never to reside at the same address as an
6979 object of a different type, unless the types are almost the same.  For
6980 example, an @code{unsigned int} can alias an @code{int}, but not a
6981 @code{void*} or a @code{double}.  A character type may alias any other
6982 type.
6983
6984 @anchor{Type-punning}Pay special attention to code like this:
6985 @smallexample
6986 union a_union @{
6987   int i;
6988   double d;
6989 @};
6990
6991 int f() @{
6992   union a_union t;
6993   t.d = 3.0;
6994   return t.i;
6995 @}
6996 @end smallexample
6997 The practice of reading from a different union member than the one most
6998 recently written to (called ``type-punning'') is common.  Even with
6999 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
7000 is accessed through the union type.  So, the code above will work as
7001 expected.  @xref{Structures unions enumerations and bit-fields
7002 implementation}.  However, this code might not:
7003 @smallexample
7004 int f() @{
7005   union a_union t;
7006   int* ip;
7007   t.d = 3.0;
7008   ip = &t.i;
7009   return *ip;
7010 @}
7011 @end smallexample
7012
7013 Similarly, access by taking the address, casting the resulting pointer
7014 and dereferencing the result has undefined behavior, even if the cast
7015 uses a union type, e.g.:
7016 @smallexample
7017 int f() @{
7018   double d = 3.0;
7019   return ((union a_union *) &d)->i;
7020 @}
7021 @end smallexample
7022
7023 The @option{-fstrict-aliasing} option is enabled at levels
7024 @option{-O2}, @option{-O3}, @option{-Os}.
7025
7026 @item -fstrict-overflow
7027 @opindex fstrict-overflow
7028 Allow the compiler to assume strict signed overflow rules, depending
7029 on the language being compiled.  For C (and C++) this means that
7030 overflow when doing arithmetic with signed numbers is undefined, which
7031 means that the compiler may assume that it will not happen.  This
7032 permits various optimizations.  For example, the compiler will assume
7033 that an expression like @code{i + 10 > i} will always be true for
7034 signed @code{i}.  This assumption is only valid if signed overflow is
7035 undefined, as the expression is false if @code{i + 10} overflows when
7036 using twos complement arithmetic.  When this option is in effect any
7037 attempt to determine whether an operation on signed numbers will
7038 overflow must be written carefully to not actually involve overflow.
7039
7040 This option also allows the compiler to assume strict pointer
7041 semantics: given a pointer to an object, if adding an offset to that
7042 pointer does not produce a pointer to the same object, the addition is
7043 undefined.  This permits the compiler to conclude that @code{p + u >
7044 p} is always true for a pointer @code{p} and unsigned integer
7045 @code{u}.  This assumption is only valid because pointer wraparound is
7046 undefined, as the expression is false if @code{p + u} overflows using
7047 twos complement arithmetic.
7048
7049 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
7050 that integer signed overflow is fully defined: it wraps.  When
7051 @option{-fwrapv} is used, there is no difference between
7052 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
7053 integers.  With @option{-fwrapv} certain types of overflow are
7054 permitted.  For example, if the compiler gets an overflow when doing
7055 arithmetic on constants, the overflowed value can still be used with
7056 @option{-fwrapv}, but not otherwise.
7057
7058 The @option{-fstrict-overflow} option is enabled at levels
7059 @option{-O2}, @option{-O3}, @option{-Os}.
7060
7061 @item -falign-functions
7062 @itemx -falign-functions=@var{n}
7063 @opindex falign-functions
7064 Align the start of functions to the next power-of-two greater than
7065 @var{n}, skipping up to @var{n} bytes.  For instance,
7066 @option{-falign-functions=32} aligns functions to the next 32-byte
7067 boundary, but @option{-falign-functions=24} would align to the next
7068 32-byte boundary only if this can be done by skipping 23 bytes or less.
7069
7070 @option{-fno-align-functions} and @option{-falign-functions=1} are
7071 equivalent and mean that functions will not be aligned.
7072
7073 Some assemblers only support this flag when @var{n} is a power of two;
7074 in that case, it is rounded up.
7075
7076 If @var{n} is not specified or is zero, use a machine-dependent default.
7077
7078 Enabled at levels @option{-O2}, @option{-O3}.
7079
7080 @item -falign-labels
7081 @itemx -falign-labels=@var{n}
7082 @opindex falign-labels
7083 Align all branch targets to a power-of-two boundary, skipping up to
7084 @var{n} bytes like @option{-falign-functions}.  This option can easily
7085 make code slower, because it must insert dummy operations for when the
7086 branch target is reached in the usual flow of the code.
7087
7088 @option{-fno-align-labels} and @option{-falign-labels=1} are
7089 equivalent and mean that labels will not be aligned.
7090
7091 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
7092 are greater than this value, then their values are used instead.
7093
7094 If @var{n} is not specified or is zero, use a machine-dependent default
7095 which is very likely to be @samp{1}, meaning no alignment.
7096
7097 Enabled at levels @option{-O2}, @option{-O3}.
7098
7099 @item -falign-loops
7100 @itemx -falign-loops=@var{n}
7101 @opindex falign-loops
7102 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
7103 like @option{-falign-functions}.  The hope is that the loop will be
7104 executed many times, which will make up for any execution of the dummy
7105 operations.
7106
7107 @option{-fno-align-loops} and @option{-falign-loops=1} are
7108 equivalent and mean that loops will not be aligned.
7109
7110 If @var{n} is not specified or is zero, use a machine-dependent default.
7111
7112 Enabled at levels @option{-O2}, @option{-O3}.
7113
7114 @item -falign-jumps
7115 @itemx -falign-jumps=@var{n}
7116 @opindex falign-jumps
7117 Align branch targets to a power-of-two boundary, for branch targets
7118 where the targets can only be reached by jumping, skipping up to @var{n}
7119 bytes like @option{-falign-functions}.  In this case, no dummy operations
7120 need be executed.
7121
7122 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
7123 equivalent and mean that loops will not be aligned.
7124
7125 If @var{n} is not specified or is zero, use a machine-dependent default.
7126
7127 Enabled at levels @option{-O2}, @option{-O3}.
7128
7129 @item -funit-at-a-time
7130 @opindex funit-at-a-time
7131 This option is left for compatibility reasons. @option{-funit-at-a-time}
7132 has no effect, while @option{-fno-unit-at-a-time} implies
7133 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
7134
7135 Enabled by default.
7136
7137 @item -fno-toplevel-reorder
7138 @opindex fno-toplevel-reorder
7139 Do not reorder top-level functions, variables, and @code{asm}
7140 statements.  Output them in the same order that they appear in the
7141 input file.  When this option is used, unreferenced static variables
7142 will not be removed.  This option is intended to support existing code
7143 which relies on a particular ordering.  For new code, it is better to
7144 use attributes.
7145
7146 Enabled at level @option{-O0}.  When disabled explicitly, it also imply
7147 @option{-fno-section-anchors} that is otherwise enabled at @option{-O0} on some
7148 targets.
7149
7150 @item -fweb
7151 @opindex fweb
7152 Constructs webs as commonly used for register allocation purposes and assign
7153 each web individual pseudo register.  This allows the register allocation pass
7154 to operate on pseudos directly, but also strengthens several other optimization
7155 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
7156 however, make debugging impossible, since variables will no longer stay in a
7157 ``home register''.
7158
7159 Enabled by default with @option{-funroll-loops}.
7160
7161 @item -fwhole-program
7162 @opindex fwhole-program
7163 Assume that the current compilation unit represents the whole program being
7164 compiled.  All public functions and variables with the exception of @code{main}
7165 and those merged by attribute @code{externally_visible} become static functions
7166 and in effect are optimized more aggressively by interprocedural optimizers.
7167 While this option is equivalent to proper use of the @code{static} keyword for
7168 programs consisting of a single file, in combination with option
7169 @option{-combine}, @option{-flto} or @option{-fwhopr} this flag can be used to
7170 compile many smaller scale programs since the functions and variables become
7171 local for the whole combined compilation unit, not for the single source file
7172 itself.
7173
7174 This option implies @option{-fwhole-file} for Fortran programs.
7175
7176 @item -flto
7177 @opindex flto
7178 This option runs the standard link-time optimizer.  When invoked
7179 with source code, it generates GIMPLE (one of GCC's internal
7180 representations) and writes it to special ELF sections in the object
7181 file.  When the object files are linked together, all the function
7182 bodies are read from these ELF sections and instantiated as if they
7183 had been part of the same translation unit.
7184
7185 To use the link-timer optimizer, @option{-flto} needs to be specified at
7186 compile time and during the final link.  For example,
7187
7188 @smallexample
7189 gcc -c -O2 -flto foo.c
7190 gcc -c -O2 -flto bar.c
7191 gcc -o myprog -flto -O2 foo.o bar.o
7192 @end smallexample
7193
7194 The first two invocations to GCC will save a bytecode representation
7195 of GIMPLE into special ELF sections inside @file{foo.o} and
7196 @file{bar.o}.  The final invocation will read the GIMPLE bytecode from
7197 @file{foo.o} and @file{bar.o}, merge the two files into a single
7198 internal image, and compile the result as usual.  Since both
7199 @file{foo.o} and @file{bar.o} are merged into a single image, this
7200 causes all the inter-procedural analyses and optimizations in GCC to
7201 work across the two files as if they were a single one.  This means,
7202 for example, that the inliner will be able to inline functions in
7203 @file{bar.o} into functions in @file{foo.o} and vice-versa.
7204
7205 Another (simpler) way to enable link-time optimization is,
7206
7207 @smallexample
7208 gcc -o myprog -flto -O2 foo.c bar.c
7209 @end smallexample
7210
7211 The above will generate bytecode for @file{foo.c} and @file{bar.c},
7212 merge them together into a single GIMPLE representation and optimize
7213 them as usual to produce @file{myprog}.
7214
7215 The only important thing to keep in mind is that to enable link-time
7216 optimizations the @option{-flto} flag needs to be passed to both the
7217 compile and the link commands.
7218
7219 Note that when a file is compiled with @option{-flto}, the generated
7220 object file will be larger than a regular object file because it will
7221 contain GIMPLE bytecodes and the usual final code.  This means that
7222 object files with LTO information can be linked as a normal object
7223 file.  So, in the previous example, if the final link is done with
7224
7225 @smallexample
7226 gcc -o myprog foo.o bar.o
7227 @end smallexample
7228
7229 The only difference will be that no inter-procedural optimizations
7230 will be applied to produce @file{myprog}.  The two object files
7231 @file{foo.o} and @file{bar.o} will be simply sent to the regular
7232 linker.
7233
7234 Additionally, the optimization flags used to compile individual files
7235 are not necessarily related to those used at link-time.  For instance,
7236
7237 @smallexample
7238 gcc -c -O0 -flto foo.c
7239 gcc -c -O0 -flto bar.c
7240 gcc -o myprog -flto -O3 foo.o bar.o
7241 @end smallexample
7242
7243 This will produce individual object files with unoptimized assembler
7244 code, but the resulting binary @file{myprog} will be optimized at
7245 @option{-O3}.  Now, if the final binary is generated without
7246 @option{-flto}, then @file{myprog} will not be optimized.
7247
7248 When producing the final binary with @option{-flto}, GCC will only
7249 apply link-time optimizations to those files that contain bytecode.
7250 Therefore, you can mix and match object files and libraries with
7251 GIMPLE bytecodes and final object code.  GCC will automatically select
7252 which files to optimize in LTO mode and which files to link without
7253 further processing.
7254
7255 There are some code generation flags that GCC will preserve when
7256 generating bytecodes, as they need to be used during the final link
7257 stage.  Currently, the following options are saved into the GIMPLE
7258 bytecode files: @option{-fPIC}, @option{-fcommon} and all the
7259 @option{-m} target flags.
7260
7261 At link time, these options are read-in and reapplied.  Note that the
7262 current implementation makes no attempt at recognizing conflicting
7263 values for these options.  If two or more files have a conflicting
7264 value (e.g., one file is compiled with @option{-fPIC} and another
7265 isn't), the compiler will simply use the last value read from the
7266 bytecode files.  It is recommended, then, that all the files
7267 participating in the same link be compiled with the same options.
7268
7269 Another feature of LTO is that it is possible to apply interprocedural
7270 optimizations on files written in different languages.  This requires
7271 some support in the language front end.  Currently, the C, C++ and
7272 Fortran front ends are capable of emitting GIMPLE bytecodes, so
7273 something like this should work
7274
7275 @smallexample
7276 gcc -c -flto foo.c
7277 g++ -c -flto bar.cc
7278 gfortran -c -flto baz.f90
7279 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
7280 @end smallexample
7281
7282 Notice that the final link is done with @command{g++} to get the C++
7283 runtime libraries and @option{-lgfortran} is added to get the Fortran
7284 runtime libraries.  In general, when mixing languages in LTO mode, you
7285 should use the same link command used when mixing languages in a
7286 regular (non-LTO) compilation.  This means that if your build process
7287 was mixing languages before, all you need to add is @option{-flto} to
7288 all the compile and link commands.
7289
7290 If object files containing GIMPLE bytecode are stored in a library
7291 archive, say @file{libfoo.a}, it is possible to extract and use them
7292 in an LTO link if you are using @command{gold} as the linker (which,
7293 in turn requires GCC to be configured with @option{--enable-gold}).
7294 To enable this feature, use the flag @option{-fuse-linker-plugin} at
7295 link-time:
7296
7297 @smallexample
7298 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
7299 @end smallexample
7300
7301 With the linker plugin enabled, @command{gold} will extract the needed
7302 GIMPLE files from @file{libfoo.a} and pass them on to the running GCC
7303 to make them part of the aggregated GIMPLE image to be optimized.
7304
7305 If you are not using @command{gold} and/or do not specify
7306 @option{-fuse-linker-plugin} then the objects inside @file{libfoo.a}
7307 will be extracted and linked as usual, but they will not participate
7308 in the LTO optimization process.
7309
7310 Link time optimizations do not require the presence of the whole
7311 program to operate.  If the program does not require any symbols to
7312 be exported, it is possible to combine @option{-flto} and
7313 @option{-fwhopr} with @option{-fwhole-program} to allow the
7314 interprocedural optimizers to use more aggressive assumptions which
7315 may lead to improved optimization opportunities.
7316
7317 Regarding portability: the current implementation of LTO makes no
7318 attempt at generating bytecode that can be ported between different
7319 types of hosts.  The bytecode files are versioned and there is a
7320 strict version check, so bytecode files generated in one version of
7321 GCC will not work with an older/newer version of GCC.
7322
7323 Link time optimization does not play well with generating debugging
7324 information.  Combining @option{-flto} or @option{-fwhopr} with
7325 @option{-g} is experimental.
7326
7327 This option is disabled by default.
7328
7329 @item -fwhopr
7330 @opindex fwhopr
7331 This option is identical in functionality to @option{-flto} but it
7332 differs in how the final link stage is executed.  Instead of loading
7333 all the function bodies in memory, the callgraph is analyzed and
7334 optimization decisions are made (whole program analysis or WPA). Once
7335 optimization decisions are made, the callgraph is partitioned and the
7336 different sections are compiled separately (local transformations or
7337 LTRANS)@.  This process allows optimizations on very large programs
7338 that otherwise would not fit in memory.  This option enables
7339 @option{-fwpa} and @option{-fltrans} automatically.
7340
7341 Disabled by default.
7342
7343 This option is experimental.
7344
7345 @item -fwpa
7346 @opindex fwpa
7347 This is an internal option used by GCC when compiling with
7348 @option{-fwhopr}.  You should never need to use it.
7349
7350 This option runs the link-time optimizer in the whole-program-analysis
7351 (WPA) mode, which reads in summary information from all inputs and
7352 performs a whole-program analysis based on summary information only.
7353 It generates object files for subsequent runs of the link-time
7354 optimizer where individual object files are optimized using both
7355 summary information from the WPA mode and the actual function bodies.
7356 It then drives the LTRANS phase.
7357
7358 Disabled by default.
7359
7360 @item -fltrans
7361 @opindex fltrans
7362 This is an internal option used by GCC when compiling with
7363 @option{-fwhopr}.  You should never need to use it.
7364
7365 This option runs the link-time optimizer in the local-transformation (LTRANS)
7366 mode, which reads in output from a previous run of the LTO in WPA mode.
7367 In the LTRANS mode, LTO optimizes an object and produces the final assembly.
7368
7369 Disabled by default.
7370
7371 @item -fltrans-output-list=@var{file}
7372 @opindex fltrans-output-list
7373 This is an internal option used by GCC when compiling with
7374 @option{-fwhopr}.  You should never need to use it.
7375
7376 This option specifies a file to which the names of LTRANS output files are
7377 written.  This option is only meaningful in conjunction with @option{-fwpa}.
7378
7379 Disabled by default.
7380
7381 @item -flto-compression-level=@var{n}
7382 This option specifies the level of compression used for intermediate
7383 language written to LTO object files, and is only meaningful in
7384 conjunction with LTO mode (@option{-fwhopr}, @option{-flto}).  Valid
7385 values are 0 (no compression) to 9 (maximum compression).  Values
7386 outside this range are clamped to either 0 or 9.  If the option is not
7387 given, a default balanced compression setting is used.
7388
7389 @item -flto-report
7390 Prints a report with internal details on the workings of the link-time
7391 optimizer.  The contents of this report vary from version to version,
7392 it is meant to be useful to GCC developers when processing object
7393 files in LTO mode (via @option{-fwhopr} or @option{-flto}).
7394
7395 Disabled by default.
7396
7397 @item -fuse-linker-plugin
7398 Enables the extraction of objects with GIMPLE bytecode information
7399 from library archives.  This option relies on features available only
7400 in @command{gold}, so to use this you must configure GCC with
7401 @option{--enable-gold}.  See @option{-flto} for a description on the
7402 effect of this flag and how to use it.
7403
7404 Disabled by default.
7405
7406 @item -fcprop-registers
7407 @opindex fcprop-registers
7408 After register allocation and post-register allocation instruction splitting,
7409 we perform a copy-propagation pass to try to reduce scheduling dependencies
7410 and occasionally eliminate the copy.
7411
7412 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7413
7414 @item -fprofile-correction
7415 @opindex fprofile-correction
7416 Profiles collected using an instrumented binary for multi-threaded programs may
7417 be inconsistent due to missed counter updates. When this option is specified,
7418 GCC will use heuristics to correct or smooth out such inconsistencies. By
7419 default, GCC will emit an error message when an inconsistent profile is detected.
7420
7421 @item -fprofile-dir=@var{path}
7422 @opindex fprofile-dir
7423
7424 Set the directory to search the profile data files in to @var{path}.
7425 This option affects only the profile data generated by
7426 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
7427 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
7428 and its related options.
7429 By default, GCC will use the current directory as @var{path}
7430 thus the profile data file will appear in the same directory as the object file.
7431
7432 @item -fprofile-generate
7433 @itemx -fprofile-generate=@var{path}
7434 @opindex fprofile-generate
7435
7436 Enable options usually used for instrumenting application to produce
7437 profile useful for later recompilation with profile feedback based
7438 optimization.  You must use @option{-fprofile-generate} both when
7439 compiling and when linking your program.
7440
7441 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
7442
7443 If @var{path} is specified, GCC will look at the @var{path} to find
7444 the profile feedback data files. See @option{-fprofile-dir}.
7445
7446 @item -fprofile-use
7447 @itemx -fprofile-use=@var{path}
7448 @opindex fprofile-use
7449 Enable profile feedback directed optimizations, and optimizations
7450 generally profitable only with profile feedback available.
7451
7452 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
7453 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
7454
7455 By default, GCC emits an error message if the feedback profiles do not
7456 match the source code.  This error can be turned into a warning by using
7457 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
7458 code.
7459
7460 If @var{path} is specified, GCC will look at the @var{path} to find
7461 the profile feedback data files. See @option{-fprofile-dir}.
7462 @end table
7463
7464 The following options control compiler behavior regarding floating
7465 point arithmetic.  These options trade off between speed and
7466 correctness.  All must be specifically enabled.
7467
7468 @table @gcctabopt
7469 @item -ffloat-store
7470 @opindex ffloat-store
7471 Do not store floating point variables in registers, and inhibit other
7472 options that might change whether a floating point value is taken from a
7473 register or memory.
7474
7475 @cindex floating point precision
7476 This option prevents undesirable excess precision on machines such as
7477 the 68000 where the floating registers (of the 68881) keep more
7478 precision than a @code{double} is supposed to have.  Similarly for the
7479 x86 architecture.  For most programs, the excess precision does only
7480 good, but a few programs rely on the precise definition of IEEE floating
7481 point.  Use @option{-ffloat-store} for such programs, after modifying
7482 them to store all pertinent intermediate computations into variables.
7483
7484 @item -fexcess-precision=@var{style}
7485 @opindex fexcess-precision
7486 This option allows further control over excess precision on machines
7487 where floating-point registers have more precision than the IEEE
7488 @code{float} and @code{double} types and the processor does not
7489 support operations rounding to those types.  By default,
7490 @option{-fexcess-precision=fast} is in effect; this means that
7491 operations are carried out in the precision of the registers and that
7492 it is unpredictable when rounding to the types specified in the source
7493 code takes place.  When compiling C, if
7494 @option{-fexcess-precision=standard} is specified then excess
7495 precision will follow the rules specified in ISO C99; in particular,
7496 both casts and assignments cause values to be rounded to their
7497 semantic types (whereas @option{-ffloat-store} only affects
7498 assignments).  This option is enabled by default for C if a strict
7499 conformance option such as @option{-std=c99} is used.
7500
7501 @opindex mfpmath
7502 @option{-fexcess-precision=standard} is not implemented for languages
7503 other than C, and has no effect if
7504 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
7505 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
7506 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
7507 semantics apply without excess precision, and in the latter, rounding
7508 is unpredictable.
7509
7510 @item -ffast-math
7511 @opindex ffast-math
7512 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
7513 @option{-ffinite-math-only}, @option{-fno-rounding-math},
7514 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
7515
7516 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
7517
7518 This option is not turned on by any @option{-O} option since
7519 it can result in incorrect output for programs which depend on
7520 an exact implementation of IEEE or ISO rules/specifications for
7521 math functions. It may, however, yield faster code for programs
7522 that do not require the guarantees of these specifications.
7523
7524 @item -fno-math-errno
7525 @opindex fno-math-errno
7526 Do not set ERRNO after calling math functions that are executed
7527 with a single instruction, e.g., sqrt.  A program that relies on
7528 IEEE exceptions for math error handling may want to use this flag
7529 for speed while maintaining IEEE arithmetic compatibility.
7530
7531 This option is not turned on by any @option{-O} option since
7532 it can result in incorrect output for programs which depend on
7533 an exact implementation of IEEE or ISO rules/specifications for
7534 math functions. It may, however, yield faster code for programs
7535 that do not require the guarantees of these specifications.
7536
7537 The default is @option{-fmath-errno}.
7538
7539 On Darwin systems, the math library never sets @code{errno}.  There is
7540 therefore no reason for the compiler to consider the possibility that
7541 it might, and @option{-fno-math-errno} is the default.
7542
7543 @item -funsafe-math-optimizations
7544 @opindex funsafe-math-optimizations
7545
7546 Allow optimizations for floating-point arithmetic that (a) assume
7547 that arguments and results are valid and (b) may violate IEEE or
7548 ANSI standards.  When used at link-time, it may include libraries
7549 or startup files that change the default FPU control word or other
7550 similar optimizations.
7551
7552 This option is not turned on by any @option{-O} option since
7553 it can result in incorrect output for programs which depend on
7554 an exact implementation of IEEE or ISO rules/specifications for
7555 math functions. It may, however, yield faster code for programs
7556 that do not require the guarantees of these specifications.
7557 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
7558 @option{-fassociative-math} and @option{-freciprocal-math}.
7559
7560 The default is @option{-fno-unsafe-math-optimizations}.
7561
7562 @item -fassociative-math
7563 @opindex fassociative-math
7564
7565 Allow re-association of operands in series of floating-point operations.
7566 This violates the ISO C and C++ language standard by possibly changing
7567 computation result.  NOTE: re-ordering may change the sign of zero as
7568 well as ignore NaNs and inhibit or create underflow or overflow (and
7569 thus cannot be used on a code which relies on rounding behavior like
7570 @code{(x + 2**52) - 2**52)}.  May also reorder floating-point comparisons
7571 and thus may not be used when ordered comparisons are required.
7572 This option requires that both @option{-fno-signed-zeros} and
7573 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
7574 much sense with @option{-frounding-math}. For Fortran the option
7575 is automatically enabled when both @option{-fno-signed-zeros} and
7576 @option{-fno-trapping-math} are in effect.
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 max-vartrack-size
8469 Sets a maximum number of hash table slots to use during variable
8470 tracking dataflow analysis of any function.  If this limit is exceeded
8471 with variable tracking at assignments enabled, analysis for that
8472 function is retried without it, after removing all debug insns from
8473 the function.  If the limit is exceeded even without debug insns, var
8474 tracking analysis is completely disabled for the function.  Setting
8475 the parameter to zero makes it unlimited.
8476
8477 @item min-nondebug-insn-uid
8478 Use uids starting at this parameter for nondebug insns.  The range below
8479 the parameter is reserved exclusively for debug insns created by
8480 @option{-fvar-tracking-assignments}, but debug insns may get
8481 (non-overlapping) uids above it if the reserved range is exhausted.
8482
8483 @item ipa-sra-ptr-growth-factor
8484 IPA-SRA will replace a pointer to an aggregate with one or more new
8485 parameters only when their cumulative size is less or equal to
8486 @option{ipa-sra-ptr-growth-factor} times the size of the original
8487 pointer parameter.
8488
8489 @end table
8490 @end table
8491
8492 @node Preprocessor Options
8493 @section Options Controlling the Preprocessor
8494 @cindex preprocessor options
8495 @cindex options, preprocessor
8496
8497 These options control the C preprocessor, which is run on each C source
8498 file before actual compilation.
8499
8500 If you use the @option{-E} option, nothing is done except preprocessing.
8501 Some of these options make sense only together with @option{-E} because
8502 they cause the preprocessor output to be unsuitable for actual
8503 compilation.
8504
8505 @table @gcctabopt
8506 @item -Wp,@var{option}
8507 @opindex Wp
8508 You can use @option{-Wp,@var{option}} to bypass the compiler driver
8509 and pass @var{option} directly through to the preprocessor.  If
8510 @var{option} contains commas, it is split into multiple options at the
8511 commas.  However, many options are modified, translated or interpreted
8512 by the compiler driver before being passed to the preprocessor, and
8513 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
8514 interface is undocumented and subject to change, so whenever possible
8515 you should avoid using @option{-Wp} and let the driver handle the
8516 options instead.
8517
8518 @item -Xpreprocessor @var{option}
8519 @opindex Xpreprocessor
8520 Pass @var{option} as an option to the preprocessor.  You can use this to
8521 supply system-specific preprocessor options which GCC does not know how to
8522 recognize.
8523
8524 If you want to pass an option that takes an argument, you must use
8525 @option{-Xpreprocessor} twice, once for the option and once for the argument.
8526 @end table
8527
8528 @include cppopts.texi
8529
8530 @node Assembler Options
8531 @section Passing Options to the Assembler
8532
8533 @c prevent bad page break with this line
8534 You can pass options to the assembler.
8535
8536 @table @gcctabopt
8537 @item -Wa,@var{option}
8538 @opindex Wa
8539 Pass @var{option} as an option to the assembler.  If @var{option}
8540 contains commas, it is split into multiple options at the commas.
8541
8542 @item -Xassembler @var{option}
8543 @opindex Xassembler
8544 Pass @var{option} as an option to the assembler.  You can use this to
8545 supply system-specific assembler options which GCC does not know how to
8546 recognize.
8547
8548 If you want to pass an option that takes an argument, you must use
8549 @option{-Xassembler} twice, once for the option and once for the argument.
8550
8551 @end table
8552
8553 @node Link Options
8554 @section Options for Linking
8555 @cindex link options
8556 @cindex options, linking
8557
8558 These options come into play when the compiler links object files into
8559 an executable output file.  They are meaningless if the compiler is
8560 not doing a link step.
8561
8562 @table @gcctabopt
8563 @cindex file names
8564 @item @var{object-file-name}
8565 A file name that does not end in a special recognized suffix is
8566 considered to name an object file or library.  (Object files are
8567 distinguished from libraries by the linker according to the file
8568 contents.)  If linking is done, these object files are used as input
8569 to the linker.
8570
8571 @item -c
8572 @itemx -S
8573 @itemx -E
8574 @opindex c
8575 @opindex S
8576 @opindex E
8577 If any of these options is used, then the linker is not run, and
8578 object file names should not be used as arguments.  @xref{Overall
8579 Options}.
8580
8581 @cindex Libraries
8582 @item -l@var{library}
8583 @itemx -l @var{library}
8584 @opindex l
8585 Search the library named @var{library} when linking.  (The second
8586 alternative with the library as a separate argument is only for
8587 POSIX compliance and is not recommended.)
8588
8589 It makes a difference where in the command you write this option; the
8590 linker searches and processes libraries and object files in the order they
8591 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
8592 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
8593 to functions in @samp{z}, those functions may not be loaded.
8594
8595 The linker searches a standard list of directories for the library,
8596 which is actually a file named @file{lib@var{library}.a}.  The linker
8597 then uses this file as if it had been specified precisely by name.
8598
8599 The directories searched include several standard system directories
8600 plus any that you specify with @option{-L}.
8601
8602 Normally the files found this way are library files---archive files
8603 whose members are object files.  The linker handles an archive file by
8604 scanning through it for members which define symbols that have so far
8605 been referenced but not defined.  But if the file that is found is an
8606 ordinary object file, it is linked in the usual fashion.  The only
8607 difference between using an @option{-l} option and specifying a file name
8608 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
8609 and searches several directories.
8610
8611 @item -lobjc
8612 @opindex lobjc
8613 You need this special case of the @option{-l} option in order to
8614 link an Objective-C or Objective-C++ program.
8615
8616 @item -nostartfiles
8617 @opindex nostartfiles
8618 Do not use the standard system startup files when linking.
8619 The standard system libraries are used normally, unless @option{-nostdlib}
8620 or @option{-nodefaultlibs} is used.
8621
8622 @item -nodefaultlibs
8623 @opindex nodefaultlibs
8624 Do not use the standard system libraries when linking.
8625 Only the libraries you specify will be passed to the linker, options
8626 specifying linkage of the system libraries, such as @code{-static-libgcc}
8627 or @code{-shared-libgcc}, will be ignored.
8628 The standard startup files are used normally, unless @option{-nostartfiles}
8629 is used.  The compiler may generate calls to @code{memcmp},
8630 @code{memset}, @code{memcpy} and @code{memmove}.
8631 These entries are usually resolved by entries in
8632 libc.  These entry points should be supplied through some other
8633 mechanism when this option is specified.
8634
8635 @item -nostdlib
8636 @opindex nostdlib
8637 Do not use the standard system startup files or libraries when linking.
8638 No startup files and only the libraries you specify will be passed to
8639 the linker, options specifying linkage of the system libraries, such as
8640 @code{-static-libgcc} or @code{-shared-libgcc}, will be ignored.
8641 The compiler may generate calls to @code{memcmp}, @code{memset},
8642 @code{memcpy} and @code{memmove}.
8643 These entries are usually resolved by entries in
8644 libc.  These entry points should be supplied through some other
8645 mechanism when this option is specified.
8646
8647 @cindex @option{-lgcc}, use with @option{-nostdlib}
8648 @cindex @option{-nostdlib} and unresolved references
8649 @cindex unresolved references and @option{-nostdlib}
8650 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
8651 @cindex @option{-nodefaultlibs} and unresolved references
8652 @cindex unresolved references and @option{-nodefaultlibs}
8653 One of the standard libraries bypassed by @option{-nostdlib} and
8654 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
8655 that GCC uses to overcome shortcomings of particular machines, or special
8656 needs for some languages.
8657 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
8658 Collection (GCC) Internals},
8659 for more discussion of @file{libgcc.a}.)
8660 In most cases, you need @file{libgcc.a} even when you want to avoid
8661 other standard libraries.  In other words, when you specify @option{-nostdlib}
8662 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
8663 This ensures that you have no unresolved references to internal GCC
8664 library subroutines.  (For example, @samp{__main}, used to ensure C++
8665 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
8666 GNU Compiler Collection (GCC) Internals}.)
8667
8668 @item -pie
8669 @opindex pie
8670 Produce a position independent executable on targets which support it.
8671 For predictable results, you must also specify the same set of options
8672 that were used to generate code (@option{-fpie}, @option{-fPIE},
8673 or model suboptions) when you specify this option.
8674
8675 @item -rdynamic
8676 @opindex rdynamic
8677 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
8678 that support it. This instructs the linker to add all symbols, not
8679 only used ones, to the dynamic symbol table. This option is needed
8680 for some uses of @code{dlopen} or to allow obtaining backtraces
8681 from within a program.
8682
8683 @item -s
8684 @opindex s
8685 Remove all symbol table and relocation information from the executable.
8686
8687 @item -static
8688 @opindex static
8689 On systems that support dynamic linking, this prevents linking with the shared
8690 libraries.  On other systems, this option has no effect.
8691
8692 @item -shared
8693 @opindex shared
8694 Produce a shared object which can then be linked with other objects to
8695 form an executable.  Not all systems support this option.  For predictable
8696 results, you must also specify the same set of options that were used to
8697 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
8698 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
8699 needs to build supplementary stub code for constructors to work.  On
8700 multi-libbed systems, @samp{gcc -shared} must select the correct support
8701 libraries to link against.  Failing to supply the correct flags may lead
8702 to subtle defects.  Supplying them in cases where they are not necessary
8703 is innocuous.}
8704
8705 @item -shared-libgcc
8706 @itemx -static-libgcc
8707 @opindex shared-libgcc
8708 @opindex static-libgcc
8709 On systems that provide @file{libgcc} as a shared library, these options
8710 force the use of either the shared or static version respectively.
8711 If no shared version of @file{libgcc} was built when the compiler was
8712 configured, these options have no effect.
8713
8714 There are several situations in which an application should use the
8715 shared @file{libgcc} instead of the static version.  The most common
8716 of these is when the application wishes to throw and catch exceptions
8717 across different shared libraries.  In that case, each of the libraries
8718 as well as the application itself should use the shared @file{libgcc}.
8719
8720 Therefore, the G++ and GCJ drivers automatically add
8721 @option{-shared-libgcc} whenever you build a shared library or a main
8722 executable, because C++ and Java programs typically use exceptions, so
8723 this is the right thing to do.
8724
8725 If, instead, you use the GCC driver to create shared libraries, you may
8726 find that they will not always be linked with the shared @file{libgcc}.
8727 If GCC finds, at its configuration time, that you have a non-GNU linker
8728 or a GNU linker that does not support option @option{--eh-frame-hdr},
8729 it will link the shared version of @file{libgcc} into shared libraries
8730 by default.  Otherwise, it will take advantage of the linker and optimize
8731 away the linking with the shared version of @file{libgcc}, linking with
8732 the static version of libgcc by default.  This allows exceptions to
8733 propagate through such shared libraries, without incurring relocation
8734 costs at library load time.
8735
8736 However, if a library or main executable is supposed to throw or catch
8737 exceptions, you must link it using the G++ or GCJ driver, as appropriate
8738 for the languages used in the program, or using the option
8739 @option{-shared-libgcc}, such that it is linked with the shared
8740 @file{libgcc}.
8741
8742 @item -static-libstdc++
8743 When the @command{g++} program is used to link a C++ program, it will
8744 normally automatically link against @option{libstdc++}.  If
8745 @file{libstdc++} is available as a shared library, and the
8746 @option{-static} option is not used, then this will link against the
8747 shared version of @file{libstdc++}.  That is normally fine.  However, it
8748 is sometimes useful to freeze the version of @file{libstdc++} used by
8749 the program without going all the way to a fully static link.  The
8750 @option{-static-libstdc++} option directs the @command{g++} driver to
8751 link @file{libstdc++} statically, without necessarily linking other
8752 libraries statically.
8753
8754 @item -symbolic
8755 @opindex symbolic
8756 Bind references to global symbols when building a shared object.  Warn
8757 about any unresolved references (unless overridden by the link editor
8758 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
8759 this option.
8760
8761 @item -T @var{script}
8762 @opindex T
8763 @cindex linker script
8764 Use @var{script} as the linker script.  This option is supported by most
8765 systems using the GNU linker.  On some targets, such as bare-board
8766 targets without an operating system, the @option{-T} option may be required
8767 when linking to avoid references to undefined symbols.
8768
8769 @item -Xlinker @var{option}
8770 @opindex Xlinker
8771 Pass @var{option} as an option to the linker.  You can use this to
8772 supply system-specific linker options which GCC does not know how to
8773 recognize.
8774
8775 If you want to pass an option that takes a separate argument, you must use
8776 @option{-Xlinker} twice, once for the option and once for the argument.
8777 For example, to pass @option{-assert definitions}, you must write
8778 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
8779 @option{-Xlinker "-assert definitions"}, because this passes the entire
8780 string as a single argument, which is not what the linker expects.
8781
8782 When using the GNU linker, it is usually more convenient to pass
8783 arguments to linker options using the @option{@var{option}=@var{value}}
8784 syntax than as separate arguments.  For example, you can specify
8785 @samp{-Xlinker -Map=output.map} rather than
8786 @samp{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
8787 this syntax for command-line options.
8788
8789 @item -Wl,@var{option}
8790 @opindex Wl
8791 Pass @var{option} as an option to the linker.  If @var{option} contains
8792 commas, it is split into multiple options at the commas.  You can use this
8793 syntax to pass an argument to the option.
8794 For example, @samp{-Wl,-Map,output.map} passes @samp{-Map output.map} to the
8795 linker.  When using the GNU linker, you can also get the same effect with
8796 @samp{-Wl,-Map=output.map}.
8797
8798 @item -u @var{symbol}
8799 @opindex u
8800 Pretend the symbol @var{symbol} is undefined, to force linking of
8801 library modules to define it.  You can use @option{-u} multiple times with
8802 different symbols to force loading of additional library modules.
8803 @end table
8804
8805 @node Directory Options
8806 @section Options for Directory Search
8807 @cindex directory options
8808 @cindex options, directory search
8809 @cindex search path
8810
8811 These options specify directories to search for header files, for
8812 libraries and for parts of the compiler:
8813
8814 @table @gcctabopt
8815 @item -I@var{dir}
8816 @opindex I
8817 Add the directory @var{dir} to the head of the list of directories to be
8818 searched for header files.  This can be used to override a system header
8819 file, substituting your own version, since these directories are
8820 searched before the system header file directories.  However, you should
8821 not use this option to add directories that contain vendor-supplied
8822 system header files (use @option{-isystem} for that).  If you use more than
8823 one @option{-I} option, the directories are scanned in left-to-right
8824 order; the standard system directories come after.
8825
8826 If a standard system include directory, or a directory specified with
8827 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
8828 option will be ignored.  The directory will still be searched but as a
8829 system directory at its normal position in the system include chain.
8830 This is to ensure that GCC's procedure to fix buggy system headers and
8831 the ordering for the include_next directive are not inadvertently changed.
8832 If you really need to change the search order for system directories,
8833 use the @option{-nostdinc} and/or @option{-isystem} options.
8834
8835 @item -iquote@var{dir}
8836 @opindex iquote
8837 Add the directory @var{dir} to the head of the list of directories to
8838 be searched for header files only for the case of @samp{#include
8839 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
8840 otherwise just like @option{-I}.
8841
8842 @item -L@var{dir}
8843 @opindex L
8844 Add directory @var{dir} to the list of directories to be searched
8845 for @option{-l}.
8846
8847 @item -B@var{prefix}
8848 @opindex B
8849 This option specifies where to find the executables, libraries,
8850 include files, and data files of the compiler itself.
8851
8852 The compiler driver program runs one or more of the subprograms
8853 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
8854 @var{prefix} as a prefix for each program it tries to run, both with and
8855 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
8856
8857 For each subprogram to be run, the compiler driver first tries the
8858 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
8859 was not specified, the driver tries two standard prefixes, which are
8860 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
8861 those results in a file name that is found, the unmodified program
8862 name is searched for using the directories specified in your
8863 @env{PATH} environment variable.
8864
8865 The compiler will check to see if the path provided by the @option{-B}
8866 refers to a directory, and if necessary it will add a directory
8867 separator character at the end of the path.
8868
8869 @option{-B} prefixes that effectively specify directory names also apply
8870 to libraries in the linker, because the compiler translates these
8871 options into @option{-L} options for the linker.  They also apply to
8872 includes files in the preprocessor, because the compiler translates these
8873 options into @option{-isystem} options for the preprocessor.  In this case,
8874 the compiler appends @samp{include} to the prefix.
8875
8876 The run-time support file @file{libgcc.a} can also be searched for using
8877 the @option{-B} prefix, if needed.  If it is not found there, the two
8878 standard prefixes above are tried, and that is all.  The file is left
8879 out of the link if it is not found by those means.
8880
8881 Another way to specify a prefix much like the @option{-B} prefix is to use
8882 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
8883 Variables}.
8884
8885 As a special kludge, if the path provided by @option{-B} is
8886 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
8887 9, then it will be replaced by @file{[dir/]include}.  This is to help
8888 with boot-strapping the compiler.
8889
8890 @item -specs=@var{file}
8891 @opindex specs
8892 Process @var{file} after the compiler reads in the standard @file{specs}
8893 file, in order to override the defaults that the @file{gcc} driver
8894 program uses when determining what switches to pass to @file{cc1},
8895 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
8896 @option{-specs=@var{file}} can be specified on the command line, and they
8897 are processed in order, from left to right.
8898
8899 @item --sysroot=@var{dir}
8900 @opindex sysroot
8901 Use @var{dir} as the logical root directory for headers and libraries.
8902 For example, if the compiler would normally search for headers in
8903 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
8904 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
8905
8906 If you use both this option and the @option{-isysroot} option, then
8907 the @option{--sysroot} option will apply to libraries, but the
8908 @option{-isysroot} option will apply to header files.
8909
8910 The GNU linker (beginning with version 2.16) has the necessary support
8911 for this option.  If your linker does not support this option, the
8912 header file aspect of @option{--sysroot} will still work, but the
8913 library aspect will not.
8914
8915 @item -I-
8916 @opindex I-
8917 This option has been deprecated.  Please use @option{-iquote} instead for
8918 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
8919 Any directories you specify with @option{-I} options before the @option{-I-}
8920 option are searched only for the case of @samp{#include "@var{file}"};
8921 they are not searched for @samp{#include <@var{file}>}.
8922
8923 If additional directories are specified with @option{-I} options after
8924 the @option{-I-}, these directories are searched for all @samp{#include}
8925 directives.  (Ordinarily @emph{all} @option{-I} directories are used
8926 this way.)
8927
8928 In addition, the @option{-I-} option inhibits the use of the current
8929 directory (where the current input file came from) as the first search
8930 directory for @samp{#include "@var{file}"}.  There is no way to
8931 override this effect of @option{-I-}.  With @option{-I.} you can specify
8932 searching the directory which was current when the compiler was
8933 invoked.  That is not exactly the same as what the preprocessor does
8934 by default, but it is often satisfactory.
8935
8936 @option{-I-} does not inhibit the use of the standard system directories
8937 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
8938 independent.
8939 @end table
8940
8941 @c man end
8942
8943 @node Spec Files
8944 @section Specifying subprocesses and the switches to pass to them
8945 @cindex Spec Files
8946
8947 @command{gcc} is a driver program.  It performs its job by invoking a
8948 sequence of other programs to do the work of compiling, assembling and
8949 linking.  GCC interprets its command-line parameters and uses these to
8950 deduce which programs it should invoke, and which command-line options
8951 it ought to place on their command lines.  This behavior is controlled
8952 by @dfn{spec strings}.  In most cases there is one spec string for each
8953 program that GCC can invoke, but a few programs have multiple spec
8954 strings to control their behavior.  The spec strings built into GCC can
8955 be overridden by using the @option{-specs=} command-line switch to specify
8956 a spec file.
8957
8958 @dfn{Spec files} are plaintext files that are used to construct spec
8959 strings.  They consist of a sequence of directives separated by blank
8960 lines.  The type of directive is determined by the first non-whitespace
8961 character on the line and it can be one of the following:
8962
8963 @table @code
8964 @item %@var{command}
8965 Issues a @var{command} to the spec file processor.  The commands that can
8966 appear here are:
8967
8968 @table @code
8969 @item %include <@var{file}>
8970 @cindex %include
8971 Search for @var{file} and insert its text at the current point in the
8972 specs file.
8973
8974 @item %include_noerr <@var{file}>
8975 @cindex %include_noerr
8976 Just like @samp{%include}, but do not generate an error message if the include
8977 file cannot be found.
8978
8979 @item %rename @var{old_name} @var{new_name}
8980 @cindex %rename
8981 Rename the spec string @var{old_name} to @var{new_name}.
8982
8983 @end table
8984
8985 @item *[@var{spec_name}]:
8986 This tells the compiler to create, override or delete the named spec
8987 string.  All lines after this directive up to the next directive or
8988 blank line are considered to be the text for the spec string.  If this
8989 results in an empty string then the spec will be deleted.  (Or, if the
8990 spec did not exist, then nothing will happened.)  Otherwise, if the spec
8991 does not currently exist a new spec will be created.  If the spec does
8992 exist then its contents will be overridden by the text of this
8993 directive, unless the first character of that text is the @samp{+}
8994 character, in which case the text will be appended to the spec.
8995
8996 @item [@var{suffix}]:
8997 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
8998 and up to the next directive or blank line are considered to make up the
8999 spec string for the indicated suffix.  When the compiler encounters an
9000 input file with the named suffix, it will processes the spec string in
9001 order to work out how to compile that file.  For example:
9002
9003 @smallexample
9004 .ZZ:
9005 z-compile -input %i
9006 @end smallexample
9007
9008 This says that any input file whose name ends in @samp{.ZZ} should be
9009 passed to the program @samp{z-compile}, which should be invoked with the
9010 command-line switch @option{-input} and with the result of performing the
9011 @samp{%i} substitution.  (See below.)
9012
9013 As an alternative to providing a spec string, the text that follows a
9014 suffix directive can be one of the following:
9015
9016 @table @code
9017 @item @@@var{language}
9018 This says that the suffix is an alias for a known @var{language}.  This is
9019 similar to using the @option{-x} command-line switch to GCC to specify a
9020 language explicitly.  For example:
9021
9022 @smallexample
9023 .ZZ:
9024 @@c++
9025 @end smallexample
9026
9027 Says that .ZZ files are, in fact, C++ source files.
9028
9029 @item #@var{name}
9030 This causes an error messages saying:
9031
9032 @smallexample
9033 @var{name} compiler not installed on this system.
9034 @end smallexample
9035 @end table
9036
9037 GCC already has an extensive list of suffixes built into it.
9038 This directive will add an entry to the end of the list of suffixes, but
9039 since the list is searched from the end backwards, it is effectively
9040 possible to override earlier entries using this technique.
9041
9042 @end table
9043
9044 GCC has the following spec strings built into it.  Spec files can
9045 override these strings or create their own.  Note that individual
9046 targets can also add their own spec strings to this list.
9047
9048 @smallexample
9049 asm          Options to pass to the assembler
9050 asm_final    Options to pass to the assembler post-processor
9051 cpp          Options to pass to the C preprocessor
9052 cc1          Options to pass to the C compiler
9053 cc1plus      Options to pass to the C++ compiler
9054 endfile      Object files to include at the end of the link
9055 link         Options to pass to the linker
9056 lib          Libraries to include on the command line to the linker
9057 libgcc       Decides which GCC support library to pass to the linker
9058 linker       Sets the name of the linker
9059 predefines   Defines to be passed to the C preprocessor
9060 signed_char  Defines to pass to CPP to say whether @code{char} is signed
9061              by default
9062 startfile    Object files to include at the start of the link
9063 @end smallexample
9064
9065 Here is a small example of a spec file:
9066
9067 @smallexample
9068 %rename lib                 old_lib
9069
9070 *lib:
9071 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
9072 @end smallexample
9073
9074 This example renames the spec called @samp{lib} to @samp{old_lib} and
9075 then overrides the previous definition of @samp{lib} with a new one.
9076 The new definition adds in some extra command-line options before
9077 including the text of the old definition.
9078
9079 @dfn{Spec strings} are a list of command-line options to be passed to their
9080 corresponding program.  In addition, the spec strings can contain
9081 @samp{%}-prefixed sequences to substitute variable text or to
9082 conditionally insert text into the command line.  Using these constructs
9083 it is possible to generate quite complex command lines.
9084
9085 Here is a table of all defined @samp{%}-sequences for spec
9086 strings.  Note that spaces are not generated automatically around the
9087 results of expanding these sequences.  Therefore you can concatenate them
9088 together or combine them with constant text in a single argument.
9089
9090 @table @code
9091 @item %%
9092 Substitute one @samp{%} into the program name or argument.
9093
9094 @item %i
9095 Substitute the name of the input file being processed.
9096
9097 @item %b
9098 Substitute the basename of the input file being processed.
9099 This is the substring up to (and not including) the last period
9100 and not including the directory.
9101
9102 @item %B
9103 This is the same as @samp{%b}, but include the file suffix (text after
9104 the last period).
9105
9106 @item %d
9107 Marks the argument containing or following the @samp{%d} as a
9108 temporary file name, so that that file will be deleted if GCC exits
9109 successfully.  Unlike @samp{%g}, this contributes no text to the
9110 argument.
9111
9112 @item %g@var{suffix}
9113 Substitute a file name that has suffix @var{suffix} and is chosen
9114 once per compilation, and mark the argument in the same way as
9115 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
9116 name is now chosen in a way that is hard to predict even when previously
9117 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
9118 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
9119 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
9120 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
9121 was simply substituted with a file name chosen once per compilation,
9122 without regard to any appended suffix (which was therefore treated
9123 just like ordinary text), making such attacks more likely to succeed.
9124
9125 @item %u@var{suffix}
9126 Like @samp{%g}, but generates a new temporary file name even if
9127 @samp{%u@var{suffix}} was already seen.
9128
9129 @item %U@var{suffix}
9130 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
9131 new one if there is no such last file name.  In the absence of any
9132 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
9133 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
9134 would involve the generation of two distinct file names, one
9135 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
9136 simply substituted with a file name chosen for the previous @samp{%u},
9137 without regard to any appended suffix.
9138
9139 @item %j@var{suffix}
9140 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
9141 writable, and if save-temps is off; otherwise, substitute the name
9142 of a temporary file, just like @samp{%u}.  This temporary file is not
9143 meant for communication between processes, but rather as a junk
9144 disposal mechanism.
9145
9146 @item %|@var{suffix}
9147 @itemx %m@var{suffix}
9148 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
9149 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
9150 all.  These are the two most common ways to instruct a program that it
9151 should read from standard input or write to standard output.  If you
9152 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
9153 construct: see for example @file{f/lang-specs.h}.
9154
9155 @item %.@var{SUFFIX}
9156 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
9157 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
9158 terminated by the next space or %.
9159
9160 @item %w
9161 Marks the argument containing or following the @samp{%w} as the
9162 designated output file of this compilation.  This puts the argument
9163 into the sequence of arguments that @samp{%o} will substitute later.
9164
9165 @item %o
9166 Substitutes the names of all the output files, with spaces
9167 automatically placed around them.  You should write spaces
9168 around the @samp{%o} as well or the results are undefined.
9169 @samp{%o} is for use in the specs for running the linker.
9170 Input files whose names have no recognized suffix are not compiled
9171 at all, but they are included among the output files, so they will
9172 be linked.
9173
9174 @item %O
9175 Substitutes the suffix for object files.  Note that this is
9176 handled specially when it immediately follows @samp{%g, %u, or %U},
9177 because of the need for those to form complete file names.  The
9178 handling is such that @samp{%O} is treated exactly as if it had already
9179 been substituted, except that @samp{%g, %u, and %U} do not currently
9180 support additional @var{suffix} characters following @samp{%O} as they would
9181 following, for example, @samp{.o}.
9182
9183 @item %p
9184 Substitutes the standard macro predefinitions for the
9185 current target machine.  Use this when running @code{cpp}.
9186
9187 @item %P
9188 Like @samp{%p}, but puts @samp{__} before and after the name of each
9189 predefined macro, except for macros that start with @samp{__} or with
9190 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
9191 C@.
9192
9193 @item %I
9194 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
9195 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
9196 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
9197 and @option{-imultilib} as necessary.
9198
9199 @item %s
9200 Current argument is the name of a library or startup file of some sort.
9201 Search for that file in a standard list of directories and substitute
9202 the full name found.  The current working directory is included in the
9203 list of directories scanned.
9204
9205 @item %T
9206 Current argument is the name of a linker script.  Search for that file
9207 in the current list of directories to scan for libraries. If the file
9208 is located insert a @option{--script} option into the command line
9209 followed by the full path name found.  If the file is not found then
9210 generate an error message.  Note: the current working directory is not
9211 searched.
9212
9213 @item %e@var{str}
9214 Print @var{str} as an error message.  @var{str} is terminated by a newline.
9215 Use this when inconsistent options are detected.
9216
9217 @item %(@var{name})
9218 Substitute the contents of spec string @var{name} at this point.
9219
9220 @item %[@var{name}]
9221 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
9222
9223 @item %x@{@var{option}@}
9224 Accumulate an option for @samp{%X}.
9225
9226 @item %X
9227 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
9228 spec string.
9229
9230 @item %Y
9231 Output the accumulated assembler options specified by @option{-Wa}.
9232
9233 @item %Z
9234 Output the accumulated preprocessor options specified by @option{-Wp}.
9235
9236 @item %a
9237 Process the @code{asm} spec.  This is used to compute the
9238 switches to be passed to the assembler.
9239
9240 @item %A
9241 Process the @code{asm_final} spec.  This is a spec string for
9242 passing switches to an assembler post-processor, if such a program is
9243 needed.
9244
9245 @item %l
9246 Process the @code{link} spec.  This is the spec for computing the
9247 command line passed to the linker.  Typically it will make use of the
9248 @samp{%L %G %S %D and %E} sequences.
9249
9250 @item %D
9251 Dump out a @option{-L} option for each directory that GCC believes might
9252 contain startup files.  If the target supports multilibs then the
9253 current multilib directory will be prepended to each of these paths.
9254
9255 @item %L
9256 Process the @code{lib} spec.  This is a spec string for deciding which
9257 libraries should be included on the command line to the linker.
9258
9259 @item %G
9260 Process the @code{libgcc} spec.  This is a spec string for deciding
9261 which GCC support library should be included on the command line to the linker.
9262
9263 @item %S
9264 Process the @code{startfile} spec.  This is a spec for deciding which
9265 object files should be the first ones passed to the linker.  Typically
9266 this might be a file named @file{crt0.o}.
9267
9268 @item %E
9269 Process the @code{endfile} spec.  This is a spec string that specifies
9270 the last object files that will be passed to the linker.
9271
9272 @item %C
9273 Process the @code{cpp} spec.  This is used to construct the arguments
9274 to be passed to the C preprocessor.
9275
9276 @item %1
9277 Process the @code{cc1} spec.  This is used to construct the options to be
9278 passed to the actual C compiler (@samp{cc1}).
9279
9280 @item %2
9281 Process the @code{cc1plus} spec.  This is used to construct the options to be
9282 passed to the actual C++ compiler (@samp{cc1plus}).
9283
9284 @item %*
9285 Substitute the variable part of a matched option.  See below.
9286 Note that each comma in the substituted string is replaced by
9287 a single space.
9288
9289 @item %<@code{S}
9290 Remove all occurrences of @code{-S} from the command line.  Note---this
9291 command is position dependent.  @samp{%} commands in the spec string
9292 before this one will see @code{-S}, @samp{%} commands in the spec string
9293 after this one will not.
9294
9295 @item %:@var{function}(@var{args})
9296 Call the named function @var{function}, passing it @var{args}.
9297 @var{args} is first processed as a nested spec string, then split
9298 into an argument vector in the usual fashion.  The function returns
9299 a string which is processed as if it had appeared literally as part
9300 of the current spec.
9301
9302 The following built-in spec functions are provided:
9303
9304 @table @code
9305 @item @code{getenv}
9306 The @code{getenv} spec function takes two arguments: an environment
9307 variable name and a string.  If the environment variable is not
9308 defined, a fatal error is issued.  Otherwise, the return value is the
9309 value of the environment variable concatenated with the string.  For
9310 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
9311
9312 @smallexample
9313 %:getenv(TOPDIR /include)
9314 @end smallexample
9315
9316 expands to @file{/path/to/top/include}.
9317
9318 @item @code{if-exists}
9319 The @code{if-exists} spec function takes one argument, an absolute
9320 pathname to a file.  If the file exists, @code{if-exists} returns the
9321 pathname.  Here is a small example of its usage:
9322
9323 @smallexample
9324 *startfile:
9325 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
9326 @end smallexample
9327
9328 @item @code{if-exists-else}
9329 The @code{if-exists-else} spec function is similar to the @code{if-exists}
9330 spec function, except that it takes two arguments.  The first argument is
9331 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
9332 returns the pathname.  If it does not exist, it returns the second argument.
9333 This way, @code{if-exists-else} can be used to select one file or another,
9334 based on the existence of the first.  Here is a small example of its usage:
9335
9336 @smallexample
9337 *startfile:
9338 crt0%O%s %:if-exists(crti%O%s) \
9339 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
9340 @end smallexample
9341
9342 @item @code{replace-outfile}
9343 The @code{replace-outfile} spec function takes two arguments.  It looks for the
9344 first argument in the outfiles array and replaces it with the second argument.  Here
9345 is a small example of its usage:
9346
9347 @smallexample
9348 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
9349 @end smallexample
9350
9351 @item @code{print-asm-header}
9352 The @code{print-asm-header} function takes no arguments and simply
9353 prints a banner like:
9354
9355 @smallexample
9356 Assembler options
9357 =================
9358
9359 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
9360 @end smallexample
9361
9362 It is used to separate compiler options from assembler options
9363 in the @option{--target-help} output.
9364 @end table
9365
9366 @item %@{@code{S}@}
9367 Substitutes the @code{-S} switch, if that switch was given to GCC@.
9368 If that switch was not specified, this substitutes nothing.  Note that
9369 the leading dash is omitted when specifying this option, and it is
9370 automatically inserted if the substitution is performed.  Thus the spec
9371 string @samp{%@{foo@}} would match the command-line option @option{-foo}
9372 and would output the command line option @option{-foo}.
9373
9374 @item %W@{@code{S}@}
9375 Like %@{@code{S}@} but mark last argument supplied within as a file to be
9376 deleted on failure.
9377
9378 @item %@{@code{S}*@}
9379 Substitutes all the switches specified to GCC whose names start
9380 with @code{-S}, but which also take an argument.  This is used for
9381 switches like @option{-o}, @option{-D}, @option{-I}, etc.
9382 GCC considers @option{-o foo} as being
9383 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
9384 text, including the space.  Thus two arguments would be generated.
9385
9386 @item %@{@code{S}*&@code{T}*@}
9387 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
9388 (the order of @code{S} and @code{T} in the spec is not significant).
9389 There can be any number of ampersand-separated variables; for each the
9390 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
9391
9392 @item %@{@code{S}:@code{X}@}
9393 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
9394
9395 @item %@{!@code{S}:@code{X}@}
9396 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
9397
9398 @item %@{@code{S}*:@code{X}@}
9399 Substitutes @code{X} if one or more switches whose names start with
9400 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
9401 once, no matter how many such switches appeared.  However, if @code{%*}
9402 appears somewhere in @code{X}, then @code{X} will be substituted once
9403 for each matching switch, with the @code{%*} replaced by the part of
9404 that switch that matched the @code{*}.
9405
9406 @item %@{.@code{S}:@code{X}@}
9407 Substitutes @code{X}, if processing a file with suffix @code{S}.
9408
9409 @item %@{!.@code{S}:@code{X}@}
9410 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
9411
9412 @item %@{,@code{S}:@code{X}@}
9413 Substitutes @code{X}, if processing a file for language @code{S}.
9414
9415 @item %@{!,@code{S}:@code{X}@}
9416 Substitutes @code{X}, if not processing a file for language @code{S}.
9417
9418 @item %@{@code{S}|@code{P}:@code{X}@}
9419 Substitutes @code{X} if either @code{-S} or @code{-P} was given to
9420 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
9421 @code{*} sequences as well, although they have a stronger binding than
9422 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
9423 alternatives must be starred, and only the first matching alternative
9424 is substituted.
9425
9426 For example, a spec string like this:
9427
9428 @smallexample
9429 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
9430 @end smallexample
9431
9432 will output the following command-line options from the following input
9433 command-line options:
9434
9435 @smallexample
9436 fred.c        -foo -baz
9437 jim.d         -bar -boggle
9438 -d fred.c     -foo -baz -boggle
9439 -d jim.d      -bar -baz -boggle
9440 @end smallexample
9441
9442 @item %@{S:X; T:Y; :D@}
9443
9444 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
9445 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
9446 be as many clauses as you need.  This may be combined with @code{.},
9447 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
9448
9449
9450 @end table
9451
9452 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
9453 construct may contain other nested @samp{%} constructs or spaces, or
9454 even newlines.  They are processed as usual, as described above.
9455 Trailing white space in @code{X} is ignored.  White space may also
9456 appear anywhere on the left side of the colon in these constructs,
9457 except between @code{.} or @code{*} and the corresponding word.
9458
9459 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
9460 handled specifically in these constructs.  If another value of
9461 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
9462 @option{-W} switch is found later in the command line, the earlier
9463 switch value is ignored, except with @{@code{S}*@} where @code{S} is
9464 just one letter, which passes all matching options.
9465
9466 The character @samp{|} at the beginning of the predicate text is used to
9467 indicate that a command should be piped to the following command, but
9468 only if @option{-pipe} is specified.
9469
9470 It is built into GCC which switches take arguments and which do not.
9471 (You might think it would be useful to generalize this to allow each
9472 compiler's spec to say which switches take arguments.  But this cannot
9473 be done in a consistent fashion.  GCC cannot even decide which input
9474 files have been specified without knowing which switches take arguments,
9475 and it must know which input files to compile in order to tell which
9476 compilers to run).
9477
9478 GCC also knows implicitly that arguments starting in @option{-l} are to be
9479 treated as compiler output files, and passed to the linker in their
9480 proper position among the other output files.
9481
9482 @c man begin OPTIONS
9483
9484 @node Target Options
9485 @section Specifying Target Machine and Compiler Version
9486 @cindex target options
9487 @cindex cross compiling
9488 @cindex specifying machine version
9489 @cindex specifying compiler version and target machine
9490 @cindex compiler version, specifying
9491 @cindex target machine, specifying
9492
9493 The usual way to run GCC is to run the executable called @file{gcc}, or
9494 @file{<machine>-gcc} when cross-compiling, or
9495 @file{<machine>-gcc-<version>} to run a version other than the one that
9496 was installed last.  Sometimes this is inconvenient, so GCC provides
9497 options that will switch to another cross-compiler or version.
9498
9499 @table @gcctabopt
9500 @item -b @var{machine}
9501 @opindex b
9502 The argument @var{machine} specifies the target machine for compilation.
9503
9504 The value to use for @var{machine} is the same as was specified as the
9505 machine type when configuring GCC as a cross-compiler.  For
9506 example, if a cross-compiler was configured with @samp{configure
9507 arm-elf}, meaning to compile for an arm processor with elf binaries,
9508 then you would specify @option{-b arm-elf} to run that cross compiler.
9509 Because there are other options beginning with @option{-b}, the
9510 configuration must contain a hyphen, or @option{-b} alone should be one
9511 argument followed by the configuration in the next argument.
9512
9513 @item -V @var{version}
9514 @opindex V
9515 The argument @var{version} specifies which version of GCC to run.
9516 This is useful when multiple versions are installed.  For example,
9517 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
9518 @end table
9519
9520 The @option{-V} and @option{-b} options work by running the
9521 @file{<machine>-gcc-<version>} executable, so there's no real reason to
9522 use them if you can just run that directly.
9523
9524 @node Submodel Options
9525 @section Hardware Models and Configurations
9526 @cindex submodel options
9527 @cindex specifying hardware config
9528 @cindex hardware models and configurations, specifying
9529 @cindex machine dependent options
9530
9531 Earlier we discussed the standard option @option{-b} which chooses among
9532 different installed compilers for completely different target
9533 machines, such as VAX vs.@: 68000 vs.@: 80386.
9534
9535 In addition, each of these target machine types can have its own
9536 special options, starting with @samp{-m}, to choose among various
9537 hardware models or configurations---for example, 68010 vs 68020,
9538 floating coprocessor or none.  A single installed version of the
9539 compiler can compile for any model or configuration, according to the
9540 options specified.
9541
9542 Some configurations of the compiler also support additional special
9543 options, usually for compatibility with other compilers on the same
9544 platform.
9545
9546 @c This list is ordered alphanumerically by subsection name.
9547 @c It should be the same order and spelling as these options are listed
9548 @c in Machine Dependent Options
9549
9550 @menu
9551 * ARC Options::
9552 * ARM Options::
9553 * AVR Options::
9554 * Blackfin Options::
9555 * CRIS Options::
9556 * CRX Options::
9557 * Darwin Options::
9558 * DEC Alpha Options::
9559 * DEC Alpha/VMS Options::
9560 * FR30 Options::
9561 * FRV Options::
9562 * GNU/Linux Options::
9563 * H8/300 Options::
9564 * HPPA Options::
9565 * i386 and x86-64 Options::
9566 * i386 and x86-64 Windows Options::
9567 * IA-64 Options::
9568 * IA-64/VMS Options::
9569 * LM32 Options::
9570 * M32C Options::
9571 * M32R/D Options::
9572 * M680x0 Options::
9573 * M68hc1x Options::
9574 * MCore Options::
9575 * MeP Options::
9576 * MIPS Options::
9577 * MMIX Options::
9578 * MN10300 Options::
9579 * PDP-11 Options::
9580 * picoChip Options::
9581 * PowerPC Options::
9582 * RS/6000 and PowerPC Options::
9583 * RX Options::
9584 * S/390 and zSeries Options::
9585 * Score Options::
9586 * SH Options::
9587 * SPARC Options::
9588 * SPU Options::
9589 * System V Options::
9590 * V850 Options::
9591 * VAX Options::
9592 * VxWorks Options::
9593 * x86-64 Options::
9594 * Xstormy16 Options::
9595 * Xtensa Options::
9596 * zSeries Options::
9597 @end menu
9598
9599 @node ARC Options
9600 @subsection ARC Options
9601 @cindex ARC Options
9602
9603 These options are defined for ARC implementations:
9604
9605 @table @gcctabopt
9606 @item -EL
9607 @opindex EL
9608 Compile code for little endian mode.  This is the default.
9609
9610 @item -EB
9611 @opindex EB
9612 Compile code for big endian mode.
9613
9614 @item -mmangle-cpu
9615 @opindex mmangle-cpu
9616 Prepend the name of the cpu to all public symbol names.
9617 In multiple-processor systems, there are many ARC variants with different
9618 instruction and register set characteristics.  This flag prevents code
9619 compiled for one cpu to be linked with code compiled for another.
9620 No facility exists for handling variants that are ``almost identical''.
9621 This is an all or nothing option.
9622
9623 @item -mcpu=@var{cpu}
9624 @opindex mcpu
9625 Compile code for ARC variant @var{cpu}.
9626 Which variants are supported depend on the configuration.
9627 All variants support @option{-mcpu=base}, this is the default.
9628
9629 @item -mtext=@var{text-section}
9630 @itemx -mdata=@var{data-section}
9631 @itemx -mrodata=@var{readonly-data-section}
9632 @opindex mtext
9633 @opindex mdata
9634 @opindex mrodata
9635 Put functions, data, and readonly data in @var{text-section},
9636 @var{data-section}, and @var{readonly-data-section} respectively
9637 by default.  This can be overridden with the @code{section} attribute.
9638 @xref{Variable Attributes}.
9639
9640 @item -mfix-cortex-m3-ldrd
9641 @opindex mfix-cortex-m3-ldrd
9642 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
9643 with overlapping destination and base registers are used.  This option avoids
9644 generating these instructions.  This option is enabled by default when
9645 @option{-mcpu=cortex-m3} is specified.
9646
9647 @end table
9648
9649 @node ARM Options
9650 @subsection ARM Options
9651 @cindex ARM options
9652
9653 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
9654 architectures:
9655
9656 @table @gcctabopt
9657 @item -mabi=@var{name}
9658 @opindex mabi
9659 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
9660 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
9661
9662 @item -mapcs-frame
9663 @opindex mapcs-frame
9664 Generate a stack frame that is compliant with the ARM Procedure Call
9665 Standard for all functions, even if this is not strictly necessary for
9666 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
9667 with this option will cause the stack frames not to be generated for
9668 leaf functions.  The default is @option{-mno-apcs-frame}.
9669
9670 @item -mapcs
9671 @opindex mapcs
9672 This is a synonym for @option{-mapcs-frame}.
9673
9674 @ignore
9675 @c not currently implemented
9676 @item -mapcs-stack-check
9677 @opindex mapcs-stack-check
9678 Generate code to check the amount of stack space available upon entry to
9679 every function (that actually uses some stack space).  If there is
9680 insufficient space available then either the function
9681 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
9682 called, depending upon the amount of stack space required.  The run time
9683 system is required to provide these functions.  The default is
9684 @option{-mno-apcs-stack-check}, since this produces smaller code.
9685
9686 @c not currently implemented
9687 @item -mapcs-float
9688 @opindex mapcs-float
9689 Pass floating point arguments using the float point registers.  This is
9690 one of the variants of the APCS@.  This option is recommended if the
9691 target hardware has a floating point unit or if a lot of floating point
9692 arithmetic is going to be performed by the code.  The default is
9693 @option{-mno-apcs-float}, since integer only code is slightly increased in
9694 size if @option{-mapcs-float} is used.
9695
9696 @c not currently implemented
9697 @item -mapcs-reentrant
9698 @opindex mapcs-reentrant
9699 Generate reentrant, position independent code.  The default is
9700 @option{-mno-apcs-reentrant}.
9701 @end ignore
9702
9703 @item -mthumb-interwork
9704 @opindex mthumb-interwork
9705 Generate code which supports calling between the ARM and Thumb
9706 instruction sets.  Without this option the two instruction sets cannot
9707 be reliably used inside one program.  The default is
9708 @option{-mno-thumb-interwork}, since slightly larger code is generated
9709 when @option{-mthumb-interwork} is specified.
9710
9711 @item -mno-sched-prolog
9712 @opindex mno-sched-prolog
9713 Prevent the reordering of instructions in the function prolog, or the
9714 merging of those instruction with the instructions in the function's
9715 body.  This means that all functions will start with a recognizable set
9716 of instructions (or in fact one of a choice from a small set of
9717 different function prologues), and this information can be used to
9718 locate the start if functions inside an executable piece of code.  The
9719 default is @option{-msched-prolog}.
9720
9721 @item -mfloat-abi=@var{name}
9722 @opindex mfloat-abi
9723 Specifies which floating-point ABI to use.  Permissible values
9724 are: @samp{soft}, @samp{softfp} and @samp{hard}.
9725
9726 Specifying @samp{soft} causes GCC to generate output containing
9727 library calls for floating-point operations.
9728 @samp{softfp} allows the generation of code using hardware floating-point
9729 instructions, but still uses the soft-float calling conventions.
9730 @samp{hard} allows generation of floating-point instructions
9731 and uses FPU-specific calling conventions.
9732
9733 The default depends on the specific target configuration.  Note that
9734 the hard-float and soft-float ABIs are not link-compatible; you must
9735 compile your entire program with the same ABI, and link with a
9736 compatible set of libraries.
9737
9738 @item -mhard-float
9739 @opindex mhard-float
9740 Equivalent to @option{-mfloat-abi=hard}.
9741
9742 @item -msoft-float
9743 @opindex msoft-float
9744 Equivalent to @option{-mfloat-abi=soft}.
9745
9746 @item -mlittle-endian
9747 @opindex mlittle-endian
9748 Generate code for a processor running in little-endian mode.  This is
9749 the default for all standard configurations.
9750
9751 @item -mbig-endian
9752 @opindex mbig-endian
9753 Generate code for a processor running in big-endian mode; the default is
9754 to compile code for a little-endian processor.
9755
9756 @item -mwords-little-endian
9757 @opindex mwords-little-endian
9758 This option only applies when generating code for big-endian processors.
9759 Generate code for a little-endian word order but a big-endian byte
9760 order.  That is, a byte order of the form @samp{32107654}.  Note: this
9761 option should only be used if you require compatibility with code for
9762 big-endian ARM processors generated by versions of the compiler prior to
9763 2.8.
9764
9765 @item -mcpu=@var{name}
9766 @opindex mcpu
9767 This specifies the name of the target ARM processor.  GCC uses this name
9768 to determine what kind of instructions it can emit when generating
9769 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
9770 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
9771 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
9772 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
9773 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
9774 @samp{arm720},
9775 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
9776 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
9777 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
9778 @samp{strongarm1110},
9779 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
9780 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
9781 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
9782 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
9783 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
9784 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
9785 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
9786 @samp{cortex-a5}, @samp{cortex-a8}, @samp{cortex-a9},
9787 @samp{cortex-r4}, @samp{cortex-r4f}, @samp{cortex-m3},
9788 @samp{cortex-m1},
9789 @samp{cortex-m0},
9790 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9791
9792 @item -mtune=@var{name}
9793 @opindex mtune
9794 This option is very similar to the @option{-mcpu=} option, except that
9795 instead of specifying the actual target processor type, and hence
9796 restricting which instructions can be used, it specifies that GCC should
9797 tune the performance of the code as if the target were of the type
9798 specified in this option, but still choosing the instructions that it
9799 will generate based on the cpu specified by a @option{-mcpu=} option.
9800 For some ARM implementations better performance can be obtained by using
9801 this option.
9802
9803 @item -march=@var{name}
9804 @opindex march
9805 This specifies the name of the target ARM architecture.  GCC uses this
9806 name to determine what kind of instructions it can emit when generating
9807 assembly code.  This option can be used in conjunction with or instead
9808 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
9809 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
9810 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
9811 @samp{armv6}, @samp{armv6j},
9812 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
9813 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m},
9814 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
9815
9816 @item -mfpu=@var{name}
9817 @itemx -mfpe=@var{number}
9818 @itemx -mfp=@var{number}
9819 @opindex mfpu
9820 @opindex mfpe
9821 @opindex mfp
9822 This specifies what floating point hardware (or hardware emulation) is
9823 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
9824 @samp{fpe3}, @samp{maverick}, @samp{vfp}, @samp{vfpv3}, @samp{vfpv3-fp16},
9825 @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd}, @samp{vfpv3xd-fp16},
9826 @samp{neon}, @samp{neon-fp16}, @samp{vfpv4}, @samp{vfpv4-d16},
9827 @samp{fpv4-sp-d16} and @samp{neon-vfpv4}.
9828 @option{-mfp} and @option{-mfpe} are synonyms for
9829 @option{-mfpu}=@samp{fpe}@var{number}, for compatibility with older versions
9830 of GCC@.
9831
9832 If @option{-msoft-float} is specified this specifies the format of
9833 floating point values.
9834
9835 @item -mfp16-format=@var{name}
9836 @opindex mfp16-format
9837 Specify the format of the @code{__fp16} half-precision floating-point type.
9838 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
9839 the default is @samp{none}, in which case the @code{__fp16} type is not
9840 defined.  @xref{Half-Precision}, for more information.
9841
9842 @item -mstructure-size-boundary=@var{n}
9843 @opindex mstructure-size-boundary
9844 The size of all structures and unions will be rounded up to a multiple
9845 of the number of bits set by this option.  Permissible values are 8, 32
9846 and 64.  The default value varies for different toolchains.  For the COFF
9847 targeted toolchain the default value is 8.  A value of 64 is only allowed
9848 if the underlying ABI supports it.
9849
9850 Specifying the larger number can produce faster, more efficient code, but
9851 can also increase the size of the program.  Different values are potentially
9852 incompatible.  Code compiled with one value cannot necessarily expect to
9853 work with code or libraries compiled with another value, if they exchange
9854 information using structures or unions.
9855
9856 @item -mabort-on-noreturn
9857 @opindex mabort-on-noreturn
9858 Generate a call to the function @code{abort} at the end of a
9859 @code{noreturn} function.  It will be executed if the function tries to
9860 return.
9861
9862 @item -mlong-calls
9863 @itemx -mno-long-calls
9864 @opindex mlong-calls
9865 @opindex mno-long-calls
9866 Tells the compiler to perform function calls by first loading the
9867 address of the function into a register and then performing a subroutine
9868 call on this register.  This switch is needed if the target function
9869 will lie outside of the 64 megabyte addressing range of the offset based
9870 version of subroutine call instruction.
9871
9872 Even if this switch is enabled, not all function calls will be turned
9873 into long calls.  The heuristic is that static functions, functions
9874 which have the @samp{short-call} attribute, functions that are inside
9875 the scope of a @samp{#pragma no_long_calls} directive and functions whose
9876 definitions have already been compiled within the current compilation
9877 unit, will not be turned into long calls.  The exception to this rule is
9878 that weak function definitions, functions with the @samp{long-call}
9879 attribute or the @samp{section} attribute, and functions that are within
9880 the scope of a @samp{#pragma long_calls} directive, will always be
9881 turned into long calls.
9882
9883 This feature is not enabled by default.  Specifying
9884 @option{-mno-long-calls} will restore the default behavior, as will
9885 placing the function calls within the scope of a @samp{#pragma
9886 long_calls_off} directive.  Note these switches have no effect on how
9887 the compiler generates code to handle function calls via function
9888 pointers.
9889
9890 @item -msingle-pic-base
9891 @opindex msingle-pic-base
9892 Treat the register used for PIC addressing as read-only, rather than
9893 loading it in the prologue for each function.  The run-time system is
9894 responsible for initializing this register with an appropriate value
9895 before execution begins.
9896
9897 @item -mpic-register=@var{reg}
9898 @opindex mpic-register
9899 Specify the register to be used for PIC addressing.  The default is R10
9900 unless stack-checking is enabled, when R9 is used.
9901
9902 @item -mcirrus-fix-invalid-insns
9903 @opindex mcirrus-fix-invalid-insns
9904 @opindex mno-cirrus-fix-invalid-insns
9905 Insert NOPs into the instruction stream to in order to work around
9906 problems with invalid Maverick instruction combinations.  This option
9907 is only valid if the @option{-mcpu=ep9312} option has been used to
9908 enable generation of instructions for the Cirrus Maverick floating
9909 point co-processor.  This option is not enabled by default, since the
9910 problem is only present in older Maverick implementations.  The default
9911 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
9912 switch.
9913
9914 @item -mpoke-function-name
9915 @opindex mpoke-function-name
9916 Write the name of each function into the text section, directly
9917 preceding the function prologue.  The generated code is similar to this:
9918
9919 @smallexample
9920      t0
9921          .ascii "arm_poke_function_name", 0
9922          .align
9923      t1
9924          .word 0xff000000 + (t1 - t0)
9925      arm_poke_function_name
9926          mov     ip, sp
9927          stmfd   sp!, @{fp, ip, lr, pc@}
9928          sub     fp, ip, #4
9929 @end smallexample
9930
9931 When performing a stack backtrace, code can inspect the value of
9932 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
9933 location @code{pc - 12} and the top 8 bits are set, then we know that
9934 there is a function name embedded immediately preceding this location
9935 and has length @code{((pc[-3]) & 0xff000000)}.
9936
9937 @item -mthumb
9938 @opindex mthumb
9939 Generate code for the Thumb instruction set.  The default is to
9940 use the 32-bit ARM instruction set.
9941 This option automatically enables either 16-bit Thumb-1 or
9942 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
9943 and @option{-march=@var{name}} options.  This option is not passed to the
9944 assembler. If you want to force assembler files to be interpreted as Thumb code,
9945 either add a @samp{.thumb} directive to the source or pass the @option{-mthumb}
9946 option directly to the assembler by prefixing it with @option{-Wa}.
9947
9948 @item -mtpcs-frame
9949 @opindex mtpcs-frame
9950 Generate a stack frame that is compliant with the Thumb Procedure Call
9951 Standard for all non-leaf functions.  (A leaf function is one that does
9952 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
9953
9954 @item -mtpcs-leaf-frame
9955 @opindex mtpcs-leaf-frame
9956 Generate a stack frame that is compliant with the Thumb Procedure Call
9957 Standard for all leaf functions.  (A leaf function is one that does
9958 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
9959
9960 @item -mcallee-super-interworking
9961 @opindex mcallee-super-interworking
9962 Gives all externally visible functions in the file being compiled an ARM
9963 instruction set header which switches to Thumb mode before executing the
9964 rest of the function.  This allows these functions to be called from
9965 non-interworking code.  This option is not valid in AAPCS configurations
9966 because interworking is enabled by default.
9967
9968 @item -mcaller-super-interworking
9969 @opindex mcaller-super-interworking
9970 Allows calls via function pointers (including virtual functions) to
9971 execute correctly regardless of whether the target code has been
9972 compiled for interworking or not.  There is a small overhead in the cost
9973 of executing a function pointer if this option is enabled.  This option
9974 is not valid in AAPCS configurations because interworking is enabled
9975 by default.
9976
9977 @item -mtp=@var{name}
9978 @opindex mtp
9979 Specify the access model for the thread local storage pointer.  The valid
9980 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
9981 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
9982 (supported in the arm6k architecture), and @option{auto}, which uses the
9983 best available method for the selected processor.  The default setting is
9984 @option{auto}.
9985
9986 @item -mword-relocations
9987 @opindex mword-relocations
9988 Only generate absolute relocations on word sized values (i.e. R_ARM_ABS32).
9989 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
9990 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
9991 is specified.
9992
9993 @end table
9994
9995 @node AVR Options
9996 @subsection AVR Options
9997 @cindex AVR Options
9998
9999 These options are defined for AVR implementations:
10000
10001 @table @gcctabopt
10002 @item -mmcu=@var{mcu}
10003 @opindex mmcu
10004 Specify ATMEL AVR instruction set or MCU type.
10005
10006 Instruction set avr1 is for the minimal AVR core, not supported by the C
10007 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
10008 attiny11, attiny12, attiny15, attiny28).
10009
10010 Instruction set avr2 (default) is for the classic AVR core with up to
10011 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
10012 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
10013 at90c8534, at90s8535).
10014
10015 Instruction set avr3 is for the classic AVR core with up to 128K program
10016 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
10017
10018 Instruction set avr4 is for the enhanced AVR core with up to 8K program
10019 memory space (MCU types: atmega8, atmega83, atmega85).
10020
10021 Instruction set avr5 is for the enhanced AVR core with up to 128K program
10022 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
10023 atmega64, atmega128, at43usb355, at94k).
10024
10025 @item -mno-interrupts
10026 @opindex mno-interrupts
10027 Generated code is not compatible with hardware interrupts.
10028 Code size will be smaller.
10029
10030 @item -mcall-prologues
10031 @opindex mcall-prologues
10032 Functions prologues/epilogues expanded as call to appropriate
10033 subroutines.  Code size will be smaller.
10034
10035 @item -mtiny-stack
10036 @opindex mtiny-stack
10037 Change only the low 8 bits of the stack pointer.
10038
10039 @item -mint8
10040 @opindex mint8
10041 Assume int to be 8 bit integer.  This affects the sizes of all types: A
10042 char will be 1 byte, an int will be 1 byte, a long will be 2 bytes
10043 and long long will be 4 bytes.  Please note that this option does not
10044 comply to the C standards, but it will provide you with smaller code
10045 size.
10046 @end table
10047
10048 @node Blackfin Options
10049 @subsection Blackfin Options
10050 @cindex Blackfin Options
10051
10052 @table @gcctabopt
10053 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
10054 @opindex mcpu=
10055 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
10056 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
10057 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
10058 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
10059 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
10060 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
10061 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
10062 @samp{bf561}.
10063 The optional @var{sirevision} specifies the silicon revision of the target
10064 Blackfin processor.  Any workarounds available for the targeted silicon revision
10065 will be enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
10066 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
10067 will be enabled.  The @code{__SILICON_REVISION__} macro is defined to two
10068 hexadecimal digits representing the major and minor numbers in the silicon
10069 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
10070 is not defined.  If @var{sirevision} is @samp{any}, the
10071 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
10072 If this optional @var{sirevision} is not used, GCC assumes the latest known
10073 silicon revision of the targeted Blackfin processor.
10074
10075 Support for @samp{bf561} is incomplete.  For @samp{bf561},
10076 Only the processor macro is defined.
10077 Without this option, @samp{bf532} is used as the processor by default.
10078 The corresponding predefined processor macros for @var{cpu} is to
10079 be defined.  And for @samp{bfin-elf} toolchain, this causes the hardware BSP
10080 provided by libgloss to be linked in if @option{-msim} is not given.
10081
10082 @item -msim
10083 @opindex msim
10084 Specifies that the program will be run on the simulator.  This causes
10085 the simulator BSP provided by libgloss to be linked in.  This option
10086 has effect only for @samp{bfin-elf} toolchain.
10087 Certain other options, such as @option{-mid-shared-library} and
10088 @option{-mfdpic}, imply @option{-msim}.
10089
10090 @item -momit-leaf-frame-pointer
10091 @opindex momit-leaf-frame-pointer
10092 Don't keep the frame pointer in a register for leaf functions.  This
10093 avoids the instructions to save, set up and restore frame pointers and
10094 makes an extra register available in leaf functions.  The option
10095 @option{-fomit-frame-pointer} removes the frame pointer for all functions
10096 which might make debugging harder.
10097
10098 @item -mspecld-anomaly
10099 @opindex mspecld-anomaly
10100 When enabled, the compiler will ensure that the generated code does not
10101 contain speculative loads after jump instructions. If this option is used,
10102 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
10103
10104 @item -mno-specld-anomaly
10105 @opindex mno-specld-anomaly
10106 Don't generate extra code to prevent speculative loads from occurring.
10107
10108 @item -mcsync-anomaly
10109 @opindex mcsync-anomaly
10110 When enabled, the compiler will ensure that the generated code does not
10111 contain CSYNC or SSYNC instructions too soon after conditional branches.
10112 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
10113
10114 @item -mno-csync-anomaly
10115 @opindex mno-csync-anomaly
10116 Don't generate extra code to prevent CSYNC or SSYNC instructions from
10117 occurring too soon after a conditional branch.
10118
10119 @item -mlow-64k
10120 @opindex mlow-64k
10121 When enabled, the compiler is free to take advantage of the knowledge that
10122 the entire program fits into the low 64k of memory.
10123
10124 @item -mno-low-64k
10125 @opindex mno-low-64k
10126 Assume that the program is arbitrarily large.  This is the default.
10127
10128 @item -mstack-check-l1
10129 @opindex mstack-check-l1
10130 Do stack checking using information placed into L1 scratchpad memory by the
10131 uClinux kernel.
10132
10133 @item -mid-shared-library
10134 @opindex mid-shared-library
10135 Generate code that supports shared libraries via the library ID method.
10136 This allows for execute in place and shared libraries in an environment
10137 without virtual memory management.  This option implies @option{-fPIC}.
10138 With a @samp{bfin-elf} target, this option implies @option{-msim}.
10139
10140 @item -mno-id-shared-library
10141 @opindex mno-id-shared-library
10142 Generate code that doesn't assume ID based shared libraries are being used.
10143 This is the default.
10144
10145 @item -mleaf-id-shared-library
10146 @opindex mleaf-id-shared-library
10147 Generate code that supports shared libraries via the library ID method,
10148 but assumes that this library or executable won't link against any other
10149 ID shared libraries.  That allows the compiler to use faster code for jumps
10150 and calls.
10151
10152 @item -mno-leaf-id-shared-library
10153 @opindex mno-leaf-id-shared-library
10154 Do not assume that the code being compiled won't link against any ID shared
10155 libraries.  Slower code will be generated for jump and call insns.
10156
10157 @item -mshared-library-id=n
10158 @opindex mshared-library-id
10159 Specified the identification number of the ID based shared library being
10160 compiled.  Specifying a value of 0 will generate more compact code, specifying
10161 other values will force the allocation of that number to the current
10162 library but is no more space or time efficient than omitting this option.
10163
10164 @item -msep-data
10165 @opindex msep-data
10166 Generate code that allows the data segment to be located in a different
10167 area of memory from the text segment.  This allows for execute in place in
10168 an environment without virtual memory management by eliminating relocations
10169 against the text section.
10170
10171 @item -mno-sep-data
10172 @opindex mno-sep-data
10173 Generate code that assumes that the data segment follows the text segment.
10174 This is the default.
10175
10176 @item -mlong-calls
10177 @itemx -mno-long-calls
10178 @opindex mlong-calls
10179 @opindex mno-long-calls
10180 Tells the compiler to perform function calls by first loading the
10181 address of the function into a register and then performing a subroutine
10182 call on this register.  This switch is needed if the target function
10183 will lie outside of the 24 bit addressing range of the offset based
10184 version of subroutine call instruction.
10185
10186 This feature is not enabled by default.  Specifying
10187 @option{-mno-long-calls} will restore the default behavior.  Note these
10188 switches have no effect on how the compiler generates code to handle
10189 function calls via function pointers.
10190
10191 @item -mfast-fp
10192 @opindex mfast-fp
10193 Link with the fast floating-point library. This library relaxes some of
10194 the IEEE floating-point standard's rules for checking inputs against
10195 Not-a-Number (NAN), in the interest of performance.
10196
10197 @item -minline-plt
10198 @opindex minline-plt
10199 Enable inlining of PLT entries in function calls to functions that are
10200 not known to bind locally.  It has no effect without @option{-mfdpic}.
10201
10202 @item -mmulticore
10203 @opindex mmulticore
10204 Build standalone application for multicore Blackfin processor. Proper
10205 start files and link scripts will be used to support multicore.
10206 This option defines @code{__BFIN_MULTICORE}. It can only be used with
10207 @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. It can be used with
10208 @option{-mcorea} or @option{-mcoreb}. If it's used without
10209 @option{-mcorea} or @option{-mcoreb}, single application/dual core
10210 programming model is used. In this model, the main function of Core B
10211 should be named as coreb_main. If it's used with @option{-mcorea} or
10212 @option{-mcoreb}, one application per core programming model is used.
10213 If this option is not used, single core application programming
10214 model is used.
10215
10216 @item -mcorea
10217 @opindex mcorea
10218 Build standalone application for Core A of BF561 when using
10219 one application per core programming model. Proper start files
10220 and link scripts will be used to support Core A. This option
10221 defines @code{__BFIN_COREA}. It must be used with @option{-mmulticore}.
10222
10223 @item -mcoreb
10224 @opindex mcoreb
10225 Build standalone application for Core B of BF561 when using
10226 one application per core programming model. Proper start files
10227 and link scripts will be used to support Core B. This option
10228 defines @code{__BFIN_COREB}. When this option is used, coreb_main
10229 should be used instead of main. It must be used with
10230 @option{-mmulticore}.
10231
10232 @item -msdram
10233 @opindex msdram
10234 Build standalone application for SDRAM. Proper start files and
10235 link scripts will be used to put the application into SDRAM.
10236 Loader should initialize SDRAM before loading the application
10237 into SDRAM. This option defines @code{__BFIN_SDRAM}.
10238
10239 @item -micplb
10240 @opindex micplb
10241 Assume that ICPLBs are enabled at runtime.  This has an effect on certain
10242 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
10243 are enabled; for standalone applications the default is off.
10244 @end table
10245
10246 @node CRIS Options
10247 @subsection CRIS Options
10248 @cindex CRIS Options
10249
10250 These options are defined specifically for the CRIS ports.
10251
10252 @table @gcctabopt
10253 @item -march=@var{architecture-type}
10254 @itemx -mcpu=@var{architecture-type}
10255 @opindex march
10256 @opindex mcpu
10257 Generate code for the specified architecture.  The choices for
10258 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
10259 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
10260 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
10261 @samp{v10}.
10262
10263 @item -mtune=@var{architecture-type}
10264 @opindex mtune
10265 Tune to @var{architecture-type} everything applicable about the generated
10266 code, except for the ABI and the set of available instructions.  The
10267 choices for @var{architecture-type} are the same as for
10268 @option{-march=@var{architecture-type}}.
10269
10270 @item -mmax-stack-frame=@var{n}
10271 @opindex mmax-stack-frame
10272 Warn when the stack frame of a function exceeds @var{n} bytes.
10273
10274 @item -metrax4
10275 @itemx -metrax100
10276 @opindex metrax4
10277 @opindex metrax100
10278 The options @option{-metrax4} and @option{-metrax100} are synonyms for
10279 @option{-march=v3} and @option{-march=v8} respectively.
10280
10281 @item -mmul-bug-workaround
10282 @itemx -mno-mul-bug-workaround
10283 @opindex mmul-bug-workaround
10284 @opindex mno-mul-bug-workaround
10285 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
10286 models where it applies.  This option is active by default.
10287
10288 @item -mpdebug
10289 @opindex mpdebug
10290 Enable CRIS-specific verbose debug-related information in the assembly
10291 code.  This option also has the effect to turn off the @samp{#NO_APP}
10292 formatted-code indicator to the assembler at the beginning of the
10293 assembly file.
10294
10295 @item -mcc-init
10296 @opindex mcc-init
10297 Do not use condition-code results from previous instruction; always emit
10298 compare and test instructions before use of condition codes.
10299
10300 @item -mno-side-effects
10301 @opindex mno-side-effects
10302 Do not emit instructions with side-effects in addressing modes other than
10303 post-increment.
10304
10305 @item -mstack-align
10306 @itemx -mno-stack-align
10307 @itemx -mdata-align
10308 @itemx -mno-data-align
10309 @itemx -mconst-align
10310 @itemx -mno-const-align
10311 @opindex mstack-align
10312 @opindex mno-stack-align
10313 @opindex mdata-align
10314 @opindex mno-data-align
10315 @opindex mconst-align
10316 @opindex mno-const-align
10317 These options (no-options) arranges (eliminate arrangements) for the
10318 stack-frame, individual data and constants to be aligned for the maximum
10319 single data access size for the chosen CPU model.  The default is to
10320 arrange for 32-bit alignment.  ABI details such as structure layout are
10321 not affected by these options.
10322
10323 @item -m32-bit
10324 @itemx -m16-bit
10325 @itemx -m8-bit
10326 @opindex m32-bit
10327 @opindex m16-bit
10328 @opindex m8-bit
10329 Similar to the stack- data- and const-align options above, these options
10330 arrange for stack-frame, writable data and constants to all be 32-bit,
10331 16-bit or 8-bit aligned.  The default is 32-bit alignment.
10332
10333 @item -mno-prologue-epilogue
10334 @itemx -mprologue-epilogue
10335 @opindex mno-prologue-epilogue
10336 @opindex mprologue-epilogue
10337 With @option{-mno-prologue-epilogue}, the normal function prologue and
10338 epilogue that sets up the stack-frame are omitted and no return
10339 instructions or return sequences are generated in the code.  Use this
10340 option only together with visual inspection of the compiled code: no
10341 warnings or errors are generated when call-saved registers must be saved,
10342 or storage for local variable needs to be allocated.
10343
10344 @item -mno-gotplt
10345 @itemx -mgotplt
10346 @opindex mno-gotplt
10347 @opindex mgotplt
10348 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
10349 instruction sequences that load addresses for functions from the PLT part
10350 of the GOT rather than (traditional on other architectures) calls to the
10351 PLT@.  The default is @option{-mgotplt}.
10352
10353 @item -melf
10354 @opindex melf
10355 Legacy no-op option only recognized with the cris-axis-elf and
10356 cris-axis-linux-gnu targets.
10357
10358 @item -mlinux
10359 @opindex mlinux
10360 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
10361
10362 @item -sim
10363 @opindex sim
10364 This option, recognized for the cris-axis-elf arranges
10365 to link with input-output functions from a simulator library.  Code,
10366 initialized data and zero-initialized data are allocated consecutively.
10367
10368 @item -sim2
10369 @opindex sim2
10370 Like @option{-sim}, but pass linker options to locate initialized data at
10371 0x40000000 and zero-initialized data at 0x80000000.
10372 @end table
10373
10374 @node CRX Options
10375 @subsection CRX Options
10376 @cindex CRX Options
10377
10378 These options are defined specifically for the CRX ports.
10379
10380 @table @gcctabopt
10381
10382 @item -mmac
10383 @opindex mmac
10384 Enable the use of multiply-accumulate instructions. Disabled by default.
10385
10386 @item -mpush-args
10387 @opindex mpush-args
10388 Push instructions will be used to pass outgoing arguments when functions
10389 are called. Enabled by default.
10390 @end table
10391
10392 @node Darwin Options
10393 @subsection Darwin Options
10394 @cindex Darwin options
10395
10396 These options are defined for all architectures running the Darwin operating
10397 system.
10398
10399 FSF GCC on Darwin does not create ``fat'' object files; it will create
10400 an object file for the single architecture that it was built to
10401 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
10402 @option{-arch} options are used; it does so by running the compiler or
10403 linker multiple times and joining the results together with
10404 @file{lipo}.
10405
10406 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
10407 @samp{i686}) is determined by the flags that specify the ISA
10408 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
10409 @option{-force_cpusubtype_ALL} option can be used to override this.
10410
10411 The Darwin tools vary in their behavior when presented with an ISA
10412 mismatch.  The assembler, @file{as}, will only permit instructions to
10413 be used that are valid for the subtype of the file it is generating,
10414 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
10415 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
10416 and print an error if asked to create a shared library with a less
10417 restrictive subtype than its input files (for instance, trying to put
10418 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
10419 for executables, @file{ld}, will quietly give the executable the most
10420 restrictive subtype of any of its input files.
10421
10422 @table @gcctabopt
10423 @item -F@var{dir}
10424 @opindex F
10425 Add the framework directory @var{dir} to the head of the list of
10426 directories to be searched for header files.  These directories are
10427 interleaved with those specified by @option{-I} options and are
10428 scanned in a left-to-right order.
10429
10430 A framework directory is a directory with frameworks in it.  A
10431 framework is a directory with a @samp{"Headers"} and/or
10432 @samp{"PrivateHeaders"} directory contained directly in it that ends
10433 in @samp{".framework"}.  The name of a framework is the name of this
10434 directory excluding the @samp{".framework"}.  Headers associated with
10435 the framework are found in one of those two directories, with
10436 @samp{"Headers"} being searched first.  A subframework is a framework
10437 directory that is in a framework's @samp{"Frameworks"} directory.
10438 Includes of subframework headers can only appear in a header of a
10439 framework that contains the subframework, or in a sibling subframework
10440 header.  Two subframeworks are siblings if they occur in the same
10441 framework.  A subframework should not have the same name as a
10442 framework, a warning will be issued if this is violated.  Currently a
10443 subframework cannot have subframeworks, in the future, the mechanism
10444 may be extended to support this.  The standard frameworks can be found
10445 in @samp{"/System/Library/Frameworks"} and
10446 @samp{"/Library/Frameworks"}.  An example include looks like
10447 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
10448 the name of the framework and header.h is found in the
10449 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
10450
10451 @item -iframework@var{dir}
10452 @opindex iframework
10453 Like @option{-F} except the directory is a treated as a system
10454 directory.  The main difference between this @option{-iframework} and
10455 @option{-F} is that with @option{-iframework} the compiler does not
10456 warn about constructs contained within header files found via
10457 @var{dir}.  This option is valid only for the C family of languages.
10458
10459 @item -gused
10460 @opindex gused
10461 Emit debugging information for symbols that are used.  For STABS
10462 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
10463 This is by default ON@.
10464
10465 @item -gfull
10466 @opindex gfull
10467 Emit debugging information for all symbols and types.
10468
10469 @item -mmacosx-version-min=@var{version}
10470 The earliest version of MacOS X that this executable will run on
10471 is @var{version}.  Typical values of @var{version} include @code{10.1},
10472 @code{10.2}, and @code{10.3.9}.
10473
10474 If the compiler was built to use the system's headers by default,
10475 then the default for this option is the system version on which the
10476 compiler is running, otherwise the default is to make choices which
10477 are compatible with as many systems and code bases as possible.
10478
10479 @item -mkernel
10480 @opindex mkernel
10481 Enable kernel development mode.  The @option{-mkernel} option sets
10482 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
10483 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
10484 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
10485 applicable.  This mode also sets @option{-mno-altivec},
10486 @option{-msoft-float}, @option{-fno-builtin} and
10487 @option{-mlong-branch} for PowerPC targets.
10488
10489 @item -mone-byte-bool
10490 @opindex mone-byte-bool
10491 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
10492 By default @samp{sizeof(bool)} is @samp{4} when compiling for
10493 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
10494 option has no effect on x86.
10495
10496 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
10497 to generate code that is not binary compatible with code generated
10498 without that switch.  Using this switch may require recompiling all
10499 other modules in a program, including system libraries.  Use this
10500 switch to conform to a non-default data model.
10501
10502 @item -mfix-and-continue
10503 @itemx -ffix-and-continue
10504 @itemx -findirect-data
10505 @opindex mfix-and-continue
10506 @opindex ffix-and-continue
10507 @opindex findirect-data
10508 Generate code suitable for fast turn around development.  Needed to
10509 enable gdb to dynamically load @code{.o} files into already running
10510 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
10511 are provided for backwards compatibility.
10512
10513 @item -all_load
10514 @opindex all_load
10515 Loads all members of static archive libraries.
10516 See man ld(1) for more information.
10517
10518 @item -arch_errors_fatal
10519 @opindex arch_errors_fatal
10520 Cause the errors having to do with files that have the wrong architecture
10521 to be fatal.
10522
10523 @item -bind_at_load
10524 @opindex bind_at_load
10525 Causes the output file to be marked such that the dynamic linker will
10526 bind all undefined references when the file is loaded or launched.
10527
10528 @item -bundle
10529 @opindex bundle
10530 Produce a Mach-o bundle format file.
10531 See man ld(1) for more information.
10532
10533 @item -bundle_loader @var{executable}
10534 @opindex bundle_loader
10535 This option specifies the @var{executable} that will be loading the build
10536 output file being linked.  See man ld(1) for more information.
10537
10538 @item -dynamiclib
10539 @opindex dynamiclib
10540 When passed this option, GCC will produce a dynamic library instead of
10541 an executable when linking, using the Darwin @file{libtool} command.
10542
10543 @item -force_cpusubtype_ALL
10544 @opindex force_cpusubtype_ALL
10545 This causes GCC's output file to have the @var{ALL} subtype, instead of
10546 one controlled by the @option{-mcpu} or @option{-march} option.
10547
10548 @item -allowable_client  @var{client_name}
10549 @itemx -client_name
10550 @itemx -compatibility_version
10551 @itemx -current_version
10552 @itemx -dead_strip
10553 @itemx -dependency-file
10554 @itemx -dylib_file
10555 @itemx -dylinker_install_name
10556 @itemx -dynamic
10557 @itemx -exported_symbols_list
10558 @itemx -filelist
10559 @itemx -flat_namespace
10560 @itemx -force_flat_namespace
10561 @itemx -headerpad_max_install_names
10562 @itemx -image_base
10563 @itemx -init
10564 @itemx -install_name
10565 @itemx -keep_private_externs
10566 @itemx -multi_module
10567 @itemx -multiply_defined
10568 @itemx -multiply_defined_unused
10569 @itemx -noall_load
10570 @itemx -no_dead_strip_inits_and_terms
10571 @itemx -nofixprebinding
10572 @itemx -nomultidefs
10573 @itemx -noprebind
10574 @itemx -noseglinkedit
10575 @itemx -pagezero_size
10576 @itemx -prebind
10577 @itemx -prebind_all_twolevel_modules
10578 @itemx -private_bundle
10579 @itemx -read_only_relocs
10580 @itemx -sectalign
10581 @itemx -sectobjectsymbols
10582 @itemx -whyload
10583 @itemx -seg1addr
10584 @itemx -sectcreate
10585 @itemx -sectobjectsymbols
10586 @itemx -sectorder
10587 @itemx -segaddr
10588 @itemx -segs_read_only_addr
10589 @itemx -segs_read_write_addr
10590 @itemx -seg_addr_table
10591 @itemx -seg_addr_table_filename
10592 @itemx -seglinkedit
10593 @itemx -segprot
10594 @itemx -segs_read_only_addr
10595 @itemx -segs_read_write_addr
10596 @itemx -single_module
10597 @itemx -static
10598 @itemx -sub_library
10599 @itemx -sub_umbrella
10600 @itemx -twolevel_namespace
10601 @itemx -umbrella
10602 @itemx -undefined
10603 @itemx -unexported_symbols_list
10604 @itemx -weak_reference_mismatches
10605 @itemx -whatsloaded
10606 @opindex allowable_client
10607 @opindex client_name
10608 @opindex compatibility_version
10609 @opindex current_version
10610 @opindex dead_strip
10611 @opindex dependency-file
10612 @opindex dylib_file
10613 @opindex dylinker_install_name
10614 @opindex dynamic
10615 @opindex exported_symbols_list
10616 @opindex filelist
10617 @opindex flat_namespace
10618 @opindex force_flat_namespace
10619 @opindex headerpad_max_install_names
10620 @opindex image_base
10621 @opindex init
10622 @opindex install_name
10623 @opindex keep_private_externs
10624 @opindex multi_module
10625 @opindex multiply_defined
10626 @opindex multiply_defined_unused
10627 @opindex noall_load
10628 @opindex no_dead_strip_inits_and_terms
10629 @opindex nofixprebinding
10630 @opindex nomultidefs
10631 @opindex noprebind
10632 @opindex noseglinkedit
10633 @opindex pagezero_size
10634 @opindex prebind
10635 @opindex prebind_all_twolevel_modules
10636 @opindex private_bundle
10637 @opindex read_only_relocs
10638 @opindex sectalign
10639 @opindex sectobjectsymbols
10640 @opindex whyload
10641 @opindex seg1addr
10642 @opindex sectcreate
10643 @opindex sectobjectsymbols
10644 @opindex sectorder
10645 @opindex segaddr
10646 @opindex segs_read_only_addr
10647 @opindex segs_read_write_addr
10648 @opindex seg_addr_table
10649 @opindex seg_addr_table_filename
10650 @opindex seglinkedit
10651 @opindex segprot
10652 @opindex segs_read_only_addr
10653 @opindex segs_read_write_addr
10654 @opindex single_module
10655 @opindex static
10656 @opindex sub_library
10657 @opindex sub_umbrella
10658 @opindex twolevel_namespace
10659 @opindex umbrella
10660 @opindex undefined
10661 @opindex unexported_symbols_list
10662 @opindex weak_reference_mismatches
10663 @opindex whatsloaded
10664 These options are passed to the Darwin linker.  The Darwin linker man page
10665 describes them in detail.
10666 @end table
10667
10668 @node DEC Alpha Options
10669 @subsection DEC Alpha Options
10670
10671 These @samp{-m} options are defined for the DEC Alpha implementations:
10672
10673 @table @gcctabopt
10674 @item -mno-soft-float
10675 @itemx -msoft-float
10676 @opindex mno-soft-float
10677 @opindex msoft-float
10678 Use (do not use) the hardware floating-point instructions for
10679 floating-point operations.  When @option{-msoft-float} is specified,
10680 functions in @file{libgcc.a} will be used to perform floating-point
10681 operations.  Unless they are replaced by routines that emulate the
10682 floating-point operations, or compiled in such a way as to call such
10683 emulations routines, these routines will issue floating-point
10684 operations.   If you are compiling for an Alpha without floating-point
10685 operations, you must ensure that the library is built so as not to call
10686 them.
10687
10688 Note that Alpha implementations without floating-point operations are
10689 required to have floating-point registers.
10690
10691 @item -mfp-reg
10692 @itemx -mno-fp-regs
10693 @opindex mfp-reg
10694 @opindex mno-fp-regs
10695 Generate code that uses (does not use) the floating-point register set.
10696 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
10697 register set is not used, floating point operands are passed in integer
10698 registers as if they were integers and floating-point results are passed
10699 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
10700 so any function with a floating-point argument or return value called by code
10701 compiled with @option{-mno-fp-regs} must also be compiled with that
10702 option.
10703
10704 A typical use of this option is building a kernel that does not use,
10705 and hence need not save and restore, any floating-point registers.
10706
10707 @item -mieee
10708 @opindex mieee
10709 The Alpha architecture implements floating-point hardware optimized for
10710 maximum performance.  It is mostly compliant with the IEEE floating
10711 point standard.  However, for full compliance, software assistance is
10712 required.  This option generates code fully IEEE compliant code
10713 @emph{except} that the @var{inexact-flag} is not maintained (see below).
10714 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
10715 defined during compilation.  The resulting code is less efficient but is
10716 able to correctly support denormalized numbers and exceptional IEEE
10717 values such as not-a-number and plus/minus infinity.  Other Alpha
10718 compilers call this option @option{-ieee_with_no_inexact}.
10719
10720 @item -mieee-with-inexact
10721 @opindex mieee-with-inexact
10722 This is like @option{-mieee} except the generated code also maintains
10723 the IEEE @var{inexact-flag}.  Turning on this option causes the
10724 generated code to implement fully-compliant IEEE math.  In addition to
10725 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
10726 macro.  On some Alpha implementations the resulting code may execute
10727 significantly slower than the code generated by default.  Since there is
10728 very little code that depends on the @var{inexact-flag}, you should
10729 normally not specify this option.  Other Alpha compilers call this
10730 option @option{-ieee_with_inexact}.
10731
10732 @item -mfp-trap-mode=@var{trap-mode}
10733 @opindex mfp-trap-mode
10734 This option controls what floating-point related traps are enabled.
10735 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
10736 The trap mode can be set to one of four values:
10737
10738 @table @samp
10739 @item n
10740 This is the default (normal) setting.  The only traps that are enabled
10741 are the ones that cannot be disabled in software (e.g., division by zero
10742 trap).
10743
10744 @item u
10745 In addition to the traps enabled by @samp{n}, underflow traps are enabled
10746 as well.
10747
10748 @item su
10749 Like @samp{u}, but the instructions are marked to be safe for software
10750 completion (see Alpha architecture manual for details).
10751
10752 @item sui
10753 Like @samp{su}, but inexact traps are enabled as well.
10754 @end table
10755
10756 @item -mfp-rounding-mode=@var{rounding-mode}
10757 @opindex mfp-rounding-mode
10758 Selects the IEEE rounding mode.  Other Alpha compilers call this option
10759 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
10760 of:
10761
10762 @table @samp
10763 @item n
10764 Normal IEEE rounding mode.  Floating point numbers are rounded towards
10765 the nearest machine number or towards the even machine number in case
10766 of a tie.
10767
10768 @item m
10769 Round towards minus infinity.
10770
10771 @item c
10772 Chopped rounding mode.  Floating point numbers are rounded towards zero.
10773
10774 @item d
10775 Dynamic rounding mode.  A field in the floating point control register
10776 (@var{fpcr}, see Alpha architecture reference manual) controls the
10777 rounding mode in effect.  The C library initializes this register for
10778 rounding towards plus infinity.  Thus, unless your program modifies the
10779 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
10780 @end table
10781
10782 @item -mtrap-precision=@var{trap-precision}
10783 @opindex mtrap-precision
10784 In the Alpha architecture, floating point traps are imprecise.  This
10785 means without software assistance it is impossible to recover from a
10786 floating trap and program execution normally needs to be terminated.
10787 GCC can generate code that can assist operating system trap handlers
10788 in determining the exact location that caused a floating point trap.
10789 Depending on the requirements of an application, different levels of
10790 precisions can be selected:
10791
10792 @table @samp
10793 @item p
10794 Program precision.  This option is the default and means a trap handler
10795 can only identify which program caused a floating point exception.
10796
10797 @item f
10798 Function precision.  The trap handler can determine the function that
10799 caused a floating point exception.
10800
10801 @item i
10802 Instruction precision.  The trap handler can determine the exact
10803 instruction that caused a floating point exception.
10804 @end table
10805
10806 Other Alpha compilers provide the equivalent options called
10807 @option{-scope_safe} and @option{-resumption_safe}.
10808
10809 @item -mieee-conformant
10810 @opindex mieee-conformant
10811 This option marks the generated code as IEEE conformant.  You must not
10812 use this option unless you also specify @option{-mtrap-precision=i} and either
10813 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
10814 is to emit the line @samp{.eflag 48} in the function prologue of the
10815 generated assembly file.  Under DEC Unix, this has the effect that
10816 IEEE-conformant math library routines will be linked in.
10817
10818 @item -mbuild-constants
10819 @opindex mbuild-constants
10820 Normally GCC examines a 32- or 64-bit integer constant to
10821 see if it can construct it from smaller constants in two or three
10822 instructions.  If it cannot, it will output the constant as a literal and
10823 generate code to load it from the data segment at runtime.
10824
10825 Use this option to require GCC to construct @emph{all} integer constants
10826 using code, even if it takes more instructions (the maximum is six).
10827
10828 You would typically use this option to build a shared library dynamic
10829 loader.  Itself a shared library, it must relocate itself in memory
10830 before it can find the variables and constants in its own data segment.
10831
10832 @item -malpha-as
10833 @itemx -mgas
10834 @opindex malpha-as
10835 @opindex mgas
10836 Select whether to generate code to be assembled by the vendor-supplied
10837 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
10838
10839 @item -mbwx
10840 @itemx -mno-bwx
10841 @itemx -mcix
10842 @itemx -mno-cix
10843 @itemx -mfix
10844 @itemx -mno-fix
10845 @itemx -mmax
10846 @itemx -mno-max
10847 @opindex mbwx
10848 @opindex mno-bwx
10849 @opindex mcix
10850 @opindex mno-cix
10851 @opindex mfix
10852 @opindex mno-fix
10853 @opindex mmax
10854 @opindex mno-max
10855 Indicate whether GCC should generate code to use the optional BWX,
10856 CIX, FIX and MAX instruction sets.  The default is to use the instruction
10857 sets supported by the CPU type specified via @option{-mcpu=} option or that
10858 of the CPU on which GCC was built if none was specified.
10859
10860 @item -mfloat-vax
10861 @itemx -mfloat-ieee
10862 @opindex mfloat-vax
10863 @opindex mfloat-ieee
10864 Generate code that uses (does not use) VAX F and G floating point
10865 arithmetic instead of IEEE single and double precision.
10866
10867 @item -mexplicit-relocs
10868 @itemx -mno-explicit-relocs
10869 @opindex mexplicit-relocs
10870 @opindex mno-explicit-relocs
10871 Older Alpha assemblers provided no way to generate symbol relocations
10872 except via assembler macros.  Use of these macros does not allow
10873 optimal instruction scheduling.  GNU binutils as of version 2.12
10874 supports a new syntax that allows the compiler to explicitly mark
10875 which relocations should apply to which instructions.  This option
10876 is mostly useful for debugging, as GCC detects the capabilities of
10877 the assembler when it is built and sets the default accordingly.
10878
10879 @item -msmall-data
10880 @itemx -mlarge-data
10881 @opindex msmall-data
10882 @opindex mlarge-data
10883 When @option{-mexplicit-relocs} is in effect, static data is
10884 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
10885 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
10886 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
10887 16-bit relocations off of the @code{$gp} register.  This limits the
10888 size of the small data area to 64KB, but allows the variables to be
10889 directly accessed via a single instruction.
10890
10891 The default is @option{-mlarge-data}.  With this option the data area
10892 is limited to just below 2GB@.  Programs that require more than 2GB of
10893 data must use @code{malloc} or @code{mmap} to allocate the data in the
10894 heap instead of in the program's data segment.
10895
10896 When generating code for shared libraries, @option{-fpic} implies
10897 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
10898
10899 @item -msmall-text
10900 @itemx -mlarge-text
10901 @opindex msmall-text
10902 @opindex mlarge-text
10903 When @option{-msmall-text} is used, the compiler assumes that the
10904 code of the entire program (or shared library) fits in 4MB, and is
10905 thus reachable with a branch instruction.  When @option{-msmall-data}
10906 is used, the compiler can assume that all local symbols share the
10907 same @code{$gp} value, and thus reduce the number of instructions
10908 required for a function call from 4 to 1.
10909
10910 The default is @option{-mlarge-text}.
10911
10912 @item -mcpu=@var{cpu_type}
10913 @opindex mcpu
10914 Set the instruction set and instruction scheduling parameters for
10915 machine type @var{cpu_type}.  You can specify either the @samp{EV}
10916 style name or the corresponding chip number.  GCC supports scheduling
10917 parameters for the EV4, EV5 and EV6 family of processors and will
10918 choose the default values for the instruction set from the processor
10919 you specify.  If you do not specify a processor type, GCC will default
10920 to the processor on which the compiler was built.
10921
10922 Supported values for @var{cpu_type} are
10923
10924 @table @samp
10925 @item ev4
10926 @itemx ev45
10927 @itemx 21064
10928 Schedules as an EV4 and has no instruction set extensions.
10929
10930 @item ev5
10931 @itemx 21164
10932 Schedules as an EV5 and has no instruction set extensions.
10933
10934 @item ev56
10935 @itemx 21164a
10936 Schedules as an EV5 and supports the BWX extension.
10937
10938 @item pca56
10939 @itemx 21164pc
10940 @itemx 21164PC
10941 Schedules as an EV5 and supports the BWX and MAX extensions.
10942
10943 @item ev6
10944 @itemx 21264
10945 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
10946
10947 @item ev67
10948 @itemx 21264a
10949 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
10950 @end table
10951
10952 Native Linux/GNU toolchains also support the value @samp{native},
10953 which selects the best architecture option for the host processor.
10954 @option{-mcpu=native} has no effect if GCC does not recognize
10955 the processor.
10956
10957 @item -mtune=@var{cpu_type}
10958 @opindex mtune
10959 Set only the instruction scheduling parameters for machine type
10960 @var{cpu_type}.  The instruction set is not changed.
10961
10962 Native Linux/GNU toolchains also support the value @samp{native},
10963 which selects the best architecture option for the host processor.
10964 @option{-mtune=native} has no effect if GCC does not recognize
10965 the processor.
10966
10967 @item -mmemory-latency=@var{time}
10968 @opindex mmemory-latency
10969 Sets the latency the scheduler should assume for typical memory
10970 references as seen by the application.  This number is highly
10971 dependent on the memory access patterns used by the application
10972 and the size of the external cache on the machine.
10973
10974 Valid options for @var{time} are
10975
10976 @table @samp
10977 @item @var{number}
10978 A decimal number representing clock cycles.
10979
10980 @item L1
10981 @itemx L2
10982 @itemx L3
10983 @itemx main
10984 The compiler contains estimates of the number of clock cycles for
10985 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
10986 (also called Dcache, Scache, and Bcache), as well as to main memory.
10987 Note that L3 is only valid for EV5.
10988
10989 @end table
10990 @end table
10991
10992 @node DEC Alpha/VMS Options
10993 @subsection DEC Alpha/VMS Options
10994
10995 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
10996
10997 @table @gcctabopt
10998 @item -mvms-return-codes
10999 @opindex mvms-return-codes
11000 Return VMS condition codes from main.  The default is to return POSIX
11001 style condition (e.g.@: error) codes.
11002
11003 @item -mdebug-main=@var{prefix}
11004 @opindex mdebug-main=@var{prefix}
11005 Flag the first routine whose name starts with @var{prefix} as the main
11006 routine for the debugger.
11007
11008 @item -mmalloc64
11009 @opindex mmalloc64
11010 Default to 64bit memory allocation routines.
11011 @end table
11012
11013 @node FR30 Options
11014 @subsection FR30 Options
11015 @cindex FR30 Options
11016
11017 These options are defined specifically for the FR30 port.
11018
11019 @table @gcctabopt
11020
11021 @item -msmall-model
11022 @opindex msmall-model
11023 Use the small address space model.  This can produce smaller code, but
11024 it does assume that all symbolic values and addresses will fit into a
11025 20-bit range.
11026
11027 @item -mno-lsim
11028 @opindex mno-lsim
11029 Assume that run-time support has been provided and so there is no need
11030 to include the simulator library (@file{libsim.a}) on the linker
11031 command line.
11032
11033 @end table
11034
11035 @node FRV Options
11036 @subsection FRV Options
11037 @cindex FRV Options
11038
11039 @table @gcctabopt
11040 @item -mgpr-32
11041 @opindex mgpr-32
11042
11043 Only use the first 32 general purpose registers.
11044
11045 @item -mgpr-64
11046 @opindex mgpr-64
11047
11048 Use all 64 general purpose registers.
11049
11050 @item -mfpr-32
11051 @opindex mfpr-32
11052
11053 Use only the first 32 floating point registers.
11054
11055 @item -mfpr-64
11056 @opindex mfpr-64
11057
11058 Use all 64 floating point registers
11059
11060 @item -mhard-float
11061 @opindex mhard-float
11062
11063 Use hardware instructions for floating point operations.
11064
11065 @item -msoft-float
11066 @opindex msoft-float
11067
11068 Use library routines for floating point operations.
11069
11070 @item -malloc-cc
11071 @opindex malloc-cc
11072
11073 Dynamically allocate condition code registers.
11074
11075 @item -mfixed-cc
11076 @opindex mfixed-cc
11077
11078 Do not try to dynamically allocate condition code registers, only
11079 use @code{icc0} and @code{fcc0}.
11080
11081 @item -mdword
11082 @opindex mdword
11083
11084 Change ABI to use double word insns.
11085
11086 @item -mno-dword
11087 @opindex mno-dword
11088
11089 Do not use double word instructions.
11090
11091 @item -mdouble
11092 @opindex mdouble
11093
11094 Use floating point double instructions.
11095
11096 @item -mno-double
11097 @opindex mno-double
11098
11099 Do not use floating point double instructions.
11100
11101 @item -mmedia
11102 @opindex mmedia
11103
11104 Use media instructions.
11105
11106 @item -mno-media
11107 @opindex mno-media
11108
11109 Do not use media instructions.
11110
11111 @item -mmuladd
11112 @opindex mmuladd
11113
11114 Use multiply and add/subtract instructions.
11115
11116 @item -mno-muladd
11117 @opindex mno-muladd
11118
11119 Do not use multiply and add/subtract instructions.
11120
11121 @item -mfdpic
11122 @opindex mfdpic
11123
11124 Select the FDPIC ABI, that uses function descriptors to represent
11125 pointers to functions.  Without any PIC/PIE-related options, it
11126 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
11127 assumes GOT entries and small data are within a 12-bit range from the
11128 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
11129 are computed with 32 bits.
11130 With a @samp{bfin-elf} target, this option implies @option{-msim}.
11131
11132 @item -minline-plt
11133 @opindex minline-plt
11134
11135 Enable inlining of PLT entries in function calls to functions that are
11136 not known to bind locally.  It has no effect without @option{-mfdpic}.
11137 It's enabled by default if optimizing for speed and compiling for
11138 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
11139 optimization option such as @option{-O3} or above is present in the
11140 command line.
11141
11142 @item -mTLS
11143 @opindex mTLS
11144
11145 Assume a large TLS segment when generating thread-local code.
11146
11147 @item -mtls
11148 @opindex mtls
11149
11150 Do not assume a large TLS segment when generating thread-local code.
11151
11152 @item -mgprel-ro
11153 @opindex mgprel-ro
11154
11155 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
11156 that is known to be in read-only sections.  It's enabled by default,
11157 except for @option{-fpic} or @option{-fpie}: even though it may help
11158 make the global offset table smaller, it trades 1 instruction for 4.
11159 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
11160 one of which may be shared by multiple symbols, and it avoids the need
11161 for a GOT entry for the referenced symbol, so it's more likely to be a
11162 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
11163
11164 @item -multilib-library-pic
11165 @opindex multilib-library-pic
11166
11167 Link with the (library, not FD) pic libraries.  It's implied by
11168 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
11169 @option{-fpic} without @option{-mfdpic}.  You should never have to use
11170 it explicitly.
11171
11172 @item -mlinked-fp
11173 @opindex mlinked-fp
11174
11175 Follow the EABI requirement of always creating a frame pointer whenever
11176 a stack frame is allocated.  This option is enabled by default and can
11177 be disabled with @option{-mno-linked-fp}.
11178
11179 @item -mlong-calls
11180 @opindex mlong-calls
11181
11182 Use indirect addressing to call functions outside the current
11183 compilation unit.  This allows the functions to be placed anywhere
11184 within the 32-bit address space.
11185
11186 @item -malign-labels
11187 @opindex malign-labels
11188
11189 Try to align labels to an 8-byte boundary by inserting nops into the
11190 previous packet.  This option only has an effect when VLIW packing
11191 is enabled.  It doesn't create new packets; it merely adds nops to
11192 existing ones.
11193
11194 @item -mlibrary-pic
11195 @opindex mlibrary-pic
11196
11197 Generate position-independent EABI code.
11198
11199 @item -macc-4
11200 @opindex macc-4
11201
11202 Use only the first four media accumulator registers.
11203
11204 @item -macc-8
11205 @opindex macc-8
11206
11207 Use all eight media accumulator registers.
11208
11209 @item -mpack
11210 @opindex mpack
11211
11212 Pack VLIW instructions.
11213
11214 @item -mno-pack
11215 @opindex mno-pack
11216
11217 Do not pack VLIW instructions.
11218
11219 @item -mno-eflags
11220 @opindex mno-eflags
11221
11222 Do not mark ABI switches in e_flags.
11223
11224 @item -mcond-move
11225 @opindex mcond-move
11226
11227 Enable the use of conditional-move instructions (default).
11228
11229 This switch is mainly for debugging the compiler and will likely be removed
11230 in a future version.
11231
11232 @item -mno-cond-move
11233 @opindex mno-cond-move
11234
11235 Disable the use of conditional-move instructions.
11236
11237 This switch is mainly for debugging the compiler and will likely be removed
11238 in a future version.
11239
11240 @item -mscc
11241 @opindex mscc
11242
11243 Enable the use of conditional set instructions (default).
11244
11245 This switch is mainly for debugging the compiler and will likely be removed
11246 in a future version.
11247
11248 @item -mno-scc
11249 @opindex mno-scc
11250
11251 Disable the use of conditional set instructions.
11252
11253 This switch is mainly for debugging the compiler and will likely be removed
11254 in a future version.
11255
11256 @item -mcond-exec
11257 @opindex mcond-exec
11258
11259 Enable the use of conditional execution (default).
11260
11261 This switch is mainly for debugging the compiler and will likely be removed
11262 in a future version.
11263
11264 @item -mno-cond-exec
11265 @opindex mno-cond-exec
11266
11267 Disable the use of conditional execution.
11268
11269 This switch is mainly for debugging the compiler and will likely be removed
11270 in a future version.
11271
11272 @item -mvliw-branch
11273 @opindex mvliw-branch
11274
11275 Run a pass to pack branches into VLIW instructions (default).
11276
11277 This switch is mainly for debugging the compiler and will likely be removed
11278 in a future version.
11279
11280 @item -mno-vliw-branch
11281 @opindex mno-vliw-branch
11282
11283 Do not run a pass to pack branches into VLIW instructions.
11284
11285 This switch is mainly for debugging the compiler and will likely be removed
11286 in a future version.
11287
11288 @item -mmulti-cond-exec
11289 @opindex mmulti-cond-exec
11290
11291 Enable optimization of @code{&&} and @code{||} in conditional execution
11292 (default).
11293
11294 This switch is mainly for debugging the compiler and will likely be removed
11295 in a future version.
11296
11297 @item -mno-multi-cond-exec
11298 @opindex mno-multi-cond-exec
11299
11300 Disable optimization of @code{&&} and @code{||} in conditional execution.
11301
11302 This switch is mainly for debugging the compiler and will likely be removed
11303 in a future version.
11304
11305 @item -mnested-cond-exec
11306 @opindex mnested-cond-exec
11307
11308 Enable nested conditional execution optimizations (default).
11309
11310 This switch is mainly for debugging the compiler and will likely be removed
11311 in a future version.
11312
11313 @item -mno-nested-cond-exec
11314 @opindex mno-nested-cond-exec
11315
11316 Disable nested conditional execution optimizations.
11317
11318 This switch is mainly for debugging the compiler and will likely be removed
11319 in a future version.
11320
11321 @item -moptimize-membar
11322 @opindex moptimize-membar
11323
11324 This switch removes redundant @code{membar} instructions from the
11325 compiler generated code.  It is enabled by default.
11326
11327 @item -mno-optimize-membar
11328 @opindex mno-optimize-membar
11329
11330 This switch disables the automatic removal of redundant @code{membar}
11331 instructions from the generated code.
11332
11333 @item -mtomcat-stats
11334 @opindex mtomcat-stats
11335
11336 Cause gas to print out tomcat statistics.
11337
11338 @item -mcpu=@var{cpu}
11339 @opindex mcpu
11340
11341 Select the processor type for which to generate code.  Possible values are
11342 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
11343 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
11344
11345 @end table
11346
11347 @node GNU/Linux Options
11348 @subsection GNU/Linux Options
11349
11350 These @samp{-m} options are defined for GNU/Linux targets:
11351
11352 @table @gcctabopt
11353 @item -mglibc
11354 @opindex mglibc
11355 Use the GNU C library instead of uClibc.  This is the default except
11356 on @samp{*-*-linux-*uclibc*} targets.
11357
11358 @item -muclibc
11359 @opindex muclibc
11360 Use uClibc instead of the GNU C library.  This is the default on
11361 @samp{*-*-linux-*uclibc*} targets.
11362 @end table
11363
11364 @node H8/300 Options
11365 @subsection H8/300 Options
11366
11367 These @samp{-m} options are defined for the H8/300 implementations:
11368
11369 @table @gcctabopt
11370 @item -mrelax
11371 @opindex mrelax
11372 Shorten some address references at link time, when possible; uses the
11373 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
11374 ld, Using ld}, for a fuller description.
11375
11376 @item -mh
11377 @opindex mh
11378 Generate code for the H8/300H@.
11379
11380 @item -ms
11381 @opindex ms
11382 Generate code for the H8S@.
11383
11384 @item -mn
11385 @opindex mn
11386 Generate code for the H8S and H8/300H in the normal mode.  This switch
11387 must be used either with @option{-mh} or @option{-ms}.
11388
11389 @item -ms2600
11390 @opindex ms2600
11391 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
11392
11393 @item -mint32
11394 @opindex mint32
11395 Make @code{int} data 32 bits by default.
11396
11397 @item -malign-300
11398 @opindex malign-300
11399 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
11400 The default for the H8/300H and H8S is to align longs and floats on 4
11401 byte boundaries.
11402 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
11403 This option has no effect on the H8/300.
11404 @end table
11405
11406 @node HPPA Options
11407 @subsection HPPA Options
11408 @cindex HPPA Options
11409
11410 These @samp{-m} options are defined for the HPPA family of computers:
11411
11412 @table @gcctabopt
11413 @item -march=@var{architecture-type}
11414 @opindex march
11415 Generate code for the specified architecture.  The choices for
11416 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
11417 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
11418 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
11419 architecture option for your machine.  Code compiled for lower numbered
11420 architectures will run on higher numbered architectures, but not the
11421 other way around.
11422
11423 @item -mpa-risc-1-0
11424 @itemx -mpa-risc-1-1
11425 @itemx -mpa-risc-2-0
11426 @opindex mpa-risc-1-0
11427 @opindex mpa-risc-1-1
11428 @opindex mpa-risc-2-0
11429 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
11430
11431 @item -mbig-switch
11432 @opindex mbig-switch
11433 Generate code suitable for big switch tables.  Use this option only if
11434 the assembler/linker complain about out of range branches within a switch
11435 table.
11436
11437 @item -mjump-in-delay
11438 @opindex mjump-in-delay
11439 Fill delay slots of function calls with unconditional jump instructions
11440 by modifying the return pointer for the function call to be the target
11441 of the conditional jump.
11442
11443 @item -mdisable-fpregs
11444 @opindex mdisable-fpregs
11445 Prevent floating point registers from being used in any manner.  This is
11446 necessary for compiling kernels which perform lazy context switching of
11447 floating point registers.  If you use this option and attempt to perform
11448 floating point operations, the compiler will abort.
11449
11450 @item -mdisable-indexing
11451 @opindex mdisable-indexing
11452 Prevent the compiler from using indexing address modes.  This avoids some
11453 rather obscure problems when compiling MIG generated code under MACH@.
11454
11455 @item -mno-space-regs
11456 @opindex mno-space-regs
11457 Generate code that assumes the target has no space registers.  This allows
11458 GCC to generate faster indirect calls and use unscaled index address modes.
11459
11460 Such code is suitable for level 0 PA systems and kernels.
11461
11462 @item -mfast-indirect-calls
11463 @opindex mfast-indirect-calls
11464 Generate code that assumes calls never cross space boundaries.  This
11465 allows GCC to emit code which performs faster indirect calls.
11466
11467 This option will not work in the presence of shared libraries or nested
11468 functions.
11469
11470 @item -mfixed-range=@var{register-range}
11471 @opindex mfixed-range
11472 Generate code treating the given register range as fixed registers.
11473 A fixed register is one that the register allocator can not use.  This is
11474 useful when compiling kernel code.  A register range is specified as
11475 two registers separated by a dash.  Multiple register ranges can be
11476 specified separated by a comma.
11477
11478 @item -mlong-load-store
11479 @opindex mlong-load-store
11480 Generate 3-instruction load and store sequences as sometimes required by
11481 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
11482 the HP compilers.
11483
11484 @item -mportable-runtime
11485 @opindex mportable-runtime
11486 Use the portable calling conventions proposed by HP for ELF systems.
11487
11488 @item -mgas
11489 @opindex mgas
11490 Enable the use of assembler directives only GAS understands.
11491
11492 @item -mschedule=@var{cpu-type}
11493 @opindex mschedule
11494 Schedule code according to the constraints for the machine type
11495 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
11496 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
11497 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
11498 proper scheduling option for your machine.  The default scheduling is
11499 @samp{8000}.
11500
11501 @item -mlinker-opt
11502 @opindex mlinker-opt
11503 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
11504 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
11505 linkers in which they give bogus error messages when linking some programs.
11506
11507 @item -msoft-float
11508 @opindex msoft-float
11509 Generate output containing library calls for floating point.
11510 @strong{Warning:} the requisite libraries are not available for all HPPA
11511 targets.  Normally the facilities of the machine's usual C compiler are
11512 used, but this cannot be done directly in cross-compilation.  You must make
11513 your own arrangements to provide suitable library functions for
11514 cross-compilation.
11515
11516 @option{-msoft-float} changes the calling convention in the output file;
11517 therefore, it is only useful if you compile @emph{all} of a program with
11518 this option.  In particular, you need to compile @file{libgcc.a}, the
11519 library that comes with GCC, with @option{-msoft-float} in order for
11520 this to work.
11521
11522 @item -msio
11523 @opindex msio
11524 Generate the predefine, @code{_SIO}, for server IO@.  The default is
11525 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
11526 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
11527 options are available under HP-UX and HI-UX@.
11528
11529 @item -mgnu-ld
11530 @opindex mgnu-ld
11531 Use GNU ld specific options.  This passes @option{-shared} to ld when
11532 building a shared library.  It is the default when GCC is configured,
11533 explicitly or implicitly, with the GNU linker.  This option does not
11534 have any affect on which ld is called, it only changes what parameters
11535 are passed to that ld.  The ld that is called is determined by the
11536 @option{--with-ld} configure option, GCC's program search path, and
11537 finally by the user's @env{PATH}.  The linker used by GCC can be printed
11538 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
11539 on the 64 bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11540
11541 @item -mhp-ld
11542 @opindex mhp-ld
11543 Use HP ld specific options.  This passes @option{-b} to ld when building
11544 a shared library and passes @option{+Accept TypeMismatch} to ld on all
11545 links.  It is the default when GCC is configured, explicitly or
11546 implicitly, with the HP linker.  This option does not have any affect on
11547 which ld is called, it only changes what parameters are passed to that
11548 ld.  The ld that is called is determined by the @option{--with-ld}
11549 configure option, GCC's program search path, and finally by the user's
11550 @env{PATH}.  The linker used by GCC can be printed using @samp{which
11551 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
11552 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
11553
11554 @item -mlong-calls
11555 @opindex mno-long-calls
11556 Generate code that uses long call sequences.  This ensures that a call
11557 is always able to reach linker generated stubs.  The default is to generate
11558 long calls only when the distance from the call site to the beginning
11559 of the function or translation unit, as the case may be, exceeds a
11560 predefined limit set by the branch type being used.  The limits for
11561 normal calls are 7,600,000 and 240,000 bytes, respectively for the
11562 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
11563 240,000 bytes.
11564
11565 Distances are measured from the beginning of functions when using the
11566 @option{-ffunction-sections} option, or when using the @option{-mgas}
11567 and @option{-mno-portable-runtime} options together under HP-UX with
11568 the SOM linker.
11569
11570 It is normally not desirable to use this option as it will degrade
11571 performance.  However, it may be useful in large applications,
11572 particularly when partial linking is used to build the application.
11573
11574 The types of long calls used depends on the capabilities of the
11575 assembler and linker, and the type of code being generated.  The
11576 impact on systems that support long absolute calls, and long pic
11577 symbol-difference or pc-relative calls should be relatively small.
11578 However, an indirect call is used on 32-bit ELF systems in pic code
11579 and it is quite long.
11580
11581 @item -munix=@var{unix-std}
11582 @opindex march
11583 Generate compiler predefines and select a startfile for the specified
11584 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
11585 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
11586 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
11587 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
11588 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
11589 and later.
11590
11591 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
11592 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
11593 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
11594 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
11595 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
11596 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
11597
11598 It is @emph{important} to note that this option changes the interfaces
11599 for various library routines.  It also affects the operational behavior
11600 of the C library.  Thus, @emph{extreme} care is needed in using this
11601 option.
11602
11603 Library code that is intended to operate with more than one UNIX
11604 standard must test, set and restore the variable @var{__xpg4_extended_mask}
11605 as appropriate.  Most GNU software doesn't provide this capability.
11606
11607 @item -nolibdld
11608 @opindex nolibdld
11609 Suppress the generation of link options to search libdld.sl when the
11610 @option{-static} option is specified on HP-UX 10 and later.
11611
11612 @item -static
11613 @opindex static
11614 The HP-UX implementation of setlocale in libc has a dependency on
11615 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
11616 when the @option{-static} option is specified, special link options
11617 are needed to resolve this dependency.
11618
11619 On HP-UX 10 and later, the GCC driver adds the necessary options to
11620 link with libdld.sl when the @option{-static} option is specified.
11621 This causes the resulting binary to be dynamic.  On the 64-bit port,
11622 the linkers generate dynamic binaries by default in any case.  The
11623 @option{-nolibdld} option can be used to prevent the GCC driver from
11624 adding these link options.
11625
11626 @item -threads
11627 @opindex threads
11628 Add support for multithreading with the @dfn{dce thread} library
11629 under HP-UX@.  This option sets flags for both the preprocessor and
11630 linker.
11631 @end table
11632
11633 @node i386 and x86-64 Options
11634 @subsection Intel 386 and AMD x86-64 Options
11635 @cindex i386 Options
11636 @cindex x86-64 Options
11637 @cindex Intel 386 Options
11638 @cindex AMD x86-64 Options
11639
11640 These @samp{-m} options are defined for the i386 and x86-64 family of
11641 computers:
11642
11643 @table @gcctabopt
11644 @item -mtune=@var{cpu-type}
11645 @opindex mtune
11646 Tune to @var{cpu-type} everything applicable about the generated code, except
11647 for the ABI and the set of available instructions.  The choices for
11648 @var{cpu-type} are:
11649 @table @emph
11650 @item generic
11651 Produce code optimized for the most common IA32/AMD64/EM64T processors.
11652 If you know the CPU on which your code will run, then you should use
11653 the corresponding @option{-mtune} option instead of
11654 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
11655 of your application will have, then you should use this option.
11656
11657 As new processors are deployed in the marketplace, the behavior of this
11658 option will change.  Therefore, if you upgrade to a newer version of
11659 GCC, the code generated option will change to reflect the processors
11660 that were most common when that version of GCC was released.
11661
11662 There is no @option{-march=generic} option because @option{-march}
11663 indicates the instruction set the compiler can use, and there is no
11664 generic instruction set applicable to all processors.  In contrast,
11665 @option{-mtune} indicates the processor (or, in this case, collection of
11666 processors) for which the code is optimized.
11667 @item native
11668 This selects the CPU to tune for at compilation time by determining
11669 the processor type of the compiling machine.  Using @option{-mtune=native}
11670 will produce code optimized for the local machine under the constraints
11671 of the selected instruction set.  Using @option{-march=native} will
11672 enable all instruction subsets supported by the local machine (hence
11673 the result might not run on different machines).
11674 @item i386
11675 Original Intel's i386 CPU@.
11676 @item i486
11677 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
11678 @item i586, pentium
11679 Intel Pentium CPU with no MMX support.
11680 @item pentium-mmx
11681 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
11682 @item pentiumpro
11683 Intel PentiumPro CPU@.
11684 @item i686
11685 Same as @code{generic}, but when used as @code{march} option, PentiumPro
11686 instruction set will be used, so the code will run on all i686 family chips.
11687 @item pentium2
11688 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
11689 @item pentium3, pentium3m
11690 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
11691 support.
11692 @item pentium-m
11693 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
11694 support.  Used by Centrino notebooks.
11695 @item pentium4, pentium4m
11696 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
11697 @item prescott
11698 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
11699 set support.
11700 @item nocona
11701 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
11702 SSE2 and SSE3 instruction set support.
11703 @item core2
11704 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11705 instruction set support.
11706 @item atom
11707 Intel Atom CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
11708 instruction set support.
11709 @item k6
11710 AMD K6 CPU with MMX instruction set support.
11711 @item k6-2, k6-3
11712 Improved versions of AMD K6 CPU with MMX and 3dNOW!@: instruction set support.
11713 @item athlon, athlon-tbird
11714 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and SSE prefetch instructions
11715 support.
11716 @item athlon-4, athlon-xp, athlon-mp
11717 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW!@: and full SSE
11718 instruction set support.
11719 @item k8, opteron, athlon64, athlon-fx
11720 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
11721 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW!@: and 64-bit instruction set extensions.)
11722 @item k8-sse3, opteron-sse3, athlon64-sse3
11723 Improved versions of k8, opteron and athlon64 with SSE3 instruction set support.
11724 @item amdfam10, barcelona
11725 AMD Family 10h core based CPUs with x86-64 instruction set support.  (This
11726 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3dNOW!, enhanced 3dNOW!, ABM and 64-bit
11727 instruction set extensions.)
11728 @item winchip-c6
11729 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
11730 set support.
11731 @item winchip2
11732 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!@:
11733 instruction set support.
11734 @item c3
11735 Via C3 CPU with MMX and 3dNOW!@: instruction set support.  (No scheduling is
11736 implemented for this chip.)
11737 @item c3-2
11738 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
11739 implemented for this chip.)
11740 @item geode
11741 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
11742 @end table
11743
11744 While picking a specific @var{cpu-type} will schedule things appropriately
11745 for that particular chip, the compiler will not generate any code that
11746 does not run on the i386 without the @option{-march=@var{cpu-type}} option
11747 being used.
11748
11749 @item -march=@var{cpu-type}
11750 @opindex march
11751 Generate instructions for the machine type @var{cpu-type}.  The choices
11752 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
11753 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
11754
11755 @item -mcpu=@var{cpu-type}
11756 @opindex mcpu
11757 A deprecated synonym for @option{-mtune}.
11758
11759 @item -mfpmath=@var{unit}
11760 @opindex mfpmath
11761 Generate floating point arithmetics for selected unit @var{unit}.  The choices
11762 for @var{unit} are:
11763
11764 @table @samp
11765 @item 387
11766 Use the standard 387 floating point coprocessor present majority of chips and
11767 emulated otherwise.  Code compiled with this option will run almost everywhere.
11768 The temporary results are computed in 80bit precision instead of precision
11769 specified by the type resulting in slightly different results compared to most
11770 of other chips.  See @option{-ffloat-store} for more detailed description.
11771
11772 This is the default choice for i386 compiler.
11773
11774 @item sse
11775 Use scalar floating point instructions present in the SSE instruction set.
11776 This instruction set is supported by Pentium3 and newer chips, in the AMD line
11777 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
11778 instruction set supports only single precision arithmetics, thus the double and
11779 extended precision arithmetics is still done using 387.  Later version, present
11780 only in Pentium4 and the future AMD x86-64 chips supports double precision
11781 arithmetics too.
11782
11783 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
11784 or @option{-msse2} switches to enable SSE extensions and make this option
11785 effective.  For the x86-64 compiler, these extensions are enabled by default.
11786
11787 The resulting code should be considerably faster in the majority of cases and avoid
11788 the numerical instability problems of 387 code, but may break some existing
11789 code that expects temporaries to be 80bit.
11790
11791 This is the default choice for the x86-64 compiler.
11792
11793 @item sse,387
11794 @itemx sse+387
11795 @itemx both
11796 Attempt to utilize both instruction sets at once.  This effectively double the
11797 amount of available registers and on chips with separate execution units for
11798 387 and SSE the execution resources too.  Use this option with care, as it is
11799 still experimental, because the GCC register allocator does not model separate
11800 functional units well resulting in instable performance.
11801 @end table
11802
11803 @item -masm=@var{dialect}
11804 @opindex masm=@var{dialect}
11805 Output asm instructions using selected @var{dialect}.  Supported
11806 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
11807 not support @samp{intel}.
11808
11809 @item -mieee-fp
11810 @itemx -mno-ieee-fp
11811 @opindex mieee-fp
11812 @opindex mno-ieee-fp
11813 Control whether or not the compiler uses IEEE floating point
11814 comparisons.  These handle correctly the case where the result of a
11815 comparison is unordered.
11816
11817 @item -msoft-float
11818 @opindex msoft-float
11819 Generate output containing library calls for floating point.
11820 @strong{Warning:} the requisite libraries are not part of GCC@.
11821 Normally the facilities of the machine's usual C compiler are used, but
11822 this can't be done directly in cross-compilation.  You must make your
11823 own arrangements to provide suitable library functions for
11824 cross-compilation.
11825
11826 On machines where a function returns floating point results in the 80387
11827 register stack, some floating point opcodes may be emitted even if
11828 @option{-msoft-float} is used.
11829
11830 @item -mno-fp-ret-in-387
11831 @opindex mno-fp-ret-in-387
11832 Do not use the FPU registers for return values of functions.
11833
11834 The usual calling convention has functions return values of types
11835 @code{float} and @code{double} in an FPU register, even if there
11836 is no FPU@.  The idea is that the operating system should emulate
11837 an FPU@.
11838
11839 The option @option{-mno-fp-ret-in-387} causes such values to be returned
11840 in ordinary CPU registers instead.
11841
11842 @item -mno-fancy-math-387
11843 @opindex mno-fancy-math-387
11844 Some 387 emulators do not support the @code{sin}, @code{cos} and
11845 @code{sqrt} instructions for the 387.  Specify this option to avoid
11846 generating those instructions.  This option is the default on FreeBSD,
11847 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
11848 indicates that the target cpu will always have an FPU and so the
11849 instruction will not need emulation.  As of revision 2.6.1, these
11850 instructions are not generated unless you also use the
11851 @option{-funsafe-math-optimizations} switch.
11852
11853 @item -malign-double
11854 @itemx -mno-align-double
11855 @opindex malign-double
11856 @opindex mno-align-double
11857 Control whether GCC aligns @code{double}, @code{long double}, and
11858 @code{long long} variables on a two word boundary or a one word
11859 boundary.  Aligning @code{double} variables on a two word boundary will
11860 produce code that runs somewhat faster on a @samp{Pentium} at the
11861 expense of more memory.
11862
11863 On x86-64, @option{-malign-double} is enabled by default.
11864
11865 @strong{Warning:} if you use the @option{-malign-double} switch,
11866 structures containing the above types will be aligned differently than
11867 the published application binary interface specifications for the 386
11868 and will not be binary compatible with structures in code compiled
11869 without that switch.
11870
11871 @item -m96bit-long-double
11872 @itemx -m128bit-long-double
11873 @opindex m96bit-long-double
11874 @opindex m128bit-long-double
11875 These switches control the size of @code{long double} type.  The i386
11876 application binary interface specifies the size to be 96 bits,
11877 so @option{-m96bit-long-double} is the default in 32 bit mode.
11878
11879 Modern architectures (Pentium and newer) would prefer @code{long double}
11880 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
11881 conforming to the ABI, this would not be possible.  So specifying a
11882 @option{-m128bit-long-double} will align @code{long double}
11883 to a 16 byte boundary by padding the @code{long double} with an additional
11884 32 bit zero.
11885
11886 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
11887 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
11888
11889 Notice that neither of these options enable any extra precision over the x87
11890 standard of 80 bits for a @code{long double}.
11891
11892 @strong{Warning:} if you override the default value for your target ABI, the
11893 structures and arrays containing @code{long double} variables will change
11894 their size as well as function calling convention for function taking
11895 @code{long double} will be modified.  Hence they will not be binary
11896 compatible with arrays or structures in code compiled without that switch.
11897
11898 @item -mlarge-data-threshold=@var{number}
11899 @opindex mlarge-data-threshold=@var{number}
11900 When @option{-mcmodel=medium} is specified, the data greater than
11901 @var{threshold} are placed in large data section.  This value must be the
11902 same across all object linked into the binary and defaults to 65535.
11903
11904 @item -mrtd
11905 @opindex mrtd
11906 Use a different function-calling convention, in which functions that
11907 take a fixed number of arguments return with the @code{ret} @var{num}
11908 instruction, which pops their arguments while returning.  This saves one
11909 instruction in the caller since there is no need to pop the arguments
11910 there.
11911
11912 You can specify that an individual function is called with this calling
11913 sequence with the function attribute @samp{stdcall}.  You can also
11914 override the @option{-mrtd} option by using the function attribute
11915 @samp{cdecl}.  @xref{Function Attributes}.
11916
11917 @strong{Warning:} this calling convention is incompatible with the one
11918 normally used on Unix, so you cannot use it if you need to call
11919 libraries compiled with the Unix compiler.
11920
11921 Also, you must provide function prototypes for all functions that
11922 take variable numbers of arguments (including @code{printf});
11923 otherwise incorrect code will be generated for calls to those
11924 functions.
11925
11926 In addition, seriously incorrect code will result if you call a
11927 function with too many arguments.  (Normally, extra arguments are
11928 harmlessly ignored.)
11929
11930 @item -mregparm=@var{num}
11931 @opindex mregparm
11932 Control how many registers are used to pass integer arguments.  By
11933 default, no registers are used to pass arguments, and at most 3
11934 registers can be used.  You can control this behavior for a specific
11935 function by using the function attribute @samp{regparm}.
11936 @xref{Function Attributes}.
11937
11938 @strong{Warning:} if you use this switch, and
11939 @var{num} is nonzero, then you must build all modules with the same
11940 value, including any libraries.  This includes the system libraries and
11941 startup modules.
11942
11943 @item -msseregparm
11944 @opindex msseregparm
11945 Use SSE register passing conventions for float and double arguments
11946 and return values.  You can control this behavior for a specific
11947 function by using the function attribute @samp{sseregparm}.
11948 @xref{Function Attributes}.
11949
11950 @strong{Warning:} if you use this switch then you must build all
11951 modules with the same value, including any libraries.  This includes
11952 the system libraries and startup modules.
11953
11954 @item -mpc32
11955 @itemx -mpc64
11956 @itemx -mpc80
11957 @opindex mpc32
11958 @opindex mpc64
11959 @opindex mpc80
11960
11961 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
11962 is specified, the significands of results of floating-point operations are
11963 rounded to 24 bits (single precision); @option{-mpc64} rounds the
11964 significands of results of floating-point operations to 53 bits (double
11965 precision) and @option{-mpc80} rounds the significands of results of
11966 floating-point operations to 64 bits (extended double precision), which is
11967 the default.  When this option is used, floating-point operations in higher
11968 precisions are not available to the programmer without setting the FPU
11969 control word explicitly.
11970
11971 Setting the rounding of floating-point operations to less than the default
11972 80 bits can speed some programs by 2% or more.  Note that some mathematical
11973 libraries assume that extended precision (80 bit) floating-point operations
11974 are enabled by default; routines in such libraries could suffer significant
11975 loss of accuracy, typically through so-called "catastrophic cancellation",
11976 when this option is used to set the precision to less than extended precision.
11977
11978 @item -mstackrealign
11979 @opindex mstackrealign
11980 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
11981 option will generate an alternate prologue and epilogue that realigns the
11982 runtime stack if necessary.  This supports mixing legacy codes that keep
11983 a 4-byte aligned stack with modern codes that keep a 16-byte stack for
11984 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
11985 applicable to individual functions.
11986
11987 @item -mpreferred-stack-boundary=@var{num}
11988 @opindex mpreferred-stack-boundary
11989 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
11990 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
11991 the default is 4 (16 bytes or 128 bits).
11992
11993 @item -mincoming-stack-boundary=@var{num}
11994 @opindex mincoming-stack-boundary
11995 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
11996 boundary.  If @option{-mincoming-stack-boundary} is not specified,
11997 the one specified by @option{-mpreferred-stack-boundary} will be used.
11998
11999 On Pentium and PentiumPro, @code{double} and @code{long double} values
12000 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
12001 suffer significant run time performance penalties.  On Pentium III, the
12002 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
12003 properly if it is not 16 byte aligned.
12004
12005 To ensure proper alignment of this values on the stack, the stack boundary
12006 must be as aligned as that required by any value stored on the stack.
12007 Further, every function must be generated such that it keeps the stack
12008 aligned.  Thus calling a function compiled with a higher preferred
12009 stack boundary from a function compiled with a lower preferred stack
12010 boundary will most likely misalign the stack.  It is recommended that
12011 libraries that use callbacks always use the default setting.
12012
12013 This extra alignment does consume extra stack space, and generally
12014 increases code size.  Code that is sensitive to stack space usage, such
12015 as embedded systems and operating system kernels, may want to reduce the
12016 preferred alignment to @option{-mpreferred-stack-boundary=2}.
12017
12018 @item -mmmx
12019 @itemx -mno-mmx
12020 @itemx -msse
12021 @itemx -mno-sse
12022 @itemx -msse2
12023 @itemx -mno-sse2
12024 @itemx -msse3
12025 @itemx -mno-sse3
12026 @itemx -mssse3
12027 @itemx -mno-ssse3
12028 @itemx -msse4.1
12029 @itemx -mno-sse4.1
12030 @itemx -msse4.2
12031 @itemx -mno-sse4.2
12032 @itemx -msse4
12033 @itemx -mno-sse4
12034 @itemx -mavx
12035 @itemx -mno-avx
12036 @itemx -maes
12037 @itemx -mno-aes
12038 @itemx -mpclmul
12039 @itemx -mno-pclmul
12040 @itemx -msse4a
12041 @itemx -mno-sse4a
12042 @itemx -mfma4
12043 @itemx -mno-fma4
12044 @itemx -mxop
12045 @itemx -mno-xop
12046 @itemx -mlwp
12047 @itemx -mno-lwp
12048 @itemx -m3dnow
12049 @itemx -mno-3dnow
12050 @itemx -mpopcnt
12051 @itemx -mno-popcnt
12052 @itemx -mabm
12053 @itemx -mno-abm
12054 @opindex mmmx
12055 @opindex mno-mmx
12056 @opindex msse
12057 @opindex mno-sse
12058 @opindex m3dnow
12059 @opindex mno-3dnow
12060 These switches enable or disable the use of instructions in the MMX,
12061 SSE, SSE2, SSE3, SSSE3, SSE4.1, AVX, AES, PCLMUL, SSE4A, FMA4, XOP,
12062 LWP, ABM or 3DNow!@: extended instruction sets.
12063 These extensions are also available as built-in functions: see
12064 @ref{X86 Built-in Functions}, for details of the functions enabled and
12065 disabled by these switches.
12066
12067 To have SSE/SSE2 instructions generated automatically from floating-point
12068 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
12069
12070 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
12071 generates new AVX instructions or AVX equivalence for all SSEx instructions
12072 when needed.
12073
12074 These options will enable GCC to use these extended instructions in
12075 generated code, even without @option{-mfpmath=sse}.  Applications which
12076 perform runtime CPU detection must compile separate files for each
12077 supported architecture, using the appropriate flags.  In particular,
12078 the file containing the CPU detection code should be compiled without
12079 these options.
12080
12081 @item -mfused-madd
12082 @itemx -mno-fused-madd
12083 @opindex mfused-madd
12084 @opindex mno-fused-madd
12085 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12086 instructions.  The default is to use these instructions.
12087
12088 @item -mcld
12089 @opindex mcld
12090 This option instructs GCC to emit a @code{cld} instruction in the prologue
12091 of functions that use string instructions.  String instructions depend on
12092 the DF flag to select between autoincrement or autodecrement mode.  While the
12093 ABI specifies the DF flag to be cleared on function entry, some operating
12094 systems violate this specification by not clearing the DF flag in their
12095 exception dispatchers.  The exception handler can be invoked with the DF flag
12096 set which leads to wrong direction mode, when string instructions are used.
12097 This option can be enabled by default on 32-bit x86 targets by configuring
12098 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
12099 instructions can be suppressed with the @option{-mno-cld} compiler option
12100 in this case.
12101
12102 @item -mcx16
12103 @opindex mcx16
12104 This option will enable GCC to use CMPXCHG16B instruction in generated code.
12105 CMPXCHG16B allows for atomic operations on 128-bit double quadword (or oword)
12106 data types.  This is useful for high resolution counters that could be updated
12107 by multiple processors (or cores).  This instruction is generated as part of
12108 atomic built-in functions: see @ref{Atomic Builtins} for details.
12109
12110 @item -msahf
12111 @opindex msahf
12112 This option will enable GCC to use SAHF instruction in generated 64-bit code.
12113 Early Intel CPUs with Intel 64 lacked LAHF and SAHF instructions supported
12114 by AMD64 until introduction of Pentium 4 G1 step in December 2005.  LAHF and
12115 SAHF are load and store instructions, respectively, for certain status flags.
12116 In 64-bit mode, SAHF instruction is used to optimize @code{fmod}, @code{drem}
12117 or @code{remainder} built-in functions: see @ref{Other Builtins} for details.
12118
12119 @item -mmovbe
12120 @opindex mmovbe
12121 This option will enable GCC to use movbe instruction to implement
12122 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
12123
12124 @item -mcrc32
12125 @opindex mcrc32
12126 This option will enable built-in functions, @code{__builtin_ia32_crc32qi},
12127 @code{__builtin_ia32_crc32hi}. @code{__builtin_ia32_crc32si} and
12128 @code{__builtin_ia32_crc32di} to generate the crc32 machine instruction.
12129
12130 @item -mrecip
12131 @opindex mrecip
12132 This option will enable GCC to use RCPSS and RSQRTSS instructions (and their
12133 vectorized variants RCPPS and RSQRTPS) with an additional Newton-Raphson step
12134 to increase precision instead of DIVSS and SQRTSS (and their vectorized
12135 variants) for single precision floating point arguments.  These instructions
12136 are generated only when @option{-funsafe-math-optimizations} is enabled
12137 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
12138 Note that while the throughput of the sequence is higher than the throughput
12139 of the non-reciprocal instruction, the precision of the sequence can be
12140 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
12141
12142 Note that GCC implements 1.0f/sqrtf(x) in terms of RSQRTSS (or RSQRTPS)
12143 already with @option{-ffast-math} (or the above option combination), and
12144 doesn't need @option{-mrecip}.
12145
12146 @item -mveclibabi=@var{type}
12147 @opindex mveclibabi
12148 Specifies the ABI type to use for vectorizing intrinsics using an
12149 external library.  Supported types are @code{svml} for the Intel short
12150 vector math library and @code{acml} for the AMD math core library style
12151 of interfacing.  GCC will currently emit calls to @code{vmldExp2},
12152 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
12153 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
12154 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
12155 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
12156 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
12157 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
12158 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
12159 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
12160 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
12161 function type when @option{-mveclibabi=svml} is used and @code{__vrd2_sin},
12162 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
12163 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
12164 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
12165 @code{__vrs4_log10f} and @code{__vrs4_powf} for corresponding function type
12166 when @option{-mveclibabi=acml} is used. Both @option{-ftree-vectorize} and
12167 @option{-funsafe-math-optimizations} have to be enabled. A SVML or ACML ABI
12168 compatible library will have to be specified at link time.
12169
12170 @item -mabi=@var{name}
12171 @opindex mabi
12172 Generate code for the specified calling convention.  Permissible values
12173 are: @samp{sysv} for the ABI used on GNU/Linux and other systems and
12174 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
12175 ABI when targeting Windows.  On all other systems, the default is the
12176 SYSV ABI.  You can control this behavior for a specific function by
12177 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
12178 @xref{Function Attributes}.
12179
12180 @item -mpush-args
12181 @itemx -mno-push-args
12182 @opindex mpush-args
12183 @opindex mno-push-args
12184 Use PUSH operations to store outgoing parameters.  This method is shorter
12185 and usually equally fast as method using SUB/MOV operations and is enabled
12186 by default.  In some cases disabling it may improve performance because of
12187 improved scheduling and reduced dependencies.
12188
12189 @item -maccumulate-outgoing-args
12190 @opindex maccumulate-outgoing-args
12191 If enabled, the maximum amount of space required for outgoing arguments will be
12192 computed in the function prologue.  This is faster on most modern CPUs
12193 because of reduced dependencies, improved scheduling and reduced stack usage
12194 when preferred stack boundary is not equal to 2.  The drawback is a notable
12195 increase in code size.  This switch implies @option{-mno-push-args}.
12196
12197 @item -mthreads
12198 @opindex mthreads
12199 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
12200 on thread-safe exception handling must compile and link all code with the
12201 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
12202 @option{-D_MT}; when linking, it links in a special thread helper library
12203 @option{-lmingwthrd} which cleans up per thread exception handling data.
12204
12205 @item -mno-align-stringops
12206 @opindex mno-align-stringops
12207 Do not align destination of inlined string operations.  This switch reduces
12208 code size and improves performance in case the destination is already aligned,
12209 but GCC doesn't know about it.
12210
12211 @item -minline-all-stringops
12212 @opindex minline-all-stringops
12213 By default GCC inlines string operations only when destination is known to be
12214 aligned at least to 4 byte boundary.  This enables more inlining, increase code
12215 size, but may improve performance of code that depends on fast memcpy, strlen
12216 and memset for short lengths.
12217
12218 @item -minline-stringops-dynamically
12219 @opindex minline-stringops-dynamically
12220 For string operation of unknown size, inline runtime checks so for small
12221 blocks inline code is used, while for large blocks library call is used.
12222
12223 @item -mstringop-strategy=@var{alg}
12224 @opindex mstringop-strategy=@var{alg}
12225 Overwrite internal decision heuristic about particular algorithm to inline
12226 string operation with.  The allowed values are @code{rep_byte},
12227 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
12228 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
12229 expanding inline loop, @code{libcall} for always expanding library call.
12230
12231 @item -momit-leaf-frame-pointer
12232 @opindex momit-leaf-frame-pointer
12233 Don't keep the frame pointer in a register for leaf functions.  This
12234 avoids the instructions to save, set up and restore frame pointers and
12235 makes an extra register available in leaf functions.  The option
12236 @option{-fomit-frame-pointer} removes the frame pointer for all functions
12237 which might make debugging harder.
12238
12239 @item -mtls-direct-seg-refs
12240 @itemx -mno-tls-direct-seg-refs
12241 @opindex mtls-direct-seg-refs
12242 Controls whether TLS variables may be accessed with offsets from the
12243 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
12244 or whether the thread base pointer must be added.  Whether or not this
12245 is legal depends on the operating system, and whether it maps the
12246 segment to cover the entire TLS area.
12247
12248 For systems that use GNU libc, the default is on.
12249
12250 @item -msse2avx
12251 @itemx -mno-sse2avx
12252 @opindex msse2avx
12253 Specify that the assembler should encode SSE instructions with VEX
12254 prefix.  The option @option{-mavx} turns this on by default.
12255 @end table
12256
12257 These @samp{-m} switches are supported in addition to the above
12258 on AMD x86-64 processors in 64-bit environments.
12259
12260 @table @gcctabopt
12261 @item -m32
12262 @itemx -m64
12263 @opindex m32
12264 @opindex m64
12265 Generate code for a 32-bit or 64-bit environment.
12266 The 32-bit environment sets int, long and pointer to 32 bits and
12267 generates code that runs on any i386 system.
12268 The 64-bit environment sets int to 32 bits and long and pointer
12269 to 64 bits and generates code for AMD's x86-64 architecture. For
12270 darwin only the -m64 option turns off the @option{-fno-pic} and
12271 @option{-mdynamic-no-pic} options.
12272
12273 @item -mno-red-zone
12274 @opindex mno-red-zone
12275 Do not use a so called red zone for x86-64 code.  The red zone is mandated
12276 by the x86-64 ABI, it is a 128-byte area beyond the location of the
12277 stack pointer that will not be modified by signal or interrupt handlers
12278 and therefore can be used for temporary data without adjusting the stack
12279 pointer.  The flag @option{-mno-red-zone} disables this red zone.
12280
12281 @item -mcmodel=small
12282 @opindex mcmodel=small
12283 Generate code for the small code model: the program and its symbols must
12284 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
12285 Programs can be statically or dynamically linked.  This is the default
12286 code model.
12287
12288 @item -mcmodel=kernel
12289 @opindex mcmodel=kernel
12290 Generate code for the kernel code model.  The kernel runs in the
12291 negative 2 GB of the address space.
12292 This model has to be used for Linux kernel code.
12293
12294 @item -mcmodel=medium
12295 @opindex mcmodel=medium
12296 Generate code for the medium model: The program is linked in the lower 2
12297 GB of the address space.  Small symbols are also placed there.  Symbols
12298 with sizes larger than @option{-mlarge-data-threshold} are put into
12299 large data or bss sections and can be located above 2GB.  Programs can
12300 be statically or dynamically linked.
12301
12302 @item -mcmodel=large
12303 @opindex mcmodel=large
12304 Generate code for the large model: This model makes no assumptions
12305 about addresses and sizes of sections.
12306 @end table
12307
12308 @node IA-64 Options
12309 @subsection IA-64 Options
12310 @cindex IA-64 Options
12311
12312 These are the @samp{-m} options defined for the Intel IA-64 architecture.
12313
12314 @table @gcctabopt
12315 @item -mbig-endian
12316 @opindex mbig-endian
12317 Generate code for a big endian target.  This is the default for HP-UX@.
12318
12319 @item -mlittle-endian
12320 @opindex mlittle-endian
12321 Generate code for a little endian target.  This is the default for AIX5
12322 and GNU/Linux.
12323
12324 @item -mgnu-as
12325 @itemx -mno-gnu-as
12326 @opindex mgnu-as
12327 @opindex mno-gnu-as
12328 Generate (or don't) code for the GNU assembler.  This is the default.
12329 @c Also, this is the default if the configure option @option{--with-gnu-as}
12330 @c is used.
12331
12332 @item -mgnu-ld
12333 @itemx -mno-gnu-ld
12334 @opindex mgnu-ld
12335 @opindex mno-gnu-ld
12336 Generate (or don't) code for the GNU linker.  This is the default.
12337 @c Also, this is the default if the configure option @option{--with-gnu-ld}
12338 @c is used.
12339
12340 @item -mno-pic
12341 @opindex mno-pic
12342 Generate code that does not use a global pointer register.  The result
12343 is not position independent code, and violates the IA-64 ABI@.
12344
12345 @item -mvolatile-asm-stop
12346 @itemx -mno-volatile-asm-stop
12347 @opindex mvolatile-asm-stop
12348 @opindex mno-volatile-asm-stop
12349 Generate (or don't) a stop bit immediately before and after volatile asm
12350 statements.
12351
12352 @item -mregister-names
12353 @itemx -mno-register-names
12354 @opindex mregister-names
12355 @opindex mno-register-names
12356 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
12357 the stacked registers.  This may make assembler output more readable.
12358
12359 @item -mno-sdata
12360 @itemx -msdata
12361 @opindex mno-sdata
12362 @opindex msdata
12363 Disable (or enable) optimizations that use the small data section.  This may
12364 be useful for working around optimizer bugs.
12365
12366 @item -mconstant-gp
12367 @opindex mconstant-gp
12368 Generate code that uses a single constant global pointer value.  This is
12369 useful when compiling kernel code.
12370
12371 @item -mauto-pic
12372 @opindex mauto-pic
12373 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
12374 This is useful when compiling firmware code.
12375
12376 @item -minline-float-divide-min-latency
12377 @opindex minline-float-divide-min-latency
12378 Generate code for inline divides of floating point values
12379 using the minimum latency algorithm.
12380
12381 @item -minline-float-divide-max-throughput
12382 @opindex minline-float-divide-max-throughput
12383 Generate code for inline divides of floating point values
12384 using the maximum throughput algorithm.
12385
12386 @item -mno-inline-float-divide
12387 @opindex mno-inline-float-divide
12388 Do not generate inline code for divides of floating point values.
12389
12390 @item -minline-int-divide-min-latency
12391 @opindex minline-int-divide-min-latency
12392 Generate code for inline divides of integer values
12393 using the minimum latency algorithm.
12394
12395 @item -minline-int-divide-max-throughput
12396 @opindex minline-int-divide-max-throughput
12397 Generate code for inline divides of integer values
12398 using the maximum throughput algorithm.
12399
12400 @item -mno-inline-int-divide
12401 @opindex mno-inline-int-divide
12402 Do not generate inline code for divides of integer values.
12403
12404 @item -minline-sqrt-min-latency
12405 @opindex minline-sqrt-min-latency
12406 Generate code for inline square roots
12407 using the minimum latency algorithm.
12408
12409 @item -minline-sqrt-max-throughput
12410 @opindex minline-sqrt-max-throughput
12411 Generate code for inline square roots
12412 using the maximum throughput algorithm.
12413
12414 @item -mno-inline-sqrt
12415 @opindex mno-inline-sqrt
12416 Do not generate inline code for sqrt.
12417
12418 @item -mfused-madd
12419 @itemx -mno-fused-madd
12420 @opindex mfused-madd
12421 @opindex mno-fused-madd
12422 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
12423 instructions.  The default is to use these instructions.
12424
12425 @item -mno-dwarf2-asm
12426 @itemx -mdwarf2-asm
12427 @opindex mno-dwarf2-asm
12428 @opindex mdwarf2-asm
12429 Don't (or do) generate assembler code for the DWARF2 line number debugging
12430 info.  This may be useful when not using the GNU assembler.
12431
12432 @item -mearly-stop-bits
12433 @itemx -mno-early-stop-bits
12434 @opindex mearly-stop-bits
12435 @opindex mno-early-stop-bits
12436 Allow stop bits to be placed earlier than immediately preceding the
12437 instruction that triggered the stop bit.  This can improve instruction
12438 scheduling, but does not always do so.
12439
12440 @item -mfixed-range=@var{register-range}
12441 @opindex mfixed-range
12442 Generate code treating the given register range as fixed registers.
12443 A fixed register is one that the register allocator can not use.  This is
12444 useful when compiling kernel code.  A register range is specified as
12445 two registers separated by a dash.  Multiple register ranges can be
12446 specified separated by a comma.
12447
12448 @item -mtls-size=@var{tls-size}
12449 @opindex mtls-size
12450 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
12451 64.
12452
12453 @item -mtune=@var{cpu-type}
12454 @opindex mtune
12455 Tune the instruction scheduling for a particular CPU, Valid values are
12456 itanium, itanium1, merced, itanium2, and mckinley.
12457
12458 @item -milp32
12459 @itemx -mlp64
12460 @opindex milp32
12461 @opindex mlp64
12462 Generate code for a 32-bit or 64-bit environment.
12463 The 32-bit environment sets int, long and pointer to 32 bits.
12464 The 64-bit environment sets int to 32 bits and long and pointer
12465 to 64 bits.  These are HP-UX specific flags.
12466
12467 @item -mno-sched-br-data-spec
12468 @itemx -msched-br-data-spec
12469 @opindex mno-sched-br-data-spec
12470 @opindex msched-br-data-spec
12471 (Dis/En)able data speculative scheduling before 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 'disable'.
12475
12476 @item -msched-ar-data-spec
12477 @itemx -mno-sched-ar-data-spec
12478 @opindex msched-ar-data-spec
12479 @opindex mno-sched-ar-data-spec
12480 (En/Dis)able data speculative scheduling after reload.
12481 This will result in generation of the ld.a instructions and
12482 the corresponding check instructions (ld.c / chk.a).
12483 The default is 'enable'.
12484
12485 @item -mno-sched-control-spec
12486 @itemx -msched-control-spec
12487 @opindex mno-sched-control-spec
12488 @opindex msched-control-spec
12489 (Dis/En)able control speculative scheduling.  This feature is
12490 available only during region scheduling (i.e.@: before reload).
12491 This will result in generation of the ld.s instructions and
12492 the corresponding check instructions chk.s .
12493 The default is 'disable'.
12494
12495 @item -msched-br-in-data-spec
12496 @itemx -mno-sched-br-in-data-spec
12497 @opindex msched-br-in-data-spec
12498 @opindex mno-sched-br-in-data-spec
12499 (En/Dis)able speculative scheduling of the instructions that
12500 are dependent on the data speculative loads before reload.
12501 This is effective only with @option{-msched-br-data-spec} enabled.
12502 The default is 'enable'.
12503
12504 @item -msched-ar-in-data-spec
12505 @itemx -mno-sched-ar-in-data-spec
12506 @opindex msched-ar-in-data-spec
12507 @opindex mno-sched-ar-in-data-spec
12508 (En/Dis)able speculative scheduling of the instructions that
12509 are dependent on the data speculative loads after reload.
12510 This is effective only with @option{-msched-ar-data-spec} enabled.
12511 The default is 'enable'.
12512
12513 @item -msched-in-control-spec
12514 @itemx -mno-sched-in-control-spec
12515 @opindex msched-in-control-spec
12516 @opindex mno-sched-in-control-spec
12517 (En/Dis)able speculative scheduling of the instructions that
12518 are dependent on the control speculative loads.
12519 This is effective only with @option{-msched-control-spec} enabled.
12520 The default is 'enable'.
12521
12522 @item -mno-sched-prefer-non-data-spec-insns
12523 @itemx -msched-prefer-non-data-spec-insns
12524 @opindex mno-sched-prefer-non-data-spec-insns
12525 @opindex msched-prefer-non-data-spec-insns
12526 If enabled, data 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 data speculation much more conservative.
12529 The default is 'disable'.
12530
12531 @item -mno-sched-prefer-non-control-spec-insns
12532 @itemx -msched-prefer-non-control-spec-insns
12533 @opindex mno-sched-prefer-non-control-spec-insns
12534 @opindex msched-prefer-non-control-spec-insns
12535 If enabled, control speculative instructions will be chosen for schedule
12536 only if there are no other choices at the moment.  This will make
12537 the use of the control speculation much more conservative.
12538 The default is 'disable'.
12539
12540 @item -mno-sched-count-spec-in-critical-path
12541 @itemx -msched-count-spec-in-critical-path
12542 @opindex mno-sched-count-spec-in-critical-path
12543 @opindex msched-count-spec-in-critical-path
12544 If enabled, speculative dependencies will be considered during
12545 computation of the instructions priorities.  This will make the use of the
12546 speculation a bit more conservative.
12547 The default is 'disable'.
12548
12549 @item -msched-spec-ldc
12550 @opindex msched-spec-ldc
12551 Use a simple data speculation check.  This option is on by default.
12552
12553 @item -msched-control-spec-ldc
12554 @opindex msched-spec-ldc
12555 Use a simple check for control speculation.  This option is on by default.
12556
12557 @item -msched-stop-bits-after-every-cycle
12558 @opindex msched-stop-bits-after-every-cycle
12559 Place a stop bit after every cycle when scheduling.  This option is on
12560 by default.
12561
12562 @item -msched-fp-mem-deps-zero-cost
12563 @opindex msched-fp-mem-deps-zero-cost
12564 Assume that floating-point stores and loads are not likely to cause a conflict
12565 when placed into the same instruction group.  This option is disabled by
12566 default.
12567
12568 @item -msel-sched-dont-check-control-spec
12569 @opindex msel-sched-dont-check-control-spec
12570 Generate checks for control speculation in selective scheduling.
12571 This flag is disabled by default.
12572
12573 @item -msched-max-memory-insns=@var{max-insns}
12574 @opindex msched-max-memory-insns
12575 Limit on the number of memory insns per instruction group, giving lower
12576 priority to subsequent memory insns attempting to schedule in the same
12577 instruction group. Frequently useful to prevent cache bank conflicts.
12578 The default value is 1.
12579
12580 @item -msched-max-memory-insns-hard-limit
12581 @opindex msched-max-memory-insns-hard-limit
12582 Disallow more than `msched-max-memory-insns' in instruction group.
12583 Otherwise, limit is `soft' meaning that we would prefer non-memory operations
12584 when limit is reached but may still schedule memory operations.
12585
12586 @end table
12587
12588 @node IA-64/VMS Options
12589 @subsection IA-64/VMS Options
12590
12591 These @samp{-m} options are defined for the IA-64/VMS implementations:
12592
12593 @table @gcctabopt
12594 @item -mvms-return-codes
12595 @opindex mvms-return-codes
12596 Return VMS condition codes from main. The default is to return POSIX
12597 style condition (e.g.@ error) codes.
12598
12599 @item -mdebug-main=@var{prefix}
12600 @opindex mdebug-main=@var{prefix}
12601 Flag the first routine whose name starts with @var{prefix} as the main
12602 routine for the debugger.
12603
12604 @item -mmalloc64
12605 @opindex mmalloc64
12606 Default to 64bit memory allocation routines.
12607 @end table
12608
12609 @node LM32 Options
12610 @subsection LM32 Options
12611 @cindex LM32 options
12612
12613 These @option{-m} options are defined for the Lattice Mico32 architecture:
12614
12615 @table @gcctabopt
12616 @item -mbarrel-shift-enabled
12617 @opindex mbarrel-shift-enabled
12618 Enable barrel-shift instructions.
12619
12620 @item -mdivide-enabled
12621 @opindex mdivide-enabled
12622 Enable divide and modulus instructions.
12623
12624 @item -mmultiply-enabled
12625 @opindex multiply-enabled
12626 Enable multiply instructions.
12627
12628 @item -msign-extend-enabled
12629 @opindex msign-extend-enabled
12630 Enable sign extend instructions.
12631
12632 @item -muser-enabled
12633 @opindex muser-enabled
12634 Enable user-defined instructions.
12635
12636 @end table
12637
12638 @node M32C Options
12639 @subsection M32C Options
12640 @cindex M32C options
12641
12642 @table @gcctabopt
12643 @item -mcpu=@var{name}
12644 @opindex mcpu=
12645 Select the CPU for which code is generated.  @var{name} may be one of
12646 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
12647 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
12648 the M32C/80 series.
12649
12650 @item -msim
12651 @opindex msim
12652 Specifies that the program will be run on the simulator.  This causes
12653 an alternate runtime library to be linked in which supports, for
12654 example, file I/O@.  You must not use this option when generating
12655 programs that will run on real hardware; you must provide your own
12656 runtime library for whatever I/O functions are needed.
12657
12658 @item -memregs=@var{number}
12659 @opindex memregs=
12660 Specifies the number of memory-based pseudo-registers GCC will use
12661 during code generation.  These pseudo-registers will be used like real
12662 registers, so there is a tradeoff between GCC's ability to fit the
12663 code into available registers, and the performance penalty of using
12664 memory instead of registers.  Note that all modules in a program must
12665 be compiled with the same value for this option.  Because of that, you
12666 must not use this option with the default runtime libraries gcc
12667 builds.
12668
12669 @end table
12670
12671 @node M32R/D Options
12672 @subsection M32R/D Options
12673 @cindex M32R/D options
12674
12675 These @option{-m} options are defined for Renesas M32R/D architectures:
12676
12677 @table @gcctabopt
12678 @item -m32r2
12679 @opindex m32r2
12680 Generate code for the M32R/2@.
12681
12682 @item -m32rx
12683 @opindex m32rx
12684 Generate code for the M32R/X@.
12685
12686 @item -m32r
12687 @opindex m32r
12688 Generate code for the M32R@.  This is the default.
12689
12690 @item -mmodel=small
12691 @opindex mmodel=small
12692 Assume all objects live in the lower 16MB of memory (so that their addresses
12693 can be loaded with the @code{ld24} instruction), and assume all subroutines
12694 are reachable with the @code{bl} instruction.
12695 This is the default.
12696
12697 The addressability of a particular object can be set with the
12698 @code{model} attribute.
12699
12700 @item -mmodel=medium
12701 @opindex mmodel=medium
12702 Assume objects may be anywhere in the 32-bit address space (the compiler
12703 will generate @code{seth/add3} instructions to load their addresses), and
12704 assume all subroutines are reachable with the @code{bl} instruction.
12705
12706 @item -mmodel=large
12707 @opindex mmodel=large
12708 Assume objects may be anywhere in the 32-bit address space (the compiler
12709 will generate @code{seth/add3} instructions to load their addresses), and
12710 assume subroutines may not be reachable with the @code{bl} instruction
12711 (the compiler will generate the much slower @code{seth/add3/jl}
12712 instruction sequence).
12713
12714 @item -msdata=none
12715 @opindex msdata=none
12716 Disable use of the small data area.  Variables will be put into
12717 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
12718 @code{section} attribute has been specified).
12719 This is the default.
12720
12721 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
12722 Objects may be explicitly put in the small data area with the
12723 @code{section} attribute using one of these sections.
12724
12725 @item -msdata=sdata
12726 @opindex msdata=sdata
12727 Put small global and static data in the small data area, but do not
12728 generate special code to reference them.
12729
12730 @item -msdata=use
12731 @opindex msdata=use
12732 Put small global and static data in the small data area, and generate
12733 special instructions to reference them.
12734
12735 @item -G @var{num}
12736 @opindex G
12737 @cindex smaller data references
12738 Put global and static objects less than or equal to @var{num} bytes
12739 into the small data or bss sections instead of the normal data or bss
12740 sections.  The default value of @var{num} is 8.
12741 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
12742 for this option to have any effect.
12743
12744 All modules should be compiled with the same @option{-G @var{num}} value.
12745 Compiling with different values of @var{num} may or may not work; if it
12746 doesn't the linker will give an error message---incorrect code will not be
12747 generated.
12748
12749 @item -mdebug
12750 @opindex mdebug
12751 Makes the M32R specific code in the compiler display some statistics
12752 that might help in debugging programs.
12753
12754 @item -malign-loops
12755 @opindex malign-loops
12756 Align all loops to a 32-byte boundary.
12757
12758 @item -mno-align-loops
12759 @opindex mno-align-loops
12760 Do not enforce a 32-byte alignment for loops.  This is the default.
12761
12762 @item -missue-rate=@var{number}
12763 @opindex missue-rate=@var{number}
12764 Issue @var{number} instructions per cycle.  @var{number} can only be 1
12765 or 2.
12766
12767 @item -mbranch-cost=@var{number}
12768 @opindex mbranch-cost=@var{number}
12769 @var{number} can only be 1 or 2.  If it is 1 then branches will be
12770 preferred over conditional code, if it is 2, then the opposite will
12771 apply.
12772
12773 @item -mflush-trap=@var{number}
12774 @opindex mflush-trap=@var{number}
12775 Specifies the trap number to use to flush the cache.  The default is
12776 12.  Valid numbers are between 0 and 15 inclusive.
12777
12778 @item -mno-flush-trap
12779 @opindex mno-flush-trap
12780 Specifies that the cache cannot be flushed by using a trap.
12781
12782 @item -mflush-func=@var{name}
12783 @opindex mflush-func=@var{name}
12784 Specifies the name of the operating system function to call to flush
12785 the cache.  The default is @emph{_flush_cache}, but a function call
12786 will only be used if a trap is not available.
12787
12788 @item -mno-flush-func
12789 @opindex mno-flush-func
12790 Indicates that there is no OS function for flushing the cache.
12791
12792 @end table
12793
12794 @node M680x0 Options
12795 @subsection M680x0 Options
12796 @cindex M680x0 options
12797
12798 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
12799 The default settings depend on which architecture was selected when
12800 the compiler was configured; the defaults for the most common choices
12801 are given below.
12802
12803 @table @gcctabopt
12804 @item -march=@var{arch}
12805 @opindex march
12806 Generate code for a specific M680x0 or ColdFire instruction set
12807 architecture.  Permissible values of @var{arch} for M680x0
12808 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
12809 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
12810 architectures are selected according to Freescale's ISA classification
12811 and the permissible values are: @samp{isaa}, @samp{isaaplus},
12812 @samp{isab} and @samp{isac}.
12813
12814 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
12815 code for a ColdFire target.  The @var{arch} in this macro is one of the
12816 @option{-march} arguments given above.
12817
12818 When used together, @option{-march} and @option{-mtune} select code
12819 that runs on a family of similar processors but that is optimized
12820 for a particular microarchitecture.
12821
12822 @item -mcpu=@var{cpu}
12823 @opindex mcpu
12824 Generate code for a specific M680x0 or ColdFire processor.
12825 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
12826 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
12827 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
12828 below, which also classifies the CPUs into families:
12829
12830 @multitable @columnfractions 0.20 0.80
12831 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
12832 @item @samp{51} @tab @samp{51} @samp{51ac} @samp{51cn} @samp{51em} @samp{51qe}
12833 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
12834 @item @samp{5206e} @tab @samp{5206e}
12835 @item @samp{5208} @tab @samp{5207} @samp{5208}
12836 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
12837 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
12838 @item @samp{5216} @tab @samp{5214} @samp{5216}
12839 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
12840 @item @samp{5225} @tab @samp{5224} @samp{5225}
12841 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
12842 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
12843 @item @samp{5249} @tab @samp{5249}
12844 @item @samp{5250} @tab @samp{5250}
12845 @item @samp{5271} @tab @samp{5270} @samp{5271}
12846 @item @samp{5272} @tab @samp{5272}
12847 @item @samp{5275} @tab @samp{5274} @samp{5275}
12848 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
12849 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
12850 @item @samp{5307} @tab @samp{5307}
12851 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
12852 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
12853 @item @samp{5407} @tab @samp{5407}
12854 @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}
12855 @end multitable
12856
12857 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
12858 @var{arch} is compatible with @var{cpu}.  Other combinations of
12859 @option{-mcpu} and @option{-march} are rejected.
12860
12861 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
12862 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
12863 where the value of @var{family} is given by the table above.
12864
12865 @item -mtune=@var{tune}
12866 @opindex mtune
12867 Tune the code for a particular microarchitecture, within the
12868 constraints set by @option{-march} and @option{-mcpu}.
12869 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
12870 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
12871 and @samp{cpu32}.  The ColdFire microarchitectures
12872 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
12873
12874 You can also use @option{-mtune=68020-40} for code that needs
12875 to run relatively well on 68020, 68030 and 68040 targets.
12876 @option{-mtune=68020-60} is similar but includes 68060 targets
12877 as well.  These two options select the same tuning decisions as
12878 @option{-m68020-40} and @option{-m68020-60} respectively.
12879
12880 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
12881 when tuning for 680x0 architecture @var{arch}.  It also defines
12882 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
12883 option is used.  If gcc is tuning for a range of architectures,
12884 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
12885 it defines the macros for every architecture in the range.
12886
12887 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
12888 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
12889 of the arguments given above.
12890
12891 @item -m68000
12892 @itemx -mc68000
12893 @opindex m68000
12894 @opindex mc68000
12895 Generate output for a 68000.  This is the default
12896 when the compiler is configured for 68000-based systems.
12897 It is equivalent to @option{-march=68000}.
12898
12899 Use this option for microcontrollers with a 68000 or EC000 core,
12900 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
12901
12902 @item -m68010
12903 @opindex m68010
12904 Generate output for a 68010.  This is the default
12905 when the compiler is configured for 68010-based systems.
12906 It is equivalent to @option{-march=68010}.
12907
12908 @item -m68020
12909 @itemx -mc68020
12910 @opindex m68020
12911 @opindex mc68020
12912 Generate output for a 68020.  This is the default
12913 when the compiler is configured for 68020-based systems.
12914 It is equivalent to @option{-march=68020}.
12915
12916 @item -m68030
12917 @opindex m68030
12918 Generate output for a 68030.  This is the default when the compiler is
12919 configured for 68030-based systems.  It is equivalent to
12920 @option{-march=68030}.
12921
12922 @item -m68040
12923 @opindex m68040
12924 Generate output for a 68040.  This is the default when the compiler is
12925 configured for 68040-based systems.  It is equivalent to
12926 @option{-march=68040}.
12927
12928 This option inhibits the use of 68881/68882 instructions that have to be
12929 emulated by software on the 68040.  Use this option if your 68040 does not
12930 have code to emulate those instructions.
12931
12932 @item -m68060
12933 @opindex m68060
12934 Generate output for a 68060.  This is the default when the compiler is
12935 configured for 68060-based systems.  It is equivalent to
12936 @option{-march=68060}.
12937
12938 This option inhibits the use of 68020 and 68881/68882 instructions that
12939 have to be emulated by software on the 68060.  Use this option if your 68060
12940 does not have code to emulate those instructions.
12941
12942 @item -mcpu32
12943 @opindex mcpu32
12944 Generate output for a CPU32.  This is the default
12945 when the compiler is configured for CPU32-based systems.
12946 It is equivalent to @option{-march=cpu32}.
12947
12948 Use this option for microcontrollers with a
12949 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
12950 68336, 68340, 68341, 68349 and 68360.
12951
12952 @item -m5200
12953 @opindex m5200
12954 Generate output for a 520X ColdFire CPU@.  This is the default
12955 when the compiler is configured for 520X-based systems.
12956 It is equivalent to @option{-mcpu=5206}, and is now deprecated
12957 in favor of that option.
12958
12959 Use this option for microcontroller with a 5200 core, including
12960 the MCF5202, MCF5203, MCF5204 and MCF5206.
12961
12962 @item -m5206e
12963 @opindex m5206e
12964 Generate output for a 5206e ColdFire CPU@.  The option is now
12965 deprecated in favor of the equivalent @option{-mcpu=5206e}.
12966
12967 @item -m528x
12968 @opindex m528x
12969 Generate output for a member of the ColdFire 528X family.
12970 The option is now deprecated in favor of the equivalent
12971 @option{-mcpu=528x}.
12972
12973 @item -m5307
12974 @opindex m5307
12975 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
12976 in favor of the equivalent @option{-mcpu=5307}.
12977
12978 @item -m5407
12979 @opindex m5407
12980 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
12981 in favor of the equivalent @option{-mcpu=5407}.
12982
12983 @item -mcfv4e
12984 @opindex mcfv4e
12985 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
12986 This includes use of hardware floating point instructions.
12987 The option is equivalent to @option{-mcpu=547x}, and is now
12988 deprecated in favor of that option.
12989
12990 @item -m68020-40
12991 @opindex m68020-40
12992 Generate output for a 68040, 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 68040.
12996
12997 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
12998
12999 @item -m68020-60
13000 @opindex m68020-60
13001 Generate output for a 68060, without using any of the new instructions.
13002 This results in code which can run relatively efficiently on either a
13003 68020/68881 or a 68030 or a 68040.  The generated code does use the
13004 68881 instructions that are emulated on the 68060.
13005
13006 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
13007
13008 @item -mhard-float
13009 @itemx -m68881
13010 @opindex mhard-float
13011 @opindex m68881
13012 Generate floating-point instructions.  This is the default for 68020
13013 and above, and for ColdFire devices that have an FPU@.  It defines the
13014 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
13015 on ColdFire targets.
13016
13017 @item -msoft-float
13018 @opindex msoft-float
13019 Do not generate floating-point instructions; use library calls instead.
13020 This is the default for 68000, 68010, and 68832 targets.  It is also
13021 the default for ColdFire devices that have no FPU.
13022
13023 @item -mdiv
13024 @itemx -mno-div
13025 @opindex mdiv
13026 @opindex mno-div
13027 Generate (do not generate) ColdFire hardware divide and remainder
13028 instructions.  If @option{-march} is used without @option{-mcpu},
13029 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
13030 architectures.  Otherwise, the default is taken from the target CPU
13031 (either the default CPU, or the one specified by @option{-mcpu}).  For
13032 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
13033 @option{-mcpu=5206e}.
13034
13035 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
13036
13037 @item -mshort
13038 @opindex mshort
13039 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13040 Additionally, parameters passed on the stack are also aligned to a
13041 16-bit boundary even on targets whose API mandates promotion to 32-bit.
13042
13043 @item -mno-short
13044 @opindex mno-short
13045 Do not consider type @code{int} to be 16 bits wide.  This is the default.
13046
13047 @item -mnobitfield
13048 @itemx -mno-bitfield
13049 @opindex mnobitfield
13050 @opindex mno-bitfield
13051 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
13052 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
13053
13054 @item -mbitfield
13055 @opindex mbitfield
13056 Do use the bit-field instructions.  The @option{-m68020} option implies
13057 @option{-mbitfield}.  This is the default if you use a configuration
13058 designed for a 68020.
13059
13060 @item -mrtd
13061 @opindex mrtd
13062 Use a different function-calling convention, in which functions
13063 that take a fixed number of arguments return with the @code{rtd}
13064 instruction, which pops their arguments while returning.  This
13065 saves one instruction in the caller since there is no need to pop
13066 the arguments there.
13067
13068 This calling convention is incompatible with the one normally
13069 used on Unix, so you cannot use it if you need to call libraries
13070 compiled with the Unix compiler.
13071
13072 Also, you must provide function prototypes for all functions that
13073 take variable numbers of arguments (including @code{printf});
13074 otherwise incorrect code will be generated for calls to those
13075 functions.
13076
13077 In addition, seriously incorrect code will result if you call a
13078 function with too many arguments.  (Normally, extra arguments are
13079 harmlessly ignored.)
13080
13081 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
13082 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
13083
13084 @item -mno-rtd
13085 @opindex mno-rtd
13086 Do not use the calling conventions selected by @option{-mrtd}.
13087 This is the default.
13088
13089 @item -malign-int
13090 @itemx -mno-align-int
13091 @opindex malign-int
13092 @opindex mno-align-int
13093 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
13094 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
13095 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
13096 Aligning variables on 32-bit boundaries produces code that runs somewhat
13097 faster on processors with 32-bit busses at the expense of more memory.
13098
13099 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
13100 align structures containing the above types  differently than
13101 most published application binary interface specifications for the m68k.
13102
13103 @item -mpcrel
13104 @opindex mpcrel
13105 Use the pc-relative addressing mode of the 68000 directly, instead of
13106 using a global offset table.  At present, this option implies @option{-fpic},
13107 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
13108 not presently supported with @option{-mpcrel}, though this could be supported for
13109 68020 and higher processors.
13110
13111 @item -mno-strict-align
13112 @itemx -mstrict-align
13113 @opindex mno-strict-align
13114 @opindex mstrict-align
13115 Do not (do) assume that unaligned memory references will be handled by
13116 the system.
13117
13118 @item -msep-data
13119 Generate code that allows the data segment to be located in a different
13120 area of memory from the text segment.  This allows for execute in place in
13121 an environment without virtual memory management.  This option implies
13122 @option{-fPIC}.
13123
13124 @item -mno-sep-data
13125 Generate code that assumes that the data segment follows the text segment.
13126 This is the default.
13127
13128 @item -mid-shared-library
13129 Generate code that supports shared libraries via the library ID method.
13130 This allows for execute in place and shared libraries in an environment
13131 without virtual memory management.  This option implies @option{-fPIC}.
13132
13133 @item -mno-id-shared-library
13134 Generate code that doesn't assume ID based shared libraries are being used.
13135 This is the default.
13136
13137 @item -mshared-library-id=n
13138 Specified the identification number of the ID based shared library being
13139 compiled.  Specifying a value of 0 will generate more compact code, specifying
13140 other values will force the allocation of that number to the current
13141 library but is no more space or time efficient than omitting this option.
13142
13143 @item -mxgot
13144 @itemx -mno-xgot
13145 @opindex mxgot
13146 @opindex mno-xgot
13147 When generating position-independent code for ColdFire, generate code
13148 that works if the GOT has more than 8192 entries.  This code is
13149 larger and slower than code generated without this option.  On M680x0
13150 processors, this option is not needed; @option{-fPIC} suffices.
13151
13152 GCC normally uses a single instruction to load values from the GOT@.
13153 While this is relatively efficient, it only works if the GOT
13154 is smaller than about 64k.  Anything larger causes the linker
13155 to report an error such as:
13156
13157 @cindex relocation truncated to fit (ColdFire)
13158 @smallexample
13159 relocation truncated to fit: R_68K_GOT16O foobar
13160 @end smallexample
13161
13162 If this happens, you should recompile your code with @option{-mxgot}.
13163 It should then work with very large GOTs.  However, code generated with
13164 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
13165 the value of a global symbol.
13166
13167 Note that some linkers, including newer versions of the GNU linker,
13168 can create multiple GOTs and sort GOT entries.  If you have such a linker,
13169 you should only need to use @option{-mxgot} when compiling a single
13170 object file that accesses more than 8192 GOT entries.  Very few do.
13171
13172 These options have no effect unless GCC is generating
13173 position-independent code.
13174
13175 @end table
13176
13177 @node M68hc1x Options
13178 @subsection M68hc1x Options
13179 @cindex M68hc1x options
13180
13181 These are the @samp{-m} options defined for the 68hc11 and 68hc12
13182 microcontrollers.  The default values for these options depends on
13183 which style of microcontroller was selected when the compiler was configured;
13184 the defaults for the most common choices are given below.
13185
13186 @table @gcctabopt
13187 @item -m6811
13188 @itemx -m68hc11
13189 @opindex m6811
13190 @opindex m68hc11
13191 Generate output for a 68HC11.  This is the default
13192 when the compiler is configured for 68HC11-based systems.
13193
13194 @item -m6812
13195 @itemx -m68hc12
13196 @opindex m6812
13197 @opindex m68hc12
13198 Generate output for a 68HC12.  This is the default
13199 when the compiler is configured for 68HC12-based systems.
13200
13201 @item -m68S12
13202 @itemx -m68hcs12
13203 @opindex m68S12
13204 @opindex m68hcs12
13205 Generate output for a 68HCS12.
13206
13207 @item -mauto-incdec
13208 @opindex mauto-incdec
13209 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
13210 addressing modes.
13211
13212 @item -minmax
13213 @itemx -mnominmax
13214 @opindex minmax
13215 @opindex mnominmax
13216 Enable the use of 68HC12 min and max instructions.
13217
13218 @item -mlong-calls
13219 @itemx -mno-long-calls
13220 @opindex mlong-calls
13221 @opindex mno-long-calls
13222 Treat all calls as being far away (near).  If calls are assumed to be
13223 far away, the compiler will use the @code{call} instruction to
13224 call a function and the @code{rtc} instruction for returning.
13225
13226 @item -mshort
13227 @opindex mshort
13228 Consider type @code{int} to be 16 bits wide, like @code{short int}.
13229
13230 @item -msoft-reg-count=@var{count}
13231 @opindex msoft-reg-count
13232 Specify the number of pseudo-soft registers which are used for the
13233 code generation.  The maximum number is 32.  Using more pseudo-soft
13234 register may or may not result in better code depending on the program.
13235 The default is 4 for 68HC11 and 2 for 68HC12.
13236
13237 @end table
13238
13239 @node MCore Options
13240 @subsection MCore Options
13241 @cindex MCore options
13242
13243 These are the @samp{-m} options defined for the Motorola M*Core
13244 processors.
13245
13246 @table @gcctabopt
13247
13248 @item -mhardlit
13249 @itemx -mno-hardlit
13250 @opindex mhardlit
13251 @opindex mno-hardlit
13252 Inline constants into the code stream if it can be done in two
13253 instructions or less.
13254
13255 @item -mdiv
13256 @itemx -mno-div
13257 @opindex mdiv
13258 @opindex mno-div
13259 Use the divide instruction.  (Enabled by default).
13260
13261 @item -mrelax-immediate
13262 @itemx -mno-relax-immediate
13263 @opindex mrelax-immediate
13264 @opindex mno-relax-immediate
13265 Allow arbitrary sized immediates in bit operations.
13266
13267 @item -mwide-bitfields
13268 @itemx -mno-wide-bitfields
13269 @opindex mwide-bitfields
13270 @opindex mno-wide-bitfields
13271 Always treat bit-fields as int-sized.
13272
13273 @item -m4byte-functions
13274 @itemx -mno-4byte-functions
13275 @opindex m4byte-functions
13276 @opindex mno-4byte-functions
13277 Force all functions to be aligned to a four byte boundary.
13278
13279 @item -mcallgraph-data
13280 @itemx -mno-callgraph-data
13281 @opindex mcallgraph-data
13282 @opindex mno-callgraph-data
13283 Emit callgraph information.
13284
13285 @item -mslow-bytes
13286 @itemx -mno-slow-bytes
13287 @opindex mslow-bytes
13288 @opindex mno-slow-bytes
13289 Prefer word access when reading byte quantities.
13290
13291 @item -mlittle-endian
13292 @itemx -mbig-endian
13293 @opindex mlittle-endian
13294 @opindex mbig-endian
13295 Generate code for a little endian target.
13296
13297 @item -m210
13298 @itemx -m340
13299 @opindex m210
13300 @opindex m340
13301 Generate code for the 210 processor.
13302
13303 @item -mno-lsim
13304 @opindex mno-lsim
13305 Assume that run-time support has been provided and so omit the
13306 simulator library (@file{libsim.a)} from the linker command line.
13307
13308 @item -mstack-increment=@var{size}
13309 @opindex mstack-increment
13310 Set the maximum amount for a single stack increment operation.  Large
13311 values can increase the speed of programs which contain functions
13312 that need a large amount of stack space, but they can also trigger a
13313 segmentation fault if the stack is extended too much.  The default
13314 value is 0x1000.
13315
13316 @end table
13317
13318 @node MeP Options
13319 @subsection MeP Options
13320 @cindex MeP options
13321
13322 @table @gcctabopt
13323
13324 @item -mabsdiff
13325 @opindex mabsdiff
13326 Enables the @code{abs} instruction, which is the absolute difference
13327 between two registers.
13328
13329 @item -mall-opts
13330 @opindex mall-opts
13331 Enables all the optional instructions - average, multiply, divide, bit
13332 operations, leading zero, absolute difference, min/max, clip, and
13333 saturation.
13334
13335
13336 @item -maverage
13337 @opindex maverage
13338 Enables the @code{ave} instruction, which computes the average of two
13339 registers.
13340
13341 @item -mbased=@var{n}
13342 @opindex mbased=
13343 Variables of size @var{n} bytes or smaller will be placed in the
13344 @code{.based} section by default.  Based variables use the @code{$tp}
13345 register as a base register, and there is a 128 byte limit to the
13346 @code{.based} section.
13347
13348 @item -mbitops
13349 @opindex mbitops
13350 Enables the bit operation instructions - bit test (@code{btstm}), set
13351 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
13352 test-and-set (@code{tas}).
13353
13354 @item -mc=@var{name}
13355 @opindex mc=
13356 Selects which section constant data will be placed in.  @var{name} may
13357 be @code{tiny}, @code{near}, or @code{far}.
13358
13359 @item -mclip
13360 @opindex mclip
13361 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
13362 useful unless you also provide @code{-mminmax}.
13363
13364 @item -mconfig=@var{name}
13365 @opindex mconfig=
13366 Selects one of the build-in core configurations.  Each MeP chip has
13367 one or more modules in it; each module has a core CPU and a variety of
13368 coprocessors, optional instructions, and peripherals.  The
13369 @code{MeP-Integrator} tool, not part of GCC, provides these
13370 configurations through this option; using this option is the same as
13371 using all the corresponding command line options.  The default
13372 configuration is @code{default}.
13373
13374 @item -mcop
13375 @opindex mcop
13376 Enables the coprocessor instructions.  By default, this is a 32-bit
13377 coprocessor.  Note that the coprocessor is normally enabled via the
13378 @code{-mconfig=} option.
13379
13380 @item -mcop32
13381 @opindex mcop32
13382 Enables the 32-bit coprocessor's instructions.
13383
13384 @item -mcop64
13385 @opindex mcop64
13386 Enables the 64-bit coprocessor's instructions.
13387
13388 @item -mivc2
13389 @opindex mivc2
13390 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
13391
13392 @item -mdc
13393 @opindex mdc
13394 Causes constant variables to be placed in the @code{.near} section.
13395
13396 @item -mdiv
13397 @opindex mdiv
13398 Enables the @code{div} and @code{divu} instructions.
13399
13400 @item -meb
13401 @opindex meb
13402 Generate big-endian code.
13403
13404 @item -mel
13405 @opindex mel
13406 Generate little-endian code.
13407
13408 @item -mio-volatile
13409 @opindex mio-volatile
13410 Tells the compiler that any variable marked with the @code{io}
13411 attribute is to be considered volatile.
13412
13413 @item -ml
13414 @opindex ml
13415 Causes variables to be assigned to the @code{.far} section by default.
13416
13417 @item -mleadz
13418 @opindex mleadz
13419 Enables the @code{leadz} (leading zero) instruction.
13420
13421 @item -mm
13422 @opindex mm
13423 Causes variables to be assigned to the @code{.near} section by default.
13424
13425 @item -mminmax
13426 @opindex mminmax
13427 Enables the @code{min} and @code{max} instructions.
13428
13429 @item -mmult
13430 @opindex mmult
13431 Enables the multiplication and multiply-accumulate instructions.
13432
13433 @item -mno-opts
13434 @opindex mno-opts
13435 Disables all the optional instructions enabled by @code{-mall-opts}.
13436
13437 @item -mrepeat
13438 @opindex mrepeat
13439 Enables the @code{repeat} and @code{erepeat} instructions, used for
13440 low-overhead looping.
13441
13442 @item -ms
13443 @opindex ms
13444 Causes all variables to default to the @code{.tiny} section.  Note
13445 that there is a 65536 byte limit to this section.  Accesses to these
13446 variables use the @code{%gp} base register.
13447
13448 @item -msatur
13449 @opindex msatur
13450 Enables the saturation instructions.  Note that the compiler does not
13451 currently generate these itself, but this option is included for
13452 compatibility with other tools, like @code{as}.
13453
13454 @item -msdram
13455 @opindex msdram
13456 Link the SDRAM-based runtime instead of the default ROM-based runtime.
13457
13458 @item -msim
13459 @opindex msim
13460 Link the simulator runtime libraries.
13461
13462 @item -msimnovec
13463 @opindex msimnovec
13464 Link the simulator runtime libraries, excluding built-in support
13465 for reset and exception vectors and tables.
13466
13467 @item -mtf
13468 @opindex mtf
13469 Causes all functions to default to the @code{.far} section.  Without
13470 this option, functions default to the @code{.near} section.
13471
13472 @item -mtiny=@var{n}
13473 @opindex mtiny=
13474 Variables that are @var{n} bytes or smaller will be allocated to the
13475 @code{.tiny} section.  These variables use the @code{$gp} base
13476 register.  The default for this option is 4, but note that there's a
13477 65536 byte limit to the @code{.tiny} section.
13478
13479 @end table
13480
13481 @node MIPS Options
13482 @subsection MIPS Options
13483 @cindex MIPS options
13484
13485 @table @gcctabopt
13486
13487 @item -EB
13488 @opindex EB
13489 Generate big-endian code.
13490
13491 @item -EL
13492 @opindex EL
13493 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
13494 configurations.
13495
13496 @item -march=@var{arch}
13497 @opindex march
13498 Generate code that will run on @var{arch}, which can be the name of a
13499 generic MIPS ISA, or the name of a particular processor.
13500 The ISA names are:
13501 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
13502 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
13503 The processor names are:
13504 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
13505 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
13506 @samp{5kc}, @samp{5kf},
13507 @samp{20kc},
13508 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
13509 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
13510 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1},
13511 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
13512 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
13513 @samp{loongson2e}, @samp{loongson2f},
13514 @samp{m4k},
13515 @samp{octeon},
13516 @samp{orion},
13517 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
13518 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
13519 @samp{rm7000}, @samp{rm9000},
13520 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
13521 @samp{sb1},
13522 @samp{sr71000},
13523 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
13524 @samp{vr5000}, @samp{vr5400}, @samp{vr5500}
13525 and @samp{xlr}.
13526 The special value @samp{from-abi} selects the
13527 most compatible architecture for the selected ABI (that is,
13528 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
13529
13530 Native Linux/GNU toolchains also support the value @samp{native},
13531 which selects the best architecture option for the host processor.
13532 @option{-march=native} has no effect if GCC does not recognize
13533 the processor.
13534
13535 In processor names, a final @samp{000} can be abbreviated as @samp{k}
13536 (for example, @samp{-march=r2k}).  Prefixes are optional, and
13537 @samp{vr} may be written @samp{r}.
13538
13539 Names of the form @samp{@var{n}f2_1} refer to processors with
13540 FPUs clocked at half the rate of the core, names of the form
13541 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
13542 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
13543 processors with FPUs clocked a ratio of 3:2 with respect to the core.
13544 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
13545 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
13546 accepted as synonyms for @samp{@var{n}f1_1}.
13547
13548 GCC defines two macros based on the value of this option.  The first
13549 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
13550 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
13551 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
13552 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
13553 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
13554
13555 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
13556 above.  In other words, it will have the full prefix and will not
13557 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
13558 the macro names the resolved architecture (either @samp{"mips1"} or
13559 @samp{"mips3"}).  It names the default architecture when no
13560 @option{-march} option is given.
13561
13562 @item -mtune=@var{arch}
13563 @opindex mtune
13564 Optimize for @var{arch}.  Among other things, this option controls
13565 the way instructions are scheduled, and the perceived cost of arithmetic
13566 operations.  The list of @var{arch} values is the same as for
13567 @option{-march}.
13568
13569 When this option is not used, GCC will optimize for the processor
13570 specified by @option{-march}.  By using @option{-march} and
13571 @option{-mtune} together, it is possible to generate code that will
13572 run on a family of processors, but optimize the code for one
13573 particular member of that family.
13574
13575 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
13576 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
13577 @samp{-march} ones described above.
13578
13579 @item -mips1
13580 @opindex mips1
13581 Equivalent to @samp{-march=mips1}.
13582
13583 @item -mips2
13584 @opindex mips2
13585 Equivalent to @samp{-march=mips2}.
13586
13587 @item -mips3
13588 @opindex mips3
13589 Equivalent to @samp{-march=mips3}.
13590
13591 @item -mips4
13592 @opindex mips4
13593 Equivalent to @samp{-march=mips4}.
13594
13595 @item -mips32
13596 @opindex mips32
13597 Equivalent to @samp{-march=mips32}.
13598
13599 @item -mips32r2
13600 @opindex mips32r2
13601 Equivalent to @samp{-march=mips32r2}.
13602
13603 @item -mips64
13604 @opindex mips64
13605 Equivalent to @samp{-march=mips64}.
13606
13607 @item -mips64r2
13608 @opindex mips64r2
13609 Equivalent to @samp{-march=mips64r2}.
13610
13611 @item -mips16
13612 @itemx -mno-mips16
13613 @opindex mips16
13614 @opindex mno-mips16
13615 Generate (do not generate) MIPS16 code.  If GCC is targetting a
13616 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
13617
13618 MIPS16 code generation can also be controlled on a per-function basis
13619 by means of @code{mips16} and @code{nomips16} attributes.
13620 @xref{Function Attributes}, for more information.
13621
13622 @item -mflip-mips16
13623 @opindex mflip-mips16
13624 Generate MIPS16 code on alternating functions.  This option is provided
13625 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
13626 not intended for ordinary use in compiling user code.
13627
13628 @item -minterlink-mips16
13629 @itemx -mno-interlink-mips16
13630 @opindex minterlink-mips16
13631 @opindex mno-interlink-mips16
13632 Require (do not require) that non-MIPS16 code be link-compatible with
13633 MIPS16 code.
13634
13635 For example, non-MIPS16 code cannot jump directly to MIPS16 code;
13636 it must either use a call or an indirect jump.  @option{-minterlink-mips16}
13637 therefore disables direct jumps unless GCC knows that the target of the
13638 jump is not MIPS16.
13639
13640 @item -mabi=32
13641 @itemx -mabi=o64
13642 @itemx -mabi=n32
13643 @itemx -mabi=64
13644 @itemx -mabi=eabi
13645 @opindex mabi=32
13646 @opindex mabi=o64
13647 @opindex mabi=n32
13648 @opindex mabi=64
13649 @opindex mabi=eabi
13650 Generate code for the given ABI@.
13651
13652 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
13653 generates 64-bit code when you select a 64-bit architecture, but you
13654 can use @option{-mgp32} to get 32-bit code instead.
13655
13656 For information about the O64 ABI, see
13657 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
13658
13659 GCC supports a variant of the o32 ABI in which floating-point registers
13660 are 64 rather than 32 bits wide.  You can select this combination with
13661 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @samp{mthc1}
13662 and @samp{mfhc1} instructions and is therefore only supported for
13663 MIPS32R2 processors.
13664
13665 The register assignments for arguments and return values remain the
13666 same, but each scalar value is passed in a single 64-bit register
13667 rather than a pair of 32-bit registers.  For example, scalar
13668 floating-point values are returned in @samp{$f0} only, not a
13669 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
13670 remains the same, but all 64 bits are saved.
13671
13672 @item -mabicalls
13673 @itemx -mno-abicalls
13674 @opindex mabicalls
13675 @opindex mno-abicalls
13676 Generate (do not generate) code that is suitable for SVR4-style
13677 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
13678 systems.
13679
13680 @item -mshared
13681 @itemx -mno-shared
13682 Generate (do not generate) code that is fully position-independent,
13683 and that can therefore be linked into shared libraries.  This option
13684 only affects @option{-mabicalls}.
13685
13686 All @option{-mabicalls} code has traditionally been position-independent,
13687 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
13688 as an extension, the GNU toolchain allows executables to use absolute
13689 accesses for locally-binding symbols.  It can also use shorter GP
13690 initialization sequences and generate direct calls to locally-defined
13691 functions.  This mode is selected by @option{-mno-shared}.
13692
13693 @option{-mno-shared} depends on binutils 2.16 or higher and generates
13694 objects that can only be linked by the GNU linker.  However, the option
13695 does not affect the ABI of the final executable; it only affects the ABI
13696 of relocatable objects.  Using @option{-mno-shared} will generally make
13697 executables both smaller and quicker.
13698
13699 @option{-mshared} is the default.
13700
13701 @item -mplt
13702 @itemx -mno-plt
13703 @opindex mplt
13704 @opindex mno-plt
13705 Assume (do not assume) that the static and dynamic linkers
13706 support PLTs and copy relocations.  This option only affects
13707 @samp{-mno-shared -mabicalls}.  For the n64 ABI, this option
13708 has no effect without @samp{-msym32}.
13709
13710 You can make @option{-mplt} the default by configuring
13711 GCC with @option{--with-mips-plt}.  The default is
13712 @option{-mno-plt} otherwise.
13713
13714 @item -mxgot
13715 @itemx -mno-xgot
13716 @opindex mxgot
13717 @opindex mno-xgot
13718 Lift (do not lift) the usual restrictions on the size of the global
13719 offset table.
13720
13721 GCC normally uses a single instruction to load values from the GOT@.
13722 While this is relatively efficient, it will only work if the GOT
13723 is smaller than about 64k.  Anything larger will cause the linker
13724 to report an error such as:
13725
13726 @cindex relocation truncated to fit (MIPS)
13727 @smallexample
13728 relocation truncated to fit: R_MIPS_GOT16 foobar
13729 @end smallexample
13730
13731 If this happens, you should recompile your code with @option{-mxgot}.
13732 It should then work with very large GOTs, although it will also be
13733 less efficient, since it will take three instructions to fetch the
13734 value of a global symbol.
13735
13736 Note that some linkers can create multiple GOTs.  If you have such a
13737 linker, you should only need to use @option{-mxgot} when a single object
13738 file accesses more than 64k's worth of GOT entries.  Very few do.
13739
13740 These options have no effect unless GCC is generating position
13741 independent code.
13742
13743 @item -mgp32
13744 @opindex mgp32
13745 Assume that general-purpose registers are 32 bits wide.
13746
13747 @item -mgp64
13748 @opindex mgp64
13749 Assume that general-purpose registers are 64 bits wide.
13750
13751 @item -mfp32
13752 @opindex mfp32
13753 Assume that floating-point registers are 32 bits wide.
13754
13755 @item -mfp64
13756 @opindex mfp64
13757 Assume that floating-point registers are 64 bits wide.
13758
13759 @item -mhard-float
13760 @opindex mhard-float
13761 Use floating-point coprocessor instructions.
13762
13763 @item -msoft-float
13764 @opindex msoft-float
13765 Do not use floating-point coprocessor instructions.  Implement
13766 floating-point calculations using library calls instead.
13767
13768 @item -msingle-float
13769 @opindex msingle-float
13770 Assume that the floating-point coprocessor only supports single-precision
13771 operations.
13772
13773 @item -mdouble-float
13774 @opindex mdouble-float
13775 Assume that the floating-point coprocessor supports double-precision
13776 operations.  This is the default.
13777
13778 @item -mllsc
13779 @itemx -mno-llsc
13780 @opindex mllsc
13781 @opindex mno-llsc
13782 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
13783 implement atomic memory built-in functions.  When neither option is
13784 specified, GCC will use the instructions if the target architecture
13785 supports them.
13786
13787 @option{-mllsc} is useful if the runtime environment can emulate the
13788 instructions and @option{-mno-llsc} can be useful when compiling for
13789 nonstandard ISAs.  You can make either option the default by
13790 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
13791 respectively.  @option{--with-llsc} is the default for some
13792 configurations; see the installation documentation for details.
13793
13794 @item -mdsp
13795 @itemx -mno-dsp
13796 @opindex mdsp
13797 @opindex mno-dsp
13798 Use (do not use) revision 1 of the MIPS DSP ASE@.
13799 @xref{MIPS DSP Built-in Functions}.  This option defines the
13800 preprocessor macro @samp{__mips_dsp}.  It also defines
13801 @samp{__mips_dsp_rev} to 1.
13802
13803 @item -mdspr2
13804 @itemx -mno-dspr2
13805 @opindex mdspr2
13806 @opindex mno-dspr2
13807 Use (do not use) revision 2 of the MIPS DSP ASE@.
13808 @xref{MIPS DSP Built-in Functions}.  This option defines the
13809 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
13810 It also defines @samp{__mips_dsp_rev} to 2.
13811
13812 @item -msmartmips
13813 @itemx -mno-smartmips
13814 @opindex msmartmips
13815 @opindex mno-smartmips
13816 Use (do not use) the MIPS SmartMIPS ASE.
13817
13818 @item -mpaired-single
13819 @itemx -mno-paired-single
13820 @opindex mpaired-single
13821 @opindex mno-paired-single
13822 Use (do not use) paired-single floating-point instructions.
13823 @xref{MIPS Paired-Single Support}.  This option requires
13824 hardware floating-point support to be enabled.
13825
13826 @item -mdmx
13827 @itemx -mno-mdmx
13828 @opindex mdmx
13829 @opindex mno-mdmx
13830 Use (do not use) MIPS Digital Media Extension instructions.
13831 This option can only be used when generating 64-bit code and requires
13832 hardware floating-point support to be enabled.
13833
13834 @item -mips3d
13835 @itemx -mno-mips3d
13836 @opindex mips3d
13837 @opindex mno-mips3d
13838 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
13839 The option @option{-mips3d} implies @option{-mpaired-single}.
13840
13841 @item -mmt
13842 @itemx -mno-mt
13843 @opindex mmt
13844 @opindex mno-mt
13845 Use (do not use) MT Multithreading instructions.
13846
13847 @item -mlong64
13848 @opindex mlong64
13849 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
13850 an explanation of the default and the way that the pointer size is
13851 determined.
13852
13853 @item -mlong32
13854 @opindex mlong32
13855 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
13856
13857 The default size of @code{int}s, @code{long}s and pointers depends on
13858 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
13859 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
13860 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
13861 or the same size as integer registers, whichever is smaller.
13862
13863 @item -msym32
13864 @itemx -mno-sym32
13865 @opindex msym32
13866 @opindex mno-sym32
13867 Assume (do not assume) that all symbols have 32-bit values, regardless
13868 of the selected ABI@.  This option is useful in combination with
13869 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
13870 to generate shorter and faster references to symbolic addresses.
13871
13872 @item -G @var{num}
13873 @opindex G
13874 Put definitions of externally-visible data in a small data section
13875 if that data is no bigger than @var{num} bytes.  GCC can then access
13876 the data more efficiently; see @option{-mgpopt} for details.
13877
13878 The default @option{-G} option depends on the configuration.
13879
13880 @item -mlocal-sdata
13881 @itemx -mno-local-sdata
13882 @opindex mlocal-sdata
13883 @opindex mno-local-sdata
13884 Extend (do not extend) the @option{-G} behavior to local data too,
13885 such as to static variables in C@.  @option{-mlocal-sdata} is the
13886 default for all configurations.
13887
13888 If the linker complains that an application is using too much small data,
13889 you might want to try rebuilding the less performance-critical parts with
13890 @option{-mno-local-sdata}.  You might also want to build large
13891 libraries with @option{-mno-local-sdata}, so that the libraries leave
13892 more room for the main program.
13893
13894 @item -mextern-sdata
13895 @itemx -mno-extern-sdata
13896 @opindex mextern-sdata
13897 @opindex mno-extern-sdata
13898 Assume (do not assume) that externally-defined data will be in
13899 a small data section if that data is within the @option{-G} limit.
13900 @option{-mextern-sdata} is the default for all configurations.
13901
13902 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
13903 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
13904 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
13905 is placed in a small data section.  If @var{Var} is defined by another
13906 module, you must either compile that module with a high-enough
13907 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
13908 definition.  If @var{Var} is common, you must link the application
13909 with a high-enough @option{-G} setting.
13910
13911 The easiest way of satisfying these restrictions is to compile
13912 and link every module with the same @option{-G} option.  However,
13913 you may wish to build a library that supports several different
13914 small data limits.  You can do this by compiling the library with
13915 the highest supported @option{-G} setting and additionally using
13916 @option{-mno-extern-sdata} to stop the library from making assumptions
13917 about externally-defined data.
13918
13919 @item -mgpopt
13920 @itemx -mno-gpopt
13921 @opindex mgpopt
13922 @opindex mno-gpopt
13923 Use (do not use) GP-relative accesses for symbols that are known to be
13924 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
13925 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
13926 configurations.
13927
13928 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
13929 might not hold the value of @code{_gp}.  For example, if the code is
13930 part of a library that might be used in a boot monitor, programs that
13931 call boot monitor routines will pass an unknown value in @code{$gp}.
13932 (In such situations, the boot monitor itself would usually be compiled
13933 with @option{-G0}.)
13934
13935 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
13936 @option{-mno-extern-sdata}.
13937
13938 @item -membedded-data
13939 @itemx -mno-embedded-data
13940 @opindex membedded-data
13941 @opindex mno-embedded-data
13942 Allocate variables to the read-only data section first if possible, then
13943 next in the small data section if possible, otherwise in data.  This gives
13944 slightly slower code than the default, but reduces the amount of RAM required
13945 when executing, and thus may be preferred for some embedded systems.
13946
13947 @item -muninit-const-in-rodata
13948 @itemx -mno-uninit-const-in-rodata
13949 @opindex muninit-const-in-rodata
13950 @opindex mno-uninit-const-in-rodata
13951 Put uninitialized @code{const} variables in the read-only data section.
13952 This option is only meaningful in conjunction with @option{-membedded-data}.
13953
13954 @item -mcode-readable=@var{setting}
13955 @opindex mcode-readable
13956 Specify whether GCC may generate code that reads from executable sections.
13957 There are three possible settings:
13958
13959 @table @gcctabopt
13960 @item -mcode-readable=yes
13961 Instructions may freely access executable sections.  This is the
13962 default setting.
13963
13964 @item -mcode-readable=pcrel
13965 MIPS16 PC-relative load instructions can access executable sections,
13966 but other instructions must not do so.  This option is useful on 4KSc
13967 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
13968 It is also useful on processors that can be configured to have a dual
13969 instruction/data SRAM interface and that, like the M4K, automatically
13970 redirect PC-relative loads to the instruction RAM.
13971
13972 @item -mcode-readable=no
13973 Instructions must not access executable sections.  This option can be
13974 useful on targets that are configured to have a dual instruction/data
13975 SRAM interface but that (unlike the M4K) do not automatically redirect
13976 PC-relative loads to the instruction RAM.
13977 @end table
13978
13979 @item -msplit-addresses
13980 @itemx -mno-split-addresses
13981 @opindex msplit-addresses
13982 @opindex mno-split-addresses
13983 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
13984 relocation operators.  This option has been superseded by
13985 @option{-mexplicit-relocs} but is retained for backwards compatibility.
13986
13987 @item -mexplicit-relocs
13988 @itemx -mno-explicit-relocs
13989 @opindex mexplicit-relocs
13990 @opindex mno-explicit-relocs
13991 Use (do not use) assembler relocation operators when dealing with symbolic
13992 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
13993 is to use assembler macros instead.
13994
13995 @option{-mexplicit-relocs} is the default if GCC was configured
13996 to use an assembler that supports relocation operators.
13997
13998 @item -mcheck-zero-division
13999 @itemx -mno-check-zero-division
14000 @opindex mcheck-zero-division
14001 @opindex mno-check-zero-division
14002 Trap (do not trap) on integer division by zero.
14003
14004 The default is @option{-mcheck-zero-division}.
14005
14006 @item -mdivide-traps
14007 @itemx -mdivide-breaks
14008 @opindex mdivide-traps
14009 @opindex mdivide-breaks
14010 MIPS systems check for division by zero by generating either a
14011 conditional trap or a break instruction.  Using traps results in
14012 smaller code, but is only supported on MIPS II and later.  Also, some
14013 versions of the Linux kernel have a bug that prevents trap from
14014 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
14015 allow conditional traps on architectures that support them and
14016 @option{-mdivide-breaks} to force the use of breaks.
14017
14018 The default is usually @option{-mdivide-traps}, but this can be
14019 overridden at configure time using @option{--with-divide=breaks}.
14020 Divide-by-zero checks can be completely disabled using
14021 @option{-mno-check-zero-division}.
14022
14023 @item -mmemcpy
14024 @itemx -mno-memcpy
14025 @opindex mmemcpy
14026 @opindex mno-memcpy
14027 Force (do not force) the use of @code{memcpy()} for non-trivial block
14028 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
14029 most constant-sized copies.
14030
14031 @item -mlong-calls
14032 @itemx -mno-long-calls
14033 @opindex mlong-calls
14034 @opindex mno-long-calls
14035 Disable (do not disable) use of the @code{jal} instruction.  Calling
14036 functions using @code{jal} is more efficient but requires the caller
14037 and callee to be in the same 256 megabyte segment.
14038
14039 This option has no effect on abicalls code.  The default is
14040 @option{-mno-long-calls}.
14041
14042 @item -mmad
14043 @itemx -mno-mad
14044 @opindex mmad
14045 @opindex mno-mad
14046 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
14047 instructions, as provided by the R4650 ISA@.
14048
14049 @item -mfused-madd
14050 @itemx -mno-fused-madd
14051 @opindex mfused-madd
14052 @opindex mno-fused-madd
14053 Enable (disable) use of the floating point multiply-accumulate
14054 instructions, when they are available.  The default is
14055 @option{-mfused-madd}.
14056
14057 When multiply-accumulate instructions are used, the intermediate
14058 product is calculated to infinite precision and is not subject to
14059 the FCSR Flush to Zero bit.  This may be undesirable in some
14060 circumstances.
14061
14062 @item -nocpp
14063 @opindex nocpp
14064 Tell the MIPS assembler to not run its preprocessor over user
14065 assembler files (with a @samp{.s} suffix) when assembling them.
14066
14067 @item -mfix-r4000
14068 @itemx -mno-fix-r4000
14069 @opindex mfix-r4000
14070 @opindex mno-fix-r4000
14071 Work around certain R4000 CPU errata:
14072 @itemize @minus
14073 @item
14074 A double-word or a variable shift may give an incorrect result if executed
14075 immediately after starting an integer division.
14076 @item
14077 A double-word or a variable shift may give an incorrect result if executed
14078 while an integer multiplication is in progress.
14079 @item
14080 An integer division may give an incorrect result if started in a delay slot
14081 of a taken branch or a jump.
14082 @end itemize
14083
14084 @item -mfix-r4400
14085 @itemx -mno-fix-r4400
14086 @opindex mfix-r4400
14087 @opindex mno-fix-r4400
14088 Work around certain R4400 CPU errata:
14089 @itemize @minus
14090 @item
14091 A double-word or a variable shift may give an incorrect result if executed
14092 immediately after starting an integer division.
14093 @end itemize
14094
14095 @item -mfix-r10000
14096 @itemx -mno-fix-r10000
14097 @opindex mfix-r10000
14098 @opindex mno-fix-r10000
14099 Work around certain R10000 errata:
14100 @itemize @minus
14101 @item
14102 @code{ll}/@code{sc} sequences may not behave atomically on revisions
14103 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
14104 @end itemize
14105
14106 This option can only be used if the target architecture supports
14107 branch-likely instructions.  @option{-mfix-r10000} is the default when
14108 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
14109 otherwise.
14110
14111 @item -mfix-vr4120
14112 @itemx -mno-fix-vr4120
14113 @opindex mfix-vr4120
14114 Work around certain VR4120 errata:
14115 @itemize @minus
14116 @item
14117 @code{dmultu} does not always produce the correct result.
14118 @item
14119 @code{div} and @code{ddiv} do not always produce the correct result if one
14120 of the operands is negative.
14121 @end itemize
14122 The workarounds for the division errata rely on special functions in
14123 @file{libgcc.a}.  At present, these functions are only provided by
14124 the @code{mips64vr*-elf} configurations.
14125
14126 Other VR4120 errata require a nop to be inserted between certain pairs of
14127 instructions.  These errata are handled by the assembler, not by GCC itself.
14128
14129 @item -mfix-vr4130
14130 @opindex mfix-vr4130
14131 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
14132 workarounds are implemented by the assembler rather than by GCC,
14133 although GCC will avoid using @code{mflo} and @code{mfhi} if the
14134 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
14135 instructions are available instead.
14136
14137 @item -mfix-sb1
14138 @itemx -mno-fix-sb1
14139 @opindex mfix-sb1
14140 Work around certain SB-1 CPU core errata.
14141 (This flag currently works around the SB-1 revision 2
14142 ``F1'' and ``F2'' floating point errata.)
14143
14144 @item -mr10k-cache-barrier=@var{setting}
14145 @opindex mr10k-cache-barrier
14146 Specify whether GCC should insert cache barriers to avoid the
14147 side-effects of speculation on R10K processors.
14148
14149 In common with many processors, the R10K tries to predict the outcome
14150 of a conditional branch and speculatively executes instructions from
14151 the ``taken'' branch.  It later aborts these instructions if the
14152 predicted outcome was wrong.  However, on the R10K, even aborted
14153 instructions can have side effects.
14154
14155 This problem only affects kernel stores and, depending on the system,
14156 kernel loads.  As an example, a speculatively-executed store may load
14157 the target memory into cache and mark the cache line as dirty, even if
14158 the store itself is later aborted.  If a DMA operation writes to the
14159 same area of memory before the ``dirty'' line is flushed, the cached
14160 data will overwrite the DMA-ed data.  See the R10K processor manual
14161 for a full description, including other potential problems.
14162
14163 One workaround is to insert cache barrier instructions before every memory
14164 access that might be speculatively executed and that might have side
14165 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
14166 controls GCC's implementation of this workaround.  It assumes that
14167 aborted accesses to any byte in the following regions will not have
14168 side effects:
14169
14170 @enumerate
14171 @item
14172 the memory occupied by the current function's stack frame;
14173
14174 @item
14175 the memory occupied by an incoming stack argument;
14176
14177 @item
14178 the memory occupied by an object with a link-time-constant address.
14179 @end enumerate
14180
14181 It is the kernel's responsibility to ensure that speculative
14182 accesses to these regions are indeed safe.
14183
14184 If the input program contains a function declaration such as:
14185
14186 @smallexample
14187 void foo (void);
14188 @end smallexample
14189
14190 then the implementation of @code{foo} must allow @code{j foo} and
14191 @code{jal foo} to be executed speculatively.  GCC honors this
14192 restriction for functions it compiles itself.  It expects non-GCC
14193 functions (such as hand-written assembly code) to do the same.
14194
14195 The option has three forms:
14196
14197 @table @gcctabopt
14198 @item -mr10k-cache-barrier=load-store
14199 Insert a cache barrier before a load or store that might be
14200 speculatively executed and that might have side effects even
14201 if aborted.
14202
14203 @item -mr10k-cache-barrier=store
14204 Insert a cache barrier before a store that might be speculatively
14205 executed and that might have side effects even if aborted.
14206
14207 @item -mr10k-cache-barrier=none
14208 Disable the insertion of cache barriers.  This is the default setting.
14209 @end table
14210
14211 @item -mflush-func=@var{func}
14212 @itemx -mno-flush-func
14213 @opindex mflush-func
14214 Specifies the function to call to flush the I and D caches, or to not
14215 call any such function.  If called, the function must take the same
14216 arguments as the common @code{_flush_func()}, that is, the address of the
14217 memory range for which the cache is being flushed, the size of the
14218 memory range, and the number 3 (to flush both caches).  The default
14219 depends on the target GCC was configured for, but commonly is either
14220 @samp{_flush_func} or @samp{__cpu_flush}.
14221
14222 @item mbranch-cost=@var{num}
14223 @opindex mbranch-cost
14224 Set the cost of branches to roughly @var{num} ``simple'' instructions.
14225 This cost is only a heuristic and is not guaranteed to produce
14226 consistent results across releases.  A zero cost redundantly selects
14227 the default, which is based on the @option{-mtune} setting.
14228
14229 @item -mbranch-likely
14230 @itemx -mno-branch-likely
14231 @opindex mbranch-likely
14232 @opindex mno-branch-likely
14233 Enable or disable use of Branch Likely instructions, regardless of the
14234 default for the selected architecture.  By default, Branch Likely
14235 instructions may be generated if they are supported by the selected
14236 architecture.  An exception is for the MIPS32 and MIPS64 architectures
14237 and processors which implement those architectures; for those, Branch
14238 Likely instructions will not be generated by default because the MIPS32
14239 and MIPS64 architectures specifically deprecate their use.
14240
14241 @item -mfp-exceptions
14242 @itemx -mno-fp-exceptions
14243 @opindex mfp-exceptions
14244 Specifies whether FP exceptions are enabled.  This affects how we schedule
14245 FP instructions for some processors.  The default is that FP exceptions are
14246 enabled.
14247
14248 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
14249 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
14250 FP pipe.
14251
14252 @item -mvr4130-align
14253 @itemx -mno-vr4130-align
14254 @opindex mvr4130-align
14255 The VR4130 pipeline is two-way superscalar, but can only issue two
14256 instructions together if the first one is 8-byte aligned.  When this
14257 option is enabled, GCC will align pairs of instructions that it
14258 thinks should execute in parallel.
14259
14260 This option only has an effect when optimizing for the VR4130.
14261 It normally makes code faster, but at the expense of making it bigger.
14262 It is enabled by default at optimization level @option{-O3}.
14263
14264 @item -msynci
14265 @itemx -mno-synci
14266 @opindex msynci
14267 Enable (disable) generation of @code{synci} instructions on
14268 architectures that support it.  The @code{synci} instructions (if
14269 enabled) will be generated when @code{__builtin___clear_cache()} is
14270 compiled.
14271
14272 This option defaults to @code{-mno-synci}, but the default can be
14273 overridden by configuring with @code{--with-synci}.
14274
14275 When compiling code for single processor systems, it is generally safe
14276 to use @code{synci}.  However, on many multi-core (SMP) systems, it
14277 will not invalidate the instruction caches on all cores and may lead
14278 to undefined behavior.
14279
14280 @item -mrelax-pic-calls
14281 @itemx -mno-relax-pic-calls
14282 @opindex mrelax-pic-calls
14283 Try to turn PIC calls that are normally dispatched via register
14284 @code{$25} into direct calls.  This is only possible if the linker can
14285 resolve the destination at link-time and if the destination is within
14286 range for a direct call.
14287
14288 @option{-mrelax-pic-calls} is the default if GCC was configured to use
14289 an assembler and a linker that supports the @code{.reloc} assembly
14290 directive and @code{-mexplicit-relocs} is in effect.  With
14291 @code{-mno-explicit-relocs}, this optimization can be performed by the
14292 assembler and the linker alone without help from the compiler.
14293
14294 @item -mmcount-ra-address
14295 @itemx -mno-mcount-ra-address
14296 @opindex mmcount-ra-address
14297 @opindex mno-mcount-ra-address
14298 Emit (do not emit) code that allows @code{_mcount} to modify the
14299 calling function's return address.  When enabled, this option extends
14300 the usual @code{_mcount} interface with a new @var{ra-address}
14301 parameter, which has type @code{intptr_t *} and is passed in register
14302 @code{$12}.  @code{_mcount} can then modify the return address by
14303 doing both of the following:
14304 @itemize
14305 @item
14306 Returning the new address in register @code{$31}.
14307 @item
14308 Storing the new address in @code{*@var{ra-address}},
14309 if @var{ra-address} is nonnull.
14310 @end itemize
14311
14312 The default is @option{-mno-mcount-ra-address}.
14313
14314 @end table
14315
14316 @node MMIX Options
14317 @subsection MMIX Options
14318 @cindex MMIX Options
14319
14320 These options are defined for the MMIX:
14321
14322 @table @gcctabopt
14323 @item -mlibfuncs
14324 @itemx -mno-libfuncs
14325 @opindex mlibfuncs
14326 @opindex mno-libfuncs
14327 Specify that intrinsic library functions are being compiled, passing all
14328 values in registers, no matter the size.
14329
14330 @item -mepsilon
14331 @itemx -mno-epsilon
14332 @opindex mepsilon
14333 @opindex mno-epsilon
14334 Generate floating-point comparison instructions that compare with respect
14335 to the @code{rE} epsilon register.
14336
14337 @item -mabi=mmixware
14338 @itemx -mabi=gnu
14339 @opindex mabi=mmixware
14340 @opindex mabi=gnu
14341 Generate code that passes function parameters and return values that (in
14342 the called function) are seen as registers @code{$0} and up, as opposed to
14343 the GNU ABI which uses global registers @code{$231} and up.
14344
14345 @item -mzero-extend
14346 @itemx -mno-zero-extend
14347 @opindex mzero-extend
14348 @opindex mno-zero-extend
14349 When reading data from memory in sizes shorter than 64 bits, use (do not
14350 use) zero-extending load instructions by default, rather than
14351 sign-extending ones.
14352
14353 @item -mknuthdiv
14354 @itemx -mno-knuthdiv
14355 @opindex mknuthdiv
14356 @opindex mno-knuthdiv
14357 Make the result of a division yielding a remainder have the same sign as
14358 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
14359 remainder follows the sign of the dividend.  Both methods are
14360 arithmetically valid, the latter being almost exclusively used.
14361
14362 @item -mtoplevel-symbols
14363 @itemx -mno-toplevel-symbols
14364 @opindex mtoplevel-symbols
14365 @opindex mno-toplevel-symbols
14366 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
14367 code can be used with the @code{PREFIX} assembly directive.
14368
14369 @item -melf
14370 @opindex melf
14371 Generate an executable in the ELF format, rather than the default
14372 @samp{mmo} format used by the @command{mmix} simulator.
14373
14374 @item -mbranch-predict
14375 @itemx -mno-branch-predict
14376 @opindex mbranch-predict
14377 @opindex mno-branch-predict
14378 Use (do not use) the probable-branch instructions, when static branch
14379 prediction indicates a probable branch.
14380
14381 @item -mbase-addresses
14382 @itemx -mno-base-addresses
14383 @opindex mbase-addresses
14384 @opindex mno-base-addresses
14385 Generate (do not generate) code that uses @emph{base addresses}.  Using a
14386 base address automatically generates a request (handled by the assembler
14387 and the linker) for a constant to be set up in a global register.  The
14388 register is used for one or more base address requests within the range 0
14389 to 255 from the value held in the register.  The generally leads to short
14390 and fast code, but the number of different data items that can be
14391 addressed is limited.  This means that a program that uses lots of static
14392 data may require @option{-mno-base-addresses}.
14393
14394 @item -msingle-exit
14395 @itemx -mno-single-exit
14396 @opindex msingle-exit
14397 @opindex mno-single-exit
14398 Force (do not force) generated code to have a single exit point in each
14399 function.
14400 @end table
14401
14402 @node MN10300 Options
14403 @subsection MN10300 Options
14404 @cindex MN10300 options
14405
14406 These @option{-m} options are defined for Matsushita MN10300 architectures:
14407
14408 @table @gcctabopt
14409 @item -mmult-bug
14410 @opindex mmult-bug
14411 Generate code to avoid bugs in the multiply instructions for the MN10300
14412 processors.  This is the default.
14413
14414 @item -mno-mult-bug
14415 @opindex mno-mult-bug
14416 Do not generate code to avoid bugs in the multiply instructions for the
14417 MN10300 processors.
14418
14419 @item -mam33
14420 @opindex mam33
14421 Generate code which uses features specific to the AM33 processor.
14422
14423 @item -mno-am33
14424 @opindex mno-am33
14425 Do not generate code which uses features specific to the AM33 processor.  This
14426 is the default.
14427
14428 @item -mreturn-pointer-on-d0
14429 @opindex mreturn-pointer-on-d0
14430 When generating a function which returns a pointer, return the pointer
14431 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
14432 only in a0, and attempts to call such functions without a prototype
14433 would result in errors.  Note that this option is on by default; use
14434 @option{-mno-return-pointer-on-d0} to disable it.
14435
14436 @item -mno-crt0
14437 @opindex mno-crt0
14438 Do not link in the C run-time initialization object file.
14439
14440 @item -mrelax
14441 @opindex mrelax
14442 Indicate to the linker that it should perform a relaxation optimization pass
14443 to shorten branches, calls and absolute memory addresses.  This option only
14444 has an effect when used on the command line for the final link step.
14445
14446 This option makes symbolic debugging impossible.
14447 @end table
14448
14449 @node PDP-11 Options
14450 @subsection PDP-11 Options
14451 @cindex PDP-11 Options
14452
14453 These options are defined for the PDP-11:
14454
14455 @table @gcctabopt
14456 @item -mfpu
14457 @opindex mfpu
14458 Use hardware FPP floating point.  This is the default.  (FIS floating
14459 point on the PDP-11/40 is not supported.)
14460
14461 @item -msoft-float
14462 @opindex msoft-float
14463 Do not use hardware floating point.
14464
14465 @item -mac0
14466 @opindex mac0
14467 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
14468
14469 @item -mno-ac0
14470 @opindex mno-ac0
14471 Return floating-point results in memory.  This is the default.
14472
14473 @item -m40
14474 @opindex m40
14475 Generate code for a PDP-11/40.
14476
14477 @item -m45
14478 @opindex m45
14479 Generate code for a PDP-11/45.  This is the default.
14480
14481 @item -m10
14482 @opindex m10
14483 Generate code for a PDP-11/10.
14484
14485 @item -mbcopy-builtin
14486 @opindex mbcopy-builtin
14487 Use inline @code{movmemhi} patterns for copying memory.  This is the
14488 default.
14489
14490 @item -mbcopy
14491 @opindex mbcopy
14492 Do not use inline @code{movmemhi} patterns for copying memory.
14493
14494 @item -mint16
14495 @itemx -mno-int32
14496 @opindex mint16
14497 @opindex mno-int32
14498 Use 16-bit @code{int}.  This is the default.
14499
14500 @item -mint32
14501 @itemx -mno-int16
14502 @opindex mint32
14503 @opindex mno-int16
14504 Use 32-bit @code{int}.
14505
14506 @item -mfloat64
14507 @itemx -mno-float32
14508 @opindex mfloat64
14509 @opindex mno-float32
14510 Use 64-bit @code{float}.  This is the default.
14511
14512 @item -mfloat32
14513 @itemx -mno-float64
14514 @opindex mfloat32
14515 @opindex mno-float64
14516 Use 32-bit @code{float}.
14517
14518 @item -mabshi
14519 @opindex mabshi
14520 Use @code{abshi2} pattern.  This is the default.
14521
14522 @item -mno-abshi
14523 @opindex mno-abshi
14524 Do not use @code{abshi2} pattern.
14525
14526 @item -mbranch-expensive
14527 @opindex mbranch-expensive
14528 Pretend that branches are expensive.  This is for experimenting with
14529 code generation only.
14530
14531 @item -mbranch-cheap
14532 @opindex mbranch-cheap
14533 Do not pretend that branches are expensive.  This is the default.
14534
14535 @item -msplit
14536 @opindex msplit
14537 Generate code for a system with split I&D@.
14538
14539 @item -mno-split
14540 @opindex mno-split
14541 Generate code for a system without split I&D@.  This is the default.
14542
14543 @item -munix-asm
14544 @opindex munix-asm
14545 Use Unix assembler syntax.  This is the default when configured for
14546 @samp{pdp11-*-bsd}.
14547
14548 @item -mdec-asm
14549 @opindex mdec-asm
14550 Use DEC assembler syntax.  This is the default when configured for any
14551 PDP-11 target other than @samp{pdp11-*-bsd}.
14552 @end table
14553
14554 @node picoChip Options
14555 @subsection picoChip Options
14556 @cindex picoChip options
14557
14558 These @samp{-m} options are defined for picoChip implementations:
14559
14560 @table @gcctabopt
14561
14562 @item -mae=@var{ae_type}
14563 @opindex mcpu
14564 Set the instruction set, register set, and instruction scheduling
14565 parameters for array element type @var{ae_type}.  Supported values
14566 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
14567
14568 @option{-mae=ANY} selects a completely generic AE type.  Code
14569 generated with this option will run on any of the other AE types.  The
14570 code will not be as efficient as it would be if compiled for a specific
14571 AE type, and some types of operation (e.g., multiplication) will not
14572 work properly on all types of AE.
14573
14574 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
14575 for compiled code, and is the default.
14576
14577 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
14578 option may suffer from poor performance of byte (char) manipulation,
14579 since the DSP AE does not provide hardware support for byte load/stores.
14580
14581 @item -msymbol-as-address
14582 Enable the compiler to directly use a symbol name as an address in a
14583 load/store instruction, without first loading it into a
14584 register.  Typically, the use of this option will generate larger
14585 programs, which run faster than when the option isn't used.  However, the
14586 results vary from program to program, so it is left as a user option,
14587 rather than being permanently enabled.
14588
14589 @item -mno-inefficient-warnings
14590 Disables warnings about the generation of inefficient code.  These
14591 warnings can be generated, for example, when compiling code which
14592 performs byte-level memory operations on the MAC AE type.  The MAC AE has
14593 no hardware support for byte-level memory operations, so all byte
14594 load/stores must be synthesized from word load/store operations.  This is
14595 inefficient and a warning will be generated indicating to the programmer
14596 that they should rewrite the code to avoid byte operations, or to target
14597 an AE type which has the necessary hardware support.  This option enables
14598 the warning to be turned off.
14599
14600 @end table
14601
14602 @node PowerPC Options
14603 @subsection PowerPC Options
14604 @cindex PowerPC options
14605
14606 These are listed under @xref{RS/6000 and PowerPC Options}.
14607
14608 @node RS/6000 and PowerPC Options
14609 @subsection IBM RS/6000 and PowerPC Options
14610 @cindex RS/6000 and PowerPC Options
14611 @cindex IBM RS/6000 and PowerPC Options
14612
14613 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
14614 @table @gcctabopt
14615 @item -mpower
14616 @itemx -mno-power
14617 @itemx -mpower2
14618 @itemx -mno-power2
14619 @itemx -mpowerpc
14620 @itemx -mno-powerpc
14621 @itemx -mpowerpc-gpopt
14622 @itemx -mno-powerpc-gpopt
14623 @itemx -mpowerpc-gfxopt
14624 @itemx -mno-powerpc-gfxopt
14625 @itemx -mpowerpc64
14626 @itemx -mno-powerpc64
14627 @itemx -mmfcrf
14628 @itemx -mno-mfcrf
14629 @itemx -mpopcntb
14630 @itemx -mno-popcntb
14631 @itemx -mpopcntd
14632 @itemx -mno-popcntd
14633 @itemx -mfprnd
14634 @itemx -mno-fprnd
14635 @itemx -mcmpb
14636 @itemx -mno-cmpb
14637 @itemx -mmfpgpr
14638 @itemx -mno-mfpgpr
14639 @itemx -mhard-dfp
14640 @itemx -mno-hard-dfp
14641 @opindex mpower
14642 @opindex mno-power
14643 @opindex mpower2
14644 @opindex mno-power2
14645 @opindex mpowerpc
14646 @opindex mno-powerpc
14647 @opindex mpowerpc-gpopt
14648 @opindex mno-powerpc-gpopt
14649 @opindex mpowerpc-gfxopt
14650 @opindex mno-powerpc-gfxopt
14651 @opindex mpowerpc64
14652 @opindex mno-powerpc64
14653 @opindex mmfcrf
14654 @opindex mno-mfcrf
14655 @opindex mpopcntb
14656 @opindex mno-popcntb
14657 @opindex mpopcntd
14658 @opindex mno-popcntd
14659 @opindex mfprnd
14660 @opindex mno-fprnd
14661 @opindex mcmpb
14662 @opindex mno-cmpb
14663 @opindex mmfpgpr
14664 @opindex mno-mfpgpr
14665 @opindex mhard-dfp
14666 @opindex mno-hard-dfp
14667 GCC supports two related instruction set architectures for the
14668 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
14669 instructions supported by the @samp{rios} chip set used in the original
14670 RS/6000 systems and the @dfn{PowerPC} instruction set is the
14671 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
14672 the IBM 4xx, 6xx, and follow-on microprocessors.
14673
14674 Neither architecture is a subset of the other.  However there is a
14675 large common subset of instructions supported by both.  An MQ
14676 register is included in processors supporting the POWER architecture.
14677
14678 You use these options to specify which instructions are available on the
14679 processor you are using.  The default value of these options is
14680 determined when configuring GCC@.  Specifying the
14681 @option{-mcpu=@var{cpu_type}} overrides the specification of these
14682 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
14683 rather than the options listed above.
14684
14685 The @option{-mpower} option allows GCC to generate instructions that
14686 are found only in the POWER architecture and to use the MQ register.
14687 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
14688 to generate instructions that are present in the POWER2 architecture but
14689 not the original POWER architecture.
14690
14691 The @option{-mpowerpc} option allows GCC to generate instructions that
14692 are found only in the 32-bit subset of the PowerPC architecture.
14693 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
14694 GCC to use the optional PowerPC architecture instructions in the
14695 General Purpose group, including floating-point square root.  Specifying
14696 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
14697 use the optional PowerPC architecture instructions in the Graphics
14698 group, including floating-point select.
14699
14700 The @option{-mmfcrf} option allows GCC to generate the move from
14701 condition register field instruction implemented on the POWER4
14702 processor and other processors that support the PowerPC V2.01
14703 architecture.
14704 The @option{-mpopcntb} option allows GCC to generate the popcount and
14705 double precision FP reciprocal estimate instruction implemented on the
14706 POWER5 processor and other processors that support the PowerPC V2.02
14707 architecture.
14708 The @option{-mpopcntd} option allows GCC to generate the popcount
14709 instruction implemented on the POWER7 processor and other processors
14710 that support the PowerPC V2.06 architecture.
14711 The @option{-mfprnd} option allows GCC to generate the FP round to
14712 integer instructions implemented on the POWER5+ processor and other
14713 processors that support the PowerPC V2.03 architecture.
14714 The @option{-mcmpb} option allows GCC to generate the compare bytes
14715 instruction implemented on the POWER6 processor and other processors
14716 that support the PowerPC V2.05 architecture.
14717 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
14718 general purpose register instructions implemented on the POWER6X
14719 processor and other processors that support the extended PowerPC V2.05
14720 architecture.
14721 The @option{-mhard-dfp} option allows GCC to generate the decimal floating
14722 point instructions implemented on some POWER processors.
14723
14724 The @option{-mpowerpc64} option allows GCC to generate the additional
14725 64-bit instructions that are found in the full PowerPC64 architecture
14726 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
14727 @option{-mno-powerpc64}.
14728
14729 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
14730 will use only the instructions in the common subset of both
14731 architectures plus some special AIX common-mode calls, and will not use
14732 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
14733 permits GCC to use any instruction from either architecture and to
14734 allow use of the MQ register; specify this for the Motorola MPC601.
14735
14736 @item -mnew-mnemonics
14737 @itemx -mold-mnemonics
14738 @opindex mnew-mnemonics
14739 @opindex mold-mnemonics
14740 Select which mnemonics to use in the generated assembler code.  With
14741 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
14742 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
14743 assembler mnemonics defined for the POWER architecture.  Instructions
14744 defined in only one architecture have only one mnemonic; GCC uses that
14745 mnemonic irrespective of which of these options is specified.
14746
14747 GCC defaults to the mnemonics appropriate for the architecture in
14748 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
14749 value of these option.  Unless you are building a cross-compiler, you
14750 should normally not specify either @option{-mnew-mnemonics} or
14751 @option{-mold-mnemonics}, but should instead accept the default.
14752
14753 @item -mcpu=@var{cpu_type}
14754 @opindex mcpu
14755 Set architecture type, register usage, choice of mnemonics, and
14756 instruction scheduling parameters for machine type @var{cpu_type}.
14757 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
14758 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
14759 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
14760 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
14761 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
14762 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
14763 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{ec603e}, @samp{G3},
14764 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
14765 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6}, @samp{power6x},
14766 @samp{power7}, @samp{common}, @samp{powerpc}, @samp{powerpc64}, @samp{rios},
14767 @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
14768
14769 @option{-mcpu=common} selects a completely generic processor.  Code
14770 generated under this option will run on any POWER or PowerPC processor.
14771 GCC will use only the instructions in the common subset of both
14772 architectures, and will not use the MQ register.  GCC assumes a generic
14773 processor model for scheduling purposes.
14774
14775 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
14776 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
14777 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
14778 types, with an appropriate, generic processor model assumed for
14779 scheduling purposes.
14780
14781 The other options specify a specific processor.  Code generated under
14782 those options will run best on that processor, and may not run at all on
14783 others.
14784
14785 The @option{-mcpu} options automatically enable or disable the
14786 following options:
14787
14788 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
14789 -mnew-mnemonics  -mpopcntb -mpopcntd  -mpower  -mpower2  -mpowerpc64 @gol
14790 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
14791 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx}
14792
14793 The particular options set for any particular CPU will vary between
14794 compiler versions, depending on what setting seems to produce optimal
14795 code for that CPU; it doesn't necessarily reflect the actual hardware's
14796 capabilities.  If you wish to set an individual option to a particular
14797 value, you may specify it after the @option{-mcpu} option, like
14798 @samp{-mcpu=970 -mno-altivec}.
14799
14800 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
14801 not enabled or disabled by the @option{-mcpu} option at present because
14802 AIX does not have full support for these options.  You may still
14803 enable or disable them individually if you're sure it'll work in your
14804 environment.
14805
14806 @item -mtune=@var{cpu_type}
14807 @opindex mtune
14808 Set the instruction scheduling parameters for machine type
14809 @var{cpu_type}, but do not set the architecture type, register usage, or
14810 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
14811 values for @var{cpu_type} are used for @option{-mtune} as for
14812 @option{-mcpu}.  If both are specified, the code generated will use the
14813 architecture, registers, and mnemonics set by @option{-mcpu}, but the
14814 scheduling parameters set by @option{-mtune}.
14815
14816 @item -mswdiv
14817 @itemx -mno-swdiv
14818 @opindex mswdiv
14819 @opindex mno-swdiv
14820 Generate code to compute division as reciprocal estimate and iterative
14821 refinement, creating opportunities for increased throughput.  This
14822 feature requires: optional PowerPC Graphics instruction set for single
14823 precision and FRE instruction for double precision, assuming divides
14824 cannot generate user-visible traps, and the domain values not include
14825 Infinities, denormals or zero denominator.
14826
14827 @item -maltivec
14828 @itemx -mno-altivec
14829 @opindex maltivec
14830 @opindex mno-altivec
14831 Generate code that uses (does not use) AltiVec instructions, and also
14832 enable the use of built-in functions that allow more direct access to
14833 the AltiVec instruction set.  You may also need to set
14834 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
14835 enhancements.
14836
14837 @item -mvrsave
14838 @itemx -mno-vrsave
14839 @opindex mvrsave
14840 @opindex mno-vrsave
14841 Generate VRSAVE instructions when generating AltiVec code.
14842
14843 @item -mgen-cell-microcode
14844 @opindex mgen-cell-microcode
14845 Generate Cell microcode instructions
14846
14847 @item -mwarn-cell-microcode
14848 @opindex mwarn-cell-microcode
14849 Warning when a Cell microcode instruction is going to emitted.  An example
14850 of a Cell microcode instruction is a variable shift.
14851
14852 @item -msecure-plt
14853 @opindex msecure-plt
14854 Generate code that allows ld and ld.so to build executables and shared
14855 libraries with non-exec .plt and .got sections.  This is a PowerPC
14856 32-bit SYSV ABI option.
14857
14858 @item -mbss-plt
14859 @opindex mbss-plt
14860 Generate code that uses a BSS .plt section that ld.so fills in, and
14861 requires .plt and .got sections that are both writable and executable.
14862 This is a PowerPC 32-bit SYSV ABI option.
14863
14864 @item -misel
14865 @itemx -mno-isel
14866 @opindex misel
14867 @opindex mno-isel
14868 This switch enables or disables the generation of ISEL instructions.
14869
14870 @item -misel=@var{yes/no}
14871 This switch has been deprecated.  Use @option{-misel} and
14872 @option{-mno-isel} instead.
14873
14874 @item -mspe
14875 @itemx -mno-spe
14876 @opindex mspe
14877 @opindex mno-spe
14878 This switch enables or disables the generation of SPE simd
14879 instructions.
14880
14881 @item -mpaired
14882 @itemx -mno-paired
14883 @opindex mpaired
14884 @opindex mno-paired
14885 This switch enables or disables the generation of PAIRED simd
14886 instructions.
14887
14888 @item -mspe=@var{yes/no}
14889 This option has been deprecated.  Use @option{-mspe} and
14890 @option{-mno-spe} instead.
14891
14892 @item -mvsx
14893 @itemx -mno-vsx
14894 @opindex mvsx
14895 @opindex mno-vsx
14896 Generate code that uses (does not use) vector/scalar (VSX)
14897 instructions, and also enable the use of built-in functions that allow
14898 more direct access to the VSX instruction set.
14899
14900 @item -mfloat-gprs=@var{yes/single/double/no}
14901 @itemx -mfloat-gprs
14902 @opindex mfloat-gprs
14903 This switch enables or disables the generation of floating point
14904 operations on the general purpose registers for architectures that
14905 support it.
14906
14907 The argument @var{yes} or @var{single} enables the use of
14908 single-precision floating point operations.
14909
14910 The argument @var{double} enables the use of single and
14911 double-precision floating point operations.
14912
14913 The argument @var{no} disables floating point operations on the
14914 general purpose registers.
14915
14916 This option is currently only available on the MPC854x.
14917
14918 @item -m32
14919 @itemx -m64
14920 @opindex m32
14921 @opindex m64
14922 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
14923 targets (including GNU/Linux).  The 32-bit environment sets int, long
14924 and pointer to 32 bits and generates code that runs on any PowerPC
14925 variant.  The 64-bit environment sets int to 32 bits and long and
14926 pointer to 64 bits, and generates code for PowerPC64, as for
14927 @option{-mpowerpc64}.
14928
14929 @item -mfull-toc
14930 @itemx -mno-fp-in-toc
14931 @itemx -mno-sum-in-toc
14932 @itemx -mminimal-toc
14933 @opindex mfull-toc
14934 @opindex mno-fp-in-toc
14935 @opindex mno-sum-in-toc
14936 @opindex mminimal-toc
14937 Modify generation of the TOC (Table Of Contents), which is created for
14938 every executable file.  The @option{-mfull-toc} option is selected by
14939 default.  In that case, GCC will allocate at least one TOC entry for
14940 each unique non-automatic variable reference in your program.  GCC
14941 will also place floating-point constants in the TOC@.  However, only
14942 16,384 entries are available in the TOC@.
14943
14944 If you receive a linker error message that saying you have overflowed
14945 the available TOC space, you can reduce the amount of TOC space used
14946 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
14947 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
14948 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
14949 generate code to calculate the sum of an address and a constant at
14950 run-time instead of putting that sum into the TOC@.  You may specify one
14951 or both of these options.  Each causes GCC to produce very slightly
14952 slower and larger code at the expense of conserving TOC space.
14953
14954 If you still run out of space in the TOC even when you specify both of
14955 these options, specify @option{-mminimal-toc} instead.  This option causes
14956 GCC to make only one TOC entry for every file.  When you specify this
14957 option, GCC will produce code that is slower and larger but which
14958 uses extremely little TOC space.  You may wish to use this option
14959 only on files that contain less frequently executed code.
14960
14961 @item -maix64
14962 @itemx -maix32
14963 @opindex maix64
14964 @opindex maix32
14965 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
14966 @code{long} type, and the infrastructure needed to support them.
14967 Specifying @option{-maix64} implies @option{-mpowerpc64} and
14968 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
14969 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
14970
14971 @item -mxl-compat
14972 @itemx -mno-xl-compat
14973 @opindex mxl-compat
14974 @opindex mno-xl-compat
14975 Produce code that conforms more closely to IBM XL compiler semantics
14976 when using AIX-compatible ABI@.  Pass floating-point arguments to
14977 prototyped functions beyond the register save area (RSA) on the stack
14978 in addition to argument FPRs.  Do not assume that most significant
14979 double in 128-bit long double value is properly rounded when comparing
14980 values and converting to double.  Use XL symbol names for long double
14981 support routines.
14982
14983 The AIX calling convention was extended but not initially documented to
14984 handle an obscure K&R C case of calling a function that takes the
14985 address of its arguments with fewer arguments than declared.  IBM XL
14986 compilers access floating point arguments which do not fit in the
14987 RSA from the stack when a subroutine is compiled without
14988 optimization.  Because always storing floating-point arguments on the
14989 stack is inefficient and rarely needed, this option is not enabled by
14990 default and only is necessary when calling subroutines compiled by IBM
14991 XL compilers without optimization.
14992
14993 @item -mpe
14994 @opindex mpe
14995 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
14996 application written to use message passing with special startup code to
14997 enable the application to run.  The system must have PE installed in the
14998 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
14999 must be overridden with the @option{-specs=} option to specify the
15000 appropriate directory location.  The Parallel Environment does not
15001 support threads, so the @option{-mpe} option and the @option{-pthread}
15002 option are incompatible.
15003
15004 @item -malign-natural
15005 @itemx -malign-power
15006 @opindex malign-natural
15007 @opindex malign-power
15008 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
15009 @option{-malign-natural} overrides the ABI-defined alignment of larger
15010 types, such as floating-point doubles, on their natural size-based boundary.
15011 The option @option{-malign-power} instructs GCC to follow the ABI-specified
15012 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
15013
15014 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
15015 is not supported.
15016
15017 @item -msoft-float
15018 @itemx -mhard-float
15019 @opindex msoft-float
15020 @opindex mhard-float
15021 Generate code that does not use (uses) the floating-point register set.
15022 Software floating point emulation is provided if you use the
15023 @option{-msoft-float} option, and pass the option to GCC when linking.
15024
15025 @item -msingle-float
15026 @itemx -mdouble-float
15027 @opindex msingle-float
15028 @opindex mdouble-float
15029 Generate code for single or double-precision floating point operations.
15030 @option{-mdouble-float} implies @option{-msingle-float}.
15031
15032 @item -msimple-fpu
15033 @opindex msimple-fpu
15034 Do not generate sqrt and div instructions for hardware floating point unit.
15035
15036 @item -mfpu
15037 @opindex mfpu
15038 Specify type of floating point unit.  Valid values are @var{sp_lite}
15039 (equivalent to -msingle-float -msimple-fpu), @var{dp_lite} (equivalent
15040 to -mdouble-float -msimple-fpu), @var{sp_full} (equivalent to -msingle-float),
15041 and @var{dp_full} (equivalent to -mdouble-float).
15042
15043 @item -mxilinx-fpu
15044 @opindex mxilinx-fpu
15045 Perform optimizations for floating point unit on Xilinx PPC 405/440.
15046
15047 @item -mmultiple
15048 @itemx -mno-multiple
15049 @opindex mmultiple
15050 @opindex mno-multiple
15051 Generate code that uses (does not use) the load multiple word
15052 instructions and the store multiple word instructions.  These
15053 instructions are generated by default on POWER systems, and not
15054 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
15055 endian PowerPC systems, since those instructions do not work when the
15056 processor is in little endian mode.  The exceptions are PPC740 and
15057 PPC750 which permit the instructions usage in little endian mode.
15058
15059 @item -mstring
15060 @itemx -mno-string
15061 @opindex mstring
15062 @opindex mno-string
15063 Generate code that uses (does not use) the load string instructions
15064 and the store string word instructions to save multiple registers and
15065 do small block moves.  These instructions are generated by default on
15066 POWER systems, and not generated on PowerPC systems.  Do not use
15067 @option{-mstring} on little endian PowerPC systems, since those
15068 instructions do not work when the processor is in little endian mode.
15069 The exceptions are PPC740 and PPC750 which permit the instructions
15070 usage in little endian mode.
15071
15072 @item -mupdate
15073 @itemx -mno-update
15074 @opindex mupdate
15075 @opindex mno-update
15076 Generate code that uses (does not use) the load or store instructions
15077 that update the base register to the address of the calculated memory
15078 location.  These instructions are generated by default.  If you use
15079 @option{-mno-update}, there is a small window between the time that the
15080 stack pointer is updated and the address of the previous frame is
15081 stored, which means code that walks the stack frame across interrupts or
15082 signals may get corrupted data.
15083
15084 @item -mavoid-indexed-addresses
15085 @itemx -mno-avoid-indexed-addresses
15086 @opindex mavoid-indexed-addresses
15087 @opindex mno-avoid-indexed-addresses
15088 Generate code that tries to avoid (not avoid) the use of indexed load
15089 or store instructions. These instructions can incur a performance
15090 penalty on Power6 processors in certain situations, such as when
15091 stepping through large arrays that cross a 16M boundary.  This option
15092 is enabled by default when targetting Power6 and disabled otherwise.
15093
15094 @item -mfused-madd
15095 @itemx -mno-fused-madd
15096 @opindex mfused-madd
15097 @opindex mno-fused-madd
15098 Generate code that uses (does not use) the floating point multiply and
15099 accumulate instructions.  These instructions are generated by default if
15100 hardware floating is used.
15101
15102 @item -mmulhw
15103 @itemx -mno-mulhw
15104 @opindex mmulhw
15105 @opindex mno-mulhw
15106 Generate code that uses (does not use) the half-word multiply and
15107 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
15108 These instructions are generated by default when targetting those
15109 processors.
15110
15111 @item -mdlmzb
15112 @itemx -mno-dlmzb
15113 @opindex mdlmzb
15114 @opindex mno-dlmzb
15115 Generate code that uses (does not use) the string-search @samp{dlmzb}
15116 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
15117 generated by default when targetting those processors.
15118
15119 @item -mno-bit-align
15120 @itemx -mbit-align
15121 @opindex mno-bit-align
15122 @opindex mbit-align
15123 On System V.4 and embedded PowerPC systems do not (do) force structures
15124 and unions that contain bit-fields to be aligned to the base type of the
15125 bit-field.
15126
15127 For example, by default a structure containing nothing but 8
15128 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
15129 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
15130 the structure would be aligned to a 1 byte boundary and be one byte in
15131 size.
15132
15133 @item -mno-strict-align
15134 @itemx -mstrict-align
15135 @opindex mno-strict-align
15136 @opindex mstrict-align
15137 On System V.4 and embedded PowerPC systems do not (do) assume that
15138 unaligned memory references will be handled by the system.
15139
15140 @item -mrelocatable
15141 @itemx -mno-relocatable
15142 @opindex mrelocatable
15143 @opindex mno-relocatable
15144 On embedded PowerPC systems generate code that allows (does not allow)
15145 the program to be relocated to a different address at runtime.  If you
15146 use @option{-mrelocatable} on any module, all objects linked together must
15147 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
15148
15149 @item -mrelocatable-lib
15150 @itemx -mno-relocatable-lib
15151 @opindex mrelocatable-lib
15152 @opindex mno-relocatable-lib
15153 On embedded PowerPC systems generate code that allows (does not allow)
15154 the program to be relocated to a different address at runtime.  Modules
15155 compiled with @option{-mrelocatable-lib} can be linked with either modules
15156 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
15157 with modules compiled with the @option{-mrelocatable} options.
15158
15159 @item -mno-toc
15160 @itemx -mtoc
15161 @opindex mno-toc
15162 @opindex mtoc
15163 On System V.4 and embedded PowerPC systems do not (do) assume that
15164 register 2 contains a pointer to a global area pointing to the addresses
15165 used in the program.
15166
15167 @item -mlittle
15168 @itemx -mlittle-endian
15169 @opindex mlittle
15170 @opindex mlittle-endian
15171 On System V.4 and embedded PowerPC systems compile code for the
15172 processor in little endian mode.  The @option{-mlittle-endian} option is
15173 the same as @option{-mlittle}.
15174
15175 @item -mbig
15176 @itemx -mbig-endian
15177 @opindex mbig
15178 @opindex mbig-endian
15179 On System V.4 and embedded PowerPC systems compile code for the
15180 processor in big endian mode.  The @option{-mbig-endian} option is
15181 the same as @option{-mbig}.
15182
15183 @item -mdynamic-no-pic
15184 @opindex mdynamic-no-pic
15185 On Darwin and Mac OS X systems, compile code so that it is not
15186 relocatable, but that its external references are relocatable.  The
15187 resulting code is suitable for applications, but not shared
15188 libraries.
15189
15190 @item -mprioritize-restricted-insns=@var{priority}
15191 @opindex mprioritize-restricted-insns
15192 This option controls the priority that is assigned to
15193 dispatch-slot restricted instructions during the second scheduling
15194 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
15195 @var{no/highest/second-highest} priority to dispatch slot restricted
15196 instructions.
15197
15198 @item -msched-costly-dep=@var{dependence_type}
15199 @opindex msched-costly-dep
15200 This option controls which dependences are considered costly
15201 by the target during instruction scheduling.  The argument
15202 @var{dependence_type} takes one of the following values:
15203 @var{no}: no dependence is costly,
15204 @var{all}: all dependences are costly,
15205 @var{true_store_to_load}: a true dependence from store to load is costly,
15206 @var{store_to_load}: any dependence from store to load is costly,
15207 @var{number}: any dependence which latency >= @var{number} is costly.
15208
15209 @item -minsert-sched-nops=@var{scheme}
15210 @opindex minsert-sched-nops
15211 This option controls which nop insertion scheme will be used during
15212 the second scheduling pass.  The argument @var{scheme} takes one of the
15213 following values:
15214 @var{no}: Don't insert nops.
15215 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
15216 according to the scheduler's grouping.
15217 @var{regroup_exact}: Insert nops to force costly dependent insns into
15218 separate groups.  Insert exactly as many nops as needed to force an insn
15219 to a new group, according to the estimated processor grouping.
15220 @var{number}: Insert nops to force costly dependent insns into
15221 separate groups.  Insert @var{number} nops to force an insn to a new group.
15222
15223 @item -mcall-sysv
15224 @opindex mcall-sysv
15225 On System V.4 and embedded PowerPC systems compile code using calling
15226 conventions that adheres to the March 1995 draft of the System V
15227 Application Binary Interface, PowerPC processor supplement.  This is the
15228 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
15229
15230 @item -mcall-sysv-eabi
15231 @itemx -mcall-eabi
15232 @opindex mcall-sysv-eabi
15233 @opindex mcall-eabi
15234 Specify both @option{-mcall-sysv} and @option{-meabi} options.
15235
15236 @item -mcall-sysv-noeabi
15237 @opindex mcall-sysv-noeabi
15238 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
15239
15240 @item -mcall-aixdesc
15241 @opindex m
15242 On System V.4 and embedded PowerPC systems compile code for the AIX
15243 operating system.
15244
15245 @item -mcall-linux
15246 @opindex mcall-linux
15247 On System V.4 and embedded PowerPC systems compile code for the
15248 Linux-based GNU system.
15249
15250 @item -mcall-gnu
15251 @opindex mcall-gnu
15252 On System V.4 and embedded PowerPC systems compile code for the
15253 Hurd-based GNU system.
15254
15255 @item -mcall-freebsd
15256 @opindex mcall-freebsd
15257 On System V.4 and embedded PowerPC systems compile code for the
15258 FreeBSD operating system.
15259
15260 @item -mcall-netbsd
15261 @opindex mcall-netbsd
15262 On System V.4 and embedded PowerPC systems compile code for the
15263 NetBSD operating system.
15264
15265 @item -mcall-openbsd
15266 @opindex mcall-netbsd
15267 On System V.4 and embedded PowerPC systems compile code for the
15268 OpenBSD operating system.
15269
15270 @item -maix-struct-return
15271 @opindex maix-struct-return
15272 Return all structures in memory (as specified by the AIX ABI)@.
15273
15274 @item -msvr4-struct-return
15275 @opindex msvr4-struct-return
15276 Return structures smaller than 8 bytes in registers (as specified by the
15277 SVR4 ABI)@.
15278
15279 @item -mabi=@var{abi-type}
15280 @opindex mabi
15281 Extend the current ABI with a particular extension, or remove such extension.
15282 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
15283 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
15284
15285 @item -mabi=spe
15286 @opindex mabi=spe
15287 Extend the current ABI with SPE ABI extensions.  This does not change
15288 the default ABI, instead it adds the SPE ABI extensions to the current
15289 ABI@.
15290
15291 @item -mabi=no-spe
15292 @opindex mabi=no-spe
15293 Disable Booke SPE ABI extensions for the current ABI@.
15294
15295 @item -mabi=ibmlongdouble
15296 @opindex mabi=ibmlongdouble
15297 Change the current ABI to use IBM extended precision long double.
15298 This is a PowerPC 32-bit SYSV ABI option.
15299
15300 @item -mabi=ieeelongdouble
15301 @opindex mabi=ieeelongdouble
15302 Change the current ABI to use IEEE extended precision long double.
15303 This is a PowerPC 32-bit Linux ABI option.
15304
15305 @item -mprototype
15306 @itemx -mno-prototype
15307 @opindex mprototype
15308 @opindex mno-prototype
15309 On System V.4 and embedded PowerPC systems assume that all calls to
15310 variable argument functions are properly prototyped.  Otherwise, the
15311 compiler must insert an instruction before every non prototyped call to
15312 set or clear bit 6 of the condition code register (@var{CR}) to
15313 indicate whether floating point values were passed in the floating point
15314 registers in case the function takes a variable arguments.  With
15315 @option{-mprototype}, only calls to prototyped variable argument functions
15316 will set or clear the bit.
15317
15318 @item -msim
15319 @opindex msim
15320 On embedded PowerPC systems, assume that the startup module is called
15321 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
15322 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
15323 configurations.
15324
15325 @item -mmvme
15326 @opindex mmvme
15327 On embedded PowerPC systems, assume that the startup module is called
15328 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
15329 @file{libc.a}.
15330
15331 @item -mads
15332 @opindex mads
15333 On embedded PowerPC systems, assume that the startup module is called
15334 @file{crt0.o} and the standard C libraries are @file{libads.a} and
15335 @file{libc.a}.
15336
15337 @item -myellowknife
15338 @opindex myellowknife
15339 On embedded PowerPC systems, assume that the startup module is called
15340 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
15341 @file{libc.a}.
15342
15343 @item -mvxworks
15344 @opindex mvxworks
15345 On System V.4 and embedded PowerPC systems, specify that you are
15346 compiling for a VxWorks system.
15347
15348 @item -memb
15349 @opindex memb
15350 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
15351 header to indicate that @samp{eabi} extended relocations are used.
15352
15353 @item -meabi
15354 @itemx -mno-eabi
15355 @opindex meabi
15356 @opindex mno-eabi
15357 On System V.4 and embedded PowerPC systems do (do not) adhere to the
15358 Embedded Applications Binary Interface (eabi) which is a set of
15359 modifications to the System V.4 specifications.  Selecting @option{-meabi}
15360 means that the stack is aligned to an 8 byte boundary, a function
15361 @code{__eabi} is called to from @code{main} to set up the eabi
15362 environment, and the @option{-msdata} option can use both @code{r2} and
15363 @code{r13} to point to two separate small data areas.  Selecting
15364 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
15365 do not call an initialization function from @code{main}, and the
15366 @option{-msdata} option will only use @code{r13} to point to a single
15367 small data area.  The @option{-meabi} option is on by default if you
15368 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
15369
15370 @item -msdata=eabi
15371 @opindex msdata=eabi
15372 On System V.4 and embedded PowerPC systems, put small initialized
15373 @code{const} global and static data in the @samp{.sdata2} section, which
15374 is pointed to by register @code{r2}.  Put small initialized
15375 non-@code{const} global and static data in the @samp{.sdata} section,
15376 which is pointed to by register @code{r13}.  Put small uninitialized
15377 global and static data in the @samp{.sbss} section, which is adjacent to
15378 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
15379 incompatible with the @option{-mrelocatable} option.  The
15380 @option{-msdata=eabi} option also sets the @option{-memb} option.
15381
15382 @item -msdata=sysv
15383 @opindex msdata=sysv
15384 On System V.4 and embedded PowerPC systems, put small global and static
15385 data in the @samp{.sdata} section, which is pointed to by register
15386 @code{r13}.  Put small uninitialized global and static data in the
15387 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
15388 The @option{-msdata=sysv} option is incompatible with the
15389 @option{-mrelocatable} option.
15390
15391 @item -msdata=default
15392 @itemx -msdata
15393 @opindex msdata=default
15394 @opindex msdata
15395 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
15396 compile code the same as @option{-msdata=eabi}, otherwise compile code the
15397 same as @option{-msdata=sysv}.
15398
15399 @item -msdata=data
15400 @opindex msdata=data
15401 On System V.4 and embedded PowerPC systems, put small global
15402 data in the @samp{.sdata} section.  Put small uninitialized global
15403 data in the @samp{.sbss} section.  Do not use register @code{r13}
15404 to address small data however.  This is the default behavior unless
15405 other @option{-msdata} options are used.
15406
15407 @item -msdata=none
15408 @itemx -mno-sdata
15409 @opindex msdata=none
15410 @opindex mno-sdata
15411 On embedded PowerPC systems, put all initialized global and static data
15412 in the @samp{.data} section, and all uninitialized data in the
15413 @samp{.bss} section.
15414
15415 @item -G @var{num}
15416 @opindex G
15417 @cindex smaller data references (PowerPC)
15418 @cindex .sdata/.sdata2 references (PowerPC)
15419 On embedded PowerPC systems, put global and static items less than or
15420 equal to @var{num} bytes into the small data or bss sections instead of
15421 the normal data or bss section.  By default, @var{num} is 8.  The
15422 @option{-G @var{num}} switch is also passed to the linker.
15423 All modules should be compiled with the same @option{-G @var{num}} value.
15424
15425 @item -mregnames
15426 @itemx -mno-regnames
15427 @opindex mregnames
15428 @opindex mno-regnames
15429 On System V.4 and embedded PowerPC systems do (do not) emit register
15430 names in the assembly language output using symbolic forms.
15431
15432 @item -mlongcall
15433 @itemx -mno-longcall
15434 @opindex mlongcall
15435 @opindex mno-longcall
15436 By default assume that all calls are far away so that a longer more
15437 expensive calling sequence is required.  This is required for calls
15438 further than 32 megabytes (33,554,432 bytes) from the current location.
15439 A short call will be generated if the compiler knows
15440 the call cannot be that far away.  This setting can be overridden by
15441 the @code{shortcall} function attribute, or by @code{#pragma
15442 longcall(0)}.
15443
15444 Some linkers are capable of detecting out-of-range calls and generating
15445 glue code on the fly.  On these systems, long calls are unnecessary and
15446 generate slower code.  As of this writing, the AIX linker can do this,
15447 as can the GNU linker for PowerPC/64.  It is planned to add this feature
15448 to the GNU linker for 32-bit PowerPC systems as well.
15449
15450 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
15451 callee, L42'', plus a ``branch island'' (glue code).  The two target
15452 addresses represent the callee and the ``branch island''.  The
15453 Darwin/PPC linker will prefer the first address and generate a ``bl
15454 callee'' if the PPC ``bl'' instruction will reach the callee directly;
15455 otherwise, the linker will generate ``bl L42'' to call the ``branch
15456 island''.  The ``branch island'' is appended to the body of the
15457 calling function; it computes the full 32-bit address of the callee
15458 and jumps to it.
15459
15460 On Mach-O (Darwin) systems, this option directs the compiler emit to
15461 the glue for every direct call, and the Darwin linker decides whether
15462 to use or discard it.
15463
15464 In the future, we may cause GCC to ignore all longcall specifications
15465 when the linker is known to generate glue.
15466
15467 @item -mtls-markers
15468 @itemx -mno-tls-markers
15469 @opindex mtls-markers
15470 @opindex mno-tls-markers
15471 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
15472 specifying the function argument.  The relocation allows ld to
15473 reliably associate function call with argument setup instructions for
15474 TLS optimization, which in turn allows gcc to better schedule the
15475 sequence.
15476
15477 @item -pthread
15478 @opindex pthread
15479 Adds support for multithreading with the @dfn{pthreads} library.
15480 This option sets flags for both the preprocessor and linker.
15481
15482 @end table
15483
15484 @node RX Options
15485 @subsection RX Options
15486 @cindex RX Options
15487
15488 These command line options are defined for RX targets:
15489
15490 @table @gcctabopt
15491 @item -m64bit-doubles
15492 @itemx -m32bit-doubles
15493 @opindex m64bit-doubles
15494 @opindex m32bit-doubles
15495 Make the @code{double} data type be 64-bits (@option{-m64bit-doubles})
15496 or 32-bits (@option{-m32bit-doubles}) in size.  The default is
15497 @option{-m32bit-doubles}.  @emph{Note} RX floating point hardware only
15498 works on 32-bit values, which is why the default is
15499 @option{-m32bit-doubles}.
15500
15501 @item -fpu
15502 @itemx -nofpu
15503 @opindex fpu
15504 @opindex nofpu
15505 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
15506 floating point hardware.  The default is enabled for the @var{RX600}
15507 series and disabled for the @var{RX200} series.
15508
15509 Floating point instructions will only be generated for 32-bit floating
15510 point values however, so if the @option{-m64bit-doubles} option is in
15511 use then the FPU hardware will not be used for doubles.
15512
15513 @emph{Note} If the @option{-fpu} option is enabled then
15514 @option{-funsafe-math-optimizations} is also enabled automatically.
15515 This is because the RX FPU instructions are themselves unsafe.
15516
15517 @item -mcpu=@var{name}
15518 @itemx -patch=@var{name}
15519 @opindex -mcpu
15520 @opindex -patch
15521 Selects the type of RX CPU to be targeted.  Currently three types are
15522 supported, the generic @var{RX600} and @var{RX200} series hardware and
15523 the specific @var{RX610} cpu.  The default is @var{RX600}.
15524
15525 The only difference between @var{RX600} and @var{RX610} is that the
15526 @var{RX610} does not support the @code{MVTIPL} instruction.
15527
15528 The @var{RX200} series does not have a hardware floating point unit
15529 and so @option{-nofpu} is enabled by default when this type is
15530 selected.
15531
15532 @item -mbig-endian-data
15533 @itemx -mlittle-endian-data
15534 @opindex mbig-endian-data
15535 @opindex mlittle-endian-data
15536 Store data (but not code) in the big-endian format.  The default is
15537 @option{-mlittle-endian-data}, ie to store data in the little endian
15538 format.
15539
15540 @item -msmall-data-limit=@var{N}
15541 @opindex msmall-data-limit
15542 Specifies the maximum size in bytes of global and static variables
15543 which can be placed into the small data area.  Using the small data
15544 area can lead to smaller and faster code, but the size of area is
15545 limited and it is up to the programmer to ensure that the area does
15546 not overflow.  Also when the small data area is used one of the RX's
15547 registers (@code{r13}) is reserved for use pointing to this area, so
15548 it is no longer available for use by the compiler.  This could result
15549 in slower and/or larger code if variables which once could have been
15550 held in @code{r13} are now pushed onto the stack.
15551
15552 Note, common variables (variables which have not been initialised) and
15553 constants are not placed into the small data area as they are assigned
15554 to other sections in the output executable.
15555
15556 The default value is zero, which disables this feature.  Note, this
15557 feature is not enabled by default with higher optimization levels
15558 (@option{-O2} etc) because of the potentially detrimental effects of
15559 reserving register @code{r13}.  It is up to the programmer to
15560 experiment and discover whether this feature is of benefit to their
15561 program.
15562
15563 @item -msim
15564 @itemx -mno-sim
15565 @opindex msim
15566 @opindex mno-sim
15567 Use the simulator runtime.  The default is to use the libgloss board
15568 specific runtime.
15569
15570 @item -mas100-syntax
15571 @itemx -mno-as100-syntax
15572 @opindex mas100-syntax
15573 @opindex mno-as100-syntax
15574 When generating assembler output use a syntax that is compatible with
15575 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
15576 assembler but it has some restrictions so generating it is not the
15577 default option.
15578
15579 @item -mmax-constant-size=@var{N}
15580 @opindex mmax-constant-size
15581 Specifies the maxium size, in bytes, of a constant that can be used as
15582 an operand in a RX instruction.  Although the RX instruction set does
15583 allow constants of up to 4 bytes in length to be used in instructions,
15584 a longer value equates to a longer instruction.  Thus in some
15585 circumstances it can be beneficial to restrict the size of constants
15586 that are used in instructions.  Constants that are too big are instead
15587 placed into a constant pool and referenced via register indirection.
15588
15589 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
15590 or 4 means that constants of any size are allowed.
15591
15592 @item -mrelax
15593 @opindex mrelax
15594 Enable linker relaxation.  Linker relaxation is a process whereby the
15595 linker will attempt to reduce the size of a program by finding shorter
15596 versions of various instructions.  Disabled by default.
15597
15598 @item -mint-register=@var{N}
15599 @opindex mint-register
15600 Specify the number of registers to reserve for fast interrupt handler
15601 functions.  The value @var{N} can be between 0 and 4.  A value of 1
15602 means that register @code{r13} will be reserved for ther exclusive use
15603 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
15604 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
15605 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
15606 A value of 0, the default, does not reserve any registers.
15607
15608 @item -msave-acc-in-interrupts
15609 @opindex msave-acc-in-interrupts
15610 Specifies that interrupt handler functions should preserve the
15611 accumulator register.  This is only necessary if normal code might use
15612 the accumulator register, for example because it performs 64-bit
15613 multiplications.  The default is to ignore the accumulator as this
15614 makes the interrupt handlers faster.
15615
15616 @end table
15617
15618 @emph{Note:} The generic GCC command line @option{-ffixed-@var{reg}}
15619 has special significance to the RX port when used with the
15620 @code{interrupt} function attribute.  This attribute indicates a
15621 function intended to process fast interrupts.  GCC will will ensure
15622 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
15623 and/or @code{r13} and only provided that the normal use of the
15624 corresponding registers have been restricted via the
15625 @option{-ffixed-@var{reg}} or @option{-mint-register} command line
15626 options.
15627
15628 @node S/390 and zSeries Options
15629 @subsection S/390 and zSeries Options
15630 @cindex S/390 and zSeries Options
15631
15632 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
15633
15634 @table @gcctabopt
15635 @item -mhard-float
15636 @itemx -msoft-float
15637 @opindex mhard-float
15638 @opindex msoft-float
15639 Use (do not use) the hardware floating-point instructions and registers
15640 for floating-point operations.  When @option{-msoft-float} is specified,
15641 functions in @file{libgcc.a} will be used to perform floating-point
15642 operations.  When @option{-mhard-float} is specified, the compiler
15643 generates IEEE floating-point instructions.  This is the default.
15644
15645 @item -mhard-dfp
15646 @itemx -mno-hard-dfp
15647 @opindex mhard-dfp
15648 @opindex mno-hard-dfp
15649 Use (do not use) the hardware decimal-floating-point instructions for
15650 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
15651 specified, functions in @file{libgcc.a} will be used to perform
15652 decimal-floating-point operations.  When @option{-mhard-dfp} is
15653 specified, the compiler generates decimal-floating-point hardware
15654 instructions.  This is the default for @option{-march=z9-ec} or higher.
15655
15656 @item -mlong-double-64
15657 @itemx -mlong-double-128
15658 @opindex mlong-double-64
15659 @opindex mlong-double-128
15660 These switches control the size of @code{long double} type. A size
15661 of 64bit makes the @code{long double} type equivalent to the @code{double}
15662 type. This is the default.
15663
15664 @item -mbackchain
15665 @itemx -mno-backchain
15666 @opindex mbackchain
15667 @opindex mno-backchain
15668 Store (do not store) the address of the caller's frame as backchain pointer
15669 into the callee's stack frame.
15670 A backchain may be needed to allow debugging using tools that do not understand
15671 DWARF-2 call frame information.
15672 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
15673 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
15674 the backchain is placed into the topmost word of the 96/160 byte register
15675 save area.
15676
15677 In general, code compiled with @option{-mbackchain} is call-compatible with
15678 code compiled with @option{-mmo-backchain}; however, use of the backchain
15679 for debugging purposes usually requires that the whole binary is built with
15680 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
15681 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15682 to build a linux kernel use @option{-msoft-float}.
15683
15684 The default is to not maintain the backchain.
15685
15686 @item -mpacked-stack
15687 @itemx -mno-packed-stack
15688 @opindex mpacked-stack
15689 @opindex mno-packed-stack
15690 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
15691 specified, the compiler uses the all fields of the 96/160 byte register save
15692 area only for their default purpose; unused fields still take up stack space.
15693 When @option{-mpacked-stack} is specified, register save slots are densely
15694 packed at the top of the register save area; unused space is reused for other
15695 purposes, allowing for more efficient use of the available stack space.
15696 However, when @option{-mbackchain} is also in effect, the topmost word of
15697 the save area is always used to store the backchain, and the return address
15698 register is always saved two words below the backchain.
15699
15700 As long as the stack frame backchain is not used, code generated with
15701 @option{-mpacked-stack} is call-compatible with code generated with
15702 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
15703 S/390 or zSeries generated code that uses the stack frame backchain at run
15704 time, not just for debugging purposes.  Such code is not call-compatible
15705 with code compiled with @option{-mpacked-stack}.  Also, note that the
15706 combination of @option{-mbackchain},
15707 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
15708 to build a linux kernel use @option{-msoft-float}.
15709
15710 The default is to not use the packed stack layout.
15711
15712 @item -msmall-exec
15713 @itemx -mno-small-exec
15714 @opindex msmall-exec
15715 @opindex mno-small-exec
15716 Generate (or do not generate) code using the @code{bras} instruction
15717 to do subroutine calls.
15718 This only works reliably if the total executable size does not
15719 exceed 64k.  The default is to use the @code{basr} instruction instead,
15720 which does not have this limitation.
15721
15722 @item -m64
15723 @itemx -m31
15724 @opindex m64
15725 @opindex m31
15726 When @option{-m31} is specified, generate code compliant to the
15727 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
15728 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
15729 particular to generate 64-bit instructions.  For the @samp{s390}
15730 targets, the default is @option{-m31}, while the @samp{s390x}
15731 targets default to @option{-m64}.
15732
15733 @item -mzarch
15734 @itemx -mesa
15735 @opindex mzarch
15736 @opindex mesa
15737 When @option{-mzarch} is specified, generate code using the
15738 instructions available on z/Architecture.
15739 When @option{-mesa} is specified, generate code using the
15740 instructions available on ESA/390.  Note that @option{-mesa} is
15741 not possible with @option{-m64}.
15742 When generating code compliant to the GNU/Linux for S/390 ABI,
15743 the default is @option{-mesa}.  When generating code compliant
15744 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
15745
15746 @item -mmvcle
15747 @itemx -mno-mvcle
15748 @opindex mmvcle
15749 @opindex mno-mvcle
15750 Generate (or do not generate) code using the @code{mvcle} instruction
15751 to perform block moves.  When @option{-mno-mvcle} is specified,
15752 use a @code{mvc} loop instead.  This is the default unless optimizing for
15753 size.
15754
15755 @item -mdebug
15756 @itemx -mno-debug
15757 @opindex mdebug
15758 @opindex mno-debug
15759 Print (or do not print) additional debug information when compiling.
15760 The default is to not print debug information.
15761
15762 @item -march=@var{cpu-type}
15763 @opindex march
15764 Generate code that will run on @var{cpu-type}, which is the name of a system
15765 representing a certain processor type.  Possible values for
15766 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
15767 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
15768 When generating code using the instructions available on z/Architecture,
15769 the default is @option{-march=z900}.  Otherwise, the default is
15770 @option{-march=g5}.
15771
15772 @item -mtune=@var{cpu-type}
15773 @opindex mtune
15774 Tune to @var{cpu-type} everything applicable about the generated code,
15775 except for the ABI and the set of available instructions.
15776 The list of @var{cpu-type} values is the same as for @option{-march}.
15777 The default is the value used for @option{-march}.
15778
15779 @item -mtpf-trace
15780 @itemx -mno-tpf-trace
15781 @opindex mtpf-trace
15782 @opindex mno-tpf-trace
15783 Generate code that adds (does not add) in TPF OS specific branches to trace
15784 routines in the operating system.  This option is off by default, even
15785 when compiling for the TPF OS@.
15786
15787 @item -mfused-madd
15788 @itemx -mno-fused-madd
15789 @opindex mfused-madd
15790 @opindex mno-fused-madd
15791 Generate code that uses (does not use) the floating point multiply and
15792 accumulate instructions.  These instructions are generated by default if
15793 hardware floating point is used.
15794
15795 @item -mwarn-framesize=@var{framesize}
15796 @opindex mwarn-framesize
15797 Emit a warning if the current function exceeds the given frame size.  Because
15798 this is a compile time check it doesn't need to be a real problem when the program
15799 runs.  It is intended to identify functions which most probably cause
15800 a stack overflow.  It is useful to be used in an environment with limited stack
15801 size e.g.@: the linux kernel.
15802
15803 @item -mwarn-dynamicstack
15804 @opindex mwarn-dynamicstack
15805 Emit a warning if the function calls alloca or uses dynamically
15806 sized arrays.  This is generally a bad idea with a limited stack size.
15807
15808 @item -mstack-guard=@var{stack-guard}
15809 @itemx -mstack-size=@var{stack-size}
15810 @opindex mstack-guard
15811 @opindex mstack-size
15812 If these options are provided the s390 back end emits additional instructions in
15813 the function prologue which trigger a trap if the stack size is @var{stack-guard}
15814 bytes above the @var{stack-size} (remember that the stack on s390 grows downward).
15815 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
15816 the frame size of the compiled function is chosen.
15817 These options are intended to be used to help debugging stack overflow problems.
15818 The additionally emitted code causes only little overhead and hence can also be
15819 used in production like systems without greater performance degradation.  The given
15820 values have to be exact powers of 2 and @var{stack-size} has to be greater than
15821 @var{stack-guard} without exceeding 64k.
15822 In order to be efficient the extra code makes the assumption that the stack starts
15823 at an address aligned to the value given by @var{stack-size}.
15824 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
15825 @end table
15826
15827 @node Score Options
15828 @subsection Score Options
15829 @cindex Score Options
15830
15831 These options are defined for Score implementations:
15832
15833 @table @gcctabopt
15834 @item -meb
15835 @opindex meb
15836 Compile code for big endian mode.  This is the default.
15837
15838 @item -mel
15839 @opindex mel
15840 Compile code for little endian mode.
15841
15842 @item -mnhwloop
15843 @opindex mnhwloop
15844 Disable generate bcnz instruction.
15845
15846 @item -muls
15847 @opindex muls
15848 Enable generate unaligned load and store instruction.
15849
15850 @item -mmac
15851 @opindex mmac
15852 Enable the use of multiply-accumulate instructions. Disabled by default.
15853
15854 @item -mscore5
15855 @opindex mscore5
15856 Specify the SCORE5 as the target architecture.
15857
15858 @item -mscore5u
15859 @opindex mscore5u
15860 Specify the SCORE5U of the target architecture.
15861
15862 @item -mscore7
15863 @opindex mscore7
15864 Specify the SCORE7 as the target architecture. This is the default.
15865
15866 @item -mscore7d
15867 @opindex mscore7d
15868 Specify the SCORE7D as the target architecture.
15869 @end table
15870
15871 @node SH Options
15872 @subsection SH Options
15873
15874 These @samp{-m} options are defined for the SH implementations:
15875
15876 @table @gcctabopt
15877 @item -m1
15878 @opindex m1
15879 Generate code for the SH1.
15880
15881 @item -m2
15882 @opindex m2
15883 Generate code for the SH2.
15884
15885 @item -m2e
15886 Generate code for the SH2e.
15887
15888 @item -m2a-nofpu
15889 @opindex m2a-nofpu
15890 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
15891 that the floating-point unit is not used.
15892
15893 @item -m2a-single-only
15894 @opindex m2a-single-only
15895 Generate code for the SH2a-FPU, in such a way that no double-precision
15896 floating point operations are used.
15897
15898 @item -m2a-single
15899 @opindex m2a-single
15900 Generate code for the SH2a-FPU assuming the floating-point unit is in
15901 single-precision mode by default.
15902
15903 @item -m2a
15904 @opindex m2a
15905 Generate code for the SH2a-FPU assuming the floating-point unit is in
15906 double-precision mode by default.
15907
15908 @item -m3
15909 @opindex m3
15910 Generate code for the SH3.
15911
15912 @item -m3e
15913 @opindex m3e
15914 Generate code for the SH3e.
15915
15916 @item -m4-nofpu
15917 @opindex m4-nofpu
15918 Generate code for the SH4 without a floating-point unit.
15919
15920 @item -m4-single-only
15921 @opindex m4-single-only
15922 Generate code for the SH4 with a floating-point unit that only
15923 supports single-precision arithmetic.
15924
15925 @item -m4-single
15926 @opindex m4-single
15927 Generate code for the SH4 assuming the floating-point unit is in
15928 single-precision mode by default.
15929
15930 @item -m4
15931 @opindex m4
15932 Generate code for the SH4.
15933
15934 @item -m4a-nofpu
15935 @opindex m4a-nofpu
15936 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
15937 floating-point unit is not used.
15938
15939 @item -m4a-single-only
15940 @opindex m4a-single-only
15941 Generate code for the SH4a, in such a way that no double-precision
15942 floating point operations are used.
15943
15944 @item -m4a-single
15945 @opindex m4a-single
15946 Generate code for the SH4a assuming the floating-point unit is in
15947 single-precision mode by default.
15948
15949 @item -m4a
15950 @opindex m4a
15951 Generate code for the SH4a.
15952
15953 @item -m4al
15954 @opindex m4al
15955 Same as @option{-m4a-nofpu}, except that it implicitly passes
15956 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
15957 instructions at the moment.
15958
15959 @item -mb
15960 @opindex mb
15961 Compile code for the processor in big endian mode.
15962
15963 @item -ml
15964 @opindex ml
15965 Compile code for the processor in little endian mode.
15966
15967 @item -mdalign
15968 @opindex mdalign
15969 Align doubles at 64-bit boundaries.  Note that this changes the calling
15970 conventions, and thus some functions from the standard C library will
15971 not work unless you recompile it first with @option{-mdalign}.
15972
15973 @item -mrelax
15974 @opindex mrelax
15975 Shorten some address references at link time, when possible; uses the
15976 linker option @option{-relax}.
15977
15978 @item -mbigtable
15979 @opindex mbigtable
15980 Use 32-bit offsets in @code{switch} tables.  The default is to use
15981 16-bit offsets.
15982
15983 @item -mbitops
15984 @opindex mbitops
15985 Enable the use of bit manipulation instructions on SH2A.
15986
15987 @item -mfmovd
15988 @opindex mfmovd
15989 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
15990 alignment constraints.
15991
15992 @item -mhitachi
15993 @opindex mhitachi
15994 Comply with the calling conventions defined by Renesas.
15995
15996 @item -mrenesas
15997 @opindex mhitachi
15998 Comply with the calling conventions defined by Renesas.
15999
16000 @item -mno-renesas
16001 @opindex mhitachi
16002 Comply with the calling conventions defined for GCC before the Renesas
16003 conventions were available.  This option is the default for all
16004 targets of the SH toolchain except for @samp{sh-symbianelf}.
16005
16006 @item -mnomacsave
16007 @opindex mnomacsave
16008 Mark the @code{MAC} register as call-clobbered, even if
16009 @option{-mhitachi} is given.
16010
16011 @item -mieee
16012 @opindex mieee
16013 Increase IEEE-compliance of floating-point code.
16014 At the moment, this is equivalent to @option{-fno-finite-math-only}.
16015 When generating 16 bit SH opcodes, getting IEEE-conforming results for
16016 comparisons of NANs / infinities incurs extra overhead in every
16017 floating point comparison, therefore the default is set to
16018 @option{-ffinite-math-only}.
16019
16020 @item -minline-ic_invalidate
16021 @opindex minline-ic_invalidate
16022 Inline code to invalidate instruction cache entries after setting up
16023 nested function trampolines.
16024 This option has no effect if -musermode is in effect and the selected
16025 code generation option (e.g. -m4) does not allow the use of the icbi
16026 instruction.
16027 If the selected code generation option does not allow the use of the icbi
16028 instruction, and -musermode is not in effect, the inlined code will
16029 manipulate the instruction cache address array directly with an associative
16030 write.  This not only requires privileged mode, but it will also
16031 fail if the cache line had been mapped via the TLB and has become unmapped.
16032
16033 @item -misize
16034 @opindex misize
16035 Dump instruction size and location in the assembly code.
16036
16037 @item -mpadstruct
16038 @opindex mpadstruct
16039 This option is deprecated.  It pads structures to multiple of 4 bytes,
16040 which is incompatible with the SH ABI@.
16041
16042 @item -mspace
16043 @opindex mspace
16044 Optimize for space instead of speed.  Implied by @option{-Os}.
16045
16046 @item -mprefergot
16047 @opindex mprefergot
16048 When generating position-independent code, emit function calls using
16049 the Global Offset Table instead of the Procedure Linkage Table.
16050
16051 @item -musermode
16052 @opindex musermode
16053 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
16054 if the inlined code would not work in user mode.
16055 This is the default when the target is @code{sh-*-linux*}.
16056
16057 @item -multcost=@var{number}
16058 @opindex multcost=@var{number}
16059 Set the cost to assume for a multiply insn.
16060
16061 @item -mdiv=@var{strategy}
16062 @opindex mdiv=@var{strategy}
16063 Set the division strategy to use for SHmedia code.  @var{strategy} must be
16064 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
16065 inv:call2, inv:fp .
16066 "fp" performs the operation in floating point.  This has a very high latency,
16067 but needs only a few instructions, so it might be a good choice if
16068 your code has enough easily exploitable ILP to allow the compiler to
16069 schedule the floating point instructions together with other instructions.
16070 Division by zero causes a floating point exception.
16071 "inv" uses integer operations to calculate the inverse of the divisor,
16072 and then multiplies the dividend with the inverse.  This strategy allows
16073 cse and hoisting of the inverse calculation.  Division by zero calculates
16074 an unspecified result, but does not trap.
16075 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
16076 have been found, or if the entire operation has been hoisted to the same
16077 place, the last stages of the inverse calculation are intertwined with the
16078 final multiply to reduce the overall latency, at the expense of using a few
16079 more instructions, and thus offering fewer scheduling opportunities with
16080 other code.
16081 "call" calls a library function that usually implements the inv:minlat
16082 strategy.
16083 This gives high code density for m5-*media-nofpu compilations.
16084 "call2" uses a different entry point of the same library function, where it
16085 assumes that a pointer to a lookup table has already been set up, which
16086 exposes the pointer load to cse / code hoisting optimizations.
16087 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
16088 code generation, but if the code stays unoptimized, revert to the "call",
16089 "call2", or "fp" strategies, respectively.  Note that the
16090 potentially-trapping side effect of division by zero is carried by a
16091 separate instruction, so it is possible that all the integer instructions
16092 are hoisted out, but the marker for the side effect stays where it is.
16093 A recombination to fp operations or a call is not possible in that case.
16094 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
16095 that the inverse calculation was nor separated from the multiply, they speed
16096 up division where the dividend fits into 20 bits (plus sign where applicable),
16097 by inserting a test to skip a number of operations in this case; this test
16098 slows down the case of larger dividends.  inv20u assumes the case of a such
16099 a small dividend to be unlikely, and inv20l assumes it to be likely.
16100
16101 @item -mdivsi3_libfunc=@var{name}
16102 @opindex mdivsi3_libfunc=@var{name}
16103 Set the name of the library function used for 32 bit signed division to
16104 @var{name}.  This only affect the name used in the call and inv:call
16105 division strategies, and the compiler will still expect the same
16106 sets of input/output/clobbered registers as if this option was not present.
16107
16108 @item -mfixed-range=@var{register-range}
16109 @opindex mfixed-range
16110 Generate code treating the given register range as fixed registers.
16111 A fixed register is one that the register allocator can not use.  This is
16112 useful when compiling kernel code.  A register range is specified as
16113 two registers separated by a dash.  Multiple register ranges can be
16114 specified separated by a comma.
16115
16116 @item -madjust-unroll
16117 @opindex madjust-unroll
16118 Throttle unrolling to avoid thrashing target registers.
16119 This option only has an effect if the gcc code base supports the
16120 TARGET_ADJUST_UNROLL_MAX target hook.
16121
16122 @item -mindexed-addressing
16123 @opindex mindexed-addressing
16124 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
16125 This is only safe if the hardware and/or OS implement 32 bit wrap-around
16126 semantics for the indexed addressing mode.  The architecture allows the
16127 implementation of processors with 64 bit MMU, which the OS could use to
16128 get 32 bit addressing, but since no current hardware implementation supports
16129 this or any other way to make the indexed addressing mode safe to use in
16130 the 32 bit ABI, the default is -mno-indexed-addressing.
16131
16132 @item -mgettrcost=@var{number}
16133 @opindex mgettrcost=@var{number}
16134 Set the cost assumed for the gettr instruction to @var{number}.
16135 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
16136
16137 @item -mpt-fixed
16138 @opindex mpt-fixed
16139 Assume pt* instructions won't trap.  This will generally generate better
16140 scheduled code, but is unsafe on current hardware.  The current architecture
16141 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
16142 This has the unintentional effect of making it unsafe to schedule ptabs /
16143 ptrel before a branch, or hoist it out of a loop.  For example,
16144 __do_global_ctors, a part of libgcc that runs constructors at program
16145 startup, calls functions in a list which is delimited by @minus{}1.  With the
16146 -mpt-fixed option, the ptabs will be done before testing against @minus{}1.
16147 That means that all the constructors will be run a bit quicker, but when
16148 the loop comes to the end of the list, the program crashes because ptabs
16149 loads @minus{}1 into a target register.  Since this option is unsafe for any
16150 hardware implementing the current architecture specification, the default
16151 is -mno-pt-fixed.  Unless the user specifies a specific cost with
16152 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
16153 this deters register allocation using target registers for storing
16154 ordinary integers.
16155
16156 @item -minvalid-symbols
16157 @opindex minvalid-symbols
16158 Assume symbols might be invalid.  Ordinary function symbols generated by
16159 the compiler will always be valid to load with movi/shori/ptabs or
16160 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
16161 to generate symbols that will cause ptabs / ptrel to trap.
16162 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
16163 It will then prevent cross-basic-block cse, hoisting and most scheduling
16164 of symbol loads.  The default is @option{-mno-invalid-symbols}.
16165 @end table
16166
16167 @node SPARC Options
16168 @subsection SPARC Options
16169 @cindex SPARC options
16170
16171 These @samp{-m} options are supported on the SPARC:
16172
16173 @table @gcctabopt
16174 @item -mno-app-regs
16175 @itemx -mapp-regs
16176 @opindex mno-app-regs
16177 @opindex mapp-regs
16178 Specify @option{-mapp-regs} to generate output using the global registers
16179 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
16180 is the default.
16181
16182 To be fully SVR4 ABI compliant at the cost of some performance loss,
16183 specify @option{-mno-app-regs}.  You should compile libraries and system
16184 software with this option.
16185
16186 @item -mfpu
16187 @itemx -mhard-float
16188 @opindex mfpu
16189 @opindex mhard-float
16190 Generate output containing floating point instructions.  This is the
16191 default.
16192
16193 @item -mno-fpu
16194 @itemx -msoft-float
16195 @opindex mno-fpu
16196 @opindex msoft-float
16197 Generate output containing library calls for floating point.
16198 @strong{Warning:} the requisite libraries are not available for all SPARC
16199 targets.  Normally the facilities of the machine's usual C compiler are
16200 used, but this cannot be done directly in cross-compilation.  You must make
16201 your own arrangements to provide suitable library functions for
16202 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
16203 @samp{sparclite-*-*} do provide software floating point support.
16204
16205 @option{-msoft-float} changes the calling convention in the output file;
16206 therefore, it is only useful if you compile @emph{all} of a program with
16207 this option.  In particular, you need to compile @file{libgcc.a}, the
16208 library that comes with GCC, with @option{-msoft-float} in order for
16209 this to work.
16210
16211 @item -mhard-quad-float
16212 @opindex mhard-quad-float
16213 Generate output containing quad-word (long double) floating point
16214 instructions.
16215
16216 @item -msoft-quad-float
16217 @opindex msoft-quad-float
16218 Generate output containing library calls for quad-word (long double)
16219 floating point instructions.  The functions called are those specified
16220 in the SPARC ABI@.  This is the default.
16221
16222 As of this writing, there are no SPARC implementations that have hardware
16223 support for the quad-word floating point instructions.  They all invoke
16224 a trap handler for one of these instructions, and then the trap handler
16225 emulates the effect of the instruction.  Because of the trap handler overhead,
16226 this is much slower than calling the ABI library routines.  Thus the
16227 @option{-msoft-quad-float} option is the default.
16228
16229 @item -mno-unaligned-doubles
16230 @itemx -munaligned-doubles
16231 @opindex mno-unaligned-doubles
16232 @opindex munaligned-doubles
16233 Assume that doubles have 8 byte alignment.  This is the default.
16234
16235 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
16236 alignment only if they are contained in another type, or if they have an
16237 absolute address.  Otherwise, it assumes they have 4 byte alignment.
16238 Specifying this option avoids some rare compatibility problems with code
16239 generated by other compilers.  It is not the default because it results
16240 in a performance loss, especially for floating point code.
16241
16242 @item -mno-faster-structs
16243 @itemx -mfaster-structs
16244 @opindex mno-faster-structs
16245 @opindex mfaster-structs
16246 With @option{-mfaster-structs}, the compiler assumes that structures
16247 should have 8 byte alignment.  This enables the use of pairs of
16248 @code{ldd} and @code{std} instructions for copies in structure
16249 assignment, in place of twice as many @code{ld} and @code{st} pairs.
16250 However, the use of this changed alignment directly violates the SPARC
16251 ABI@.  Thus, it's intended only for use on targets where the developer
16252 acknowledges that their resulting code will not be directly in line with
16253 the rules of the ABI@.
16254
16255 @item -mimpure-text
16256 @opindex mimpure-text
16257 @option{-mimpure-text}, used in addition to @option{-shared}, tells
16258 the compiler to not pass @option{-z text} to the linker when linking a
16259 shared object.  Using this option, you can link position-dependent
16260 code into a shared object.
16261
16262 @option{-mimpure-text} suppresses the ``relocations remain against
16263 allocatable but non-writable sections'' linker error message.
16264 However, the necessary relocations will trigger copy-on-write, and the
16265 shared object is not actually shared across processes.  Instead of
16266 using @option{-mimpure-text}, you should compile all source code with
16267 @option{-fpic} or @option{-fPIC}.
16268
16269 This option is only available on SunOS and Solaris.
16270
16271 @item -mcpu=@var{cpu_type}
16272 @opindex mcpu
16273 Set the instruction set, register set, and instruction scheduling parameters
16274 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
16275 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
16276 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
16277 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
16278 @samp{ultrasparc3}, @samp{niagara} and @samp{niagara2}.
16279
16280 Default instruction scheduling parameters are used for values that select
16281 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
16282 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
16283
16284 Here is a list of each supported architecture and their supported
16285 implementations.
16286
16287 @smallexample
16288     v7:             cypress
16289     v8:             supersparc, hypersparc
16290     sparclite:      f930, f934, sparclite86x
16291     sparclet:       tsc701
16292     v9:             ultrasparc, ultrasparc3, niagara, niagara2
16293 @end smallexample
16294
16295 By default (unless configured otherwise), GCC generates code for the V7
16296 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
16297 additionally optimizes it for the Cypress CY7C602 chip, as used in the
16298 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
16299 SPARCStation 1, 2, IPX etc.
16300
16301 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
16302 architecture.  The only difference from V7 code is that the compiler emits
16303 the integer multiply and integer divide instructions which exist in SPARC-V8
16304 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
16305 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
16306 2000 series.
16307
16308 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
16309 the SPARC architecture.  This adds the integer multiply, integer divide step
16310 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
16311 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
16312 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
16313 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
16314 MB86934 chip, which is the more recent SPARClite with FPU@.
16315
16316 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
16317 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
16318 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
16319 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
16320 optimizes it for the TEMIC SPARClet chip.
16321
16322 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
16323 architecture.  This adds 64-bit integer and floating-point move instructions,
16324 3 additional floating-point condition code registers and conditional move
16325 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
16326 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
16327 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
16328 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
16329 @option{-mcpu=niagara}, the compiler additionally optimizes it for
16330 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
16331 additionally optimizes it for Sun UltraSPARC T2 chips.
16332
16333 @item -mtune=@var{cpu_type}
16334 @opindex mtune
16335 Set the instruction scheduling parameters for machine type
16336 @var{cpu_type}, but do not set the instruction set or register set that the
16337 option @option{-mcpu=@var{cpu_type}} would.
16338
16339 The same values for @option{-mcpu=@var{cpu_type}} can be used for
16340 @option{-mtune=@var{cpu_type}}, but the only useful values are those
16341 that select a particular cpu implementation.  Those are @samp{cypress},
16342 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
16343 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
16344 @samp{ultrasparc3}, @samp{niagara}, and @samp{niagara2}.
16345
16346 @item -mv8plus
16347 @itemx -mno-v8plus
16348 @opindex mv8plus
16349 @opindex mno-v8plus
16350 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
16351 difference from the V8 ABI is that the global and out registers are
16352 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
16353 mode for all SPARC-V9 processors.
16354
16355 @item -mvis
16356 @itemx -mno-vis
16357 @opindex mvis
16358 @opindex mno-vis
16359 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
16360 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
16361 @end table
16362
16363 These @samp{-m} options are supported in addition to the above
16364 on SPARC-V9 processors in 64-bit environments:
16365
16366 @table @gcctabopt
16367 @item -mlittle-endian
16368 @opindex mlittle-endian
16369 Generate code for a processor running in little-endian mode.  It is only
16370 available for a few configurations and most notably not on Solaris and Linux.
16371
16372 @item -m32
16373 @itemx -m64
16374 @opindex m32
16375 @opindex m64
16376 Generate code for a 32-bit or 64-bit environment.
16377 The 32-bit environment sets int, long and pointer to 32 bits.
16378 The 64-bit environment sets int to 32 bits and long and pointer
16379 to 64 bits.
16380
16381 @item -mcmodel=medlow
16382 @opindex mcmodel=medlow
16383 Generate code for the Medium/Low code model: 64-bit addresses, programs
16384 must be linked in the low 32 bits of memory.  Programs can be statically
16385 or dynamically linked.
16386
16387 @item -mcmodel=medmid
16388 @opindex mcmodel=medmid
16389 Generate code for the Medium/Middle code model: 64-bit addresses, programs
16390 must be linked in the low 44 bits of memory, the text and data segments must
16391 be less than 2GB in size and the data segment must be located within 2GB of
16392 the text segment.
16393
16394 @item -mcmodel=medany
16395 @opindex mcmodel=medany
16396 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
16397 may be linked anywhere in memory, the text and data segments must be less
16398 than 2GB in size and the data segment must be located within 2GB of the
16399 text segment.
16400
16401 @item -mcmodel=embmedany
16402 @opindex mcmodel=embmedany
16403 Generate code for the Medium/Anywhere code model for embedded systems:
16404 64-bit addresses, the text and data segments must be less than 2GB in
16405 size, both starting anywhere in memory (determined at link time).  The
16406 global register %g4 points to the base of the data segment.  Programs
16407 are statically linked and PIC is not supported.
16408
16409 @item -mstack-bias
16410 @itemx -mno-stack-bias
16411 @opindex mstack-bias
16412 @opindex mno-stack-bias
16413 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
16414 frame pointer if present, are offset by @minus{}2047 which must be added back
16415 when making stack frame references.  This is the default in 64-bit mode.
16416 Otherwise, assume no such offset is present.
16417 @end table
16418
16419 These switches are supported in addition to the above on Solaris:
16420
16421 @table @gcctabopt
16422 @item -threads
16423 @opindex threads
16424 Add support for multithreading using the Solaris threads library.  This
16425 option sets flags for both the preprocessor and linker.  This option does
16426 not affect the thread safety of object code produced by the compiler or
16427 that of libraries supplied with it.
16428
16429 @item -pthreads
16430 @opindex pthreads
16431 Add support for multithreading using the POSIX threads library.  This
16432 option sets flags for both the preprocessor and linker.  This option does
16433 not affect the thread safety of object code produced  by the compiler or
16434 that of libraries supplied with it.
16435
16436 @item -pthread
16437 @opindex pthread
16438 This is a synonym for @option{-pthreads}.
16439 @end table
16440
16441 @node SPU Options
16442 @subsection SPU Options
16443 @cindex SPU options
16444
16445 These @samp{-m} options are supported on the SPU:
16446
16447 @table @gcctabopt
16448 @item -mwarn-reloc
16449 @itemx -merror-reloc
16450 @opindex mwarn-reloc
16451 @opindex merror-reloc
16452
16453 The loader for SPU does not handle dynamic relocations.  By default, GCC
16454 will give an error when it generates code that requires a dynamic
16455 relocation.  @option{-mno-error-reloc} disables the error,
16456 @option{-mwarn-reloc} will generate a warning instead.
16457
16458 @item -msafe-dma
16459 @itemx -munsafe-dma
16460 @opindex msafe-dma
16461 @opindex munsafe-dma
16462
16463 Instructions which initiate or test completion of DMA must not be
16464 reordered with respect to loads and stores of the memory which is being
16465 accessed.  Users typically address this problem using the volatile
16466 keyword, but that can lead to inefficient code in places where the
16467 memory is known to not change.  Rather than mark the memory as volatile
16468 we treat the DMA instructions as potentially effecting all memory.  With
16469 @option{-munsafe-dma} users must use the volatile keyword to protect
16470 memory accesses.
16471
16472 @item -mbranch-hints
16473 @opindex mbranch-hints
16474
16475 By default, GCC will generate a branch hint instruction to avoid
16476 pipeline stalls for always taken or probably taken branches.  A hint
16477 will not be generated closer than 8 instructions away from its branch.
16478 There is little reason to disable them, except for debugging purposes,
16479 or to make an object a little bit smaller.
16480
16481 @item -msmall-mem
16482 @itemx -mlarge-mem
16483 @opindex msmall-mem
16484 @opindex mlarge-mem
16485
16486 By default, GCC generates code assuming that addresses are never larger
16487 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
16488 a full 32 bit address.
16489
16490 @item -mstdmain
16491 @opindex mstdmain
16492
16493 By default, GCC links against startup code that assumes the SPU-style
16494 main function interface (which has an unconventional parameter list).
16495 With @option{-mstdmain}, GCC will link your program against startup
16496 code that assumes a C99-style interface to @code{main}, including a
16497 local copy of @code{argv} strings.
16498
16499 @item -mfixed-range=@var{register-range}
16500 @opindex mfixed-range
16501 Generate code treating the given register range as fixed registers.
16502 A fixed register is one that the register allocator can not use.  This is
16503 useful when compiling kernel code.  A register range is specified as
16504 two registers separated by a dash.  Multiple register ranges can be
16505 specified separated by a comma.
16506
16507 @item -mea32
16508 @itemx -mea64
16509 @opindex mea32
16510 @opindex mea64
16511 Compile code assuming that pointers to the PPU address space accessed
16512 via the @code{__ea} named address space qualifier are either 32 or 64
16513 bits wide.  The default is 32 bits.  As this is an ABI changing option,
16514 all object code in an executable must be compiled with the same setting.
16515
16516 @item -maddress-space-conversion
16517 @itemx -mno-address-space-conversion
16518 @opindex maddress-space-conversion
16519 @opindex mno-address-space-conversion
16520 Allow/disallow treating the @code{__ea} address space as superset
16521 of the generic address space.  This enables explicit type casts
16522 between @code{__ea} and generic pointer as well as implicit
16523 conversions of generic pointers to @code{__ea} pointers.  The
16524 default is to allow address space pointer conversions.
16525
16526 @item -mcache-size=@var{cache-size}
16527 @opindex mcache-size
16528 This option controls the version of libgcc that the compiler links to an
16529 executable and selects a software-managed cache for accessing variables
16530 in the @code{__ea} address space with a particular cache size.  Possible
16531 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
16532 and @samp{128}.  The default cache size is 64KB.
16533
16534 @item -matomic-updates
16535 @itemx -mno-atomic-updates
16536 @opindex matomic-updates
16537 @opindex mno-atomic-updates
16538 This option controls the version of libgcc that the compiler links to an
16539 executable and selects whether atomic updates to the software-managed
16540 cache of PPU-side variables are used.  If you use atomic updates, changes
16541 to a PPU variable from SPU code using the @code{__ea} named address space
16542 qualifier will not interfere with changes to other PPU variables residing
16543 in the same cache line from PPU code.  If you do not use atomic updates,
16544 such interference may occur; however, writing back cache lines will be
16545 more efficient.  The default behavior is to use atomic updates.
16546
16547 @item -mdual-nops
16548 @itemx -mdual-nops=@var{n}
16549 @opindex mdual-nops
16550 By default, GCC will insert nops to increase dual issue when it expects
16551 it to increase performance.  @var{n} can be a value from 0 to 10.  A
16552 smaller @var{n} will insert fewer nops.  10 is the default, 0 is the
16553 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
16554
16555 @item -mhint-max-nops=@var{n}
16556 @opindex mhint-max-nops
16557 Maximum number of nops to insert for a branch hint.  A branch hint must
16558 be at least 8 instructions away from the branch it is effecting.  GCC
16559 will insert up to @var{n} nops to enforce this, otherwise it will not
16560 generate the branch hint.
16561
16562 @item -mhint-max-distance=@var{n}
16563 @opindex mhint-max-distance
16564 The encoding of the branch hint instruction limits the hint to be within
16565 256 instructions of the branch it is effecting.  By default, GCC makes
16566 sure it is within 125.
16567
16568 @item -msafe-hints
16569 @opindex msafe-hints
16570 Work around a hardware bug which causes the SPU to stall indefinitely.
16571 By default, GCC will insert the @code{hbrp} instruction to make sure
16572 this stall won't happen.
16573
16574 @end table
16575
16576 @node System V Options
16577 @subsection Options for System V
16578
16579 These additional options are available on System V Release 4 for
16580 compatibility with other compilers on those systems:
16581
16582 @table @gcctabopt
16583 @item -G
16584 @opindex G
16585 Create a shared object.
16586 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
16587
16588 @item -Qy
16589 @opindex Qy
16590 Identify the versions of each tool used by the compiler, in a
16591 @code{.ident} assembler directive in the output.
16592
16593 @item -Qn
16594 @opindex Qn
16595 Refrain from adding @code{.ident} directives to the output file (this is
16596 the default).
16597
16598 @item -YP,@var{dirs}
16599 @opindex YP
16600 Search the directories @var{dirs}, and no others, for libraries
16601 specified with @option{-l}.
16602
16603 @item -Ym,@var{dir}
16604 @opindex Ym
16605 Look in the directory @var{dir} to find the M4 preprocessor.
16606 The assembler uses this option.
16607 @c This is supposed to go with a -Yd for predefined M4 macro files, but
16608 @c the generic assembler that comes with Solaris takes just -Ym.
16609 @end table
16610
16611 @node V850 Options
16612 @subsection V850 Options
16613 @cindex V850 Options
16614
16615 These @samp{-m} options are defined for V850 implementations:
16616
16617 @table @gcctabopt
16618 @item -mlong-calls
16619 @itemx -mno-long-calls
16620 @opindex mlong-calls
16621 @opindex mno-long-calls
16622 Treat all calls as being far away (near).  If calls are assumed to be
16623 far away, the compiler will always load the functions address up into a
16624 register, and call indirect through the pointer.
16625
16626 @item -mno-ep
16627 @itemx -mep
16628 @opindex mno-ep
16629 @opindex mep
16630 Do not optimize (do optimize) basic blocks that use the same index
16631 pointer 4 or more times to copy pointer into the @code{ep} register, and
16632 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
16633 option is on by default if you optimize.
16634
16635 @item -mno-prolog-function
16636 @itemx -mprolog-function
16637 @opindex mno-prolog-function
16638 @opindex mprolog-function
16639 Do not use (do use) external functions to save and restore registers
16640 at the prologue and epilogue of a function.  The external functions
16641 are slower, but use less code space if more than one function saves
16642 the same number of registers.  The @option{-mprolog-function} option
16643 is on by default if you optimize.
16644
16645 @item -mspace
16646 @opindex mspace
16647 Try to make the code as small as possible.  At present, this just turns
16648 on the @option{-mep} and @option{-mprolog-function} options.
16649
16650 @item -mtda=@var{n}
16651 @opindex mtda
16652 Put static or global variables whose size is @var{n} bytes or less into
16653 the tiny data area that register @code{ep} points to.  The tiny data
16654 area can hold up to 256 bytes in total (128 bytes for byte references).
16655
16656 @item -msda=@var{n}
16657 @opindex msda
16658 Put static or global variables whose size is @var{n} bytes or less into
16659 the small data area that register @code{gp} points to.  The small data
16660 area can hold up to 64 kilobytes.
16661
16662 @item -mzda=@var{n}
16663 @opindex mzda
16664 Put static or global variables whose size is @var{n} bytes or less into
16665 the first 32 kilobytes of memory.
16666
16667 @item -mv850
16668 @opindex mv850
16669 Specify that the target processor is the V850.
16670
16671 @item -mbig-switch
16672 @opindex mbig-switch
16673 Generate code suitable for big switch tables.  Use this option only if
16674 the assembler/linker complain about out of range branches within a switch
16675 table.
16676
16677 @item -mapp-regs
16678 @opindex mapp-regs
16679 This option will cause r2 and r5 to be used in the code generated by
16680 the compiler.  This setting is the default.
16681
16682 @item -mno-app-regs
16683 @opindex mno-app-regs
16684 This option will cause r2 and r5 to be treated as fixed registers.
16685
16686 @item -mv850e1
16687 @opindex mv850e1
16688 Specify that the target processor is the V850E1.  The preprocessor
16689 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
16690 this option is used.
16691
16692 @item -mv850e
16693 @opindex mv850e
16694 Specify that the target processor is the V850E@.  The preprocessor
16695 constant @samp{__v850e__} will be defined if this option is used.
16696
16697 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
16698 are defined then a default target processor will be chosen and the
16699 relevant @samp{__v850*__} preprocessor constant will be defined.
16700
16701 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
16702 defined, regardless of which processor variant is the target.
16703
16704 @item -mdisable-callt
16705 @opindex mdisable-callt
16706 This option will suppress generation of the CALLT instruction for the
16707 v850e and v850e1 flavors of the v850 architecture.  The default is
16708 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
16709
16710 @end table
16711
16712 @node VAX Options
16713 @subsection VAX Options
16714 @cindex VAX options
16715
16716 These @samp{-m} options are defined for the VAX:
16717
16718 @table @gcctabopt
16719 @item -munix
16720 @opindex munix
16721 Do not output certain jump instructions (@code{aobleq} and so on)
16722 that the Unix assembler for the VAX cannot handle across long
16723 ranges.
16724
16725 @item -mgnu
16726 @opindex mgnu
16727 Do output those jump instructions, on the assumption that you
16728 will assemble with the GNU assembler.
16729
16730 @item -mg
16731 @opindex mg
16732 Output code for g-format floating point numbers instead of d-format.
16733 @end table
16734
16735 @node VxWorks Options
16736 @subsection VxWorks Options
16737 @cindex VxWorks Options
16738
16739 The options in this section are defined for all VxWorks targets.
16740 Options specific to the target hardware are listed with the other
16741 options for that target.
16742
16743 @table @gcctabopt
16744 @item -mrtp
16745 @opindex mrtp
16746 GCC can generate code for both VxWorks kernels and real time processes
16747 (RTPs).  This option switches from the former to the latter.  It also
16748 defines the preprocessor macro @code{__RTP__}.
16749
16750 @item -non-static
16751 @opindex non-static
16752 Link an RTP executable against shared libraries rather than static
16753 libraries.  The options @option{-static} and @option{-shared} can
16754 also be used for RTPs (@pxref{Link Options}); @option{-static}
16755 is the default.
16756
16757 @item -Bstatic
16758 @itemx -Bdynamic
16759 @opindex Bstatic
16760 @opindex Bdynamic
16761 These options are passed down to the linker.  They are defined for
16762 compatibility with Diab.
16763
16764 @item -Xbind-lazy
16765 @opindex Xbind-lazy
16766 Enable lazy binding of function calls.  This option is equivalent to
16767 @option{-Wl,-z,now} and is defined for compatibility with Diab.
16768
16769 @item -Xbind-now
16770 @opindex Xbind-now
16771 Disable lazy binding of function calls.  This option is the default and
16772 is defined for compatibility with Diab.
16773 @end table
16774
16775 @node x86-64 Options
16776 @subsection x86-64 Options
16777 @cindex x86-64 options
16778
16779 These are listed under @xref{i386 and x86-64 Options}.
16780
16781 @node i386 and x86-64 Windows Options
16782 @subsection i386 and x86-64 Windows Options
16783 @cindex i386 and x86-64 Windows Options
16784
16785 These additional options are available for Windows targets:
16786
16787 @table @gcctabopt
16788 @item -mconsole
16789 @opindex mconsole
16790 This option is available for Cygwin and MinGW targets.  It
16791 specifies that a console application is to be generated, by
16792 instructing the linker to set the PE header subsystem type
16793 required for console applications.
16794 This is the default behavior for Cygwin and MinGW targets.
16795
16796 @item -mcygwin
16797 @opindex mcygwin
16798 This option is available for Cygwin targets.  It specifies that
16799 the Cygwin internal interface is to be used for predefined
16800 preprocessor macros, C runtime libraries and related linker
16801 paths and options.  For Cygwin targets this is the default behavior.
16802 This option is deprecated and will be removed in a future release.
16803
16804 @item -mno-cygwin
16805 @opindex mno-cygwin
16806 This option is available for Cygwin targets.  It specifies that
16807 the MinGW internal interface is to be used instead of Cygwin's, by
16808 setting MinGW-related predefined macros and linker paths and default
16809 library options.
16810 This option is deprecated and will be removed in a future release.
16811
16812 @item -mdll
16813 @opindex mdll
16814 This option is available for Cygwin and MinGW targets.  It
16815 specifies that a DLL - a dynamic link library - is to be
16816 generated, enabling the selection of the required runtime
16817 startup object and entry point.
16818
16819 @item -mnop-fun-dllimport
16820 @opindex mnop-fun-dllimport
16821 This option is available for Cygwin and MinGW targets.  It
16822 specifies that the dllimport attribute should be ignored.
16823
16824 @item -mthread
16825 @opindex mthread
16826 This option is available for MinGW targets. It specifies
16827 that MinGW-specific thread support is to be used.
16828
16829 @item -municode
16830 @opindex municode
16831 This option is available for mingw-w64 targets.  It specifies
16832 that the UNICODE macro is getting pre-defined and that the
16833 unicode capable runtime startup code is chosen.
16834
16835 @item -mwin32
16836 @opindex mwin32
16837 This option is available for Cygwin and MinGW targets.  It
16838 specifies that the typical Windows pre-defined macros are to
16839 be set in the pre-processor, but does not influence the choice
16840 of runtime library/startup code.
16841
16842 @item -mwindows
16843 @opindex mwindows
16844 This option is available for Cygwin and MinGW targets.  It
16845 specifies that a GUI application is to be generated by
16846 instructing the linker to set the PE header subsystem type
16847 appropriately.
16848
16849 @item -fno-set-stack-executable
16850 @opindex fno-set-stack-executable
16851 This option is available for MinGW targets. It specifies that
16852 the executable flag for stack used by nested functions isn't
16853 set. This is necessary for binaries running in kernel mode of
16854 Windows, as there the user32 API, which is used to set executable
16855 privileges, isn't available.
16856
16857 @item -mpe-aligned-commons
16858 @opindex mpe-aligned-commons
16859 This option is available for Cygwin and MinGW targets.  It
16860 specifies that the GNU extension to the PE file format that
16861 permits the correct alignment of COMMON variables should be
16862 used when generating code.  It will be enabled by default if
16863 GCC detects that the target assembler found during configuration
16864 supports the feature.
16865 @end table
16866
16867 See also under @ref{i386 and x86-64 Options} for standard options.
16868
16869 @node Xstormy16 Options
16870 @subsection Xstormy16 Options
16871 @cindex Xstormy16 Options
16872
16873 These options are defined for Xstormy16:
16874
16875 @table @gcctabopt
16876 @item -msim
16877 @opindex msim
16878 Choose startup files and linker script suitable for the simulator.
16879 @end table
16880
16881 @node Xtensa Options
16882 @subsection Xtensa Options
16883 @cindex Xtensa Options
16884
16885 These options are supported for Xtensa targets:
16886
16887 @table @gcctabopt
16888 @item -mconst16
16889 @itemx -mno-const16
16890 @opindex mconst16
16891 @opindex mno-const16
16892 Enable or disable use of @code{CONST16} instructions for loading
16893 constant values.  The @code{CONST16} instruction is currently not a
16894 standard option from Tensilica.  When enabled, @code{CONST16}
16895 instructions are always used in place of the standard @code{L32R}
16896 instructions.  The use of @code{CONST16} is enabled by default only if
16897 the @code{L32R} instruction is not available.
16898
16899 @item -mfused-madd
16900 @itemx -mno-fused-madd
16901 @opindex mfused-madd
16902 @opindex mno-fused-madd
16903 Enable or disable use of fused multiply/add and multiply/subtract
16904 instructions in the floating-point option.  This has no effect if the
16905 floating-point option is not also enabled.  Disabling fused multiply/add
16906 and multiply/subtract instructions forces the compiler to use separate
16907 instructions for the multiply and add/subtract operations.  This may be
16908 desirable in some cases where strict IEEE 754-compliant results are
16909 required: the fused multiply add/subtract instructions do not round the
16910 intermediate result, thereby producing results with @emph{more} bits of
16911 precision than specified by the IEEE standard.  Disabling fused multiply
16912 add/subtract instructions also ensures that the program output is not
16913 sensitive to the compiler's ability to combine multiply and add/subtract
16914 operations.
16915
16916 @item -mserialize-volatile
16917 @itemx -mno-serialize-volatile
16918 @opindex mserialize-volatile
16919 @opindex mno-serialize-volatile
16920 When this option is enabled, GCC inserts @code{MEMW} instructions before
16921 @code{volatile} memory references to guarantee sequential consistency.
16922 The default is @option{-mserialize-volatile}.  Use
16923 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
16924
16925 @item -mtext-section-literals
16926 @itemx -mno-text-section-literals
16927 @opindex mtext-section-literals
16928 @opindex mno-text-section-literals
16929 Control the treatment of literal pools.  The default is
16930 @option{-mno-text-section-literals}, which places literals in a separate
16931 section in the output file.  This allows the literal pool to be placed
16932 in a data RAM/ROM, and it also allows the linker to combine literal
16933 pools from separate object files to remove redundant literals and
16934 improve code size.  With @option{-mtext-section-literals}, the literals
16935 are interspersed in the text section in order to keep them as close as
16936 possible to their references.  This may be necessary for large assembly
16937 files.
16938
16939 @item -mtarget-align
16940 @itemx -mno-target-align
16941 @opindex mtarget-align
16942 @opindex mno-target-align
16943 When this option is enabled, GCC instructs the assembler to
16944 automatically align instructions to reduce branch penalties at the
16945 expense of some code density.  The assembler attempts to widen density
16946 instructions to align branch targets and the instructions following call
16947 instructions.  If there are not enough preceding safe density
16948 instructions to align a target, no widening will be performed.  The
16949 default is @option{-mtarget-align}.  These options do not affect the
16950 treatment of auto-aligned instructions like @code{LOOP}, which the
16951 assembler will always align, either by widening density instructions or
16952 by inserting no-op instructions.
16953
16954 @item -mlongcalls
16955 @itemx -mno-longcalls
16956 @opindex mlongcalls
16957 @opindex mno-longcalls
16958 When this option is enabled, GCC instructs the assembler to translate
16959 direct calls to indirect calls unless it can determine that the target
16960 of a direct call is in the range allowed by the call instruction.  This
16961 translation typically occurs for calls to functions in other source
16962 files.  Specifically, the assembler translates a direct @code{CALL}
16963 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
16964 The default is @option{-mno-longcalls}.  This option should be used in
16965 programs where the call target can potentially be out of range.  This
16966 option is implemented in the assembler, not the compiler, so the
16967 assembly code generated by GCC will still show direct call
16968 instructions---look at the disassembled object code to see the actual
16969 instructions.  Note that the assembler will use an indirect call for
16970 every cross-file call, not just those that really will be out of range.
16971 @end table
16972
16973 @node zSeries Options
16974 @subsection zSeries Options
16975 @cindex zSeries options
16976
16977 These are listed under @xref{S/390 and zSeries Options}.
16978
16979 @node Code Gen Options
16980 @section Options for Code Generation Conventions
16981 @cindex code generation conventions
16982 @cindex options, code generation
16983 @cindex run-time options
16984
16985 These machine-independent options control the interface conventions
16986 used in code generation.
16987
16988 Most of them have both positive and negative forms; the negative form
16989 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
16990 one of the forms is listed---the one which is not the default.  You
16991 can figure out the other form by either removing @samp{no-} or adding
16992 it.
16993
16994 @table @gcctabopt
16995 @item -fbounds-check
16996 @opindex fbounds-check
16997 For front-ends that support it, generate additional code to check that
16998 indices used to access arrays are within the declared range.  This is
16999 currently only supported by the Java and Fortran front-ends, where
17000 this option defaults to true and false respectively.
17001
17002 @item -ftrapv
17003 @opindex ftrapv
17004 This option generates traps for signed overflow on addition, subtraction,
17005 multiplication operations.
17006
17007 @item -fwrapv
17008 @opindex fwrapv
17009 This option instructs the compiler to assume that signed arithmetic
17010 overflow of addition, subtraction and multiplication wraps around
17011 using twos-complement representation.  This flag enables some optimizations
17012 and disables others.  This option is enabled by default for the Java
17013 front-end, as required by the Java language specification.
17014
17015 @item -fexceptions
17016 @opindex fexceptions
17017 Enable exception handling.  Generates extra code needed to propagate
17018 exceptions.  For some targets, this implies GCC will generate frame
17019 unwind information for all functions, which can produce significant data
17020 size overhead, although it does not affect execution.  If you do not
17021 specify this option, GCC will enable it by default for languages like
17022 C++ which normally require exception handling, and disable it for
17023 languages like C that do not normally require it.  However, you may need
17024 to enable this option when compiling C code that needs to interoperate
17025 properly with exception handlers written in C++.  You may also wish to
17026 disable this option if you are compiling older C++ programs that don't
17027 use exception handling.
17028
17029 @item -fnon-call-exceptions
17030 @opindex fnon-call-exceptions
17031 Generate code that allows trapping instructions to throw exceptions.
17032 Note that this requires platform-specific runtime support that does
17033 not exist everywhere.  Moreover, it only allows @emph{trapping}
17034 instructions to throw exceptions, i.e.@: memory references or floating
17035 point instructions.  It does not allow exceptions to be thrown from
17036 arbitrary signal handlers such as @code{SIGALRM}.
17037
17038 @item -funwind-tables
17039 @opindex funwind-tables
17040 Similar to @option{-fexceptions}, except that it will just generate any needed
17041 static data, but will not affect the generated code in any other way.
17042 You will normally not enable this option; instead, a language processor
17043 that needs this handling would enable it on your behalf.
17044
17045 @item -fasynchronous-unwind-tables
17046 @opindex fasynchronous-unwind-tables
17047 Generate unwind table in dwarf2 format, if supported by target machine.  The
17048 table is exact at each instruction boundary, so it can be used for stack
17049 unwinding from asynchronous events (such as debugger or garbage collector).
17050
17051 @item -fpcc-struct-return
17052 @opindex fpcc-struct-return
17053 Return ``short'' @code{struct} and @code{union} values in memory like
17054 longer ones, rather than in registers.  This convention is less
17055 efficient, but it has the advantage of allowing intercallability between
17056 GCC-compiled files and files compiled with other compilers, particularly
17057 the Portable C Compiler (pcc).
17058
17059 The precise convention for returning structures in memory depends
17060 on the target configuration macros.
17061
17062 Short structures and unions are those whose size and alignment match
17063 that of some integer type.
17064
17065 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
17066 switch is not binary compatible with code compiled with the
17067 @option{-freg-struct-return} switch.
17068 Use it to conform to a non-default application binary interface.
17069
17070 @item -freg-struct-return
17071 @opindex freg-struct-return
17072 Return @code{struct} and @code{union} values in registers when possible.
17073 This is more efficient for small structures than
17074 @option{-fpcc-struct-return}.
17075
17076 If you specify neither @option{-fpcc-struct-return} nor
17077 @option{-freg-struct-return}, GCC defaults to whichever convention is
17078 standard for the target.  If there is no standard convention, GCC
17079 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
17080 the principal compiler.  In those cases, we can choose the standard, and
17081 we chose the more efficient register return alternative.
17082
17083 @strong{Warning:} code compiled with the @option{-freg-struct-return}
17084 switch is not binary compatible with code compiled with the
17085 @option{-fpcc-struct-return} switch.
17086 Use it to conform to a non-default application binary interface.
17087
17088 @item -fshort-enums
17089 @opindex fshort-enums
17090 Allocate to an @code{enum} type only as many bytes as it needs for the
17091 declared range of possible values.  Specifically, the @code{enum} type
17092 will be equivalent to the smallest integer type which has enough room.
17093
17094 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
17095 code that is not binary compatible with code generated without that switch.
17096 Use it to conform to a non-default application binary interface.
17097
17098 @item -fshort-double
17099 @opindex fshort-double
17100 Use the same size for @code{double} as for @code{float}.
17101
17102 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
17103 code that is not binary compatible with code generated without that switch.
17104 Use it to conform to a non-default application binary interface.
17105
17106 @item -fshort-wchar
17107 @opindex fshort-wchar
17108 Override the underlying type for @samp{wchar_t} to be @samp{short
17109 unsigned int} instead of the default for the target.  This option is
17110 useful for building programs to run under WINE@.
17111
17112 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
17113 code that is not binary compatible with code generated without that switch.
17114 Use it to conform to a non-default application binary interface.
17115
17116 @item -fno-common
17117 @opindex fno-common
17118 In C code, controls the placement of uninitialized global variables.
17119 Unix C compilers have traditionally permitted multiple definitions of
17120 such variables in different compilation units by placing the variables
17121 in a common block.
17122 This is the behavior specified by @option{-fcommon}, and is the default
17123 for GCC on most targets.
17124 On the other hand, this behavior is not required by ISO C, and on some
17125 targets may carry a speed or code size penalty on variable references.
17126 The @option{-fno-common} option specifies that the compiler should place
17127 uninitialized global variables in the data section of the object file,
17128 rather than generating them as common blocks.
17129 This has the effect that if the same variable is declared
17130 (without @code{extern}) in two different compilations,
17131 you will get a multiple-definition error when you link them.
17132 In this case, you must compile with @option{-fcommon} instead.
17133 Compiling with @option{-fno-common} is useful on targets for which
17134 it provides better performance, or if you wish to verify that the
17135 program will work on other systems which always treat uninitialized
17136 variable declarations this way.
17137
17138 @item -fno-ident
17139 @opindex fno-ident
17140 Ignore the @samp{#ident} directive.
17141
17142 @item -finhibit-size-directive
17143 @opindex finhibit-size-directive
17144 Don't output a @code{.size} assembler directive, or anything else that
17145 would cause trouble if the function is split in the middle, and the
17146 two halves are placed at locations far apart in memory.  This option is
17147 used when compiling @file{crtstuff.c}; you should not need to use it
17148 for anything else.
17149
17150 @item -fverbose-asm
17151 @opindex fverbose-asm
17152 Put extra commentary information in the generated assembly code to
17153 make it more readable.  This option is generally only of use to those
17154 who actually need to read the generated assembly code (perhaps while
17155 debugging the compiler itself).
17156
17157 @option{-fno-verbose-asm}, the default, causes the
17158 extra information to be omitted and is useful when comparing two assembler
17159 files.
17160
17161 @item -frecord-gcc-switches
17162 @opindex frecord-gcc-switches
17163 This switch causes the command line that was used to invoke the
17164 compiler to be recorded into the object file that is being created.
17165 This switch is only implemented on some targets and the exact format
17166 of the recording is target and binary file format dependent, but it
17167 usually takes the form of a section containing ASCII text.  This
17168 switch is related to the @option{-fverbose-asm} switch, but that
17169 switch only records information in the assembler output file as
17170 comments, so it never reaches the object file.
17171
17172 @item -fpic
17173 @opindex fpic
17174 @cindex global offset table
17175 @cindex PIC
17176 Generate position-independent code (PIC) suitable for use in a shared
17177 library, if supported for the target machine.  Such code accesses all
17178 constant addresses through a global offset table (GOT)@.  The dynamic
17179 loader resolves the GOT entries when the program starts (the dynamic
17180 loader is not part of GCC; it is part of the operating system).  If
17181 the GOT size for the linked executable exceeds a machine-specific
17182 maximum size, you get an error message from the linker indicating that
17183 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
17184 instead.  (These maximums are 8k on the SPARC and 32k
17185 on the m68k and RS/6000.  The 386 has no such limit.)
17186
17187 Position-independent code requires special support, and therefore works
17188 only on certain machines.  For the 386, GCC supports PIC for System V
17189 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
17190 position-independent.
17191
17192 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17193 are defined to 1.
17194
17195 @item -fPIC
17196 @opindex fPIC
17197 If supported for the target machine, emit position-independent code,
17198 suitable for dynamic linking and avoiding any limit on the size of the
17199 global offset table.  This option makes a difference on the m68k,
17200 PowerPC and SPARC@.
17201
17202 Position-independent code requires special support, and therefore works
17203 only on certain machines.
17204
17205 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
17206 are defined to 2.
17207
17208 @item -fpie
17209 @itemx -fPIE
17210 @opindex fpie
17211 @opindex fPIE
17212 These options are similar to @option{-fpic} and @option{-fPIC}, but
17213 generated position independent code can be only linked into executables.
17214 Usually these options are used when @option{-pie} GCC option will be
17215 used during linking.
17216
17217 @option{-fpie} and @option{-fPIE} both define the macros
17218 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
17219 for @option{-fpie} and 2 for @option{-fPIE}.
17220
17221 @item -fno-jump-tables
17222 @opindex fno-jump-tables
17223 Do not use jump tables for switch statements even where it would be
17224 more efficient than other code generation strategies.  This option is
17225 of use in conjunction with @option{-fpic} or @option{-fPIC} for
17226 building code which forms part of a dynamic linker and cannot
17227 reference the address of a jump table.  On some targets, jump tables
17228 do not require a GOT and this option is not needed.
17229
17230 @item -ffixed-@var{reg}
17231 @opindex ffixed
17232 Treat the register named @var{reg} as a fixed register; generated code
17233 should never refer to it (except perhaps as a stack pointer, frame
17234 pointer or in some other fixed role).
17235
17236 @var{reg} must be the name of a register.  The register names accepted
17237 are machine-specific and are defined in the @code{REGISTER_NAMES}
17238 macro in the machine description macro file.
17239
17240 This flag does not have a negative form, because it specifies a
17241 three-way choice.
17242
17243 @item -fcall-used-@var{reg}
17244 @opindex fcall-used
17245 Treat the register named @var{reg} as an allocable register that is
17246 clobbered by function calls.  It may be allocated for temporaries or
17247 variables that do not live across a call.  Functions compiled this way
17248 will not save and restore the register @var{reg}.
17249
17250 It is an error to used this flag with the frame pointer or stack pointer.
17251 Use of this flag for other registers that have fixed pervasive roles in
17252 the machine's execution model will produce disastrous results.
17253
17254 This flag does not have a negative form, because it specifies a
17255 three-way choice.
17256
17257 @item -fcall-saved-@var{reg}
17258 @opindex fcall-saved
17259 Treat the register named @var{reg} as an allocable register saved by
17260 functions.  It may be allocated even for temporaries or variables that
17261 live across a call.  Functions compiled this way will save and restore
17262 the register @var{reg} if they use it.
17263
17264 It is an error to used this flag with the frame pointer or stack pointer.
17265 Use of this flag for other registers that have fixed pervasive roles in
17266 the machine's execution model will produce disastrous results.
17267
17268 A different sort of disaster will result from the use of this flag for
17269 a register in which function values may be returned.
17270
17271 This flag does not have a negative form, because it specifies a
17272 three-way choice.
17273
17274 @item -fpack-struct[=@var{n}]
17275 @opindex fpack-struct
17276 Without a value specified, pack all structure members together without
17277 holes.  When a value is specified (which must be a small power of two), pack
17278 structure members according to this value, representing the maximum
17279 alignment (that is, objects with default alignment requirements larger than
17280 this will be output potentially unaligned at the next fitting location.
17281
17282 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
17283 code that is not binary compatible with code generated without that switch.
17284 Additionally, it makes the code suboptimal.
17285 Use it to conform to a non-default application binary interface.
17286
17287 @item -finstrument-functions
17288 @opindex finstrument-functions
17289 Generate instrumentation calls for entry and exit to functions.  Just
17290 after function entry and just before function exit, the following
17291 profiling functions will be called with the address of the current
17292 function and its call site.  (On some platforms,
17293 @code{__builtin_return_address} does not work beyond the current
17294 function, so the call site information may not be available to the
17295 profiling functions otherwise.)
17296
17297 @smallexample
17298 void __cyg_profile_func_enter (void *this_fn,
17299                                void *call_site);
17300 void __cyg_profile_func_exit  (void *this_fn,
17301                                void *call_site);
17302 @end smallexample
17303
17304 The first argument is the address of the start of the current function,
17305 which may be looked up exactly in the symbol table.
17306
17307 This instrumentation is also done for functions expanded inline in other
17308 functions.  The profiling calls will indicate where, conceptually, the
17309 inline function is entered and exited.  This means that addressable
17310 versions of such functions must be available.  If all your uses of a
17311 function are expanded inline, this may mean an additional expansion of
17312 code size.  If you use @samp{extern inline} in your C code, an
17313 addressable version of such functions must be provided.  (This is
17314 normally the case anyways, but if you get lucky and the optimizer always
17315 expands the functions inline, you might have gotten away without
17316 providing static copies.)
17317
17318 A function may be given the attribute @code{no_instrument_function}, in
17319 which case this instrumentation will not be done.  This can be used, for
17320 example, for the profiling functions listed above, high-priority
17321 interrupt routines, and any functions from which the profiling functions
17322 cannot safely be called (perhaps signal handlers, if the profiling
17323 routines generate output or allocate memory).
17324
17325 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
17326 @opindex finstrument-functions-exclude-file-list
17327
17328 Set the list of functions that are excluded from instrumentation (see
17329 the description of @code{-finstrument-functions}).  If the file that
17330 contains a function definition matches with one of @var{file}, then
17331 that function is not instrumented.  The match is done on substrings:
17332 if the @var{file} parameter is a substring of the file name, it is
17333 considered to be a match.
17334
17335 For example,
17336 @code{-finstrument-functions-exclude-file-list=/bits/stl,include/sys}
17337 will exclude any inline function defined in files whose pathnames
17338 contain @code{/bits/stl} or @code{include/sys}.
17339
17340 If, for some reason, you want to include letter @code{','} in one of
17341 @var{sym}, write @code{'\,'}. For example,
17342 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
17343 (note the single quote surrounding the option).
17344
17345 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
17346 @opindex finstrument-functions-exclude-function-list
17347
17348 This is similar to @code{-finstrument-functions-exclude-file-list},
17349 but this option sets the list of function names to be excluded from
17350 instrumentation.  The function name to be matched is its user-visible
17351 name, such as @code{vector<int> blah(const vector<int> &)}, not the
17352 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
17353 match is done on substrings: if the @var{sym} parameter is a substring
17354 of the function name, it is considered to be a match.  For C99 and C++
17355 extended identifiers, the function name must be given in UTF-8, not
17356 using universal character names.
17357
17358 @item -fstack-check
17359 @opindex fstack-check
17360 Generate code to verify that you do not go beyond the boundary of the
17361 stack.  You should specify this flag if you are running in an
17362 environment with multiple threads, but only rarely need to specify it in
17363 a single-threaded environment since stack overflow is automatically
17364 detected on nearly all systems if there is only one stack.
17365
17366 Note that this switch does not actually cause checking to be done; the
17367 operating system or the language runtime must do that.  The switch causes
17368 generation of code to ensure that they see the stack being extended.
17369
17370 You can additionally specify a string parameter: @code{no} means no
17371 checking, @code{generic} means force the use of old-style checking,
17372 @code{specific} means use the best checking method and is equivalent
17373 to bare @option{-fstack-check}.
17374
17375 Old-style checking is a generic mechanism that requires no specific
17376 target support in the compiler but comes with the following drawbacks:
17377
17378 @enumerate
17379 @item
17380 Modified allocation strategy for large objects: they will always be
17381 allocated dynamically if their size exceeds a fixed threshold.
17382
17383 @item
17384 Fixed limit on the size of the static frame of functions: when it is
17385 topped by a particular function, stack checking is not reliable and
17386 a warning is issued by the compiler.
17387
17388 @item
17389 Inefficiency: because of both the modified allocation strategy and the
17390 generic implementation, the performances of the code are hampered.
17391 @end enumerate
17392
17393 Note that old-style stack checking is also the fallback method for
17394 @code{specific} if no target support has been added in the compiler.
17395
17396 @item -fstack-limit-register=@var{reg}
17397 @itemx -fstack-limit-symbol=@var{sym}
17398 @itemx -fno-stack-limit
17399 @opindex fstack-limit-register
17400 @opindex fstack-limit-symbol
17401 @opindex fno-stack-limit
17402 Generate code to ensure that the stack does not grow beyond a certain value,
17403 either the value of a register or the address of a symbol.  If the stack
17404 would grow beyond the value, a signal is raised.  For most targets,
17405 the signal is raised before the stack overruns the boundary, so
17406 it is possible to catch the signal without taking special precautions.
17407
17408 For instance, if the stack starts at absolute address @samp{0x80000000}
17409 and grows downwards, you can use the flags
17410 @option{-fstack-limit-symbol=__stack_limit} and
17411 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
17412 of 128KB@.  Note that this may only work with the GNU linker.
17413
17414 @cindex aliasing of parameters
17415 @cindex parameters, aliased
17416 @item -fargument-alias
17417 @itemx -fargument-noalias
17418 @itemx -fargument-noalias-global
17419 @itemx -fargument-noalias-anything
17420 @opindex fargument-alias
17421 @opindex fargument-noalias
17422 @opindex fargument-noalias-global
17423 @opindex fargument-noalias-anything
17424 Specify the possible relationships among parameters and between
17425 parameters and global data.
17426
17427 @option{-fargument-alias} specifies that arguments (parameters) may
17428 alias each other and may alias global storage.@*
17429 @option{-fargument-noalias} specifies that arguments do not alias
17430 each other, but may alias global storage.@*
17431 @option{-fargument-noalias-global} specifies that arguments do not
17432 alias each other and do not alias global storage.
17433 @option{-fargument-noalias-anything} specifies that arguments do not
17434 alias any other storage.
17435
17436 Each language will automatically use whatever option is required by
17437 the language standard.  You should not need to use these options yourself.
17438
17439 @item -fleading-underscore
17440 @opindex fleading-underscore
17441 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
17442 change the way C symbols are represented in the object file.  One use
17443 is to help link with legacy assembly code.
17444
17445 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
17446 generate code that is not binary compatible with code generated without that
17447 switch.  Use it to conform to a non-default application binary interface.
17448 Not all targets provide complete support for this switch.
17449
17450 @item -ftls-model=@var{model}
17451 @opindex ftls-model
17452 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
17453 The @var{model} argument should be one of @code{global-dynamic},
17454 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
17455
17456 The default without @option{-fpic} is @code{initial-exec}; with
17457 @option{-fpic} the default is @code{global-dynamic}.
17458
17459 @item -fvisibility=@var{default|internal|hidden|protected}
17460 @opindex fvisibility
17461 Set the default ELF image symbol visibility to the specified option---all
17462 symbols will be marked with this unless overridden within the code.
17463 Using this feature can very substantially improve linking and
17464 load times of shared object libraries, produce more optimized
17465 code, provide near-perfect API export and prevent symbol clashes.
17466 It is @strong{strongly} recommended that you use this in any shared objects
17467 you distribute.
17468
17469 Despite the nomenclature, @code{default} always means public ie;
17470 available to be linked against from outside the shared object.
17471 @code{protected} and @code{internal} are pretty useless in real-world
17472 usage so the only other commonly used option will be @code{hidden}.
17473 The default if @option{-fvisibility} isn't specified is
17474 @code{default}, i.e., make every
17475 symbol public---this causes the same behavior as previous versions of
17476 GCC@.
17477
17478 A good explanation of the benefits offered by ensuring ELF
17479 symbols have the correct visibility is given by ``How To Write
17480 Shared Libraries'' by Ulrich Drepper (which can be found at
17481 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
17482 solution made possible by this option to marking things hidden when
17483 the default is public is to make the default hidden and mark things
17484 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
17485 and @code{__attribute__ ((visibility("default")))} instead of
17486 @code{__declspec(dllexport)} you get almost identical semantics with
17487 identical syntax.  This is a great boon to those working with
17488 cross-platform projects.
17489
17490 For those adding visibility support to existing code, you may find
17491 @samp{#pragma GCC visibility} of use.  This works by you enclosing
17492 the declarations you wish to set visibility for with (for example)
17493 @samp{#pragma GCC visibility push(hidden)} and
17494 @samp{#pragma GCC visibility pop}.
17495 Bear in mind that symbol visibility should be viewed @strong{as
17496 part of the API interface contract} and thus all new code should
17497 always specify visibility when it is not the default ie; declarations
17498 only for use within the local DSO should @strong{always} be marked explicitly
17499 as hidden as so to avoid PLT indirection overheads---making this
17500 abundantly clear also aids readability and self-documentation of the code.
17501 Note that due to ISO C++ specification requirements, operator new and
17502 operator delete must always be of default visibility.
17503
17504 Be aware that headers from outside your project, in particular system
17505 headers and headers from any other library you use, may not be
17506 expecting to be compiled with visibility other than the default.  You
17507 may need to explicitly say @samp{#pragma GCC visibility push(default)}
17508 before including any such headers.
17509
17510 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
17511 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
17512 no modifications.  However, this means that calls to @samp{extern}
17513 functions with no explicit visibility will use the PLT, so it is more
17514 effective to use @samp{__attribute ((visibility))} and/or
17515 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
17516 declarations should be treated as hidden.
17517
17518 Note that @samp{-fvisibility} does affect C++ vague linkage
17519 entities. This means that, for instance, an exception class that will
17520 be thrown between DSOs must be explicitly marked with default
17521 visibility so that the @samp{type_info} nodes will be unified between
17522 the DSOs.
17523
17524 An overview of these techniques, their benefits and how to use them
17525 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
17526
17527 @end table
17528
17529 @c man end
17530
17531 @node Environment Variables
17532 @section Environment Variables Affecting GCC
17533 @cindex environment variables
17534
17535 @c man begin ENVIRONMENT
17536 This section describes several environment variables that affect how GCC
17537 operates.  Some of them work by specifying directories or prefixes to use
17538 when searching for various kinds of files.  Some are used to specify other
17539 aspects of the compilation environment.
17540
17541 Note that you can also specify places to search using options such as
17542 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
17543 take precedence over places specified using environment variables, which
17544 in turn take precedence over those specified by the configuration of GCC@.
17545 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
17546 GNU Compiler Collection (GCC) Internals}.
17547
17548 @table @env
17549 @item LANG
17550 @itemx LC_CTYPE
17551 @c @itemx LC_COLLATE
17552 @itemx LC_MESSAGES
17553 @c @itemx LC_MONETARY
17554 @c @itemx LC_NUMERIC
17555 @c @itemx LC_TIME
17556 @itemx LC_ALL
17557 @findex LANG
17558 @findex LC_CTYPE
17559 @c @findex LC_COLLATE
17560 @findex LC_MESSAGES
17561 @c @findex LC_MONETARY
17562 @c @findex LC_NUMERIC
17563 @c @findex LC_TIME
17564 @findex LC_ALL
17565 @cindex locale
17566 These environment variables control the way that GCC uses
17567 localization information that allow GCC to work with different
17568 national conventions.  GCC inspects the locale categories
17569 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
17570 so.  These locale categories can be set to any value supported by your
17571 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
17572 Kingdom encoded in UTF-8.
17573
17574 The @env{LC_CTYPE} environment variable specifies character
17575 classification.  GCC uses it to determine the character boundaries in
17576 a string; this is needed for some multibyte encodings that contain quote
17577 and escape characters that would otherwise be interpreted as a string
17578 end or escape.
17579
17580 The @env{LC_MESSAGES} environment variable specifies the language to
17581 use in diagnostic messages.
17582
17583 If the @env{LC_ALL} environment variable is set, it overrides the value
17584 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
17585 and @env{LC_MESSAGES} default to the value of the @env{LANG}
17586 environment variable.  If none of these variables are set, GCC
17587 defaults to traditional C English behavior.
17588
17589 @item TMPDIR
17590 @findex TMPDIR
17591 If @env{TMPDIR} is set, it specifies the directory to use for temporary
17592 files.  GCC uses temporary files to hold the output of one stage of
17593 compilation which is to be used as input to the next stage: for example,
17594 the output of the preprocessor, which is the input to the compiler
17595 proper.
17596
17597 @item GCC_EXEC_PREFIX
17598 @findex GCC_EXEC_PREFIX
17599 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
17600 names of the subprograms executed by the compiler.  No slash is added
17601 when this prefix is combined with the name of a subprogram, but you can
17602 specify a prefix that ends with a slash if you wish.
17603
17604 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
17605 an appropriate prefix to use based on the pathname it was invoked with.
17606
17607 If GCC cannot find the subprogram using the specified prefix, it
17608 tries looking in the usual places for the subprogram.
17609
17610 The default value of @env{GCC_EXEC_PREFIX} is
17611 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
17612 the installed compiler. In many cases @var{prefix} is the value
17613 of @code{prefix} when you ran the @file{configure} script.
17614
17615 Other prefixes specified with @option{-B} take precedence over this prefix.
17616
17617 This prefix is also used for finding files such as @file{crt0.o} that are
17618 used for linking.
17619
17620 In addition, the prefix is used in an unusual way in finding the
17621 directories to search for header files.  For each of the standard
17622 directories whose name normally begins with @samp{/usr/local/lib/gcc}
17623 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
17624 replacing that beginning with the specified prefix to produce an
17625 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
17626 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
17627 These alternate directories are searched first; the standard directories
17628 come next. If a standard directory begins with the configured
17629 @var{prefix} then the value of @var{prefix} is replaced by
17630 @env{GCC_EXEC_PREFIX} when looking for header files.
17631
17632 @item COMPILER_PATH
17633 @findex COMPILER_PATH
17634 The value of @env{COMPILER_PATH} is a colon-separated list of
17635 directories, much like @env{PATH}.  GCC tries the directories thus
17636 specified when searching for subprograms, if it can't find the
17637 subprograms using @env{GCC_EXEC_PREFIX}.
17638
17639 @item LIBRARY_PATH
17640 @findex LIBRARY_PATH
17641 The value of @env{LIBRARY_PATH} is a colon-separated list of
17642 directories, much like @env{PATH}.  When configured as a native compiler,
17643 GCC tries the directories thus specified when searching for special
17644 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
17645 using GCC also uses these directories when searching for ordinary
17646 libraries for the @option{-l} option (but directories specified with
17647 @option{-L} come first).
17648
17649 @item LANG
17650 @findex LANG
17651 @cindex locale definition
17652 This variable is used to pass locale information to the compiler.  One way in
17653 which this information is used is to determine the character set to be used
17654 when character literals, string literals and comments are parsed in C and C++.
17655 When the compiler is configured to allow multibyte characters,
17656 the following values for @env{LANG} are recognized:
17657
17658 @table @samp
17659 @item C-JIS
17660 Recognize JIS characters.
17661 @item C-SJIS
17662 Recognize SJIS characters.
17663 @item C-EUCJP
17664 Recognize EUCJP characters.
17665 @end table
17666
17667 If @env{LANG} is not defined, or if it has some other value, then the
17668 compiler will use mblen and mbtowc as defined by the default locale to
17669 recognize and translate multibyte characters.
17670 @end table
17671
17672 @noindent
17673 Some additional environments variables affect the behavior of the
17674 preprocessor.
17675
17676 @include cppenv.texi
17677
17678 @c man end
17679
17680 @node Precompiled Headers
17681 @section Using Precompiled Headers
17682 @cindex precompiled headers
17683 @cindex speed of compilation
17684
17685 Often large projects have many header files that are included in every
17686 source file.  The time the compiler takes to process these header files
17687 over and over again can account for nearly all of the time required to
17688 build the project.  To make builds faster, GCC allows users to
17689 `precompile' a header file; then, if builds can use the precompiled
17690 header file they will be much faster.
17691
17692 To create a precompiled header file, simply compile it as you would any
17693 other file, if necessary using the @option{-x} option to make the driver
17694 treat it as a C or C++ header file.  You will probably want to use a
17695 tool like @command{make} to keep the precompiled header up-to-date when
17696 the headers it contains change.
17697
17698 A precompiled header file will be searched for when @code{#include} is
17699 seen in the compilation.  As it searches for the included file
17700 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
17701 compiler looks for a precompiled header in each directory just before it
17702 looks for the include file in that directory.  The name searched for is
17703 the name specified in the @code{#include} with @samp{.gch} appended.  If
17704 the precompiled header file can't be used, it is ignored.
17705
17706 For instance, if you have @code{#include "all.h"}, and you have
17707 @file{all.h.gch} in the same directory as @file{all.h}, then the
17708 precompiled header file will be used if possible, and the original
17709 header will be used otherwise.
17710
17711 Alternatively, you might decide to put the precompiled header file in a
17712 directory and use @option{-I} to ensure that directory is searched
17713 before (or instead of) the directory containing the original header.
17714 Then, if you want to check that the precompiled header file is always
17715 used, you can put a file of the same name as the original header in this
17716 directory containing an @code{#error} command.
17717
17718 This also works with @option{-include}.  So yet another way to use
17719 precompiled headers, good for projects not designed with precompiled
17720 header files in mind, is to simply take most of the header files used by
17721 a project, include them from another header file, precompile that header
17722 file, and @option{-include} the precompiled header.  If the header files
17723 have guards against multiple inclusion, they will be skipped because
17724 they've already been included (in the precompiled header).
17725
17726 If you need to precompile the same header file for different
17727 languages, targets, or compiler options, you can instead make a
17728 @emph{directory} named like @file{all.h.gch}, and put each precompiled
17729 header in the directory, perhaps using @option{-o}.  It doesn't matter
17730 what you call the files in the directory, every precompiled header in
17731 the directory will be considered.  The first precompiled header
17732 encountered in the directory that is valid for this compilation will
17733 be used; they're searched in no particular order.
17734
17735 There are many other possibilities, limited only by your imagination,
17736 good sense, and the constraints of your build system.
17737
17738 A precompiled header file can be used only when these conditions apply:
17739
17740 @itemize
17741 @item
17742 Only one precompiled header can be used in a particular compilation.
17743
17744 @item
17745 A precompiled header can't be used once the first C token is seen.  You
17746 can have preprocessor directives before a precompiled header; you can
17747 even include a precompiled header from inside another header, so long as
17748 there are no C tokens before the @code{#include}.
17749
17750 @item
17751 The precompiled header file must be produced for the same language as
17752 the current compilation.  You can't use a C precompiled header for a C++
17753 compilation.
17754
17755 @item
17756 The precompiled header file must have been produced by the same compiler
17757 binary as the current compilation is using.
17758
17759 @item
17760 Any macros defined before the precompiled header is included must
17761 either be defined in the same way as when the precompiled header was
17762 generated, or must not affect the precompiled header, which usually
17763 means that they don't appear in the precompiled header at all.
17764
17765 The @option{-D} option is one way to define a macro before a
17766 precompiled header is included; using a @code{#define} can also do it.
17767 There are also some options that define macros implicitly, like
17768 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
17769 defined this way.
17770
17771 @item If debugging information is output when using the precompiled
17772 header, using @option{-g} or similar, the same kind of debugging information
17773 must have been output when building the precompiled header.  However,
17774 a precompiled header built using @option{-g} can be used in a compilation
17775 when no debugging information is being output.
17776
17777 @item The same @option{-m} options must generally be used when building
17778 and using the precompiled header.  @xref{Submodel Options},
17779 for any cases where this rule is relaxed.
17780
17781 @item Each of the following options must be the same when building and using
17782 the precompiled header:
17783
17784 @gccoptlist{-fexceptions}
17785
17786 @item
17787 Some other command-line options starting with @option{-f},
17788 @option{-p}, or @option{-O} must be defined in the same way as when
17789 the precompiled header was generated.  At present, it's not clear
17790 which options are safe to change and which are not; the safest choice
17791 is to use exactly the same options when generating and using the
17792 precompiled header.  The following are known to be safe:
17793
17794 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
17795 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
17796 -fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
17797 -pedantic-errors}
17798
17799 @end itemize
17800
17801 For all of these except the last, the compiler will automatically
17802 ignore the precompiled header if the conditions aren't met.  If you
17803 find an option combination that doesn't work and doesn't cause the
17804 precompiled header to be ignored, please consider filing a bug report,
17805 see @ref{Bugs}.
17806
17807 If you do use differing options when generating and using the
17808 precompiled header, the actual behavior will be a mixture of the
17809 behavior for the options.  For instance, if you use @option{-g} to
17810 generate the precompiled header but not when using it, you may or may
17811 not get debugging information for routines in the precompiled header.